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 * Defining Component ClassDecorator 18 * 19 * @syscap SystemCapability.ArkUI.ArkUI.Full 20 * @since 7 21 */ 22/** 23 * Defining Component ClassDecorator 24 * 25 * @syscap SystemCapability.ArkUI.ArkUI.Full 26 * @since 9 27 * @form 28 */ 29/** 30 * Defining Component ClassDecorator 31 * 32 * @syscap SystemCapability.ArkUI.ArkUI.Full 33 * @crossplatform 34 * @since 10 35 * @form 36 */ 37declare const Component: ClassDecorator; 38 39/** 40 * Defines the options of Entry ClassDecorator. 41 * 42 * @interface EntryOptions 43 * @syscap SystemCapability.ArkUI.ArkUI.Full 44 * @since 10 45 * @form 46 */ 47declare interface EntryOptions { 48 /** 49 * Named route name. 50 * 51 * @type { ?string } 52 * @syscap SystemCapability.ArkUI.ArkUI.Full 53 * @since 10 54 * @form 55 */ 56 routeName? : string, 57 58 /** 59 * LocalStorage to be passed. 60 * 61 * @type { ?LocalStorage } 62 * @syscap SystemCapability.ArkUI.ArkUI.Full 63 * @since 10 64 * @form 65 */ 66 storage? : LocalStorage, 67} 68 69/** 70 * Defines Entry ClassDecorator. 71 * 72 * @syscap SystemCapability.ArkUI.ArkUI.Full 73 * @since 7 74 */ 75/** 76 * Defines Entry ClassDecorator. 77 * 78 * Entry is a ClassDecorator and it supports LocalStorage as parameters. 79 * @syscap SystemCapability.ArkUI.ArkUI.Full 80 * @since 9 81 * @form 82 */ 83/** 84 * Defines Entry ClassDecorator. 85 * 86 * Entry is a ClassDecorator and it supports LocalStorage or EntryOptions as parameters. 87 * @syscap SystemCapability.ArkUI.ArkUI.Full 88 * @crossplatform 89 * @since 10 90 * @form 91 */ 92declare const Entry: ClassDecorator & ((options?: LocalStorage | EntryOptions) => ClassDecorator); 93 94/** 95 * Defining Observed ClassDecorator. 96 * 97 * @syscap SystemCapability.ArkUI.ArkUI.Full 98 * @since 7 99 */ 100/** 101 * Defining Observed ClassDecorator. 102 * 103 * @syscap SystemCapability.ArkUI.ArkUI.Full 104 * @since 9 105 * @form 106 */ 107/** 108 * Defining Observed ClassDecorator. 109 * 110 * @syscap SystemCapability.ArkUI.ArkUI.Full 111 * @crossplatform 112 * @since 10 113 * @form 114 */ 115declare const Observed: ClassDecorator; 116 117/** 118 * Defining Preview ClassDecorator. 119 * 120 * @syscap SystemCapability.ArkUI.ArkUI.Full 121 * @since 7 122 */ 123/** 124 * Defining Preview ClassDecorator. 125 * 126 * @syscap SystemCapability.ArkUI.ArkUI.Full 127 * @since 9 128 * @form 129 */ 130/** 131 * Defining Preview ClassDecorator. 132 * 133 * @syscap SystemCapability.ArkUI.ArkUI.Full 134 * @crossplatform 135 * @since 10 136 * @form 137 */ 138declare const Preview: ClassDecorator & ((value: PreviewParams) => ClassDecorator); 139 140/** 141 * Defining BuilderParam PropertyDecorator 142 * 143 * @syscap SystemCapability.ArkUI.ArkUI.Full 144 * @since 7 145 */ 146/** 147 * Defining BuilderParam PropertyDecorator 148 * 149 * @syscap SystemCapability.ArkUI.ArkUI.Full 150 * @since 9 151 * @form 152 */ 153/** 154 * Defining BuilderParam PropertyDecorator 155 * 156 * @syscap SystemCapability.ArkUI.ArkUI.Full 157 * @crossplatform 158 * @since 10 159 * @form 160 */ 161declare const BuilderParam: PropertyDecorator; 162 163/** 164 * Defining State PropertyDecorator. 165 * 166 * @syscap SystemCapability.ArkUI.ArkUI.Full 167 * @since 7 168 */ 169/** 170 * Defining State PropertyDecorator. 171 * 172 * @syscap SystemCapability.ArkUI.ArkUI.Full 173 * @since 9 174 * @form 175 */ 176/** 177 * Defining State PropertyDecorator. 178 * 179 * @syscap SystemCapability.ArkUI.ArkUI.Full 180 * @crossplatform 181 * @since 10 182 * @form 183 */ 184declare const State: PropertyDecorator; 185 186/** 187 * Defining Prop PropertyDecorator. 188 * 189 * @syscap SystemCapability.ArkUI.ArkUI.Full 190 * @since 7 191 */ 192/** 193 * Defining Prop PropertyDecorator. 194 * 195 * @syscap SystemCapability.ArkUI.ArkUI.Full 196 * @since 9 197 * @form 198 */ 199/** 200 * Defining Prop PropertyDecorator. 201 * 202 * @syscap SystemCapability.ArkUI.ArkUI.Full 203 * @crossplatform 204 * @since 10 205 * @form 206 */ 207declare const Prop: PropertyDecorator; 208 209/** 210 * Defining Link PropertyDecorator. 211 * 212 * @syscap SystemCapability.ArkUI.ArkUI.Full 213 * @since 7 214 */ 215/** 216 * Defining Link PropertyDecorator. 217 * 218 * @syscap SystemCapability.ArkUI.ArkUI.Full 219 * @since 9 220 * @form 221 */ 222/** 223 * Defining Link PropertyDecorator. 224 * 225 * @syscap SystemCapability.ArkUI.ArkUI.Full 226 * @crossplatform 227 * @since 10 228 * @form 229 */ 230declare const Link: PropertyDecorator; 231 232/** 233 * Defining ObjectLink PropertyDecorator. 234 * 235 * @syscap SystemCapability.ArkUI.ArkUI.Full 236 * @since 7 237 */ 238/** 239 * Defining ObjectLink PropertyDecorator. 240 * 241 * @syscap SystemCapability.ArkUI.ArkUI.Full 242 * @since 9 243 * @form 244 */ 245/** 246 * Defining ObjectLink PropertyDecorator. 247 * 248 * @syscap SystemCapability.ArkUI.ArkUI.Full 249 * @crossplatform 250 * @since 10 251 * @form 252 */ 253declare const ObjectLink: PropertyDecorator; 254 255/** 256 * Defining Provide PropertyDecorator. 257 * 258 * @syscap SystemCapability.ArkUI.ArkUI.Full 259 * @since 7 260 */ 261/** 262 * Defining Provide PropertyDecorator. 263 * 264 * @syscap SystemCapability.ArkUI.ArkUI.Full 265 * @since 9 266 * @form 267 */ 268/** 269 * Defining Provide PropertyDecorator. 270 * 271 * @syscap SystemCapability.ArkUI.ArkUI.Full 272 * @crossplatform 273 * @since 10 274 * @form 275 */ 276declare const Provide: PropertyDecorator & ((value: string) => PropertyDecorator); 277 278/** 279 * Defining Consume PropertyDecorator. 280 * 281 * @syscap SystemCapability.ArkUI.ArkUI.Full 282 * @since 7 283 */ 284/** 285 * Defining Consume PropertyDecorator. 286 * 287 * @syscap SystemCapability.ArkUI.ArkUI.Full 288 * @since 9 289 * @form 290 */ 291/** 292 * Defining Consume PropertyDecorator. 293 * 294 * @syscap SystemCapability.ArkUI.ArkUI.Full 295 * @crossplatform 296 * @since 10 297 * @form 298 */ 299declare const Consume: PropertyDecorator & ((value: string) => PropertyDecorator); 300 301/** 302 * Defining StorageProp PropertyDecorator. 303 * 304 * @syscap SystemCapability.ArkUI.ArkUI.Full 305 * @since 7 306 */ 307/** 308 * Defining StorageProp PropertyDecorator. 309 * 310 * @syscap SystemCapability.ArkUI.ArkUI.Full 311 * @crossplatform 312 * @since 10 313 */ 314declare const StorageProp: (value: string) => PropertyDecorator; 315 316/** 317 * Defining StorageLink PropertyDecorator. 318 * 319 * @syscap SystemCapability.ArkUI.ArkUI.Full 320 * @since 7 321 */ 322/** 323 * Defining StorageLink PropertyDecorator. 324 * 325 * @syscap SystemCapability.ArkUI.ArkUI.Full 326 * @crossplatform 327 * @since 10 328 */ 329declare const StorageLink: (value: string) => PropertyDecorator; 330 331/** 332 * Defining Watch PropertyDecorator. 333 * 334 * @syscap SystemCapability.ArkUI.ArkUI.Full 335 * @since 7 336 */ 337/** 338 * Defining Watch PropertyDecorator. 339 * 340 * @syscap SystemCapability.ArkUI.ArkUI.Full 341 * @since 9 342 * @form 343 */ 344/** 345 * Defining Watch PropertyDecorator. 346 * 347 * @syscap SystemCapability.ArkUI.ArkUI.Full 348 * @crossplatform 349 * @since 10 350 * @form 351 */ 352declare const Watch: (value: string) => PropertyDecorator; 353 354/** 355 * Defining Builder MethodDecorator 356 * 357 * @syscap SystemCapability.ArkUI.ArkUI.Full 358 * @since 7 359 */ 360/** 361 * Defining Builder MethodDecorator 362 * 363 * @syscap SystemCapability.ArkUI.ArkUI.Full 364 * @since 9 365 * @form 366 */ 367/** 368 * Defining Builder MethodDecorator 369 * 370 * @syscap SystemCapability.ArkUI.ArkUI.Full 371 * @crossplatform 372 * @since 10 373 * @form 374 */ 375declare const Builder: MethodDecorator; 376 377/** 378 * Defining Styles MethodDecorator 379 * 380 * @syscap SystemCapability.ArkUI.ArkUI.Full 381 * @since 8 382 */ 383/** 384 * Defining Styles MethodDecorator 385 * 386 * @syscap SystemCapability.ArkUI.ArkUI.Full 387 * @since 9 388 * @form 389 */ 390/** 391 * Defining Styles MethodDecorator 392 * 393 * @syscap SystemCapability.ArkUI.ArkUI.Full 394 * @crossplatform 395 * @since 10 396 * @form 397 */ 398declare const Styles: MethodDecorator; 399 400/** 401 * Defining Extend MethodDecorator 402 * 403 * @syscap SystemCapability.ArkUI.ArkUI.Full 404 * @since 7 405 */ 406/** 407 * Defining Extend MethodDecorator 408 * 409 * @syscap SystemCapability.ArkUI.ArkUI.Full 410 * @since 9 411 * @form 412 */ 413/** 414 * Defining Extend MethodDecorator 415 * 416 * @syscap SystemCapability.ArkUI.ArkUI.Full 417 * @crossplatform 418 * @since 10 419 * @form 420 */ 421declare const Extend: MethodDecorator & ((value: any) => MethodDecorator); 422 423/** 424 * Define AnimatableExtend MethodDecorator 425 * 426 * @syscap SystemCapability.ArkUI.ArkUI.Full 427 * @crossplatform 428 * @since 10 429 */ 430 declare const AnimatableExtend: MethodDecorator & ((value: Object) => MethodDecorator); 431 432/** 433 * Define AnimatableArithmetic interface 434 * 435 * @interface AnimatableArithmetic 436 * @syscap SystemCapability.ArkUI.ArkUI.Full 437 * @crossplatform 438 * @since 10 439 */ 440 declare interface AnimatableArithmetic<T> { 441 /** 442 * Define plus method 443 * 444 * @param { AnimatableArithmetic<T> } rhs - another value 445 * @returns { AnimatableArithmetic<T> } new value which implements AnimatableArithmetic<T> interface 446 * @syscap SystemCapability.ArkUI.ArkUI.Full 447 * @crossplatform 448 * @since 10 449 */ 450 plus(rhs: AnimatableArithmetic<T>): AnimatableArithmetic<T>; 451 452 /** 453 * Define subtract method 454 * 455 * @param { AnimatableArithmetic<T> } rhs - another value 456 * @returns { AnimatableArithmetic<T> } new value which implements AnimatableArithmetic<T> interface 457 * @syscap SystemCapability.ArkUI.ArkUI.Full 458 * @crossplatform 459 * @since 10 460 */ 461 subtract(rhs: AnimatableArithmetic<T>): AnimatableArithmetic<T>; 462 463 /** 464 * Define multiply method 465 * 466 * @param { number } scale - scale value 467 * @returns { AnimatableArithmetic<T> } new value which implements AnimatableArithmetic<T> interface 468 * @syscap SystemCapability.ArkUI.ArkUI.Full 469 * @crossplatform 470 * @since 10 471 */ 472 multiply(scale: number): AnimatableArithmetic<T>; 473 474 /** 475 * Define equals method 476 * 477 * @param { AnimatableArithmetic<T> } rhs - another value 478 * @returns { boolean } is equals 479 * @syscap SystemCapability.ArkUI.ArkUI.Full 480 * @crossplatform 481 * @since 10 482 */ 483 equals(rhs: AnimatableArithmetic<T>): boolean; 484} 485 486/** 487 * Defining Concurrent MethodDecorator 488 * 489 * @syscap SystemCapability.ArkUI.ArkUI.Full 490 * @since 9 491 */ 492/** 493 * Defining Concurrent MethodDecorator 494 * 495 * @syscap SystemCapability.ArkUI.ArkUI.Full 496 * @crossplatform 497 * @since 10 498 */ 499declare const Concurrent: MethodDecorator; 500 501/** 502 * Defining CustomDialog ClassDecorator 503 * 504 * @syscap SystemCapability.ArkUI.ArkUI.Full 505 * @since 7 506 */ 507/** 508 * Defining CustomDialog ClassDecorator 509 * 510 * @syscap SystemCapability.ArkUI.ArkUI.Full 511 * @crossplatform 512 * @since 10 513 */ 514declare const CustomDialog: ClassDecorator; 515 516/** 517 * Defining LocalStorageLink PropertyDecorator. 518 * 519 * @syscap SystemCapability.ArkUI.ArkUI.Full 520 * @since 9 521 */ 522/** 523 * Defining LocalStorageLink PropertyDecorator. 524 * 525 * @syscap SystemCapability.ArkUI.ArkUI.Full 526 * @crossplatform 527 * @since 10 528 */ 529declare const LocalStorageLink: (value: string) => PropertyDecorator; 530 531/** 532 * Defining LocalStorageProp PropertyDecorator 533 * 534 * @syscap SystemCapability.ArkUI.ArkUI.Full 535 * @since 9 536 * @form 537 */ 538/** 539 * Defining LocalStorageProp PropertyDecorator 540 * 541 * @syscap SystemCapability.ArkUI.ArkUI.Full 542 * @crossplatform 543 * @since 10 544 * @form 545 */ 546declare const LocalStorageProp: (value: string) => PropertyDecorator; 547 548/** 549 * Obtains the Context object associated with a component on the page. 550 * 551 * @param { Object } component - indicate the component on the page. 552 * @returns { Context } 553 * @syscap SystemCapability.ArkUI.ArkUI.Full 554 * @StageModelOnly 555 * @since 9 556 */ 557/** 558 * Obtains the Context object associated with a component on the page. 559 * 560 * @param { Object } component - indicate the component on the page. 561 * @returns { Context } 562 * @syscap SystemCapability.ArkUI.ArkUI.Full 563 * @StageModelOnly 564 * @crossplatform 565 * @since 10 566 */ 567declare function getContext(component?: Object): Context; 568 569/** 570 * Defining Reusable ClassDecorator. 571 * 572 * @syscap SystemCapability.ArkUI.ArkUI.Full 573 * @crossplatform 574 * @since 10 575 */ 576declare const Reusable: ClassDecorator; 577 578/** 579 * Get context. 580 * 581 * @syscap SystemCapability.ArkUI.ArkUI.Full 582 * @StageModelOnly 583 * @since 9 584 */ 585/** 586 * Get context. 587 * 588 * @syscap SystemCapability.ArkUI.ArkUI.Full 589 * @StageModelOnly 590 * @crossplatform 591 * @since 10 592 */ 593declare type Context = import('../api/application/Context').default; 594 595/** 596 * Post Card Action. 597 * 598 * @param { Object } component - indicate the card entry component. 599 * @param { Object } action - indicate the router, message or call event. 600 * @syscap SystemCapability.ArkUI.ArkUI.Full 601 * @StageModelOnly 602 * @since 9 603 * @form 604 */ 605/** 606 * Post Card Action. 607 * 608 * @param { Object } component - indicate the card entry component. 609 * @param { Object } action - indicate the router, message or call event. 610 * @syscap SystemCapability.ArkUI.ArkUI.Full 611 * @StageModelOnly 612 * @crossplatform 613 * @since 10 614 * @form 615 */ 616declare function postCardAction(component: Object, action: Object): void; 617 618/** 619 * Defines the data type of the interface restriction. 620 * 621 * @interface Configuration 622 * @syscap SystemCapability.ArkUI.ArkUI.Full 623 * @since 7 624 */ 625/** 626 * Defines the data type of the interface restriction. 627 * 628 * @interface Configuration 629 * @syscap SystemCapability.ArkUI.ArkUI.Full 630 * @since 9 631 * @form 632 */ 633/** 634 * Defines the data type of the interface restriction. 635 * 636 * @interface Configuration 637 * @syscap SystemCapability.ArkUI.ArkUI.Full 638 * @crossplatform 639 * @since 10 640 * @form 641 */ 642declare interface Configuration { 643 /** 644 * Set colorMode. 645 * 646 * @type { string } 647 * @syscap SystemCapability.ArkUI.ArkUI.Full 648 * @since 7 649 */ 650 /** 651 * Set colorMode. 652 * 653 * @type { string } 654 * @syscap SystemCapability.ArkUI.ArkUI.Full 655 * @since 9 656 * @form 657 */ 658 /** 659 * Set colorMode. 660 * 661 * @type { string } 662 * @syscap SystemCapability.ArkUI.ArkUI.Full 663 * @crossplatform 664 * @since 10 665 * @form 666 */ 667 readonly colorMode: string; 668 669 /** 670 * Set fontScale. 671 * 672 * @type { number } 673 * @syscap SystemCapability.ArkUI.ArkUI.Full 674 * @since 7 675 */ 676 /** 677 * Set fontScale. 678 * 679 * @type { number } 680 * @syscap SystemCapability.ArkUI.ArkUI.Full 681 * @since 9 682 * @form 683 */ 684 /** 685 * Set fontScale. 686 * 687 * @type { number } 688 * @syscap SystemCapability.ArkUI.ArkUI.Full 689 * @crossplatform 690 * @since 10 691 * @form 692 */ 693 readonly fontScale: number; 694} 695 696/** 697 * Defines the data type of the interface restriction. 698 * 699 * @interface Rectangle 700 * @syscap SystemCapability.ArkUI.ArkUI.Full 701 * @since 8 702 */ 703/** 704 * Defines the data type of the interface restriction. 705 * 706 * @interface Rectangle 707 * @syscap SystemCapability.ArkUI.ArkUI.Full 708 * @since 9 709 * @form 710 */ 711/** 712 * Defines the data type of the interface restriction. 713 * 714 * @interface Rectangle 715 * @syscap SystemCapability.ArkUI.ArkUI.Full 716 * @crossplatform 717 * @since 10 718 * @form 719 */ 720declare interface Rectangle { 721 /** 722 * x:Horizontal coordinate 723 * 724 * @type { ?Length } 725 * @syscap SystemCapability.ArkUI.ArkUI.Full 726 * @since 8 727 */ 728 /** 729 * x:Horizontal coordinate 730 * 731 * @type { ?Length } 732 * @syscap SystemCapability.ArkUI.ArkUI.Full 733 * @since 9 734 * @form 735 */ 736 /** 737 * x:Horizontal coordinate 738 * 739 * @type { ?Length } 740 * @syscap SystemCapability.ArkUI.ArkUI.Full 741 * @crossplatform 742 * @since 10 743 * @form 744 */ 745 x?: Length; 746 747 /** 748 * y:Vertical axis coordinate. 749 * 750 * @type { ?Length } 751 * @syscap SystemCapability.ArkUI.ArkUI.Full 752 * @since 8 753 */ 754 /** 755 * y:Vertical axis coordinate. 756 * 757 * @type { ?Length } 758 * @syscap SystemCapability.ArkUI.ArkUI.Full 759 * @since 9 760 * @form 761 */ 762 /** 763 * y:Vertical axis coordinate. 764 * 765 * @type { ?Length } 766 * @syscap SystemCapability.ArkUI.ArkUI.Full 767 * @crossplatform 768 * @since 10 769 * @form 770 */ 771 y?: Length; 772 773 /** 774 * Sets the width of the current touchRect. 775 * 776 * @type { ?Length } 777 * @syscap SystemCapability.ArkUI.ArkUI.Full 778 * @since 8 779 */ 780 /** 781 * Sets the width of the current touchRect. 782 * 783 * @type { ?Length } 784 * @syscap SystemCapability.ArkUI.ArkUI.Full 785 * @since 9 786 * @form 787 */ 788 /** 789 * Sets the width of the current touchRect. 790 * 791 * @type { ?Length } 792 * @syscap SystemCapability.ArkUI.ArkUI.Full 793 * @crossplatform 794 * @since 10 795 * @form 796 */ 797 width?: Length; 798 799 /** 800 * Sets the height of the current touchRect. 801 * 802 * @type { ?Length } 803 * @syscap SystemCapability.ArkUI.ArkUI.Full 804 * @since 8 805 */ 806 /** 807 * Sets the height of the current touchRect. 808 * 809 * @type { ?Length } 810 * @syscap SystemCapability.ArkUI.ArkUI.Full 811 * @since 9 812 * @form 813 */ 814 /** 815 * Sets the height of the current touchRect. 816 * 817 * @type { ?Length } 818 * @syscap SystemCapability.ArkUI.ArkUI.Full 819 * @crossplatform 820 * @since 10 821 * @form 822 */ 823 height?: Length; 824} 825 826/** 827 * global $r function 828 * 829 * @param { string } value 830 * @param { any[] } params 831 * @returns { Resource } 832 * @syscap SystemCapability.ArkUI.ArkUI.Full 833 * @since 7 834 */ 835/** 836 * global $r function 837 * 838 * @param { string } value 839 * @param { any[] } params 840 * @returns { Resource } 841 * @syscap SystemCapability.ArkUI.ArkUI.Full 842 * @since 9 843 * @form 844 */ 845/** 846 * global $r function 847 * 848 * @param { string } value 849 * @param { any[] } params 850 * @returns { Resource } 851 * @syscap SystemCapability.ArkUI.ArkUI.Full 852 * @crossplatform 853 * @since 10 854 * @form 855 */ 856declare function $r(value: string, ...params: any[]): Resource; 857 858/** 859 * global $rawfile function 860 * 861 * @param { string } value 862 * @returns { Resource } 863 * @syscap SystemCapability.ArkUI.ArkUI.Full 864 * @since 7 865 */ 866/** 867 * global $rawfile function 868 * 869 * @param { string } value 870 * @returns { Resource } 871 * @syscap SystemCapability.ArkUI.ArkUI.Full 872 * @since 9 873 * @form 874 */ 875/** 876 * global $rawfile function 877 * 878 * @param { string } value 879 * @returns { Resource } 880 * @syscap SystemCapability.ArkUI.ArkUI.Full 881 * @crossplatform 882 * @since 10 883 * @form 884 */ 885declare function $rawfile(value: string): Resource; 886 887/** 888 * Defines the animate function params. 889 * 890 * @interface AnimateParam 891 * @syscap SystemCapability.ArkUI.ArkUI.Full 892 * @since 7 893 */ 894/** 895 * Defines the animate function params. 896 * 897 * @interface AnimateParam 898 * @syscap SystemCapability.ArkUI.ArkUI.Full 899 * @since 9 900 * @form 901 */ 902/** 903 * Defines the animate function params. 904 * 905 * @interface AnimateParam 906 * @syscap SystemCapability.ArkUI.ArkUI.Full 907 * @crossplatform 908 * @since 10 909 * @form 910 */ 911declare interface AnimateParam { 912 /** 913 * Animation duration, in ms. 914 * 915 * @type { ?number } 916 * @syscap SystemCapability.ArkUI.ArkUI.Full 917 * @since 7 918 */ 919 /** 920 * Animation duration, in ms. 921 * 922 * @type { ?number } 923 * @syscap SystemCapability.ArkUI.ArkUI.Full 924 * @since 9 925 * @form 926 */ 927 /** 928 * Animation duration, in ms. 929 * 930 * @type { ?number } 931 * @syscap SystemCapability.ArkUI.ArkUI.Full 932 * @crossplatform 933 * @since 10 934 * @form 935 */ 936 duration?: number; 937 /** 938 * Animation playback speed. A larger value indicates faster animation playback, and a smaller value indicates slower 939 * animation playback. The value 0 means that there is no animation. 940 * 941 * @type { ?number } 942 * @syscap SystemCapability.ArkUI.ArkUI.Full 943 * @since 7 944 */ 945 /** 946 * Animation playback speed. A larger value indicates faster animation playback, and a smaller value indicates slower 947 * animation playback. The value 0 means that there is no animation. 948 * 949 * @type { ?number } 950 * @syscap SystemCapability.ArkUI.ArkUI.Full 951 * @crossplatform 952 * @since 10 953 */ 954 tempo?: number; 955 /** 956 * Animation curve. 957 * 958 * @type { ?(Curve | string) } 959 * @syscap SystemCapability.ArkUI.ArkUI.Full 960 * @since 7 961 */ 962 /** 963 * Animation curve. 964 * 965 * @type { ?(Curve | string | ICurve) } 966 * @syscap SystemCapability.ArkUI.ArkUI.Full 967 * @since 9 968 * @form 969 */ 970 /** 971 * Animation curve. 972 * 973 * @type { ?(Curve | string | ICurve) } 974 * @syscap SystemCapability.ArkUI.ArkUI.Full 975 * @crossplatform 976 * @since 10 977 * @form 978 */ 979 curve?: Curve | string | ICurve; 980 981 /** 982 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 983 * 984 * @type { ?number } 985 * @syscap SystemCapability.ArkUI.ArkUI.Full 986 * @since 7 987 */ 988 /** 989 * Animation delay time, in ms. 990 * 991 * @type { ?number } 992 * @syscap SystemCapability.ArkUI.ArkUI.Full 993 * @crossplatform 994 * @since 10 995 */ 996 delay?: number; 997 998 /** 999 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 1000 * 1001 * @type { ?number } 1002 * @syscap SystemCapability.ArkUI.ArkUI.Full 1003 * @since 7 1004 */ 1005 /** 1006 * Animation iterations. 1007 * 1008 * @type { ?number } 1009 * @syscap SystemCapability.ArkUI.ArkUI.Full 1010 * @crossplatform 1011 * @since 10 1012 */ 1013 iterations?: number; 1014 1015 /** 1016 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 1017 * 1018 * @type { ?PlayMode } 1019 * @syscap SystemCapability.ArkUI.ArkUI.Full 1020 * @since 7 1021 */ 1022 /** 1023 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 1024 * 1025 * @type { ?PlayMode } 1026 * @syscap SystemCapability.ArkUI.ArkUI.Full 1027 * @since 9 1028 * @form 1029 */ 1030 /** 1031 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 1032 * 1033 * @type { ?PlayMode } 1034 * @syscap SystemCapability.ArkUI.ArkUI.Full 1035 * @crossplatform 1036 * @since 10 1037 * @form 1038 */ 1039 playMode?: PlayMode; 1040 1041 /** 1042 * Callback invoked when the animation playback is complete. 1043 * 1044 * @type { ?function } 1045 * @syscap SystemCapability.ArkUI.ArkUI.Full 1046 * @since 7 1047 */ 1048 /** 1049 * Callback invoked when the animation playback is complete. 1050 * 1051 * @type { ?function } 1052 * @syscap SystemCapability.ArkUI.ArkUI.Full 1053 * @since 9 1054 * @form 1055 */ 1056 /** 1057 * Callback invoked when the animation playback is complete. 1058 * 1059 * @type { ?function } 1060 * @syscap SystemCapability.ArkUI.ArkUI.Full 1061 * @crossplatform 1062 * @since 10 1063 * @form 1064 */ 1065 onFinish?: () => void; 1066} 1067 1068/** 1069 * Interface for curve object. 1070 * 1071 * @interface ICurve 1072 * @syscap SystemCapability.ArkUI.ArkUI.Full 1073 * @since 9 1074 * @form 1075 */ 1076/** 1077 * Interface for curve object. 1078 * 1079 * @interface ICurve 1080 * @syscap SystemCapability.ArkUI.ArkUI.Full 1081 * @crossplatform 1082 * @since 10 1083 * @form 1084 */ 1085interface ICurve { 1086 /** 1087 * Get curve value by fraction. 1088 * 1089 * @param { number } fraction 1090 * @returns { number } 1091 * @syscap SystemCapability.ArkUI.ArkUI.Full 1092 * @since 9 1093 * @form 1094 */ 1095 /** 1096 * Get curve value by fraction. 1097 * 1098 * @param { number } fraction 1099 * @returns { number } 1100 * @syscap SystemCapability.ArkUI.ArkUI.Full 1101 * @crossplatform 1102 * @since 10 1103 * @form 1104 */ 1105 interpolate(fraction: number): number; 1106} 1107 1108/** 1109 * Defines the motion path options. 1110 * 1111 * @interface MotionPathOptions 1112 * @syscap SystemCapability.ArkUI.ArkUI.Full 1113 * @since 7 1114 */ 1115/** 1116 * Defines the motion path options. 1117 * 1118 * @interface MotionPathOptions 1119 * @syscap SystemCapability.ArkUI.ArkUI.Full 1120 * @crossplatform 1121 * @since 10 1122 */ 1123declare interface MotionPathOptions { 1124 /** 1125 * The path info. 1126 * 1127 * @type { string } 1128 * @syscap SystemCapability.ArkUI.ArkUI.Full 1129 * @since 7 1130 */ 1131 /** 1132 * The path info. 1133 * 1134 * @type { string } 1135 * @syscap SystemCapability.ArkUI.ArkUI.Full 1136 * @crossplatform 1137 * @since 10 1138 */ 1139 path: string; 1140 1141 /** 1142 * The origin point info. 1143 * 1144 * @type { ?number } 1145 * @syscap SystemCapability.ArkUI.ArkUI.Full 1146 * @since 7 1147 */ 1148 /** 1149 * The origin point info. 1150 * 1151 * @type { ?number } 1152 * @syscap SystemCapability.ArkUI.ArkUI.Full 1153 * @crossplatform 1154 * @since 10 1155 */ 1156 from?: number; 1157 1158 /** 1159 * The distance point info. 1160 * 1161 * @type { ?number } 1162 * @syscap SystemCapability.ArkUI.ArkUI.Full 1163 * @since 7 1164 */ 1165 /** 1166 * The distance point info. 1167 * 1168 * @type { ?number } 1169 * @syscap SystemCapability.ArkUI.ArkUI.Full 1170 * @crossplatform 1171 * @since 10 1172 */ 1173 to?: number; 1174 1175 /** 1176 * The rotate info. 1177 * 1178 * @type { ?boolean } 1179 * @syscap SystemCapability.ArkUI.ArkUI.Full 1180 * @since 7 1181 */ 1182 /** 1183 * The rotate info. 1184 * 1185 * @type { ?boolean } 1186 * @syscap SystemCapability.ArkUI.ArkUI.Full 1187 * @crossplatform 1188 * @since 10 1189 */ 1190 rotatable?: boolean; 1191} 1192 1193/** 1194 * Defines the shard transition function params. 1195 * 1196 * @interface sharedTransitionOptions 1197 * @syscap SystemCapability.ArkUI.ArkUI.Full 1198 * @since 7 1199 */ 1200/** 1201 * Defines the shard transition function params. 1202 * 1203 * @interface sharedTransitionOptions 1204 * @syscap SystemCapability.ArkUI.ArkUI.Full 1205 * @crossplatform 1206 * @since 10 1207 */ 1208declare interface sharedTransitionOptions { 1209 /** 1210 * Animation duration, in ms. 1211 * 1212 * @type { ?number } 1213 * @syscap SystemCapability.ArkUI.ArkUI.Full 1214 * @since 7 1215 */ 1216 /** 1217 * Animation duration, in ms. 1218 * 1219 * @type { ?number } 1220 * @syscap SystemCapability.ArkUI.ArkUI.Full 1221 * @crossplatform 1222 * @since 10 1223 */ 1224 duration?: number; 1225 1226 /** 1227 * Animation duration, in ms. 1228 * 1229 * @type { ?(Curve | string | ICurve) } 1230 * @syscap SystemCapability.ArkUI.ArkUI.Full 1231 * @since 7 1232 */ 1233 /** 1234 * Animation curve. 1235 * 1236 * @type { ?(Curve | string | ICurve) } 1237 * @syscap SystemCapability.ArkUI.ArkUI.Full 1238 * @crossplatform 1239 * @since 10 1240 */ 1241 curve?: Curve | string | ICurve; 1242 1243 /** 1244 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 1245 * 1246 * @type { ?number } 1247 * @syscap SystemCapability.ArkUI.ArkUI.Full 1248 * @since 7 1249 */ 1250 /** 1251 * Animation delay time, in ms. 1252 * 1253 * @type { ?number } 1254 * @syscap SystemCapability.ArkUI.ArkUI.Full 1255 * @crossplatform 1256 * @since 10 1257 */ 1258 delay?: number; 1259 1260 /** 1261 * The motion path info. 1262 * 1263 * @type { ?MotionPathOptions } 1264 * @syscap SystemCapability.ArkUI.ArkUI.Full 1265 * @since 7 1266 */ 1267 /** 1268 * The motion path info. 1269 * 1270 * @type { ?MotionPathOptions } 1271 * @syscap SystemCapability.ArkUI.ArkUI.Full 1272 * @crossplatform 1273 * @since 10 1274 */ 1275 motionPath?: MotionPathOptions; 1276 1277 /** 1278 * Z index info. 1279 * 1280 * @type { ?number } 1281 * @syscap SystemCapability.ArkUI.ArkUI.Full 1282 * @since 7 1283 */ 1284 /** 1285 * Z index info. 1286 * 1287 * @type { ?number } 1288 * @syscap SystemCapability.ArkUI.ArkUI.Full 1289 * @crossplatform 1290 * @since 10 1291 */ 1292 zIndex?: number; 1293 1294 /** 1295 * the animate type. 1296 * 1297 * @type { ?SharedTransitionEffectType } 1298 * @syscap SystemCapability.ArkUI.ArkUI.Full 1299 * @since 7 1300 */ 1301 /** 1302 * the animate type. 1303 * 1304 * @type { ?SharedTransitionEffectType } 1305 * @syscap SystemCapability.ArkUI.ArkUI.Full 1306 * @crossplatform 1307 * @since 10 1308 */ 1309 type?: SharedTransitionEffectType; 1310} 1311 1312/** 1313 * Defines the options of translate. 1314 * 1315 * @interface TranslateOptions 1316 * @syscap SystemCapability.ArkUI.ArkUI.Full 1317 * @since 7 1318 */ 1319/** 1320 * Defines the options of translate. 1321 * 1322 * @interface TranslateOptions 1323 * @syscap SystemCapability.ArkUI.ArkUI.Full 1324 * @since 9 1325 * @form 1326 */ 1327/** 1328 * Defines the options of translate. 1329 * 1330 * @interface TranslateOptions 1331 * @syscap SystemCapability.ArkUI.ArkUI.Full 1332 * @crossplatform 1333 * @since 10 1334 * @form 1335 */ 1336declare interface TranslateOptions { 1337 /** 1338 * The param of x direction. 1339 * 1340 * @type { ?(number | string) } 1341 * @syscap SystemCapability.ArkUI.ArkUI.Full 1342 * @since 7 1343 */ 1344 /** 1345 * The param of x direction. 1346 * 1347 * @type { ?(number | string) } 1348 * @syscap SystemCapability.ArkUI.ArkUI.Full 1349 * @since 9 1350 * @form 1351 */ 1352 /** 1353 * The param of x direction. 1354 * 1355 * @type { ?(number | string) } 1356 * @syscap SystemCapability.ArkUI.ArkUI.Full 1357 * @crossplatform 1358 * @since 10 1359 * @form 1360 */ 1361 x?: number | string; 1362 1363 /** 1364 * The param of y direction. 1365 * 1366 * @type { ?(number | string) } 1367 * @syscap SystemCapability.ArkUI.ArkUI.Full 1368 * @since 7 1369 */ 1370 /** 1371 * The param of y direction. 1372 * 1373 * @type { ?(number | string) } 1374 * @syscap SystemCapability.ArkUI.ArkUI.Full 1375 * @since 9 1376 * @form 1377 */ 1378 /** 1379 * The param of y direction. 1380 * 1381 * @type { ?(number | string) } 1382 * @syscap SystemCapability.ArkUI.ArkUI.Full 1383 * @crossplatform 1384 * @since 10 1385 * @form 1386 */ 1387 y?: number | string; 1388 1389 /** 1390 * The param of z direction. 1391 * 1392 * @type { ?(number | string) } 1393 * @syscap SystemCapability.ArkUI.ArkUI.Full 1394 * @since 7 1395 */ 1396 /** 1397 * The param of z direction. 1398 * 1399 * @type { ?(number | string) } 1400 * @syscap SystemCapability.ArkUI.ArkUI.Full 1401 * @since 9 1402 * @form 1403 */ 1404 /** 1405 * The param of z direction. 1406 * 1407 * @type { ?(number | string) } 1408 * @syscap SystemCapability.ArkUI.ArkUI.Full 1409 * @crossplatform 1410 * @since 10 1411 * @form 1412 */ 1413 z?: number | string; 1414} 1415 1416/** 1417 * Defines the options of scale. 1418 * 1419 * @interface ScaleOptions 1420 * @syscap SystemCapability.ArkUI.ArkUI.Full 1421 * @since 7 1422 */ 1423/** 1424 * Defines the options of scale. 1425 * 1426 * @interface ScaleOptions 1427 * @syscap SystemCapability.ArkUI.ArkUI.Full 1428 * @since 9 1429 * @form 1430 */ 1431/** 1432 * Defines the options of scale. 1433 * 1434 * @interface ScaleOptions 1435 * @syscap SystemCapability.ArkUI.ArkUI.Full 1436 * @crossplatform 1437 * @since 10 1438 * @form 1439 */ 1440declare interface ScaleOptions { 1441 /** 1442 * The param of x direction. 1443 * 1444 * @type { ?number } 1445 * @syscap SystemCapability.ArkUI.ArkUI.Full 1446 * @since 7 1447 */ 1448 /** 1449 * The param of x direction. 1450 * 1451 * @type { ?number } 1452 * @syscap SystemCapability.ArkUI.ArkUI.Full 1453 * @since 9 1454 * @form 1455 */ 1456 /** 1457 * The param of x direction. 1458 * 1459 * @type { ?number } 1460 * @syscap SystemCapability.ArkUI.ArkUI.Full 1461 * @crossplatform 1462 * @since 10 1463 * @form 1464 */ 1465 x?: number; 1466 1467 /** 1468 * The param of y direction. 1469 * 1470 * @type { ?number } 1471 * @syscap SystemCapability.ArkUI.ArkUI.Full 1472 * @since 7 1473 */ 1474 /** 1475 * The param of y direction. 1476 * 1477 * @type { ?number } 1478 * @syscap SystemCapability.ArkUI.ArkUI.Full 1479 * @since 9 1480 * @form 1481 */ 1482 /** 1483 * The param of y direction. 1484 * 1485 * @type { ?number } 1486 * @syscap SystemCapability.ArkUI.ArkUI.Full 1487 * @crossplatform 1488 * @since 10 1489 * @form 1490 */ 1491 y?: number; 1492 1493 /** 1494 * The param of z direction. 1495 * 1496 * @type { ?number } 1497 * @syscap SystemCapability.ArkUI.ArkUI.Full 1498 * @since 7 1499 */ 1500 /** 1501 * The param of z direction. 1502 * 1503 * @type { ?number } 1504 * @syscap SystemCapability.ArkUI.ArkUI.Full 1505 * @since 9 1506 * @form 1507 */ 1508 /** 1509 * The param of z direction. 1510 * 1511 * @type { ?number } 1512 * @syscap SystemCapability.ArkUI.ArkUI.Full 1513 * @crossplatform 1514 * @since 10 1515 * @form 1516 */ 1517 z?: number; 1518 1519 /** 1520 * The param of center point of x. 1521 * 1522 * @type { ?(number | string) } 1523 * @syscap SystemCapability.ArkUI.ArkUI.Full 1524 * @since 7 1525 */ 1526 /** 1527 * The param of center point of x. 1528 * 1529 * @type { ?(number | string) } 1530 * @syscap SystemCapability.ArkUI.ArkUI.Full 1531 * @since 9 1532 * @form 1533 */ 1534 /** 1535 * The param of center point of x. 1536 * 1537 * @type { ?(number | string) } 1538 * @syscap SystemCapability.ArkUI.ArkUI.Full 1539 * @crossplatform 1540 * @since 10 1541 * @form 1542 */ 1543 centerX?: number | string; 1544 1545 /** 1546 * The param of center point of y. 1547 * 1548 * @type { ?(number | string) } 1549 * @syscap SystemCapability.ArkUI.ArkUI.Full 1550 * @since 7 1551 */ 1552 /** 1553 * The param of center point of y. 1554 * 1555 * @type { ?(number | string) } 1556 * @syscap SystemCapability.ArkUI.ArkUI.Full 1557 * @since 9 1558 * @form 1559 */ 1560 /** 1561 * The param of center point of y. 1562 * 1563 * @type { ?(number | string) } 1564 * @syscap SystemCapability.ArkUI.ArkUI.Full 1565 * @crossplatform 1566 * @since 10 1567 * @form 1568 */ 1569 centerY?: number | string; 1570} 1571 1572/** 1573 * Defines the align rule options of relative container. 1574 * 1575 * @interface AlignRuleOption 1576 * @syscap SystemCapability.ArkUI.ArkUI.Full 1577 * @since 9 1578 * @form 1579 */ 1580/** 1581 * Defines the align rule options of relative container. 1582 * 1583 * @interface AlignRuleOption 1584 * @syscap SystemCapability.ArkUI.ArkUI.Full 1585 * @crossplatform 1586 * @since 10 1587 * @form 1588 */ 1589declare interface AlignRuleOption { 1590 /** 1591 * The param of left align. 1592 * 1593 * @type { ?object } 1594 * @syscap SystemCapability.ArkUI.ArkUI.Full 1595 * @since 9 1596 * @form 1597 */ 1598 /** 1599 * The param of left align. 1600 * 1601 * @type { ?object } 1602 * @syscap SystemCapability.ArkUI.ArkUI.Full 1603 * @crossplatform 1604 * @since 10 1605 * @form 1606 */ 1607 left?: { anchor: string, align: HorizontalAlign }; 1608 1609 /** 1610 * The param of right align. 1611 * 1612 * @type { ?object } 1613 * @syscap SystemCapability.ArkUI.ArkUI.Full 1614 * @since 9 1615 * @form 1616 */ 1617 /** 1618 * The param of right align. 1619 * 1620 * @type { ?object } 1621 * @syscap SystemCapability.ArkUI.ArkUI.Full 1622 * @crossplatform 1623 * @since 10 1624 * @form 1625 */ 1626 right?: { anchor: string, align: HorizontalAlign }; 1627 1628 /** 1629 * The param of middle align. 1630 * 1631 * @type { ?object } 1632 * @syscap SystemCapability.ArkUI.ArkUI.Full 1633 * @since 9 1634 * @form 1635 */ 1636 /** 1637 * The param of middle align. 1638 * 1639 * @type { ?object } 1640 * @syscap SystemCapability.ArkUI.ArkUI.Full 1641 * @crossplatform 1642 * @since 10 1643 * @form 1644 */ 1645 middle?: { anchor: string, align: HorizontalAlign }; 1646 1647 /** 1648 * The param of top align. 1649 * 1650 * @type { ?object } 1651 * @syscap SystemCapability.ArkUI.ArkUI.Full 1652 * @since 9 1653 * @form 1654 */ 1655 /** 1656 * The param of top align. 1657 * 1658 * @type { ?object } 1659 * @syscap SystemCapability.ArkUI.ArkUI.Full 1660 * @crossplatform 1661 * @since 10 1662 * @form 1663 */ 1664 top?: { anchor: string, align: VerticalAlign }; 1665 1666 /** 1667 * The param of bottom align. 1668 * 1669 * @type { ?object } 1670 * @syscap SystemCapability.ArkUI.ArkUI.Full 1671 * @since 9 1672 * @form 1673 */ 1674 /** 1675 * The param of bottom align. 1676 * 1677 * @type { ?object } 1678 * @syscap SystemCapability.ArkUI.ArkUI.Full 1679 * @since 10 1680 * @form 1681 */ 1682 bottom?: { anchor: string, align: VerticalAlign }; 1683 1684 /** 1685 * The param of center align. 1686 * 1687 * @type { ?object } 1688 * @syscap SystemCapability.ArkUI.ArkUI.Full 1689 * @since 9 1690 * @form 1691 */ 1692 /** 1693 * The param of center align. 1694 * 1695 * @type { ?object } 1696 * @syscap SystemCapability.ArkUI.ArkUI.Full 1697 * @crossplatform 1698 * @since 10 1699 * @form 1700 */ 1701 center?: { anchor: string, align: VerticalAlign }; 1702} 1703 1704/** 1705 * The param of rotate. 1706 * 1707 * @interface RotateOptions 1708 * @syscap SystemCapability.ArkUI.ArkUI.Full 1709 * @since 7 1710 */ 1711/** 1712 * The param of rotate. 1713 * 1714 * @interface RotateOptions 1715 * @syscap SystemCapability.ArkUI.ArkUI.Full 1716 * @since 9 1717 * @form 1718 */ 1719/** 1720 * The param of rotate. 1721 * 1722 * @interface RotateOptions 1723 * @syscap SystemCapability.ArkUI.ArkUI.Full 1724 * @crossplatform 1725 * @since 10 1726 * @form 1727 */ 1728declare interface RotateOptions { 1729 /** 1730 * The param of x direction. 1731 * 1732 * @type { ?number } 1733 * @syscap SystemCapability.ArkUI.ArkUI.Full 1734 * @since 7 1735 */ 1736 /** 1737 * The param of x direction. 1738 * 1739 * @type { ?number } 1740 * @syscap SystemCapability.ArkUI.ArkUI.Full 1741 * @since 9 1742 * @form 1743 */ 1744 /** 1745 * The param of x direction. 1746 * 1747 * @type { ?number } 1748 * @syscap SystemCapability.ArkUI.ArkUI.Full 1749 * @crossplatform 1750 * @since 10 1751 * @form 1752 */ 1753 x?: number; 1754 1755 /** 1756 * The param of y direction. 1757 * 1758 * @type { ?number } 1759 * @syscap SystemCapability.ArkUI.ArkUI.Full 1760 * @since 7 1761 */ 1762 /** 1763 * The param of y direction. 1764 * 1765 * @type { ?number } 1766 * @syscap SystemCapability.ArkUI.ArkUI.Full 1767 * @since 9 1768 * @form 1769 */ 1770 /** 1771 * The param of y direction. 1772 * 1773 * @type { ?number } 1774 * @syscap SystemCapability.ArkUI.ArkUI.Full 1775 * @crossplatform 1776 * @since 10 1777 * @form 1778 */ 1779 y?: number; 1780 1781 /** 1782 * The param of z direction. 1783 * 1784 * @type { ?number } 1785 * @syscap SystemCapability.ArkUI.ArkUI.Full 1786 * @since 7 1787 */ 1788 /** 1789 * The param of z direction. 1790 * 1791 * @type { ?number } 1792 * @syscap SystemCapability.ArkUI.ArkUI.Full 1793 * @since 9 1794 * @form 1795 */ 1796 /** 1797 * The param of z direction. 1798 * 1799 * @type { ?number } 1800 * @syscap SystemCapability.ArkUI.ArkUI.Full 1801 * @crossplatform 1802 * @since 10 1803 * @form 1804 */ 1805 z?: number; 1806 1807 /** 1808 * The param of center point of x. 1809 * 1810 * @type { ?(number | string) } 1811 * @syscap SystemCapability.ArkUI.ArkUI.Full 1812 * @since 7 1813 */ 1814 /** 1815 * The param of center point of x. 1816 * 1817 * @type { ?(number | string) } 1818 * @syscap SystemCapability.ArkUI.ArkUI.Full 1819 * @since 9 1820 * @form 1821 */ 1822 /** 1823 * The param of center point of x. 1824 * 1825 * @type { ?(number | string) } 1826 * @syscap SystemCapability.ArkUI.ArkUI.Full 1827 * @crossplatform 1828 * @since 10 1829 * @form 1830 */ 1831 centerX?: number | string; 1832 1833 /** 1834 * The param of center point of y. 1835 * 1836 * @type { ?(number | string) } 1837 * @syscap SystemCapability.ArkUI.ArkUI.Full 1838 * @since 7 1839 */ 1840 /** 1841 * The param of center point of y. 1842 * 1843 * @type { ?(number | string) } 1844 * @syscap SystemCapability.ArkUI.ArkUI.Full 1845 * @since 9 1846 */ 1847 /** 1848 * The param of center point of y. 1849 * 1850 * @type { ?(number | string) } 1851 * @syscap SystemCapability.ArkUI.ArkUI.Full 1852 * @crossplatform 1853 * @since 10 1854 * @form 1855 */ 1856 centerY?: number | string; 1857 1858 /** 1859 * The param of center point of z. 1860 * 1861 * @type { ?number } 1862 * @default 0 1863 * @syscap SystemCapability.ArkUI.ArkUI.Full 1864 * @crossplatform 1865 * @since 10 1866 * @form 1867 */ 1868 centerZ?: number; 1869 1870 /** 1871 * The param of camera distance, value range (-∞, ∞). 1872 * @type { ?number } 1873 * @default 0 1874 * @syscap SystemCapability.ArkUI.ArkUI.Full 1875 * @crossplatform 1876 * @since 10 1877 * @form 1878 */ 1879 perspective?: number; 1880 1881 /** 1882 * The param of angle. 1883 * 1884 * @type { number | string } 1885 * @syscap SystemCapability.ArkUI.ArkUI.Full 1886 * @since 7 1887 */ 1888 /** 1889 * The param of angle. 1890 * 1891 * @type { number | string } 1892 * @syscap SystemCapability.ArkUI.ArkUI.Full 1893 * @since 9 1894 * @form 1895 */ 1896 /** 1897 * The param of angle. 1898 * 1899 * @type { number | string } 1900 * @syscap SystemCapability.ArkUI.ArkUI.Full 1901 * @crossplatform 1902 * @since 10 1903 * @form 1904 */ 1905 angle: number | string; 1906} 1907 1908/** 1909 * Defines the param of transition. 1910 * 1911 * @interface TransitionOptions 1912 * @syscap SystemCapability.ArkUI.ArkUI.Full 1913 * @since 7 1914 * @deprecated since 10 1915 * @useinstead TransitionEffect 1916 */ 1917declare interface TransitionOptions { 1918 /** 1919 * Defines the param of type. 1920 * 1921 * @type { ?TransitionType } 1922 * @syscap SystemCapability.ArkUI.ArkUI.Full 1923 * @since 7 1924 * @deprecated since 10 1925 */ 1926 type?: TransitionType; 1927 /** 1928 * Defines the param of opacity. 1929 * 1930 * @type { ?number } 1931 * @syscap SystemCapability.ArkUI.ArkUI.Full 1932 * @since 7 1933 * @deprecated since 10 1934 */ 1935 opacity?: number; 1936 /** 1937 * Defines the param of translate. 1938 * 1939 * @type { ?TranslateOptions } 1940 * @syscap SystemCapability.ArkUI.ArkUI.Full 1941 * @since 7 1942 * @deprecated since 10 1943 */ 1944 translate?: TranslateOptions; 1945 /** 1946 * Defines the param of scale. 1947 * 1948 * @type { ?ScaleOptions } 1949 * @syscap SystemCapability.ArkUI.ArkUI.Full 1950 * @since 7 1951 * @deprecated since 10 1952 */ 1953 scale?: ScaleOptions; 1954 /** 1955 * Defines the param of rotate. 1956 * 1957 * @type { ?RotateOptions } 1958 * @syscap SystemCapability.ArkUI.ArkUI.Full 1959 * @since 7 1960 * @deprecated since 10 1961 */ 1962 rotate?: RotateOptions; 1963} 1964 1965/** 1966 * Defines the Edge object. 1967 * 1968 * @enum { number } 1969 * @syscap SystemCapability.ArkUI.ArkUI.Full 1970 * @crossplatform 1971 * @since 10 1972 * @form 1973 */ 1974declare enum TransitionEdge { 1975 /** 1976 * Top edge 1977 * 1978 * @syscap SystemCapability.ArkUI.ArkUI.Full 1979 * @crossplatform 1980 * @since 10 1981 * @form 1982 */ 1983 TOP, 1984 1985 /** 1986 * Bottom edge 1987 * 1988 * @syscap SystemCapability.ArkUI.ArkUI.Full 1989 * @crossplatform 1990 * @since 10 1991 * @form 1992 */ 1993 BOTTOM, 1994 1995 /** 1996 * Start edge 1997 * 1998 * @syscap SystemCapability.ArkUI.ArkUI.Full 1999 * @crossplatform 2000 * @since 10 2001 * @form 2002 */ 2003 START, 2004 2005 /** 2006 * End edge 2007 * 2008 * @syscap SystemCapability.ArkUI.ArkUI.Full 2009 * @crossplatform 2010 * @since 10 2011 * @form 2012 */ 2013 END 2014} 2015 2016/** 2017 * Defines all transition effects. 2018 * 2019 * @syscap SystemCapability.ArkUI.ArkUI.Full 2020 * @crossplatform 2021 * @since 10 2022 * @form 2023 */ 2024declare type TransitionEffects = { 2025 identity: undefined; 2026 opacity: number; 2027 slideSwitch: undefined; 2028 move: TransitionEdge; 2029 translate: TranslateOptions; 2030 rotate: RotateOptions; 2031 scale: ScaleOptions; 2032 asymmetric: { 2033 appear: TransitionEffect; 2034 disappear: TransitionEffect; 2035 }; 2036}; 2037 2038/** 2039 * Defines the transition effect 2040 * 2041 * @syscap SystemCapability.ArkUI.ArkUI.Full 2042 * @crossplatform 2043 * @since 10 2044 * @form 2045 */ 2046declare class TransitionEffect< 2047 Type extends keyof TransitionEffects = keyof TransitionEffects, 2048 Effect extends TransitionEffects[Type] = TransitionEffects[Type] 2049> { 2050 /** 2051 * Defines an identity transition effect 2052 * 2053 * @constant 2054 * @type { TransitionEffect<"identity"> } 2055 * @syscap SystemCapability.ArkUI.ArkUI.Full 2056 * @crossplatform 2057 * @since 10 2058 * @form 2059 */ 2060 static readonly IDENTITY: TransitionEffect<"identity">; 2061 2062 /** 2063 * Defines an opacity transition effect 2064 * 2065 * @constant 2066 * @type { TransitionEffect<"opacity"> } 2067 * @syscap SystemCapability.ArkUI.ArkUI.Full 2068 * @crossplatform 2069 * @since 10 2070 * @form 2071 */ 2072 static readonly OPACITY: TransitionEffect<"opacity">; 2073 2074 /** 2075 * Defines a slide transition effect 2076 * 2077 * @constant 2078 * @type { TransitionEffect< 2079 * "asymmetric", 2080 * {appear: TransitionEffect<"move", TransitionEdge>; 2081 * disappear: TransitionEffect<"move", TransitionEdge>; 2082 * }> } 2083 * @syscap SystemCapability.ArkUI.ArkUI.Full 2084 * @crossplatform 2085 * @since 10 2086 * @form 2087 */ 2088 static readonly SLIDE: TransitionEffect< 2089 "asymmetric", 2090 { 2091 appear: TransitionEffect<"move", TransitionEdge>; 2092 disappear: TransitionEffect<"move", TransitionEdge>; 2093 } 2094 >; 2095 2096 /** 2097 * Defines a slide & switch transition effect 2098 * 2099 * @constant 2100 * @type { TransitionEffect<"slideSwitch"> } 2101 * @syscap SystemCapability.ArkUI.ArkUI.Full 2102 * @crossplatform 2103 * @since 10 2104 * @form 2105 */ 2106 static readonly SLIDE_SWITCH: TransitionEffect<"slideSwitch">; 2107 2108 /** 2109 * Creates a translate transition effect 2110 * 2111 * @param { TranslateOptions } options - translate options 2112 * @returns { TransitionEffect<"translate"> } 2113 * @syscap SystemCapability.ArkUI.ArkUI.Full 2114 * @crossplatform 2115 * @since 10 2116 * @form 2117 */ 2118 static translate(options: TranslateOptions): TransitionEffect<"translate">; 2119 2120 /** 2121 * Creates a rotation transition effect 2122 * 2123 * @param { RotateOptions } options - rotate options 2124 * @returns { TransitionEffect<"rotate"> } 2125 * @syscap SystemCapability.ArkUI.ArkUI.Full 2126 * @crossplatform 2127 * @since 10 2128 * @form 2129 */ 2130 static rotate(options: RotateOptions): TransitionEffect<"rotate">; 2131 2132 /** 2133 * Creates a scale transition effect 2134 * 2135 * @param { ScaleOptions } options - scale options 2136 * @returns { TransitionEffect<"scale"> } 2137 * @syscap SystemCapability.ArkUI.ArkUI.Full 2138 * @crossplatform 2139 * @since 10 2140 * @form 2141 */ 2142 static scale(options: ScaleOptions): TransitionEffect<"scale">; 2143 2144 /** 2145 * Creates an opacity transition effect with alpha value 2146 * 2147 * @param { number } alpha - opacity alpha value 2148 * @returns { TransitionEffect<"opacity"> } 2149 * @syscap SystemCapability.ArkUI.ArkUI.Full 2150 * @crossplatform 2151 * @since 10 2152 * @form 2153 */ 2154 static opacity(alpha: number): TransitionEffect<"opacity">; 2155 2156 /** 2157 * Creates a move transition effect 2158 * 2159 * @param { TransitionEdge } edge - the edge that component will move to 2160 * @returns { TransitionEffect<"move"> } 2161 * @syscap SystemCapability.ArkUI.ArkUI.Full 2162 * @crossplatform 2163 * @since 10 2164 * @form 2165 */ 2166 static move(edge: TransitionEdge): TransitionEffect<"move">; 2167 2168 /** 2169 * Creates an asymmetric transition effect 2170 * 2171 * @param { TransitionEffect } appear - the transition which will be attached when the component is appear 2172 * @param { TransitionEffect } disappear - the transition which will be attached when the component is disappear 2173 * @returns { TransitionEffect<"asymmetric"> } 2174 * @syscap SystemCapability.ArkUI.ArkUI.Full 2175 * @crossplatform 2176 * @since 10 2177 * @form 2178 */ 2179 static asymmetric( 2180 appear: TransitionEffect, 2181 disappear: TransitionEffect 2182 ): TransitionEffect<"asymmetric">; 2183 2184 /** 2185 * TransitionEffect constructor 2186 * 2187 * @param { Type } type - transition type 2188 * @param { Effect } effect - transition options 2189 * @syscap SystemCapability.ArkUI.ArkUI.Full 2190 * @crossplatform 2191 * @since 10 2192 * @form 2193 */ 2194 constructor(type: Type, effect: Effect); 2195 2196 /** 2197 * Set the animation of current transition effect 2198 * 2199 * @param { AnimateParam } value - animation parameters 2200 * @returns { TransitionEffect } 2201 * @syscap SystemCapability.ArkUI.ArkUI.Full 2202 * @crossplatform 2203 * @since 10 2204 * @form 2205 */ 2206 animation(value: AnimateParam): TransitionEffect; 2207 2208 /** 2209 * Combines another transition effect 2210 * 2211 * @param { TransitionEffect } transitionEffect - transition effect which is be combined 2212 * @returns { TransitionEffect } combined transition effect 2213 * @syscap SystemCapability.ArkUI.ArkUI.Full 2214 * @crossplatform 2215 * @since 10 2216 * @form 2217 */ 2218 combine(transitionEffect: TransitionEffect): TransitionEffect; 2219} 2220 2221/** 2222 * Define Preview property 2223 * 2224 * @interface PreviewParams 2225 * @syscap SystemCapability.ArkUI.ArkUI.Full 2226 * @since 9 2227 * @form 2228 */ 2229interface PreviewParams { 2230 /** 2231 * Define Preview title 2232 * 2233 * @type { ?string } 2234 * @syscap SystemCapability.ArkUI.ArkUI.Full 2235 * @since 9 2236 * @form 2237 */ 2238 title?: string; 2239 2240 /** 2241 * Define Preview width 2242 * 2243 * @type { ?number } 2244 * @syscap SystemCapability.ArkUI.ArkUI.Full 2245 * @since 9 2246 * @form 2247 */ 2248 width?: number; 2249 2250 /** 2251 * Define Preview height 2252 * 2253 * @type { ?number } 2254 * @syscap SystemCapability.ArkUI.ArkUI.Full 2255 * @since 9 2256 * @form 2257 */ 2258 height?: number; 2259 2260 /** 2261 * Define Preview locale 2262 * 2263 * @type { ?string } 2264 * @syscap SystemCapability.ArkUI.ArkUI.Full 2265 * @since 9 2266 * @form 2267 */ 2268 locale?: string; 2269 2270 /** 2271 * Define Preview colorMode 2272 * 2273 * @type { ?string } 2274 * @syscap SystemCapability.ArkUI.ArkUI.Full 2275 * @since 9 2276 * @form 2277 */ 2278 colorMode?: string; 2279 2280 /** 2281 * Define Preview deviceType 2282 * 2283 * @type { ?string } 2284 * @syscap SystemCapability.ArkUI.ArkUI.Full 2285 * @since 9 2286 * @form 2287 */ 2288 deviceType?: string; 2289 2290 /** 2291 * Define Preview dpi 2292 * 2293 * @type { ?number } 2294 * @syscap SystemCapability.ArkUI.ArkUI.Full 2295 * @since 9 2296 * @form 2297 */ 2298 dpi?: number; 2299 2300 /** 2301 * Define Preview orientation 2302 * 2303 * @type { ?string } 2304 * @syscap SystemCapability.ArkUI.ArkUI.Full 2305 * @since 9 2306 * @form 2307 */ 2308 orientation?: string; 2309 2310 /** 2311 * Define Preview roundScreen 2312 * 2313 * @type { ?boolean } 2314 * @syscap SystemCapability.ArkUI.ArkUI.Full 2315 * @since 9 2316 * @form 2317 */ 2318 roundScreen?: boolean; 2319} 2320 2321/** 2322 * ItemDragInfo object description 2323 * 2324 * @interface ItemDragInfo 2325 * @syscap SystemCapability.ArkUI.ArkUI.Full 2326 * @since 8 2327 */ 2328/** 2329 * ItemDragInfo object description 2330 * 2331 * @interface ItemDragInfo 2332 * @syscap SystemCapability.ArkUI.ArkUI.Full 2333 * @crossplatform 2334 * @since 10 2335 */ 2336declare interface ItemDragInfo { 2337 /** 2338 * Obtains the X coordinate of the drag window, in vp. 2339 * 2340 * @type { number } 2341 * @syscap SystemCapability.ArkUI.ArkUI.Full 2342 * @since 8 2343 */ 2344 /** 2345 * Obtains the X coordinate of the drag window, in vp. 2346 * 2347 * @type { number } 2348 * @syscap SystemCapability.ArkUI.ArkUI.Full 2349 * @crossplatform 2350 * @since 10 2351 */ 2352 x: number; 2353 2354 /** 2355 * Obtains the Y coordinate of the drag window, in vp. 2356 * 2357 * @type { number } 2358 * @syscap SystemCapability.ArkUI.ArkUI.Full 2359 * @since 8 2360 */ 2361 /** 2362 * Obtains the Y coordinate of the drag window, in vp. 2363 * 2364 * @type { number } 2365 * @syscap SystemCapability.ArkUI.ArkUI.Full 2366 * @crossplatform 2367 * @since 10 2368 */ 2369 y: number; 2370} 2371 2372/** 2373 * DragItemInfo object description 2374 * 2375 * @interface DragItemInfo 2376 * @syscap SystemCapability.ArkUI.ArkUI.Full 2377 * @since 8 2378 */ 2379declare interface DragItemInfo { 2380 /** 2381 * Uses the pixelMap object for drawing. 2382 * 2383 * @type { ?PixelMap } 2384 * @syscap SystemCapability.ArkUI.ArkUI.Full 2385 * @since 8 2386 */ 2387 pixelMap?: PixelMap; 2388 2389 /** 2390 * Uses the custom builder for drawing, if pixelMap is set, this value is ignored. 2391 * 2392 * @type { ?CustomBuilder } 2393 * @syscap SystemCapability.ArkUI.ArkUI.Full 2394 * @since 8 2395 */ 2396 builder?: CustomBuilder; 2397 2398 /** 2399 * Sets the extra info for drag event. 2400 * 2401 * @type { ?string } 2402 * @syscap SystemCapability.ArkUI.ArkUI.Full 2403 * @since 8 2404 */ 2405 extraInfo?: string; 2406} 2407 2408/** 2409 * Defining animation function. 2410 * 2411 * @param { AnimateParam } value 2412 * @param { function } event 2413 * @syscap SystemCapability.ArkUI.ArkUI.Full 2414 * @since 7 2415 */ 2416/** 2417 * Defining animation function. 2418 * 2419 * @param { AnimateParam } value 2420 * @param { function } event 2421 * @syscap SystemCapability.ArkUI.ArkUI.Full 2422 * @since 9 2423 * @form 2424 */ 2425/** 2426 * Defining animation function. 2427 * 2428 * @param { AnimateParam } value 2429 * @param { function } event 2430 * @syscap SystemCapability.ArkUI.ArkUI.Full 2431 * @crossplatform 2432 * @since 10 2433 * @form 2434 */ 2435declare function animateTo(value: AnimateParam, event: () => void): void; 2436 2437/** 2438 * Converts a value in vp units to a value in px. 2439 * 2440 * @param { number } value 2441 * @returns { number } 2442 * @syscap SystemCapability.ArkUI.ArkUI.Full 2443 * @since 7 2444 */ 2445/** 2446 * Converts a value in vp units to a value in px. 2447 * 2448 * @param { number } value 2449 * @returns { number } 2450 * @syscap SystemCapability.ArkUI.ArkUI.Full 2451 * @since 9 2452 * @form 2453 */ 2454/** 2455 * Converts a value in vp units to a value in px. 2456 * 2457 * @param { number } value 2458 * @returns { number } 2459 * @syscap SystemCapability.ArkUI.ArkUI.Full 2460 * @crossplatform 2461 * @since 10 2462 * @form 2463 */ 2464declare function vp2px(value: number): number; 2465 2466/** 2467 * Converts a number in units of px to a number in units of vp. 2468 * 2469 * @param { number } value 2470 * @returns { number } 2471 * @syscap SystemCapability.ArkUI.ArkUI.Full 2472 * @since 7 2473 */ 2474/** 2475 * Converts a number in units of px to a number in units of vp. 2476 * 2477 * @param { number } value 2478 * @returns { number } 2479 * @syscap SystemCapability.ArkUI.ArkUI.Full 2480 * @since 9 2481 * @form 2482 */ 2483/** 2484 * Converts a number in units of px to a number in units of vp. 2485 * 2486 * @param { number } value 2487 * @returns { number } 2488 * @syscap SystemCapability.ArkUI.ArkUI.Full 2489 * @crossplatform 2490 * @since 10 2491 * @form 2492 */ 2493declare function px2vp(value: number): number; 2494 2495/** 2496 * Converts a number in fp units to a number in px. 2497 * 2498 * @param { number } value 2499 * @returns { number } 2500 * @syscap SystemCapability.ArkUI.ArkUI.Full 2501 * @since 7 2502 */ 2503/** 2504 * Converts a number in fp units to a number in px. 2505 * 2506 * @param { number } value 2507 * @returns { number } 2508 * @syscap SystemCapability.ArkUI.ArkUI.Full 2509 * @since 9 2510 * @form 2511 */ 2512/** 2513 * Converts a number in fp units to a number in px. 2514 * 2515 * @param { number } value 2516 * @returns { number } 2517 * @syscap SystemCapability.ArkUI.ArkUI.Full 2518 * @crossplatform 2519 * @since 10 2520 * @form 2521 */ 2522declare function fp2px(value: number): number; 2523 2524/** 2525 * Converts a number in units of px to a number in units of fp. 2526 * 2527 * @param { number } value 2528 * @returns { number } 2529 * @syscap SystemCapability.ArkUI.ArkUI.Full 2530 * @since 7 2531 */ 2532/** 2533 * Converts a number in units of px to a number in units of fp. 2534 * 2535 * @param { number } value 2536 * @returns { number } 2537 * @syscap SystemCapability.ArkUI.ArkUI.Full 2538 * @since 9 2539 * @form 2540 */ 2541/** 2542 * Converts a number in units of px to a number in units of fp. 2543 * 2544 * @param { number } value 2545 * @returns { number } 2546 * @syscap SystemCapability.ArkUI.ArkUI.Full 2547 * @crossplatform 2548 * @since 10 2549 * @form 2550 */ 2551declare function px2fp(value: number): number; 2552 2553/** 2554 * Converts a number in units of lpx to a number in units of px. 2555 * 2556 * @param { number } value 2557 * @returns { number } 2558 * @syscap SystemCapability.ArkUI.ArkUI.Full 2559 * @since 7 2560 */ 2561/** 2562 * Converts a number in units of lpx to a number in units of px. 2563 * 2564 * @param { number } value 2565 * @returns { number } 2566 * @syscap SystemCapability.ArkUI.ArkUI.Full 2567 * @since 9 2568 * @form 2569 */ 2570/** 2571 * Converts a number in units of lpx to a number in units of px. 2572 * 2573 * @param { number } value 2574 * @returns { number } 2575 * @syscap SystemCapability.ArkUI.ArkUI.Full 2576 * @crossplatform 2577 * @since 10 2578 * @form 2579 */ 2580declare function lpx2px(value: number): number; 2581 2582/** 2583 * Converts a number in units of px to a number in units of lpx. 2584 * 2585 * @param { number } value 2586 * @returns { number } 2587 * @syscap SystemCapability.ArkUI.ArkUI.Full 2588 * @since 7 2589 */ 2590/** 2591 * Converts a number in units of px to a number in units of lpx. 2592 * 2593 * @param { number } value 2594 * @returns { number } 2595 * @syscap SystemCapability.ArkUI.ArkUI.Full 2596 * @since 9 2597 * @form 2598 */ 2599/** 2600 * Converts a number in units of px to a number in units of lpx. 2601 * 2602 * @param { number } value 2603 * @returns { number } 2604 * @syscap SystemCapability.ArkUI.ArkUI.Full 2605 * @crossplatform 2606 * @since 10 2607 * @form 2608 */ 2609declare function px2lpx(value: number): number; 2610 2611declare namespace focusControl { 2612 /** 2613 * Request focus to the specific component by param: 'id/key'. 2614 * 2615 * @param { string } value 2616 * @returns { boolean } 2617 * @syscap SystemCapability.ArkUI.ArkUI.Full 2618 * @since 9 2619 */ 2620 /** 2621 * Request focus to the specific component by param: 'id/key'. 2622 * 2623 * @param { string } value 2624 * @returns { boolean } 2625 * @syscap SystemCapability.ArkUI.ArkUI.Full 2626 * @crossplatform 2627 * @since 10 2628 */ 2629 function requestFocus(value: string): boolean; 2630} 2631 2632/** 2633 * Defines the event target. 2634 * 2635 * @interface EventTarget 2636 * @syscap SystemCapability.ArkUI.ArkUI.Full 2637 * @since 8 2638 */ 2639/** 2640 * Defines the event target. 2641 * 2642 * @interface EventTarget 2643 * @syscap SystemCapability.ArkUI.ArkUI.Full 2644 * @since 9 2645 * @form 2646 */ 2647/** 2648 * Defines the event target. 2649 * 2650 * @interface EventTarget 2651 * @syscap SystemCapability.ArkUI.ArkUI.Full 2652 * @crossplatform 2653 * @since 10 2654 * @form 2655 */ 2656declare interface EventTarget { 2657 /** 2658 * Area of current target. 2659 * 2660 * @type { Area } 2661 * @syscap SystemCapability.ArkUI.ArkUI.Full 2662 * @since 8 2663 */ 2664 /** 2665 * Area of current target. 2666 * 2667 * @type { Area } 2668 * @syscap SystemCapability.ArkUI.ArkUI.Full 2669 * @since 9 2670 * @form 2671 */ 2672 /** 2673 * Area of current target. 2674 * 2675 * @type { Area } 2676 * @syscap SystemCapability.ArkUI.ArkUI.Full 2677 * @crossplatform 2678 * @since 10 2679 * @form 2680 */ 2681 area: Area; 2682} 2683 2684/** 2685 * Defines the event source type. 2686 * 2687 * @enum { number } 2688 * @syscap SystemCapability.ArkUI.ArkUI.Full 2689 * @since 8 2690 */ 2691/** 2692 * Defines the event source type. 2693 * 2694 * @enum { number } 2695 * @syscap SystemCapability.ArkUI.ArkUI.Full 2696 * @crossplatform 2697 * @since 10 2698 */ 2699declare enum SourceType { 2700 /** 2701 * Unknown type. 2702 * 2703 * @syscap SystemCapability.ArkUI.ArkUI.Full 2704 * @since 8 2705 */ 2706 /** 2707 * Unknown type. 2708 * 2709 * @syscap SystemCapability.ArkUI.ArkUI.Full 2710 * @crossplatform 2711 * @since 10 2712 */ 2713 Unknown, 2714 2715 /** 2716 * The mouse type. 2717 * 2718 * @syscap SystemCapability.ArkUI.ArkUI.Full 2719 * @since 8 2720 */ 2721 /** 2722 * The mouse type. 2723 * 2724 * @syscap SystemCapability.ArkUI.ArkUI.Full 2725 * @crossplatform 2726 * @since 10 2727 */ 2728 Mouse, 2729 2730 /** 2731 * The touch screen type. 2732 * 2733 * @syscap SystemCapability.ArkUI.ArkUI.Full 2734 * @since 8 2735 */ 2736 /** 2737 * The touch screen type. 2738 * 2739 * @syscap SystemCapability.ArkUI.ArkUI.Full 2740 * @crossplatform 2741 * @since 10 2742 */ 2743 TouchScreen, 2744} 2745 2746/** 2747 * Defines the event tool type. 2748 * 2749 * @enum { number } 2750 * @syscap SystemCapability.ArkUI.ArkUI.Full 2751 * @since 9 2752 */ 2753/** 2754 * Defines the event tool type. 2755 * 2756 * @enum { number } 2757 * @syscap SystemCapability.ArkUI.ArkUI.Full 2758 * @crossplatform 2759 * @since 10 2760 */ 2761declare enum SourceTool { 2762 /** 2763 * Unknown type. 2764 * 2765 * @syscap SystemCapability.ArkUI.ArkUI.Full 2766 * @since 9 2767 */ 2768 /** 2769 * Unknown type. 2770 * 2771 * @syscap SystemCapability.ArkUI.ArkUI.Full 2772 * @crossplatform 2773 * @since 10 2774 */ 2775 Unknown, 2776 2777 /** 2778 * The finger type. 2779 * 2780 * @syscap SystemCapability.ArkUI.ArkUI.Full 2781 * @since 9 2782 */ 2783 /** 2784 * The finger type. 2785 * 2786 * @syscap SystemCapability.ArkUI.ArkUI.Full 2787 * @crossplatform 2788 * @since 10 2789 */ 2790 Finger, 2791 2792 /** 2793 * The pen type. 2794 * 2795 * @syscap SystemCapability.ArkUI.ArkUI.Full 2796 * @since 9 2797 */ 2798 /** 2799 * The pen type. 2800 * 2801 * @syscap SystemCapability.ArkUI.ArkUI.Full 2802 * @crossplatform 2803 * @since 10 2804 */ 2805 Pen, 2806} 2807 2808/** 2809 * Defines the Border Image Repeat Mode. 2810 * 2811 * @enum { number } 2812 * @syscap SystemCapability.ArkUI.ArkUI.Full 2813 * @since 9 2814 * @form 2815 */ 2816/** 2817 * Defines the Border Image Repeat Mode. 2818 * 2819 * @enum { number } 2820 * @syscap SystemCapability.ArkUI.ArkUI.Full 2821 * @crossplatform 2822 * @since 10 2823 * @form 2824 */ 2825declare enum RepeatMode { 2826 /** 2827 * Repeat mode. 2828 * 2829 * @syscap SystemCapability.ArkUI.ArkUI.Full 2830 * @since 9 2831 * @form 2832 */ 2833 /** 2834 * Repeat mode. 2835 * 2836 * @syscap SystemCapability.ArkUI.ArkUI.Full 2837 * @crossplatform 2838 * @since 10 2839 * @form 2840 */ 2841 Repeat, 2842 2843 /** 2844 * Stretch mode. 2845 * 2846 * @syscap SystemCapability.ArkUI.ArkUI.Full 2847 * @since 9 2848 * @form 2849 */ 2850 /** 2851 * Stretch mode. 2852 * 2853 * @syscap SystemCapability.ArkUI.ArkUI.Full 2854 * @crossplatform 2855 * @since 10 2856 * @form 2857 */ 2858 Stretch, 2859 2860 /** 2861 * Round mode. 2862 * 2863 * @syscap SystemCapability.ArkUI.ArkUI.Full 2864 * @since 9 2865 * @form 2866 */ 2867 /** 2868 * Round mode. 2869 * 2870 * @syscap SystemCapability.ArkUI.ArkUI.Full 2871 * @crossplatform 2872 * @since 10 2873 * @form 2874 */ 2875 Round, 2876 2877 /** 2878 * Space mode. 2879 * 2880 * @syscap SystemCapability.ArkUI.ArkUI.Full 2881 * @since 9 2882 * @form 2883 */ 2884 /** 2885 * Space mode. 2886 * 2887 * @syscap SystemCapability.ArkUI.ArkUI.Full 2888 * @crossplatform 2889 * @since 10 2890 * @form 2891 */ 2892 Space, 2893} 2894 2895/** 2896 * enum Blur style 2897 * 2898 * @enum { number } 2899 * @syscap SystemCapability.ArkUI.ArkUI.Full 2900 * @since 9 2901 * @form 2902 */ 2903/** 2904 * enum Blur style 2905 * 2906 * @enum { number } 2907 * @syscap SystemCapability.ArkUI.ArkUI.Full 2908 * @crossplatform 2909 * @since 10 2910 * @form 2911 */ 2912declare enum BlurStyle { 2913 /** 2914 * Defines the thin card material. 2915 * 2916 * @syscap SystemCapability.ArkUI.ArkUI.Full 2917 * @since 9 2918 * @form 2919 */ 2920 /** 2921 * Defines the thin card material. 2922 * 2923 * @syscap SystemCapability.ArkUI.ArkUI.Full 2924 * @crossplatform 2925 * @since 10 2926 * @form 2927 */ 2928 Thin, 2929 2930 /** 2931 * Defines the regular card material. 2932 * 2933 * @syscap SystemCapability.ArkUI.ArkUI.Full 2934 * @since 9 2935 * @form 2936 */ 2937 /** 2938 * Defines the regular card material. 2939 * 2940 * @syscap SystemCapability.ArkUI.ArkUI.Full 2941 * @crossplatform 2942 * @since 10 2943 * @form 2944 */ 2945 Regular, 2946 2947 /** 2948 * Defines the thick card material. 2949 * 2950 * @syscap SystemCapability.ArkUI.ArkUI.Full 2951 * @since 9 2952 * @form 2953 */ 2954 /** 2955 * Defines the thick card material. 2956 * 2957 * @syscap SystemCapability.ArkUI.ArkUI.Full 2958 * @crossplatform 2959 * @since 10 2960 * @form 2961 */ 2962 Thick, 2963 2964 /** 2965 * Defines the thin background material. 2966 * 2967 * @syscap SystemCapability.ArkUI.ArkUI.Full 2968 * @crossplatform 2969 * @since 10 2970 */ 2971 BACKGROUND_THIN, 2972 2973 /** 2974 * Defines the thin regular material. 2975 * 2976 * @syscap SystemCapability.ArkUI.ArkUI.Full 2977 * @crossplatform 2978 * @since 10 2979 */ 2980 BACKGROUND_REGULAR, 2981 2982 /** 2983 * Defines the thin thick material. 2984 * 2985 * @syscap SystemCapability.ArkUI.ArkUI.Full 2986 * @crossplatform 2987 * @since 10 2988 */ 2989 BACKGROUND_THICK, 2990 2991 /** 2992 * Defines the thin ultra thick material. 2993 * 2994 * @syscap SystemCapability.ArkUI.ArkUI.Full 2995 * @crossplatform 2996 * @since 10 2997 */ 2998 BACKGROUND_ULTRA_THICK, 2999 3000 /** 3001 * Defines none material. 3002 * 3003 * @syscap SystemCapability.ArkUI.ArkUI.Full 3004 * @crossplatform 3005 * @since 10 3006 * @form 3007 */ 3008 NONE, 3009} 3010 3011/** 3012 * enum color mode 3013 * 3014 * @enum { number } 3015 * @syscap SystemCapability.ArkUI.ArkUI.Full 3016 * @crossplatform 3017 * @since 10 3018 */ 3019declare enum ThemeColorMode { 3020 /** 3021 * Defines the mode which is follow up with system. 3022 * 3023 * @syscap SystemCapability.ArkUI.ArkUI.Full 3024 * @crossplatform 3025 * @since 10 3026 */ 3027 SYSTEM, 3028 3029 /** 3030 * Defines the light mode. 3031 * 3032 * @syscap SystemCapability.ArkUI.ArkUI.Full 3033 * @crossplatform 3034 * @since 10 3035 */ 3036 LIGHT, 3037 3038 /** 3039 * Defines the dark mode. 3040 * 3041 * @syscap SystemCapability.ArkUI.ArkUI.Full 3042 * @crossplatform 3043 * @since 10 3044 */ 3045 DARK, 3046} 3047 3048/** 3049 * Defines adaptive color 3050 * 3051 * @enum { number } 3052 * @syscap SystemCapability.ArkUI.ArkUI.Full 3053 * @crossplatform 3054 * @since 10 3055 */ 3056declare enum AdaptiveColor { 3057 /** 3058 * Defines the fixed value color adaptive mode. 3059 * 3060 * @syscap SystemCapability.ArkUI.ArkUI.Full 3061 * @crossplatform 3062 * @since 10 3063 */ 3064 DEFAULT, 3065 3066 /** 3067 * Defines the background average color adaptive mode. 3068 * 3069 * @syscap SystemCapability.ArkUI.ArkUI.Full 3070 * @crossplatform 3071 * @since 10 3072 */ 3073 AVERAGE, 3074} 3075 3076/** 3077 * Defines modal transition type. 3078 * 3079 * @enum { number } 3080 * @syscap SystemCapability.ArkUI.ArkUI.Full 3081 * @crossplatform 3082 * @since 10 3083 */ 3084declare enum ModalTransition { 3085 /** 3086 * Use default animation. 3087 * 3088 * @syscap SystemCapability.ArkUI.ArkUI.Full 3089 * @crossplatform 3090 * @since 10 3091 */ 3092 DEFAULT, 3093 3094 /** 3095 * Use none animation. 3096 * 3097 * @syscap SystemCapability.ArkUI.ArkUI.Full 3098 * @crossplatform 3099 * @since 10 3100 */ 3101 NONE, 3102 3103 /** 3104 * Use alpha animation. 3105 * 3106 * @syscap SystemCapability.ArkUI.ArkUI.Full 3107 * @crossplatform 3108 * @since 10 3109 */ 3110 ALPHA, 3111} 3112 3113/** 3114 * Defines the options of backgroundBlurStyle 3115 * 3116 * @interface BackgroundBlurStyleOptions 3117 * @syscap SystemCapability.ArkUI.ArkUI.Full 3118 * @crossplatform 3119 * @since 10 3120 */ 3121declare interface BackgroundBlurStyleOptions extends BlurStyleOptions {} 3122 3123/** 3124 * Defines the options of ForegroundBlurStyle 3125 * 3126 * @interface ForegroundBlurStyleOptions 3127 * @syscap SystemCapability.ArkUI.ArkUI.Full 3128 * @crossplatform 3129 * @since 10 3130 */ 3131declare interface ForegroundBlurStyleOptions extends BlurStyleOptions {} 3132 3133/** 3134 * Defines the options of blurStyle 3135 * 3136 * @interface BlurStyleOptions 3137 * @syscap SystemCapability.ArkUI.ArkUI.Full 3138 * @crossplatform 3139 * @since 10 3140 */ 3141declare interface BlurStyleOptions { 3142 /** 3143 * color mode 3144 * 3145 * @type { ?ThemeColorMode } 3146 * @default ThemeColorMode.SYSTEM 3147 * @syscap SystemCapability.ArkUI.ArkUI.Full 3148 * @since 10 3149 */ 3150 colorMode?: ThemeColorMode; 3151 3152 /** 3153 * adaptive color 3154 * 3155 * @type { ?AdaptiveColor } 3156 * @default AdaptiveColor.DEFAULT 3157 * @syscap SystemCapability.ArkUI.ArkUI.Full 3158 * @since 10 3159 */ 3160 adaptiveColor?: AdaptiveColor; 3161 3162 /** 3163 * Define the scale of blur effect. 3164 * The range of value is [0, 1]. The larger the value, the more obvious the blurring effect. 3165 * A value of 0 indicates no blur effect and a value of 1 indicates a complete blur effect. 3166 * 3167 * @type { ?number } 3168 * @default 1.0 3169 * @syscap SystemCapability.ArkUI.ArkUI.Full 3170 * @systemapi 3171 * @since 10 3172 */ 3173 scale?: number; 3174} 3175 3176/** 3177 * Provide an interface for the text style of picker 3178 * 3179 * @interface PickerTextStyle 3180 * @syscap SystemCapability.ArkUI.ArkUI.Full 3181 * @crossplatform 3182 * @since 10 3183 */ 3184declare interface PickerTextStyle { 3185 /** 3186 * Define the text color of picker. 3187 * 3188 * @type { ?ResourceColor } 3189 * @syscap SystemCapability.ArkUI.ArkUI.Full 3190 * @crossplatform 3191 * @since 10 3192 */ 3193 color?: ResourceColor; 3194 3195 /** 3196 * Define the text font of picker. 3197 * Only support size and weight. 3198 * 3199 * @type { ?Font } 3200 * @syscap SystemCapability.ArkUI.ArkUI.Full 3201 * @crossplatform 3202 * @since 10 3203 */ 3204 font?: Font; 3205} 3206 3207/** 3208 * Define the type of shadow 3209 * 3210 * @enum { number } 3211 * @syscap SystemCapability.ArkUI.ArkUI.Full 3212 * @crossplatform 3213 * @since 10 3214 */ 3215declare enum ShadowType { 3216 /** 3217 * Define a color type of shadow 3218 * 3219 * @syscap SystemCapability.ArkUI.ArkUI.Full 3220 * @crossplatform 3221 * @since 10 3222 */ 3223 COLOR, 3224 3225 /** 3226 * Define a blur type of shadow 3227 * 3228 * @syscap SystemCapability.ArkUI.ArkUI.Full 3229 * @crossplatform 3230 * @since 10 3231 */ 3232 BLUR, 3233} 3234 3235/** 3236 * Define the options of shadow 3237 * 3238 * @interface ShadowOptions 3239 * @syscap SystemCapability.ArkUI.ArkUI.Full 3240 * @since 7 3241 */ 3242/** 3243 * Define the options of shadow 3244 * 3245 * @interface ShadowOptions 3246 * @syscap SystemCapability.ArkUI.ArkUI.Full 3247 * @since 9 3248 * @form 3249 */ 3250/** 3251 * Define the options of shadow 3252 * 3253 * @interface ShadowOptions 3254 * @syscap SystemCapability.ArkUI.ArkUI.Full 3255 * @crossplatform 3256 * @since 10 3257 * @form 3258 */ 3259declare interface ShadowOptions { 3260 /** 3261 * Define the radius size of shadow 3262 * 3263 * @type { number | Resource } 3264 * @syscap SystemCapability.ArkUI.ArkUI.Full 3265 * @since 7 3266 */ 3267 /** 3268 * Define the radius size of shadow 3269 * 3270 * @type { number | Resource } 3271 * @syscap SystemCapability.ArkUI.ArkUI.Full 3272 * @since 9 3273 * @form 3274 */ 3275 /** 3276 * Define the radius size of shadow 3277 * 3278 * @type { number | Resource } 3279 * @syscap SystemCapability.ArkUI.ArkUI.Full 3280 * @crossplatform 3281 * @since 10 3282 * @form 3283 */ 3284 radius: number | Resource; 3285 3286 /** 3287 * Define the type of shadow 3288 * 3289 * @type { ?ShadowType } 3290 * @default ShadowType.COLOR 3291 * @syscap SystemCapability.ArkUI.ArkUI.Full 3292 * @crossplatform 3293 * @since 10 3294 */ 3295 type?: ShadowType; 3296 3297 /** 3298 * Define the color of shadow 3299 * 3300 * @type { ?(Color | string | Resource) } 3301 * @syscap SystemCapability.ArkUI.ArkUI.Full 3302 * @since 7 3303 */ 3304 /** 3305 * Define the color of shadow 3306 * 3307 * @type { ?(Color | string | Resource) } 3308 * @syscap SystemCapability.ArkUI.ArkUI.Full 3309 * @since 9 3310 * @form 3311 */ 3312 /** 3313 * Define the color of shadow 3314 * 3315 * @type { ?(Color | string | Resource) } 3316 * @syscap SystemCapability.ArkUI.ArkUI.Full 3317 * @crossplatform 3318 * @since 10 3319 * @form 3320 */ 3321 color?: Color | string | Resource; 3322 3323 /** 3324 * Define the horizontal offset size of shadow 3325 * 3326 * @type { ?(number | Resource) } 3327 * @syscap SystemCapability.ArkUI.ArkUI.Full 3328 * @since 7 3329 */ 3330 /** 3331 * Define the horizontal offset size of shadow 3332 * 3333 * @type { ?(number | Resource) } 3334 * @syscap SystemCapability.ArkUI.ArkUI.Full 3335 * @since 9 3336 * @form 3337 */ 3338 /** 3339 * Define the horizontal offset size of shadow 3340 * 3341 * @type { ?(number | Resource) } 3342 * @syscap SystemCapability.ArkUI.ArkUI.Full 3343 * @crossplatform 3344 * @since 10 3345 * @form 3346 */ 3347 offsetX?: number | Resource; 3348 3349 /** 3350 * Define the vertical offset size of shadow 3351 * 3352 * @type { ?(number | Resource) } 3353 * @syscap SystemCapability.ArkUI.ArkUI.Full 3354 * @since 7 3355 */ 3356 /** 3357 * Define the vertical offset size of shadow 3358 * 3359 * @type { ?(number | Resource) } 3360 * @syscap SystemCapability.ArkUI.ArkUI.Full 3361 * @since 9 3362 * @form 3363 */ 3364 /** 3365 * Define the vertical offset size of shadow 3366 * 3367 * @type { ?(number | Resource) } 3368 * @syscap SystemCapability.ArkUI.ArkUI.Full 3369 * @crossplatform 3370 * @since 10 3371 * @form 3372 */ 3373 offsetY?: number | Resource; 3374} 3375 3376/** 3377 * enum Shadow style 3378 * 3379 * @enum { number } 3380 * @syscap SystemCapability.ArkUI.ArkUI.Full 3381 * @crossplatform 3382 * @since 10 3383 */ 3384declare enum ShadowStyle { 3385 /** 3386 * Defines the super small default shadow style. 3387 * 3388 * @syscap SystemCapability.ArkUI.ArkUI.Full 3389 * @crossplatform 3390 * @since 10 3391 */ 3392 OUTER_DEFAULT_XS, 3393 3394 /** 3395 * Defines the small default shadow style. 3396 * 3397 * @syscap SystemCapability.ArkUI.ArkUI.Full 3398 * @crossplatform 3399 * @since 10 3400 */ 3401 OUTER_DEFAULT_SM, 3402 3403 /** 3404 * Defines the medium default shadow style. 3405 * 3406 * @syscap SystemCapability.ArkUI.ArkUI.Full 3407 * @crossplatform 3408 * @since 10 3409 */ 3410 OUTER_DEFAULT_MD, 3411 3412 /** 3413 * Defines the large default shadow style. 3414 * 3415 * @syscap SystemCapability.ArkUI.ArkUI.Full 3416 * @crossplatform 3417 * @since 10 3418 */ 3419 OUTER_DEFAULT_LG, 3420 3421 /** 3422 * Defines the small floating shadow style. 3423 * 3424 * @syscap SystemCapability.ArkUI.ArkUI.Full 3425 * @crossplatform 3426 * @since 10 3427 */ 3428 OUTER_FLOATING_SM, 3429 3430 /** 3431 * Defines the medium floating shadow style. 3432 * 3433 * @syscap SystemCapability.ArkUI.ArkUI.Full 3434 * @crossplatform 3435 * @since 10 3436 */ 3437 OUTER_FLOATING_MD, 3438} 3439 3440/** 3441 * Enumerates the safe area types. 3442 * 3443 * @enum { number } 3444 * @syscap SystemCapability.ArkUI.ArkUI.Full 3445 * @since 10 3446 */ 3447declare enum SafeAreaType { 3448 /** 3449 * Default area of the system, including the status bar and navigation bar. 3450 * 3451 * @syscap SystemCapability.ArkUI.ArkUI.Full 3452 * @since 10 3453 */ 3454 SYSTEM, 3455 3456 /** 3457 * Notch or punch hole. 3458 * 3459 * @syscap SystemCapability.ArkUI.ArkUI.Full 3460 * @since 10 3461 */ 3462 CUTOUT, 3463 3464 /** 3465 * Soft keyboard area. 3466 * 3467 * @syscap SystemCapability.ArkUI.ArkUI.Full 3468 * @since 10 3469 */ 3470 KEYBOARD 3471} 3472 3473/** 3474 * Enumerates the safe area edges. 3475 * 3476 * @enum { number } 3477 * @syscap SystemCapability.ArkUI.ArkUI.Full 3478 * @since 10 3479 */ 3480declare enum SafeAreaEdge { 3481 /** 3482 * Top edge of the safe area. 3483 * 3484 * @syscap SystemCapability.ArkUI.ArkUI.Full 3485 * @since 10 3486 */ 3487 TOP, 3488 3489 /** 3490 * Bottom edge of the safe area. 3491 * 3492 * @syscap SystemCapability.ArkUI.ArkUI.Full 3493 * @since 10 3494 */ 3495 BOTTOM, 3496 3497 /** 3498 * Start edge of the safe area. 3499 * 3500 * @syscap SystemCapability.ArkUI.ArkUI.Full 3501 * @since 10 3502 */ 3503 START, 3504 3505 /** 3506 * End edge of the safe area. 3507 * 3508 * @syscap SystemCapability.ArkUI.ArkUI.Full 3509 * @since 10 3510 */ 3511 END 3512} 3513 3514/** 3515 * Defines sheet size type. 3516 * 3517 * @enum { number } 3518 * @syscap SystemCapability.ArkUI.ArkUI.Full 3519 * @crossplatform 3520 * @since 10 3521 */ 3522declare enum SheetSize { 3523 /** 3524 * Defines the sheet size medium height type. The height is half the screen height 3525 * 3526 * @syscap SystemCapability.ArkUI.ArkUI.Full 3527 * @crossplatform 3528 * @since 10 3529 */ 3530 MEDIUM, 3531 3532 /** 3533 * Defines the sheet size large height type. The height is almost screen height. 3534 * 3535 * @syscap SystemCapability.ArkUI.ArkUI.Full 3536 * @crossplatform 3537 * @since 10 3538 */ 3539 LARGE, 3540} 3541 3542/** 3543 * Defines the base event. 3544 * 3545 * @interface BaseEvent 3546 * @syscap SystemCapability.ArkUI.ArkUI.Full 3547 * @since 8 3548 */ 3549/** 3550 * Defines the base event. 3551 * 3552 * @interface BaseEvent 3553 * @syscap SystemCapability.ArkUI.ArkUI.Full 3554 * @since 9 3555 * @form 3556 */ 3557/** 3558 * Defines the base event. 3559 * 3560 * @interface BaseEvent 3561 * @syscap SystemCapability.ArkUI.ArkUI.Full 3562 * @crossplatform 3563 * @since 10 3564 * @form 3565 */ 3566declare interface BaseEvent { 3567 /** 3568 * Defines the current target which fires this event. 3569 * 3570 * @type { EventTarget } 3571 * @syscap SystemCapability.ArkUI.ArkUI.Full 3572 * @since 8 3573 */ 3574 /** 3575 * Defines the current target which fires this event. 3576 * 3577 * @type { EventTarget } 3578 * @syscap SystemCapability.ArkUI.ArkUI.Full 3579 * @since 9 3580 * @form 3581 */ 3582 /** 3583 * Defines the current target which fires this event. 3584 * 3585 * @type { EventTarget } 3586 * @syscap SystemCapability.ArkUI.ArkUI.Full 3587 * @crossplatform 3588 * @since 10 3589 * @form 3590 */ 3591 target: EventTarget; 3592 3593 /** 3594 * Event timestamp. 3595 * 3596 * @type { number } 3597 * @syscap SystemCapability.ArkUI.ArkUI.Full 3598 * @since 8 3599 */ 3600 /** 3601 * Event timestamp. 3602 * 3603 * @type { number } 3604 * @syscap SystemCapability.ArkUI.ArkUI.Full 3605 * @since 9 3606 * @form 3607 */ 3608 /** 3609 * Event timestamp. 3610 * 3611 * @type { number } 3612 * @syscap SystemCapability.ArkUI.ArkUI.Full 3613 * @crossplatform 3614 * @since 10 3615 * @form 3616 */ 3617 timestamp: number; 3618 3619 /** 3620 * the event source info. 3621 * 3622 * @type { SourceType } 3623 * @syscap SystemCapability.ArkUI.ArkUI.Full 3624 * @since 8 3625 */ 3626 /** 3627 * the event source info. 3628 * 3629 * @type { SourceType } 3630 * @syscap SystemCapability.ArkUI.ArkUI.Full 3631 * @since 9 3632 * @form 3633 */ 3634 /** 3635 * the event source info. 3636 * 3637 * @type { SourceType } 3638 * @syscap SystemCapability.ArkUI.ArkUI.Full 3639 * @crossplatform 3640 * @since 10 3641 * @form 3642 */ 3643 source: SourceType; 3644 3645 /** 3646 * Touch pressure. 3647 * 3648 * @type { number } 3649 * @syscap SystemCapability.ArkUI.ArkUI.Full 3650 * @since 9 3651 * @form 3652 */ 3653 /** 3654 * Touch pressure. 3655 * 3656 * @type { number } 3657 * @syscap SystemCapability.ArkUI.ArkUI.Full 3658 * @crossplatform 3659 * @since 10 3660 * @form 3661 */ 3662 pressure: number; 3663 3664 /** 3665 * The angle between pencil projection on plane-X-Y and axis-Z. 3666 * 3667 * @type { number } 3668 * @syscap SystemCapability.ArkUI.ArkUI.Full 3669 * @since 9 3670 * @form 3671 */ 3672 /** 3673 * The angle between pencil projection on plane-X-Y and axis-Z. 3674 * 3675 * @type { number } 3676 * @syscap SystemCapability.ArkUI.ArkUI.Full 3677 * @crossplatform 3678 * @since 10 3679 * @form 3680 */ 3681 tiltX: number; 3682 3683 /** 3684 * The angle between pencil projection on plane-Y-Z and axis-Z. 3685 * 3686 * @type { number } 3687 * @syscap SystemCapability.ArkUI.ArkUI.Full 3688 * @since 9 3689 * @form 3690 */ 3691 /** 3692 * The angle between pencil projection on plane-Y-Z and axis-Z. 3693 * 3694 * @type { number } 3695 * @syscap SystemCapability.ArkUI.ArkUI.Full 3696 * @crossplatform 3697 * @since 10 3698 * @form 3699 */ 3700 tiltY: number; 3701 3702 /** 3703 * The event tool type info. 3704 * 3705 * @type { SourceTool } 3706 * @syscap SystemCapability.ArkUI.ArkUI.Full 3707 * @since 9 3708 * @form 3709 */ 3710 /** 3711 * The event tool type info. 3712 * 3713 * @type { SourceTool } 3714 * @syscap SystemCapability.ArkUI.ArkUI.Full 3715 * @crossplatform 3716 * @since 10 3717 * @form 3718 */ 3719 sourceTool: SourceTool; 3720} 3721 3722/** 3723 * Border image option 3724 * 3725 * @interface BorderImageOption 3726 * @syscap SystemCapability.ArkUI.ArkUI.Full 3727 * @since 9 3728 * @form 3729 */ 3730/** 3731 * Border image option 3732 * 3733 * @interface BorderImageOption 3734 * @syscap SystemCapability.ArkUI.ArkUI.Full 3735 * @crossplatform 3736 * @since 10 3737 * @form 3738 */ 3739declare interface BorderImageOption { 3740 /** 3741 * Border image slice 3742 * 3743 * @type { ?(Length | EdgeWidths) } 3744 * @syscap SystemCapability.ArkUI.ArkUI.Full 3745 * @since 9 3746 * @form 3747 */ 3748 /** 3749 * Border image slice 3750 * 3751 * @type { ?(Length | EdgeWidths) } 3752 * @syscap SystemCapability.ArkUI.ArkUI.Full 3753 * @crossplatform 3754 * @since 10 3755 * @form 3756 */ 3757 slice?: Length | EdgeWidths, 3758 3759 /** 3760 * Border image repeat 3761 * 3762 * @type { ?RepeatMode } 3763 * @syscap SystemCapability.ArkUI.ArkUI.Full 3764 * @since 9 3765 * @form 3766 */ 3767 /** 3768 * Border image repeat 3769 * 3770 * @type { ?RepeatMode } 3771 * @syscap SystemCapability.ArkUI.ArkUI.Full 3772 * @crossplatform 3773 * @since 10 3774 * @form 3775 */ 3776 repeat?: RepeatMode, 3777 3778 /** 3779 * Border image source 3780 * 3781 * @type { ?(string | Resource | LinearGradient) } 3782 * @syscap SystemCapability.ArkUI.ArkUI.Full 3783 * @since 9 3784 * @form 3785 */ 3786 /** 3787 * Border image source 3788 * 3789 * @type { ?(string | Resource | LinearGradient) } 3790 * @syscap SystemCapability.ArkUI.ArkUI.Full 3791 * @crossplatform 3792 * @since 10 3793 * @form 3794 */ 3795 source?: string | Resource | LinearGradient, 3796 3797 /** 3798 * Border image width 3799 * 3800 * @type { ?(Length | EdgeWidths) } 3801 * @syscap SystemCapability.ArkUI.ArkUI.Full 3802 * @since 9 3803 * @form 3804 */ 3805 /** 3806 * Border image width 3807 * 3808 * @type { ?(Length | EdgeWidths) } 3809 * @syscap SystemCapability.ArkUI.ArkUI.Full 3810 * @crossplatform 3811 * @since 10 3812 * @form 3813 */ 3814 width?: Length | EdgeWidths, 3815 3816 /** 3817 * Border image outset 3818 * 3819 * @type { ?(Length | EdgeWidths) } 3820 * @syscap SystemCapability.ArkUI.ArkUI.Full 3821 * @since 9 3822 * @form 3823 */ 3824 /** 3825 * Border image outset 3826 * 3827 * @type { ?(Length | EdgeWidths) } 3828 * @syscap SystemCapability.ArkUI.ArkUI.Full 3829 * @crossplatform 3830 * @since 10 3831 * @form 3832 */ 3833 outset?: Length | EdgeWidths, 3834 3835 /** 3836 * Border image center fill 3837 * 3838 * @type { ?boolean } 3839 * @syscap SystemCapability.ArkUI.ArkUI.Full 3840 * @since 9 3841 * @form 3842 */ 3843 /** 3844 * Border image center fill 3845 * 3846 * @type { ?boolean } 3847 * @syscap SystemCapability.ArkUI.ArkUI.Full 3848 * @crossplatform 3849 * @since 10 3850 * @form 3851 */ 3852 fill?: boolean 3853} 3854 3855/** 3856 * The tap action triggers this method invocation. 3857 * 3858 * @interface ClickEvent 3859 * @syscap SystemCapability.ArkUI.ArkUI.Full 3860 * @since 7 3861 */ 3862/** 3863 * The tap action triggers this method invocation. 3864 * 3865 * @interface ClickEvent 3866 * @syscap SystemCapability.ArkUI.ArkUI.Full 3867 * @since 9 3868 * @form 3869 */ 3870/** 3871 * The tap action triggers this method invocation. 3872 * 3873 * @interface ClickEvent 3874 * @syscap SystemCapability.ArkUI.ArkUI.Full 3875 * @crossplatform 3876 * @since 10 3877 * @form 3878 */ 3879declare interface ClickEvent extends BaseEvent { 3880 /** 3881 * X coordinate of the click point relative to the left edge of the device screen. 3882 * 3883 * @type { number } 3884 * @syscap SystemCapability.ArkUI.ArkUI.Full 3885 * @crossplatform 3886 * @since 10 3887 */ 3888 displayX: number; 3889 3890 /** 3891 * Y coordinate of the click point relative to the upper edge of the device screen. 3892 * 3893 * @type { number } 3894 * @syscap SystemCapability.ArkUI.ArkUI.Full 3895 * @crossplatform 3896 * @since 10 3897 */ 3898 displayY: number; 3899 3900 /** 3901 * X coordinate of the click point relative to the left edge of the current window. 3902 * 3903 * @type { number } 3904 * @syscap SystemCapability.ArkUI.ArkUI.Full 3905 * @crossplatform 3906 * @since 10 3907 */ 3908 windowX: number; 3909 3910 /** 3911 * Y coordinate of the click point relative to the upper edge of the current window. 3912 * 3913 * @type { number } 3914 * @syscap SystemCapability.ArkUI.ArkUI.Full 3915 * @crossplatform 3916 * @since 10 3917 */ 3918 windowY: number; 3919 3920 /** 3921 * X coordinate of the click point relative to the left edge of the current window. 3922 * 3923 * @type { number } 3924 * @syscap SystemCapability.ArkUI.ArkUI.Full 3925 * @since 7 3926 * @deprecated since 10 3927 * @useinstead ClickEvent#windowX 3928 */ 3929 screenX: number; 3930 3931 /** 3932 * Y coordinate of the click point relative to the upper edge of the current window. 3933 * 3934 * @type { number } 3935 * @syscap SystemCapability.ArkUI.ArkUI.Full 3936 * @since 7 3937 * @deprecated since 10 3938 * @useinstead ClickEvent#windowY 3939 */ 3940 screenY: number; 3941 3942 /** 3943 * X coordinate of the click point relative to the left edge of the clicked element. 3944 * 3945 * @type { number } 3946 * @syscap SystemCapability.ArkUI.ArkUI.Full 3947 * @since 7 3948 */ 3949 /** 3950 * X coordinate of the click point relative to the left edge of the clicked element. 3951 * 3952 * @type { number } 3953 * @syscap SystemCapability.ArkUI.ArkUI.Full 3954 * @since 9 3955 * @form 3956 */ 3957 /** 3958 * X coordinate of the click point relative to the left edge of the clicked element. 3959 * 3960 * @type { number } 3961 * @syscap SystemCapability.ArkUI.ArkUI.Full 3962 * @crossplatform 3963 * @since 10 3964 * @form 3965 */ 3966 x: number; 3967 3968 /** 3969 * Y coordinate of the click point relative to the upper edge of the clicked element. 3970 * 3971 * @type { number } 3972 * @syscap SystemCapability.ArkUI.ArkUI.Full 3973 * @since 7 3974 */ 3975 /** 3976 * Y coordinate of the click point relative to the left edge of the clicked element. 3977 * 3978 * @type { number } 3979 * @syscap SystemCapability.ArkUI.ArkUI.Full 3980 * @since 9 3981 * @form 3982 */ 3983 /** 3984 * Y coordinate of the click point relative to the left edge of the clicked element. 3985 * 3986 * @type { number } 3987 * @syscap SystemCapability.ArkUI.ArkUI.Full 3988 * @crossplatform 3989 * @since 10 3990 * @form 3991 */ 3992 y: number; 3993} 3994 3995/** 3996 * The hover action triggers this method invocation. 3997 * 3998 * @interface HoverEvent 3999 * @syscap SystemCapability.ArkUI.ArkUI.Full 4000 * @since 10 4001 */ 4002declare interface HoverEvent extends BaseEvent { 4003 /** 4004 * The blocking hover event pops up. 4005 * 4006 * @type { function } 4007 * @syscap SystemCapability.ArkUI.ArkUI.Full 4008 * @since 10 4009 */ 4010 stopPropagation: () => void; 4011} 4012 4013/** 4014 * The mouse click action triggers this method invocation. 4015 * 4016 * @interface MouseEvent 4017 * @syscap SystemCapability.ArkUI.ArkUI.Full 4018 * @since 8 4019 */ 4020declare interface MouseEvent extends BaseEvent { 4021 /** 4022 * Mouse button of the click event. 4023 * 4024 * @type { MouseButton } 4025 * @syscap SystemCapability.ArkUI.ArkUI.Full 4026 * @since 8 4027 */ 4028 button: MouseButton; 4029 4030 /** 4031 * Mouse action of the click event. 4032 * 4033 * @type { MouseAction } 4034 * @syscap SystemCapability.ArkUI.ArkUI.Full 4035 * @since 8 4036 */ 4037 action: MouseAction; 4038 4039 /** 4040 * X coordinate of the mouse point relative to the left edge of the device screen. 4041 * 4042 * @type { number } 4043 * @syscap SystemCapability.ArkUI.ArkUI.Full 4044 * @since 10 4045 */ 4046 displayX: number; 4047 4048 /** 4049 * Y coordinate of the mouse point relative to the upper edge of the device screen. 4050 * 4051 * @type { number } 4052 * @syscap SystemCapability.ArkUI.ArkUI.Full 4053 * @since 10 4054 */ 4055 displayY: number; 4056 4057 /** 4058 * X coordinate of the mouse point relative to the left edge of the current window. 4059 * 4060 * @type { number } 4061 * @syscap SystemCapability.ArkUI.ArkUI.Full 4062 * @since 10 4063 */ 4064 windowX: number; 4065 4066 /** 4067 * Y coordinate of the mouse point relative to the upper edge of the current window. 4068 * 4069 * @type { number } 4070 * @syscap SystemCapability.ArkUI.ArkUI.Full 4071 * @since 10 4072 */ 4073 windowY: number; 4074 4075 /** 4076 * X coordinate of the mouse point relative to the left edge of the current window. 4077 * 4078 * @type { number } 4079 * @syscap SystemCapability.ArkUI.ArkUI.Full 4080 * @since 8 4081 * @deprecated since 10 4082 * @useinstead MouseEvent#windowX 4083 */ 4084 screenX: number; 4085 4086 /** 4087 * Y coordinate of the mouse point relative to the upper edge of the current window. 4088 * 4089 * @type { number } 4090 * @syscap SystemCapability.ArkUI.ArkUI.Full 4091 * @since 8 4092 * @deprecated since 10 4093 * @useinstead MouseEvent#windowY 4094 */ 4095 screenY: number; 4096 4097 /** 4098 * X coordinate of the mouse point relative to the left edge of the mouse hit element. 4099 * 4100 * @type { number } 4101 * @syscap SystemCapability.ArkUI.ArkUI.Full 4102 * @since 8 4103 */ 4104 x: number; 4105 4106 /** 4107 * Y coordinate of the mouse point relative to the upper edge of the mouse hit element. 4108 * 4109 * @type { number } 4110 * @syscap SystemCapability.ArkUI.ArkUI.Full 4111 * @since 8 4112 */ 4113 y: number; 4114 4115 /** 4116 * The blocking event pops up. 4117 * 4118 * @type { function } 4119 * @syscap SystemCapability.ArkUI.ArkUI.Full 4120 * @since 8 4121 */ 4122 stopPropagation: () => void; 4123} 4124 4125/** 4126 * Type of the touch event. 4127 * 4128 * @interface TouchObject 4129 * @syscap SystemCapability.ArkUI.ArkUI.Full 4130 * @since 7 4131 */ 4132/** 4133 * Type of the touch event. 4134 * 4135 * @interface TouchObject 4136 * @syscap SystemCapability.ArkUI.ArkUI.Full 4137 * @crossplatform 4138 * @since 10 4139 */ 4140declare interface TouchObject { 4141 /** 4142 * Type of the touch event. 4143 * 4144 * @type { TouchType } 4145 * @syscap SystemCapability.ArkUI.ArkUI.Full 4146 * @since 7 4147 */ 4148 /** 4149 * Type of the touch event. 4150 * 4151 * @type { TouchType } 4152 * @syscap SystemCapability.ArkUI.ArkUI.Full 4153 * @crossplatform 4154 * @since 10 4155 */ 4156 type: TouchType; 4157 4158 /** 4159 * Finger unique identifier. 4160 * 4161 * @type { number } 4162 * @syscap SystemCapability.ArkUI.ArkUI.Full 4163 * @since 7 4164 */ 4165 /** 4166 * Finger unique identifier. 4167 * 4168 * @type { number } 4169 * @syscap SystemCapability.ArkUI.ArkUI.Full 4170 * @crossplatform 4171 * @since 10 4172 */ 4173 id: number; 4174 4175 /** 4176 * X coordinate of the touch point relative to the left edge of the device screen. 4177 * 4178 * @type { number } 4179 * @syscap SystemCapability.ArkUI.ArkUI.Full 4180 * @crossplatform 4181 * @since 10 4182 */ 4183 displayX: number; 4184 4185 /** 4186 * Y coordinate of the touch point relative to the upper edge of the device screen. 4187 * 4188 * @type { number } 4189 * @syscap SystemCapability.ArkUI.ArkUI.Full 4190 * @crossplatform 4191 * @since 10 4192 */ 4193 displayY: number; 4194 4195 /** 4196 * X coordinate of the touch point relative to the left edge of the current window. 4197 * 4198 * @type { number } 4199 * @syscap SystemCapability.ArkUI.ArkUI.Full 4200 * @crossplatform 4201 * @since 10 4202 */ 4203 windowX: number; 4204 4205 /** 4206 * Y coordinate of the touch point relative to the upper edge of the current window. 4207 * 4208 * @type { number } 4209 * @syscap SystemCapability.ArkUI.ArkUI.Full 4210 * @crossplatform 4211 * @since 10 4212 */ 4213 windowY: number; 4214 4215 /** 4216 * X coordinate of the touch point relative to the left edge of the current window. 4217 * 4218 * @type { number } 4219 * @syscap SystemCapability.ArkUI.ArkUI.Full 4220 * @since 7 4221 * @deprecated since 10 4222 * @useinstead TouchObject#windowX 4223 */ 4224 screenX: number; 4225 4226 /** 4227 * Y coordinate of the touch point relative to the upper edge of the current window. 4228 * 4229 * @type { number } 4230 * @syscap SystemCapability.ArkUI.ArkUI.Full 4231 * @since 7 4232 * @deprecated since 10 4233 * @useinstead TouchObject#windowY 4234 */ 4235 screenY: number; 4236 4237 /** 4238 * X coordinate of the touch point relative to the left edge of the touched element. 4239 * 4240 * @type { number } 4241 * @syscap SystemCapability.ArkUI.ArkUI.Full 4242 * @since 7 4243 */ 4244 /** 4245 * X coordinate of the touch point relative to the left edge of the touched element. 4246 * 4247 * @type { number } 4248 * @syscap SystemCapability.ArkUI.ArkUI.Full 4249 * @crossplatform 4250 * @since 10 4251 */ 4252 x: number; 4253 4254 /** 4255 * Y coordinate of the touch point relative to the upper edge of the touched element. 4256 * 4257 * @type { number } 4258 * @syscap SystemCapability.ArkUI.ArkUI.Full 4259 * @since 7 4260 */ 4261 /** 4262 * Y coordinate of the touch point relative to the upper edge of the touched element. 4263 * 4264 * @type { number } 4265 * @syscap SystemCapability.ArkUI.ArkUI.Full 4266 * @crossplatform 4267 * @since 10 4268 */ 4269 y: number; 4270} 4271 4272/** 4273 * TouchObject getHistoricalPoints Function Parameters 4274 * 4275 * @interface HistoricalPoint 4276 * @syscap SystemCapability.ArkUI.ArkUI.Full 4277 * @crossplatform 4278 * @since 10 4279 */ 4280declare interface HistoricalPoint { 4281 /** 4282 * The base touchObject information of historicalPoint 4283 * 4284 * @type { TouchObject } 4285 * @syscap SystemCapability.ArkUI.ArkUI.Full 4286 * @crossplatform 4287 * @since 10 4288 */ 4289 touchObject: TouchObject; 4290 4291 /** 4292 * Contact area between the finger pad and the screen. 4293 * 4294 * @type { number } 4295 * @syscap SystemCapability.ArkUI.ArkUI.Full 4296 * @crossplatform 4297 * @since 10 4298 */ 4299 size: number; 4300 4301 /** 4302 * Pressure of the touch event. 4303 * 4304 * @type { number } 4305 * @syscap SystemCapability.ArkUI.ArkUI.Full 4306 * @crossplatform 4307 * @since 10 4308 */ 4309 force: number; 4310 4311 /** 4312 * Timestamp of the touch event. 4313 * 4314 * @type { number } 4315 * @syscap SystemCapability.ArkUI.ArkUI.Full 4316 * @crossplatform 4317 * @since 10 4318 */ 4319 timestamp: number; 4320} 4321 4322/** 4323 * Touch Action Function Parameters 4324 * 4325 * @interface TouchEvent 4326 * @syscap SystemCapability.ArkUI.ArkUI.Full 4327 * @since 7 4328 */ 4329/** 4330 * Touch Action Function Parameters 4331 * 4332 * @interface TouchEvent 4333 * @syscap SystemCapability.ArkUI.ArkUI.Full 4334 * @crossplatform 4335 * @since 10 4336 */ 4337declare interface TouchEvent extends BaseEvent { 4338 /** 4339 * Type of the touch event. 4340 * 4341 * @type { TouchType } 4342 * @syscap SystemCapability.ArkUI.ArkUI.Full 4343 * @since 7 4344 */ 4345 /** 4346 * Type of the touch event. 4347 * 4348 * @type { TouchType } 4349 * @syscap SystemCapability.ArkUI.ArkUI.Full 4350 * @crossplatform 4351 * @since 10 4352 */ 4353 type: TouchType; 4354 4355 /** 4356 * All finger information. 4357 * 4358 * @type { TouchObject[] } 4359 * @syscap SystemCapability.ArkUI.ArkUI.Full 4360 * @since 7 4361 */ 4362 /** 4363 * All finger information. 4364 * 4365 * @type { TouchObject[] } 4366 * @syscap SystemCapability.ArkUI.ArkUI.Full 4367 * @crossplatform 4368 * @since 10 4369 */ 4370 touches: TouchObject[]; 4371 4372 /** 4373 * Indicates the current changed finger information. 4374 * 4375 * @type { TouchObject[] } 4376 * @syscap SystemCapability.ArkUI.ArkUI.Full 4377 * @since 7 4378 */ 4379 /** 4380 * Indicates the current changed finger information. 4381 * 4382 * @type { TouchObject[] } 4383 * @syscap SystemCapability.ArkUI.ArkUI.Full 4384 * @crossplatform 4385 * @since 10 4386 */ 4387 changedTouches: TouchObject[]; 4388 4389 /** 4390 * The blocking event pops up. 4391 * 4392 * @type { function } 4393 * @syscap SystemCapability.ArkUI.ArkUI.Full 4394 * @since 7 4395 */ 4396 /** 4397 * The blocking event pops up. 4398 * 4399 * @type { function } 4400 * @syscap SystemCapability.ArkUI.ArkUI.Full 4401 * @crossplatform 4402 * @since 10 4403 */ 4404 stopPropagation: () => void; 4405 4406 /** 4407 * Get the historical points. 4408 * 4409 * @returns { Array<HistoricalPoint> } - return all historical points. 4410 * @syscap SystemCapability.ArkUI.ArkUI.Full 4411 * @crossplatform 4412 * @since 10 4413 */ 4414 getHistoricalPoints(): Array<HistoricalPoint>; 4415} 4416 4417/** 4418 * Defines the PixelMap type object for ui component. 4419 * 4420 * @syscap SystemCapability.ArkUI.ArkUI.Full 4421 * @since 7 4422 */ 4423/** 4424 * Defines the PixelMap type object for ui component. 4425 * 4426 * @syscap SystemCapability.ArkUI.ArkUI.Full 4427 * @crossplatform 4428 * @since 10 4429 */ 4430declare type PixelMap = import('../api/@ohos.multimedia.image').default.PixelMap; 4431 4432/** 4433 * pixelmap object with release function. 4434 * 4435 * @interface PixelMapMock 4436 * @syscap SystemCapability.ArkUI.ArkUI.Full 4437 * @systemapi 4438 * @since 7 4439 */ 4440declare interface PixelMapMock { 4441 /** 4442 * release function. 4443 * 4444 * @syscap SystemCapability.ArkUI.ArkUI.Full 4445 * @systemapi 4446 * @since 7 4447 */ 4448 release(): void; 4449} 4450 4451/** 4452 * Enum for Drag Behavior. 4453 * 4454 * @enum { number } 4455 * @syscap SystemCapability.ArkUI.ArkUI.Full 4456 * @since 10 4457 */ 4458declare enum DragBehavior { 4459 /** 4460 * If drag use copy event, then set DragBehavior.COPY. 4461 * 4462 * @syscap SystemCapability.ArkUI.ArkUI.Full 4463 * @since 10 4464 */ 4465 COPY, 4466 /** 4467 * If drag use move event, then set DragBehavior.MOVE. 4468 * 4469 * @syscap SystemCapability.ArkUI.ArkUI.Full 4470 * @since 10 4471 */ 4472 MOVE 4473} 4474 4475/** 4476 * Import the UnifiedData type object for ui component. 4477 * 4478 * @syscap SystemCapability.ArkUI.ArkUI.Full 4479 * @crossplatform 4480 * @since 10 4481 */ 4482declare type UnifiedData = import('../api/@ohos.data.unifiedDataChannel').default.UnifiedData; 4483 4484/** 4485 * Import the Summary type object for ui component. 4486 * 4487 * @syscap SystemCapability.ArkUI.ArkUI.Full 4488 * @since 10 4489 */ 4490declare type Summary = import('../api/@ohos.data.unifiedDataChannel').default.Summary; 4491 4492/** 4493 * Import the UniformDataType type object for ui component. 4494 * 4495 * @syscap SystemCapability.ArkUI.ArkUI.Full 4496 * @since 10 4497 */ 4498declare type UniformDataType = import('../api/@ohos.data.uniformTypeDescriptor').default.UniformDataType; 4499 4500/** 4501 * Enum for Drag Result. 4502 * 4503 * @enum { number } 4504 * @syscap SystemCapability.ArkUI.ArkUI.Full 4505 * @since 10 4506 */ 4507declare enum DragResult { 4508 /** 4509 * If the drag is successful, return DragResult.DRAG_SUCCESSFUL. 4510 * 4511 * @syscap SystemCapability.ArkUI.ArkUI.Full 4512 * @since 10 4513 */ 4514 DRAG_SUCCESSFUL = 0, 4515 /** 4516 * If drag fail, return DragResult.DRAG_FAILED. 4517 * 4518 * @syscap SystemCapability.ArkUI.ArkUI.Full 4519 * @since 10 4520 */ 4521 DRAG_FAILED = 1, 4522 /** 4523 * If drag action cancel, return DragResult.DRAG_CANCELED. 4524 * 4525 * @syscap SystemCapability.ArkUI.ArkUI.Full 4526 * @since 10 4527 */ 4528 DRAG_CANCELED = 2, 4529 /** 4530 * If node allow drop in, return DragResult.DROP_ENABLED. 4531 * 4532 * @syscap SystemCapability.ArkUI.ArkUI.Full 4533 * @since 10 4534 */ 4535 DROP_ENABLED = 3, 4536 /** 4537 * If node don't allow drop in, return DragResult.DROP_DISABLED. 4538 * 4539 * @syscap SystemCapability.ArkUI.ArkUI.Full 4540 * @since 10 4541 */ 4542 DROP_DISABLED = 4 4543} 4544 4545/** 4546 * DragEvent object description 4547 * 4548 * @interface DragEvent 4549 * @syscap SystemCapability.ArkUI.ArkUI.Full 4550 * @since 7 4551 */ 4552declare interface DragEvent { 4553 /** 4554 * X coordinate of the touch point relative to the left edge of the device screen. 4555 * 4556 * @returns { number } 4557 * @syscap SystemCapability.ArkUI.ArkUI.Full 4558 * @since 10 4559 */ 4560 getDisplayX(): number; 4561 4562 /** 4563 * Y coordinate of the touch point relative to the upper edge of the device screen. 4564 * 4565 * @returns { number } 4566 * @syscap SystemCapability.ArkUI.ArkUI.Full 4567 * @since 10 4568 */ 4569 getDisplayY(): number; 4570 4571 /** 4572 * X coordinate of the touch point relative to the left edge of the current window. 4573 * 4574 * @returns { number } 4575 * @syscap SystemCapability.ArkUI.ArkUI.Full 4576 * @since 10 4577 */ 4578 getWindowX(): number; 4579 4580 /** 4581 * Y coordinate of the touch point relative to the left edge of the current window. 4582 * 4583 * @returns { number } 4584 * @syscap SystemCapability.ArkUI.ArkUI.Full 4585 * @since 10 4586 */ 4587 getWindowY(): number; 4588 4589 /** 4590 * X coordinate of the touch point relative to the left edge of the current window. in vp. 4591 * 4592 * @returns { number } 4593 * @syscap SystemCapability.ArkUI.ArkUI.Full 4594 * @since 7 4595 * @deprecated since 10 4596 * @useinstead DragEvent#getWindowX 4597 */ 4598 getX(): number; 4599 4600 /** 4601 * Y coordinate of the touch point relative to the left edge of the current window. in vp. 4602 * 4603 * @returns { number } 4604 * @syscap SystemCapability.ArkUI.ArkUI.Full 4605 * @since 7 4606 * @deprecated since 10 4607 * @useinstead DragEvent#getWindowY 4608 */ 4609 getY(): number; 4610 4611 /** 4612 * If copy is COPY, this DragEvent is a copy event. 4613 * @type { DragBehavior } Operation, if use copy then set COPY, else set MOVE. 4614 * @default COPY 4615 * @syscap SystemCapability.ArkUI.ArkUI.Full 4616 * @since 10 4617 */ 4618 dragBehavior: DragBehavior; 4619 4620 /** 4621 * If useCustomDropAnimation is true, System will not use drop animation. 4622 * 4623 * @type { boolean } 4624 * @syscap SystemCapability.ArkUI.ArkUI.Full 4625 * @since 10 4626 */ 4627 useCustomDropAnimation: boolean; 4628 4629 /** 4630 * Set dragData into DragEvent. 4631 * 4632 * @param { UnifiedData } unifiedData - dragData. 4633 * @syscap SystemCapability.ArkUI.ArkUI.Full 4634 * @crossplatform 4635 * @since 10 4636 */ 4637 setData(unifiedData: UnifiedData): void; 4638 4639 /** 4640 * Get dragData from DragEvent. 4641 * 4642 * @returns { UnifiedData } - get dragData. 4643 * @throws { BusinessError } 190001 - data not found. 4644 * @throws { BusinessError } 190002 - data error. 4645 * @syscap SystemCapability.ArkUI.ArkUI.Full 4646 * @crossplatform 4647 * @since 10 4648 */ 4649 getData(): UnifiedData; 4650 4651 /** 4652 * Get dragData summary from DragEvent. 4653 * 4654 * @returns { Summary } - get Summary Data. 4655 * @syscap SystemCapability.ArkUI.ArkUI.Full 4656 * @crossplatform 4657 * @since 10 4658 */ 4659 getSummary(): Summary; 4660 4661 /** 4662 * Set dragEvent result to DragEvent. 4663 * 4664 * @param { DragResult } dragResult - the return of dragEvent. 4665 * @syscap SystemCapability.ArkUI.ArkUI.Full 4666 * @since 10 4667 */ 4668 setResult(dragResult: DragResult): void; 4669 4670 /** 4671 * Get dragEvent result from DragEvent. 4672 * 4673 * @returns { DragResult } - dragResult Data. 4674 * @syscap SystemCapability.ArkUI.ArkUI.Full 4675 * @since 10 4676 */ 4677 getResult(): DragResult; 4678 4679 /** 4680 * Get the rectangle of drag window. 4681 * 4682 * @returns { Rectangle } - getPreview rectangle. 4683 * @syscap SystemCapability.ArkUI.ArkUI.Full 4684 * @since 10 4685 */ 4686 getPreviewRect(): Rectangle; 4687 4688 /** 4689 * Get the x axis velocity of drag gesture. 4690 * 4691 * @returns { number } - get x axis velocity. 4692 * @syscap SystemCapability.ArkUI.ArkUI.Full 4693 * @crossplatform 4694 * @since 10 4695 */ 4696 getVelocityX(): number; 4697 4698 /** 4699 * Get the y axis velocity of drag gesture. 4700 * 4701 * @returns { number } - get y axis velocity. 4702 * @syscap SystemCapability.ArkUI.ArkUI.Full 4703 * @crossplatform 4704 * @since 10 4705 */ 4706 getVelocityY(): number; 4707 4708 /** 4709 * Get the velocity of drag gesture. 4710 * 4711 * @returns { number } - get velocity. 4712 * @syscap SystemCapability.ArkUI.ArkUI.Full 4713 * @crossplatform 4714 * @since 10 4715 */ 4716 getVelocity(): number; 4717} 4718 4719/** 4720 * Import the IntentionCode type object for IntentionCode. 4721 * 4722 * @syscap SystemCapability.ArkUI.ArkUI.Full 4723 * @since 10 4724 */ 4725declare type IntentionCode = import('../api/@ohos.multimodalInput.intentionCode').IntentionCode; 4726 4727/** 4728 * KeyEvent object description: 4729 * 4730 * @interface KeyEvent 4731 * @syscap SystemCapability.ArkUI.ArkUI.Full 4732 * @since 7 4733 */ 4734/** 4735 * KeyEvent object description: 4736 * 4737 * @interface KeyEvent 4738 * @syscap SystemCapability.ArkUI.ArkUI.Full 4739 * @crossplatform 4740 * @since 10 4741 */ 4742declare interface KeyEvent { 4743 /** 4744 * Type of a key. 4745 * 4746 * @type { KeyType } 4747 * @syscap SystemCapability.ArkUI.ArkUI.Full 4748 * @since 7 4749 */ 4750 /** 4751 * Type of a key. 4752 * 4753 * @type { KeyType } 4754 * @syscap SystemCapability.ArkUI.ArkUI.Full 4755 * @crossplatform 4756 * @since 10 4757 */ 4758 type: KeyType; 4759 4760 /** 4761 * Key code of a key 4762 * 4763 * @type { number } 4764 * @syscap SystemCapability.ArkUI.ArkUI.Full 4765 * @since 7 4766 */ 4767 /** 4768 * Key code of a key 4769 * 4770 * @type { number } 4771 * @syscap SystemCapability.ArkUI.ArkUI.Full 4772 * @crossplatform 4773 * @since 10 4774 */ 4775 keyCode: number; 4776 4777 /** 4778 * Key value of a key. 4779 * 4780 * @type { string } 4781 * @syscap SystemCapability.ArkUI.ArkUI.Full 4782 * @since 7 4783 */ 4784 /** 4785 * Key value of a key. 4786 * 4787 * @type { string } 4788 * @syscap SystemCapability.ArkUI.ArkUI.Full 4789 * @crossplatform 4790 * @since 10 4791 */ 4792 keyText: string; 4793 4794 /** 4795 * Type of the input device that triggers the current key, such as the keyboard or handle. 4796 * 4797 * @type { KeySource } 4798 * @syscap SystemCapability.ArkUI.ArkUI.Full 4799 * @since 7 4800 */ 4801 /** 4802 * Type of the input device that triggers the current key, such as the keyboard or handle. 4803 * 4804 * @type { KeySource } 4805 * @syscap SystemCapability.ArkUI.ArkUI.Full 4806 * @crossplatform 4807 * @since 10 4808 */ 4809 keySource: KeySource; 4810 4811 /** 4812 * Indicates the ID of the input device that triggers the current key. 4813 * 4814 * @type { number } 4815 * @syscap SystemCapability.ArkUI.ArkUI.Full 4816 * @since 7 4817 */ 4818 /** 4819 * Indicates the ID of the input device that triggers the current key. 4820 * 4821 * @type { number } 4822 * @syscap SystemCapability.ArkUI.ArkUI.Full 4823 * @crossplatform 4824 * @since 10 4825 */ 4826 deviceId: number; 4827 4828 /** 4829 * Indicates the status of the key when the key is pressed. 4830 * The value 1 indicates the pressed state, and the value 0 indicates the unpressed state. 4831 * 4832 * @type { number } 4833 * @syscap SystemCapability.ArkUI.ArkUI.Full 4834 * @since 7 4835 */ 4836 /** 4837 * Indicates the status of the key when the key is pressed. 4838 * The value 1 indicates the pressed state, and the value 0 indicates the unpressed state. 4839 * 4840 * @type { number } 4841 * @syscap SystemCapability.ArkUI.ArkUI.Full 4842 * @crossplatform 4843 * @since 10 4844 */ 4845 metaKey: number; 4846 4847 /** 4848 * Timestamp when the key was pressed. 4849 * 4850 * @type { number } 4851 * @syscap SystemCapability.ArkUI.ArkUI.Full 4852 * @since 7 4853 */ 4854 /** 4855 * Timestamp when the key was pressed. 4856 * 4857 * @type { number } 4858 * @syscap SystemCapability.ArkUI.ArkUI.Full 4859 * @crossplatform 4860 * @since 10 4861 */ 4862 timestamp: number; 4863 4864 /** 4865 * Block event bubbling. 4866 * 4867 * @type { function } 4868 * @syscap SystemCapability.ArkUI.ArkUI.Full 4869 * @since 7 4870 */ 4871 /** 4872 * Block event bubbling. 4873 * 4874 * @type { function } 4875 * @syscap SystemCapability.ArkUI.ArkUI.Full 4876 * @crossplatform 4877 * @since 10 4878 */ 4879 stopPropagation: () => void; 4880 4881 /** 4882 * Intention code of a key or modifier keys. 4883 * 4884 * @type { IntentionCode } 4885 * @default IntentionCode.INTENTION_UNKNOWN 4886 * @syscap SystemCapability.ArkUI.ArkUI.Full 4887 * @since 10 4888 */ 4889 intentionCode: IntentionCode; 4890} 4891 4892/** 4893 * Overlay module options 4894 * 4895 * @interface BindOptions 4896 * @syscap SystemCapability.ArkUI.ArkUI.Full 4897 * @crossplatform 4898 * @since 10 4899 */ 4900declare interface BindOptions { 4901 /** 4902 * Defines the background color 4903 * 4904 * @type { ?ResourceColor } 4905 * @syscap SystemCapability.ArkUI.ArkUI.Full 4906 * @crossplatform 4907 * @since 10 4908 */ 4909 backgroundColor?: ResourceColor; 4910 4911 /** 4912 * Callback function when overlay interface appears 4913 * 4914 * @type { ?function } 4915 * @syscap SystemCapability.ArkUI.ArkUI.Full 4916 * @crossplatform 4917 * @since 10 4918 */ 4919 onAppear?: () => void; 4920 4921 /** 4922 * Callback function when overlay interface exits 4923 * 4924 * @type { ?function } 4925 * @syscap SystemCapability.ArkUI.ArkUI.Full 4926 * @crossplatform 4927 * @since 10 4928 */ 4929 onDisappear?: () => void; 4930} 4931 4932/** 4933 * Component content cover options 4934 * 4935 * @interface ContentCoverOptions 4936 * @syscap SystemCapability.ArkUI.ArkUI.Full 4937 * @crossplatform 4938 * @since 10 4939 */ 4940declare interface ContentCoverOptions extends BindOptions { 4941 /** 4942 * Defines transition type 4943 * 4944 * @type { ?ModalTransition } 4945 * @default ModalTransition.Default 4946 * @syscap SystemCapability.ArkUI.ArkUI.Full 4947 * @crossplatform 4948 * @since 10 4949 */ 4950 modalTransition?: ModalTransition, 4951} 4952 4953/** 4954 * Component sheet options 4955 * 4956 * @interface SheetOptions 4957 * @syscap SystemCapability.ArkUI.ArkUI.Full 4958 * @crossplatform 4959 * @since 10 4960 */ 4961declare interface SheetOptions extends BindOptions { 4962 /** 4963 * Defines sheet height 4964 * 4965 * @type { ?(SheetSize | Length) } 4966 * @default Sheet.LARGE 4967 * @syscap SystemCapability.ArkUI.ArkUI.Full 4968 * @crossplatform 4969 * @since 10 4970 */ 4971 height?: SheetSize | Length; 4972 4973 /** 4974 * Defines whether the control bar is displayed. 4975 * 4976 * @type { ?boolean } 4977 * @default true 4978 * @syscap SystemCapability.ArkUI.ArkUI.Full 4979 * @crossplatform 4980 * @since 10 4981 */ 4982 dragBar?: boolean; 4983 4984 /** 4985 * Defines sheet maskColor 4986 * 4987 * @type { ?ResourceColor } 4988 * @syscap SystemCapability.ArkUI.ArkUI.Full 4989 * @crossplatform 4990 * @since 10 4991 */ 4992 maskColor?: ResourceColor; 4993} 4994 4995/** 4996 * Component State Styles. 4997 * 4998 * @interface StateStyles 4999 * @syscap SystemCapability.ArkUI.ArkUI.Full 5000 * @since 8 5001 */ 5002/** 5003 * Component State Styles. 5004 * 5005 * @interface StateStyles 5006 * @syscap SystemCapability.ArkUI.ArkUI.Full 5007 * @since 9 5008 * @form 5009 */ 5010/** 5011 * Component State Styles. 5012 * 5013 * @interface StateStyles 5014 * @syscap SystemCapability.ArkUI.ArkUI.Full 5015 * @crossplatform 5016 * @since 10 5017 * @form 5018 */ 5019declare interface StateStyles { 5020 /** 5021 * Defines normal state styles. 5022 * 5023 * @type { ?any } 5024 * @syscap SystemCapability.ArkUI.ArkUI.Full 5025 * @since 8 5026 */ 5027 /** 5028 * Defines normal state styles. 5029 * 5030 * @type { ?any } 5031 * @syscap SystemCapability.ArkUI.ArkUI.Full 5032 * @since 9 5033 * @form 5034 */ 5035 /** 5036 * Defines normal state styles. 5037 * 5038 * @type { ?any } 5039 * @syscap SystemCapability.ArkUI.ArkUI.Full 5040 * @crossplatform 5041 * @since 10 5042 * @form 5043 */ 5044 normal?: any; 5045 5046 /** 5047 * Defines pressed state styles. 5048 * 5049 * @type { ?any } 5050 * @syscap SystemCapability.ArkUI.ArkUI.Full 5051 * @since 8 5052 */ 5053 /** 5054 * Defines pressed state styles. 5055 * 5056 * @type { ?any } 5057 * @syscap SystemCapability.ArkUI.ArkUI.Full 5058 * @since 9 5059 * @form 5060 */ 5061 /** 5062 * Defines pressed state styles. 5063 * 5064 * @type { ?any } 5065 * @syscap SystemCapability.ArkUI.ArkUI.Full 5066 * @crossplatform 5067 * @since 10 5068 * @form 5069 */ 5070 pressed?: any; 5071 5072 /** 5073 * Defines disabled state styles. 5074 * 5075 * @type { ?any } 5076 * @syscap SystemCapability.ArkUI.ArkUI.Full 5077 * @since 8 5078 */ 5079 /** 5080 * Defines disabled state styles. 5081 * 5082 * @type { ?any } 5083 * @syscap SystemCapability.ArkUI.ArkUI.Full 5084 * @since 9 5085 * @form 5086 */ 5087 /** 5088 * Defines disabled state styles. 5089 * 5090 * @type { ?any } 5091 * @syscap SystemCapability.ArkUI.ArkUI.Full 5092 * @crossplatform 5093 * @since 10 5094 * @form 5095 */ 5096 disabled?: any; 5097 5098 /** 5099 * Defines focused state styles. 5100 * 5101 * @type { ?any } 5102 * @syscap SystemCapability.ArkUI.ArkUI.Full 5103 * @since 8 5104 */ 5105 /** 5106 * Defines focused state styles. 5107 * 5108 * @type { ?any } 5109 * @syscap SystemCapability.ArkUI.ArkUI.Full 5110 * @since 9 5111 * @form 5112 */ 5113 /** 5114 * Defines focused state styles. 5115 * 5116 * @type { ?any } 5117 * @syscap SystemCapability.ArkUI.ArkUI.Full 5118 * @crossplatform 5119 * @since 10 5120 * @form 5121 */ 5122 focused?: any; 5123 5124 /** 5125 * Defines clicked state styles. 5126 * 5127 * @type { ?any } 5128 * @syscap SystemCapability.ArkUI.ArkUI.Full 5129 * @since 8 5130 */ 5131 /** 5132 * Defines clicked state styles. 5133 * 5134 * @type { ?any } 5135 * @syscap SystemCapability.ArkUI.ArkUI.Full 5136 * @since 9 5137 * @form 5138 */ 5139 /** 5140 * Defines clicked state styles. 5141 * 5142 * @type { ?any } 5143 * @syscap SystemCapability.ArkUI.ArkUI.Full 5144 * @crossplatform 5145 * @since 10 5146 * @form 5147 */ 5148 clicked?: any; 5149 5150 /** 5151 * Defines selected state styles. 5152 * 5153 * @type { ?object } 5154 * @syscap SystemCapability.ArkUI.ArkUI.Full 5155 * @crossplatform 5156 * @since 10 5157 * @form 5158 */ 5159 selected?: object; 5160} 5161 5162/** 5163 * Defines the options of popup message. 5164 * 5165 * @interface PopupMessageOptions 5166 * @syscap SystemCapability.ArkUI.ArkUI.Full 5167 * @crossplatform 5168 * @since 10 5169 */ 5170declare interface PopupMessageOptions { 5171 /** 5172 * Sets the color of popup text. 5173 * 5174 * @type { ?ResourceColor } 5175 * @syscap SystemCapability.ArkUI.ArkUI.Full 5176 * @crossplatform 5177 * @since 10 5178 */ 5179 textColor?: ResourceColor; 5180 5181 /** 5182 * Sets the font of popup text. 5183 * 5184 * @type { ?Font } 5185 * @syscap SystemCapability.ArkUI.ArkUI.Full 5186 * @crossplatform 5187 * @since 10 5188 */ 5189 font?: Font; 5190} 5191 5192/** 5193 * Defines the popup options. 5194 * 5195 * @interface PopupOptions 5196 * @syscap SystemCapability.ArkUI.ArkUI.Full 5197 * @since 7 5198 */ 5199/** 5200 * Defines the popup options. 5201 * 5202 * @interface PopupOptions 5203 * @syscap SystemCapability.ArkUI.ArkUI.Full 5204 * @crossplatform 5205 * @since 10 5206 */ 5207declare interface PopupOptions { 5208 /** 5209 * Information in the pop-up window. 5210 * 5211 * @type { string } 5212 * @syscap SystemCapability.ArkUI.ArkUI.Full 5213 * @since 7 5214 */ 5215 /** 5216 * Information in the pop-up window. 5217 * 5218 * @type { string } 5219 * @syscap SystemCapability.ArkUI.ArkUI.Full 5220 * @crossplatform 5221 * @since 10 5222 */ 5223 message: string; 5224 5225 /** 5226 * placement On Top 5227 * 5228 * @type { ?boolean } 5229 * @syscap SystemCapability.ArkUI.ArkUI.Full 5230 * @since 7 5231 * @deprecated since 10 5232 * @useinstead PopupOptions#placement 5233 */ 5234 placementOnTop?: boolean; 5235 5236 /** 5237 * The placement of popup. 5238 * Supports all positions defined in Placement. 5239 * 5240 * @type { ?Placement } 5241 * @default Placement.Bottom 5242 * @syscap SystemCapability.ArkUI.ArkUI.Full 5243 * @crossplatform 5244 * @since 10 5245 */ 5246 placement?: Placement; 5247 5248 /** 5249 * The first button. 5250 * 5251 * @type { ?object } 5252 * @syscap SystemCapability.ArkUI.ArkUI.Full 5253 * @since 7 5254 */ 5255 /** 5256 * The first button. 5257 * 5258 * @type { ?object } 5259 * @syscap SystemCapability.ArkUI.ArkUI.Full 5260 * @crossplatform 5261 * @since 10 5262 */ 5263 primaryButton?: { 5264 /** 5265 * Button text value 5266 * 5267 * @type { string } 5268 * @syscap SystemCapability.ArkUI.ArkUI.Full 5269 * @since 7 5270 */ 5271 /** 5272 * Button text value 5273 * 5274 * @type { string } 5275 * @syscap SystemCapability.ArkUI.ArkUI.Full 5276 * @crossplatform 5277 * @since 10 5278 */ 5279 value: string; 5280 5281 /** 5282 * action 5283 * 5284 * @type { function } 5285 * @syscap SystemCapability.ArkUI.ArkUI.Full 5286 * @since 7 5287 */ 5288 /** 5289 * action 5290 * 5291 * @type { function } 5292 * @syscap SystemCapability.ArkUI.ArkUI.Full 5293 * @crossplatform 5294 * @since 10 5295 */ 5296 action: () => void; 5297 }; 5298 5299 /** 5300 * The second button. 5301 * 5302 * @type { ?object } 5303 * @syscap SystemCapability.ArkUI.ArkUI.Full 5304 * @since 7 5305 */ 5306 /** 5307 * The second button. 5308 * 5309 * @type { ?object } 5310 * @syscap SystemCapability.ArkUI.ArkUI.Full 5311 * @crossplatform 5312 * @since 10 5313 */ 5314 secondaryButton?: { 5315 /** 5316 * Button text value 5317 * 5318 * @type { string } 5319 * @syscap SystemCapability.ArkUI.ArkUI.Full 5320 * @since 7 5321 */ 5322 /** 5323 * Button text value 5324 * 5325 * @type { string } 5326 * @syscap SystemCapability.ArkUI.ArkUI.Full 5327 * @crossplatform 5328 * @since 10 5329 */ 5330 value: string; 5331 5332 /** 5333 * action 5334 * 5335 * @type { function } 5336 * @syscap SystemCapability.ArkUI.ArkUI.Full 5337 * @since 7 5338 */ 5339 /** 5340 * action 5341 * 5342 * @type { function } 5343 * @syscap SystemCapability.ArkUI.ArkUI.Full 5344 * @crossplatform 5345 * @since 10 5346 */ 5347 action: () => void; 5348 }; 5349 5350 /** 5351 * on State Change 5352 * 5353 * @type { ?function } 5354 * @syscap SystemCapability.ArkUI.ArkUI.Full 5355 * @since 7 5356 */ 5357 /** 5358 * on State Change 5359 * 5360 * @type { ?function } 5361 * @syscap SystemCapability.ArkUI.ArkUI.Full 5362 * @crossplatform 5363 * @since 10 5364 */ 5365 onStateChange?: (event: { 5366 /** 5367 * is Visible. 5368 * 5369 * @type { boolean } 5370 * @syscap SystemCapability.ArkUI.ArkUI.Full 5371 * @crossplatform 5372 * @since 10 5373 */ 5374 isVisible: boolean 5375 }) => void; 5376 5377 /** 5378 * The offset of the sharp corner of popup. 5379 * 5380 * @type { ?Length } 5381 * @syscap SystemCapability.ArkUI.ArkUI.Full 5382 * @since 9 5383 */ 5384 /** 5385 * The offset of the sharp corner of popup. 5386 * 5387 * @type { ?Length } 5388 * @syscap SystemCapability.ArkUI.ArkUI.Full 5389 * @crossplatform 5390 * @since 10 5391 */ 5392 arrowOffset?: Length; 5393 5394 /** 5395 * Whether to display in the sub window. 5396 * 5397 * @type { ?boolean } 5398 * @syscap SystemCapability.ArkUI.ArkUI.Full 5399 * @since 9 5400 */ 5401 /** 5402 * Whether to display in the sub window. 5403 * 5404 * @type { ?boolean } 5405 * @syscap SystemCapability.ArkUI.ArkUI.Full 5406 * @crossplatform 5407 * @since 10 5408 */ 5409 showInSubWindow?: boolean; 5410 5411 /** 5412 * The mask to block gesture events of popup. 5413 * When mask is set false, gesture events are not blocked. 5414 * When mask is set true, gesture events are blocked and mask color is transparent. 5415 * 5416 * @type { ?(boolean | { color: ResourceColor }) } 5417 * @syscap SystemCapability.ArkUI.ArkUI.Full 5418 * @crossplatform 5419 * @since 10 5420 */ 5421 mask?: boolean | { color: ResourceColor }; 5422 5423 /** 5424 * Sets the options of popup message. 5425 * 5426 * @type { ?PopupMessageOptions } 5427 * @syscap SystemCapability.ArkUI.ArkUI.Full 5428 * @crossplatform 5429 * @since 10 5430 */ 5431 messageOptions?: PopupMessageOptions 5432 5433 /** 5434 * Sets the space of between the popup and target. 5435 * 5436 * @type { ?Length } 5437 * @syscap SystemCapability.ArkUI.ArkUI.Full 5438 * @crossplatform 5439 * @since 10 5440 */ 5441 targetSpace?: Length 5442 5443 /** 5444 * whether show arrow 5445 * 5446 * @type { ?boolean } 5447 * @default true 5448 * @syscap SystemCapability.ArkUI.ArkUI.Full 5449 * @since 10 5450 */ 5451 enableArrow?: boolean; 5452 /** 5453 * Sets the position offset of the popup. 5454 * 5455 * @type { ?Position } 5456 * @syscap SystemCapability.ArkUI.ArkUI.Full 5457 * @crossplatform 5458 * @since 10 5459 */ 5460 offset?: Position 5461} 5462 5463/** 5464 * Defines the custom popup options. 5465 * 5466 * @interface CustomPopupOptions 5467 * @syscap SystemCapability.ArkUI.ArkUI.Full 5468 * @since 8 5469 */ 5470/** 5471 * Defines the custom popup options. 5472 * 5473 * @interface CustomPopupOptions 5474 * @syscap SystemCapability.ArkUI.ArkUI.Full 5475 * @crossplatform 5476 * @since 10 5477 */ 5478declare interface CustomPopupOptions { 5479 /** 5480 * builder of popup 5481 * 5482 * @type { CustomBuilder } 5483 * @syscap SystemCapability.ArkUI.ArkUI.Full 5484 * @since 8 5485 */ 5486 /** 5487 * builder of popup 5488 * 5489 * @type { CustomBuilder } 5490 * @syscap SystemCapability.ArkUI.ArkUI.Full 5491 * @crossplatform 5492 * @since 10 5493 */ 5494 builder: CustomBuilder; 5495 5496 /** 5497 * placement of popup 5498 * 5499 * @type { ?Placement } 5500 * @syscap SystemCapability.ArkUI.ArkUI.Full 5501 * @since 8 5502 */ 5503 /** 5504 * placement of popup 5505 * 5506 * @type { ?Placement } 5507 * @syscap SystemCapability.ArkUI.ArkUI.Full 5508 * @crossplatform 5509 * @since 10 5510 */ 5511 placement?: Placement; 5512 5513 /** 5514 * mask color of popup 5515 * 5516 * @type { ?(Color | string | Resource | number) } 5517 * @syscap SystemCapability.ArkUI.ArkUI.Full 5518 * @since 8 5519 * @deprecated since 10 5520 * @useinstead CustomPopupOptions#mask 5521 */ 5522 maskColor?: Color | string | Resource | number; 5523 5524 /** 5525 * background color of popup 5526 * 5527 * @type { ?(Color | string | Resource | number) } 5528 * @syscap SystemCapability.ArkUI.ArkUI.Full 5529 * @since 8 5530 */ 5531 /** 5532 * background color of popup 5533 * 5534 * @type { ?(Color | string | Resource | number) } 5535 * @syscap SystemCapability.ArkUI.ArkUI.Full 5536 * @crossplatform 5537 * @since 10 5538 */ 5539 popupColor?: Color | string | Resource | number; 5540 5541 /** 5542 * whether show arrow 5543 * 5544 * @type { ?boolean } 5545 * @syscap SystemCapability.ArkUI.ArkUI.Full 5546 * @since 8 5547 */ 5548 /** 5549 * whether show arrow 5550 * 5551 * @type { ?boolean } 5552 * @syscap SystemCapability.ArkUI.ArkUI.Full 5553 * @crossplatform 5554 * @since 10 5555 */ 5556 enableArrow?: boolean; 5557 5558 /** 5559 * whether hide popup when click mask 5560 * 5561 * @type { ?boolean } 5562 * @syscap SystemCapability.ArkUI.ArkUI.Full 5563 * @since 8 5564 */ 5565 /** 5566 * whether hide popup when click mask 5567 * 5568 * @type { ?boolean } 5569 * @syscap SystemCapability.ArkUI.ArkUI.Full 5570 * @crossplatform 5571 * @since 10 5572 */ 5573 autoCancel?: boolean; 5574 5575 /** 5576 * on State Change 5577 * 5578 * @type { ?function } 5579 * @syscap SystemCapability.ArkUI.ArkUI.Full 5580 * @since 8 5581 */ 5582 /** 5583 * on State Change 5584 * 5585 * @type { ?function } 5586 * @syscap SystemCapability.ArkUI.ArkUI.Full 5587 * @crossplatform 5588 * @since 10 5589 */ 5590 onStateChange?: (event: { 5591 /** 5592 * is Visible. 5593 * 5594 * @type { boolean } 5595 * @syscap SystemCapability.ArkUI.ArkUI.Full 5596 * @crossplatform 5597 * @since 10 5598 */ 5599 isVisible: boolean 5600 }) => void; 5601 5602 /** 5603 * The offset of the sharp corner of popup. 5604 * 5605 * @type { ?Length } 5606 * @syscap SystemCapability.ArkUI.ArkUI.Full 5607 * @since 9 5608 */ 5609 /** 5610 * The offset of the sharp corner of popup. 5611 * 5612 * @type { ?Length } 5613 * @syscap SystemCapability.ArkUI.ArkUI.Full 5614 * @crossplatform 5615 * @since 10 5616 */ 5617 arrowOffset?: Length; 5618 5619 /** 5620 * Whether to display in the sub window. 5621 * 5622 * @type { ?boolean } 5623 * @syscap SystemCapability.ArkUI.ArkUI.Full 5624 * @since 9 5625 */ 5626 /** 5627 * Whether to display in the sub window. 5628 * 5629 * @type { ?boolean } 5630 * @syscap SystemCapability.ArkUI.ArkUI.Full 5631 * @crossplatform 5632 * @since 10 5633 */ 5634 showInSubWindow?: boolean; 5635 5636 /** 5637 * The mask to block gesture events of popup. 5638 * When mask is set false, gesture events are not blocked. 5639 * When mask is set true, gesture events are blocked and mask color is transparent. 5640 * 5641 * @type { ?(boolean | { color: ResourceColor }) } 5642 * @syscap SystemCapability.ArkUI.ArkUI.Full 5643 * @crossplatform 5644 * @since 10 5645 */ 5646 mask?: boolean | { color: ResourceColor }; 5647 5648 /** 5649 * Sets the space of between the popup and target. 5650 * 5651 * @type { ?Length } 5652 * @syscap SystemCapability.ArkUI.ArkUI.Full 5653 * @crossplatform 5654 * @since 10 5655 */ 5656 targetSpace?: Length 5657 5658 /** 5659 * Sets the position offset of the popup. 5660 * 5661 * @type { ?Position } 5662 * @syscap SystemCapability.ArkUI.ArkUI.Full 5663 * @crossplatform 5664 * @since 10 5665 */ 5666 offset?: Position 5667} 5668 5669/** 5670 * Defines the context menu options. 5671 * 5672 * @interface ContextMenuOptions 5673 * @syscap SystemCapability.ArkUI.ArkUI.Full 5674 * @crossplatform 5675 * @since 10 5676 */ 5677declare interface ContextMenuOptions { 5678 /** 5679 * Sets the position offset of the context menu window. 5680 * 5681 * @type { ?Position } 5682 * @default - 5683 * @syscap SystemCapability.ArkUI.ArkUI.Full 5684 * @crossplatform 5685 * @since 10 5686 */ 5687 offset?: Position; 5688 5689 /** 5690 * Sets the placement of the context menu window. 5691 * 5692 * @type { ?Placement } 5693 * @default - 5694 * @syscap SystemCapability.ArkUI.ArkUI.Full 5695 * @crossplatform 5696 * @since 10 5697 */ 5698 placement?: Placement; 5699 5700 /** 5701 * whether show arrow belong to the menu, default: false, not show arrow 5702 * 5703 * @type { ?boolean } 5704 * @default false 5705 * @syscap SystemCapability.ArkUI.ArkUI.Full 5706 * @since 10 5707 */ 5708 enableArrow?: boolean; 5709 5710 /** 5711 * The horizontal offset to the left of menu or vertical offset to the top of menu 5712 * 5713 * @type { ?Length } 5714 * @default 0 5715 * @syscap SystemCapability.ArkUI.ArkUI.Full 5716 * @since 10 5717 */ 5718 arrowOffset?: Length; 5719 5720 /** 5721 * Callback function when the context menu appears. 5722 * 5723 * @type { ?function } 5724 * @syscap SystemCapability.ArkUI.ArkUI.Full 5725 * @crossplatform 5726 * @since 10 5727 */ 5728 onAppear?: () => void; 5729 5730 /** 5731 * Callback function when the context menu disappear. 5732 * 5733 * @type { ?function } 5734 * @syscap SystemCapability.ArkUI.ArkUI.Full 5735 * @crossplatform 5736 * @since 10 5737 */ 5738 onDisappear?: () => void; 5739} 5740 5741/** 5742 * Defines the menu options. 5743 * 5744 * @interface MenuOptions 5745 * @syscap SystemCapability.ArkUI.ArkUI.Full 5746 * @crossplatform 5747 * @since 10 5748 */ 5749declare interface MenuOptions extends ContextMenuOptions { 5750 /** 5751 * Sets the title of the menu window. 5752 * 5753 * @type { ?ResourceStr } 5754 * @syscap SystemCapability.ArkUI.ArkUI.Full 5755 * @crossplatform 5756 * @since 10 5757 */ 5758 title?: ResourceStr; 5759} 5760 5761/** 5762 * Defines the ProgressMask class. 5763 * 5764 * @syscap SystemCapability.ArkUI.ArkUI.Full 5765 * @crossplatform 5766 * @since 10 5767 */ 5768declare class ProgressMask { 5769 /** 5770 * constructor. 5771 * 5772 * @param { number } value - indicates the current value of the progress. 5773 * @param { number } total - indicates the total value of the progress. 5774 * @param { ResourceColor } color - indicates the color of the mask. 5775 * @syscap SystemCapability.ArkUI.ArkUI.Full 5776 * @crossplatform 5777 * @since 10 5778 */ 5779 constructor(value: number, total: number, color: ResourceColor); 5780 5781 /** 5782 * Update the current value of the progress. 5783 * 5784 * @param { number } value - indicates the current value of the progress. 5785 * @syscap SystemCapability.ArkUI.ArkUI.Full 5786 * @crossplatform 5787 * @since 10 5788 */ 5789 updateProgress(value: number): void; 5790 5791 /** 5792 * Update the color of the mask. 5793 * 5794 * @param { ResourceColor } value - indicates the color of the mask. 5795 * @syscap SystemCapability.ArkUI.ArkUI.Full 5796 * @crossplatform 5797 * @since 10 5798 */ 5799 updateColor(value: ResourceColor): void; 5800} 5801 5802/** 5803 * Set the edge blur effect distance of the corresponding defense line of the component 5804 * When the component expand out, no re-layout is triggered 5805 * 5806 * @interface PixelStretchEffectOptions 5807 * @syscap SystemCapability.ArkUI.ArkUI.Full 5808 * @crossplatform 5809 * @since 10 5810 */ 5811declare interface PixelStretchEffectOptions { 5812 /** 5813 * top property. value range (-∞, ∞) 5814 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 5815 * 5816 * @type { ?Length } 5817 * @default 0 5818 * @syscap SystemCapability.ArkUI.ArkUI.Full 5819 * @crossplatform 5820 * @since 10 5821 */ 5822 top?: Length; 5823 5824 /** 5825 * bottom property. value range (-∞, ∞) 5826 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 5827 * 5828 * @type { ?Length } 5829 * @default 0 5830 * @syscap SystemCapability.ArkUI.ArkUI.Full 5831 * @crossplatform 5832 * @since 10 5833 */ 5834 bottom?: Length; 5835 5836 /** 5837 * left property. value range (-∞, ∞) 5838 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 5839 * 5840 * @type { ?Length } 5841 * @default 0 5842 * @syscap SystemCapability.ArkUI.ArkUI.Full 5843 * @crossplatform 5844 * @since 10 5845 */ 5846 left?: Length; 5847 5848 /** 5849 * right property. value range (-∞, ∞) 5850 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 5851 * 5852 * @default 0 5853 * @syscap SystemCapability.ArkUI.ArkUI.Full 5854 * @crossplatform 5855 * @since 10 5856 */ 5857 right?: Length; 5858} 5859 5860/** 5861 * Defines the click effect. 5862 * 5863 * @interface ClickEffect 5864 * @syscap SystemCapability.ArkUI.ArkUI.Full 5865 * @crossplatform 5866 * @since 10 5867 */ 5868declare interface ClickEffect { 5869 /** 5870 * Set the click effect level. 5871 * 5872 * @type { ClickEffectLevel } 5873 * @default ClickEffectLevel.Light 5874 * @syscap SystemCapability.ArkUI.ArkUI.Full 5875 * @since 10 5876 */ 5877 level: ClickEffectLevel; 5878 5879 /** 5880 * Set scale number. 5881 * This default scale is same as the scale of click effect level. 5882 * 5883 * @type { ?number } 5884 * @syscap SystemCapability.ArkUI.ArkUI.Full 5885 * @since 10 5886 */ 5887 scale?: number; 5888} 5889 5890/** 5891 * Define nested scroll options 5892 * 5893 * @interface NestedScrollOptions 5894 * @syscap SystemCapability.ArkUI.ArkUI.Full 5895 * @since 10 5896 */ 5897declare interface NestedScrollOptions { 5898 /** 5899 * Set NestedScrollMode when the scrollable component scrolls forward 5900 * 5901 * @type { NestedScrollMode } 5902 * @syscap SystemCapability.ArkUI.ArkUI.Full 5903 * @since 10 5904 */ 5905 scrollForward: NestedScrollMode; 5906 5907 /** 5908 * Set NestedScrollMode when the scrollable component scrolls backward 5909 * 5910 * @type { NestedScrollMode } 5911 * @syscap SystemCapability.ArkUI.ArkUI.Full 5912 * @since 10 5913 */ 5914 scrollBackward: NestedScrollMode; 5915} 5916 5917/** 5918 * CommonMethod. 5919 * 5920 * @syscap SystemCapability.ArkUI.ArkUI.Full 5921 * @since 7 5922 */ 5923/** 5924 * CommonMethod. 5925 * 5926 * @syscap SystemCapability.ArkUI.ArkUI.Full 5927 * @since 9 5928 * @form 5929 */ 5930/** 5931 * CommonMethod. 5932 * 5933 * @syscap SystemCapability.ArkUI.ArkUI.Full 5934 * @crossplatform 5935 * @since 10 5936 * @form 5937 */ 5938declare class CommonMethod<T> { 5939 /** 5940 * constructor. 5941 * 5942 * @syscap SystemCapability.ArkUI.ArkUI.Full 5943 * @systemapi 5944 * @since 7 5945 */ 5946 /** 5947 * constructor. 5948 * 5949 * @syscap SystemCapability.ArkUI.ArkUI.Full 5950 * @systemapi 5951 * @since 9 5952 * @form 5953 */ 5954 constructor(); 5955 5956 /** 5957 * Sets the width of the current component. 5958 * 5959 * @param { Length } value 5960 * @returns { T } 5961 * @syscap SystemCapability.ArkUI.ArkUI.Full 5962 * @since 7 5963 */ 5964 /** 5965 * Sets the width of the current component. 5966 * 5967 * @param { Length } value 5968 * @returns { T } 5969 * @syscap SystemCapability.ArkUI.ArkUI.Full 5970 * @since 9 5971 * @form 5972 */ 5973 /** 5974 * Sets the width of the current component. 5975 * 5976 * @param { Length } value 5977 * @returns { T } 5978 * @syscap SystemCapability.ArkUI.ArkUI.Full 5979 * @crossplatform 5980 * @since 10 5981 * @form 5982 */ 5983 width(value: Length): T; 5984 5985 /** 5986 * Sets the height of the current component. 5987 * 5988 * @param { Length } value 5989 * @returns { T } 5990 * @syscap SystemCapability.ArkUI.ArkUI.Full 5991 * @since 7 5992 */ 5993 /** 5994 * Sets the height of the current component. 5995 * 5996 * @param { Length } value 5997 * @returns { T } 5998 * @syscap SystemCapability.ArkUI.ArkUI.Full 5999 * @since 9 6000 * @form 6001 */ 6002 /** 6003 * Sets the height of the current component. 6004 * 6005 * @param { Length } value 6006 * @returns { T } 6007 * @syscap SystemCapability.ArkUI.ArkUI.Full 6008 * @crossplatform 6009 * @since 10 6010 * @form 6011 */ 6012 height(value: Length): T; 6013 6014 /** 6015 * Expands the safe area. 6016 * 6017 * @param { Array<SafeAreaType> } types - Indicates the types of the safe area. 6018 * @param { Array<SafeAreaEdge> } edges - Indicates the edges of the safe area. 6019 * @returns { T } The component instance. 6020 * @syscap SystemCapability.ArkUI.ArkUI.Full 6021 * @crossplatform 6022 * @since 10 6023 */ 6024 expandSafeArea(types?: Array<SafeAreaType>, edges?: Array<SafeAreaEdge>): T; 6025 6026 /** 6027 * Sets the response region of the current component. 6028 * 6029 * @param { Array<Rectangle> | Rectangle } value 6030 * @returns { T } 6031 * @syscap SystemCapability.ArkUI.ArkUI.Full 6032 * @since 8 6033 */ 6034 /** 6035 * Sets the response region of the current component. 6036 * 6037 * @param { Array<Rectangle> | Rectangle } value 6038 * @returns { T } 6039 * @syscap SystemCapability.ArkUI.ArkUI.Full 6040 * @since 9 6041 * @form 6042 */ 6043 /** 6044 * Sets the response region of the current component. 6045 * 6046 * @param { Array<Rectangle> | Rectangle } value 6047 * @returns { T } 6048 * @syscap SystemCapability.ArkUI.ArkUI.Full 6049 * @crossplatform 6050 * @since 10 6051 * @form 6052 */ 6053 responseRegion(value: Array<Rectangle> | Rectangle): T; 6054 6055 /** 6056 * Sets the mouse response region of current component 6057 * 6058 * @param { Array<Rectangle> | Rectangle } value 6059 * @returns { T } return the component attribute 6060 * @syscap SystemCapability.ArkUI.ArkUI.Full 6061 * @crossplatform 6062 * @since 10 6063 */ 6064 mouseResponseRegion(value: Array<Rectangle> | Rectangle): T; 6065 6066 /** 6067 * The size of the current component. 6068 * 6069 * @param { SizeOptions } value 6070 * @returns { T } 6071 * @syscap SystemCapability.ArkUI.ArkUI.Full 6072 * @since 7 6073 */ 6074 /** 6075 * The size of the current component. 6076 * 6077 * @param { SizeOptions } value 6078 * @returns { T } 6079 * @syscap SystemCapability.ArkUI.ArkUI.Full 6080 * @since 9 6081 * @form 6082 */ 6083 /** 6084 * The size of the current component. 6085 * 6086 * @param { SizeOptions } value 6087 * @returns { T } 6088 * @syscap SystemCapability.ArkUI.ArkUI.Full 6089 * @crossplatform 6090 * @since 10 6091 * @form 6092 */ 6093 size(value: SizeOptions): T; 6094 6095 /** 6096 * constraint Size: 6097 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 6098 * 6099 * @param { ConstraintSizeOptions } value 6100 * @returns { T } 6101 * @syscap SystemCapability.ArkUI.ArkUI.Full 6102 * @since 7 6103 */ 6104 /** 6105 * constraint Size: 6106 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 6107 * 6108 * @param { ConstraintSizeOptions } value 6109 * @returns { T } 6110 * @syscap SystemCapability.ArkUI.ArkUI.Full 6111 * @since 9 6112 * @form 6113 */ 6114 /** 6115 * constraint Size: 6116 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 6117 * 6118 * @param { ConstraintSizeOptions } value 6119 * @returns { T } 6120 * @syscap SystemCapability.ArkUI.ArkUI.Full 6121 * @crossplatform 6122 * @since 10 6123 * @form 6124 */ 6125 constraintSize(value: ConstraintSizeOptions): T; 6126 6127 /** 6128 * Sets the touchable of the current component 6129 * 6130 * @param { boolean } value 6131 * @returns { T } 6132 * @syscap SystemCapability.ArkUI.ArkUI.Full 6133 * @since 7 6134 * @deprecated since 9 6135 * @useinstead hitTestBehavior 6136 */ 6137 touchable(value: boolean): T; 6138 6139 /** 6140 * Defines the component's hit test behavior in touch events. 6141 * 6142 * @param { HitTestMode } value - the hit test mode. 6143 * @returns { T } 6144 * @syscap SystemCapability.ArkUI.ArkUI.Full 6145 * @since 9 6146 */ 6147 /** 6148 * Defines the component's hit test behavior in touch events. 6149 * 6150 * @param { HitTestMode } value - the hit test mode. 6151 * @returns { T } 6152 * @syscap SystemCapability.ArkUI.ArkUI.Full 6153 * @crossplatform 6154 * @since 10 6155 */ 6156 hitTestBehavior(value: HitTestMode): T; 6157 6158 /** 6159 * layout Weight 6160 * 6161 * @param { number | string } value 6162 * @returns { T } 6163 * @syscap SystemCapability.ArkUI.ArkUI.Full 6164 * @since 7 6165 */ 6166 /** 6167 * layout Weight 6168 * 6169 * @param { number | string } value 6170 * @returns { T } 6171 * @syscap SystemCapability.ArkUI.ArkUI.Full 6172 * @since 9 6173 * @form 6174 */ 6175 /** 6176 * layout Weight 6177 * 6178 * @param { number | string } value 6179 * @returns { T } 6180 * @syscap SystemCapability.ArkUI.ArkUI.Full 6181 * @crossplatform 6182 * @since 10 6183 * @form 6184 */ 6185 layoutWeight(value: number | string): T; 6186 6187 /** 6188 * Inner margin. 6189 * 6190 * @param { Padding | Length } value 6191 * @returns { T } 6192 * @syscap SystemCapability.ArkUI.ArkUI.Full 6193 * @since 7 6194 */ 6195 /** 6196 * Inner margin. 6197 * 6198 * @param { Padding | Length } value 6199 * @returns { T } 6200 * @syscap SystemCapability.ArkUI.ArkUI.Full 6201 * @since 9 6202 * @form 6203 */ 6204 /** 6205 * Inner margin. 6206 * 6207 * @param { Padding | Length } value 6208 * @returns { T } 6209 * @syscap SystemCapability.ArkUI.ArkUI.Full 6210 * @crossplatform 6211 * @since 10 6212 * @form 6213 */ 6214 padding(value: Padding | Length): T; 6215 6216 /** 6217 * Outer Margin. 6218 * 6219 * @param { Margin | Length } value 6220 * @returns { T } 6221 * @syscap SystemCapability.ArkUI.ArkUI.Full 6222 * @since 7 6223 */ 6224 /** 6225 * Outer Margin. 6226 * 6227 * @param { Margin | Length } value 6228 * @returns { T } 6229 * @syscap SystemCapability.ArkUI.ArkUI.Full 6230 * @since 9 6231 * @form 6232 */ 6233 /** 6234 * Outer Margin. 6235 * 6236 * @param { Margin | Length } value 6237 * @returns { T } 6238 * @syscap SystemCapability.ArkUI.ArkUI.Full 6239 * @crossplatform 6240 * @since 10 6241 * @form 6242 */ 6243 margin(value: Margin | Length): T; 6244 6245 /** 6246 * Background. 6247 * 6248 * @param { CustomBuilder } builder 6249 * @param { object } options 6250 * @returns { T } 6251 * @syscap SystemCapability.ArkUI.ArkUI.Full 6252 * @crossplatform 6253 * @since 10 6254 */ 6255 background(builder: CustomBuilder, options?: { align?: Alignment }): T; 6256 6257 /** 6258 * Background color 6259 * 6260 * @param { ResourceColor } value 6261 * @returns { T } 6262 * @syscap SystemCapability.ArkUI.ArkUI.Full 6263 * @since 7 6264 */ 6265 /** 6266 * Background color 6267 * 6268 * @param { ResourceColor } value 6269 * @returns { T } 6270 * @syscap SystemCapability.ArkUI.ArkUI.Full 6271 * @since 9 6272 * @form 6273 */ 6274 /** 6275 * Background color 6276 * 6277 * @param { ResourceColor } value 6278 * @returns { T } 6279 * @syscap SystemCapability.ArkUI.ArkUI.Full 6280 * @crossplatform 6281 * @since 10 6282 * @form 6283 */ 6284 backgroundColor(value: ResourceColor): T; 6285 6286 /** 6287 * Background image 6288 * src: Image address url 6289 * 6290 * @param { ResourceStr } src 6291 * @param { ImageRepeat } repeat 6292 * @returns { T } 6293 * @syscap SystemCapability.ArkUI.ArkUI.Full 6294 * @since 7 6295 */ 6296 /** 6297 * Background image 6298 * src: Image address url 6299 * 6300 * @param { ResourceStr } src 6301 * @param { ImageRepeat } repeat 6302 * @returns { T } 6303 * @syscap SystemCapability.ArkUI.ArkUI.Full 6304 * @since 9 6305 * @form 6306 */ 6307 /** 6308 * Background image 6309 * src: Image address url 6310 * 6311 * @param { ResourceStr } src 6312 * @param { ImageRepeat } repeat 6313 * @returns { T } 6314 * @syscap SystemCapability.ArkUI.ArkUI.Full 6315 * @crossplatform 6316 * @since 10 6317 * @form 6318 */ 6319 backgroundImage(src: ResourceStr, repeat?: ImageRepeat): T; 6320 6321 /** 6322 * Background image size 6323 * 6324 * @param { SizeOptions | ImageSize } value 6325 * @returns { T } 6326 * @syscap SystemCapability.ArkUI.ArkUI.Full 6327 * @since 7 6328 */ 6329 /** 6330 * Background image size 6331 * 6332 * @param { SizeOptions | ImageSize } value 6333 * @returns { T } 6334 * @syscap SystemCapability.ArkUI.ArkUI.Full 6335 * @since 9 6336 * @form 6337 */ 6338 /** 6339 * Background image size 6340 * 6341 * @param { SizeOptions | ImageSize } value 6342 * @returns { T } 6343 * @syscap SystemCapability.ArkUI.ArkUI.Full 6344 * @crossplatform 6345 * @since 10 6346 * @form 6347 */ 6348 backgroundImageSize(value: SizeOptions | ImageSize): T; 6349 6350 /** 6351 * Background image position 6352 * x:Horizontal coordinate;y:Vertical axis coordinate. 6353 * 6354 * @param { Position | Alignment } value 6355 * @returns { T } 6356 * @syscap SystemCapability.ArkUI.ArkUI.Full 6357 * @since 7 6358 */ 6359 /** 6360 * Background image position 6361 * x:Horizontal coordinate;y:Vertical axis coordinate. 6362 * 6363 * @param { Position | Alignment } value 6364 * @returns { T } 6365 * @syscap SystemCapability.ArkUI.ArkUI.Full 6366 * @since 9 6367 * @form 6368 */ 6369 /** 6370 * Background image position 6371 * x:Horizontal coordinate;y:Vertical axis coordinate. 6372 * 6373 * @param { Position | Alignment } value 6374 * @returns { T } 6375 * @syscap SystemCapability.ArkUI.ArkUI.Full 6376 * @crossplatform 6377 * @since 10 6378 * @form 6379 */ 6380 backgroundImagePosition(value: Position | Alignment): T; 6381 6382 /** 6383 * Background blur style. 6384 * blurStyle:Blur style type. 6385 * 6386 * @param { BlurStyle } value 6387 * @param { BackgroundBlurStyleOptions } options 6388 * @returns { T } 6389 * @syscap SystemCapability.ArkUI.ArkUI.Full 6390 * @since 9 6391 * @form 6392 */ 6393 /** 6394 * Background blur style. 6395 * blurStyle:Blur style type. 6396 * 6397 * @param { BlurStyle } value 6398 * @param { BackgroundBlurStyleOptions } options 6399 * @returns { T } 6400 * @syscap SystemCapability.ArkUI.ArkUI.Full 6401 * @crossplatform 6402 * @since 10 6403 * @form 6404 */ 6405 backgroundBlurStyle(value: BlurStyle, options?: BackgroundBlurStyleOptions): T; 6406 6407 /** 6408 * Foreground blur style. 6409 * blurStyle:Blur style type. 6410 * 6411 * @param { BlurStyle } value 6412 * @param { ForegroundBlurStyleOptions } options 6413 * @returns { T } 6414 * @syscap SystemCapability.ArkUI.ArkUI.Full 6415 * @crossplatform 6416 * @since 10 6417 */ 6418 foregroundBlurStyle(value: BlurStyle, options?: ForegroundBlurStyleOptions): T; 6419 6420 /** 6421 * Opacity 6422 * 6423 * @param { number | Resource } value 6424 * @returns { T } 6425 * @syscap SystemCapability.ArkUI.ArkUI.Full 6426 * @since 7 6427 */ 6428 /** 6429 * Opacity 6430 * 6431 * @param { number | Resource } value 6432 * @returns { T } 6433 * @syscap SystemCapability.ArkUI.ArkUI.Full 6434 * @since 9 6435 * @form 6436 */ 6437 /** 6438 * Opacity 6439 * 6440 * @param { number | Resource } value 6441 * @returns { T } 6442 * @syscap SystemCapability.ArkUI.ArkUI.Full 6443 * @crossplatform 6444 * @since 10 6445 * @form 6446 */ 6447 opacity(value: number | Resource): T; 6448 6449 /** 6450 * Opacity 6451 * width:Border width;color:Border color;radius:Border radius; 6452 * 6453 * @param { BorderOptions } value 6454 * @returns { T } 6455 * @syscap SystemCapability.ArkUI.ArkUI.Full 6456 * @since 7 6457 */ 6458 /** 6459 * Opacity 6460 * width:Border width;color:Border color;radius:Border radius; 6461 * 6462 * @param { BorderOptions } value 6463 * @returns { T } 6464 * @syscap SystemCapability.ArkUI.ArkUI.Full 6465 * @since 9 6466 * @form 6467 */ 6468 /** 6469 * Opacity 6470 * width:Border width;color:Border color;radius:Border radius; 6471 * 6472 * @param { BorderOptions } value 6473 * @returns { T } 6474 * @syscap SystemCapability.ArkUI.ArkUI.Full 6475 * @crossplatform 6476 * @since 10 6477 * @form 6478 */ 6479 border(value: BorderOptions): T; 6480 6481 /** 6482 * Border style 6483 * 6484 * @param { BorderStyle | EdgeStyles } value 6485 * @returns { T } 6486 * @syscap SystemCapability.ArkUI.ArkUI.Full 6487 * @since 7 6488 */ 6489 /** 6490 * Border style 6491 * 6492 * @param { BorderStyle | EdgeStyles } value 6493 * @returns { T } 6494 * @syscap SystemCapability.ArkUI.ArkUI.Full 6495 * @since 9 6496 * @form 6497 */ 6498 /** 6499 * Border style 6500 * 6501 * @param { BorderStyle | EdgeStyles } value 6502 * @returns { T } 6503 * @syscap SystemCapability.ArkUI.ArkUI.Full 6504 * @crossplatform 6505 * @since 10 6506 * @form 6507 */ 6508 borderStyle(value: BorderStyle | EdgeStyles): T; 6509 6510 /** 6511 * Border width 6512 * 6513 * @param { Length | EdgeWidths } value 6514 * @returns { T } 6515 * @syscap SystemCapability.ArkUI.ArkUI.Full 6516 * @since 7 6517 */ 6518 /** 6519 * Border width 6520 * 6521 * @param { Length | EdgeWidths } value 6522 * @returns { T } 6523 * @syscap SystemCapability.ArkUI.ArkUI.Full 6524 * @since 9 6525 * @form 6526 */ 6527 /** 6528 * Border width 6529 * 6530 * @param { Length | EdgeWidths } value 6531 * @returns { T } 6532 * @syscap SystemCapability.ArkUI.ArkUI.Full 6533 * @crossplatform 6534 * @since 10 6535 * @form 6536 */ 6537 borderWidth(value: Length | EdgeWidths): T; 6538 6539 /** 6540 * Border color 6541 * 6542 * @param { ResourceColor | EdgeColors } value 6543 * @returns { T } 6544 * @syscap SystemCapability.ArkUI.ArkUI.Full 6545 * @since 7 6546 */ 6547 /** 6548 * Border color 6549 * 6550 * @param { ResourceColor | EdgeColors } value 6551 * @returns { T } 6552 * @syscap SystemCapability.ArkUI.ArkUI.Full 6553 * @since 9 6554 * @form 6555 */ 6556 /** 6557 * Border color 6558 * 6559 * @param { ResourceColor | EdgeColors } value 6560 * @returns { T } 6561 * @syscap SystemCapability.ArkUI.ArkUI.Full 6562 * @crossplatform 6563 * @since 10 6564 * @form 6565 */ 6566 borderColor(value: ResourceColor | EdgeColors): T; 6567 6568 /** 6569 * Border radius 6570 * 6571 * @param { Length | BorderRadiuses } value 6572 * @returns { T } 6573 * @syscap SystemCapability.ArkUI.ArkUI.Full 6574 * @since 7 6575 */ 6576 /** 6577 * Border radius 6578 * 6579 * @param { Length | BorderRadiuses } value 6580 * @returns { T } 6581 * @syscap SystemCapability.ArkUI.ArkUI.Full 6582 * @since 9 6583 * @form 6584 */ 6585 /** 6586 * Border radius 6587 * 6588 * @param { Length | BorderRadiuses } value 6589 * @returns { T } 6590 * @syscap SystemCapability.ArkUI.ArkUI.Full 6591 * @crossplatform 6592 * @since 10 6593 * @form 6594 */ 6595 borderRadius(value: Length | BorderRadiuses): T; 6596 6597 /** 6598 * Border image 6599 * 6600 * @param { BorderImageOption } value 6601 * @returns { T } 6602 * @syscap SystemCapability.ArkUI.ArkUI.Full 6603 * @since 9 6604 * @form 6605 */ 6606 /** 6607 * Border image 6608 * 6609 * @param { BorderImageOption } value 6610 * @returns { T } 6611 * @syscap SystemCapability.ArkUI.ArkUI.Full 6612 * @crossplatform 6613 * @since 10 6614 * @form 6615 */ 6616 borderImage(value: BorderImageOption): T; 6617 6618 /** 6619 * Provides the general foreground color capability of UI components, and assigns color values 6620 * according to the characteristics of components. 6621 * 6622 * @param { ResourceColor | ColoringStrategy } value - indicates the color or color selection strategy 6623 * @returns { T } 6624 * @syscap SystemCapability.ArkUI.ArkUI.Full 6625 * @crossplatform 6626 * @since 10 6627 */ 6628 foregroundColor(value: ResourceColor | ColoringStrategy): T; 6629 6630 /** 6631 * Trigger a click event when a click is clicked. 6632 * 6633 * @param { function } event 6634 * @returns { T } 6635 * @syscap SystemCapability.ArkUI.ArkUI.Full 6636 * @since 7 6637 */ 6638 /** 6639 * Trigger a click event when a click is clicked. 6640 * 6641 * @param { function } event 6642 * @returns { T } 6643 * @syscap SystemCapability.ArkUI.ArkUI.Full 6644 * @since 9 6645 * @form 6646 */ 6647 /** 6648 * Trigger a click event when a click is clicked. 6649 * 6650 * @param { function } event 6651 * @returns { T } 6652 * @syscap SystemCapability.ArkUI.ArkUI.Full 6653 * @crossplatform 6654 * @since 10 6655 * @form 6656 */ 6657 onClick(event: (event: ClickEvent) => void): T; 6658 6659 /** 6660 * Trigger a hover event. 6661 * 6662 * @param { function } event 6663 * @returns { T } 6664 * @syscap SystemCapability.ArkUI.ArkUI.Full 6665 * @since 8 6666 */ 6667 onHover(event: (isHover: boolean, event: HoverEvent) => void): T; 6668 6669 /** 6670 * Set hover effect. 6671 * 6672 * @param { HoverEffect } value 6673 * @returns { T } 6674 * @syscap SystemCapability.ArkUI.ArkUI.Full 6675 * @since 8 6676 */ 6677 /** 6678 * Set hover effect. 6679 * 6680 * @param { HoverEffect } value 6681 * @returns { T } 6682 * @syscap SystemCapability.ArkUI.ArkUI.Full 6683 * @crossplatform 6684 * @since 10 6685 */ 6686 hoverEffect(value: HoverEffect): T; 6687 6688 /** 6689 * Trigger a mouse event. 6690 * 6691 * @param { function } event 6692 * @returns { T } 6693 * @syscap SystemCapability.ArkUI.ArkUI.Full 6694 * @since 8 6695 */ 6696 onMouse(event: (event: MouseEvent) => void): T; 6697 6698 /** 6699 * Trigger a touch event when touched. 6700 * 6701 * @param { function } event 6702 * @returns { T } 6703 * @syscap SystemCapability.ArkUI.ArkUI.Full 6704 * @since 7 6705 */ 6706 /** 6707 * Trigger a touch event when touched. 6708 * 6709 * @param { function } event 6710 * @returns { T } 6711 * @syscap SystemCapability.ArkUI.ArkUI.Full 6712 * @crossplatform 6713 * @since 10 6714 */ 6715 onTouch(event: (event: TouchEvent) => void): T; 6716 6717 /** 6718 * Keyboard input 6719 * 6720 * @param { function } event 6721 * @returns { T } 6722 * @syscap SystemCapability.ArkUI.ArkUI.Full 6723 * @since 7 6724 */ 6725 /** 6726 * Keyboard input 6727 * 6728 * @param { function } event 6729 * @returns { T } 6730 * @syscap SystemCapability.ArkUI.ArkUI.Full 6731 * @crossplatform 6732 * @since 10 6733 */ 6734 onKeyEvent(event: (event: KeyEvent) => void): T; 6735 6736 /** 6737 * Set focusable. 6738 * 6739 * @param { boolean } value 6740 * @returns { T } 6741 * @syscap SystemCapability.ArkUI.ArkUI.Full 6742 * @since 8 6743 */ 6744 /** 6745 * Set focusable. 6746 * 6747 * @param { boolean } value 6748 * @returns { T } 6749 * @syscap SystemCapability.ArkUI.ArkUI.Full 6750 * @crossplatform 6751 * @since 10 6752 */ 6753 focusable(value: boolean): T; 6754 6755 /** 6756 * Trigger a event when got focus. 6757 * 6758 * @param { function } event 6759 * @returns { T } 6760 * @syscap SystemCapability.ArkUI.ArkUI.Full 6761 * @since 8 6762 */ 6763 /** 6764 * Trigger a event when got focus. 6765 * 6766 * @param { function } event 6767 * @returns { T } 6768 * @syscap SystemCapability.ArkUI.ArkUI.Full 6769 * @crossplatform 6770 * @since 10 6771 */ 6772 onFocus(event: () => void): T; 6773 6774 /** 6775 * Trigger a event when lose focus. 6776 * 6777 * @param { function } event 6778 * @returns { T } 6779 * @syscap SystemCapability.ArkUI.ArkUI.Full 6780 * @since 8 6781 */ 6782 /** 6783 * Trigger a event when lose focus. 6784 * 6785 * @param { function } event 6786 * @returns { T } 6787 * @syscap SystemCapability.ArkUI.ArkUI.Full 6788 * @crossplatform 6789 * @since 10 6790 */ 6791 onBlur(event: () => void): T; 6792 6793 /** 6794 * Set focus index by key tab. 6795 * 6796 * @param { number } index 6797 * @returns { T } 6798 * @syscap SystemCapability.ArkUI.ArkUI.Full 6799 * @since 9 6800 */ 6801 /** 6802 * Set focus index by key tab. 6803 * 6804 * @param { number } index 6805 * @returns { T } 6806 * @syscap SystemCapability.ArkUI.ArkUI.Full 6807 * @crossplatform 6808 * @since 10 6809 */ 6810 tabIndex(index: number): T; 6811 6812 /** 6813 * Set default focused component when a page create. 6814 * 6815 * @param { boolean } value 6816 * @returns { T } 6817 * @syscap SystemCapability.ArkUI.ArkUI.Full 6818 * @since 9 6819 */ 6820 /** 6821 * Set default focused component when a page create. 6822 * 6823 * @param { boolean } value 6824 * @returns { T } 6825 * @syscap SystemCapability.ArkUI.ArkUI.Full 6826 * @crossplatform 6827 * @since 10 6828 */ 6829 defaultFocus(value: boolean): T; 6830 6831 /** 6832 * Set default focused component when focus on a focus group. 6833 * 6834 * @param { boolean } value 6835 * @returns { T } 6836 * @syscap SystemCapability.ArkUI.ArkUI.Full 6837 * @since 9 6838 */ 6839 /** 6840 * Set default focused component when focus on a focus group. 6841 * 6842 * @param { boolean } value 6843 * @returns { T } 6844 * @syscap SystemCapability.ArkUI.ArkUI.Full 6845 * @crossplatform 6846 * @since 10 6847 */ 6848 groupDefaultFocus(value: boolean): T; 6849 6850 /** 6851 * Set a component focused when the component be touched. 6852 * 6853 * @param { boolean } value 6854 * @returns { T } 6855 * @syscap SystemCapability.ArkUI.ArkUI.Full 6856 * @since 9 6857 */ 6858 /** 6859 * Set a component focused when the component be touched. 6860 * 6861 * @param { boolean } value 6862 * @returns { T } 6863 * @syscap SystemCapability.ArkUI.ArkUI.Full 6864 * @crossplatform 6865 * @since 10 6866 */ 6867 focusOnTouch(value: boolean): T; 6868 6869 /**git 6870 * animation 6871 * 6872 * @param { AnimateParam } value 6873 * @returns { T } 6874 * @syscap SystemCapability.ArkUI.ArkUI.Full 6875 * @since 7 6876 */ 6877 /** 6878 * animation 6879 * 6880 * @param { AnimateParam } value 6881 * @returns { T } 6882 * @syscap SystemCapability.ArkUI.ArkUI.Full 6883 * @since 9 6884 * @form 6885 */ 6886 /** 6887 * animation 6888 * 6889 * @param { AnimateParam } value 6890 * @returns { T } 6891 * @syscap SystemCapability.ArkUI.ArkUI.Full 6892 * @crossplatform 6893 * @since 10 6894 * @form 6895 */ 6896 animation(value: AnimateParam): T; 6897 6898 /** 6899 * Transition parameter 6900 * 6901 * @param { TransitionOptions | TransitionEffect } value 6902 * @returns { T } 6903 * @syscap SystemCapability.ArkUI.ArkUI.Full 6904 * @since 7 6905 */ 6906 /** 6907 * Transition parameter 6908 * 6909 * @param { TransitionOptions | TransitionEffect } value - transition options 6910 * @returns { T } 6911 * @syscap SystemCapability.ArkUI.ArkUI.Full 6912 * @since 9 6913 * @form 6914 */ 6915 /** 6916 * Transition parameter 6917 * 6918 * @param { TransitionOptions | TransitionEffect } value - transition options or transition effect 6919 * @returns { T } 6920 * @syscap SystemCapability.ArkUI.ArkUI.Full 6921 * @crossplatform 6922 * @since 10 6923 * @form 6924 */ 6925 transition(value: TransitionOptions | TransitionEffect): T; 6926 6927 /** 6928 * Bind gesture recognition. 6929 * gesture:Bound Gesture Type,mask:GestureMask; 6930 * 6931 * @param { GestureType } gesture 6932 * @param { GestureMask } mask 6933 * @returns { T } 6934 * @syscap SystemCapability.ArkUI.ArkUI.Full 6935 * @since 7 6936 */ 6937 /** 6938 * Bind gesture recognition. 6939 * gesture:Bound Gesture Type,mask:GestureMask; 6940 * 6941 * @param { GestureType } gesture 6942 * @param { GestureMask } mask 6943 * @returns { T } 6944 * @syscap SystemCapability.ArkUI.ArkUI.Full 6945 * @crossplatform 6946 * @since 10 6947 */ 6948 gesture(gesture: GestureType, mask?: GestureMask): T; 6949 6950 /** 6951 * Binding Preferential Recognition Gestures 6952 * gesture:Bound Gesture Type,mask:GestureMask; 6953 * 6954 * @param { GestureType } gesture 6955 * @param { GestureMask } mask 6956 * @returns { T } 6957 * @syscap SystemCapability.ArkUI.ArkUI.Full 6958 * @since 7 6959 */ 6960 /** 6961 * Binding Preferential Recognition Gestures 6962 * gesture:Bound Gesture Type,mask:GestureMask; 6963 * 6964 * @param { GestureType } gesture 6965 * @param { GestureMask } mask 6966 * @returns { T } 6967 * @syscap SystemCapability.ArkUI.ArkUI.Full 6968 * @crossplatform 6969 * @since 10 6970 */ 6971 priorityGesture(gesture: GestureType, mask?: GestureMask): T; 6972 6973 /** 6974 * Binding gestures that can be triggered simultaneously with internal component gestures 6975 * gesture:Bound Gesture Type,mask:GestureMask; 6976 * 6977 * @param { GestureType } gesture 6978 * @param { GestureMask } mask 6979 * @returns { T } 6980 * @syscap SystemCapability.ArkUI.ArkUI.Full 6981 * @since 7 6982 */ 6983 /** 6984 * Binding gestures that can be triggered simultaneously with internal component gestures 6985 * gesture:Bound Gesture Type,mask:GestureMask; 6986 * 6987 * @param { GestureType } gesture 6988 * @param { GestureMask } mask 6989 * @returns { T } 6990 * @syscap SystemCapability.ArkUI.ArkUI.Full 6991 * @crossplatform 6992 * @since 10 6993 */ 6994 parallelGesture(gesture: GestureType, mask?: GestureMask): T; 6995 6996 /** 6997 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 6998 * The larger the blurring radius, the more blurring the content. 6999 * If the value is 0, the content blurring effect is not blurring. 7000 * 7001 * @param { number } value 7002 * @returns { T } 7003 * @syscap SystemCapability.ArkUI.ArkUI.Full 7004 * @since 7 7005 */ 7006 /** 7007 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 7008 * The larger the blurring radius, the more blurring the content. 7009 * If the value is 0, the content blurring effect is not blurring. 7010 * 7011 * @param { number } value 7012 * @returns { T } 7013 * @syscap SystemCapability.ArkUI.ArkUI.Full 7014 * @since 9 7015 * @form 7016 */ 7017 /** 7018 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 7019 * The larger the blurring radius, the more blurring the content. 7020 * If the value is 0, the content blurring effect is not blurring. 7021 * 7022 * @param { number } value 7023 * @returns { T } 7024 * @syscap SystemCapability.ArkUI.ArkUI.Full 7025 * @crossplatform 7026 * @since 10 7027 * @form 7028 */ 7029 blur(value: number): T; 7030 7031 /** 7032 * Adds the content linear gradient blurring effect for the current component. The input parameter is the blurring radius. 7033 * 7034 * @param { number } value - the blurring radius. 7035 * The larger the blurring radius, the more blurring the content, and if the value is 0, the content blurring effect is not blurring. 7036 * @param { LinearGradientBlurOptions } options - the linear gradient blur options. 7037 * @returns { T } 7038 * @syscap SystemCapability.ArkUI.ArkUI.Full 7039 * @systemapi 7040 * @since 10 7041 */ 7042 linearGradientBlur(value: number, options: LinearGradientBlurOptions): T; 7043 7044 /** 7045 * Adds a highlight effect to the current component. 7046 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 7047 * The component is displayed as all white (percentage). 7048 * 7049 * @param { number } value 7050 * @returns { T } 7051 * @syscap SystemCapability.ArkUI.ArkUI.Full 7052 * @since 7 7053 */ 7054 /** 7055 * Adds a highlight effect to the current component. 7056 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 7057 * The component is displayed as all white (percentage). 7058 * 7059 * @param { number } value 7060 * @returns { T } 7061 * @syscap SystemCapability.ArkUI.ArkUI.Full 7062 * @since 9 7063 * @form 7064 */ 7065 /** 7066 * Adds a highlight effect to the current component. 7067 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 7068 * The component is displayed as all white (percentage). 7069 * 7070 * @param { number } value 7071 * @returns { T } 7072 * @syscap SystemCapability.ArkUI.ArkUI.Full 7073 * @crossplatform 7074 * @since 10 7075 * @form 7076 */ 7077 brightness(value: number): T; 7078 7079 /** 7080 * Adds a contrast effect to the current component. The input parameter is the contrast value. 7081 * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) 7082 * 7083 * @param { number } value 7084 * @returns { T } 7085 * @syscap SystemCapability.ArkUI.ArkUI.Full 7086 * @since 7 7087 */ 7088 /** 7089 * Adds a contrast effect to the current component. The input parameter is the contrast value. 7090 * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) 7091 * 7092 * @param { number } value 7093 * @returns { T } 7094 * @syscap SystemCapability.ArkUI.ArkUI.Full 7095 * @since 9 7096 * @form 7097 */ 7098 /** 7099 * Adds a contrast effect to the current component. The input parameter is the contrast value. 7100 * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) 7101 * 7102 * @param { number } value 7103 * @returns { T } 7104 * @syscap SystemCapability.ArkUI.ArkUI.Full 7105 * @crossplatform 7106 * @since 10 7107 * @form 7108 */ 7109 contrast(value: number): T; 7110 7111 /** 7112 * Adds a grayscale effect to the current component. 7113 * The value is the gray scale conversion ratio. If the input parameter is 1.0, the gray scale image is completely converted to the gray scale image. If the input parameter is 0.0, the image does not change. 7114 * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) 7115 * 7116 * @param { number } value 7117 * @returns { T } 7118 * @syscap SystemCapability.ArkUI.ArkUI.Full 7119 * @since 7 7120 */ 7121 /** 7122 * Adds a grayscale effect to the current component. 7123 * The value is the gray scale conversion ratio. If the input parameter is 1.0, the gray scale image is completely converted to the gray scale image. If the input parameter is 0.0, the image does not change. 7124 * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) 7125 * 7126 * @param { number } value 7127 * @returns { T } 7128 * @syscap SystemCapability.ArkUI.ArkUI.Full 7129 * @since 9 7130 * @form 7131 */ 7132 /** 7133 * Adds a grayscale effect to the current component. 7134 * The value is the gray scale conversion ratio. If the input parameter is 1.0, the gray scale image is completely converted to the gray scale image. If the input parameter is 0.0, the image does not change. 7135 * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) 7136 * 7137 * @param { number } value 7138 * @returns { T } 7139 * @syscap SystemCapability.ArkUI.ArkUI.Full 7140 * @crossplatform 7141 * @since 10 7142 * @form 7143 */ 7144 grayscale(value: number): T; 7145 7146 /** 7147 * Adds a color overlay effect for the current component. The input parameter is the superimposed color. 7148 * 7149 * @param { Color | string | Resource } value 7150 * @returns { T } 7151 * @syscap SystemCapability.ArkUI.ArkUI.Full 7152 * @since 7 7153 */ 7154 /** 7155 * Adds a color overlay effect for the current component. The input parameter is the superimposed color. 7156 * 7157 * @param { Color | string | Resource } value 7158 * @returns { T } 7159 * @syscap SystemCapability.ArkUI.ArkUI.Full 7160 * @since 9 7161 * @form 7162 */ 7163 /** 7164 * Adds a color overlay effect for the current component. The input parameter is the superimposed color. 7165 * 7166 * @param { Color | string | Resource } value 7167 * @returns { T } 7168 * @syscap SystemCapability.ArkUI.ArkUI.Full 7169 * @crossplatform 7170 * @since 10 7171 * @form 7172 */ 7173 colorBlend(value: Color | string | Resource): T; 7174 7175 /** 7176 * Adds a saturation effect to the current component. 7177 * The saturation is the ratio of the color-containing component to the achromatic component (gray). 7178 * The larger the color-containing component, the greater the saturation. 7179 * The larger the achromatic component, the smaller the saturation. (Percentage) 7180 * 7181 * @param { number } value 7182 * @returns { T } 7183 * @syscap SystemCapability.ArkUI.ArkUI.Full 7184 * @since 7 7185 */ 7186 /** 7187 * Adds a saturation effect to the current component. 7188 * The saturation is the ratio of the color-containing component to the achromatic component (gray). 7189 * The larger the color-containing component, the greater the saturation. 7190 * The larger the achromatic component, the smaller the saturation. (Percentage) 7191 * 7192 * @param { number } value 7193 * @returns { T } 7194 * @syscap SystemCapability.ArkUI.ArkUI.Full 7195 * @since 9 7196 * @form 7197 */ 7198 /** 7199 * Adds a saturation effect to the current component. 7200 * The saturation is the ratio of the color-containing component to the achromatic component (gray). 7201 * The larger the color-containing component, the greater the saturation. 7202 * The larger the achromatic component, the smaller the saturation. (Percentage) 7203 * 7204 * @param { number } value 7205 * @returns { T } 7206 * @syscap SystemCapability.ArkUI.ArkUI.Full 7207 * @crossplatform 7208 * @since 10 7209 * @form 7210 */ 7211 saturate(value: number): T; 7212 7213 /** 7214 * Converts the image to sepia. Value defines the scale of the conversion. 7215 * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) 7216 * 7217 * @param { number } value 7218 * @returns { T } 7219 * @syscap SystemCapability.ArkUI.ArkUI.Full 7220 * @since 7 7221 */ 7222 /** 7223 * Converts the image to sepia. Value defines the scale of the conversion. 7224 * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) 7225 * 7226 * @param { number } value 7227 * @returns { T } 7228 * @syscap SystemCapability.ArkUI.ArkUI.Full 7229 * @since 9 7230 * @form 7231 */ 7232 /** 7233 * Converts the image to sepia. Value defines the scale of the conversion. 7234 * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) 7235 * 7236 * @param { number } value 7237 * @returns { T } 7238 * @syscap SystemCapability.ArkUI.ArkUI.Full 7239 * @crossplatform 7240 * @since 10 7241 * @form 7242 */ 7243 sepia(value: number): T; 7244 7245 /** 7246 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 7247 * A value of 0% does not change the image. (Percentage) 7248 * 7249 * @param { number } value 7250 * @returns { T } 7251 * @syscap SystemCapability.ArkUI.ArkUI.Full 7252 * @since 7 7253 */ 7254 /** 7255 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 7256 * A value of 0% does not change the image. (Percentage) 7257 * 7258 * @param { number } value 7259 * @returns { T } 7260 * @syscap SystemCapability.ArkUI.ArkUI.Full 7261 * @since 9 7262 * @form 7263 */ 7264 /** 7265 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 7266 * A value of 0% does not change the image. (Percentage) 7267 * 7268 * @param { number } value 7269 * @returns { T } 7270 * @syscap SystemCapability.ArkUI.ArkUI.Full 7271 * @crossplatform 7272 * @since 10 7273 * @form 7274 */ 7275 invert(value: number): T; 7276 7277 /** 7278 * Adds the hue rotation effect to the current component. 7279 * The input parameter is the rotation angle. When the input parameter is 0deg, the image does not change (the default value is 0deg), and the input parameter does not have a maximum value. 7280 * If the value exceeds 360deg, the image is circled again. 7281 * 7282 * @param { number | string } value 7283 * @returns { T } 7284 * @syscap SystemCapability.ArkUI.ArkUI.Full 7285 * @since 7 7286 */ 7287 /** 7288 * Adds the hue rotation effect to the current component. 7289 * The input parameter is the rotation angle. When the input parameter is 0deg, the image does not change (the default value is 0deg), and the input parameter does not have a maximum value. 7290 * If the value exceeds 360deg, the image is circled again. 7291 * 7292 * @param { number | string } value 7293 * @returns { T } 7294 * @syscap SystemCapability.ArkUI.ArkUI.Full 7295 * @since 9 7296 * @form 7297 */ 7298 /** 7299 * Adds the hue rotation effect to the current component. 7300 * The input parameter is the rotation angle. When the input parameter is 0deg, the image does not change (the default value is 0deg), and the input parameter does not have a maximum value. 7301 * If the value exceeds 360deg, the image is circled again. 7302 * 7303 * @param { number | string } value 7304 * @returns { T } 7305 * @syscap SystemCapability.ArkUI.ArkUI.Full 7306 * @crossplatform 7307 * @since 10 7308 * @form 7309 */ 7310 hueRotate(value: number | string): T; 7311 7312 /** 7313 * Sets whether the component should apply the effects template defined by the parent effectComponent. 7314 * If multiple parent effectComponents are found, the nearest one will be used. 7315 * If no parent effectComponent is found, this method has no effect. 7316 * 7317 * @param { boolean } value - true means the component should apply the effects template. 7318 * @returns { T } return the component attribute. 7319 * @syscap SystemCapability.ArkUI.ArkUI.Full 7320 * @systemapi 7321 * @since 10 7322 */ 7323 useEffect(value: boolean): T; 7324 7325 /** 7326 * Adds the background blur effect for the current component. The input parameter is the blur radius. 7327 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 7328 * 7329 * @param { number } value 7330 * @returns { T } 7331 * @syscap SystemCapability.ArkUI.ArkUI.Full 7332 * @since 7 7333 */ 7334 /** 7335 * Adds the background blur effect for the current component. The input parameter is the blur radius. 7336 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 7337 * 7338 * @param { number } value 7339 * @returns { T } 7340 * @syscap SystemCapability.ArkUI.ArkUI.Full 7341 * @since 9 7342 * @form 7343 */ 7344 /** 7345 * Adds the background blur effect for the current component. The input parameter is the blur radius. 7346 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 7347 * 7348 * @param { number } value 7349 * @returns { T } 7350 * @syscap SystemCapability.ArkUI.ArkUI.Full 7351 * @crossplatform 7352 * @since 10 7353 * @form 7354 */ 7355 backdropBlur(value: number): T; 7356 7357 /** 7358 * Composite the contents of this view and its children into an offscreen cache before display in the screen. 7359 * 7360 * @param { boolean } value - if this view and its children need to composite into an offscreen cache. 7361 * @returns { T } 7362 * @syscap SystemCapability.ArkUI.ArkUI.Full 7363 * @crossplatform 7364 * @since 10 7365 */ 7366 renderGroup(value: boolean): T; 7367 7368 /** 7369 * Sets the translation effect during page transition. 7370 * The value is the start point of entry and end point of exit. 7371 * When this parameter is set together with slide, slide takes effect by default. 7372 * 7373 * @param { TranslateOptions } value 7374 * @returns { T } 7375 * @syscap SystemCapability.ArkUI.ArkUI.Full 7376 * @since 7 7377 */ 7378 /** 7379 * Sets the translation effect during page transition. 7380 * The value is the start point of entry and end point of exit. 7381 * When this parameter is set together with slide, slide takes effect by default. 7382 * 7383 * @param { TranslateOptions } value 7384 * @returns { T } 7385 * @syscap SystemCapability.ArkUI.ArkUI.Full 7386 * @since 9 7387 * @form 7388 */ 7389 /** 7390 * Sets the translation effect during page transition. 7391 * The value is the start point of entry and end point of exit. 7392 * When this parameter is set together with slide, slide takes effect by default. 7393 * 7394 * @param { TranslateOptions } value 7395 * @returns { T } 7396 * @syscap SystemCapability.ArkUI.ArkUI.Full 7397 * @crossplatform 7398 * @since 10 7399 * @form 7400 */ 7401 translate(value: TranslateOptions): T; 7402 7403 /** 7404 * Sets the zoom effect during page transition. The value is the start point of entry and end point of exit. 7405 * 7406 * @param { ScaleOptions } value 7407 * @returns { T } 7408 * @syscap SystemCapability.ArkUI.ArkUI.Full 7409 * @since 7 7410 */ 7411 /** 7412 * Sets the zoom effect during page transition. The value is the start point of entry and end point of exit. 7413 * 7414 * @param { ScaleOptions } value 7415 * @returns { T } 7416 * @syscap SystemCapability.ArkUI.ArkUI.Full 7417 * @since 9 7418 * @form 7419 */ 7420 /** 7421 * Sets the zoom effect during page transition. The value is the start point of entry and end point of exit. 7422 * 7423 * @param { ScaleOptions } value 7424 * @returns { T } 7425 * @syscap SystemCapability.ArkUI.ArkUI.Full 7426 * @crossplatform 7427 * @since 10 7428 * @form 7429 */ 7430 scale(value: ScaleOptions): T; 7431 7432 /** 7433 * Default number of occupied columns, indicating the number of occupied grid columns when the number of columns (span) of the corresponding size is not set in the useSizeType attribute. 7434 * 7435 * @param { number } value 7436 * @returns { T } 7437 * @syscap SystemCapability.ArkUI.ArkUI.Full 7438 * @since 7 7439 */ 7440 /** 7441 * Default number of occupied columns, indicating the number of occupied grid columns when the number of columns (span) of the corresponding size is not set in the useSizeType attribute. 7442 * 7443 * @param { number } value 7444 * @returns { T } 7445 * @syscap SystemCapability.ArkUI.ArkUI.Full 7446 * @crossplatform 7447 * @since 10 7448 */ 7449 gridSpan(value: number): T; 7450 7451 /** 7452 * The default offset column number indicates the number of offset columns of the current component in the start direction of the parent component when the useSizeType attribute does not set the offset of the corresponding dimension. That is, 7453 * the current component is located in the nth column. 7454 * 7455 * @param { number } value 7456 * @returns { T } 7457 * @syscap SystemCapability.ArkUI.ArkUI.Full 7458 * @since 7 7459 */ 7460 /** 7461 * The default offset column number indicates the number of offset columns of the current component in the start direction of the parent component when the useSizeType attribute does not set the offset of the corresponding dimension. That is, 7462 * the current component is located in the nth column. 7463 * 7464 * @param { number } value 7465 * @returns { T } 7466 * @syscap SystemCapability.ArkUI.ArkUI.Full 7467 * @crossplatform 7468 * @since 10 7469 */ 7470 gridOffset(value: number): T; 7471 7472 /** 7473 * Sets the rotation effect during assembly transition. 7474 * The values are the start point during insertion and the end point during deletion. 7475 * 7476 * @param { RotateOptions } value 7477 * @returns { T } 7478 * @syscap SystemCapability.ArkUI.ArkUI.Full 7479 * @since 7 7480 */ 7481 /** 7482 * Sets the rotation effect during assembly transition. 7483 * The values are the start point during insertion and the end point during deletion. 7484 * 7485 * @param { RotateOptions } value 7486 * @returns { T } 7487 * @syscap SystemCapability.ArkUI.ArkUI.Full 7488 * @since 9 7489 * @form 7490 */ 7491 /** 7492 * Sets the rotation effect during assembly transition. 7493 * The values are the start point during insertion and the end point during deletion. 7494 * 7495 * @param { RotateOptions } value 7496 * @returns { T } 7497 * @syscap SystemCapability.ArkUI.ArkUI.Full 7498 * @crossplatform 7499 * @since 10 7500 * @form 7501 */ 7502 rotate(value: RotateOptions): T; 7503 7504 /** 7505 * Sets the transformation matrix for the current component. 7506 * 7507 * @param { object } value 7508 * @returns { T } 7509 * @syscap SystemCapability.ArkUI.ArkUI.Full 7510 * @since 7 7511 */ 7512 /** 7513 * Sets the transformation matrix for the current component. 7514 * 7515 * @param { object } value 7516 * @returns { T } 7517 * @syscap SystemCapability.ArkUI.ArkUI.Full 7518 * @crossplatform 7519 * @since 10 7520 */ 7521 transform(value: object): T; 7522 7523 /** 7524 * This callback is triggered when a component mounts a display. 7525 * 7526 * @param { function } event 7527 * @returns { T } 7528 * @syscap SystemCapability.ArkUI.ArkUI.Full 7529 * @since 7 7530 */ 7531 /** 7532 * This callback is triggered when a component mounts a display. 7533 * 7534 * @param { function } event 7535 * @returns { T } 7536 * @syscap SystemCapability.ArkUI.ArkUI.Full 7537 * @since 9 7538 * @form 7539 */ 7540 /** 7541 * This callback is triggered when a component mounts a display. 7542 * 7543 * @param { function } event 7544 * @returns { T } 7545 * @syscap SystemCapability.ArkUI.ArkUI.Full 7546 * @crossplatform 7547 * @since 10 7548 * @form 7549 */ 7550 onAppear(event: () => void): T; 7551 7552 /** 7553 * This callback is triggered when component uninstallation disappears. 7554 * 7555 * @param { function } event 7556 * @returns { T } 7557 * @syscap SystemCapability.ArkUI.ArkUI.Full 7558 * @since 7 7559 */ 7560 /** 7561 * This callback is triggered when component uninstallation disappears. 7562 * 7563 * @param { function } event 7564 * @returns { T } 7565 * @syscap SystemCapability.ArkUI.ArkUI.Full 7566 * @since 9 7567 * @form 7568 */ 7569 /** 7570 * This callback is triggered when component uninstallation disappears. 7571 * 7572 * @param { function } event 7573 * @returns { T } 7574 * @syscap SystemCapability.ArkUI.ArkUI.Full 7575 * @crossplatform 7576 * @since 10 7577 * @form 7578 */ 7579 onDisAppear(event: () => void): T; 7580 7581 /** 7582 * This callback is triggered when the size or position of this component change finished. 7583 * 7584 * @param { function } event - event callback. 7585 * @returns { T } 7586 * @syscap SystemCapability.ArkUI.ArkUI.Full 7587 * @since 8 7588 */ 7589 /** 7590 * This callback is triggered when the size or position of this component change finished. 7591 * 7592 * @param { function } event - event callback. 7593 * @returns { T } 7594 * @syscap SystemCapability.ArkUI.ArkUI.Full 7595 * @crossplatform 7596 * @since 10 7597 */ 7598 onAreaChange(event: (oldValue: Area, newValue: Area) => void): T; 7599 7600 /** 7601 * Controls the display or hide of the current component. 7602 * 7603 * @param { Visibility } value 7604 * @returns { T } 7605 * @syscap SystemCapability.ArkUI.ArkUI.Full 7606 * @since 7 7607 */ 7608 /** 7609 * Controls the display or hide of the current component. 7610 * 7611 * @param { Visibility } value 7612 * @returns { T } 7613 * @syscap SystemCapability.ArkUI.ArkUI.Full 7614 * @since 9 7615 * @form 7616 */ 7617 /** 7618 * Controls the display or hide of the current component. 7619 * 7620 * @param { Visibility } value 7621 * @returns { T } 7622 * @syscap SystemCapability.ArkUI.ArkUI.Full 7623 * @crossplatform 7624 * @since 10 7625 * @form 7626 */ 7627 visibility(value: Visibility): T; 7628 7629 /** 7630 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 7631 * 7632 * @param { number } value 7633 * @returns { T } 7634 * @syscap SystemCapability.ArkUI.ArkUI.Full 7635 * @since 7 7636 */ 7637 /** 7638 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 7639 * 7640 * @param { number } value 7641 * @returns { T } 7642 * @syscap SystemCapability.ArkUI.ArkUI.Full 7643 * @since 9 7644 * @form 7645 */ 7646 /** 7647 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 7648 * 7649 * @param { number } value 7650 * @returns { T } 7651 * @syscap SystemCapability.ArkUI.ArkUI.Full 7652 * @crossplatform 7653 * @since 10 7654 * @form 7655 */ 7656 flexGrow(value: number): T; 7657 7658 /** 7659 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 7660 * 7661 * @param { number } value 7662 * @returns { T } 7663 * @syscap SystemCapability.ArkUI.ArkUI.Full 7664 * @since 7 7665 */ 7666 /** 7667 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 7668 * 7669 * @param { number } value 7670 * @returns { T } 7671 * @syscap SystemCapability.ArkUI.ArkUI.Full 7672 * @since 9 7673 * @form 7674 */ 7675 /** 7676 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 7677 * 7678 * @param { number } value 7679 * @returns { T } 7680 * @syscap SystemCapability.ArkUI.ArkUI.Full 7681 * @crossplatform 7682 * @since 10 7683 * @form 7684 */ 7685 flexShrink(value: number): T; 7686 7687 /** 7688 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 7689 * 7690 * @param { number | string } value 7691 * @returns { T } 7692 * @syscap SystemCapability.ArkUI.ArkUI.Full 7693 * @since 7 7694 */ 7695 /** 7696 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 7697 * 7698 * @param { number | string } value 7699 * @returns { T } 7700 * @syscap SystemCapability.ArkUI.ArkUI.Full 7701 * @since 9 7702 * @form 7703 */ 7704 /** 7705 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 7706 * 7707 * @param { number | string } value 7708 * @returns { T } 7709 * @syscap SystemCapability.ArkUI.ArkUI.Full 7710 * @crossplatform 7711 * @since 10 7712 * @form 7713 */ 7714 flexBasis(value: number | string): T; 7715 7716 /** 7717 * Overrides the default configuration of alignItems in the Flex Layout container. 7718 * 7719 * @param { ItemAlign } value 7720 * @returns { T } 7721 * @syscap SystemCapability.ArkUI.ArkUI.Full 7722 * @since 7 7723 */ 7724 /** 7725 * Overrides the default configuration of alignItems in the Flex Layout container. 7726 * 7727 * @param { ItemAlign } value 7728 * @returns { T } 7729 * @syscap SystemCapability.ArkUI.ArkUI.Full 7730 * @since 9 7731 * @form 7732 */ 7733 /** 7734 * Overrides the default configuration of alignItems in the Flex Layout container. 7735 * 7736 * @param { ItemAlign } value 7737 * @returns { T } 7738 * @syscap SystemCapability.ArkUI.ArkUI.Full 7739 * @crossplatform 7740 * @since 10 7741 * @form 7742 */ 7743 alignSelf(value: ItemAlign): T; 7744 7745 /** 7746 * Sets the current component and displays the priority in the layout container. This parameter is valid only in Row, Column, and Flex single-row layouts. 7747 * 7748 * @param { number } value 7749 * @returns { T } 7750 * @syscap SystemCapability.ArkUI.ArkUI.Full 7751 * @since 7 7752 */ 7753 /** 7754 * Sets the current component and displays the priority in the layout container. This parameter is valid only in Row, Column, and Flex single-row layouts. 7755 * 7756 * @param { number } value 7757 * @returns { T } 7758 * @syscap SystemCapability.ArkUI.ArkUI.Full 7759 * @since 9 7760 * @form 7761 */ 7762 /** 7763 * Sets the current component and displays the priority in the layout container. This parameter is valid only in Row, Column, and Flex single-row layouts. 7764 * 7765 * @param { number } value 7766 * @returns { T } 7767 * @syscap SystemCapability.ArkUI.ArkUI.Full 7768 * @crossplatform 7769 * @since 10 7770 * @form 7771 */ 7772 displayPriority(value: number): T; 7773 7774 /** 7775 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 7776 * 7777 * @param { number } value 7778 * @returns { T } 7779 * @syscap SystemCapability.ArkUI.ArkUI.Full 7780 * @since 7 7781 */ 7782 /** 7783 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 7784 * 7785 * @param { number } value 7786 * @returns { T } 7787 * @syscap SystemCapability.ArkUI.ArkUI.Full 7788 * @since 9 7789 * @form 7790 */ 7791 /** 7792 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 7793 * 7794 * @param { number } value 7795 * @returns { T } 7796 * @syscap SystemCapability.ArkUI.ArkUI.Full 7797 * @crossplatform 7798 * @since 10 7799 * @form 7800 */ 7801 zIndex(value: number): T; 7802 7803 /** 7804 * If the components of the two pages are configured with the same ID, the shared element transition is performed during transition. If the parameter is set to an empty string, the shared element transition does not occur. For details about the options parameter, see the options parameter description. 7805 * 7806 * @param { string } id 7807 * @param { sharedTransitionOptions } options 7808 * @returns { T } 7809 * @syscap SystemCapability.ArkUI.ArkUI.Full 7810 * @since 7 7811 */ 7812 /** 7813 * If the components of the two pages are configured with the same ID, the shared element transition is performed during transition. If the parameter is set to an empty string, the shared element transition does not occur. For details about the options parameter, see the options parameter description. 7814 * 7815 * @param { string } id 7816 * @param { sharedTransitionOptions } options 7817 * @returns { T } 7818 * @syscap SystemCapability.ArkUI.ArkUI.Full 7819 * @crossplatform 7820 * @since 10 7821 */ 7822 sharedTransition(id: string, options?: sharedTransitionOptions): T; 7823 7824 /** 7825 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 7826 * 7827 * @param { Direction } value 7828 * @returns { T } 7829 * @syscap SystemCapability.ArkUI.ArkUI.Full 7830 * @since 7 7831 */ 7832 /** 7833 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 7834 * 7835 * @param { Direction } value 7836 * @returns { T } 7837 * @syscap SystemCapability.ArkUI.ArkUI.Full 7838 * @since 9 7839 * @form 7840 */ 7841 /** 7842 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 7843 * 7844 * @param { Direction } value 7845 * @returns { T } 7846 * @syscap SystemCapability.ArkUI.ArkUI.Full 7847 * @crossplatform 7848 * @since 10 7849 * @form 7850 */ 7851 direction(value: Direction): T; 7852 7853 /** 7854 * align 7855 * 7856 * @param { Alignment } value 7857 * @returns { T } 7858 * @syscap SystemCapability.ArkUI.ArkUI.Full 7859 * @since 7 7860 */ 7861 /** 7862 * align 7863 * 7864 * @param { Alignment } value 7865 * @returns { T } 7866 * @syscap SystemCapability.ArkUI.ArkUI.Full 7867 * @since 9 7868 * @form 7869 */ 7870 /** 7871 * align 7872 * 7873 * @param { Alignment } value 7874 * @returns { T } 7875 * @syscap SystemCapability.ArkUI.ArkUI.Full 7876 * @crossplatform 7877 * @since 10 7878 * @form 7879 */ 7880 align(value: Alignment): T; 7881 7882 /** 7883 * position 7884 * 7885 * @param { Position } value 7886 * @returns { T } 7887 * @syscap SystemCapability.ArkUI.ArkUI.Full 7888 * @since 7 7889 */ 7890 /** 7891 * position 7892 * 7893 * @param { Position } value 7894 * @returns { T } 7895 * @syscap SystemCapability.ArkUI.ArkUI.Full 7896 * @since 9 7897 * @form 7898 */ 7899 /** 7900 * position 7901 * 7902 * @param { Position } value 7903 * @returns { T } 7904 * @syscap SystemCapability.ArkUI.ArkUI.Full 7905 * @crossplatform 7906 * @since 10 7907 * @form 7908 */ 7909 position(value: Position): T; 7910 7911 /** 7912 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 7913 * 7914 * @param { Position } value 7915 * @returns { T } 7916 * @syscap SystemCapability.ArkUI.ArkUI.Full 7917 * @since 7 7918 */ 7919 /** 7920 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 7921 * 7922 * @param { Position } value 7923 * @returns { T } 7924 * @syscap SystemCapability.ArkUI.ArkUI.Full 7925 * @since 9 7926 * @form 7927 */ 7928 /** 7929 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 7930 * 7931 * @param { Position } value 7932 * @returns { T } 7933 * @syscap SystemCapability.ArkUI.ArkUI.Full 7934 * @crossplatform 7935 * @since 10 7936 * @form 7937 */ 7938 markAnchor(value: Position): T; 7939 7940 /** 7941 * Coordinate offset relative to the layout completion position. 7942 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 7943 * 7944 * @param { Position } value 7945 * @returns { T } 7946 * @syscap SystemCapability.ArkUI.ArkUI.Full 7947 * @since 7 7948 */ 7949 /** 7950 * Coordinate offset relative to the layout completion position. 7951 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 7952 * 7953 * @param { Position } value 7954 * @returns { T } 7955 * @syscap SystemCapability.ArkUI.ArkUI.Full 7956 * @since 9 7957 * @form 7958 */ 7959 /** 7960 * Coordinate offset relative to the layout completion position. 7961 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 7962 * 7963 * @param { Position } value 7964 * @returns { T } 7965 * @syscap SystemCapability.ArkUI.ArkUI.Full 7966 * @crossplatform 7967 * @since 10 7968 * @form 7969 */ 7970 offset(value: Position): T; 7971 7972 /** 7973 * If the value is true, the component is available and can respond to operations such as clicking. 7974 * If it is set to false, click operations are not responded. 7975 * 7976 * @param { boolean } value 7977 * @returns { T } 7978 * @syscap SystemCapability.ArkUI.ArkUI.Full 7979 * @since 7 7980 */ 7981 /** 7982 * If the value is true, the component is available and can respond to operations such as clicking. 7983 * If it is set to false, click operations are not responded. 7984 * 7985 * @param { boolean } value 7986 * @returns { T } 7987 * @syscap SystemCapability.ArkUI.ArkUI.Full 7988 * @since 9 7989 * @form 7990 */ 7991 /** 7992 * If the value is true, the component is available and can respond to operations such as clicking. 7993 * If it is set to false, click operations are not responded. 7994 * 7995 * @param { boolean } value 7996 * @returns { T } 7997 * @syscap SystemCapability.ArkUI.ArkUI.Full 7998 * @crossplatform 7999 * @since 10 8000 * @form 8001 */ 8002 enabled(value: boolean): T; 8003 8004 /** 8005 * Sets the number of occupied columns and offset columns for a specific device width type. 8006 * 8007 * @param { object } value 8008 * @returns { T } 8009 * @syscap SystemCapability.ArkUI.ArkUI.Full 8010 * @since 7 8011 * @deprecated since 9 8012 * @useinstead grid_col/[GridColColumnOption] and grid_row/[GridRowColumnOption] 8013 */ 8014 useSizeType(value: { 8015 xs?: number | { span: number; offset: number }; 8016 sm?: number | { span: number; offset: number }; 8017 md?: number | { span: number; offset: number }; 8018 lg?: number | { span: number; offset: number }; 8019 }): T; 8020 8021 /** 8022 * Specifies the alignRules of relative container 8023 * 8024 * @param { AlignRuleOption } value 8025 * @returns { T } 8026 * @syscap SystemCapability.ArkUI.ArkUI.Full 8027 * @since 9 8028 * @form 8029 */ 8030 /** 8031 * Specifies the alignRules of relative container 8032 * 8033 * @param { AlignRuleOption } value 8034 * @returns { T } 8035 * @syscap SystemCapability.ArkUI.ArkUI.Full 8036 * @crossplatform 8037 * @since 10 8038 * @form 8039 */ 8040 alignRules(value: AlignRuleOption): T; 8041 8042 /** 8043 * Specifies the aspect ratio of the current component. 8044 * 8045 * @param { number } value 8046 * @returns { T } 8047 * @syscap SystemCapability.ArkUI.ArkUI.Full 8048 * @since 7 8049 */ 8050 /** 8051 * Specifies the aspect ratio of the current component. 8052 * 8053 * @param { number } value 8054 * @returns { T } 8055 * @syscap SystemCapability.ArkUI.ArkUI.Full 8056 * @since 9 8057 * @form 8058 */ 8059 /** 8060 * Specifies the aspect ratio of the current component. 8061 * 8062 * @param { number } value 8063 * @returns { T } 8064 * @syscap SystemCapability.ArkUI.ArkUI.Full 8065 * @crossplatform 8066 * @since 10 8067 * @form 8068 */ 8069 aspectRatio(value: number): T; 8070 8071 /** 8072 * The click effect level and scale number. 8073 * 8074 * @param { ClickEffect | null } value 8075 * @returns { T } return the component attribute. 8076 * @syscap SystemCapability.ArkUI.ArkUI.Full 8077 * @crossplatform 8078 * @since 10 8079 */ 8080 clickEffect(value: ClickEffect | null): T; 8081 8082 /** 8083 * After a listener is bound, the component can be dragged. After the drag occurs, a callback is triggered. 8084 * (To be triggered, press and hold for 170 milliseconds (ms)) 8085 * 8086 * @param { function } event 8087 * @returns { T } 8088 * @syscap SystemCapability.ArkUI.ArkUI.Full 8089 * @since 8 8090 */ 8091 onDragStart(event: (event: DragEvent, extraParams?: string) => CustomBuilder | DragItemInfo): T; 8092 8093 /** 8094 * After binding, a callback is triggered when the component is dragged to the range of the component. 8095 * 8096 * @param { function } event 8097 * @returns { T } 8098 * @syscap SystemCapability.ArkUI.ArkUI.Full 8099 * @since 8 8100 */ 8101 onDragEnter(event: (event: DragEvent, extraParams?: string) => void): T; 8102 8103 /** 8104 * After binding, a callback is triggered when the drag moves within the range of a placeable component. 8105 * 8106 * @param { function } event 8107 * @returns { T } 8108 * @syscap SystemCapability.ArkUI.ArkUI.Full 8109 * @since 8 8110 */ 8111 onDragMove(event: (event: DragEvent, extraParams?: string) => void): T; 8112 8113 /** 8114 * After binding, a callback is triggered when the component is dragged out of the component range. 8115 * 8116 * @param { function } event 8117 * @returns { T } 8118 * @syscap SystemCapability.ArkUI.ArkUI.Full 8119 * @since 8 8120 */ 8121 onDragLeave(event: (event: DragEvent, extraParams?: string) => void): T; 8122 8123 /** 8124 * The component bound to this event can be used as the drag release target. 8125 * This callback is triggered when the drag behavior is stopped within the scope of the component. 8126 * 8127 * @param { function } event 8128 * @returns { T } 8129 * @syscap SystemCapability.ArkUI.ArkUI.Full 8130 * @since 8 8131 */ 8132 onDrop(event: (event: DragEvent, extraParams?: string) => void): T; 8133 8134 /** 8135 * This function is called when the drag event is end. 8136 * 8137 * @param { function } event - indicates the function to be called. 8138 * @returns { T } property value of type T. 8139 * @syscap SystemCapability.ArkUI.ArkUI.Full 8140 * @since 10 8141 */ 8142 onDragEnd(event: (event: DragEvent, extraParams?: string) => void): T; 8143 8144 /** 8145 * Allowed drop uniformData type for this node. 8146 * 8147 * @param { Array<UniformDataType> } value - the uniformData type for this node. 8148 * @returns { T } property value of type T. 8149 * @syscap SystemCapability.ArkUI.ArkUI.Full 8150 * @crossplatform 8151 * @since 10 8152 */ 8153 allowDrop(value: Array<UniformDataType>): T; 8154 8155 /** 8156 * Enable the selectable area can be dragged. 8157 * 8158 * @param { boolean } value - true means the area can be dragged, false means the area can't be dragged. 8159 * @returns { T } property value of type T. 8160 * @syscap SystemCapability.ArkUI.ArkUI.Full 8161 * @since 10 8162 */ 8163 draggable(value: boolean): T; 8164 8165 /** 8166 * Add mask text to the current component. The layout is the same as that of the current component. 8167 * 8168 * @param { string | CustomBuilder } value 8169 * @param { object } options 8170 * @returns { T } 8171 * @syscap SystemCapability.ArkUI.ArkUI.Full 8172 * @since 7 8173 */ 8174 /** 8175 * Add mask text to the current component. The layout is the same as that of the current component. 8176 * 8177 * @param { string | CustomBuilder } value 8178 * @param { object } options 8179 * @returns { T } 8180 * @syscap SystemCapability.ArkUI.ArkUI.Full 8181 * @since 9 8182 * @form 8183 */ 8184 /** 8185 * Add mask text to the current component. The layout is the same as that of the current component. 8186 * 8187 * @param { string | CustomBuilder } value 8188 * @param { object } options 8189 * @returns { T } 8190 * @syscap SystemCapability.ArkUI.ArkUI.Full 8191 * @crossplatform 8192 * @since 10 8193 * @form 8194 */ 8195 overlay(value: string | CustomBuilder, options?: { align?: Alignment; offset?: { x?: number; y?: number } }): T; 8196 8197 /** 8198 * Linear Gradient 8199 * angle: Angle of Linear Gradient; direction:Direction of Linear Gradient; colors:Color description for gradients,repeating:repeating. 8200 * 8201 * @param { object } value 8202 * @returns { T } 8203 * @syscap SystemCapability.ArkUI.ArkUI.Full 8204 * @since 7 8205 */ 8206 /** 8207 * Linear Gradient 8208 * angle: Angle of Linear Gradient; direction:Direction of Linear Gradient; colors:Color description for gradients,repeating:repeating. 8209 * 8210 * @param { object } value 8211 * @returns { T } 8212 * @syscap SystemCapability.ArkUI.ArkUI.Full 8213 * @since 9 8214 * @form 8215 */ 8216 /** 8217 * Linear Gradient 8218 * angle: Angle of Linear Gradient; direction:Direction of Linear Gradient; colors:Color description for gradients,repeating:repeating. 8219 * 8220 * @param { object } value 8221 * @returns { T } 8222 * @syscap SystemCapability.ArkUI.ArkUI.Full 8223 * @crossplatform 8224 * @since 10 8225 * @form 8226 */ 8227 linearGradient(value: { 8228 angle?: number | string; 8229 direction?: GradientDirection; 8230 colors: Array<any>; 8231 repeating?: boolean; 8232 }): T; 8233 8234 /** 8235 * Angle Gradient 8236 * center:is the center point of the angle gradient 8237 * start:Start point of angle gradient 8238 * end:End point of angle gradient 8239 * number:number 8240 * rotating:rotating 8241 * colors:Color description for gradients 8242 * repeating:repeating 8243 * 8244 * @param { object } value 8245 * @returns { T } 8246 * @syscap SystemCapability.ArkUI.ArkUI.Full 8247 * @since 7 8248 */ 8249 /** 8250 * Angle Gradient 8251 * center:is the center point of the angle gradient 8252 * start:Start point of angle gradient 8253 * end:End point of angle gradient 8254 * number:number 8255 * rotating:rotating 8256 * colors:Color description for gradients 8257 * repeating:repeating 8258 * 8259 * @param { object } value 8260 * @returns { T } 8261 * @syscap SystemCapability.ArkUI.ArkUI.Full 8262 * @since 9 8263 * @form 8264 */ 8265 /** 8266 * Angle Gradient 8267 * center:is the center point of the angle gradient 8268 * start:Start point of angle gradient 8269 * end:End point of angle gradient 8270 * number:number 8271 * rotating:rotating 8272 * colors:Color description for gradients 8273 * repeating:repeating 8274 * 8275 * @param { object } value 8276 * @returns { T } 8277 * @syscap SystemCapability.ArkUI.ArkUI.Full 8278 * @crossplatform 8279 * @since 10 8280 * @form 8281 */ 8282 sweepGradient(value: { 8283 center: Array<any>; 8284 start?: number | string; 8285 end?: number | string; 8286 rotation?: number | string; 8287 colors: Array<any>; 8288 repeating?: boolean; 8289 }): T; 8290 8291 /** 8292 * Radial Gradient 8293 * center:Center point of radial gradient 8294 * radius:Radius of Radial Gradient 8295 * colors:Color description for gradients 8296 * repeating: Refill 8297 * 8298 * @param { object } value 8299 * @returns { T } 8300 * @syscap SystemCapability.ArkUI.ArkUI.Full 8301 * @since 7 8302 */ 8303 /** 8304 * Radial Gradient 8305 * center:Center point of radial gradient 8306 * radius:Radius of Radial Gradient 8307 * colors:Color description for gradients 8308 * repeating: Refill 8309 * 8310 * @param { object } value 8311 * @returns { T } 8312 * @syscap SystemCapability.ArkUI.ArkUI.Full 8313 * @since 9 8314 * @form 8315 */ 8316 /** 8317 * Radial Gradient 8318 * center:Center point of radial gradient 8319 * radius:Radius of Radial Gradient 8320 * colors:Color description for gradients 8321 * repeating: Refill 8322 * 8323 * @param { object } value 8324 * @returns { T } 8325 * @syscap SystemCapability.ArkUI.ArkUI.Full 8326 * @crossplatform 8327 * @since 10 8328 * @form 8329 */ 8330 radialGradient(value: { center: Array<any>; radius: number | string; colors: Array<any>; repeating?: boolean }): T; 8331 8332 /** 8333 * Set the motion path of the component 8334 * path:Motion path for displacement animation, using the svg path string. 8335 * from:Start point of the motion path. The default value is 0.0. 8336 * to:End point of the motion path. The default value is 1.0. 8337 * rotatable:Whether to follow the path for rotation. 8338 * 8339 * @param { MotionPathOptions } value 8340 * @returns { T } 8341 * @syscap SystemCapability.ArkUI.ArkUI.Full 8342 * @since 7 8343 */ 8344 /** 8345 * Set the motion path of the component 8346 * path:Motion path for displacement animation, using the svg path string. 8347 * from:Start point of the motion path. The default value is 0.0. 8348 * to:End point of the motion path. The default value is 1.0. 8349 * rotatable:Whether to follow the path for rotation. 8350 * 8351 * @param { MotionPathOptions } value 8352 * @returns { T } 8353 * @syscap SystemCapability.ArkUI.ArkUI.Full 8354 * @crossplatform 8355 * @since 10 8356 */ 8357 motionPath(value: MotionPathOptions): T; 8358 8359 /** 8360 * Add a shadow effect to the current component 8361 * 8362 * @param { ShadowOptions | ShadowStyle } value 8363 * @returns { T } 8364 * @syscap SystemCapability.ArkUI.ArkUI.Full 8365 * @since 7 8366 */ 8367 /** 8368 * Add a shadow effect to the current component 8369 * 8370 * @param { ShadowOptions | ShadowStyle } value 8371 * @returns { T } 8372 * @syscap SystemCapability.ArkUI.ArkUI.Full 8373 * @since 9 8374 * @form 8375 */ 8376 /** 8377 * Add a shadow effect to the current component 8378 * 8379 * @param { ShadowOptions | ShadowStyle } value 8380 * @returns { T } 8381 * @syscap SystemCapability.ArkUI.ArkUI.Full 8382 * @crossplatform 8383 * @since 10 8384 * @form 8385 */ 8386 shadow(value: ShadowOptions | ShadowStyle): T; 8387 8388 /** 8389 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 8390 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 8391 * 8392 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value 8393 * @returns { T } 8394 * @syscap SystemCapability.ArkUI.ArkUI.Full 8395 * @since 7 8396 */ 8397 /** 8398 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 8399 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 8400 * 8401 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value 8402 * @returns { T } 8403 * @syscap SystemCapability.ArkUI.ArkUI.Full 8404 * @since 9 8405 * @form 8406 */ 8407 /** 8408 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 8409 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 8410 * 8411 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value 8412 * @returns { T } 8413 * @syscap SystemCapability.ArkUI.ArkUI.Full 8414 * @crossplatform 8415 * @since 10 8416 * @form 8417 */ 8418 clip(value: boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute): T; 8419 8420 /** 8421 * Applies a mask of the specified shape to the current assembly. 8422 * 8423 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value 8424 * @returns { T } 8425 * @syscap SystemCapability.ArkUI.ArkUI.Full 8426 * @since 7 8427 */ 8428 /** 8429 * Applies a mask of the specified shape to the current assembly. 8430 * 8431 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value - indicates the shape of the mask. 8432 * @returns { T } 8433 * @syscap SystemCapability.ArkUI.ArkUI.Full 8434 * @since 9 8435 * @form 8436 */ 8437 /** 8438 * Applies a mask of the specified shape to the current assembly. 8439 * 8440 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value - indicates the shape of the mask. 8441 * @returns { T } 8442 * @syscap SystemCapability.ArkUI.ArkUI.Full 8443 * @crossplatform 8444 * @since 10 8445 * @form 8446 */ 8447 mask(value: CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask): T; 8448 8449 /** 8450 * Key. User can set an key to the component to identify it. 8451 * 8452 * @param { string } value 8453 * @returns { T } 8454 * @syscap SystemCapability.ArkUI.ArkUI.Full 8455 * @systemapi 8456 * @since 8 8457 * @test 8458 */ 8459 key(value: string): T; 8460 8461 /** 8462 * Id. User can set an id to the component to identify it. 8463 * 8464 * @param { string } value 8465 * @returns { T } 8466 * @syscap SystemCapability.ArkUI.ArkUI.Full 8467 * @since 8 8468 */ 8469 /** 8470 * Id. User can set an id to the component to identify it. 8471 * 8472 * @param { string } value 8473 * @returns { T } 8474 * @syscap SystemCapability.ArkUI.ArkUI.Full 8475 * @since 9 8476 * @form 8477 */ 8478 /** 8479 * Id. User can set an id to the component to identify it. 8480 * 8481 * @param { string } value 8482 * @returns { T } 8483 * @syscap SystemCapability.ArkUI.ArkUI.Full 8484 * @crossplatform 8485 * @since 10 8486 * @form 8487 */ 8488 id(value: string): T; 8489 8490 /** 8491 * geometryTransition 8492 * 8493 * @param { string } id 8494 * @returns { T } 8495 * @syscap SystemCapability.ArkUI.ArkUI.Full 8496 * @since 7 8497 */ 8498 /** 8499 * geometryTransition 8500 * 8501 * @param { string } id 8502 * @returns { T } 8503 * @syscap SystemCapability.ArkUI.ArkUI.Full 8504 * @crossplatform 8505 * @since 10 8506 */ 8507 geometryTransition(id: string): T; 8508 8509 /** 8510 * Popup control 8511 * 8512 * @param { boolean } show 8513 * @param { PopupOptions | CustomPopupOptions } popup 8514 * @returns { T } 8515 * @syscap SystemCapability.ArkUI.ArkUI.Full 8516 * @since 7 8517 */ 8518 bindPopup(show: boolean, popup: PopupOptions | CustomPopupOptions): T; 8519 8520 /** 8521 * Menu control 8522 * 8523 * @param { { value: ResourceStr; icon?: ResourceStr; action: () => void }[] | CustomBuilder } content 8524 * action: () => void }[] | CustomBuilder } content - Indicates the content of menu. 8525 * @param { MenuOptions } options 8526 * @returns { T } 8527 * @syscap SystemCapability.ArkUI.ArkUI.Full 8528 * @since 7 8529 */ 8530 /** 8531 * Menu control 8532 * 8533 * @param { { value: ResourceStr; icon?: ResourceStr; action: () => void }[] | CustomBuilder } content 8534 * action: () => void }[] | CustomBuilder } content - Indicates the content of menu. 8535 * @param { MenuOptions } options - Indicates the options of menu. 8536 * @returns { T } 8537 * @syscap SystemCapability.ArkUI.ArkUI.Full 8538 * @crossplatform 8539 * @since 10 8540 */ 8541 bindMenu( 8542 content: { value: ResourceStr; icon?: ResourceStr; action: () => void }[] | CustomBuilder, 8543 options?: MenuOptions 8544 ): T; 8545 8546 /** 8547 * ContextMenu control 8548 * 8549 * @param { CustomBuilder } content 8550 * @param { ResponseType } responseType 8551 * @param { ContextMenuOptions } options 8552 * @returns { T } 8553 * @syscap SystemCapability.ArkUI.ArkUI.Full 8554 * @since 8 8555 */ 8556 /** 8557 * ContextMenu control 8558 * 8559 * @param { CustomBuilder } content - Indicates the content of context menu. 8560 * @param { ResponseType } responseType - Indicates response type of context menu. 8561 * @param { ContextMenuOptions } options - Indicates the options of context menu. 8562 * @returns { T } 8563 * @syscap SystemCapability.ArkUI.ArkUI.Full 8564 * @crossplatform 8565 * @since 10 8566 */ 8567 bindContextMenu(content: CustomBuilder, responseType: ResponseType, options?: ContextMenuOptions): T; 8568 8569 /** 8570 * Bind content cover 8571 * 8572 * @param { boolean } isShow - true means display content, false means hide content. 8573 * @param { CustomBuilder } builder - the content to be displayed. 8574 * @param { ModalTransition } type - transition type. 8575 * @returns { T } 8576 * @syscap SystemCapability.ArkUI.ArkUI.Full 8577 * @crossplatform 8578 * @since 10 8579 */ 8580 bindContentCover(isShow: boolean, builder: CustomBuilder, type?: ModalTransition): T; 8581 8582 /** 8583 * Bind content cover 8584 * 8585 * @param { boolean } isShow - true means display content, false means hide content. 8586 * @param { CustomBuilder } builder - the content to be displayed. 8587 * @param { ContentCoverOptions } options - options of content cover. 8588 * @returns { T } 8589 * @syscap SystemCapability.ArkUI.ArkUI.Full 8590 * @crossplatform 8591 * @since 10 8592 */ 8593 bindContentCover(isShow: boolean, builder: CustomBuilder, options?: ContentCoverOptions): T; 8594 8595 /** 8596 * Bind sheet 8597 * 8598 * @param { boolean } isShow - true means display sheet, false means hide sheet. 8599 * @param { CustomBuilder } builder - the sheet to be displayed. 8600 * @param { SheetOptions } options - options of sheet. 8601 * @returns { T } - template type 8602 * @syscap SystemCapability.ArkUI.ArkUI.Full 8603 * @crossplatform 8604 * @since 10 8605 */ 8606 bindSheet(isShow: boolean, builder: CustomBuilder, options?: SheetOptions): T; 8607 8608 /** 8609 * Sets styles for component state. 8610 * 8611 * @param { StateStyles } value 8612 * @returns { T } 8613 * @syscap SystemCapability.ArkUI.ArkUI.Full 8614 * @since 8 8615 */ 8616 /** 8617 * Sets styles for component state. 8618 * 8619 * @param { StateStyles } value 8620 * @returns { T } 8621 * @syscap SystemCapability.ArkUI.ArkUI.Full 8622 * @since 9 8623 * @form 8624 */ 8625 /** 8626 * Sets styles for component state. 8627 * 8628 * @param { StateStyles } value 8629 * @returns { T } 8630 * @syscap SystemCapability.ArkUI.ArkUI.Full 8631 * @crossplatform 8632 * @since 10 8633 * @form 8634 */ 8635 stateStyles(value: StateStyles): T; 8636 8637 /** 8638 * id for distribute identification. 8639 * 8640 * @param { number } value 8641 * @returns { T } 8642 * @syscap SystemCapability.ArkUI.ArkUI.Full 8643 * @since 8 8644 */ 8645 restoreId(value: number): T; 8646 8647 /** 8648 * Trigger a visible area change event. 8649 * 8650 * @param { Array<number> } ratios 8651 * @param { function } event 8652 * @returns { T } 8653 * @syscap SystemCapability.ArkUI.ArkUI.Full 8654 * @since 9 8655 */ 8656 /** 8657 * Trigger a visible area change event. 8658 * 8659 * @param { Array<number> } ratios 8660 * @param { function } event 8661 * @returns { T } 8662 * @syscap SystemCapability.ArkUI.ArkUI.Full 8663 * @crossplatform 8664 * @since 10 8665 */ 8666 onVisibleAreaChange(ratios: Array<number>, event: (isVisible: boolean, currentRatio: number) => void): T; 8667 8668 /** 8669 * Set the spherical effect of the component. 8670 * 8671 * @param { number } value - set the degree of spherical effect, value range [0, 1]. 8672 * If the value is 0, the component keep same, else the value is 1, component are fully spherical. 8673 * @returns { T } 8674 * @syscap SystemCapability.ArkUI.ArkUI.Full 8675 * @systemapi 8676 * @crossplatform 8677 * @since 10 8678 */ 8679 sphericalEffect(value: number): T; 8680 8681 /** 8682 * Set the light up effect of the component 8683 * 8684 * @param { number } value - set the degree to which the component lights up, value range [0, 1]. 8685 * The color brightness in the component rendering content area is greater than the value and can be displayed, otherwise it will not be displayed. 8686 * @returns { T } 8687 * @syscap SystemCapability.ArkUI.ArkUI.Full 8688 * @systemapi 8689 * @crossplatform 8690 * @since 10 8691 */ 8692 lightUpEffect(value: number): T; 8693 8694 /** 8695 * Set the edge pixel stretch effect of the Component. 8696 * 8697 * @param { PixelStretchEffectOptions } options 8698 * @returns { T } 8699 * @syscap SystemCapability.ArkUI.ArkUI.Full 8700 * @systemapi 8701 * @crossplatform 8702 * @since 10 8703 */ 8704 pixelStretchEffect(options: PixelStretchEffectOptions): T; 8705 8706 /** 8707 * Sets hot keys 8708 * 8709 * @param { string | FunctionKey } value - Character of the combination key. 8710 * @param { Array<ModifierKey> } keys - The modifier keys modify the action of key when the key are pressed at the same time. 8711 * @param { function } action - Callback function, triggered when the shortcut keyboard is pressed. 8712 * @returns { T } 8713 * @syscap SystemCapability.ArkUI.ArkUI.Full 8714 * @crossplatform 8715 * @since 10 8716 */ 8717 keyboardShortcut(value: string | FunctionKey, keys: Array<ModifierKey>, action?: () => void): T; 8718 8719 /** 8720 * Sets accessibilityGroup 8721 * 8722 * @param { boolean } value - set group with accessibility 8723 * @returns { T } 8724 * @syscap SystemCapability.ArkUI.ArkUI.Full 8725 * @crossplatform 8726 * @since 10 8727 */ 8728 accessibilityGroup(value: boolean): T; 8729 8730 /** 8731 * Sets accessibilityText 8732 * 8733 * @param { string } value - set accessibility text 8734 * @returns { T } 8735 * @syscap SystemCapability.ArkUI.ArkUI.Full 8736 * @crossplatform 8737 * @since 10 8738 */ 8739 accessibilityText(value: string): T; 8740 8741 /** 8742 * Sets accessibilityDescription 8743 * 8744 * @param { string } value - set description of accessibility 8745 * @returns { T } 8746 * @syscap SystemCapability.ArkUI.ArkUI.Full 8747 * @crossplatform 8748 * @since 10 8749 */ 8750 accessibilityDescription(value: string): T; 8751 8752 /** 8753 * Sets accessibilityLevel 8754 * 8755 * @param { string } value - set accessibility level 8756 * @returns { T } 8757 * @syscap SystemCapability.ArkUI.ArkUI.Full 8758 * @crossplatform 8759 * @since 10 8760 */ 8761 accessibilityLevel(value: string): T; 8762 8763 /** 8764 * Sets obscured 8765 * 8766 * @param { Array<ObscuredReasons> } reasons - reasons of obscuration 8767 * @returns { T } 8768 * @syscap SystemCapability.ArkUI.ArkUI.Full 8769 * @crossplatform 8770 * @since 10 8771 */ 8772 obscured(reasons: Array<ObscuredReasons>): T; 8773 8774 /** 8775 * Reuse id is used for identify the reuse type for each custom node. 8776 * 8777 * @param { string } id - The id for reusable custom node. 8778 * @returns { T } 8779 * @syscap SystemCapability.ArkUI.ArkUI.Full 8780 * @crossplatform 8781 * @since 10 8782 */ 8783 reuseId(id: string): T; 8784 8785 /** 8786 * Sets how content is drawn within nodes duration animation 8787 * 8788 * @param { RenderFit } fitMode - The render fit mode of content. 8789 * @returns { T } 8790 * @syscap SystemCapability.ArkUI.ArkUI.Full 8791 * @crossplatform 8792 * @since 10 8793 */ 8794 renderFit(fitMode: RenderFit): T; 8795} 8796 8797/** 8798 * CommonAttribute for ide. 8799 * 8800 * @extends CommonMethod 8801 * @syscap SystemCapability.ArkUI.ArkUI.Full 8802 * @since 7 8803 */ 8804/** 8805 * CommonAttribute for ide. 8806 * 8807 * @extends CommonMethod 8808 * @syscap SystemCapability.ArkUI.ArkUI.Full 8809 * @since 9 8810 * @form 8811 */ 8812/** 8813 * CommonAttribute for ide. 8814 * 8815 * @extends CommonMethod 8816 * @syscap SystemCapability.ArkUI.ArkUI.Full 8817 * @crossplatform 8818 * @since 10 8819 * @form 8820 */ 8821declare class CommonAttribute extends CommonMethod<CommonAttribute> {} 8822 8823/** 8824 * CommonInterface for ide. 8825 * 8826 * @interface CommonInterface 8827 * @syscap SystemCapability.ArkUI.ArkUI.Full 8828 * @since 7 8829 */ 8830/** 8831 * CommonInterface for ide. 8832 * 8833 * @interface CommonInterface 8834 * @syscap SystemCapability.ArkUI.ArkUI.Full 8835 * @since 9 8836 * @form 8837 */ 8838/** 8839 * CommonInterface for ide. 8840 * 8841 * @interface CommonInterface 8842 * @syscap SystemCapability.ArkUI.ArkUI.Full 8843 * @crossplatform 8844 * @since 10 8845 * @form 8846 */ 8847interface CommonInterface { 8848 (): CommonAttribute; 8849} 8850 8851/** 8852 * CommonInstance for ide. 8853 * 8854 * @syscap SystemCapability.ArkUI.ArkUI.Full 8855 * @since 7 8856 */ 8857/** 8858 * CommonInstance for ide. 8859 * 8860 * @syscap SystemCapability.ArkUI.ArkUI.Full 8861 * @since 9 8862 * @form 8863 */ 8864/** 8865 * CommonInstance for ide. 8866 * 8867 * @syscap SystemCapability.ArkUI.ArkUI.Full 8868 * @crossplatform 8869 * @since 10 8870 * @form 8871 */ 8872declare const CommonInstance: CommonAttribute; 8873 8874/** 8875 * Common for ide. 8876 * 8877 * @syscap SystemCapability.ArkUI.ArkUI.Full 8878 * @since 7 8879 */ 8880/** 8881 * Common for ide. 8882 * 8883 * @syscap SystemCapability.ArkUI.ArkUI.Full 8884 * @since 9 8885 * @form 8886 */ 8887/** 8888 * Common for ide. 8889 * 8890 * @syscap SystemCapability.ArkUI.ArkUI.Full 8891 * @crossplatform 8892 * @since 10 8893 * @form 8894 */ 8895declare const Common: CommonInterface; 8896 8897/** 8898 * Defines the CustomBuilder Type. 8899 * 8900 * @syscap SystemCapability.ArkUI.ArkUI.Full 8901 * @since 7 8902 */ 8903/** 8904 * Defines the CustomBuilder Type. 8905 * 8906 * @syscap SystemCapability.ArkUI.ArkUI.Full 8907 * @since 9 8908 * @form 8909 */ 8910/** 8911 * Defines the CustomBuilder Type. 8912 * 8913 * @syscap SystemCapability.ArkUI.ArkUI.Full 8914 * @crossplatform 8915 * @since 10 8916 * @form 8917 */ 8918declare type CustomBuilder = (() => any) | void; 8919 8920/** 8921 * Defines the segment of blur. 8922 * The first element in the tuple means fraction. 8923 * The range of this value is [0,1]. A value of 1 means opaque and 0 means completely transparent. 8924 * The second element means the stop position. 8925 * The range of this value is [0,1]. A value of 1 means region ending position and 0 means region starting position. 8926 * 8927 * @syscap SystemCapability.ArkUI.ArkUI.Full 8928 * @systemapi 8929 * @since 10 8930 */ 8931declare type FractionStop = [ number, number ]; 8932 8933/** 8934 * CommonShapeMethod 8935 * 8936 * @extends CommonMethod 8937 * @syscap SystemCapability.ArkUI.ArkUI.Full 8938 * @since 7 8939 */ 8940/** 8941 * CommonShapeMethod 8942 * 8943 * @extends CommonMethod 8944 * @syscap SystemCapability.ArkUI.ArkUI.Full 8945 * @since 9 8946 * @form 8947 */ 8948/** 8949 * CommonShapeMethod 8950 * 8951 * @extends CommonMethod 8952 * @syscap SystemCapability.ArkUI.ArkUI.Full 8953 * @crossplatform 8954 * @since 10 8955 * @form 8956 */ 8957declare class CommonShapeMethod<T> extends CommonMethod<T> { 8958 /** 8959 * constructor. 8960 * 8961 * @syscap SystemCapability.ArkUI.ArkUI.Full 8962 * @systemapi 8963 * @since 7 8964 */ 8965 /** 8966 * constructor. 8967 * 8968 * @syscap SystemCapability.ArkUI.ArkUI.Full 8969 * @systemapi 8970 * @since 9 8971 * @form 8972 */ 8973 constructor(); 8974 8975 /** 8976 * border Color 8977 * 8978 * @param { ResourceColor } value 8979 * @returns { T } 8980 * @syscap SystemCapability.ArkUI.ArkUI.Full 8981 * @since 7 8982 */ 8983 /** 8984 * border Color 8985 * 8986 * @param { ResourceColor } value 8987 * @returns { T } 8988 * @syscap SystemCapability.ArkUI.ArkUI.Full 8989 * @since 9 8990 * @form 8991 */ 8992 /** 8993 * border Color 8994 * 8995 * @param { ResourceColor } value 8996 * @returns { T } 8997 * @syscap SystemCapability.ArkUI.ArkUI.Full 8998 * @crossplatform 8999 * @since 10 9000 * @form 9001 */ 9002 stroke(value: ResourceColor): T; 9003 9004 /** 9005 * Fill color. 9006 * 9007 * @param { ResourceColor } value 9008 * @returns { T } 9009 * @syscap SystemCapability.ArkUI.ArkUI.Full 9010 * @since 7 9011 */ 9012 /** 9013 * Fill color. 9014 * 9015 * @param { ResourceColor } value 9016 * @returns { T } 9017 * @syscap SystemCapability.ArkUI.ArkUI.Full 9018 * @since 9 9019 * @form 9020 */ 9021 /** 9022 * Fill color. 9023 * 9024 * @param { ResourceColor } value 9025 * @returns { T } 9026 * @syscap SystemCapability.ArkUI.ArkUI.Full 9027 * @crossplatform 9028 * @since 10 9029 * @form 9030 */ 9031 fill(value: ResourceColor): T; 9032 9033 /** 9034 * Offset from the start point of the border drawing. 9035 * 9036 * @param { number | string } value 9037 * @returns { T } 9038 * @syscap SystemCapability.ArkUI.ArkUI.Full 9039 * @since 7 9040 */ 9041 /** 9042 * Offset from the start point of the border drawing. 9043 * 9044 * @param { number | string } value 9045 * @returns { T } 9046 * @syscap SystemCapability.ArkUI.ArkUI.Full 9047 * @since 9 9048 * @form 9049 */ 9050 /** 9051 * Offset from the start point of the border drawing. 9052 * 9053 * @param { number | string } value 9054 * @returns { T } 9055 * @syscap SystemCapability.ArkUI.ArkUI.Full 9056 * @crossplatform 9057 * @since 10 9058 * @form 9059 */ 9060 strokeDashOffset(value: number | string): T; 9061 9062 /** 9063 * Path endpoint drawing style. 9064 * 9065 * @param { LineCapStyle } value 9066 * @returns { T } 9067 * @syscap SystemCapability.ArkUI.ArkUI.Full 9068 * @since 7 9069 */ 9070 /** 9071 * Path endpoint drawing style. 9072 * 9073 * @param { LineCapStyle } value 9074 * @returns { T } 9075 * @syscap SystemCapability.ArkUI.ArkUI.Full 9076 * @since 9 9077 * @form 9078 */ 9079 /** 9080 * Path endpoint drawing style. 9081 * 9082 * @param { LineCapStyle } value 9083 * @returns { T } 9084 * @syscap SystemCapability.ArkUI.ArkUI.Full 9085 * @crossplatform 9086 * @since 10 9087 * @form 9088 */ 9089 strokeLineCap(value: LineCapStyle): T; 9090 9091 /** 9092 * Border corner drawing style. 9093 * 9094 * @param { LineJoinStyle } value 9095 * @returns { T } 9096 * @syscap SystemCapability.ArkUI.ArkUI.Full 9097 * @since 7 9098 */ 9099 /** 9100 * Border corner drawing style. 9101 * 9102 * @param { LineJoinStyle } value 9103 * @returns { T } 9104 * @syscap SystemCapability.ArkUI.ArkUI.Full 9105 * @since 9 9106 * @form 9107 */ 9108 /** 9109 * Border corner drawing style. 9110 * 9111 * @param { LineJoinStyle } value 9112 * @returns { T } 9113 * @syscap SystemCapability.ArkUI.ArkUI.Full 9114 * @crossplatform 9115 * @since 10 9116 * @form 9117 */ 9118 strokeLineJoin(value: LineJoinStyle): T; 9119 9120 /** 9121 * Limits for drawing acute angles as bevels 9122 * 9123 * @param { number | string } value 9124 * @returns { T } 9125 * @syscap SystemCapability.ArkUI.ArkUI.Full 9126 * @since 7 9127 */ 9128 /** 9129 * Limits for drawing acute angles as bevels 9130 * 9131 * @param { number | string } value 9132 * @returns { T } 9133 * @syscap SystemCapability.ArkUI.ArkUI.Full 9134 * @since 9 9135 * @form 9136 */ 9137 /** 9138 * Limits for drawing acute angles as bevels 9139 * 9140 * @param { number | string } value 9141 * @returns { T } 9142 * @syscap SystemCapability.ArkUI.ArkUI.Full 9143 * @crossplatform 9144 * @since 10 9145 * @form 9146 */ 9147 strokeMiterLimit(value: number | string): T; 9148 9149 /** 9150 * Sets the opacity of the border. 9151 * 9152 * @param { number | string | Resource } value 9153 * @returns { T } 9154 * @syscap SystemCapability.ArkUI.ArkUI.Full 9155 * @since 7 9156 */ 9157 /** 9158 * Sets the opacity of the border. 9159 * 9160 * @param { number | string | Resource } value 9161 * @returns { T } 9162 * @syscap SystemCapability.ArkUI.ArkUI.Full 9163 * @since 9 9164 * @form 9165 */ 9166 /** 9167 * Sets the opacity of the border. 9168 * 9169 * @param { number | string | Resource } value 9170 * @returns { T } 9171 * @syscap SystemCapability.ArkUI.ArkUI.Full 9172 * @crossplatform 9173 * @since 10 9174 * @form 9175 */ 9176 strokeOpacity(value: number | string | Resource): T; 9177 9178 /** 9179 * fill Opacity 9180 * 9181 * @param { number | string | Resource } value 9182 * @returns { T } 9183 * @syscap SystemCapability.ArkUI.ArkUI.Full 9184 * @since 7 9185 */ 9186 /** 9187 * fill Opacity 9188 * 9189 * @param { number | string | Resource } value 9190 * @returns { T } 9191 * @syscap SystemCapability.ArkUI.ArkUI.Full 9192 * @since 9 9193 * @form 9194 */ 9195 /** 9196 * fill Opacity 9197 * 9198 * @param { number | string | Resource } value 9199 * @returns { T } 9200 * @syscap SystemCapability.ArkUI.ArkUI.Full 9201 * @crossplatform 9202 * @since 10 9203 * @form 9204 */ 9205 fillOpacity(value: number | string | Resource): T; 9206 9207 /** 9208 * Sets the width of the dividing line. 9209 * 9210 * @param { Length } value 9211 * @returns { T } 9212 * @syscap SystemCapability.ArkUI.ArkUI.Full 9213 * @since 7 9214 */ 9215 /** 9216 * Sets the width of the dividing line. 9217 * 9218 * @param { Length } value 9219 * @returns { T } 9220 * @syscap SystemCapability.ArkUI.ArkUI.Full 9221 * @since 9 9222 * @form 9223 */ 9224 /** 9225 * Sets the width of the dividing line. 9226 * 9227 * @param { Length } value 9228 * @returns { T } 9229 * @syscap SystemCapability.ArkUI.ArkUI.Full 9230 * @crossplatform 9231 * @since 10 9232 * @form 9233 */ 9234 strokeWidth(value: Length): T; 9235 9236 /** 9237 * Indicates whether to enable anti-aliasing 9238 * 9239 * @param { boolean } value 9240 * @returns { T } 9241 * @syscap SystemCapability.ArkUI.ArkUI.Full 9242 * @since 7 9243 */ 9244 /** 9245 * Indicates whether to enable anti-aliasing 9246 * 9247 * @param { boolean } value 9248 * @returns { T } 9249 * @syscap SystemCapability.ArkUI.ArkUI.Full 9250 * @since 9 9251 * @form 9252 */ 9253 /** 9254 * Indicates whether to enable anti-aliasing 9255 * 9256 * @param { boolean } value 9257 * @returns { T } 9258 * @syscap SystemCapability.ArkUI.ArkUI.Full 9259 * @crossplatform 9260 * @since 10 9261 * @form 9262 */ 9263 antiAlias(value: boolean): T; 9264 9265 /** 9266 * Sets the gap for the border. 9267 * 9268 * @param { Array<any> } value 9269 * @returns { T } 9270 * @syscap SystemCapability.ArkUI.ArkUI.Full 9271 * @since 7 9272 */ 9273 /** 9274 * Sets the gap for the border. 9275 * 9276 * @param { Array<any> } value 9277 * @returns { T } 9278 * @syscap SystemCapability.ArkUI.ArkUI.Full 9279 * @since 9 9280 * @form 9281 */ 9282 /** 9283 * Sets the gap for the border. 9284 * 9285 * @param { Array<any> } value 9286 * @returns { T } 9287 * @syscap SystemCapability.ArkUI.ArkUI.Full 9288 * @crossplatform 9289 * @since 10 9290 * @form 9291 */ 9292 strokeDashArray(value: Array<any>): T; 9293} 9294 9295/** 9296 * Linear Gradient Interface 9297 * 9298 * @interface LinearGradient 9299 * @syscap SystemCapability.ArkUI.ArkUI.Full 9300 * @since 9 9301 */ 9302/** 9303 * Linear Gradient Interface 9304 * 9305 * @interface LinearGradient 9306 * @syscap SystemCapability.ArkUI.ArkUI.Full 9307 * @crossplatform 9308 * @since 10 9309 */ 9310declare interface LinearGradient { 9311 angle?: number | string; 9312 direction?: GradientDirection; 9313 colors: Array<any>; 9314 repeating?: boolean; 9315} 9316 9317/** 9318 * Linear Gradient Blur Interface 9319 * 9320 * @interface LinearGradientBlurOptions 9321 * @syscap SystemCapability.ArkUI.ArkUI.Full 9322 * @systemapi 9323 * @since 10 9324 */ 9325declare interface LinearGradientBlurOptions { 9326 /** 9327 * Percentage of blurring effect. 9328 * 9329 * @type { FractionStop[] } 9330 * @syscap SystemCapability.ArkUI.ArkUI.Full 9331 * @systemapi 9332 * @since 10 9333 */ 9334 fractionStops: FractionStop[]; 9335 /** 9336 * Direction of linear gradient blur. 9337 * 9338 * @type { GradientDirection } 9339 * @syscap SystemCapability.ArkUI.ArkUI.Full 9340 * @systemapi 9341 * @since 10 9342 */ 9343 direction: GradientDirection; 9344} 9345 9346/** 9347 * Sub component border info. 9348 * 9349 * @interface LayoutBorderInfo 9350 * @syscap SystemCapability.ArkUI.ArkUI.Full 9351 * @since 9 9352 * @form 9353 */ 9354/** 9355 * Sub component border info. 9356 * 9357 * @interface LayoutBorderInfo 9358 * @syscap SystemCapability.ArkUI.ArkUI.Full 9359 * @crossplatform 9360 * @since 10 9361 * @form 9362 */ 9363declare interface LayoutBorderInfo { 9364 /** 9365 * Sub component borderWidth info. 9366 * 9367 * @type { EdgeWidths } 9368 * @syscap SystemCapability.ArkUI.ArkUI.Full 9369 * @since 9 9370 * @form 9371 */ 9372 /** 9373 * Sub component borderWidth info. 9374 * 9375 * @type { EdgeWidths } 9376 * @syscap SystemCapability.ArkUI.ArkUI.Full 9377 * @crossplatform 9378 * @since 10 9379 * @form 9380 */ 9381 borderWidth: EdgeWidths; 9382 9383 /** 9384 * Sub component margin info. 9385 * 9386 * @type { Margin } 9387 * @syscap SystemCapability.ArkUI.ArkUI.Full 9388 * @since 9 9389 * @form 9390 */ 9391 /** 9392 * Sub component margin info. 9393 * 9394 * @type { Margin } 9395 * @syscap SystemCapability.ArkUI.ArkUI.Full 9396 * @crossplatform 9397 * @since 10 9398 * @form 9399 */ 9400 margin: Margin, 9401 9402 /** 9403 * Sub component padding info. 9404 * 9405 * @type { Padding } 9406 * @syscap SystemCapability.ArkUI.ArkUI.Full 9407 * @since 9 9408 * @form 9409 */ 9410 /** 9411 * Sub component padding info. 9412 * 9413 * @type { Padding } 9414 * @syscap SystemCapability.ArkUI.ArkUI.Full 9415 * @crossplatform 9416 * @since 10 9417 * @form 9418 */ 9419 padding: Padding, 9420} 9421 9422/** 9423 * Sub component layout info. 9424 * 9425 * @interface LayoutInfo 9426 * @syscap SystemCapability.ArkUI.ArkUI.Full 9427 * @since 9 9428 * @form 9429 */ 9430/** 9431 * Sub component layout info. 9432 * 9433 * @interface LayoutInfo 9434 * @syscap SystemCapability.ArkUI.ArkUI.Full 9435 * @crossplatform 9436 * @since 10 9437 * @form 9438 */ 9439declare interface LayoutInfo { 9440 /** 9441 * Sub component position info. 9442 * 9443 * @type { Position } 9444 * @syscap SystemCapability.ArkUI.ArkUI.Full 9445 * @since 9 9446 * @form 9447 */ 9448 /** 9449 * Sub component position info. 9450 * 9451 * @type { Position } 9452 * @syscap SystemCapability.ArkUI.ArkUI.Full 9453 * @crossplatform 9454 * @since 10 9455 * @form 9456 */ 9457 position: Position, 9458 9459 /** 9460 * Sub component constraint info. 9461 * 9462 * @type { ConstraintSizeOptions } 9463 * @syscap SystemCapability.ArkUI.ArkUI.Full 9464 * @since 9 9465 * @form 9466 */ 9467 /** 9468 * Sub component constraint info. 9469 * 9470 * @type { ConstraintSizeOptions } 9471 * @syscap SystemCapability.ArkUI.ArkUI.Full 9472 * @crossplatform 9473 * @since 10 9474 * @form 9475 */ 9476 constraint: ConstraintSizeOptions, 9477} 9478 9479/** 9480 * Sub component info passed from framework when layout and measure happens. 9481 * 9482 * @interface LayoutChild 9483 * @syscap SystemCapability.ArkUI.ArkUI.Full 9484 * @since 9 9485 * @form 9486 */ 9487/** 9488 * Sub component info passed from framework when layout and measure happens. 9489 * 9490 * @interface LayoutChild 9491 * @syscap SystemCapability.ArkUI.ArkUI.Full 9492 * @crossplatform 9493 * @since 10 9494 * @form 9495 */ 9496declare interface LayoutChild { 9497 /** 9498 * Sub component name. 9499 * 9500 * @type { string } 9501 * @syscap SystemCapability.ArkUI.ArkUI.Full 9502 * @since 9 9503 * @form 9504 */ 9505 /** 9506 * Sub component name. 9507 * 9508 * @type { string } 9509 * @syscap SystemCapability.ArkUI.ArkUI.Full 9510 * @crossplatform 9511 * @since 10 9512 * @form 9513 */ 9514 name: string, 9515 9516 /** 9517 * Sub component id. 9518 * 9519 * @type { string } 9520 * @syscap SystemCapability.ArkUI.ArkUI.Full 9521 * @since 9 9522 * @form 9523 */ 9524 /** 9525 * Sub component id. 9526 * 9527 * @type { string } 9528 * @syscap SystemCapability.ArkUI.ArkUI.Full 9529 * @crossplatform 9530 * @since 10 9531 * @form 9532 */ 9533 id: string, 9534 9535 /** 9536 * Sub component constraint. 9537 * 9538 * @type { ConstraintSizeOptions } 9539 * @syscap SystemCapability.ArkUI.ArkUI.Full 9540 * @since 9 9541 * @form 9542 */ 9543 /** 9544 * Sub component constraint. 9545 * 9546 * @type { ConstraintSizeOptions } 9547 * @syscap SystemCapability.ArkUI.ArkUI.Full 9548 * @crossplatform 9549 * @since 10 9550 * @form 9551 */ 9552 constraint: ConstraintSizeOptions, 9553 9554 /** 9555 * Sub component border info. 9556 * 9557 * @type { LayoutBorderInfo } 9558 * @syscap SystemCapability.ArkUI.ArkUI.Full 9559 * @since 9 9560 * @form 9561 */ 9562 /** 9563 * Sub component border info. 9564 * 9565 * @type { LayoutBorderInfo } 9566 * @syscap SystemCapability.ArkUI.ArkUI.Full 9567 * @crossplatform 9568 * @since 10 9569 * @form 9570 */ 9571 borderInfo: LayoutBorderInfo, 9572 9573 /** 9574 * Sub component position. 9575 * 9576 * @type { Position } 9577 * @syscap SystemCapability.ArkUI.ArkUI.Full 9578 * @since 9 9579 * @form 9580 */ 9581 /** 9582 * Sub component position. 9583 * 9584 * @type { Position } 9585 * @syscap SystemCapability.ArkUI.ArkUI.Full 9586 * @crossplatform 9587 * @since 10 9588 * @form 9589 */ 9590 position: Position, 9591 9592 /** 9593 * Call this measure method in onMeasure callback to supply sub component size. 9594 * 9595 * @param { ConstraintSizeOptions } childConstraint 9596 * @syscap SystemCapability.ArkUI.ArkUI.Full 9597 * @since 9 9598 * @form 9599 */ 9600 /** 9601 * Call this measure method in onMeasure callback to supply sub component size. 9602 * 9603 * @param { ConstraintSizeOptions } childConstraint 9604 * @syscap SystemCapability.ArkUI.ArkUI.Full 9605 * @crossplatform 9606 * @since 10 9607 * @form 9608 */ 9609 measure(childConstraint: ConstraintSizeOptions), 9610 9611 /** 9612 * Call this layout method in onLayout callback to assign layout info to sub component. 9613 * 9614 * @param { LayoutInfo } childLayoutInfo 9615 * @syscap SystemCapability.ArkUI.ArkUI.Full 9616 * @since 9 9617 * @form 9618 */ 9619 /** 9620 * Call this layout method in onLayout callback to assign layout info to sub component. 9621 * 9622 * @param { LayoutInfo } childLayoutInfo 9623 * @syscap SystemCapability.ArkUI.ArkUI.Full 9624 * @crossplatform 9625 * @since 10 9626 * @form 9627 */ 9628 layout(childLayoutInfo: LayoutInfo), 9629} 9630 9631/** 9632 * Sub component layout info. 9633 * 9634 * @interface GeometryInfo 9635 * @syscap SystemCapability.ArkUI.ArkUI.Full 9636 * @crossplatform 9637 * @since 10 9638 */ 9639declare interface GeometryInfo extends SizeResult { 9640 /** 9641 * Sub component borderWidth info. 9642 * 9643 * @type { EdgeWidth } 9644 * @syscap SystemCapability.ArkUI.ArkUI.Full 9645 * @crossplatform 9646 * @since 10 9647 */ 9648 borderWidth: EdgeWidth; 9649 9650 /** 9651 * Sub component margin info. 9652 * 9653 * @type { Margin } 9654 * @syscap SystemCapability.ArkUI.ArkUI.Full 9655 * @crossplatform 9656 * @since 10 9657 */ 9658 margin: Margin, 9659 9660 /** 9661 * Sub component padding info. 9662 * 9663 * @type { Padding } 9664 * @syscap SystemCapability.ArkUI.ArkUI.Full 9665 * @crossplatform 9666 * @since 10 9667 */ 9668 padding: Padding, 9669} 9670 9671/** 9672 * Sub component info passed from framework when layout happens. 9673 * 9674 * @interface Layoutable 9675 * @syscap SystemCapability.ArkUI.ArkUI.Full 9676 * @crossplatform 9677 * @since 10 9678 */ 9679declare interface Layoutable { 9680 /** 9681 * Sub component name. 9682 * 9683 * @type { MeasureResult } 9684 * @syscap SystemCapability.ArkUI.ArkUI.Full 9685 * @crossplatform 9686 * @since 10 9687 */ 9688 measureResult: MeasureResult, 9689 9690 /** 9691 * Call this layout method in onLayout callback to assign layout info to sub component. 9692 * 9693 * @param { Position } position 9694 * @syscap SystemCapability.ArkUI.ArkUI.Full 9695 * @crossplatform 9696 * @since 10 9697 */ 9698 layout(position: Position): void, 9699} 9700 9701/** 9702 * Sub component info passed from framework when measure happens. 9703 * 9704 * @interface Measurable 9705 * @syscap SystemCapability.ArkUI.ArkUI.Full 9706 * @crossplatform 9707 * @since 10 9708 */ 9709declare interface Measurable { 9710 /** 9711 * Call this measure method in onMeasure callback to supply sub component size. 9712 * 9713 * @param { ConstraintSizeOptions } childConstraint 9714 * @returns { MeasureResult } 9715 * @syscap SystemCapability.ArkUI.ArkUI.Full 9716 * @crossplatform 9717 * @since 10 9718 */ 9719 measure(constraint: ConstraintSizeOptions) : MeasureResult, 9720} 9721 9722/** 9723 * Sub component SizeResult info. 9724 * 9725 * @interface SizeResult 9726 * @syscap SystemCapability.ArkUI.ArkUI.Full 9727 * @crossplatform 9728 * @since 10 9729 */ 9730declare interface SizeResult { 9731 /** 9732 * Sub component width info. 9733 * 9734 * @type { number } 9735 * @syscap SystemCapability.ArkUI.ArkUI.Full 9736 * @crossplatform 9737 * @since 10 9738 */ 9739 width: number, 9740 9741 /** 9742 * Sub component height info. 9743 * 9744 * @type { number } 9745 * @syscap SystemCapability.ArkUI.ArkUI.Full 9746 * @crossplatform 9747 * @since 10 9748 */ 9749 height: number, 9750} 9751 9752/** 9753 * Sub component MeasureResult info. 9754 * 9755 * @interface MeasureResult 9756 * @syscap SystemCapability.ArkUI.ArkUI.Full 9757 * @crossplatform 9758 * @since 10 9759 */ 9760declare interface MeasureResult extends SizeResult { 9761 9762} 9763 9764/** 9765 * Custom Component 9766 * 9767 * @extends CommonAttribute 9768 * @syscap SystemCapability.ArkUI.ArkUI.Full 9769 * @since 7 9770 */ 9771/** 9772 * Custom Component 9773 * 9774 * @extends CommonAttribute 9775 * @syscap SystemCapability.ArkUI.ArkUI.Full 9776 * @since 9 9777 * @form 9778 */ 9779/** 9780 * Custom Component 9781 * 9782 * @extends CommonAttribute 9783 * @syscap SystemCapability.ArkUI.ArkUI.Full 9784 * @crossplatform 9785 * @since 10 9786 * @form 9787 */ 9788declare class CustomComponent extends CommonAttribute { 9789 /** 9790 * Customize the pop-up content constructor. 9791 * 9792 * @syscap SystemCapability.ArkUI.ArkUI.Full 9793 * @since 7 9794 */ 9795 /** 9796 * Customize the pop-up content constructor. 9797 * 9798 * @syscap SystemCapability.ArkUI.ArkUI.Full 9799 * @since 9 9800 * @form 9801 */ 9802 /** 9803 * Customize the pop-up content constructor. 9804 * 9805 * @syscap SystemCapability.ArkUI.ArkUI.Full 9806 * @crossplatform 9807 * @since 10 9808 * @form 9809 */ 9810 build(): void; 9811 9812 /** 9813 * aboutToAppear Method 9814 * 9815 * @syscap SystemCapability.ArkUI.ArkUI.Full 9816 * @since 7 9817 */ 9818 /** 9819 * aboutToAppear Method 9820 * 9821 * @syscap SystemCapability.ArkUI.ArkUI.Full 9822 * @since 9 9823 * @form 9824 */ 9825 /** 9826 * aboutToAppear Method 9827 * 9828 * @syscap SystemCapability.ArkUI.ArkUI.Full 9829 * @crossplatform 9830 * @since 10 9831 * @form 9832 */ 9833 aboutToAppear?(): void; 9834 9835 /** 9836 * aboutToDisappear Method 9837 * 9838 * @syscap SystemCapability.ArkUI.ArkUI.Full 9839 * @since 7 9840 */ 9841 /** 9842 * aboutToDisappear Method 9843 * 9844 * @syscap SystemCapability.ArkUI.ArkUI.Full 9845 * @since 9 9846 * @form 9847 */ 9848 /** 9849 * aboutToDisappear Method 9850 * 9851 * @syscap SystemCapability.ArkUI.ArkUI.Full 9852 * @crossplatform 9853 * @since 10 9854 * @form 9855 */ 9856 aboutToDisappear?(): void; 9857 9858 /** 9859 * aboutToReuse Method 9860 * 9861 * @param { object } params - Custom component init params. 9862 * @syscap SystemCapability.ArkUI.ArkUI.Full 9863 * @crossplatform 9864 * @since 10 9865 */ 9866 aboutToReuse?(params: { [key: string]: unknown }): void; 9867 9868 /** 9869 * aboutToRecycle Method 9870 * 9871 * @syscap SystemCapability.ArkUI.ArkUI.Full 9872 * @crossplatform 9873 * @since 10 9874 */ 9875 aboutToRecycle?(): void; 9876 9877 /** 9878 * Custom component override this method to layout each of its sub components. 9879 * 9880 * @param { Array<LayoutChild> } children 9881 * @param { ConstraintSizeOptions } constraint 9882 * @syscap SystemCapability.ArkUI.ArkUI.Full 9883 * @since 9 9884 * @deprecated since 10 9885 * @useinstead common[CustomComponent]#onPlaceChildren 9886 * @form 9887 */ 9888 onLayout?(children: Array<LayoutChild>, constraint: ConstraintSizeOptions): void; 9889 9890 /** 9891 * Custom component override this method to layout each of its sub components. 9892 * 9893 * @param { GeometryInfo } selfLayoutInfo 9894 * @param { Array<Layoutable> } children 9895 * @param { ConstraintSizeOptions } constraint 9896 * @syscap SystemCapability.ArkUI.ArkUI.Full 9897 * @crossplatform 9898 * @since 10 9899 */ 9900 onPlaceChildren?(selfLayoutInfo: GeometryInfo, children: Array<Layoutable>, constraint: ConstraintSizeOptions): void; 9901 9902 /** 9903 * Custom component override this method to measure each of its sub components. 9904 * 9905 * @param { Array<LayoutChild> } children 9906 * @param { ConstraintSizeOptions } constraint 9907 * @syscap SystemCapability.ArkUI.ArkUI.Full 9908 * @since 9 9909 * @deprecated since 10 9910 * @useinstead common[CustomComponent]#onMeasureSize 9911 * @form 9912 */ 9913 onMeasure?(children: Array<LayoutChild>, constraint: ConstraintSizeOptions): void; 9914 9915 /** 9916 * Custom component override this method to measure each of its sub components. 9917 * @param { GeometryInfo } selfLayoutInfo 9918 * @param { Array<Measurable> } children - indicate the measure child 9919 * @param { ConstraintSizeOptions } constraint - indicate child constraint size 9920 * @returns { SizeResult } 9921 * @syscap SystemCapability.ArkUI.ArkUI.Full 9922 * @crossplatform 9923 * @since 10 9924 */ 9925 onMeasureSize?(selfLayoutInfo: GeometryInfo, children: Array<Measurable>, constraint: ConstraintSizeOptions): SizeResult; 9926 9927 /** 9928 * onPageShow Method 9929 * 9930 * @syscap SystemCapability.ArkUI.ArkUI.Full 9931 * @since 7 9932 */ 9933 /** 9934 * onPageShow Method 9935 * 9936 * @syscap SystemCapability.ArkUI.ArkUI.Full 9937 * @crossplatform 9938 * @since 10 9939 */ 9940 onPageShow?(): void; 9941 9942 /** 9943 * onPageHide Method 9944 * 9945 * @syscap SystemCapability.ArkUI.ArkUI.Full 9946 * @since 7 9947 */ 9948 /** 9949 * onPageHide Method 9950 * 9951 * @syscap SystemCapability.ArkUI.ArkUI.Full 9952 * @crossplatform 9953 * @since 10 9954 */ 9955 onPageHide?(): void; 9956 9957 /** 9958 * onBackPress Method 9959 * 9960 * @returns { void | boolean } 9961 * @syscap SystemCapability.ArkUI.ArkUI.Full 9962 * @since 7 9963 */ 9964 /** 9965 * onBackPress Method 9966 * 9967 * @returns { void | boolean } true means that the page itself processes the return logic. 9968 * false means that the default return logic is used. 9969 * If no value is returned, the default return logic is used. 9970 * @syscap SystemCapability.ArkUI.ArkUI.Full 9971 * @crossplatform 9972 * @since 10 9973 */ 9974 onBackPress?(): void | boolean; 9975 9976 /** 9977 * PageTransition Method. 9978 * Implement Animation when enter this page or move to other pages. 9979 * 9980 * @syscap SystemCapability.ArkUI.ArkUI.Full 9981 * @since 9 9982 */ 9983 /** 9984 * PageTransition Method. 9985 * Implement Animation when enter this page or move to other pages. 9986 * 9987 * @syscap SystemCapability.ArkUI.ArkUI.Full 9988 * @crossplatform 9989 * @since 10 9990 */ 9991 pageTransition?(): void; 9992} 9993 9994/** 9995 * View 9996 * 9997 * @syscap SystemCapability.ArkUI.ArkUI.Full 9998 * @systemapi 9999 * @since 7 10000 */ 10001/** 10002 * View 10003 * 10004 * @syscap SystemCapability.ArkUI.ArkUI.Full 10005 * @systemapi 10006 * @since 9 10007 * @form 10008 */ 10009declare class View { 10010 /** 10011 * Just use for generate tsbundle 10012 * 10013 * @param { any } value 10014 * @returns { any } 10015 * @syscap SystemCapability.ArkUI.ArkUI.Full 10016 * @systemapi 10017 * @since 7 10018 */ 10019 /** 10020 * Just use for generate tsbundle 10021 * 10022 * @param { any } value 10023 * @returns { any } 10024 * @syscap SystemCapability.ArkUI.ArkUI.Full 10025 * @systemapi 10026 * @since 9 10027 * @form 10028 */ 10029 create(value: any): any; 10030} 10031 10032/** 10033 * Rect info. 10034 * 10035 * @interface RectResult 10036 * @syscap SystemCapability.ArkUI.ArkUI.Full 10037 * @crossplatform 10038 * @since 10 10039 */ 10040declare interface RectResult { 10041 /** 10042 * x:Horizontal coordinate relative to the component. 10043 * 10044 * @type { number } 10045 * @syscap SystemCapability.ArkUI.ArkUI.Full 10046 * @since 10 10047 */ 10048 x: number; 10049 10050 /** 10051 * y:Vertical axis coordinate relative to the component. 10052 * 10053 * @type { number } 10054 * @syscap SystemCapability.ArkUI.ArkUI.Full 10055 * @since 10 10056 */ 10057 y: number; 10058 10059 /** 10060 * Get the width of the current textRect. 10061 * 10062 * @type { number } 10063 * @syscap SystemCapability.ArkUI.ArkUI.Full 10064 * @since 10 10065 */ 10066 width: number; 10067 10068 /** 10069 * Get the height of the current textRect. 10070 * 10071 * @type { number } 10072 * @syscap SystemCapability.ArkUI.ArkUI.Full 10073 * @since 10 10074 */ 10075 height: number; 10076} 10077 10078/** 10079 * TextContentControllerBase 10080 * 10081 * @syscap SystemCapability.ArkUI.ArkUI.Full 10082 * @crossplatform 10083 * @since 10 10084 */ 10085declare abstract class TextContentControllerBase { 10086 /** 10087 * Get the start and end positions of the text content. 10088 * 10089 * @returns { RectResult } Text content rect. 10090 * @syscap SystemCapability.ArkUI.ArkUI.Full 10091 * @crossplatform 10092 * @since 10 10093 */ 10094 getTextContentRect() : RectResult; 10095 10096 /** 10097 * Get the lines number of the text content. 10098 * 10099 * @returns { number } Text content line count 10100 * @syscap SystemCapability.ArkUI.ArkUI.Full 10101 * @crossplatform 10102 * @since 10 10103 */ 10104 getTextContentLineCount() : number; 10105} 10106 10107declare module "SpecialEvent" { 10108 module "SpecialEvent" { 10109 // @ts-ignore 10110 export { TouchObject, KeyEvent, MouseEvent }; 10111 } 10112} 10113 10114declare module "AnimateToParam" { 10115 module "AnimateToParam" { 10116 // @ts-ignore 10117 export { AnimateParam }; 10118 } 10119} 10120 10121declare module 'DragControllerParam' { 10122 module 'DragControllerParam' { 10123 // @ts-ignore 10124 export type { CustomBuilder, DragItemInfo, DragEvent }; 10125 } 10126} 10127