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 * Defines the options of Component ClassDecorator. 18 * 19 * @interface ComponentOptions 20 * @syscap SystemCapability.ArkUI.ArkUI.Full 21 * @crossplatform 22 * @since 11 23 * @form 24 */ 25declare interface ComponentOptions { 26 /** 27 * freeze UI state. 28 * 29 * @type { boolean } 30 * @default false 31 * @syscap SystemCapability.ArkUI.ArkUI.Full 32 * @crossplatform 33 * @since 11 34 * @form 35 */ 36 freezeWhenInactive : boolean, 37} 38 39/** 40 * Define the ratio of characters entered by the the percentage of InputCounterOptions. 41 * 42 * @interface InputCounterOptions 43 * @syscap SystemCapability.ArkUI.ArkUI.Full 44 * @crossplatform 45 * @since 11 46 */ 47declare interface InputCounterOptions { 48 /** 49 * It is the numerator bit of the percentage and used as a threshold. If the number of characters input 50 * reaches the maximum number of characters multiplied by this threshold, the counter is displayed. 51 * @type { ?number } 52 * @syscap SystemCapability.ArkUI.ArkUI.Full 53 * @crossplatform 54 * @since 11 55 */ 56 thresholdPercentage?: number; 57 58 /** 59 * If the current input character count reaches the maximum character count and users want to exceed the 60 * normal input, the border will turn red. If this parameter is true, the red border displayed. 61 * @type { ?boolean } 62 * @default true 63 * @syscap SystemCapability.ArkUI.ArkUI.Full 64 * @crossplatform 65 * @since 11 66 */ 67 highlightBorder?: boolean; 68} 69 70/** 71 * Defining Component ClassDecorator 72 * 73 * @syscap SystemCapability.ArkUI.ArkUI.Full 74 * @since 7 75 */ 76/** 77 * Defining Component ClassDecorator 78 * 79 * @syscap SystemCapability.ArkUI.ArkUI.Full 80 * @since 9 81 * @form 82 */ 83/** 84 * Defining Component ClassDecorator 85 * 86 * @syscap SystemCapability.ArkUI.ArkUI.Full 87 * @crossplatform 88 * @since 10 89 * @form 90 */ 91/** 92 * Defining Component ClassDecorator 93 * 94 * Component is a ClassDecorator and it supports ComponentOptions as parameters. 95 * @syscap SystemCapability.ArkUI.ArkUI.Full 96 * @crossplatform 97 * @atomicservice 98 * @since 11 99 * @form 100 */ 101declare const Component: ClassDecorator & ((options: ComponentOptions) => ClassDecorator); 102 103/** 104 * Defines the options of Entry ClassDecorator. 105 * 106 * @interface EntryOptions 107 * @syscap SystemCapability.ArkUI.ArkUI.Full 108 * @since 10 109 * @form 110 */ 111/** 112 * Defines the options of Entry ClassDecorator. 113 * 114 * @interface EntryOptions 115 * @syscap SystemCapability.ArkUI.ArkUI.Full 116 * @atomicservice 117 * @since 11 118 * @form 119 */ 120declare interface EntryOptions { 121 /** 122 * Named route name. 123 * 124 * @type { ?string } 125 * @syscap SystemCapability.ArkUI.ArkUI.Full 126 * @since 10 127 * @form 128 */ 129 /** 130 * Named route name. 131 * 132 * @type { ?string } 133 * @syscap SystemCapability.ArkUI.ArkUI.Full 134 * @atomicservice 135 * @since 11 136 * @form 137 */ 138 routeName? : string, 139 140 /** 141 * LocalStorage to be passed. 142 * 143 * @type { ?LocalStorage } 144 * @syscap SystemCapability.ArkUI.ArkUI.Full 145 * @since 10 146 * @form 147 */ 148 /** 149 * LocalStorage to be passed. 150 * 151 * @type { ?LocalStorage } 152 * @syscap SystemCapability.ArkUI.ArkUI.Full 153 * @atomicservice 154 * @since 11 155 * @form 156 */ 157 storage? : LocalStorage, 158} 159 160/** 161 * Defines Entry ClassDecorator. 162 * 163 * @syscap SystemCapability.ArkUI.ArkUI.Full 164 * @since 7 165 */ 166/** 167 * Defines Entry ClassDecorator. 168 * 169 * Entry is a ClassDecorator and it supports LocalStorage as parameters. 170 * @syscap SystemCapability.ArkUI.ArkUI.Full 171 * @since 9 172 * @form 173 */ 174/** 175 * Defines Entry ClassDecorator. 176 * 177 * Entry is a ClassDecorator and it supports LocalStorage or EntryOptions as parameters. 178 * @syscap SystemCapability.ArkUI.ArkUI.Full 179 * @crossplatform 180 * @since 10 181 * @form 182 */ 183/** 184 * Defines Entry ClassDecorator. 185 * 186 * Entry is a ClassDecorator and it supports LocalStorage or EntryOptions as parameters. 187 * @syscap SystemCapability.ArkUI.ArkUI.Full 188 * @crossplatform 189 * @atomicservice 190 * @since 11 191 * @form 192 */ 193declare const Entry: ClassDecorator & ((options?: LocalStorage | EntryOptions) => ClassDecorator); 194 195/** 196 * Defining Observed ClassDecorator. 197 * 198 * @syscap SystemCapability.ArkUI.ArkUI.Full 199 * @since 7 200 */ 201/** 202 * Defining Observed ClassDecorator. 203 * 204 * @syscap SystemCapability.ArkUI.ArkUI.Full 205 * @since 9 206 * @form 207 */ 208/** 209 * Defining Observed ClassDecorator. 210 * 211 * @syscap SystemCapability.ArkUI.ArkUI.Full 212 * @crossplatform 213 * @since 10 214 * @form 215 */ 216/** 217 * Defining Observed ClassDecorator. 218 * 219 * @syscap SystemCapability.ArkUI.ArkUI.Full 220 * @crossplatform 221 * @atomicservice 222 * @since 11 223 * @form 224 */ 225declare const Observed: ClassDecorator; 226 227/** 228 * Defining Preview ClassDecorator. 229 * 230 * @syscap SystemCapability.ArkUI.ArkUI.Full 231 * @since 7 232 */ 233/** 234 * Defining Preview ClassDecorator. 235 * 236 * @syscap SystemCapability.ArkUI.ArkUI.Full 237 * @since 9 238 * @form 239 */ 240/** 241 * Defining Preview ClassDecorator. 242 * 243 * @syscap SystemCapability.ArkUI.ArkUI.Full 244 * @crossplatform 245 * @since 10 246 * @form 247 */ 248/** 249 * Defining Preview ClassDecorator. 250 * 251 * @syscap SystemCapability.ArkUI.ArkUI.Full 252 * @crossplatform 253 * @atomicservice 254 * @since 11 255 * @form 256 */ 257declare const Preview: ClassDecorator & ((value: PreviewParams) => ClassDecorator); 258 259/** 260 * Defining Require PropertyDecorator. 261 * 262 * @syscap SystemCapability.ArkUI.ArkUI.Full 263 * @crossplatform 264 * @atomicservice 265 * @since 11 266 * @form 267 */ 268declare const Require: PropertyDecorator; 269 270/** 271 * Defining BuilderParam PropertyDecorator 272 * 273 * @syscap SystemCapability.ArkUI.ArkUI.Full 274 * @since 7 275 */ 276/** 277 * Defining BuilderParam PropertyDecorator 278 * 279 * @syscap SystemCapability.ArkUI.ArkUI.Full 280 * @since 9 281 * @form 282 */ 283/** 284 * Defining BuilderParam PropertyDecorator 285 * 286 * @syscap SystemCapability.ArkUI.ArkUI.Full 287 * @crossplatform 288 * @since 10 289 * @form 290 */ 291/** 292 * Defining BuilderParam PropertyDecorator 293 * 294 * @syscap SystemCapability.ArkUI.ArkUI.Full 295 * @crossplatform 296 * @atomicservice 297 * @since 11 298 * @form 299 */ 300declare const BuilderParam: PropertyDecorator; 301 302/** 303 * Defining State PropertyDecorator. 304 * 305 * @syscap SystemCapability.ArkUI.ArkUI.Full 306 * @since 7 307 */ 308/** 309 * Defining State PropertyDecorator. 310 * 311 * @syscap SystemCapability.ArkUI.ArkUI.Full 312 * @since 9 313 * @form 314 */ 315/** 316 * Defining State PropertyDecorator. 317 * 318 * @syscap SystemCapability.ArkUI.ArkUI.Full 319 * @crossplatform 320 * @since 10 321 * @form 322 */ 323/** 324 * Defining State PropertyDecorator. 325 * 326 * @syscap SystemCapability.ArkUI.ArkUI.Full 327 * @crossplatform 328 * @atomicservice 329 * @since 11 330 * @form 331 */ 332declare const State: PropertyDecorator; 333 334/** 335 * Defining Track PropertyDecorator. 336 * 337 * @syscap SystemCapability.ArkUI.ArkUI.Full 338 * @crossplatform 339 * @since 11 340 * @form 341 */ 342declare const Track: PropertyDecorator; 343 344/** 345 * Defining Prop PropertyDecorator. 346 * 347 * @syscap SystemCapability.ArkUI.ArkUI.Full 348 * @since 7 349 */ 350/** 351 * Defining Prop PropertyDecorator. 352 * 353 * @syscap SystemCapability.ArkUI.ArkUI.Full 354 * @since 9 355 * @form 356 */ 357/** 358 * Defining Prop PropertyDecorator. 359 * 360 * @syscap SystemCapability.ArkUI.ArkUI.Full 361 * @crossplatform 362 * @since 10 363 * @form 364 */ 365/** 366 * Defining Prop PropertyDecorator. 367 * 368 * @syscap SystemCapability.ArkUI.ArkUI.Full 369 * @crossplatform 370 * @atomicservice 371 * @since 11 372 * @form 373 */ 374declare const Prop: PropertyDecorator; 375 376/** 377 * Defining Link PropertyDecorator. 378 * 379 * @syscap SystemCapability.ArkUI.ArkUI.Full 380 * @since 7 381 */ 382/** 383 * Defining Link PropertyDecorator. 384 * 385 * @syscap SystemCapability.ArkUI.ArkUI.Full 386 * @since 9 387 * @form 388 */ 389/** 390 * Defining Link PropertyDecorator. 391 * 392 * @syscap SystemCapability.ArkUI.ArkUI.Full 393 * @crossplatform 394 * @since 10 395 * @form 396 */ 397/** 398 * Defining Link PropertyDecorator. 399 * 400 * @syscap SystemCapability.ArkUI.ArkUI.Full 401 * @crossplatform 402 * @atomicservice 403 * @since 11 404 * @form 405 */ 406declare const Link: PropertyDecorator; 407 408/** 409 * Defining ObjectLink PropertyDecorator. 410 * 411 * @syscap SystemCapability.ArkUI.ArkUI.Full 412 * @since 7 413 */ 414/** 415 * Defining ObjectLink PropertyDecorator. 416 * 417 * @syscap SystemCapability.ArkUI.ArkUI.Full 418 * @since 9 419 * @form 420 */ 421/** 422 * Defining ObjectLink PropertyDecorator. 423 * 424 * @syscap SystemCapability.ArkUI.ArkUI.Full 425 * @crossplatform 426 * @since 10 427 * @form 428 */ 429/** 430 * Defining ObjectLink PropertyDecorator. 431 * 432 * @syscap SystemCapability.ArkUI.ArkUI.Full 433 * @crossplatform 434 * @atomicservice 435 * @since 11 436 * @form 437 */ 438declare const ObjectLink: PropertyDecorator; 439 440/** 441 * Defines the options of Provide PropertyDecorator. 442 * 443 * @interface ProvideOptions 444 * @syscap SystemCapability.ArkUI.ArkUI.Full 445 * @crossplatform 446 * @atomicservice 447 * @since 11 448 * @form 449 */ 450declare interface ProvideOptions { 451 /** 452 * Override the @Provide of any parent or parent of parent @Component.@Provide({allowOverride: "name"}) is 453 * also allowed to be used even when there is no ancestor @Component whose @Provide would be overridden. 454 * 455 * @type { ?string } 456 * @syscap SystemCapability.ArkUI.ArkUI.Full 457 * @crossplatform 458 * @atomicservice 459 * @since 11 460 * @form 461 */ 462 allowOverride?: string, 463} 464 465/** 466 * Defining Provide PropertyDecorator. 467 * 468 * @syscap SystemCapability.ArkUI.ArkUI.Full 469 * @since 7 470 */ 471/** 472 * Defining Provide PropertyDecorator. 473 * 474 * @syscap SystemCapability.ArkUI.ArkUI.Full 475 * @since 9 476 * @form 477 */ 478/** 479 * Defining Provide PropertyDecorator. 480 * 481 * @syscap SystemCapability.ArkUI.ArkUI.Full 482 * @crossplatform 483 * @since 10 484 * @form 485 */ 486/** 487 * Defining Provide PropertyDecorator. 488 * 489 * @syscap SystemCapability.ArkUI.ArkUI.Full 490 * @crossplatform 491 * @atomicservice 492 * @since 11 493 * @form 494 */ 495declare const Provide: PropertyDecorator & ((value: string | ProvideOptions) => PropertyDecorator); 496 497/** 498 * Defining Consume PropertyDecorator. 499 * 500 * @syscap SystemCapability.ArkUI.ArkUI.Full 501 * @since 7 502 */ 503/** 504 * Defining Consume PropertyDecorator. 505 * 506 * @syscap SystemCapability.ArkUI.ArkUI.Full 507 * @since 9 508 * @form 509 */ 510/** 511 * Defining Consume PropertyDecorator. 512 * 513 * @syscap SystemCapability.ArkUI.ArkUI.Full 514 * @crossplatform 515 * @since 10 516 * @form 517 */ 518/** 519 * Defining Consume PropertyDecorator. 520 * 521 * @syscap SystemCapability.ArkUI.ArkUI.Full 522 * @crossplatform 523 * @atomicservice 524 * @since 11 525 * @form 526 */ 527declare const Consume: PropertyDecorator & ((value: string) => PropertyDecorator); 528 529/** 530 * Defining StorageProp PropertyDecorator. 531 * 532 * @syscap SystemCapability.ArkUI.ArkUI.Full 533 * @since 7 534 */ 535/** 536 * Defining StorageProp PropertyDecorator. 537 * 538 * @syscap SystemCapability.ArkUI.ArkUI.Full 539 * @crossplatform 540 * @since 10 541 */ 542/** 543 * Defining StorageProp PropertyDecorator. 544 * 545 * @syscap SystemCapability.ArkUI.ArkUI.Full 546 * @crossplatform 547 * @atomicservice 548 * @since 11 549 */ 550declare const StorageProp: (value: string) => PropertyDecorator; 551 552/** 553 * Defining StorageLink PropertyDecorator. 554 * 555 * @syscap SystemCapability.ArkUI.ArkUI.Full 556 * @since 7 557 */ 558/** 559 * Defining StorageLink PropertyDecorator. 560 * 561 * @syscap SystemCapability.ArkUI.ArkUI.Full 562 * @crossplatform 563 * @since 10 564 */ 565/** 566 * Defining StorageLink PropertyDecorator. 567 * 568 * @syscap SystemCapability.ArkUI.ArkUI.Full 569 * @crossplatform 570 * @atomicservice 571 * @since 11 572 */ 573declare const StorageLink: (value: string) => PropertyDecorator; 574 575/** 576 * Defining Watch PropertyDecorator. 577 * 578 * @syscap SystemCapability.ArkUI.ArkUI.Full 579 * @since 7 580 */ 581/** 582 * Defining Watch PropertyDecorator. 583 * 584 * @syscap SystemCapability.ArkUI.ArkUI.Full 585 * @since 9 586 * @form 587 */ 588/** 589 * Defining Watch PropertyDecorator. 590 * 591 * @syscap SystemCapability.ArkUI.ArkUI.Full 592 * @crossplatform 593 * @since 10 594 * @form 595 */ 596/** 597 * Defining Watch PropertyDecorator. 598 * 599 * @syscap SystemCapability.ArkUI.ArkUI.Full 600 * @crossplatform 601 * @atomicservice 602 * @since 11 603 * @form 604 */ 605declare const Watch: (value: string) => PropertyDecorator; 606 607/** 608 * Defining Builder MethodDecorator 609 * 610 * @syscap SystemCapability.ArkUI.ArkUI.Full 611 * @since 7 612 */ 613/** 614 * Defining Builder MethodDecorator 615 * 616 * @syscap SystemCapability.ArkUI.ArkUI.Full 617 * @since 9 618 * @form 619 */ 620/** 621 * Defining Builder MethodDecorator 622 * 623 * @syscap SystemCapability.ArkUI.ArkUI.Full 624 * @crossplatform 625 * @since 10 626 * @form 627 */ 628/** 629 * Defining Builder MethodDecorator 630 * 631 * @syscap SystemCapability.ArkUI.ArkUI.Full 632 * @crossplatform 633 * @atomicservice 634 * @since 11 635 * @form 636 */ 637declare const Builder: MethodDecorator; 638 639/** 640 * Defining Styles MethodDecorator 641 * 642 * @syscap SystemCapability.ArkUI.ArkUI.Full 643 * @since 8 644 */ 645/** 646 * Defining Styles MethodDecorator 647 * 648 * @syscap SystemCapability.ArkUI.ArkUI.Full 649 * @since 9 650 * @form 651 */ 652/** 653 * Defining Styles MethodDecorator 654 * 655 * @syscap SystemCapability.ArkUI.ArkUI.Full 656 * @crossplatform 657 * @since 10 658 * @form 659 */ 660/** 661 * Defining Styles MethodDecorator 662 * 663 * @syscap SystemCapability.ArkUI.ArkUI.Full 664 * @crossplatform 665 * @atomicservice 666 * @since 11 667 * @form 668 */ 669declare const Styles: MethodDecorator; 670 671/** 672 * Defining Extend MethodDecorator 673 * 674 * @syscap SystemCapability.ArkUI.ArkUI.Full 675 * @since 7 676 */ 677/** 678 * Defining Extend MethodDecorator 679 * 680 * @syscap SystemCapability.ArkUI.ArkUI.Full 681 * @since 9 682 * @form 683 */ 684/** 685 * Defining Extend MethodDecorator 686 * 687 * @syscap SystemCapability.ArkUI.ArkUI.Full 688 * @crossplatform 689 * @since 10 690 * @form 691 */ 692/** 693 * Defining Extend MethodDecorator 694 * 695 * @syscap SystemCapability.ArkUI.ArkUI.Full 696 * @crossplatform 697 * @atomicservice 698 * @since 11 699 * @form 700 */ 701declare const Extend: MethodDecorator & ((value: any) => MethodDecorator); 702 703/** 704 * Define AnimatableExtend MethodDecorator 705 * 706 * @syscap SystemCapability.ArkUI.ArkUI.Full 707 * @crossplatform 708 * @since 10 709 */ 710/** 711 * Define AnimatableExtend MethodDecorator 712 * 713 * @syscap SystemCapability.ArkUI.ArkUI.Full 714 * @crossplatform 715 * @atomicservice 716 * @since 11 717 */ 718 declare const AnimatableExtend: MethodDecorator & ((value: Object) => MethodDecorator); 719 720/** 721 * Define AnimatableArithmetic interface 722 * 723 * @interface AnimatableArithmetic 724 * @syscap SystemCapability.ArkUI.ArkUI.Full 725 * @crossplatform 726 * @since 10 727 */ 728/** 729 * Define AnimatableArithmetic interface 730 * 731 * @interface AnimatableArithmetic 732 * @syscap SystemCapability.ArkUI.ArkUI.Full 733 * @crossplatform 734 * @atomicservice 735 * @since 11 736 */ 737 declare interface AnimatableArithmetic<T> { 738 /** 739 * Define plus method 740 * 741 * @param { AnimatableArithmetic<T> } rhs - another value 742 * @returns { AnimatableArithmetic<T> } new value which implements AnimatableArithmetic<T> interface 743 * @syscap SystemCapability.ArkUI.ArkUI.Full 744 * @crossplatform 745 * @since 10 746 */ 747 /** 748 * Define plus method 749 * 750 * @param { AnimatableArithmetic<T> } rhs - another value 751 * @returns { AnimatableArithmetic<T> } new value which implements AnimatableArithmetic<T> interface 752 * @syscap SystemCapability.ArkUI.ArkUI.Full 753 * @crossplatform 754 * @atomicservice 755 * @since 11 756 */ 757 plus(rhs: AnimatableArithmetic<T>): AnimatableArithmetic<T>; 758 759 /** 760 * Define subtract method 761 * 762 * @param { AnimatableArithmetic<T> } rhs - another value 763 * @returns { AnimatableArithmetic<T> } new value which implements AnimatableArithmetic<T> interface 764 * @syscap SystemCapability.ArkUI.ArkUI.Full 765 * @crossplatform 766 * @since 10 767 */ 768 /** 769 * Define subtract method 770 * 771 * @param { AnimatableArithmetic<T> } rhs - another value 772 * @returns { AnimatableArithmetic<T> } new value which implements AnimatableArithmetic<T> interface 773 * @syscap SystemCapability.ArkUI.ArkUI.Full 774 * @crossplatform 775 * @atomicservice 776 * @since 11 777 */ 778 subtract(rhs: AnimatableArithmetic<T>): AnimatableArithmetic<T>; 779 780 /** 781 * Define multiply method 782 * 783 * @param { number } scale - scale value 784 * @returns { AnimatableArithmetic<T> } new value which implements AnimatableArithmetic<T> interface 785 * @syscap SystemCapability.ArkUI.ArkUI.Full 786 * @crossplatform 787 * @since 10 788 */ 789 /** 790 * Define multiply method 791 * 792 * @param { number } scale - scale value 793 * @returns { AnimatableArithmetic<T> } new value which implements AnimatableArithmetic<T> interface 794 * @syscap SystemCapability.ArkUI.ArkUI.Full 795 * @crossplatform 796 * @atomicservice 797 * @since 11 798 */ 799 multiply(scale: number): AnimatableArithmetic<T>; 800 801 /** 802 * Define equals method 803 * 804 * @param { AnimatableArithmetic<T> } rhs - another value 805 * @returns { boolean } is equals 806 * @syscap SystemCapability.ArkUI.ArkUI.Full 807 * @crossplatform 808 * @since 10 809 */ 810 /** 811 * Define equals method 812 * 813 * @param { AnimatableArithmetic<T> } rhs - another value 814 * @returns { boolean } is equals 815 * @syscap SystemCapability.ArkUI.ArkUI.Full 816 * @crossplatform 817 * @atomicservice 818 * @since 11 819 */ 820 equals(rhs: AnimatableArithmetic<T>): boolean; 821} 822 823/** 824 * Defining Concurrent MethodDecorator 825 * 826 * @syscap SystemCapability.ArkUI.ArkUI.Full 827 * @since 9 828 */ 829/** 830 * Defining Concurrent MethodDecorator 831 * 832 * @syscap SystemCapability.ArkUI.ArkUI.Full 833 * @crossplatform 834 * @since 10 835 */ 836/** 837 * Defining Concurrent MethodDecorator 838 * 839 * @syscap SystemCapability.ArkUI.ArkUI.Full 840 * @crossplatform 841 * @atomicservice 842 * @since 11 843 */ 844declare const Concurrent: MethodDecorator; 845 846/** 847 * Defining Sendable ClassDecorator 848 * The Sendable decorator can be used only for classes. A class with this decorator is marked as sendable, and the class object can be shared globally. 849 * @syscap SystemCapability.ArkUI.ArkUI.Full 850 * @crossplatform 851 * @atomicservice 852 * @since 11 853 */ 854declare const Sendable: ClassDecorator; 855 856/** 857 * Defining CustomDialog ClassDecorator 858 * 859 * @syscap SystemCapability.ArkUI.ArkUI.Full 860 * @since 7 861 */ 862/** 863 * Defining CustomDialog ClassDecorator 864 * 865 * @syscap SystemCapability.ArkUI.ArkUI.Full 866 * @crossplatform 867 * @since 10 868 */ 869/** 870 * Defining CustomDialog ClassDecorator 871 * 872 * @syscap SystemCapability.ArkUI.ArkUI.Full 873 * @crossplatform 874 * @atomicservice 875 * @since 11 876 */ 877declare const CustomDialog: ClassDecorator; 878 879/** 880 * Defining LocalStorageLink PropertyDecorator. 881 * 882 * @syscap SystemCapability.ArkUI.ArkUI.Full 883 * @since 9 884 */ 885/** 886 * Defining LocalStorageLink PropertyDecorator. 887 * 888 * @syscap SystemCapability.ArkUI.ArkUI.Full 889 * @crossplatform 890 * @since 10 891 */ 892/** 893 * Defining LocalStorageLink PropertyDecorator. 894 * 895 * @syscap SystemCapability.ArkUI.ArkUI.Full 896 * @crossplatform 897 * @atomicservice 898 * @since 11 899 */ 900declare const LocalStorageLink: (value: string) => PropertyDecorator; 901 902/** 903 * Defining LocalStorageProp PropertyDecorator 904 * 905 * @syscap SystemCapability.ArkUI.ArkUI.Full 906 * @since 9 907 * @form 908 */ 909/** 910 * Defining LocalStorageProp PropertyDecorator 911 * 912 * @syscap SystemCapability.ArkUI.ArkUI.Full 913 * @crossplatform 914 * @since 10 915 * @form 916 */ 917/** 918 * Defining LocalStorageProp PropertyDecorator 919 * 920 * @syscap SystemCapability.ArkUI.ArkUI.Full 921 * @crossplatform 922 * @atomicservice 923 * @since 11 924 * @form 925 */ 926declare const LocalStorageProp: (value: string) => PropertyDecorator; 927 928/** 929 * Obtains the Context object associated with a component on the page. 930 * 931 * @param { Object } component - indicate the component on the page. 932 * @returns { Context } 933 * @syscap SystemCapability.ArkUI.ArkUI.Full 934 * @StageModelOnly 935 * @since 9 936 */ 937/** 938 * Obtains the Context object associated with a component on the page. 939 * 940 * @param { Object } component - indicate the component on the page. 941 * @returns { Context } 942 * @syscap SystemCapability.ArkUI.ArkUI.Full 943 * @StageModelOnly 944 * @crossplatform 945 * @since 10 946 */ 947/** 948 * Obtains the Context object associated with a component on the page. 949 * 950 * @param { Object } component - indicate the component on the page. 951 * @returns { Context } 952 * @syscap SystemCapability.ArkUI.ArkUI.Full 953 * @StageModelOnly 954 * @crossplatform 955 * @atomicservice 956 * @since 11 957 */ 958declare function getContext(component?: Object): Context; 959 960/** 961 * Defining Reusable ClassDecorator. 962 * 963 * @syscap SystemCapability.ArkUI.ArkUI.Full 964 * @crossplatform 965 * @since 10 966 */ 967/** 968 * Defining Reusable ClassDecorator. 969 * 970 * @syscap SystemCapability.ArkUI.ArkUI.Full 971 * @crossplatform 972 * @atomicservice 973 * @since 11 974 */ 975declare const Reusable: ClassDecorator; 976 977/** 978 * Get context. 979 * 980 * @syscap SystemCapability.ArkUI.ArkUI.Full 981 * @StageModelOnly 982 * @since 9 983 */ 984/** 985 * Get context. 986 * 987 * @syscap SystemCapability.ArkUI.ArkUI.Full 988 * @StageModelOnly 989 * @crossplatform 990 * @since 10 991 */ 992/** 993 * Get context. 994 * 995 * @syscap SystemCapability.ArkUI.ArkUI.Full 996 * @StageModelOnly 997 * @crossplatform 998 * @atomicservice 999 * @since 11 1000 */ 1001declare type Context = import('../api/application/Context').default; 1002 1003/** 1004 * Post Card Action. 1005 * 1006 * @param { Object } component - indicate the card entry component. 1007 * @param { Object } action - indicate the router, message or call event. 1008 * @syscap SystemCapability.ArkUI.ArkUI.Full 1009 * @StageModelOnly 1010 * @since 9 1011 * @form 1012 */ 1013/** 1014 * Post Card Action. 1015 * 1016 * @param { Object } component - indicate the card entry component. 1017 * @param { Object } action - indicate the router, message or call event. 1018 * @syscap SystemCapability.ArkUI.ArkUI.Full 1019 * @StageModelOnly 1020 * @crossplatform 1021 * @since 10 1022 * @form 1023 */ 1024/** 1025 * Post Card Action. 1026 * 1027 * @param { Object } component - indicate the card entry component. 1028 * @param { Object } action - indicate the router, message or call event. 1029 * @syscap SystemCapability.ArkUI.ArkUI.Full 1030 * @StageModelOnly 1031 * @crossplatform 1032 * @atomicservice 1033 * @since 11 1034 * @form 1035 */ 1036declare function postCardAction(component: Object, action: Object): void; 1037 1038/** 1039 * Defines the data type of the interface restriction. 1040 * 1041 * @interface Configuration 1042 * @syscap SystemCapability.ArkUI.ArkUI.Full 1043 * @since 7 1044 */ 1045/** 1046 * Defines the data type of the interface restriction. 1047 * 1048 * @interface Configuration 1049 * @syscap SystemCapability.ArkUI.ArkUI.Full 1050 * @since 9 1051 * @form 1052 */ 1053/** 1054 * Defines the data type of the interface restriction. 1055 * 1056 * @interface Configuration 1057 * @syscap SystemCapability.ArkUI.ArkUI.Full 1058 * @crossplatform 1059 * @since 10 1060 * @form 1061 */ 1062/** 1063 * Defines the data type of the interface restriction. 1064 * 1065 * @interface Configuration 1066 * @syscap SystemCapability.ArkUI.ArkUI.Full 1067 * @crossplatform 1068 * @atomicservice 1069 * @since 11 1070 * @form 1071 */ 1072declare interface Configuration { 1073 /** 1074 * Set colorMode. 1075 * 1076 * @type { string } 1077 * @syscap SystemCapability.ArkUI.ArkUI.Full 1078 * @since 7 1079 */ 1080 /** 1081 * Set colorMode. 1082 * 1083 * @type { string } 1084 * @syscap SystemCapability.ArkUI.ArkUI.Full 1085 * @since 9 1086 * @form 1087 */ 1088 /** 1089 * Set colorMode. 1090 * 1091 * @type { string } 1092 * @syscap SystemCapability.ArkUI.ArkUI.Full 1093 * @crossplatform 1094 * @since 10 1095 * @form 1096 */ 1097 /** 1098 * Set colorMode. 1099 * 1100 * @type { string } 1101 * @syscap SystemCapability.ArkUI.ArkUI.Full 1102 * @crossplatform 1103 * @atomicservice 1104 * @since 11 1105 * @form 1106 */ 1107 readonly colorMode: string; 1108 1109 /** 1110 * Set fontScale. 1111 * 1112 * @type { number } 1113 * @syscap SystemCapability.ArkUI.ArkUI.Full 1114 * @since 7 1115 */ 1116 /** 1117 * Set fontScale. 1118 * 1119 * @type { number } 1120 * @syscap SystemCapability.ArkUI.ArkUI.Full 1121 * @since 9 1122 * @form 1123 */ 1124 /** 1125 * Set fontScale. 1126 * 1127 * @type { number } 1128 * @syscap SystemCapability.ArkUI.ArkUI.Full 1129 * @crossplatform 1130 * @since 10 1131 * @form 1132 */ 1133 /** 1134 * Set fontScale. 1135 * 1136 * @type { number } 1137 * @syscap SystemCapability.ArkUI.ArkUI.Full 1138 * @crossplatform 1139 * @atomicservice 1140 * @since 11 1141 * @form 1142 */ 1143 readonly fontScale: number; 1144} 1145 1146/** 1147 * Defines the data type of the interface restriction. 1148 * 1149 * @interface Rectangle 1150 * @syscap SystemCapability.ArkUI.ArkUI.Full 1151 * @since 8 1152 */ 1153/** 1154 * Defines the data type of the interface restriction. 1155 * 1156 * @interface Rectangle 1157 * @syscap SystemCapability.ArkUI.ArkUI.Full 1158 * @since 9 1159 * @form 1160 */ 1161/** 1162 * Defines the data type of the interface restriction. 1163 * 1164 * @interface Rectangle 1165 * @syscap SystemCapability.ArkUI.ArkUI.Full 1166 * @crossplatform 1167 * @since 10 1168 * @form 1169 */ 1170/** 1171 * Defines the data type of the interface restriction. 1172 * 1173 * @interface Rectangle 1174 * @syscap SystemCapability.ArkUI.ArkUI.Full 1175 * @crossplatform 1176 * @atomicservice 1177 * @since 11 1178 * @form 1179 */ 1180declare interface Rectangle { 1181 /** 1182 * x:Horizontal coordinate 1183 * 1184 * @type { ?Length } 1185 * @syscap SystemCapability.ArkUI.ArkUI.Full 1186 * @since 8 1187 */ 1188 /** 1189 * x:Horizontal coordinate 1190 * 1191 * @type { ?Length } 1192 * @syscap SystemCapability.ArkUI.ArkUI.Full 1193 * @since 9 1194 * @form 1195 */ 1196 /** 1197 * x:Horizontal coordinate 1198 * 1199 * @type { ?Length } 1200 * @syscap SystemCapability.ArkUI.ArkUI.Full 1201 * @crossplatform 1202 * @since 10 1203 * @form 1204 */ 1205 /** 1206 * x:Horizontal coordinate 1207 * 1208 * @type { ?Length } 1209 * @syscap SystemCapability.ArkUI.ArkUI.Full 1210 * @crossplatform 1211 * @atomicservice 1212 * @since 11 1213 * @form 1214 */ 1215 x?: Length; 1216 1217 /** 1218 * y:Vertical axis coordinate. 1219 * 1220 * @type { ?Length } 1221 * @syscap SystemCapability.ArkUI.ArkUI.Full 1222 * @since 8 1223 */ 1224 /** 1225 * y:Vertical axis coordinate. 1226 * 1227 * @type { ?Length } 1228 * @syscap SystemCapability.ArkUI.ArkUI.Full 1229 * @since 9 1230 * @form 1231 */ 1232 /** 1233 * y:Vertical axis coordinate. 1234 * 1235 * @type { ?Length } 1236 * @syscap SystemCapability.ArkUI.ArkUI.Full 1237 * @crossplatform 1238 * @since 10 1239 * @form 1240 */ 1241 /** 1242 * y:Vertical axis coordinate. 1243 * 1244 * @type { ?Length } 1245 * @syscap SystemCapability.ArkUI.ArkUI.Full 1246 * @crossplatform 1247 * @atomicservice 1248 * @since 11 1249 * @form 1250 */ 1251 y?: Length; 1252 1253 /** 1254 * Sets the width of the current touchRect. 1255 * 1256 * @type { ?Length } 1257 * @syscap SystemCapability.ArkUI.ArkUI.Full 1258 * @since 8 1259 */ 1260 /** 1261 * Sets the width of the current touchRect. 1262 * 1263 * @type { ?Length } 1264 * @syscap SystemCapability.ArkUI.ArkUI.Full 1265 * @since 9 1266 * @form 1267 */ 1268 /** 1269 * Sets the width of the current touchRect. 1270 * 1271 * @type { ?Length } 1272 * @syscap SystemCapability.ArkUI.ArkUI.Full 1273 * @crossplatform 1274 * @since 10 1275 * @form 1276 */ 1277 /** 1278 * Sets the width of the current touchRect. 1279 * 1280 * @type { ?Length } 1281 * @syscap SystemCapability.ArkUI.ArkUI.Full 1282 * @crossplatform 1283 * @atomicservice 1284 * @since 11 1285 * @form 1286 */ 1287 width?: Length; 1288 1289 /** 1290 * Sets the height of the current touchRect. 1291 * 1292 * @type { ?Length } 1293 * @syscap SystemCapability.ArkUI.ArkUI.Full 1294 * @since 8 1295 */ 1296 /** 1297 * Sets the height of the current touchRect. 1298 * 1299 * @type { ?Length } 1300 * @syscap SystemCapability.ArkUI.ArkUI.Full 1301 * @since 9 1302 * @form 1303 */ 1304 /** 1305 * Sets the height of the current touchRect. 1306 * 1307 * @type { ?Length } 1308 * @syscap SystemCapability.ArkUI.ArkUI.Full 1309 * @crossplatform 1310 * @since 10 1311 * @form 1312 */ 1313 /** 1314 * Sets the height of the current touchRect. 1315 * 1316 * @type { ?Length } 1317 * @syscap SystemCapability.ArkUI.ArkUI.Full 1318 * @crossplatform 1319 * @atomicservice 1320 * @since 11 1321 * @form 1322 */ 1323 height?: Length; 1324} 1325 1326/** 1327 * Interface for ExpectedFrameRateRange. 1328 * 1329 * @interface ExpectedFrameRateRange 1330 * @syscap SystemCapability.ArkUI.ArkUI.Full 1331 * @since 11 1332 */ 1333declare interface ExpectedFrameRateRange { 1334 /** 1335 * The minimum animation drawing FPS. 1336 * The minimum value should be less than or equal to the maximum value. 1337 * @type { number } 1338 * @syscap SystemCapability.ArkUI.ArkUI.Full 1339 * @since 11 1340 */ 1341 min: number, 1342 /** 1343 * The maximum animation drawing FPS. 1344 * The maximum value should be greater than or equal to the minimum value. 1345 * @type { number } 1346 * @syscap SystemCapability.ArkUI.ArkUI.Full 1347 * @since 11 1348 */ 1349 max: number, 1350 /** 1351 * The expected frame rate of dynamical callback rate range. 1352 * The value should be between the minimum and maximum value. 1353 * Otherwise, the actual callback rate will be dynamically 1354 * adjusted to better align with other animation sources. 1355 * @type { number } 1356 * @syscap SystemCapability.ArkUI.ArkUI.Full 1357 * @since 11 1358 */ 1359 expected: number, 1360} 1361 1362/** 1363 * global $r function 1364 * 1365 * @param { string } value 1366 * @param { any[] } params 1367 * @returns { Resource } 1368 * @syscap SystemCapability.ArkUI.ArkUI.Full 1369 * @since 7 1370 */ 1371/** 1372 * global $r function 1373 * 1374 * @param { string } value 1375 * @param { any[] } params 1376 * @returns { Resource } 1377 * @syscap SystemCapability.ArkUI.ArkUI.Full 1378 * @since 9 1379 * @form 1380 */ 1381/** 1382 * global $r function 1383 * 1384 * @param { string } value 1385 * @param { any[] } params 1386 * @returns { Resource } 1387 * @syscap SystemCapability.ArkUI.ArkUI.Full 1388 * @crossplatform 1389 * @since 10 1390 * @form 1391 */ 1392/** 1393 * global $r function 1394 * 1395 * @param { string } value 1396 * @param { any[] } params 1397 * @returns { Resource } 1398 * @syscap SystemCapability.ArkUI.ArkUI.Full 1399 * @crossplatform 1400 * @atomicservice 1401 * @since 11 1402 * @form 1403 */ 1404declare function $r(value: string, ...params: any[]): Resource; 1405 1406/** 1407 * global $rawfile function 1408 * 1409 * @param { string } value 1410 * @returns { Resource } 1411 * @syscap SystemCapability.ArkUI.ArkUI.Full 1412 * @since 7 1413 */ 1414/** 1415 * global $rawfile function 1416 * 1417 * @param { string } value 1418 * @returns { Resource } 1419 * @syscap SystemCapability.ArkUI.ArkUI.Full 1420 * @since 9 1421 * @form 1422 */ 1423/** 1424 * global $rawfile function 1425 * 1426 * @param { string } value 1427 * @returns { Resource } 1428 * @syscap SystemCapability.ArkUI.ArkUI.Full 1429 * @crossplatform 1430 * @since 10 1431 * @form 1432 */ 1433/** 1434 * global $rawfile function 1435 * 1436 * @param { string } value 1437 * @returns { Resource } 1438 * @syscap SystemCapability.ArkUI.ArkUI.Full 1439 * @crossplatform 1440 * @atomicservice 1441 * @since 11 1442 * @form 1443 */ 1444declare function $rawfile(value: string): Resource; 1445 1446/** 1447 * Enum for FinishCallbackType. 1448 * 1449 * @enum { number } 1450 * @syscap SystemCapability.ArkUI.ArkUI.Full 1451 * @crossplatform 1452 * @form 1453 * @since 11 1454 */ 1455declare enum FinishCallbackType { 1456 /** 1457 * When the entire animation ends and will be removed immediately, the callback is triggered. 1458 * 1459 * @syscap SystemCapability.ArkUI.ArkUI.Full 1460 * @crossplatform 1461 * @form 1462 * @since 11 1463 */ 1464 REMOVED = 0, 1465 /** 1466 * When the animation is logically down but may still be in its long tail, the callback is triggered. 1467 * 1468 * @syscap SystemCapability.ArkUI.ArkUI.Full 1469 * @crossplatform 1470 * @form 1471 * @since 11 1472 */ 1473 LOGICALLY = 1, 1474} 1475 1476/** 1477 * Defines the touch test strategy object. 1478 * 1479 * @enum { number } 1480 * @syscap SystemCapability.ArkUI.ArkUI.Full 1481 * @crossplatform 1482 * @since 11 1483 * @form 1484 */ 1485declare enum TouchTestStrategy { 1486 /** 1487 * Do framework touch test. 1488 * 1489 * @syscap SystemCapability.ArkUI.ArkUI.Full 1490 * @crossplatform 1491 * @since 11 1492 * @form 1493 */ 1494 DEFAULT = 0, 1495 1496 /** 1497 * Specify the component to do touch test and follow the framework touch test 1498 * 1499 * @syscap SystemCapability.ArkUI.ArkUI.Full 1500 * @crossplatform 1501 * @since 11 1502 * @form 1503 */ 1504 FORWARD_COMPETITION = 1, 1505 1506 /** 1507 * Specify the component to do touch test and not follow the framework touch test 1508 * 1509 * @syscap SystemCapability.ArkUI.ArkUI.Full 1510 * @crossplatform 1511 * @since 11 1512 * @form 1513 */ 1514 FORWARD = 2 1515} 1516 1517/** 1518 * Defines the animate function params. 1519 * 1520 * @interface AnimateParam 1521 * @syscap SystemCapability.ArkUI.ArkUI.Full 1522 * @since 7 1523 */ 1524/** 1525 * Defines the animate function params. 1526 * 1527 * @interface AnimateParam 1528 * @syscap SystemCapability.ArkUI.ArkUI.Full 1529 * @since 9 1530 * @form 1531 */ 1532/** 1533 * Defines the animate function params. 1534 * 1535 * @interface AnimateParam 1536 * @syscap SystemCapability.ArkUI.ArkUI.Full 1537 * @crossplatform 1538 * @since 10 1539 * @form 1540 */ 1541/** 1542 * Defines the animate function params. 1543 * 1544 * @interface AnimateParam 1545 * @syscap SystemCapability.ArkUI.ArkUI.Full 1546 * @crossplatform 1547 * @atomicservice 1548 * @since 11 1549 * @form 1550 */ 1551declare interface AnimateParam { 1552 /** 1553 * Animation duration, in ms. 1554 * 1555 * @type { ?number } 1556 * @syscap SystemCapability.ArkUI.ArkUI.Full 1557 * @since 7 1558 */ 1559 /** 1560 * Animation duration, in ms. 1561 * 1562 * @type { ?number } 1563 * @syscap SystemCapability.ArkUI.ArkUI.Full 1564 * @since 9 1565 * @form 1566 */ 1567 /** 1568 * Animation duration, in ms. 1569 * 1570 * @type { ?number } 1571 * @syscap SystemCapability.ArkUI.ArkUI.Full 1572 * @crossplatform 1573 * @since 10 1574 * @form 1575 */ 1576 /** 1577 * Animation duration, in ms. 1578 * 1579 * @type { ?number } 1580 * @syscap SystemCapability.ArkUI.ArkUI.Full 1581 * @crossplatform 1582 * @atomicservice 1583 * @since 11 1584 * @form 1585 */ 1586 duration?: number; 1587 /** 1588 * Animation playback speed. A larger value indicates faster animation playback, and a smaller value indicates slower 1589 * animation playback. The value 0 means that there is no animation. 1590 * 1591 * @type { ?number } 1592 * @syscap SystemCapability.ArkUI.ArkUI.Full 1593 * @since 7 1594 */ 1595 /** 1596 * Animation playback speed. A larger value indicates faster animation playback, and a smaller value indicates slower 1597 * animation playback. The value 0 means that there is no animation. 1598 * 1599 * @type { ?number } 1600 * @syscap SystemCapability.ArkUI.ArkUI.Full 1601 * @crossplatform 1602 * @since 10 1603 */ 1604 /** 1605 * Animation playback speed. A larger value indicates faster animation playback, and a smaller value indicates slower 1606 * animation playback. The value 0 means that there is no animation. 1607 * 1608 * @type { ?number } 1609 * @syscap SystemCapability.ArkUI.ArkUI.Full 1610 * @crossplatform 1611 * @atomicservice 1612 * @since 11 1613 */ 1614 tempo?: number; 1615 /** 1616 * Animation curve. 1617 * 1618 * @type { ?(Curve | string) } 1619 * @syscap SystemCapability.ArkUI.ArkUI.Full 1620 * @since 7 1621 */ 1622 /** 1623 * Animation curve. 1624 * 1625 * @type { ?(Curve | string | ICurve) } 1626 * @syscap SystemCapability.ArkUI.ArkUI.Full 1627 * @since 9 1628 * @form 1629 */ 1630 /** 1631 * Animation curve. 1632 * 1633 * @type { ?(Curve | string | ICurve) } 1634 * @syscap SystemCapability.ArkUI.ArkUI.Full 1635 * @crossplatform 1636 * @since 10 1637 * @form 1638 */ 1639 /** 1640 * Animation curve. 1641 * 1642 * @type { ?(Curve | string | ICurve) } 1643 * @syscap SystemCapability.ArkUI.ArkUI.Full 1644 * @crossplatform 1645 * @atomicservice 1646 * @since 11 1647 * @form 1648 */ 1649 curve?: Curve | string | ICurve; 1650 1651 /** 1652 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 1653 * 1654 * @type { ?number } 1655 * @syscap SystemCapability.ArkUI.ArkUI.Full 1656 * @since 7 1657 */ 1658 /** 1659 * Animation delay time, in ms. 1660 * 1661 * @type { ?number } 1662 * @syscap SystemCapability.ArkUI.ArkUI.Full 1663 * @crossplatform 1664 * @since 10 1665 */ 1666 /** 1667 * Animation delay time, in ms. 1668 * 1669 * @type { ?number } 1670 * @syscap SystemCapability.ArkUI.ArkUI.Full 1671 * @crossplatform 1672 * @atomicservice 1673 * @since 11 1674 */ 1675 delay?: number; 1676 1677 /** 1678 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 1679 * 1680 * @type { ?number } 1681 * @syscap SystemCapability.ArkUI.ArkUI.Full 1682 * @since 7 1683 */ 1684 /** 1685 * Animation iterations. 1686 * 1687 * @type { ?number } 1688 * @syscap SystemCapability.ArkUI.ArkUI.Full 1689 * @crossplatform 1690 * @since 10 1691 */ 1692 /** 1693 * Animation iterations. 1694 * 1695 * @type { ?number } 1696 * @syscap SystemCapability.ArkUI.ArkUI.Full 1697 * @crossplatform 1698 * @atomicservice 1699 * @since 11 1700 */ 1701 iterations?: number; 1702 1703 /** 1704 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 1705 * 1706 * @type { ?PlayMode } 1707 * @syscap SystemCapability.ArkUI.ArkUI.Full 1708 * @since 7 1709 */ 1710 /** 1711 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 1712 * 1713 * @type { ?PlayMode } 1714 * @syscap SystemCapability.ArkUI.ArkUI.Full 1715 * @since 9 1716 * @form 1717 */ 1718 /** 1719 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 1720 * 1721 * @type { ?PlayMode } 1722 * @syscap SystemCapability.ArkUI.ArkUI.Full 1723 * @crossplatform 1724 * @since 10 1725 * @form 1726 */ 1727 /** 1728 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 1729 * 1730 * @type { ?PlayMode } 1731 * @syscap SystemCapability.ArkUI.ArkUI.Full 1732 * @crossplatform 1733 * @atomicservice 1734 * @since 11 1735 * @form 1736 */ 1737 playMode?: PlayMode; 1738 1739 /** 1740 * Callback invoked when the animation playback is complete. 1741 * 1742 * @type { ?function } 1743 * @syscap SystemCapability.ArkUI.ArkUI.Full 1744 * @since 7 1745 */ 1746 /** 1747 * Callback invoked when the animation playback is complete. 1748 * 1749 * @type { ?function } 1750 * @syscap SystemCapability.ArkUI.ArkUI.Full 1751 * @since 9 1752 * @form 1753 */ 1754 /** 1755 * Callback invoked when the animation playback is complete. 1756 * 1757 * @type { ?function } 1758 * @syscap SystemCapability.ArkUI.ArkUI.Full 1759 * @crossplatform 1760 * @since 10 1761 * @form 1762 */ 1763 /** 1764 * Callback invoked when the animation playback is complete. 1765 * 1766 * @type { ?function } 1767 * @syscap SystemCapability.ArkUI.ArkUI.Full 1768 * @crossplatform 1769 * @atomicservice 1770 * @since 11 1771 * @form 1772 */ 1773 onFinish?: () => void; 1774 1775 /** 1776 * Define the type of onFinish callback in animation. 1777 * 1778 * @type { ?FinishCallbackType } 1779 * @syscap SystemCapability.ArkUI.ArkUI.Full 1780 * @crossplatform 1781 * @since 11 1782 * @form 1783 */ 1784 finishCallbackType?: FinishCallbackType; 1785 1786 /** 1787 * Indicates expectedFrameRateRange including minimum、maximum and expected frame rate. 1788 * 1789 * @type { ?ExpectedFrameRateRange } 1790 * @syscap SystemCapability.ArkUI.ArkUI.Full 1791 * @since 11 1792 */ 1793 expectedFrameRateRange?: ExpectedFrameRateRange; 1794} 1795 1796/** 1797 * Interface for curve object. 1798 * 1799 * @interface ICurve 1800 * @syscap SystemCapability.ArkUI.ArkUI.Full 1801 * @since 9 1802 * @form 1803 */ 1804/** 1805 * Interface for curve object. 1806 * 1807 * @interface ICurve 1808 * @syscap SystemCapability.ArkUI.ArkUI.Full 1809 * @crossplatform 1810 * @since 10 1811 * @form 1812 */ 1813/** 1814 * Interface for curve object. 1815 * 1816 * @interface ICurve 1817 * @syscap SystemCapability.ArkUI.ArkUI.Full 1818 * @crossplatform 1819 * @atomicservice 1820 * @since 11 1821 * @form 1822 */ 1823interface ICurve { 1824 /** 1825 * Get curve value by fraction. 1826 * 1827 * @param { number } fraction 1828 * @returns { number } 1829 * @syscap SystemCapability.ArkUI.ArkUI.Full 1830 * @since 9 1831 * @form 1832 */ 1833 /** 1834 * Get curve value by fraction. 1835 * 1836 * @param { number } fraction 1837 * @returns { number } 1838 * @syscap SystemCapability.ArkUI.ArkUI.Full 1839 * @crossplatform 1840 * @since 10 1841 * @form 1842 */ 1843 /** 1844 * Get curve value by fraction. 1845 * 1846 * @param { number } fraction 1847 * @returns { number } 1848 * @syscap SystemCapability.ArkUI.ArkUI.Full 1849 * @crossplatform 1850 * @atomicservice 1851 * @since 11 1852 * @form 1853 */ 1854 interpolate(fraction: number): number; 1855} 1856 1857/** 1858 * Defines the motion path options. 1859 * 1860 * @interface MotionPathOptions 1861 * @syscap SystemCapability.ArkUI.ArkUI.Full 1862 * @since 7 1863 */ 1864/** 1865 * Defines the motion path options. 1866 * 1867 * @interface MotionPathOptions 1868 * @syscap SystemCapability.ArkUI.ArkUI.Full 1869 * @crossplatform 1870 * @since 10 1871 */ 1872/** 1873 * Defines the motion path options. 1874 * 1875 * @interface MotionPathOptions 1876 * @syscap SystemCapability.ArkUI.ArkUI.Full 1877 * @crossplatform 1878 * @atomicservice 1879 * @since 11 1880 */ 1881declare interface MotionPathOptions { 1882 /** 1883 * The path info. 1884 * 1885 * @type { string } 1886 * @syscap SystemCapability.ArkUI.ArkUI.Full 1887 * @since 7 1888 */ 1889 /** 1890 * The path info. 1891 * 1892 * @type { string } 1893 * @syscap SystemCapability.ArkUI.ArkUI.Full 1894 * @crossplatform 1895 * @since 10 1896 */ 1897 /** 1898 * The path info. 1899 * 1900 * @type { string } 1901 * @syscap SystemCapability.ArkUI.ArkUI.Full 1902 * @crossplatform 1903 * @atomicservice 1904 * @since 11 1905 */ 1906 path: string; 1907 1908 /** 1909 * The origin point info. 1910 * 1911 * @type { ?number } 1912 * @syscap SystemCapability.ArkUI.ArkUI.Full 1913 * @since 7 1914 */ 1915 /** 1916 * The origin point info. 1917 * 1918 * @type { ?number } 1919 * @syscap SystemCapability.ArkUI.ArkUI.Full 1920 * @crossplatform 1921 * @since 10 1922 */ 1923 /** 1924 * The origin point info. 1925 * 1926 * @type { ?number } 1927 * @syscap SystemCapability.ArkUI.ArkUI.Full 1928 * @crossplatform 1929 * @atomicservice 1930 * @since 11 1931 */ 1932 from?: number; 1933 1934 /** 1935 * The distance point info. 1936 * 1937 * @type { ?number } 1938 * @syscap SystemCapability.ArkUI.ArkUI.Full 1939 * @since 7 1940 */ 1941 /** 1942 * The distance point info. 1943 * 1944 * @type { ?number } 1945 * @syscap SystemCapability.ArkUI.ArkUI.Full 1946 * @crossplatform 1947 * @since 10 1948 */ 1949 /** 1950 * The distance point info. 1951 * 1952 * @type { ?number } 1953 * @syscap SystemCapability.ArkUI.ArkUI.Full 1954 * @crossplatform 1955 * @atomicservice 1956 * @since 11 1957 */ 1958 to?: number; 1959 1960 /** 1961 * The rotate info. 1962 * 1963 * @type { ?boolean } 1964 * @syscap SystemCapability.ArkUI.ArkUI.Full 1965 * @since 7 1966 */ 1967 /** 1968 * The rotate info. 1969 * 1970 * @type { ?boolean } 1971 * @syscap SystemCapability.ArkUI.ArkUI.Full 1972 * @crossplatform 1973 * @since 10 1974 */ 1975 /** 1976 * The rotate info. 1977 * 1978 * @type { ?boolean } 1979 * @syscap SystemCapability.ArkUI.ArkUI.Full 1980 * @crossplatform 1981 * @atomicservice 1982 * @since 11 1983 */ 1984 rotatable?: boolean; 1985} 1986 1987/** 1988 * Defines the shard transition function params. 1989 * 1990 * @interface sharedTransitionOptions 1991 * @syscap SystemCapability.ArkUI.ArkUI.Full 1992 * @since 7 1993 */ 1994/** 1995 * Defines the shard transition function params. 1996 * 1997 * @interface sharedTransitionOptions 1998 * @syscap SystemCapability.ArkUI.ArkUI.Full 1999 * @crossplatform 2000 * @since 10 2001 */ 2002/** 2003 * Defines the shard transition function params. 2004 * 2005 * @interface sharedTransitionOptions 2006 * @syscap SystemCapability.ArkUI.ArkUI.Full 2007 * @crossplatform 2008 * @atomicservice 2009 * @since 11 2010 */ 2011declare interface sharedTransitionOptions { 2012 /** 2013 * Animation duration, in ms. 2014 * 2015 * @type { ?number } 2016 * @syscap SystemCapability.ArkUI.ArkUI.Full 2017 * @since 7 2018 */ 2019 /** 2020 * Animation duration, in ms. 2021 * 2022 * @type { ?number } 2023 * @syscap SystemCapability.ArkUI.ArkUI.Full 2024 * @crossplatform 2025 * @since 10 2026 */ 2027 /** 2028 * Animation duration, in ms. 2029 * 2030 * @type { ?number } 2031 * @syscap SystemCapability.ArkUI.ArkUI.Full 2032 * @crossplatform 2033 * @atomicservice 2034 * @since 11 2035 */ 2036 duration?: number; 2037 2038 /** 2039 * Animation duration, in ms. 2040 * 2041 * @type { ?(Curve | string | ICurve) } 2042 * @syscap SystemCapability.ArkUI.ArkUI.Full 2043 * @since 7 2044 */ 2045 /** 2046 * Animation curve. 2047 * 2048 * @type { ?(Curve | string | ICurve) } 2049 * @syscap SystemCapability.ArkUI.ArkUI.Full 2050 * @crossplatform 2051 * @since 10 2052 */ 2053 /** 2054 * Animation curve. 2055 * 2056 * @type { ?(Curve | string | ICurve) } 2057 * @syscap SystemCapability.ArkUI.ArkUI.Full 2058 * @crossplatform 2059 * @atomicservice 2060 * @since 11 2061 */ 2062 curve?: Curve | string | ICurve; 2063 2064 /** 2065 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 2066 * 2067 * @type { ?number } 2068 * @syscap SystemCapability.ArkUI.ArkUI.Full 2069 * @since 7 2070 */ 2071 /** 2072 * Animation delay time, in ms. 2073 * 2074 * @type { ?number } 2075 * @syscap SystemCapability.ArkUI.ArkUI.Full 2076 * @crossplatform 2077 * @since 10 2078 */ 2079 /** 2080 * Animation delay time, in ms. 2081 * 2082 * @type { ?number } 2083 * @syscap SystemCapability.ArkUI.ArkUI.Full 2084 * @crossplatform 2085 * @atomicservice 2086 * @since 11 2087 */ 2088 delay?: number; 2089 2090 /** 2091 * The motion path info. 2092 * 2093 * @type { ?MotionPathOptions } 2094 * @syscap SystemCapability.ArkUI.ArkUI.Full 2095 * @since 7 2096 */ 2097 /** 2098 * The motion path info. 2099 * 2100 * @type { ?MotionPathOptions } 2101 * @syscap SystemCapability.ArkUI.ArkUI.Full 2102 * @crossplatform 2103 * @since 10 2104 */ 2105 /** 2106 * The motion path info. 2107 * 2108 * @type { ?MotionPathOptions } 2109 * @syscap SystemCapability.ArkUI.ArkUI.Full 2110 * @crossplatform 2111 * @atomicservice 2112 * @since 11 2113 */ 2114 motionPath?: MotionPathOptions; 2115 2116 /** 2117 * Z index info. 2118 * 2119 * @type { ?number } 2120 * @syscap SystemCapability.ArkUI.ArkUI.Full 2121 * @since 7 2122 */ 2123 /** 2124 * Z index info. 2125 * 2126 * @type { ?number } 2127 * @syscap SystemCapability.ArkUI.ArkUI.Full 2128 * @crossplatform 2129 * @since 10 2130 */ 2131 /** 2132 * Z index info. 2133 * 2134 * @type { ?number } 2135 * @syscap SystemCapability.ArkUI.ArkUI.Full 2136 * @crossplatform 2137 * @atomicservice 2138 * @since 11 2139 */ 2140 zIndex?: number; 2141 2142 /** 2143 * the animate type. 2144 * 2145 * @type { ?SharedTransitionEffectType } 2146 * @syscap SystemCapability.ArkUI.ArkUI.Full 2147 * @since 7 2148 */ 2149 /** 2150 * the animate type. 2151 * 2152 * @type { ?SharedTransitionEffectType } 2153 * @syscap SystemCapability.ArkUI.ArkUI.Full 2154 * @crossplatform 2155 * @since 10 2156 */ 2157 /** 2158 * the animate type. 2159 * 2160 * @type { ?SharedTransitionEffectType } 2161 * @syscap SystemCapability.ArkUI.ArkUI.Full 2162 * @crossplatform 2163 * @atomicservice 2164 * @since 11 2165 */ 2166 type?: SharedTransitionEffectType; 2167} 2168 2169/** 2170 * Defines the options of geometry transition. 2171 * 2172 * @interface GeometryTransitionOptions 2173 * @syscap SystemCapability.ArkUI.ArkUI.Full 2174 * @crossplatform 2175 * @since 11 2176 */ 2177declare interface GeometryTransitionOptions { 2178 /** 2179 * whether follow target for the component still in the hierarchy, default: false, stay current. 2180 * 2181 * @type { ?boolean } 2182 * @syscap SystemCapability.ArkUI.ArkUI.Full 2183 * @crossplatform 2184 * @since 11 2185 */ 2186 follow?: boolean; 2187} 2188 2189/** 2190 * Defines the options of translate. 2191 * 2192 * @interface TranslateOptions 2193 * @syscap SystemCapability.ArkUI.ArkUI.Full 2194 * @since 7 2195 */ 2196/** 2197 * Defines the options of translate. 2198 * 2199 * @interface TranslateOptions 2200 * @syscap SystemCapability.ArkUI.ArkUI.Full 2201 * @since 9 2202 * @form 2203 */ 2204/** 2205 * Defines the options of translate. 2206 * 2207 * @interface TranslateOptions 2208 * @syscap SystemCapability.ArkUI.ArkUI.Full 2209 * @crossplatform 2210 * @since 10 2211 * @form 2212 */ 2213/** 2214 * Defines the options of translate. 2215 * 2216 * @interface TranslateOptions 2217 * @syscap SystemCapability.ArkUI.ArkUI.Full 2218 * @crossplatform 2219 * @atomicservice 2220 * @since 11 2221 * @form 2222 */ 2223declare interface TranslateOptions { 2224 /** 2225 * The param of x direction. 2226 * 2227 * @type { ?(number | string) } 2228 * @syscap SystemCapability.ArkUI.ArkUI.Full 2229 * @since 7 2230 */ 2231 /** 2232 * The param of x direction. 2233 * 2234 * @type { ?(number | string) } 2235 * @syscap SystemCapability.ArkUI.ArkUI.Full 2236 * @since 9 2237 * @form 2238 */ 2239 /** 2240 * The param of x direction. 2241 * 2242 * @type { ?(number | string) } 2243 * @syscap SystemCapability.ArkUI.ArkUI.Full 2244 * @crossplatform 2245 * @since 10 2246 * @form 2247 */ 2248 /** 2249 * The param of x direction. 2250 * 2251 * @type { ?(number | string) } 2252 * @syscap SystemCapability.ArkUI.ArkUI.Full 2253 * @crossplatform 2254 * @atomicservice 2255 * @since 11 2256 * @form 2257 */ 2258 x?: number | string; 2259 2260 /** 2261 * The param of y direction. 2262 * 2263 * @type { ?(number | string) } 2264 * @syscap SystemCapability.ArkUI.ArkUI.Full 2265 * @since 7 2266 */ 2267 /** 2268 * The param of y direction. 2269 * 2270 * @type { ?(number | string) } 2271 * @syscap SystemCapability.ArkUI.ArkUI.Full 2272 * @since 9 2273 * @form 2274 */ 2275 /** 2276 * The param of y direction. 2277 * 2278 * @type { ?(number | string) } 2279 * @syscap SystemCapability.ArkUI.ArkUI.Full 2280 * @crossplatform 2281 * @since 10 2282 * @form 2283 */ 2284 /** 2285 * The param of y direction. 2286 * 2287 * @type { ?(number | string) } 2288 * @syscap SystemCapability.ArkUI.ArkUI.Full 2289 * @crossplatform 2290 * @atomicservice 2291 * @since 11 2292 * @form 2293 */ 2294 y?: number | string; 2295 2296 /** 2297 * The param of z direction. 2298 * 2299 * @type { ?(number | string) } 2300 * @syscap SystemCapability.ArkUI.ArkUI.Full 2301 * @since 7 2302 */ 2303 /** 2304 * The param of z direction. 2305 * 2306 * @type { ?(number | string) } 2307 * @syscap SystemCapability.ArkUI.ArkUI.Full 2308 * @since 9 2309 * @form 2310 */ 2311 /** 2312 * The param of z direction. 2313 * 2314 * @type { ?(number | string) } 2315 * @syscap SystemCapability.ArkUI.ArkUI.Full 2316 * @crossplatform 2317 * @since 10 2318 * @form 2319 */ 2320 /** 2321 * The param of z direction. 2322 * 2323 * @type { ?(number | string) } 2324 * @syscap SystemCapability.ArkUI.ArkUI.Full 2325 * @crossplatform 2326 * @atomicservice 2327 * @since 11 2328 * @form 2329 */ 2330 z?: number | string; 2331} 2332 2333/** 2334 * Defines the options of scale. 2335 * 2336 * @interface ScaleOptions 2337 * @syscap SystemCapability.ArkUI.ArkUI.Full 2338 * @since 7 2339 */ 2340/** 2341 * Defines the options of scale. 2342 * 2343 * @interface ScaleOptions 2344 * @syscap SystemCapability.ArkUI.ArkUI.Full 2345 * @since 9 2346 * @form 2347 */ 2348/** 2349 * Defines the options of scale. 2350 * 2351 * @interface ScaleOptions 2352 * @syscap SystemCapability.ArkUI.ArkUI.Full 2353 * @crossplatform 2354 * @since 10 2355 * @form 2356 */ 2357/** 2358 * Defines the options of scale. 2359 * 2360 * @interface ScaleOptions 2361 * @syscap SystemCapability.ArkUI.ArkUI.Full 2362 * @crossplatform 2363 * @atomicservice 2364 * @since 11 2365 * @form 2366 */ 2367declare interface ScaleOptions { 2368 /** 2369 * The param of x direction. 2370 * 2371 * @type { ?number } 2372 * @syscap SystemCapability.ArkUI.ArkUI.Full 2373 * @since 7 2374 */ 2375 /** 2376 * The param of x direction. 2377 * 2378 * @type { ?number } 2379 * @syscap SystemCapability.ArkUI.ArkUI.Full 2380 * @since 9 2381 * @form 2382 */ 2383 /** 2384 * The param of x direction. 2385 * 2386 * @type { ?number } 2387 * @syscap SystemCapability.ArkUI.ArkUI.Full 2388 * @crossplatform 2389 * @since 10 2390 * @form 2391 */ 2392 /** 2393 * The param of x direction. 2394 * 2395 * @type { ?number } 2396 * @syscap SystemCapability.ArkUI.ArkUI.Full 2397 * @crossplatform 2398 * @atomicservice 2399 * @since 11 2400 * @form 2401 */ 2402 x?: number; 2403 2404 /** 2405 * The param of y direction. 2406 * 2407 * @type { ?number } 2408 * @syscap SystemCapability.ArkUI.ArkUI.Full 2409 * @since 7 2410 */ 2411 /** 2412 * The param of y direction. 2413 * 2414 * @type { ?number } 2415 * @syscap SystemCapability.ArkUI.ArkUI.Full 2416 * @since 9 2417 * @form 2418 */ 2419 /** 2420 * The param of y direction. 2421 * 2422 * @type { ?number } 2423 * @syscap SystemCapability.ArkUI.ArkUI.Full 2424 * @crossplatform 2425 * @since 10 2426 * @form 2427 */ 2428 /** 2429 * The param of y direction. 2430 * 2431 * @type { ?number } 2432 * @syscap SystemCapability.ArkUI.ArkUI.Full 2433 * @crossplatform 2434 * @atomicservice 2435 * @since 11 2436 * @form 2437 */ 2438 y?: number; 2439 2440 /** 2441 * The param of z direction. 2442 * 2443 * @type { ?number } 2444 * @syscap SystemCapability.ArkUI.ArkUI.Full 2445 * @since 7 2446 */ 2447 /** 2448 * The param of z direction. 2449 * 2450 * @type { ?number } 2451 * @syscap SystemCapability.ArkUI.ArkUI.Full 2452 * @since 9 2453 * @form 2454 */ 2455 /** 2456 * The param of z direction. 2457 * 2458 * @type { ?number } 2459 * @syscap SystemCapability.ArkUI.ArkUI.Full 2460 * @crossplatform 2461 * @since 10 2462 * @form 2463 */ 2464 /** 2465 * The param of z direction. 2466 * 2467 * @type { ?number } 2468 * @syscap SystemCapability.ArkUI.ArkUI.Full 2469 * @crossplatform 2470 * @atomicservice 2471 * @since 11 2472 * @form 2473 */ 2474 z?: number; 2475 2476 /** 2477 * The param of center point of x. 2478 * 2479 * @type { ?(number | string) } 2480 * @syscap SystemCapability.ArkUI.ArkUI.Full 2481 * @since 7 2482 */ 2483 /** 2484 * The param of center point of x. 2485 * 2486 * @type { ?(number | string) } 2487 * @syscap SystemCapability.ArkUI.ArkUI.Full 2488 * @since 9 2489 * @form 2490 */ 2491 /** 2492 * The param of center point of x. 2493 * 2494 * @type { ?(number | string) } 2495 * @syscap SystemCapability.ArkUI.ArkUI.Full 2496 * @crossplatform 2497 * @since 10 2498 * @form 2499 */ 2500 /** 2501 * The param of center point of x. 2502 * 2503 * @type { ?(number | string) } 2504 * @syscap SystemCapability.ArkUI.ArkUI.Full 2505 * @crossplatform 2506 * @atomicservice 2507 * @since 11 2508 * @form 2509 */ 2510 centerX?: number | string; 2511 2512 /** 2513 * The param of center point of y. 2514 * 2515 * @type { ?(number | string) } 2516 * @syscap SystemCapability.ArkUI.ArkUI.Full 2517 * @since 7 2518 */ 2519 /** 2520 * The param of center point of y. 2521 * 2522 * @type { ?(number | string) } 2523 * @syscap SystemCapability.ArkUI.ArkUI.Full 2524 * @since 9 2525 * @form 2526 */ 2527 /** 2528 * The param of center point of y. 2529 * 2530 * @type { ?(number | string) } 2531 * @syscap SystemCapability.ArkUI.ArkUI.Full 2532 * @crossplatform 2533 * @since 10 2534 * @form 2535 */ 2536 /** 2537 * The param of center point of y. 2538 * 2539 * @type { ?(number | string) } 2540 * @syscap SystemCapability.ArkUI.ArkUI.Full 2541 * @crossplatform 2542 * @atomicservice 2543 * @since 11 2544 * @form 2545 */ 2546 centerY?: number | string; 2547} 2548 2549/** 2550 * Defines the align rule options of relative container. 2551 * 2552 * @interface AlignRuleOption 2553 * @syscap SystemCapability.ArkUI.ArkUI.Full 2554 * @since 9 2555 * @form 2556 */ 2557/** 2558 * Defines the align rule options of relative container. 2559 * 2560 * @interface AlignRuleOption 2561 * @syscap SystemCapability.ArkUI.ArkUI.Full 2562 * @crossplatform 2563 * @since 10 2564 * @form 2565 */ 2566/** 2567 * Defines the align rule options of relative container. 2568 * 2569 * @interface AlignRuleOption 2570 * @syscap SystemCapability.ArkUI.ArkUI.Full 2571 * @crossplatform 2572 * @atomicservice 2573 * @since 11 2574 * @form 2575 */ 2576declare interface AlignRuleOption { 2577 /** 2578 * The param of left align. 2579 * 2580 * @type { ?object } 2581 * @syscap SystemCapability.ArkUI.ArkUI.Full 2582 * @since 9 2583 * @form 2584 */ 2585 /** 2586 * The param of left align. 2587 * 2588 * @type { ?object } 2589 * @syscap SystemCapability.ArkUI.ArkUI.Full 2590 * @crossplatform 2591 * @since 10 2592 * @form 2593 */ 2594 /** 2595 * The param of left align. 2596 * 2597 * @type { ?object } 2598 * @syscap SystemCapability.ArkUI.ArkUI.Full 2599 * @crossplatform 2600 * @atomicservice 2601 * @since 11 2602 * @form 2603 */ 2604 left?: { anchor: string, align: HorizontalAlign }; 2605 2606 /** 2607 * The param of right align. 2608 * 2609 * @type { ?object } 2610 * @syscap SystemCapability.ArkUI.ArkUI.Full 2611 * @since 9 2612 * @form 2613 */ 2614 /** 2615 * The param of right align. 2616 * 2617 * @type { ?object } 2618 * @syscap SystemCapability.ArkUI.ArkUI.Full 2619 * @crossplatform 2620 * @since 10 2621 * @form 2622 */ 2623 /** 2624 * The param of right align. 2625 * 2626 * @type { ?object } 2627 * @syscap SystemCapability.ArkUI.ArkUI.Full 2628 * @crossplatform 2629 * @atomicservice 2630 * @since 11 2631 * @form 2632 */ 2633 right?: { anchor: string, align: HorizontalAlign }; 2634 2635 /** 2636 * The param of middle align. 2637 * 2638 * @type { ?object } 2639 * @syscap SystemCapability.ArkUI.ArkUI.Full 2640 * @since 9 2641 * @form 2642 */ 2643 /** 2644 * The param of middle align. 2645 * 2646 * @type { ?object } 2647 * @syscap SystemCapability.ArkUI.ArkUI.Full 2648 * @crossplatform 2649 * @since 10 2650 * @form 2651 */ 2652 /** 2653 * The param of middle align. 2654 * 2655 * @type { ?object } 2656 * @syscap SystemCapability.ArkUI.ArkUI.Full 2657 * @crossplatform 2658 * @atomicservice 2659 * @since 11 2660 * @form 2661 */ 2662 middle?: { anchor: string, align: HorizontalAlign }; 2663 2664 /** 2665 * The param of top align. 2666 * 2667 * @type { ?object } 2668 * @syscap SystemCapability.ArkUI.ArkUI.Full 2669 * @since 9 2670 * @form 2671 */ 2672 /** 2673 * The param of top align. 2674 * 2675 * @type { ?object } 2676 * @syscap SystemCapability.ArkUI.ArkUI.Full 2677 * @crossplatform 2678 * @since 10 2679 * @form 2680 */ 2681 /** 2682 * The param of top align. 2683 * 2684 * @type { ?object } 2685 * @syscap SystemCapability.ArkUI.ArkUI.Full 2686 * @crossplatform 2687 * @atomicservice 2688 * @since 11 2689 * @form 2690 */ 2691 top?: { anchor: string, align: VerticalAlign }; 2692 2693 /** 2694 * The param of bottom align. 2695 * 2696 * @type { ?object } 2697 * @syscap SystemCapability.ArkUI.ArkUI.Full 2698 * @since 9 2699 * @form 2700 */ 2701 /** 2702 * The param of bottom align. 2703 * 2704 * @type { ?object } 2705 * @syscap SystemCapability.ArkUI.ArkUI.Full 2706 * @since 10 2707 * @form 2708 */ 2709 /** 2710 * The param of bottom align. 2711 * 2712 * @type { ?object } 2713 * @syscap SystemCapability.ArkUI.ArkUI.Full 2714 * @atomicservice 2715 * @since 11 2716 * @form 2717 */ 2718 bottom?: { anchor: string, align: VerticalAlign }; 2719 2720 /** 2721 * The param of center align. 2722 * 2723 * @type { ?object } 2724 * @syscap SystemCapability.ArkUI.ArkUI.Full 2725 * @since 9 2726 * @form 2727 */ 2728 /** 2729 * The param of center align. 2730 * 2731 * @type { ?object } 2732 * @syscap SystemCapability.ArkUI.ArkUI.Full 2733 * @crossplatform 2734 * @since 10 2735 * @form 2736 */ 2737 /** 2738 * The param of center align. 2739 * 2740 * @type { ?object } 2741 * @syscap SystemCapability.ArkUI.ArkUI.Full 2742 * @crossplatform 2743 * @atomicservice 2744 * @since 11 2745 * @form 2746 */ 2747 center?: { anchor: string, align: VerticalAlign }; 2748 2749 /** 2750 * Defines the bias ratio in horizontal and vertical direction. 2751 * 2752 * @type { ?Bias } 2753 * @default {horizontal:0.5,vertical:0.5} 2754 * @syscap SystemCapability.ArkUI.ArkUI.Full 2755 * @crossplatform 2756 * @since 11 2757 * @form 2758 */ 2759 bias?: Bias; 2760} 2761 2762/** 2763 * The param of rotate. 2764 * 2765 * @interface RotateOptions 2766 * @syscap SystemCapability.ArkUI.ArkUI.Full 2767 * @since 7 2768 */ 2769/** 2770 * The param of rotate. 2771 * 2772 * @interface RotateOptions 2773 * @syscap SystemCapability.ArkUI.ArkUI.Full 2774 * @since 9 2775 * @form 2776 */ 2777/** 2778 * The param of rotate. 2779 * 2780 * @interface RotateOptions 2781 * @syscap SystemCapability.ArkUI.ArkUI.Full 2782 * @crossplatform 2783 * @since 10 2784 * @form 2785 */ 2786/** 2787 * The param of rotate. 2788 * 2789 * @interface RotateOptions 2790 * @syscap SystemCapability.ArkUI.ArkUI.Full 2791 * @crossplatform 2792 * @atomicservice 2793 * @since 11 2794 * @form 2795 */ 2796declare interface RotateOptions { 2797 /** 2798 * The param of x direction. 2799 * 2800 * @type { ?number } 2801 * @syscap SystemCapability.ArkUI.ArkUI.Full 2802 * @since 7 2803 */ 2804 /** 2805 * The param of x direction. 2806 * 2807 * @type { ?number } 2808 * @syscap SystemCapability.ArkUI.ArkUI.Full 2809 * @since 9 2810 * @form 2811 */ 2812 /** 2813 * The param of x direction. 2814 * 2815 * @type { ?number } 2816 * @syscap SystemCapability.ArkUI.ArkUI.Full 2817 * @crossplatform 2818 * @since 10 2819 * @form 2820 */ 2821 /** 2822 * The param of x direction. 2823 * 2824 * @type { ?number } 2825 * @syscap SystemCapability.ArkUI.ArkUI.Full 2826 * @crossplatform 2827 * @atomicservice 2828 * @since 11 2829 * @form 2830 */ 2831 x?: number; 2832 2833 /** 2834 * The param of y direction. 2835 * 2836 * @type { ?number } 2837 * @syscap SystemCapability.ArkUI.ArkUI.Full 2838 * @since 7 2839 */ 2840 /** 2841 * The param of y direction. 2842 * 2843 * @type { ?number } 2844 * @syscap SystemCapability.ArkUI.ArkUI.Full 2845 * @since 9 2846 * @form 2847 */ 2848 /** 2849 * The param of y direction. 2850 * 2851 * @type { ?number } 2852 * @syscap SystemCapability.ArkUI.ArkUI.Full 2853 * @crossplatform 2854 * @since 10 2855 * @form 2856 */ 2857 /** 2858 * The param of y direction. 2859 * 2860 * @type { ?number } 2861 * @syscap SystemCapability.ArkUI.ArkUI.Full 2862 * @crossplatform 2863 * @atomicservice 2864 * @since 11 2865 * @form 2866 */ 2867 y?: number; 2868 2869 /** 2870 * The param of z direction. 2871 * 2872 * @type { ?number } 2873 * @syscap SystemCapability.ArkUI.ArkUI.Full 2874 * @since 7 2875 */ 2876 /** 2877 * The param of z direction. 2878 * 2879 * @type { ?number } 2880 * @syscap SystemCapability.ArkUI.ArkUI.Full 2881 * @since 9 2882 * @form 2883 */ 2884 /** 2885 * The param of z direction. 2886 * 2887 * @type { ?number } 2888 * @syscap SystemCapability.ArkUI.ArkUI.Full 2889 * @crossplatform 2890 * @since 10 2891 * @form 2892 */ 2893 /** 2894 * The param of z direction. 2895 * 2896 * @type { ?number } 2897 * @syscap SystemCapability.ArkUI.ArkUI.Full 2898 * @crossplatform 2899 * @atomicservice 2900 * @since 11 2901 * @form 2902 */ 2903 z?: number; 2904 2905 /** 2906 * The param of center point of x. 2907 * 2908 * @type { ?(number | string) } 2909 * @syscap SystemCapability.ArkUI.ArkUI.Full 2910 * @since 7 2911 */ 2912 /** 2913 * The param of center point of x. 2914 * 2915 * @type { ?(number | string) } 2916 * @syscap SystemCapability.ArkUI.ArkUI.Full 2917 * @since 9 2918 * @form 2919 */ 2920 /** 2921 * The param of center point of x. 2922 * 2923 * @type { ?(number | string) } 2924 * @syscap SystemCapability.ArkUI.ArkUI.Full 2925 * @crossplatform 2926 * @since 10 2927 * @form 2928 */ 2929 /** 2930 * The param of center point of x. 2931 * 2932 * @type { ?(number | string) } 2933 * @syscap SystemCapability.ArkUI.ArkUI.Full 2934 * @crossplatform 2935 * @atomicservice 2936 * @since 11 2937 * @form 2938 */ 2939 centerX?: number | string; 2940 2941 /** 2942 * The param of center point of y. 2943 * 2944 * @type { ?(number | string) } 2945 * @syscap SystemCapability.ArkUI.ArkUI.Full 2946 * @since 7 2947 */ 2948 /** 2949 * The param of center point of y. 2950 * 2951 * @type { ?(number | string) } 2952 * @syscap SystemCapability.ArkUI.ArkUI.Full 2953 * @since 9 2954 */ 2955 /** 2956 * The param of center point of y. 2957 * 2958 * @type { ?(number | string) } 2959 * @syscap SystemCapability.ArkUI.ArkUI.Full 2960 * @crossplatform 2961 * @since 10 2962 * @form 2963 */ 2964 /** 2965 * The param of center point of y. 2966 * 2967 * @type { ?(number | string) } 2968 * @syscap SystemCapability.ArkUI.ArkUI.Full 2969 * @crossplatform 2970 * @atomicservice 2971 * @since 11 2972 * @form 2973 */ 2974 centerY?: number | string; 2975 2976 /** 2977 * The param of center point of z. 2978 * 2979 * @type { ?number } 2980 * @default 0 2981 * @syscap SystemCapability.ArkUI.ArkUI.Full 2982 * @crossplatform 2983 * @since 10 2984 * @form 2985 */ 2986 /** 2987 * The param of center point of z. 2988 * 2989 * @type { ?number } 2990 * @default 0 2991 * @syscap SystemCapability.ArkUI.ArkUI.Full 2992 * @crossplatform 2993 * @atomicservice 2994 * @since 11 2995 * @form 2996 */ 2997 centerZ?: number; 2998 2999 /** 3000 * The param of camera distance, value range (-∞, ∞). 3001 * @type { ?number } 3002 * @default 0 3003 * @syscap SystemCapability.ArkUI.ArkUI.Full 3004 * @crossplatform 3005 * @since 10 3006 * @form 3007 */ 3008 /** 3009 * The param of camera distance, value range (-∞, ∞). 3010 * @type { ?number } 3011 * @default 0 3012 * @syscap SystemCapability.ArkUI.ArkUI.Full 3013 * @crossplatform 3014 * @atomicservice 3015 * @since 11 3016 * @form 3017 */ 3018 perspective?: number; 3019 3020 /** 3021 * The param of angle. 3022 * 3023 * @type { number | string } 3024 * @syscap SystemCapability.ArkUI.ArkUI.Full 3025 * @since 7 3026 */ 3027 /** 3028 * The param of angle. 3029 * 3030 * @type { number | string } 3031 * @syscap SystemCapability.ArkUI.ArkUI.Full 3032 * @since 9 3033 * @form 3034 */ 3035 /** 3036 * The param of angle. 3037 * 3038 * @type { number | string } 3039 * @syscap SystemCapability.ArkUI.ArkUI.Full 3040 * @crossplatform 3041 * @since 10 3042 * @form 3043 */ 3044 /** 3045 * The param of angle. 3046 * 3047 * @type { number | string } 3048 * @syscap SystemCapability.ArkUI.ArkUI.Full 3049 * @crossplatform 3050 * @atomicservice 3051 * @since 11 3052 * @form 3053 */ 3054 angle: number | string; 3055} 3056 3057/** 3058 * Defines the param of transition. 3059 * 3060 * @interface TransitionOptions 3061 * @syscap SystemCapability.ArkUI.ArkUI.Full 3062 * @since 7 3063 * @deprecated since 10 3064 * @useinstead TransitionEffect 3065 */ 3066declare interface TransitionOptions { 3067 /** 3068 * Defines the param of type. 3069 * 3070 * @type { ?TransitionType } 3071 * @syscap SystemCapability.ArkUI.ArkUI.Full 3072 * @since 7 3073 * @deprecated since 10 3074 */ 3075 type?: TransitionType; 3076 /** 3077 * Defines the param of opacity. 3078 * 3079 * @type { ?number } 3080 * @syscap SystemCapability.ArkUI.ArkUI.Full 3081 * @since 7 3082 * @deprecated since 10 3083 */ 3084 opacity?: number; 3085 /** 3086 * Defines the param of translate. 3087 * 3088 * @type { ?TranslateOptions } 3089 * @syscap SystemCapability.ArkUI.ArkUI.Full 3090 * @since 7 3091 * @deprecated since 10 3092 */ 3093 translate?: TranslateOptions; 3094 /** 3095 * Defines the param of scale. 3096 * 3097 * @type { ?ScaleOptions } 3098 * @syscap SystemCapability.ArkUI.ArkUI.Full 3099 * @since 7 3100 * @deprecated since 10 3101 */ 3102 scale?: ScaleOptions; 3103 /** 3104 * Defines the param of rotate. 3105 * 3106 * @type { ?RotateOptions } 3107 * @syscap SystemCapability.ArkUI.ArkUI.Full 3108 * @since 7 3109 * @deprecated since 10 3110 */ 3111 rotate?: RotateOptions; 3112} 3113 3114/** 3115 * Defines the Edge object. 3116 * 3117 * @enum { number } 3118 * @syscap SystemCapability.ArkUI.ArkUI.Full 3119 * @crossplatform 3120 * @since 10 3121 * @form 3122 */ 3123/** 3124 * Defines the Edge object. 3125 * 3126 * @enum { number } 3127 * @syscap SystemCapability.ArkUI.ArkUI.Full 3128 * @crossplatform 3129 * @atomicservice 3130 * @since 11 3131 * @form 3132 */ 3133declare enum TransitionEdge { 3134 /** 3135 * Top edge 3136 * 3137 * @syscap SystemCapability.ArkUI.ArkUI.Full 3138 * @crossplatform 3139 * @since 10 3140 * @form 3141 */ 3142 /** 3143 * Top edge 3144 * 3145 * @syscap SystemCapability.ArkUI.ArkUI.Full 3146 * @crossplatform 3147 * @atomicservice 3148 * @since 11 3149 * @form 3150 */ 3151 TOP, 3152 3153 /** 3154 * Bottom edge 3155 * 3156 * @syscap SystemCapability.ArkUI.ArkUI.Full 3157 * @crossplatform 3158 * @since 10 3159 * @form 3160 */ 3161 /** 3162 * Bottom edge 3163 * 3164 * @syscap SystemCapability.ArkUI.ArkUI.Full 3165 * @crossplatform 3166 * @atomicservice 3167 * @since 11 3168 * @form 3169 */ 3170 BOTTOM, 3171 3172 /** 3173 * Start edge 3174 * 3175 * @syscap SystemCapability.ArkUI.ArkUI.Full 3176 * @crossplatform 3177 * @since 10 3178 * @form 3179 */ 3180 /** 3181 * Start edge 3182 * 3183 * @syscap SystemCapability.ArkUI.ArkUI.Full 3184 * @crossplatform 3185 * @atomicservice 3186 * @since 11 3187 * @form 3188 */ 3189 START, 3190 3191 /** 3192 * End edge 3193 * 3194 * @syscap SystemCapability.ArkUI.ArkUI.Full 3195 * @crossplatform 3196 * @since 10 3197 * @form 3198 */ 3199 /** 3200 * End edge 3201 * 3202 * @syscap SystemCapability.ArkUI.ArkUI.Full 3203 * @crossplatform 3204 * @atomicservice 3205 * @since 11 3206 * @form 3207 */ 3208 END 3209} 3210 3211/** 3212 * Defines all transition effects. 3213 * 3214 * @syscap SystemCapability.ArkUI.ArkUI.Full 3215 * @crossplatform 3216 * @since 10 3217 * @form 3218 */ 3219/** 3220 * Defines all transition effects. 3221 * 3222 * @syscap SystemCapability.ArkUI.ArkUI.Full 3223 * @crossplatform 3224 * @atomicservice 3225 * @since 11 3226 * @form 3227 */ 3228declare type TransitionEffects = { 3229 identity: undefined; 3230 opacity: number; 3231 slideSwitch: undefined; 3232 move: TransitionEdge; 3233 translate: TranslateOptions; 3234 rotate: RotateOptions; 3235 scale: ScaleOptions; 3236 asymmetric: { 3237 appear: TransitionEffect; 3238 disappear: TransitionEffect; 3239 }; 3240}; 3241 3242/** 3243 * Defines the transition effect 3244 * 3245 * @syscap SystemCapability.ArkUI.ArkUI.Full 3246 * @crossplatform 3247 * @since 10 3248 * @form 3249 */ 3250/** 3251 * Defines the transition effect 3252 * 3253 * @syscap SystemCapability.ArkUI.ArkUI.Full 3254 * @crossplatform 3255 * @atomicservice 3256 * @since 11 3257 * @form 3258 */ 3259declare class TransitionEffect< 3260 Type extends keyof TransitionEffects = keyof TransitionEffects, 3261 Effect extends TransitionEffects[Type] = TransitionEffects[Type] 3262> { 3263 /** 3264 * Defines an identity transition effect 3265 * 3266 * @type { TransitionEffect<"identity"> } 3267 * @readonly 3268 * @static 3269 * @syscap SystemCapability.ArkUI.ArkUI.Full 3270 * @crossplatform 3271 * @since 10 3272 * @form 3273 */ 3274 /** 3275 * Defines an identity transition effect 3276 * 3277 * @type { TransitionEffect<"identity"> } 3278 * @readonly 3279 * @static 3280 * @syscap SystemCapability.ArkUI.ArkUI.Full 3281 * @crossplatform 3282 * @atomicservice 3283 * @since 11 3284 * @form 3285 */ 3286 static readonly IDENTITY: TransitionEffect<"identity">; 3287 3288 /** 3289 * Defines an opacity transition effect 3290 * 3291 * @type { TransitionEffect<"opacity"> } 3292 * @readonly 3293 * @static 3294 * @syscap SystemCapability.ArkUI.ArkUI.Full 3295 * @crossplatform 3296 * @since 10 3297 * @form 3298 */ 3299 /** 3300 * Defines an opacity transition effect 3301 * 3302 * @type { TransitionEffect<"opacity"> } 3303 * @readonly 3304 * @static 3305 * @syscap SystemCapability.ArkUI.ArkUI.Full 3306 * @crossplatform 3307 * @atomicservice 3308 * @since 11 3309 * @form 3310 */ 3311 static readonly OPACITY: TransitionEffect<"opacity">; 3312 3313 /** 3314 * Defines a slide transition effect 3315 * 3316 * @type { TransitionEffect< 3317 * "asymmetric", 3318 * {appear: TransitionEffect<"move", TransitionEdge>; 3319 * disappear: TransitionEffect<"move", TransitionEdge>; 3320 * }> } 3321 * @readonly 3322 * @static 3323 * @syscap SystemCapability.ArkUI.ArkUI.Full 3324 * @crossplatform 3325 * @since 10 3326 * @form 3327 */ 3328 /** 3329 * Defines a slide transition effect 3330 * 3331 * @type { TransitionEffect< 3332 * "asymmetric", 3333 * {appear: TransitionEffect<"move", TransitionEdge>; 3334 * disappear: TransitionEffect<"move", TransitionEdge>; 3335 * }> } 3336 * @readonly 3337 * @static 3338 * @syscap SystemCapability.ArkUI.ArkUI.Full 3339 * @crossplatform 3340 * @atomicservice 3341 * @since 11 3342 * @form 3343 */ 3344 static readonly SLIDE: TransitionEffect< 3345 "asymmetric", 3346 { 3347 appear: TransitionEffect<"move", TransitionEdge>; 3348 disappear: TransitionEffect<"move", TransitionEdge>; 3349 } 3350 >; 3351 3352 /** 3353 * Defines a slide & switch transition effect 3354 * 3355 * @type { TransitionEffect<"slideSwitch"> } 3356 * @readonly 3357 * @static 3358 * @syscap SystemCapability.ArkUI.ArkUI.Full 3359 * @crossplatform 3360 * @since 10 3361 * @form 3362 */ 3363 /** 3364 * Defines a slide & switch transition effect 3365 * 3366 * @type { TransitionEffect<"slideSwitch"> } 3367 * @readonly 3368 * @static 3369 * @syscap SystemCapability.ArkUI.ArkUI.Full 3370 * @crossplatform 3371 * @atomicservice 3372 * @since 11 3373 * @form 3374 */ 3375 static readonly SLIDE_SWITCH: TransitionEffect<"slideSwitch">; 3376 3377 /** 3378 * Creates a translate transition effect 3379 * 3380 * @param { TranslateOptions } options - translate options 3381 * @returns { TransitionEffect<"translate"> } 3382 * @syscap SystemCapability.ArkUI.ArkUI.Full 3383 * @crossplatform 3384 * @since 10 3385 * @form 3386 */ 3387 /** 3388 * Creates a translate transition effect 3389 * 3390 * @param { TranslateOptions } options - translate options 3391 * @returns { TransitionEffect<"translate"> } 3392 * @syscap SystemCapability.ArkUI.ArkUI.Full 3393 * @crossplatform 3394 * @atomicservice 3395 * @since 11 3396 * @form 3397 */ 3398 static translate(options: TranslateOptions): TransitionEffect<"translate">; 3399 3400 /** 3401 * Creates a rotation transition effect 3402 * 3403 * @param { RotateOptions } options - rotate options 3404 * @returns { TransitionEffect<"rotate"> } 3405 * @syscap SystemCapability.ArkUI.ArkUI.Full 3406 * @crossplatform 3407 * @since 10 3408 * @form 3409 */ 3410 /** 3411 * Creates a rotation transition effect 3412 * 3413 * @param { RotateOptions } options - rotate options 3414 * @returns { TransitionEffect<"rotate"> } 3415 * @syscap SystemCapability.ArkUI.ArkUI.Full 3416 * @crossplatform 3417 * @atomicservice 3418 * @since 11 3419 * @form 3420 */ 3421 static rotate(options: RotateOptions): TransitionEffect<"rotate">; 3422 3423 /** 3424 * Creates a scale transition effect 3425 * 3426 * @param { ScaleOptions } options - scale options 3427 * @returns { TransitionEffect<"scale"> } 3428 * @syscap SystemCapability.ArkUI.ArkUI.Full 3429 * @crossplatform 3430 * @since 10 3431 * @form 3432 */ 3433 /** 3434 * Creates a scale transition effect 3435 * 3436 * @param { ScaleOptions } options - scale options 3437 * @returns { TransitionEffect<"scale"> } 3438 * @syscap SystemCapability.ArkUI.ArkUI.Full 3439 * @crossplatform 3440 * @atomicservice 3441 * @since 11 3442 * @form 3443 */ 3444 static scale(options: ScaleOptions): TransitionEffect<"scale">; 3445 3446 /** 3447 * Creates an opacity transition effect with alpha value 3448 * 3449 * @param { number } alpha - opacity alpha value 3450 * @returns { TransitionEffect<"opacity"> } 3451 * @syscap SystemCapability.ArkUI.ArkUI.Full 3452 * @crossplatform 3453 * @since 10 3454 * @form 3455 */ 3456 /** 3457 * Creates an opacity transition effect with alpha value 3458 * 3459 * @param { number } alpha - opacity alpha value 3460 * @returns { TransitionEffect<"opacity"> } 3461 * @syscap SystemCapability.ArkUI.ArkUI.Full 3462 * @crossplatform 3463 * @atomicservice 3464 * @since 11 3465 * @form 3466 */ 3467 static opacity(alpha: number): TransitionEffect<"opacity">; 3468 3469 /** 3470 * Creates a move transition effect 3471 * 3472 * @param { TransitionEdge } edge - the edge that component will move to 3473 * @returns { TransitionEffect<"move"> } 3474 * @syscap SystemCapability.ArkUI.ArkUI.Full 3475 * @crossplatform 3476 * @since 10 3477 * @form 3478 */ 3479 /** 3480 * Creates a move transition effect 3481 * 3482 * @param { TransitionEdge } edge - the edge that component will move to 3483 * @returns { TransitionEffect<"move"> } 3484 * @syscap SystemCapability.ArkUI.ArkUI.Full 3485 * @crossplatform 3486 * @atomicservice 3487 * @since 11 3488 * @form 3489 */ 3490 static move(edge: TransitionEdge): TransitionEffect<"move">; 3491 3492 /** 3493 * Creates an asymmetric transition effect 3494 * 3495 * @param { TransitionEffect } appear - the transition which will be attached when the component is appear 3496 * @param { TransitionEffect } disappear - the transition which will be attached when the component is disappear 3497 * @returns { TransitionEffect<"asymmetric"> } 3498 * @syscap SystemCapability.ArkUI.ArkUI.Full 3499 * @crossplatform 3500 * @since 10 3501 * @form 3502 */ 3503 /** 3504 * Creates an asymmetric transition effect 3505 * 3506 * @param { TransitionEffect } appear - the transition which will be attached when the component is appear 3507 * @param { TransitionEffect } disappear - the transition which will be attached when the component is disappear 3508 * @returns { TransitionEffect<"asymmetric"> } 3509 * @syscap SystemCapability.ArkUI.ArkUI.Full 3510 * @crossplatform 3511 * @atomicservice 3512 * @since 11 3513 * @form 3514 */ 3515 static asymmetric( 3516 appear: TransitionEffect, 3517 disappear: TransitionEffect 3518 ): TransitionEffect<"asymmetric">; 3519 3520 /** 3521 * TransitionEffect constructor 3522 * 3523 * @param { Type } type - transition type 3524 * @param { Effect } effect - transition options 3525 * @syscap SystemCapability.ArkUI.ArkUI.Full 3526 * @crossplatform 3527 * @since 10 3528 * @form 3529 */ 3530 /** 3531 * TransitionEffect constructor 3532 * 3533 * @param { Type } type - transition type 3534 * @param { Effect } effect - transition options 3535 * @syscap SystemCapability.ArkUI.ArkUI.Full 3536 * @crossplatform 3537 * @atomicservice 3538 * @since 11 3539 * @form 3540 */ 3541 constructor(type: Type, effect: Effect); 3542 3543 /** 3544 * Set the animation of current transition effect 3545 * 3546 * @param { AnimateParam } value - animation parameters 3547 * @returns { TransitionEffect } 3548 * @syscap SystemCapability.ArkUI.ArkUI.Full 3549 * @crossplatform 3550 * @since 10 3551 * @form 3552 */ 3553 /** 3554 * Set the animation of current transition effect 3555 * 3556 * @param { AnimateParam } value - animation parameters 3557 * @returns { TransitionEffect } 3558 * @syscap SystemCapability.ArkUI.ArkUI.Full 3559 * @crossplatform 3560 * @atomicservice 3561 * @since 11 3562 * @form 3563 */ 3564 animation(value: AnimateParam): TransitionEffect; 3565 3566 /** 3567 * Combines another transition effect 3568 * 3569 * @param { TransitionEffect } transitionEffect - transition effect which is be combined 3570 * @returns { TransitionEffect } combined transition effect 3571 * @syscap SystemCapability.ArkUI.ArkUI.Full 3572 * @crossplatform 3573 * @since 10 3574 * @form 3575 */ 3576 /** 3577 * Combines another transition effect 3578 * 3579 * @param { TransitionEffect } transitionEffect - transition effect which is be combined 3580 * @returns { TransitionEffect } combined transition effect 3581 * @syscap SystemCapability.ArkUI.ArkUI.Full 3582 * @crossplatform 3583 * @atomicservice 3584 * @since 11 3585 * @form 3586 */ 3587 combine(transitionEffect: TransitionEffect): TransitionEffect; 3588} 3589 3590/** 3591 * Define Preview property 3592 * 3593 * @interface PreviewParams 3594 * @syscap SystemCapability.ArkUI.ArkUI.Full 3595 * @since 9 3596 * @form 3597 */ 3598/** 3599 * Define Preview property 3600 * 3601 * @interface PreviewParams 3602 * @syscap SystemCapability.ArkUI.ArkUI.Full 3603 * @crossplatform 3604 * @atomicservice 3605 * @since 11 3606 * @form 3607 */ 3608interface PreviewParams { 3609 /** 3610 * Define Preview title 3611 * 3612 * @type { ?string } 3613 * @syscap SystemCapability.ArkUI.ArkUI.Full 3614 * @since 9 3615 * @form 3616 */ 3617 /** 3618 * Define Preview title 3619 * 3620 * @type { ?string } 3621 * @syscap SystemCapability.ArkUI.ArkUI.Full 3622 * @crossplatform 3623 * @atomicservice 3624 * @since 11 3625 * @form 3626 */ 3627 title?: string; 3628 3629 /** 3630 * Define Preview width 3631 * 3632 * @type { ?number } 3633 * @syscap SystemCapability.ArkUI.ArkUI.Full 3634 * @since 9 3635 * @form 3636 */ 3637 /** 3638 * Define Preview width 3639 * 3640 * @type { ?number } 3641 * @syscap SystemCapability.ArkUI.ArkUI.Full 3642 * @crossplatform 3643 * @atomicservice 3644 * @since 11 3645 * @form 3646 */ 3647 width?: number; 3648 3649 /** 3650 * Define Preview height 3651 * 3652 * @type { ?number } 3653 * @syscap SystemCapability.ArkUI.ArkUI.Full 3654 * @since 9 3655 * @form 3656 */ 3657 /** 3658 * Define Preview height 3659 * 3660 * @type { ?number } 3661 * @syscap SystemCapability.ArkUI.ArkUI.Full 3662 * @crossplatform 3663 * @atomicservice 3664 * @since 11 3665 * @form 3666 */ 3667 height?: number; 3668 3669 /** 3670 * Define Preview locale 3671 * 3672 * @type { ?string } 3673 * @syscap SystemCapability.ArkUI.ArkUI.Full 3674 * @since 9 3675 * @form 3676 */ 3677 /** 3678 * Define Preview locale 3679 * 3680 * @type { ?string } 3681 * @syscap SystemCapability.ArkUI.ArkUI.Full 3682 * @atomicservice 3683 * @since 11 3684 * @form 3685 */ 3686 locale?: string; 3687 3688 /** 3689 * Define Preview colorMode 3690 * 3691 * @type { ?string } 3692 * @syscap SystemCapability.ArkUI.ArkUI.Full 3693 * @since 9 3694 * @form 3695 */ 3696 /** 3697 * Define Preview colorMode 3698 * 3699 * @type { ?string } 3700 * @syscap SystemCapability.ArkUI.ArkUI.Full 3701 * @crossplatform 3702 * @atomicservice 3703 * @since 11 3704 * @form 3705 */ 3706 colorMode?: string; 3707 3708 /** 3709 * Define Preview deviceType 3710 * 3711 * @type { ?string } 3712 * @syscap SystemCapability.ArkUI.ArkUI.Full 3713 * @since 9 3714 * @form 3715 */ 3716 /** 3717 * Define Preview deviceType 3718 * 3719 * @type { ?string } 3720 * @syscap SystemCapability.ArkUI.ArkUI.Full 3721 * @atomicservice 3722 * @since 11 3723 * @form 3724 */ 3725 deviceType?: string; 3726 3727 /** 3728 * Define Preview dpi 3729 * 3730 * @type { ?number } 3731 * @syscap SystemCapability.ArkUI.ArkUI.Full 3732 * @since 9 3733 * @form 3734 */ 3735 /** 3736 * Define Preview dpi 3737 * 3738 * @type { ?number } 3739 * @syscap SystemCapability.ArkUI.ArkUI.Full 3740 * @atomicservice 3741 * @since 11 3742 * @form 3743 */ 3744 dpi?: number; 3745 3746 /** 3747 * Define Preview orientation 3748 * 3749 * @type { ?string } 3750 * @syscap SystemCapability.ArkUI.ArkUI.Full 3751 * @since 9 3752 * @form 3753 */ 3754 /** 3755 * Define Preview orientation 3756 * 3757 * @type { ?string } 3758 * @syscap SystemCapability.ArkUI.ArkUI.Full 3759 * @atomicservice 3760 * @since 11 3761 * @form 3762 */ 3763 orientation?: string; 3764 3765 /** 3766 * Define Preview roundScreen 3767 * 3768 * @type { ?boolean } 3769 * @syscap SystemCapability.ArkUI.ArkUI.Full 3770 * @since 9 3771 * @form 3772 */ 3773 /** 3774 * Define Preview roundScreen 3775 * 3776 * @type { ?boolean } 3777 * @syscap SystemCapability.ArkUI.ArkUI.Full 3778 * @atomicservice 3779 * @since 11 3780 * @form 3781 */ 3782 roundScreen?: boolean; 3783} 3784 3785/** 3786 * ItemDragInfo object description 3787 * 3788 * @interface ItemDragInfo 3789 * @syscap SystemCapability.ArkUI.ArkUI.Full 3790 * @since 8 3791 */ 3792/** 3793 * ItemDragInfo object description 3794 * 3795 * @interface ItemDragInfo 3796 * @syscap SystemCapability.ArkUI.ArkUI.Full 3797 * @crossplatform 3798 * @since 10 3799 */ 3800/** 3801 * ItemDragInfo object description 3802 * 3803 * @interface ItemDragInfo 3804 * @syscap SystemCapability.ArkUI.ArkUI.Full 3805 * @crossplatform 3806 * @atomicservice 3807 * @since 11 3808 */ 3809declare interface ItemDragInfo { 3810 /** 3811 * Obtains the X coordinate of the drag window, in vp. 3812 * 3813 * @type { number } 3814 * @syscap SystemCapability.ArkUI.ArkUI.Full 3815 * @since 8 3816 */ 3817 /** 3818 * Obtains the X coordinate of the drag window, in vp. 3819 * 3820 * @type { number } 3821 * @syscap SystemCapability.ArkUI.ArkUI.Full 3822 * @crossplatform 3823 * @since 10 3824 */ 3825 /** 3826 * Obtains the X coordinate of the drag window, in vp. 3827 * 3828 * @type { number } 3829 * @syscap SystemCapability.ArkUI.ArkUI.Full 3830 * @crossplatform 3831 * @atomicservice 3832 * @since 11 3833 */ 3834 x: number; 3835 3836 /** 3837 * Obtains the Y coordinate of the drag window, in vp. 3838 * 3839 * @type { number } 3840 * @syscap SystemCapability.ArkUI.ArkUI.Full 3841 * @since 8 3842 */ 3843 /** 3844 * Obtains the Y coordinate of the drag window, in vp. 3845 * 3846 * @type { number } 3847 * @syscap SystemCapability.ArkUI.ArkUI.Full 3848 * @crossplatform 3849 * @since 10 3850 */ 3851 /** 3852 * Obtains the Y coordinate of the drag window, in vp. 3853 * 3854 * @type { number } 3855 * @syscap SystemCapability.ArkUI.ArkUI.Full 3856 * @crossplatform 3857 * @atomicservice 3858 * @since 11 3859 */ 3860 y: number; 3861} 3862 3863/** 3864 * DragItemInfo object description 3865 * 3866 * @interface DragItemInfo 3867 * @syscap SystemCapability.ArkUI.ArkUI.Full 3868 * @since 8 3869 */ 3870/** 3871 * DragItemInfo object description 3872 * 3873 * @interface DragItemInfo 3874 * @syscap SystemCapability.ArkUI.ArkUI.Full 3875 * @atomicservice 3876 * @since 11 3877 */ 3878declare interface DragItemInfo { 3879 /** 3880 * Uses the pixelMap object for drawing. 3881 * 3882 * @type { ?PixelMap } 3883 * @syscap SystemCapability.ArkUI.ArkUI.Full 3884 * @since 8 3885 */ 3886 /** 3887 * Uses the pixelMap object for drawing. 3888 * 3889 * @type { ?PixelMap } 3890 * @syscap SystemCapability.ArkUI.ArkUI.Full 3891 * @atomicservice 3892 * @since 11 3893 */ 3894 pixelMap?: PixelMap; 3895 3896 /** 3897 * Uses the custom builder for drawing, if pixelMap is set, this value is ignored. 3898 * 3899 * @type { ?CustomBuilder } 3900 * @syscap SystemCapability.ArkUI.ArkUI.Full 3901 * @since 8 3902 */ 3903 /** 3904 * Uses the custom builder for drawing, if pixelMap is set, this value is ignored. 3905 * 3906 * @type { ?CustomBuilder } 3907 * @syscap SystemCapability.ArkUI.ArkUI.Full 3908 * @atomicservice 3909 * @since 11 3910 */ 3911 builder?: CustomBuilder; 3912 3913 /** 3914 * Sets the extra info for drag event. 3915 * 3916 * @type { ?string } 3917 * @syscap SystemCapability.ArkUI.ArkUI.Full 3918 * @since 8 3919 */ 3920 /** 3921 * Sets the extra info for drag event. 3922 * 3923 * @type { ?string } 3924 * @syscap SystemCapability.ArkUI.ArkUI.Full 3925 * @atomicservice 3926 * @since 11 3927 */ 3928 extraInfo?: string; 3929} 3930 3931/** 3932 * Defining animation function. 3933 * 3934 * @param { AnimateParam } value 3935 * @param { function } event 3936 * @syscap SystemCapability.ArkUI.ArkUI.Full 3937 * @since 7 3938 */ 3939/** 3940 * Defining animation function. 3941 * 3942 * @param { AnimateParam } value 3943 * @param { function } event 3944 * @syscap SystemCapability.ArkUI.ArkUI.Full 3945 * @since 9 3946 * @form 3947 */ 3948/** 3949 * Defining animation function. 3950 * 3951 * @param { AnimateParam } value 3952 * @param { function } event 3953 * @syscap SystemCapability.ArkUI.ArkUI.Full 3954 * @crossplatform 3955 * @since 10 3956 * @form 3957 */ 3958/** 3959 * Defining animation function. 3960 * 3961 * @param { AnimateParam } value 3962 * @param { function } event 3963 * @syscap SystemCapability.ArkUI.ArkUI.Full 3964 * @crossplatform 3965 * @atomicservice 3966 * @since 11 3967 * @form 3968 */ 3969declare function animateTo(value: AnimateParam, event: () => void): void; 3970 3971/** 3972 * Define animation functions for immediate distribution. 3973 * 3974 * @param { AnimateParam } value - Set animation effect parameters. 3975 * @param { function } event - Specify the closure function that displays dynamic effects, 3976 * and the system will automatically insert transition animations for state changes caused by the closure function. 3977 * @syscap SystemCapability.ArkUI.ArkUI.Full 3978 * @systemapi 3979 * @since 11 3980 */ 3981declare function animateToImmediately(value: AnimateParam, event: () => void): void; 3982 3983/** 3984 * Converts a value in vp units to a value in px. 3985 * 3986 * @param { number } value 3987 * @returns { number } 3988 * @syscap SystemCapability.ArkUI.ArkUI.Full 3989 * @since 7 3990 */ 3991/** 3992 * Converts a value in vp units to a value in px. 3993 * 3994 * @param { number } value 3995 * @returns { number } 3996 * @syscap SystemCapability.ArkUI.ArkUI.Full 3997 * @since 9 3998 * @form 3999 */ 4000/** 4001 * Converts a value in vp units to a value in px. 4002 * 4003 * @param { number } value 4004 * @returns { number } 4005 * @syscap SystemCapability.ArkUI.ArkUI.Full 4006 * @crossplatform 4007 * @since 10 4008 * @form 4009 */ 4010/** 4011 * Converts a value in vp units to a value in px. 4012 * 4013 * @param { number } value 4014 * @returns { number } 4015 * @syscap SystemCapability.ArkUI.ArkUI.Full 4016 * @crossplatform 4017 * @atomicservice 4018 * @since 11 4019 * @form 4020 */ 4021declare function vp2px(value: number): number; 4022 4023/** 4024 * Converts a number in units of px to a number in units of vp. 4025 * 4026 * @param { number } value 4027 * @returns { number } 4028 * @syscap SystemCapability.ArkUI.ArkUI.Full 4029 * @since 7 4030 */ 4031/** 4032 * Converts a number in units of px to a number in units of vp. 4033 * 4034 * @param { number } value 4035 * @returns { number } 4036 * @syscap SystemCapability.ArkUI.ArkUI.Full 4037 * @since 9 4038 * @form 4039 */ 4040/** 4041 * Converts a number in units of px to a number in units of vp. 4042 * 4043 * @param { number } value 4044 * @returns { number } 4045 * @syscap SystemCapability.ArkUI.ArkUI.Full 4046 * @crossplatform 4047 * @since 10 4048 * @form 4049 */ 4050/** 4051 * Converts a number in units of px to a number in units of vp. 4052 * 4053 * @param { number } value 4054 * @returns { number } 4055 * @syscap SystemCapability.ArkUI.ArkUI.Full 4056 * @crossplatform 4057 * @atomicservice 4058 * @since 11 4059 * @form 4060 */ 4061declare function px2vp(value: number): number; 4062 4063/** 4064 * Converts a number in fp units to a number in px. 4065 * 4066 * @param { number } value 4067 * @returns { number } 4068 * @syscap SystemCapability.ArkUI.ArkUI.Full 4069 * @since 7 4070 */ 4071/** 4072 * Converts a number in fp units to a number in px. 4073 * 4074 * @param { number } value 4075 * @returns { number } 4076 * @syscap SystemCapability.ArkUI.ArkUI.Full 4077 * @since 9 4078 * @form 4079 */ 4080/** 4081 * Converts a number in fp units to a number in px. 4082 * 4083 * @param { number } value 4084 * @returns { number } 4085 * @syscap SystemCapability.ArkUI.ArkUI.Full 4086 * @crossplatform 4087 * @since 10 4088 * @form 4089 */ 4090/** 4091 * Converts a number in fp units to a number in px. 4092 * 4093 * @param { number } value 4094 * @returns { number } 4095 * @syscap SystemCapability.ArkUI.ArkUI.Full 4096 * @crossplatform 4097 * @atomicservice 4098 * @since 11 4099 * @form 4100 */ 4101declare function fp2px(value: number): number; 4102 4103/** 4104 * Converts a number in units of px to a number in units of fp. 4105 * 4106 * @param { number } value 4107 * @returns { number } 4108 * @syscap SystemCapability.ArkUI.ArkUI.Full 4109 * @since 7 4110 */ 4111/** 4112 * Converts a number in units of px to a number in units of fp. 4113 * 4114 * @param { number } value 4115 * @returns { number } 4116 * @syscap SystemCapability.ArkUI.ArkUI.Full 4117 * @since 9 4118 * @form 4119 */ 4120/** 4121 * Converts a number in units of px to a number in units of fp. 4122 * 4123 * @param { number } value 4124 * @returns { number } 4125 * @syscap SystemCapability.ArkUI.ArkUI.Full 4126 * @crossplatform 4127 * @since 10 4128 * @form 4129 */ 4130/** 4131 * Converts a number in units of px to a number in units of fp. 4132 * 4133 * @param { number } value 4134 * @returns { number } 4135 * @syscap SystemCapability.ArkUI.ArkUI.Full 4136 * @crossplatform 4137 * @atomicservice 4138 * @since 11 4139 * @form 4140 */ 4141declare function px2fp(value: number): number; 4142 4143/** 4144 * Converts a number in units of lpx to a number in units of px. 4145 * 4146 * @param { number } value 4147 * @returns { number } 4148 * @syscap SystemCapability.ArkUI.ArkUI.Full 4149 * @since 7 4150 */ 4151/** 4152 * Converts a number in units of lpx to a number in units of px. 4153 * 4154 * @param { number } value 4155 * @returns { number } 4156 * @syscap SystemCapability.ArkUI.ArkUI.Full 4157 * @since 9 4158 * @form 4159 */ 4160/** 4161 * Converts a number in units of lpx to a number in units of px. 4162 * 4163 * @param { number } value 4164 * @returns { number } 4165 * @syscap SystemCapability.ArkUI.ArkUI.Full 4166 * @crossplatform 4167 * @since 10 4168 * @form 4169 */ 4170/** 4171 * Converts a number in units of lpx to a number in units of px. 4172 * 4173 * @param { number } value 4174 * @returns { number } 4175 * @syscap SystemCapability.ArkUI.ArkUI.Full 4176 * @crossplatform 4177 * @atomicservice 4178 * @since 11 4179 * @form 4180 */ 4181declare function lpx2px(value: number): number; 4182 4183/** 4184 * Converts a number in units of px to a number in units of lpx. 4185 * 4186 * @param { number } value 4187 * @returns { number } 4188 * @syscap SystemCapability.ArkUI.ArkUI.Full 4189 * @since 7 4190 */ 4191/** 4192 * Converts a number in units of px to a number in units of lpx. 4193 * 4194 * @param { number } value 4195 * @returns { number } 4196 * @syscap SystemCapability.ArkUI.ArkUI.Full 4197 * @since 9 4198 * @form 4199 */ 4200/** 4201 * Converts a number in units of px to a number in units of lpx. 4202 * 4203 * @param { number } value 4204 * @returns { number } 4205 * @syscap SystemCapability.ArkUI.ArkUI.Full 4206 * @crossplatform 4207 * @since 10 4208 * @form 4209 */ 4210/** 4211 * Converts a number in units of px to a number in units of lpx. 4212 * 4213 * @param { number } value 4214 * @returns { number } 4215 * @syscap SystemCapability.ArkUI.ArkUI.Full 4216 * @crossplatform 4217 * @atomicservice 4218 * @since 11 4219 * @form 4220 */ 4221declare function px2lpx(value: number): number; 4222 4223/** 4224 * Defines the namespace of focus controller. 4225 * 4226 * @namespace focusControl 4227 * @syscap SystemCapability.ArkUI.ArkUI.Full 4228 * @crossplatform 4229 * @since 9 4230 * @form 4231 */ 4232/** 4233 * Defines the namespace of focus controller. 4234 * 4235 * @namespace focusControl 4236 * @syscap SystemCapability.ArkUI.ArkUI.Full 4237 * @crossplatform 4238 * @atomicservice 4239 * @since 11 4240 * @form 4241 */ 4242declare namespace focusControl { 4243 /** 4244 * Request focus to the specific component by param: 'id/key'. 4245 * 4246 * @param { string } value 4247 * @returns { boolean } 4248 * @syscap SystemCapability.ArkUI.ArkUI.Full 4249 * @since 9 4250 */ 4251 /** 4252 * Request focus to the specific component by param: 'id/key'. 4253 * 4254 * @param { string } value 4255 * @returns { boolean } 4256 * @syscap SystemCapability.ArkUI.ArkUI.Full 4257 * @crossplatform 4258 * @since 10 4259 */ 4260 /** 4261 * Request focus to the specific component by param: 'id/key'. 4262 * 4263 * @param { string } value 4264 * @returns { boolean } 4265 * @syscap SystemCapability.ArkUI.ArkUI.Full 4266 * @crossplatform 4267 * @atomicservice 4268 * @since 11 4269 */ 4270 function requestFocus(value: string): boolean; 4271} 4272 4273/** 4274 * Import the PointerStyle type object for setCursor. 4275 * 4276 * @syscap SystemCapability.ArkUI.ArkUI.Full 4277 * @since 11 4278 */ 4279declare type PointerStyle = import('../api/@ohos.multimodalInput.pointer').default.PointerStyle; 4280 4281/** 4282 * CursorControl 4283 * 4284 * @namespace cursorControl 4285 * @syscap SystemCapability.ArkUI.ArkUI.Full 4286 * @since 11 4287 */ 4288declare namespace cursorControl { 4289 4290 /** 4291 * Change the mouse cursor style by param: 'PointerStyle'. 4292 * 4293 * @param { PointerStyle } value 4294 * @syscap SystemCapability.ArkUI.ArkUI.Full 4295 * @crossplatform 4296 * @since 11 4297 */ 4298 function setCursor(value: PointerStyle): void; 4299 4300 /** 4301 * Restore the default mouse cursor style. 4302 * 4303 * @syscap SystemCapability.ArkUI.ArkUI.Full 4304 * @crossplatform 4305 * @since 11 4306 */ 4307 function restoreDefault(): void; 4308} 4309 4310/** 4311 * Defines the event target. 4312 * 4313 * @interface EventTarget 4314 * @syscap SystemCapability.ArkUI.ArkUI.Full 4315 * @since 8 4316 */ 4317/** 4318 * Defines the event target. 4319 * 4320 * @interface EventTarget 4321 * @syscap SystemCapability.ArkUI.ArkUI.Full 4322 * @since 9 4323 * @form 4324 */ 4325/** 4326 * Defines the event target. 4327 * 4328 * @interface EventTarget 4329 * @syscap SystemCapability.ArkUI.ArkUI.Full 4330 * @crossplatform 4331 * @since 10 4332 * @form 4333 */ 4334/** 4335 * Defines the event target. 4336 * 4337 * @interface EventTarget 4338 * @syscap SystemCapability.ArkUI.ArkUI.Full 4339 * @crossplatform 4340 * @atomicservice 4341 * @since 11 4342 * @form 4343 */ 4344declare interface EventTarget { 4345 /** 4346 * Area of current target. 4347 * 4348 * @type { Area } 4349 * @syscap SystemCapability.ArkUI.ArkUI.Full 4350 * @since 8 4351 */ 4352 /** 4353 * Area of current target. 4354 * 4355 * @type { Area } 4356 * @syscap SystemCapability.ArkUI.ArkUI.Full 4357 * @since 9 4358 * @form 4359 */ 4360 /** 4361 * Area of current target. 4362 * 4363 * @type { Area } 4364 * @syscap SystemCapability.ArkUI.ArkUI.Full 4365 * @crossplatform 4366 * @since 10 4367 * @form 4368 */ 4369 /** 4370 * Area of current target. 4371 * 4372 * @type { Area } 4373 * @syscap SystemCapability.ArkUI.ArkUI.Full 4374 * @crossplatform 4375 * @atomicservice 4376 * @since 11 4377 * @form 4378 */ 4379 area: Area; 4380} 4381 4382/** 4383 * Defines the event source type. 4384 * 4385 * @enum { number } 4386 * @syscap SystemCapability.ArkUI.ArkUI.Full 4387 * @since 8 4388 */ 4389/** 4390 * Defines the event source type. 4391 * 4392 * @enum { number } 4393 * @syscap SystemCapability.ArkUI.ArkUI.Full 4394 * @crossplatform 4395 * @since 10 4396 */ 4397/** 4398 * Defines the event source type. 4399 * 4400 * @enum { number } 4401 * @syscap SystemCapability.ArkUI.ArkUI.Full 4402 * @crossplatform 4403 * @atomicservice 4404 * @since 11 4405 */ 4406declare enum SourceType { 4407 /** 4408 * Unknown type. 4409 * 4410 * @syscap SystemCapability.ArkUI.ArkUI.Full 4411 * @since 8 4412 */ 4413 /** 4414 * Unknown type. 4415 * 4416 * @syscap SystemCapability.ArkUI.ArkUI.Full 4417 * @crossplatform 4418 * @since 10 4419 */ 4420 /** 4421 * Unknown type. 4422 * 4423 * @syscap SystemCapability.ArkUI.ArkUI.Full 4424 * @crossplatform 4425 * @atomicservice 4426 * @since 11 4427 */ 4428 Unknown, 4429 4430 /** 4431 * The mouse type. 4432 * 4433 * @syscap SystemCapability.ArkUI.ArkUI.Full 4434 * @since 8 4435 */ 4436 /** 4437 * The mouse type. 4438 * 4439 * @syscap SystemCapability.ArkUI.ArkUI.Full 4440 * @crossplatform 4441 * @since 10 4442 */ 4443 /** 4444 * The mouse type. 4445 * 4446 * @syscap SystemCapability.ArkUI.ArkUI.Full 4447 * @crossplatform 4448 * @atomicservice 4449 * @since 11 4450 */ 4451 Mouse, 4452 4453 /** 4454 * The touch screen type. 4455 * 4456 * @syscap SystemCapability.ArkUI.ArkUI.Full 4457 * @since 8 4458 */ 4459 /** 4460 * The touch screen type. 4461 * 4462 * @syscap SystemCapability.ArkUI.ArkUI.Full 4463 * @crossplatform 4464 * @since 10 4465 */ 4466 /** 4467 * The touch screen type. 4468 * 4469 * @syscap SystemCapability.ArkUI.ArkUI.Full 4470 * @crossplatform 4471 * @atomicservice 4472 * @since 11 4473 */ 4474 TouchScreen, 4475} 4476 4477/** 4478 * Defines the event tool type. 4479 * 4480 * @enum { number } 4481 * @syscap SystemCapability.ArkUI.ArkUI.Full 4482 * @since 9 4483 */ 4484/** 4485 * Defines the event tool type. 4486 * 4487 * @enum { number } 4488 * @syscap SystemCapability.ArkUI.ArkUI.Full 4489 * @crossplatform 4490 * @since 10 4491 */ 4492/** 4493 * Defines the event tool type. 4494 * 4495 * @enum { number } 4496 * @syscap SystemCapability.ArkUI.ArkUI.Full 4497 * @crossplatform 4498 * @atomicservice 4499 * @since 11 4500 */ 4501declare enum SourceTool { 4502 /** 4503 * Unknown type. 4504 * 4505 * @syscap SystemCapability.ArkUI.ArkUI.Full 4506 * @since 9 4507 */ 4508 /** 4509 * Unknown type. 4510 * 4511 * @syscap SystemCapability.ArkUI.ArkUI.Full 4512 * @crossplatform 4513 * @since 10 4514 */ 4515 /** 4516 * Unknown type. 4517 * 4518 * @syscap SystemCapability.ArkUI.ArkUI.Full 4519 * @crossplatform 4520 * @atomicservice 4521 * @since 11 4522 */ 4523 Unknown, 4524 4525 /** 4526 * The finger type. 4527 * 4528 * @syscap SystemCapability.ArkUI.ArkUI.Full 4529 * @since 9 4530 */ 4531 /** 4532 * The finger type. 4533 * 4534 * @syscap SystemCapability.ArkUI.ArkUI.Full 4535 * @crossplatform 4536 * @since 10 4537 */ 4538 /** 4539 * The finger type. 4540 * 4541 * @syscap SystemCapability.ArkUI.ArkUI.Full 4542 * @crossplatform 4543 * @atomicservice 4544 * @since 11 4545 */ 4546 Finger, 4547 4548 /** 4549 * The pen type. 4550 * 4551 * @syscap SystemCapability.ArkUI.ArkUI.Full 4552 * @since 9 4553 */ 4554 /** 4555 * The pen type. 4556 * 4557 * @syscap SystemCapability.ArkUI.ArkUI.Full 4558 * @crossplatform 4559 * @since 10 4560 */ 4561 /** 4562 * The pen type. 4563 * 4564 * @syscap SystemCapability.ArkUI.ArkUI.Full 4565 * @crossplatform 4566 * @atomicservice 4567 * @since 11 4568 */ 4569 Pen, 4570} 4571 4572/** 4573 * Defines the Border Image Repeat Mode. 4574 * 4575 * @enum { number } 4576 * @syscap SystemCapability.ArkUI.ArkUI.Full 4577 * @since 9 4578 * @form 4579 */ 4580/** 4581 * Defines the Border Image Repeat Mode. 4582 * 4583 * @enum { number } 4584 * @syscap SystemCapability.ArkUI.ArkUI.Full 4585 * @crossplatform 4586 * @since 10 4587 * @form 4588 */ 4589/** 4590 * Defines the Border Image Repeat Mode. 4591 * 4592 * @enum { number } 4593 * @syscap SystemCapability.ArkUI.ArkUI.Full 4594 * @crossplatform 4595 * @atomicservice 4596 * @since 11 4597 * @form 4598 */ 4599declare enum RepeatMode { 4600 /** 4601 * Repeat mode. 4602 * 4603 * @syscap SystemCapability.ArkUI.ArkUI.Full 4604 * @since 9 4605 * @form 4606 */ 4607 /** 4608 * Repeat mode. 4609 * 4610 * @syscap SystemCapability.ArkUI.ArkUI.Full 4611 * @crossplatform 4612 * @since 10 4613 * @form 4614 */ 4615 /** 4616 * Repeat mode. 4617 * 4618 * @syscap SystemCapability.ArkUI.ArkUI.Full 4619 * @crossplatform 4620 * @atomicservice 4621 * @since 11 4622 * @form 4623 */ 4624 Repeat, 4625 4626 /** 4627 * Stretch mode. 4628 * 4629 * @syscap SystemCapability.ArkUI.ArkUI.Full 4630 * @since 9 4631 * @form 4632 */ 4633 /** 4634 * Stretch mode. 4635 * 4636 * @syscap SystemCapability.ArkUI.ArkUI.Full 4637 * @crossplatform 4638 * @since 10 4639 * @form 4640 */ 4641 /** 4642 * Stretch mode. 4643 * 4644 * @syscap SystemCapability.ArkUI.ArkUI.Full 4645 * @crossplatform 4646 * @atomicservice 4647 * @since 11 4648 * @form 4649 */ 4650 Stretch, 4651 4652 /** 4653 * Round mode. 4654 * 4655 * @syscap SystemCapability.ArkUI.ArkUI.Full 4656 * @since 9 4657 * @form 4658 */ 4659 /** 4660 * Round mode. 4661 * 4662 * @syscap SystemCapability.ArkUI.ArkUI.Full 4663 * @crossplatform 4664 * @since 10 4665 * @form 4666 */ 4667 /** 4668 * Round mode. 4669 * 4670 * @syscap SystemCapability.ArkUI.ArkUI.Full 4671 * @crossplatform 4672 * @atomicservice 4673 * @since 11 4674 * @form 4675 */ 4676 Round, 4677 4678 /** 4679 * Space mode. 4680 * 4681 * @syscap SystemCapability.ArkUI.ArkUI.Full 4682 * @since 9 4683 * @form 4684 */ 4685 /** 4686 * Space mode. 4687 * 4688 * @syscap SystemCapability.ArkUI.ArkUI.Full 4689 * @crossplatform 4690 * @since 10 4691 * @form 4692 */ 4693 /** 4694 * Space mode. 4695 * 4696 * @syscap SystemCapability.ArkUI.ArkUI.Full 4697 * @crossplatform 4698 * @atomicservice 4699 * @since 11 4700 * @form 4701 */ 4702 Space, 4703} 4704 4705/** 4706 * enum Blur style 4707 * 4708 * @enum { number } 4709 * @syscap SystemCapability.ArkUI.ArkUI.Full 4710 * @since 9 4711 * @form 4712 */ 4713/** 4714 * enum Blur style 4715 * 4716 * @enum { number } 4717 * @syscap SystemCapability.ArkUI.ArkUI.Full 4718 * @crossplatform 4719 * @since 10 4720 * @form 4721 */ 4722/** 4723 * enum Blur style 4724 * 4725 * @enum { number } 4726 * @syscap SystemCapability.ArkUI.ArkUI.Full 4727 * @crossplatform 4728 * @atomicservice 4729 * @since 11 4730 * @form 4731 */ 4732declare enum BlurStyle { 4733 /** 4734 * Defines the thin card material. 4735 * 4736 * @syscap SystemCapability.ArkUI.ArkUI.Full 4737 * @since 9 4738 * @form 4739 */ 4740 /** 4741 * Defines the thin card material. 4742 * 4743 * @syscap SystemCapability.ArkUI.ArkUI.Full 4744 * @crossplatform 4745 * @since 10 4746 * @form 4747 */ 4748 /** 4749 * Defines the thin card material. 4750 * 4751 * @syscap SystemCapability.ArkUI.ArkUI.Full 4752 * @crossplatform 4753 * @atomicservice 4754 * @since 11 4755 * @form 4756 */ 4757 Thin, 4758 4759 /** 4760 * Defines the regular card material. 4761 * 4762 * @syscap SystemCapability.ArkUI.ArkUI.Full 4763 * @since 9 4764 * @form 4765 */ 4766 /** 4767 * Defines the regular card material. 4768 * 4769 * @syscap SystemCapability.ArkUI.ArkUI.Full 4770 * @crossplatform 4771 * @since 10 4772 * @form 4773 */ 4774 /** 4775 * Defines the regular card material. 4776 * 4777 * @syscap SystemCapability.ArkUI.ArkUI.Full 4778 * @crossplatform 4779 * @atomicservice 4780 * @since 11 4781 * @form 4782 */ 4783 Regular, 4784 4785 /** 4786 * Defines the thick card material. 4787 * 4788 * @syscap SystemCapability.ArkUI.ArkUI.Full 4789 * @since 9 4790 * @form 4791 */ 4792 /** 4793 * Defines the thick card material. 4794 * 4795 * @syscap SystemCapability.ArkUI.ArkUI.Full 4796 * @crossplatform 4797 * @since 10 4798 * @form 4799 */ 4800 /** 4801 * Defines the thick card material. 4802 * 4803 * @syscap SystemCapability.ArkUI.ArkUI.Full 4804 * @crossplatform 4805 * @atomicservice 4806 * @since 11 4807 * @form 4808 */ 4809 Thick, 4810 4811 /** 4812 * Defines the thin background material. 4813 * 4814 * @syscap SystemCapability.ArkUI.ArkUI.Full 4815 * @crossplatform 4816 * @since 10 4817 */ 4818 /** 4819 * Defines the thin background material. 4820 * 4821 * @syscap SystemCapability.ArkUI.ArkUI.Full 4822 * @crossplatform 4823 * @atomicservice 4824 * @since 11 4825 * @form 4826 */ 4827 BACKGROUND_THIN, 4828 4829 /** 4830 * Defines the thin regular material. 4831 * 4832 * @syscap SystemCapability.ArkUI.ArkUI.Full 4833 * @crossplatform 4834 * @since 10 4835 */ 4836 /** 4837 * Defines the thin regular material. 4838 * 4839 * @syscap SystemCapability.ArkUI.ArkUI.Full 4840 * @crossplatform 4841 * @atomicservice 4842 * @since 11 4843 * @form 4844 */ 4845 BACKGROUND_REGULAR, 4846 4847 /** 4848 * Defines the thin thick material. 4849 * 4850 * @syscap SystemCapability.ArkUI.ArkUI.Full 4851 * @crossplatform 4852 * @since 10 4853 */ 4854 /** 4855 * Defines the thin thick material. 4856 * 4857 * @syscap SystemCapability.ArkUI.ArkUI.Full 4858 * @crossplatform 4859 * @atomicservice 4860 * @since 11 4861 * @form 4862 */ 4863 BACKGROUND_THICK, 4864 4865 /** 4866 * Defines the thin ultra thick material. 4867 * 4868 * @syscap SystemCapability.ArkUI.ArkUI.Full 4869 * @crossplatform 4870 * @since 10 4871 */ 4872 /** 4873 * Defines the thin ultra thick material. 4874 * 4875 * @syscap SystemCapability.ArkUI.ArkUI.Full 4876 * @crossplatform 4877 * @atomicservice 4878 * @since 11 4879 * @form 4880 */ 4881 BACKGROUND_ULTRA_THICK, 4882 4883 /** 4884 * Defines none material. 4885 * 4886 * @syscap SystemCapability.ArkUI.ArkUI.Full 4887 * @crossplatform 4888 * @since 10 4889 * @form 4890 */ 4891 /** 4892 * Defines none material. 4893 * 4894 * @syscap SystemCapability.ArkUI.ArkUI.Full 4895 * @crossplatform 4896 * @atomicservice 4897 * @since 11 4898 * @form 4899 */ 4900 NONE, 4901 4902 /** 4903 * Defines the ultra thin component material. 4904 * 4905 * @syscap SystemCapability.ArkUI.ArkUI.Full 4906 * @crossplatform 4907 * @since 11 4908 * @form 4909 */ 4910 COMPONENT_ULTRA_THIN = 8, 4911 4912 /** 4913 * Defines the thin component material. 4914 * 4915 * @syscap SystemCapability.ArkUI.ArkUI.Full 4916 * @crossplatform 4917 * @since 11 4918 * @form 4919 */ 4920 COMPONENT_THIN = 9, 4921 4922 /** 4923 * Defines the regular component material. 4924 * 4925 * @syscap SystemCapability.ArkUI.ArkUI.Full 4926 * @crossplatform 4927 * @since 11 4928 * @form 4929 */ 4930 COMPONENT_REGULAR = 10, 4931 4932 /** 4933 * Defines the thick component material. 4934 * 4935 * @syscap SystemCapability.ArkUI.ArkUI.Full 4936 * @crossplatform 4937 * @since 11 4938 * @form 4939 */ 4940 COMPONENT_THICK = 11, 4941 4942 /** 4943 * Defines the ultra thick component material. 4944 * 4945 * @syscap SystemCapability.ArkUI.ArkUI.Full 4946 * @crossplatform 4947 * @since 11 4948 * @form 4949 */ 4950 COMPONENT_ULTRA_THICK = 12, 4951} 4952 4953/** 4954 * enum color mode 4955 * 4956 * @enum { number } 4957 * @syscap SystemCapability.ArkUI.ArkUI.Full 4958 * @crossplatform 4959 * @since 10 4960 */ 4961/** 4962 * enum color mode 4963 * 4964 * @enum { number } 4965 * @syscap SystemCapability.ArkUI.ArkUI.Full 4966 * @crossplatform 4967 * @atomicservice 4968 * @since 11 4969 */ 4970declare enum ThemeColorMode { 4971 /** 4972 * Defines the mode which is follow up with system. 4973 * 4974 * @syscap SystemCapability.ArkUI.ArkUI.Full 4975 * @crossplatform 4976 * @since 10 4977 */ 4978 /** 4979 * Defines the mode which is follow up with system. 4980 * 4981 * @syscap SystemCapability.ArkUI.ArkUI.Full 4982 * @crossplatform 4983 * @atomicservice 4984 * @since 11 4985 */ 4986 SYSTEM, 4987 4988 /** 4989 * Defines the light mode. 4990 * 4991 * @syscap SystemCapability.ArkUI.ArkUI.Full 4992 * @crossplatform 4993 * @since 10 4994 */ 4995 /** 4996 * Defines the light mode. 4997 * 4998 * @syscap SystemCapability.ArkUI.ArkUI.Full 4999 * @crossplatform 5000 * @atomicservice 5001 * @since 11 5002 */ 5003 LIGHT, 5004 5005 /** 5006 * Defines the dark mode. 5007 * 5008 * @syscap SystemCapability.ArkUI.ArkUI.Full 5009 * @crossplatform 5010 * @since 10 5011 */ 5012 /** 5013 * Defines the dark mode. 5014 * 5015 * @syscap SystemCapability.ArkUI.ArkUI.Full 5016 * @crossplatform 5017 * @atomicservice 5018 * @since 11 5019 */ 5020 DARK, 5021} 5022 5023/** 5024 * Defines adaptive color 5025 * 5026 * @enum { number } 5027 * @syscap SystemCapability.ArkUI.ArkUI.Full 5028 * @crossplatform 5029 * @since 10 5030 */ 5031/** 5032 * Defines adaptive color 5033 * 5034 * @enum { number } 5035 * @syscap SystemCapability.ArkUI.ArkUI.Full 5036 * @crossplatform 5037 * @atomicservice 5038 * @since 11 5039 */ 5040declare enum AdaptiveColor { 5041 /** 5042 * Defines the fixed value color adaptive mode. 5043 * 5044 * @syscap SystemCapability.ArkUI.ArkUI.Full 5045 * @crossplatform 5046 * @since 10 5047 */ 5048 /** 5049 * Defines the fixed value color adaptive mode. 5050 * 5051 * @syscap SystemCapability.ArkUI.ArkUI.Full 5052 * @crossplatform 5053 * @atomicservice 5054 * @since 11 5055 */ 5056 DEFAULT, 5057 5058 /** 5059 * Defines the background average color adaptive mode. 5060 * 5061 * @syscap SystemCapability.ArkUI.ArkUI.Full 5062 * @crossplatform 5063 * @since 10 5064 */ 5065 /** 5066 * Defines the background average color adaptive mode. 5067 * 5068 * @syscap SystemCapability.ArkUI.ArkUI.Full 5069 * @crossplatform 5070 * @atomicservice 5071 * @since 11 5072 */ 5073 AVERAGE, 5074} 5075 5076/** 5077 * Defines modal transition type. 5078 * 5079 * @enum { number } 5080 * @syscap SystemCapability.ArkUI.ArkUI.Full 5081 * @crossplatform 5082 * @since 10 5083 */ 5084/** 5085 * Defines modal transition type. 5086 * 5087 * @enum { number } 5088 * @syscap SystemCapability.ArkUI.ArkUI.Full 5089 * @crossplatform 5090 * @atomicservice 5091 * @since 11 5092 */ 5093declare enum ModalTransition { 5094 /** 5095 * Use default animation. 5096 * 5097 * @syscap SystemCapability.ArkUI.ArkUI.Full 5098 * @crossplatform 5099 * @since 10 5100 */ 5101 /** 5102 * Use default animation. 5103 * 5104 * @syscap SystemCapability.ArkUI.ArkUI.Full 5105 * @crossplatform 5106 * @atomicservice 5107 * @since 11 5108 */ 5109 DEFAULT, 5110 5111 /** 5112 * Use none animation. 5113 * 5114 * @syscap SystemCapability.ArkUI.ArkUI.Full 5115 * @crossplatform 5116 * @since 10 5117 */ 5118 /** 5119 * Use none animation. 5120 * 5121 * @syscap SystemCapability.ArkUI.ArkUI.Full 5122 * @crossplatform 5123 * @atomicservice 5124 * @since 11 5125 */ 5126 NONE, 5127 5128 /** 5129 * Use alpha animation. 5130 * 5131 * @syscap SystemCapability.ArkUI.ArkUI.Full 5132 * @crossplatform 5133 * @since 10 5134 */ 5135 /** 5136 * Use alpha animation. 5137 * 5138 * @syscap SystemCapability.ArkUI.ArkUI.Full 5139 * @crossplatform 5140 * @atomicservice 5141 * @since 11 5142 */ 5143 ALPHA, 5144} 5145 5146/** 5147 * Defines the options of backgroundBlurStyle 5148 * 5149 * @interface BackgroundBlurStyleOptions 5150 * @syscap SystemCapability.ArkUI.ArkUI.Full 5151 * @crossplatform 5152 * @since 10 5153 */ 5154/** 5155 * Defines the options of backgroundBlurStyle 5156 * 5157 * @interface BackgroundBlurStyleOptions 5158 * @syscap SystemCapability.ArkUI.ArkUI.Full 5159 * @crossplatform 5160 * @atomicservice 5161 * @since 11 5162 */ 5163declare interface BackgroundBlurStyleOptions extends BlurStyleOptions {} 5164 5165/** 5166 * Defines the options of ForegroundBlurStyle 5167 * 5168 * @interface ForegroundBlurStyleOptions 5169 * @syscap SystemCapability.ArkUI.ArkUI.Full 5170 * @crossplatform 5171 * @since 10 5172 */ 5173/** 5174 * Defines the options of ForegroundBlurStyle 5175 * 5176 * @interface ForegroundBlurStyleOptions 5177 * @syscap SystemCapability.ArkUI.ArkUI.Full 5178 * @crossplatform 5179 * @atomicservice 5180 * @since 11 5181 */ 5182declare interface ForegroundBlurStyleOptions extends BlurStyleOptions {} 5183 5184 5185/** 5186 * Defines the options of blur 5187 * 5188 * @interface BlurOptions 5189 * @syscap SystemCapability.ArkUI.ArkUI.Full 5190 * @crossplatform 5191 * @since 11 5192 */ 5193declare interface BlurOptions { 5194 /** 5195 * Fuzzy gray scale parameter. 5196 * @type { [number, number] } 5197 * @syscap SystemCapability.ArkUI.ArkUI.Full 5198 * @crossplatform 5199 * @since 11 5200 */ 5201 grayscale: [number, number]; 5202} 5203 5204/** 5205 * Defines the options of blurStyle 5206 * 5207 * @interface BlurStyleOptions 5208 * @syscap SystemCapability.ArkUI.ArkUI.Full 5209 * @crossplatform 5210 * @since 10 5211 */ 5212/** 5213 * Defines the options of blurStyle 5214 * 5215 * @interface BlurStyleOptions 5216 * @syscap SystemCapability.ArkUI.ArkUI.Full 5217 * @crossplatform 5218 * @atomicservice 5219 * @since 11 5220 */ 5221declare interface BlurStyleOptions { 5222 /** 5223 * color mode 5224 * 5225 * @type { ?ThemeColorMode } 5226 * @default ThemeColorMode.SYSTEM 5227 * @syscap SystemCapability.ArkUI.ArkUI.Full 5228 * @since 10 5229 */ 5230 /** 5231 * color mode 5232 * 5233 * @type { ?ThemeColorMode } 5234 * @default ThemeColorMode.SYSTEM 5235 * @syscap SystemCapability.ArkUI.ArkUI.Full 5236 * @crossplatform 5237 * @atomicservice 5238 * @since 11 5239 */ 5240 colorMode?: ThemeColorMode; 5241 5242 /** 5243 * adaptive color 5244 * 5245 * @type { ?AdaptiveColor } 5246 * @default AdaptiveColor.DEFAULT 5247 * @syscap SystemCapability.ArkUI.ArkUI.Full 5248 * @since 10 5249 */ 5250 /** 5251 * adaptive color 5252 * 5253 * @type { ?AdaptiveColor } 5254 * @default AdaptiveColor.DEFAULT 5255 * @syscap SystemCapability.ArkUI.ArkUI.Full 5256 * @crossplatform 5257 * @atomicservice 5258 * @since 11 5259 */ 5260 adaptiveColor?: AdaptiveColor; 5261 5262 /** 5263 * Define the scale of blur effect. 5264 * The range of value is [0, 1]. The larger the value, the more obvious the blurring effect. 5265 * A value of 0 indicates no blur effect and a value of 1 indicates a complete blur effect. 5266 * 5267 * @type { ?number } 5268 * @default 1.0 5269 * @syscap SystemCapability.ArkUI.ArkUI.Full 5270 * @systemapi 5271 * @since 10 5272 */ 5273 scale?: number; 5274 5275 /** 5276 * Defines the options of blur 5277 * 5278 * @type { ?BlurOptions } 5279 * @default { grayScale: [0,0] } 5280 * @syscap SystemCapability.ArkUI.ArkUI.Full 5281 * @crossplatform 5282 * @since 11 5283 */ 5284 blurOptions?: BlurOptions; 5285} 5286 5287/** 5288 * Defines the options of BackgroundEffect 5289 * 5290 * @interface BackgroundEffectOptions 5291 * @syscap SystemCapability.ArkUI.ArkUI.Full 5292 * @crossplatform 5293 * @since 11 5294 */ 5295declare interface BackgroundEffectOptions { 5296 5297 /** 5298 * Define the radius size of BackgroundEffect.The range of this value is [0, ∞) 5299 * 5300 * @type { number } 5301 * @syscap SystemCapability.ArkUI.ArkUI.Full 5302 * @crossplatform 5303 * @since 11 5304 */ 5305 radius: number; 5306 5307 /** 5308 * Define the saturation of BackgroundEffect. Value range [0, ∞) 5309 * 5310 * @type { ?number } 5311 * @default 1 5312 * @syscap SystemCapability.ArkUI.ArkUI.Full 5313 * @crossplatform 5314 * @since 11 5315 */ 5316 saturation?: number; 5317 5318 /** 5319 * Define the brightness of BackgroundEffect. Value range [0, ∞) 5320 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 5321 * @type { ?number } 5322 * @default 1 5323 * @syscap SystemCapability.ArkUI.ArkUI.Full 5324 * @crossplatform 5325 * @since 11 5326 */ 5327 brightness?: number; 5328 5329 /** 5330 * color the brightness of BackgroundEffect. 5331 * 5332 * @type { ?ResourceColor } 5333 * @default Color.Transparent 5334 * @syscap SystemCapability.ArkUI.ArkUI.Full 5335 * @crossplatform 5336 * @since 11 5337 */ 5338 color?: ResourceColor; 5339 5340 /** 5341 * Define the adaptiveColor of BackgroundEffect. 5342 * 5343 * @type { ?AdaptiveColor } 5344 * @default AdaptiveColor.DEFAULT 5345 * @syscap SystemCapability.ArkUI.ArkUI.Full 5346 * @crossplatform 5347 * @since 11 5348 */ 5349 adaptiveColor?: AdaptiveColor; 5350 5351 /** 5352 * Define the blurOptions of BackgroundEffect. 5353 * 5354 * @type { ?BlurOptions } 5355 * @default { grayScale: [0,1] } 5356 * @syscap SystemCapability.ArkUI.ArkUI.Full 5357 * @crossplatform 5358 * @since 11 5359 */ 5360 blurOptions?: BlurOptions; 5361} 5362 5363/** 5364 * Provide an interface for the text style of picker 5365 * 5366 * @interface PickerTextStyle 5367 * @syscap SystemCapability.ArkUI.ArkUI.Full 5368 * @crossplatform 5369 * @since 10 5370 */ 5371/** 5372 * Provide an interface for the text style of picker 5373 * 5374 * @interface PickerTextStyle 5375 * @syscap SystemCapability.ArkUI.ArkUI.Full 5376 * @crossplatform 5377 * @atomicservice 5378 * @since 11 5379 */ 5380declare interface PickerTextStyle { 5381 /** 5382 * Define the text color of picker. 5383 * 5384 * @type { ?ResourceColor } 5385 * @syscap SystemCapability.ArkUI.ArkUI.Full 5386 * @crossplatform 5387 * @since 10 5388 */ 5389 /** 5390 * Define the text color of picker. 5391 * 5392 * @type { ?ResourceColor } 5393 * @syscap SystemCapability.ArkUI.ArkUI.Full 5394 * @crossplatform 5395 * @atomicservice 5396 * @since 11 5397 */ 5398 color?: ResourceColor; 5399 5400 /** 5401 * Define the text font of picker. 5402 * Only support size and weight. 5403 * 5404 * @type { ?Font } 5405 * @syscap SystemCapability.ArkUI.ArkUI.Full 5406 * @crossplatform 5407 * @since 10 5408 */ 5409 /** 5410 * Define the text font of picker. 5411 * Only support size and weight. 5412 * 5413 * @type { ?Font } 5414 * @syscap SystemCapability.ArkUI.ArkUI.Full 5415 * @crossplatform 5416 * @atomicservice 5417 * @since 11 5418 */ 5419 font?: Font; 5420} 5421 5422/** 5423 * Define the type of shadow 5424 * 5425 * @enum { number } 5426 * @syscap SystemCapability.ArkUI.ArkUI.Full 5427 * @crossplatform 5428 * @since 10 5429 */ 5430/** 5431 * Define the type of shadow 5432 * 5433 * @enum { number } 5434 * @syscap SystemCapability.ArkUI.ArkUI.Full 5435 * @crossplatform 5436 * @atomicservice 5437 * @since 11 5438 */ 5439declare enum ShadowType { 5440 /** 5441 * Define a color type of shadow 5442 * 5443 * @syscap SystemCapability.ArkUI.ArkUI.Full 5444 * @crossplatform 5445 * @since 10 5446 */ 5447 /** 5448 * Define a color type of shadow 5449 * 5450 * @syscap SystemCapability.ArkUI.ArkUI.Full 5451 * @crossplatform 5452 * @atomicservice 5453 * @since 11 5454 */ 5455 COLOR, 5456 5457 /** 5458 * Define a blur type of shadow 5459 * 5460 * @syscap SystemCapability.ArkUI.ArkUI.Full 5461 * @crossplatform 5462 * @since 10 5463 */ 5464 /** 5465 * Define a blur type of shadow 5466 * 5467 * @syscap SystemCapability.ArkUI.ArkUI.Full 5468 * @crossplatform 5469 * @atomicservice 5470 * @since 11 5471 */ 5472 BLUR, 5473} 5474 5475/** 5476 * Define the options of shadow 5477 * 5478 * @interface ShadowOptions 5479 * @syscap SystemCapability.ArkUI.ArkUI.Full 5480 * @since 7 5481 */ 5482/** 5483 * Define the options of shadow 5484 * 5485 * @interface ShadowOptions 5486 * @syscap SystemCapability.ArkUI.ArkUI.Full 5487 * @since 9 5488 * @form 5489 */ 5490/** 5491 * Define the options of shadow 5492 * 5493 * @interface ShadowOptions 5494 * @syscap SystemCapability.ArkUI.ArkUI.Full 5495 * @crossplatform 5496 * @since 10 5497 * @form 5498 */ 5499/** 5500 * Define the options of shadow 5501 * 5502 * @interface ShadowOptions 5503 * @syscap SystemCapability.ArkUI.ArkUI.Full 5504 * @crossplatform 5505 * @atomicservice 5506 * @since 11 5507 * @form 5508 */ 5509declare interface ShadowOptions { 5510 /** 5511 * Define the radius size of shadow 5512 * 5513 * @type { number | Resource } 5514 * @syscap SystemCapability.ArkUI.ArkUI.Full 5515 * @since 7 5516 */ 5517 /** 5518 * Define the radius size of shadow 5519 * 5520 * @type { number | Resource } 5521 * @syscap SystemCapability.ArkUI.ArkUI.Full 5522 * @since 9 5523 * @form 5524 */ 5525 /** 5526 * Define the radius size of shadow 5527 * 5528 * @type { number | Resource } 5529 * @syscap SystemCapability.ArkUI.ArkUI.Full 5530 * @crossplatform 5531 * @since 10 5532 * @form 5533 */ 5534 /** 5535 * Define the radius size of shadow 5536 * 5537 * @type { number | Resource } 5538 * @syscap SystemCapability.ArkUI.ArkUI.Full 5539 * @crossplatform 5540 * @atomicservice 5541 * @since 11 5542 * @form 5543 */ 5544 radius: number | Resource; 5545 5546 /** 5547 * Define the type of shadow 5548 * 5549 * @type { ?ShadowType } 5550 * @default ShadowType.COLOR 5551 * @syscap SystemCapability.ArkUI.ArkUI.Full 5552 * @crossplatform 5553 * @since 10 5554 */ 5555 /** 5556 * Define the type of shadow 5557 * 5558 * @type { ?ShadowType } 5559 * @default ShadowType.COLOR 5560 * @syscap SystemCapability.ArkUI.ArkUI.Full 5561 * @crossplatform 5562 * @atomicservice 5563 * @since 11 5564 */ 5565 type?: ShadowType; 5566 5567 /** 5568 * Define the color of shadow 5569 * 5570 * @type { ?(Color | string | Resource) } 5571 * @syscap SystemCapability.ArkUI.ArkUI.Full 5572 * @since 7 5573 */ 5574 /** 5575 * Define the color of shadow 5576 * 5577 * @type { ?(Color | string | Resource) } 5578 * @syscap SystemCapability.ArkUI.ArkUI.Full 5579 * @since 9 5580 * @form 5581 */ 5582 /** 5583 * Define the color of shadow 5584 * 5585 * @type { ?(Color | string | Resource) } 5586 * @syscap SystemCapability.ArkUI.ArkUI.Full 5587 * @crossplatform 5588 * @since 10 5589 * @form 5590 */ 5591 /** 5592 * Define the color or the color strategy of shadow 5593 * 5594 * @type { ?(Color | string | Resource| ColoringStrategy) } 5595 * @syscap SystemCapability.ArkUI.ArkUI.Full 5596 * @crossplatform 5597 * @atomicservice 5598 * @since 11 5599 * @form 5600 */ 5601 color?: Color | string | Resource | ColoringStrategy; 5602 5603 /** 5604 * Define the horizontal offset size of shadow 5605 * 5606 * @type { ?(number | Resource) } 5607 * @syscap SystemCapability.ArkUI.ArkUI.Full 5608 * @since 7 5609 */ 5610 /** 5611 * Define the horizontal offset size of shadow 5612 * 5613 * @type { ?(number | Resource) } 5614 * @syscap SystemCapability.ArkUI.ArkUI.Full 5615 * @since 9 5616 * @form 5617 */ 5618 /** 5619 * Define the horizontal offset size of shadow 5620 * 5621 * @type { ?(number | Resource) } 5622 * @syscap SystemCapability.ArkUI.ArkUI.Full 5623 * @crossplatform 5624 * @since 10 5625 * @form 5626 */ 5627 /** 5628 * Define the horizontal offset size of shadow 5629 * 5630 * @type { ?(number | Resource) } 5631 * @syscap SystemCapability.ArkUI.ArkUI.Full 5632 * @crossplatform 5633 * @atomicservice 5634 * @since 11 5635 * @form 5636 */ 5637 offsetX?: number | Resource; 5638 5639 /** 5640 * Define the vertical offset size of shadow 5641 * 5642 * @type { ?(number | Resource) } 5643 * @syscap SystemCapability.ArkUI.ArkUI.Full 5644 * @since 7 5645 */ 5646 /** 5647 * Define the vertical offset size of shadow 5648 * 5649 * @type { ?(number | Resource) } 5650 * @syscap SystemCapability.ArkUI.ArkUI.Full 5651 * @since 9 5652 * @form 5653 */ 5654 /** 5655 * Define the vertical offset size of shadow 5656 * 5657 * @type { ?(number | Resource) } 5658 * @syscap SystemCapability.ArkUI.ArkUI.Full 5659 * @crossplatform 5660 * @since 10 5661 * @form 5662 */ 5663 /** 5664 * Define the vertical offset size of shadow 5665 * 5666 * @type { ?(number | Resource) } 5667 * @syscap SystemCapability.ArkUI.ArkUI.Full 5668 * @crossplatform 5669 * @atomicservice 5670 * @since 11 5671 * @form 5672 */ 5673 offsetY?: number | Resource; 5674 5675 /** 5676 * Define whether the shadow should fill the area 5677 * 5678 * @type { ?boolean } 5679 * @default false 5680 * @syscap SystemCapability.ArkUI.ArkUI.Full 5681 * @crossplatform 5682 * @since 11 5683 */ 5684 fill?: boolean; 5685} 5686 5687/** 5688 * enum Shadow style 5689 * 5690 * @enum { number } 5691 * @syscap SystemCapability.ArkUI.ArkUI.Full 5692 * @crossplatform 5693 * @since 10 5694 */ 5695/** 5696 * enum Shadow style 5697 * 5698 * @enum { number } 5699 * @syscap SystemCapability.ArkUI.ArkUI.Full 5700 * @crossplatform 5701 * @atomicservice 5702 * @since 11 5703 */ 5704declare enum ShadowStyle { 5705 /** 5706 * Defines the super small default shadow style. 5707 * 5708 * @syscap SystemCapability.ArkUI.ArkUI.Full 5709 * @crossplatform 5710 * @since 10 5711 */ 5712 /** 5713 * Defines the super small default shadow style. 5714 * 5715 * @syscap SystemCapability.ArkUI.ArkUI.Full 5716 * @crossplatform 5717 * @atomicservice 5718 * @since 11 5719 */ 5720 OUTER_DEFAULT_XS, 5721 5722 /** 5723 * Defines the small default shadow style. 5724 * 5725 * @syscap SystemCapability.ArkUI.ArkUI.Full 5726 * @crossplatform 5727 * @since 10 5728 */ 5729 /** 5730 * Defines the small default shadow style. 5731 * 5732 * @syscap SystemCapability.ArkUI.ArkUI.Full 5733 * @crossplatform 5734 * @atomicservice 5735 * @since 11 5736 */ 5737 OUTER_DEFAULT_SM, 5738 5739 /** 5740 * Defines the medium default shadow style. 5741 * 5742 * @syscap SystemCapability.ArkUI.ArkUI.Full 5743 * @crossplatform 5744 * @since 10 5745 */ 5746 /** 5747 * Defines the medium default shadow style. 5748 * 5749 * @syscap SystemCapability.ArkUI.ArkUI.Full 5750 * @crossplatform 5751 * @atomicservice 5752 * @since 11 5753 */ 5754 OUTER_DEFAULT_MD, 5755 5756 /** 5757 * Defines the large default shadow style. 5758 * 5759 * @syscap SystemCapability.ArkUI.ArkUI.Full 5760 * @crossplatform 5761 * @since 10 5762 */ 5763 /** 5764 * Defines the large default shadow style. 5765 * 5766 * @syscap SystemCapability.ArkUI.ArkUI.Full 5767 * @crossplatform 5768 * @atomicservice 5769 * @since 11 5770 */ 5771 OUTER_DEFAULT_LG, 5772 5773 /** 5774 * Defines the small floating shadow style. 5775 * 5776 * @syscap SystemCapability.ArkUI.ArkUI.Full 5777 * @crossplatform 5778 * @since 10 5779 */ 5780 /** 5781 * Defines the small floating shadow style. 5782 * 5783 * @syscap SystemCapability.ArkUI.ArkUI.Full 5784 * @crossplatform 5785 * @atomicservice 5786 * @since 11 5787 */ 5788 OUTER_FLOATING_SM, 5789 5790 /** 5791 * Defines the medium floating shadow style. 5792 * 5793 * @syscap SystemCapability.ArkUI.ArkUI.Full 5794 * @crossplatform 5795 * @since 10 5796 */ 5797 /** 5798 * Defines the medium floating shadow style. 5799 * 5800 * @syscap SystemCapability.ArkUI.ArkUI.Full 5801 * @crossplatform 5802 * @atomicservice 5803 * @since 11 5804 */ 5805 OUTER_FLOATING_MD, 5806} 5807 5808/** 5809 * Defines the options of Shadow. 5810 * 5811 * @interface MultiShadowOptions 5812 * @syscap SystemCapability.ArkUI.ArkUI.Full 5813 * @crossplatform 5814 * @since 10 5815 */ 5816/** 5817 * Defines the options of Shadow. 5818 * 5819 * @interface MultiShadowOptions 5820 * @syscap SystemCapability.ArkUI.ArkUI.Full 5821 * @crossplatform 5822 * @atomicservice 5823 * @since 11 5824 */ 5825declare interface MultiShadowOptions { 5826 /** 5827 * Current shadow radius. 5828 * 5829 * @type { ?(number | Resource) } 5830 * @default 5 5831 * @syscap SystemCapability.ArkUI.ArkUI.Full 5832 * @crossplatform 5833 * @since 10 5834 */ 5835 /** 5836 * Current shadow radius. 5837 * 5838 * @type { ?(number | Resource) } 5839 * @default 20 5840 * @syscap SystemCapability.ArkUI.ArkUI.Full 5841 * @crossplatform 5842 * @atomicservice 5843 * @since 11 5844 */ 5845 radius?: number | Resource; 5846 5847 /** 5848 * Current shadow offsetX. 5849 * 5850 * @type { ?(number | Resource) } 5851 * @default 5 5852 * @syscap SystemCapability.ArkUI.ArkUI.Full 5853 * @crossplatform 5854 * @since 10 5855 */ 5856 /** 5857 * Current shadow offsetX. 5858 * 5859 * @type { ?(number | Resource) } 5860 * @default 5 5861 * @syscap SystemCapability.ArkUI.ArkUI.Full 5862 * @crossplatform 5863 * @atomicservice 5864 * @since 11 5865 */ 5866 offsetX?: number | Resource; 5867 5868 /** 5869 * Current shadow offsetY 5870 * 5871 * @type { ?(number | Resource) } 5872 * @default 5 5873 * @syscap SystemCapability.ArkUI.ArkUI.Full 5874 * @crossplatform 5875 * @since 10 5876 */ 5877 /** 5878 * Current shadow offsetY 5879 * 5880 * @type { ?(number | Resource) } 5881 * @default 5 5882 * @syscap SystemCapability.ArkUI.ArkUI.Full 5883 * @crossplatform 5884 * @atomicservice 5885 * @since 11 5886 */ 5887 offsetY?: number | Resource; 5888} 5889 5890/** 5891 * Enumerates the safe area types. 5892 * 5893 * @enum { number } 5894 * @syscap SystemCapability.ArkUI.ArkUI.Full 5895 * @since 10 5896 */ 5897/** 5898 * Enumerates the safe area types. 5899 * 5900 * @enum { number } 5901 * @syscap SystemCapability.ArkUI.ArkUI.Full 5902 * @crossplatform 5903 * @atomicservice 5904 * @since 11 5905 */ 5906declare enum SafeAreaType { 5907 /** 5908 * Default area of the system, including the status bar and navigation bar. 5909 * 5910 * @syscap SystemCapability.ArkUI.ArkUI.Full 5911 * @since 10 5912 */ 5913 /** 5914 * Default area of the system, including the status bar and navigation bar. 5915 * 5916 * @syscap SystemCapability.ArkUI.ArkUI.Full 5917 * @crossplatform 5918 * @atomicservice 5919 * @since 11 5920 */ 5921 SYSTEM, 5922 5923 /** 5924 * Notch or punch hole. 5925 * 5926 * @syscap SystemCapability.ArkUI.ArkUI.Full 5927 * @since 10 5928 */ 5929 /** 5930 * Notch or punch hole. 5931 * 5932 * @syscap SystemCapability.ArkUI.ArkUI.Full 5933 * @crossplatform 5934 * @atomicservice 5935 * @since 11 5936 */ 5937 CUTOUT, 5938 5939 /** 5940 * Soft keyboard area. 5941 * 5942 * @syscap SystemCapability.ArkUI.ArkUI.Full 5943 * @since 10 5944 */ 5945 /** 5946 * Soft keyboard area. 5947 * 5948 * @syscap SystemCapability.ArkUI.ArkUI.Full 5949 * @crossplatform 5950 * @atomicservice 5951 * @since 11 5952 */ 5953 KEYBOARD 5954} 5955 5956/** 5957 * Enumerates the safe area edges. 5958 * 5959 * @enum { number } 5960 * @syscap SystemCapability.ArkUI.ArkUI.Full 5961 * @since 10 5962 */ 5963/** 5964 * Enumerates the safe area edges. 5965 * 5966 * @enum { number } 5967 * @syscap SystemCapability.ArkUI.ArkUI.Full 5968 * @crossplatform 5969 * @atomicservice 5970 * @since 11 5971 */ 5972declare enum SafeAreaEdge { 5973 /** 5974 * Top edge of the safe area. 5975 * 5976 * @syscap SystemCapability.ArkUI.ArkUI.Full 5977 * @since 10 5978 */ 5979 /** 5980 * Top edge of the safe area. 5981 * 5982 * @syscap SystemCapability.ArkUI.ArkUI.Full 5983 * @crossplatform 5984 * @atomicservice 5985 * @since 11 5986 */ 5987 TOP, 5988 5989 /** 5990 * Bottom edge of the safe area. 5991 * 5992 * @syscap SystemCapability.ArkUI.ArkUI.Full 5993 * @since 10 5994 */ 5995 /** 5996 * Bottom edge of the safe area. 5997 * 5998 * @syscap SystemCapability.ArkUI.ArkUI.Full 5999 * @crossplatform 6000 * @atomicservice 6001 * @since 11 6002 */ 6003 BOTTOM, 6004 6005 /** 6006 * Start edge of the safe area. 6007 * 6008 * @syscap SystemCapability.ArkUI.ArkUI.Full 6009 * @since 10 6010 */ 6011 /** 6012 * Start edge of the safe area. 6013 * 6014 * @syscap SystemCapability.ArkUI.ArkUI.Full 6015 * @crossplatform 6016 * @atomicservice 6017 * @since 11 6018 */ 6019 START, 6020 6021 /** 6022 * End edge of the safe area. 6023 * 6024 * @syscap SystemCapability.ArkUI.ArkUI.Full 6025 * @since 10 6026 */ 6027 /** 6028 * End edge of the safe area. 6029 * 6030 * @syscap SystemCapability.ArkUI.ArkUI.Full 6031 * @crossplatform 6032 * @atomicservice 6033 * @since 11 6034 */ 6035 END 6036} 6037 6038/** 6039 * Defines sheet size type. 6040 * 6041 * @enum { number } 6042 * @syscap SystemCapability.ArkUI.ArkUI.Full 6043 * @crossplatform 6044 * @since 10 6045 */ 6046/** 6047 * Defines sheet size type. 6048 * 6049 * @enum { number } 6050 * @syscap SystemCapability.ArkUI.ArkUI.Full 6051 * @crossplatform 6052 * @atomicservice 6053 * @since 11 6054 */ 6055declare enum SheetSize { 6056 /** 6057 * Defines the sheet size medium height type. The height is half the screen height 6058 * 6059 * @syscap SystemCapability.ArkUI.ArkUI.Full 6060 * @crossplatform 6061 * @since 10 6062 */ 6063 /** 6064 * Defines the sheet size medium height type. The height is half the screen height 6065 * 6066 * @syscap SystemCapability.ArkUI.ArkUI.Full 6067 * @crossplatform 6068 * @atomicservice 6069 * @since 11 6070 */ 6071 MEDIUM, 6072 6073 /** 6074 * Defines the sheet size large height type. The height is almost screen height. 6075 * 6076 * @syscap SystemCapability.ArkUI.ArkUI.Full 6077 * @crossplatform 6078 * @since 10 6079 */ 6080 /** 6081 * Defines the sheet size large height type. The height is almost screen height. 6082 * 6083 * @syscap SystemCapability.ArkUI.ArkUI.Full 6084 * @crossplatform 6085 * @atomicservice 6086 * @since 11 6087 */ 6088 LARGE, 6089 6090 /** 6091 * Defines the sheet size fit content height type. The height fit content. 6092 * 6093 * @syscap SystemCapability.ArkUI.ArkUI.Full 6094 * @crossplatform 6095 * @since 11 6096 */ 6097 FIT_CONTENT = 2, 6098} 6099 6100/** 6101 * Defines the base event. 6102 * 6103 * @interface BaseEvent 6104 * @syscap SystemCapability.ArkUI.ArkUI.Full 6105 * @since 8 6106 */ 6107/** 6108 * Defines the base event. 6109 * 6110 * @interface BaseEvent 6111 * @syscap SystemCapability.ArkUI.ArkUI.Full 6112 * @since 9 6113 * @form 6114 */ 6115/** 6116 * Defines the base event. 6117 * 6118 * @interface BaseEvent 6119 * @syscap SystemCapability.ArkUI.ArkUI.Full 6120 * @crossplatform 6121 * @since 10 6122 * @form 6123 */ 6124/** 6125 * Defines the base event. 6126 * 6127 * @interface BaseEvent 6128 * @syscap SystemCapability.ArkUI.ArkUI.Full 6129 * @crossplatform 6130 * @atomicservice 6131 * @since 11 6132 * @form 6133 */ 6134declare interface BaseEvent { 6135 /** 6136 * Defines the current target which fires this event. 6137 * 6138 * @type { EventTarget } 6139 * @syscap SystemCapability.ArkUI.ArkUI.Full 6140 * @since 8 6141 */ 6142 /** 6143 * Defines the current target which fires this event. 6144 * 6145 * @type { EventTarget } 6146 * @syscap SystemCapability.ArkUI.ArkUI.Full 6147 * @since 9 6148 * @form 6149 */ 6150 /** 6151 * Defines the current target which fires this event. 6152 * 6153 * @type { EventTarget } 6154 * @syscap SystemCapability.ArkUI.ArkUI.Full 6155 * @crossplatform 6156 * @since 10 6157 * @form 6158 */ 6159 /** 6160 * Defines the current target which fires this event. 6161 * 6162 * @type { EventTarget } 6163 * @syscap SystemCapability.ArkUI.ArkUI.Full 6164 * @crossplatform 6165 * @atomicservice 6166 * @since 11 6167 * @form 6168 */ 6169 target: EventTarget; 6170 6171 /** 6172 * Event timestamp. 6173 * 6174 * @type { number } 6175 * @syscap SystemCapability.ArkUI.ArkUI.Full 6176 * @since 8 6177 */ 6178 /** 6179 * Event timestamp. 6180 * 6181 * @type { number } 6182 * @syscap SystemCapability.ArkUI.ArkUI.Full 6183 * @since 9 6184 * @form 6185 */ 6186 /** 6187 * Event timestamp. 6188 * 6189 * @type { number } 6190 * @syscap SystemCapability.ArkUI.ArkUI.Full 6191 * @crossplatform 6192 * @since 10 6193 * @form 6194 */ 6195 /** 6196 * Event timestamp. 6197 * 6198 * @type { number } 6199 * @syscap SystemCapability.ArkUI.ArkUI.Full 6200 * @crossplatform 6201 * @atomicservice 6202 * @since 11 6203 * @form 6204 */ 6205 timestamp: number; 6206 6207 /** 6208 * the event source info. 6209 * 6210 * @type { SourceType } 6211 * @syscap SystemCapability.ArkUI.ArkUI.Full 6212 * @since 8 6213 */ 6214 /** 6215 * the event source info. 6216 * 6217 * @type { SourceType } 6218 * @syscap SystemCapability.ArkUI.ArkUI.Full 6219 * @since 9 6220 * @form 6221 */ 6222 /** 6223 * the event source info. 6224 * 6225 * @type { SourceType } 6226 * @syscap SystemCapability.ArkUI.ArkUI.Full 6227 * @crossplatform 6228 * @since 10 6229 * @form 6230 */ 6231 /** 6232 * the event source info. 6233 * 6234 * @type { SourceType } 6235 * @syscap SystemCapability.ArkUI.ArkUI.Full 6236 * @crossplatform 6237 * @atomicservice 6238 * @since 11 6239 * @form 6240 */ 6241 source: SourceType; 6242 6243 /** 6244 * Touch pressure. 6245 * 6246 * @type { number } 6247 * @syscap SystemCapability.ArkUI.ArkUI.Full 6248 * @since 9 6249 * @form 6250 */ 6251 /** 6252 * Touch pressure. 6253 * 6254 * @type { number } 6255 * @syscap SystemCapability.ArkUI.ArkUI.Full 6256 * @crossplatform 6257 * @since 10 6258 * @form 6259 */ 6260 /** 6261 * Touch pressure. 6262 * 6263 * @type { number } 6264 * @syscap SystemCapability.ArkUI.ArkUI.Full 6265 * @crossplatform 6266 * @atomicservice 6267 * @since 11 6268 * @form 6269 */ 6270 pressure: number; 6271 6272 /** 6273 * The angle between pencil projection on plane-X-Y and axis-Z. 6274 * 6275 * @type { number } 6276 * @syscap SystemCapability.ArkUI.ArkUI.Full 6277 * @since 9 6278 * @form 6279 */ 6280 /** 6281 * The angle between pencil projection on plane-X-Y and axis-Z. 6282 * 6283 * @type { number } 6284 * @syscap SystemCapability.ArkUI.ArkUI.Full 6285 * @crossplatform 6286 * @since 10 6287 * @form 6288 */ 6289 /** 6290 * The angle between pencil projection on plane-X-Y and axis-Z. 6291 * 6292 * @type { number } 6293 * @syscap SystemCapability.ArkUI.ArkUI.Full 6294 * @crossplatform 6295 * @atomicservice 6296 * @since 11 6297 * @form 6298 */ 6299 tiltX: number; 6300 6301 /** 6302 * The angle between pencil projection on plane-Y-Z and axis-Z. 6303 * 6304 * @type { number } 6305 * @syscap SystemCapability.ArkUI.ArkUI.Full 6306 * @since 9 6307 * @form 6308 */ 6309 /** 6310 * The angle between pencil projection on plane-Y-Z and axis-Z. 6311 * 6312 * @type { number } 6313 * @syscap SystemCapability.ArkUI.ArkUI.Full 6314 * @crossplatform 6315 * @since 10 6316 * @form 6317 */ 6318 /** 6319 * The angle between pencil projection on plane-Y-Z and axis-Z. 6320 * 6321 * @type { number } 6322 * @syscap SystemCapability.ArkUI.ArkUI.Full 6323 * @crossplatform 6324 * @atomicservice 6325 * @since 11 6326 * @form 6327 */ 6328 tiltY: number; 6329 6330 /** 6331 * The event tool type info. 6332 * 6333 * @type { SourceTool } 6334 * @syscap SystemCapability.ArkUI.ArkUI.Full 6335 * @since 9 6336 * @form 6337 */ 6338 /** 6339 * The event tool type info. 6340 * 6341 * @type { SourceTool } 6342 * @syscap SystemCapability.ArkUI.ArkUI.Full 6343 * @crossplatform 6344 * @since 10 6345 * @form 6346 */ 6347 /** 6348 * The event tool type info. 6349 * 6350 * @type { SourceTool } 6351 * @syscap SystemCapability.ArkUI.ArkUI.Full 6352 * @crossplatform 6353 * @atomicservice 6354 * @since 11 6355 * @form 6356 */ 6357 sourceTool: SourceTool; 6358} 6359 6360/** 6361 * Border image option 6362 * 6363 * @interface BorderImageOption 6364 * @syscap SystemCapability.ArkUI.ArkUI.Full 6365 * @since 9 6366 * @form 6367 */ 6368/** 6369 * Border image option 6370 * 6371 * @interface BorderImageOption 6372 * @syscap SystemCapability.ArkUI.ArkUI.Full 6373 * @crossplatform 6374 * @since 10 6375 * @form 6376 */ 6377/** 6378 * Border image option 6379 * 6380 * @interface BorderImageOption 6381 * @syscap SystemCapability.ArkUI.ArkUI.Full 6382 * @crossplatform 6383 * @atomicservice 6384 * @since 11 6385 * @form 6386 */ 6387declare interface BorderImageOption { 6388 /** 6389 * Border image slice 6390 * 6391 * @type { ?(Length | EdgeWidths) } 6392 * @syscap SystemCapability.ArkUI.ArkUI.Full 6393 * @since 9 6394 * @form 6395 */ 6396 /** 6397 * Border image slice 6398 * 6399 * @type { ?(Length | EdgeWidths) } 6400 * @syscap SystemCapability.ArkUI.ArkUI.Full 6401 * @crossplatform 6402 * @since 10 6403 * @form 6404 */ 6405 /** 6406 * Border image slice 6407 * 6408 * @type { ?(Length | EdgeWidths) } 6409 * @syscap SystemCapability.ArkUI.ArkUI.Full 6410 * @crossplatform 6411 * @atomicservice 6412 * @since 11 6413 * @form 6414 */ 6415 slice?: Length | EdgeWidths, 6416 6417 /** 6418 * Border image repeat 6419 * 6420 * @type { ?RepeatMode } 6421 * @syscap SystemCapability.ArkUI.ArkUI.Full 6422 * @since 9 6423 * @form 6424 */ 6425 /** 6426 * Border image repeat 6427 * 6428 * @type { ?RepeatMode } 6429 * @syscap SystemCapability.ArkUI.ArkUI.Full 6430 * @crossplatform 6431 * @since 10 6432 * @form 6433 */ 6434 /** 6435 * Border image repeat 6436 * 6437 * @type { ?RepeatMode } 6438 * @syscap SystemCapability.ArkUI.ArkUI.Full 6439 * @crossplatform 6440 * @atomicservice 6441 * @since 11 6442 * @form 6443 */ 6444 repeat?: RepeatMode, 6445 6446 /** 6447 * Border image source 6448 * 6449 * @type { ?(string | Resource | LinearGradient) } 6450 * @syscap SystemCapability.ArkUI.ArkUI.Full 6451 * @since 9 6452 * @form 6453 */ 6454 /** 6455 * Border image source 6456 * 6457 * @type { ?(string | Resource | LinearGradient) } 6458 * @syscap SystemCapability.ArkUI.ArkUI.Full 6459 * @crossplatform 6460 * @since 10 6461 * @form 6462 */ 6463 /** 6464 * Border image source 6465 * 6466 * @type { ?(string | Resource | LinearGradient) } 6467 * @syscap SystemCapability.ArkUI.ArkUI.Full 6468 * @crossplatform 6469 * @atomicservice 6470 * @since 11 6471 * @form 6472 */ 6473 source?: string | Resource | LinearGradient, 6474 6475 /** 6476 * Border image width 6477 * 6478 * @type { ?(Length | EdgeWidths) } 6479 * @syscap SystemCapability.ArkUI.ArkUI.Full 6480 * @since 9 6481 * @form 6482 */ 6483 /** 6484 * Border image width 6485 * 6486 * @type { ?(Length | EdgeWidths) } 6487 * @syscap SystemCapability.ArkUI.ArkUI.Full 6488 * @crossplatform 6489 * @since 10 6490 * @form 6491 */ 6492 /** 6493 * Border image width 6494 * 6495 * @type { ?(Length | EdgeWidths) } 6496 * @syscap SystemCapability.ArkUI.ArkUI.Full 6497 * @crossplatform 6498 * @atomicservice 6499 * @since 11 6500 * @form 6501 */ 6502 width?: Length | EdgeWidths, 6503 6504 /** 6505 * Border image outset 6506 * 6507 * @type { ?(Length | EdgeWidths) } 6508 * @syscap SystemCapability.ArkUI.ArkUI.Full 6509 * @since 9 6510 * @form 6511 */ 6512 /** 6513 * Border image outset 6514 * 6515 * @type { ?(Length | EdgeWidths) } 6516 * @syscap SystemCapability.ArkUI.ArkUI.Full 6517 * @crossplatform 6518 * @since 10 6519 * @form 6520 */ 6521 /** 6522 * Border image outset 6523 * 6524 * @type { ?(Length | EdgeWidths) } 6525 * @syscap SystemCapability.ArkUI.ArkUI.Full 6526 * @crossplatform 6527 * @atomicservice 6528 * @since 11 6529 * @form 6530 */ 6531 outset?: Length | EdgeWidths, 6532 6533 /** 6534 * Border image center fill 6535 * 6536 * @type { ?boolean } 6537 * @syscap SystemCapability.ArkUI.ArkUI.Full 6538 * @since 9 6539 * @form 6540 */ 6541 /** 6542 * Border image center fill 6543 * 6544 * @type { ?boolean } 6545 * @syscap SystemCapability.ArkUI.ArkUI.Full 6546 * @crossplatform 6547 * @since 10 6548 * @form 6549 */ 6550 /** 6551 * Border image center fill 6552 * 6553 * @type { ?boolean } 6554 * @syscap SystemCapability.ArkUI.ArkUI.Full 6555 * @crossplatform 6556 * @atomicservice 6557 * @since 11 6558 * @form 6559 */ 6560 fill?: boolean 6561} 6562 6563/** 6564 * The tap action triggers this method invocation. 6565 * 6566 * @interface ClickEvent 6567 * @syscap SystemCapability.ArkUI.ArkUI.Full 6568 * @since 7 6569 */ 6570/** 6571 * The tap action triggers this method invocation. 6572 * 6573 * @interface ClickEvent 6574 * @syscap SystemCapability.ArkUI.ArkUI.Full 6575 * @since 9 6576 * @form 6577 */ 6578/** 6579 * The tap action triggers this method invocation. 6580 * 6581 * @interface ClickEvent 6582 * @syscap SystemCapability.ArkUI.ArkUI.Full 6583 * @crossplatform 6584 * @since 10 6585 * @form 6586 */ 6587/** 6588 * The tap action triggers this method invocation. 6589 * 6590 * @interface ClickEvent 6591 * @syscap SystemCapability.ArkUI.ArkUI.Full 6592 * @crossplatform 6593 * @atomicservice 6594 * @since 11 6595 * @form 6596 */ 6597declare interface ClickEvent extends BaseEvent { 6598 /** 6599 * X coordinate of the click point relative to the left edge of the device screen. 6600 * 6601 * @type { number } 6602 * @syscap SystemCapability.ArkUI.ArkUI.Full 6603 * @crossplatform 6604 * @since 10 6605 */ 6606 /** 6607 * X coordinate of the click point relative to the left edge of the device screen. 6608 * 6609 * @type { number } 6610 * @syscap SystemCapability.ArkUI.ArkUI.Full 6611 * @crossplatform 6612 * @atomicservice 6613 * @since 11 6614 */ 6615 displayX: number; 6616 6617 /** 6618 * Y coordinate of the click point relative to the upper edge of the device screen. 6619 * 6620 * @type { number } 6621 * @syscap SystemCapability.ArkUI.ArkUI.Full 6622 * @crossplatform 6623 * @since 10 6624 */ 6625 /** 6626 * Y coordinate of the click point relative to the upper edge of the device screen. 6627 * 6628 * @type { number } 6629 * @syscap SystemCapability.ArkUI.ArkUI.Full 6630 * @crossplatform 6631 * @atomicservice 6632 * @since 11 6633 */ 6634 displayY: number; 6635 6636 /** 6637 * X coordinate of the click point relative to the left edge of the current window. 6638 * 6639 * @type { number } 6640 * @syscap SystemCapability.ArkUI.ArkUI.Full 6641 * @crossplatform 6642 * @since 10 6643 */ 6644 /** 6645 * X coordinate of the click point relative to the left edge of the current window. 6646 * 6647 * @type { number } 6648 * @syscap SystemCapability.ArkUI.ArkUI.Full 6649 * @crossplatform 6650 * @atomicservice 6651 * @since 11 6652 */ 6653 windowX: number; 6654 6655 /** 6656 * Y coordinate of the click point relative to the upper edge of the current window. 6657 * 6658 * @type { number } 6659 * @syscap SystemCapability.ArkUI.ArkUI.Full 6660 * @crossplatform 6661 * @since 10 6662 */ 6663 /** 6664 * Y coordinate of the click point relative to the upper edge of the current window. 6665 * 6666 * @type { number } 6667 * @syscap SystemCapability.ArkUI.ArkUI.Full 6668 * @crossplatform 6669 * @atomicservice 6670 * @since 11 6671 */ 6672 windowY: number; 6673 6674 /** 6675 * X coordinate of the click point relative to the left edge of the current window. 6676 * 6677 * @type { number } 6678 * @syscap SystemCapability.ArkUI.ArkUI.Full 6679 * @since 7 6680 * @deprecated since 10 6681 * @useinstead ClickEvent#windowX 6682 */ 6683 screenX: number; 6684 6685 /** 6686 * Y coordinate of the click point relative to the upper edge of the current window. 6687 * 6688 * @type { number } 6689 * @syscap SystemCapability.ArkUI.ArkUI.Full 6690 * @since 7 6691 * @deprecated since 10 6692 * @useinstead ClickEvent#windowY 6693 */ 6694 screenY: number; 6695 6696 /** 6697 * X coordinate of the click point relative to the left edge of the clicked element. 6698 * 6699 * @type { number } 6700 * @syscap SystemCapability.ArkUI.ArkUI.Full 6701 * @since 7 6702 */ 6703 /** 6704 * X coordinate of the click point relative to the left edge of the clicked element. 6705 * 6706 * @type { number } 6707 * @syscap SystemCapability.ArkUI.ArkUI.Full 6708 * @since 9 6709 * @form 6710 */ 6711 /** 6712 * X coordinate of the click point relative to the left edge of the clicked element. 6713 * 6714 * @type { number } 6715 * @syscap SystemCapability.ArkUI.ArkUI.Full 6716 * @crossplatform 6717 * @since 10 6718 * @form 6719 */ 6720 /** 6721 * X coordinate of the click point relative to the left edge of the clicked element. 6722 * 6723 * @type { number } 6724 * @syscap SystemCapability.ArkUI.ArkUI.Full 6725 * @crossplatform 6726 * @atomicservice 6727 * @since 11 6728 * @form 6729 */ 6730 x: number; 6731 6732 /** 6733 * Y coordinate of the click point relative to the upper edge of the clicked element. 6734 * 6735 * @type { number } 6736 * @syscap SystemCapability.ArkUI.ArkUI.Full 6737 * @since 7 6738 */ 6739 /** 6740 * Y coordinate of the click point relative to the left edge of the clicked element. 6741 * 6742 * @type { number } 6743 * @syscap SystemCapability.ArkUI.ArkUI.Full 6744 * @since 9 6745 * @form 6746 */ 6747 /** 6748 * Y coordinate of the click point relative to the left edge of the clicked element. 6749 * 6750 * @type { number } 6751 * @syscap SystemCapability.ArkUI.ArkUI.Full 6752 * @crossplatform 6753 * @since 10 6754 * @form 6755 */ 6756 /** 6757 * Y coordinate of the click point relative to the left edge of the clicked element. 6758 * 6759 * @type { number } 6760 * @syscap SystemCapability.ArkUI.ArkUI.Full 6761 * @crossplatform 6762 * @atomicservice 6763 * @since 11 6764 * @form 6765 */ 6766 y: number; 6767} 6768 6769/** 6770 * The hover action triggers this method invocation. 6771 * 6772 * @interface HoverEvent 6773 * @syscap SystemCapability.ArkUI.ArkUI.Full 6774 * @since 10 6775 */ 6776/** 6777 * The hover action triggers this method invocation. 6778 * 6779 * @interface HoverEvent 6780 * @syscap SystemCapability.ArkUI.ArkUI.Full 6781 * @atomicservice 6782 * @since 11 6783 */ 6784declare interface HoverEvent extends BaseEvent { 6785 /** 6786 * The blocking hover event pops up. 6787 * 6788 * @type { function } 6789 * @syscap SystemCapability.ArkUI.ArkUI.Full 6790 * @since 10 6791 */ 6792 /** 6793 * The blocking hover event pops up. 6794 * 6795 * @type { function } 6796 * @syscap SystemCapability.ArkUI.ArkUI.Full 6797 * @atomicservice 6798 * @since 11 6799 */ 6800 stopPropagation: () => void; 6801} 6802 6803/** 6804 * The mouse click action triggers this method invocation. 6805 * 6806 * @interface MouseEvent 6807 * @syscap SystemCapability.ArkUI.ArkUI.Full 6808 * @since 8 6809 */ 6810/** 6811 * The mouse click action triggers this method invocation. 6812 * 6813 * @interface MouseEvent 6814 * @syscap SystemCapability.ArkUI.ArkUI.Full 6815 * @atomicservice 6816 * @since 11 6817 */ 6818declare interface MouseEvent extends BaseEvent { 6819 /** 6820 * Mouse button of the click event. 6821 * 6822 * @type { MouseButton } 6823 * @syscap SystemCapability.ArkUI.ArkUI.Full 6824 * @since 8 6825 */ 6826 /** 6827 * Mouse button of the click event. 6828 * 6829 * @type { MouseButton } 6830 * @syscap SystemCapability.ArkUI.ArkUI.Full 6831 * @atomicservice 6832 * @since 11 6833 */ 6834 button: MouseButton; 6835 6836 /** 6837 * Mouse action of the click event. 6838 * 6839 * @type { MouseAction } 6840 * @syscap SystemCapability.ArkUI.ArkUI.Full 6841 * @since 8 6842 */ 6843 /** 6844 * Mouse action of the click event. 6845 * 6846 * @type { MouseAction } 6847 * @syscap SystemCapability.ArkUI.ArkUI.Full 6848 * @atomicservice 6849 * @since 11 6850 */ 6851 action: MouseAction; 6852 6853 /** 6854 * X coordinate of the mouse point relative to the left edge of the device screen. 6855 * 6856 * @type { number } 6857 * @syscap SystemCapability.ArkUI.ArkUI.Full 6858 * @since 10 6859 */ 6860 /** 6861 * X coordinate of the mouse point relative to the left edge of the device screen. 6862 * 6863 * @type { number } 6864 * @syscap SystemCapability.ArkUI.ArkUI.Full 6865 * @atomicservice 6866 * @since 11 6867 */ 6868 displayX: number; 6869 6870 /** 6871 * Y coordinate of the mouse point relative to the upper edge of the device screen. 6872 * 6873 * @type { number } 6874 * @syscap SystemCapability.ArkUI.ArkUI.Full 6875 * @since 10 6876 */ 6877 /** 6878 * Y coordinate of the mouse point relative to the upper edge of the device screen. 6879 * 6880 * @type { number } 6881 * @syscap SystemCapability.ArkUI.ArkUI.Full 6882 * @atomicservice 6883 * @since 11 6884 */ 6885 displayY: number; 6886 6887 /** 6888 * X coordinate of the mouse point relative to the left edge of the current window. 6889 * 6890 * @type { number } 6891 * @syscap SystemCapability.ArkUI.ArkUI.Full 6892 * @since 10 6893 */ 6894 /** 6895 * X coordinate of the mouse point relative to the left edge of the current window. 6896 * 6897 * @type { number } 6898 * @syscap SystemCapability.ArkUI.ArkUI.Full 6899 * @atomicservice 6900 * @since 11 6901 */ 6902 windowX: number; 6903 6904 /** 6905 * Y coordinate of the mouse point relative to the upper edge of the current window. 6906 * 6907 * @type { number } 6908 * @syscap SystemCapability.ArkUI.ArkUI.Full 6909 * @since 10 6910 */ 6911 /** 6912 * Y coordinate of the mouse point relative to the upper edge of the current window. 6913 * 6914 * @type { number } 6915 * @syscap SystemCapability.ArkUI.ArkUI.Full 6916 * @atomicservice 6917 * @since 11 6918 */ 6919 windowY: number; 6920 6921 /** 6922 * X coordinate of the mouse point relative to the left edge of the current window. 6923 * 6924 * @type { number } 6925 * @syscap SystemCapability.ArkUI.ArkUI.Full 6926 * @since 8 6927 * @deprecated since 10 6928 * @useinstead MouseEvent#windowX 6929 */ 6930 screenX: number; 6931 6932 /** 6933 * Y coordinate of the mouse point relative to the upper edge of the current window. 6934 * 6935 * @type { number } 6936 * @syscap SystemCapability.ArkUI.ArkUI.Full 6937 * @since 8 6938 * @deprecated since 10 6939 * @useinstead MouseEvent#windowY 6940 */ 6941 screenY: number; 6942 6943 /** 6944 * X coordinate of the mouse point relative to the left edge of the mouse hit element. 6945 * 6946 * @type { number } 6947 * @syscap SystemCapability.ArkUI.ArkUI.Full 6948 * @since 8 6949 */ 6950 /** 6951 * X coordinate of the mouse point relative to the left edge of the mouse hit element. 6952 * 6953 * @type { number } 6954 * @syscap SystemCapability.ArkUI.ArkUI.Full 6955 * @atomicservice 6956 * @since 11 6957 */ 6958 x: number; 6959 6960 /** 6961 * Y coordinate of the mouse point relative to the upper edge of the mouse hit element. 6962 * 6963 * @type { number } 6964 * @syscap SystemCapability.ArkUI.ArkUI.Full 6965 * @since 8 6966 */ 6967 /** 6968 * Y coordinate of the mouse point relative to the upper edge of the mouse hit element. 6969 * 6970 * @type { number } 6971 * @syscap SystemCapability.ArkUI.ArkUI.Full 6972 * @atomicservice 6973 * @since 11 6974 */ 6975 y: number; 6976 6977 /** 6978 * The blocking event pops up. 6979 * 6980 * @type { function } 6981 * @syscap SystemCapability.ArkUI.ArkUI.Full 6982 * @since 8 6983 */ 6984 /** 6985 * The blocking event pops up. 6986 * 6987 * @type { function } 6988 * @syscap SystemCapability.ArkUI.ArkUI.Full 6989 * @atomicservice 6990 * @since 11 6991 */ 6992 stopPropagation: () => void; 6993} 6994 6995/** 6996 * Type of the touch event. 6997 * 6998 * @interface TouchObject 6999 * @syscap SystemCapability.ArkUI.ArkUI.Full 7000 * @since 7 7001 */ 7002/** 7003 * Type of the touch event. 7004 * 7005 * @interface TouchObject 7006 * @syscap SystemCapability.ArkUI.ArkUI.Full 7007 * @crossplatform 7008 * @since 10 7009 */ 7010/** 7011 * Type of the touch event. 7012 * 7013 * @interface TouchObject 7014 * @syscap SystemCapability.ArkUI.ArkUI.Full 7015 * @crossplatform 7016 * @atomicservice 7017 * @since 11 7018 */ 7019declare interface TouchObject { 7020 /** 7021 * Type of the touch event. 7022 * 7023 * @type { TouchType } 7024 * @syscap SystemCapability.ArkUI.ArkUI.Full 7025 * @since 7 7026 */ 7027 /** 7028 * Type of the touch event. 7029 * 7030 * @type { TouchType } 7031 * @syscap SystemCapability.ArkUI.ArkUI.Full 7032 * @crossplatform 7033 * @since 10 7034 */ 7035 /** 7036 * Type of the touch event. 7037 * 7038 * @type { TouchType } 7039 * @syscap SystemCapability.ArkUI.ArkUI.Full 7040 * @crossplatform 7041 * @atomicservice 7042 * @since 11 7043 */ 7044 type: TouchType; 7045 7046 /** 7047 * Finger unique identifier. 7048 * 7049 * @type { number } 7050 * @syscap SystemCapability.ArkUI.ArkUI.Full 7051 * @since 7 7052 */ 7053 /** 7054 * Finger unique identifier. 7055 * 7056 * @type { number } 7057 * @syscap SystemCapability.ArkUI.ArkUI.Full 7058 * @crossplatform 7059 * @since 10 7060 */ 7061 /** 7062 * Finger unique identifier. 7063 * 7064 * @type { number } 7065 * @syscap SystemCapability.ArkUI.ArkUI.Full 7066 * @crossplatform 7067 * @atomicservice 7068 * @since 11 7069 */ 7070 id: number; 7071 7072 /** 7073 * X coordinate of the touch point relative to the left edge of the device screen. 7074 * 7075 * @type { number } 7076 * @syscap SystemCapability.ArkUI.ArkUI.Full 7077 * @crossplatform 7078 * @since 10 7079 */ 7080 /** 7081 * X coordinate of the touch point relative to the left edge of the device screen. 7082 * 7083 * @type { number } 7084 * @syscap SystemCapability.ArkUI.ArkUI.Full 7085 * @crossplatform 7086 * @atomicservice 7087 * @since 11 7088 */ 7089 displayX: number; 7090 7091 /** 7092 * Y coordinate of the touch point relative to the upper edge of the device screen. 7093 * 7094 * @type { number } 7095 * @syscap SystemCapability.ArkUI.ArkUI.Full 7096 * @crossplatform 7097 * @since 10 7098 */ 7099 /** 7100 * Y coordinate of the touch point relative to the upper edge of the device screen. 7101 * 7102 * @type { number } 7103 * @syscap SystemCapability.ArkUI.ArkUI.Full 7104 * @crossplatform 7105 * @atomicservice 7106 * @since 11 7107 */ 7108 displayY: number; 7109 7110 /** 7111 * X coordinate of the touch point relative to the left edge of the current window. 7112 * 7113 * @type { number } 7114 * @syscap SystemCapability.ArkUI.ArkUI.Full 7115 * @crossplatform 7116 * @since 10 7117 */ 7118 /** 7119 * X coordinate of the touch point relative to the left edge of the current window. 7120 * 7121 * @type { number } 7122 * @syscap SystemCapability.ArkUI.ArkUI.Full 7123 * @crossplatform 7124 * @atomicservice 7125 * @since 11 7126 */ 7127 windowX: number; 7128 7129 /** 7130 * Y coordinate of the touch point relative to the upper edge of the current window. 7131 * 7132 * @type { number } 7133 * @syscap SystemCapability.ArkUI.ArkUI.Full 7134 * @crossplatform 7135 * @since 10 7136 */ 7137 /** 7138 * Y coordinate of the touch point relative to the upper edge of the current window. 7139 * 7140 * @type { number } 7141 * @syscap SystemCapability.ArkUI.ArkUI.Full 7142 * @crossplatform 7143 * @atomicservice 7144 * @since 11 7145 */ 7146 windowY: number; 7147 7148 /** 7149 * X coordinate of the touch point relative to the left edge of the current window. 7150 * 7151 * @type { number } 7152 * @syscap SystemCapability.ArkUI.ArkUI.Full 7153 * @since 7 7154 * @deprecated since 10 7155 * @useinstead TouchObject#windowX 7156 */ 7157 screenX: number; 7158 7159 /** 7160 * Y coordinate of the touch point relative to the upper edge of the current window. 7161 * 7162 * @type { number } 7163 * @syscap SystemCapability.ArkUI.ArkUI.Full 7164 * @since 7 7165 * @deprecated since 10 7166 * @useinstead TouchObject#windowY 7167 */ 7168 screenY: number; 7169 7170 /** 7171 * X coordinate of the touch point relative to the left edge of the touched element. 7172 * 7173 * @type { number } 7174 * @syscap SystemCapability.ArkUI.ArkUI.Full 7175 * @since 7 7176 */ 7177 /** 7178 * X coordinate of the touch point relative to the left edge of the touched element. 7179 * 7180 * @type { number } 7181 * @syscap SystemCapability.ArkUI.ArkUI.Full 7182 * @crossplatform 7183 * @since 10 7184 */ 7185 /** 7186 * X coordinate of the touch point relative to the left edge of the touched element. 7187 * 7188 * @type { number } 7189 * @syscap SystemCapability.ArkUI.ArkUI.Full 7190 * @crossplatform 7191 * @atomicservice 7192 * @since 11 7193 */ 7194 x: number; 7195 7196 /** 7197 * Y coordinate of the touch point relative to the upper edge of the touched element. 7198 * 7199 * @type { number } 7200 * @syscap SystemCapability.ArkUI.ArkUI.Full 7201 * @since 7 7202 */ 7203 /** 7204 * Y coordinate of the touch point relative to the upper edge of the touched element. 7205 * 7206 * @type { number } 7207 * @syscap SystemCapability.ArkUI.ArkUI.Full 7208 * @crossplatform 7209 * @since 10 7210 */ 7211 /** 7212 * Y coordinate of the touch point relative to the upper edge of the touched element. 7213 * 7214 * @type { number } 7215 * @syscap SystemCapability.ArkUI.ArkUI.Full 7216 * @crossplatform 7217 * @atomicservice 7218 * @since 11 7219 */ 7220 y: number; 7221} 7222 7223/** 7224 * TouchObject getHistoricalPoints Function Parameters 7225 * 7226 * @interface HistoricalPoint 7227 * @syscap SystemCapability.ArkUI.ArkUI.Full 7228 * @crossplatform 7229 * @since 10 7230 */ 7231/** 7232 * TouchObject getHistoricalPoints Function Parameters 7233 * 7234 * @interface HistoricalPoint 7235 * @syscap SystemCapability.ArkUI.ArkUI.Full 7236 * @crossplatform 7237 * @atomicservice 7238 * @since 11 7239 */ 7240declare interface HistoricalPoint { 7241 /** 7242 * The base touchObject information of historicalPoint 7243 * 7244 * @type { TouchObject } 7245 * @syscap SystemCapability.ArkUI.ArkUI.Full 7246 * @crossplatform 7247 * @since 10 7248 */ 7249 /** 7250 * The base touchObject information of historicalPoint 7251 * 7252 * @type { TouchObject } 7253 * @syscap SystemCapability.ArkUI.ArkUI.Full 7254 * @crossplatform 7255 * @atomicservice 7256 * @since 11 7257 */ 7258 touchObject: TouchObject; 7259 7260 /** 7261 * Contact area between the finger pad and the screen. 7262 * 7263 * @type { number } 7264 * @syscap SystemCapability.ArkUI.ArkUI.Full 7265 * @crossplatform 7266 * @since 10 7267 */ 7268 /** 7269 * Contact area between the finger pad and the screen. 7270 * 7271 * @type { number } 7272 * @syscap SystemCapability.ArkUI.ArkUI.Full 7273 * @crossplatform 7274 * @atomicservice 7275 * @since 11 7276 */ 7277 size: number; 7278 7279 /** 7280 * Pressure of the touch event. 7281 * 7282 * @type { number } 7283 * @syscap SystemCapability.ArkUI.ArkUI.Full 7284 * @crossplatform 7285 * @since 10 7286 */ 7287 /** 7288 * Pressure of the touch event. 7289 * 7290 * @type { number } 7291 * @syscap SystemCapability.ArkUI.ArkUI.Full 7292 * @crossplatform 7293 * @atomicservice 7294 * @since 11 7295 */ 7296 force: number; 7297 7298 /** 7299 * Timestamp of the touch event. 7300 * 7301 * @type { number } 7302 * @syscap SystemCapability.ArkUI.ArkUI.Full 7303 * @crossplatform 7304 * @since 10 7305 */ 7306 /** 7307 * Timestamp of the touch event. 7308 * 7309 * @type { number } 7310 * @syscap SystemCapability.ArkUI.ArkUI.Full 7311 * @crossplatform 7312 * @atomicservice 7313 * @since 11 7314 */ 7315 timestamp: number; 7316} 7317 7318/** 7319 * Touch Action Function Parameters 7320 * 7321 * @interface TouchEvent 7322 * @syscap SystemCapability.ArkUI.ArkUI.Full 7323 * @since 7 7324 */ 7325/** 7326 * Touch Action Function Parameters 7327 * 7328 * @interface TouchEvent 7329 * @syscap SystemCapability.ArkUI.ArkUI.Full 7330 * @crossplatform 7331 * @since 10 7332 */ 7333/** 7334 * Touch Action Function Parameters 7335 * 7336 * @interface TouchEvent 7337 * @syscap SystemCapability.ArkUI.ArkUI.Full 7338 * @crossplatform 7339 * @atomicservice 7340 * @since 11 7341 */ 7342declare interface TouchEvent extends BaseEvent { 7343 /** 7344 * Type of the touch event. 7345 * 7346 * @type { TouchType } 7347 * @syscap SystemCapability.ArkUI.ArkUI.Full 7348 * @since 7 7349 */ 7350 /** 7351 * Type of the touch event. 7352 * 7353 * @type { TouchType } 7354 * @syscap SystemCapability.ArkUI.ArkUI.Full 7355 * @crossplatform 7356 * @since 10 7357 */ 7358 /** 7359 * Type of the touch event. 7360 * 7361 * @type { TouchType } 7362 * @syscap SystemCapability.ArkUI.ArkUI.Full 7363 * @crossplatform 7364 * @atomicservice 7365 * @since 11 7366 */ 7367 type: TouchType; 7368 7369 /** 7370 * All finger information. 7371 * 7372 * @type { TouchObject[] } 7373 * @syscap SystemCapability.ArkUI.ArkUI.Full 7374 * @since 7 7375 */ 7376 /** 7377 * All finger information. 7378 * 7379 * @type { TouchObject[] } 7380 * @syscap SystemCapability.ArkUI.ArkUI.Full 7381 * @crossplatform 7382 * @since 10 7383 */ 7384 /** 7385 * All finger information. 7386 * 7387 * @type { TouchObject[] } 7388 * @syscap SystemCapability.ArkUI.ArkUI.Full 7389 * @crossplatform 7390 * @atomicservice 7391 * @since 11 7392 */ 7393 touches: TouchObject[]; 7394 7395 /** 7396 * Indicates the current changed finger information. 7397 * 7398 * @type { TouchObject[] } 7399 * @syscap SystemCapability.ArkUI.ArkUI.Full 7400 * @since 7 7401 */ 7402 /** 7403 * Indicates the current changed finger information. 7404 * 7405 * @type { TouchObject[] } 7406 * @syscap SystemCapability.ArkUI.ArkUI.Full 7407 * @crossplatform 7408 * @since 10 7409 */ 7410 /** 7411 * Indicates the current changed finger information. 7412 * 7413 * @type { TouchObject[] } 7414 * @syscap SystemCapability.ArkUI.ArkUI.Full 7415 * @crossplatform 7416 * @atomicservice 7417 * @since 11 7418 */ 7419 changedTouches: TouchObject[]; 7420 7421 /** 7422 * The blocking event pops up. 7423 * 7424 * @type { function } 7425 * @syscap SystemCapability.ArkUI.ArkUI.Full 7426 * @since 7 7427 */ 7428 /** 7429 * The blocking event pops up. 7430 * 7431 * @type { function } 7432 * @syscap SystemCapability.ArkUI.ArkUI.Full 7433 * @crossplatform 7434 * @since 10 7435 */ 7436 /** 7437 * The blocking event pops up. 7438 * 7439 * @type { function } 7440 * @syscap SystemCapability.ArkUI.ArkUI.Full 7441 * @crossplatform 7442 * @atomicservice 7443 * @since 11 7444 */ 7445 stopPropagation: () => void; 7446 7447 /** 7448 * Get the historical points. 7449 * 7450 * @returns { Array<HistoricalPoint> } - return all historical points. 7451 * @syscap SystemCapability.ArkUI.ArkUI.Full 7452 * @crossplatform 7453 * @since 10 7454 */ 7455 /** 7456 * Get the historical points. 7457 * 7458 * @returns { Array<HistoricalPoint> } - return all historical points. 7459 * @syscap SystemCapability.ArkUI.ArkUI.Full 7460 * @crossplatform 7461 * @atomicservice 7462 * @since 11 7463 */ 7464 getHistoricalPoints(): Array<HistoricalPoint>; 7465} 7466 7467/** 7468 * Defines the PixelMap type object for ui component. 7469 * 7470 * @syscap SystemCapability.ArkUI.ArkUI.Full 7471 * @since 7 7472 */ 7473/** 7474 * Defines the PixelMap type object for ui component. 7475 * 7476 * @syscap SystemCapability.ArkUI.ArkUI.Full 7477 * @crossplatform 7478 * @since 10 7479 */ 7480/** 7481 * Defines the PixelMap type object for ui component. 7482 * 7483 * @syscap SystemCapability.ArkUI.ArkUI.Full 7484 * @crossplatform 7485 * @atomicservice 7486 * @since 11 7487 */ 7488declare type PixelMap = import('../api/@ohos.multimedia.image').default.PixelMap; 7489 7490/** 7491 * pixelmap object with release function. 7492 * 7493 * @interface PixelMapMock 7494 * @syscap SystemCapability.ArkUI.ArkUI.Full 7495 * @systemapi 7496 * @since 7 7497 */ 7498declare interface PixelMapMock { 7499 /** 7500 * release function. 7501 * 7502 * @syscap SystemCapability.ArkUI.ArkUI.Full 7503 * @systemapi 7504 * @since 7 7505 */ 7506 release(): void; 7507} 7508 7509/** 7510 * Enum for Drag Behavior. 7511 * 7512 * @enum { number } 7513 * @syscap SystemCapability.ArkUI.ArkUI.Full 7514 * @since 10 7515 */ 7516/** 7517 * Enum for Drag Behavior. 7518 * 7519 * @enum { number } 7520 * @syscap SystemCapability.ArkUI.ArkUI.Full 7521 * @atomicservice 7522 * @since 11 7523 */ 7524declare enum DragBehavior { 7525 /** 7526 * If drag use copy event, then set DragBehavior.COPY. 7527 * 7528 * @syscap SystemCapability.ArkUI.ArkUI.Full 7529 * @since 10 7530 */ 7531 /** 7532 * If drag use copy event, then set DragBehavior.COPY. 7533 * 7534 * @syscap SystemCapability.ArkUI.ArkUI.Full 7535 * @atomicservice 7536 * @since 11 7537 */ 7538 COPY, 7539 /** 7540 * If drag use move event, then set DragBehavior.MOVE. 7541 * 7542 * @syscap SystemCapability.ArkUI.ArkUI.Full 7543 * @since 10 7544 */ 7545 /** 7546 * If drag use move event, then set DragBehavior.MOVE. 7547 * 7548 * @syscap SystemCapability.ArkUI.ArkUI.Full 7549 * @atomicservice 7550 * @since 11 7551 */ 7552 MOVE 7553} 7554 7555/** 7556 * Import the UnifiedData type object for ui component. 7557 * 7558 * @syscap SystemCapability.ArkUI.ArkUI.Full 7559 * @crossplatform 7560 * @since 10 7561 */ 7562/** 7563 * Import the UnifiedData type object for ui component. 7564 * 7565 * @syscap SystemCapability.ArkUI.ArkUI.Full 7566 * @crossplatform 7567 * @atomicservice 7568 * @since 11 7569 */ 7570declare type UnifiedData = import('../api/@ohos.data.unifiedDataChannel').default.UnifiedData; 7571 7572/** 7573 * Import the Summary type object for ui component. 7574 * 7575 * @syscap SystemCapability.ArkUI.ArkUI.Full 7576 * @since 10 7577 */ 7578/** 7579 * Import the Summary type object for ui component. 7580 * 7581 * @syscap SystemCapability.ArkUI.ArkUI.Full 7582 * @atomicservice 7583 * @since 11 7584 */ 7585declare type Summary = import('../api/@ohos.data.unifiedDataChannel').default.Summary; 7586 7587/** 7588 * Import the UniformDataType type object for ui component. 7589 * 7590 * @syscap SystemCapability.ArkUI.ArkUI.Full 7591 * @since 10 7592 */ 7593/** 7594 * Import the UniformDataType type object for ui component. 7595 * 7596 * @syscap SystemCapability.ArkUI.ArkUI.Full 7597 * @atomicservice 7598 * @since 11 7599 */ 7600declare type UniformDataType = import('../api/@ohos.data.uniformTypeDescriptor').default.UniformDataType; 7601 7602/** 7603 * Enum for Drag Result. 7604 * 7605 * @enum { number } 7606 * @syscap SystemCapability.ArkUI.ArkUI.Full 7607 * @since 10 7608 */ 7609/** 7610 * Enum for Drag Result. 7611 * 7612 * @enum { number } 7613 * @syscap SystemCapability.ArkUI.ArkUI.Full 7614 * @atomicservice 7615 * @since 11 7616 */ 7617declare enum DragResult { 7618 /** 7619 * If the drag is successful, return DragResult.DRAG_SUCCESSFUL. 7620 * 7621 * @syscap SystemCapability.ArkUI.ArkUI.Full 7622 * @since 10 7623 */ 7624 /** 7625 * If the drag is successful, return DragResult.DRAG_SUCCESSFUL. 7626 * 7627 * @syscap SystemCapability.ArkUI.ArkUI.Full 7628 * @atomicservice 7629 * @since 11 7630 */ 7631 DRAG_SUCCESSFUL = 0, 7632 /** 7633 * If drag fail, return DragResult.DRAG_FAILED. 7634 * 7635 * @syscap SystemCapability.ArkUI.ArkUI.Full 7636 * @since 10 7637 */ 7638 /** 7639 * If drag fail, return DragResult.DRAG_FAILED. 7640 * 7641 * @syscap SystemCapability.ArkUI.ArkUI.Full 7642 * @atomicservice 7643 * @since 11 7644 */ 7645 DRAG_FAILED = 1, 7646 /** 7647 * If drag action cancel, return DragResult.DRAG_CANCELED. 7648 * 7649 * @syscap SystemCapability.ArkUI.ArkUI.Full 7650 * @since 10 7651 */ 7652 /** 7653 * If drag action cancel, return DragResult.DRAG_CANCELED. 7654 * 7655 * @syscap SystemCapability.ArkUI.ArkUI.Full 7656 * @atomicservice 7657 * @since 11 7658 */ 7659 DRAG_CANCELED = 2, 7660 /** 7661 * If node allow drop in, return DragResult.DROP_ENABLED. 7662 * 7663 * @syscap SystemCapability.ArkUI.ArkUI.Full 7664 * @since 10 7665 */ 7666 /** 7667 * If node allow drop in, return DragResult.DROP_ENABLED. 7668 * 7669 * @syscap SystemCapability.ArkUI.ArkUI.Full 7670 * @atomicservice 7671 * @since 11 7672 */ 7673 DROP_ENABLED = 3, 7674 /** 7675 * If node don't allow drop in, return DragResult.DROP_DISABLED. 7676 * 7677 * @syscap SystemCapability.ArkUI.ArkUI.Full 7678 * @since 10 7679 */ 7680 /** 7681 * If node don't allow drop in, return DragResult.DROP_DISABLED. 7682 * 7683 * @syscap SystemCapability.ArkUI.ArkUI.Full 7684 * @atomicservice 7685 * @since 11 7686 */ 7687 DROP_DISABLED = 4 7688} 7689 7690/** 7691 * Enum for BlendMode. 7692 * Blend modes for compositing current component 7693 * with overlapping content. Use overlapping content 7694 * as dst, current component as src. 7695 * 7696 * @enum { number } 7697 * @syscap SystemCapability.ArkUI.ArkUI.Full 7698 * @crossplatform 7699 * @form 7700 * @since 11 7701 */ 7702declare enum BlendMode { 7703 /** 7704 * Hybrid mode does not take effect 7705 * 7706 * @syscap SystemCapability.ArkUI.ArkUI.Full 7707 * @crossplatform 7708 * @form 7709 * @since 11 7710 */ 7711 NONE = 0, 7712 /** 7713 * Clear destination color covered by the source to 0. 7714 * 7715 * @syscap SystemCapability.ArkUI.ArkUI.Full 7716 * @crossplatform 7717 * @form 7718 * @since 11 7719 */ 7720 CLEAR = 1, 7721 /** 7722 * r = s 7723 * 7724 * @syscap SystemCapability.ArkUI.ArkUI.Full 7725 * @crossplatform 7726 * @form 7727 * @since 11 7728 */ 7729 SRC = 2, 7730 /** 7731 * r = d 7732 * 7733 * @syscap SystemCapability.ArkUI.ArkUI.Full 7734 * @crossplatform 7735 * @form 7736 * @since 11 7737 */ 7738 DST = 3, 7739 /** 7740 * r = s + (1 - sa) * d 7741 * 7742 * @syscap SystemCapability.ArkUI.ArkUI.Full 7743 * @crossplatform 7744 * @form 7745 * @since 11 7746 */ 7747 SRC_OVER = 4, 7748 /** 7749 * r = d + (1 - da) * s 7750 * 7751 * @syscap SystemCapability.ArkUI.ArkUI.Full 7752 * @crossplatform 7753 * @form 7754 * @since 11 7755 */ 7756 DST_OVER = 5, 7757 /** 7758 * r = s * da 7759 * 7760 * @syscap SystemCapability.ArkUI.ArkUI.Full 7761 * @crossplatform 7762 * @form 7763 * @since 11 7764 */ 7765 SRC_IN = 6, 7766 /** 7767 * r = d * sa 7768 * 7769 * @syscap SystemCapability.ArkUI.ArkUI.Full 7770 * @crossplatform 7771 * @form 7772 * @since 11 7773 */ 7774 DST_IN = 7, 7775 /** 7776 * r = s * (1 - da) 7777 * 7778 * @syscap SystemCapability.ArkUI.ArkUI.Full 7779 * @crossplatform 7780 * @form 7781 * @since 11 7782 */ 7783 SRC_OUT = 8, 7784 /** 7785 * r = d * (1 - sa) 7786 * 7787 * @syscap SystemCapability.ArkUI.ArkUI.Full 7788 * @crossplatform 7789 * @form 7790 * @since 11 7791 */ 7792 DST_OUT = 9, 7793 /** 7794 * r = s * da + d * (1 - sa) 7795 * 7796 * @syscap SystemCapability.ArkUI.ArkUI.Full 7797 * @crossplatform 7798 * @form 7799 * @since 11 7800 */ 7801 SRC_ATOP = 10, 7802 /** 7803 * r = d * sa + s * (1 - da) 7804 * 7805 * @syscap SystemCapability.ArkUI.ArkUI.Full 7806 * @crossplatform 7807 * @form 7808 * @since 11 7809 */ 7810 DST_ATOP = 11, 7811 /** 7812 * r = s * (1 - da) + d * (1 - sa) 7813 * 7814 * @syscap SystemCapability.ArkUI.ArkUI.Full 7815 * @crossplatform 7816 * @form 7817 * @since 11 7818 */ 7819 XOR = 12, 7820 /** 7821 * r = min(s + d, 1) 7822 * 7823 * @syscap SystemCapability.ArkUI.ArkUI.Full 7824 * @crossplatform 7825 * @form 7826 * @since 11 7827 */ 7828 PLUS = 13, 7829 /** 7830 * r = s * d 7831 * 7832 * @syscap SystemCapability.ArkUI.ArkUI.Full 7833 * @crossplatform 7834 * @form 7835 * @since 11 7836 */ 7837 MODULATE = 14, 7838 /** 7839 * r = s + d - s * d 7840 * 7841 * @syscap SystemCapability.ArkUI.ArkUI.Full 7842 * @crossplatform 7843 * @form 7844 * @since 11 7845 */ 7846 SCREEN = 15, 7847 /** 7848 * multiply or screen, depending on destination 7849 * 7850 * @syscap SystemCapability.ArkUI.ArkUI.Full 7851 * @crossplatform 7852 * @form 7853 * @since 11 7854 */ 7855 OVERLAY = 16, 7856 /** 7857 * rc = s + d - max(s * da, d * sa), ra = kSrcOver 7858 * 7859 * @syscap SystemCapability.ArkUI.ArkUI.Full 7860 * @crossplatform 7861 * @form 7862 * @since 11 7863 */ 7864 DARKEN = 17, 7865 /** 7866 * rc = s + d - min(s * da, d * sa), ra = kSrcOver 7867 * 7868 * @syscap SystemCapability.ArkUI.ArkUI.Full 7869 * @crossplatform 7870 * @form 7871 * @since 11 7872 */ 7873 LIGHTEN = 18, 7874 /** 7875 * brighten destination to reflect source 7876 * 7877 * @syscap SystemCapability.ArkUI.ArkUI.Full 7878 * @crossplatform 7879 * @form 7880 * @since 11 7881 */ 7882 COLOR_DODGE = 19, 7883 /** 7884 * darken destination to reflect source 7885 * 7886 * @syscap SystemCapability.ArkUI.ArkUI.Full 7887 * @crossplatform 7888 * @form 7889 * @since 11 7890 */ 7891 COLOR_BURN = 20, 7892 /** 7893 * multiply or screen, depending on source 7894 * 7895 * @syscap SystemCapability.ArkUI.ArkUI.Full 7896 * @crossplatform 7897 * @form 7898 * @since 11 7899 */ 7900 HARD_LIGHT = 21, 7901 /** 7902 * lighten or darken, depending on source 7903 * 7904 * @syscap SystemCapability.ArkUI.ArkUI.Full 7905 * @crossplatform 7906 * @form 7907 * @since 11 7908 */ 7909 SOFT_LIGHT = 22, 7910 /** 7911 * rc = s + d - 2 * (min(s * da, d * sa)), ra = kSrcOver 7912 * 7913 * @syscap SystemCapability.ArkUI.ArkUI.Full 7914 * @crossplatform 7915 * @form 7916 * @since 11 7917 */ 7918 DIFFERENCE = 23, 7919 /** 7920 * rc = s + d - two(s * d), ra = kSrcOver 7921 * 7922 * @syscap SystemCapability.ArkUI.ArkUI.Full 7923 * @crossplatform 7924 * @form 7925 * @since 11 7926 */ 7927 EXCLUSION = 24, 7928 /** 7929 * r = s * (1 - da) + d * (1 - sa) + s * d 7930 * 7931 * @syscap SystemCapability.ArkUI.ArkUI.Full 7932 * @crossplatform 7933 * @form 7934 * @since 11 7935 */ 7936 MULTIPLY = 25, 7937 /** 7938 * hue of source with saturation and luminosity of destination 7939 * 7940 * @syscap SystemCapability.ArkUI.ArkUI.Full 7941 * @crossplatform 7942 * @form 7943 * @since 11 7944 */ 7945 HUE = 26, 7946 /** 7947 * saturation of source with hue and luminosity of destination 7948 * 7949 * @syscap SystemCapability.ArkUI.ArkUI.Full 7950 * @crossplatform 7951 * @form 7952 * @since 11 7953 */ 7954 SATURATION = 27, 7955 /** 7956 * hue and saturation of source with luminosity of destination 7957 * 7958 * @syscap SystemCapability.ArkUI.ArkUI.Full 7959 * @crossplatform 7960 * @form 7961 * @since 11 7962 */ 7963 COLOR = 28, 7964 /** 7965 * luminosity of source with hue and saturation of destination 7966 * 7967 * @syscap SystemCapability.ArkUI.ArkUI.Full 7968 * @crossplatform 7969 * @form 7970 * @since 11 7971 */ 7972 LUMINOSITY = 29 7973} 7974 7975/** 7976 * Enum for BlendApplyType. 7977 * Indicate how to apply specified blend mode to 7978 * the view's content. 7979 * 7980 * @enum { number } 7981 * @syscap SystemCapability.ArkUI.ArkUI.Full 7982 * @crossplatform 7983 * @form 7984 * @since 11 7985 */ 7986declare enum BlendApplyType { 7987 /** 7988 * Blend view's content in sequence over dst 7989 * 7990 * @syscap SystemCapability.ArkUI.ArkUI.Full 7991 * @crossplatform 7992 * @form 7993 * @since 11 7994 */ 7995 FAST = 0, 7996 7997 /** 7998 * Composite this views's contents into an 7999 * offscreen image and then blend over dst 8000 * 8001 * @syscap SystemCapability.ArkUI.ArkUI.Full 8002 * @crossplatform 8003 * @form 8004 * @since 11 8005 */ 8006 OFFSCREEN = 1, 8007} 8008 8009/** 8010 * DragEvent object description 8011 * 8012 * @interface DragEvent 8013 * @syscap SystemCapability.ArkUI.ArkUI.Full 8014 * @since 7 8015 */ 8016/** 8017 * DragEvent object description 8018 * 8019 * @interface DragEvent 8020 * @syscap SystemCapability.ArkUI.ArkUI.Full 8021 * @atomicservice 8022 * @since 11 8023 */ 8024declare interface DragEvent { 8025 /** 8026 * X coordinate of the touch point relative to the left edge of the device screen. 8027 * 8028 * @returns { number } 8029 * @syscap SystemCapability.ArkUI.ArkUI.Full 8030 * @since 10 8031 */ 8032 /** 8033 * X coordinate of the touch point relative to the left edge of the device screen. 8034 * 8035 * @returns { number } 8036 * @syscap SystemCapability.ArkUI.ArkUI.Full 8037 * @atomicservice 8038 * @since 11 8039 */ 8040 getDisplayX(): number; 8041 8042 /** 8043 * Y coordinate of the touch point relative to the upper edge of the device screen. 8044 * 8045 * @returns { number } 8046 * @syscap SystemCapability.ArkUI.ArkUI.Full 8047 * @since 10 8048 */ 8049 /** 8050 * Y coordinate of the touch point relative to the upper edge of the device screen. 8051 * 8052 * @returns { number } 8053 * @syscap SystemCapability.ArkUI.ArkUI.Full 8054 * @atomicservice 8055 * @since 11 8056 */ 8057 getDisplayY(): number; 8058 8059 /** 8060 * X coordinate of the touch point relative to the left edge of the current window. 8061 * 8062 * @returns { number } 8063 * @syscap SystemCapability.ArkUI.ArkUI.Full 8064 * @since 10 8065 */ 8066 /** 8067 * X coordinate of the touch point relative to the left edge of the current window. 8068 * 8069 * @returns { number } 8070 * @syscap SystemCapability.ArkUI.ArkUI.Full 8071 * @atomicservice 8072 * @since 11 8073 */ 8074 getWindowX(): number; 8075 8076 /** 8077 * Y coordinate of the touch point relative to the left edge of the current window. 8078 * 8079 * @returns { number } 8080 * @syscap SystemCapability.ArkUI.ArkUI.Full 8081 * @since 10 8082 */ 8083 /** 8084 * Y coordinate of the touch point relative to the left edge of the current window. 8085 * 8086 * @returns { number } 8087 * @syscap SystemCapability.ArkUI.ArkUI.Full 8088 * @atomicservice 8089 * @since 11 8090 */ 8091 getWindowY(): number; 8092 8093 /** 8094 * X coordinate of the touch point relative to the left edge of the current window. in vp. 8095 * 8096 * @returns { number } 8097 * @syscap SystemCapability.ArkUI.ArkUI.Full 8098 * @since 7 8099 * @deprecated since 10 8100 * @useinstead DragEvent#getWindowX 8101 */ 8102 getX(): number; 8103 8104 /** 8105 * Y coordinate of the touch point relative to the left edge of the current window. in vp. 8106 * 8107 * @returns { number } 8108 * @syscap SystemCapability.ArkUI.ArkUI.Full 8109 * @since 7 8110 * @deprecated since 10 8111 * @useinstead DragEvent#getWindowY 8112 */ 8113 getY(): number; 8114 8115 /** 8116 * If copy is COPY, this DragEvent is a copy event. 8117 * @type { DragBehavior } Operation, if use copy then set COPY, else set MOVE. 8118 * @default COPY 8119 * @syscap SystemCapability.ArkUI.ArkUI.Full 8120 * @since 10 8121 */ 8122 /** 8123 * If copy is COPY, this DragEvent is a copy event. 8124 * @type { DragBehavior } Operation, if use copy then set COPY, else set MOVE. 8125 * @default COPY 8126 * @syscap SystemCapability.ArkUI.ArkUI.Full 8127 * @atomicservice 8128 * @since 11 8129 */ 8130 dragBehavior: DragBehavior; 8131 8132 /** 8133 * If useCustomDropAnimation is true, System will not use drop animation. 8134 * 8135 * @type { boolean } 8136 * @syscap SystemCapability.ArkUI.ArkUI.Full 8137 * @since 10 8138 */ 8139 /** 8140 * If useCustomDropAnimation is true, System will not use drop animation. 8141 * 8142 * @type { boolean } 8143 * @syscap SystemCapability.ArkUI.ArkUI.Full 8144 * @atomicservice 8145 * @since 11 8146 */ 8147 useCustomDropAnimation: boolean; 8148 8149 /** 8150 * Set dragData into DragEvent. 8151 * 8152 * @param { UnifiedData } unifiedData - dragData. 8153 * @syscap SystemCapability.ArkUI.ArkUI.Full 8154 * @crossplatform 8155 * @since 10 8156 */ 8157 /** 8158 * Set dragData into DragEvent. 8159 * 8160 * @param { UnifiedData } unifiedData - dragData. 8161 * @syscap SystemCapability.ArkUI.ArkUI.Full 8162 * @crossplatform 8163 * @atomicservice 8164 * @since 11 8165 */ 8166 setData(unifiedData: UnifiedData): void; 8167 8168 /** 8169 * Get dragData from DragEvent. 8170 * 8171 * @returns { UnifiedData } - get dragData. 8172 * @throws { BusinessError } 190001 - data not found. 8173 * @throws { BusinessError } 190002 - data error. 8174 * @syscap SystemCapability.ArkUI.ArkUI.Full 8175 * @crossplatform 8176 * @since 10 8177 */ 8178 /** 8179 * Get dragData from DragEvent. 8180 * 8181 * @returns { UnifiedData } - get dragData. 8182 * @throws { BusinessError } 190001 - data not found. 8183 * @throws { BusinessError } 190002 - data error. 8184 * @syscap SystemCapability.ArkUI.ArkUI.Full 8185 * @crossplatform 8186 * @atomicservice 8187 * @since 11 8188 */ 8189 getData(): UnifiedData; 8190 8191 /** 8192 * Get dragData summary from DragEvent. 8193 * 8194 * @returns { Summary } - get Summary Data. 8195 * @syscap SystemCapability.ArkUI.ArkUI.Full 8196 * @crossplatform 8197 * @since 10 8198 */ 8199 /** 8200 * Get dragData summary from DragEvent. 8201 * 8202 * @returns { Summary } - get Summary Data. 8203 * @syscap SystemCapability.ArkUI.ArkUI.Full 8204 * @crossplatform 8205 * @atomicservice 8206 * @since 11 8207 */ 8208 getSummary(): Summary; 8209 8210 /** 8211 * Set dragEvent result to DragEvent. 8212 * 8213 * @param { DragResult } dragResult - the return of dragEvent. 8214 * @syscap SystemCapability.ArkUI.ArkUI.Full 8215 * @since 10 8216 */ 8217 /** 8218 * Set dragEvent result to DragEvent. 8219 * 8220 * @param { DragResult } dragResult - the return of dragEvent. 8221 * @syscap SystemCapability.ArkUI.ArkUI.Full 8222 * @atomicservice 8223 * @since 11 8224 */ 8225 setResult(dragResult: DragResult): void; 8226 8227 /** 8228 * Get dragEvent result from DragEvent. 8229 * 8230 * @returns { DragResult } - dragResult Data. 8231 * @syscap SystemCapability.ArkUI.ArkUI.Full 8232 * @since 10 8233 */ 8234 /** 8235 * Get dragEvent result from DragEvent. 8236 * 8237 * @returns { DragResult } - dragResult Data. 8238 * @syscap SystemCapability.ArkUI.ArkUI.Full 8239 * @atomicservice 8240 * @since 11 8241 */ 8242 getResult(): DragResult; 8243 8244 /** 8245 * Get the rectangle of drag window. 8246 * 8247 * @returns { Rectangle } - getPreview rectangle. 8248 * @syscap SystemCapability.ArkUI.ArkUI.Full 8249 * @since 10 8250 */ 8251 /** 8252 * Get the rectangle of drag window. 8253 * 8254 * @returns { Rectangle } - getPreview rectangle. 8255 * @syscap SystemCapability.ArkUI.ArkUI.Full 8256 * @atomicservice 8257 * @since 11 8258 */ 8259 getPreviewRect(): Rectangle; 8260 8261 /** 8262 * Get the x axis velocity of drag gesture. 8263 * 8264 * @returns { number } - get x axis velocity. 8265 * @syscap SystemCapability.ArkUI.ArkUI.Full 8266 * @crossplatform 8267 * @since 10 8268 */ 8269 /** 8270 * Get the x axis velocity of drag gesture. 8271 * 8272 * @returns { number } - get x axis velocity. 8273 * @syscap SystemCapability.ArkUI.ArkUI.Full 8274 * @crossplatform 8275 * @atomicservice 8276 * @since 11 8277 */ 8278 getVelocityX(): number; 8279 8280 /** 8281 * Get the y axis velocity of drag gesture. 8282 * 8283 * @returns { number } - get y axis velocity. 8284 * @syscap SystemCapability.ArkUI.ArkUI.Full 8285 * @crossplatform 8286 * @since 10 8287 */ 8288 /** 8289 * Get the y axis velocity of drag gesture. 8290 * 8291 * @returns { number } - get y axis velocity. 8292 * @syscap SystemCapability.ArkUI.ArkUI.Full 8293 * @crossplatform 8294 * @atomicservice 8295 * @since 11 8296 */ 8297 getVelocityY(): number; 8298 8299 /** 8300 * Get the velocity of drag gesture. 8301 * 8302 * @returns { number } - get velocity. 8303 * @syscap SystemCapability.ArkUI.ArkUI.Full 8304 * @crossplatform 8305 * @since 10 8306 */ 8307 /** 8308 * Get the velocity of drag gesture. 8309 * 8310 * @returns { number } - get velocity. 8311 * @syscap SystemCapability.ArkUI.ArkUI.Full 8312 * @crossplatform 8313 * @atomicservice 8314 * @since 11 8315 */ 8316 getVelocity(): number; 8317} 8318 8319/** 8320 * Import the IntentionCode type object for IntentionCode. 8321 * 8322 * @syscap SystemCapability.ArkUI.ArkUI.Full 8323 * @since 10 8324 */ 8325/** 8326 * Import the IntentionCode type object for IntentionCode. 8327 * 8328 * @syscap SystemCapability.ArkUI.ArkUI.Full 8329 * @atomicservice 8330 * @since 11 8331 */ 8332declare type IntentionCode = import('../api/@ohos.multimodalInput.intentionCode').IntentionCode; 8333 8334/** 8335 * KeyEvent object description: 8336 * 8337 * @interface KeyEvent 8338 * @syscap SystemCapability.ArkUI.ArkUI.Full 8339 * @since 7 8340 */ 8341/** 8342 * KeyEvent object description: 8343 * 8344 * @interface KeyEvent 8345 * @syscap SystemCapability.ArkUI.ArkUI.Full 8346 * @crossplatform 8347 * @since 10 8348 */ 8349/** 8350 * KeyEvent object description: 8351 * 8352 * @interface KeyEvent 8353 * @syscap SystemCapability.ArkUI.ArkUI.Full 8354 * @crossplatform 8355 * @atomicservice 8356 * @since 11 8357 */ 8358declare interface KeyEvent { 8359 /** 8360 * Type of a key. 8361 * 8362 * @type { KeyType } 8363 * @syscap SystemCapability.ArkUI.ArkUI.Full 8364 * @since 7 8365 */ 8366 /** 8367 * Type of a key. 8368 * 8369 * @type { KeyType } 8370 * @syscap SystemCapability.ArkUI.ArkUI.Full 8371 * @crossplatform 8372 * @since 10 8373 */ 8374 /** 8375 * Type of a key. 8376 * 8377 * @type { KeyType } 8378 * @syscap SystemCapability.ArkUI.ArkUI.Full 8379 * @crossplatform 8380 * @atomicservice 8381 * @since 11 8382 */ 8383 type: KeyType; 8384 8385 /** 8386 * Key code of a key 8387 * 8388 * @type { number } 8389 * @syscap SystemCapability.ArkUI.ArkUI.Full 8390 * @since 7 8391 */ 8392 /** 8393 * Key code of a key 8394 * 8395 * @type { number } 8396 * @syscap SystemCapability.ArkUI.ArkUI.Full 8397 * @crossplatform 8398 * @since 10 8399 */ 8400 /** 8401 * Key code of a key 8402 * 8403 * @type { number } 8404 * @syscap SystemCapability.ArkUI.ArkUI.Full 8405 * @crossplatform 8406 * @atomicservice 8407 * @since 11 8408 */ 8409 keyCode: number; 8410 8411 /** 8412 * Key value of a key. 8413 * 8414 * @type { string } 8415 * @syscap SystemCapability.ArkUI.ArkUI.Full 8416 * @since 7 8417 */ 8418 /** 8419 * Key value of a key. 8420 * 8421 * @type { string } 8422 * @syscap SystemCapability.ArkUI.ArkUI.Full 8423 * @crossplatform 8424 * @since 10 8425 */ 8426 /** 8427 * Key value of a key. 8428 * 8429 * @type { string } 8430 * @syscap SystemCapability.ArkUI.ArkUI.Full 8431 * @crossplatform 8432 * @atomicservice 8433 * @since 11 8434 */ 8435 keyText: string; 8436 8437 /** 8438 * Type of the input device that triggers the current key, such as the keyboard or handle. 8439 * 8440 * @type { KeySource } 8441 * @syscap SystemCapability.ArkUI.ArkUI.Full 8442 * @since 7 8443 */ 8444 /** 8445 * Type of the input device that triggers the current key, such as the keyboard or handle. 8446 * 8447 * @type { KeySource } 8448 * @syscap SystemCapability.ArkUI.ArkUI.Full 8449 * @crossplatform 8450 * @since 10 8451 */ 8452 /** 8453 * Type of the input device that triggers the current key, such as the keyboard or handle. 8454 * 8455 * @type { KeySource } 8456 * @syscap SystemCapability.ArkUI.ArkUI.Full 8457 * @crossplatform 8458 * @atomicservice 8459 * @since 11 8460 */ 8461 keySource: KeySource; 8462 8463 /** 8464 * Indicates the ID of the input device that triggers the current key. 8465 * 8466 * @type { number } 8467 * @syscap SystemCapability.ArkUI.ArkUI.Full 8468 * @since 7 8469 */ 8470 /** 8471 * Indicates the ID of the input device that triggers the current key. 8472 * 8473 * @type { number } 8474 * @syscap SystemCapability.ArkUI.ArkUI.Full 8475 * @crossplatform 8476 * @since 10 8477 */ 8478 /** 8479 * Indicates the ID of the input device that triggers the current key. 8480 * 8481 * @type { number } 8482 * @syscap SystemCapability.ArkUI.ArkUI.Full 8483 * @crossplatform 8484 * @atomicservice 8485 * @since 11 8486 */ 8487 deviceId: number; 8488 8489 /** 8490 * Indicates the status of the key when the key is pressed. 8491 * The value 1 indicates the pressed state, and the value 0 indicates the unpressed state. 8492 * 8493 * @type { number } 8494 * @syscap SystemCapability.ArkUI.ArkUI.Full 8495 * @since 7 8496 */ 8497 /** 8498 * Indicates the status of the key when the key is pressed. 8499 * The value 1 indicates the pressed state, and the value 0 indicates the unpressed state. 8500 * 8501 * @type { number } 8502 * @syscap SystemCapability.ArkUI.ArkUI.Full 8503 * @crossplatform 8504 * @since 10 8505 */ 8506 /** 8507 * Indicates the status of the key when the key is pressed. 8508 * The value 1 indicates the pressed state, and the value 0 indicates the unpressed state. 8509 * 8510 * @type { number } 8511 * @syscap SystemCapability.ArkUI.ArkUI.Full 8512 * @crossplatform 8513 * @atomicservice 8514 * @since 11 8515 */ 8516 metaKey: number; 8517 8518 /** 8519 * Timestamp when the key was pressed. 8520 * 8521 * @type { number } 8522 * @syscap SystemCapability.ArkUI.ArkUI.Full 8523 * @since 7 8524 */ 8525 /** 8526 * Timestamp when the key was pressed. 8527 * 8528 * @type { number } 8529 * @syscap SystemCapability.ArkUI.ArkUI.Full 8530 * @crossplatform 8531 * @since 10 8532 */ 8533 /** 8534 * Timestamp when the key was pressed. 8535 * 8536 * @type { number } 8537 * @syscap SystemCapability.ArkUI.ArkUI.Full 8538 * @crossplatform 8539 * @atomicservice 8540 * @since 11 8541 */ 8542 timestamp: number; 8543 8544 /** 8545 * Block event bubbling. 8546 * 8547 * @type { function } 8548 * @syscap SystemCapability.ArkUI.ArkUI.Full 8549 * @since 7 8550 */ 8551 /** 8552 * Block event bubbling. 8553 * 8554 * @type { function } 8555 * @syscap SystemCapability.ArkUI.ArkUI.Full 8556 * @crossplatform 8557 * @since 10 8558 */ 8559 /** 8560 * Block event bubbling. 8561 * 8562 * @type { function } 8563 * @syscap SystemCapability.ArkUI.ArkUI.Full 8564 * @crossplatform 8565 * @atomicservice 8566 * @since 11 8567 */ 8568 stopPropagation: () => void; 8569 8570 /** 8571 * Intention code of a key or modifier keys. 8572 * 8573 * @type { IntentionCode } 8574 * @default IntentionCode.INTENTION_UNKNOWN 8575 * @syscap SystemCapability.ArkUI.ArkUI.Full 8576 * @since 10 8577 */ 8578 /** 8579 * Intention code of a key or modifier keys. 8580 * 8581 * @type { IntentionCode } 8582 * @default IntentionCode.INTENTION_UNKNOWN 8583 * @syscap SystemCapability.ArkUI.ArkUI.Full 8584 * @atomicservice 8585 * @since 11 8586 */ 8587 intentionCode: IntentionCode; 8588} 8589 8590/** 8591 * Overlay module options 8592 * 8593 * @interface BindOptions 8594 * @syscap SystemCapability.ArkUI.ArkUI.Full 8595 * @crossplatform 8596 * @since 10 8597 */ 8598/** 8599 * Overlay module options 8600 * 8601 * @interface BindOptions 8602 * @syscap SystemCapability.ArkUI.ArkUI.Full 8603 * @crossplatform 8604 * @atomicservice 8605 * @since 11 8606 */ 8607declare interface BindOptions { 8608 /** 8609 * Defines the background color 8610 * 8611 * @type { ?ResourceColor } 8612 * @syscap SystemCapability.ArkUI.ArkUI.Full 8613 * @crossplatform 8614 * @since 10 8615 */ 8616 /** 8617 * Defines the background color 8618 * 8619 * @type { ?ResourceColor } 8620 * @syscap SystemCapability.ArkUI.ArkUI.Full 8621 * @crossplatform 8622 * @atomicservice 8623 * @since 11 8624 */ 8625 backgroundColor?: ResourceColor; 8626 8627 /** 8628 * Callback function when overlay interface appears 8629 * 8630 * @type { ?function } 8631 * @syscap SystemCapability.ArkUI.ArkUI.Full 8632 * @crossplatform 8633 * @since 10 8634 */ 8635 /** 8636 * Callback function when overlay interface appears 8637 * 8638 * @type { ?function } 8639 * @syscap SystemCapability.ArkUI.ArkUI.Full 8640 * @crossplatform 8641 * @atomicservice 8642 * @since 11 8643 */ 8644 onAppear?: () => void; 8645 8646 /** 8647 * Callback function when overlay interface exits 8648 * 8649 * @type { ?function } 8650 * @syscap SystemCapability.ArkUI.ArkUI.Full 8651 * @crossplatform 8652 * @since 10 8653 */ 8654 /** 8655 * Callback function when overlay interface exits 8656 * 8657 * @type { ?function } 8658 * @syscap SystemCapability.ArkUI.ArkUI.Full 8659 * @crossplatform 8660 * @atomicservice 8661 * @since 11 8662 */ 8663 onDisappear?: () => void; 8664} 8665 8666/** 8667 * Component content cover options 8668 * 8669 * @interface ContentCoverOptions 8670 * @syscap SystemCapability.ArkUI.ArkUI.Full 8671 * @crossplatform 8672 * @since 10 8673 */ 8674/** 8675 * Component content cover options 8676 * 8677 * @interface ContentCoverOptions 8678 * @syscap SystemCapability.ArkUI.ArkUI.Full 8679 * @crossplatform 8680 * @atomicservice 8681 * @since 11 8682 */ 8683declare interface ContentCoverOptions extends BindOptions { 8684 /** 8685 * Defines transition type 8686 * 8687 * @type { ?ModalTransition } 8688 * @default ModalTransition.Default 8689 * @syscap SystemCapability.ArkUI.ArkUI.Full 8690 * @crossplatform 8691 * @since 10 8692 */ 8693 /** 8694 * Defines transition type 8695 * 8696 * @type { ?ModalTransition } 8697 * @default ModalTransition.Default 8698 * @syscap SystemCapability.ArkUI.ArkUI.Full 8699 * @crossplatform 8700 * @atomicservice 8701 * @since 11 8702 */ 8703 modalTransition?: ModalTransition, 8704} 8705 8706/** 8707 * Component sheet title options 8708 * 8709 * @interface SheetTitleOptions 8710 * @syscap SystemCapability.ArkUI.ArkUI.Full 8711 * @crossplatform 8712 * @since 11 8713 */ 8714declare interface SheetTitleOptions { 8715 /** 8716 * Defines title text 8717 * 8718 * @type { ResourceStr } 8719 * @syscap SystemCapability.ArkUI.ArkUI.Full 8720 * @crossplatform 8721 * @since 11 8722 */ 8723 title: ResourceStr; 8724 8725 /** 8726 * Defines subtitle text 8727 * 8728 * @type { ?ResourceStr } 8729 * @syscap SystemCapability.ArkUI.ArkUI.Full 8730 * @crossplatform 8731 * @since 11 8732 */ 8733 subtitle?: ResourceStr; 8734} 8735 8736/** 8737 * Defines the sheet type. 8738 * 8739 * @enum { number } 8740 * @syscap SystemCapability.ArkUI.ArkUI.Full 8741 * @crossplatform 8742 * @since 11 8743 */ 8744declare enum SheetType { 8745 /** 8746 * Defines bottom sheet type. 8747 * 8748 * @syscap SystemCapability.ArkUI.ArkUI.Full 8749 * @crossplatform 8750 * @since 11 8751 */ 8752 BOTTOM = 0, 8753 8754 /** 8755 * Defines center sheet type. 8756 * 8757 * @syscap SystemCapability.ArkUI.ArkUI.Full 8758 * @crossplatform 8759 * @since 11 8760 */ 8761 CENTER = 1, 8762 8763 /** 8764 * Defines popup sheet type. 8765 * 8766 * @syscap SystemCapability.ArkUI.ArkUI.Full 8767 * @crossplatform 8768 * @since 11 8769 */ 8770 POPUP = 2, 8771} 8772 8773/** 8774 * Component sheet dismiss 8775 * 8776 * @interface SheetDismiss 8777 * @syscap SystemCapability.ArkUI.ArkUI.Full 8778 * @crossplatform 8779 * @since 11 8780 */ 8781declare interface SheetDismiss { 8782 /** 8783 * Defines sheet dismiss function 8784 * 8785 * @type { function } 8786 * @syscap SystemCapability.ArkUI.ArkUI.Full 8787 * @crossplatform 8788 * @since 11 8789 */ 8790 dismiss: () => void; 8791} 8792 8793/** 8794 * Component sheet options 8795 * 8796 * @interface SheetOptions 8797 * @syscap SystemCapability.ArkUI.ArkUI.Full 8798 * @crossplatform 8799 * @since 10 8800 */ 8801/** 8802 * Component sheet options 8803 * 8804 * @interface SheetOptions 8805 * @syscap SystemCapability.ArkUI.ArkUI.Full 8806 * @crossplatform 8807 * @atomicservice 8808 * @since 11 8809 */ 8810declare interface SheetOptions extends BindOptions { 8811 /** 8812 * Defines sheet height 8813 * 8814 * @type { ?(SheetSize | Length) } 8815 * @default Sheet.LARGE 8816 * @syscap SystemCapability.ArkUI.ArkUI.Full 8817 * @crossplatform 8818 * @since 10 8819 */ 8820 /** 8821 * Defines sheet height 8822 * 8823 * @type { ?(SheetSize | Length) } 8824 * @default Sheet.LARGE 8825 * @syscap SystemCapability.ArkUI.ArkUI.Full 8826 * @crossplatform 8827 * @atomicservice 8828 * @since 11 8829 */ 8830 height?: SheetSize | Length; 8831 8832 /** 8833 * Defines whether the control bar is displayed. 8834 * 8835 * @type { ?boolean } 8836 * @default true 8837 * @syscap SystemCapability.ArkUI.ArkUI.Full 8838 * @crossplatform 8839 * @since 10 8840 */ 8841 /** 8842 * Defines whether the control bar is displayed. 8843 * 8844 * @type { ?boolean } 8845 * @default true 8846 * @syscap SystemCapability.ArkUI.ArkUI.Full 8847 * @crossplatform 8848 * @atomicservice 8849 * @since 11 8850 */ 8851 dragBar?: boolean; 8852 8853 /** 8854 * Defines sheet maskColor 8855 * 8856 * @type { ?ResourceColor } 8857 * @syscap SystemCapability.ArkUI.ArkUI.Full 8858 * @crossplatform 8859 * @since 10 8860 */ 8861 /** 8862 * Defines sheet maskColor 8863 * 8864 * @type { ?ResourceColor } 8865 * @syscap SystemCapability.ArkUI.ArkUI.Full 8866 * @crossplatform 8867 * @atomicservice 8868 * @since 11 8869 */ 8870 maskColor?: ResourceColor; 8871 8872 /** 8873 * Defines sheet detents 8874 * 8875 * @type { ?[(SheetSize | Length), (SheetSize | Length)?, (SheetSize | Length)?] } 8876 * @syscap SystemCapability.ArkUI.ArkUI.Full 8877 * @crossplatform 8878 * @since 11 8879 */ 8880 detents?: [(SheetSize | Length), (SheetSize | Length)?, (SheetSize | Length)?]; 8881 8882 /** 8883 * Defines sheet background blur Style 8884 * 8885 * @type { ?BlurStyle } 8886 * @default BlurStyle.NONE 8887 * @syscap SystemCapability.ArkUI.ArkUI.Full 8888 * @crossplatform 8889 * @since 11 8890 */ 8891 blurStyle?: BlurStyle; 8892 8893 /** 8894 * Defines whether the close icon is displayed 8895 * 8896 * @type { ?(boolean | Resource) } 8897 * @default true 8898 * @syscap SystemCapability.ArkUI.ArkUI.Full 8899 * @crossplatform 8900 * @since 11 8901 */ 8902 showClose?: boolean | Resource; 8903 8904 /** 8905 * Defines the sheet prefer type 8906 * 8907 * @type { ?(SheetType.CENTER | SheetType.POPUP) } 8908 * @syscap SystemCapability.ArkUI.ArkUI.Full 8909 * @crossplatform 8910 * @since 11 8911 */ 8912 preferType?: SheetType.CENTER | SheetType.POPUP; 8913 8914 /** 8915 * Defines the sheet title 8916 * 8917 * @type { ?(SheetTitleOptions | CustomBuilder) } 8918 * @syscap SystemCapability.ArkUI.ArkUI.Full 8919 * @crossplatform 8920 * @since 11 8921 */ 8922 title?: SheetTitleOptions | CustomBuilder; 8923 8924 /** 8925 * Callback function when the sheet interactive dismiss 8926 * 8927 * @type { ?function } 8928 * @syscap SystemCapability.ArkUI.ArkUI.Full 8929 * @crossplatform 8930 * @since 11 8931 */ 8932 shouldDismiss?: (sheetDismiss: SheetDismiss) => void; 8933 8934 /** 8935 * Set whether interaction is allowed outside the sheet 8936 * 8937 * @type { ?boolean } 8938 * @default false 8939 * @syscap SystemCapability.ArkUI.ArkUI.Full 8940 * @crossplatform 8941 * @since 11 8942 */ 8943 enableOutsideInteractive?: boolean; 8944} 8945 8946/** 8947 * Component State Styles. 8948 * 8949 * @interface StateStyles 8950 * @syscap SystemCapability.ArkUI.ArkUI.Full 8951 * @since 8 8952 */ 8953/** 8954 * Component State Styles. 8955 * 8956 * @interface StateStyles 8957 * @syscap SystemCapability.ArkUI.ArkUI.Full 8958 * @since 9 8959 * @form 8960 */ 8961/** 8962 * Component State Styles. 8963 * 8964 * @interface StateStyles 8965 * @syscap SystemCapability.ArkUI.ArkUI.Full 8966 * @crossplatform 8967 * @since 10 8968 * @form 8969 */ 8970/** 8971 * Component State Styles. 8972 * 8973 * @interface StateStyles 8974 * @syscap SystemCapability.ArkUI.ArkUI.Full 8975 * @crossplatform 8976 * @atomicservice 8977 * @since 11 8978 * @form 8979 */ 8980declare interface StateStyles { 8981 /** 8982 * Defines normal state styles. 8983 * 8984 * @type { ?any } 8985 * @syscap SystemCapability.ArkUI.ArkUI.Full 8986 * @since 8 8987 */ 8988 /** 8989 * Defines normal state styles. 8990 * 8991 * @type { ?any } 8992 * @syscap SystemCapability.ArkUI.ArkUI.Full 8993 * @since 9 8994 * @form 8995 */ 8996 /** 8997 * Defines normal state styles. 8998 * 8999 * @type { ?any } 9000 * @syscap SystemCapability.ArkUI.ArkUI.Full 9001 * @crossplatform 9002 * @since 10 9003 * @form 9004 */ 9005 /** 9006 * Defines normal state styles. 9007 * 9008 * @type { ?any } 9009 * @syscap SystemCapability.ArkUI.ArkUI.Full 9010 * @crossplatform 9011 * @atomicservice 9012 * @since 11 9013 * @form 9014 */ 9015 normal?: any; 9016 9017 /** 9018 * Defines pressed state styles. 9019 * 9020 * @type { ?any } 9021 * @syscap SystemCapability.ArkUI.ArkUI.Full 9022 * @since 8 9023 */ 9024 /** 9025 * Defines pressed state styles. 9026 * 9027 * @type { ?any } 9028 * @syscap SystemCapability.ArkUI.ArkUI.Full 9029 * @since 9 9030 * @form 9031 */ 9032 /** 9033 * Defines pressed state styles. 9034 * 9035 * @type { ?any } 9036 * @syscap SystemCapability.ArkUI.ArkUI.Full 9037 * @crossplatform 9038 * @since 10 9039 * @form 9040 */ 9041 /** 9042 * Defines pressed state styles. 9043 * 9044 * @type { ?any } 9045 * @syscap SystemCapability.ArkUI.ArkUI.Full 9046 * @crossplatform 9047 * @atomicservice 9048 * @since 11 9049 * @form 9050 */ 9051 pressed?: any; 9052 9053 /** 9054 * Defines disabled state styles. 9055 * 9056 * @type { ?any } 9057 * @syscap SystemCapability.ArkUI.ArkUI.Full 9058 * @since 8 9059 */ 9060 /** 9061 * Defines disabled state styles. 9062 * 9063 * @type { ?any } 9064 * @syscap SystemCapability.ArkUI.ArkUI.Full 9065 * @since 9 9066 * @form 9067 */ 9068 /** 9069 * Defines disabled state styles. 9070 * 9071 * @type { ?any } 9072 * @syscap SystemCapability.ArkUI.ArkUI.Full 9073 * @crossplatform 9074 * @since 10 9075 * @form 9076 */ 9077 /** 9078 * Defines disabled state styles. 9079 * 9080 * @type { ?any } 9081 * @syscap SystemCapability.ArkUI.ArkUI.Full 9082 * @crossplatform 9083 * @atomicservice 9084 * @since 11 9085 * @form 9086 */ 9087 disabled?: any; 9088 9089 /** 9090 * Defines focused state styles. 9091 * 9092 * @type { ?any } 9093 * @syscap SystemCapability.ArkUI.ArkUI.Full 9094 * @since 8 9095 */ 9096 /** 9097 * Defines focused state styles. 9098 * 9099 * @type { ?any } 9100 * @syscap SystemCapability.ArkUI.ArkUI.Full 9101 * @since 9 9102 * @form 9103 */ 9104 /** 9105 * Defines focused state styles. 9106 * 9107 * @type { ?any } 9108 * @syscap SystemCapability.ArkUI.ArkUI.Full 9109 * @crossplatform 9110 * @since 10 9111 * @form 9112 */ 9113 /** 9114 * Defines focused state styles. 9115 * 9116 * @type { ?any } 9117 * @syscap SystemCapability.ArkUI.ArkUI.Full 9118 * @crossplatform 9119 * @atomicservice 9120 * @since 11 9121 * @form 9122 */ 9123 focused?: any; 9124 9125 /** 9126 * Defines clicked state styles. 9127 * 9128 * @type { ?any } 9129 * @syscap SystemCapability.ArkUI.ArkUI.Full 9130 * @since 8 9131 */ 9132 /** 9133 * Defines clicked state styles. 9134 * 9135 * @type { ?any } 9136 * @syscap SystemCapability.ArkUI.ArkUI.Full 9137 * @since 9 9138 * @form 9139 */ 9140 /** 9141 * Defines clicked state styles. 9142 * 9143 * @type { ?any } 9144 * @syscap SystemCapability.ArkUI.ArkUI.Full 9145 * @crossplatform 9146 * @since 10 9147 * @form 9148 */ 9149 /** 9150 * Defines clicked state styles. 9151 * 9152 * @type { ?any } 9153 * @syscap SystemCapability.ArkUI.ArkUI.Full 9154 * @crossplatform 9155 * @atomicservice 9156 * @since 11 9157 * @form 9158 */ 9159 clicked?: any; 9160 9161 /** 9162 * Defines selected state styles. 9163 * 9164 * @type { ?object } 9165 * @syscap SystemCapability.ArkUI.ArkUI.Full 9166 * @crossplatform 9167 * @since 10 9168 * @form 9169 */ 9170 /** 9171 * Defines selected state styles. 9172 * 9173 * @type { ?object } 9174 * @syscap SystemCapability.ArkUI.ArkUI.Full 9175 * @crossplatform 9176 * @atomicservice 9177 * @since 11 9178 * @form 9179 */ 9180 selected?: object; 9181} 9182 9183/** 9184 * Defines the options of popup message. 9185 * 9186 * @interface PopupMessageOptions 9187 * @syscap SystemCapability.ArkUI.ArkUI.Full 9188 * @crossplatform 9189 * @since 10 9190 */ 9191/** 9192 * Defines the options of popup message. 9193 * 9194 * @interface PopupMessageOptions 9195 * @syscap SystemCapability.ArkUI.ArkUI.Full 9196 * @crossplatform 9197 * @atomicservice 9198 * @since 11 9199 */ 9200declare interface PopupMessageOptions { 9201 /** 9202 * Sets the color of popup text. 9203 * 9204 * @type { ?ResourceColor } 9205 * @syscap SystemCapability.ArkUI.ArkUI.Full 9206 * @crossplatform 9207 * @since 10 9208 */ 9209 /** 9210 * Sets the color of popup text. 9211 * 9212 * @type { ?ResourceColor } 9213 * @syscap SystemCapability.ArkUI.ArkUI.Full 9214 * @crossplatform 9215 * @atomicservice 9216 * @since 11 9217 */ 9218 textColor?: ResourceColor; 9219 9220 /** 9221 * Sets the font of popup text. 9222 * 9223 * @type { ?Font } 9224 * @syscap SystemCapability.ArkUI.ArkUI.Full 9225 * @crossplatform 9226 * @since 10 9227 */ 9228 /** 9229 * Sets the font of popup text. 9230 * 9231 * @type { ?Font } 9232 * @syscap SystemCapability.ArkUI.ArkUI.Full 9233 * @crossplatform 9234 * @atomicservice 9235 * @since 11 9236 */ 9237 font?: Font; 9238} 9239 9240/** 9241 * Defines the popup options. 9242 * 9243 * @interface PopupOptions 9244 * @syscap SystemCapability.ArkUI.ArkUI.Full 9245 * @since 7 9246 */ 9247/** 9248 * Defines the popup options. 9249 * 9250 * @interface PopupOptions 9251 * @syscap SystemCapability.ArkUI.ArkUI.Full 9252 * @crossplatform 9253 * @since 10 9254 */ 9255/** 9256 * Defines the popup options. 9257 * 9258 * @interface PopupOptions 9259 * @syscap SystemCapability.ArkUI.ArkUI.Full 9260 * @crossplatform 9261 * @atomicservice 9262 * @since 11 9263 */ 9264declare interface PopupOptions { 9265 /** 9266 * Information in the pop-up window. 9267 * 9268 * @type { string } 9269 * @syscap SystemCapability.ArkUI.ArkUI.Full 9270 * @since 7 9271 */ 9272 /** 9273 * Information in the pop-up window. 9274 * 9275 * @type { string } 9276 * @syscap SystemCapability.ArkUI.ArkUI.Full 9277 * @crossplatform 9278 * @since 10 9279 */ 9280 /** 9281 * Information in the pop-up window. 9282 * 9283 * @type { string } 9284 * @syscap SystemCapability.ArkUI.ArkUI.Full 9285 * @crossplatform 9286 * @atomicservice 9287 * @since 11 9288 */ 9289 message: string; 9290 9291 /** 9292 * placement On Top 9293 * 9294 * @type { ?boolean } 9295 * @syscap SystemCapability.ArkUI.ArkUI.Full 9296 * @since 7 9297 * @deprecated since 10 9298 * @useinstead PopupOptions#placement 9299 */ 9300 placementOnTop?: boolean; 9301 9302 /** 9303 * The placement of popup. 9304 * Supports all positions defined in Placement. 9305 * 9306 * @type { ?Placement } 9307 * @default Placement.Bottom 9308 * @syscap SystemCapability.ArkUI.ArkUI.Full 9309 * @crossplatform 9310 * @since 10 9311 */ 9312 /** 9313 * The placement of popup. 9314 * Supports all positions defined in Placement. 9315 * 9316 * @type { ?Placement } 9317 * @default Placement.Bottom 9318 * @syscap SystemCapability.ArkUI.ArkUI.Full 9319 * @crossplatform 9320 * @atomicservice 9321 * @since 11 9322 */ 9323 placement?: Placement; 9324 9325 /** 9326 * The first button. 9327 * 9328 * @type { ?object } 9329 * @syscap SystemCapability.ArkUI.ArkUI.Full 9330 * @since 7 9331 */ 9332 /** 9333 * The first button. 9334 * 9335 * @type { ?object } 9336 * @syscap SystemCapability.ArkUI.ArkUI.Full 9337 * @crossplatform 9338 * @since 10 9339 */ 9340 /** 9341 * The first button. 9342 * 9343 * @type { ?object } 9344 * @syscap SystemCapability.ArkUI.ArkUI.Full 9345 * @crossplatform 9346 * @atomicservice 9347 * @since 11 9348 */ 9349 primaryButton?: { 9350 /** 9351 * Button text value 9352 * 9353 * @type { string } 9354 * @syscap SystemCapability.ArkUI.ArkUI.Full 9355 * @since 7 9356 */ 9357 /** 9358 * Button text value 9359 * 9360 * @type { string } 9361 * @syscap SystemCapability.ArkUI.ArkUI.Full 9362 * @crossplatform 9363 * @since 10 9364 */ 9365 /** 9366 * Button text value 9367 * 9368 * @type { string } 9369 * @syscap SystemCapability.ArkUI.ArkUI.Full 9370 * @crossplatform 9371 * @atomicservice 9372 * @since 11 9373 */ 9374 value: string; 9375 9376 /** 9377 * action 9378 * 9379 * @type { function } 9380 * @syscap SystemCapability.ArkUI.ArkUI.Full 9381 * @since 7 9382 */ 9383 /** 9384 * action 9385 * 9386 * @type { function } 9387 * @syscap SystemCapability.ArkUI.ArkUI.Full 9388 * @crossplatform 9389 * @since 10 9390 */ 9391 /** 9392 * action 9393 * 9394 * @type { function } 9395 * @syscap SystemCapability.ArkUI.ArkUI.Full 9396 * @crossplatform 9397 * @atomicservice 9398 * @since 11 9399 */ 9400 action: () => void; 9401 }; 9402 9403 /** 9404 * The second button. 9405 * 9406 * @type { ?object } 9407 * @syscap SystemCapability.ArkUI.ArkUI.Full 9408 * @since 7 9409 */ 9410 /** 9411 * The second button. 9412 * 9413 * @type { ?object } 9414 * @syscap SystemCapability.ArkUI.ArkUI.Full 9415 * @crossplatform 9416 * @since 10 9417 */ 9418 /** 9419 * The second button. 9420 * 9421 * @type { ?object } 9422 * @syscap SystemCapability.ArkUI.ArkUI.Full 9423 * @crossplatform 9424 * @atomicservice 9425 * @since 11 9426 */ 9427 secondaryButton?: { 9428 /** 9429 * Button text value 9430 * 9431 * @type { string } 9432 * @syscap SystemCapability.ArkUI.ArkUI.Full 9433 * @since 7 9434 */ 9435 /** 9436 * Button text value 9437 * 9438 * @type { string } 9439 * @syscap SystemCapability.ArkUI.ArkUI.Full 9440 * @crossplatform 9441 * @since 10 9442 */ 9443 /** 9444 * Button text value 9445 * 9446 * @type { string } 9447 * @syscap SystemCapability.ArkUI.ArkUI.Full 9448 * @crossplatform 9449 * @atomicservice 9450 * @since 11 9451 */ 9452 value: string; 9453 9454 /** 9455 * action 9456 * 9457 * @type { function } 9458 * @syscap SystemCapability.ArkUI.ArkUI.Full 9459 * @since 7 9460 */ 9461 /** 9462 * action 9463 * 9464 * @type { function } 9465 * @syscap SystemCapability.ArkUI.ArkUI.Full 9466 * @crossplatform 9467 * @since 10 9468 */ 9469 /** 9470 * action 9471 * 9472 * @type { function } 9473 * @syscap SystemCapability.ArkUI.ArkUI.Full 9474 * @crossplatform 9475 * @atomicservice 9476 * @since 11 9477 */ 9478 action: () => void; 9479 }; 9480 9481 /** 9482 * on State Change 9483 * 9484 * @type { ?function } 9485 * @syscap SystemCapability.ArkUI.ArkUI.Full 9486 * @since 7 9487 */ 9488 /** 9489 * on State Change 9490 * 9491 * @type { ?function } 9492 * @syscap SystemCapability.ArkUI.ArkUI.Full 9493 * @crossplatform 9494 * @since 10 9495 */ 9496 /** 9497 * on State Change 9498 * 9499 * @type { ?function } 9500 * @syscap SystemCapability.ArkUI.ArkUI.Full 9501 * @crossplatform 9502 * @atomicservice 9503 * @since 11 9504 */ 9505 onStateChange?: (event: { 9506 /** 9507 * is Visible. 9508 * 9509 * @type { boolean } 9510 * @syscap SystemCapability.ArkUI.ArkUI.Full 9511 * @crossplatform 9512 * @since 10 9513 */ 9514 /** 9515 * is Visible. 9516 * 9517 * @type { boolean } 9518 * @syscap SystemCapability.ArkUI.ArkUI.Full 9519 * @crossplatform 9520 * @atomicservice 9521 * @since 11 9522 */ 9523 isVisible: boolean 9524 }) => void; 9525 9526 /** 9527 * The offset of the sharp corner of popup. 9528 * 9529 * @type { ?Length } 9530 * @syscap SystemCapability.ArkUI.ArkUI.Full 9531 * @since 9 9532 */ 9533 /** 9534 * The offset of the sharp corner of popup. 9535 * 9536 * @type { ?Length } 9537 * @syscap SystemCapability.ArkUI.ArkUI.Full 9538 * @crossplatform 9539 * @since 10 9540 */ 9541 /** 9542 * The offset of the sharp corner of popup. 9543 * 9544 * @type { ?Length } 9545 * @syscap SystemCapability.ArkUI.ArkUI.Full 9546 * @crossplatform 9547 * @atomicservice 9548 * @since 11 9549 */ 9550 arrowOffset?: Length; 9551 9552 /** 9553 * Whether to display in the sub window. 9554 * 9555 * @type { ?boolean } 9556 * @syscap SystemCapability.ArkUI.ArkUI.Full 9557 * @since 9 9558 */ 9559 /** 9560 * Whether to display in the sub window. 9561 * 9562 * @type { ?boolean } 9563 * @syscap SystemCapability.ArkUI.ArkUI.Full 9564 * @crossplatform 9565 * @since 10 9566 */ 9567 /** 9568 * Whether to display in the sub window. 9569 * 9570 * @type { ?boolean } 9571 * @syscap SystemCapability.ArkUI.ArkUI.Full 9572 * @crossplatform 9573 * @atomicservice 9574 * @since 11 9575 */ 9576 showInSubWindow?: boolean; 9577 9578 /** 9579 * The mask to block gesture events of popup. 9580 * When mask is set false, gesture events are not blocked. 9581 * When mask is set true, gesture events are blocked and mask color is transparent. 9582 * 9583 * @type { ?(boolean | { color: ResourceColor }) } 9584 * @syscap SystemCapability.ArkUI.ArkUI.Full 9585 * @crossplatform 9586 * @since 10 9587 */ 9588 /** 9589 * The mask to block gesture events of popup. 9590 * When mask is set false, gesture events are not blocked. 9591 * When mask is set true, gesture events are blocked and mask color is transparent. 9592 * 9593 * @type { ?(boolean | { color: ResourceColor }) } 9594 * @syscap SystemCapability.ArkUI.ArkUI.Full 9595 * @crossplatform 9596 * @atomicservice 9597 * @since 11 9598 */ 9599 mask?: boolean | { color: ResourceColor }; 9600 9601 /** 9602 * Sets the options of popup message. 9603 * 9604 * @type { ?PopupMessageOptions } 9605 * @syscap SystemCapability.ArkUI.ArkUI.Full 9606 * @crossplatform 9607 * @since 10 9608 */ 9609 /** 9610 * Sets the options of popup message. 9611 * 9612 * @type { ?PopupMessageOptions } 9613 * @syscap SystemCapability.ArkUI.ArkUI.Full 9614 * @crossplatform 9615 * @atomicservice 9616 * @since 11 9617 */ 9618 messageOptions?: PopupMessageOptions 9619 9620 /** 9621 * Sets the space of between the popup and target. 9622 * 9623 * @type { ?Length } 9624 * @syscap SystemCapability.ArkUI.ArkUI.Full 9625 * @crossplatform 9626 * @since 10 9627 */ 9628 /** 9629 * Sets the space of between the popup and target. 9630 * 9631 * @type { ?Length } 9632 * @syscap SystemCapability.ArkUI.ArkUI.Full 9633 * @crossplatform 9634 * @atomicservice 9635 * @since 11 9636 */ 9637 targetSpace?: Length 9638 9639 /** 9640 * whether show arrow 9641 * 9642 * @type { ?boolean } 9643 * @default true 9644 * @syscap SystemCapability.ArkUI.ArkUI.Full 9645 * @since 10 9646 */ 9647 /** 9648 * whether show arrow 9649 * 9650 * @type { ?boolean } 9651 * @default true 9652 * @syscap SystemCapability.ArkUI.ArkUI.Full 9653 * @crossplatform 9654 * @atomicservice 9655 * @since 11 9656 */ 9657 enableArrow?: boolean; 9658 /** 9659 * Sets the position offset of the popup. 9660 * 9661 * @type { ?Position } 9662 * @syscap SystemCapability.ArkUI.ArkUI.Full 9663 * @crossplatform 9664 * @since 10 9665 */ 9666 /** 9667 * Sets the position offset of the popup. 9668 * 9669 * @type { ?Position } 9670 * @syscap SystemCapability.ArkUI.ArkUI.Full 9671 * @crossplatform 9672 * @atomicservice 9673 * @since 11 9674 */ 9675 offset?: Position 9676 9677 /** 9678 * Set the background color of the popup. 9679 * 9680 * @type { ?(Color | string | Resource | number) } 9681 * @syscap SystemCapability.ArkUI.ArkUI.Full 9682 * @crossplatform 9683 * @since 11 9684 */ 9685 popupColor?: Color | string | Resource | number; 9686 9687 /** 9688 * Whether hide popup when click mask 9689 * 9690 * @type { ?boolean } 9691 * @default true 9692 * @syscap SystemCapability.ArkUI.ArkUI.Full 9693 * @crossplatform 9694 * @since 11 9695 */ 9696 autoCancel?: boolean; 9697 9698 /** 9699 * Set the width of the popup. 9700 * 9701 * @type { ?Dimension } 9702 * @syscap SystemCapability.ArkUI.ArkUI.Full 9703 * @crossplatform 9704 * @since 11 9705 */ 9706 width?: Dimension; 9707 9708 /** 9709 * The position of the sharp corner of popup. 9710 * 9711 * @type { ?ArrowPointPosition } 9712 * @syscap SystemCapability.ArkUI.ArkUI.Full 9713 * @crossplatform 9714 * @since 11 9715 */ 9716 arrowPointPosition?: ArrowPointPosition; 9717 9718 /** 9719 * The width of the arrow. 9720 * 9721 * @type { ?Dimension } 9722 * @default 16.0_vp. 9723 * @syscap SystemCapability.ArkUI.ArkUI.Full 9724 * @crossplatform 9725 * @since 11 9726 */ 9727 arrowWidth?: Dimension; 9728 9729 /** 9730 * The height of the arrow. 9731 * 9732 * @type { ?Dimension } 9733 * @default 8.0_vp. 9734 * @syscap SystemCapability.ArkUI.ArkUI.Full 9735 * @crossplatform 9736 * @since 11 9737 */ 9738 arrowHeight?: Dimension; 9739 9740 /** 9741 * The round corners of the popup. 9742 * 9743 * @type { ?Dimension } 9744 * @default 20.0_vp. 9745 * @syscap SystemCapability.ArkUI.ArkUI.Full 9746 * @crossplatform 9747 * @since 11 9748 */ 9749 radius?: Dimension; 9750 9751 /** 9752 * The style of popup Shadow. 9753 * 9754 * @type { ?(ShadowOptions | ShadowStyle) } 9755 * @default ShadowStyle.OUTER_DEFAULT_MD. 9756 * @syscap SystemCapability.ArkUI.ArkUI.Full 9757 * @crossplatform 9758 * @since 11 9759 */ 9760 shadow?: ShadowOptions | ShadowStyle; 9761 9762 /** 9763 * Defines popup background blur Style 9764 * 9765 * @type { ?BlurStyle } 9766 * @default BlurStyle.COMPONENT_ULTRA_THICK 9767 * @syscap SystemCapability.ArkUI.ArkUI.Full 9768 * @crossplatform 9769 * @since 11 9770 */ 9771 backgroundBlurStyle?: BlurStyle; 9772} 9773 9774/** 9775 * Defines the custom popup options. 9776 * 9777 * @interface CustomPopupOptions 9778 * @syscap SystemCapability.ArkUI.ArkUI.Full 9779 * @since 8 9780 */ 9781/** 9782 * Defines the custom popup options. 9783 * 9784 * @interface CustomPopupOptions 9785 * @syscap SystemCapability.ArkUI.ArkUI.Full 9786 * @crossplatform 9787 * @since 10 9788 */ 9789/** 9790 * Defines the custom popup options. 9791 * 9792 * @interface CustomPopupOptions 9793 * @syscap SystemCapability.ArkUI.ArkUI.Full 9794 * @crossplatform 9795 * @atomicservice 9796 * @since 11 9797 */ 9798declare interface CustomPopupOptions { 9799 /** 9800 * builder of popup 9801 * 9802 * @type { CustomBuilder } 9803 * @syscap SystemCapability.ArkUI.ArkUI.Full 9804 * @since 8 9805 */ 9806 /** 9807 * builder of popup 9808 * 9809 * @type { CustomBuilder } 9810 * @syscap SystemCapability.ArkUI.ArkUI.Full 9811 * @crossplatform 9812 * @since 10 9813 */ 9814 /** 9815 * builder of popup 9816 * 9817 * @type { CustomBuilder } 9818 * @syscap SystemCapability.ArkUI.ArkUI.Full 9819 * @crossplatform 9820 * @atomicservice 9821 * @since 11 9822 */ 9823 builder: CustomBuilder; 9824 9825 /** 9826 * placement of popup 9827 * 9828 * @type { ?Placement } 9829 * @syscap SystemCapability.ArkUI.ArkUI.Full 9830 * @since 8 9831 */ 9832 /** 9833 * placement of popup 9834 * 9835 * @type { ?Placement } 9836 * @syscap SystemCapability.ArkUI.ArkUI.Full 9837 * @crossplatform 9838 * @since 10 9839 */ 9840 /** 9841 * placement of popup 9842 * 9843 * @type { ?Placement } 9844 * @syscap SystemCapability.ArkUI.ArkUI.Full 9845 * @crossplatform 9846 * @atomicservice 9847 * @since 11 9848 */ 9849 placement?: Placement; 9850 9851 /** 9852 * mask color of popup 9853 * 9854 * @type { ?(Color | string | Resource | number) } 9855 * @syscap SystemCapability.ArkUI.ArkUI.Full 9856 * @since 8 9857 * @deprecated since 10 9858 * @useinstead CustomPopupOptions#mask 9859 */ 9860 maskColor?: Color | string | Resource | number; 9861 9862 /** 9863 * background color of popup 9864 * 9865 * @type { ?(Color | string | Resource | number) } 9866 * @syscap SystemCapability.ArkUI.ArkUI.Full 9867 * @since 8 9868 */ 9869 /** 9870 * background color of popup 9871 * 9872 * @type { ?(Color | string | Resource | number) } 9873 * @syscap SystemCapability.ArkUI.ArkUI.Full 9874 * @crossplatform 9875 * @since 10 9876 */ 9877 /** 9878 * background color of popup 9879 * 9880 * @type { ?(Color | string | Resource | number) } 9881 * @syscap SystemCapability.ArkUI.ArkUI.Full 9882 * @crossplatform 9883 * @atomicservice 9884 * @since 11 9885 */ 9886 popupColor?: Color | string | Resource | number; 9887 9888 /** 9889 * whether show arrow 9890 * 9891 * @type { ?boolean } 9892 * @syscap SystemCapability.ArkUI.ArkUI.Full 9893 * @since 8 9894 */ 9895 /** 9896 * whether show arrow 9897 * 9898 * @type { ?boolean } 9899 * @syscap SystemCapability.ArkUI.ArkUI.Full 9900 * @crossplatform 9901 * @since 10 9902 */ 9903 /** 9904 * whether show arrow 9905 * 9906 * @type { ?boolean } 9907 * @syscap SystemCapability.ArkUI.ArkUI.Full 9908 * @crossplatform 9909 * @atomicservice 9910 * @since 11 9911 */ 9912 enableArrow?: boolean; 9913 9914 /** 9915 * whether hide popup when click mask 9916 * 9917 * @type { ?boolean } 9918 * @syscap SystemCapability.ArkUI.ArkUI.Full 9919 * @since 8 9920 */ 9921 /** 9922 * whether hide popup when click mask 9923 * 9924 * @type { ?boolean } 9925 * @syscap SystemCapability.ArkUI.ArkUI.Full 9926 * @crossplatform 9927 * @since 10 9928 */ 9929 /** 9930 * whether hide popup when click mask 9931 * 9932 * @type { ?boolean } 9933 * @syscap SystemCapability.ArkUI.ArkUI.Full 9934 * @crossplatform 9935 * @atomicservice 9936 * @since 11 9937 */ 9938 autoCancel?: boolean; 9939 9940 /** 9941 * on State Change 9942 * 9943 * @type { ?function } 9944 * @syscap SystemCapability.ArkUI.ArkUI.Full 9945 * @since 8 9946 */ 9947 /** 9948 * on State Change 9949 * 9950 * @type { ?function } 9951 * @syscap SystemCapability.ArkUI.ArkUI.Full 9952 * @crossplatform 9953 * @since 10 9954 */ 9955 /** 9956 * on State Change 9957 * 9958 * @type { ?function } 9959 * @syscap SystemCapability.ArkUI.ArkUI.Full 9960 * @crossplatform 9961 * @atomicservice 9962 * @since 11 9963 */ 9964 onStateChange?: (event: { 9965 /** 9966 * is Visible. 9967 * 9968 * @type { boolean } 9969 * @syscap SystemCapability.ArkUI.ArkUI.Full 9970 * @crossplatform 9971 * @since 10 9972 */ 9973 /** 9974 * is Visible. 9975 * 9976 * @type { boolean } 9977 * @syscap SystemCapability.ArkUI.ArkUI.Full 9978 * @crossplatform 9979 * @atomicservice 9980 * @since 11 9981 */ 9982 isVisible: boolean 9983 }) => void; 9984 9985 /** 9986 * The offset of the sharp corner of popup. 9987 * 9988 * @type { ?Length } 9989 * @syscap SystemCapability.ArkUI.ArkUI.Full 9990 * @since 9 9991 */ 9992 /** 9993 * The offset of the sharp corner of popup. 9994 * 9995 * @type { ?Length } 9996 * @syscap SystemCapability.ArkUI.ArkUI.Full 9997 * @crossplatform 9998 * @since 10 9999 */ 10000 /** 10001 * The offset of the sharp corner of popup. 10002 * 10003 * @type { ?Length } 10004 * @syscap SystemCapability.ArkUI.ArkUI.Full 10005 * @crossplatform 10006 * @atomicservice 10007 * @since 11 10008 */ 10009 arrowOffset?: Length; 10010 10011 /** 10012 * Whether to display in the sub window. 10013 * 10014 * @type { ?boolean } 10015 * @syscap SystemCapability.ArkUI.ArkUI.Full 10016 * @since 9 10017 */ 10018 /** 10019 * Whether to display in the sub window. 10020 * 10021 * @type { ?boolean } 10022 * @syscap SystemCapability.ArkUI.ArkUI.Full 10023 * @crossplatform 10024 * @since 10 10025 */ 10026 /** 10027 * Whether to display in the sub window. 10028 * 10029 * @type { ?boolean } 10030 * @syscap SystemCapability.ArkUI.ArkUI.Full 10031 * @crossplatform 10032 * @atomicservice 10033 * @since 11 10034 */ 10035 showInSubWindow?: boolean; 10036 10037 /** 10038 * The mask to block gesture events of popup. 10039 * When mask is set false, gesture events are not blocked. 10040 * When mask is set true, gesture events are blocked and mask color is transparent. 10041 * 10042 * @type { ?(boolean | { color: ResourceColor }) } 10043 * @syscap SystemCapability.ArkUI.ArkUI.Full 10044 * @crossplatform 10045 * @since 10 10046 */ 10047 /** 10048 * The mask to block gesture events of popup. 10049 * When mask is set false, gesture events are not blocked. 10050 * When mask is set true, gesture events are blocked and mask color is transparent. 10051 * 10052 * @type { ?(boolean | { color: ResourceColor }) } 10053 * @syscap SystemCapability.ArkUI.ArkUI.Full 10054 * @crossplatform 10055 * @atomicservice 10056 * @since 11 10057 */ 10058 mask?: boolean | { color: ResourceColor }; 10059 10060 /** 10061 * Sets the space of between the popup and target. 10062 * 10063 * @type { ?Length } 10064 * @syscap SystemCapability.ArkUI.ArkUI.Full 10065 * @crossplatform 10066 * @since 10 10067 */ 10068 /** 10069 * Sets the space of between the popup and target. 10070 * 10071 * @type { ?Length } 10072 * @syscap SystemCapability.ArkUI.ArkUI.Full 10073 * @crossplatform 10074 * @atomicservice 10075 * @since 11 10076 */ 10077 targetSpace?: Length 10078 10079 /** 10080 * Sets the position offset of the popup. 10081 * 10082 * @type { ?Position } 10083 * @syscap SystemCapability.ArkUI.ArkUI.Full 10084 * @crossplatform 10085 * @since 10 10086 */ 10087 /** 10088 * Sets the position offset of the popup. 10089 * 10090 * @type { ?Position } 10091 * @syscap SystemCapability.ArkUI.ArkUI.Full 10092 * @crossplatform 10093 * @atomicservice 10094 * @since 11 10095 */ 10096 offset?: Position 10097 10098 /** 10099 * Set the width of the popup. 10100 * 10101 * @type { ?Dimension } 10102 * @syscap SystemCapability.ArkUI.ArkUI.Full 10103 * @crossplatform 10104 * @since 11 10105 */ 10106 width?: Dimension; 10107 10108 /** 10109 * The position of the sharp corner of popup. 10110 * 10111 * @type { ?ArrowPointPosition } 10112 * @syscap SystemCapability.ArkUI.ArkUI.Full 10113 * @crossplatform 10114 * @since 11 10115 */ 10116 arrowPointPosition?: ArrowPointPosition; 10117 10118 /** 10119 * The width of the arrow. 10120 * 10121 * @type { ?Dimension } 10122 * @default 16.0_vp. 10123 * @syscap SystemCapability.ArkUI.ArkUI.Full 10124 * @crossplatform 10125 * @since 11 10126 */ 10127 arrowWidth?: Dimension; 10128 10129 /** 10130 * The height of the arrow. 10131 * 10132 * @type { ?Dimension } 10133 * @default 8.0_vp. 10134 * @syscap SystemCapability.ArkUI.ArkUI.Full 10135 * @crossplatform 10136 * @since 11 10137 */ 10138 arrowHeight?: Dimension; 10139 10140 /** 10141 * The round corners of the popup. 10142 * 10143 * @type { ?Dimension } 10144 * @default 20.0_vp. 10145 * @syscap SystemCapability.ArkUI.ArkUI.Full 10146 * @crossplatform 10147 * @since 11 10148 */ 10149 radius?: Dimension; 10150 10151 /** 10152 * The style of popup Shadow. 10153 * 10154 * @type { ?(ShadowOptions | ShadowStyle) } 10155 * @default ShadowStyle.OUTER_DEFAULT_MD. 10156 * @syscap SystemCapability.ArkUI.ArkUI.Full 10157 * @crossplatform 10158 * @since 11 10159 */ 10160 shadow?: ShadowOptions | ShadowStyle; 10161 10162 /** 10163 * Defines popup background blur Style 10164 * 10165 * @type { ?BlurStyle } 10166 * @default BlurStyle.COMPONENT_ULTRA_THICK 10167 * @syscap SystemCapability.ArkUI.ArkUI.Full 10168 * @crossplatform 10169 * @since 11 10170 */ 10171 backgroundBlurStyle?: BlurStyle; 10172 10173 /** 10174 * Set popup focusable 10175 * 10176 * @type { ?boolean } 10177 * @default true 10178 * @syscap SystemCapability.ArkUI.ArkUI.Full 10179 * @crossplatform 10180 * @since 11 10181 */ 10182 focusable?: boolean; 10183} 10184 10185/** 10186 * Defines the menu preview mode. 10187 * 10188 * @enum { number } 10189 * @syscap SystemCapability.ArkUI.ArkUI.Full 10190 * @crossplatform 10191 * @since 11 10192 */ 10193declare enum MenuPreviewMode { 10194 /** 10195 * No preview content. 10196 * 10197 * @syscap SystemCapability.ArkUI.ArkUI.Full 10198 * @crossplatform 10199 * @since 11 10200 */ 10201 NONE = 0, 10202 /** 10203 * Defines image type preview content. 10204 * 10205 * @syscap SystemCapability.ArkUI.ArkUI.Full 10206 * @crossplatform 10207 * @since 11 10208 */ 10209 IMAGE = 1 10210} 10211 10212/** 10213 * Defines the animator range of start and end property. 10214 * 10215 * @syscap SystemCapability.ArkUI.ArkUI.Full 10216 * @crossplatform 10217 * @since 11 10218 */ 10219declare type AnimationRange<T> = [from: T, to: T]; 10220 10221/** 10222 * Defines the ContextMenu's preview animator options. 10223 * 10224 * @interface ContextMenuAnimationOptions 10225 * @syscap SystemCapability.ArkUI.ArkUI.Full 10226 * @crossplatform 10227 * @since 11 10228 */ 10229interface ContextMenuAnimationOptions { 10230 /** 10231 * Sets the start animator scale and end animator scale. 10232 * 10233 * @type { ?AnimationRange<number> } 10234 * @default - 10235 * @syscap SystemCapability.ArkUI.ArkUI.Full 10236 * @crossplatform 10237 * @since 11 10238 */ 10239 scale?: AnimationRange<number>; 10240} 10241 10242/** 10243 * Defines the context menu options. 10244 * 10245 * @interface ContextMenuOptions 10246 * @syscap SystemCapability.ArkUI.ArkUI.Full 10247 * @crossplatform 10248 * @since 10 10249 */ 10250/** 10251 * Defines the context menu options. 10252 * 10253 * @interface ContextMenuOptions 10254 * @syscap SystemCapability.ArkUI.ArkUI.Full 10255 * @crossplatform 10256 * @atomicservice 10257 * @since 11 10258 */ 10259declare interface ContextMenuOptions { 10260 /** 10261 * Sets the position offset of the context menu window. 10262 * 10263 * @type { ?Position } 10264 * @default - 10265 * @syscap SystemCapability.ArkUI.ArkUI.Full 10266 * @crossplatform 10267 * @since 10 10268 */ 10269 /** 10270 * Sets the position offset of the context menu window. 10271 * 10272 * @type { ?Position } 10273 * @default - 10274 * @syscap SystemCapability.ArkUI.ArkUI.Full 10275 * @crossplatform 10276 * @atomicservice 10277 * @since 11 10278 */ 10279 offset?: Position; 10280 10281 /** 10282 * Sets the placement of the context menu window. 10283 * 10284 * @type { ?Placement } 10285 * @default - 10286 * @syscap SystemCapability.ArkUI.ArkUI.Full 10287 * @crossplatform 10288 * @since 10 10289 */ 10290 /** 10291 * Sets the placement of the context menu window. 10292 * 10293 * @type { ?Placement } 10294 * @default - 10295 * @syscap SystemCapability.ArkUI.ArkUI.Full 10296 * @crossplatform 10297 * @atomicservice 10298 * @since 11 10299 */ 10300 placement?: Placement; 10301 10302 /** 10303 * whether show arrow belong to the menu, default: false, not show arrow 10304 * 10305 * @type { ?boolean } 10306 * @default false 10307 * @syscap SystemCapability.ArkUI.ArkUI.Full 10308 * @since 10 10309 */ 10310 /** 10311 * whether show arrow belong to the menu, default: false, not show arrow 10312 * 10313 * @type { ?boolean } 10314 * @default false 10315 * @syscap SystemCapability.ArkUI.ArkUI.Full 10316 * @crossplatform 10317 * @atomicservice 10318 * @since 11 10319 */ 10320 enableArrow?: boolean; 10321 10322 /** 10323 * The horizontal offset to the left of menu or vertical offset to the top of menu 10324 * 10325 * @type { ?Length } 10326 * @default 0 10327 * @syscap SystemCapability.ArkUI.ArkUI.Full 10328 * @since 10 10329 */ 10330 /** 10331 * The horizontal offset to the left of menu or vertical offset to the top of menu 10332 * 10333 * @type { ?Length } 10334 * @default 0 10335 * @syscap SystemCapability.ArkUI.ArkUI.Full 10336 * @crossplatform 10337 * @atomicservice 10338 * @since 11 10339 */ 10340 arrowOffset?: Length; 10341 10342 /** 10343 * The preview content of context menu. 10344 * 10345 * @type { ?(MenuPreviewMode | CustomBuilder) } 10346 * @default MenuPreviewMode.NONE 10347 * @syscap SystemCapability.ArkUI.ArkUI.Full 10348 * @crossplatform 10349 * @since 11 10350 */ 10351 preview?: MenuPreviewMode | CustomBuilder; 10352 10353 /** 10354 * Callback function when the context menu appears. 10355 * 10356 * @type { ?function } 10357 * @syscap SystemCapability.ArkUI.ArkUI.Full 10358 * @crossplatform 10359 * @since 10 10360 */ 10361 /** 10362 * Callback function when the context menu appears. 10363 * 10364 * @type { ?function } 10365 * @syscap SystemCapability.ArkUI.ArkUI.Full 10366 * @crossplatform 10367 * @atomicservice 10368 * @since 11 10369 */ 10370 onAppear?: () => void; 10371 10372 /** 10373 * Callback function when the context menu disappear. 10374 * 10375 * @type { ?function } 10376 * @syscap SystemCapability.ArkUI.ArkUI.Full 10377 * @crossplatform 10378 * @since 10 10379 */ 10380 /** 10381 * Callback function when the context menu disappear. 10382 * 10383 * @type { ?function } 10384 * @syscap SystemCapability.ArkUI.ArkUI.Full 10385 * @crossplatform 10386 * @atomicservice 10387 * @since 11 10388 */ 10389 onDisappear?: () => void; 10390 10391 /** 10392 * Callback function before the context menu animation starts. 10393 * 10394 * @type { ?function } 10395 * @syscap SystemCapability.ArkUI.ArkUI.Full 10396 * @crossplatform 10397 * @since 11 10398 */ 10399 aboutToAppear?: () => void; 10400 10401 /** 10402 * Callback function before the context menu popAnimation starts. 10403 * 10404 * @type { ?function } 10405 * @syscap SystemCapability.ArkUI.ArkUI.Full 10406 * @crossplatform 10407 * @since 11 10408 */ 10409 aboutToDisappear?: () => void; 10410 10411 /** 10412 * The preview animator options. 10413 * 10414 * @type { ?ContextMenuAnimationOptions } 10415 * @syscap SystemCapability.ArkUI.ArkUI.Full 10416 * @crossplatform 10417 * @since 11 10418 */ 10419 previewAnimationOptions?: ContextMenuAnimationOptions; 10420 10421 /** 10422 * Defines the menu's background color 10423 * 10424 * @type { ?ResourceColor } 10425 * @default Color.Transparent 10426 * @syscap SystemCapability.ArkUI.ArkUI.Full 10427 * @crossplatform 10428 * @since 11 10429 */ 10430 backgroundColor?: ResourceColor; 10431 10432 /** 10433 * Defines menu background blur Style 10434 * 10435 * @type { ?BlurStyle } 10436 * @default BlurStyle.COMPONENT_ULTRA_THICK 10437 * @syscap SystemCapability.ArkUI.ArkUI.Full 10438 * @crossplatform 10439 * @since 11 10440 */ 10441 backgroundBlurStyle?: BlurStyle; 10442} 10443 10444/** 10445 * Defines the menu options. 10446 * 10447 * @interface MenuOptions 10448 * @syscap SystemCapability.ArkUI.ArkUI.Full 10449 * @crossplatform 10450 * @since 10 10451 */ 10452/** 10453 * Defines the menu options. 10454 * 10455 * @interface MenuOptions 10456 * @syscap SystemCapability.ArkUI.ArkUI.Full 10457 * @crossplatform 10458 * @atomicservice 10459 * @since 11 10460 */ 10461declare interface MenuOptions extends ContextMenuOptions { 10462 /** 10463 * Sets the title of the menu window. 10464 * 10465 * @type { ?ResourceStr } 10466 * @syscap SystemCapability.ArkUI.ArkUI.Full 10467 * @crossplatform 10468 * @since 10 10469 */ 10470 /** 10471 * Sets the title of the menu window. 10472 * 10473 * @type { ?ResourceStr } 10474 * @syscap SystemCapability.ArkUI.ArkUI.Full 10475 * @crossplatform 10476 * @atomicservice 10477 * @since 11 10478 */ 10479 title?: ResourceStr; 10480 10481 /** 10482 * Whether to display in the sub window. 10483 * 10484 * @type { ?boolean } 10485 * @syscap SystemCapability.ArkUI.ArkUI.Full 10486 * @crossplatform 10487 * @since 11 10488 */ 10489 showInSubWindow?: boolean; 10490} 10491 10492/** 10493 * Defines the ProgressMask class. 10494 * 10495 * @syscap SystemCapability.ArkUI.ArkUI.Full 10496 * @crossplatform 10497 * @since 10 10498 */ 10499/** 10500 * Defines the ProgressMask class. 10501 * 10502 * @syscap SystemCapability.ArkUI.ArkUI.Full 10503 * @crossplatform 10504 * @atomicservice 10505 * @since 11 10506 */ 10507declare class ProgressMask { 10508 /** 10509 * constructor. 10510 * 10511 * @param { number } value - indicates the current value of the progress. 10512 * @param { number } total - indicates the total value of the progress. 10513 * @param { ResourceColor } color - indicates the color of the mask. 10514 * @syscap SystemCapability.ArkUI.ArkUI.Full 10515 * @crossplatform 10516 * @since 10 10517 */ 10518 /** 10519 * constructor. 10520 * 10521 * @param { number } value - indicates the current value of the progress. 10522 * @param { number } total - indicates the total value of the progress. 10523 * @param { ResourceColor } color - indicates the color of the mask. 10524 * @syscap SystemCapability.ArkUI.ArkUI.Full 10525 * @crossplatform 10526 * @atomicservice 10527 * @since 11 10528 */ 10529 constructor(value: number, total: number, color: ResourceColor); 10530 10531 /** 10532 * Update the current value of the progress. 10533 * 10534 * @param { number } value - indicates the current value of the progress. 10535 * @syscap SystemCapability.ArkUI.ArkUI.Full 10536 * @crossplatform 10537 * @since 10 10538 */ 10539 /** 10540 * Update the current value of the progress. 10541 * 10542 * @param { number } value - indicates the current value of the progress. 10543 * @syscap SystemCapability.ArkUI.ArkUI.Full 10544 * @crossplatform 10545 * @atomicservice 10546 * @since 11 10547 */ 10548 updateProgress(value: number): void; 10549 10550 /** 10551 * Update the color of the mask. 10552 * 10553 * @param { ResourceColor } value - indicates the color of the mask. 10554 * @syscap SystemCapability.ArkUI.ArkUI.Full 10555 * @crossplatform 10556 * @since 10 10557 */ 10558 /** 10559 * Update the color of the mask. 10560 * 10561 * @param { ResourceColor } value - indicates the color of the mask. 10562 * @syscap SystemCapability.ArkUI.ArkUI.Full 10563 * @crossplatform 10564 * @atomicservice 10565 * @since 11 10566 */ 10567 updateColor(value: ResourceColor): void; 10568} 10569 10570/** 10571 * Defines TouchTestInfo class. 10572 * 10573 * @syscap SystemCapability.ArkUI.ArkUI.Full 10574 * @crossplatform 10575 * @since 11 10576 */ 10577declare class TouchTestInfo { 10578 /** 10579 * Get the X-coordinate relative to the window. 10580 * 10581 * @type { number } 10582 * @syscap SystemCapability.ArkUI.ArkUI.Full 10583 * @crossplatform 10584 * @since 11 10585 */ 10586 windowX: number; 10587 10588 /** 10589 * Get the Y-coordinate relative to the window. 10590 * 10591 * @type { number } 10592 * @syscap SystemCapability.ArkUI.ArkUI.Full 10593 * @crossplatform 10594 * @since 11 10595 */ 10596 windowY: number; 10597 10598 /** 10599 * Get the X-coordinate relative to the current component. 10600 * 10601 * @type { number } 10602 * @syscap SystemCapability.ArkUI.ArkUI.Full 10603 * @crossplatform 10604 * @since 11 10605 */ 10606 parentX: number; 10607 10608 /** 10609 * Get the Y-coordinate relative to the current component. 10610 * 10611 * @type { number } 10612 * @syscap SystemCapability.ArkUI.ArkUI.Full 10613 * @crossplatform 10614 * @since 11 10615 */ 10616 parentY: number; 10617 10618 /** 10619 * Get the X-coordinate relative to the sub component. 10620 * 10621 * @type { number } 10622 * @syscap SystemCapability.ArkUI.ArkUI.Full 10623 * @crossplatform 10624 * @since 11 10625 */ 10626 x: number; 10627 10628 /** 10629 * Get the Y-coordinate relative to the sub component. 10630 * 10631 * @type { number } 10632 * @syscap SystemCapability.ArkUI.ArkUI.Full 10633 * @crossplatform 10634 * @since 11 10635 */ 10636 y: number; 10637 10638 /** 10639 * Get the rectangle of sub component. 10640 * 10641 * @type { RectResult } 10642 * @syscap SystemCapability.ArkUI.ArkUI.Full 10643 * @crossplatform 10644 * @since 11 10645 */ 10646 rect: RectResult; 10647 10648 /** 10649 * Get the name of sub component. 10650 * 10651 * @type { string } 10652 * @syscap SystemCapability.ArkUI.ArkUI.Full 10653 * @crossplatform 10654 * @since 11 10655 */ 10656 id: string; 10657} 10658 10659/** 10660 * Defines TouchResult class. 10661 * 10662 * @syscap SystemCapability.ArkUI.ArkUI.Full 10663 * @crossplatform 10664 * @since 11 10665 */ 10666declare class TouchResult { 10667 /** 10668 * Defines the touch test strategy. 10669 * 10670 * @type { TouchTestStrategy } 10671 * @syscap SystemCapability.ArkUI.ArkUI.Full 10672 * @crossplatform 10673 * @since 11 10674 */ 10675 strategy: TouchTestStrategy; 10676 10677 /** 10678 * Defines the component's name. 10679 * 10680 * @type { ?string } 10681 * @syscap SystemCapability.ArkUI.ArkUI.Full 10682 * @crossplatform 10683 * @since 11 10684 */ 10685 id?: string; 10686} 10687 10688/** 10689 * Set the edge blur effect distance of the corresponding defense line of the component 10690 * When the component expand out, no re-layout is triggered 10691 * 10692 * @interface PixelStretchEffectOptions 10693 * @syscap SystemCapability.ArkUI.ArkUI.Full 10694 * @crossplatform 10695 * @since 10 10696 */ 10697/** 10698 * Set the edge blur effect distance of the corresponding defense line of the component 10699 * When the component expand out, no re-layout is triggered 10700 * 10701 * @interface PixelStretchEffectOptions 10702 * @syscap SystemCapability.ArkUI.ArkUI.Full 10703 * @crossplatform 10704 * @atomicservice 10705 * @since 11 10706 */ 10707declare interface PixelStretchEffectOptions { 10708 /** 10709 * top property. value range (-∞, ∞) 10710 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 10711 * 10712 * @type { ?Length } 10713 * @default 0 10714 * @syscap SystemCapability.ArkUI.ArkUI.Full 10715 * @crossplatform 10716 * @since 10 10717 */ 10718 /** 10719 * top property. value range (-∞, ∞) 10720 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 10721 * 10722 * @type { ?Length } 10723 * @default 0 10724 * @syscap SystemCapability.ArkUI.ArkUI.Full 10725 * @crossplatform 10726 * @atomicservice 10727 * @since 11 10728 */ 10729 top?: Length; 10730 10731 /** 10732 * bottom property. value range (-∞, ∞) 10733 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 10734 * 10735 * @type { ?Length } 10736 * @default 0 10737 * @syscap SystemCapability.ArkUI.ArkUI.Full 10738 * @crossplatform 10739 * @since 10 10740 */ 10741 /** 10742 * bottom property. value range (-∞, ∞) 10743 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 10744 * 10745 * @type { ?Length } 10746 * @default 0 10747 * @syscap SystemCapability.ArkUI.ArkUI.Full 10748 * @crossplatform 10749 * @atomicservice 10750 * @since 11 10751 */ 10752 bottom?: Length; 10753 10754 /** 10755 * left property. value range (-∞, ∞) 10756 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 10757 * 10758 * @type { ?Length } 10759 * @default 0 10760 * @syscap SystemCapability.ArkUI.ArkUI.Full 10761 * @crossplatform 10762 * @since 10 10763 */ 10764 /** 10765 * left property. value range (-∞, ∞) 10766 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 10767 * 10768 * @type { ?Length } 10769 * @default 0 10770 * @syscap SystemCapability.ArkUI.ArkUI.Full 10771 * @crossplatform 10772 * @atomicservice 10773 * @since 11 10774 */ 10775 left?: Length; 10776 10777 /** 10778 * right property. value range (-∞, ∞) 10779 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 10780 * 10781 * @default 0 10782 * @syscap SystemCapability.ArkUI.ArkUI.Full 10783 * @crossplatform 10784 * @since 10 10785 */ 10786 /** 10787 * right property. value range (-∞, ∞) 10788 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 10789 * 10790 * @default 0 10791 * @syscap SystemCapability.ArkUI.ArkUI.Full 10792 * @crossplatform 10793 * @atomicservice 10794 * @since 11 10795 */ 10796 right?: Length; 10797} 10798 10799/** 10800 * Defines the click effect. 10801 * 10802 * @interface ClickEffect 10803 * @syscap SystemCapability.ArkUI.ArkUI.Full 10804 * @crossplatform 10805 * @since 10 10806 */ 10807/** 10808 * Defines the click effect. 10809 * 10810 * @interface ClickEffect 10811 * @syscap SystemCapability.ArkUI.ArkUI.Full 10812 * @crossplatform 10813 * @atomicservice 10814 * @since 11 10815 */ 10816declare interface ClickEffect { 10817 /** 10818 * Set the click effect level. 10819 * 10820 * @type { ClickEffectLevel } 10821 * @default ClickEffectLevel.Light 10822 * @syscap SystemCapability.ArkUI.ArkUI.Full 10823 * @since 10 10824 */ 10825 /** 10826 * Set the click effect level. 10827 * 10828 * @type { ClickEffectLevel } 10829 * @default ClickEffectLevel.Light 10830 * @syscap SystemCapability.ArkUI.ArkUI.Full 10831 * @atomicservice 10832 * @since 11 10833 */ 10834 level: ClickEffectLevel; 10835 10836 /** 10837 * Set scale number. 10838 * This default scale is same as the scale of click effect level. 10839 * 10840 * @type { ?number } 10841 * @syscap SystemCapability.ArkUI.ArkUI.Full 10842 * @since 10 10843 */ 10844 /** 10845 * Set scale number. 10846 * This default scale is same as the scale of click effect level. 10847 * 10848 * @type { ?number } 10849 * @syscap SystemCapability.ArkUI.ArkUI.Full 10850 * @atomicservice 10851 * @since 11 10852 */ 10853 scale?: number; 10854} 10855 10856/** 10857 * Define nested scroll options 10858 * 10859 * @interface NestedScrollOptions 10860 * @syscap SystemCapability.ArkUI.ArkUI.Full 10861 * @since 10 10862 */ 10863/** 10864 * Define nested scroll options 10865 * 10866 * @interface NestedScrollOptions 10867 * @syscap SystemCapability.ArkUI.ArkUI.Full 10868 * @atomicservice 10869 * @since 11 10870 */ 10871declare interface NestedScrollOptions { 10872 /** 10873 * Set NestedScrollMode when the scrollable component scrolls forward 10874 * 10875 * @type { NestedScrollMode } 10876 * @syscap SystemCapability.ArkUI.ArkUI.Full 10877 * @since 10 10878 */ 10879 /** 10880 * Set NestedScrollMode when the scrollable component scrolls forward 10881 * 10882 * @type { NestedScrollMode } 10883 * @syscap SystemCapability.ArkUI.ArkUI.Full 10884 * @crossplatform 10885 * @atomicservice 10886 * @since 11 10887 */ 10888 scrollForward: NestedScrollMode; 10889 10890 /** 10891 * Set NestedScrollMode when the scrollable component scrolls backward 10892 * 10893 * @type { NestedScrollMode } 10894 * @syscap SystemCapability.ArkUI.ArkUI.Full 10895 * @since 10 10896 */ 10897 /** 10898 * Set NestedScrollMode when the scrollable component scrolls backward 10899 * 10900 * @type { NestedScrollMode } 10901 * @syscap SystemCapability.ArkUI.ArkUI.Full 10902 * @crossplatform 10903 * @atomicservice 10904 * @since 11 10905 */ 10906 scrollBackward: NestedScrollMode; 10907} 10908 10909/** 10910 * Defines the menu element. 10911 * 10912 * @interface MenuElement 10913 * @syscap SystemCapability.ArkUI.ArkUI.Full 10914 * @since 7 10915 */ 10916/** 10917 * Defines the menu element. 10918 * 10919 * @interface MenuElement 10920 * @syscap SystemCapability.ArkUI.ArkUI.Full 10921 * @crossplatform 10922 * @since 10 10923 */ 10924/** 10925 * Defines the menu element. 10926 * 10927 * @interface MenuElement 10928 * @syscap SystemCapability.ArkUI.ArkUI.Full 10929 * @crossplatform 10930 * @atomicservice 10931 * @since 11 10932 */ 10933declare interface MenuElement { 10934 /** 10935 * Sets the value of the menu element. 10936 * 10937 * @type { ResourceStr } 10938 * @syscap SystemCapability.ArkUI.ArkUI.Full 10939 * @since 7 10940 */ 10941 /** 10942 * Sets the value of the menu element. 10943 * 10944 * @type { ResourceStr } 10945 * @syscap SystemCapability.ArkUI.ArkUI.Full 10946 * @crossplatform 10947 * @since 10 10948 */ 10949 /** 10950 * Sets the value of the menu element. 10951 * 10952 * @type { ResourceStr } 10953 * @syscap SystemCapability.ArkUI.ArkUI.Full 10954 * @crossplatform 10955 * @atomicservice 10956 * @since 11 10957 */ 10958 value: ResourceStr; 10959 10960 /** 10961 * Sets the icon of the menu element. 10962 * 10963 * @type { ?ResourceStr } 10964 * @syscap SystemCapability.ArkUI.ArkUI.Full 10965 * @crossplatform 10966 * @since 10 10967 */ 10968 /** 10969 * Sets the icon of the menu element. 10970 * 10971 * @type { ?ResourceStr } 10972 * @syscap SystemCapability.ArkUI.ArkUI.Full 10973 * @crossplatform 10974 * @atomicservice 10975 * @since 11 10976 */ 10977 icon?: ResourceStr; 10978 10979 /** 10980 * If the value is true, the menu element is available and can respond to operations such as clicking. 10981 * If the value is false, the menu element is not available and click operations are not responded. 10982 * 10983 * @type { ?boolean } 10984 * @default true 10985 * @syscap SystemCapability.ArkUI.ArkUI.Full 10986 * @crossplatform 10987 * @since 11 10988 */ 10989 enabled?: boolean; 10990 10991 /** 10992 * Method executed by the callback. 10993 * 10994 * @type { function } 10995 * @syscap SystemCapability.ArkUI.ArkUI.Full 10996 * @since 7 10997 */ 10998 /** 10999 * Method executed by the callback. 11000 * 11001 * @type { function } 11002 * @syscap SystemCapability.ArkUI.ArkUI.Full 11003 * @crossplatform 11004 * @since 10 11005 */ 11006 /** 11007 * Method executed by the callback. 11008 * 11009 * @type { function } 11010 * @syscap SystemCapability.ArkUI.ArkUI.Full 11011 * @crossplatform 11012 * @atomicservice 11013 * @since 11 11014 */ 11015 action: () => void; 11016} 11017 11018/** 11019 * Defines the attribute modifier. 11020 * 11021 * @interface AttributeModifier<T> 11022 * @syscap SystemCapability.ArkUI.ArkUI.Full 11023 * @crossplatform 11024 * @since 11 11025 */ 11026declare interface AttributeModifier<T> { 11027 11028 /** 11029 * Defines the normal update attribute function. 11030 * 11031 * @param { T } instance 11032 * @syscap SystemCapability.ArkUI.ArkUI.Full 11033 * @crossplatform 11034 * @since 11 11035 */ 11036 applyNormalAttribute?(instance: T) : void; 11037 11038 /** 11039 * Defines the pressed update attribute function. 11040 * 11041 * @param { T } instance 11042 * @syscap SystemCapability.ArkUI.ArkUI.Full 11043 * @crossplatform 11044 * @since 11 11045 */ 11046 applyPressedAttribute?(instance: T) : void; 11047 11048 /** 11049 * Defines the focused update attribute function. 11050 * 11051 * @param { T } instance 11052 * @syscap SystemCapability.ArkUI.ArkUI.Full 11053 * @crossplatform 11054 * @since 11 11055 */ 11056 applyFocusedAttribute?(instance: T) : void; 11057 11058 /** 11059 * Defines the disabled update attribute function. 11060 * 11061 * @param { T } instance 11062 * @syscap SystemCapability.ArkUI.ArkUI.Full 11063 * @crossplatform 11064 * @since 11 11065 */ 11066 applyDisabledAttribute?(instance: T) : void; 11067 11068 /** 11069 * Defines the selected update attribute function. 11070 * 11071 * @param { T } instance 11072 * @syscap SystemCapability.ArkUI.ArkUI.Full 11073 * @crossplatform 11074 * @since 11 11075 */ 11076 applySelectedAttribute?(instance: T) : void; 11077} 11078 11079/** 11080 * Outline Style 11081 * 11082 * @enum { number } 11083 * @syscap SystemCapability.ArkUI.ArkUI.Full 11084 * @crossplatform 11085 * @since 11 11086 * @form 11087 */ 11088declare enum OutlineStyle { 11089 /** 11090 * Shows as a solid line. 11091 * 11092 * @syscap SystemCapability.ArkUI.ArkUI.Full 11093 * @crossplatform 11094 * @since 11 11095 * @form 11096 */ 11097 SOLID = 0, 11098 11099 /** 11100 * Shows as a series of short square dashed lines. 11101 * 11102 * @syscap SystemCapability.ArkUI.ArkUI.Full 11103 * @crossplatform 11104 * @since 11 11105 * @form 11106 */ 11107 DASHED = 1, 11108 11109 /** 11110 * Displays as a series of dots with a radius of half the borderWidth. 11111 * 11112 * @syscap SystemCapability.ArkUI.ArkUI.Full 11113 * @crossplatform 11114 * @since 11 11115 * @form 11116 */ 11117 DOTTED = 2, 11118} 11119 11120/** 11121 * Defines the drag preview mode. 11122 * 11123 * @enum { number } 11124 * @syscap SystemCapability.ArkUI.ArkUI.Full 11125 * @since 11 11126 */ 11127declare enum DragPreviewMode { 11128 /** 11129 * Default preview mode, let system process preview scale. 11130 * 11131 * @syscap SystemCapability.ArkUI.ArkUI.Full 11132 * @since 11 11133 */ 11134 AUTO = 1, 11135 /** 11136 * Disable system scale to preview panel 11137 * 11138 * @syscap SystemCapability.ArkUI.ArkUI.Full 11139 * @since 11 11140 */ 11141 DISABLE_SCALE = 2, 11142} 11143 11144/** 11145 * Defines the preview options. 11146 * 11147 * @interface DragPreviewOptions 11148 * @syscap SystemCapability.ArkUI.ArkUI.Full 11149 * @since 11 11150 */ 11151declare interface DragPreviewOptions { 11152 /** 11153 * Drag preview mode. 11154 * 11155 * @type { ?DragPreviewMode } 11156 * @syscap SystemCapability.ArkUI.ArkUI.Full 11157 * @since 11 11158 */ 11159 mode?: DragPreviewMode; 11160} 11161 11162/** 11163 * Define the options of invert 11164 * 11165 * @interface InvertOptions 11166 * @syscap SystemCapability.ArkUI.ArkUI.Full 11167 * @since 11 11168 */ 11169declare interface InvertOptions { 11170 11171 /** 11172 * Defines the low value of threshold 11173 * 11174 * @type { number } 11175 * @syscap SystemCapability.ArkUI.ArkUI.Full 11176 * @crossplatform 11177 * @since 11 11178 */ 11179 low: number; 11180 11181 /** 11182 * Defines the high value of threshold 11183 * 11184 * @type { number } 11185 * @syscap SystemCapability.ArkUI.ArkUI.Full 11186 * @crossplatform 11187 * @since 11 11188 */ 11189 high: number; 11190 11191 /** 11192 * Defines the threshold 11193 * 11194 * @type { number } 11195 * @syscap SystemCapability.ArkUI.ArkUI.Full 11196 * @crossplatform 11197 * @since 11 11198 */ 11199 threshold: number; 11200 11201 /** 11202 *Defines the threshold range 11203 * 11204 * @type { number } 11205 * @syscap SystemCapability.ArkUI.ArkUI.Full 11206 * @crossplatform 11207 * @since 11 11208 */ 11209 thresholdRange: number; 11210} 11211 11212/** 11213 * CommonMethod. 11214 * 11215 * @syscap SystemCapability.ArkUI.ArkUI.Full 11216 * @since 7 11217 */ 11218/** 11219 * CommonMethod. 11220 * 11221 * @syscap SystemCapability.ArkUI.ArkUI.Full 11222 * @since 9 11223 * @form 11224 */ 11225/** 11226 * CommonMethod. 11227 * 11228 * @syscap SystemCapability.ArkUI.ArkUI.Full 11229 * @crossplatform 11230 * @since 10 11231 * @form 11232 */ 11233/** 11234 * CommonMethod. 11235 * 11236 * @syscap SystemCapability.ArkUI.ArkUI.Full 11237 * @crossplatform 11238 * @atomicservice 11239 * @since 11 11240 * @form 11241 */ 11242declare class CommonMethod<T> { 11243 /** 11244 * constructor. 11245 * 11246 * @syscap SystemCapability.ArkUI.ArkUI.Full 11247 * @systemapi 11248 * @since 7 11249 */ 11250 /** 11251 * constructor. 11252 * 11253 * @syscap SystemCapability.ArkUI.ArkUI.Full 11254 * @systemapi 11255 * @since 9 11256 * @form 11257 */ 11258 constructor(); 11259 11260 /** 11261 * Sets the width of the current component. 11262 * 11263 * @param { Length } value 11264 * @returns { T } 11265 * @syscap SystemCapability.ArkUI.ArkUI.Full 11266 * @since 7 11267 */ 11268 /** 11269 * Sets the width of the current component. 11270 * 11271 * @param { Length } value 11272 * @returns { T } 11273 * @syscap SystemCapability.ArkUI.ArkUI.Full 11274 * @since 9 11275 * @form 11276 */ 11277 /** 11278 * Sets the width of the current component. 11279 * 11280 * @param { Length } value 11281 * @returns { T } 11282 * @syscap SystemCapability.ArkUI.ArkUI.Full 11283 * @crossplatform 11284 * @since 10 11285 * @form 11286 */ 11287 /** 11288 * Sets the width of the current component. 11289 * 11290 * @param { Length } value 11291 * @returns { T } 11292 * @syscap SystemCapability.ArkUI.ArkUI.Full 11293 * @crossplatform 11294 * @atomicservice 11295 * @since 11 11296 * @form 11297 */ 11298 width(value: Length): T; 11299 11300 /** 11301 * Sets the height of the current component. 11302 * 11303 * @param { Length } value 11304 * @returns { T } 11305 * @syscap SystemCapability.ArkUI.ArkUI.Full 11306 * @since 7 11307 */ 11308 /** 11309 * Sets the height of the current component. 11310 * 11311 * @param { Length } value 11312 * @returns { T } 11313 * @syscap SystemCapability.ArkUI.ArkUI.Full 11314 * @since 9 11315 * @form 11316 */ 11317 /** 11318 * Sets the height of the current component. 11319 * 11320 * @param { Length } value 11321 * @returns { T } 11322 * @syscap SystemCapability.ArkUI.ArkUI.Full 11323 * @crossplatform 11324 * @since 10 11325 * @form 11326 */ 11327 /** 11328 * Sets the height of the current component. 11329 * 11330 * @param { Length } value 11331 * @returns { T } 11332 * @syscap SystemCapability.ArkUI.ArkUI.Full 11333 * @crossplatform 11334 * @atomicservice 11335 * @since 11 11336 * @form 11337 */ 11338 height(value: Length): T; 11339 11340 /** 11341 * Expands the safe area. 11342 * 11343 * @param { Array<SafeAreaType> } types - Indicates the types of the safe area. 11344 * @param { Array<SafeAreaEdge> } edges - Indicates the edges of the safe area. 11345 * @returns { T } The component instance. 11346 * @syscap SystemCapability.ArkUI.ArkUI.Full 11347 * @crossplatform 11348 * @since 10 11349 */ 11350 /** 11351 * Expands the safe area. 11352 * 11353 * @param { Array<SafeAreaType> } types - Indicates the types of the safe area. 11354 * @param { Array<SafeAreaEdge> } edges - Indicates the edges of the safe area. 11355 * @returns { T } The component instance. 11356 * @syscap SystemCapability.ArkUI.ArkUI.Full 11357 * @crossplatform 11358 * @atomicservice 11359 * @since 11 11360 */ 11361 expandSafeArea(types?: Array<SafeAreaType>, edges?: Array<SafeAreaEdge>): T; 11362 11363 /** 11364 * Sets the response region of the current component. 11365 * 11366 * @param { Array<Rectangle> | Rectangle } value 11367 * @returns { T } 11368 * @syscap SystemCapability.ArkUI.ArkUI.Full 11369 * @since 8 11370 */ 11371 /** 11372 * Sets the response region of the current component. 11373 * 11374 * @param { Array<Rectangle> | Rectangle } value 11375 * @returns { T } 11376 * @syscap SystemCapability.ArkUI.ArkUI.Full 11377 * @since 9 11378 * @form 11379 */ 11380 /** 11381 * Sets the response region of the current component. 11382 * 11383 * @param { Array<Rectangle> | Rectangle } value 11384 * @returns { T } 11385 * @syscap SystemCapability.ArkUI.ArkUI.Full 11386 * @crossplatform 11387 * @since 10 11388 * @form 11389 */ 11390 /** 11391 * Sets the response region of the current component. 11392 * 11393 * @param { Array<Rectangle> | Rectangle } value 11394 * @returns { T } 11395 * @syscap SystemCapability.ArkUI.ArkUI.Full 11396 * @crossplatform 11397 * @atomicservice 11398 * @since 11 11399 * @form 11400 */ 11401 responseRegion(value: Array<Rectangle> | Rectangle): T; 11402 11403 /** 11404 * Sets the mouse response region of current component 11405 * 11406 * @param { Array<Rectangle> | Rectangle } value 11407 * @returns { T } return the component attribute 11408 * @syscap SystemCapability.ArkUI.ArkUI.Full 11409 * @crossplatform 11410 * @since 10 11411 */ 11412 /** 11413 * Sets the mouse response region of current component 11414 * 11415 * @param { Array<Rectangle> | Rectangle } value 11416 * @returns { T } return the component attribute 11417 * @syscap SystemCapability.ArkUI.ArkUI.Full 11418 * @crossplatform 11419 * @atomicservice 11420 * @since 11 11421 */ 11422 mouseResponseRegion(value: Array<Rectangle> | Rectangle): T; 11423 11424 /** 11425 * The size of the current component. 11426 * 11427 * @param { SizeOptions } value 11428 * @returns { T } 11429 * @syscap SystemCapability.ArkUI.ArkUI.Full 11430 * @since 7 11431 */ 11432 /** 11433 * The size of the current component. 11434 * 11435 * @param { SizeOptions } value 11436 * @returns { T } 11437 * @syscap SystemCapability.ArkUI.ArkUI.Full 11438 * @since 9 11439 * @form 11440 */ 11441 /** 11442 * The size of the current component. 11443 * 11444 * @param { SizeOptions } value 11445 * @returns { T } 11446 * @syscap SystemCapability.ArkUI.ArkUI.Full 11447 * @crossplatform 11448 * @since 10 11449 * @form 11450 */ 11451 /** 11452 * The size of the current component. 11453 * 11454 * @param { SizeOptions } value 11455 * @returns { T } 11456 * @syscap SystemCapability.ArkUI.ArkUI.Full 11457 * @crossplatform 11458 * @atomicservice 11459 * @since 11 11460 * @form 11461 */ 11462 size(value: SizeOptions): T; 11463 11464 /** 11465 * constraint Size: 11466 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 11467 * 11468 * @param { ConstraintSizeOptions } value 11469 * @returns { T } 11470 * @syscap SystemCapability.ArkUI.ArkUI.Full 11471 * @since 7 11472 */ 11473 /** 11474 * constraint Size: 11475 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 11476 * 11477 * @param { ConstraintSizeOptions } value 11478 * @returns { T } 11479 * @syscap SystemCapability.ArkUI.ArkUI.Full 11480 * @since 9 11481 * @form 11482 */ 11483 /** 11484 * constraint Size: 11485 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 11486 * 11487 * @param { ConstraintSizeOptions } value 11488 * @returns { T } 11489 * @syscap SystemCapability.ArkUI.ArkUI.Full 11490 * @crossplatform 11491 * @since 10 11492 * @form 11493 */ 11494 /** 11495 * constraint Size: 11496 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 11497 * 11498 * @param { ConstraintSizeOptions } value 11499 * @returns { T } 11500 * @syscap SystemCapability.ArkUI.ArkUI.Full 11501 * @crossplatform 11502 * @atomicservice 11503 * @since 11 11504 * @form 11505 */ 11506 constraintSize(value: ConstraintSizeOptions): T; 11507 11508 /** 11509 * Sets the touchable of the current component 11510 * 11511 * @param { boolean } value 11512 * @returns { T } 11513 * @syscap SystemCapability.ArkUI.ArkUI.Full 11514 * @since 7 11515 * @deprecated since 9 11516 * @useinstead hitTestBehavior 11517 */ 11518 touchable(value: boolean): T; 11519 11520 /** 11521 * Defines the component's hit test behavior in touch events. 11522 * 11523 * @param { HitTestMode } value - the hit test mode. 11524 * @returns { T } 11525 * @syscap SystemCapability.ArkUI.ArkUI.Full 11526 * @since 9 11527 */ 11528 /** 11529 * Defines the component's hit test behavior in touch events. 11530 * 11531 * @param { HitTestMode } value - the hit test mode. 11532 * @returns { T } 11533 * @syscap SystemCapability.ArkUI.ArkUI.Full 11534 * @crossplatform 11535 * @since 10 11536 */ 11537 /** 11538 * Defines the component's hit test behavior in touch events. 11539 * 11540 * @param { HitTestMode } value - the hit test mode. 11541 * @returns { T } 11542 * @syscap SystemCapability.ArkUI.ArkUI.Full 11543 * @crossplatform 11544 * @atomicservice 11545 * @since 11 11546 */ 11547 hitTestBehavior(value: HitTestMode): T; 11548 11549 /** 11550 * Defines the pre-touch test of sub component in touch events. 11551 * 11552 * @param { function } event 11553 * @returns { T } 11554 * @syscap SystemCapability.ArkUI.ArkUI.Full 11555 * @crossplatform 11556 * @since 11 11557 */ 11558 onChildTouchTest(event: (value: Array<TouchTestInfo>) => TouchResult): T; 11559 11560 /** 11561 * layout Weight 11562 * 11563 * @param { number | string } value 11564 * @returns { T } 11565 * @syscap SystemCapability.ArkUI.ArkUI.Full 11566 * @since 7 11567 */ 11568 /** 11569 * layout Weight 11570 * 11571 * @param { number | string } value 11572 * @returns { T } 11573 * @syscap SystemCapability.ArkUI.ArkUI.Full 11574 * @since 9 11575 * @form 11576 */ 11577 /** 11578 * layout Weight 11579 * 11580 * @param { number | string } value 11581 * @returns { T } 11582 * @syscap SystemCapability.ArkUI.ArkUI.Full 11583 * @crossplatform 11584 * @since 10 11585 * @form 11586 */ 11587 /** 11588 * layout Weight 11589 * 11590 * @param { number | string } value 11591 * @returns { T } 11592 * @syscap SystemCapability.ArkUI.ArkUI.Full 11593 * @crossplatform 11594 * @atomicservice 11595 * @since 11 11596 * @form 11597 */ 11598 layoutWeight(value: number | string): T; 11599 11600 /** 11601 * Inner margin. 11602 * 11603 * @param { Padding | Length } value 11604 * @returns { T } 11605 * @syscap SystemCapability.ArkUI.ArkUI.Full 11606 * @since 7 11607 */ 11608 /** 11609 * Inner margin. 11610 * 11611 * @param { Padding | Length } value 11612 * @returns { T } 11613 * @syscap SystemCapability.ArkUI.ArkUI.Full 11614 * @since 9 11615 * @form 11616 */ 11617 /** 11618 * Inner margin. 11619 * 11620 * @param { Padding | Length } value 11621 * @returns { T } 11622 * @syscap SystemCapability.ArkUI.ArkUI.Full 11623 * @crossplatform 11624 * @since 10 11625 * @form 11626 */ 11627 /** 11628 * Inner margin. 11629 * 11630 * @param { Padding | Length } value 11631 * @returns { T } 11632 * @syscap SystemCapability.ArkUI.ArkUI.Full 11633 * @crossplatform 11634 * @atomicservice 11635 * @since 11 11636 * @form 11637 */ 11638 padding(value: Padding | Length): T; 11639 11640 /** 11641 * Outer Margin. 11642 * 11643 * @param { Margin | Length } value 11644 * @returns { T } 11645 * @syscap SystemCapability.ArkUI.ArkUI.Full 11646 * @since 7 11647 */ 11648 /** 11649 * Outer Margin. 11650 * 11651 * @param { Margin | Length } value 11652 * @returns { T } 11653 * @syscap SystemCapability.ArkUI.ArkUI.Full 11654 * @since 9 11655 * @form 11656 */ 11657 /** 11658 * Outer Margin. 11659 * 11660 * @param { Margin | Length } value 11661 * @returns { T } 11662 * @syscap SystemCapability.ArkUI.ArkUI.Full 11663 * @crossplatform 11664 * @since 10 11665 * @form 11666 */ 11667 /** 11668 * Outer Margin. 11669 * 11670 * @param { Margin | Length } value 11671 * @returns { T } 11672 * @syscap SystemCapability.ArkUI.ArkUI.Full 11673 * @crossplatform 11674 * @atomicservice 11675 * @since 11 11676 * @form 11677 */ 11678 margin(value: Margin | Length): T; 11679 11680 /** 11681 * Background. 11682 * 11683 * @param { CustomBuilder } builder 11684 * @param { object } options 11685 * @returns { T } 11686 * @syscap SystemCapability.ArkUI.ArkUI.Full 11687 * @crossplatform 11688 * @since 10 11689 */ 11690 /** 11691 * Background. 11692 * 11693 * @param { CustomBuilder } builder 11694 * @param { object } options 11695 * @returns { T } 11696 * @syscap SystemCapability.ArkUI.ArkUI.Full 11697 * @crossplatform 11698 * @atomicservice 11699 * @since 11 11700 */ 11701 background(builder: CustomBuilder, options?: { align?: Alignment }): T; 11702 11703 /** 11704 * Background color 11705 * 11706 * @param { ResourceColor } value 11707 * @returns { T } 11708 * @syscap SystemCapability.ArkUI.ArkUI.Full 11709 * @since 7 11710 */ 11711 /** 11712 * Background color 11713 * 11714 * @param { ResourceColor } value 11715 * @returns { T } 11716 * @syscap SystemCapability.ArkUI.ArkUI.Full 11717 * @since 9 11718 * @form 11719 */ 11720 /** 11721 * Background color 11722 * 11723 * @param { ResourceColor } value 11724 * @returns { T } 11725 * @syscap SystemCapability.ArkUI.ArkUI.Full 11726 * @crossplatform 11727 * @since 10 11728 * @form 11729 */ 11730 /** 11731 * Background color 11732 * 11733 * @param { ResourceColor } value 11734 * @returns { T } 11735 * @syscap SystemCapability.ArkUI.ArkUI.Full 11736 * @crossplatform 11737 * @atomicservice 11738 * @since 11 11739 * @form 11740 */ 11741 backgroundColor(value: ResourceColor): T; 11742 11743 /** 11744 * PixelRound 11745 * 11746 * @param { PixelRoundPolicy } value 11747 * @returns { T } 11748 * @syscap SystemCapability.ArkUI.ArkUI.Full 11749 * @crossplatform 11750 * @atomicservice 11751 * @since 11 11752 * @form 11753 */ 11754 pixelRound(value: PixelRoundPolicy): T; 11755 11756 /** 11757 * Background image 11758 * src: Image address url 11759 * 11760 * @param { ResourceStr } src 11761 * @param { ImageRepeat } repeat 11762 * @returns { T } 11763 * @syscap SystemCapability.ArkUI.ArkUI.Full 11764 * @since 7 11765 */ 11766 /** 11767 * Background image 11768 * src: Image address url 11769 * 11770 * @param { ResourceStr } src 11771 * @param { ImageRepeat } repeat 11772 * @returns { T } 11773 * @syscap SystemCapability.ArkUI.ArkUI.Full 11774 * @since 9 11775 * @form 11776 */ 11777 /** 11778 * Background image 11779 * src: Image address url 11780 * 11781 * @param { ResourceStr } src 11782 * @param { ImageRepeat } repeat 11783 * @returns { T } 11784 * @syscap SystemCapability.ArkUI.ArkUI.Full 11785 * @crossplatform 11786 * @since 10 11787 * @form 11788 */ 11789 /** 11790 * Background image 11791 * src: Image address url 11792 * 11793 * @param { ResourceStr } src 11794 * @param { ImageRepeat } repeat 11795 * @returns { T } 11796 * @syscap SystemCapability.ArkUI.ArkUI.Full 11797 * @crossplatform 11798 * @atomicservice 11799 * @since 11 11800 * @form 11801 */ 11802 backgroundImage(src: ResourceStr, repeat?: ImageRepeat): T; 11803 11804 /** 11805 * Background image size 11806 * 11807 * @param { SizeOptions | ImageSize } value 11808 * @returns { T } 11809 * @syscap SystemCapability.ArkUI.ArkUI.Full 11810 * @since 7 11811 */ 11812 /** 11813 * Background image size 11814 * 11815 * @param { SizeOptions | ImageSize } value 11816 * @returns { T } 11817 * @syscap SystemCapability.ArkUI.ArkUI.Full 11818 * @since 9 11819 * @form 11820 */ 11821 /** 11822 * Background image size 11823 * 11824 * @param { SizeOptions | ImageSize } value 11825 * @returns { T } 11826 * @syscap SystemCapability.ArkUI.ArkUI.Full 11827 * @crossplatform 11828 * @since 10 11829 * @form 11830 */ 11831 /** 11832 * Background image size 11833 * 11834 * @param { SizeOptions | ImageSize } value 11835 * @returns { T } 11836 * @syscap SystemCapability.ArkUI.ArkUI.Full 11837 * @crossplatform 11838 * @atomicservice 11839 * @since 11 11840 * @form 11841 */ 11842 backgroundImageSize(value: SizeOptions | ImageSize): T; 11843 11844 /** 11845 * Background image position 11846 * x:Horizontal coordinate;y:Vertical axis coordinate. 11847 * 11848 * @param { Position | Alignment } value 11849 * @returns { T } 11850 * @syscap SystemCapability.ArkUI.ArkUI.Full 11851 * @since 7 11852 */ 11853 /** 11854 * Background image position 11855 * x:Horizontal coordinate;y:Vertical axis coordinate. 11856 * 11857 * @param { Position | Alignment } value 11858 * @returns { T } 11859 * @syscap SystemCapability.ArkUI.ArkUI.Full 11860 * @since 9 11861 * @form 11862 */ 11863 /** 11864 * Background image position 11865 * x:Horizontal coordinate;y:Vertical axis coordinate. 11866 * 11867 * @param { Position | Alignment } value 11868 * @returns { T } 11869 * @syscap SystemCapability.ArkUI.ArkUI.Full 11870 * @crossplatform 11871 * @since 10 11872 * @form 11873 */ 11874 /** 11875 * Background image position 11876 * x:Horizontal coordinate;y:Vertical axis coordinate. 11877 * 11878 * @param { Position | Alignment } value 11879 * @returns { T } 11880 * @syscap SystemCapability.ArkUI.ArkUI.Full 11881 * @crossplatform 11882 * @atomicservice 11883 * @since 11 11884 * @form 11885 */ 11886 backgroundImagePosition(value: Position | Alignment): T; 11887 11888 /** 11889 * Background blur style. 11890 * blurStyle:Blur style type. 11891 * 11892 * @param { BlurStyle } value 11893 * @param { BackgroundBlurStyleOptions } options 11894 * @returns { T } 11895 * @syscap SystemCapability.ArkUI.ArkUI.Full 11896 * @since 9 11897 * @form 11898 */ 11899 /** 11900 * Background blur style. 11901 * blurStyle:Blur style type. 11902 * 11903 * @param { BlurStyle } value 11904 * @param { BackgroundBlurStyleOptions } options 11905 * @returns { T } 11906 * @syscap SystemCapability.ArkUI.ArkUI.Full 11907 * @crossplatform 11908 * @since 10 11909 * @form 11910 */ 11911 /** 11912 * Background blur style. 11913 * blurStyle:Blur style type. 11914 * 11915 * @param { BlurStyle } value 11916 * @param { BackgroundBlurStyleOptions } options 11917 * @returns { T } 11918 * @syscap SystemCapability.ArkUI.ArkUI.Full 11919 * @crossplatform 11920 * @atomicservice 11921 * @since 11 11922 * @form 11923 */ 11924 backgroundBlurStyle(value: BlurStyle, options?: BackgroundBlurStyleOptions): T; 11925 11926 /** 11927 * options:background effect options. 11928 * 11929 * @param { BackgroundEffectOptions } options - options indicates the effect options. 11930 * @returns { T } 11931 * @syscap SystemCapability.ArkUI.ArkUI.Full 11932 * @crossplatform 11933 * @since 11 11934 */ 11935 backgroundEffect(options: BackgroundEffectOptions): T; 11936 11937 11938 /** 11939 * Foreground blur style. 11940 * blurStyle:Blur style type. 11941 * 11942 * @param { BlurStyle } value 11943 * @param { ForegroundBlurStyleOptions } options 11944 * @returns { T } 11945 * @syscap SystemCapability.ArkUI.ArkUI.Full 11946 * @crossplatform 11947 * @since 10 11948 */ 11949 /** 11950 * Foreground blur style. 11951 * blurStyle:Blur style type. 11952 * 11953 * @param { BlurStyle } value 11954 * @param { ForegroundBlurStyleOptions } options 11955 * @returns { T } 11956 * @syscap SystemCapability.ArkUI.ArkUI.Full 11957 * @crossplatform 11958 * @atomicservice 11959 * @since 11 11960 */ 11961 foregroundBlurStyle(value: BlurStyle, options?: ForegroundBlurStyleOptions): T; 11962 11963 /** 11964 * Opacity 11965 * 11966 * @param { number | Resource } value 11967 * @returns { T } 11968 * @syscap SystemCapability.ArkUI.ArkUI.Full 11969 * @since 7 11970 */ 11971 /** 11972 * Opacity 11973 * 11974 * @param { number | Resource } value 11975 * @returns { T } 11976 * @syscap SystemCapability.ArkUI.ArkUI.Full 11977 * @since 9 11978 * @form 11979 */ 11980 /** 11981 * Opacity 11982 * 11983 * @param { number | Resource } value 11984 * @returns { T } 11985 * @syscap SystemCapability.ArkUI.ArkUI.Full 11986 * @crossplatform 11987 * @since 10 11988 * @form 11989 */ 11990 /** 11991 * Opacity 11992 * 11993 * @param { number | Resource } value 11994 * @returns { T } 11995 * @syscap SystemCapability.ArkUI.ArkUI.Full 11996 * @crossplatform 11997 * @atomicservice 11998 * @since 11 11999 * @form 12000 */ 12001 opacity(value: number | Resource): T; 12002 12003 /** 12004 * Opacity 12005 * width:Border width;color:Border color;radius:Border radius; 12006 * 12007 * @param { BorderOptions } value 12008 * @returns { T } 12009 * @syscap SystemCapability.ArkUI.ArkUI.Full 12010 * @since 7 12011 */ 12012 /** 12013 * Opacity 12014 * width:Border width;color:Border color;radius:Border radius; 12015 * 12016 * @param { BorderOptions } value 12017 * @returns { T } 12018 * @syscap SystemCapability.ArkUI.ArkUI.Full 12019 * @since 9 12020 * @form 12021 */ 12022 /** 12023 * Opacity 12024 * width:Border width;color:Border color;radius:Border radius; 12025 * 12026 * @param { BorderOptions } value 12027 * @returns { T } 12028 * @syscap SystemCapability.ArkUI.ArkUI.Full 12029 * @crossplatform 12030 * @since 10 12031 * @form 12032 */ 12033 /** 12034 * Opacity 12035 * width:Border width;color:Border color;radius:Border radius; 12036 * 12037 * @param { BorderOptions } value 12038 * @returns { T } 12039 * @syscap SystemCapability.ArkUI.ArkUI.Full 12040 * @crossplatform 12041 * @atomicservice 12042 * @since 11 12043 * @form 12044 */ 12045 border(value: BorderOptions): T; 12046 12047 /** 12048 * Border style 12049 * 12050 * @param { BorderStyle } value 12051 * @returns { T } 12052 * @syscap SystemCapability.ArkUI.ArkUI.Full 12053 * @since 7 12054 */ 12055 /** 12056 * Border style 12057 * 12058 * @param { BorderStyle | EdgeStyles } value 12059 * @returns { T } 12060 * @syscap SystemCapability.ArkUI.ArkUI.Full 12061 * @since 9 12062 * @form 12063 */ 12064 /** 12065 * Border style 12066 * 12067 * @param { BorderStyle | EdgeStyles } value 12068 * @returns { T } 12069 * @syscap SystemCapability.ArkUI.ArkUI.Full 12070 * @crossplatform 12071 * @since 10 12072 * @form 12073 */ 12074 /** 12075 * Border style 12076 * 12077 * @param { BorderStyle | EdgeStyles } value 12078 * @returns { T } 12079 * @syscap SystemCapability.ArkUI.ArkUI.Full 12080 * @crossplatform 12081 * @atomicservice 12082 * @since 11 12083 * @form 12084 */ 12085 borderStyle(value: BorderStyle | EdgeStyles): T; 12086 12087 /** 12088 * Border width 12089 * 12090 * @param { Length } value 12091 * @returns { T } 12092 * @syscap SystemCapability.ArkUI.ArkUI.Full 12093 * @since 7 12094 */ 12095 /** 12096 * Border width 12097 * 12098 * @param { Length | EdgeWidths } value 12099 * @returns { T } 12100 * @syscap SystemCapability.ArkUI.ArkUI.Full 12101 * @since 9 12102 * @form 12103 */ 12104 /** 12105 * Border width 12106 * 12107 * @param { Length | EdgeWidths } value 12108 * @returns { T } 12109 * @syscap SystemCapability.ArkUI.ArkUI.Full 12110 * @crossplatform 12111 * @since 10 12112 * @form 12113 */ 12114 /** 12115 * Border width 12116 * 12117 * @param { Length | EdgeWidths } value 12118 * @returns { T } 12119 * @syscap SystemCapability.ArkUI.ArkUI.Full 12120 * @crossplatform 12121 * @atomicservice 12122 * @since 11 12123 * @form 12124 */ 12125 borderWidth(value: Length | EdgeWidths): T; 12126 12127 /** 12128 * Border color 12129 * 12130 * @param { ResourceColor } value 12131 * @returns { T } 12132 * @syscap SystemCapability.ArkUI.ArkUI.Full 12133 * @since 7 12134 */ 12135 /** 12136 * Border color 12137 * 12138 * @param { ResourceColor | EdgeColors } value 12139 * @returns { T } 12140 * @syscap SystemCapability.ArkUI.ArkUI.Full 12141 * @since 9 12142 * @form 12143 */ 12144 /** 12145 * Border color 12146 * 12147 * @param { ResourceColor | EdgeColors } value 12148 * @returns { T } 12149 * @syscap SystemCapability.ArkUI.ArkUI.Full 12150 * @crossplatform 12151 * @since 10 12152 * @form 12153 */ 12154 /** 12155 * Border color 12156 * 12157 * @param { ResourceColor | EdgeColors } value 12158 * @returns { T } 12159 * @syscap SystemCapability.ArkUI.ArkUI.Full 12160 * @crossplatform 12161 * @atomicservice 12162 * @since 11 12163 * @form 12164 */ 12165 borderColor(value: ResourceColor | EdgeColors): T; 12166 12167 /** 12168 * Border radius 12169 * 12170 * @param { Length } value 12171 * @returns { T } 12172 * @syscap SystemCapability.ArkUI.ArkUI.Full 12173 * @since 7 12174 */ 12175 /** 12176 * Border radius 12177 * 12178 * @param { Length | BorderRadiuses } value 12179 * @returns { T } 12180 * @syscap SystemCapability.ArkUI.ArkUI.Full 12181 * @since 9 12182 * @form 12183 */ 12184 /** 12185 * Border radius 12186 * 12187 * @param { Length | BorderRadiuses } value 12188 * @returns { T } 12189 * @syscap SystemCapability.ArkUI.ArkUI.Full 12190 * @crossplatform 12191 * @since 10 12192 * @form 12193 */ 12194 /** 12195 * Border radius 12196 * 12197 * @param { Length | BorderRadiuses } value 12198 * @returns { T } 12199 * @syscap SystemCapability.ArkUI.ArkUI.Full 12200 * @crossplatform 12201 * @atomicservice 12202 * @since 11 12203 * @form 12204 */ 12205 borderRadius(value: Length | BorderRadiuses): T; 12206 12207 /** 12208 * Border image 12209 * 12210 * @param { BorderImageOption } value 12211 * @returns { T } 12212 * @syscap SystemCapability.ArkUI.ArkUI.Full 12213 * @since 9 12214 * @form 12215 */ 12216 /** 12217 * Border image 12218 * 12219 * @param { BorderImageOption } value 12220 * @returns { T } 12221 * @syscap SystemCapability.ArkUI.ArkUI.Full 12222 * @crossplatform 12223 * @since 10 12224 * @form 12225 */ 12226 /** 12227 * Border image 12228 * 12229 * @param { BorderImageOption } value 12230 * @returns { T } 12231 * @syscap SystemCapability.ArkUI.ArkUI.Full 12232 * @crossplatform 12233 * @atomicservice 12234 * @since 11 12235 * @form 12236 */ 12237 borderImage(value: BorderImageOption): T; 12238 12239 /** 12240 * Opacity 12241 * width:Outline width;color:Outline color;radius:Outline radius; 12242 * 12243 * @param { OutlineOptions } value 12244 * @returns { T } 12245 * @syscap SystemCapability.ArkUI.ArkUI.Full 12246 * @crossplatform 12247 * @since 11 12248 * @form 12249 */ 12250 outline(value: OutlineOptions): T; 12251 12252 /** 12253 * Outline style 12254 * 12255 * @param { OutlineStyle | EdgeOutlineStyles } value 12256 * @returns { T } 12257 * @syscap SystemCapability.ArkUI.ArkUI.Full 12258 * @crossplatform 12259 * @since 11 12260 * @form 12261 */ 12262 outlineStyle(value: OutlineStyle | EdgeOutlineStyles): T; 12263 12264 /** 12265 * Outline width 12266 * 12267 * @param { Dimension | EdgeOutlineWidths } value 12268 * @returns { T } 12269 * @syscap SystemCapability.ArkUI.ArkUI.Full 12270 * @crossplatform 12271 * @since 11 12272 * @form 12273 */ 12274 outlineWidth(value: Dimension | EdgeOutlineWidths): T; 12275 12276 /** 12277 * Outline color 12278 * 12279 * @param { ResourceColor | EdgeColors } value 12280 * @returns { T } 12281 * @syscap SystemCapability.ArkUI.ArkUI.Full 12282 * @crossplatform 12283 * @since 11 12284 * @form 12285 */ 12286 outlineColor(value: ResourceColor | EdgeColors): T; 12287 12288 /** 12289 * Outline radius 12290 * 12291 * @param { Dimension | OutlineRadiuses } value 12292 * @returns { T } 12293 * @syscap SystemCapability.ArkUI.ArkUI.Full 12294 * @crossplatform 12295 * @since 11 12296 * @form 12297 */ 12298 outlineRadius(value: Dimension | OutlineRadiuses): T; 12299 12300 /** 12301 * Provides the general foreground color capability of UI components, and assigns color values 12302 * according to the characteristics of components. 12303 * 12304 * @param { ResourceColor | ColoringStrategy } value - indicates the color or color selection strategy 12305 * @returns { T } 12306 * @syscap SystemCapability.ArkUI.ArkUI.Full 12307 * @crossplatform 12308 * @since 10 12309 */ 12310 /** 12311 * Provides the general foreground color capability of UI components, and assigns color values 12312 * according to the characteristics of components. 12313 * 12314 * @param { ResourceColor | ColoringStrategy } value - indicates the color or color selection strategy 12315 * @returns { T } 12316 * @syscap SystemCapability.ArkUI.ArkUI.Full 12317 * @crossplatform 12318 * @atomicservice 12319 * @since 11 12320 */ 12321 foregroundColor(value: ResourceColor | ColoringStrategy): T; 12322 12323 /** 12324 * Trigger a click event when a click is clicked. 12325 * 12326 * @param { function } event 12327 * @returns { T } 12328 * @syscap SystemCapability.ArkUI.ArkUI.Full 12329 * @since 7 12330 */ 12331 /** 12332 * Trigger a click event when a click is clicked. 12333 * 12334 * @param { function } event 12335 * @returns { T } 12336 * @syscap SystemCapability.ArkUI.ArkUI.Full 12337 * @since 9 12338 * @form 12339 */ 12340 /** 12341 * Trigger a click event when a click is clicked. 12342 * 12343 * @param { function } event 12344 * @returns { T } 12345 * @syscap SystemCapability.ArkUI.ArkUI.Full 12346 * @crossplatform 12347 * @since 10 12348 * @form 12349 */ 12350 /** 12351 * Trigger a click event when a click is clicked. 12352 * 12353 * @param { function } event 12354 * @returns { T } 12355 * @syscap SystemCapability.ArkUI.ArkUI.Full 12356 * @crossplatform 12357 * @atomicservice 12358 * @since 11 12359 * @form 12360 */ 12361 onClick(event: (event: ClickEvent) => void): T; 12362 12363 /** 12364 * Trigger a hover event. 12365 * 12366 * @param { function } event 12367 * @returns { T } 12368 * @syscap SystemCapability.ArkUI.ArkUI.Full 12369 * @since 8 12370 */ 12371 /** 12372 * Trigger a hover event. 12373 * 12374 * @param { function } event 12375 * @returns { T } 12376 * @syscap SystemCapability.ArkUI.ArkUI.Full 12377 * @crossplatform 12378 * @atomicservice 12379 * @since 11 12380 */ 12381 onHover(event: (isHover: boolean, event: HoverEvent) => void): T; 12382 12383 /** 12384 * Set hover effect. 12385 * 12386 * @param { HoverEffect } value 12387 * @returns { T } 12388 * @syscap SystemCapability.ArkUI.ArkUI.Full 12389 * @since 8 12390 */ 12391 /** 12392 * Set hover effect. 12393 * 12394 * @param { HoverEffect } value 12395 * @returns { T } 12396 * @syscap SystemCapability.ArkUI.ArkUI.Full 12397 * @crossplatform 12398 * @since 10 12399 */ 12400 /** 12401 * Set hover effect. 12402 * 12403 * @param { HoverEffect } value 12404 * @returns { T } 12405 * @syscap SystemCapability.ArkUI.ArkUI.Full 12406 * @crossplatform 12407 * @atomicservice 12408 * @since 11 12409 */ 12410 hoverEffect(value: HoverEffect): T; 12411 12412 /** 12413 * Trigger a mouse event. 12414 * 12415 * @param { function } event 12416 * @returns { T } 12417 * @syscap SystemCapability.ArkUI.ArkUI.Full 12418 * @since 8 12419 */ 12420 /** 12421 * Trigger a mouse event. 12422 * 12423 * @param { function } event 12424 * @returns { T } 12425 * @syscap SystemCapability.ArkUI.ArkUI.Full 12426 * @atomicservice 12427 * @since 11 12428 */ 12429 onMouse(event: (event: MouseEvent) => void): T; 12430 12431 /** 12432 * Trigger a touch event when touched. 12433 * 12434 * @param { function } event 12435 * @returns { T } 12436 * @syscap SystemCapability.ArkUI.ArkUI.Full 12437 * @since 7 12438 */ 12439 /** 12440 * Trigger a touch event when touched. 12441 * 12442 * @param { function } event 12443 * @returns { T } 12444 * @syscap SystemCapability.ArkUI.ArkUI.Full 12445 * @crossplatform 12446 * @since 10 12447 */ 12448 /** 12449 * Trigger a touch event when touched. 12450 * 12451 * @param { function } event 12452 * @returns { T } 12453 * @syscap SystemCapability.ArkUI.ArkUI.Full 12454 * @crossplatform 12455 * @atomicservice 12456 * @since 11 12457 */ 12458 onTouch(event: (event: TouchEvent) => void): T; 12459 12460 /** 12461 * Keyboard input 12462 * 12463 * @param { function } event 12464 * @returns { T } 12465 * @syscap SystemCapability.ArkUI.ArkUI.Full 12466 * @since 7 12467 */ 12468 /** 12469 * Keyboard input 12470 * 12471 * @param { function } event 12472 * @returns { T } 12473 * @syscap SystemCapability.ArkUI.ArkUI.Full 12474 * @crossplatform 12475 * @since 10 12476 */ 12477 /** 12478 * Keyboard input 12479 * 12480 * @param { function } event 12481 * @returns { T } 12482 * @syscap SystemCapability.ArkUI.ArkUI.Full 12483 * @crossplatform 12484 * @atomicservice 12485 * @since 11 12486 */ 12487 onKeyEvent(event: (event: KeyEvent) => void): T; 12488 12489 /** 12490 * Set focusable. 12491 * 12492 * @param { boolean } value 12493 * @returns { T } 12494 * @syscap SystemCapability.ArkUI.ArkUI.Full 12495 * @since 8 12496 */ 12497 /** 12498 * Set focusable. 12499 * 12500 * @param { boolean } value 12501 * @returns { T } 12502 * @syscap SystemCapability.ArkUI.ArkUI.Full 12503 * @crossplatform 12504 * @since 10 12505 */ 12506 /** 12507 * Set focusable. 12508 * 12509 * @param { boolean } value 12510 * @returns { T } 12511 * @syscap SystemCapability.ArkUI.ArkUI.Full 12512 * @crossplatform 12513 * @atomicservice 12514 * @since 11 12515 */ 12516 focusable(value: boolean): T; 12517 12518 /** 12519 * Trigger a event when got focus. 12520 * 12521 * @param { function } event 12522 * @returns { T } 12523 * @syscap SystemCapability.ArkUI.ArkUI.Full 12524 * @since 8 12525 */ 12526 /** 12527 * Trigger a event when got focus. 12528 * 12529 * @param { function } event 12530 * @returns { T } 12531 * @syscap SystemCapability.ArkUI.ArkUI.Full 12532 * @crossplatform 12533 * @since 10 12534 */ 12535 /** 12536 * Trigger a event when got focus. 12537 * 12538 * @param { function } event 12539 * @returns { T } 12540 * @syscap SystemCapability.ArkUI.ArkUI.Full 12541 * @crossplatform 12542 * @atomicservice 12543 * @since 11 12544 */ 12545 onFocus(event: () => void): T; 12546 12547 /** 12548 * Trigger a event when lose focus. 12549 * 12550 * @param { function } event 12551 * @returns { T } 12552 * @syscap SystemCapability.ArkUI.ArkUI.Full 12553 * @since 8 12554 */ 12555 /** 12556 * Trigger a event when lose focus. 12557 * 12558 * @param { function } event 12559 * @returns { T } 12560 * @syscap SystemCapability.ArkUI.ArkUI.Full 12561 * @crossplatform 12562 * @since 10 12563 */ 12564 /** 12565 * Trigger a event when lose focus. 12566 * 12567 * @param { function } event 12568 * @returns { T } 12569 * @syscap SystemCapability.ArkUI.ArkUI.Full 12570 * @crossplatform 12571 * @atomicservice 12572 * @since 11 12573 */ 12574 onBlur(event: () => void): T; 12575 12576 /** 12577 * Set focus index by key tab. 12578 * 12579 * @param { number } index 12580 * @returns { T } 12581 * @syscap SystemCapability.ArkUI.ArkUI.Full 12582 * @since 9 12583 */ 12584 /** 12585 * Set focus index by key tab. 12586 * 12587 * @param { number } index 12588 * @returns { T } 12589 * @syscap SystemCapability.ArkUI.ArkUI.Full 12590 * @crossplatform 12591 * @since 10 12592 */ 12593 /** 12594 * Set focus index by key tab. 12595 * 12596 * @param { number } index 12597 * @returns { T } 12598 * @syscap SystemCapability.ArkUI.ArkUI.Full 12599 * @crossplatform 12600 * @atomicservice 12601 * @since 11 12602 */ 12603 tabIndex(index: number): T; 12604 12605 /** 12606 * Set default focused component when a page create. 12607 * 12608 * @param { boolean } value 12609 * @returns { T } 12610 * @syscap SystemCapability.ArkUI.ArkUI.Full 12611 * @since 9 12612 */ 12613 /** 12614 * Set default focused component when a page create. 12615 * 12616 * @param { boolean } value 12617 * @returns { T } 12618 * @syscap SystemCapability.ArkUI.ArkUI.Full 12619 * @crossplatform 12620 * @since 10 12621 */ 12622 /** 12623 * Set default focused component when a page create. 12624 * 12625 * @param { boolean } value 12626 * @returns { T } 12627 * @syscap SystemCapability.ArkUI.ArkUI.Full 12628 * @crossplatform 12629 * @atomicservice 12630 * @since 11 12631 */ 12632 defaultFocus(value: boolean): T; 12633 12634 /** 12635 * Set default focused component when focus on a focus group. 12636 * 12637 * @param { boolean } value 12638 * @returns { T } 12639 * @syscap SystemCapability.ArkUI.ArkUI.Full 12640 * @since 9 12641 */ 12642 /** 12643 * Set default focused component when focus on a focus group. 12644 * 12645 * @param { boolean } value 12646 * @returns { T } 12647 * @syscap SystemCapability.ArkUI.ArkUI.Full 12648 * @crossplatform 12649 * @since 10 12650 */ 12651 /** 12652 * Set default focused component when focus on a focus group. 12653 * 12654 * @param { boolean } value 12655 * @returns { T } 12656 * @syscap SystemCapability.ArkUI.ArkUI.Full 12657 * @crossplatform 12658 * @atomicservice 12659 * @since 11 12660 */ 12661 groupDefaultFocus(value: boolean): T; 12662 12663 /** 12664 * Set a component focused when the component be touched. 12665 * 12666 * @param { boolean } value 12667 * @returns { T } 12668 * @syscap SystemCapability.ArkUI.ArkUI.Full 12669 * @since 9 12670 */ 12671 /** 12672 * Set a component focused when the component be touched. 12673 * 12674 * @param { boolean } value 12675 * @returns { T } 12676 * @syscap SystemCapability.ArkUI.ArkUI.Full 12677 * @crossplatform 12678 * @since 10 12679 */ 12680 /** 12681 * Set a component focused when the component be touched. 12682 * 12683 * @param { boolean } value 12684 * @returns { T } 12685 * @syscap SystemCapability.ArkUI.ArkUI.Full 12686 * @crossplatform 12687 * @atomicservice 12688 * @since 11 12689 */ 12690 focusOnTouch(value: boolean): T; 12691 12692 /**git 12693 * animation 12694 * 12695 * @param { AnimateParam } value 12696 * @returns { T } 12697 * @syscap SystemCapability.ArkUI.ArkUI.Full 12698 * @since 7 12699 */ 12700 /** 12701 * animation 12702 * 12703 * @param { AnimateParam } value 12704 * @returns { T } 12705 * @syscap SystemCapability.ArkUI.ArkUI.Full 12706 * @since 9 12707 * @form 12708 */ 12709 /** 12710 * animation 12711 * 12712 * @param { AnimateParam } value 12713 * @returns { T } 12714 * @syscap SystemCapability.ArkUI.ArkUI.Full 12715 * @crossplatform 12716 * @since 10 12717 * @form 12718 */ 12719 /** 12720 * animation 12721 * 12722 * @param { AnimateParam } value 12723 * @returns { T } 12724 * @syscap SystemCapability.ArkUI.ArkUI.Full 12725 * @crossplatform 12726 * @atomicservice 12727 * @since 11 12728 * @form 12729 */ 12730 animation(value: AnimateParam): T; 12731 12732 /** 12733 * Transition parameter 12734 * 12735 * @param { TransitionOptions | TransitionEffect } value 12736 * @returns { T } 12737 * @syscap SystemCapability.ArkUI.ArkUI.Full 12738 * @since 7 12739 */ 12740 /** 12741 * Transition parameter 12742 * 12743 * @param { TransitionOptions | TransitionEffect } value - transition options 12744 * @returns { T } 12745 * @syscap SystemCapability.ArkUI.ArkUI.Full 12746 * @since 9 12747 * @form 12748 */ 12749 /** 12750 * Transition parameter 12751 * 12752 * @param { TransitionOptions | TransitionEffect } value - transition options or transition effect 12753 * @returns { T } 12754 * @syscap SystemCapability.ArkUI.ArkUI.Full 12755 * @crossplatform 12756 * @since 10 12757 * @form 12758 */ 12759 /** 12760 * Transition parameter 12761 * 12762 * @param { TransitionOptions | TransitionEffect } value - transition options or transition effect 12763 * @returns { T } 12764 * @syscap SystemCapability.ArkUI.ArkUI.Full 12765 * @crossplatform 12766 * @atomicservice 12767 * @since 11 12768 * @form 12769 */ 12770 transition(value: TransitionOptions | TransitionEffect): T; 12771 12772 /** 12773 * Bind gesture recognition. 12774 * gesture:Bound Gesture Type,mask:GestureMask; 12775 * 12776 * @param { GestureType } gesture 12777 * @param { GestureMask } mask 12778 * @returns { T } 12779 * @syscap SystemCapability.ArkUI.ArkUI.Full 12780 * @since 7 12781 */ 12782 /** 12783 * Bind gesture recognition. 12784 * gesture:Bound Gesture Type,mask:GestureMask; 12785 * 12786 * @param { GestureType } gesture 12787 * @param { GestureMask } mask 12788 * @returns { T } 12789 * @syscap SystemCapability.ArkUI.ArkUI.Full 12790 * @crossplatform 12791 * @since 10 12792 */ 12793 /** 12794 * Bind gesture recognition. 12795 * gesture:Bound Gesture Type,mask:GestureMask; 12796 * 12797 * @param { GestureType } gesture 12798 * @param { GestureMask } mask 12799 * @returns { T } 12800 * @syscap SystemCapability.ArkUI.ArkUI.Full 12801 * @crossplatform 12802 * @atomicservice 12803 * @since 11 12804 */ 12805 gesture(gesture: GestureType, mask?: GestureMask): T; 12806 12807 /** 12808 * Binding Preferential Recognition Gestures 12809 * gesture:Bound Gesture Type,mask:GestureMask; 12810 * 12811 * @param { GestureType } gesture 12812 * @param { GestureMask } mask 12813 * @returns { T } 12814 * @syscap SystemCapability.ArkUI.ArkUI.Full 12815 * @since 7 12816 */ 12817 /** 12818 * Binding Preferential Recognition Gestures 12819 * gesture:Bound Gesture Type,mask:GestureMask; 12820 * 12821 * @param { GestureType } gesture 12822 * @param { GestureMask } mask 12823 * @returns { T } 12824 * @syscap SystemCapability.ArkUI.ArkUI.Full 12825 * @crossplatform 12826 * @since 10 12827 */ 12828 /** 12829 * Binding Preferential Recognition Gestures 12830 * gesture:Bound Gesture Type,mask:GestureMask; 12831 * 12832 * @param { GestureType } gesture 12833 * @param { GestureMask } mask 12834 * @returns { T } 12835 * @syscap SystemCapability.ArkUI.ArkUI.Full 12836 * @crossplatform 12837 * @atomicservice 12838 * @since 11 12839 */ 12840 priorityGesture(gesture: GestureType, mask?: GestureMask): T; 12841 12842 /** 12843 * Binding gestures that can be triggered simultaneously with internal component gestures 12844 * gesture:Bound Gesture Type,mask:GestureMask; 12845 * 12846 * @param { GestureType } gesture 12847 * @param { GestureMask } mask 12848 * @returns { T } 12849 * @syscap SystemCapability.ArkUI.ArkUI.Full 12850 * @since 7 12851 */ 12852 /** 12853 * Binding gestures that can be triggered simultaneously with internal component gestures 12854 * gesture:Bound Gesture Type,mask:GestureMask; 12855 * 12856 * @param { GestureType } gesture 12857 * @param { GestureMask } mask 12858 * @returns { T } 12859 * @syscap SystemCapability.ArkUI.ArkUI.Full 12860 * @crossplatform 12861 * @since 10 12862 */ 12863 /** 12864 * Binding gestures that can be triggered simultaneously with internal component gestures 12865 * gesture:Bound Gesture Type,mask:GestureMask; 12866 * 12867 * @param { GestureType } gesture 12868 * @param { GestureMask } mask 12869 * @returns { T } 12870 * @syscap SystemCapability.ArkUI.ArkUI.Full 12871 * @crossplatform 12872 * @atomicservice 12873 * @since 11 12874 */ 12875 parallelGesture(gesture: GestureType, mask?: GestureMask): T; 12876 12877 /** 12878 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 12879 * The larger the blurring radius, the more blurring the content. 12880 * If the value is 0, the content blurring effect is not blurring. 12881 * 12882 * @param { number } value 12883 * @returns { T } 12884 * @syscap SystemCapability.ArkUI.ArkUI.Full 12885 * @since 7 12886 */ 12887 /** 12888 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 12889 * The larger the blurring radius, the more blurring the content. 12890 * If the value is 0, the content blurring effect is not blurring. 12891 * 12892 * @param { number } value 12893 * @returns { T } 12894 * @syscap SystemCapability.ArkUI.ArkUI.Full 12895 * @since 9 12896 * @form 12897 */ 12898 /** 12899 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 12900 * The larger the blurring radius, the more blurring the content. 12901 * If the value is 0, the content blurring effect is not blurring. 12902 * 12903 * @param { number } value 12904 * @returns { T } 12905 * @syscap SystemCapability.ArkUI.ArkUI.Full 12906 * @crossplatform 12907 * @since 10 12908 * @form 12909 */ 12910 /** 12911 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 12912 * The larger the blurring radius, the more blurring the content. 12913 * If the value is 0, the content blurring effect is not blurring. 12914 * 12915 * @param { number } value - value indicates radius of backdrop blur. 12916 * @param { BlurOptions } options - options indicates blur options. 12917 * @returns { T } 12918 * @syscap SystemCapability.ArkUI.ArkUI.Full 12919 * @crossplatform 12920 * @atomicservice 12921 * @since 11 12922 * @form 12923 */ 12924 blur(value: number, options?: BlurOptions): T; 12925 12926 /** 12927 * Adds the content linear gradient blurring effect for the current component. The input parameter is the blurring radius. 12928 * 12929 * @param { number } value - the blurring radius. 12930 * The larger the blurring radius, the more blurring the content, and if the value is 0, the content blurring effect is not blurring. 12931 * @param { LinearGradientBlurOptions } options - the linear gradient blur options. 12932 * @returns { T } 12933 * @syscap SystemCapability.ArkUI.ArkUI.Full 12934 * @systemapi 12935 * @since 10 12936 */ 12937 linearGradientBlur(value: number, options: LinearGradientBlurOptions): T; 12938 12939 /** 12940 * Adds a highlight effect to the current component. 12941 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 12942 * The component is displayed as all white (percentage). 12943 * 12944 * @param { number } value 12945 * @returns { T } 12946 * @syscap SystemCapability.ArkUI.ArkUI.Full 12947 * @since 7 12948 */ 12949 /** 12950 * Adds a highlight effect to the current component. 12951 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 12952 * The component is displayed as all white (percentage). 12953 * 12954 * @param { number } value 12955 * @returns { T } 12956 * @syscap SystemCapability.ArkUI.ArkUI.Full 12957 * @since 9 12958 * @form 12959 */ 12960 /** 12961 * Adds a highlight effect to the current component. 12962 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 12963 * The component is displayed as all white (percentage). 12964 * 12965 * @param { number } value 12966 * @returns { T } 12967 * @syscap SystemCapability.ArkUI.ArkUI.Full 12968 * @crossplatform 12969 * @since 10 12970 * @form 12971 */ 12972 /** 12973 * Adds a highlight effect to the current component. 12974 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 12975 * The component is displayed as all white (percentage). 12976 * 12977 * @param { number } value 12978 * @returns { T } 12979 * @syscap SystemCapability.ArkUI.ArkUI.Full 12980 * @crossplatform 12981 * @atomicservice 12982 * @since 11 12983 * @form 12984 */ 12985 brightness(value: number): T; 12986 12987 /** 12988 * Adds a contrast effect to the current component. The input parameter is the contrast value. 12989 * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) 12990 * 12991 * @param { number } value 12992 * @returns { T } 12993 * @syscap SystemCapability.ArkUI.ArkUI.Full 12994 * @since 7 12995 */ 12996 /** 12997 * Adds a contrast effect to the current component. The input parameter is the contrast value. 12998 * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) 12999 * 13000 * @param { number } value 13001 * @returns { T } 13002 * @syscap SystemCapability.ArkUI.ArkUI.Full 13003 * @since 9 13004 * @form 13005 */ 13006 /** 13007 * Adds a contrast effect to the current component. The input parameter is the contrast value. 13008 * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) 13009 * 13010 * @param { number } value 13011 * @returns { T } 13012 * @syscap SystemCapability.ArkUI.ArkUI.Full 13013 * @crossplatform 13014 * @since 10 13015 * @form 13016 */ 13017 /** 13018 * Adds a contrast effect to the current component. The input parameter is the contrast value. 13019 * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) 13020 * 13021 * @param { number } value 13022 * @returns { T } 13023 * @syscap SystemCapability.ArkUI.ArkUI.Full 13024 * @crossplatform 13025 * @atomicservice 13026 * @since 11 13027 * @form 13028 */ 13029 contrast(value: number): T; 13030 13031 /** 13032 * Adds a grayscale effect to the current component. 13033 * 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. 13034 * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) 13035 * 13036 * @param { number } value 13037 * @returns { T } 13038 * @syscap SystemCapability.ArkUI.ArkUI.Full 13039 * @since 7 13040 */ 13041 /** 13042 * Adds a grayscale effect to the current component. 13043 * 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. 13044 * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) 13045 * 13046 * @param { number } value 13047 * @returns { T } 13048 * @syscap SystemCapability.ArkUI.ArkUI.Full 13049 * @since 9 13050 * @form 13051 */ 13052 /** 13053 * Adds a grayscale effect to the current component. 13054 * 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. 13055 * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) 13056 * 13057 * @param { number } value 13058 * @returns { T } 13059 * @syscap SystemCapability.ArkUI.ArkUI.Full 13060 * @crossplatform 13061 * @since 10 13062 * @form 13063 */ 13064 /** 13065 * Adds a grayscale effect to the current component. 13066 * 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. 13067 * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) 13068 * 13069 * @param { number } value 13070 * @returns { T } 13071 * @syscap SystemCapability.ArkUI.ArkUI.Full 13072 * @crossplatform 13073 * @atomicservice 13074 * @since 11 13075 * @form 13076 */ 13077 grayscale(value: number): T; 13078 13079 /** 13080 * Adds a color overlay effect for the current component. The input parameter is the superimposed color. 13081 * 13082 * @param { Color | string | Resource } value 13083 * @returns { T } 13084 * @syscap SystemCapability.ArkUI.ArkUI.Full 13085 * @since 7 13086 */ 13087 /** 13088 * Adds a color overlay effect for the current component. The input parameter is the superimposed color. 13089 * 13090 * @param { Color | string | Resource } value 13091 * @returns { T } 13092 * @syscap SystemCapability.ArkUI.ArkUI.Full 13093 * @since 9 13094 * @form 13095 */ 13096 /** 13097 * Adds a color overlay effect for the current component. The input parameter is the superimposed color. 13098 * 13099 * @param { Color | string | Resource } value 13100 * @returns { T } 13101 * @syscap SystemCapability.ArkUI.ArkUI.Full 13102 * @crossplatform 13103 * @since 10 13104 * @form 13105 */ 13106 /** 13107 * Adds a color overlay effect for the current component. The input parameter is the superimposed color. 13108 * 13109 * @param { Color | string | Resource } value 13110 * @returns { T } 13111 * @syscap SystemCapability.ArkUI.ArkUI.Full 13112 * @crossplatform 13113 * @atomicservice 13114 * @since 11 13115 * @form 13116 */ 13117 colorBlend(value: Color | string | Resource): T; 13118 13119 /** 13120 * Adds a saturation effect to the current component. 13121 * The saturation is the ratio of the color-containing component to the achromatic component (gray). 13122 * The larger the color-containing component, the greater the saturation. 13123 * The larger the achromatic component, the smaller the saturation. (Percentage) 13124 * 13125 * @param { number } value 13126 * @returns { T } 13127 * @syscap SystemCapability.ArkUI.ArkUI.Full 13128 * @since 7 13129 */ 13130 /** 13131 * Adds a saturation effect to the current component. 13132 * The saturation is the ratio of the color-containing component to the achromatic component (gray). 13133 * The larger the color-containing component, the greater the saturation. 13134 * The larger the achromatic component, the smaller the saturation. (Percentage) 13135 * 13136 * @param { number } value 13137 * @returns { T } 13138 * @syscap SystemCapability.ArkUI.ArkUI.Full 13139 * @since 9 13140 * @form 13141 */ 13142 /** 13143 * Adds a saturation effect to the current component. 13144 * The saturation is the ratio of the color-containing component to the achromatic component (gray). 13145 * The larger the color-containing component, the greater the saturation. 13146 * The larger the achromatic component, the smaller the saturation. (Percentage) 13147 * 13148 * @param { number } value 13149 * @returns { T } 13150 * @syscap SystemCapability.ArkUI.ArkUI.Full 13151 * @crossplatform 13152 * @since 10 13153 * @form 13154 */ 13155 /** 13156 * Adds a saturation effect to the current component. 13157 * The saturation is the ratio of the color-containing component to the achromatic component (gray). 13158 * The larger the color-containing component, the greater the saturation. 13159 * The larger the achromatic component, the smaller the saturation. (Percentage) 13160 * 13161 * @param { number } value 13162 * @returns { T } 13163 * @syscap SystemCapability.ArkUI.ArkUI.Full 13164 * @crossplatform 13165 * @atomicservice 13166 * @since 11 13167 * @form 13168 */ 13169 saturate(value: number): T; 13170 13171 /** 13172 * Converts the image to sepia. Value defines the scale of the conversion. 13173 * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) 13174 * 13175 * @param { number } value 13176 * @returns { T } 13177 * @syscap SystemCapability.ArkUI.ArkUI.Full 13178 * @since 7 13179 */ 13180 /** 13181 * Converts the image to sepia. Value defines the scale of the conversion. 13182 * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) 13183 * 13184 * @param { number } value 13185 * @returns { T } 13186 * @syscap SystemCapability.ArkUI.ArkUI.Full 13187 * @since 9 13188 * @form 13189 */ 13190 /** 13191 * Converts the image to sepia. Value defines the scale of the conversion. 13192 * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) 13193 * 13194 * @param { number } value 13195 * @returns { T } 13196 * @syscap SystemCapability.ArkUI.ArkUI.Full 13197 * @crossplatform 13198 * @since 10 13199 * @form 13200 */ 13201 /** 13202 * Converts the image to sepia. Value defines the scale of the conversion. 13203 * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) 13204 * 13205 * @param { number } value 13206 * @returns { T } 13207 * @syscap SystemCapability.ArkUI.ArkUI.Full 13208 * @crossplatform 13209 * @atomicservice 13210 * @since 11 13211 * @form 13212 */ 13213 sepia(value: number): T; 13214 13215 /** 13216 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 13217 * A value of 0% does not change the image. (Percentage) 13218 * 13219 * @param { number } value 13220 * @returns { T } 13221 * @syscap SystemCapability.ArkUI.ArkUI.Full 13222 * @since 7 13223 */ 13224 /** 13225 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 13226 * A value of 0% does not change the image. (Percentage) 13227 * 13228 * @param { number } value 13229 * @returns { T } 13230 * @syscap SystemCapability.ArkUI.ArkUI.Full 13231 * @since 9 13232 * @form 13233 */ 13234 /** 13235 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 13236 * A value of 0% does not change the image. (Percentage) 13237 * 13238 * @param { number } value 13239 * @returns { T } 13240 * @syscap SystemCapability.ArkUI.ArkUI.Full 13241 * @crossplatform 13242 * @since 10 13243 * @form 13244 */ 13245 /** 13246 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 13247 * A value of 0% does not change the image. (Percentage) 13248 * 13249 * @param { number | InvertOptions } value - value indicates the scale of the conversion or the options of invert. 13250 * @returns { T } 13251 * @syscap SystemCapability.ArkUI.ArkUI.Full 13252 * @crossplatform 13253 * @atomicservice 13254 * @since 11 13255 * @form 13256 */ 13257 invert(value: number | InvertOptions): T; 13258 13259 /** 13260 * Sets system bar effect to the component. 13261 * 13262 * @returns { T } return the component attribute. 13263 * @syscap SystemCapability.ArkUI.ArkUI.Full 13264 * @systemapi 13265 * @since 11 13266 */ 13267 systemBarEffect(): T; 13268 13269 /** 13270 * Adds the hue rotation effect to the current component. 13271 * 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. 13272 * If the value exceeds 360deg, the image is circled again. 13273 * 13274 * @param { number | string } value 13275 * @returns { T } 13276 * @syscap SystemCapability.ArkUI.ArkUI.Full 13277 * @since 7 13278 */ 13279 /** 13280 * Adds the hue rotation effect to the current component. 13281 * 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. 13282 * If the value exceeds 360deg, the image is circled again. 13283 * 13284 * @param { number | string } value 13285 * @returns { T } 13286 * @syscap SystemCapability.ArkUI.ArkUI.Full 13287 * @since 9 13288 * @form 13289 */ 13290 /** 13291 * Adds the hue rotation effect to the current component. 13292 * 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. 13293 * If the value exceeds 360deg, the image is circled again. 13294 * 13295 * @param { number | string } value 13296 * @returns { T } 13297 * @syscap SystemCapability.ArkUI.ArkUI.Full 13298 * @crossplatform 13299 * @since 10 13300 * @form 13301 */ 13302 /** 13303 * Adds the hue rotation effect to the current component. 13304 * 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. 13305 * If the value exceeds 360deg, the image is circled again. 13306 * 13307 * @param { number | string } value 13308 * @returns { T } 13309 * @syscap SystemCapability.ArkUI.ArkUI.Full 13310 * @crossplatform 13311 * @atomicservice 13312 * @since 11 13313 * @form 13314 */ 13315 hueRotate(value: number | string): T; 13316 13317 /** 13318 * Add an attribute to control whether the shadows of the child nodes overlap each other. 13319 * 13320 * @param { boolean } value - true means the shadows of the child nodes overlap each other effect and drawn in batches. 13321 * @returns { T } 13322 * @syscap SystemCapability.ArkUI.ArkUI.Full 13323 * @crossplatform 13324 * @form 13325 * @since 11 13326 */ 13327 useShadowBatching(value: boolean): T; 13328 13329 /** 13330 * Sets whether the component should apply the effects template defined by the parent effectComponent. 13331 * If multiple parent effectComponents are found, the nearest one will be used. 13332 * If no parent effectComponent is found, this method has no effect. 13333 * 13334 * @param { boolean } value - true means the component should apply the effects template. 13335 * @returns { T } return the component attribute. 13336 * @syscap SystemCapability.ArkUI.ArkUI.Full 13337 * @systemapi 13338 * @since 10 13339 */ 13340 useEffect(value: boolean): T; 13341 13342 /** 13343 * Adds the background blur effect for the current component. The input parameter is the blur radius. 13344 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 13345 * 13346 * @param { number } value 13347 * @returns { T } 13348 * @syscap SystemCapability.ArkUI.ArkUI.Full 13349 * @since 7 13350 */ 13351 /** 13352 * Adds the background blur effect for the current component. The input parameter is the blur radius. 13353 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 13354 * 13355 * @param { number } value 13356 * @returns { T } 13357 * @syscap SystemCapability.ArkUI.ArkUI.Full 13358 * @since 9 13359 * @form 13360 */ 13361 /** 13362 * Adds the background blur effect for the current component. The input parameter is the blur radius. 13363 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 13364 * 13365 * @param { number } value 13366 * @returns { T } 13367 * @syscap SystemCapability.ArkUI.ArkUI.Full 13368 * @crossplatform 13369 * @since 10 13370 * @form 13371 */ 13372 /** 13373 * Adds the background blur effect for the current component. The input parameter is the blur radius. 13374 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 13375 * 13376 * @param { number } value - value indicates radius of backdrop blur. 13377 * @param { BlurOptions } options - options indicates the backdrop blur options. 13378 * @returns { T } 13379 * @syscap SystemCapability.ArkUI.ArkUI.Full 13380 * @crossplatform 13381 * @atomicservice 13382 * @since 11 13383 * @form 13384 */ 13385 backdropBlur(value: number, options?: BlurOptions): T; 13386 13387 /** 13388 * Composite the contents of this view and its children into an offscreen cache before display in the screen. 13389 * 13390 * @param { boolean } value - if this view and its children need to composite into an offscreen cache. 13391 * @returns { T } 13392 * @syscap SystemCapability.ArkUI.ArkUI.Full 13393 * @crossplatform 13394 * @since 10 13395 */ 13396 /** 13397 * Composite the contents of this view and its children into an offscreen cache before display in the screen. 13398 * 13399 * @param { boolean } value - if this view and its children need to composite into an offscreen cache. 13400 * @returns { T } 13401 * @syscap SystemCapability.ArkUI.ArkUI.Full 13402 * @crossplatform 13403 * @atomicservice 13404 * @since 11 13405 */ 13406 renderGroup(value: boolean): T; 13407 13408 /** 13409 * Sets the translation effect during page transition. 13410 * The value is the start point of entry and end point of exit. 13411 * When this parameter is set together with slide, slide takes effect by default. 13412 * 13413 * @param { TranslateOptions } value 13414 * @returns { T } 13415 * @syscap SystemCapability.ArkUI.ArkUI.Full 13416 * @since 7 13417 */ 13418 /** 13419 * Sets the translation effect during page transition. 13420 * The value is the start point of entry and end point of exit. 13421 * When this parameter is set together with slide, slide takes effect by default. 13422 * 13423 * @param { TranslateOptions } value 13424 * @returns { T } 13425 * @syscap SystemCapability.ArkUI.ArkUI.Full 13426 * @since 9 13427 * @form 13428 */ 13429 /** 13430 * Sets the translation effect during page transition. 13431 * The value is the start point of entry and end point of exit. 13432 * When this parameter is set together with slide, slide takes effect by default. 13433 * 13434 * @param { TranslateOptions } value 13435 * @returns { T } 13436 * @syscap SystemCapability.ArkUI.ArkUI.Full 13437 * @crossplatform 13438 * @since 10 13439 * @form 13440 */ 13441 /** 13442 * Sets the translation effect during page transition. 13443 * The value is the start point of entry and end point of exit. 13444 * When this parameter is set together with slide, slide takes effect by default. 13445 * 13446 * @param { TranslateOptions } value 13447 * @returns { T } 13448 * @syscap SystemCapability.ArkUI.ArkUI.Full 13449 * @crossplatform 13450 * @atomicservice 13451 * @since 11 13452 * @form 13453 */ 13454 translate(value: TranslateOptions): T; 13455 13456 /** 13457 * Sets the zoom effect during page transition. The value is the start point of entry and end point of exit. 13458 * 13459 * @param { ScaleOptions } value 13460 * @returns { T } 13461 * @syscap SystemCapability.ArkUI.ArkUI.Full 13462 * @since 7 13463 */ 13464 /** 13465 * Sets the zoom effect during page transition. The value is the start point of entry and end point of exit. 13466 * 13467 * @param { ScaleOptions } value 13468 * @returns { T } 13469 * @syscap SystemCapability.ArkUI.ArkUI.Full 13470 * @since 9 13471 * @form 13472 */ 13473 /** 13474 * Sets the zoom effect during page transition. The value is the start point of entry and end point of exit. 13475 * 13476 * @param { ScaleOptions } value 13477 * @returns { T } 13478 * @syscap SystemCapability.ArkUI.ArkUI.Full 13479 * @crossplatform 13480 * @since 10 13481 * @form 13482 */ 13483 /** 13484 * Sets the zoom effect during page transition. The value is the start point of entry and end point of exit. 13485 * 13486 * @param { ScaleOptions } value 13487 * @returns { T } 13488 * @syscap SystemCapability.ArkUI.ArkUI.Full 13489 * @crossplatform 13490 * @atomicservice 13491 * @since 11 13492 * @form 13493 */ 13494 scale(value: ScaleOptions): T; 13495 13496 /** 13497 * 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. 13498 * 13499 * @param { number } value 13500 * @returns { T } 13501 * @syscap SystemCapability.ArkUI.ArkUI.Full 13502 * @since 7 13503 */ 13504 /** 13505 * 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. 13506 * 13507 * @param { number } value 13508 * @returns { T } 13509 * @syscap SystemCapability.ArkUI.ArkUI.Full 13510 * @crossplatform 13511 * @since 10 13512 */ 13513 /** 13514 * 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. 13515 * 13516 * @param { number } value 13517 * @returns { T } 13518 * @syscap SystemCapability.ArkUI.ArkUI.Full 13519 * @crossplatform 13520 * @atomicservice 13521 * @since 11 13522 */ 13523 gridSpan(value: number): T; 13524 13525 /** 13526 * 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, 13527 * the current component is located in the nth column. 13528 * 13529 * @param { number } value 13530 * @returns { T } 13531 * @syscap SystemCapability.ArkUI.ArkUI.Full 13532 * @since 7 13533 */ 13534 /** 13535 * 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, 13536 * the current component is located in the nth column. 13537 * 13538 * @param { number } value 13539 * @returns { T } 13540 * @syscap SystemCapability.ArkUI.ArkUI.Full 13541 * @crossplatform 13542 * @since 10 13543 */ 13544 /** 13545 * 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, 13546 * the current component is located in the nth column. 13547 * 13548 * @param { number } value 13549 * @returns { T } 13550 * @syscap SystemCapability.ArkUI.ArkUI.Full 13551 * @crossplatform 13552 * @atomicservice 13553 * @since 11 13554 */ 13555 gridOffset(value: number): T; 13556 13557 /** 13558 * Sets the rotation effect during assembly transition. 13559 * The values are the start point during insertion and the end point during deletion. 13560 * 13561 * @param { RotateOptions } value 13562 * @returns { T } 13563 * @syscap SystemCapability.ArkUI.ArkUI.Full 13564 * @since 7 13565 */ 13566 /** 13567 * Sets the rotation effect during assembly transition. 13568 * The values are the start point during insertion and the end point during deletion. 13569 * 13570 * @param { RotateOptions } value 13571 * @returns { T } 13572 * @syscap SystemCapability.ArkUI.ArkUI.Full 13573 * @since 9 13574 * @form 13575 */ 13576 /** 13577 * Sets the rotation effect during assembly transition. 13578 * The values are the start point during insertion and the end point during deletion. 13579 * 13580 * @param { RotateOptions } value 13581 * @returns { T } 13582 * @syscap SystemCapability.ArkUI.ArkUI.Full 13583 * @crossplatform 13584 * @since 10 13585 * @form 13586 */ 13587 /** 13588 * Sets the rotation effect during assembly transition. 13589 * The values are the start point during insertion and the end point during deletion. 13590 * 13591 * @param { RotateOptions } value 13592 * @returns { T } 13593 * @syscap SystemCapability.ArkUI.ArkUI.Full 13594 * @crossplatform 13595 * @atomicservice 13596 * @since 11 13597 * @form 13598 */ 13599 rotate(value: RotateOptions): T; 13600 13601 /** 13602 * Sets the transformation matrix for the current component. 13603 * 13604 * @param { object } value 13605 * @returns { T } 13606 * @syscap SystemCapability.ArkUI.ArkUI.Full 13607 * @since 7 13608 */ 13609 /** 13610 * Sets the transformation matrix for the current component. 13611 * 13612 * @param { object } value 13613 * @returns { T } 13614 * @syscap SystemCapability.ArkUI.ArkUI.Full 13615 * @crossplatform 13616 * @since 10 13617 */ 13618 /** 13619 * Sets the transformation matrix for the current component. 13620 * 13621 * @param { object } value 13622 * @returns { T } 13623 * @syscap SystemCapability.ArkUI.ArkUI.Full 13624 * @crossplatform 13625 * @atomicservice 13626 * @since 11 13627 */ 13628 transform(value: object): T; 13629 13630 /** 13631 * This callback is triggered when a component mounts a display. 13632 * 13633 * @param { function } event 13634 * @returns { T } 13635 * @syscap SystemCapability.ArkUI.ArkUI.Full 13636 * @since 7 13637 */ 13638 /** 13639 * This callback is triggered when a component mounts a display. 13640 * 13641 * @param { function } event 13642 * @returns { T } 13643 * @syscap SystemCapability.ArkUI.ArkUI.Full 13644 * @since 9 13645 * @form 13646 */ 13647 /** 13648 * This callback is triggered when a component mounts a display. 13649 * 13650 * @param { function } event 13651 * @returns { T } 13652 * @syscap SystemCapability.ArkUI.ArkUI.Full 13653 * @crossplatform 13654 * @since 10 13655 * @form 13656 */ 13657 /** 13658 * This callback is triggered when a component mounts a display. 13659 * 13660 * @param { function } event 13661 * @returns { T } 13662 * @syscap SystemCapability.ArkUI.ArkUI.Full 13663 * @crossplatform 13664 * @atomicservice 13665 * @since 11 13666 * @form 13667 */ 13668 onAppear(event: () => void): T; 13669 13670 /** 13671 * This callback is triggered when component uninstallation disappears. 13672 * 13673 * @param { function } event 13674 * @returns { T } 13675 * @syscap SystemCapability.ArkUI.ArkUI.Full 13676 * @since 7 13677 */ 13678 /** 13679 * This callback is triggered when component uninstallation disappears. 13680 * 13681 * @param { function } event 13682 * @returns { T } 13683 * @syscap SystemCapability.ArkUI.ArkUI.Full 13684 * @since 9 13685 * @form 13686 */ 13687 /** 13688 * This callback is triggered when component uninstallation disappears. 13689 * 13690 * @param { function } event 13691 * @returns { T } 13692 * @syscap SystemCapability.ArkUI.ArkUI.Full 13693 * @crossplatform 13694 * @since 10 13695 * @form 13696 */ 13697 /** 13698 * This callback is triggered when component uninstallation disappears. 13699 * 13700 * @param { function } event 13701 * @returns { T } 13702 * @syscap SystemCapability.ArkUI.ArkUI.Full 13703 * @crossplatform 13704 * @atomicservice 13705 * @since 11 13706 * @form 13707 */ 13708 onDisAppear(event: () => void): T; 13709 13710 /** 13711 * This callback is triggered when the size or position of this component change finished. 13712 * 13713 * @param { function } event - event callback. 13714 * @returns { T } 13715 * @syscap SystemCapability.ArkUI.ArkUI.Full 13716 * @since 8 13717 */ 13718 /** 13719 * This callback is triggered when the size or position of this component change finished. 13720 * 13721 * @param { function } event - event callback. 13722 * @returns { T } 13723 * @syscap SystemCapability.ArkUI.ArkUI.Full 13724 * @crossplatform 13725 * @since 10 13726 */ 13727 /** 13728 * This callback is triggered when the size or position of this component change finished. 13729 * 13730 * @param { function } event - event callback. 13731 * @returns { T } 13732 * @syscap SystemCapability.ArkUI.ArkUI.Full 13733 * @crossplatform 13734 * @atomicservice 13735 * @since 11 13736 */ 13737 onAreaChange(event: (oldValue: Area, newValue: Area) => void): T; 13738 13739 /** 13740 * Controls the display or hide of the current component. 13741 * 13742 * @param { Visibility } value 13743 * @returns { T } 13744 * @syscap SystemCapability.ArkUI.ArkUI.Full 13745 * @since 7 13746 */ 13747 /** 13748 * Controls the display or hide of the current component. 13749 * 13750 * @param { Visibility } value 13751 * @returns { T } 13752 * @syscap SystemCapability.ArkUI.ArkUI.Full 13753 * @since 9 13754 * @form 13755 */ 13756 /** 13757 * Controls the display or hide of the current component. 13758 * 13759 * @param { Visibility } value 13760 * @returns { T } 13761 * @syscap SystemCapability.ArkUI.ArkUI.Full 13762 * @crossplatform 13763 * @since 10 13764 * @form 13765 */ 13766 /** 13767 * Controls the display or hide of the current component. 13768 * 13769 * @param { Visibility } value 13770 * @returns { T } 13771 * @syscap SystemCapability.ArkUI.ArkUI.Full 13772 * @crossplatform 13773 * @atomicservice 13774 * @since 11 13775 * @form 13776 */ 13777 visibility(value: Visibility): T; 13778 13779 /** 13780 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 13781 * 13782 * @param { number } value 13783 * @returns { T } 13784 * @syscap SystemCapability.ArkUI.ArkUI.Full 13785 * @since 7 13786 */ 13787 /** 13788 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 13789 * 13790 * @param { number } value 13791 * @returns { T } 13792 * @syscap SystemCapability.ArkUI.ArkUI.Full 13793 * @since 9 13794 * @form 13795 */ 13796 /** 13797 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 13798 * 13799 * @param { number } value 13800 * @returns { T } 13801 * @syscap SystemCapability.ArkUI.ArkUI.Full 13802 * @crossplatform 13803 * @since 10 13804 * @form 13805 */ 13806 /** 13807 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 13808 * 13809 * @param { number } value 13810 * @returns { T } 13811 * @syscap SystemCapability.ArkUI.ArkUI.Full 13812 * @crossplatform 13813 * @atomicservice 13814 * @since 11 13815 * @form 13816 */ 13817 flexGrow(value: number): T; 13818 13819 /** 13820 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 13821 * 13822 * @param { number } value 13823 * @returns { T } 13824 * @syscap SystemCapability.ArkUI.ArkUI.Full 13825 * @since 7 13826 */ 13827 /** 13828 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 13829 * 13830 * @param { number } value 13831 * @returns { T } 13832 * @syscap SystemCapability.ArkUI.ArkUI.Full 13833 * @since 9 13834 * @form 13835 */ 13836 /** 13837 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 13838 * 13839 * @param { number } value 13840 * @returns { T } 13841 * @syscap SystemCapability.ArkUI.ArkUI.Full 13842 * @crossplatform 13843 * @since 10 13844 * @form 13845 */ 13846 /** 13847 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 13848 * 13849 * @param { number } value 13850 * @returns { T } 13851 * @syscap SystemCapability.ArkUI.ArkUI.Full 13852 * @crossplatform 13853 * @atomicservice 13854 * @since 11 13855 * @form 13856 */ 13857 flexShrink(value: number): T; 13858 13859 /** 13860 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 13861 * 13862 * @param { number | string } value 13863 * @returns { T } 13864 * @syscap SystemCapability.ArkUI.ArkUI.Full 13865 * @since 7 13866 */ 13867 /** 13868 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 13869 * 13870 * @param { number | string } value 13871 * @returns { T } 13872 * @syscap SystemCapability.ArkUI.ArkUI.Full 13873 * @since 9 13874 * @form 13875 */ 13876 /** 13877 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 13878 * 13879 * @param { number | string } value 13880 * @returns { T } 13881 * @syscap SystemCapability.ArkUI.ArkUI.Full 13882 * @crossplatform 13883 * @since 10 13884 * @form 13885 */ 13886 /** 13887 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 13888 * 13889 * @param { number | string } value 13890 * @returns { T } 13891 * @syscap SystemCapability.ArkUI.ArkUI.Full 13892 * @crossplatform 13893 * @atomicservice 13894 * @since 11 13895 * @form 13896 */ 13897 flexBasis(value: number | string): T; 13898 13899 /** 13900 * Overrides the default configuration of alignItems in the Flex Layout container. 13901 * 13902 * @param { ItemAlign } value 13903 * @returns { T } 13904 * @syscap SystemCapability.ArkUI.ArkUI.Full 13905 * @since 7 13906 */ 13907 /** 13908 * Overrides the default configuration of alignItems in the Flex Layout container. 13909 * 13910 * @param { ItemAlign } value 13911 * @returns { T } 13912 * @syscap SystemCapability.ArkUI.ArkUI.Full 13913 * @since 9 13914 * @form 13915 */ 13916 /** 13917 * Overrides the default configuration of alignItems in the Flex Layout container. 13918 * 13919 * @param { ItemAlign } value 13920 * @returns { T } 13921 * @syscap SystemCapability.ArkUI.ArkUI.Full 13922 * @crossplatform 13923 * @since 10 13924 * @form 13925 */ 13926 /** 13927 * Overrides the default configuration of alignItems in the Flex Layout container. 13928 * 13929 * @param { ItemAlign } value 13930 * @returns { T } 13931 * @syscap SystemCapability.ArkUI.ArkUI.Full 13932 * @crossplatform 13933 * @atomicservice 13934 * @since 11 13935 * @form 13936 */ 13937 alignSelf(value: ItemAlign): T; 13938 13939 /** 13940 * 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. 13941 * 13942 * @param { number } value 13943 * @returns { T } 13944 * @syscap SystemCapability.ArkUI.ArkUI.Full 13945 * @since 7 13946 */ 13947 /** 13948 * 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. 13949 * 13950 * @param { number } value 13951 * @returns { T } 13952 * @syscap SystemCapability.ArkUI.ArkUI.Full 13953 * @since 9 13954 * @form 13955 */ 13956 /** 13957 * 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. 13958 * 13959 * @param { number } value 13960 * @returns { T } 13961 * @syscap SystemCapability.ArkUI.ArkUI.Full 13962 * @crossplatform 13963 * @since 10 13964 * @form 13965 */ 13966 /** 13967 * 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. 13968 * 13969 * @param { number } value 13970 * @returns { T } 13971 * @syscap SystemCapability.ArkUI.ArkUI.Full 13972 * @crossplatform 13973 * @atomicservice 13974 * @since 11 13975 * @form 13976 */ 13977 displayPriority(value: number): T; 13978 13979 /** 13980 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 13981 * 13982 * @param { number } value 13983 * @returns { T } 13984 * @syscap SystemCapability.ArkUI.ArkUI.Full 13985 * @since 7 13986 */ 13987 /** 13988 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 13989 * 13990 * @param { number } value 13991 * @returns { T } 13992 * @syscap SystemCapability.ArkUI.ArkUI.Full 13993 * @since 9 13994 * @form 13995 */ 13996 /** 13997 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 13998 * 13999 * @param { number } value 14000 * @returns { T } 14001 * @syscap SystemCapability.ArkUI.ArkUI.Full 14002 * @crossplatform 14003 * @since 10 14004 * @form 14005 */ 14006 /** 14007 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 14008 * 14009 * @param { number } value 14010 * @returns { T } 14011 * @syscap SystemCapability.ArkUI.ArkUI.Full 14012 * @crossplatform 14013 * @atomicservice 14014 * @since 11 14015 * @form 14016 */ 14017 zIndex(value: number): T; 14018 14019 /** 14020 * 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. 14021 * 14022 * @param { string } id 14023 * @param { sharedTransitionOptions } options 14024 * @returns { T } 14025 * @syscap SystemCapability.ArkUI.ArkUI.Full 14026 * @since 7 14027 */ 14028 /** 14029 * 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. 14030 * 14031 * @param { string } id 14032 * @param { sharedTransitionOptions } options 14033 * @returns { T } 14034 * @syscap SystemCapability.ArkUI.ArkUI.Full 14035 * @crossplatform 14036 * @since 10 14037 */ 14038 /** 14039 * 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. 14040 * 14041 * @param { string } id 14042 * @param { sharedTransitionOptions } options 14043 * @returns { T } 14044 * @syscap SystemCapability.ArkUI.ArkUI.Full 14045 * @crossplatform 14046 * @atomicservice 14047 * @since 11 14048 */ 14049 sharedTransition(id: string, options?: sharedTransitionOptions): T; 14050 14051 /** 14052 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 14053 * 14054 * @param { Direction } value 14055 * @returns { T } 14056 * @syscap SystemCapability.ArkUI.ArkUI.Full 14057 * @since 7 14058 */ 14059 /** 14060 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 14061 * 14062 * @param { Direction } value 14063 * @returns { T } 14064 * @syscap SystemCapability.ArkUI.ArkUI.Full 14065 * @since 9 14066 * @form 14067 */ 14068 /** 14069 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 14070 * 14071 * @param { Direction } value 14072 * @returns { T } 14073 * @syscap SystemCapability.ArkUI.ArkUI.Full 14074 * @crossplatform 14075 * @since 10 14076 * @form 14077 */ 14078 /** 14079 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 14080 * 14081 * @param { Direction } value 14082 * @returns { T } 14083 * @syscap SystemCapability.ArkUI.ArkUI.Full 14084 * @crossplatform 14085 * @atomicservice 14086 * @since 11 14087 * @form 14088 */ 14089 direction(value: Direction): T; 14090 14091 /** 14092 * align 14093 * 14094 * @param { Alignment } value 14095 * @returns { T } 14096 * @syscap SystemCapability.ArkUI.ArkUI.Full 14097 * @since 7 14098 */ 14099 /** 14100 * align 14101 * 14102 * @param { Alignment } value 14103 * @returns { T } 14104 * @syscap SystemCapability.ArkUI.ArkUI.Full 14105 * @since 9 14106 * @form 14107 */ 14108 /** 14109 * align 14110 * 14111 * @param { Alignment } value 14112 * @returns { T } 14113 * @syscap SystemCapability.ArkUI.ArkUI.Full 14114 * @crossplatform 14115 * @since 10 14116 * @form 14117 */ 14118 /** 14119 * align 14120 * 14121 * @param { Alignment } value 14122 * @returns { T } 14123 * @syscap SystemCapability.ArkUI.ArkUI.Full 14124 * @crossplatform 14125 * @atomicservice 14126 * @since 11 14127 * @form 14128 */ 14129 align(value: Alignment): T; 14130 14131 /** 14132 * position 14133 * 14134 * @param { Position } value 14135 * @returns { T } 14136 * @syscap SystemCapability.ArkUI.ArkUI.Full 14137 * @since 7 14138 */ 14139 /** 14140 * position 14141 * 14142 * @param { Position } value 14143 * @returns { T } 14144 * @syscap SystemCapability.ArkUI.ArkUI.Full 14145 * @since 9 14146 * @form 14147 */ 14148 /** 14149 * position 14150 * 14151 * @param { Position } value 14152 * @returns { T } 14153 * @syscap SystemCapability.ArkUI.ArkUI.Full 14154 * @crossplatform 14155 * @since 10 14156 * @form 14157 */ 14158 /** 14159 * position 14160 * 14161 * @param { Position } value 14162 * @returns { T } 14163 * @syscap SystemCapability.ArkUI.ArkUI.Full 14164 * @crossplatform 14165 * @atomicservice 14166 * @since 11 14167 * @form 14168 */ 14169 position(value: Position): T; 14170 14171 /** 14172 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 14173 * 14174 * @param { Position } value 14175 * @returns { T } 14176 * @syscap SystemCapability.ArkUI.ArkUI.Full 14177 * @since 7 14178 */ 14179 /** 14180 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 14181 * 14182 * @param { Position } value 14183 * @returns { T } 14184 * @syscap SystemCapability.ArkUI.ArkUI.Full 14185 * @since 9 14186 * @form 14187 */ 14188 /** 14189 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 14190 * 14191 * @param { Position } value 14192 * @returns { T } 14193 * @syscap SystemCapability.ArkUI.ArkUI.Full 14194 * @crossplatform 14195 * @since 10 14196 * @form 14197 */ 14198 /** 14199 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 14200 * 14201 * @param { Position } value 14202 * @returns { T } 14203 * @syscap SystemCapability.ArkUI.ArkUI.Full 14204 * @crossplatform 14205 * @atomicservice 14206 * @since 11 14207 * @form 14208 */ 14209 markAnchor(value: Position): T; 14210 14211 /** 14212 * Coordinate offset relative to the layout completion position. 14213 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 14214 * 14215 * @param { Position } value 14216 * @returns { T } 14217 * @syscap SystemCapability.ArkUI.ArkUI.Full 14218 * @since 7 14219 */ 14220 /** 14221 * Coordinate offset relative to the layout completion position. 14222 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 14223 * 14224 * @param { Position } value 14225 * @returns { T } 14226 * @syscap SystemCapability.ArkUI.ArkUI.Full 14227 * @since 9 14228 * @form 14229 */ 14230 /** 14231 * Coordinate offset relative to the layout completion position. 14232 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 14233 * 14234 * @param { Position } value 14235 * @returns { T } 14236 * @syscap SystemCapability.ArkUI.ArkUI.Full 14237 * @crossplatform 14238 * @since 10 14239 * @form 14240 */ 14241 /** 14242 * Coordinate offset relative to the layout completion position. 14243 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 14244 * 14245 * @param { Position } value 14246 * @returns { T } 14247 * @syscap SystemCapability.ArkUI.ArkUI.Full 14248 * @crossplatform 14249 * @atomicservice 14250 * @since 11 14251 * @form 14252 */ 14253 offset(value: Position): T; 14254 14255 /** 14256 * If the value is true, the component is available and can respond to operations such as clicking. 14257 * If it is set to false, click operations are not responded. 14258 * 14259 * @param { boolean } value 14260 * @returns { T } 14261 * @syscap SystemCapability.ArkUI.ArkUI.Full 14262 * @since 7 14263 */ 14264 /** 14265 * If the value is true, the component is available and can respond to operations such as clicking. 14266 * If it is set to false, click operations are not responded. 14267 * 14268 * @param { boolean } value 14269 * @returns { T } 14270 * @syscap SystemCapability.ArkUI.ArkUI.Full 14271 * @since 9 14272 * @form 14273 */ 14274 /** 14275 * If the value is true, the component is available and can respond to operations such as clicking. 14276 * If it is set to false, click operations are not responded. 14277 * 14278 * @param { boolean } value 14279 * @returns { T } 14280 * @syscap SystemCapability.ArkUI.ArkUI.Full 14281 * @crossplatform 14282 * @since 10 14283 * @form 14284 */ 14285 /** 14286 * If the value is true, the component is available and can respond to operations such as clicking. 14287 * If it is set to false, click operations are not responded. 14288 * 14289 * @param { boolean } value 14290 * @returns { T } 14291 * @syscap SystemCapability.ArkUI.ArkUI.Full 14292 * @crossplatform 14293 * @atomicservice 14294 * @since 11 14295 * @form 14296 */ 14297 enabled(value: boolean): T; 14298 14299 /** 14300 * Sets the number of occupied columns and offset columns for a specific device width type. 14301 * 14302 * @param { object } value 14303 * @returns { T } 14304 * @syscap SystemCapability.ArkUI.ArkUI.Full 14305 * @since 7 14306 * @deprecated since 9 14307 * @useinstead grid_col/[GridColColumnOption] and grid_row/[GridRowColumnOption] 14308 */ 14309 useSizeType(value: { 14310 xs?: number | { span: number; offset: number }; 14311 sm?: number | { span: number; offset: number }; 14312 md?: number | { span: number; offset: number }; 14313 lg?: number | { span: number; offset: number }; 14314 }): T; 14315 14316 /** 14317 * Specifies the alignRules of relative container 14318 * 14319 * @param { AlignRuleOption } value 14320 * @returns { T } 14321 * @syscap SystemCapability.ArkUI.ArkUI.Full 14322 * @since 9 14323 * @form 14324 */ 14325 /** 14326 * Specifies the alignRules of relative container 14327 * 14328 * @param { AlignRuleOption } value 14329 * @returns { T } 14330 * @syscap SystemCapability.ArkUI.ArkUI.Full 14331 * @crossplatform 14332 * @since 10 14333 * @form 14334 */ 14335 /** 14336 * Specifies the alignRules of relative container 14337 * 14338 * @param { AlignRuleOption } value 14339 * @returns { T } 14340 * @syscap SystemCapability.ArkUI.ArkUI.Full 14341 * @crossplatform 14342 * @atomicservice 14343 * @since 11 14344 * @form 14345 */ 14346 alignRules(value: AlignRuleOption): T; 14347 14348 /** 14349 * Specifies the aspect ratio of the current component. 14350 * 14351 * @param { number } value 14352 * @returns { T } 14353 * @syscap SystemCapability.ArkUI.ArkUI.Full 14354 * @since 7 14355 */ 14356 /** 14357 * Specifies the aspect ratio of the current component. 14358 * 14359 * @param { number } value 14360 * @returns { T } 14361 * @syscap SystemCapability.ArkUI.ArkUI.Full 14362 * @since 9 14363 * @form 14364 */ 14365 /** 14366 * Specifies the aspect ratio of the current component. 14367 * 14368 * @param { number } value 14369 * @returns { T } 14370 * @syscap SystemCapability.ArkUI.ArkUI.Full 14371 * @crossplatform 14372 * @since 10 14373 * @form 14374 */ 14375 /** 14376 * Specifies the aspect ratio of the current component. 14377 * 14378 * @param { number } value 14379 * @returns { T } 14380 * @syscap SystemCapability.ArkUI.ArkUI.Full 14381 * @crossplatform 14382 * @atomicservice 14383 * @since 11 14384 * @form 14385 */ 14386 aspectRatio(value: number): T; 14387 14388 /** 14389 * The click effect level and scale number. 14390 * 14391 * @param { ClickEffect | null } value 14392 * @returns { T } return the component attribute. 14393 * @syscap SystemCapability.ArkUI.ArkUI.Full 14394 * @crossplatform 14395 * @since 10 14396 */ 14397 /** 14398 * The click effect level and scale number. 14399 * 14400 * @param { ClickEffect | null } value 14401 * @returns { T } return the component attribute. 14402 * @syscap SystemCapability.ArkUI.ArkUI.Full 14403 * @crossplatform 14404 * @atomicservice 14405 * @since 11 14406 */ 14407 clickEffect(value: ClickEffect | null): T; 14408 14409 /** 14410 * After a listener is bound, the component can be dragged. After the drag occurs, a callback is triggered. 14411 * (To be triggered, press and hold for 170 milliseconds (ms)) 14412 * 14413 * @param { function } event 14414 * @returns { T } 14415 * @syscap SystemCapability.ArkUI.ArkUI.Full 14416 * @since 8 14417 */ 14418 /** 14419 * After a listener is bound, the component can be dragged. After the drag occurs, a callback is triggered. 14420 * (To be triggered, press and hold for 170 milliseconds (ms)) 14421 * 14422 * @param { function } event 14423 * @returns { T } 14424 * @syscap SystemCapability.ArkUI.ArkUI.Full 14425 * @atomicservice 14426 * @since 11 14427 */ 14428 onDragStart(event: (event: DragEvent, extraParams?: string) => CustomBuilder | DragItemInfo): T; 14429 14430 /** 14431 * After binding, a callback is triggered when the component is dragged to the range of the component. 14432 * 14433 * @param { function } event 14434 * @returns { T } 14435 * @syscap SystemCapability.ArkUI.ArkUI.Full 14436 * @since 8 14437 */ 14438 /** 14439 * After binding, a callback is triggered when the component is dragged to the range of the component. 14440 * 14441 * @param { function } event 14442 * @returns { T } 14443 * @syscap SystemCapability.ArkUI.ArkUI.Full 14444 * @atomicservice 14445 * @since 11 14446 */ 14447 onDragEnter(event: (event: DragEvent, extraParams?: string) => void): T; 14448 14449 /** 14450 * After binding, a callback is triggered when the drag moves within the range of a placeable component. 14451 * 14452 * @param { function } event 14453 * @returns { T } 14454 * @syscap SystemCapability.ArkUI.ArkUI.Full 14455 * @since 8 14456 */ 14457 /** 14458 * After binding, a callback is triggered when the drag moves within the range of a placeable component. 14459 * 14460 * @param { function } event 14461 * @returns { T } 14462 * @syscap SystemCapability.ArkUI.ArkUI.Full 14463 * @atomicservice 14464 * @since 11 14465 */ 14466 onDragMove(event: (event: DragEvent, extraParams?: string) => void): T; 14467 14468 /** 14469 * After binding, a callback is triggered when the component is dragged out of the component range. 14470 * 14471 * @param { function } event 14472 * @returns { T } 14473 * @syscap SystemCapability.ArkUI.ArkUI.Full 14474 * @since 8 14475 */ 14476 /** 14477 * After binding, a callback is triggered when the component is dragged out of the component range. 14478 * 14479 * @param { function } event 14480 * @returns { T } 14481 * @syscap SystemCapability.ArkUI.ArkUI.Full 14482 * @atomicservice 14483 * @since 11 14484 */ 14485 onDragLeave(event: (event: DragEvent, extraParams?: string) => void): T; 14486 14487 /** 14488 * The component bound to this event can be used as the drag release target. 14489 * This callback is triggered when the drag behavior is stopped within the scope of the component. 14490 * 14491 * @param { function } event 14492 * @returns { T } 14493 * @syscap SystemCapability.ArkUI.ArkUI.Full 14494 * @since 8 14495 */ 14496 /** 14497 * The component bound to this event can be used as the drag release target. 14498 * This callback is triggered when the drag behavior is stopped within the scope of the component. 14499 * 14500 * @param { function } event 14501 * @returns { T } 14502 * @syscap SystemCapability.ArkUI.ArkUI.Full 14503 * @atomicservice 14504 * @since 11 14505 */ 14506 onDrop(event: (event: DragEvent, extraParams?: string) => void): T; 14507 14508 /** 14509 * This function is called when the drag event is end. 14510 * 14511 * @param { function } event - indicates the function to be called. 14512 * @returns { T } property value of type T. 14513 * @syscap SystemCapability.ArkUI.ArkUI.Full 14514 * @since 10 14515 */ 14516 /** 14517 * This function is called when the drag event is end. 14518 * 14519 * @param { function } event - indicates the function to be called. 14520 * @returns { T } property value of type T. 14521 * @syscap SystemCapability.ArkUI.ArkUI.Full 14522 * @atomicservice 14523 * @since 11 14524 */ 14525 onDragEnd(event: (event: DragEvent, extraParams?: string) => void): T; 14526 14527 /** 14528 * Allowed drop uniformData type for this node. 14529 * 14530 * @param { Array<UniformDataType> } value - the uniformData type for this node. 14531 * @returns { T } property value of type T. 14532 * @syscap SystemCapability.ArkUI.ArkUI.Full 14533 * @crossplatform 14534 * @since 10 14535 */ 14536 /** 14537 * Allowed drop uniformData type for this node. 14538 * 14539 * @param { Array<UniformDataType> } value - the uniformData type for this node. 14540 * @returns { T } property value of type T. 14541 * @syscap SystemCapability.ArkUI.ArkUI.Full 14542 * @crossplatform 14543 * @atomicservice 14544 * @since 11 14545 */ 14546 allowDrop(value: Array<UniformDataType>): T; 14547 14548 /** 14549 * Enable the selectable area can be dragged. 14550 * 14551 * @param { boolean } value - true means the area can be dragged, false means the area can't be dragged. 14552 * @returns { T } property value of type T. 14553 * @syscap SystemCapability.ArkUI.ArkUI.Full 14554 * @since 10 14555 */ 14556 /** 14557 * Enable the selectable area can be dragged. 14558 * 14559 * @param { boolean } value - true means the area can be dragged, false means the area can't be dragged. 14560 * @returns { T } property value of type T. 14561 * @syscap SystemCapability.ArkUI.ArkUI.Full 14562 * @crossplatform 14563 * @atomicservice 14564 * @since 11 14565 */ 14566 draggable(value: boolean): T; 14567 14568 /** 14569 * Set preview of the component for dragging process 14570 * 14571 * @param { CustomBuilder | DragItemInfo } value - preview of the component for dragging process 14572 * @returns { T } property value of type T. 14573 * @syscap SystemCapability.ArkUI.ArkUI.Full 14574 * @since 11 14575 */ 14576 dragPreview(value: CustomBuilder | DragItemInfo): T; 14577 14578 /** 14579 * Set the selectable area drag preview options. 14580 * 14581 * @param { DragPreviewOptions } value - preview options value. 14582 * @returns { T } property value of type T. 14583 * @syscap SystemCapability.ArkUI.ArkUI.Full 14584 * @since 11 14585 */ 14586 dragPreviewOptions(value: DragPreviewOptions): T; 14587 14588 /** 14589 * Add mask text to the current component. The layout is the same as that of the current component. 14590 * 14591 * @param { string | CustomBuilder } value 14592 * @param { object } options 14593 * @returns { T } 14594 * @syscap SystemCapability.ArkUI.ArkUI.Full 14595 * @since 7 14596 */ 14597 /** 14598 * Add mask text to the current component. The layout is the same as that of the current component. 14599 * 14600 * @param { string | CustomBuilder } value 14601 * @param { object } options 14602 * @returns { T } 14603 * @syscap SystemCapability.ArkUI.ArkUI.Full 14604 * @since 9 14605 * @form 14606 */ 14607 /** 14608 * Add mask text to the current component. The layout is the same as that of the current component. 14609 * 14610 * @param { string | CustomBuilder } value 14611 * @param { object } options 14612 * @returns { T } 14613 * @syscap SystemCapability.ArkUI.ArkUI.Full 14614 * @crossplatform 14615 * @since 10 14616 * @form 14617 */ 14618 /** 14619 * Add mask text to the current component. The layout is the same as that of the current component. 14620 * 14621 * @param { string | CustomBuilder } value 14622 * @param { object } options 14623 * @returns { T } 14624 * @syscap SystemCapability.ArkUI.ArkUI.Full 14625 * @crossplatform 14626 * @atomicservice 14627 * @since 11 14628 * @form 14629 */ 14630 overlay(value: string | CustomBuilder, options?: { align?: Alignment; offset?: { x?: number; y?: number } }): T; 14631 14632 /** 14633 * Linear Gradient 14634 * angle: Angle of Linear Gradient; direction:Direction of Linear Gradient; colors:Color description for gradients,repeating:repeating. 14635 * 14636 * @param { object } value 14637 * @returns { T } 14638 * @syscap SystemCapability.ArkUI.ArkUI.Full 14639 * @since 7 14640 */ 14641 /** 14642 * Linear Gradient 14643 * angle: Angle of Linear Gradient; direction:Direction of Linear Gradient; colors:Color description for gradients,repeating:repeating. 14644 * 14645 * @param { object } value 14646 * @returns { T } 14647 * @syscap SystemCapability.ArkUI.ArkUI.Full 14648 * @since 9 14649 * @form 14650 */ 14651 /** 14652 * Linear Gradient 14653 * angle: Angle of Linear Gradient; direction:Direction of Linear Gradient; colors:Color description for gradients,repeating:repeating. 14654 * 14655 * @param { object } value 14656 * @returns { T } 14657 * @syscap SystemCapability.ArkUI.ArkUI.Full 14658 * @crossplatform 14659 * @since 10 14660 * @form 14661 */ 14662 /** 14663 * Linear Gradient 14664 * angle: Angle of Linear Gradient; direction:Direction of Linear Gradient; colors:Color description for gradients,repeating:repeating. 14665 * 14666 * @param { object } value 14667 * @returns { T } 14668 * @syscap SystemCapability.ArkUI.ArkUI.Full 14669 * @crossplatform 14670 * @atomicservice 14671 * @since 11 14672 * @form 14673 */ 14674 linearGradient(value: { 14675 angle?: number | string; 14676 direction?: GradientDirection; 14677 colors: Array<any>; 14678 repeating?: boolean; 14679 }): T; 14680 14681 /** 14682 * Angle Gradient 14683 * center:is the center point of the angle gradient 14684 * start:Start point of angle gradient 14685 * end:End point of angle gradient 14686 * number:number 14687 * rotating:rotating 14688 * colors:Color description for gradients 14689 * repeating:repeating 14690 * 14691 * @param { object } value 14692 * @returns { T } 14693 * @syscap SystemCapability.ArkUI.ArkUI.Full 14694 * @since 7 14695 */ 14696 /** 14697 * Angle Gradient 14698 * center:is the center point of the angle gradient 14699 * start:Start point of angle gradient 14700 * end:End point of angle gradient 14701 * number:number 14702 * rotating:rotating 14703 * colors:Color description for gradients 14704 * repeating:repeating 14705 * 14706 * @param { object } value 14707 * @returns { T } 14708 * @syscap SystemCapability.ArkUI.ArkUI.Full 14709 * @since 9 14710 * @form 14711 */ 14712 /** 14713 * Angle Gradient 14714 * center:is the center point of the angle gradient 14715 * start:Start point of angle gradient 14716 * end:End point of angle gradient 14717 * number:number 14718 * rotating:rotating 14719 * colors:Color description for gradients 14720 * repeating:repeating 14721 * 14722 * @param { object } value 14723 * @returns { T } 14724 * @syscap SystemCapability.ArkUI.ArkUI.Full 14725 * @crossplatform 14726 * @since 10 14727 * @form 14728 */ 14729 /** 14730 * Angle Gradient 14731 * center:is the center point of the angle gradient 14732 * start:Start point of angle gradient 14733 * end:End point of angle gradient 14734 * number:number 14735 * rotating:rotating 14736 * colors:Color description for gradients 14737 * repeating:repeating 14738 * 14739 * @param { object } value 14740 * @returns { T } 14741 * @syscap SystemCapability.ArkUI.ArkUI.Full 14742 * @crossplatform 14743 * @atomicservice 14744 * @since 11 14745 * @form 14746 */ 14747 sweepGradient(value: { 14748 center: Array<any>; 14749 start?: number | string; 14750 end?: number | string; 14751 rotation?: number | string; 14752 colors: Array<any>; 14753 repeating?: boolean; 14754 }): T; 14755 14756 /** 14757 * Radial Gradient 14758 * center:Center point of radial gradient 14759 * radius:Radius of Radial Gradient 14760 * colors:Color description for gradients 14761 * repeating: Refill 14762 * 14763 * @param { object } value 14764 * @returns { T } 14765 * @syscap SystemCapability.ArkUI.ArkUI.Full 14766 * @since 7 14767 */ 14768 /** 14769 * Radial Gradient 14770 * center:Center point of radial gradient 14771 * radius:Radius of Radial Gradient 14772 * colors:Color description for gradients 14773 * repeating: Refill 14774 * 14775 * @param { object } value 14776 * @returns { T } 14777 * @syscap SystemCapability.ArkUI.ArkUI.Full 14778 * @since 9 14779 * @form 14780 */ 14781 /** 14782 * Radial Gradient 14783 * center:Center point of radial gradient 14784 * radius:Radius of Radial Gradient 14785 * colors:Color description for gradients 14786 * repeating: Refill 14787 * 14788 * @param { object } value 14789 * @returns { T } 14790 * @syscap SystemCapability.ArkUI.ArkUI.Full 14791 * @crossplatform 14792 * @since 10 14793 * @form 14794 */ 14795 /** 14796 * Radial Gradient 14797 * center:Center point of radial gradient 14798 * radius:Radius of Radial Gradient 14799 * colors:Color description for gradients 14800 * repeating: Refill 14801 * 14802 * @param { object } value 14803 * @returns { T } 14804 * @syscap SystemCapability.ArkUI.ArkUI.Full 14805 * @crossplatform 14806 * @atomicservice 14807 * @since 11 14808 * @form 14809 */ 14810 radialGradient(value: { center: Array<any>; radius: number | string; colors: Array<any>; repeating?: boolean }): T; 14811 14812 /** 14813 * Set the motion path of the component 14814 * path:Motion path for displacement animation, using the svg path string. 14815 * from:Start point of the motion path. The default value is 0.0. 14816 * to:End point of the motion path. The default value is 1.0. 14817 * rotatable:Whether to follow the path for rotation. 14818 * 14819 * @param { MotionPathOptions } value 14820 * @returns { T } 14821 * @syscap SystemCapability.ArkUI.ArkUI.Full 14822 * @since 7 14823 */ 14824 /** 14825 * Set the motion path of the component 14826 * path:Motion path for displacement animation, using the svg path string. 14827 * from:Start point of the motion path. The default value is 0.0. 14828 * to:End point of the motion path. The default value is 1.0. 14829 * rotatable:Whether to follow the path for rotation. 14830 * 14831 * @param { MotionPathOptions } value 14832 * @returns { T } 14833 * @syscap SystemCapability.ArkUI.ArkUI.Full 14834 * @crossplatform 14835 * @since 10 14836 */ 14837 /** 14838 * Set the motion path of the component 14839 * path:Motion path for displacement animation, using the svg path string. 14840 * from:Start point of the motion path. The default value is 0.0. 14841 * to:End point of the motion path. The default value is 1.0. 14842 * rotatable:Whether to follow the path for rotation. 14843 * 14844 * @param { MotionPathOptions } value 14845 * @returns { T } 14846 * @syscap SystemCapability.ArkUI.ArkUI.Full 14847 * @crossplatform 14848 * @atomicservice 14849 * @since 11 14850 */ 14851 motionPath(value: MotionPathOptions): T; 14852 14853 /** 14854 * Add a shadow effect to the current component 14855 * 14856 * @param { ShadowOptions | ShadowStyle } value 14857 * @returns { T } 14858 * @syscap SystemCapability.ArkUI.ArkUI.Full 14859 * @since 7 14860 */ 14861 /** 14862 * Add a shadow effect to the current component 14863 * 14864 * @param { ShadowOptions | ShadowStyle } value 14865 * @returns { T } 14866 * @syscap SystemCapability.ArkUI.ArkUI.Full 14867 * @since 9 14868 * @form 14869 */ 14870 /** 14871 * Add a shadow effect to the current component 14872 * 14873 * @param { ShadowOptions | ShadowStyle } value 14874 * @returns { T } 14875 * @syscap SystemCapability.ArkUI.ArkUI.Full 14876 * @crossplatform 14877 * @since 10 14878 * @form 14879 */ 14880 /** 14881 * Add a shadow effect to the current component 14882 * 14883 * @param { ShadowOptions | ShadowStyle } value 14884 * @returns { T } 14885 * @syscap SystemCapability.ArkUI.ArkUI.Full 14886 * @crossplatform 14887 * @atomicservice 14888 * @since 11 14889 * @form 14890 */ 14891 shadow(value: ShadowOptions | ShadowStyle): T; 14892 14893 /** 14894 * Add a blendMode effect to the current component 14895 * 14896 * @param { BlendMode } value - Different hybrid modes 14897 * @param { BlendApplyType } [type] - Different blend apply type 14898 * @returns { T } 14899 * @syscap SystemCapability.ArkUI.ArkUI.Full 14900 * @crossplatform 14901 * @form 14902 * @since 11 14903 */ 14904 blendMode(value: BlendMode, type?: BlendApplyType): T; 14905 14906 /** 14907 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 14908 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 14909 * 14910 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value 14911 * @returns { T } 14912 * @syscap SystemCapability.ArkUI.ArkUI.Full 14913 * @since 7 14914 */ 14915 /** 14916 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 14917 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 14918 * 14919 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value 14920 * @returns { T } 14921 * @syscap SystemCapability.ArkUI.ArkUI.Full 14922 * @since 9 14923 * @form 14924 */ 14925 /** 14926 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 14927 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 14928 * 14929 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value 14930 * @returns { T } 14931 * @syscap SystemCapability.ArkUI.ArkUI.Full 14932 * @crossplatform 14933 * @since 10 14934 * @form 14935 */ 14936 /** 14937 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 14938 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 14939 * 14940 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value 14941 * @returns { T } 14942 * @syscap SystemCapability.ArkUI.ArkUI.Full 14943 * @crossplatform 14944 * @atomicservice 14945 * @since 11 14946 * @form 14947 */ 14948 clip(value: boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute): T; 14949 14950 /** 14951 * Applies a mask of the specified shape to the current assembly. 14952 * 14953 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value 14954 * @returns { T } 14955 * @syscap SystemCapability.ArkUI.ArkUI.Full 14956 * @since 7 14957 */ 14958 /** 14959 * Applies a mask of the specified shape to the current assembly. 14960 * 14961 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value - indicates the shape of the mask. 14962 * @returns { T } 14963 * @syscap SystemCapability.ArkUI.ArkUI.Full 14964 * @since 9 14965 * @form 14966 */ 14967 /** 14968 * Applies a mask of the specified shape to the current assembly. 14969 * 14970 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value - indicates the shape of the mask. 14971 * @returns { T } 14972 * @syscap SystemCapability.ArkUI.ArkUI.Full 14973 * @crossplatform 14974 * @since 10 14975 * @form 14976 */ 14977 /** 14978 * Applies a mask of the specified shape to the current assembly. 14979 * 14980 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value - indicates the shape of the mask. 14981 * @returns { T } 14982 * @syscap SystemCapability.ArkUI.ArkUI.Full 14983 * @crossplatform 14984 * @atomicservice 14985 * @since 11 14986 * @form 14987 */ 14988 mask(value: CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask): T; 14989 14990 /** 14991 * Key. User can set an key to the component to identify it. 14992 * 14993 * @param { string } value 14994 * @returns { T } 14995 * @syscap SystemCapability.ArkUI.ArkUI.Full 14996 * @systemapi 14997 * @since 8 14998 * @test 14999 */ 15000 key(value: string): T; 15001 15002 /** 15003 * Id. User can set an id to the component to identify it. 15004 * 15005 * @param { string } value 15006 * @returns { T } 15007 * @syscap SystemCapability.ArkUI.ArkUI.Full 15008 * @since 8 15009 */ 15010 /** 15011 * Id. User can set an id to the component to identify it. 15012 * 15013 * @param { string } value 15014 * @returns { T } 15015 * @syscap SystemCapability.ArkUI.ArkUI.Full 15016 * @since 9 15017 * @form 15018 */ 15019 /** 15020 * Id. User can set an id to the component to identify it. 15021 * 15022 * @param { string } value 15023 * @returns { T } 15024 * @syscap SystemCapability.ArkUI.ArkUI.Full 15025 * @crossplatform 15026 * @since 10 15027 * @form 15028 */ 15029 /** 15030 * Id. User can set an id to the component to identify it. 15031 * 15032 * @param { string } value 15033 * @returns { T } 15034 * @syscap SystemCapability.ArkUI.ArkUI.Full 15035 * @crossplatform 15036 * @atomicservice 15037 * @since 11 15038 * @form 15039 */ 15040 id(value: string): T; 15041 15042 /** 15043 * geometryTransition 15044 * 15045 * @param { string } id 15046 * @returns { T } 15047 * @syscap SystemCapability.ArkUI.ArkUI.Full 15048 * @since 7 15049 */ 15050 /** 15051 * geometryTransition 15052 * 15053 * @param { string } id 15054 * @returns { T } 15055 * @syscap SystemCapability.ArkUI.ArkUI.Full 15056 * @crossplatform 15057 * @since 10 15058 */ 15059 /** 15060 * geometryTransition 15061 * 15062 * @param { string } id 15063 * @returns { T } 15064 * @syscap SystemCapability.ArkUI.ArkUI.Full 15065 * @crossplatform 15066 * @atomicservice 15067 * @since 11 15068 */ 15069 geometryTransition(id: string): T; 15070 /** 15071 * Shared geometry transition 15072 * 15073 * @param { string } id - geometry transition id 15074 * @param { GeometryTransitionOptions } options - Indicates the options of geometry transition. 15075 * @returns { T } 15076 * @syscap SystemCapability.ArkUI.ArkUI.Full 15077 * @crossplatform 15078 * @since 11 15079 */ 15080 geometryTransition(id: string, options?: GeometryTransitionOptions): T; 15081 15082 /** 15083 * Popup control 15084 * 15085 * @param { boolean } show 15086 * @param { PopupOptions | CustomPopupOptions } popup 15087 * @returns { T } 15088 * @syscap SystemCapability.ArkUI.ArkUI.Full 15089 * @since 7 15090 */ 15091 /** 15092 * Popup control 15093 * 15094 * @param { boolean } show 15095 * @param { PopupOptions | CustomPopupOptions } popup 15096 * @returns { T } 15097 * @syscap SystemCapability.ArkUI.ArkUI.Full 15098 * @crossplatform 15099 * @atomicservice 15100 * @since 11 15101 */ 15102 bindPopup(show: boolean, popup: PopupOptions | CustomPopupOptions): T; 15103 15104 /** 15105 * Menu control 15106 * 15107 * @param { { value: ResourceStr; icon?: ResourceStr; action: () => void }[] | CustomBuilder } content 15108 * action: () => void }[] | CustomBuilder } content - Indicates the content of menu. 15109 * @param { MenuOptions } options 15110 * @returns { T } 15111 * @syscap SystemCapability.ArkUI.ArkUI.Full 15112 * @since 7 15113 */ 15114 /** 15115 * Menu control 15116 * 15117 * @param { { value: ResourceStr; icon?: ResourceStr; action: () => void }[] | CustomBuilder } content 15118 * action: () => void }[] | CustomBuilder } content - Indicates the content of menu. 15119 * @param { MenuOptions } options - Indicates the options of menu. 15120 * @returns { T } 15121 * @syscap SystemCapability.ArkUI.ArkUI.Full 15122 * @crossplatform 15123 * @since 10 15124 */ 15125 /** 15126 * Menu control 15127 * 15128 * @param { Array<MenuElement> | CustomBuilder } content - Indicates the content of menu. 15129 * @param { MenuOptions } options - Indicates the options of menu. 15130 * @returns { T } 15131 * @syscap SystemCapability.ArkUI.ArkUI.Full 15132 * @crossplatform 15133 * @atomicservice 15134 * @since 11 15135 */ 15136 bindMenu(content: Array<MenuElement> | CustomBuilder, options?: MenuOptions): T; 15137 15138 /** 15139 * Menu control 15140 * 15141 * @param { boolean } isShow true means display menu, false means hide menu. 15142 * @param { Array<MenuElement> | CustomBuilder } content - Indicates the content of menu. 15143 * @param { MenuOptions } options - Indicates the options of menu. 15144 * @returns { T } 15145 * @syscap SystemCapability.ArkUI.ArkUI.Full 15146 * @crossplatform 15147 * @since 11 15148 */ 15149 bindMenu(isShow: boolean, content: Array<MenuElement> | CustomBuilder, options?: MenuOptions): T; 15150 15151 /** 15152 * ContextMenu control 15153 * 15154 * @param { CustomBuilder } content 15155 * @param { ResponseType } responseType 15156 * @param { ContextMenuOptions } options 15157 * @returns { T } 15158 * @syscap SystemCapability.ArkUI.ArkUI.Full 15159 * @since 8 15160 */ 15161 /** 15162 * ContextMenu control 15163 * 15164 * @param { CustomBuilder } content - Indicates the content of context menu. 15165 * @param { ResponseType } responseType - Indicates response type of context menu. 15166 * @param { ContextMenuOptions } options - Indicates the options of context menu. 15167 * @returns { T } 15168 * @syscap SystemCapability.ArkUI.ArkUI.Full 15169 * @crossplatform 15170 * @since 10 15171 */ 15172 /** 15173 * ContextMenu control 15174 * 15175 * @param { CustomBuilder } content - Indicates the content of context menu. 15176 * @param { ResponseType } responseType - Indicates response type of context menu. 15177 * @param { ContextMenuOptions } options - Indicates the options of context menu. 15178 * @returns { T } 15179 * @syscap SystemCapability.ArkUI.ArkUI.Full 15180 * @crossplatform 15181 * @atomicservice 15182 * @since 11 15183 */ 15184 bindContextMenu(content: CustomBuilder, responseType: ResponseType, options?: ContextMenuOptions): T; 15185 15186 /** 15187 * Bind content cover 15188 * 15189 * @param { boolean } isShow - true means display content, false means hide content. 15190 * @param { CustomBuilder } builder - the content to be displayed. 15191 * @param { ModalTransition } type - transition type. 15192 * @returns { T } 15193 * @syscap SystemCapability.ArkUI.ArkUI.Full 15194 * @crossplatform 15195 * @since 10 15196 */ 15197 /** 15198 * Bind content cover 15199 * 15200 * @param { boolean } isShow - true means display content, false means hide content. 15201 * @param { CustomBuilder } builder - the content to be displayed. 15202 * @param { ModalTransition } type - transition type. 15203 * @returns { T } 15204 * @syscap SystemCapability.ArkUI.ArkUI.Full 15205 * @crossplatform 15206 * @atomicservice 15207 * @since 11 15208 */ 15209 bindContentCover(isShow: boolean, builder: CustomBuilder, type?: ModalTransition): T; 15210 15211 /** 15212 * Bind content cover 15213 * 15214 * @param { boolean } isShow - true means display content, false means hide content. 15215 * @param { CustomBuilder } builder - the content to be displayed. 15216 * @param { ContentCoverOptions } options - options of content cover. 15217 * @returns { T } 15218 * @syscap SystemCapability.ArkUI.ArkUI.Full 15219 * @crossplatform 15220 * @since 10 15221 */ 15222 /** 15223 * Bind content cover 15224 * 15225 * @param { boolean } isShow - true means display content, false means hide content. 15226 * @param { CustomBuilder } builder - the content to be displayed. 15227 * @param { ContentCoverOptions } options - options of content cover. 15228 * @returns { T } 15229 * @syscap SystemCapability.ArkUI.ArkUI.Full 15230 * @crossplatform 15231 * @atomicservice 15232 * @since 11 15233 */ 15234 bindContentCover(isShow: boolean, builder: CustomBuilder, options?: ContentCoverOptions): T; 15235 15236 /** 15237 * Bind sheet 15238 * 15239 * @param { boolean } isShow - true means display sheet, false means hide sheet. 15240 * @param { CustomBuilder } builder - the sheet to be displayed. 15241 * @param { SheetOptions } options - options of sheet. 15242 * @returns { T } - template type 15243 * @syscap SystemCapability.ArkUI.ArkUI.Full 15244 * @crossplatform 15245 * @since 10 15246 */ 15247 /** 15248 * Bind sheet 15249 * 15250 * @param { boolean } isShow - true means display sheet, false means hide sheet. 15251 * @param { CustomBuilder } builder - the sheet to be displayed. 15252 * @param { SheetOptions } options - options of sheet. 15253 * @returns { T } - template type 15254 * @syscap SystemCapability.ArkUI.ArkUI.Full 15255 * @crossplatform 15256 * @atomicservice 15257 * @since 11 15258 */ 15259 bindSheet(isShow: boolean, builder: CustomBuilder, options?: SheetOptions): T; 15260 15261 /** 15262 * Sets styles for component state. 15263 * 15264 * @param { StateStyles } value 15265 * @returns { T } 15266 * @syscap SystemCapability.ArkUI.ArkUI.Full 15267 * @since 8 15268 */ 15269 /** 15270 * Sets styles for component state. 15271 * 15272 * @param { StateStyles } value 15273 * @returns { T } 15274 * @syscap SystemCapability.ArkUI.ArkUI.Full 15275 * @since 9 15276 * @form 15277 */ 15278 /** 15279 * Sets styles for component state. 15280 * 15281 * @param { StateStyles } value 15282 * @returns { T } 15283 * @syscap SystemCapability.ArkUI.ArkUI.Full 15284 * @crossplatform 15285 * @since 10 15286 * @form 15287 */ 15288 /** 15289 * Sets styles for component state. 15290 * 15291 * @param { StateStyles } value 15292 * @returns { T } 15293 * @syscap SystemCapability.ArkUI.ArkUI.Full 15294 * @crossplatform 15295 * @atomicservice 15296 * @since 11 15297 * @form 15298 */ 15299 stateStyles(value: StateStyles): T; 15300 15301 /** 15302 * id for distribute identification. 15303 * 15304 * @param { number } value 15305 * @returns { T } 15306 * @syscap SystemCapability.ArkUI.ArkUI.Full 15307 * @since 8 15308 */ 15309 /** 15310 * id for distribute identification. 15311 * 15312 * @param { number } value 15313 * @returns { T } 15314 * @syscap SystemCapability.ArkUI.ArkUI.Full 15315 * @crossplatform 15316 * @atomicservice 15317 * @since 11 15318 */ 15319 restoreId(value: number): T; 15320 15321 /** 15322 * Trigger a visible area change event. 15323 * 15324 * @param { Array<number> } ratios 15325 * @param { function } event 15326 * @returns { T } 15327 * @syscap SystemCapability.ArkUI.ArkUI.Full 15328 * @since 9 15329 */ 15330 /** 15331 * Trigger a visible area change event. 15332 * 15333 * @param { Array<number> } ratios 15334 * @param { function } event 15335 * @returns { T } 15336 * @syscap SystemCapability.ArkUI.ArkUI.Full 15337 * @crossplatform 15338 * @since 10 15339 */ 15340 /** 15341 * Trigger a visible area change event. 15342 * 15343 * @param { Array<number> } ratios 15344 * @param { function } event 15345 * @returns { T } 15346 * @syscap SystemCapability.ArkUI.ArkUI.Full 15347 * @crossplatform 15348 * @atomicservice 15349 * @since 11 15350 */ 15351 onVisibleAreaChange(ratios: Array<number>, event: (isVisible: boolean, currentRatio: number) => void): T; 15352 15353 /** 15354 * Set the spherical effect of the component. 15355 * 15356 * @param { number } value - set the degree of spherical effect, value range [0, 1]. 15357 * If the value is 0, the component keep same, else the value is 1, component are fully spherical. 15358 * @returns { T } 15359 * @syscap SystemCapability.ArkUI.ArkUI.Full 15360 * @systemapi 15361 * @crossplatform 15362 * @since 10 15363 */ 15364 sphericalEffect(value: number): T; 15365 15366 /** 15367 * Set the light up effect of the component 15368 * 15369 * @param { number } value - set the degree to which the component lights up, value range [0, 1]. 15370 * The color brightness in the component rendering content area is greater than the value and can be displayed, otherwise it will not be displayed. 15371 * @returns { T } 15372 * @syscap SystemCapability.ArkUI.ArkUI.Full 15373 * @systemapi 15374 * @crossplatform 15375 * @since 10 15376 */ 15377 lightUpEffect(value: number): T; 15378 15379 /** 15380 * Set the edge pixel stretch effect of the Component. 15381 * 15382 * @param { PixelStretchEffectOptions } options 15383 * @returns { T } 15384 * @syscap SystemCapability.ArkUI.ArkUI.Full 15385 * @systemapi 15386 * @crossplatform 15387 * @since 10 15388 */ 15389 pixelStretchEffect(options: PixelStretchEffectOptions): T; 15390 15391 /** 15392 * Sets hot keys 15393 * 15394 * @param { string | FunctionKey } value - Character of the combination key. 15395 * @param { Array<ModifierKey> } keys - The modifier keys modify the action of key when the key are pressed at the same time. 15396 * @param { function } [action] - Callback function, triggered when the shortcut keyboard is pressed. 15397 * @returns { T } 15398 * @syscap SystemCapability.ArkUI.ArkUI.Full 15399 * @crossplatform 15400 * @since 10 15401 */ 15402 /** 15403 * Sets hot keys 15404 * 15405 * @param { string | FunctionKey } value - Character of the combination key. 15406 * @param { Array<ModifierKey> } keys - The modifier keys modify the action of key when the key are pressed at the same time. 15407 * @param { function } [action] - Callback function, triggered when the shortcut keyboard is pressed. 15408 * @returns { T } 15409 * @syscap SystemCapability.ArkUI.ArkUI.Full 15410 * @crossplatform 15411 * @atomicservice 15412 * @since 11 15413 */ 15414 keyboardShortcut(value: string | FunctionKey, keys: Array<ModifierKey>, action?: () => void): T; 15415 15416 /** 15417 * Sets accessibilityGroup 15418 * 15419 * @param { boolean } value - set group with accessibility 15420 * @returns { T } 15421 * @syscap SystemCapability.ArkUI.ArkUI.Full 15422 * @crossplatform 15423 * @since 10 15424 */ 15425 /** 15426 * Sets accessibilityGroup 15427 * 15428 * @param { boolean } value - set group with accessibility 15429 * @returns { T } 15430 * @syscap SystemCapability.ArkUI.ArkUI.Full 15431 * @crossplatform 15432 * @atomicservice 15433 * @since 11 15434 */ 15435 accessibilityGroup(value: boolean): T; 15436 15437 /** 15438 * Sets accessibilityText 15439 * 15440 * @param { string } value - set accessibility text 15441 * @returns { T } 15442 * @syscap SystemCapability.ArkUI.ArkUI.Full 15443 * @crossplatform 15444 * @since 10 15445 */ 15446 /** 15447 * Sets accessibilityText 15448 * 15449 * @param { string } value - set accessibility text 15450 * @returns { T } 15451 * @syscap SystemCapability.ArkUI.ArkUI.Full 15452 * @crossplatform 15453 * @atomicservice 15454 * @since 11 15455 */ 15456 accessibilityText(value: string): T; 15457 15458 /** 15459 * Sets accessibilityDescription 15460 * 15461 * @param { string } value - set description of accessibility 15462 * @returns { T } 15463 * @syscap SystemCapability.ArkUI.ArkUI.Full 15464 * @crossplatform 15465 * @since 10 15466 */ 15467 /** 15468 * Sets accessibilityDescription 15469 * 15470 * @param { string } value - set description of accessibility 15471 * @returns { T } 15472 * @syscap SystemCapability.ArkUI.ArkUI.Full 15473 * @crossplatform 15474 * @atomicservice 15475 * @since 11 15476 */ 15477 accessibilityDescription(value: string): T; 15478 15479 /** 15480 * Sets accessibilityLevel 15481 * 15482 * @param { string } value - set accessibility level 15483 * @returns { T } 15484 * @syscap SystemCapability.ArkUI.ArkUI.Full 15485 * @crossplatform 15486 * @since 10 15487 */ 15488 /** 15489 * Sets accessibilityLevel 15490 * 15491 * @param { string } value - set accessibility level 15492 * @returns { T } 15493 * @syscap SystemCapability.ArkUI.ArkUI.Full 15494 * @crossplatform 15495 * @atomicservice 15496 * @since 11 15497 */ 15498 accessibilityLevel(value: string): T; 15499 15500 /** 15501 * Sets accessibilityVirtualNode 15502 * 15503 * @param { CustomBuilder } builder - set virtual node of accessibility 15504 * @returns { T } 15505 * @syscap SystemCapability.ArkUI.ArkUI.Full 15506 * @crossplatform 15507 * @atomicservice 15508 * @since 11 15509 */ 15510 accessibilityVirtualNode(builder: CustomBuilder): T; 15511 15512 /** 15513 * Sets obscured 15514 * 15515 * @param { Array<ObscuredReasons> } reasons - reasons of obscuration 15516 * @returns { T } 15517 * @syscap SystemCapability.ArkUI.ArkUI.Full 15518 * @crossplatform 15519 * @since 10 15520 */ 15521 /** 15522 * Sets obscured 15523 * 15524 * @param { Array<ObscuredReasons> } reasons - reasons of obscuration 15525 * @returns { T } 15526 * @syscap SystemCapability.ArkUI.ArkUI.Full 15527 * @crossplatform 15528 * @atomicservice 15529 * @since 11 15530 */ 15531 obscured(reasons: Array<ObscuredReasons>): T; 15532 15533 /** 15534 * Reuse id is used for identify the reuse type for each custom node. 15535 * 15536 * @param { string } id - The id for reusable custom node. 15537 * @returns { T } 15538 * @syscap SystemCapability.ArkUI.ArkUI.Full 15539 * @crossplatform 15540 * @since 10 15541 */ 15542 /** 15543 * Reuse id is used for identify the reuse type for each custom node. 15544 * 15545 * @param { string } id - The id for reusable custom node. 15546 * @returns { T } 15547 * @syscap SystemCapability.ArkUI.ArkUI.Full 15548 * @crossplatform 15549 * @atomicservice 15550 * @since 11 15551 */ 15552 reuseId(id: string): T; 15553 15554 /** 15555 * Sets how content is drawn within nodes duration animation 15556 * 15557 * @param { RenderFit } fitMode - The render fit mode of content. 15558 * @returns { T } 15559 * @syscap SystemCapability.ArkUI.ArkUI.Full 15560 * @crossplatform 15561 * @since 10 15562 */ 15563 /** 15564 * Sets how content is drawn within nodes duration animation 15565 * 15566 * @param { RenderFit } fitMode - The render fit mode of content. 15567 * @returns { T } 15568 * @syscap SystemCapability.ArkUI.ArkUI.Full 15569 * @crossplatform 15570 * @atomicservice 15571 * @since 11 15572 */ 15573 renderFit(fitMode: RenderFit): T; 15574 15575 /** 15576 * Sets the attribute modifier. 15577 * 15578 * @param { AttributeModifier<T> } modifier 15579 * @returns { T } 15580 * @syscap SystemCapability.ArkUI.ArkUI.Full 15581 * @crossplatform 15582 * @since 11 15583 */ 15584 attributeModifier(modifier: AttributeModifier<T>): T; 15585 15586 /** 15587 * Adds a background dynamic light up effect to the current component. 15588 * 15589 * @param { BackgroundBrightnessOptions } params - params indicates BackgroundBrightnessOptions 15590 * @returns { T } 15591 * @syscap SystemCapability.ArkUI.ArkUI.Full 15592 * @systemapi 15593 * @since 11 15594 */ 15595 backgroundBrightness(params: BackgroundBrightnessOptions): T; 15596 15597 /** 15598 * When a gesture bound to this component will be accepted, a user-defined callback is triggered to get the result 15599 * 15600 * @param { function } callback - A callback instance used when a gesture bound to this component will be accepted. 15601 * @returns { T } 15602 * @syscap SystemCapability.ArkUI.ArkUI.Full 15603 * @crossplatform 15604 * @since 11 15605 */ 15606 onGestureJudgeBegin(callback: (gestureInfo: GestureInfo, event: BaseGestureEvent) => GestureJudgeResult): T; 15607 15608 /** 15609 * Events are monopolized by components. 15610 * 15611 * @param { boolean } monopolize - indicate the monopoly of events 15612 * @returns { T } 15613 * @syscap SystemCapability.ArkUI.ArkUI.Full 15614 * @crossplatform 15615 * @since 11 15616 */ 15617 monopolizeEvents(monopolize: boolean): T; 15618} 15619 15620/** 15621 * CommonAttribute for ide. 15622 * 15623 * @extends CommonMethod<CommonAttribute> 15624 * @syscap SystemCapability.ArkUI.ArkUI.Full 15625 * @since 7 15626 */ 15627/** 15628 * CommonAttribute for ide. 15629 * 15630 * @extends CommonMethod<CommonAttribute> 15631 * @syscap SystemCapability.ArkUI.ArkUI.Full 15632 * @since 9 15633 * @form 15634 */ 15635/** 15636 * CommonAttribute for ide. 15637 * 15638 * @extends CommonMethod<CommonAttribute> 15639 * @syscap SystemCapability.ArkUI.ArkUI.Full 15640 * @crossplatform 15641 * @since 10 15642 * @form 15643 */ 15644/** 15645 * CommonAttribute for ide. 15646 * 15647 * @extends CommonMethod<CommonAttribute> 15648 * @syscap SystemCapability.ArkUI.ArkUI.Full 15649 * @crossplatform 15650 * @atomicservice 15651 * @since 11 15652 * @form 15653 */ 15654declare class CommonAttribute extends CommonMethod<CommonAttribute> {} 15655 15656/** 15657 * CommonInterface for ide. 15658 * 15659 * @interface CommonInterface 15660 * @syscap SystemCapability.ArkUI.ArkUI.Full 15661 * @since 7 15662 */ 15663/** 15664 * CommonInterface for ide. 15665 * 15666 * @interface CommonInterface 15667 * @syscap SystemCapability.ArkUI.ArkUI.Full 15668 * @since 9 15669 * @form 15670 */ 15671/** 15672 * CommonInterface for ide. 15673 * 15674 * @interface CommonInterface 15675 * @syscap SystemCapability.ArkUI.ArkUI.Full 15676 * @crossplatform 15677 * @since 10 15678 * @form 15679 */ 15680/** 15681 * CommonInterface for ide. 15682 * 15683 * @interface CommonInterface 15684 * @syscap SystemCapability.ArkUI.ArkUI.Full 15685 * @crossplatform 15686 * @atomicservice 15687 * @since 11 15688 * @form 15689 */ 15690interface CommonInterface { 15691 /** 15692 * Constructor. 15693 * 15694 * @returns { CommonAttribute } 15695 * @syscap SystemCapability.ArkUI.ArkUI.Full 15696 * @since 7 15697 */ 15698 /** 15699 * Constructor 15700 * 15701 * @returns { CommonAttribute } 15702 * @syscap SystemCapability.ArkUI.ArkUI.Full 15703 * @since 9 15704 * @form 15705 */ 15706 /** 15707 * Constructor 15708 * 15709 * @returns { CommonAttribute } 15710 * @syscap SystemCapability.ArkUI.ArkUI.Full 15711 * @crossplatform 15712 * @since 10 15713 * @form 15714 */ 15715 /** 15716 * Constructor 15717 * 15718 * @returns { CommonAttribute } 15719 * @syscap SystemCapability.ArkUI.ArkUI.Full 15720 * @crossplatform 15721 * @atomicservice 15722 * @since 11 15723 * @form 15724 */ 15725 (): CommonAttribute; 15726} 15727 15728/** 15729 * CommonInstance for ide. 15730 * 15731 * @syscap SystemCapability.ArkUI.ArkUI.Full 15732 * @since 7 15733 */ 15734/** 15735 * CommonInstance for ide. 15736 * 15737 * @syscap SystemCapability.ArkUI.ArkUI.Full 15738 * @since 9 15739 * @form 15740 */ 15741/** 15742 * CommonInstance for ide. 15743 * 15744 * @syscap SystemCapability.ArkUI.ArkUI.Full 15745 * @crossplatform 15746 * @since 10 15747 * @form 15748 */ 15749/** 15750 * CommonInstance for ide. 15751 * 15752 * @syscap SystemCapability.ArkUI.ArkUI.Full 15753 * @crossplatform 15754 * @atomicservice 15755 * @since 11 15756 * @form 15757 */ 15758declare const CommonInstance: CommonAttribute; 15759 15760/** 15761 * Common for ide. 15762 * 15763 * @syscap SystemCapability.ArkUI.ArkUI.Full 15764 * @since 7 15765 */ 15766/** 15767 * Common for ide. 15768 * 15769 * @syscap SystemCapability.ArkUI.ArkUI.Full 15770 * @since 9 15771 * @form 15772 */ 15773/** 15774 * Common for ide. 15775 * 15776 * @syscap SystemCapability.ArkUI.ArkUI.Full 15777 * @crossplatform 15778 * @since 10 15779 * @form 15780 */ 15781/** 15782 * Common for ide. 15783 * 15784 * @syscap SystemCapability.ArkUI.ArkUI.Full 15785 * @crossplatform 15786 * @atomicservice 15787 * @since 11 15788 * @form 15789 */ 15790declare const Common: CommonInterface; 15791 15792/** 15793 * Defines the CustomBuilder Type. 15794 * 15795 * @syscap SystemCapability.ArkUI.ArkUI.Full 15796 * @since 8 15797 */ 15798/** 15799 * Defines the CustomBuilder Type. 15800 * 15801 * @syscap SystemCapability.ArkUI.ArkUI.Full 15802 * @since 9 15803 * @form 15804 */ 15805/** 15806 * Defines the CustomBuilder Type. 15807 * 15808 * @syscap SystemCapability.ArkUI.ArkUI.Full 15809 * @crossplatform 15810 * @since 10 15811 * @form 15812 */ 15813/** 15814 * Defines the CustomBuilder Type. 15815 * 15816 * @syscap SystemCapability.ArkUI.ArkUI.Full 15817 * @crossplatform 15818 * @atomicservice 15819 * @since 11 15820 * @form 15821 */ 15822declare type CustomBuilder = (() => any) | void; 15823 15824/** 15825 * Defines the segment of blur. 15826 * The first element in the tuple means fraction. 15827 * The range of this value is [0,1]. A value of 1 means opaque and 0 means completely transparent. 15828 * The second element means the stop position. 15829 * The range of this value is [0,1]. A value of 1 means region ending position and 0 means region starting position. 15830 * 15831 * @syscap SystemCapability.ArkUI.ArkUI.Full 15832 * @systemapi 15833 * @since 10 15834 */ 15835declare type FractionStop = [ number, number ]; 15836 15837/** 15838 * CommonShapeMethod 15839 * 15840 * @extends CommonMethod<T> 15841 * @syscap SystemCapability.ArkUI.ArkUI.Full 15842 * @since 7 15843 */ 15844/** 15845 * CommonShapeMethod 15846 * 15847 * @extends CommonMethod<T> 15848 * @syscap SystemCapability.ArkUI.ArkUI.Full 15849 * @since 9 15850 * @form 15851 */ 15852/** 15853 * CommonShapeMethod 15854 * 15855 * @extends CommonMethod<T> 15856 * @syscap SystemCapability.ArkUI.ArkUI.Full 15857 * @crossplatform 15858 * @since 10 15859 * @form 15860 */ 15861/** 15862 * CommonShapeMethod 15863 * 15864 * @extends CommonMethod<T> 15865 * @syscap SystemCapability.ArkUI.ArkUI.Full 15866 * @crossplatform 15867 * @atomicservice 15868 * @since 11 15869 * @form 15870 */ 15871declare class CommonShapeMethod<T> extends CommonMethod<T> { 15872 /** 15873 * constructor. 15874 * 15875 * @syscap SystemCapability.ArkUI.ArkUI.Full 15876 * @systemapi 15877 * @since 7 15878 */ 15879 /** 15880 * constructor. 15881 * 15882 * @syscap SystemCapability.ArkUI.ArkUI.Full 15883 * @systemapi 15884 * @since 9 15885 * @form 15886 */ 15887 constructor(); 15888 15889 /** 15890 * border Color 15891 * 15892 * @param { ResourceColor } value 15893 * @returns { T } 15894 * @syscap SystemCapability.ArkUI.ArkUI.Full 15895 * @since 7 15896 */ 15897 /** 15898 * border Color 15899 * 15900 * @param { ResourceColor } value 15901 * @returns { T } 15902 * @syscap SystemCapability.ArkUI.ArkUI.Full 15903 * @since 9 15904 * @form 15905 */ 15906 /** 15907 * border Color 15908 * 15909 * @param { ResourceColor } value 15910 * @returns { T } 15911 * @syscap SystemCapability.ArkUI.ArkUI.Full 15912 * @crossplatform 15913 * @since 10 15914 * @form 15915 */ 15916 /** 15917 * border Color 15918 * 15919 * @param { ResourceColor } value 15920 * @returns { T } 15921 * @syscap SystemCapability.ArkUI.ArkUI.Full 15922 * @crossplatform 15923 * @atomicservice 15924 * @since 11 15925 * @form 15926 */ 15927 stroke(value: ResourceColor): T; 15928 15929 /** 15930 * Fill color. 15931 * 15932 * @param { ResourceColor } value 15933 * @returns { T } 15934 * @syscap SystemCapability.ArkUI.ArkUI.Full 15935 * @since 7 15936 */ 15937 /** 15938 * Fill color. 15939 * 15940 * @param { ResourceColor } value 15941 * @returns { T } 15942 * @syscap SystemCapability.ArkUI.ArkUI.Full 15943 * @since 9 15944 * @form 15945 */ 15946 /** 15947 * Fill color. 15948 * 15949 * @param { ResourceColor } value 15950 * @returns { T } 15951 * @syscap SystemCapability.ArkUI.ArkUI.Full 15952 * @crossplatform 15953 * @since 10 15954 * @form 15955 */ 15956 /** 15957 * Fill color. 15958 * 15959 * @param { ResourceColor } value 15960 * @returns { T } 15961 * @syscap SystemCapability.ArkUI.ArkUI.Full 15962 * @crossplatform 15963 * @atomicservice 15964 * @since 11 15965 * @form 15966 */ 15967 fill(value: ResourceColor): T; 15968 15969 /** 15970 * Offset from the start point of the border drawing. 15971 * 15972 * @param { number | string } value 15973 * @returns { T } 15974 * @syscap SystemCapability.ArkUI.ArkUI.Full 15975 * @since 7 15976 */ 15977 /** 15978 * Offset from the start point of the border drawing. 15979 * 15980 * @param { number | string } value 15981 * @returns { T } 15982 * @syscap SystemCapability.ArkUI.ArkUI.Full 15983 * @since 9 15984 * @form 15985 */ 15986 /** 15987 * Offset from the start point of the border drawing. 15988 * 15989 * @param { number | string } value 15990 * @returns { T } 15991 * @syscap SystemCapability.ArkUI.ArkUI.Full 15992 * @crossplatform 15993 * @since 10 15994 * @form 15995 */ 15996 /** 15997 * Offset from the start point of the border drawing. 15998 * 15999 * @param { number | string } value 16000 * @returns { T } 16001 * @syscap SystemCapability.ArkUI.ArkUI.Full 16002 * @crossplatform 16003 * @atomicservice 16004 * @since 11 16005 * @form 16006 */ 16007 strokeDashOffset(value: number | string): T; 16008 16009 /** 16010 * Path endpoint drawing style. 16011 * 16012 * @param { LineCapStyle } value 16013 * @returns { T } 16014 * @syscap SystemCapability.ArkUI.ArkUI.Full 16015 * @since 7 16016 */ 16017 /** 16018 * Path endpoint drawing style. 16019 * 16020 * @param { LineCapStyle } value 16021 * @returns { T } 16022 * @syscap SystemCapability.ArkUI.ArkUI.Full 16023 * @since 9 16024 * @form 16025 */ 16026 /** 16027 * Path endpoint drawing style. 16028 * 16029 * @param { LineCapStyle } value 16030 * @returns { T } 16031 * @syscap SystemCapability.ArkUI.ArkUI.Full 16032 * @crossplatform 16033 * @since 10 16034 * @form 16035 */ 16036 /** 16037 * Path endpoint drawing style. 16038 * 16039 * @param { LineCapStyle } value 16040 * @returns { T } 16041 * @syscap SystemCapability.ArkUI.ArkUI.Full 16042 * @crossplatform 16043 * @atomicservice 16044 * @since 11 16045 * @form 16046 */ 16047 strokeLineCap(value: LineCapStyle): T; 16048 16049 /** 16050 * Border corner drawing style. 16051 * 16052 * @param { LineJoinStyle } value 16053 * @returns { T } 16054 * @syscap SystemCapability.ArkUI.ArkUI.Full 16055 * @since 7 16056 */ 16057 /** 16058 * Border corner drawing style. 16059 * 16060 * @param { LineJoinStyle } value 16061 * @returns { T } 16062 * @syscap SystemCapability.ArkUI.ArkUI.Full 16063 * @since 9 16064 * @form 16065 */ 16066 /** 16067 * Border corner drawing style. 16068 * 16069 * @param { LineJoinStyle } value 16070 * @returns { T } 16071 * @syscap SystemCapability.ArkUI.ArkUI.Full 16072 * @crossplatform 16073 * @since 10 16074 * @form 16075 */ 16076 /** 16077 * Border corner drawing style. 16078 * 16079 * @param { LineJoinStyle } value 16080 * @returns { T } 16081 * @syscap SystemCapability.ArkUI.ArkUI.Full 16082 * @crossplatform 16083 * @atomicservice 16084 * @since 11 16085 * @form 16086 */ 16087 strokeLineJoin(value: LineJoinStyle): T; 16088 16089 /** 16090 * Limits for drawing acute angles as bevels 16091 * 16092 * @param { number | string } value 16093 * @returns { T } 16094 * @syscap SystemCapability.ArkUI.ArkUI.Full 16095 * @since 7 16096 */ 16097 /** 16098 * Limits for drawing acute angles as bevels 16099 * 16100 * @param { number | string } value 16101 * @returns { T } 16102 * @syscap SystemCapability.ArkUI.ArkUI.Full 16103 * @since 9 16104 * @form 16105 */ 16106 /** 16107 * Limits for drawing acute angles as bevels 16108 * 16109 * @param { number | string } value 16110 * @returns { T } 16111 * @syscap SystemCapability.ArkUI.ArkUI.Full 16112 * @crossplatform 16113 * @since 10 16114 * @form 16115 */ 16116 /** 16117 * Limits for drawing acute angles as bevels 16118 * 16119 * @param { number | string } value 16120 * @returns { T } 16121 * @syscap SystemCapability.ArkUI.ArkUI.Full 16122 * @crossplatform 16123 * @atomicservice 16124 * @since 11 16125 * @form 16126 */ 16127 strokeMiterLimit(value: number | string): T; 16128 16129 /** 16130 * Sets the opacity of the border. 16131 * 16132 * @param { number | string | Resource } value 16133 * @returns { T } 16134 * @syscap SystemCapability.ArkUI.ArkUI.Full 16135 * @since 7 16136 */ 16137 /** 16138 * Sets the opacity of the border. 16139 * 16140 * @param { number | string | Resource } value 16141 * @returns { T } 16142 * @syscap SystemCapability.ArkUI.ArkUI.Full 16143 * @since 9 16144 * @form 16145 */ 16146 /** 16147 * Sets the opacity of the border. 16148 * 16149 * @param { number | string | Resource } value 16150 * @returns { T } 16151 * @syscap SystemCapability.ArkUI.ArkUI.Full 16152 * @crossplatform 16153 * @since 10 16154 * @form 16155 */ 16156 /** 16157 * Sets the opacity of the border. 16158 * 16159 * @param { number | string | Resource } value 16160 * @returns { T } 16161 * @syscap SystemCapability.ArkUI.ArkUI.Full 16162 * @crossplatform 16163 * @atomicservice 16164 * @since 11 16165 * @form 16166 */ 16167 strokeOpacity(value: number | string | Resource): T; 16168 16169 /** 16170 * fill Opacity 16171 * 16172 * @param { number | string | Resource } value 16173 * @returns { T } 16174 * @syscap SystemCapability.ArkUI.ArkUI.Full 16175 * @since 7 16176 */ 16177 /** 16178 * fill Opacity 16179 * 16180 * @param { number | string | Resource } value 16181 * @returns { T } 16182 * @syscap SystemCapability.ArkUI.ArkUI.Full 16183 * @since 9 16184 * @form 16185 */ 16186 /** 16187 * fill Opacity 16188 * 16189 * @param { number | string | Resource } value 16190 * @returns { T } 16191 * @syscap SystemCapability.ArkUI.ArkUI.Full 16192 * @crossplatform 16193 * @since 10 16194 * @form 16195 */ 16196 /** 16197 * fill Opacity 16198 * 16199 * @param { number | string | Resource } value 16200 * @returns { T } 16201 * @syscap SystemCapability.ArkUI.ArkUI.Full 16202 * @crossplatform 16203 * @atomicservice 16204 * @since 11 16205 * @form 16206 */ 16207 fillOpacity(value: number | string | Resource): T; 16208 16209 /** 16210 * Sets the width of the dividing line. 16211 * 16212 * @param { Length } value 16213 * @returns { T } 16214 * @syscap SystemCapability.ArkUI.ArkUI.Full 16215 * @since 7 16216 */ 16217 /** 16218 * Sets the width of the dividing line. 16219 * 16220 * @param { Length } value 16221 * @returns { T } 16222 * @syscap SystemCapability.ArkUI.ArkUI.Full 16223 * @since 9 16224 * @form 16225 */ 16226 /** 16227 * Sets the width of the dividing line. 16228 * 16229 * @param { Length } value 16230 * @returns { T } 16231 * @syscap SystemCapability.ArkUI.ArkUI.Full 16232 * @crossplatform 16233 * @since 10 16234 * @form 16235 */ 16236 /** 16237 * Sets the width of the dividing line. 16238 * 16239 * @param { Length } value 16240 * @returns { T } 16241 * @syscap SystemCapability.ArkUI.ArkUI.Full 16242 * @crossplatform 16243 * @atomicservice 16244 * @since 11 16245 * @form 16246 */ 16247 strokeWidth(value: Length): T; 16248 16249 /** 16250 * Indicates whether to enable anti-aliasing 16251 * 16252 * @param { boolean } value 16253 * @returns { T } 16254 * @syscap SystemCapability.ArkUI.ArkUI.Full 16255 * @since 7 16256 */ 16257 /** 16258 * Indicates whether to enable anti-aliasing 16259 * 16260 * @param { boolean } value 16261 * @returns { T } 16262 * @syscap SystemCapability.ArkUI.ArkUI.Full 16263 * @since 9 16264 * @form 16265 */ 16266 /** 16267 * Indicates whether to enable anti-aliasing 16268 * 16269 * @param { boolean } value 16270 * @returns { T } 16271 * @syscap SystemCapability.ArkUI.ArkUI.Full 16272 * @crossplatform 16273 * @since 10 16274 * @form 16275 */ 16276 /** 16277 * Indicates whether to enable anti-aliasing 16278 * 16279 * @param { boolean } value 16280 * @returns { T } 16281 * @syscap SystemCapability.ArkUI.ArkUI.Full 16282 * @crossplatform 16283 * @atomicservice 16284 * @since 11 16285 * @form 16286 */ 16287 antiAlias(value: boolean): T; 16288 16289 /** 16290 * Sets the gap for the border. 16291 * 16292 * @param { Array<any> } value 16293 * @returns { T } 16294 * @syscap SystemCapability.ArkUI.ArkUI.Full 16295 * @since 7 16296 */ 16297 /** 16298 * Sets the gap for the border. 16299 * 16300 * @param { Array<any> } value 16301 * @returns { T } 16302 * @syscap SystemCapability.ArkUI.ArkUI.Full 16303 * @since 9 16304 * @form 16305 */ 16306 /** 16307 * Sets the gap for the border. 16308 * 16309 * @param { Array<any> } value 16310 * @returns { T } 16311 * @syscap SystemCapability.ArkUI.ArkUI.Full 16312 * @crossplatform 16313 * @since 10 16314 * @form 16315 */ 16316 /** 16317 * Sets the gap for the border. 16318 * 16319 * @param { Array<any> } value 16320 * @returns { T } 16321 * @syscap SystemCapability.ArkUI.ArkUI.Full 16322 * @crossplatform 16323 * @atomicservice 16324 * @since 11 16325 * @form 16326 */ 16327 strokeDashArray(value: Array<any>): T; 16328} 16329 16330/** 16331 * Linear Gradient Interface 16332 * 16333 * @interface LinearGradient 16334 * @syscap SystemCapability.ArkUI.ArkUI.Full 16335 * @since 9 16336 */ 16337/** 16338 * Linear Gradient Interface 16339 * 16340 * @interface LinearGradient 16341 * @syscap SystemCapability.ArkUI.ArkUI.Full 16342 * @crossplatform 16343 * @since 10 16344 */ 16345/** 16346 * Linear Gradient Interface 16347 * 16348 * @interface LinearGradient 16349 * @syscap SystemCapability.ArkUI.ArkUI.Full 16350 * @crossplatform 16351 * @atomicservice 16352 * @since 11 16353 */ 16354declare interface LinearGradient { 16355 /** 16356 * Linear Gradient Angle 16357 * 16358 * @type { ?(number | string) } 16359 * @syscap SystemCapability.ArkUI.ArkUI.Full 16360 * @since 9 16361 */ 16362 /** 16363 * Linear Gradient Angle 16364 * 16365 * @type { ?(number | string) } 16366 * @syscap SystemCapability.ArkUI.ArkUI.Full 16367 * @crossplatform 16368 * @since 10 16369 */ 16370 /** 16371 * Linear Gradient Angle 16372 * 16373 * @type { ?(number | string) } 16374 * @syscap SystemCapability.ArkUI.ArkUI.Full 16375 * @crossplatform 16376 * @atomicservice 16377 * @since 11 16378 */ 16379 angle?: number | string; 16380 /** 16381 * Linear Gradient Direction 16382 * 16383 * @type { ?GradientDirection } 16384 * @syscap SystemCapability.ArkUI.ArkUI.Full 16385 * @since 9 16386 */ 16387 /** 16388 * Linear Gradient Direction 16389 * 16390 * @type { ?GradientDirection } 16391 * @syscap SystemCapability.ArkUI.ArkUI.Full 16392 * @crossplatform 16393 * @since 10 16394 */ 16395 /** 16396 * Linear Gradient Direction 16397 * 16398 * @type { ?GradientDirection } 16399 * @syscap SystemCapability.ArkUI.ArkUI.Full 16400 * @crossplatform 16401 * @atomicservice 16402 * @since 11 16403 */ 16404 direction?: GradientDirection; 16405 /** 16406 * Linear Gradient Colors 16407 * 16408 * @type { Array<any> } 16409 * @syscap SystemCapability.ArkUI.ArkUI.Full 16410 * @since 9 16411 */ 16412 /** 16413 * Linear Gradient Colors 16414 * 16415 * @type { Array<any> } 16416 * @syscap SystemCapability.ArkUI.ArkUI.Full 16417 * @crossplatform 16418 * @since 10 16419 */ 16420 /** 16421 * Linear Gradient Colors 16422 * 16423 * @type { Array<any> } 16424 * @syscap SystemCapability.ArkUI.ArkUI.Full 16425 * @crossplatform 16426 * @atomicservice 16427 * @since 11 16428 */ 16429 colors: Array<any>; 16430 /** 16431 * Linear Gradient Repeating 16432 * 16433 * @type { ?boolean } 16434 * @syscap SystemCapability.ArkUI.ArkUI.Full 16435 * @since 9 16436 */ 16437 /** 16438 * Linear Gradient Repeating 16439 * 16440 * @type { ?boolean } 16441 * @syscap SystemCapability.ArkUI.ArkUI.Full 16442 * @crossplatform 16443 * @since 10 16444 */ 16445 /** 16446 * Linear Gradient Repeating 16447 * 16448 * @type { ?boolean } 16449 * @syscap SystemCapability.ArkUI.ArkUI.Full 16450 * @crossplatform 16451 * @atomicservice 16452 * @since 11 16453 */ 16454 repeating?: boolean; 16455} 16456 16457/** 16458 * Defines the pixel round property. 16459 * 16460 * @interface PixelRoundPolicy 16461 * @syscap SystemCapability.ArkUI.ArkUI.Full 16462 * @crossplatform 16463 * @atomicservice 16464 * @since 11 16465 * @form 16466 */ 16467declare interface PixelRoundPolicy { 16468 /** 16469 * start property. 16470 * 16471 * @type { ?PixelRoundCalcPolicy } 16472 * @default PixelRoundCalcPolicy.NO_FORCE_ROUND 16473 * @syscap SystemCapability.ArkUI.ArkUI.Full 16474 * @crossplatform 16475 * @atomicservice 16476 * @since 11 16477 * @form 16478 */ 16479 start?: PixelRoundCalcPolicy; 16480 16481 /** 16482 * top property. 16483 * 16484 * @type { ?PixelRoundCalcPolicy } 16485 * @default PixelRoundCalcPolicy.NO_FORCE_ROUND 16486 * @syscap SystemCapability.ArkUI.ArkUI.Full 16487 * @crossplatform 16488 * @atomicservice 16489 * @since 11 16490 * @form 16491 */ 16492 top?: PixelRoundCalcPolicy; 16493 16494 /** 16495 * end property. 16496 * 16497 * @type { ?PixelRoundCalcPolicy } 16498 * @default PixelRoundCalcPolicy.NO_FORCE_ROUND 16499 * @syscap SystemCapability.ArkUI.ArkUI.Full 16500 * @crossplatform 16501 * @atomicservice 16502 * @since 11 16503 * @form 16504 */ 16505 end?: PixelRoundCalcPolicy; 16506 16507 /** 16508 * bottom property. 16509 * 16510 * @type { ?PixelRoundCalcPolicy } 16511 * @default PixelRoundCalcPolicy.NO_FORCE_ROUND 16512 * @syscap SystemCapability.ArkUI.ArkUI.Full 16513 * @crossplatform 16514 * @atomicservice 16515 * @since 11 16516 * @form 16517 */ 16518 bottom?: PixelRoundCalcPolicy; 16519} 16520 16521/** 16522 * Linear Gradient Blur Interface 16523 * 16524 * @interface LinearGradientBlurOptions 16525 * @syscap SystemCapability.ArkUI.ArkUI.Full 16526 * @systemapi 16527 * @since 10 16528 */ 16529declare interface LinearGradientBlurOptions { 16530 /** 16531 * Percentage of blurring effect. 16532 * 16533 * @type { FractionStop[] } 16534 * @syscap SystemCapability.ArkUI.ArkUI.Full 16535 * @systemapi 16536 * @since 10 16537 */ 16538 fractionStops: FractionStop[]; 16539 /** 16540 * Direction of linear gradient blur. 16541 * 16542 * @type { GradientDirection } 16543 * @syscap SystemCapability.ArkUI.ArkUI.Full 16544 * @systemapi 16545 * @since 10 16546 */ 16547 direction: GradientDirection; 16548} 16549 16550/** 16551 * Sub component border info. 16552 * 16553 * @interface LayoutBorderInfo 16554 * @syscap SystemCapability.ArkUI.ArkUI.Full 16555 * @since 9 16556 * @deprecated since 10 16557 * @form 16558 */ 16559declare interface LayoutBorderInfo { 16560 /** 16561 * Sub component borderWidth info. 16562 * 16563 * @type { EdgeWidths } 16564 * @syscap SystemCapability.ArkUI.ArkUI.Full 16565 * @since 9 16566 * @deprecated since 10 16567 * @form 16568 */ 16569 borderWidth: EdgeWidths; 16570 16571 /** 16572 * Sub component margin info. 16573 * 16574 * @type { Margin } 16575 * @syscap SystemCapability.ArkUI.ArkUI.Full 16576 * @since 9 16577 * @deprecated since 10 16578 * @form 16579 */ 16580 margin: Margin, 16581 16582 /** 16583 * Sub component padding info. 16584 * 16585 * @type { Padding } 16586 * @syscap SystemCapability.ArkUI.ArkUI.Full 16587 * @since 9 16588 * @deprecated since 10 16589 * @form 16590 */ 16591 padding: Padding, 16592} 16593 16594/** 16595 * Sub component layout info. 16596 * 16597 * @interface LayoutInfo 16598 * @syscap SystemCapability.ArkUI.ArkUI.Full 16599 * @since 9 16600 * @deprecated since 10 16601 * @form 16602 */ 16603declare interface LayoutInfo { 16604 /** 16605 * Sub component position info. 16606 * 16607 * @type { Position } 16608 * @syscap SystemCapability.ArkUI.ArkUI.Full 16609 * @since 9 16610 * @deprecated since 10 16611 * @form 16612 */ 16613 position: Position, 16614 16615 /** 16616 * Sub component constraint info. 16617 * 16618 * @type { ConstraintSizeOptions } 16619 * @syscap SystemCapability.ArkUI.ArkUI.Full 16620 * @since 9 16621 * @deprecated since 10 16622 * @form 16623 */ 16624 constraint: ConstraintSizeOptions, 16625} 16626 16627/** 16628 * Sub component info passed from framework when layout and measure happens. 16629 * 16630 * @interface LayoutChild 16631 * @syscap SystemCapability.ArkUI.ArkUI.Full 16632 * @since 9 16633 * @deprecated since 10 16634 * @form 16635 */ 16636declare interface LayoutChild { 16637 /** 16638 * Sub component name. 16639 * 16640 * @type { string } 16641 * @syscap SystemCapability.ArkUI.ArkUI.Full 16642 * @since 9 16643 * @deprecated since 10 16644 * @form 16645 */ 16646 name: string, 16647 16648 /** 16649 * Sub component id. 16650 * 16651 * @type { string } 16652 * @syscap SystemCapability.ArkUI.ArkUI.Full 16653 * @since 9 16654 * @deprecated since 10 16655 * @form 16656 */ 16657 id: string, 16658 16659 /** 16660 * Sub component constraint. 16661 * 16662 * @type { ConstraintSizeOptions } 16663 * @syscap SystemCapability.ArkUI.ArkUI.Full 16664 * @since 9 16665 * @deprecated since 10 16666 * @form 16667 */ 16668 constraint: ConstraintSizeOptions, 16669 16670 /** 16671 * Sub component border info. 16672 * 16673 * @type { LayoutBorderInfo } 16674 * @syscap SystemCapability.ArkUI.ArkUI.Full 16675 * @since 9 16676 * @deprecated since 10 16677 * @form 16678 */ 16679 borderInfo: LayoutBorderInfo, 16680 16681 /** 16682 * Sub component position. 16683 * 16684 * @type { Position } 16685 * @syscap SystemCapability.ArkUI.ArkUI.Full 16686 * @since 9 16687 * @deprecated since 10 16688 * @form 16689 */ 16690 position: Position, 16691 16692 /** 16693 * Call this measure method in onMeasure callback to supply sub component size. 16694 * 16695 * @param { ConstraintSizeOptions } childConstraint 16696 * @syscap SystemCapability.ArkUI.ArkUI.Full 16697 * @since 9 16698 * @deprecated since 10 16699 * @form 16700 */ 16701 measure(childConstraint: ConstraintSizeOptions), 16702 16703 /** 16704 * Call this layout method in onLayout callback to assign layout info to sub component. 16705 * 16706 * @param { LayoutInfo } childLayoutInfo 16707 * @syscap SystemCapability.ArkUI.ArkUI.Full 16708 * @since 9 16709 * @deprecated since 10 16710 * @form 16711 */ 16712 layout(childLayoutInfo: LayoutInfo), 16713} 16714 16715/** 16716 * Sub component layout info. 16717 * 16718 * @interface GeometryInfo 16719 * @syscap SystemCapability.ArkUI.ArkUI.Full 16720 * @crossplatform 16721 * @since 10 16722 */ 16723/** 16724 * Sub component layout info. 16725 * 16726 * @interface GeometryInfo 16727 * @syscap SystemCapability.ArkUI.ArkUI.Full 16728 * @crossplatform 16729 * @atomicservice 16730 * @since 11 16731 */ 16732declare interface GeometryInfo extends SizeResult { 16733 /** 16734 * Sub component borderWidth info. 16735 * 16736 * @type { EdgeWidth } 16737 * @syscap SystemCapability.ArkUI.ArkUI.Full 16738 * @crossplatform 16739 * @since 10 16740 */ 16741 /** 16742 * Sub component borderWidth info. 16743 * 16744 * @type { EdgeWidth } 16745 * @syscap SystemCapability.ArkUI.ArkUI.Full 16746 * @crossplatform 16747 * @atomicservice 16748 * @since 11 16749 */ 16750 borderWidth: EdgeWidth; 16751 16752 /** 16753 * Sub component margin info. 16754 * 16755 * @type { Margin } 16756 * @syscap SystemCapability.ArkUI.ArkUI.Full 16757 * @crossplatform 16758 * @since 10 16759 */ 16760 /** 16761 * Sub component margin info. 16762 * 16763 * @type { Margin } 16764 * @syscap SystemCapability.ArkUI.ArkUI.Full 16765 * @crossplatform 16766 * @atomicservice 16767 * @since 11 16768 */ 16769 margin: Margin, 16770 16771 /** 16772 * Sub component padding info. 16773 * 16774 * @type { Padding } 16775 * @syscap SystemCapability.ArkUI.ArkUI.Full 16776 * @crossplatform 16777 * @since 10 16778 */ 16779 /** 16780 * Sub component padding info. 16781 * 16782 * @type { Padding } 16783 * @syscap SystemCapability.ArkUI.ArkUI.Full 16784 * @crossplatform 16785 * @atomicservice 16786 * @since 11 16787 */ 16788 padding: Padding, 16789} 16790 16791/** 16792 * Sub component info passed from framework when layout happens. 16793 * 16794 * @interface Layoutable 16795 * @syscap SystemCapability.ArkUI.ArkUI.Full 16796 * @crossplatform 16797 * @since 10 16798 */ 16799/** 16800 * Sub component info passed from framework when layout happens. 16801 * 16802 * @interface Layoutable 16803 * @syscap SystemCapability.ArkUI.ArkUI.Full 16804 * @crossplatform 16805 * @atomicservice 16806 * @since 11 16807 */ 16808declare interface Layoutable { 16809 /** 16810 * Measurement result of the child component. 16811 * 16812 * @type { MeasureResult } 16813 * @syscap SystemCapability.ArkUI.ArkUI.Full 16814 * @crossplatform 16815 * @since 10 16816 */ 16817 /** 16818 * Measurement result of the child component. 16819 * 16820 * @type { MeasureResult } 16821 * @syscap SystemCapability.ArkUI.ArkUI.Full 16822 * @crossplatform 16823 * @atomicservice 16824 * @since 11 16825 */ 16826 measureResult: MeasureResult, 16827 16828 /** 16829 * Call this layout method in onLayout callback to assign layout info to sub component. 16830 * 16831 * @param { Position } position 16832 * @syscap SystemCapability.ArkUI.ArkUI.Full 16833 * @crossplatform 16834 * @since 10 16835 */ 16836 /** 16837 * Call this layout method in onLayout callback to assign layout info to sub component. 16838 * 16839 * @param { Position } position 16840 * @syscap SystemCapability.ArkUI.ArkUI.Full 16841 * @crossplatform 16842 * @atomicservice 16843 * @since 11 16844 */ 16845 layout(position: Position): void, 16846} 16847 16848/** 16849 * Sub component info passed from framework when measure happens. 16850 * 16851 * @interface Measurable 16852 * @syscap SystemCapability.ArkUI.ArkUI.Full 16853 * @crossplatform 16854 * @since 10 16855 */ 16856/** 16857 * Sub component info passed from framework when measure happens. 16858 * 16859 * @interface Measurable 16860 * @syscap SystemCapability.ArkUI.ArkUI.Full 16861 * @crossplatform 16862 * @atomicservice 16863 * @since 11 16864 */ 16865declare interface Measurable { 16866 /** 16867 * Call this measure method in onMeasure callback to supply sub component size. 16868 * 16869 * @param { ConstraintSizeOptions } childConstraint 16870 * @returns { MeasureResult } 16871 * @syscap SystemCapability.ArkUI.ArkUI.Full 16872 * @crossplatform 16873 * @since 10 16874 */ 16875 /** 16876 * Call this measure method in onMeasure callback to supply sub component size. 16877 * 16878 * @param { ConstraintSizeOptions } childConstraint 16879 * @returns { MeasureResult } 16880 * @syscap SystemCapability.ArkUI.ArkUI.Full 16881 * @crossplatform 16882 * @atomicservice 16883 * @since 11 16884 */ 16885 measure(constraint: ConstraintSizeOptions) : MeasureResult, 16886} 16887 16888/** 16889 * Sub component SizeResult info. 16890 * 16891 * @interface SizeResult 16892 * @syscap SystemCapability.ArkUI.ArkUI.Full 16893 * @crossplatform 16894 * @since 10 16895 */ 16896/** 16897 * Sub component SizeResult info. 16898 * 16899 * @interface SizeResult 16900 * @syscap SystemCapability.ArkUI.ArkUI.Full 16901 * @crossplatform 16902 * @atomicservice 16903 * @since 11 16904 */ 16905declare interface SizeResult { 16906 /** 16907 * Width obtained from the measurement result. 16908 * 16909 * @type { number } 16910 * @syscap SystemCapability.ArkUI.ArkUI.Full 16911 * @crossplatform 16912 * @since 10 16913 */ 16914 /** 16915 * Width obtained from the measurement result. 16916 * 16917 * @type { number } 16918 * @syscap SystemCapability.ArkUI.ArkUI.Full 16919 * @crossplatform 16920 * @atomicservice 16921 * @since 11 16922 */ 16923 width: number, 16924 16925 /** 16926 * Height obtained from the measurement result. 16927 * 16928 * @type { number } 16929 * @syscap SystemCapability.ArkUI.ArkUI.Full 16930 * @crossplatform 16931 * @since 10 16932 */ 16933 /** 16934 * Height obtained from the measurement result. 16935 * 16936 * @type { number } 16937 * @syscap SystemCapability.ArkUI.ArkUI.Full 16938 * @crossplatform 16939 * @atomicservice 16940 * @since 11 16941 */ 16942 height: number, 16943} 16944 16945/** 16946 * Sub component MeasureResult info. 16947 * 16948 * @interface MeasureResult 16949 * @syscap SystemCapability.ArkUI.ArkUI.Full 16950 * @crossplatform 16951 * @since 10 16952 */ 16953/** 16954 * Sub component MeasureResult info. 16955 * 16956 * @interface MeasureResult 16957 * @syscap SystemCapability.ArkUI.ArkUI.Full 16958 * @crossplatform 16959 * @atomicservice 16960 * @since 11 16961 */ 16962declare interface MeasureResult extends SizeResult { 16963 16964} 16965 16966/** 16967 * The navigation destination information. 16968 * 16969 * @syscap SystemCapability.ArkUI.ArkUI.Full 16970 * @crossplatform 16971 * @since 11 16972 */ 16973declare type NavDestinationInfo = import('../api/@ohos.arkui.observer').default.NavDestinationInfo; 16974 16975/** 16976 * UIContext 16977 * 16978 * @syscap SystemCapability.ArkUI.ArkUI.Full 16979 * @crossplatform 16980 * @since 11 16981 */ 16982declare type UIContext = import('../api/@ohos.arkui.UIContext').UIContext; 16983 16984/** 16985 * Custom Component 16986 * 16987 * @extends CommonAttribute 16988 * @syscap SystemCapability.ArkUI.ArkUI.Full 16989 * @since 7 16990 */ 16991/** 16992 * Custom Component 16993 * 16994 * @extends CommonAttribute 16995 * @syscap SystemCapability.ArkUI.ArkUI.Full 16996 * @since 9 16997 * @form 16998 */ 16999/** 17000 * Custom Component 17001 * 17002 * @extends CommonAttribute 17003 * @syscap SystemCapability.ArkUI.ArkUI.Full 17004 * @crossplatform 17005 * @since 10 17006 * @form 17007 */ 17008/** 17009 * Custom Component 17010 * 17011 * @extends CommonAttribute 17012 * @syscap SystemCapability.ArkUI.ArkUI.Full 17013 * @crossplatform 17014 * @atomicservice 17015 * @since 11 17016 * @form 17017 */ 17018declare class CustomComponent extends CommonAttribute { 17019 /** 17020 * Customize the pop-up content constructor. 17021 * 17022 * @syscap SystemCapability.ArkUI.ArkUI.Full 17023 * @since 7 17024 */ 17025 /** 17026 * Customize the pop-up content constructor. 17027 * 17028 * @syscap SystemCapability.ArkUI.ArkUI.Full 17029 * @since 9 17030 * @form 17031 */ 17032 /** 17033 * Customize the pop-up content constructor. 17034 * 17035 * @syscap SystemCapability.ArkUI.ArkUI.Full 17036 * @crossplatform 17037 * @since 10 17038 * @form 17039 */ 17040 /** 17041 * Customize the pop-up content constructor. 17042 * 17043 * @syscap SystemCapability.ArkUI.ArkUI.Full 17044 * @crossplatform 17045 * @atomicservice 17046 * @since 11 17047 * @form 17048 */ 17049 build(): void; 17050 17051 /** 17052 * aboutToAppear Method 17053 * 17054 * @syscap SystemCapability.ArkUI.ArkUI.Full 17055 * @since 7 17056 */ 17057 /** 17058 * aboutToAppear Method 17059 * 17060 * @syscap SystemCapability.ArkUI.ArkUI.Full 17061 * @since 9 17062 * @form 17063 */ 17064 /** 17065 * aboutToAppear Method 17066 * 17067 * @syscap SystemCapability.ArkUI.ArkUI.Full 17068 * @crossplatform 17069 * @since 10 17070 * @form 17071 */ 17072 /** 17073 * aboutToAppear Method 17074 * 17075 * @syscap SystemCapability.ArkUI.ArkUI.Full 17076 * @crossplatform 17077 * @atomicservice 17078 * @since 11 17079 * @form 17080 */ 17081 aboutToAppear?(): void; 17082 17083 /** 17084 * aboutToDisappear Method 17085 * 17086 * @syscap SystemCapability.ArkUI.ArkUI.Full 17087 * @since 7 17088 */ 17089 /** 17090 * aboutToDisappear Method 17091 * 17092 * @syscap SystemCapability.ArkUI.ArkUI.Full 17093 * @since 9 17094 * @form 17095 */ 17096 /** 17097 * aboutToDisappear Method 17098 * 17099 * @syscap SystemCapability.ArkUI.ArkUI.Full 17100 * @crossplatform 17101 * @since 10 17102 * @form 17103 */ 17104 /** 17105 * aboutToDisappear Method 17106 * 17107 * @syscap SystemCapability.ArkUI.ArkUI.Full 17108 * @crossplatform 17109 * @atomicservice 17110 * @since 11 17111 * @form 17112 */ 17113 aboutToDisappear?(): void; 17114 17115 /** 17116 * aboutToReuse Method 17117 * 17118 * @param { object } params - Custom component init params. 17119 * @syscap SystemCapability.ArkUI.ArkUI.Full 17120 * @crossplatform 17121 * @since 10 17122 */ 17123 /** 17124 * aboutToReuse Method 17125 * 17126 * @param { object } params - Custom component init params. 17127 * @syscap SystemCapability.ArkUI.ArkUI.Full 17128 * @crossplatform 17129 * @atomicservice 17130 * @since 11 17131 */ 17132 aboutToReuse?(params: { [key: string]: unknown }): void; 17133 17134 /** 17135 * aboutToRecycle Method 17136 * 17137 * @syscap SystemCapability.ArkUI.ArkUI.Full 17138 * @crossplatform 17139 * @since 10 17140 */ 17141 /** 17142 * aboutToRecycle Method 17143 * 17144 * @syscap SystemCapability.ArkUI.ArkUI.Full 17145 * @crossplatform 17146 * @atomicservice 17147 * @since 11 17148 */ 17149 aboutToRecycle?(): void; 17150 17151 /** 17152 * Custom component override this method to layout each of its sub components. 17153 * 17154 * @param { Array<LayoutChild> } children 17155 * @param { ConstraintSizeOptions } constraint 17156 * @syscap SystemCapability.ArkUI.ArkUI.Full 17157 * @since 9 17158 * @deprecated since 10 17159 * @useinstead common[CustomComponent]#onPlaceChildren 17160 * @form 17161 */ 17162 onLayout?(children: Array<LayoutChild>, constraint: ConstraintSizeOptions): void; 17163 17164 /** 17165 * Custom component override this method to layout each of its sub components. 17166 * 17167 * @param { GeometryInfo } selfLayoutInfo 17168 * @param { Array<Layoutable> } children 17169 * @param { ConstraintSizeOptions } constraint 17170 * @syscap SystemCapability.ArkUI.ArkUI.Full 17171 * @crossplatform 17172 * @since 10 17173 */ 17174 /** 17175 * Custom component override this method to layout each of its sub components. 17176 * 17177 * @param { GeometryInfo } selfLayoutInfo 17178 * @param { Array<Layoutable> } children 17179 * @param { ConstraintSizeOptions } constraint 17180 * @syscap SystemCapability.ArkUI.ArkUI.Full 17181 * @crossplatform 17182 * @atomicservice 17183 * @since 11 17184 */ 17185 onPlaceChildren?(selfLayoutInfo: GeometryInfo, children: Array<Layoutable>, constraint: ConstraintSizeOptions): void; 17186 17187 /** 17188 * Custom component override this method to measure each of its sub components. 17189 * 17190 * @param { Array<LayoutChild> } children 17191 * @param { ConstraintSizeOptions } constraint 17192 * @syscap SystemCapability.ArkUI.ArkUI.Full 17193 * @since 9 17194 * @deprecated since 10 17195 * @useinstead common[CustomComponent]#onMeasureSize 17196 * @form 17197 */ 17198 onMeasure?(children: Array<LayoutChild>, constraint: ConstraintSizeOptions): void; 17199 17200 /** 17201 * Custom component override this method to measure each of its sub components. 17202 * @param { GeometryInfo } selfLayoutInfo 17203 * @param { Array<Measurable> } children - indicate the measure child 17204 * @param { ConstraintSizeOptions } constraint - indicate child constraint size 17205 * @returns { SizeResult } 17206 * @syscap SystemCapability.ArkUI.ArkUI.Full 17207 * @crossplatform 17208 * @since 10 17209 */ 17210 /** 17211 * Custom component override this method to measure each of its sub components. 17212 * @param { GeometryInfo } selfLayoutInfo 17213 * @param { Array<Measurable> } children - indicate the measure child 17214 * @param { ConstraintSizeOptions } constraint - indicate child constraint size 17215 * @returns { SizeResult } 17216 * @syscap SystemCapability.ArkUI.ArkUI.Full 17217 * @crossplatform 17218 * @atomicservice 17219 * @since 11 17220 */ 17221 onMeasureSize?(selfLayoutInfo: GeometryInfo, children: Array<Measurable>, constraint: ConstraintSizeOptions): SizeResult; 17222 17223 /** 17224 * onPageShow Method 17225 * 17226 * @syscap SystemCapability.ArkUI.ArkUI.Full 17227 * @since 7 17228 */ 17229 /** 17230 * onPageShow Method 17231 * 17232 * @syscap SystemCapability.ArkUI.ArkUI.Full 17233 * @crossplatform 17234 * @since 10 17235 */ 17236 /** 17237 * onPageShow Method 17238 * 17239 * @syscap SystemCapability.ArkUI.ArkUI.Full 17240 * @crossplatform 17241 * @atomicservice 17242 * @since 11 17243 */ 17244 onPageShow?(): void; 17245 17246 /** 17247 * onPageHide Method 17248 * 17249 * @syscap SystemCapability.ArkUI.ArkUI.Full 17250 * @since 7 17251 */ 17252 /** 17253 * onPageHide Method 17254 * 17255 * @syscap SystemCapability.ArkUI.ArkUI.Full 17256 * @crossplatform 17257 * @since 10 17258 */ 17259 /** 17260 * onPageHide Method 17261 * 17262 * @syscap SystemCapability.ArkUI.ArkUI.Full 17263 * @crossplatform 17264 * @atomicservice 17265 * @since 11 17266 */ 17267 onPageHide?(): void; 17268 17269 /** 17270 * onFormRecycle Method, this is only for ArkTS form, if form was marked recyclable by form user, when system memory is low, 17271 * it will be recycled after calling this method, you should return a string of params that you wish to be saved, it will be 17272 * passed back as params in onFormRecover, in which you can recover the form 17273 * 17274 * @returns { string } status data of ArkTS form UI, this data will be passed in when recover form later 17275 * @syscap SystemCapability.ArkUI.ArkUI.Full 17276 * @crossplatform 17277 * @since 11 17278 * @form 17279 */ 17280 onFormRecycle?(): string; 17281 17282 /** 17283 * onFormRecover Method, this is only for ArkTS form 17284 * 17285 * @param { string } statusData - indicate status data of ArkTS form UI, which is acquired by calling onFormRecycle, it is used to recover form 17286 * @syscap SystemCapability.ArkUI.ArkUI.Full 17287 * @crossplatform 17288 * @since 11 17289 * @form 17290 */ 17291 onFormRecover?(statusData: string): void; 17292 17293 /** 17294 * onBackPress Method 17295 * 17296 * @returns { void | boolean } 17297 * @syscap SystemCapability.ArkUI.ArkUI.Full 17298 * @since 7 17299 */ 17300 /** 17301 * onBackPress Method 17302 * 17303 * @returns { void | boolean } true means that the page itself processes the return logic. 17304 * false means that the default return logic is used. 17305 * If no value is returned, the default return logic is used. 17306 * @syscap SystemCapability.ArkUI.ArkUI.Full 17307 * @crossplatform 17308 * @since 10 17309 */ 17310 /** 17311 * onBackPress Method 17312 * 17313 * @returns { void | boolean } true means that the page itself processes the return logic. 17314 * false means that the default return logic is used. 17315 * If no value is returned, the default return logic is used. 17316 * @syscap SystemCapability.ArkUI.ArkUI.Full 17317 * @crossplatform 17318 * @atomicservice 17319 * @since 11 17320 */ 17321 onBackPress?(): void | boolean; 17322 17323 /** 17324 * PageTransition Method. 17325 * Implement Animation when enter this page or move to other pages. 17326 * 17327 * @syscap SystemCapability.ArkUI.ArkUI.Full 17328 * @since 9 17329 */ 17330 /** 17331 * PageTransition Method. 17332 * Implement Animation when enter this page or move to other pages. 17333 * 17334 * @syscap SystemCapability.ArkUI.ArkUI.Full 17335 * @crossplatform 17336 * @since 10 17337 */ 17338 /** 17339 * PageTransition Method. 17340 * Implement Animation when enter this page or move to other pages. 17341 * 17342 * @syscap SystemCapability.ArkUI.ArkUI.Full 17343 * @crossplatform 17344 * @atomicservice 17345 * @since 11 17346 */ 17347 pageTransition?(): void; 17348 17349 /** 17350 * Get current UIContext 17351 * 17352 * @returns { UIContext } The UIContext that the custom component belongs to. 17353 * @syscap SystemCapability.ArkUI.ArkUI.Full 17354 * @crossplatform 17355 * @since 11 17356 */ 17357 getUIContext(): UIContext; 17358 17359 /** 17360 * Queries the navigation destination information. 17361 * 17362 * @returns { NavDestinationInfo | undefined } The navigation destination information, or undefined if it is not available. 17363 * @syscap SystemCapability.ArkUI.ArkUI.Full 17364 * @crossplatform 17365 * @since 11 17366 */ 17367 queryNavDestinationInfo(): NavDestinationInfo | undefined; 17368} 17369 17370/** 17371 * View 17372 * 17373 * @syscap SystemCapability.ArkUI.ArkUI.Full 17374 * @systemapi 17375 * @since 7 17376 */ 17377/** 17378 * View 17379 * 17380 * @syscap SystemCapability.ArkUI.ArkUI.Full 17381 * @systemapi 17382 * @since 9 17383 * @form 17384 */ 17385declare class View { 17386 /** 17387 * Just use for generate tsbundle 17388 * 17389 * @param { any } value 17390 * @returns { any } 17391 * @syscap SystemCapability.ArkUI.ArkUI.Full 17392 * @systemapi 17393 * @since 7 17394 */ 17395 /** 17396 * Just use for generate tsbundle 17397 * 17398 * @param { any } value 17399 * @returns { any } 17400 * @syscap SystemCapability.ArkUI.ArkUI.Full 17401 * @systemapi 17402 * @since 9 17403 * @form 17404 */ 17405 create(value: any): any; 17406} 17407 17408/** 17409 * Rect info. 17410 * 17411 * @interface RectResult 17412 * @syscap SystemCapability.ArkUI.ArkUI.Full 17413 * @crossplatform 17414 * @since 10 17415 */ 17416/** 17417 * Rect info. 17418 * 17419 * @interface RectResult 17420 * @syscap SystemCapability.ArkUI.ArkUI.Full 17421 * @crossplatform 17422 * @atomicservice 17423 * @since 11 17424 */ 17425declare interface RectResult { 17426 /** 17427 * x:Horizontal coordinate relative to the component. 17428 * 17429 * @type { number } 17430 * @syscap SystemCapability.ArkUI.ArkUI.Full 17431 * @since 10 17432 */ 17433 /** 17434 * x:Horizontal coordinate relative to the component. 17435 * 17436 * @type { number } 17437 * @syscap SystemCapability.ArkUI.ArkUI.Full 17438 * @crossplatform 17439 * @atomicservice 17440 * @since 11 17441 */ 17442 x: number; 17443 17444 /** 17445 * y:Vertical axis coordinate relative to the component. 17446 * 17447 * @type { number } 17448 * @syscap SystemCapability.ArkUI.ArkUI.Full 17449 * @since 10 17450 */ 17451 /** 17452 * y:Vertical axis coordinate relative to the component. 17453 * 17454 * @type { number } 17455 * @syscap SystemCapability.ArkUI.ArkUI.Full 17456 * @crossplatform 17457 * @atomicservice 17458 * @since 11 17459 */ 17460 y: number; 17461 17462 /** 17463 * Get the width of the current textRect. 17464 * 17465 * @type { number } 17466 * @syscap SystemCapability.ArkUI.ArkUI.Full 17467 * @since 10 17468 */ 17469 /** 17470 * Get the width of the current textRect. 17471 * 17472 * @type { number } 17473 * @syscap SystemCapability.ArkUI.ArkUI.Full 17474 * @crossplatform 17475 * @atomicservice 17476 * @since 11 17477 */ 17478 width: number; 17479 17480 /** 17481 * Get the height of the current textRect. 17482 * 17483 * @type { number } 17484 * @syscap SystemCapability.ArkUI.ArkUI.Full 17485 * @since 10 17486 */ 17487 /** 17488 * Get the height of the current textRect. 17489 * 17490 * @type { number } 17491 * @syscap SystemCapability.ArkUI.ArkUI.Full 17492 * @crossplatform 17493 * @atomicservice 17494 * @since 11 17495 */ 17496 height: number; 17497} 17498 17499/** 17500 * CaretOffset info. 17501 * 17502 * @interface CaretOffset 17503 * @syscap SystemCapability.ArkUI.ArkUI.Full 17504 * @crossplatform 17505 * @since 11 17506 */ 17507declare interface CaretOffset { 17508 /** 17509 * Get the index of the CaretOffset 17510 * 17511 * @type { number } 17512 * @syscap SystemCapability.ArkUI.ArkUI.Full 17513 * @since 11 17514 */ 17515 index: number; 17516 17517 /** 17518 * Get the x of the relative position. 17519 * 17520 * @type { number } 17521 * @syscap SystemCapability.ArkUI.ArkUI.Full 17522 * @since 11 17523 */ 17524 x: number; 17525 17526 /** 17527 * Get the y of the relative position. 17528 * 17529 * @type { number } 17530 * @syscap SystemCapability.ArkUI.ArkUI.Full 17531 * @since 11 17532 */ 17533 y: number; 17534} 17535 17536/** 17537 * TextContentControllerBase 17538 * 17539 * @syscap SystemCapability.ArkUI.ArkUI.Full 17540 * @crossplatform 17541 * @since 10 17542 */ 17543/** 17544 * TextContentControllerBase 17545 * 17546 * @syscap SystemCapability.ArkUI.ArkUI.Full 17547 * @crossplatform 17548 * @atomicservice 17549 * @since 11 17550 */ 17551declare abstract class TextContentControllerBase { 17552 /** 17553 * Get the index and relative position of the CaretOffset. 17554 * 17555 * @returns { CaretOffset } index and relative position of the CaretOffset. 17556 * @syscap SystemCapability.ArkUI.ArkUI.Full 17557 * @crossplatform 17558 * @since 11 17559 */ 17560 getCaretOffset() : CaretOffset; 17561 17562 /** 17563 * Get the start and end positions of the text content. 17564 * 17565 * @returns { RectResult } Text content rect. 17566 * @syscap SystemCapability.ArkUI.ArkUI.Full 17567 * @crossplatform 17568 * @since 10 17569 */ 17570 /** 17571 * Get the start and end positions of the text content. 17572 * 17573 * @returns { RectResult } Text content rect. 17574 * @syscap SystemCapability.ArkUI.ArkUI.Full 17575 * @crossplatform 17576 * @atomicservice 17577 * @since 11 17578 */ 17579 getTextContentRect() : RectResult; 17580 17581 /** 17582 * Get the lines number of the text content. 17583 * 17584 * @returns { number } Text content line count 17585 * @syscap SystemCapability.ArkUI.ArkUI.Full 17586 * @crossplatform 17587 * @since 10 17588 */ 17589 /** 17590 * Get the lines number of the text content. 17591 * 17592 * @returns { number } Text content line count 17593 * @syscap SystemCapability.ArkUI.ArkUI.Full 17594 * @crossplatform 17595 * @atomicservice 17596 * @since 11 17597 */ 17598 getTextContentLineCount() : number; 17599} 17600 17601/** 17602 * CommonScrollableMethod 17603 * 17604 * @extends CommonMethod<T> 17605 * @syscap SystemCapability.ArkUI.ArkUI.Full 17606 * @crossplatform 17607 * @atomicservice 17608 * @since 11 17609 */ 17610declare class ScrollableCommonMethod<T> extends CommonMethod<T> { 17611 /** 17612 * Scrollbar status. 17613 * 17614 * @param { BarState } barState - Scrollbar status. 17615 * @returns { T } 17616 * @syscap SystemCapability.ArkUI.ArkUI.Full 17617 * @crossplatform 17618 * @atomicservice 17619 * @since 11 17620 */ 17621 scrollBar(barState: BarState): T; 17622 17623 /** 17624 * Color of the scrollbar. 17625 * 17626 * @param { Color | number | string } color - Color of the scrollbar. 17627 * @returns { T } 17628 * @syscap SystemCapability.ArkUI.ArkUI.Full 17629 * @crossplatform 17630 * @atomicservice 17631 * @since 11 17632 */ 17633 scrollBarColor(color: Color | number | string): T; 17634 17635 /** 17636 * Width of the scrollbar. 17637 * 17638 * @param { number | string } value - Width of the scrollbar. 17639 * @returns { T } 17640 * @syscap SystemCapability.ArkUI.ArkUI.Full 17641 * @crossplatform 17642 * @atomicservice 17643 * @since 11 17644 */ 17645 scrollBarWidth(value: number | string): T; 17646 17647 /** 17648 * Edge scrolling effect. 17649 * 17650 * @param { EdgeEffect } value - edge scrolling effect. 17651 * @param { EdgeEffectOptions } options - edge scrolling effect options. 17652 * @returns { T } 17653 * @syscap SystemCapability.ArkUI.ArkUI.Full 17654 * @crossplatform 17655 * @atomicservice 17656 * @since 11 17657 */ 17658 edgeEffect(edgeEffect: EdgeEffect, options?: EdgeEffectOptions): T; 17659 17660 /** 17661 * Nested scrolling options. 17662 * 17663 * @param { NestedScrollOptions } value - options for nested scrolling. 17664 * @returns { T } 17665 * @syscap SystemCapability.ArkUI.ArkUI.Full 17666 * @crossplatform 17667 * @atomicservice 17668 * @since 11 17669 */ 17670 nestedScroll(value: NestedScrollOptions): T; 17671 17672 /** 17673 * Whether to support scroll gestures by finger or mouse. 17674 * 17675 * @param { boolean } value - Whether to support scroll gestures by finger or mouse. 17676 * @returns { T } 17677 * @syscap SystemCapability.ArkUI.ArkUI.Full 17678 * @crossplatform 17679 * @atomicservice 17680 * @since 11 17681 */ 17682 enableScrollInteraction(value: boolean): T; 17683 17684 /** 17685 * Friction coefficient. 17686 * 17687 * @param { number | Resource } value - friction coefficient. 17688 * @returns { T } 17689 * @syscap SystemCapability.ArkUI.ArkUI.Full 17690 * @crossplatform 17691 * @atomicservice 17692 * @since 11 17693 */ 17694 friction(value: number | Resource): T; 17695 17696 /** 17697 * Called when the scrollable scrolls. 17698 * 17699 * @param { function } event - callback of scrollable, 17700 * scrollOffset is offset per frame scrolling, ScrollState is current scroll state. 17701 * @returns { T } 17702 * @syscap SystemCapability.ArkUI.ArkUI.Full 17703 * @crossplatform 17704 * @atomicservice 17705 * @since 11 17706 */ 17707 onScroll(event: (scrollOffset: number, scrollState: ScrollState) => void): T; 17708 17709 /** 17710 * Called when the scrollable reaches the start position. 17711 * 17712 * @param { function } event - Callback function, triggered when the scrollable reaches the start position. 17713 * @returns { T } 17714 * @syscap SystemCapability.ArkUI.ArkUI.Full 17715 * @crossplatform 17716 * @atomicservice 17717 * @since 11 17718 */ 17719 onReachStart(event: () => void): T; 17720 17721 /** 17722 * Called when the scrollable reaches the end position. 17723 * 17724 * @param { function } event - Callback function, triggered when the scrollable reaches the end position. 17725 * @returns { T } 17726 * @syscap SystemCapability.ArkUI.ArkUI.Full 17727 * @crossplatform 17728 * @atomicservice 17729 * @since 11 17730 */ 17731 onReachEnd(event: () => void): T; 17732 17733 /** 17734 * Called when the scrollable starts scrolling. 17735 * 17736 * @param { function } event - Callback function, triggered when the scrollable starts scrolling. 17737 * @returns { T } 17738 * @syscap SystemCapability.ArkUI.ArkUI.Full 17739 * @crossplatform 17740 * @atomicservice 17741 * @since 11 17742 */ 17743 onScrollStart(event: () => void): T; 17744 17745 /** 17746 * Called when the scrollable stops scrolling. 17747 * 17748 * @param { function } event - Callback function, triggered when the scrollable stops scrolling. 17749 * @returns { T } 17750 * @syscap SystemCapability.ArkUI.ArkUI.Full 17751 * @crossplatform 17752 * @atomicservice 17753 * @since 11 17754 */ 17755 onScrollStop(event: () => void): T; 17756 17757 /** 17758 * Limit the max speed when fling. 17759 * 17760 * @param { number } speedLimit - Max fling speed, the minimum value is 0, the maximum value is not limited. 17761 * The unit is vp/s. 17762 * @returns { T } 17763 * @syscap SystemCapability.ArkUI.ArkUI.Full 17764 * @crossplatform 17765 * @atomicservice 17766 * @since 11 17767 */ 17768 flingSpeedLimit(speedLimit: number): T; 17769} 17770 17771declare module "SpecialEvent" { 17772 module "SpecialEvent" { 17773 // @ts-ignore 17774 export { TouchObject, KeyEvent, MouseEvent }; 17775 } 17776} 17777 17778declare module "AnimateToParam" { 17779 module "AnimateToParam" { 17780 // @ts-ignore 17781 export type { AnimateParam, KeyframeAnimateParam, KeyframeState }; 17782 } 17783} 17784 17785declare module 'DragControllerParam' { 17786 module 'DragControllerParam' { 17787 // @ts-ignore 17788 export type { CustomBuilder, DragItemInfo, DragEvent, DragPreviewOptions }; 17789 } 17790} 17791 17792declare module 'ExpectedFrameRateRange' { 17793 module 'ExpectedFrameRateRange' { 17794 // @ts-ignore 17795 export type { ExpectedFrameRateRange }; 17796 } 17797} 17798 17799/** 17800 * Define EdgeEffect Options. 17801 * 17802 * @interface EdgeEffectOptions 17803 * @syscap SystemCapability.ArkUI.ArkUI.Full 17804 * @crossplatform 17805 * @since 11 17806 */ 17807declare interface EdgeEffectOptions { 17808 /** 17809 * Enable Sliding effect when component does not full screen. 17810 * 17811 * @type { boolean } 17812 * @syscap SystemCapability.ArkUI.ArkUI.Full 17813 * @crossplatform 17814 * @since 11 17815 */ 17816 alwaysEnabled: boolean; 17817} 17818 17819/** 17820 * Define BackgroundBrightness Options. 17821 * 17822 * @interface BackgroundBrightnessOptions 17823 * @syscap SystemCapability.ArkUI.ArkUI.Full 17824 * @systemapi 17825 * @since 11 17826 */ 17827declare interface BackgroundBrightnessOptions { 17828 17829 /** 17830 * Rate represents the rate at which lightUpDegree 17831 * decreases with increasing pixel brightness. 17832 * 17833 * @type { number } 17834 * @syscap SystemCapability.ArkUI.ArkUI.Full 17835 * @systemapi 17836 * @since 11 17837 */ 17838 rate: number; 17839 17840 /** 17841 * LightUpDegree represents the degree of brightness 17842 * of the rgb value changes when its brightness 17843 * is 0. 17844 * 17845 * @type { number } 17846 * @syscap SystemCapability.ArkUI.ArkUI.Full 17847 * @systemapi 17848 * @since 11 17849 */ 17850 lightUpDegree: number; 17851} 17852 17853/** 17854 * PointLightStyle info 17855 * 17856 * @interface PointLightStyle 17857 * @syscap SystemCapability.ArkUI.ArkUI.Full 17858 * @systemapi 17859 * @since 11 17860 */ 17861declare interface PointLightStyle { 17862 /** 17863 * Defines the PointLight light intensity and position. 17864 * 17865 * @type { ?LightSource } 17866 * @default undefined 17867 * @syscap SystemCapability.ArkUI.ArkUI.Full 17868 * @systemapi 17869 * @since 11 17870 */ 17871 lightSource?: LightSource; 17872 /** 17873 * Defines the PointLight illuminated type. 17874 * 17875 * @type { ?IlluminatedType } 17876 * @default IlluminatedType.NONE 17877 * @syscap SystemCapability.ArkUI.ArkUI.Full 17878 * @systemapi 17879 * @since 11 17880 */ 17881 illuminated?: IlluminatedType; 17882 /** 17883 * Defines the PointLight bloom. 17884 * 17885 * @type { ?number } 17886 * @default 0 17887 * @syscap SystemCapability.ArkUI.ArkUI.Full 17888 * @systemapi 17889 * @since 11 17890 */ 17891 bloom?: number; 17892} 17893 17894/** 17895 * LightSource info 17896 * 17897 * @interface LightSource 17898 * @syscap SystemCapability.ArkUI.ArkUI.Full 17899 * @systemapi 17900 * @since 11 17901 */ 17902declare interface LightSource { 17903 /** 17904 * Defines the PointLight light positionX. 17905 * 17906 * @type { Dimension } 17907 * @syscap SystemCapability.ArkUI.ArkUI.Full 17908 * @systemapi 17909 * @since 11 17910 */ 17911 positionX: Dimension; 17912 /** 17913 * Defines the PointLight light positionX. 17914 * 17915 * @type { Dimension } 17916 * @syscap SystemCapability.ArkUI.ArkUI.Full 17917 * @systemapi 17918 * @since 11 17919 */ 17920 positionY: Dimension; 17921 /** 17922 * Defines the PointLight light positionX. 17923 * 17924 * @type { Dimension } 17925 * @syscap SystemCapability.ArkUI.ArkUI.Full 17926 * @systemapi 17927 * @since 11 17928 */ 17929 positionZ: Dimension; 17930 /** 17931 * Defines the PointLight light intensity. 17932 * 17933 * @type { number } 17934 * @syscap SystemCapability.ArkUI.ArkUI.Full 17935 * @systemapi 17936 * @since 11 17937 */ 17938 intensity: number; 17939} 17940 17941/** 17942 * Defining wrapBuilder function. 17943 * @param { function } builder 17944 * @returns { WrappedBuilder<Args> } 17945 * @syscap SystemCapability.ArkUI.ArkUI.Full 17946 * @crossplatform 17947 * @since 11 17948 */ 17949declare function wrapBuilder<Args extends Object[]>(builder: (...args: Args) => void): WrappedBuilder<Args>; 17950 17951/** 17952 * Defines the WrappedBuilder class. 17953 * @syscap SystemCapability.ArkUI.ArkUI.Full 17954 * @crossplatform 17955 * @since 11 17956 */ 17957declare class WrappedBuilder<Args extends Object[]> { 17958 /** 17959 * @type { function } 17960 * @syscap SystemCapability.ArkUI.ArkUI.Full 17961 * @crossplatform 17962 * @since 11 17963 */ 17964 builder: (...args: Args) => void; 17965 17966 /** 17967 * @param { function } builder 17968 * @syscap SystemCapability.ArkUI.ArkUI.Full 17969 * @crossplatform 17970 * @since 11 17971 */ 17972 constructor(builder: (...args: Args) => void); 17973} 17974 17975declare module "wrappedBuilderObject" { 17976 module "wrappedBuilderObject" { 17977 // @ts-ignore 17978 export { WrappedBuilder }; 17979 } 17980} 17981 17982/** 17983 * Defines the overall animation parameters of the keyframe animation. 17984 * 17985 * @interface KeyframeAnimateParam 17986 * @syscap SystemCapability.ArkUI.ArkUI.Full 17987 * @crossplatform 17988 * @since 11 17989 */ 17990declare interface KeyframeAnimateParam { 17991 /** 17992 * Animation delay time, in ms. 17993 * 17994 * @type { ?number } 17995 * @syscap SystemCapability.ArkUI.ArkUI.Full 17996 * @crossplatform 17997 * @since 11 17998 */ 17999 delay?: number; 18000 18001 /** 18002 * Animation iterations. 18003 * 18004 * @type { ?number } 18005 * @syscap SystemCapability.ArkUI.ArkUI.Full 18006 * @crossplatform 18007 * @since 11 18008 */ 18009 iterations?: number; 18010 18011 /** 18012 * Callback invoked when the whole keyframe animation is complete. 18013 * 18014 * @type { ?function } 18015 * @syscap SystemCapability.ArkUI.ArkUI.Full 18016 * @crossplatform 18017 * @since 11 18018 */ 18019 onFinish?: () => void; 18020} 18021 18022/** 18023 * Defines a keyframe state. 18024 * 18025 * @interface KeyframeState 18026 * @syscap SystemCapability.ArkUI.ArkUI.Full 18027 * @crossplatform 18028 * @since 11 18029 */ 18030declare interface KeyframeState { 18031 /** 18032 * Animation duration of this keyframe, in ms. 18033 * 18034 * @type { number } 18035 * @syscap SystemCapability.ArkUI.ArkUI.Full 18036 * @crossplatform 18037 * @since 11 18038 */ 18039 duration: number; 18040 18041 /** 18042 * Animation curve of this keyframe. 18043 * 18044 * @type { ?(Curve | string | ICurve) } 18045 * @syscap SystemCapability.ArkUI.ArkUI.Full 18046 * @crossplatform 18047 * @since 11 18048 */ 18049 curve?: Curve | string | ICurve; 18050 18051 /** 18052 * The closure function to specify the terminating state of this keyframe. 18053 * 18054 * @type { function } 18055 * @syscap SystemCapability.ArkUI.ArkUI.Full 18056 * @crossplatform 18057 * @since 11 18058 */ 18059 event: () => void; 18060} 18061 18062declare module 'touchEvent'{ 18063 module 'touchEvent' { 18064 // @ts-ignore 18065 export { TouchEvent }; 18066 } 18067} 18068