1/* 2 * Copyright (c) 2021-2023 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16/** 17 * @file 18 * @kit ArkUI 19 */ 20 21/** 22 * Defines the options of Component ClassDecorator. 23 * 24 * @interface ComponentOptions 25 * @syscap SystemCapability.ArkUI.ArkUI.Full 26 * @crossplatform 27 * @form 28 * @since 11 29 */ 30/** 31 * Defines the options of Component ClassDecorator. 32 * 33 * @interface ComponentOptions 34 * @syscap SystemCapability.ArkUI.ArkUI.Full 35 * @crossplatform 36 * @form 37 * @atomicservice 38 * @since 12 39 */ 40declare interface ComponentOptions { 41 /** 42 * freeze UI state. 43 * 44 * @type { boolean } 45 * @default false 46 * @syscap SystemCapability.ArkUI.ArkUI.Full 47 * @crossplatform 48 * @form 49 * @since 11 50 */ 51 /** 52 * freeze UI state. 53 * 54 * @type { boolean } 55 * @default false 56 * @syscap SystemCapability.ArkUI.ArkUI.Full 57 * @crossplatform 58 * @form 59 * @atomicservice 60 * @since 12 61 */ 62 freezeWhenInactive : boolean, 63} 64 65/** 66 * Define the ratio of characters entered by the the percentage of InputCounterOptions. 67 * 68 * @interface InputCounterOptions 69 * @syscap SystemCapability.ArkUI.ArkUI.Full 70 * @crossplatform 71 * @since 11 72 */ 73/** 74 * Define the ratio of characters entered by the the percentage of InputCounterOptions. 75 * 76 * @interface InputCounterOptions 77 * @syscap SystemCapability.ArkUI.ArkUI.Full 78 * @crossplatform 79 * @atomicservice 80 * @since 12 81 */ 82declare interface InputCounterOptions { 83 /** 84 * It is the numerator bit of the percentage and used as a threshold. If the number of characters input 85 * reaches the maximum number of characters multiplied by this threshold, the counter is displayed. 86 * @type { ?number } 87 * @syscap SystemCapability.ArkUI.ArkUI.Full 88 * @crossplatform 89 * @since 11 90 */ 91 /** 92 * It is the numerator bit of the percentage and used as a threshold. If the number of characters input 93 * reaches the maximum number of characters multiplied by this threshold, the counter is displayed. 94 * @type { ?number } 95 * @syscap SystemCapability.ArkUI.ArkUI.Full 96 * @crossplatform 97 * @atomicservice 98 * @since 12 99 */ 100 thresholdPercentage?: number; 101 102 /** 103 * If the current input character count reaches the maximum character count and users want to exceed the 104 * normal input, the border will turn red. If this parameter is true, the red border displayed. 105 * @type { ?boolean } 106 * @default true 107 * @syscap SystemCapability.ArkUI.ArkUI.Full 108 * @crossplatform 109 * @since 11 110 */ 111 /** 112 * If the current input character count reaches the maximum character count and users want to exceed the 113 * normal input, the border will turn red. If this parameter is true, the red border displayed. 114 * @type { ?boolean } 115 * @default true 116 * @syscap SystemCapability.ArkUI.ArkUI.Full 117 * @crossplatform 118 * @atomicservice 119 * @since 12 120 */ 121 highlightBorder?: boolean; 122} 123 124/** 125 * Defines the options of decoration. 126 * 127 * @interface TextDecorationOptions 128 * @syscap SystemCapability.ArkUI.ArkUI.Full 129 * @crossplatform 130 * @atomicservice 131 * @since 12 132 */ 133declare interface TextDecorationOptions { 134 /** 135 * The decoration type. 136 * 137 * @type { TextDecorationType } 138 * @syscap SystemCapability.ArkUI.ArkUI.Full 139 * @crossplatform 140 * @atomicservice 141 * @since 12 142 */ 143 type: TextDecorationType; 144 145 /** 146 * Sets the color of decoration. 147 * 148 * @type { ?ResourceColor } 149 * @syscap SystemCapability.ArkUI.ArkUI.Full 150 * @crossplatform 151 * @atomicservice 152 * @since 12 153 */ 154 color?: ResourceColor; 155 156 /** 157 * The style value of decoration. 158 * 159 * @type { ?TextDecorationStyle } 160 * @syscap SystemCapability.ArkUI.ArkUI.Full 161 * @crossplatform 162 * @atomicservice 163 * @since 12 164 */ 165 style?: TextDecorationStyle; 166} 167 168/** 169 * Defining Component ClassDecorator 170 * 171 * @syscap SystemCapability.ArkUI.ArkUI.Full 172 * @since 7 173 */ 174/** 175 * Defining Component ClassDecorator 176 * 177 * @syscap SystemCapability.ArkUI.ArkUI.Full 178 * @form 179 * @since 9 180 */ 181/** 182 * Defining Component ClassDecorator 183 * 184 * @syscap SystemCapability.ArkUI.ArkUI.Full 185 * @crossplatform 186 * @form 187 * @since 10 188 */ 189/** 190 * Defining Component ClassDecorator 191 * 192 * Component is a ClassDecorator and it supports ComponentOptions as parameters. 193 * @syscap SystemCapability.ArkUI.ArkUI.Full 194 * @crossplatform 195 * @form 196 * @atomicservice 197 * @since 11 198 */ 199declare const Component: ClassDecorator & ((options: ComponentOptions) => ClassDecorator); 200 201/** 202 * Defining ComponentV2 ClassDecorator 203 * 204 * ComponentV2 is a ClassDecorator and it supports ComponentOptions as parameters. 205 * @syscap SystemCapability.ArkUI.ArkUI.Full 206 * @crossplatform 207 * @atomicservice 208 * @since 12 209 */ 210declare const ComponentV2: ClassDecorator & ((options: ComponentOptions) => ClassDecorator); 211 212/** 213 * Defines the options of Entry ClassDecorator. 214 * 215 * @interface EntryOptions 216 * @syscap SystemCapability.ArkUI.ArkUI.Full 217 * @form 218 * @since 10 219 */ 220/** 221 * Defines the options of Entry ClassDecorator. 222 * 223 * @interface EntryOptions 224 * @syscap SystemCapability.ArkUI.ArkUI.Full 225 * @form 226 * @atomicservice 227 * @since 11 228 */ 229declare interface EntryOptions { 230 /** 231 * Named route name. 232 * 233 * @type { ?string } 234 * @syscap SystemCapability.ArkUI.ArkUI.Full 235 * @form 236 * @since 10 237 */ 238 /** 239 * Named route name. 240 * 241 * @type { ?string } 242 * @syscap SystemCapability.ArkUI.ArkUI.Full 243 * @form 244 * @atomicservice 245 * @since 11 246 */ 247 routeName? : string, 248 249 /** 250 * LocalStorage to be passed. 251 * 252 * @type { ?LocalStorage } 253 * @syscap SystemCapability.ArkUI.ArkUI.Full 254 * @form 255 * @since 10 256 */ 257 /** 258 * LocalStorage to be passed. 259 * 260 * @type { ?LocalStorage } 261 * @syscap SystemCapability.ArkUI.ArkUI.Full 262 * @form 263 * @atomicservice 264 * @since 11 265 */ 266 storage? : LocalStorage, 267 268 /** 269 * Determines whether to use the LocalStorage instance object returned by the LocalStorage.getShared() interface. 270 * 271 * @type { ?boolean } 272 * @syscap SystemCapability.ArkUI.ArkUI.Full 273 * @crossplatform 274 * @form 275 * @atomicservice 276 * @since 12 277 */ 278 useSharedStorage? : boolean, 279} 280 281/** 282 * Defines Entry ClassDecorator. 283 * 284 * @syscap SystemCapability.ArkUI.ArkUI.Full 285 * @since 7 286 */ 287/** 288 * Defines Entry ClassDecorator. 289 * 290 * Entry is a ClassDecorator and it supports LocalStorage as parameters. 291 * @syscap SystemCapability.ArkUI.ArkUI.Full 292 * @form 293 * @since 9 294 */ 295/** 296 * Defines Entry ClassDecorator. 297 * 298 * Entry is a ClassDecorator and it supports LocalStorage or EntryOptions as parameters. 299 * @syscap SystemCapability.ArkUI.ArkUI.Full 300 * @crossplatform 301 * @form 302 * @since 10 303 */ 304/** 305 * Defines Entry ClassDecorator. 306 * 307 * Entry is a ClassDecorator and it supports LocalStorage or EntryOptions as parameters. 308 * @syscap SystemCapability.ArkUI.ArkUI.Full 309 * @crossplatform 310 * @form 311 * @atomicservice 312 * @since 11 313 */ 314declare const Entry: ClassDecorator & ((options?: LocalStorage | EntryOptions) => ClassDecorator); 315 316/** 317 * Defining Observed ClassDecorator. 318 * 319 * @syscap SystemCapability.ArkUI.ArkUI.Full 320 * @since 7 321 */ 322/** 323 * Defining Observed ClassDecorator. 324 * 325 * @syscap SystemCapability.ArkUI.ArkUI.Full 326 * @form 327 * @since 9 328 */ 329/** 330 * Defining Observed ClassDecorator. 331 * 332 * @syscap SystemCapability.ArkUI.ArkUI.Full 333 * @crossplatform 334 * @form 335 * @since 10 336 */ 337/** 338 * Defining Observed ClassDecorator. 339 * 340 * @syscap SystemCapability.ArkUI.ArkUI.Full 341 * @crossplatform 342 * @form 343 * @atomicservice 344 * @since 11 345 */ 346declare const Observed: ClassDecorator; 347 348/** 349 * Defining ObservedV2 ClassDecorator. 350 * 351 * @syscap SystemCapability.ArkUI.ArkUI.Full 352 * @crossplatform 353 * @form 354 * @atomicservice 355 * @since 12 356 */ 357declare const ObservedV2: ClassDecorator; 358 359/** 360 * Defining Preview ClassDecorator. 361 * 362 * @syscap SystemCapability.ArkUI.ArkUI.Full 363 * @since 7 364 */ 365/** 366 * Defining Preview ClassDecorator. 367 * 368 * @syscap SystemCapability.ArkUI.ArkUI.Full 369 * @form 370 * @since 9 371 */ 372/** 373 * Defining Preview ClassDecorator. 374 * 375 * @syscap SystemCapability.ArkUI.ArkUI.Full 376 * @crossplatform 377 * @form 378 * @since 10 379 */ 380/** 381 * Defining Preview ClassDecorator. 382 * 383 * @syscap SystemCapability.ArkUI.ArkUI.Full 384 * @crossplatform 385 * @form 386 * @atomicservice 387 * @since 11 388 */ 389declare const Preview: ClassDecorator & ((value: PreviewParams) => ClassDecorator); 390 391/** 392 * Defining Require PropertyDecorator. 393 * 394 * @syscap SystemCapability.ArkUI.ArkUI.Full 395 * @crossplatform 396 * @form 397 * @atomicservice 398 * @since 11 399 */ 400declare const Require: PropertyDecorator; 401 402/** 403 * Defining BuilderParam PropertyDecorator 404 * 405 * @syscap SystemCapability.ArkUI.ArkUI.Full 406 * @since 7 407 */ 408/** 409 * Defining BuilderParam PropertyDecorator 410 * 411 * @syscap SystemCapability.ArkUI.ArkUI.Full 412 * @form 413 * @since 9 414 */ 415/** 416 * Defining BuilderParam PropertyDecorator 417 * 418 * @syscap SystemCapability.ArkUI.ArkUI.Full 419 * @crossplatform 420 * @form 421 * @since 10 422 */ 423/** 424 * Defining BuilderParam PropertyDecorator 425 * 426 * @syscap SystemCapability.ArkUI.ArkUI.Full 427 * @crossplatform 428 * @form 429 * @atomicservice 430 * @since 11 431 */ 432declare const BuilderParam: PropertyDecorator; 433 434/** 435 * Defining Local PropertyDecorator. 436 * 437 * @syscap SystemCapability.ArkUI.ArkUI.Full 438 * @crossplatform 439 * @atomicservice 440 * @since 12 441 */ 442declare const Local: PropertyDecorator; 443 444/** 445 * Defining Param PropertyDecorator. 446 * 447 * @syscap SystemCapability.ArkUI.ArkUI.Full 448 * @crossplatform 449 * @atomicservice 450 * @since 12 451 */ 452declare const Param: PropertyDecorator; 453 454/** 455 * Defining Once PropertyDecorator. 456 * 457 * @syscap SystemCapability.ArkUI.ArkUI.Full 458 * @crossplatform 459 * @atomicservice 460 * @since 12 461 */ 462declare const Once: PropertyDecorator; 463 464/** 465 * Defining Event PropertyDecorator. 466 * 467 * @syscap SystemCapability.ArkUI.ArkUI.Full 468 * @crossplatform 469 * @atomicservice 470 * @since 12 471 */ 472declare const Event: PropertyDecorator; 473 474/** 475 * Defining State PropertyDecorator. 476 * 477 * @syscap SystemCapability.ArkUI.ArkUI.Full 478 * @since 7 479 */ 480/** 481 * Defining State PropertyDecorator. 482 * 483 * @syscap SystemCapability.ArkUI.ArkUI.Full 484 * @form 485 * @since 9 486 */ 487/** 488 * Defining State PropertyDecorator. 489 * 490 * @syscap SystemCapability.ArkUI.ArkUI.Full 491 * @crossplatform 492 * @form 493 * @since 10 494 */ 495/** 496 * Defining State PropertyDecorator. 497 * 498 * @syscap SystemCapability.ArkUI.ArkUI.Full 499 * @crossplatform 500 * @form 501 * @atomicservice 502 * @since 11 503 */ 504declare const State: PropertyDecorator; 505 506/** 507 * Defining Track PropertyDecorator. 508 * 509 * @syscap SystemCapability.ArkUI.ArkUI.Full 510 * @crossplatform 511 * @form 512 * @since 11 513 */ 514/** 515 * Defining Track PropertyDecorator. 516 * 517 * @syscap SystemCapability.ArkUI.ArkUI.Full 518 * @crossplatform 519 * @form 520 * @atomicservice 521 * @since 12 522 */ 523declare const Track: PropertyDecorator; 524 525/** 526 * Defining Trace PropertyDecorator. 527 * 528 * @syscap SystemCapability.ArkUI.ArkUI.Full 529 * @crossplatform 530 * @form 531 * @atomicservice 532 * @since 12 533 */ 534declare const Trace: PropertyDecorator; 535 536/** 537 * Defining Prop PropertyDecorator. 538 * 539 * @syscap SystemCapability.ArkUI.ArkUI.Full 540 * @since 7 541 */ 542/** 543 * Defining Prop PropertyDecorator. 544 * 545 * @syscap SystemCapability.ArkUI.ArkUI.Full 546 * @form 547 * @since 9 548 */ 549/** 550 * Defining Prop PropertyDecorator. 551 * 552 * @syscap SystemCapability.ArkUI.ArkUI.Full 553 * @crossplatform 554 * @form 555 * @since 10 556 */ 557/** 558 * Defining Prop PropertyDecorator. 559 * 560 * @syscap SystemCapability.ArkUI.ArkUI.Full 561 * @crossplatform 562 * @form 563 * @atomicservice 564 * @since 11 565 */ 566declare const Prop: PropertyDecorator; 567 568/** 569 * Defining Link PropertyDecorator. 570 * 571 * @syscap SystemCapability.ArkUI.ArkUI.Full 572 * @since 7 573 */ 574/** 575 * Defining Link PropertyDecorator. 576 * 577 * @syscap SystemCapability.ArkUI.ArkUI.Full 578 * @form 579 * @since 9 580 */ 581/** 582 * Defining Link PropertyDecorator. 583 * 584 * @syscap SystemCapability.ArkUI.ArkUI.Full 585 * @crossplatform 586 * @form 587 * @since 10 588 */ 589/** 590 * Defining Link PropertyDecorator. 591 * 592 * @syscap SystemCapability.ArkUI.ArkUI.Full 593 * @crossplatform 594 * @form 595 * @atomicservice 596 * @since 11 597 */ 598declare const Link: PropertyDecorator; 599 600/** 601 * Defining ObjectLink PropertyDecorator. 602 * 603 * @syscap SystemCapability.ArkUI.ArkUI.Full 604 * @since 7 605 */ 606/** 607 * Defining ObjectLink PropertyDecorator. 608 * 609 * @syscap SystemCapability.ArkUI.ArkUI.Full 610 * @form 611 * @since 9 612 */ 613/** 614 * Defining ObjectLink PropertyDecorator. 615 * 616 * @syscap SystemCapability.ArkUI.ArkUI.Full 617 * @crossplatform 618 * @form 619 * @since 10 620 */ 621/** 622 * Defining ObjectLink PropertyDecorator. 623 * 624 * @syscap SystemCapability.ArkUI.ArkUI.Full 625 * @crossplatform 626 * @form 627 * @atomicservice 628 * @since 11 629 */ 630declare const ObjectLink: PropertyDecorator; 631 632/** 633 * Defines the options of Provide PropertyDecorator. 634 * 635 * @interface ProvideOptions 636 * @syscap SystemCapability.ArkUI.ArkUI.Full 637 * @crossplatform 638 * @form 639 * @atomicservice 640 * @since 11 641 */ 642declare interface ProvideOptions { 643 /** 644 * Override the @Provide of any parent or parent of parent @Component.@Provide({allowOverride: "name"}) is 645 * also allowed to be used even when there is no ancestor @Component whose @Provide would be overridden. 646 * 647 * @type { ?string } 648 * @syscap SystemCapability.ArkUI.ArkUI.Full 649 * @crossplatform 650 * @form 651 * @atomicservice 652 * @since 11 653 */ 654 allowOverride?: string, 655} 656 657/** 658 * Defining Provide PropertyDecorator. 659 * 660 * @syscap SystemCapability.ArkUI.ArkUI.Full 661 * @since 7 662 */ 663/** 664 * Defining Provide PropertyDecorator. 665 * 666 * @syscap SystemCapability.ArkUI.ArkUI.Full 667 * @form 668 * @since 9 669 */ 670/** 671 * Defining Provide PropertyDecorator. 672 * 673 * @syscap SystemCapability.ArkUI.ArkUI.Full 674 * @crossplatform 675 * @form 676 * @since 10 677 */ 678/** 679 * Defining Provide PropertyDecorator. 680 * 681 * @syscap SystemCapability.ArkUI.ArkUI.Full 682 * @crossplatform 683 * @form 684 * @atomicservice 685 * @since 11 686 */ 687declare const Provide: PropertyDecorator & ((value: string | ProvideOptions) => PropertyDecorator); 688 689/** 690 * Defining Provider PropertyDecorator, aliasName is the only matching key and if aliasName is the default, the default attribute name is regarded as aliasName. 691 * @syscap SystemCapability.ArkUI.ArkUI.Full 692 * @crossplatform 693 * @atomicservice 694 * @since 12 695 */ 696declare const Provider: (aliasName?: string) => PropertyDecorator; 697 698/** 699 * Defining Consume PropertyDecorator. 700 * 701 * @syscap SystemCapability.ArkUI.ArkUI.Full 702 * @since 7 703 */ 704/** 705 * Defining Consume PropertyDecorator. 706 * 707 * @syscap SystemCapability.ArkUI.ArkUI.Full 708 * @form 709 * @since 9 710 */ 711/** 712 * Defining Consume PropertyDecorator. 713 * 714 * @syscap SystemCapability.ArkUI.ArkUI.Full 715 * @crossplatform 716 * @form 717 * @since 10 718 */ 719/** 720 * Defining Consume PropertyDecorator. 721 * 722 * @syscap SystemCapability.ArkUI.ArkUI.Full 723 * @crossplatform 724 * @form 725 * @atomicservice 726 * @since 11 727 */ 728declare const Consume: PropertyDecorator & ((value: string) => PropertyDecorator); 729 730/** 731* Defining Consumer PropertyDecorator, aliasName is the only matching key and if aliasName is the default, the default attribute name is regarded as aliasName. 732* And @Consumer will find the nearest @Provider. 733* @syscap SystemCapability.ArkUI.ArkUI.Full 734* @crossplatform 735* @atomicservice 736* @since 12 737*/ 738declare const Consumer: (aliasName?: string) => PropertyDecorator; 739 740/** 741* Defining Computed MethodDecorator. 742* 743* @syscap SystemCapability.ArkUI.ArkUI.Full 744* @crossplatform 745* @atomicservice 746* @since 12 747*/ 748declare const Computed: MethodDecorator; 749 750/** 751 * Defining StorageProp PropertyDecorator. 752 * 753 * @syscap SystemCapability.ArkUI.ArkUI.Full 754 * @since 7 755 */ 756/** 757 * Defining StorageProp PropertyDecorator. 758 * 759 * @syscap SystemCapability.ArkUI.ArkUI.Full 760 * @crossplatform 761 * @since 10 762 */ 763/** 764 * Defining StorageProp PropertyDecorator. 765 * 766 * @syscap SystemCapability.ArkUI.ArkUI.Full 767 * @crossplatform 768 * @atomicservice 769 * @since 11 770 */ 771declare const StorageProp: (value: string) => PropertyDecorator; 772 773/** 774 * Defining StorageLink PropertyDecorator. 775 * 776 * @syscap SystemCapability.ArkUI.ArkUI.Full 777 * @since 7 778 */ 779/** 780 * Defining StorageLink PropertyDecorator. 781 * 782 * @syscap SystemCapability.ArkUI.ArkUI.Full 783 * @crossplatform 784 * @since 10 785 */ 786/** 787 * Defining StorageLink PropertyDecorator. 788 * 789 * @syscap SystemCapability.ArkUI.ArkUI.Full 790 * @crossplatform 791 * @atomicservice 792 * @since 11 793 */ 794declare const StorageLink: (value: string) => PropertyDecorator; 795 796/** 797 * Defining Watch PropertyDecorator. 798 * 799 * @syscap SystemCapability.ArkUI.ArkUI.Full 800 * @since 7 801 */ 802/** 803 * Defining Watch PropertyDecorator. 804 * 805 * @syscap SystemCapability.ArkUI.ArkUI.Full 806 * @form 807 * @since 9 808 */ 809/** 810 * Defining Watch PropertyDecorator. 811 * 812 * @syscap SystemCapability.ArkUI.ArkUI.Full 813 * @crossplatform 814 * @form 815 * @since 10 816 */ 817/** 818 * Defining Watch PropertyDecorator. 819 * 820 * @syscap SystemCapability.ArkUI.ArkUI.Full 821 * @crossplatform 822 * @form 823 * @atomicservice 824 * @since 11 825 */ 826declare const Watch: (value: string) => PropertyDecorator; 827 828/** 829 * Defining Builder MethodDecorator 830 * 831 * @syscap SystemCapability.ArkUI.ArkUI.Full 832 * @since 7 833 */ 834/** 835 * Defining Builder MethodDecorator 836 * 837 * @syscap SystemCapability.ArkUI.ArkUI.Full 838 * @form 839 * @since 9 840 */ 841/** 842 * Defining Builder MethodDecorator 843 * 844 * @syscap SystemCapability.ArkUI.ArkUI.Full 845 * @crossplatform 846 * @form 847 * @since 10 848 */ 849/** 850 * Defining Builder MethodDecorator 851 * 852 * @syscap SystemCapability.ArkUI.ArkUI.Full 853 * @crossplatform 854 * @form 855 * @atomicservice 856 * @since 11 857 */ 858declare const Builder: MethodDecorator; 859 860/** 861 * Defining LocalBuilder MethodDecorator 862 * 863 * @syscap SystemCapability.ArkUI.ArkUI.Full 864 * @crossplatform 865 * @form 866 * @atomicservice 867 * @since 12 868 */ 869declare const LocalBuilder: MethodDecorator; 870 871/** 872 * Defining Styles MethodDecorator 873 * 874 * @syscap SystemCapability.ArkUI.ArkUI.Full 875 * @since 8 876 */ 877/** 878 * Defining Styles MethodDecorator 879 * 880 * @syscap SystemCapability.ArkUI.ArkUI.Full 881 * @form 882 * @since 9 883 */ 884/** 885 * Defining Styles MethodDecorator 886 * 887 * @syscap SystemCapability.ArkUI.ArkUI.Full 888 * @crossplatform 889 * @form 890 * @since 10 891 */ 892/** 893 * Defining Styles MethodDecorator 894 * 895 * @syscap SystemCapability.ArkUI.ArkUI.Full 896 * @crossplatform 897 * @form 898 * @atomicservice 899 * @since 11 900 */ 901declare const Styles: MethodDecorator; 902 903/** 904 * Defining Extend MethodDecorator 905 * 906 * @syscap SystemCapability.ArkUI.ArkUI.Full 907 * @since 7 908 */ 909/** 910 * Defining Extend MethodDecorator 911 * 912 * @syscap SystemCapability.ArkUI.ArkUI.Full 913 * @form 914 * @since 9 915 */ 916/** 917 * Defining Extend MethodDecorator 918 * 919 * @syscap SystemCapability.ArkUI.ArkUI.Full 920 * @crossplatform 921 * @form 922 * @since 10 923 */ 924/** 925 * Defining Extend MethodDecorator 926 * 927 * @syscap SystemCapability.ArkUI.ArkUI.Full 928 * @crossplatform 929 * @form 930 * @atomicservice 931 * @since 11 932 */ 933declare const Extend: MethodDecorator & ((value: any) => MethodDecorator); 934 935/** 936 * Define AnimatableExtend MethodDecorator 937 * 938 * @syscap SystemCapability.ArkUI.ArkUI.Full 939 * @crossplatform 940 * @since 10 941 */ 942/** 943 * Define AnimatableExtend MethodDecorator 944 * 945 * @syscap SystemCapability.ArkUI.ArkUI.Full 946 * @crossplatform 947 * @atomicservice 948 * @since 11 949 */ 950 declare const AnimatableExtend: MethodDecorator & ((value: Object) => MethodDecorator); 951 952/** 953 * Define Monitor MethodDecorator 954 * 955 * @syscap SystemCapability.ArkUI.ArkUI.Full 956 * @crossplatform 957 * @atomicservice 958 * @since 12 959 */ 960declare const Monitor: MonitorDecorator; 961 962/** 963 * Define Monitor Decorator type 964 * 965 * @typedef { function } MonitorDecorator 966 * @param { string } value - Monitored path input by the user 967 * @param { string[] } args - Monitored path(s) input by the user 968 * @returns { MethodDecorator } Monitor decorator 969 * @syscap SystemCapability.ArkUI.ArkUI.Full 970 * @crossplatform 971 * @atomicservice 972 * @since 12 973 */ 974declare type MonitorDecorator = (value: string, ...args: string[]) => MethodDecorator; 975 976/** 977 * Define IMonitor interface 978 * 979 * @interface IMonitor 980 * @syscap SystemCapability.ArkUI.ArkUI.Full 981 * @crossplatform 982 * @atomicservice 983 * @since 12 984 */ 985declare interface IMonitor { 986 /** 987 * Array of changed paths(keys) 988 * 989 * @type { Array<string> } 990 * @syscap SystemCapability.ArkUI.ArkUI.Full 991 * @crossplatform 992 * @atomicservice 993 * @since 12 994 */ 995 dirty: Array<string>; 996 997 /** 998 * Return the pair of the value before the most recent change and current value for given path. 999 * If path does not exist, return undefined; If path is not specified, return the value pair corresponding to the first path in dirty. 1000 * 1001 * @param { string } [path] 1002 * @returns { IMonitorValue<T> | undefined } 1003 * @syscap SystemCapability.ArkUI.ArkUI.Full 1004 * @crossplatform 1005 * @atomicservice 1006 * @since 12 1007 */ 1008 value<T>(path?: string): IMonitorValue<T> | undefined; 1009} 1010 1011/** 1012 * Define IMonitorValue interface 1013 * 1014 * @interface IMonitorValue<T> 1015 * @syscap SystemCapability.ArkUI.ArkUI.Full 1016 * @crossplatform 1017 * @atomicservice 1018 * @since 12 1019 */ 1020declare interface IMonitorValue<T> { 1021 /** 1022 * Get the previous value. 1023 * 1024 * @type { T } 1025 * @syscap SystemCapability.ArkUI.ArkUI.Full 1026 * @crossplatform 1027 * @atomicservice 1028 * @since 12 1029 */ 1030 before: T; 1031 1032 /** 1033 * Get current value. 1034 * 1035 * @type { T } 1036 * @syscap SystemCapability.ArkUI.ArkUI.Full 1037 * @crossplatform 1038 * @atomicservice 1039 * @since 12 1040 */ 1041 now: T; 1042 1043 /** 1044 * Monitored path input by the user. 1045 * 1046 * @type { string } 1047 * @syscap SystemCapability.ArkUI.ArkUI.Full 1048 * @crossplatform 1049 * @atomicservice 1050 * @since 12 1051 */ 1052 path: string; 1053} 1054 1055/** 1056 * Define AnimatableArithmetic interface 1057 * 1058 * @interface AnimatableArithmetic 1059 * @syscap SystemCapability.ArkUI.ArkUI.Full 1060 * @crossplatform 1061 * @since 10 1062 */ 1063/** 1064 * Define AnimatableArithmetic interface 1065 * 1066 * @interface AnimatableArithmetic 1067 * @syscap SystemCapability.ArkUI.ArkUI.Full 1068 * @crossplatform 1069 * @atomicservice 1070 * @since 11 1071 */ 1072 declare interface AnimatableArithmetic<T> { 1073 /** 1074 * Define plus method 1075 * 1076 * @param { AnimatableArithmetic<T> } rhs - another value 1077 * @returns { AnimatableArithmetic<T> } new value which implements AnimatableArithmetic<T> interface 1078 * @syscap SystemCapability.ArkUI.ArkUI.Full 1079 * @crossplatform 1080 * @since 10 1081 */ 1082 /** 1083 * Define plus method 1084 * 1085 * @param { AnimatableArithmetic<T> } rhs - another value 1086 * @returns { AnimatableArithmetic<T> } new value which implements AnimatableArithmetic<T> interface 1087 * @syscap SystemCapability.ArkUI.ArkUI.Full 1088 * @crossplatform 1089 * @atomicservice 1090 * @since 11 1091 */ 1092 plus(rhs: AnimatableArithmetic<T>): AnimatableArithmetic<T>; 1093 1094 /** 1095 * Define subtract method 1096 * 1097 * @param { AnimatableArithmetic<T> } rhs - another value 1098 * @returns { AnimatableArithmetic<T> } new value which implements AnimatableArithmetic<T> interface 1099 * @syscap SystemCapability.ArkUI.ArkUI.Full 1100 * @crossplatform 1101 * @since 10 1102 */ 1103 /** 1104 * Define subtract method 1105 * 1106 * @param { AnimatableArithmetic<T> } rhs - another value 1107 * @returns { AnimatableArithmetic<T> } new value which implements AnimatableArithmetic<T> interface 1108 * @syscap SystemCapability.ArkUI.ArkUI.Full 1109 * @crossplatform 1110 * @atomicservice 1111 * @since 11 1112 */ 1113 subtract(rhs: AnimatableArithmetic<T>): AnimatableArithmetic<T>; 1114 1115 /** 1116 * Define multiply method 1117 * 1118 * @param { number } scale - scale value 1119 * @returns { AnimatableArithmetic<T> } new value which implements AnimatableArithmetic<T> interface 1120 * @syscap SystemCapability.ArkUI.ArkUI.Full 1121 * @crossplatform 1122 * @since 10 1123 */ 1124 /** 1125 * Define multiply method 1126 * 1127 * @param { number } scale - scale value 1128 * @returns { AnimatableArithmetic<T> } new value which implements AnimatableArithmetic<T> interface 1129 * @syscap SystemCapability.ArkUI.ArkUI.Full 1130 * @crossplatform 1131 * @atomicservice 1132 * @since 11 1133 */ 1134 multiply(scale: number): AnimatableArithmetic<T>; 1135 1136 /** 1137 * Define equals method 1138 * 1139 * @param { AnimatableArithmetic<T> } rhs - another value 1140 * @returns { boolean } is equals 1141 * @syscap SystemCapability.ArkUI.ArkUI.Full 1142 * @crossplatform 1143 * @since 10 1144 */ 1145 /** 1146 * Define equals method 1147 * 1148 * @param { AnimatableArithmetic<T> } rhs - another value 1149 * @returns { boolean } is equals 1150 * @syscap SystemCapability.ArkUI.ArkUI.Full 1151 * @crossplatform 1152 * @atomicservice 1153 * @since 11 1154 */ 1155 equals(rhs: AnimatableArithmetic<T>): boolean; 1156} 1157 1158/** 1159 * Defining Concurrent MethodDecorator 1160 * 1161 * @syscap SystemCapability.ArkUI.ArkUI.Full 1162 * @since 9 1163 */ 1164/** 1165 * Defining Concurrent MethodDecorator 1166 * 1167 * @syscap SystemCapability.ArkUI.ArkUI.Full 1168 * @crossplatform 1169 * @since 10 1170 */ 1171/** 1172 * Defining Concurrent MethodDecorator 1173 * 1174 * @syscap SystemCapability.ArkUI.ArkUI.Full 1175 * @crossplatform 1176 * @atomicservice 1177 * @since 11 1178 */ 1179declare const Concurrent: MethodDecorator; 1180 1181/** 1182 * Defining Sendable ClassDecorator 1183 * 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. 1184 * Since 12, the Sendable decorator can be used for function and typeAlias also. 1185 * A function with this decorator is marked as sendable, and the function can be an shareable property of sendable-class object. 1186 * A typeAlias with this decorator is marked as sendable, and the typeAlias can be used to declare properties, variables, 1187 * and arguments that need to be assigned with sendable-function. 1188 * 1189 * @syscap SystemCapability.ArkUI.ArkUI.Full 1190 * @crossplatform 1191 * @atomicservice 1192 * @since 11 1193 */ 1194declare const Sendable: ClassDecorator; 1195 1196/** 1197 * Defining CustomDialog ClassDecorator 1198 * 1199 * @syscap SystemCapability.ArkUI.ArkUI.Full 1200 * @since 7 1201 */ 1202/** 1203 * Defining CustomDialog ClassDecorator 1204 * 1205 * @syscap SystemCapability.ArkUI.ArkUI.Full 1206 * @crossplatform 1207 * @since 10 1208 */ 1209/** 1210 * Defining CustomDialog ClassDecorator 1211 * 1212 * @syscap SystemCapability.ArkUI.ArkUI.Full 1213 * @crossplatform 1214 * @atomicservice 1215 * @since 11 1216 */ 1217declare const CustomDialog: ClassDecorator; 1218 1219/** 1220 * Defining LocalStorageLink PropertyDecorator. 1221 * 1222 * @syscap SystemCapability.ArkUI.ArkUI.Full 1223 * @since 9 1224 */ 1225/** 1226 * Defining LocalStorageLink PropertyDecorator. 1227 * 1228 * @syscap SystemCapability.ArkUI.ArkUI.Full 1229 * @crossplatform 1230 * @since 10 1231 */ 1232/** 1233 * Defining LocalStorageLink PropertyDecorator. 1234 * 1235 * @syscap SystemCapability.ArkUI.ArkUI.Full 1236 * @crossplatform 1237 * @atomicservice 1238 * @since 11 1239 */ 1240declare const LocalStorageLink: (value: string) => PropertyDecorator; 1241 1242/** 1243 * Defining LocalStorageProp PropertyDecorator 1244 * 1245 * @syscap SystemCapability.ArkUI.ArkUI.Full 1246 * @form 1247 * @since 9 1248 */ 1249/** 1250 * Defining LocalStorageProp PropertyDecorator 1251 * 1252 * @syscap SystemCapability.ArkUI.ArkUI.Full 1253 * @crossplatform 1254 * @form 1255 * @since 10 1256 */ 1257/** 1258 * Defining LocalStorageProp PropertyDecorator 1259 * 1260 * @syscap SystemCapability.ArkUI.ArkUI.Full 1261 * @crossplatform 1262 * @form 1263 * @atomicservice 1264 * @since 11 1265 */ 1266declare const LocalStorageProp: (value: string) => PropertyDecorator; 1267 1268/** 1269 * Obtains the Context object associated with a component on the page. 1270 * 1271 * @param { Object } component - indicate the component on the page. 1272 * @returns { Context } 1273 * @syscap SystemCapability.ArkUI.ArkUI.Full 1274 * @StageModelOnly 1275 * @since 9 1276 */ 1277/** 1278 * Obtains the Context object associated with a component on the page. 1279 * 1280 * @param { Object } component - indicate the component on the page. 1281 * @returns { Context } 1282 * @syscap SystemCapability.ArkUI.ArkUI.Full 1283 * @StageModelOnly 1284 * @crossplatform 1285 * @since 10 1286 */ 1287/** 1288 * Obtains the Context object associated with a component on the page. 1289 * 1290 * @param { Object } component - indicate the component on the page. 1291 * @returns { Context } 1292 * @syscap SystemCapability.ArkUI.ArkUI.Full 1293 * @StageModelOnly 1294 * @crossplatform 1295 * @atomicservice 1296 * @since 11 1297 */ 1298declare function getContext(component?: Object): Context; 1299 1300/** 1301 * Defining Reusable ClassDecorator. 1302 * 1303 * @syscap SystemCapability.ArkUI.ArkUI.Full 1304 * @crossplatform 1305 * @since 10 1306 */ 1307/** 1308 * Defining Reusable ClassDecorator. 1309 * 1310 * @syscap SystemCapability.ArkUI.ArkUI.Full 1311 * @crossplatform 1312 * @atomicservice 1313 * @since 11 1314 */ 1315declare const Reusable: ClassDecorator; 1316 1317/** 1318 * Get context. 1319 * 1320 * @typedef { import('../api/application/Context').default } Context 1321 * @syscap SystemCapability.ArkUI.ArkUI.Full 1322 * @StageModelOnly 1323 * @since 9 1324 */ 1325/** 1326 * Get context. 1327 * 1328 * @typedef { import('../api/application/Context').default } Context 1329 * @syscap SystemCapability.ArkUI.ArkUI.Full 1330 * @StageModelOnly 1331 * @crossplatform 1332 * @since 10 1333 */ 1334/** 1335 * Get context. 1336 * 1337 * @typedef { import('../api/application/Context').default } Context 1338 * @syscap SystemCapability.ArkUI.ArkUI.Full 1339 * @StageModelOnly 1340 * @crossplatform 1341 * @atomicservice 1342 * @since 11 1343 */ 1344declare type Context = import('../api/application/Context').default; 1345 1346/** 1347 * Post Card Action. 1348 * 1349 * @param { Object } component - indicate the card entry component. 1350 * @param { Object } action - indicate the router, message or call event. 1351 * @syscap SystemCapability.ArkUI.ArkUI.Full 1352 * @StageModelOnly 1353 * @form 1354 * @since 9 1355 */ 1356/** 1357 * Post Card Action. 1358 * 1359 * @param { Object } component - indicate the card entry component. 1360 * @param { Object } action - indicate the router, message or call event. 1361 * @syscap SystemCapability.ArkUI.ArkUI.Full 1362 * @StageModelOnly 1363 * @crossplatform 1364 * @form 1365 * @since 10 1366 */ 1367/** 1368 * Post Card Action. 1369 * 1370 * @param { Object } component - indicate the card entry component. 1371 * @param { Object } action - indicate the router, message or call event. 1372 * @syscap SystemCapability.ArkUI.ArkUI.Full 1373 * @StageModelOnly 1374 * @crossplatform 1375 * @form 1376 * @atomicservice 1377 * @since 11 1378 */ 1379declare function postCardAction(component: Object, action: Object): void; 1380 1381/** 1382 * Defines the data type of the interface restriction. 1383 * 1384 * @interface Configuration 1385 * @syscap SystemCapability.ArkUI.ArkUI.Full 1386 * @since 7 1387 */ 1388/** 1389 * Defines the data type of the interface restriction. 1390 * 1391 * @interface Configuration 1392 * @syscap SystemCapability.ArkUI.ArkUI.Full 1393 * @form 1394 * @since 9 1395 */ 1396/** 1397 * Defines the data type of the interface restriction. 1398 * 1399 * @interface Configuration 1400 * @syscap SystemCapability.ArkUI.ArkUI.Full 1401 * @crossplatform 1402 * @form 1403 * @since 10 1404 */ 1405/** 1406 * Defines the data type of the interface restriction. 1407 * 1408 * @interface Configuration 1409 * @syscap SystemCapability.ArkUI.ArkUI.Full 1410 * @crossplatform 1411 * @form 1412 * @atomicservice 1413 * @since 11 1414 */ 1415declare interface Configuration { 1416 /** 1417 * Set colorMode. 1418 * 1419 * @type { string } 1420 * @syscap SystemCapability.ArkUI.ArkUI.Full 1421 * @since 7 1422 */ 1423 /** 1424 * Set colorMode. 1425 * 1426 * @type { string } 1427 * @syscap SystemCapability.ArkUI.ArkUI.Full 1428 * @form 1429 * @since 9 1430 */ 1431 /** 1432 * Set colorMode. 1433 * 1434 * @type { string } 1435 * @syscap SystemCapability.ArkUI.ArkUI.Full 1436 * @crossplatform 1437 * @form 1438 * @since 10 1439 */ 1440 /** 1441 * Set colorMode. 1442 * 1443 * @type { string } 1444 * @syscap SystemCapability.ArkUI.ArkUI.Full 1445 * @crossplatform 1446 * @form 1447 * @atomicservice 1448 * @since 11 1449 */ 1450 readonly colorMode: string; 1451 1452 /** 1453 * Set fontScale. 1454 * 1455 * @type { number } 1456 * @syscap SystemCapability.ArkUI.ArkUI.Full 1457 * @since 7 1458 */ 1459 /** 1460 * Set fontScale. 1461 * 1462 * @type { number } 1463 * @syscap SystemCapability.ArkUI.ArkUI.Full 1464 * @form 1465 * @since 9 1466 */ 1467 /** 1468 * Set fontScale. 1469 * 1470 * @type { number } 1471 * @syscap SystemCapability.ArkUI.ArkUI.Full 1472 * @crossplatform 1473 * @form 1474 * @since 10 1475 */ 1476 /** 1477 * Set fontScale. 1478 * 1479 * @type { number } 1480 * @syscap SystemCapability.ArkUI.ArkUI.Full 1481 * @crossplatform 1482 * @form 1483 * @atomicservice 1484 * @since 11 1485 */ 1486 readonly fontScale: number; 1487} 1488 1489/** 1490 * Defines the data type of the interface restriction. 1491 * 1492 * @interface Rectangle 1493 * @syscap SystemCapability.ArkUI.ArkUI.Full 1494 * @since 8 1495 */ 1496/** 1497 * Defines the data type of the interface restriction. 1498 * 1499 * @interface Rectangle 1500 * @syscap SystemCapability.ArkUI.ArkUI.Full 1501 * @form 1502 * @since 9 1503 */ 1504/** 1505 * Defines the data type of the interface restriction. 1506 * 1507 * @interface Rectangle 1508 * @syscap SystemCapability.ArkUI.ArkUI.Full 1509 * @crossplatform 1510 * @form 1511 * @since 10 1512 */ 1513/** 1514 * Defines the data type of the interface restriction. 1515 * 1516 * @interface Rectangle 1517 * @syscap SystemCapability.ArkUI.ArkUI.Full 1518 * @crossplatform 1519 * @form 1520 * @atomicservice 1521 * @since 11 1522 */ 1523declare interface Rectangle { 1524 /** 1525 * x:Horizontal coordinate 1526 * 1527 * @type { ?Length } 1528 * @syscap SystemCapability.ArkUI.ArkUI.Full 1529 * @since 8 1530 */ 1531 /** 1532 * x:Horizontal coordinate 1533 * 1534 * @type { ?Length } 1535 * @syscap SystemCapability.ArkUI.ArkUI.Full 1536 * @form 1537 * @since 9 1538 */ 1539 /** 1540 * x:Horizontal coordinate 1541 * 1542 * @type { ?Length } 1543 * @syscap SystemCapability.ArkUI.ArkUI.Full 1544 * @crossplatform 1545 * @form 1546 * @since 10 1547 */ 1548 /** 1549 * x:Horizontal coordinate 1550 * 1551 * @type { ?Length } 1552 * @syscap SystemCapability.ArkUI.ArkUI.Full 1553 * @crossplatform 1554 * @form 1555 * @atomicservice 1556 * @since 11 1557 */ 1558 x?: Length; 1559 1560 /** 1561 * y:Vertical axis coordinate. 1562 * 1563 * @type { ?Length } 1564 * @syscap SystemCapability.ArkUI.ArkUI.Full 1565 * @since 8 1566 */ 1567 /** 1568 * y:Vertical axis coordinate. 1569 * 1570 * @type { ?Length } 1571 * @syscap SystemCapability.ArkUI.ArkUI.Full 1572 * @form 1573 * @since 9 1574 */ 1575 /** 1576 * y:Vertical axis coordinate. 1577 * 1578 * @type { ?Length } 1579 * @syscap SystemCapability.ArkUI.ArkUI.Full 1580 * @crossplatform 1581 * @form 1582 * @since 10 1583 */ 1584 /** 1585 * y:Vertical axis coordinate. 1586 * 1587 * @type { ?Length } 1588 * @syscap SystemCapability.ArkUI.ArkUI.Full 1589 * @crossplatform 1590 * @form 1591 * @atomicservice 1592 * @since 11 1593 */ 1594 y?: Length; 1595 1596 /** 1597 * Sets the width of the current touchRect. 1598 * 1599 * @type { ?Length } 1600 * @syscap SystemCapability.ArkUI.ArkUI.Full 1601 * @since 8 1602 */ 1603 /** 1604 * Sets the width of the current touchRect. 1605 * 1606 * @type { ?Length } 1607 * @syscap SystemCapability.ArkUI.ArkUI.Full 1608 * @form 1609 * @since 9 1610 */ 1611 /** 1612 * Sets the width of the current touchRect. 1613 * 1614 * @type { ?Length } 1615 * @syscap SystemCapability.ArkUI.ArkUI.Full 1616 * @crossplatform 1617 * @form 1618 * @since 10 1619 */ 1620 /** 1621 * Sets the width of the current touchRect. 1622 * 1623 * @type { ?Length } 1624 * @syscap SystemCapability.ArkUI.ArkUI.Full 1625 * @crossplatform 1626 * @form 1627 * @atomicservice 1628 * @since 11 1629 */ 1630 width?: Length; 1631 1632 /** 1633 * Sets the height of the current touchRect. 1634 * 1635 * @type { ?Length } 1636 * @syscap SystemCapability.ArkUI.ArkUI.Full 1637 * @since 8 1638 */ 1639 /** 1640 * Sets the height of the current touchRect. 1641 * 1642 * @type { ?Length } 1643 * @syscap SystemCapability.ArkUI.ArkUI.Full 1644 * @form 1645 * @since 9 1646 */ 1647 /** 1648 * Sets the height of the current touchRect. 1649 * 1650 * @type { ?Length } 1651 * @syscap SystemCapability.ArkUI.ArkUI.Full 1652 * @crossplatform 1653 * @form 1654 * @since 10 1655 */ 1656 /** 1657 * Sets the height of the current touchRect. 1658 * 1659 * @type { ?Length } 1660 * @syscap SystemCapability.ArkUI.ArkUI.Full 1661 * @crossplatform 1662 * @form 1663 * @atomicservice 1664 * @since 11 1665 */ 1666 height?: Length; 1667} 1668 1669/** 1670 * Interface for ExpectedFrameRateRange. 1671 * 1672 * @interface ExpectedFrameRateRange 1673 * @syscap SystemCapability.ArkUI.ArkUI.Full 1674 * @since 11 1675 */ 1676/** 1677 * Interface for ExpectedFrameRateRange. 1678 * 1679 * @interface ExpectedFrameRateRange 1680 * @syscap SystemCapability.ArkUI.ArkUI.Full 1681 * @atomicservice 1682 * @since 12 1683 */ 1684declare interface ExpectedFrameRateRange { 1685 /** 1686 * The minimum animation drawing FPS. 1687 * The minimum value should be less than or equal to the maximum value. 1688 * @type { number } 1689 * @syscap SystemCapability.ArkUI.ArkUI.Full 1690 * @since 11 1691 */ 1692 /** 1693 * The minimum animation drawing FPS. 1694 * The minimum value should be less than or equal to the maximum value. 1695 * @type { number } 1696 * @syscap SystemCapability.ArkUI.ArkUI.Full 1697 * @atomicservice 1698 * @since 12 1699 */ 1700 min: number, 1701 /** 1702 * The maximum animation drawing FPS. 1703 * The maximum value should be greater than or equal to the minimum value. 1704 * @type { number } 1705 * @syscap SystemCapability.ArkUI.ArkUI.Full 1706 * @since 11 1707 */ 1708 /** 1709 * The maximum animation drawing FPS. 1710 * The maximum value should be greater than or equal to the minimum value. 1711 * @type { number } 1712 * @syscap SystemCapability.ArkUI.ArkUI.Full 1713 * @atomicservice 1714 * @since 12 1715 */ 1716 max: number, 1717 /** 1718 * The expected frame rate of dynamical callback rate range. 1719 * The value should be between the minimum and maximum value. 1720 * Otherwise, the actual callback rate will be dynamically 1721 * adjusted to better align with other animation sources. 1722 * @type { number } 1723 * @syscap SystemCapability.ArkUI.ArkUI.Full 1724 * @since 11 1725 */ 1726 /** 1727 * The expected frame rate of dynamical callback rate range. 1728 * The value should be between the minimum and maximum value. 1729 * Otherwise, the actual callback rate will be dynamically 1730 * adjusted to better align with other animation sources. 1731 * @type { number } 1732 * @syscap SystemCapability.ArkUI.ArkUI.Full 1733 * @atomicservice 1734 * @since 12 1735 */ 1736 expected: number, 1737} 1738 1739/** 1740 * global $r function 1741 * 1742 * @param { string } value 1743 * @param { any[] } params 1744 * @returns { Resource } 1745 * @syscap SystemCapability.ArkUI.ArkUI.Full 1746 * @since 7 1747 */ 1748/** 1749 * global $r function 1750 * 1751 * @param { string } value 1752 * @param { any[] } params 1753 * @returns { Resource } 1754 * @syscap SystemCapability.ArkUI.ArkUI.Full 1755 * @form 1756 * @since 9 1757 */ 1758/** 1759 * global $r function 1760 * 1761 * @param { string } value 1762 * @param { any[] } params 1763 * @returns { Resource } 1764 * @syscap SystemCapability.ArkUI.ArkUI.Full 1765 * @crossplatform 1766 * @form 1767 * @since 10 1768 */ 1769/** 1770 * global $r function 1771 * 1772 * @param { string } value 1773 * @param { any[] } params 1774 * @returns { Resource } 1775 * @syscap SystemCapability.ArkUI.ArkUI.Full 1776 * @crossplatform 1777 * @form 1778 * @atomicservice 1779 * @since 11 1780 */ 1781declare function $r(value: string, ...params: any[]): Resource; 1782 1783/** 1784 * global $rawfile function 1785 * 1786 * @param { string } value 1787 * @returns { Resource } 1788 * @syscap SystemCapability.ArkUI.ArkUI.Full 1789 * @since 7 1790 */ 1791/** 1792 * global $rawfile function 1793 * 1794 * @param { string } value 1795 * @returns { Resource } 1796 * @syscap SystemCapability.ArkUI.ArkUI.Full 1797 * @form 1798 * @since 9 1799 */ 1800/** 1801 * global $rawfile function 1802 * 1803 * @param { string } value 1804 * @returns { Resource } 1805 * @syscap SystemCapability.ArkUI.ArkUI.Full 1806 * @crossplatform 1807 * @form 1808 * @since 10 1809 */ 1810/** 1811 * global $rawfile function 1812 * 1813 * @param { string } value 1814 * @returns { Resource } 1815 * @syscap SystemCapability.ArkUI.ArkUI.Full 1816 * @crossplatform 1817 * @form 1818 * @atomicservice 1819 * @since 11 1820 */ 1821declare function $rawfile(value: string): Resource; 1822 1823/** 1824 * Enum for FinishCallbackType. 1825 * 1826 * @enum { number } 1827 * @syscap SystemCapability.ArkUI.ArkUI.Full 1828 * @crossplatform 1829 * @form 1830 * @since 11 1831 */ 1832/** 1833 * Enum for FinishCallbackType. 1834 * 1835 * @enum { number } 1836 * @syscap SystemCapability.ArkUI.ArkUI.Full 1837 * @crossplatform 1838 * @form 1839 * @atomicservice 1840 * @since 12 1841 */ 1842declare enum FinishCallbackType { 1843 /** 1844 * When the entire animation ends and will be removed immediately, the callback is triggered. 1845 * 1846 * @syscap SystemCapability.ArkUI.ArkUI.Full 1847 * @crossplatform 1848 * @form 1849 * @since 11 1850 */ 1851 /** 1852 * When the entire animation ends and will be removed immediately, the callback is triggered. 1853 * 1854 * @syscap SystemCapability.ArkUI.ArkUI.Full 1855 * @crossplatform 1856 * @form 1857 * @atomicservice 1858 * @since 12 1859 */ 1860 REMOVED = 0, 1861 /** 1862 * When the animation is logically down but may still be in its long tail, the callback is triggered. 1863 * 1864 * @syscap SystemCapability.ArkUI.ArkUI.Full 1865 * @crossplatform 1866 * @form 1867 * @since 11 1868 */ 1869 /** 1870 * When the animation is logically down but may still be in its long tail, the callback is triggered. 1871 * 1872 * @syscap SystemCapability.ArkUI.ArkUI.Full 1873 * @crossplatform 1874 * @form 1875 * @atomicservice 1876 * @since 12 1877 */ 1878 LOGICALLY = 1, 1879} 1880 1881/** 1882 * Defines the touch test strategy object. 1883 * 1884 * @enum { number } 1885 * @syscap SystemCapability.ArkUI.ArkUI.Full 1886 * @crossplatform 1887 * @form 1888 * @since 11 1889 */ 1890/** 1891 * Defines the touch test strategy object. 1892 * 1893 * @enum { number } 1894 * @syscap SystemCapability.ArkUI.ArkUI.Full 1895 * @crossplatform 1896 * @form 1897 * @atomicservice 1898 * @since 12 1899 */ 1900declare enum TouchTestStrategy { 1901 /** 1902 * Do framework touch test. 1903 * 1904 * @syscap SystemCapability.ArkUI.ArkUI.Full 1905 * @crossplatform 1906 * @form 1907 * @since 11 1908 */ 1909 /** 1910 * Do framework touch test. 1911 * 1912 * @syscap SystemCapability.ArkUI.ArkUI.Full 1913 * @crossplatform 1914 * @form 1915 * @atomicservice 1916 * @since 12 1917 */ 1918 DEFAULT = 0, 1919 1920 /** 1921 * Specify the component to do touch test and follow the framework touch test 1922 * 1923 * @syscap SystemCapability.ArkUI.ArkUI.Full 1924 * @crossplatform 1925 * @form 1926 * @since 11 1927 */ 1928 /** 1929 * Specify the component to do touch test and follow the framework touch test 1930 * 1931 * @syscap SystemCapability.ArkUI.ArkUI.Full 1932 * @crossplatform 1933 * @form 1934 * @atomicservice 1935 * @since 12 1936 */ 1937 FORWARD_COMPETITION = 1, 1938 1939 /** 1940 * Specify the component to do touch test and not follow the framework touch test 1941 * 1942 * @syscap SystemCapability.ArkUI.ArkUI.Full 1943 * @crossplatform 1944 * @form 1945 * @since 11 1946 */ 1947 /** 1948 * Specify the component to do touch test and not follow the framework touch test 1949 * 1950 * @syscap SystemCapability.ArkUI.ArkUI.Full 1951 * @crossplatform 1952 * @form 1953 * @atomicservice 1954 * @since 12 1955 */ 1956 FORWARD = 2 1957} 1958 1959/** 1960 * Defines the animate function params. 1961 * 1962 * @interface AnimateParam 1963 * @syscap SystemCapability.ArkUI.ArkUI.Full 1964 * @since 7 1965 */ 1966/** 1967 * Defines the animate function params. 1968 * 1969 * @interface AnimateParam 1970 * @syscap SystemCapability.ArkUI.ArkUI.Full 1971 * @form 1972 * @since 9 1973 */ 1974/** 1975 * Defines the animate function params. 1976 * 1977 * @interface AnimateParam 1978 * @syscap SystemCapability.ArkUI.ArkUI.Full 1979 * @crossplatform 1980 * @form 1981 * @since 10 1982 */ 1983/** 1984 * Defines the animate function params. 1985 * 1986 * @interface AnimateParam 1987 * @syscap SystemCapability.ArkUI.ArkUI.Full 1988 * @crossplatform 1989 * @form 1990 * @atomicservice 1991 * @since 11 1992 */ 1993declare interface AnimateParam { 1994 /** 1995 * Animation duration, in ms. 1996 * 1997 * @type { ?number } 1998 * @default 1000 1999 * @syscap SystemCapability.ArkUI.ArkUI.Full 2000 * @since 7 2001 */ 2002 /** 2003 * Animation duration, in ms. 2004 * 2005 * @type { ?number } 2006 * @default 1000 2007 * @syscap SystemCapability.ArkUI.ArkUI.Full 2008 * @form 2009 * @since 9 2010 */ 2011 /** 2012 * Animation duration, in ms. 2013 * 2014 * @type { ?number } 2015 * @default 1000 2016 * @syscap SystemCapability.ArkUI.ArkUI.Full 2017 * @crossplatform 2018 * @form 2019 * @since 10 2020 */ 2021 /** 2022 * Animation duration, in ms. 2023 * 2024 * @type { ?number } 2025 * @default 1000 2026 * @syscap SystemCapability.ArkUI.ArkUI.Full 2027 * @crossplatform 2028 * @form 2029 * @atomicservice 2030 * @since 11 2031 */ 2032 duration?: number; 2033 /** 2034 * Animation playback speed. A larger value indicates faster animation playback, and a smaller value indicates slower 2035 * animation playback. The value 0 means that there is no animation. 2036 * 2037 * @type { ?number } 2038 * @default 1.0 2039 * @syscap SystemCapability.ArkUI.ArkUI.Full 2040 * @since 7 2041 */ 2042 /** 2043 * Animation playback speed. A larger value indicates faster animation playback, and a smaller value indicates slower 2044 * animation playback. The value 0 means that there is no animation. 2045 * 2046 * @type { ?number } 2047 * @default 1.0 2048 * @syscap SystemCapability.ArkUI.ArkUI.Full 2049 * @crossplatform 2050 * @since 10 2051 */ 2052 /** 2053 * Animation playback speed. A larger value indicates faster animation playback, and a smaller value indicates slower 2054 * animation playback. The value 0 means that there is no animation. 2055 * 2056 * @type { ?number } 2057 * @default 1.0 2058 * @syscap SystemCapability.ArkUI.ArkUI.Full 2059 * @crossplatform 2060 * @atomicservice 2061 * @since 11 2062 */ 2063 tempo?: number; 2064 /** 2065 * Animation curve. 2066 * 2067 * @type { ?(Curve | string) } 2068 * @default Curve.EaseInOut 2069 * @syscap SystemCapability.ArkUI.ArkUI.Full 2070 * @since 7 2071 */ 2072 /** 2073 * Animation curve. 2074 * 2075 * @type { ?(Curve | string | ICurve) } 2076 * @default Curve.EaseInOut 2077 * @syscap SystemCapability.ArkUI.ArkUI.Full 2078 * @form 2079 * @since 9 2080 */ 2081 /** 2082 * Animation curve. 2083 * 2084 * @type { ?(Curve | string | ICurve) } 2085 * @default Curve.EaseInOut 2086 * @syscap SystemCapability.ArkUI.ArkUI.Full 2087 * @crossplatform 2088 * @form 2089 * @since 10 2090 */ 2091 /** 2092 * Animation curve. 2093 * 2094 * @type { ?(Curve | string | ICurve) } 2095 * @default Curve.EaseInOut 2096 * @syscap SystemCapability.ArkUI.ArkUI.Full 2097 * @crossplatform 2098 * @form 2099 * @atomicservice 2100 * @since 11 2101 */ 2102 curve?: Curve | string | ICurve; 2103 2104 /** 2105 * Animation plays with delay,when set to a negative number, the animation plays in advance. 2106 * 2107 * @type { ?number } 2108 * @default 0 2109 * @syscap SystemCapability.ArkUI.ArkUI.Full 2110 * @since 7 2111 */ 2112 /** 2113 * Animation delay time, in ms. 2114 * 2115 * @type { ?number } 2116 * @default 0 2117 * @syscap SystemCapability.ArkUI.ArkUI.Full 2118 * @crossplatform 2119 * @since 10 2120 */ 2121 /** 2122 * Animation delay time, in ms. 2123 * 2124 * @type { ?number } 2125 * @default 0 2126 * @syscap SystemCapability.ArkUI.ArkUI.Full 2127 * @crossplatform 2128 * @atomicservice 2129 * @since 11 2130 */ 2131 delay?: number; 2132 2133 /** 2134 * Animation iterations. When set to -1, the animation playing it repeatedly. The value range is greater than or equal to -1. 2135 * 2136 * @type { ?number } 2137 * @default 1 2138 * @syscap SystemCapability.ArkUI.ArkUI.Full 2139 * @since 7 2140 */ 2141 /** 2142 * Animation iterations. When set to -1, the animation playing it repeatedly. The value range is greater than or equal to -1. 2143 * 2144 * @type { ?number } 2145 * @default 1 2146 * @syscap SystemCapability.ArkUI.ArkUI.Full 2147 * @crossplatform 2148 * @since 10 2149 */ 2150 /** 2151 * Animation iterations. When set to -1, the animation playing it repeatedly. The value range is greater than or equal to -1. 2152 * 2153 * @type { ?number } 2154 * @default 1 2155 * @syscap SystemCapability.ArkUI.ArkUI.Full 2156 * @crossplatform 2157 * @atomicservice 2158 * @since 11 2159 */ 2160 iterations?: number; 2161 2162 /** 2163 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 2164 * 2165 * @type { ?PlayMode } 2166 * @default PlayMode.Normal 2167 * @syscap SystemCapability.ArkUI.ArkUI.Full 2168 * @since 7 2169 */ 2170 /** 2171 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 2172 * 2173 * @type { ?PlayMode } 2174 * @default PlayMode.Normal 2175 * @syscap SystemCapability.ArkUI.ArkUI.Full 2176 * @form 2177 * @since 9 2178 */ 2179 /** 2180 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 2181 * 2182 * @type { ?PlayMode } 2183 * @default PlayMode.Normal 2184 * @syscap SystemCapability.ArkUI.ArkUI.Full 2185 * @crossplatform 2186 * @form 2187 * @since 10 2188 */ 2189 /** 2190 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 2191 * 2192 * @type { ?PlayMode } 2193 * @default PlayMode.Normal 2194 * @syscap SystemCapability.ArkUI.ArkUI.Full 2195 * @crossplatform 2196 * @form 2197 * @atomicservice 2198 * @since 11 2199 */ 2200 playMode?: PlayMode; 2201 2202 /** 2203 * Callback invoked when the animation playback is complete or the ability is about to enter the background. 2204 * 2205 * @type { ?function } 2206 * @syscap SystemCapability.ArkUI.ArkUI.Full 2207 * @since 7 2208 */ 2209 /** 2210 * Callback invoked when the animation playback is complete or the ability is about to enter the background. 2211 * 2212 * @type { ?function } 2213 * @syscap SystemCapability.ArkUI.ArkUI.Full 2214 * @form 2215 * @since 9 2216 */ 2217 /** 2218 * Callback invoked when the animation playback is complete or the ability is about to enter the background. 2219 * 2220 * @type { ?function } 2221 * @syscap SystemCapability.ArkUI.ArkUI.Full 2222 * @crossplatform 2223 * @form 2224 * @since 10 2225 */ 2226 /** 2227 * Callback invoked when the animation playback is complete or the ability is about to enter the background. 2228 * 2229 * @type { ?function } 2230 * @syscap SystemCapability.ArkUI.ArkUI.Full 2231 * @crossplatform 2232 * @form 2233 * @atomicservice 2234 * @since 11 2235 */ 2236 onFinish?: () => void; 2237 2238 /** 2239 * Define the type of onFinish callback in animation. 2240 * 2241 * @type { ?FinishCallbackType } 2242 * @syscap SystemCapability.ArkUI.ArkUI.Full 2243 * @crossplatform 2244 * @form 2245 * @since 11 2246 */ 2247 /** 2248 * Define the type of onFinish callback in animation. 2249 * 2250 * @type { ?FinishCallbackType } 2251 * @syscap SystemCapability.ArkUI.ArkUI.Full 2252 * @crossplatform 2253 * @form 2254 * @atomicservice 2255 * @since 12 2256 */ 2257 finishCallbackType?: FinishCallbackType; 2258 2259 /** 2260 * Indicates expectedFrameRateRange including minimum、maximum and expected frame rate. 2261 * 2262 * @type { ?ExpectedFrameRateRange } 2263 * @syscap SystemCapability.ArkUI.ArkUI.Full 2264 * @since 11 2265 */ 2266 /** 2267 * Indicates expectedFrameRateRange including minimum、maximum and expected frame rate. 2268 * 2269 * @type { ?ExpectedFrameRateRange } 2270 * @syscap SystemCapability.ArkUI.ArkUI.Full 2271 * @atomicservice 2272 * @since 12 2273 */ 2274 expectedFrameRateRange?: ExpectedFrameRateRange; 2275} 2276 2277/** 2278 * Interface for curve object. 2279 * 2280 * @interface ICurve 2281 * @syscap SystemCapability.ArkUI.ArkUI.Full 2282 * @form 2283 * @since 9 2284 */ 2285/** 2286 * Interface for curve object. 2287 * 2288 * @interface ICurve 2289 * @syscap SystemCapability.ArkUI.ArkUI.Full 2290 * @crossplatform 2291 * @form 2292 * @since 10 2293 */ 2294/** 2295 * Interface for curve object. 2296 * 2297 * @interface ICurve 2298 * @syscap SystemCapability.ArkUI.ArkUI.Full 2299 * @crossplatform 2300 * @form 2301 * @atomicservice 2302 * @since 11 2303 */ 2304interface ICurve { 2305 /** 2306 * Get curve value by fraction. 2307 * 2308 * @param { number } fraction - Indicates the current normalized time parameter. Value range: [0, 1]. 2309 * Note: If the value is less than 0, it will be processed as 0. If the value is greater than 1, 1 is used. 2310 * @returns { number } 2311 * @syscap SystemCapability.ArkUI.ArkUI.Full 2312 * @form 2313 * @since 9 2314 */ 2315 /** 2316 * Get curve value by fraction. 2317 * 2318 * @param { number } fraction - Indicates the current normalized time parameter. Value range: [0, 1]. 2319 * Note: If the value is less than 0, it will be processed as 0. If the value is greater than 1, 1 is used. 2320 * @returns { number } 2321 * @syscap SystemCapability.ArkUI.ArkUI.Full 2322 * @crossplatform 2323 * @form 2324 * @since 10 2325 */ 2326 /** 2327 * Get curve value by fraction. 2328 * 2329 * @param { number } fraction - Indicates the current normalized time parameter. Value range: [0, 1]. 2330 * Note: If the value is less than 0, it will be processed as 0. If the value is greater than 1, 1 is used. 2331 * @returns { number } 2332 * @syscap SystemCapability.ArkUI.ArkUI.Full 2333 * @crossplatform 2334 * @form 2335 * @atomicservice 2336 * @since 11 2337 */ 2338 interpolate(fraction: number): number; 2339} 2340 2341/** 2342 * Defines the motion path options. 2343 * 2344 * @interface MotionPathOptions 2345 * @syscap SystemCapability.ArkUI.ArkUI.Full 2346 * @since 7 2347 */ 2348/** 2349 * Defines the motion path options. 2350 * 2351 * @interface MotionPathOptions 2352 * @syscap SystemCapability.ArkUI.ArkUI.Full 2353 * @crossplatform 2354 * @since 10 2355 */ 2356/** 2357 * Defines the motion path options. 2358 * 2359 * @interface MotionPathOptions 2360 * @syscap SystemCapability.ArkUI.ArkUI.Full 2361 * @crossplatform 2362 * @atomicservice 2363 * @since 11 2364 */ 2365declare interface MotionPathOptions { 2366 /** 2367 * The path info. 2368 * 2369 * @type { string } 2370 * @syscap SystemCapability.ArkUI.ArkUI.Full 2371 * @since 7 2372 */ 2373 /** 2374 * The path info. 2375 * 2376 * @type { string } 2377 * @syscap SystemCapability.ArkUI.ArkUI.Full 2378 * @crossplatform 2379 * @since 10 2380 */ 2381 /** 2382 * The path info. 2383 * 2384 * @type { string } 2385 * @syscap SystemCapability.ArkUI.ArkUI.Full 2386 * @crossplatform 2387 * @atomicservice 2388 * @since 11 2389 */ 2390 path: string; 2391 2392 /** 2393 * The origin point info in range [0,1). 2394 * 2395 * @type { ?number } 2396 * @default 0.0 2397 * @syscap SystemCapability.ArkUI.ArkUI.Full 2398 * @since 7 2399 */ 2400 /** 2401 * The origin point info in range [0,1). 2402 * 2403 * @type { ?number } 2404 * @default 0.0 2405 * @syscap SystemCapability.ArkUI.ArkUI.Full 2406 * @crossplatform 2407 * @since 10 2408 */ 2409 /** 2410 * The origin point info in range [0,1). 2411 * 2412 * @type { ?number } 2413 * @default 0.0 2414 * @syscap SystemCapability.ArkUI.ArkUI.Full 2415 * @crossplatform 2416 * @atomicservice 2417 * @since 11 2418 */ 2419 from?: number; 2420 2421 /** 2422 * he distance point info in range (0,1]. 2423 * 2424 * @type { ?number } 2425 * @default 1.0 2426 * @syscap SystemCapability.ArkUI.ArkUI.Full 2427 * @since 7 2428 */ 2429 /** 2430 * he distance point info in range (0,1]. 2431 * 2432 * @type { ?number } 2433 * @default 1.0 2434 * @syscap SystemCapability.ArkUI.ArkUI.Full 2435 * @crossplatform 2436 * @since 10 2437 */ 2438 /** 2439 * The distance point info in range (0,1]. 2440 * 2441 * @type { ?number } 2442 * @default 1.0 2443 * @syscap SystemCapability.ArkUI.ArkUI.Full 2444 * @crossplatform 2445 * @atomicservice 2446 * @since 11 2447 */ 2448 to?: number; 2449 2450 /** 2451 * The rotate info. 2452 * 2453 * @type { ?boolean } 2454 * @default false 2455 * @syscap SystemCapability.ArkUI.ArkUI.Full 2456 * @since 7 2457 */ 2458 /** 2459 * The rotate info. 2460 * 2461 * @type { ?boolean } 2462 * @default false 2463 * @syscap SystemCapability.ArkUI.ArkUI.Full 2464 * @crossplatform 2465 * @since 10 2466 */ 2467 /** 2468 * The rotate info. 2469 * 2470 * @type { ?boolean } 2471 * @default false 2472 * @syscap SystemCapability.ArkUI.ArkUI.Full 2473 * @crossplatform 2474 * @atomicservice 2475 * @since 11 2476 */ 2477 rotatable?: boolean; 2478} 2479 2480/** 2481 * Defines the shard transition function params. 2482 * 2483 * @interface sharedTransitionOptions 2484 * @syscap SystemCapability.ArkUI.ArkUI.Full 2485 * @since 7 2486 */ 2487/** 2488 * Defines the shard transition function params. 2489 * 2490 * @interface sharedTransitionOptions 2491 * @syscap SystemCapability.ArkUI.ArkUI.Full 2492 * @crossplatform 2493 * @since 10 2494 */ 2495/** 2496 * Defines the shard transition function params. 2497 * 2498 * @interface sharedTransitionOptions 2499 * @syscap SystemCapability.ArkUI.ArkUI.Full 2500 * @crossplatform 2501 * @atomicservice 2502 * @since 11 2503 */ 2504declare interface sharedTransitionOptions { 2505 /** 2506 * Animation duration, in ms. 2507 * 2508 * @type { ?number } 2509 * @default 1000 2510 * @syscap SystemCapability.ArkUI.ArkUI.Full 2511 * @since 7 2512 */ 2513 /** 2514 * Animation duration, in ms. 2515 * 2516 * @type { ?number } 2517 * @default 1000 2518 * @syscap SystemCapability.ArkUI.ArkUI.Full 2519 * @crossplatform 2520 * @since 10 2521 */ 2522 /** 2523 * Animation duration, in ms. 2524 * 2525 * @type { ?number } 2526 * @default 1000 2527 * @syscap SystemCapability.ArkUI.ArkUI.Full 2528 * @crossplatform 2529 * @atomicservice 2530 * @since 11 2531 */ 2532 duration?: number; 2533 2534 /** 2535 * Animation duration, in ms. 2536 * 2537 * @type { ?(Curve | string | ICurve) } 2538 * @default 1000 2539 * @syscap SystemCapability.ArkUI.ArkUI.Full 2540 * @since 7 2541 */ 2542 /** 2543 * Animation curve. 2544 * 2545 * @type { ?(Curve | string | ICurve) } 2546 * @default 1000 2547 * @syscap SystemCapability.ArkUI.ArkUI.Full 2548 * @crossplatform 2549 * @since 10 2550 */ 2551 /** 2552 * Animation curve. 2553 * 2554 * @type { ?(Curve | string | ICurve) } 2555 * @default 1000 2556 * @syscap SystemCapability.ArkUI.ArkUI.Full 2557 * @crossplatform 2558 * @atomicservice 2559 * @since 11 2560 */ 2561 curve?: Curve | string | ICurve; 2562 2563 /** 2564 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 2565 * 2566 * @type { ?number } 2567 * @default 0 2568 * @syscap SystemCapability.ArkUI.ArkUI.Full 2569 * @since 7 2570 */ 2571 /** 2572 * Animation delay time, in ms. 2573 * 2574 * @type { ?number } 2575 * @default 0 2576 * @syscap SystemCapability.ArkUI.ArkUI.Full 2577 * @crossplatform 2578 * @since 10 2579 */ 2580 /** 2581 * Animation delay time, in ms. 2582 * 2583 * @type { ?number } 2584 * @default 0 2585 * @syscap SystemCapability.ArkUI.ArkUI.Full 2586 * @crossplatform 2587 * @atomicservice 2588 * @since 11 2589 */ 2590 delay?: number; 2591 2592 /** 2593 * The motion path info. 2594 * 2595 * @type { ?MotionPathOptions } 2596 * @syscap SystemCapability.ArkUI.ArkUI.Full 2597 * @since 7 2598 */ 2599 /** 2600 * The motion path info. 2601 * 2602 * @type { ?MotionPathOptions } 2603 * @syscap SystemCapability.ArkUI.ArkUI.Full 2604 * @crossplatform 2605 * @since 10 2606 */ 2607 /** 2608 * The motion path info. 2609 * 2610 * @type { ?MotionPathOptions } 2611 * @syscap SystemCapability.ArkUI.ArkUI.Full 2612 * @crossplatform 2613 * @atomicservice 2614 * @since 11 2615 */ 2616 motionPath?: MotionPathOptions; 2617 2618 /** 2619 * Z index info. 2620 * 2621 * @type { ?number } 2622 * @syscap SystemCapability.ArkUI.ArkUI.Full 2623 * @since 7 2624 */ 2625 /** 2626 * Z index info. 2627 * 2628 * @type { ?number } 2629 * @syscap SystemCapability.ArkUI.ArkUI.Full 2630 * @crossplatform 2631 * @since 10 2632 */ 2633 /** 2634 * Z index info. 2635 * 2636 * @type { ?number } 2637 * @syscap SystemCapability.ArkUI.ArkUI.Full 2638 * @crossplatform 2639 * @atomicservice 2640 * @since 11 2641 */ 2642 zIndex?: number; 2643 2644 /** 2645 * the animate type. 2646 * 2647 * @type { ?SharedTransitionEffectType } 2648 * @default SharedTransitionEffectType.Exchange 2649 * @syscap SystemCapability.ArkUI.ArkUI.Full 2650 * @since 7 2651 */ 2652 /** 2653 * the animate type. 2654 * 2655 * @type { ?SharedTransitionEffectType } 2656 * @default SharedTransitionEffectType.Exchange 2657 * @syscap SystemCapability.ArkUI.ArkUI.Full 2658 * @crossplatform 2659 * @since 10 2660 */ 2661 /** 2662 * the animate type. 2663 * 2664 * @type { ?SharedTransitionEffectType } 2665 * @default SharedTransitionEffectType.Exchange 2666 * @syscap SystemCapability.ArkUI.ArkUI.Full 2667 * @crossplatform 2668 * @atomicservice 2669 * @since 11 2670 */ 2671 type?: SharedTransitionEffectType; 2672} 2673 2674/** 2675 * Defines the options of geometry transition. 2676 * 2677 * @interface GeometryTransitionOptions 2678 * @syscap SystemCapability.ArkUI.ArkUI.Full 2679 * @crossplatform 2680 * @since 11 2681 */ 2682/** 2683 * Defines the options of geometry transition. 2684 * 2685 * @interface GeometryTransitionOptions 2686 * @syscap SystemCapability.ArkUI.ArkUI.Full 2687 * @crossplatform 2688 * @atomicservice 2689 * @since 12 2690 */ 2691declare interface GeometryTransitionOptions { 2692 /** 2693 * whether follow target for the component still in the hierarchy, default: false, stay current. 2694 * 2695 * @type { ?boolean } 2696 * @default false 2697 * @syscap SystemCapability.ArkUI.ArkUI.Full 2698 * @crossplatform 2699 * @since 11 2700 */ 2701 /** 2702 * whether follow target for the component still in the hierarchy, default: false, stay current. 2703 * 2704 * @type { ?boolean } 2705 * @default false 2706 * @syscap SystemCapability.ArkUI.ArkUI.Full 2707 * @crossplatform 2708 * @atomicservice 2709 * @since 12 2710 */ 2711 follow?: boolean; 2712 /** 2713 * Defines movement strategy of source and target in the hierarchy during geometry transition. 2714 * 2715 * @type { ?TransitionHierarchyStrategy } 2716 * @default TransitionHierarchyStrategy.ADAPTIVE 2717 * @syscap SystemCapability.ArkUI.ArkUI.Full 2718 * @systemapi 2719 * @atomicservice 2720 * @since 12 2721 */ 2722 /** 2723 * Defines movement strategy of source and target in the hierarchy during geometry transition. 2724 * 2725 * @type { ?TransitionHierarchyStrategy } 2726 * @default TransitionHierarchyStrategy.ADAPTIVE 2727 * @syscap SystemCapability.ArkUI.ArkUI.Full 2728 * @systemapi 2729 * @since 13 2730 */ 2731 hierarchyStrategy?: TransitionHierarchyStrategy 2732} 2733 2734/** 2735 * Source and target are two matched elements during the geometry transition. 2736 * The animation starts at the source and ends at the target. 2737 * TransitionHierarchyStrategy enumeration defines how levels of source and target elements 2738 * would be changed in the hierarchy during the geometry transition. 2739 * 2740 * @enum { number } 2741 * @syscap SystemCapability.ArkUI.ArkUI.Full 2742 * @systemapi 2743 * @atomicservice 2744 * @since 12 2745 */ 2746/** 2747 * Source and target are two matched elements during the geometry transition. 2748 * The animation starts at the source and ends at the target. 2749 * TransitionHierarchyStrategy enumeration defines how levels of source and target elements 2750 * would be changed in the hierarchy during the geometry transition. 2751 * 2752 * @enum { number } 2753 * @syscap SystemCapability.ArkUI.ArkUI.Full 2754 * @systemapi 2755 * @since 13 2756 */ 2757declare enum TransitionHierarchyStrategy { 2758 /** 2759 * None mode. 2760 * Source and target staty in the original level in the hierarchy during geometry transition. 2761 * 2762 * @syscap SystemCapability.ArkUI.ArkUI.Full 2763 * @systemapi 2764 * @atomicservice 2765 * @since 12 2766 */ 2767 /** 2768 * None mode. 2769 * Source and target staty in the original level in the hierarchy during geometry transition. 2770 * 2771 * @syscap SystemCapability.ArkUI.ArkUI.Full 2772 * @systemapi 2773 * @since 13 2774 */ 2775 NONE = 0, 2776 2777 /** 2778 * ADAPTIVE mode. 2779 * Lower level one of source and target is elevated to higher level of both, 2780 * indicating that two elements are in same high level. 2781 * 2782 * @syscap SystemCapability.ArkUI.ArkUI.Full 2783 * @systemapi 2784 * @atomicservice 2785 * @since 12 2786 */ 2787 /** 2788 * ADAPTIVE mode. 2789 * Lower level one of source and target is elevated to higher level of both, 2790 * indicating that two elements are in same high level. 2791 * 2792 * @syscap SystemCapability.ArkUI.ArkUI.Full 2793 * @systemapi 2794 * @since 13 2795 */ 2796 ADAPTIVE = 1, 2797} 2798 2799/** 2800 * Defines the options of translate. 2801 * 2802 * @interface TranslateOptions 2803 * @syscap SystemCapability.ArkUI.ArkUI.Full 2804 * @since 7 2805 */ 2806/** 2807 * Defines the options of translate. 2808 * 2809 * @interface TranslateOptions 2810 * @syscap SystemCapability.ArkUI.ArkUI.Full 2811 * @form 2812 * @since 9 2813 */ 2814/** 2815 * Defines the options of translate. 2816 * 2817 * @interface TranslateOptions 2818 * @syscap SystemCapability.ArkUI.ArkUI.Full 2819 * @crossplatform 2820 * @form 2821 * @since 10 2822 */ 2823/** 2824 * Defines the options of translate. 2825 * 2826 * @interface TranslateOptions 2827 * @syscap SystemCapability.ArkUI.ArkUI.Full 2828 * @crossplatform 2829 * @form 2830 * @atomicservice 2831 * @since 11 2832 */ 2833declare interface TranslateOptions { 2834 /** 2835 * The param of x direction. 2836 * 2837 * @type { ?(number | string) } 2838 * @syscap SystemCapability.ArkUI.ArkUI.Full 2839 * @since 7 2840 */ 2841 /** 2842 * The param of x direction. 2843 * 2844 * @type { ?(number | string) } 2845 * @syscap SystemCapability.ArkUI.ArkUI.Full 2846 * @form 2847 * @since 9 2848 */ 2849 /** 2850 * The param of x direction. 2851 * 2852 * @type { ?(number | string) } 2853 * @syscap SystemCapability.ArkUI.ArkUI.Full 2854 * @crossplatform 2855 * @form 2856 * @since 10 2857 */ 2858 /** 2859 * The param of x direction. 2860 * 2861 * @type { ?(number | string) } 2862 * @syscap SystemCapability.ArkUI.ArkUI.Full 2863 * @crossplatform 2864 * @form 2865 * @atomicservice 2866 * @since 11 2867 */ 2868 x?: number | string; 2869 2870 /** 2871 * The param of y direction. 2872 * 2873 * @type { ?(number | string) } 2874 * @syscap SystemCapability.ArkUI.ArkUI.Full 2875 * @since 7 2876 */ 2877 /** 2878 * The param of y direction. 2879 * 2880 * @type { ?(number | string) } 2881 * @syscap SystemCapability.ArkUI.ArkUI.Full 2882 * @form 2883 * @since 9 2884 */ 2885 /** 2886 * The param of y direction. 2887 * 2888 * @type { ?(number | string) } 2889 * @syscap SystemCapability.ArkUI.ArkUI.Full 2890 * @crossplatform 2891 * @form 2892 * @since 10 2893 */ 2894 /** 2895 * The param of y direction. 2896 * 2897 * @type { ?(number | string) } 2898 * @syscap SystemCapability.ArkUI.ArkUI.Full 2899 * @crossplatform 2900 * @form 2901 * @atomicservice 2902 * @since 11 2903 */ 2904 y?: number | string; 2905 2906 /** 2907 * The param of z direction. 2908 * 2909 * @type { ?(number | string) } 2910 * @syscap SystemCapability.ArkUI.ArkUI.Full 2911 * @since 7 2912 */ 2913 /** 2914 * The param of z direction. 2915 * 2916 * @type { ?(number | string) } 2917 * @syscap SystemCapability.ArkUI.ArkUI.Full 2918 * @form 2919 * @since 9 2920 */ 2921 /** 2922 * The param of z direction. 2923 * 2924 * @type { ?(number | string) } 2925 * @syscap SystemCapability.ArkUI.ArkUI.Full 2926 * @crossplatform 2927 * @form 2928 * @since 10 2929 */ 2930 /** 2931 * The param of z direction. 2932 * 2933 * @type { ?(number | string) } 2934 * @syscap SystemCapability.ArkUI.ArkUI.Full 2935 * @crossplatform 2936 * @form 2937 * @atomicservice 2938 * @since 11 2939 */ 2940 z?: number | string; 2941} 2942 2943/** 2944 * Defines the options of scale. 2945 * 2946 * @interface ScaleOptions 2947 * @syscap SystemCapability.ArkUI.ArkUI.Full 2948 * @since 7 2949 */ 2950/** 2951 * Defines the options of scale. 2952 * 2953 * @interface ScaleOptions 2954 * @syscap SystemCapability.ArkUI.ArkUI.Full 2955 * @form 2956 * @since 9 2957 */ 2958/** 2959 * Defines the options of scale. 2960 * 2961 * @interface ScaleOptions 2962 * @syscap SystemCapability.ArkUI.ArkUI.Full 2963 * @crossplatform 2964 * @form 2965 * @since 10 2966 */ 2967/** 2968 * Defines the options of scale. 2969 * 2970 * @interface ScaleOptions 2971 * @syscap SystemCapability.ArkUI.ArkUI.Full 2972 * @crossplatform 2973 * @form 2974 * @atomicservice 2975 * @since 11 2976 */ 2977declare interface ScaleOptions { 2978 /** 2979 * The param of x direction. 2980 * 2981 * @type { ?number } 2982 * @syscap SystemCapability.ArkUI.ArkUI.Full 2983 * @since 7 2984 */ 2985 /** 2986 * The param of x direction. 2987 * 2988 * @type { ?number } 2989 * @syscap SystemCapability.ArkUI.ArkUI.Full 2990 * @form 2991 * @since 9 2992 */ 2993 /** 2994 * The param of x direction. 2995 * 2996 * @type { ?number } 2997 * @syscap SystemCapability.ArkUI.ArkUI.Full 2998 * @crossplatform 2999 * @form 3000 * @since 10 3001 */ 3002 /** 3003 * The param of x direction. 3004 * 3005 * @type { ?number } 3006 * @syscap SystemCapability.ArkUI.ArkUI.Full 3007 * @crossplatform 3008 * @form 3009 * @atomicservice 3010 * @since 11 3011 */ 3012 x?: number; 3013 3014 /** 3015 * The param of y direction. 3016 * 3017 * @type { ?number } 3018 * @syscap SystemCapability.ArkUI.ArkUI.Full 3019 * @since 7 3020 */ 3021 /** 3022 * The param of y direction. 3023 * 3024 * @type { ?number } 3025 * @syscap SystemCapability.ArkUI.ArkUI.Full 3026 * @form 3027 * @since 9 3028 */ 3029 /** 3030 * The param of y direction. 3031 * 3032 * @type { ?number } 3033 * @syscap SystemCapability.ArkUI.ArkUI.Full 3034 * @crossplatform 3035 * @form 3036 * @since 10 3037 */ 3038 /** 3039 * The param of y direction. 3040 * 3041 * @type { ?number } 3042 * @syscap SystemCapability.ArkUI.ArkUI.Full 3043 * @crossplatform 3044 * @form 3045 * @atomicservice 3046 * @since 11 3047 */ 3048 y?: number; 3049 3050 /** 3051 * The param of z direction. 3052 * 3053 * @type { ?number } 3054 * @syscap SystemCapability.ArkUI.ArkUI.Full 3055 * @since 7 3056 */ 3057 /** 3058 * The param of z direction. 3059 * 3060 * @type { ?number } 3061 * @syscap SystemCapability.ArkUI.ArkUI.Full 3062 * @form 3063 * @since 9 3064 */ 3065 /** 3066 * The param of z direction. 3067 * 3068 * @type { ?number } 3069 * @syscap SystemCapability.ArkUI.ArkUI.Full 3070 * @crossplatform 3071 * @form 3072 * @since 10 3073 */ 3074 /** 3075 * The param of z direction. 3076 * 3077 * @type { ?number } 3078 * @syscap SystemCapability.ArkUI.ArkUI.Full 3079 * @crossplatform 3080 * @form 3081 * @atomicservice 3082 * @since 11 3083 */ 3084 z?: number; 3085 3086 /** 3087 * The param of center point of x. 3088 * 3089 * @type { ?(number | string) } 3090 * @syscap SystemCapability.ArkUI.ArkUI.Full 3091 * @since 7 3092 */ 3093 /** 3094 * The param of center point of x. 3095 * 3096 * @type { ?(number | string) } 3097 * @syscap SystemCapability.ArkUI.ArkUI.Full 3098 * @form 3099 * @since 9 3100 */ 3101 /** 3102 * The param of center point of x. 3103 * 3104 * @type { ?(number | string) } 3105 * @syscap SystemCapability.ArkUI.ArkUI.Full 3106 * @crossplatform 3107 * @form 3108 * @since 10 3109 */ 3110 /** 3111 * The param of center point of x. 3112 * 3113 * @type { ?(number | string) } 3114 * @syscap SystemCapability.ArkUI.ArkUI.Full 3115 * @crossplatform 3116 * @form 3117 * @atomicservice 3118 * @since 11 3119 */ 3120 centerX?: number | string; 3121 3122 /** 3123 * The param of center point of y. 3124 * 3125 * @type { ?(number | string) } 3126 * @syscap SystemCapability.ArkUI.ArkUI.Full 3127 * @since 7 3128 */ 3129 /** 3130 * The param of center point of y. 3131 * 3132 * @type { ?(number | string) } 3133 * @syscap SystemCapability.ArkUI.ArkUI.Full 3134 * @form 3135 * @since 9 3136 */ 3137 /** 3138 * The param of center point of y. 3139 * 3140 * @type { ?(number | string) } 3141 * @syscap SystemCapability.ArkUI.ArkUI.Full 3142 * @crossplatform 3143 * @form 3144 * @since 10 3145 */ 3146 /** 3147 * The param of center point of y. 3148 * 3149 * @type { ?(number | string) } 3150 * @syscap SystemCapability.ArkUI.ArkUI.Full 3151 * @crossplatform 3152 * @form 3153 * @atomicservice 3154 * @since 11 3155 */ 3156 centerY?: number | string; 3157} 3158 3159/** 3160 * Defines the align rule options of relative container. 3161 * 3162 * @interface AlignRuleOption 3163 * @syscap SystemCapability.ArkUI.ArkUI.Full 3164 * @form 3165 * @since 9 3166 */ 3167/** 3168 * Defines the align rule options of relative container. 3169 * 3170 * @interface AlignRuleOption 3171 * @syscap SystemCapability.ArkUI.ArkUI.Full 3172 * @crossplatform 3173 * @form 3174 * @since 10 3175 */ 3176/** 3177 * Defines the align rule options of relative container. 3178 * 3179 * @interface AlignRuleOption 3180 * @syscap SystemCapability.ArkUI.ArkUI.Full 3181 * @crossplatform 3182 * @form 3183 * @atomicservice 3184 * @since 11 3185 */ 3186declare interface AlignRuleOption { 3187 /** 3188 * The param of left align. 3189 * 3190 * @type { ?object } 3191 * @syscap SystemCapability.ArkUI.ArkUI.Full 3192 * @form 3193 * @since 9 3194 */ 3195 /** 3196 * The param of left align. 3197 * 3198 * @type { ?object } 3199 * @syscap SystemCapability.ArkUI.ArkUI.Full 3200 * @crossplatform 3201 * @form 3202 * @since 10 3203 */ 3204 /** 3205 * The param of left align. 3206 * 3207 * @type { ?object } 3208 * @syscap SystemCapability.ArkUI.ArkUI.Full 3209 * @crossplatform 3210 * @form 3211 * @atomicservice 3212 * @since 11 3213 */ 3214 left?: { anchor: string, align: HorizontalAlign }; 3215 3216 /** 3217 * The param of right align. 3218 * 3219 * @type { ?object } 3220 * @syscap SystemCapability.ArkUI.ArkUI.Full 3221 * @form 3222 * @since 9 3223 */ 3224 /** 3225 * The param of right align. 3226 * 3227 * @type { ?object } 3228 * @syscap SystemCapability.ArkUI.ArkUI.Full 3229 * @crossplatform 3230 * @form 3231 * @since 10 3232 */ 3233 /** 3234 * The param of right align. 3235 * 3236 * @type { ?object } 3237 * @syscap SystemCapability.ArkUI.ArkUI.Full 3238 * @crossplatform 3239 * @form 3240 * @atomicservice 3241 * @since 11 3242 */ 3243 right?: { anchor: string, align: HorizontalAlign }; 3244 3245 /** 3246 * The param of middle align. 3247 * 3248 * @type { ?object } 3249 * @syscap SystemCapability.ArkUI.ArkUI.Full 3250 * @form 3251 * @since 9 3252 */ 3253 /** 3254 * The param of middle align. 3255 * 3256 * @type { ?object } 3257 * @syscap SystemCapability.ArkUI.ArkUI.Full 3258 * @crossplatform 3259 * @form 3260 * @since 10 3261 */ 3262 /** 3263 * The param of middle align. 3264 * 3265 * @type { ?object } 3266 * @syscap SystemCapability.ArkUI.ArkUI.Full 3267 * @crossplatform 3268 * @form 3269 * @atomicservice 3270 * @since 11 3271 */ 3272 middle?: { anchor: string, align: HorizontalAlign }; 3273 3274 /** 3275 * The param of top align. 3276 * 3277 * @type { ?object } 3278 * @syscap SystemCapability.ArkUI.ArkUI.Full 3279 * @form 3280 * @since 9 3281 */ 3282 /** 3283 * The param of top align. 3284 * 3285 * @type { ?object } 3286 * @syscap SystemCapability.ArkUI.ArkUI.Full 3287 * @crossplatform 3288 * @form 3289 * @since 10 3290 */ 3291 /** 3292 * The param of top align. 3293 * 3294 * @type { ?object } 3295 * @syscap SystemCapability.ArkUI.ArkUI.Full 3296 * @crossplatform 3297 * @form 3298 * @atomicservice 3299 * @since 11 3300 */ 3301 top?: { anchor: string, align: VerticalAlign }; 3302 3303 /** 3304 * The param of bottom align. 3305 * 3306 * @type { ?object } 3307 * @syscap SystemCapability.ArkUI.ArkUI.Full 3308 * @form 3309 * @since 9 3310 */ 3311 /** 3312 * The param of bottom align. 3313 * 3314 * @type { ?object } 3315 * @syscap SystemCapability.ArkUI.ArkUI.Full 3316 * @form 3317 * @since 10 3318 */ 3319 /** 3320 * The param of bottom align. 3321 * 3322 * @type { ?object } 3323 * @syscap SystemCapability.ArkUI.ArkUI.Full 3324 * @form 3325 * @atomicservice 3326 * @since 11 3327 */ 3328 bottom?: { anchor: string, align: VerticalAlign }; 3329 3330 /** 3331 * The param of center align. 3332 * 3333 * @type { ?object } 3334 * @syscap SystemCapability.ArkUI.ArkUI.Full 3335 * @form 3336 * @since 9 3337 */ 3338 /** 3339 * The param of center align. 3340 * 3341 * @type { ?object } 3342 * @syscap SystemCapability.ArkUI.ArkUI.Full 3343 * @crossplatform 3344 * @form 3345 * @since 10 3346 */ 3347 /** 3348 * The param of center align. 3349 * 3350 * @type { ?object } 3351 * @syscap SystemCapability.ArkUI.ArkUI.Full 3352 * @crossplatform 3353 * @form 3354 * @atomicservice 3355 * @since 11 3356 */ 3357 center?: { anchor: string, align: VerticalAlign }; 3358 3359 /** 3360 * Defines the bias ratio in horizontal and vertical direction. 3361 * 3362 * @type { ?Bias } 3363 * @default {horizontal:0.5,vertical:0.5} 3364 * @syscap SystemCapability.ArkUI.ArkUI.Full 3365 * @crossplatform 3366 * @form 3367 * @since 11 3368 */ 3369 /** 3370 * Defines the bias ratio in horizontal and vertical direction. 3371 * 3372 * @type { ?Bias } 3373 * @default {horizontal:0.5,vertical:0.5} 3374 * @syscap SystemCapability.ArkUI.ArkUI.Full 3375 * @crossplatform 3376 * @form 3377 * @atomicservice 3378 * @since 12 3379 */ 3380 bias?: Bias; 3381} 3382 3383/** 3384 * Defines the localized horizontal align param of relative container. 3385 * 3386 * @interface LocalizedHorizontalAlignParam 3387 * @syscap SystemCapability.ArkUI.ArkUI.Full 3388 * @crossplatform 3389 * @atomicservice 3390 * @since 12 3391 */ 3392declare interface LocalizedHorizontalAlignParam { 3393 /** 3394 * The anchor of localized align param. 3395 * 3396 * @type { string } 3397 * @syscap SystemCapability.ArkUI.ArkUI.Full 3398 * @crossplatform 3399 * @atomicservice 3400 * @since 12 3401 */ 3402 anchor: string; 3403 3404 /** 3405 * The align of localized align param. 3406 * 3407 * @type { HorizontalAlign } 3408 * @syscap SystemCapability.ArkUI.ArkUI.Full 3409 * @crossplatform 3410 * @atomicservice 3411 * @since 12 3412 */ 3413 align: HorizontalAlign; 3414} 3415 3416/** 3417 * Defines the localized vertical align param of relative container. 3418 * 3419 * @interface LocalizedVerticalAlignParam 3420 * @syscap SystemCapability.ArkUI.ArkUI.Full 3421 * @crossplatform 3422 * @atomicservice 3423 * @since 12 3424 */ 3425declare interface LocalizedVerticalAlignParam { 3426 /** 3427 * The anchor of localized align param. 3428 * 3429 * @type { string } 3430 * @syscap SystemCapability.ArkUI.ArkUI.Full 3431 * @crossplatform 3432 * @atomicservice 3433 * @since 12 3434 */ 3435 anchor: string; 3436 3437 /** 3438 * The align of localized align param. 3439 * 3440 * @type { VerticalAlign } 3441 * @syscap SystemCapability.ArkUI.ArkUI.Full 3442 * @crossplatform 3443 * @atomicservice 3444 * @since 12 3445 */ 3446 align: VerticalAlign; 3447} 3448 3449/** 3450 * Defines the Localized align rule options of relative container. 3451 * 3452 * @interface LocalizedAlignRuleOptions 3453 * @syscap SystemCapability.ArkUI.ArkUI.Full 3454 * @crossplatform 3455 * @atomicservice 3456 * @since 12 3457 */ 3458declare interface LocalizedAlignRuleOptions { 3459 /** 3460 * The param of start align. 3461 * 3462 * @type { ?LocalizedHorizontalAlignParam } 3463 * @syscap SystemCapability.ArkUI.ArkUI.Full 3464 * @crossplatform 3465 * @atomicservice 3466 * @since 12 3467 */ 3468 start?: LocalizedHorizontalAlignParam; 3469 3470 /** 3471 * The param of end align. 3472 * 3473 * @type { ?LocalizedHorizontalAlignParam } 3474 * @syscap SystemCapability.ArkUI.ArkUI.Full 3475 * @crossplatform 3476 * @atomicservice 3477 * @since 12 3478 */ 3479 end?: LocalizedHorizontalAlignParam; 3480 3481 /** 3482 * The param of middle align. 3483 * 3484 * @type { ?LocalizedHorizontalAlignParam } 3485 * @syscap SystemCapability.ArkUI.ArkUI.Full 3486 * @crossplatform 3487 * @atomicservice 3488 * @since 12 3489 */ 3490 middle?: LocalizedHorizontalAlignParam; 3491 3492 /** 3493 * The param of top align. 3494 * 3495 * @type { ?LocalizedVerticalAlignParam } 3496 * @syscap SystemCapability.ArkUI.ArkUI.Full 3497 * @crossplatform 3498 * @atomicservice 3499 * @since 12 3500 */ 3501 top?: LocalizedVerticalAlignParam; 3502 3503 /** 3504 * The param of bottom align. 3505 * 3506 * @type { ?LocalizedVerticalAlignParam } 3507 * @syscap SystemCapability.ArkUI.ArkUI.Full 3508 * @crossplatform 3509 * @atomicservice 3510 * @since 12 3511 */ 3512 bottom?: LocalizedVerticalAlignParam; 3513 3514 /** 3515 * The param of center align. 3516 * 3517 * @type { ?LocalizedVerticalAlignParam } 3518 * @syscap SystemCapability.ArkUI.ArkUI.Full 3519 * @crossplatform 3520 * @atomicservice 3521 * @since 12 3522 */ 3523 center?: LocalizedVerticalAlignParam; 3524 3525 /** 3526 * Defines the bias ratio in horizontal and vertical direction. 3527 * 3528 * @type { ?Bias } 3529 * @default {horizontal:0.5,vertical:0.5} 3530 * @syscap SystemCapability.ArkUI.ArkUI.Full 3531 * @crossplatform 3532 * @atomicservice 3533 * @since 12 3534 */ 3535 bias?: Bias; 3536} 3537 3538/** 3539 * Defines the style of the chain in relative container. 3540 * 3541 * @enum { number } 3542 * @syscap SystemCapability.ArkUI.ArkUI.Full 3543 * @crossplatform 3544 * @atomicservice 3545 * @since 12 3546 */ 3547declare enum ChainStyle { 3548 /** 3549 * Elements of the chain will be spread out. 3550 * 3551 * @syscap SystemCapability.ArkUI.ArkUI.Full 3552 * @crossplatform 3553 * @atomicservice 3554 * @since 12 3555 */ 3556 SPREAD, 3557 3558 /** 3559 * Elements except chain's head and tail will be spread out. 3560 * 3561 * @syscap SystemCapability.ArkUI.ArkUI.Full 3562 * @crossplatform 3563 * @atomicservice 3564 * @since 12 3565 */ 3566 SPREAD_INSIDE, 3567 3568 /** 3569 * Elements of the chain will be packed together. 3570 * 3571 * @syscap SystemCapability.ArkUI.ArkUI.Full 3572 * @crossplatform 3573 * @atomicservice 3574 * @since 12 3575 */ 3576 PACKED, 3577} 3578 3579/** 3580 * The param of rotate. 3581 * 3582 * @interface RotateOptions 3583 * @syscap SystemCapability.ArkUI.ArkUI.Full 3584 * @since 7 3585 */ 3586/** 3587 * The param of rotate. 3588 * 3589 * @interface RotateOptions 3590 * @syscap SystemCapability.ArkUI.ArkUI.Full 3591 * @form 3592 * @since 9 3593 */ 3594/** 3595 * The param of rotate. 3596 * 3597 * @interface RotateOptions 3598 * @syscap SystemCapability.ArkUI.ArkUI.Full 3599 * @crossplatform 3600 * @form 3601 * @since 10 3602 */ 3603/** 3604 * The param of rotate. 3605 * 3606 * @interface RotateOptions 3607 * @syscap SystemCapability.ArkUI.ArkUI.Full 3608 * @crossplatform 3609 * @form 3610 * @atomicservice 3611 * @since 11 3612 */ 3613declare interface RotateOptions { 3614 /** 3615 * The param of x direction. 3616 * 3617 * @type { ?number } 3618 * @syscap SystemCapability.ArkUI.ArkUI.Full 3619 * @since 7 3620 */ 3621 /** 3622 * The param of x direction. 3623 * 3624 * @type { ?number } 3625 * @syscap SystemCapability.ArkUI.ArkUI.Full 3626 * @form 3627 * @since 9 3628 */ 3629 /** 3630 * The param of x direction. 3631 * 3632 * @type { ?number } 3633 * @syscap SystemCapability.ArkUI.ArkUI.Full 3634 * @crossplatform 3635 * @form 3636 * @since 10 3637 */ 3638 /** 3639 * The param of x direction. 3640 * 3641 * @type { ?number } 3642 * @syscap SystemCapability.ArkUI.ArkUI.Full 3643 * @crossplatform 3644 * @form 3645 * @atomicservice 3646 * @since 11 3647 */ 3648 x?: number; 3649 3650 /** 3651 * The param of y direction. 3652 * 3653 * @type { ?number } 3654 * @syscap SystemCapability.ArkUI.ArkUI.Full 3655 * @since 7 3656 */ 3657 /** 3658 * The param of y direction. 3659 * 3660 * @type { ?number } 3661 * @syscap SystemCapability.ArkUI.ArkUI.Full 3662 * @form 3663 * @since 9 3664 */ 3665 /** 3666 * The param of y direction. 3667 * 3668 * @type { ?number } 3669 * @syscap SystemCapability.ArkUI.ArkUI.Full 3670 * @crossplatform 3671 * @form 3672 * @since 10 3673 */ 3674 /** 3675 * The param of y direction. 3676 * 3677 * @type { ?number } 3678 * @syscap SystemCapability.ArkUI.ArkUI.Full 3679 * @crossplatform 3680 * @form 3681 * @atomicservice 3682 * @since 11 3683 */ 3684 y?: number; 3685 3686 /** 3687 * The param of z direction. 3688 * 3689 * @type { ?number } 3690 * @syscap SystemCapability.ArkUI.ArkUI.Full 3691 * @since 7 3692 */ 3693 /** 3694 * The param of z direction. 3695 * 3696 * @type { ?number } 3697 * @syscap SystemCapability.ArkUI.ArkUI.Full 3698 * @form 3699 * @since 9 3700 */ 3701 /** 3702 * The param of z direction. 3703 * 3704 * @type { ?number } 3705 * @syscap SystemCapability.ArkUI.ArkUI.Full 3706 * @crossplatform 3707 * @form 3708 * @since 10 3709 */ 3710 /** 3711 * The param of z direction. 3712 * 3713 * @type { ?number } 3714 * @syscap SystemCapability.ArkUI.ArkUI.Full 3715 * @crossplatform 3716 * @form 3717 * @atomicservice 3718 * @since 11 3719 */ 3720 z?: number; 3721 3722 /** 3723 * The param of center point of x. 3724 * 3725 * @type { ?(number | string) } 3726 * @syscap SystemCapability.ArkUI.ArkUI.Full 3727 * @since 7 3728 */ 3729 /** 3730 * The param of center point of x. 3731 * 3732 * @type { ?(number | string) } 3733 * @syscap SystemCapability.ArkUI.ArkUI.Full 3734 * @form 3735 * @since 9 3736 */ 3737 /** 3738 * The param of center point of x. 3739 * 3740 * @type { ?(number | string) } 3741 * @syscap SystemCapability.ArkUI.ArkUI.Full 3742 * @crossplatform 3743 * @form 3744 * @since 10 3745 */ 3746 /** 3747 * The param of center point of x. 3748 * 3749 * @type { ?(number | string) } 3750 * @syscap SystemCapability.ArkUI.ArkUI.Full 3751 * @crossplatform 3752 * @form 3753 * @atomicservice 3754 * @since 11 3755 */ 3756 centerX?: number | string; 3757 3758 /** 3759 * The param of center point of y. 3760 * 3761 * @type { ?(number | string) } 3762 * @syscap SystemCapability.ArkUI.ArkUI.Full 3763 * @since 7 3764 */ 3765 /** 3766 * The param of center point of y. 3767 * 3768 * @type { ?(number | string) } 3769 * @syscap SystemCapability.ArkUI.ArkUI.Full 3770 * @since 9 3771 */ 3772 /** 3773 * The param of center point of y. 3774 * 3775 * @type { ?(number | string) } 3776 * @syscap SystemCapability.ArkUI.ArkUI.Full 3777 * @crossplatform 3778 * @form 3779 * @since 10 3780 */ 3781 /** 3782 * The param of center point of y. 3783 * 3784 * @type { ?(number | string) } 3785 * @syscap SystemCapability.ArkUI.ArkUI.Full 3786 * @crossplatform 3787 * @form 3788 * @atomicservice 3789 * @since 11 3790 */ 3791 centerY?: number | string; 3792 3793 /** 3794 * The param of center point of z. 3795 * 3796 * @type { ?number } 3797 * @default 0 3798 * @syscap SystemCapability.ArkUI.ArkUI.Full 3799 * @crossplatform 3800 * @form 3801 * @since 10 3802 */ 3803 /** 3804 * The param of center point of z. 3805 * 3806 * @type { ?number } 3807 * @default 0 3808 * @syscap SystemCapability.ArkUI.ArkUI.Full 3809 * @crossplatform 3810 * @form 3811 * @atomicservice 3812 * @since 11 3813 */ 3814 centerZ?: number; 3815 3816 /** 3817 * The param of camera distance, value range (-∞, ∞). 3818 * @type { ?number } 3819 * @default 0 3820 * @syscap SystemCapability.ArkUI.ArkUI.Full 3821 * @crossplatform 3822 * @form 3823 * @since 10 3824 */ 3825 /** 3826 * The param of camera distance, value range (-∞, ∞). 3827 * @type { ?number } 3828 * @default 0 3829 * @syscap SystemCapability.ArkUI.ArkUI.Full 3830 * @crossplatform 3831 * @form 3832 * @atomicservice 3833 * @since 11 3834 */ 3835 perspective?: number; 3836 3837 /** 3838 * The param of angle. 3839 * 3840 * @type { number | string } 3841 * @syscap SystemCapability.ArkUI.ArkUI.Full 3842 * @since 7 3843 */ 3844 /** 3845 * The param of angle. 3846 * 3847 * @type { number | string } 3848 * @syscap SystemCapability.ArkUI.ArkUI.Full 3849 * @form 3850 * @since 9 3851 */ 3852 /** 3853 * The param of angle. 3854 * 3855 * @type { number | string } 3856 * @syscap SystemCapability.ArkUI.ArkUI.Full 3857 * @crossplatform 3858 * @form 3859 * @since 10 3860 */ 3861 /** 3862 * The param of angle. 3863 * 3864 * @type { number | string } 3865 * @syscap SystemCapability.ArkUI.ArkUI.Full 3866 * @crossplatform 3867 * @form 3868 * @atomicservice 3869 * @since 11 3870 */ 3871 angle: number | string; 3872} 3873 3874/** 3875 * Defines the param of transition. 3876 * 3877 * @interface TransitionOptions 3878 * @syscap SystemCapability.ArkUI.ArkUI.Full 3879 * @since 7 3880 * @deprecated since 10 3881 * @useinstead TransitionEffect 3882 */ 3883declare interface TransitionOptions { 3884 /** 3885 * Defines the param of type. 3886 * 3887 * @type { ?TransitionType } 3888 * @syscap SystemCapability.ArkUI.ArkUI.Full 3889 * @since 7 3890 * @deprecated since 10 3891 */ 3892 type?: TransitionType; 3893 /** 3894 * Defines the param of opacity. 3895 * 3896 * @type { ?number } 3897 * @syscap SystemCapability.ArkUI.ArkUI.Full 3898 * @since 7 3899 * @deprecated since 10 3900 */ 3901 opacity?: number; 3902 /** 3903 * Defines the param of translate. 3904 * 3905 * @type { ?TranslateOptions } 3906 * @syscap SystemCapability.ArkUI.ArkUI.Full 3907 * @since 7 3908 * @deprecated since 10 3909 */ 3910 translate?: TranslateOptions; 3911 /** 3912 * Defines the param of scale. 3913 * 3914 * @type { ?ScaleOptions } 3915 * @syscap SystemCapability.ArkUI.ArkUI.Full 3916 * @since 7 3917 * @deprecated since 10 3918 */ 3919 scale?: ScaleOptions; 3920 /** 3921 * Defines the param of rotate. 3922 * 3923 * @type { ?RotateOptions } 3924 * @syscap SystemCapability.ArkUI.ArkUI.Full 3925 * @since 7 3926 * @deprecated since 10 3927 */ 3928 rotate?: RotateOptions; 3929} 3930 3931/** 3932 * Defines the Edge object. 3933 * 3934 * @enum { number } 3935 * @syscap SystemCapability.ArkUI.ArkUI.Full 3936 * @crossplatform 3937 * @form 3938 * @since 10 3939 */ 3940/** 3941 * Defines the Edge object. 3942 * 3943 * @enum { number } 3944 * @syscap SystemCapability.ArkUI.ArkUI.Full 3945 * @crossplatform 3946 * @form 3947 * @atomicservice 3948 * @since 11 3949 */ 3950declare enum TransitionEdge { 3951 /** 3952 * Top edge 3953 * 3954 * @syscap SystemCapability.ArkUI.ArkUI.Full 3955 * @crossplatform 3956 * @form 3957 * @since 10 3958 */ 3959 /** 3960 * Top edge 3961 * 3962 * @syscap SystemCapability.ArkUI.ArkUI.Full 3963 * @crossplatform 3964 * @form 3965 * @atomicservice 3966 * @since 11 3967 */ 3968 TOP, 3969 3970 /** 3971 * Bottom edge 3972 * 3973 * @syscap SystemCapability.ArkUI.ArkUI.Full 3974 * @crossplatform 3975 * @form 3976 * @since 10 3977 */ 3978 /** 3979 * Bottom edge 3980 * 3981 * @syscap SystemCapability.ArkUI.ArkUI.Full 3982 * @crossplatform 3983 * @form 3984 * @atomicservice 3985 * @since 11 3986 */ 3987 BOTTOM, 3988 3989 /** 3990 * Start edge 3991 * 3992 * @syscap SystemCapability.ArkUI.ArkUI.Full 3993 * @crossplatform 3994 * @form 3995 * @since 10 3996 */ 3997 /** 3998 * Start edge 3999 * 4000 * @syscap SystemCapability.ArkUI.ArkUI.Full 4001 * @crossplatform 4002 * @form 4003 * @atomicservice 4004 * @since 11 4005 */ 4006 START, 4007 4008 /** 4009 * End edge 4010 * 4011 * @syscap SystemCapability.ArkUI.ArkUI.Full 4012 * @crossplatform 4013 * @form 4014 * @since 10 4015 */ 4016 /** 4017 * End edge 4018 * 4019 * @syscap SystemCapability.ArkUI.ArkUI.Full 4020 * @crossplatform 4021 * @form 4022 * @atomicservice 4023 * @since 11 4024 */ 4025 END 4026} 4027 4028/** 4029 * Defines all transition effects. 4030 * 4031 * @typedef { object } TransitionEffects 4032 * @syscap SystemCapability.ArkUI.ArkUI.Full 4033 * @crossplatform 4034 * @form 4035 * @since 10 4036 */ 4037/** 4038 * Defines all transition effects. 4039 * 4040 * @typedef { object } TransitionEffects 4041 * @syscap SystemCapability.ArkUI.ArkUI.Full 4042 * @crossplatform 4043 * @form 4044 * @atomicservice 4045 * @since 11 4046 */ 4047declare type TransitionEffects = { 4048 identity: undefined; 4049 opacity: number; 4050 slideSwitch: undefined; 4051 move: TransitionEdge; 4052 translate: TranslateOptions; 4053 rotate: RotateOptions; 4054 scale: ScaleOptions; 4055 asymmetric: { 4056 appear: TransitionEffect; 4057 disappear: TransitionEffect; 4058 }; 4059}; 4060 4061/** 4062 * Defined the draw modifier of node. Provides draw callbacks for the associated Node. 4063 * 4064 * @syscap SystemCapability.ArkUI.ArkUI.Full 4065 * @crossplatform 4066 * @atomicservice 4067 * @since 12 4068 */ 4069declare class DrawModifier { 4070 /** 4071 * drawBehind Method. Executed before drawing associated Node. 4072 * 4073 * @param { DrawContext } drawContext - The drawContext used to draw. 4074 * @syscap SystemCapability.ArkUI.ArkUI.Full 4075 * @crossplatform 4076 * @atomicservice 4077 * @since 12 4078 */ 4079 drawBehind?(drawContext: DrawContext): void; 4080 4081 /** 4082 * drawContent Method. Executed when associated Node is drawing, the default drawContent method will be replaced 4083 * if this method is set. 4084 * 4085 * @param { DrawContext } drawContext - The drawContext used to draw. 4086 * @syscap SystemCapability.ArkUI.ArkUI.Full 4087 * @crossplatform 4088 * @atomicservice 4089 * @since 12 4090 */ 4091 drawContent?(drawContext: DrawContext): void; 4092 4093 /** 4094 * drawFront Method. Executed after drawing associated Node. 4095 * 4096 * @param { DrawContext } drawContext - The drawContext used to draw. 4097 * @syscap SystemCapability.ArkUI.ArkUI.Full 4098 * @crossplatform 4099 * @atomicservice 4100 * @since 12 4101 */ 4102 drawFront?(drawContext: DrawContext): void; 4103 4104 /** 4105 * Invalidate the component, which will cause a re-render of the component. 4106 * 4107 * @syscap SystemCapability.ArkUI.ArkUI.Full 4108 * @crossplatform 4109 * @atomicservice 4110 * @since 12 4111 */ 4112 invalidate(): void; 4113} 4114 4115/** 4116 * Defines the transition effect 4117 * 4118 * @syscap SystemCapability.ArkUI.ArkUI.Full 4119 * @crossplatform 4120 * @form 4121 * @since 10 4122 */ 4123/** 4124 * Defines the transition effect 4125 * 4126 * @syscap SystemCapability.ArkUI.ArkUI.Full 4127 * @crossplatform 4128 * @form 4129 * @atomicservice 4130 * @since 11 4131 */ 4132declare class TransitionEffect< 4133 Type extends keyof TransitionEffects = keyof TransitionEffects, 4134 Effect extends TransitionEffects[Type] = TransitionEffects[Type] 4135> { 4136 /** 4137 * Disables the transition effect 4138 * 4139 * @type { TransitionEffect<"identity"> } 4140 * @readonly 4141 * @static 4142 * @syscap SystemCapability.ArkUI.ArkUI.Full 4143 * @crossplatform 4144 * @form 4145 * @since 10 4146 */ 4147 /** 4148 * Disables the transition effect 4149 * 4150 * @type { TransitionEffect<"identity"> } 4151 * @readonly 4152 * @static 4153 * @syscap SystemCapability.ArkUI.ArkUI.Full 4154 * @crossplatform 4155 * @form 4156 * @atomicservice 4157 * @since 11 4158 */ 4159 static readonly IDENTITY: TransitionEffect<"identity">; 4160 4161 /** 4162 * Specifies a transition effect with transparency of 0, which is equivalent to TransitionEffect.opacity(0). 4163 * 4164 * @type { TransitionEffect<"opacity"> } 4165 * @readonly 4166 * @static 4167 * @syscap SystemCapability.ArkUI.ArkUI.Full 4168 * @crossplatform 4169 * @form 4170 * @since 10 4171 */ 4172 /** 4173 * Specifies a transition effect with transparency of 0, which is equivalent to TransitionEffect.opacity(0). 4174 * 4175 * @type { TransitionEffect<"opacity"> } 4176 * @readonly 4177 * @static 4178 * @syscap SystemCapability.ArkUI.ArkUI.Full 4179 * @crossplatform 4180 * @form 4181 * @atomicservice 4182 * @since 11 4183 */ 4184 static readonly OPACITY: TransitionEffect<"opacity">; 4185 4186 /** 4187 * Defines a slide transition effect 4188 * 4189 * @type { TransitionEffect< 4190 * "asymmetric", 4191 * {appear: TransitionEffect<"move", TransitionEdge>; 4192 * disappear: TransitionEffect<"move", TransitionEdge>; 4193 * }> } 4194 * @readonly 4195 * @static 4196 * @syscap SystemCapability.ArkUI.ArkUI.Full 4197 * @crossplatform 4198 * @form 4199 * @since 10 4200 */ 4201 /** 4202 * Defines a slide transition effect 4203 * 4204 * @type { TransitionEffect< 4205 * "asymmetric", 4206 * {appear: TransitionEffect<"move", TransitionEdge>; 4207 * disappear: TransitionEffect<"move", TransitionEdge>; 4208 * }> } 4209 * @readonly 4210 * @static 4211 * @syscap SystemCapability.ArkUI.ArkUI.Full 4212 * @crossplatform 4213 * @form 4214 * @atomicservice 4215 * @since 11 4216 */ 4217 static readonly SLIDE: TransitionEffect< 4218 "asymmetric", 4219 { 4220 appear: TransitionEffect<"move", TransitionEdge>; 4221 disappear: TransitionEffect<"move", TransitionEdge>; 4222 } 4223 >; 4224 4225 /** 4226 * Specify a transition effect where the element enters by shrinking first and then expanding as it slides in from the right, 4227 * and exits by shrinking first and then expanding as it slides out to the left, with a minimum scale ratio of 0.8. 4228 * It comes with default animation parameters, which can also be overridden. 4229 * The default animation duration is set to 600ms, and the specified animation curve is cubicBezierCurve(0.24, 0.0, 0.50, 1.0). 4230 * 4231 * @type { TransitionEffect<"slideSwitch"> } 4232 * @readonly 4233 * @static 4234 * @syscap SystemCapability.ArkUI.ArkUI.Full 4235 * @crossplatform 4236 * @form 4237 * @since 10 4238 */ 4239 /** 4240 * Specify a transition effect where the element enters by shrinking first and then expanding as it slides in from the right, 4241 * and exits by shrinking first and then expanding as it slides out to the left, with a minimum scale ratio of 0.8. 4242 * It comes with default animation parameters, which can also be overridden. 4243 * The default animation duration is set to 600ms, and the specified animation curve is cubicBezierCurve(0.24, 0.0, 0.50, 1.0). 4244 * 4245 * @type { TransitionEffect<"slideSwitch"> } 4246 * @readonly 4247 * @static 4248 * @syscap SystemCapability.ArkUI.ArkUI.Full 4249 * @crossplatform 4250 * @form 4251 * @atomicservice 4252 * @since 11 4253 */ 4254 static readonly SLIDE_SWITCH: TransitionEffect<"slideSwitch">; 4255 4256 /** 4257 * Creates a translate transition effect 4258 * 4259 * @param { TranslateOptions } options - translate options 4260 * @returns { TransitionEffect<"translate"> } 4261 * @syscap SystemCapability.ArkUI.ArkUI.Full 4262 * @crossplatform 4263 * @form 4264 * @since 10 4265 */ 4266 /** 4267 * Creates a translate transition effect 4268 * 4269 * @param { TranslateOptions } options - translate options 4270 * @returns { TransitionEffect<"translate"> } 4271 * @syscap SystemCapability.ArkUI.ArkUI.Full 4272 * @crossplatform 4273 * @form 4274 * @atomicservice 4275 * @since 11 4276 */ 4277 static translate(options: TranslateOptions): TransitionEffect<"translate">; 4278 4279 /** 4280 * Creates a rotation transition effect 4281 * 4282 * @param { RotateOptions } options - rotate options 4283 * Set the rotation effect for component transitions when inserting and deleting. 4284 * The value represents the starting rotation point for the inserting animation and the ending rotation point for the deleting animation. 4285 * -x: Horizontal component of the rotational vector. 4286 * -y: Vertical component of the rotational vector. 4287 * -z: Vertical component of the rotational vector. 4288 * -centerX, centerY specify the rotation center point, with default values of "50%", 4289 * meaning that the default rotation center point is the center point of the component. 4290 * -The center point of (0, 0) represents the upper-left corner of the component. 4291 * -centerZ refers to the Z-axis anchor point. The default value of centerZ is 0. 4292 * -perspective indicates the visual distance. The perspective property does not support transition animation. 4293 * @returns { TransitionEffect<"rotate"> } 4294 * @syscap SystemCapability.ArkUI.ArkUI.Full 4295 * @crossplatform 4296 * @form 4297 * @since 10 4298 */ 4299 /** 4300 * Creates a rotation transition effect 4301 * 4302 * @param { RotateOptions } options - rotate options 4303 * Set the rotation effect for component transitions when inserting and deleting. 4304 * The value represents the starting rotation point for the inserting animation and the ending rotation point for the deleting animation. 4305 * -x: Horizontal component of the rotational vector. 4306 * -y: Vertical component of the rotational vector. 4307 * -z: Vertical component of the rotational vector. 4308 * -centerX, centerY specify the rotation center point, with default values of "50%", 4309 * meaning that the default rotation center point is the center point of the component. 4310 * -The center point of (0, 0) represents the upper-left corner of the component. 4311 * -centerZ refers to the Z-axis anchor point. The default value of centerZ is 0. 4312 * -perspective indicates the visual distance. The perspective property does not support transition animation. 4313 * @returns { TransitionEffect<"rotate"> } 4314 * @syscap SystemCapability.ArkUI.ArkUI.Full 4315 * @crossplatform 4316 * @form 4317 * @atomicservice 4318 * @since 11 4319 */ 4320 static rotate(options: RotateOptions): TransitionEffect<"rotate">; 4321 4322 /** 4323 * Creates a scale transition effect 4324 * 4325 * @param { ScaleOptions } options - scale options 4326 * @returns { TransitionEffect<"scale"> } 4327 * @syscap SystemCapability.ArkUI.ArkUI.Full 4328 * @crossplatform 4329 * @form 4330 * @since 10 4331 */ 4332 /** 4333 * Creates a scale transition effect 4334 * 4335 * @param { ScaleOptions } options - scale options 4336 * @returns { TransitionEffect<"scale"> } 4337 * @syscap SystemCapability.ArkUI.ArkUI.Full 4338 * @crossplatform 4339 * @form 4340 * @atomicservice 4341 * @since 11 4342 */ 4343 static scale(options: ScaleOptions): TransitionEffect<"scale">; 4344 4345 /** 4346 * Creates an opacity transition effect with alpha value 4347 * 4348 * @param { number } alpha - opacity alpha value, value range [0, 1]. 4349 * @returns { TransitionEffect<"opacity"> } 4350 * @syscap SystemCapability.ArkUI.ArkUI.Full 4351 * @crossplatform 4352 * @form 4353 * @since 10 4354 */ 4355 /** 4356 * Creates an opacity transition effect with alpha value 4357 * 4358 * @param { number } alpha - opacity alpha value, value range [0, 1]. 4359 * @returns { TransitionEffect<"opacity"> } 4360 * @syscap SystemCapability.ArkUI.ArkUI.Full 4361 * @crossplatform 4362 * @form 4363 * @atomicservice 4364 * @since 11 4365 */ 4366 /** 4367 * Creates an opacity transition effect with alpha value 4368 * 4369 * @param { number } alpha - opacity alpha value, value range [0, 1]. 4370 * Illegal values less than 0 are treated as 0, and illegal values greater than 1 are treated as 1. 4371 * @returns { TransitionEffect<"opacity"> } 4372 * @syscap SystemCapability.ArkUI.ArkUI.Full 4373 * @crossplatform 4374 * @form 4375 * @atomicservice 4376 * @since 12 4377 */ 4378 static opacity(alpha: number): TransitionEffect<"opacity">; 4379 4380 /** 4381 * Creates a move transition effect 4382 * 4383 * @param { TransitionEdge } edge - the edge that component will move to 4384 * @returns { TransitionEffect<"move"> } 4385 * @syscap SystemCapability.ArkUI.ArkUI.Full 4386 * @crossplatform 4387 * @form 4388 * @since 10 4389 */ 4390 /** 4391 * Creates a move transition effect 4392 * 4393 * @param { TransitionEdge } edge - the edge that component will move to 4394 * @returns { TransitionEffect<"move"> } 4395 * @syscap SystemCapability.ArkUI.ArkUI.Full 4396 * @crossplatform 4397 * @form 4398 * @atomicservice 4399 * @since 11 4400 */ 4401 static move(edge: TransitionEdge): TransitionEffect<"move">; 4402 4403 /** 4404 * Creates an asymmetric transition effect 4405 * 4406 * @param { TransitionEffect } appear - the transition which will be attached when the component is appear 4407 * @param { TransitionEffect } disappear - the transition which will be attached when the component is disappear 4408 * @returns { TransitionEffect<"asymmetric"> } 4409 * @syscap SystemCapability.ArkUI.ArkUI.Full 4410 * @crossplatform 4411 * @form 4412 * @since 10 4413 */ 4414 /** 4415 * Creates an asymmetric transition effect 4416 * 4417 * @param { TransitionEffect } appear - the transition which will be attached when the component is appear 4418 * @param { TransitionEffect } disappear - the transition which will be attached when the component is disappear 4419 * @returns { TransitionEffect<"asymmetric"> } 4420 * @syscap SystemCapability.ArkUI.ArkUI.Full 4421 * @crossplatform 4422 * @form 4423 * @atomicservice 4424 * @since 11 4425 */ 4426 static asymmetric( 4427 appear: TransitionEffect, 4428 disappear: TransitionEffect 4429 ): TransitionEffect<"asymmetric">; 4430 4431 /** 4432 * TransitionEffect constructor 4433 * 4434 * @param { Type } type - transition type 4435 * @param { Effect } effect - transition options 4436 * @syscap SystemCapability.ArkUI.ArkUI.Full 4437 * @crossplatform 4438 * @form 4439 * @since 10 4440 */ 4441 /** 4442 * TransitionEffect constructor 4443 * 4444 * @param { Type } type - transition type 4445 * @param { Effect } effect - transition options 4446 * @syscap SystemCapability.ArkUI.ArkUI.Full 4447 * @crossplatform 4448 * @form 4449 * @atomicservice 4450 * @since 11 4451 */ 4452 constructor(type: Type, effect: Effect); 4453 4454 /** 4455 * Set the animation of current transition effect 4456 * 4457 * @param { AnimateParam } value - animation parameters 4458 * @returns { TransitionEffect } 4459 * @syscap SystemCapability.ArkUI.ArkUI.Full 4460 * @crossplatform 4461 * @form 4462 * @since 10 4463 */ 4464 /** 4465 * Set the animation of current transition effect 4466 * 4467 * @param { AnimateParam } value - animation parameters 4468 * @returns { TransitionEffect } 4469 * @syscap SystemCapability.ArkUI.ArkUI.Full 4470 * @crossplatform 4471 * @form 4472 * @atomicservice 4473 * @since 11 4474 */ 4475 animation(value: AnimateParam): TransitionEffect; 4476 4477 /** 4478 * Combines another transition effect 4479 * 4480 * @param { TransitionEffect } transitionEffect - transition effect which is be combined 4481 * @returns { TransitionEffect } combined transition effect 4482 * @syscap SystemCapability.ArkUI.ArkUI.Full 4483 * @crossplatform 4484 * @form 4485 * @since 10 4486 */ 4487 /** 4488 * Combines another transition effect 4489 * 4490 * @param { TransitionEffect } transitionEffect - transition effect which is be combined 4491 * @returns { TransitionEffect } combined transition effect 4492 * @syscap SystemCapability.ArkUI.ArkUI.Full 4493 * @crossplatform 4494 * @form 4495 * @atomicservice 4496 * @since 11 4497 */ 4498 combine(transitionEffect: TransitionEffect): TransitionEffect; 4499} 4500 4501/** 4502 * Define Preview property 4503 * 4504 * @interface PreviewParams 4505 * @syscap SystemCapability.ArkUI.ArkUI.Full 4506 * @form 4507 * @since 9 4508 */ 4509/** 4510 * Define Preview property 4511 * 4512 * @interface PreviewParams 4513 * @syscap SystemCapability.ArkUI.ArkUI.Full 4514 * @crossplatform 4515 * @form 4516 * @atomicservice 4517 * @since 11 4518 */ 4519interface PreviewParams { 4520 /** 4521 * Define Preview title 4522 * 4523 * @type { ?string } 4524 * @syscap SystemCapability.ArkUI.ArkUI.Full 4525 * @form 4526 * @since 9 4527 */ 4528 /** 4529 * Define Preview title 4530 * 4531 * @type { ?string } 4532 * @syscap SystemCapability.ArkUI.ArkUI.Full 4533 * @crossplatform 4534 * @form 4535 * @atomicservice 4536 * @since 11 4537 */ 4538 title?: string; 4539 4540 /** 4541 * Define Preview width 4542 * 4543 * @type { ?number } 4544 * @syscap SystemCapability.ArkUI.ArkUI.Full 4545 * @form 4546 * @since 9 4547 */ 4548 /** 4549 * Define Preview width 4550 * 4551 * @type { ?number } 4552 * @syscap SystemCapability.ArkUI.ArkUI.Full 4553 * @crossplatform 4554 * @form 4555 * @atomicservice 4556 * @since 11 4557 */ 4558 width?: number; 4559 4560 /** 4561 * Define Preview height 4562 * 4563 * @type { ?number } 4564 * @syscap SystemCapability.ArkUI.ArkUI.Full 4565 * @form 4566 * @since 9 4567 */ 4568 /** 4569 * Define Preview height 4570 * 4571 * @type { ?number } 4572 * @syscap SystemCapability.ArkUI.ArkUI.Full 4573 * @crossplatform 4574 * @form 4575 * @atomicservice 4576 * @since 11 4577 */ 4578 height?: number; 4579 4580 /** 4581 * Define Preview locale 4582 * 4583 * @type { ?string } 4584 * @syscap SystemCapability.ArkUI.ArkUI.Full 4585 * @form 4586 * @since 9 4587 */ 4588 /** 4589 * Define Preview locale 4590 * 4591 * @type { ?string } 4592 * @syscap SystemCapability.ArkUI.ArkUI.Full 4593 * @form 4594 * @atomicservice 4595 * @since 11 4596 */ 4597 locale?: string; 4598 4599 /** 4600 * Define Preview colorMode 4601 * 4602 * @type { ?string } 4603 * @syscap SystemCapability.ArkUI.ArkUI.Full 4604 * @form 4605 * @since 9 4606 */ 4607 /** 4608 * Define Preview colorMode 4609 * 4610 * @type { ?string } 4611 * @syscap SystemCapability.ArkUI.ArkUI.Full 4612 * @crossplatform 4613 * @form 4614 * @atomicservice 4615 * @since 11 4616 */ 4617 colorMode?: string; 4618 4619 /** 4620 * Define Preview deviceType 4621 * 4622 * @type { ?string } 4623 * @syscap SystemCapability.ArkUI.ArkUI.Full 4624 * @form 4625 * @since 9 4626 */ 4627 /** 4628 * Define Preview deviceType 4629 * 4630 * @type { ?string } 4631 * @syscap SystemCapability.ArkUI.ArkUI.Full 4632 * @form 4633 * @atomicservice 4634 * @since 11 4635 */ 4636 deviceType?: string; 4637 4638 /** 4639 * Define Preview dpi 4640 * 4641 * @type { ?number } 4642 * @syscap SystemCapability.ArkUI.ArkUI.Full 4643 * @form 4644 * @since 9 4645 */ 4646 /** 4647 * Define Preview dpi 4648 * 4649 * @type { ?number } 4650 * @syscap SystemCapability.ArkUI.ArkUI.Full 4651 * @form 4652 * @atomicservice 4653 * @since 11 4654 */ 4655 dpi?: number; 4656 4657 /** 4658 * Define Preview orientation 4659 * 4660 * @type { ?string } 4661 * @syscap SystemCapability.ArkUI.ArkUI.Full 4662 * @form 4663 * @since 9 4664 */ 4665 /** 4666 * Define Preview orientation 4667 * 4668 * @type { ?string } 4669 * @syscap SystemCapability.ArkUI.ArkUI.Full 4670 * @form 4671 * @atomicservice 4672 * @since 11 4673 */ 4674 orientation?: string; 4675 4676 /** 4677 * Define Preview roundScreen 4678 * 4679 * @type { ?boolean } 4680 * @syscap SystemCapability.ArkUI.ArkUI.Full 4681 * @form 4682 * @since 9 4683 */ 4684 /** 4685 * Define Preview roundScreen 4686 * 4687 * @type { ?boolean } 4688 * @syscap SystemCapability.ArkUI.ArkUI.Full 4689 * @form 4690 * @atomicservice 4691 * @since 11 4692 */ 4693 roundScreen?: boolean; 4694} 4695 4696/** 4697 * ItemDragInfo object description 4698 * 4699 * @interface ItemDragInfo 4700 * @syscap SystemCapability.ArkUI.ArkUI.Full 4701 * @since 8 4702 */ 4703/** 4704 * ItemDragInfo object description 4705 * 4706 * @interface ItemDragInfo 4707 * @syscap SystemCapability.ArkUI.ArkUI.Full 4708 * @crossplatform 4709 * @since 10 4710 */ 4711/** 4712 * ItemDragInfo object description 4713 * 4714 * @interface ItemDragInfo 4715 * @syscap SystemCapability.ArkUI.ArkUI.Full 4716 * @crossplatform 4717 * @atomicservice 4718 * @since 11 4719 */ 4720declare interface ItemDragInfo { 4721 /** 4722 * Obtains the X coordinate of the drag window, in vp. 4723 * 4724 * @type { number } 4725 * @syscap SystemCapability.ArkUI.ArkUI.Full 4726 * @since 8 4727 */ 4728 /** 4729 * Obtains the X coordinate of the drag window, in vp. 4730 * 4731 * @type { number } 4732 * @syscap SystemCapability.ArkUI.ArkUI.Full 4733 * @crossplatform 4734 * @since 10 4735 */ 4736 /** 4737 * Obtains the X coordinate of the drag window, in vp. 4738 * 4739 * @type { number } 4740 * @syscap SystemCapability.ArkUI.ArkUI.Full 4741 * @crossplatform 4742 * @atomicservice 4743 * @since 11 4744 */ 4745 x: number; 4746 4747 /** 4748 * Obtains the Y coordinate of the drag window, in vp. 4749 * 4750 * @type { number } 4751 * @syscap SystemCapability.ArkUI.ArkUI.Full 4752 * @since 8 4753 */ 4754 /** 4755 * Obtains the Y coordinate of the drag window, in vp. 4756 * 4757 * @type { number } 4758 * @syscap SystemCapability.ArkUI.ArkUI.Full 4759 * @crossplatform 4760 * @since 10 4761 */ 4762 /** 4763 * Obtains the Y coordinate of the drag window, in vp. 4764 * 4765 * @type { number } 4766 * @syscap SystemCapability.ArkUI.ArkUI.Full 4767 * @crossplatform 4768 * @atomicservice 4769 * @since 11 4770 */ 4771 y: number; 4772} 4773 4774/** 4775 * Defines the drag status before drag action. 4776 * 4777 * @enum { number } 4778 * @syscap SystemCapability.ArkUI.ArkUI.Full 4779 * @atomicservice 4780 * @since 12 4781 */ 4782declare enum PreDragStatus { 4783 /** 4784 * Define the status for user prepare to start long press gesture. 4785 * 4786 * @syscap SystemCapability.ArkUI.ArkUI.Full 4787 * @atomicservice 4788 * @since 12 4789 */ 4790 ACTION_DETECTING_STATUS = 0, 4791 4792 /** 4793 * Define the status for user can start drag action. 4794 * 4795 * @syscap SystemCapability.ArkUI.ArkUI.Full 4796 * @atomicservice 4797 * @since 12 4798 */ 4799 READY_TO_TRIGGER_DRAG_ACTION = 1, 4800 4801 /** 4802 * Define the status for dragItem lift animation started. 4803 * 4804 * @syscap SystemCapability.ArkUI.ArkUI.Full 4805 * @atomicservice 4806 * @since 12 4807 */ 4808 PREVIEW_LIFT_STARTED = 2, 4809 4810 /** 4811 * Define the status for dragItem lift animation finished. 4812 * 4813 * @syscap SystemCapability.ArkUI.ArkUI.Full 4814 * @atomicservice 4815 * @since 12 4816 */ 4817 PREVIEW_LIFT_FINISHED = 3, 4818 4819 /** 4820 * Define the status for dragItem landing animation started. 4821 * 4822 * @syscap SystemCapability.ArkUI.ArkUI.Full 4823 * @atomicservice 4824 * @since 12 4825 */ 4826 PREVIEW_LANDING_STARTED = 4, 4827 4828 /** 4829 * Define the status for dragItem landing animation finished. 4830 * 4831 * @syscap SystemCapability.ArkUI.ArkUI.Full 4832 * @atomicservice 4833 * @since 12 4834 */ 4835 PREVIEW_LANDING_FINISHED = 5, 4836 4837 /** 4838 * Define the status for user cancel drag action. 4839 * 4840 * @syscap SystemCapability.ArkUI.ArkUI.Full 4841 * @atomicservice 4842 * @since 12 4843 */ 4844 ACTION_CANCELED_BEFORE_DRAG = 6, 4845} 4846 4847/** 4848 * DragItemInfo object description 4849 * 4850 * @interface DragItemInfo 4851 * @syscap SystemCapability.ArkUI.ArkUI.Full 4852 * @since 8 4853 */ 4854/** 4855 * DragItemInfo object description 4856 * 4857 * @interface DragItemInfo 4858 * @syscap SystemCapability.ArkUI.ArkUI.Full 4859 * @atomicservice 4860 * @since 11 4861 */ 4862/** 4863 * DragItemInfo object description 4864 * 4865 * @interface DragItemInfo 4866 * @syscap SystemCapability.ArkUI.ArkUI.Full 4867 * @crossplatform 4868 * @atomicservice 4869 * @since 13 4870 */ 4871declare interface DragItemInfo { 4872 /** 4873 * Uses the pixelMap object for drawing. 4874 * 4875 * @type { ?PixelMap } 4876 * @syscap SystemCapability.ArkUI.ArkUI.Full 4877 * @since 8 4878 */ 4879 /** 4880 * Uses the pixelMap object for drawing. 4881 * 4882 * @type { ?PixelMap } 4883 * @syscap SystemCapability.ArkUI.ArkUI.Full 4884 * @atomicservice 4885 * @since 11 4886 */ 4887 /** 4888 * Uses the pixelMap object for drawing. 4889 * 4890 * @type { ?PixelMap } 4891 * @syscap SystemCapability.ArkUI.ArkUI.Full 4892 * @crossplatform 4893 * @atomicservice 4894 * @since 13 4895 */ 4896 pixelMap?: PixelMap; 4897 4898 /** 4899 * Uses the custom builder for drawing, if pixelMap is set, this value is ignored. 4900 * 4901 * @type { ?CustomBuilder } 4902 * @syscap SystemCapability.ArkUI.ArkUI.Full 4903 * @since 8 4904 */ 4905 /** 4906 * Uses the custom builder for drawing, if pixelMap is set, this value is ignored. 4907 * 4908 * @type { ?CustomBuilder } 4909 * @syscap SystemCapability.ArkUI.ArkUI.Full 4910 * @atomicservice 4911 * @since 11 4912 */ 4913 /** 4914 * Uses the custom builder for drawing, if pixelMap is set, this value is ignored. 4915 * 4916 * @type { ?CustomBuilder } 4917 * @syscap SystemCapability.ArkUI.ArkUI.Full 4918 * @crossplatform 4919 * @atomicservice 4920 * @since 13 4921 */ 4922 builder?: CustomBuilder; 4923 4924 /** 4925 * Sets the extra info for drag event. 4926 * 4927 * @type { ?string } 4928 * @syscap SystemCapability.ArkUI.ArkUI.Full 4929 * @since 8 4930 */ 4931 /** 4932 * Sets the extra info for drag event. 4933 * 4934 * @type { ?string } 4935 * @syscap SystemCapability.ArkUI.ArkUI.Full 4936 * @atomicservice 4937 * @since 11 4938 */ 4939 /** 4940 * Sets the extra info for drag event. 4941 * 4942 * @type { ?string } 4943 * @syscap SystemCapability.ArkUI.ArkUI.Full 4944 * @crossplatform 4945 * @atomicservice 4946 * @since 13 4947 */ 4948 extraInfo?: string; 4949} 4950 4951/** 4952 * Defining animation function. 4953 * 4954 * @param { AnimateParam } value 4955 * @param { function } event 4956 * @syscap SystemCapability.ArkUI.ArkUI.Full 4957 * @since 7 4958 */ 4959/** 4960 * Defining animation function. 4961 * 4962 * @param { AnimateParam } value 4963 * @param { function } event 4964 * @syscap SystemCapability.ArkUI.ArkUI.Full 4965 * @form 4966 * @since 9 4967 */ 4968/** 4969 * Defining animation function. 4970 * 4971 * @param { AnimateParam } value 4972 * @param { function } event 4973 * @syscap SystemCapability.ArkUI.ArkUI.Full 4974 * @crossplatform 4975 * @form 4976 * @since 10 4977 */ 4978/** 4979 * Defining animation function. 4980 * 4981 * @param { AnimateParam } value 4982 * @param { function } event 4983 * @syscap SystemCapability.ArkUI.ArkUI.Full 4984 * @crossplatform 4985 * @form 4986 * @atomicservice 4987 * @since 11 4988 */ 4989declare function animateTo(value: AnimateParam, event: () => void): void; 4990 4991/** 4992 * Define animation functions for immediate distribution. 4993 * 4994 * @param { AnimateParam } value - Set animation effect parameters. 4995 * @param { function } event - Specify the closure function that displays dynamic effects, 4996 * and the system will automatically insert transition animations for state changes caused by the closure function. 4997 * @syscap SystemCapability.ArkUI.ArkUI.Full 4998 * @atomicservice 4999 * @since 12 5000 */ 5001declare function animateToImmediately(value: AnimateParam, event: () => void): void; 5002 5003/** 5004 * Converts a value in vp units to a value in px. 5005 * 5006 * @param { number } value 5007 * @returns { number } 5008 * @syscap SystemCapability.ArkUI.ArkUI.Full 5009 * @since 7 5010 */ 5011/** 5012 * Converts a value in vp units to a value in px. 5013 * 5014 * @param { number } value 5015 * @returns { number } 5016 * @syscap SystemCapability.ArkUI.ArkUI.Full 5017 * @form 5018 * @since 9 5019 */ 5020/** 5021 * Converts a value in vp units to a value in px. 5022 * 5023 * @param { number } value 5024 * @returns { number } 5025 * @syscap SystemCapability.ArkUI.ArkUI.Full 5026 * @crossplatform 5027 * @form 5028 * @since 10 5029 */ 5030/** 5031 * Converts a value in vp units to a value in px. 5032 * 5033 * @param { number } value 5034 * @returns { number } 5035 * @syscap SystemCapability.ArkUI.ArkUI.Full 5036 * @crossplatform 5037 * @form 5038 * @atomicservice 5039 * @since 11 5040 */ 5041declare function vp2px(value: number): number; 5042 5043/** 5044 * Converts a number in units of px to a number in units of vp. 5045 * 5046 * @param { number } value 5047 * @returns { number } 5048 * @syscap SystemCapability.ArkUI.ArkUI.Full 5049 * @since 7 5050 */ 5051/** 5052 * Converts a number in units of px to a number in units of vp. 5053 * 5054 * @param { number } value 5055 * @returns { number } 5056 * @syscap SystemCapability.ArkUI.ArkUI.Full 5057 * @form 5058 * @since 9 5059 */ 5060/** 5061 * Converts a number in units of px to a number in units of vp. 5062 * 5063 * @param { number } value 5064 * @returns { number } 5065 * @syscap SystemCapability.ArkUI.ArkUI.Full 5066 * @crossplatform 5067 * @form 5068 * @since 10 5069 */ 5070/** 5071 * Converts a number in units of px to a number in units of vp. 5072 * 5073 * @param { number } value 5074 * @returns { number } 5075 * @syscap SystemCapability.ArkUI.ArkUI.Full 5076 * @crossplatform 5077 * @form 5078 * @atomicservice 5079 * @since 11 5080 */ 5081declare function px2vp(value: number): number; 5082 5083/** 5084 * Converts a number in fp units to a number in px. 5085 * 5086 * @param { number } value 5087 * @returns { number } 5088 * @syscap SystemCapability.ArkUI.ArkUI.Full 5089 * @since 7 5090 */ 5091/** 5092 * Converts a number in fp units to a number in px. 5093 * 5094 * @param { number } value 5095 * @returns { number } 5096 * @syscap SystemCapability.ArkUI.ArkUI.Full 5097 * @form 5098 * @since 9 5099 */ 5100/** 5101 * Converts a number in fp units to a number in px. 5102 * 5103 * @param { number } value 5104 * @returns { number } 5105 * @syscap SystemCapability.ArkUI.ArkUI.Full 5106 * @crossplatform 5107 * @form 5108 * @since 10 5109 */ 5110/** 5111 * Converts a number in fp units to a number in px. 5112 * 5113 * @param { number } value 5114 * @returns { number } 5115 * @syscap SystemCapability.ArkUI.ArkUI.Full 5116 * @crossplatform 5117 * @form 5118 * @atomicservice 5119 * @since 11 5120 */ 5121declare function fp2px(value: number): number; 5122 5123/** 5124 * Converts a number in units of px to a number in units of fp. 5125 * 5126 * @param { number } value 5127 * @returns { number } 5128 * @syscap SystemCapability.ArkUI.ArkUI.Full 5129 * @since 7 5130 */ 5131/** 5132 * Converts a number in units of px to a number in units of fp. 5133 * 5134 * @param { number } value 5135 * @returns { number } 5136 * @syscap SystemCapability.ArkUI.ArkUI.Full 5137 * @form 5138 * @since 9 5139 */ 5140/** 5141 * Converts a number in units of px to a number in units of fp. 5142 * 5143 * @param { number } value 5144 * @returns { number } 5145 * @syscap SystemCapability.ArkUI.ArkUI.Full 5146 * @crossplatform 5147 * @form 5148 * @since 10 5149 */ 5150/** 5151 * Converts a number in units of px to a number in units of fp. 5152 * 5153 * @param { number } value 5154 * @returns { number } 5155 * @syscap SystemCapability.ArkUI.ArkUI.Full 5156 * @crossplatform 5157 * @form 5158 * @atomicservice 5159 * @since 11 5160 */ 5161declare function px2fp(value: number): number; 5162 5163/** 5164 * Converts a number in units of lpx to a number in units of px. 5165 * 5166 * @param { number } value 5167 * @returns { number } 5168 * @syscap SystemCapability.ArkUI.ArkUI.Full 5169 * @since 7 5170 */ 5171/** 5172 * Converts a number in units of lpx to a number in units of px. 5173 * 5174 * @param { number } value 5175 * @returns { number } 5176 * @syscap SystemCapability.ArkUI.ArkUI.Full 5177 * @form 5178 * @since 9 5179 */ 5180/** 5181 * Converts a number in units of lpx to a number in units of px. 5182 * 5183 * @param { number } value 5184 * @returns { number } 5185 * @syscap SystemCapability.ArkUI.ArkUI.Full 5186 * @crossplatform 5187 * @form 5188 * @since 10 5189 */ 5190/** 5191 * Converts a number in units of lpx to a number in units of px. 5192 * 5193 * @param { number } value 5194 * @returns { number } 5195 * @syscap SystemCapability.ArkUI.ArkUI.Full 5196 * @crossplatform 5197 * @form 5198 * @atomicservice 5199 * @since 11 5200 */ 5201declare function lpx2px(value: number): number; 5202 5203/** 5204 * Converts a number in units of px to a number in units of lpx. 5205 * 5206 * @param { number } value 5207 * @returns { number } 5208 * @syscap SystemCapability.ArkUI.ArkUI.Full 5209 * @since 7 5210 */ 5211/** 5212 * Converts a number in units of px to a number in units of lpx. 5213 * 5214 * @param { number } value 5215 * @returns { number } 5216 * @syscap SystemCapability.ArkUI.ArkUI.Full 5217 * @form 5218 * @since 9 5219 */ 5220/** 5221 * Converts a number in units of px to a number in units of lpx. 5222 * 5223 * @param { number } value 5224 * @returns { number } 5225 * @syscap SystemCapability.ArkUI.ArkUI.Full 5226 * @crossplatform 5227 * @form 5228 * @since 10 5229 */ 5230/** 5231 * Converts a number in units of px to a number in units of lpx. 5232 * 5233 * @param { number } value 5234 * @returns { number } 5235 * @syscap SystemCapability.ArkUI.ArkUI.Full 5236 * @crossplatform 5237 * @form 5238 * @atomicservice 5239 * @since 11 5240 */ 5241declare function px2lpx(value: number): number; 5242 5243/** 5244 * Defines the namespace of focus controller. 5245 * 5246 * @namespace focusControl 5247 * @syscap SystemCapability.ArkUI.ArkUI.Full 5248 * @crossplatform 5249 * @form 5250 * @since 9 5251 */ 5252/** 5253 * Defines the namespace of focus controller. 5254 * 5255 * @namespace focusControl 5256 * @syscap SystemCapability.ArkUI.ArkUI.Full 5257 * @crossplatform 5258 * @form 5259 * @atomicservice 5260 * @since 11 5261 */ 5262declare namespace focusControl { 5263 /** 5264 * Request focus to the specific component by param: 'id/key'. 5265 * 5266 * @param { string } value 5267 * @returns { boolean } 5268 * @syscap SystemCapability.ArkUI.ArkUI.Full 5269 * @since 9 5270 */ 5271 /** 5272 * Request focus to the specific component by param: 'id/key'. 5273 * 5274 * @param { string } value 5275 * @returns { boolean } 5276 * @syscap SystemCapability.ArkUI.ArkUI.Full 5277 * @crossplatform 5278 * @since 10 5279 */ 5280 /** 5281 * Request focus to the specific component by param: 'id/key'. 5282 * 5283 * @param { string } value 5284 * @returns { boolean } 5285 * @syscap SystemCapability.ArkUI.ArkUI.Full 5286 * @crossplatform 5287 * @atomicservice 5288 * @since 11 5289 */ 5290 function requestFocus(value: string): boolean; 5291} 5292 5293/** 5294 * Import the PointerStyle type object for setCursor. 5295 * 5296 * @typedef { import('../api/@ohos.multimodalInput.pointer').default.PointerStyle } PointerStyle 5297 * @syscap SystemCapability.ArkUI.ArkUI.Full 5298 * @since 11 5299 */ 5300/** 5301 * Import the PointerStyle type object for setCursor. 5302 * 5303 * @typedef { import('../api/@ohos.multimodalInput.pointer').default.PointerStyle } PointerStyle 5304 * @syscap SystemCapability.ArkUI.ArkUI.Full 5305 * @atomicservice 5306 * @since 12 5307 */ 5308declare type PointerStyle = import('../api/@ohos.multimodalInput.pointer').default.PointerStyle; 5309 5310/** 5311 * CursorControl 5312 * 5313 * @namespace cursorControl 5314 * @syscap SystemCapability.ArkUI.ArkUI.Full 5315 * @since 11 5316 */ 5317/** 5318 * CursorControl 5319 * 5320 * @namespace cursorControl 5321 * @syscap SystemCapability.ArkUI.ArkUI.Full 5322 * @atomicservice 5323 * @since 12 5324 */ 5325declare namespace cursorControl { 5326 5327 /** 5328 * Change the mouse cursor style by param: 'PointerStyle'. 5329 * 5330 * @param { PointerStyle } value 5331 * @syscap SystemCapability.ArkUI.ArkUI.Full 5332 * @crossplatform 5333 * @since 11 5334 */ 5335 /** 5336 * Change the mouse cursor style by param: 'PointerStyle'. 5337 * 5338 * @param { PointerStyle } value 5339 * @syscap SystemCapability.ArkUI.ArkUI.Full 5340 * @crossplatform 5341 * @atomicservice 5342 * @since 12 5343 */ 5344 function setCursor(value: PointerStyle): void; 5345 5346 /** 5347 * Restore the default mouse cursor style. 5348 * 5349 * @syscap SystemCapability.ArkUI.ArkUI.Full 5350 * @crossplatform 5351 * @since 11 5352 */ 5353 /** 5354 * Restore the default mouse cursor style. 5355 * 5356 * @syscap SystemCapability.ArkUI.ArkUI.Full 5357 * @crossplatform 5358 * @atomicservice 5359 * @since 12 5360 */ 5361 function restoreDefault(): void; 5362} 5363 5364/** 5365 * Defines the event target. 5366 * 5367 * @interface EventTarget 5368 * @syscap SystemCapability.ArkUI.ArkUI.Full 5369 * @since 8 5370 */ 5371/** 5372 * Defines the event target. 5373 * 5374 * @interface EventTarget 5375 * @syscap SystemCapability.ArkUI.ArkUI.Full 5376 * @form 5377 * @since 9 5378 */ 5379/** 5380 * Defines the event target. 5381 * 5382 * @interface EventTarget 5383 * @syscap SystemCapability.ArkUI.ArkUI.Full 5384 * @crossplatform 5385 * @form 5386 * @since 10 5387 */ 5388/** 5389 * Defines the event target. 5390 * 5391 * @interface EventTarget 5392 * @syscap SystemCapability.ArkUI.ArkUI.Full 5393 * @crossplatform 5394 * @form 5395 * @atomicservice 5396 * @since 11 5397 */ 5398declare interface EventTarget { 5399 /** 5400 * Area of current target. 5401 * 5402 * @type { Area } 5403 * @syscap SystemCapability.ArkUI.ArkUI.Full 5404 * @since 8 5405 */ 5406 /** 5407 * Area of current target. 5408 * 5409 * @type { Area } 5410 * @syscap SystemCapability.ArkUI.ArkUI.Full 5411 * @form 5412 * @since 9 5413 */ 5414 /** 5415 * Area of current target. 5416 * 5417 * @type { Area } 5418 * @syscap SystemCapability.ArkUI.ArkUI.Full 5419 * @crossplatform 5420 * @form 5421 * @since 10 5422 */ 5423 /** 5424 * Area of current target. 5425 * 5426 * @type { Area } 5427 * @syscap SystemCapability.ArkUI.ArkUI.Full 5428 * @crossplatform 5429 * @form 5430 * @atomicservice 5431 * @since 11 5432 */ 5433 area: Area; 5434} 5435 5436/** 5437 * Defines the event source type. 5438 * 5439 * @enum { number } 5440 * @syscap SystemCapability.ArkUI.ArkUI.Full 5441 * @since 8 5442 */ 5443/** 5444 * Defines the event source type. 5445 * 5446 * @enum { number } 5447 * @syscap SystemCapability.ArkUI.ArkUI.Full 5448 * @crossplatform 5449 * @since 10 5450 */ 5451/** 5452 * Defines the event source type. 5453 * 5454 * @enum { number } 5455 * @syscap SystemCapability.ArkUI.ArkUI.Full 5456 * @crossplatform 5457 * @atomicservice 5458 * @since 11 5459 */ 5460declare enum SourceType { 5461 /** 5462 * Unknown type. 5463 * 5464 * @syscap SystemCapability.ArkUI.ArkUI.Full 5465 * @since 8 5466 */ 5467 /** 5468 * Unknown type. 5469 * 5470 * @syscap SystemCapability.ArkUI.ArkUI.Full 5471 * @crossplatform 5472 * @since 10 5473 */ 5474 /** 5475 * Unknown type. 5476 * 5477 * @syscap SystemCapability.ArkUI.ArkUI.Full 5478 * @crossplatform 5479 * @atomicservice 5480 * @since 11 5481 */ 5482 Unknown, 5483 5484 /** 5485 * The mouse type. 5486 * 5487 * @syscap SystemCapability.ArkUI.ArkUI.Full 5488 * @since 8 5489 */ 5490 /** 5491 * The mouse type. 5492 * 5493 * @syscap SystemCapability.ArkUI.ArkUI.Full 5494 * @crossplatform 5495 * @since 10 5496 */ 5497 /** 5498 * The mouse type. 5499 * 5500 * @syscap SystemCapability.ArkUI.ArkUI.Full 5501 * @crossplatform 5502 * @atomicservice 5503 * @since 11 5504 */ 5505 Mouse, 5506 5507 /** 5508 * The touch screen type. 5509 * 5510 * @syscap SystemCapability.ArkUI.ArkUI.Full 5511 * @since 8 5512 */ 5513 /** 5514 * The touch screen type. 5515 * 5516 * @syscap SystemCapability.ArkUI.ArkUI.Full 5517 * @crossplatform 5518 * @since 10 5519 */ 5520 /** 5521 * The touch screen type. 5522 * 5523 * @syscap SystemCapability.ArkUI.ArkUI.Full 5524 * @crossplatform 5525 * @atomicservice 5526 * @since 11 5527 */ 5528 TouchScreen, 5529} 5530 5531/** 5532 * Defines the event tool type. 5533 * 5534 * @enum { number } 5535 * @syscap SystemCapability.ArkUI.ArkUI.Full 5536 * @since 9 5537 */ 5538/** 5539 * Defines the event tool type. 5540 * 5541 * @enum { number } 5542 * @syscap SystemCapability.ArkUI.ArkUI.Full 5543 * @crossplatform 5544 * @since 10 5545 */ 5546/** 5547 * Defines the event tool type. 5548 * 5549 * @enum { number } 5550 * @syscap SystemCapability.ArkUI.ArkUI.Full 5551 * @crossplatform 5552 * @atomicservice 5553 * @since 11 5554 */ 5555declare enum SourceTool { 5556 /** 5557 * Unknown type. 5558 * 5559 * @syscap SystemCapability.ArkUI.ArkUI.Full 5560 * @since 9 5561 */ 5562 /** 5563 * Unknown type. 5564 * 5565 * @syscap SystemCapability.ArkUI.ArkUI.Full 5566 * @crossplatform 5567 * @since 10 5568 */ 5569 /** 5570 * Unknown type. 5571 * 5572 * @syscap SystemCapability.ArkUI.ArkUI.Full 5573 * @crossplatform 5574 * @atomicservice 5575 * @since 11 5576 */ 5577 Unknown, 5578 5579 /** 5580 * The finger type. 5581 * 5582 * @syscap SystemCapability.ArkUI.ArkUI.Full 5583 * @since 9 5584 */ 5585 /** 5586 * The finger type. 5587 * 5588 * @syscap SystemCapability.ArkUI.ArkUI.Full 5589 * @crossplatform 5590 * @since 10 5591 */ 5592 /** 5593 * The finger type. 5594 * 5595 * @syscap SystemCapability.ArkUI.ArkUI.Full 5596 * @crossplatform 5597 * @atomicservice 5598 * @since 11 5599 */ 5600 Finger, 5601 5602 /** 5603 * The pen type. 5604 * 5605 * @syscap SystemCapability.ArkUI.ArkUI.Full 5606 * @since 9 5607 */ 5608 /** 5609 * The pen type. 5610 * 5611 * @syscap SystemCapability.ArkUI.ArkUI.Full 5612 * @crossplatform 5613 * @since 10 5614 */ 5615 /** 5616 * The pen type. 5617 * 5618 * @syscap SystemCapability.ArkUI.ArkUI.Full 5619 * @crossplatform 5620 * @atomicservice 5621 * @since 11 5622 */ 5623 Pen, 5624 5625 /** 5626 * The mouse type. 5627 * 5628 * @syscap SystemCapability.ArkUI.ArkUI.Full 5629 * @crossplatform 5630 * @atomicservice 5631 * @since 12 5632 */ 5633 MOUSE, 5634 5635 /** 5636 * The touchpad type. 5637 * 5638 * @syscap SystemCapability.ArkUI.ArkUI.Full 5639 * @crossplatform 5640 * @atomicservice 5641 * @since 12 5642 */ 5643 TOUCHPAD, 5644 5645 /** 5646 * The joystick type. 5647 * 5648 * @syscap SystemCapability.ArkUI.ArkUI.Full 5649 * @crossplatform 5650 * @atomicservice 5651 * @since 12 5652 */ 5653 JOYSTICK, 5654} 5655 5656/** 5657 * Defines the Border Image Repeat Mode. 5658 * 5659 * @enum { number } 5660 * @syscap SystemCapability.ArkUI.ArkUI.Full 5661 * @form 5662 * @since 9 5663 */ 5664/** 5665 * Defines the Border Image Repeat Mode. 5666 * 5667 * @enum { number } 5668 * @syscap SystemCapability.ArkUI.ArkUI.Full 5669 * @crossplatform 5670 * @form 5671 * @since 10 5672 */ 5673/** 5674 * Defines the Border Image Repeat Mode. 5675 * 5676 * @enum { number } 5677 * @syscap SystemCapability.ArkUI.ArkUI.Full 5678 * @crossplatform 5679 * @form 5680 * @atomicservice 5681 * @since 11 5682 */ 5683declare enum RepeatMode { 5684 /** 5685 * Repeat mode. 5686 * 5687 * @syscap SystemCapability.ArkUI.ArkUI.Full 5688 * @form 5689 * @since 9 5690 */ 5691 /** 5692 * Repeat mode. 5693 * 5694 * @syscap SystemCapability.ArkUI.ArkUI.Full 5695 * @crossplatform 5696 * @form 5697 * @since 10 5698 */ 5699 /** 5700 * Repeat mode. 5701 * 5702 * @syscap SystemCapability.ArkUI.ArkUI.Full 5703 * @crossplatform 5704 * @form 5705 * @atomicservice 5706 * @since 11 5707 */ 5708 Repeat, 5709 5710 /** 5711 * Stretch mode. 5712 * 5713 * @syscap SystemCapability.ArkUI.ArkUI.Full 5714 * @form 5715 * @since 9 5716 */ 5717 /** 5718 * Stretch mode. 5719 * 5720 * @syscap SystemCapability.ArkUI.ArkUI.Full 5721 * @crossplatform 5722 * @form 5723 * @since 10 5724 */ 5725 /** 5726 * Stretch mode. 5727 * 5728 * @syscap SystemCapability.ArkUI.ArkUI.Full 5729 * @crossplatform 5730 * @form 5731 * @atomicservice 5732 * @since 11 5733 */ 5734 Stretch, 5735 5736 /** 5737 * Round mode. 5738 * 5739 * @syscap SystemCapability.ArkUI.ArkUI.Full 5740 * @form 5741 * @since 9 5742 */ 5743 /** 5744 * Round mode. 5745 * 5746 * @syscap SystemCapability.ArkUI.ArkUI.Full 5747 * @crossplatform 5748 * @form 5749 * @since 10 5750 */ 5751 /** 5752 * Round mode. 5753 * 5754 * @syscap SystemCapability.ArkUI.ArkUI.Full 5755 * @crossplatform 5756 * @form 5757 * @atomicservice 5758 * @since 11 5759 */ 5760 Round, 5761 5762 /** 5763 * Space mode. 5764 * 5765 * @syscap SystemCapability.ArkUI.ArkUI.Full 5766 * @form 5767 * @since 9 5768 */ 5769 /** 5770 * Space mode. 5771 * 5772 * @syscap SystemCapability.ArkUI.ArkUI.Full 5773 * @crossplatform 5774 * @form 5775 * @since 10 5776 */ 5777 /** 5778 * Space mode. 5779 * 5780 * @syscap SystemCapability.ArkUI.ArkUI.Full 5781 * @crossplatform 5782 * @form 5783 * @atomicservice 5784 * @since 11 5785 */ 5786 Space, 5787} 5788 5789/** 5790 * enum Blur style 5791 * 5792 * @enum { number } 5793 * @syscap SystemCapability.ArkUI.ArkUI.Full 5794 * @form 5795 * @since 9 5796 */ 5797/** 5798 * enum Blur style 5799 * 5800 * @enum { number } 5801 * @syscap SystemCapability.ArkUI.ArkUI.Full 5802 * @crossplatform 5803 * @form 5804 * @since 10 5805 */ 5806/** 5807 * enum Blur style 5808 * 5809 * @enum { number } 5810 * @syscap SystemCapability.ArkUI.ArkUI.Full 5811 * @crossplatform 5812 * @form 5813 * @atomicservice 5814 * @since 11 5815 */ 5816declare enum BlurStyle { 5817 /** 5818 * Defines the thin card material. 5819 * 5820 * @syscap SystemCapability.ArkUI.ArkUI.Full 5821 * @form 5822 * @since 9 5823 */ 5824 /** 5825 * Defines the thin card material. 5826 * 5827 * @syscap SystemCapability.ArkUI.ArkUI.Full 5828 * @crossplatform 5829 * @form 5830 * @since 10 5831 */ 5832 /** 5833 * Defines the thin card material. 5834 * 5835 * @syscap SystemCapability.ArkUI.ArkUI.Full 5836 * @crossplatform 5837 * @form 5838 * @atomicservice 5839 * @since 11 5840 */ 5841 Thin, 5842 5843 /** 5844 * Defines the regular card material. 5845 * 5846 * @syscap SystemCapability.ArkUI.ArkUI.Full 5847 * @form 5848 * @since 9 5849 */ 5850 /** 5851 * Defines the regular card material. 5852 * 5853 * @syscap SystemCapability.ArkUI.ArkUI.Full 5854 * @crossplatform 5855 * @form 5856 * @since 10 5857 */ 5858 /** 5859 * Defines the regular card material. 5860 * 5861 * @syscap SystemCapability.ArkUI.ArkUI.Full 5862 * @crossplatform 5863 * @form 5864 * @atomicservice 5865 * @since 11 5866 */ 5867 Regular, 5868 5869 /** 5870 * Defines the thick card material. 5871 * 5872 * @syscap SystemCapability.ArkUI.ArkUI.Full 5873 * @form 5874 * @since 9 5875 */ 5876 /** 5877 * Defines the thick card material. 5878 * 5879 * @syscap SystemCapability.ArkUI.ArkUI.Full 5880 * @crossplatform 5881 * @form 5882 * @since 10 5883 */ 5884 /** 5885 * Defines the thick card material. 5886 * 5887 * @syscap SystemCapability.ArkUI.ArkUI.Full 5888 * @crossplatform 5889 * @form 5890 * @atomicservice 5891 * @since 11 5892 */ 5893 Thick, 5894 5895 /** 5896 * Defines the thin background material. 5897 * 5898 * @syscap SystemCapability.ArkUI.ArkUI.Full 5899 * @crossplatform 5900 * @since 10 5901 */ 5902 /** 5903 * Defines the thin background material. 5904 * 5905 * @syscap SystemCapability.ArkUI.ArkUI.Full 5906 * @crossplatform 5907 * @form 5908 * @atomicservice 5909 * @since 11 5910 */ 5911 BACKGROUND_THIN, 5912 5913 /** 5914 * Defines the thin regular material. 5915 * 5916 * @syscap SystemCapability.ArkUI.ArkUI.Full 5917 * @crossplatform 5918 * @since 10 5919 */ 5920 /** 5921 * Defines the thin regular material. 5922 * 5923 * @syscap SystemCapability.ArkUI.ArkUI.Full 5924 * @crossplatform 5925 * @form 5926 * @atomicservice 5927 * @since 11 5928 */ 5929 BACKGROUND_REGULAR, 5930 5931 /** 5932 * Defines the thin thick material. 5933 * 5934 * @syscap SystemCapability.ArkUI.ArkUI.Full 5935 * @crossplatform 5936 * @since 10 5937 */ 5938 /** 5939 * Defines the thin thick material. 5940 * 5941 * @syscap SystemCapability.ArkUI.ArkUI.Full 5942 * @crossplatform 5943 * @form 5944 * @atomicservice 5945 * @since 11 5946 */ 5947 BACKGROUND_THICK, 5948 5949 /** 5950 * Defines the thin ultra thick material. 5951 * 5952 * @syscap SystemCapability.ArkUI.ArkUI.Full 5953 * @crossplatform 5954 * @since 10 5955 */ 5956 /** 5957 * Defines the thin ultra thick material. 5958 * 5959 * @syscap SystemCapability.ArkUI.ArkUI.Full 5960 * @crossplatform 5961 * @form 5962 * @atomicservice 5963 * @since 11 5964 */ 5965 BACKGROUND_ULTRA_THICK, 5966 5967 /** 5968 * Defines none material. 5969 * 5970 * @syscap SystemCapability.ArkUI.ArkUI.Full 5971 * @crossplatform 5972 * @form 5973 * @since 10 5974 */ 5975 /** 5976 * Defines none material. 5977 * 5978 * @syscap SystemCapability.ArkUI.ArkUI.Full 5979 * @crossplatform 5980 * @form 5981 * @atomicservice 5982 * @since 11 5983 */ 5984 NONE, 5985 5986 /** 5987 * Defines the ultra thin component material. 5988 * 5989 * @syscap SystemCapability.ArkUI.ArkUI.Full 5990 * @crossplatform 5991 * @form 5992 * @since 11 5993 */ 5994 /** 5995 * Defines the ultra thin component material. 5996 * 5997 * @syscap SystemCapability.ArkUI.ArkUI.Full 5998 * @crossplatform 5999 * @form 6000 * @atomicservice 6001 * @since 12 6002 */ 6003 COMPONENT_ULTRA_THIN = 8, 6004 6005 /** 6006 * Defines the thin component material. 6007 * 6008 * @syscap SystemCapability.ArkUI.ArkUI.Full 6009 * @crossplatform 6010 * @form 6011 * @since 11 6012 */ 6013 /** 6014 * Defines the thin component material. 6015 * 6016 * @syscap SystemCapability.ArkUI.ArkUI.Full 6017 * @crossplatform 6018 * @form 6019 * @atomicservice 6020 * @since 12 6021 */ 6022 COMPONENT_THIN = 9, 6023 6024 /** 6025 * Defines the regular component material. 6026 * 6027 * @syscap SystemCapability.ArkUI.ArkUI.Full 6028 * @crossplatform 6029 * @form 6030 * @since 11 6031 */ 6032 /** 6033 * Defines the regular component material. 6034 * 6035 * @syscap SystemCapability.ArkUI.ArkUI.Full 6036 * @crossplatform 6037 * @form 6038 * @atomicservice 6039 * @since 12 6040 */ 6041 COMPONENT_REGULAR = 10, 6042 6043 /** 6044 * Defines the thick component material. 6045 * 6046 * @syscap SystemCapability.ArkUI.ArkUI.Full 6047 * @crossplatform 6048 * @form 6049 * @since 11 6050 */ 6051 /** 6052 * Defines the thick component material. 6053 * 6054 * @syscap SystemCapability.ArkUI.ArkUI.Full 6055 * @crossplatform 6056 * @form 6057 * @atomicservice 6058 * @since 12 6059 */ 6060 COMPONENT_THICK = 11, 6061 6062 /** 6063 * Defines the ultra thick component material. 6064 * 6065 * @syscap SystemCapability.ArkUI.ArkUI.Full 6066 * @crossplatform 6067 * @form 6068 * @since 11 6069 */ 6070 /** 6071 * Defines the ultra thick component material. 6072 * 6073 * @syscap SystemCapability.ArkUI.ArkUI.Full 6074 * @crossplatform 6075 * @form 6076 * @atomicservice 6077 * @since 12 6078 */ 6079 COMPONENT_ULTRA_THICK = 12, 6080} 6081 6082/** 6083 * Enumerates the policies for activating the blur style. 6084 * 6085 * @enum { number } 6086 * @syscap SystemCapability.ArkUI.ArkUI.Full 6087 * @crossplatform 6088 * @atomicservice 6089 * @since 13 6090 */ 6091declare enum BlurStyleActivePolicy { 6092 /** 6093 * The component has the blur effect only when the window is focused. 6094 * 6095 * @syscap SystemCapability.ArkUI.ArkUI.Full 6096 * @crossplatform 6097 * @atomicservice 6098 * @since 13 6099 */ 6100 FOLLOWS_WINDOW_ACTIVE_STATE = 0, 6101 6102 /** 6103 * The component always has the blur effect, regardless of whether the window is focused. 6104 * 6105 * @syscap SystemCapability.ArkUI.ArkUI.Full 6106 * @crossplatform 6107 * @atomicservice 6108 * @since 13 6109 */ 6110 ALWAYS_ACTIVE = 1, 6111 6112 /** 6113 * The component does not have the blur effect, regardless of whether the window is focused. 6114 * 6115 * @syscap SystemCapability.ArkUI.ArkUI.Full 6116 * @crossplatform 6117 * @atomicservice 6118 * @since 13 6119 */ 6120 ALWAYS_INACTIVE = 2, 6121} 6122 6123/** 6124 * enum color mode 6125 * 6126 * @enum { number } 6127 * @syscap SystemCapability.ArkUI.ArkUI.Full 6128 * @crossplatform 6129 * @since 10 6130 */ 6131/** 6132 * enum color mode 6133 * 6134 * @enum { number } 6135 * @syscap SystemCapability.ArkUI.ArkUI.Full 6136 * @crossplatform 6137 * @atomicservice 6138 * @since 11 6139 */ 6140declare enum ThemeColorMode { 6141 /** 6142 * Defines the mode which is follow up with system. 6143 * 6144 * @syscap SystemCapability.ArkUI.ArkUI.Full 6145 * @crossplatform 6146 * @since 10 6147 */ 6148 /** 6149 * Defines the mode which is follow up with system. 6150 * 6151 * @syscap SystemCapability.ArkUI.ArkUI.Full 6152 * @crossplatform 6153 * @atomicservice 6154 * @since 11 6155 */ 6156 SYSTEM, 6157 6158 /** 6159 * Defines the light mode. 6160 * 6161 * @syscap SystemCapability.ArkUI.ArkUI.Full 6162 * @crossplatform 6163 * @since 10 6164 */ 6165 /** 6166 * Defines the light mode. 6167 * 6168 * @syscap SystemCapability.ArkUI.ArkUI.Full 6169 * @crossplatform 6170 * @atomicservice 6171 * @since 11 6172 */ 6173 LIGHT, 6174 6175 /** 6176 * Defines the dark mode. 6177 * 6178 * @syscap SystemCapability.ArkUI.ArkUI.Full 6179 * @crossplatform 6180 * @since 10 6181 */ 6182 /** 6183 * Defines the dark mode. 6184 * 6185 * @syscap SystemCapability.ArkUI.ArkUI.Full 6186 * @crossplatform 6187 * @atomicservice 6188 * @since 11 6189 */ 6190 DARK, 6191} 6192 6193/** 6194 * Defines adaptive color 6195 * 6196 * @enum { number } 6197 * @syscap SystemCapability.ArkUI.ArkUI.Full 6198 * @crossplatform 6199 * @since 10 6200 */ 6201/** 6202 * Defines adaptive color 6203 * 6204 * @enum { number } 6205 * @syscap SystemCapability.ArkUI.ArkUI.Full 6206 * @crossplatform 6207 * @atomicservice 6208 * @since 11 6209 */ 6210declare enum AdaptiveColor { 6211 /** 6212 * Defines the fixed value color adaptive mode. 6213 * 6214 * @syscap SystemCapability.ArkUI.ArkUI.Full 6215 * @crossplatform 6216 * @since 10 6217 */ 6218 /** 6219 * Defines the fixed value color adaptive mode. 6220 * 6221 * @syscap SystemCapability.ArkUI.ArkUI.Full 6222 * @crossplatform 6223 * @atomicservice 6224 * @since 11 6225 */ 6226 DEFAULT, 6227 6228 /** 6229 * Defines the background average color adaptive mode. 6230 * 6231 * @syscap SystemCapability.ArkUI.ArkUI.Full 6232 * @crossplatform 6233 * @since 10 6234 */ 6235 /** 6236 * Defines the background average color adaptive mode. 6237 * 6238 * @syscap SystemCapability.ArkUI.ArkUI.Full 6239 * @crossplatform 6240 * @atomicservice 6241 * @since 11 6242 */ 6243 AVERAGE, 6244} 6245 6246/** 6247 * Defines modal transition type. 6248 * 6249 * @enum { number } 6250 * @syscap SystemCapability.ArkUI.ArkUI.Full 6251 * @crossplatform 6252 * @since 10 6253 */ 6254/** 6255 * Defines modal transition type. 6256 * 6257 * @enum { number } 6258 * @syscap SystemCapability.ArkUI.ArkUI.Full 6259 * @crossplatform 6260 * @atomicservice 6261 * @since 11 6262 */ 6263declare enum ModalTransition { 6264 /** 6265 * Use default animation. 6266 * 6267 * @syscap SystemCapability.ArkUI.ArkUI.Full 6268 * @crossplatform 6269 * @since 10 6270 */ 6271 /** 6272 * Use default animation. 6273 * 6274 * @syscap SystemCapability.ArkUI.ArkUI.Full 6275 * @crossplatform 6276 * @atomicservice 6277 * @since 11 6278 */ 6279 DEFAULT, 6280 6281 /** 6282 * Use none animation. 6283 * 6284 * @syscap SystemCapability.ArkUI.ArkUI.Full 6285 * @crossplatform 6286 * @since 10 6287 */ 6288 /** 6289 * Use none animation. 6290 * 6291 * @syscap SystemCapability.ArkUI.ArkUI.Full 6292 * @crossplatform 6293 * @atomicservice 6294 * @since 11 6295 */ 6296 NONE, 6297 6298 /** 6299 * Use alpha animation. 6300 * 6301 * @syscap SystemCapability.ArkUI.ArkUI.Full 6302 * @crossplatform 6303 * @since 10 6304 */ 6305 /** 6306 * Use alpha animation. 6307 * 6308 * @syscap SystemCapability.ArkUI.ArkUI.Full 6309 * @crossplatform 6310 * @atomicservice 6311 * @since 11 6312 */ 6313 ALPHA, 6314} 6315 6316/** 6317 * Defines the options of backgroundBlurStyle 6318 * 6319 * @interface BackgroundBlurStyleOptions 6320 * @syscap SystemCapability.ArkUI.ArkUI.Full 6321 * @crossplatform 6322 * @since 10 6323 */ 6324/** 6325 * Defines the options of backgroundBlurStyle 6326 * 6327 * @interface BackgroundBlurStyleOptions 6328 * @syscap SystemCapability.ArkUI.ArkUI.Full 6329 * @crossplatform 6330 * @atomicservice 6331 * @since 11 6332 */ 6333declare interface BackgroundBlurStyleOptions extends BlurStyleOptions { 6334 /** 6335 * Defines the policy for activating the blur style. 6336 * 6337 * @type { ?BlurStyleActivePolicy } 6338 * @default BlurStyleActivePolicy.ALWAYS_ACTIVE 6339 * @syscap SystemCapability.ArkUI.ArkUI.Full 6340 * @crossplatform 6341 * @atomicservice 6342 * @since 13 6343 */ 6344 policy?: BlurStyleActivePolicy; 6345 6346 /** 6347 * Color of the background effect when the window is not focused. 6348 * 6349 * @type { ?ResourceColor } 6350 * @default Color.Transparent 6351 * @syscap SystemCapability.ArkUI.ArkUI.Full 6352 * @crossplatform 6353 * @atomicservice 6354 * @since 13 6355 */ 6356 inactiveColor?: ResourceColor; 6357} 6358 6359/** 6360 * Defines the options of ForegroundBlurStyle 6361 * 6362 * @interface ForegroundBlurStyleOptions 6363 * @syscap SystemCapability.ArkUI.ArkUI.Full 6364 * @crossplatform 6365 * @since 10 6366 */ 6367/** 6368 * Defines the options of ForegroundBlurStyle 6369 * 6370 * @interface ForegroundBlurStyleOptions 6371 * @syscap SystemCapability.ArkUI.ArkUI.Full 6372 * @crossplatform 6373 * @atomicservice 6374 * @since 11 6375 */ 6376declare interface ForegroundBlurStyleOptions extends BlurStyleOptions {} 6377 6378 6379/** 6380 * Defines the options of blur 6381 * 6382 * @interface BlurOptions 6383 * @syscap SystemCapability.ArkUI.ArkUI.Full 6384 * @crossplatform 6385 * @since 11 6386 */ 6387/** 6388 * Defines the options of blur 6389 * 6390 * @interface BlurOptions 6391 * @syscap SystemCapability.ArkUI.ArkUI.Full 6392 * @crossplatform 6393 * @atomicservice 6394 * @since 12 6395 */ 6396declare interface BlurOptions { 6397 /** 6398 * Fuzzy gray scale parameter. 6399 * @type { [number, number] } 6400 * @syscap SystemCapability.ArkUI.ArkUI.Full 6401 * @crossplatform 6402 * @since 11 6403 */ 6404 /** 6405 * Fuzzy gray scale parameter. 6406 * @type { [number, number] } 6407 * @syscap SystemCapability.ArkUI.ArkUI.Full 6408 * @crossplatform 6409 * @atomicservice 6410 * @since 12 6411 */ 6412 grayscale: [number, number]; 6413} 6414 6415/** 6416 * Defines the options of blurStyle 6417 * 6418 * @interface BlurStyleOptions 6419 * @syscap SystemCapability.ArkUI.ArkUI.Full 6420 * @crossplatform 6421 * @since 10 6422 */ 6423/** 6424 * Defines the options of blurStyle 6425 * 6426 * @interface BlurStyleOptions 6427 * @syscap SystemCapability.ArkUI.ArkUI.Full 6428 * @crossplatform 6429 * @atomicservice 6430 * @since 11 6431 */ 6432declare interface BlurStyleOptions { 6433 /** 6434 * color mode 6435 * 6436 * @type { ?ThemeColorMode } 6437 * @default ThemeColorMode.SYSTEM 6438 * @syscap SystemCapability.ArkUI.ArkUI.Full 6439 * @since 10 6440 */ 6441 /** 6442 * color mode 6443 * 6444 * @type { ?ThemeColorMode } 6445 * @default ThemeColorMode.SYSTEM 6446 * @syscap SystemCapability.ArkUI.ArkUI.Full 6447 * @crossplatform 6448 * @atomicservice 6449 * @since 11 6450 */ 6451 colorMode?: ThemeColorMode; 6452 6453 /** 6454 * adaptive color 6455 * 6456 * @type { ?AdaptiveColor } 6457 * @default AdaptiveColor.DEFAULT 6458 * @syscap SystemCapability.ArkUI.ArkUI.Full 6459 * @since 10 6460 */ 6461 /** 6462 * adaptive color 6463 * 6464 * @type { ?AdaptiveColor } 6465 * @default AdaptiveColor.DEFAULT 6466 * @syscap SystemCapability.ArkUI.ArkUI.Full 6467 * @crossplatform 6468 * @atomicservice 6469 * @since 11 6470 */ 6471 adaptiveColor?: AdaptiveColor; 6472 6473 /** 6474 * Define the scale of blur effect. 6475 * The range of value is [0, 1]. The larger the value, the more obvious the blurring effect. 6476 * A value of 0 indicates no blur effect and a value of 1 indicates a complete blur effect. 6477 * 6478 * @type { ?number } 6479 * @default 1.0 6480 * @syscap SystemCapability.ArkUI.ArkUI.Full 6481 * @atomicservice 6482 * @since 12 6483 */ 6484 scale?: number; 6485 6486 /** 6487 * Defines the options of blur 6488 * 6489 * @type { ?BlurOptions } 6490 * @default { grayScale: [0,0] } 6491 * @syscap SystemCapability.ArkUI.ArkUI.Full 6492 * @crossplatform 6493 * @since 11 6494 */ 6495 /** 6496 * Defines the options of blur 6497 * 6498 * @type { ?BlurOptions } 6499 * @default { grayScale: [0,0] } 6500 * @syscap SystemCapability.ArkUI.ArkUI.Full 6501 * @crossplatform 6502 * @atomicservice 6503 * @since 12 6504 */ 6505 blurOptions?: BlurOptions; 6506} 6507 6508/** 6509 * Defines the options of BackgroundEffect 6510 * 6511 * @interface BackgroundEffectOptions 6512 * @syscap SystemCapability.ArkUI.ArkUI.Full 6513 * @crossplatform 6514 * @since 11 6515 */ 6516/** 6517 * Defines the options of BackgroundEffect 6518 * 6519 * @interface BackgroundEffectOptions 6520 * @syscap SystemCapability.ArkUI.ArkUI.Full 6521 * @crossplatform 6522 * @atomicservice 6523 * @since 12 6524 */ 6525declare interface BackgroundEffectOptions { 6526 6527 /** 6528 * Define the radius size of BackgroundEffect.The range of this value is [0, ∞) 6529 * 6530 * @type { number } 6531 * @syscap SystemCapability.ArkUI.ArkUI.Full 6532 * @crossplatform 6533 * @since 11 6534 */ 6535 /** 6536 * Define the radius size of BackgroundEffect.The range of this value is [0, ∞) 6537 * 6538 * @type { number } 6539 * @syscap SystemCapability.ArkUI.ArkUI.Full 6540 * @crossplatform 6541 * @atomicservice 6542 * @since 12 6543 */ 6544 radius: number; 6545 6546 /** 6547 * Define the saturation of BackgroundEffect. Value range [0, ∞) 6548 * 6549 * @type { ?number } 6550 * @default 1 6551 * @syscap SystemCapability.ArkUI.ArkUI.Full 6552 * @crossplatform 6553 * @since 11 6554 */ 6555 /** 6556 * Define the saturation of BackgroundEffect. Value range [0, ∞) 6557 * 6558 * @type { ?number } 6559 * @default 1 6560 * @syscap SystemCapability.ArkUI.ArkUI.Full 6561 * @crossplatform 6562 * @atomicservice 6563 * @since 12 6564 */ 6565 saturation?: number; 6566 6567 /** 6568 * Define the brightness of BackgroundEffect. Value range [0, ∞) 6569 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 6570 * @type { ?number } 6571 * @default 1 6572 * @syscap SystemCapability.ArkUI.ArkUI.Full 6573 * @crossplatform 6574 * @since 11 6575 */ 6576 /** 6577 * Define the brightness of BackgroundEffect. Value range [0, ∞) 6578 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 6579 * @type { ?number } 6580 * @default 1 6581 * @syscap SystemCapability.ArkUI.ArkUI.Full 6582 * @crossplatform 6583 * @atomicservice 6584 * @since 12 6585 */ 6586 brightness?: number; 6587 6588 /** 6589 * color the brightness of BackgroundEffect. 6590 * 6591 * @type { ?ResourceColor } 6592 * @default Color.Transparent 6593 * @syscap SystemCapability.ArkUI.ArkUI.Full 6594 * @crossplatform 6595 * @since 11 6596 */ 6597 /** 6598 * color the brightness of BackgroundEffect. 6599 * 6600 * @type { ?ResourceColor } 6601 * @default Color.Transparent 6602 * @syscap SystemCapability.ArkUI.ArkUI.Full 6603 * @crossplatform 6604 * @atomicservice 6605 * @since 12 6606 */ 6607 color?: ResourceColor; 6608 6609 /** 6610 * Define the adaptiveColor of BackgroundEffect. 6611 * 6612 * @type { ?AdaptiveColor } 6613 * @default AdaptiveColor.DEFAULT 6614 * @syscap SystemCapability.ArkUI.ArkUI.Full 6615 * @crossplatform 6616 * @since 11 6617 */ 6618 /** 6619 * Define the adaptiveColor of BackgroundEffect. 6620 * 6621 * @type { ?AdaptiveColor } 6622 * @default AdaptiveColor.DEFAULT 6623 * @syscap SystemCapability.ArkUI.ArkUI.Full 6624 * @crossplatform 6625 * @atomicservice 6626 * @since 12 6627 */ 6628 adaptiveColor?: AdaptiveColor; 6629 6630 /** 6631 * Define the blurOptions of BackgroundEffect. 6632 * 6633 * @type { ?BlurOptions } 6634 * @default { grayScale: [0,1] } 6635 * @syscap SystemCapability.ArkUI.ArkUI.Full 6636 * @crossplatform 6637 * @since 11 6638 */ 6639 /** 6640 * Define the blurOptions of BackgroundEffect. 6641 * 6642 * @type { ?BlurOptions } 6643 * @default { grayScale: [0,0] } 6644 * @syscap SystemCapability.ArkUI.ArkUI.Full 6645 * @crossplatform 6646 * @atomicservice 6647 * @since 12 6648 */ 6649 blurOptions?: BlurOptions; 6650 6651 /** 6652 * Defines the policy for activating the blur style. 6653 * 6654 * @type { ?BlurStyleActivePolicy } 6655 * @default BlurStyleActivePolicy.ALWAYS_ACTIVE 6656 * @syscap SystemCapability.ArkUI.ArkUI.Full 6657 * @crossplatform 6658 * @atomicservice 6659 * @since 13 6660 */ 6661 policy?: BlurStyleActivePolicy; 6662 6663 /** 6664 * Color of the background effect when the window is not focused. 6665 * 6666 * @type { ?ResourceColor } 6667 * @default Color.Transparent 6668 * @syscap SystemCapability.ArkUI.ArkUI.Full 6669 * @crossplatform 6670 * @atomicservice 6671 * @since 13 6672 */ 6673 inactiveColor?: ResourceColor; 6674} 6675 6676/** 6677 * Defines the options of ForegroundEffect 6678 * 6679 * @interface ForegroundEffectOptions 6680 * @syscap SystemCapability.ArkUI.ArkUI.Full 6681 * @crossplatform 6682 * @atomicservice 6683 * @since 12 6684 */ 6685declare interface ForegroundEffectOptions { 6686 6687 /** 6688 * Define the radius size of ForegroundEffect.The range of this value is [0, ∞) 6689 * 6690 * @type { number } 6691 * @syscap SystemCapability.ArkUI.ArkUI.Full 6692 * @crossplatform 6693 * @atomicservice 6694 * @since 12 6695 */ 6696 radius: number; 6697} 6698 6699/** 6700 * Provide an interface for the text style of picker 6701 * 6702 * @interface PickerTextStyle 6703 * @syscap SystemCapability.ArkUI.ArkUI.Full 6704 * @crossplatform 6705 * @since 10 6706 */ 6707/** 6708 * Provide an interface for the text style of picker 6709 * 6710 * @interface PickerTextStyle 6711 * @syscap SystemCapability.ArkUI.ArkUI.Full 6712 * @crossplatform 6713 * @atomicservice 6714 * @since 11 6715 */ 6716declare interface PickerTextStyle { 6717 /** 6718 * Define the text color of picker. 6719 * 6720 * @type { ?ResourceColor } 6721 * @syscap SystemCapability.ArkUI.ArkUI.Full 6722 * @crossplatform 6723 * @since 10 6724 */ 6725 /** 6726 * Define the text color of picker. 6727 * 6728 * @type { ?ResourceColor } 6729 * @syscap SystemCapability.ArkUI.ArkUI.Full 6730 * @crossplatform 6731 * @atomicservice 6732 * @since 11 6733 */ 6734 color?: ResourceColor; 6735 6736 /** 6737 * Define the text font of picker. 6738 * Only support size and weight. 6739 * 6740 * @type { ?Font } 6741 * @syscap SystemCapability.ArkUI.ArkUI.Full 6742 * @crossplatform 6743 * @since 10 6744 */ 6745 /** 6746 * Define the text font of picker. 6747 * Only support size and weight. 6748 * 6749 * @type { ?Font } 6750 * @syscap SystemCapability.ArkUI.ArkUI.Full 6751 * @crossplatform 6752 * @atomicservice 6753 * @since 11 6754 */ 6755 font?: Font; 6756} 6757 6758/** 6759 * Provide an interface for the button style of picker 6760 * 6761 * @interface PickerDialogButtonStyle 6762 * @syscap SystemCapability.ArkUI.ArkUI.Full 6763 * @crossplatform 6764 * @atomicservice 6765 * @since 12 6766 */ 6767declare interface PickerDialogButtonStyle { 6768 /** 6769 * Describes the button style. 6770 * 6771 * @type { ?ButtonType } 6772 * @syscap SystemCapability.ArkUI.ArkUI.Full 6773 * @crossplatform 6774 * @atomicservice 6775 * @since 12 6776 */ 6777 type?: ButtonType; 6778 6779 /** 6780 * Describes the button style. 6781 * 6782 * @type { ?ButtonStyleMode } 6783 * @syscap SystemCapability.ArkUI.ArkUI.Full 6784 * @crossplatform 6785 * @atomicservice 6786 * @since 12 6787 */ 6788 style?: ButtonStyleMode; 6789 6790 /** 6791 * Describes the button role. 6792 * 6793 * @type { ?ButtonRole } 6794 * @syscap SystemCapability.ArkUI.ArkUI.Full 6795 * @crossplatform 6796 * @atomicservice 6797 * @since 12 6798 */ 6799 role?: ButtonRole; 6800 6801 /** 6802 * Describes the button text size. 6803 * 6804 * @type { ?Length } 6805 * @syscap SystemCapability.ArkUI.ArkUI.Full 6806 * @crossplatform 6807 * @atomicservice 6808 * @since 12 6809 */ 6810 fontSize?: Length; 6811 6812 /** 6813 * Describes the button text color. 6814 * 6815 * @type { ?ResourceColor } 6816 * @syscap SystemCapability.ArkUI.ArkUI.Full 6817 * @crossplatform 6818 * @atomicservice 6819 * @since 12 6820 */ 6821 fontColor?: ResourceColor; 6822 6823 /** 6824 * Describes the button font weight. 6825 * 6826 * @type { ?(FontWeight | number | string) } 6827 * @syscap SystemCapability.ArkUI.ArkUI.Full 6828 * @crossplatform 6829 * @atomicservice 6830 * @since 12 6831 */ 6832 fontWeight?: FontWeight | number | string; 6833 6834 /** 6835 * Describes the button font style. 6836 * 6837 * @type { ?FontStyle } 6838 * @syscap SystemCapability.ArkUI.ArkUI.Full 6839 * @crossplatform 6840 * @atomicservice 6841 * @since 12 6842 */ 6843 fontStyle?: FontStyle; 6844 6845 /** 6846 * Describes the button font family. 6847 * 6848 * @type { ?(Resource | string) } 6849 * @syscap SystemCapability.ArkUI.ArkUI.Full 6850 * @crossplatform 6851 * @atomicservice 6852 * @since 12 6853 */ 6854 fontFamily?: Resource | string; 6855 6856 /** 6857 * Describes the button background color. 6858 * 6859 * @type { ?ResourceColor } 6860 * @syscap SystemCapability.ArkUI.ArkUI.Full 6861 * @crossplatform 6862 * @atomicservice 6863 * @since 12 6864 */ 6865 backgroundColor?: ResourceColor; 6866 6867 /** 6868 * Describes the button border radius. 6869 * 6870 * @type { ?(Length | BorderRadiuses) } 6871 * @syscap SystemCapability.ArkUI.ArkUI.Full 6872 * @crossplatform 6873 * @atomicservice 6874 * @since 12 6875 */ 6876 borderRadius?: Length | BorderRadiuses; 6877 6878 /** 6879 * Define whether the button default to responding to the Enter key 6880 * 6881 * @type { ?boolean } 6882 * @syscap SystemCapability.ArkUI.ArkUI.Full 6883 * @crossplatform 6884 * @atomicservice 6885 * @since 12 6886 */ 6887 primary?: boolean; 6888} 6889 6890/** 6891 * Define the type of shadow 6892 * 6893 * @enum { number } 6894 * @syscap SystemCapability.ArkUI.ArkUI.Full 6895 * @crossplatform 6896 * @since 10 6897 */ 6898/** 6899 * Define the type of shadow 6900 * 6901 * @enum { number } 6902 * @syscap SystemCapability.ArkUI.ArkUI.Full 6903 * @crossplatform 6904 * @atomicservice 6905 * @since 11 6906 */ 6907declare enum ShadowType { 6908 /** 6909 * Define a color type of shadow 6910 * 6911 * @syscap SystemCapability.ArkUI.ArkUI.Full 6912 * @crossplatform 6913 * @since 10 6914 */ 6915 /** 6916 * Define a color type of shadow 6917 * 6918 * @syscap SystemCapability.ArkUI.ArkUI.Full 6919 * @crossplatform 6920 * @atomicservice 6921 * @since 11 6922 */ 6923 COLOR, 6924 6925 /** 6926 * Define a blur type of shadow 6927 * 6928 * @syscap SystemCapability.ArkUI.ArkUI.Full 6929 * @crossplatform 6930 * @since 10 6931 */ 6932 /** 6933 * Define a blur type of shadow 6934 * 6935 * @syscap SystemCapability.ArkUI.ArkUI.Full 6936 * @crossplatform 6937 * @atomicservice 6938 * @since 11 6939 */ 6940 BLUR, 6941} 6942 6943/** 6944 * Define the options of shadow 6945 * 6946 * @interface ShadowOptions 6947 * @syscap SystemCapability.ArkUI.ArkUI.Full 6948 * @since 7 6949 */ 6950/** 6951 * Define the options of shadow 6952 * 6953 * @interface ShadowOptions 6954 * @syscap SystemCapability.ArkUI.ArkUI.Full 6955 * @form 6956 * @since 9 6957 */ 6958/** 6959 * Define the options of shadow 6960 * 6961 * @interface ShadowOptions 6962 * @syscap SystemCapability.ArkUI.ArkUI.Full 6963 * @crossplatform 6964 * @form 6965 * @since 10 6966 */ 6967/** 6968 * Define the options of shadow 6969 * 6970 * @interface ShadowOptions 6971 * @syscap SystemCapability.ArkUI.ArkUI.Full 6972 * @crossplatform 6973 * @form 6974 * @atomicservice 6975 * @since 11 6976 */ 6977declare interface ShadowOptions { 6978 /** 6979 * Define the radius size of shadow 6980 * 6981 * @type { number | Resource } 6982 * @syscap SystemCapability.ArkUI.ArkUI.Full 6983 * @since 7 6984 */ 6985 /** 6986 * Define the radius size of shadow 6987 * 6988 * @type { number | Resource } 6989 * @syscap SystemCapability.ArkUI.ArkUI.Full 6990 * @form 6991 * @since 9 6992 */ 6993 /** 6994 * Define the radius size of shadow 6995 * 6996 * @type { number | Resource } 6997 * @syscap SystemCapability.ArkUI.ArkUI.Full 6998 * @crossplatform 6999 * @form 7000 * @since 10 7001 */ 7002 /** 7003 * Define the radius size of shadow 7004 * 7005 * @type { number | Resource } 7006 * @syscap SystemCapability.ArkUI.ArkUI.Full 7007 * @crossplatform 7008 * @form 7009 * @atomicservice 7010 * @since 11 7011 */ 7012 radius: number | Resource; 7013 7014 /** 7015 * Define the type of shadow 7016 * 7017 * @type { ?ShadowType } 7018 * @default ShadowType.COLOR 7019 * @syscap SystemCapability.ArkUI.ArkUI.Full 7020 * @crossplatform 7021 * @since 10 7022 */ 7023 /** 7024 * Define the type of shadow 7025 * 7026 * @type { ?ShadowType } 7027 * @default ShadowType.COLOR 7028 * @syscap SystemCapability.ArkUI.ArkUI.Full 7029 * @crossplatform 7030 * @atomicservice 7031 * @since 11 7032 */ 7033 type?: ShadowType; 7034 7035 /** 7036 * Define the color of shadow 7037 * 7038 * @type { ?(Color | string | Resource) } 7039 * @syscap SystemCapability.ArkUI.ArkUI.Full 7040 * @since 7 7041 */ 7042 /** 7043 * Define the color of shadow 7044 * 7045 * @type { ?(Color | string | Resource) } 7046 * @syscap SystemCapability.ArkUI.ArkUI.Full 7047 * @form 7048 * @since 9 7049 */ 7050 /** 7051 * Define the color of shadow 7052 * 7053 * @type { ?(Color | string | Resource) } 7054 * @syscap SystemCapability.ArkUI.ArkUI.Full 7055 * @crossplatform 7056 * @form 7057 * @since 10 7058 */ 7059 /** 7060 * Define the color or the color strategy of shadow 7061 * 7062 * @type { ?(Color | string | Resource| ColoringStrategy) } 7063 * @syscap SystemCapability.ArkUI.ArkUI.Full 7064 * @crossplatform 7065 * @form 7066 * @atomicservice 7067 * @since 11 7068 */ 7069 color?: Color | string | Resource | ColoringStrategy; 7070 7071 /** 7072 * Define the horizontal offset size of shadow 7073 * 7074 * @type { ?(number | Resource) } 7075 * @syscap SystemCapability.ArkUI.ArkUI.Full 7076 * @since 7 7077 */ 7078 /** 7079 * Define the horizontal offset size of shadow 7080 * 7081 * @type { ?(number | Resource) } 7082 * @syscap SystemCapability.ArkUI.ArkUI.Full 7083 * @form 7084 * @since 9 7085 */ 7086 /** 7087 * Define the horizontal offset size of shadow 7088 * 7089 * @type { ?(number | Resource) } 7090 * @syscap SystemCapability.ArkUI.ArkUI.Full 7091 * @crossplatform 7092 * @form 7093 * @since 10 7094 */ 7095 /** 7096 * Define the horizontal offset size of shadow 7097 * 7098 * @type { ?(number | Resource) } 7099 * @syscap SystemCapability.ArkUI.ArkUI.Full 7100 * @crossplatform 7101 * @form 7102 * @atomicservice 7103 * @since 11 7104 */ 7105 offsetX?: number | Resource; 7106 7107 /** 7108 * Define the vertical offset size of shadow 7109 * 7110 * @type { ?(number | Resource) } 7111 * @syscap SystemCapability.ArkUI.ArkUI.Full 7112 * @since 7 7113 */ 7114 /** 7115 * Define the vertical offset size of shadow 7116 * 7117 * @type { ?(number | Resource) } 7118 * @syscap SystemCapability.ArkUI.ArkUI.Full 7119 * @form 7120 * @since 9 7121 */ 7122 /** 7123 * Define the vertical offset size of shadow 7124 * 7125 * @type { ?(number | Resource) } 7126 * @syscap SystemCapability.ArkUI.ArkUI.Full 7127 * @crossplatform 7128 * @form 7129 * @since 10 7130 */ 7131 /** 7132 * Define the vertical offset size of shadow 7133 * 7134 * @type { ?(number | Resource) } 7135 * @syscap SystemCapability.ArkUI.ArkUI.Full 7136 * @crossplatform 7137 * @form 7138 * @atomicservice 7139 * @since 11 7140 */ 7141 offsetY?: number | Resource; 7142 7143 /** 7144 * Define whether the shadow should fill the area 7145 * 7146 * @type { ?boolean } 7147 * @default false 7148 * @syscap SystemCapability.ArkUI.ArkUI.Full 7149 * @crossplatform 7150 * @since 11 7151 */ 7152 /** 7153 * Define whether the shadow should fill the area 7154 * 7155 * @type { ?boolean } 7156 * @default false 7157 * @syscap SystemCapability.ArkUI.ArkUI.Full 7158 * @crossplatform 7159 * @atomicservice 7160 * @since 12 7161 */ 7162 fill?: boolean; 7163} 7164 7165/** 7166 * enum Shadow style 7167 * 7168 * @enum { number } 7169 * @syscap SystemCapability.ArkUI.ArkUI.Full 7170 * @crossplatform 7171 * @since 10 7172 */ 7173/** 7174 * enum Shadow style 7175 * 7176 * @enum { number } 7177 * @syscap SystemCapability.ArkUI.ArkUI.Full 7178 * @crossplatform 7179 * @atomicservice 7180 * @since 11 7181 */ 7182declare enum ShadowStyle { 7183 /** 7184 * Defines the super small default shadow style. 7185 * 7186 * @syscap SystemCapability.ArkUI.ArkUI.Full 7187 * @crossplatform 7188 * @since 10 7189 */ 7190 /** 7191 * Defines the super small default shadow style. 7192 * 7193 * @syscap SystemCapability.ArkUI.ArkUI.Full 7194 * @crossplatform 7195 * @atomicservice 7196 * @since 11 7197 */ 7198 OUTER_DEFAULT_XS, 7199 7200 /** 7201 * Defines the small default shadow style. 7202 * 7203 * @syscap SystemCapability.ArkUI.ArkUI.Full 7204 * @crossplatform 7205 * @since 10 7206 */ 7207 /** 7208 * Defines the small default shadow style. 7209 * 7210 * @syscap SystemCapability.ArkUI.ArkUI.Full 7211 * @crossplatform 7212 * @atomicservice 7213 * @since 11 7214 */ 7215 OUTER_DEFAULT_SM, 7216 7217 /** 7218 * Defines the medium default shadow style. 7219 * 7220 * @syscap SystemCapability.ArkUI.ArkUI.Full 7221 * @crossplatform 7222 * @since 10 7223 */ 7224 /** 7225 * Defines the medium default shadow style. 7226 * 7227 * @syscap SystemCapability.ArkUI.ArkUI.Full 7228 * @crossplatform 7229 * @atomicservice 7230 * @since 11 7231 */ 7232 OUTER_DEFAULT_MD, 7233 7234 /** 7235 * Defines the large default shadow style. 7236 * 7237 * @syscap SystemCapability.ArkUI.ArkUI.Full 7238 * @crossplatform 7239 * @since 10 7240 */ 7241 /** 7242 * Defines the large default shadow style. 7243 * 7244 * @syscap SystemCapability.ArkUI.ArkUI.Full 7245 * @crossplatform 7246 * @atomicservice 7247 * @since 11 7248 */ 7249 OUTER_DEFAULT_LG, 7250 7251 /** 7252 * Defines the small floating shadow style. 7253 * 7254 * @syscap SystemCapability.ArkUI.ArkUI.Full 7255 * @crossplatform 7256 * @since 10 7257 */ 7258 /** 7259 * Defines the small floating shadow style. 7260 * 7261 * @syscap SystemCapability.ArkUI.ArkUI.Full 7262 * @crossplatform 7263 * @atomicservice 7264 * @since 11 7265 */ 7266 OUTER_FLOATING_SM, 7267 7268 /** 7269 * Defines the medium floating shadow style. 7270 * 7271 * @syscap SystemCapability.ArkUI.ArkUI.Full 7272 * @crossplatform 7273 * @since 10 7274 */ 7275 /** 7276 * Defines the medium floating shadow style. 7277 * 7278 * @syscap SystemCapability.ArkUI.ArkUI.Full 7279 * @crossplatform 7280 * @atomicservice 7281 * @since 11 7282 */ 7283 OUTER_FLOATING_MD, 7284} 7285 7286/** 7287 * Defines the options of Shadow. 7288 * 7289 * @interface MultiShadowOptions 7290 * @syscap SystemCapability.ArkUI.ArkUI.Full 7291 * @crossplatform 7292 * @since 10 7293 */ 7294/** 7295 * Defines the options of Shadow. 7296 * 7297 * @interface MultiShadowOptions 7298 * @syscap SystemCapability.ArkUI.ArkUI.Full 7299 * @crossplatform 7300 * @atomicservice 7301 * @since 11 7302 */ 7303declare interface MultiShadowOptions { 7304 /** 7305 * Current shadow radius. 7306 * 7307 * @type { ?(number | Resource) } 7308 * @default 5 7309 * @syscap SystemCapability.ArkUI.ArkUI.Full 7310 * @crossplatform 7311 * @since 10 7312 */ 7313 /** 7314 * Current shadow radius. 7315 * 7316 * @type { ?(number | Resource) } 7317 * @default 20 7318 * @syscap SystemCapability.ArkUI.ArkUI.Full 7319 * @crossplatform 7320 * @atomicservice 7321 * @since 11 7322 */ 7323 radius?: number | Resource; 7324 7325 /** 7326 * Current shadow offsetX. 7327 * 7328 * @type { ?(number | Resource) } 7329 * @default 5 7330 * @syscap SystemCapability.ArkUI.ArkUI.Full 7331 * @crossplatform 7332 * @since 10 7333 */ 7334 /** 7335 * Current shadow offsetX. 7336 * 7337 * @type { ?(number | Resource) } 7338 * @default 5 7339 * @syscap SystemCapability.ArkUI.ArkUI.Full 7340 * @crossplatform 7341 * @atomicservice 7342 * @since 11 7343 */ 7344 offsetX?: number | Resource; 7345 7346 /** 7347 * Current shadow offsetY 7348 * 7349 * @type { ?(number | Resource) } 7350 * @default 5 7351 * @syscap SystemCapability.ArkUI.ArkUI.Full 7352 * @crossplatform 7353 * @since 10 7354 */ 7355 /** 7356 * Current shadow offsetY 7357 * 7358 * @type { ?(number | Resource) } 7359 * @default 5 7360 * @syscap SystemCapability.ArkUI.ArkUI.Full 7361 * @crossplatform 7362 * @atomicservice 7363 * @since 11 7364 */ 7365 offsetY?: number | Resource; 7366} 7367 7368/** 7369 * Enumerates the safe area types. 7370 * 7371 * @enum { number } 7372 * @syscap SystemCapability.ArkUI.ArkUI.Full 7373 * @since 10 7374 */ 7375/** 7376 * Enumerates the safe area types. 7377 * 7378 * @enum { number } 7379 * @syscap SystemCapability.ArkUI.ArkUI.Full 7380 * @crossplatform 7381 * @atomicservice 7382 * @since 11 7383 */ 7384declare enum SafeAreaType { 7385 /** 7386 * Default area of the system, including the status bar and navigation bar. 7387 * 7388 * @syscap SystemCapability.ArkUI.ArkUI.Full 7389 * @since 10 7390 */ 7391 /** 7392 * Default area of the system, including the status bar and navigation bar. 7393 * 7394 * @syscap SystemCapability.ArkUI.ArkUI.Full 7395 * @crossplatform 7396 * @atomicservice 7397 * @since 11 7398 */ 7399 SYSTEM, 7400 7401 /** 7402 * Notch or punch hole. 7403 * 7404 * @syscap SystemCapability.ArkUI.ArkUI.Full 7405 * @since 10 7406 */ 7407 /** 7408 * Notch or punch hole. 7409 * 7410 * @syscap SystemCapability.ArkUI.ArkUI.Full 7411 * @crossplatform 7412 * @atomicservice 7413 * @since 11 7414 */ 7415 CUTOUT, 7416 7417 /** 7418 * Soft keyboard area. 7419 * 7420 * @syscap SystemCapability.ArkUI.ArkUI.Full 7421 * @since 10 7422 */ 7423 /** 7424 * Soft keyboard area. 7425 * 7426 * @syscap SystemCapability.ArkUI.ArkUI.Full 7427 * @crossplatform 7428 * @atomicservice 7429 * @since 11 7430 */ 7431 KEYBOARD 7432} 7433 7434/** 7435 * Enumerates the safe area edges. 7436 * 7437 * @enum { number } 7438 * @syscap SystemCapability.ArkUI.ArkUI.Full 7439 * @since 10 7440 */ 7441/** 7442 * Enumerates the safe area edges. 7443 * 7444 * @enum { number } 7445 * @syscap SystemCapability.ArkUI.ArkUI.Full 7446 * @crossplatform 7447 * @atomicservice 7448 * @since 11 7449 */ 7450declare enum SafeAreaEdge { 7451 /** 7452 * Top edge of the safe area. 7453 * 7454 * @syscap SystemCapability.ArkUI.ArkUI.Full 7455 * @since 10 7456 */ 7457 /** 7458 * Top edge of the safe area. 7459 * 7460 * @syscap SystemCapability.ArkUI.ArkUI.Full 7461 * @crossplatform 7462 * @atomicservice 7463 * @since 11 7464 */ 7465 TOP, 7466 7467 /** 7468 * Bottom edge of the safe area. 7469 * 7470 * @syscap SystemCapability.ArkUI.ArkUI.Full 7471 * @since 10 7472 */ 7473 /** 7474 * Bottom edge of the safe area. 7475 * 7476 * @syscap SystemCapability.ArkUI.ArkUI.Full 7477 * @crossplatform 7478 * @atomicservice 7479 * @since 11 7480 */ 7481 BOTTOM, 7482 7483 /** 7484 * Start edge of the safe area. 7485 * 7486 * @syscap SystemCapability.ArkUI.ArkUI.Full 7487 * @since 10 7488 */ 7489 /** 7490 * Start edge of the safe area. 7491 * 7492 * @syscap SystemCapability.ArkUI.ArkUI.Full 7493 * @crossplatform 7494 * @atomicservice 7495 * @since 11 7496 */ 7497 START, 7498 7499 /** 7500 * End edge of the safe area. 7501 * 7502 * @syscap SystemCapability.ArkUI.ArkUI.Full 7503 * @since 10 7504 */ 7505 /** 7506 * End edge of the safe area. 7507 * 7508 * @syscap SystemCapability.ArkUI.ArkUI.Full 7509 * @crossplatform 7510 * @atomicservice 7511 * @since 11 7512 */ 7513 END 7514} 7515 7516/** 7517 * Enumerates the safe area types can be ignored. 7518 * 7519 * @enum { number } 7520 * @syscap SystemCapability.ArkUI.ArkUI.Full 7521 * @crossplatform 7522 * @atomicservice 7523 * @since 12 7524 */ 7525declare enum LayoutSafeAreaType { 7526 /** 7527 * Default area of the system, including the status bar and navigation bar. 7528 * 7529 * @syscap SystemCapability.ArkUI.ArkUI.Full 7530 * @crossplatform 7531 * @atomicservice 7532 * @since 12 7533 */ 7534 SYSTEM = 0, 7535} 7536 7537/** 7538 * Enumerates the safe area edges can be ignored. 7539 * 7540 * @enum { number } 7541 * @syscap SystemCapability.ArkUI.ArkUI.Full 7542 * @crossplatform 7543 * @atomicservice 7544 * @since 12 7545 */ 7546declare enum LayoutSafeAreaEdge { 7547 /** 7548 * Top edge of the safe area. 7549 * 7550 * @syscap SystemCapability.ArkUI.ArkUI.Full 7551 * @crossplatform 7552 * @atomicservice 7553 * @since 12 7554 */ 7555 TOP = 0, 7556 7557 /** 7558 * Bottom edge of the safe area. 7559 * 7560 * @syscap SystemCapability.ArkUI.ArkUI.Full 7561 * @crossplatform 7562 * @atomicservice 7563 * @since 12 7564 */ 7565 BOTTOM = 1, 7566} 7567 7568/** 7569 * Defines sheet size type. 7570 * 7571 * @enum { number } 7572 * @syscap SystemCapability.ArkUI.ArkUI.Full 7573 * @crossplatform 7574 * @since 10 7575 */ 7576/** 7577 * Defines sheet size type. 7578 * 7579 * @enum { number } 7580 * @syscap SystemCapability.ArkUI.ArkUI.Full 7581 * @crossplatform 7582 * @atomicservice 7583 * @since 11 7584 */ 7585declare enum SheetSize { 7586 /** 7587 * Defines the sheet size medium height type. The height is half the screen height 7588 * 7589 * @syscap SystemCapability.ArkUI.ArkUI.Full 7590 * @crossplatform 7591 * @since 10 7592 */ 7593 /** 7594 * Defines the sheet size medium height type. The height is half the screen height 7595 * 7596 * @syscap SystemCapability.ArkUI.ArkUI.Full 7597 * @crossplatform 7598 * @atomicservice 7599 * @since 11 7600 */ 7601 MEDIUM, 7602 7603 /** 7604 * Defines the sheet size large height type. The height is almost screen height. 7605 * 7606 * @syscap SystemCapability.ArkUI.ArkUI.Full 7607 * @crossplatform 7608 * @since 10 7609 */ 7610 /** 7611 * Defines the sheet size large height type. The height is almost screen height. 7612 * 7613 * @syscap SystemCapability.ArkUI.ArkUI.Full 7614 * @crossplatform 7615 * @atomicservice 7616 * @since 11 7617 */ 7618 LARGE, 7619 7620 /** 7621 * Defines the sheet size fit content height type. The height fit content. 7622 * 7623 * @syscap SystemCapability.ArkUI.ArkUI.Full 7624 * @crossplatform 7625 * @since 11 7626 */ 7627 /** 7628 * Defines the sheet size fit content height type. The height fit content. 7629 * 7630 * @syscap SystemCapability.ArkUI.ArkUI.Full 7631 * @crossplatform 7632 * @atomicservice 7633 * @since 12 7634 */ 7635 FIT_CONTENT = 2, 7636} 7637 7638/** 7639 * Defines the base event. 7640 * 7641 * @interface BaseEvent 7642 * @syscap SystemCapability.ArkUI.ArkUI.Full 7643 * @since 8 7644 */ 7645/** 7646 * Defines the base event. 7647 * 7648 * @interface BaseEvent 7649 * @syscap SystemCapability.ArkUI.ArkUI.Full 7650 * @form 7651 * @since 9 7652 */ 7653/** 7654 * Defines the base event. 7655 * 7656 * @interface BaseEvent 7657 * @syscap SystemCapability.ArkUI.ArkUI.Full 7658 * @crossplatform 7659 * @form 7660 * @since 10 7661 */ 7662/** 7663 * Defines the base event. 7664 * 7665 * @interface BaseEvent 7666 * @syscap SystemCapability.ArkUI.ArkUI.Full 7667 * @crossplatform 7668 * @form 7669 * @atomicservice 7670 * @since 11 7671 */ 7672declare interface BaseEvent { 7673 /** 7674 * Defines the current target which fires this event. 7675 * 7676 * @type { EventTarget } 7677 * @syscap SystemCapability.ArkUI.ArkUI.Full 7678 * @since 8 7679 */ 7680 /** 7681 * Defines the current target which fires this event. 7682 * 7683 * @type { EventTarget } 7684 * @syscap SystemCapability.ArkUI.ArkUI.Full 7685 * @form 7686 * @since 9 7687 */ 7688 /** 7689 * Defines the current target which fires this event. 7690 * 7691 * @type { EventTarget } 7692 * @syscap SystemCapability.ArkUI.ArkUI.Full 7693 * @crossplatform 7694 * @form 7695 * @since 10 7696 */ 7697 /** 7698 * Defines the current target which fires this event. 7699 * 7700 * @type { EventTarget } 7701 * @syscap SystemCapability.ArkUI.ArkUI.Full 7702 * @crossplatform 7703 * @form 7704 * @atomicservice 7705 * @since 11 7706 */ 7707 target: EventTarget; 7708 7709 /** 7710 * Event timestamp. 7711 * 7712 * @type { number } 7713 * @syscap SystemCapability.ArkUI.ArkUI.Full 7714 * @since 8 7715 */ 7716 /** 7717 * Event timestamp. 7718 * 7719 * @type { number } 7720 * @syscap SystemCapability.ArkUI.ArkUI.Full 7721 * @form 7722 * @since 9 7723 */ 7724 /** 7725 * Event timestamp. 7726 * 7727 * @type { number } 7728 * @syscap SystemCapability.ArkUI.ArkUI.Full 7729 * @crossplatform 7730 * @form 7731 * @since 10 7732 */ 7733 /** 7734 * Event timestamp. 7735 * 7736 * @type { number } 7737 * @syscap SystemCapability.ArkUI.ArkUI.Full 7738 * @crossplatform 7739 * @form 7740 * @atomicservice 7741 * @since 11 7742 */ 7743 timestamp: number; 7744 7745 /** 7746 * the event source info. 7747 * 7748 * @type { SourceType } 7749 * @syscap SystemCapability.ArkUI.ArkUI.Full 7750 * @since 8 7751 */ 7752 /** 7753 * the event source info. 7754 * 7755 * @type { SourceType } 7756 * @syscap SystemCapability.ArkUI.ArkUI.Full 7757 * @form 7758 * @since 9 7759 */ 7760 /** 7761 * the event source info. 7762 * 7763 * @type { SourceType } 7764 * @syscap SystemCapability.ArkUI.ArkUI.Full 7765 * @crossplatform 7766 * @form 7767 * @since 10 7768 */ 7769 /** 7770 * the event source info. 7771 * 7772 * @type { SourceType } 7773 * @syscap SystemCapability.ArkUI.ArkUI.Full 7774 * @crossplatform 7775 * @form 7776 * @atomicservice 7777 * @since 11 7778 */ 7779 source: SourceType; 7780 7781 /** 7782 * the Horizontal axis coordinate. 7783 * 7784 * @type { ?number } 7785 * @syscap SystemCapability.ArkUI.ArkUI.Full 7786 * @crossplatform 7787 * @form 7788 * @atomicservice 7789 * @since 12 7790 */ 7791 axisHorizontal?: number; 7792 7793 /** 7794 * the Vertical axis coordinate. 7795 * 7796 * @type { ?number } 7797 * @syscap SystemCapability.ArkUI.ArkUI.Full 7798 * @crossplatform 7799 * @form 7800 * @atomicservice 7801 * @since 12 7802 */ 7803 axisVertical?: number; 7804 7805 /** 7806 * Touch pressure. 7807 * 7808 * @type { number } 7809 * @syscap SystemCapability.ArkUI.ArkUI.Full 7810 * @form 7811 * @since 9 7812 */ 7813 /** 7814 * Touch pressure. 7815 * 7816 * @type { number } 7817 * @syscap SystemCapability.ArkUI.ArkUI.Full 7818 * @crossplatform 7819 * @form 7820 * @since 10 7821 */ 7822 /** 7823 * Touch pressure. 7824 * 7825 * @type { number } 7826 * @syscap SystemCapability.ArkUI.ArkUI.Full 7827 * @crossplatform 7828 * @form 7829 * @atomicservice 7830 * @since 11 7831 */ 7832 pressure: number; 7833 7834 /** 7835 * The angle between pencil projection on plane-X-Y and axis-Z. 7836 * 7837 * @type { number } 7838 * @syscap SystemCapability.ArkUI.ArkUI.Full 7839 * @form 7840 * @since 9 7841 */ 7842 /** 7843 * The angle between pencil projection on plane-X-Y and axis-Z. 7844 * 7845 * @type { number } 7846 * @syscap SystemCapability.ArkUI.ArkUI.Full 7847 * @crossplatform 7848 * @form 7849 * @since 10 7850 */ 7851 /** 7852 * The angle between pencil projection on plane-X-Y and axis-Z. 7853 * 7854 * @type { number } 7855 * @syscap SystemCapability.ArkUI.ArkUI.Full 7856 * @crossplatform 7857 * @form 7858 * @atomicservice 7859 * @since 11 7860 */ 7861 tiltX: number; 7862 7863 /** 7864 * The angle between pencil projection on plane-Y-Z and axis-Z. 7865 * 7866 * @type { number } 7867 * @syscap SystemCapability.ArkUI.ArkUI.Full 7868 * @form 7869 * @since 9 7870 */ 7871 /** 7872 * The angle between pencil projection on plane-Y-Z and axis-Z. 7873 * 7874 * @type { number } 7875 * @syscap SystemCapability.ArkUI.ArkUI.Full 7876 * @crossplatform 7877 * @form 7878 * @since 10 7879 */ 7880 /** 7881 * The angle between pencil projection on plane-Y-Z and axis-Z. 7882 * 7883 * @type { number } 7884 * @syscap SystemCapability.ArkUI.ArkUI.Full 7885 * @crossplatform 7886 * @form 7887 * @atomicservice 7888 * @since 11 7889 */ 7890 tiltY: number; 7891 7892 /** 7893 * The event tool type info. 7894 * 7895 * @type { SourceTool } 7896 * @syscap SystemCapability.ArkUI.ArkUI.Full 7897 * @form 7898 * @since 9 7899 */ 7900 /** 7901 * The event tool type info. 7902 * 7903 * @type { SourceTool } 7904 * @syscap SystemCapability.ArkUI.ArkUI.Full 7905 * @crossplatform 7906 * @form 7907 * @since 10 7908 */ 7909 /** 7910 * The event tool type info. 7911 * 7912 * @type { SourceTool } 7913 * @syscap SystemCapability.ArkUI.ArkUI.Full 7914 * @crossplatform 7915 * @form 7916 * @atomicservice 7917 * @since 11 7918 */ 7919 sourceTool: SourceTool; 7920 7921 /** 7922 * Query the ModifierKey press state, support 'ctrl'|'alt'|'shift'|'fn' 7923 * 7924 * @param { Array<string> } keys - indicate the keys of the ModifierKey. 7925 * @returns { boolean } 7926 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 7927 * @syscap SystemCapability.ArkUI.ArkUI.Full 7928 * @crossplatform 7929 * @atomicservice 7930 * @since 12 7931 */ 7932 getModifierKeyState?(keys: Array<string>): boolean; 7933 7934 /** 7935 * Indicates the ID of the input device that triggers the current event. 7936 * 7937 * @type { ?number } [deviceId] The ID of the input device that triggers the current event 7938 * @syscap SystemCapability.ArkUI.ArkUI.Full 7939 * @crossplatform 7940 * @atomicservice 7941 * @since 12 7942 */ 7943 deviceId?: number; 7944} 7945 7946/** 7947 * Border image option 7948 * 7949 * @interface BorderImageOption 7950 * @syscap SystemCapability.ArkUI.ArkUI.Full 7951 * @form 7952 * @since 9 7953 */ 7954/** 7955 * Border image option 7956 * 7957 * @interface BorderImageOption 7958 * @syscap SystemCapability.ArkUI.ArkUI.Full 7959 * @crossplatform 7960 * @form 7961 * @since 10 7962 */ 7963/** 7964 * Border image option 7965 * 7966 * @interface BorderImageOption 7967 * @syscap SystemCapability.ArkUI.ArkUI.Full 7968 * @crossplatform 7969 * @form 7970 * @atomicservice 7971 * @since 11 7972 */ 7973declare interface BorderImageOption { 7974 /** 7975 * Border image slice 7976 * 7977 * @type { ?(Length | EdgeWidths) } 7978 * @syscap SystemCapability.ArkUI.ArkUI.Full 7979 * @form 7980 * @since 9 7981 */ 7982 /** 7983 * Border image slice 7984 * 7985 * @type { ?(Length | EdgeWidths) } 7986 * @syscap SystemCapability.ArkUI.ArkUI.Full 7987 * @crossplatform 7988 * @form 7989 * @since 10 7990 */ 7991 /** 7992 * Border image slice 7993 * 7994 * @type { ?(Length | EdgeWidths) } 7995 * @syscap SystemCapability.ArkUI.ArkUI.Full 7996 * @crossplatform 7997 * @form 7998 * @atomicservice 7999 * @since 11 8000 */ 8001 /** 8002 * Border image slice 8003 * 8004 * @type { ?(Length | EdgeWidths | LocalizedEdgeWidths) } 8005 * @syscap SystemCapability.ArkUI.ArkUI.Full 8006 * @crossplatform 8007 * @form 8008 * @atomicservice 8009 * @since 12 8010 */ 8011 slice?: Length | EdgeWidths | LocalizedEdgeWidths, 8012 8013 /** 8014 * Border image repeat 8015 * 8016 * @type { ?RepeatMode } 8017 * @syscap SystemCapability.ArkUI.ArkUI.Full 8018 * @form 8019 * @since 9 8020 */ 8021 /** 8022 * Border image repeat 8023 * 8024 * @type { ?RepeatMode } 8025 * @syscap SystemCapability.ArkUI.ArkUI.Full 8026 * @crossplatform 8027 * @form 8028 * @since 10 8029 */ 8030 /** 8031 * Border image repeat 8032 * 8033 * @type { ?RepeatMode } 8034 * @syscap SystemCapability.ArkUI.ArkUI.Full 8035 * @crossplatform 8036 * @form 8037 * @atomicservice 8038 * @since 11 8039 */ 8040 repeat?: RepeatMode, 8041 8042 /** 8043 * Border image source 8044 * 8045 * @type { ?(string | Resource | LinearGradient) } 8046 * @syscap SystemCapability.ArkUI.ArkUI.Full 8047 * @form 8048 * @since 9 8049 */ 8050 /** 8051 * Border image source 8052 * 8053 * @type { ?(string | Resource | LinearGradient) } 8054 * @syscap SystemCapability.ArkUI.ArkUI.Full 8055 * @crossplatform 8056 * @form 8057 * @since 10 8058 */ 8059 /** 8060 * Border image source 8061 * 8062 * @type { ?(string | Resource | LinearGradient) } 8063 * @syscap SystemCapability.ArkUI.ArkUI.Full 8064 * @crossplatform 8065 * @form 8066 * @atomicservice 8067 * @since 11 8068 */ 8069 source?: string | Resource | LinearGradient, 8070 8071 /** 8072 * Border image width 8073 * 8074 * @type { ?(Length | EdgeWidths) } 8075 * @syscap SystemCapability.ArkUI.ArkUI.Full 8076 * @form 8077 * @since 9 8078 */ 8079 /** 8080 * Border image width 8081 * 8082 * @type { ?(Length | EdgeWidths) } 8083 * @syscap SystemCapability.ArkUI.ArkUI.Full 8084 * @crossplatform 8085 * @form 8086 * @since 10 8087 */ 8088 /** 8089 * Border image width 8090 * 8091 * @type { ?(Length | EdgeWidths) } 8092 * @syscap SystemCapability.ArkUI.ArkUI.Full 8093 * @crossplatform 8094 * @form 8095 * @atomicservice 8096 * @since 11 8097 */ 8098 /** 8099 * Border image width 8100 * 8101 * @type { ?(Length | EdgeWidths | LocalizedEdgeWidths) } 8102 * @syscap SystemCapability.ArkUI.ArkUI.Full 8103 * @crossplatform 8104 * @form 8105 * @atomicservice 8106 * @since 12 8107 */ 8108 width?: Length | EdgeWidths | LocalizedEdgeWidths, 8109 8110 /** 8111 * Border image outset 8112 * 8113 * @type { ?(Length | EdgeWidths) } 8114 * @syscap SystemCapability.ArkUI.ArkUI.Full 8115 * @form 8116 * @since 9 8117 */ 8118 /** 8119 * Border image outset 8120 * 8121 * @type { ?(Length | EdgeWidths) } 8122 * @syscap SystemCapability.ArkUI.ArkUI.Full 8123 * @crossplatform 8124 * @form 8125 * @since 10 8126 */ 8127 /** 8128 * Border image outset 8129 * 8130 * @type { ?(Length | EdgeWidths) } 8131 * @syscap SystemCapability.ArkUI.ArkUI.Full 8132 * @crossplatform 8133 * @form 8134 * @atomicservice 8135 * @since 11 8136 */ 8137 /** 8138 * Border image outset 8139 * 8140 * @type { ?(Length | EdgeWidths | LocalizedEdgeWidths) } 8141 * @syscap SystemCapability.ArkUI.ArkUI.Full 8142 * @crossplatform 8143 * @form 8144 * @atomicservice 8145 * @since 12 8146 */ 8147 outset?: Length | EdgeWidths | LocalizedEdgeWidths, 8148 8149 /** 8150 * Border image center fill 8151 * 8152 * @type { ?boolean } 8153 * @syscap SystemCapability.ArkUI.ArkUI.Full 8154 * @form 8155 * @since 9 8156 */ 8157 /** 8158 * Border image center fill 8159 * 8160 * @type { ?boolean } 8161 * @syscap SystemCapability.ArkUI.ArkUI.Full 8162 * @crossplatform 8163 * @form 8164 * @since 10 8165 */ 8166 /** 8167 * Border image center fill 8168 * 8169 * @type { ?boolean } 8170 * @syscap SystemCapability.ArkUI.ArkUI.Full 8171 * @crossplatform 8172 * @form 8173 * @atomicservice 8174 * @since 11 8175 */ 8176 fill?: boolean 8177} 8178 8179/** 8180 * The tap action triggers this method invocation. 8181 * 8182 * @interface ClickEvent 8183 * @syscap SystemCapability.ArkUI.ArkUI.Full 8184 * @since 7 8185 */ 8186/** 8187 * The tap action triggers this method invocation. 8188 * 8189 * @interface ClickEvent 8190 * @syscap SystemCapability.ArkUI.ArkUI.Full 8191 * @form 8192 * @since 9 8193 */ 8194/** 8195 * The tap action triggers this method invocation. 8196 * 8197 * @interface ClickEvent 8198 * @syscap SystemCapability.ArkUI.ArkUI.Full 8199 * @crossplatform 8200 * @form 8201 * @since 10 8202 */ 8203/** 8204 * The tap action triggers this method invocation. 8205 * 8206 * @interface ClickEvent 8207 * @syscap SystemCapability.ArkUI.ArkUI.Full 8208 * @crossplatform 8209 * @form 8210 * @atomicservice 8211 * @since 11 8212 */ 8213declare interface ClickEvent extends BaseEvent { 8214 /** 8215 * X coordinate of the click point relative to the left edge of the device screen. 8216 * 8217 * @type { number } 8218 * @syscap SystemCapability.ArkUI.ArkUI.Full 8219 * @crossplatform 8220 * @since 10 8221 */ 8222 /** 8223 * X coordinate of the click point relative to the left edge of the device screen. 8224 * 8225 * @type { number } 8226 * @syscap SystemCapability.ArkUI.ArkUI.Full 8227 * @crossplatform 8228 * @atomicservice 8229 * @since 11 8230 */ 8231 displayX: number; 8232 8233 /** 8234 * Y coordinate of the click point relative to the upper edge of the device screen. 8235 * 8236 * @type { number } 8237 * @syscap SystemCapability.ArkUI.ArkUI.Full 8238 * @crossplatform 8239 * @since 10 8240 */ 8241 /** 8242 * Y coordinate of the click point relative to the upper edge of the device screen. 8243 * 8244 * @type { number } 8245 * @syscap SystemCapability.ArkUI.ArkUI.Full 8246 * @crossplatform 8247 * @atomicservice 8248 * @since 11 8249 */ 8250 displayY: number; 8251 8252 /** 8253 * X coordinate of the click point relative to the left edge of the current window. 8254 * 8255 * @type { number } 8256 * @syscap SystemCapability.ArkUI.ArkUI.Full 8257 * @crossplatform 8258 * @since 10 8259 */ 8260 /** 8261 * X coordinate of the click point relative to the left edge of the current window. 8262 * 8263 * @type { number } 8264 * @syscap SystemCapability.ArkUI.ArkUI.Full 8265 * @crossplatform 8266 * @atomicservice 8267 * @since 11 8268 */ 8269 windowX: number; 8270 8271 /** 8272 * Y coordinate of the click point relative to the upper edge of the current window. 8273 * 8274 * @type { number } 8275 * @syscap SystemCapability.ArkUI.ArkUI.Full 8276 * @crossplatform 8277 * @since 10 8278 */ 8279 /** 8280 * Y coordinate of the click point relative to the upper edge of the current window. 8281 * 8282 * @type { number } 8283 * @syscap SystemCapability.ArkUI.ArkUI.Full 8284 * @crossplatform 8285 * @atomicservice 8286 * @since 11 8287 */ 8288 windowY: number; 8289 8290 /** 8291 * X coordinate of the click point relative to the left edge of the current window. 8292 * 8293 * @type { number } 8294 * @syscap SystemCapability.ArkUI.ArkUI.Full 8295 * @since 7 8296 * @deprecated since 10 8297 * @useinstead ClickEvent#windowX 8298 */ 8299 screenX: number; 8300 8301 /** 8302 * Y coordinate of the click point relative to the upper edge of the current window. 8303 * 8304 * @type { number } 8305 * @syscap SystemCapability.ArkUI.ArkUI.Full 8306 * @since 7 8307 * @deprecated since 10 8308 * @useinstead ClickEvent#windowY 8309 */ 8310 screenY: number; 8311 8312 /** 8313 * X coordinate of the click point relative to the left edge of the clicked element. 8314 * 8315 * @type { number } 8316 * @syscap SystemCapability.ArkUI.ArkUI.Full 8317 * @since 7 8318 */ 8319 /** 8320 * X coordinate of the click point relative to the left edge of the clicked element. 8321 * 8322 * @type { number } 8323 * @syscap SystemCapability.ArkUI.ArkUI.Full 8324 * @form 8325 * @since 9 8326 */ 8327 /** 8328 * X coordinate of the click point relative to the left edge of the clicked element. 8329 * 8330 * @type { number } 8331 * @syscap SystemCapability.ArkUI.ArkUI.Full 8332 * @crossplatform 8333 * @form 8334 * @since 10 8335 */ 8336 /** 8337 * X coordinate of the click point relative to the left edge of the clicked element. 8338 * 8339 * @type { number } 8340 * @syscap SystemCapability.ArkUI.ArkUI.Full 8341 * @crossplatform 8342 * @form 8343 * @atomicservice 8344 * @since 11 8345 */ 8346 x: number; 8347 8348 /** 8349 * Y coordinate of the click point relative to the upper edge of the clicked element. 8350 * 8351 * @type { number } 8352 * @syscap SystemCapability.ArkUI.ArkUI.Full 8353 * @since 7 8354 */ 8355 /** 8356 * Y coordinate of the click point relative to the left edge of the clicked element. 8357 * 8358 * @type { number } 8359 * @syscap SystemCapability.ArkUI.ArkUI.Full 8360 * @form 8361 * @since 9 8362 */ 8363 /** 8364 * Y coordinate of the click point relative to the left edge of the clicked element. 8365 * 8366 * @type { number } 8367 * @syscap SystemCapability.ArkUI.ArkUI.Full 8368 * @crossplatform 8369 * @form 8370 * @since 10 8371 */ 8372 /** 8373 * Y coordinate of the click point relative to the left edge of the clicked element. 8374 * 8375 * @type { number } 8376 * @syscap SystemCapability.ArkUI.ArkUI.Full 8377 * @crossplatform 8378 * @form 8379 * @atomicservice 8380 * @since 11 8381 */ 8382 y: number; 8383 8384 /** 8385 * Prevent the default function. 8386 * 8387 * @type { function } 8388 * @syscap SystemCapability.ArkUI.ArkUI.Full 8389 * @crossplatform 8390 * @atomicservice 8391 * @since 12 8392 */ 8393 preventDefault: () => void; 8394} 8395 8396/** 8397 * The hover action triggers this method invocation. 8398 * 8399 * @interface HoverEvent 8400 * @syscap SystemCapability.ArkUI.ArkUI.Full 8401 * @since 10 8402 */ 8403/** 8404 * The hover action triggers this method invocation. 8405 * 8406 * @interface HoverEvent 8407 * @syscap SystemCapability.ArkUI.ArkUI.Full 8408 * @atomicservice 8409 * @since 11 8410 */ 8411declare interface HoverEvent extends BaseEvent { 8412 /** 8413 * The blocking hover event pops up. 8414 * 8415 * @type { function } 8416 * @syscap SystemCapability.ArkUI.ArkUI.Full 8417 * @since 10 8418 */ 8419 /** 8420 * The blocking hover event pops up. 8421 * 8422 * @type { function } 8423 * @syscap SystemCapability.ArkUI.ArkUI.Full 8424 * @atomicservice 8425 * @since 11 8426 */ 8427 stopPropagation: () => void; 8428} 8429 8430/** 8431 * The mouse click action triggers this method invocation. 8432 * 8433 * @interface MouseEvent 8434 * @syscap SystemCapability.ArkUI.ArkUI.Full 8435 * @since 8 8436 */ 8437/** 8438 * The mouse click action triggers this method invocation. 8439 * 8440 * @interface MouseEvent 8441 * @syscap SystemCapability.ArkUI.ArkUI.Full 8442 * @atomicservice 8443 * @since 11 8444 */ 8445declare interface MouseEvent extends BaseEvent { 8446 /** 8447 * Mouse button of the click event. 8448 * 8449 * @type { MouseButton } 8450 * @syscap SystemCapability.ArkUI.ArkUI.Full 8451 * @since 8 8452 */ 8453 /** 8454 * Mouse button of the click event. 8455 * 8456 * @type { MouseButton } 8457 * @syscap SystemCapability.ArkUI.ArkUI.Full 8458 * @atomicservice 8459 * @since 11 8460 */ 8461 button: MouseButton; 8462 8463 /** 8464 * Mouse action of the click event. 8465 * 8466 * @type { MouseAction } 8467 * @syscap SystemCapability.ArkUI.ArkUI.Full 8468 * @since 8 8469 */ 8470 /** 8471 * Mouse action of the click event. 8472 * 8473 * @type { MouseAction } 8474 * @syscap SystemCapability.ArkUI.ArkUI.Full 8475 * @atomicservice 8476 * @since 11 8477 */ 8478 action: MouseAction; 8479 8480 /** 8481 * X coordinate of the mouse point relative to the left edge of the device screen. 8482 * 8483 * @type { number } 8484 * @syscap SystemCapability.ArkUI.ArkUI.Full 8485 * @since 10 8486 */ 8487 /** 8488 * X coordinate of the mouse point relative to the left edge of the device screen. 8489 * 8490 * @type { number } 8491 * @syscap SystemCapability.ArkUI.ArkUI.Full 8492 * @atomicservice 8493 * @since 11 8494 */ 8495 displayX: number; 8496 8497 /** 8498 * Y coordinate of the mouse point relative to the upper edge of the device screen. 8499 * 8500 * @type { number } 8501 * @syscap SystemCapability.ArkUI.ArkUI.Full 8502 * @since 10 8503 */ 8504 /** 8505 * Y coordinate of the mouse point relative to the upper edge of the device screen. 8506 * 8507 * @type { number } 8508 * @syscap SystemCapability.ArkUI.ArkUI.Full 8509 * @atomicservice 8510 * @since 11 8511 */ 8512 displayY: number; 8513 8514 /** 8515 * X coordinate of the mouse point relative to the left edge of the current window. 8516 * 8517 * @type { number } 8518 * @syscap SystemCapability.ArkUI.ArkUI.Full 8519 * @since 10 8520 */ 8521 /** 8522 * X coordinate of the mouse point relative to the left edge of the current window. 8523 * 8524 * @type { number } 8525 * @syscap SystemCapability.ArkUI.ArkUI.Full 8526 * @atomicservice 8527 * @since 11 8528 */ 8529 windowX: number; 8530 8531 /** 8532 * Y coordinate of the mouse point relative to the upper edge of the current window. 8533 * 8534 * @type { number } 8535 * @syscap SystemCapability.ArkUI.ArkUI.Full 8536 * @since 10 8537 */ 8538 /** 8539 * Y coordinate of the mouse point relative to the upper edge of the current window. 8540 * 8541 * @type { number } 8542 * @syscap SystemCapability.ArkUI.ArkUI.Full 8543 * @atomicservice 8544 * @since 11 8545 */ 8546 windowY: number; 8547 8548 /** 8549 * X coordinate of the mouse point relative to the left edge of the current window. 8550 * 8551 * @type { number } 8552 * @syscap SystemCapability.ArkUI.ArkUI.Full 8553 * @since 8 8554 * @deprecated since 10 8555 * @useinstead MouseEvent#windowX 8556 */ 8557 screenX: number; 8558 8559 /** 8560 * Y coordinate of the mouse point relative to the upper edge of the current window. 8561 * 8562 * @type { number } 8563 * @syscap SystemCapability.ArkUI.ArkUI.Full 8564 * @since 8 8565 * @deprecated since 10 8566 * @useinstead MouseEvent#windowY 8567 */ 8568 screenY: number; 8569 8570 /** 8571 * X coordinate of the mouse point relative to the left edge of the mouse hit element. 8572 * 8573 * @type { number } 8574 * @syscap SystemCapability.ArkUI.ArkUI.Full 8575 * @since 8 8576 */ 8577 /** 8578 * X coordinate of the mouse point relative to the left edge of the mouse hit element. 8579 * 8580 * @type { number } 8581 * @syscap SystemCapability.ArkUI.ArkUI.Full 8582 * @atomicservice 8583 * @since 11 8584 */ 8585 x: number; 8586 8587 /** 8588 * Y coordinate of the mouse point relative to the upper edge of the mouse hit element. 8589 * 8590 * @type { number } 8591 * @syscap SystemCapability.ArkUI.ArkUI.Full 8592 * @since 8 8593 */ 8594 /** 8595 * Y coordinate of the mouse point relative to the upper edge of the mouse hit element. 8596 * 8597 * @type { number } 8598 * @syscap SystemCapability.ArkUI.ArkUI.Full 8599 * @atomicservice 8600 * @since 11 8601 */ 8602 y: number; 8603 8604 /** 8605 * The blocking event pops up. 8606 * 8607 * @type { function } 8608 * @syscap SystemCapability.ArkUI.ArkUI.Full 8609 * @since 8 8610 */ 8611 /** 8612 * The blocking event pops up. 8613 * 8614 * @type { function } 8615 * @syscap SystemCapability.ArkUI.ArkUI.Full 8616 * @atomicservice 8617 * @since 11 8618 */ 8619 stopPropagation: () => void; 8620} 8621 8622/** 8623 * The accessibility hover action triggers this method invocation. 8624 * 8625 * @typedef AccessibilityHoverEvent 8626 * @extends BaseEvent 8627 * @syscap SystemCapability.ArkUI.ArkUI.Full 8628 * @atomicservice 8629 * @since 12 8630 */ 8631declare interface AccessibilityHoverEvent extends BaseEvent { 8632 /** 8633 * Type of the accessibility hover event. 8634 * 8635 * @type { AccessibilityHoverType } 8636 * @syscap SystemCapability.ArkUI.ArkUI.Full 8637 * @atomicservice 8638 * @since 12 8639 */ 8640 type: AccessibilityHoverType; 8641 8642 /** 8643 * X coordinate of the accessibility hover point relative to the left edge of the event hit element. 8644 * 8645 * @type { number } 8646 * @syscap SystemCapability.ArkUI.ArkUI.Full 8647 * @atomicservice 8648 * @since 12 8649 */ 8650 x: number; 8651 8652 /** 8653 * Y coordinate of the accessibility hover point relative to the upper edge of the event hit element. 8654 * 8655 * @type { number } 8656 * @syscap SystemCapability.ArkUI.ArkUI.Full 8657 * @atomicservice 8658 * @since 12 8659 */ 8660 y: number; 8661 8662 /** 8663 * X coordinate of the accessibility hover point relative to the left edge of the device screen. 8664 * 8665 * @type { number } 8666 * @syscap SystemCapability.ArkUI.ArkUI.Full 8667 * @atomicservice 8668 * @since 12 8669 */ 8670 displayX: number; 8671 8672 /** 8673 * Y coordinate of the accessibility hover point relative to the upper edge of the device screen. 8674 * 8675 * @type { number } 8676 * @syscap SystemCapability.ArkUI.ArkUI.Full 8677 * @atomicservice 8678 * @since 12 8679 */ 8680 displayY: number; 8681 8682 /** 8683 * X coordinate of the accessibility hover point relative to the left edge of the current window. 8684 * 8685 * @type { number } 8686 * @syscap SystemCapability.ArkUI.ArkUI.Full 8687 * @atomicservice 8688 * @since 12 8689 */ 8690 windowX: number; 8691 8692 /** 8693 * Y coordinate of the accessibility hover point relative to the upper edge of the current window. 8694 * 8695 * @type { number } 8696 * @syscap SystemCapability.ArkUI.ArkUI.Full 8697 * @atomicservice 8698 * @since 12 8699 */ 8700 windowY: number; 8701} 8702 8703/** 8704 * Type of the touch event. 8705 * 8706 * @interface TouchObject 8707 * @syscap SystemCapability.ArkUI.ArkUI.Full 8708 * @since 7 8709 */ 8710/** 8711 * Type of the touch event. 8712 * 8713 * @interface TouchObject 8714 * @syscap SystemCapability.ArkUI.ArkUI.Full 8715 * @crossplatform 8716 * @since 10 8717 */ 8718/** 8719 * Type of the touch event. 8720 * 8721 * @interface TouchObject 8722 * @syscap SystemCapability.ArkUI.ArkUI.Full 8723 * @crossplatform 8724 * @atomicservice 8725 * @since 11 8726 */ 8727declare interface TouchObject { 8728 /** 8729 * Type of the touch event. 8730 * 8731 * @type { TouchType } 8732 * @syscap SystemCapability.ArkUI.ArkUI.Full 8733 * @since 7 8734 */ 8735 /** 8736 * Type of the touch event. 8737 * 8738 * @type { TouchType } 8739 * @syscap SystemCapability.ArkUI.ArkUI.Full 8740 * @crossplatform 8741 * @since 10 8742 */ 8743 /** 8744 * Type of the touch event. 8745 * 8746 * @type { TouchType } 8747 * @syscap SystemCapability.ArkUI.ArkUI.Full 8748 * @crossplatform 8749 * @atomicservice 8750 * @since 11 8751 */ 8752 type: TouchType; 8753 8754 /** 8755 * Finger unique identifier. 8756 * 8757 * @type { number } 8758 * @syscap SystemCapability.ArkUI.ArkUI.Full 8759 * @since 7 8760 */ 8761 /** 8762 * Finger unique identifier. 8763 * 8764 * @type { number } 8765 * @syscap SystemCapability.ArkUI.ArkUI.Full 8766 * @crossplatform 8767 * @since 10 8768 */ 8769 /** 8770 * Finger unique identifier. 8771 * 8772 * @type { number } 8773 * @syscap SystemCapability.ArkUI.ArkUI.Full 8774 * @crossplatform 8775 * @atomicservice 8776 * @since 11 8777 */ 8778 id: number; 8779 8780 /** 8781 * X coordinate of the touch point relative to the left edge of the device screen. 8782 * 8783 * @type { number } 8784 * @syscap SystemCapability.ArkUI.ArkUI.Full 8785 * @crossplatform 8786 * @since 10 8787 */ 8788 /** 8789 * X coordinate of the touch point relative to the left edge of the device screen. 8790 * 8791 * @type { number } 8792 * @syscap SystemCapability.ArkUI.ArkUI.Full 8793 * @crossplatform 8794 * @atomicservice 8795 * @since 11 8796 */ 8797 displayX: number; 8798 8799 /** 8800 * Y coordinate of the touch point relative to the upper edge of the device screen. 8801 * 8802 * @type { number } 8803 * @syscap SystemCapability.ArkUI.ArkUI.Full 8804 * @crossplatform 8805 * @since 10 8806 */ 8807 /** 8808 * Y coordinate of the touch point relative to the upper edge of the device screen. 8809 * 8810 * @type { number } 8811 * @syscap SystemCapability.ArkUI.ArkUI.Full 8812 * @crossplatform 8813 * @atomicservice 8814 * @since 11 8815 */ 8816 displayY: number; 8817 8818 /** 8819 * X coordinate of the touch point relative to the left edge of the current window. 8820 * 8821 * @type { number } 8822 * @syscap SystemCapability.ArkUI.ArkUI.Full 8823 * @crossplatform 8824 * @since 10 8825 */ 8826 /** 8827 * X coordinate of the touch point relative to the left edge of the current window. 8828 * 8829 * @type { number } 8830 * @syscap SystemCapability.ArkUI.ArkUI.Full 8831 * @crossplatform 8832 * @atomicservice 8833 * @since 11 8834 */ 8835 windowX: number; 8836 8837 /** 8838 * Y coordinate of the touch point relative to the upper edge of the current window. 8839 * 8840 * @type { number } 8841 * @syscap SystemCapability.ArkUI.ArkUI.Full 8842 * @crossplatform 8843 * @since 10 8844 */ 8845 /** 8846 * Y coordinate of the touch point relative to the upper edge of the current window. 8847 * 8848 * @type { number } 8849 * @syscap SystemCapability.ArkUI.ArkUI.Full 8850 * @crossplatform 8851 * @atomicservice 8852 * @since 11 8853 */ 8854 windowY: number; 8855 8856 /** 8857 * X coordinate of the touch point relative to the left edge of the current window. 8858 * 8859 * @type { number } 8860 * @syscap SystemCapability.ArkUI.ArkUI.Full 8861 * @since 7 8862 * @deprecated since 10 8863 * @useinstead TouchObject#windowX 8864 */ 8865 screenX: number; 8866 8867 /** 8868 * Y coordinate of the touch point relative to the upper edge of the current window. 8869 * 8870 * @type { number } 8871 * @syscap SystemCapability.ArkUI.ArkUI.Full 8872 * @since 7 8873 * @deprecated since 10 8874 * @useinstead TouchObject#windowY 8875 */ 8876 screenY: number; 8877 8878 /** 8879 * X coordinate of the touch point relative to the left edge of the touched element. 8880 * 8881 * @type { number } 8882 * @syscap SystemCapability.ArkUI.ArkUI.Full 8883 * @since 7 8884 */ 8885 /** 8886 * X coordinate of the touch point relative to the left edge of the touched element. 8887 * 8888 * @type { number } 8889 * @syscap SystemCapability.ArkUI.ArkUI.Full 8890 * @crossplatform 8891 * @since 10 8892 */ 8893 /** 8894 * X coordinate of the touch point relative to the left edge of the touched element. 8895 * 8896 * @type { number } 8897 * @syscap SystemCapability.ArkUI.ArkUI.Full 8898 * @crossplatform 8899 * @atomicservice 8900 * @since 11 8901 */ 8902 x: number; 8903 8904 /** 8905 * Y coordinate of the touch point relative to the upper edge of the touched element. 8906 * 8907 * @type { number } 8908 * @syscap SystemCapability.ArkUI.ArkUI.Full 8909 * @since 7 8910 */ 8911 /** 8912 * Y coordinate of the touch point relative to the upper edge of the touched element. 8913 * 8914 * @type { number } 8915 * @syscap SystemCapability.ArkUI.ArkUI.Full 8916 * @crossplatform 8917 * @since 10 8918 */ 8919 /** 8920 * Y coordinate of the touch point relative to the upper edge of the touched element. 8921 * 8922 * @type { number } 8923 * @syscap SystemCapability.ArkUI.ArkUI.Full 8924 * @crossplatform 8925 * @atomicservice 8926 * @since 11 8927 */ 8928 y: number; 8929} 8930 8931/** 8932 * TouchObject getHistoricalPoints Function Parameters 8933 * 8934 * @interface HistoricalPoint 8935 * @syscap SystemCapability.ArkUI.ArkUI.Full 8936 * @crossplatform 8937 * @since 10 8938 */ 8939/** 8940 * TouchObject getHistoricalPoints Function Parameters 8941 * 8942 * @interface HistoricalPoint 8943 * @syscap SystemCapability.ArkUI.ArkUI.Full 8944 * @crossplatform 8945 * @atomicservice 8946 * @since 11 8947 */ 8948declare interface HistoricalPoint { 8949 /** 8950 * The base touchObject information of historicalPoint 8951 * 8952 * @type { TouchObject } 8953 * @syscap SystemCapability.ArkUI.ArkUI.Full 8954 * @crossplatform 8955 * @since 10 8956 */ 8957 /** 8958 * The base touchObject information of historicalPoint 8959 * 8960 * @type { TouchObject } 8961 * @syscap SystemCapability.ArkUI.ArkUI.Full 8962 * @crossplatform 8963 * @atomicservice 8964 * @since 11 8965 */ 8966 touchObject: TouchObject; 8967 8968 /** 8969 * Contact area between the finger pad and the screen. 8970 * 8971 * @type { number } 8972 * @syscap SystemCapability.ArkUI.ArkUI.Full 8973 * @crossplatform 8974 * @since 10 8975 */ 8976 /** 8977 * Contact area between the finger pad and the screen. 8978 * 8979 * @type { number } 8980 * @syscap SystemCapability.ArkUI.ArkUI.Full 8981 * @crossplatform 8982 * @atomicservice 8983 * @since 11 8984 */ 8985 size: number; 8986 8987 /** 8988 * Pressure of the touch event. 8989 * 8990 * @type { number } 8991 * @syscap SystemCapability.ArkUI.ArkUI.Full 8992 * @crossplatform 8993 * @since 10 8994 */ 8995 /** 8996 * Pressure of the touch event. 8997 * 8998 * @type { number } 8999 * @syscap SystemCapability.ArkUI.ArkUI.Full 9000 * @crossplatform 9001 * @atomicservice 9002 * @since 11 9003 */ 9004 force: number; 9005 9006 /** 9007 * Timestamp of the touch event. 9008 * 9009 * @type { number } 9010 * @syscap SystemCapability.ArkUI.ArkUI.Full 9011 * @crossplatform 9012 * @since 10 9013 */ 9014 /** 9015 * Timestamp of the touch event. 9016 * 9017 * @type { number } 9018 * @syscap SystemCapability.ArkUI.ArkUI.Full 9019 * @crossplatform 9020 * @atomicservice 9021 * @since 11 9022 */ 9023 timestamp: number; 9024} 9025 9026/** 9027 * Touch Action Function Parameters 9028 * 9029 * @interface TouchEvent 9030 * @syscap SystemCapability.ArkUI.ArkUI.Full 9031 * @since 7 9032 */ 9033/** 9034 * Touch Action Function Parameters 9035 * 9036 * @interface TouchEvent 9037 * @syscap SystemCapability.ArkUI.ArkUI.Full 9038 * @crossplatform 9039 * @since 10 9040 */ 9041/** 9042 * Touch Action Function Parameters 9043 * 9044 * @interface TouchEvent 9045 * @syscap SystemCapability.ArkUI.ArkUI.Full 9046 * @crossplatform 9047 * @atomicservice 9048 * @since 11 9049 */ 9050declare interface TouchEvent extends BaseEvent { 9051 /** 9052 * Type of the touch event. 9053 * 9054 * @type { TouchType } 9055 * @syscap SystemCapability.ArkUI.ArkUI.Full 9056 * @since 7 9057 */ 9058 /** 9059 * Type of the touch event. 9060 * 9061 * @type { TouchType } 9062 * @syscap SystemCapability.ArkUI.ArkUI.Full 9063 * @crossplatform 9064 * @since 10 9065 */ 9066 /** 9067 * Type of the touch event. 9068 * 9069 * @type { TouchType } 9070 * @syscap SystemCapability.ArkUI.ArkUI.Full 9071 * @crossplatform 9072 * @atomicservice 9073 * @since 11 9074 */ 9075 type: TouchType; 9076 9077 /** 9078 * All finger information. 9079 * 9080 * @type { TouchObject[] } 9081 * @syscap SystemCapability.ArkUI.ArkUI.Full 9082 * @since 7 9083 */ 9084 /** 9085 * All finger information. 9086 * 9087 * @type { TouchObject[] } 9088 * @syscap SystemCapability.ArkUI.ArkUI.Full 9089 * @crossplatform 9090 * @since 10 9091 */ 9092 /** 9093 * All finger information. 9094 * 9095 * @type { TouchObject[] } 9096 * @syscap SystemCapability.ArkUI.ArkUI.Full 9097 * @crossplatform 9098 * @atomicservice 9099 * @since 11 9100 */ 9101 touches: TouchObject[]; 9102 9103 /** 9104 * Indicates the current changed finger information. 9105 * 9106 * @type { TouchObject[] } 9107 * @syscap SystemCapability.ArkUI.ArkUI.Full 9108 * @since 7 9109 */ 9110 /** 9111 * Indicates the current changed finger information. 9112 * 9113 * @type { TouchObject[] } 9114 * @syscap SystemCapability.ArkUI.ArkUI.Full 9115 * @crossplatform 9116 * @since 10 9117 */ 9118 /** 9119 * Indicates the current changed finger information. 9120 * 9121 * @type { TouchObject[] } 9122 * @syscap SystemCapability.ArkUI.ArkUI.Full 9123 * @crossplatform 9124 * @atomicservice 9125 * @since 11 9126 */ 9127 changedTouches: TouchObject[]; 9128 9129 /** 9130 * The blocking event pops up. 9131 * 9132 * @type { function } 9133 * @syscap SystemCapability.ArkUI.ArkUI.Full 9134 * @since 7 9135 */ 9136 /** 9137 * The blocking event pops up. 9138 * 9139 * @type { function } 9140 * @syscap SystemCapability.ArkUI.ArkUI.Full 9141 * @crossplatform 9142 * @since 10 9143 */ 9144 /** 9145 * The blocking event pops up. 9146 * 9147 * @type { function } 9148 * @syscap SystemCapability.ArkUI.ArkUI.Full 9149 * @crossplatform 9150 * @atomicservice 9151 * @since 11 9152 */ 9153 stopPropagation: () => void; 9154 9155 /** 9156 * Get the historical points. 9157 * 9158 * @returns { Array<HistoricalPoint> } - return all historical points. 9159 * @syscap SystemCapability.ArkUI.ArkUI.Full 9160 * @crossplatform 9161 * @since 10 9162 */ 9163 /** 9164 * Get the historical points. 9165 * 9166 * @returns { Array<HistoricalPoint> } - return all historical points. 9167 * @syscap SystemCapability.ArkUI.ArkUI.Full 9168 * @crossplatform 9169 * @atomicservice 9170 * @since 11 9171 */ 9172 getHistoricalPoints(): Array<HistoricalPoint>; 9173 9174 /** 9175 * Prevent the default function. 9176 * 9177 * @type { function } 9178 * @syscap SystemCapability.ArkUI.ArkUI.Full 9179 * @crossplatform 9180 * @atomicservice 9181 * @since 12 9182 */ 9183 preventDefault: () => void; 9184} 9185 9186/** 9187 * Defines the callback type used in onSizeChange. 9188 * The value of oldValue is last size of the component. 9189 * The value of newValue is new size of the component. 9190 * 9191 * @typedef { function } SizeChangeCallback 9192 * @syscap SystemCapability.ArkUI.ArkUI.Full 9193 * @crossplatform 9194 * @form 9195 * @atomicservice 9196 * @since 12 9197 */ 9198declare type SizeChangeCallback = (oldValue: SizeOptions, newValue: SizeOptions) => void; 9199 9200/** 9201 * Defines the callback type used in onGestureRecognizerJudgeBegin. 9202 * 9203 * @typedef { function } GestureRecognizerJudgeBeginCallback 9204 * @param { BaseGestureEvent } event - the event information 9205 * @param { GestureRecognizer } current - the current gesture recognizer of the component 9206 * @param { Array<GestureRecognizer> } recognizers - the gesture recognizers of the component on the response chain 9207 * @returns { GestureJudgeResult } the gesture judge result 9208 * @syscap SystemCapability.ArkUI.ArkUI.Full 9209 * @crossplatform 9210 * @atomicservice 9211 * @since 12 9212 */ 9213declare type GestureRecognizerJudgeBeginCallback = (event: BaseGestureEvent, current: GestureRecognizer, recognizers: Array<GestureRecognizer>) => GestureJudgeResult; 9214 9215/** 9216 * Defines the callback type used in shouldBuiltInRecognizerParallelWith. 9217 * 9218 * @typedef { function } ShouldBuiltInRecognizerParallelWithCallback 9219 * @param { GestureRecognizer } current - the current gesture recognizer of the component 9220 * @param { Array<GestureRecognizer> } others - the gesture recognizers of the component on the response chain 9221 * @returns { GestureRecognizer } gesture recognizer of the component 9222 * @syscap SystemCapability.ArkUI.ArkUI.Full 9223 * @crossplatform 9224 * @atomicservice 9225 * @since 12 9226 */ 9227declare type ShouldBuiltInRecognizerParallelWithCallback = (current: GestureRecognizer, others: Array<GestureRecognizer>) => GestureRecognizer; 9228 9229/** 9230 * Defines the finish callback type used in transition. 9231 * 9232 * @typedef { function } TransitionFinishCallback 9233 * @param { boolean } transitionIn - a boolean value indicates whether it is the callback of transitionIn or transitionOut. 9234 * @syscap SystemCapability.ArkUI.ArkUI.Full 9235 * @crossplatform 9236 * @form 9237 * @atomicservice 9238 * @since 12 9239 */ 9240declare type TransitionFinishCallback = (transitionIn: boolean) => void; 9241 9242/** 9243 * Defines the PixelMap type object for ui component. 9244 * 9245 * @syscap SystemCapability.ArkUI.ArkUI.Full 9246 * @since 7 9247 */ 9248/** 9249 * Defines the PixelMap type object for ui component. 9250 * 9251 * @syscap SystemCapability.ArkUI.ArkUI.Full 9252 * @crossplatform 9253 * @since 10 9254 */ 9255/** 9256 * Defines the PixelMap type object for ui component. 9257 * 9258 * @typedef { import('../api/@ohos.multimedia.image').default.PixelMap } PixelMap 9259 * @syscap SystemCapability.ArkUI.ArkUI.Full 9260 * @crossplatform 9261 * @atomicservice 9262 * @since 11 9263 */ 9264declare type PixelMap = import('../api/@ohos.multimedia.image').default.PixelMap; 9265 9266/** 9267 * pixelmap object with release function. 9268 * 9269 * @interface PixelMapMock 9270 * @syscap SystemCapability.ArkUI.ArkUI.Full 9271 * @systemapi 9272 * @since 7 9273 */ 9274declare interface PixelMapMock { 9275 /** 9276 * release function. 9277 * 9278 * @syscap SystemCapability.ArkUI.ArkUI.Full 9279 * @systemapi 9280 * @since 7 9281 */ 9282 release(): void; 9283} 9284 9285/** 9286 * Enum for Drag Behavior. 9287 * 9288 * @enum { number } 9289 * @syscap SystemCapability.ArkUI.ArkUI.Full 9290 * @since 10 9291 */ 9292/** 9293 * Enum for Drag Behavior. 9294 * 9295 * @enum { number } 9296 * @syscap SystemCapability.ArkUI.ArkUI.Full 9297 * @atomicservice 9298 * @since 11 9299 */ 9300declare enum DragBehavior { 9301 /** 9302 * If drag use copy event, then set DragBehavior.COPY. 9303 * 9304 * @syscap SystemCapability.ArkUI.ArkUI.Full 9305 * @since 10 9306 */ 9307 /** 9308 * If drag use copy event, then set DragBehavior.COPY. 9309 * 9310 * @syscap SystemCapability.ArkUI.ArkUI.Full 9311 * @atomicservice 9312 * @since 11 9313 */ 9314 COPY, 9315 /** 9316 * If drag use move event, then set DragBehavior.MOVE. 9317 * 9318 * @syscap SystemCapability.ArkUI.ArkUI.Full 9319 * @since 10 9320 */ 9321 /** 9322 * If drag use move event, then set DragBehavior.MOVE. 9323 * 9324 * @syscap SystemCapability.ArkUI.ArkUI.Full 9325 * @atomicservice 9326 * @since 11 9327 */ 9328 MOVE 9329} 9330 9331/** 9332 * Import the UnifiedData type object for ui component. 9333 * 9334 * @typedef { import('../api/@ohos.data.unifiedDataChannel').default.UnifiedData } UnifiedData 9335 * @syscap SystemCapability.ArkUI.ArkUI.Full 9336 * @crossplatform 9337 * @since 10 9338 */ 9339/** 9340 * Import the UnifiedData type object for ui component. 9341 * 9342 * @typedef { import('../api/@ohos.data.unifiedDataChannel').default.UnifiedData } UnifiedData 9343 * @syscap SystemCapability.ArkUI.ArkUI.Full 9344 * @crossplatform 9345 * @atomicservice 9346 * @since 11 9347 */ 9348declare type UnifiedData = import('../api/@ohos.data.unifiedDataChannel').default.UnifiedData; 9349 9350/** 9351 * Import the Summary type object for ui component. 9352 * 9353 * @typedef { import('../api/@ohos.data.unifiedDataChannel').default.Summary } Summary 9354 * @syscap SystemCapability.ArkUI.ArkUI.Full 9355 * @since 10 9356 */ 9357/** 9358 * Import the Summary type object for ui component. 9359 * 9360 * @typedef { import('../api/@ohos.data.unifiedDataChannel').default.Summary } Summary 9361 * @syscap SystemCapability.ArkUI.ArkUI.Full 9362 * @atomicservice 9363 * @since 11 9364 */ 9365declare type Summary = import('../api/@ohos.data.unifiedDataChannel').default.Summary; 9366 9367/** 9368 * Import the UniformDataType type object for ui component. 9369 * 9370 * @typedef { import('../api/@ohos.data.uniformTypeDescriptor').default.UniformDataType } UniformDataType 9371 * @syscap SystemCapability.ArkUI.ArkUI.Full 9372 * @since 10 9373 */ 9374/** 9375 * Import the UniformDataType type object for ui component. 9376 * 9377 * @typedef { import('../api/@ohos.data.uniformTypeDescriptor').default.UniformDataType } UniformDataType 9378 * @syscap SystemCapability.ArkUI.ArkUI.Full 9379 * @atomicservice 9380 * @since 11 9381 */ 9382declare type UniformDataType = import('../api/@ohos.data.uniformTypeDescriptor').default.UniformDataType; 9383 9384/** 9385 * Enum for Drag Result. 9386 * 9387 * @enum { number } 9388 * @syscap SystemCapability.ArkUI.ArkUI.Full 9389 * @since 10 9390 */ 9391/** 9392 * Enum for Drag Result. 9393 * 9394 * @enum { number } 9395 * @syscap SystemCapability.ArkUI.ArkUI.Full 9396 * @atomicservice 9397 * @since 11 9398 */ 9399/** 9400 * Enum for Drag Result. 9401 * 9402 * @enum { number } 9403 * @syscap SystemCapability.ArkUI.ArkUI.Full 9404 * @crossplatform 9405 * @atomicservice 9406 * @since 13 9407 */ 9408declare enum DragResult { 9409 /** 9410 * If the drag is successful, return DragResult.DRAG_SUCCESSFUL. 9411 * 9412 * @syscap SystemCapability.ArkUI.ArkUI.Full 9413 * @since 10 9414 */ 9415 /** 9416 * If the drag is successful, return DragResult.DRAG_SUCCESSFUL. 9417 * 9418 * @syscap SystemCapability.ArkUI.ArkUI.Full 9419 * @atomicservice 9420 * @since 11 9421 */ 9422 /** 9423 * If the drag is successful, return DragResult.DRAG_SUCCESSFUL. 9424 * 9425 * @syscap SystemCapability.ArkUI.ArkUI.Full 9426 * @crossplatform 9427 * @atomicservice 9428 * @since 13 9429 */ 9430 DRAG_SUCCESSFUL = 0, 9431 /** 9432 * If drag fail, return DragResult.DRAG_FAILED. 9433 * 9434 * @syscap SystemCapability.ArkUI.ArkUI.Full 9435 * @since 10 9436 */ 9437 /** 9438 * If drag fail, return DragResult.DRAG_FAILED. 9439 * 9440 * @syscap SystemCapability.ArkUI.ArkUI.Full 9441 * @atomicservice 9442 * @since 11 9443 */ 9444 /** 9445 * If drag fail, return DragResult.DRAG_FAILED. 9446 * 9447 * @syscap SystemCapability.ArkUI.ArkUI.Full 9448 * @crossplatform 9449 * @atomicservice 9450 * @since 13 9451 */ 9452 DRAG_FAILED = 1, 9453 /** 9454 * If drag action cancel, return DragResult.DRAG_CANCELED. 9455 * 9456 * @syscap SystemCapability.ArkUI.ArkUI.Full 9457 * @since 10 9458 */ 9459 /** 9460 * If drag action cancel, return DragResult.DRAG_CANCELED. 9461 * 9462 * @syscap SystemCapability.ArkUI.ArkUI.Full 9463 * @atomicservice 9464 * @since 11 9465 */ 9466 DRAG_CANCELED = 2, 9467 /** 9468 * If node allow drop in, return DragResult.DROP_ENABLED. 9469 * 9470 * @syscap SystemCapability.ArkUI.ArkUI.Full 9471 * @since 10 9472 */ 9473 /** 9474 * If node allow drop in, return DragResult.DROP_ENABLED. 9475 * 9476 * @syscap SystemCapability.ArkUI.ArkUI.Full 9477 * @atomicservice 9478 * @since 11 9479 */ 9480 DROP_ENABLED = 3, 9481 /** 9482 * If node don't allow drop in, return DragResult.DROP_DISABLED. 9483 * 9484 * @syscap SystemCapability.ArkUI.ArkUI.Full 9485 * @since 10 9486 */ 9487 /** 9488 * If node don't allow drop in, return DragResult.DROP_DISABLED. 9489 * 9490 * @syscap SystemCapability.ArkUI.ArkUI.Full 9491 * @atomicservice 9492 * @since 11 9493 */ 9494 DROP_DISABLED = 4 9495} 9496 9497/** 9498 * Enum for BlendMode. 9499 * Blend modes for compositing current component 9500 * with overlapping content. Use overlapping content 9501 * as dst, current component as src. 9502 * 9503 * @enum { number } 9504 * @syscap SystemCapability.ArkUI.ArkUI.Full 9505 * @crossplatform 9506 * @form 9507 * @since 11 9508 */ 9509/** 9510 * Enum for BlendMode. 9511 * Blend modes for compositing current component 9512 * with overlapping content. Use overlapping content 9513 * as dst, current component as src. 9514 * 9515 * @enum { number } 9516 * @syscap SystemCapability.ArkUI.ArkUI.Full 9517 * @crossplatform 9518 * @form 9519 * @atomicservice 9520 * @since 12 9521 */ 9522declare enum BlendMode { 9523 /** 9524 * Hybrid mode does not take effect 9525 * 9526 * @syscap SystemCapability.ArkUI.ArkUI.Full 9527 * @crossplatform 9528 * @form 9529 * @since 11 9530 */ 9531 /** 9532 * Hybrid mode does not take effect 9533 * 9534 * @syscap SystemCapability.ArkUI.ArkUI.Full 9535 * @crossplatform 9536 * @form 9537 * @atomicservice 9538 * @since 12 9539 */ 9540 NONE = 0, 9541 /** 9542 * Clear destination color covered by the source to 0. 9543 * 9544 * @syscap SystemCapability.ArkUI.ArkUI.Full 9545 * @crossplatform 9546 * @form 9547 * @since 11 9548 */ 9549 /** 9550 * Clear destination color covered by the source to 0. 9551 * 9552 * @syscap SystemCapability.ArkUI.ArkUI.Full 9553 * @crossplatform 9554 * @form 9555 * @atomicservice 9556 * @since 12 9557 */ 9558 CLEAR = 1, 9559 /** 9560 * r = s 9561 * 9562 * @syscap SystemCapability.ArkUI.ArkUI.Full 9563 * @crossplatform 9564 * @form 9565 * @since 11 9566 */ 9567 /** 9568 * r = s 9569 * 9570 * @syscap SystemCapability.ArkUI.ArkUI.Full 9571 * @crossplatform 9572 * @form 9573 * @atomicservice 9574 * @since 12 9575 */ 9576 SRC = 2, 9577 /** 9578 * r = d 9579 * 9580 * @syscap SystemCapability.ArkUI.ArkUI.Full 9581 * @crossplatform 9582 * @form 9583 * @since 11 9584 */ 9585 /** 9586 * r = d 9587 * 9588 * @syscap SystemCapability.ArkUI.ArkUI.Full 9589 * @crossplatform 9590 * @form 9591 * @atomicservice 9592 * @since 12 9593 */ 9594 DST = 3, 9595 /** 9596 * r = s + (1 - sa) * d 9597 * 9598 * @syscap SystemCapability.ArkUI.ArkUI.Full 9599 * @crossplatform 9600 * @form 9601 * @since 11 9602 */ 9603 /** 9604 * r = s + (1 - sa) * d 9605 * 9606 * @syscap SystemCapability.ArkUI.ArkUI.Full 9607 * @crossplatform 9608 * @form 9609 * @atomicservice 9610 * @since 12 9611 */ 9612 SRC_OVER = 4, 9613 /** 9614 * r = d + (1 - da) * s 9615 * 9616 * @syscap SystemCapability.ArkUI.ArkUI.Full 9617 * @crossplatform 9618 * @form 9619 * @since 11 9620 */ 9621 /** 9622 * r = d + (1 - da) * s 9623 * 9624 * @syscap SystemCapability.ArkUI.ArkUI.Full 9625 * @crossplatform 9626 * @form 9627 * @atomicservice 9628 * @since 12 9629 */ 9630 DST_OVER = 5, 9631 /** 9632 * r = s * da 9633 * 9634 * @syscap SystemCapability.ArkUI.ArkUI.Full 9635 * @crossplatform 9636 * @form 9637 * @since 11 9638 */ 9639 /** 9640 * r = s * da 9641 * 9642 * @syscap SystemCapability.ArkUI.ArkUI.Full 9643 * @crossplatform 9644 * @form 9645 * @atomicservice 9646 * @since 12 9647 */ 9648 SRC_IN = 6, 9649 /** 9650 * r = d * sa 9651 * 9652 * @syscap SystemCapability.ArkUI.ArkUI.Full 9653 * @crossplatform 9654 * @form 9655 * @since 11 9656 */ 9657 /** 9658 * r = d * sa 9659 * 9660 * @syscap SystemCapability.ArkUI.ArkUI.Full 9661 * @crossplatform 9662 * @form 9663 * @atomicservice 9664 * @since 12 9665 */ 9666 DST_IN = 7, 9667 /** 9668 * r = s * (1 - da) 9669 * 9670 * @syscap SystemCapability.ArkUI.ArkUI.Full 9671 * @crossplatform 9672 * @form 9673 * @since 11 9674 */ 9675 /** 9676 * r = s * (1 - da) 9677 * 9678 * @syscap SystemCapability.ArkUI.ArkUI.Full 9679 * @crossplatform 9680 * @form 9681 * @atomicservice 9682 * @since 12 9683 */ 9684 SRC_OUT = 8, 9685 /** 9686 * r = d * (1 - sa) 9687 * 9688 * @syscap SystemCapability.ArkUI.ArkUI.Full 9689 * @crossplatform 9690 * @form 9691 * @since 11 9692 */ 9693 /** 9694 * r = d * (1 - sa) 9695 * 9696 * @syscap SystemCapability.ArkUI.ArkUI.Full 9697 * @crossplatform 9698 * @form 9699 * @atomicservice 9700 * @since 12 9701 */ 9702 DST_OUT = 9, 9703 /** 9704 * r = s * da + d * (1 - sa) 9705 * 9706 * @syscap SystemCapability.ArkUI.ArkUI.Full 9707 * @crossplatform 9708 * @form 9709 * @since 11 9710 */ 9711 /** 9712 * r = s * da + d * (1 - sa) 9713 * 9714 * @syscap SystemCapability.ArkUI.ArkUI.Full 9715 * @crossplatform 9716 * @form 9717 * @atomicservice 9718 * @since 12 9719 */ 9720 SRC_ATOP = 10, 9721 /** 9722 * r = d * sa + s * (1 - da) 9723 * 9724 * @syscap SystemCapability.ArkUI.ArkUI.Full 9725 * @crossplatform 9726 * @form 9727 * @since 11 9728 */ 9729 /** 9730 * r = d * sa + s * (1 - da) 9731 * 9732 * @syscap SystemCapability.ArkUI.ArkUI.Full 9733 * @crossplatform 9734 * @form 9735 * @atomicservice 9736 * @since 12 9737 */ 9738 DST_ATOP = 11, 9739 /** 9740 * r = s * (1 - da) + d * (1 - sa) 9741 * 9742 * @syscap SystemCapability.ArkUI.ArkUI.Full 9743 * @crossplatform 9744 * @form 9745 * @since 11 9746 */ 9747 /** 9748 * r = s * (1 - da) + d * (1 - sa) 9749 * 9750 * @syscap SystemCapability.ArkUI.ArkUI.Full 9751 * @crossplatform 9752 * @form 9753 * @atomicservice 9754 * @since 12 9755 */ 9756 XOR = 12, 9757 /** 9758 * r = min(s + d, 1) 9759 * 9760 * @syscap SystemCapability.ArkUI.ArkUI.Full 9761 * @crossplatform 9762 * @form 9763 * @since 11 9764 */ 9765 /** 9766 * r = min(s + d, 1) 9767 * 9768 * @syscap SystemCapability.ArkUI.ArkUI.Full 9769 * @crossplatform 9770 * @form 9771 * @atomicservice 9772 * @since 12 9773 */ 9774 PLUS = 13, 9775 /** 9776 * r = s * d 9777 * 9778 * @syscap SystemCapability.ArkUI.ArkUI.Full 9779 * @crossplatform 9780 * @form 9781 * @since 11 9782 */ 9783 /** 9784 * r = s * d 9785 * 9786 * @syscap SystemCapability.ArkUI.ArkUI.Full 9787 * @crossplatform 9788 * @form 9789 * @atomicservice 9790 * @since 12 9791 */ 9792 MODULATE = 14, 9793 /** 9794 * r = s + d - s * d 9795 * 9796 * @syscap SystemCapability.ArkUI.ArkUI.Full 9797 * @crossplatform 9798 * @form 9799 * @since 11 9800 */ 9801 /** 9802 * r = s + d - s * d 9803 * 9804 * @syscap SystemCapability.ArkUI.ArkUI.Full 9805 * @crossplatform 9806 * @form 9807 * @atomicservice 9808 * @since 12 9809 */ 9810 SCREEN = 15, 9811 /** 9812 * multiply or screen, depending on destination 9813 * 9814 * @syscap SystemCapability.ArkUI.ArkUI.Full 9815 * @crossplatform 9816 * @form 9817 * @since 11 9818 */ 9819 /** 9820 * multiply or screen, depending on destination 9821 * 9822 * @syscap SystemCapability.ArkUI.ArkUI.Full 9823 * @crossplatform 9824 * @form 9825 * @atomicservice 9826 * @since 12 9827 */ 9828 OVERLAY = 16, 9829 /** 9830 * rc = s + d - max(s * da, d * sa), ra = kSrcOver 9831 * 9832 * @syscap SystemCapability.ArkUI.ArkUI.Full 9833 * @crossplatform 9834 * @form 9835 * @since 11 9836 */ 9837 /** 9838 * rc = s + d - max(s * da, d * sa), ra = kSrcOver 9839 * 9840 * @syscap SystemCapability.ArkUI.ArkUI.Full 9841 * @crossplatform 9842 * @form 9843 * @atomicservice 9844 * @since 12 9845 */ 9846 DARKEN = 17, 9847 /** 9848 * rc = s + d - min(s * da, d * sa), ra = kSrcOver 9849 * 9850 * @syscap SystemCapability.ArkUI.ArkUI.Full 9851 * @crossplatform 9852 * @form 9853 * @since 11 9854 */ 9855 /** 9856 * rc = s + d - min(s * da, d * sa), ra = kSrcOver 9857 * 9858 * @syscap SystemCapability.ArkUI.ArkUI.Full 9859 * @crossplatform 9860 * @form 9861 * @atomicservice 9862 * @since 12 9863 */ 9864 LIGHTEN = 18, 9865 /** 9866 * brighten destination to reflect source 9867 * 9868 * @syscap SystemCapability.ArkUI.ArkUI.Full 9869 * @crossplatform 9870 * @form 9871 * @since 11 9872 */ 9873 /** 9874 * brighten destination to reflect source 9875 * 9876 * @syscap SystemCapability.ArkUI.ArkUI.Full 9877 * @crossplatform 9878 * @form 9879 * @atomicservice 9880 * @since 12 9881 */ 9882 COLOR_DODGE = 19, 9883 /** 9884 * darken destination to reflect source 9885 * 9886 * @syscap SystemCapability.ArkUI.ArkUI.Full 9887 * @crossplatform 9888 * @form 9889 * @since 11 9890 */ 9891 /** 9892 * darken destination to reflect source 9893 * 9894 * @syscap SystemCapability.ArkUI.ArkUI.Full 9895 * @crossplatform 9896 * @form 9897 * @atomicservice 9898 * @since 12 9899 */ 9900 COLOR_BURN = 20, 9901 /** 9902 * multiply or screen, depending on source 9903 * 9904 * @syscap SystemCapability.ArkUI.ArkUI.Full 9905 * @crossplatform 9906 * @form 9907 * @since 11 9908 */ 9909 /** 9910 * multiply or screen, depending on source 9911 * 9912 * @syscap SystemCapability.ArkUI.ArkUI.Full 9913 * @crossplatform 9914 * @form 9915 * @atomicservice 9916 * @since 12 9917 */ 9918 HARD_LIGHT = 21, 9919 /** 9920 * lighten or darken, depending on source 9921 * 9922 * @syscap SystemCapability.ArkUI.ArkUI.Full 9923 * @crossplatform 9924 * @form 9925 * @since 11 9926 */ 9927 /** 9928 * lighten or darken, depending on source 9929 * 9930 * @syscap SystemCapability.ArkUI.ArkUI.Full 9931 * @crossplatform 9932 * @form 9933 * @atomicservice 9934 * @since 12 9935 */ 9936 SOFT_LIGHT = 22, 9937 /** 9938 * rc = s + d - 2 * (min(s * da, d * sa)), ra = kSrcOver 9939 * 9940 * @syscap SystemCapability.ArkUI.ArkUI.Full 9941 * @crossplatform 9942 * @form 9943 * @since 11 9944 */ 9945 /** 9946 * rc = s + d - 2 * (min(s * da, d * sa)), ra = kSrcOver 9947 * 9948 * @syscap SystemCapability.ArkUI.ArkUI.Full 9949 * @crossplatform 9950 * @form 9951 * @atomicservice 9952 * @since 12 9953 */ 9954 DIFFERENCE = 23, 9955 /** 9956 * rc = s + d - two(s * d), ra = kSrcOver 9957 * 9958 * @syscap SystemCapability.ArkUI.ArkUI.Full 9959 * @crossplatform 9960 * @form 9961 * @since 11 9962 */ 9963 /** 9964 * rc = s + d - two(s * d), ra = kSrcOver 9965 * 9966 * @syscap SystemCapability.ArkUI.ArkUI.Full 9967 * @crossplatform 9968 * @form 9969 * @atomicservice 9970 * @since 12 9971 */ 9972 EXCLUSION = 24, 9973 /** 9974 * r = s * (1 - da) + d * (1 - sa) + s * d 9975 * 9976 * @syscap SystemCapability.ArkUI.ArkUI.Full 9977 * @crossplatform 9978 * @form 9979 * @since 11 9980 */ 9981 /** 9982 * r = s * (1 - da) + d * (1 - sa) + s * d 9983 * 9984 * @syscap SystemCapability.ArkUI.ArkUI.Full 9985 * @crossplatform 9986 * @form 9987 * @atomicservice 9988 * @since 12 9989 */ 9990 MULTIPLY = 25, 9991 /** 9992 * hue of source with saturation and luminosity of destination 9993 * 9994 * @syscap SystemCapability.ArkUI.ArkUI.Full 9995 * @crossplatform 9996 * @form 9997 * @since 11 9998 */ 9999 /** 10000 * hue of source with saturation and luminosity of destination 10001 * 10002 * @syscap SystemCapability.ArkUI.ArkUI.Full 10003 * @crossplatform 10004 * @form 10005 * @atomicservice 10006 * @since 12 10007 */ 10008 HUE = 26, 10009 /** 10010 * saturation of source with hue and luminosity of destination 10011 * 10012 * @syscap SystemCapability.ArkUI.ArkUI.Full 10013 * @crossplatform 10014 * @form 10015 * @since 11 10016 */ 10017 /** 10018 * saturation of source with hue and luminosity of destination 10019 * 10020 * @syscap SystemCapability.ArkUI.ArkUI.Full 10021 * @crossplatform 10022 * @form 10023 * @atomicservice 10024 * @since 12 10025 */ 10026 SATURATION = 27, 10027 /** 10028 * hue and saturation of source with luminosity of destination 10029 * 10030 * @syscap SystemCapability.ArkUI.ArkUI.Full 10031 * @crossplatform 10032 * @form 10033 * @since 11 10034 */ 10035 /** 10036 * hue and saturation of source with luminosity of destination 10037 * 10038 * @syscap SystemCapability.ArkUI.ArkUI.Full 10039 * @crossplatform 10040 * @form 10041 * @atomicservice 10042 * @since 12 10043 */ 10044 COLOR = 28, 10045 /** 10046 * luminosity of source with hue and saturation of destination 10047 * 10048 * @syscap SystemCapability.ArkUI.ArkUI.Full 10049 * @crossplatform 10050 * @form 10051 * @since 11 10052 */ 10053 /** 10054 * luminosity of source with hue and saturation of destination 10055 * 10056 * @syscap SystemCapability.ArkUI.ArkUI.Full 10057 * @crossplatform 10058 * @form 10059 * @atomicservice 10060 * @since 12 10061 */ 10062 LUMINOSITY = 29 10063} 10064 10065/** 10066 * Enum for BlendApplyType. 10067 * Indicate how to apply specified blend mode to 10068 * the view's content. 10069 * 10070 * @enum { number } 10071 * @syscap SystemCapability.ArkUI.ArkUI.Full 10072 * @crossplatform 10073 * @form 10074 * @since 11 10075 */ 10076/** 10077 * Enum for BlendApplyType. 10078 * Indicate how to apply specified blend mode to 10079 * the view's content. 10080 * 10081 * @enum { number } 10082 * @syscap SystemCapability.ArkUI.ArkUI.Full 10083 * @crossplatform 10084 * @form 10085 * @atomicservice 10086 * @since 12 10087 */ 10088declare enum BlendApplyType { 10089 /** 10090 * Blend view's content in sequence over dst 10091 * 10092 * @syscap SystemCapability.ArkUI.ArkUI.Full 10093 * @crossplatform 10094 * @form 10095 * @since 11 10096 */ 10097 /** 10098 * Blend view's content in sequence over dst 10099 * 10100 * @syscap SystemCapability.ArkUI.ArkUI.Full 10101 * @crossplatform 10102 * @form 10103 * @atomicservice 10104 * @since 12 10105 */ 10106 FAST = 0, 10107 10108 /** 10109 * Composite this views's contents into an 10110 * offscreen image and then blend over dst 10111 * 10112 * @syscap SystemCapability.ArkUI.ArkUI.Full 10113 * @crossplatform 10114 * @form 10115 * @since 11 10116 */ 10117 /** 10118 * Composite this views's contents into an 10119 * offscreen image and then blend over dst 10120 * 10121 * @syscap SystemCapability.ArkUI.ArkUI.Full 10122 * @crossplatform 10123 * @form 10124 * @atomicservice 10125 * @since 12 10126 */ 10127 OFFSCREEN = 1, 10128} 10129 10130/** 10131 * DragEvent object description 10132 * 10133 * @interface DragEvent 10134 * @syscap SystemCapability.ArkUI.ArkUI.Full 10135 * @since 7 10136 */ 10137/** 10138 * DragEvent object description 10139 * 10140 * @interface DragEvent 10141 * @syscap SystemCapability.ArkUI.ArkUI.Full 10142 * @atomicservice 10143 * @since 11 10144 */ 10145/** 10146 * DragEvent object description 10147 * 10148 * @interface DragEvent 10149 * @syscap SystemCapability.ArkUI.ArkUI.Full 10150 * @crossplatform 10151 * @atomicservice 10152 * @since 13 10153 */ 10154declare interface DragEvent { 10155 /** 10156 * X coordinate of the touch point relative to the left edge of the device screen. 10157 * 10158 * @returns { number } 10159 * @syscap SystemCapability.ArkUI.ArkUI.Full 10160 * @since 10 10161 */ 10162 /** 10163 * X coordinate of the touch point relative to the left edge of the device screen. 10164 * 10165 * @returns { number } 10166 * @syscap SystemCapability.ArkUI.ArkUI.Full 10167 * @atomicservice 10168 * @since 11 10169 */ 10170 /** 10171 * X coordinate of the touch point relative to the left edge of the device screen. 10172 * 10173 * @returns { number } 10174 * @syscap SystemCapability.ArkUI.ArkUI.Full 10175 * @crossplatform 10176 * @atomicservice 10177 * @since 13 10178 */ 10179 getDisplayX(): number; 10180 10181 /** 10182 * Y coordinate of the touch point relative to the upper edge of the device screen. 10183 * 10184 * @returns { number } 10185 * @syscap SystemCapability.ArkUI.ArkUI.Full 10186 * @since 10 10187 */ 10188 /** 10189 * Y coordinate of the touch point relative to the upper edge of the device screen. 10190 * 10191 * @returns { number } 10192 * @syscap SystemCapability.ArkUI.ArkUI.Full 10193 * @atomicservice 10194 * @since 11 10195 */ 10196 /** 10197 * Y coordinate of the touch point relative to the upper edge of the device screen. 10198 * 10199 * @returns { number } 10200 * @syscap SystemCapability.ArkUI.ArkUI.Full 10201 * @crossplatform 10202 * @atomicservice 10203 * @since 13 10204 */ 10205 getDisplayY(): number; 10206 10207 /** 10208 * X coordinate of the touch point relative to the left edge of the current window. 10209 * 10210 * @returns { number } 10211 * @syscap SystemCapability.ArkUI.ArkUI.Full 10212 * @since 10 10213 */ 10214 /** 10215 * X coordinate of the touch point relative to the left edge of the current window. 10216 * 10217 * @returns { number } 10218 * @syscap SystemCapability.ArkUI.ArkUI.Full 10219 * @atomicservice 10220 * @since 11 10221 */ 10222 /** 10223 * X coordinate of the touch point relative to the left edge of the current window. 10224 * 10225 * @returns { number } 10226 * @syscap SystemCapability.ArkUI.ArkUI.Full 10227 * @crossplatform 10228 * @atomicservice 10229 * @since 13 10230 */ 10231 getWindowX(): number; 10232 10233 /** 10234 * Y coordinate of the touch point relative to the left edge of the current window. 10235 * 10236 * @returns { number } 10237 * @syscap SystemCapability.ArkUI.ArkUI.Full 10238 * @since 10 10239 */ 10240 /** 10241 * Y coordinate of the touch point relative to the left edge of the current window. 10242 * 10243 * @returns { number } 10244 * @syscap SystemCapability.ArkUI.ArkUI.Full 10245 * @atomicservice 10246 * @since 11 10247 */ 10248 /** 10249 * Y coordinate of the touch point relative to the left edge of the current window. 10250 * 10251 * @returns { number } 10252 * @syscap SystemCapability.ArkUI.ArkUI.Full 10253 * @crossplatform 10254 * @atomicservice 10255 * @since 13 10256 */ 10257 getWindowY(): number; 10258 10259 /** 10260 * X coordinate of the touch point relative to the left edge of the current window. in vp. 10261 * 10262 * @returns { number } 10263 * @syscap SystemCapability.ArkUI.ArkUI.Full 10264 * @since 7 10265 * @deprecated since 10 10266 * @useinstead DragEvent#getWindowX 10267 */ 10268 getX(): number; 10269 10270 /** 10271 * Y coordinate of the touch point relative to the left edge of the current window. in vp. 10272 * 10273 * @returns { number } 10274 * @syscap SystemCapability.ArkUI.ArkUI.Full 10275 * @since 7 10276 * @deprecated since 10 10277 * @useinstead DragEvent#getWindowY 10278 */ 10279 getY(): number; 10280 10281 /** 10282 * If copy is COPY, this DragEvent is a copy event. 10283 * @type { DragBehavior } Operation, if use copy then set COPY, else set MOVE. 10284 * @default COPY 10285 * @syscap SystemCapability.ArkUI.ArkUI.Full 10286 * @since 10 10287 */ 10288 /** 10289 * If copy is COPY, this DragEvent is a copy event. 10290 * @type { DragBehavior } Operation, if use copy then set COPY, else set MOVE. 10291 * @default COPY 10292 * @syscap SystemCapability.ArkUI.ArkUI.Full 10293 * @atomicservice 10294 * @since 11 10295 */ 10296 dragBehavior: DragBehavior; 10297 10298 /** 10299 * If useCustomDropAnimation is true, System will not use drop animation. 10300 * 10301 * @type { boolean } 10302 * @syscap SystemCapability.ArkUI.ArkUI.Full 10303 * @since 10 10304 */ 10305 /** 10306 * If useCustomDropAnimation is true, System will not use drop animation. 10307 * 10308 * @type { boolean } 10309 * @syscap SystemCapability.ArkUI.ArkUI.Full 10310 * @atomicservice 10311 * @since 11 10312 */ 10313 useCustomDropAnimation: boolean; 10314 10315 /** 10316 * Set dragData into DragEvent. 10317 * 10318 * @param { UnifiedData } unifiedData - dragData. 10319 * @syscap SystemCapability.ArkUI.ArkUI.Full 10320 * @crossplatform 10321 * @since 10 10322 */ 10323 /** 10324 * Set dragData into DragEvent. 10325 * 10326 * @param { UnifiedData } unifiedData - dragData. 10327 * @syscap SystemCapability.ArkUI.ArkUI.Full 10328 * @crossplatform 10329 * @atomicservice 10330 * @since 11 10331 */ 10332 setData(unifiedData: UnifiedData): void; 10333 10334 /** 10335 * Get dragData from DragEvent. 10336 * 10337 * @returns { UnifiedData } - get dragData. 10338 * @throws { BusinessError } 190001 - Data not found. 10339 * @throws { BusinessError } 190002 - Data error. 10340 * @syscap SystemCapability.ArkUI.ArkUI.Full 10341 * @crossplatform 10342 * @since 10 10343 */ 10344 /** 10345 * Get dragData from DragEvent. 10346 * 10347 * @returns { UnifiedData } - get dragData. 10348 * @throws { BusinessError } 190001 - Data not found. 10349 * @throws { BusinessError } 190002 - Data error. 10350 * @syscap SystemCapability.ArkUI.ArkUI.Full 10351 * @crossplatform 10352 * @atomicservice 10353 * @since 11 10354 */ 10355 getData(): UnifiedData; 10356 10357 /** 10358 * Get dragData summary from DragEvent. 10359 * 10360 * @returns { Summary } - get Summary Data. 10361 * @syscap SystemCapability.ArkUI.ArkUI.Full 10362 * @crossplatform 10363 * @since 10 10364 */ 10365 /** 10366 * Get dragData summary from DragEvent. 10367 * 10368 * @returns { Summary } - get Summary Data. 10369 * @syscap SystemCapability.ArkUI.ArkUI.Full 10370 * @crossplatform 10371 * @atomicservice 10372 * @since 11 10373 */ 10374 getSummary(): Summary; 10375 10376 /** 10377 * Set dragEvent result to DragEvent. 10378 * 10379 * @param { DragResult } dragResult - the return of dragEvent. 10380 * @syscap SystemCapability.ArkUI.ArkUI.Full 10381 * @since 10 10382 */ 10383 /** 10384 * Set dragEvent result to DragEvent. 10385 * 10386 * @param { DragResult } dragResult - the return of dragEvent. 10387 * @syscap SystemCapability.ArkUI.ArkUI.Full 10388 * @atomicservice 10389 * @since 11 10390 */ 10391 /** 10392 * Set dragEvent result to DragEvent. 10393 * 10394 * @param { DragResult } dragResult - the return of dragEvent. 10395 * @syscap SystemCapability.ArkUI.ArkUI.Full 10396 * @crossplatform 10397 * @atomicservice 10398 * @since 13 10399 */ 10400 setResult(dragResult: DragResult): void; 10401 10402 /** 10403 * Get dragEvent result from DragEvent. 10404 * 10405 * @returns { DragResult } - dragResult Data. 10406 * @syscap SystemCapability.ArkUI.ArkUI.Full 10407 * @since 10 10408 */ 10409 /** 10410 * Get dragEvent result from DragEvent. 10411 * 10412 * @returns { DragResult } - dragResult Data. 10413 * @syscap SystemCapability.ArkUI.ArkUI.Full 10414 * @atomicservice 10415 * @since 11 10416 */ 10417 /** 10418 * Get dragEvent result from DragEvent. 10419 * 10420 * @returns { DragResult } - dragResult Data. 10421 * @syscap SystemCapability.ArkUI.ArkUI.Full 10422 * @crossplatform 10423 * @atomicservice 10424 * @since 13 10425 */ 10426 getResult(): DragResult; 10427 10428 /** 10429 * Get the rectangle of drag window. 10430 * 10431 * @returns { Rectangle } - getPreview rectangle. 10432 * @syscap SystemCapability.ArkUI.ArkUI.Full 10433 * @since 10 10434 */ 10435 /** 10436 * Get the rectangle of drag window. 10437 * 10438 * @returns { Rectangle } - getPreview rectangle. 10439 * @syscap SystemCapability.ArkUI.ArkUI.Full 10440 * @atomicservice 10441 * @since 11 10442 */ 10443 /** 10444 * Get the rectangle of drag window. 10445 * 10446 * @returns { Rectangle } - getPreview rectangle. 10447 * @syscap SystemCapability.ArkUI.ArkUI.Full 10448 * @crossplatform 10449 * @atomicservice 10450 * @since 13 10451 */ 10452 getPreviewRect(): Rectangle; 10453 10454 /** 10455 * Get the x axis velocity of drag gesture. 10456 * 10457 * @returns { number } - get x axis velocity. 10458 * @syscap SystemCapability.ArkUI.ArkUI.Full 10459 * @crossplatform 10460 * @since 10 10461 */ 10462 /** 10463 * Get the x axis velocity of drag gesture. 10464 * 10465 * @returns { number } - get x axis velocity. 10466 * @syscap SystemCapability.ArkUI.ArkUI.Full 10467 * @crossplatform 10468 * @atomicservice 10469 * @since 11 10470 */ 10471 getVelocityX(): number; 10472 10473 /** 10474 * Get the y axis velocity of drag gesture. 10475 * 10476 * @returns { number } - get y axis velocity. 10477 * @syscap SystemCapability.ArkUI.ArkUI.Full 10478 * @crossplatform 10479 * @since 10 10480 */ 10481 /** 10482 * Get the y axis velocity of drag gesture. 10483 * 10484 * @returns { number } - get y axis velocity. 10485 * @syscap SystemCapability.ArkUI.ArkUI.Full 10486 * @crossplatform 10487 * @atomicservice 10488 * @since 11 10489 */ 10490 getVelocityY(): number; 10491 10492 /** 10493 * Get the velocity of drag gesture. 10494 * 10495 * @returns { number } - get velocity. 10496 * @syscap SystemCapability.ArkUI.ArkUI.Full 10497 * @crossplatform 10498 * @since 10 10499 */ 10500 /** 10501 * Get the velocity of drag gesture. 10502 * 10503 * @returns { number } - get velocity. 10504 * @syscap SystemCapability.ArkUI.ArkUI.Full 10505 * @crossplatform 10506 * @atomicservice 10507 * @since 11 10508 */ 10509 getVelocity(): number; 10510 10511 /** 10512 * Query the ModifierKey press state, support 'ctrl'|'alt'|'shift'|'fn' 10513 * 10514 * @param { Array<string> } keys - indicate the keys of the ModifierKey. 10515 * @returns { boolean } 10516 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 10517 * @syscap SystemCapability.ArkUI.ArkUI.Full 10518 * @crossplatform 10519 * @since 12 10520 */ 10521 /** 10522 * Query the ModifierKey press state, support 'ctrl'|'alt'|'shift'|'fn' 10523 * 10524 * @param { Array<string> } keys - indicate the keys of the ModifierKey. 10525 * @returns { boolean } 10526 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 10527 * @syscap SystemCapability.ArkUI.ArkUI.Full 10528 * @crossplatform 10529 * @atomicservice 10530 * @since 13 10531 */ 10532 getModifierKeyState?(keys: Array<string>): boolean; 10533} 10534 10535/** 10536 * Import the IntentionCode type object for IntentionCode. 10537 * 10538 * @typedef { import('../api/@ohos.multimodalInput.intentionCode').IntentionCode } IntentionCode 10539 * @syscap SystemCapability.ArkUI.ArkUI.Full 10540 * @since 10 10541 */ 10542/** 10543 * Import the IntentionCode type object for IntentionCode. 10544 * 10545 * @typedef { import('../api/@ohos.multimodalInput.intentionCode').IntentionCode } IntentionCode 10546 * @syscap SystemCapability.ArkUI.ArkUI.Full 10547 * @atomicservice 10548 * @since 11 10549 */ 10550declare type IntentionCode = import('../api/@ohos.multimodalInput.intentionCode').IntentionCode; 10551 10552/** 10553 * KeyEvent object description: 10554 * 10555 * @interface KeyEvent 10556 * @syscap SystemCapability.ArkUI.ArkUI.Full 10557 * @since 7 10558 */ 10559/** 10560 * KeyEvent object description: 10561 * 10562 * @interface KeyEvent 10563 * @syscap SystemCapability.ArkUI.ArkUI.Full 10564 * @crossplatform 10565 * @since 10 10566 */ 10567/** 10568 * KeyEvent object description: 10569 * 10570 * @interface KeyEvent 10571 * @syscap SystemCapability.ArkUI.ArkUI.Full 10572 * @crossplatform 10573 * @atomicservice 10574 * @since 11 10575 */ 10576declare interface KeyEvent { 10577 /** 10578 * Type of a key. 10579 * 10580 * @type { KeyType } 10581 * @syscap SystemCapability.ArkUI.ArkUI.Full 10582 * @since 7 10583 */ 10584 /** 10585 * Type of a key. 10586 * 10587 * @type { KeyType } 10588 * @syscap SystemCapability.ArkUI.ArkUI.Full 10589 * @crossplatform 10590 * @since 10 10591 */ 10592 /** 10593 * Type of a key. 10594 * 10595 * @type { KeyType } 10596 * @syscap SystemCapability.ArkUI.ArkUI.Full 10597 * @crossplatform 10598 * @atomicservice 10599 * @since 11 10600 */ 10601 type: KeyType; 10602 10603 /** 10604 * Key code of a key 10605 * 10606 * @type { number } 10607 * @syscap SystemCapability.ArkUI.ArkUI.Full 10608 * @since 7 10609 */ 10610 /** 10611 * Key code of a key 10612 * 10613 * @type { number } 10614 * @syscap SystemCapability.ArkUI.ArkUI.Full 10615 * @crossplatform 10616 * @since 10 10617 */ 10618 /** 10619 * Key code of a key 10620 * 10621 * @type { number } 10622 * @syscap SystemCapability.ArkUI.ArkUI.Full 10623 * @crossplatform 10624 * @atomicservice 10625 * @since 11 10626 */ 10627 keyCode: number; 10628 10629 /** 10630 * Key value of a key. 10631 * 10632 * @type { string } 10633 * @syscap SystemCapability.ArkUI.ArkUI.Full 10634 * @since 7 10635 */ 10636 /** 10637 * Key value of a key. 10638 * 10639 * @type { string } 10640 * @syscap SystemCapability.ArkUI.ArkUI.Full 10641 * @crossplatform 10642 * @since 10 10643 */ 10644 /** 10645 * Key value of a key. 10646 * 10647 * @type { string } 10648 * @syscap SystemCapability.ArkUI.ArkUI.Full 10649 * @crossplatform 10650 * @atomicservice 10651 * @since 11 10652 */ 10653 keyText: string; 10654 10655 /** 10656 * Type of the input device that triggers the current key, such as the keyboard or handle. 10657 * 10658 * @type { KeySource } 10659 * @syscap SystemCapability.ArkUI.ArkUI.Full 10660 * @since 7 10661 */ 10662 /** 10663 * Type of the input device that triggers the current key, such as the keyboard or handle. 10664 * 10665 * @type { KeySource } 10666 * @syscap SystemCapability.ArkUI.ArkUI.Full 10667 * @crossplatform 10668 * @since 10 10669 */ 10670 /** 10671 * Type of the input device that triggers the current key, such as the keyboard or handle. 10672 * 10673 * @type { KeySource } 10674 * @syscap SystemCapability.ArkUI.ArkUI.Full 10675 * @crossplatform 10676 * @atomicservice 10677 * @since 11 10678 */ 10679 keySource: KeySource; 10680 10681 /** 10682 * Indicates the ID of the input device that triggers the current key. 10683 * 10684 * @type { number } 10685 * @syscap SystemCapability.ArkUI.ArkUI.Full 10686 * @since 7 10687 */ 10688 /** 10689 * Indicates the ID of the input device that triggers the current key. 10690 * 10691 * @type { number } 10692 * @syscap SystemCapability.ArkUI.ArkUI.Full 10693 * @crossplatform 10694 * @since 10 10695 */ 10696 /** 10697 * Indicates the ID of the input device that triggers the current key. 10698 * 10699 * @type { number } 10700 * @syscap SystemCapability.ArkUI.ArkUI.Full 10701 * @crossplatform 10702 * @atomicservice 10703 * @since 11 10704 */ 10705 deviceId: number; 10706 10707 /** 10708 * Indicates the status of the key when the key is pressed. 10709 * The value 1 indicates the pressed state, and the value 0 indicates the unpressed state. 10710 * 10711 * @type { number } 10712 * @syscap SystemCapability.ArkUI.ArkUI.Full 10713 * @since 7 10714 */ 10715 /** 10716 * Indicates the status of the key when the key is pressed. 10717 * The value 1 indicates the pressed state, and the value 0 indicates the unpressed state. 10718 * 10719 * @type { number } 10720 * @syscap SystemCapability.ArkUI.ArkUI.Full 10721 * @crossplatform 10722 * @since 10 10723 */ 10724 /** 10725 * Indicates the status of the key when the key is pressed. 10726 * The value 1 indicates the pressed state, and the value 0 indicates the unpressed state. 10727 * 10728 * @type { number } 10729 * @syscap SystemCapability.ArkUI.ArkUI.Full 10730 * @crossplatform 10731 * @atomicservice 10732 * @since 11 10733 */ 10734 metaKey: number; 10735 10736 /** 10737 * Timestamp when the key was pressed. 10738 * 10739 * @type { number } 10740 * @syscap SystemCapability.ArkUI.ArkUI.Full 10741 * @since 7 10742 */ 10743 /** 10744 * Timestamp when the key was pressed. 10745 * 10746 * @type { number } 10747 * @syscap SystemCapability.ArkUI.ArkUI.Full 10748 * @crossplatform 10749 * @since 10 10750 */ 10751 /** 10752 * Timestamp when the key was pressed. 10753 * 10754 * @type { number } 10755 * @syscap SystemCapability.ArkUI.ArkUI.Full 10756 * @crossplatform 10757 * @atomicservice 10758 * @since 11 10759 */ 10760 timestamp: number; 10761 10762 /** 10763 * Block event bubbling. 10764 * 10765 * @type { function } 10766 * @syscap SystemCapability.ArkUI.ArkUI.Full 10767 * @since 7 10768 */ 10769 /** 10770 * Block event bubbling. 10771 * 10772 * @type { function } 10773 * @syscap SystemCapability.ArkUI.ArkUI.Full 10774 * @crossplatform 10775 * @since 10 10776 */ 10777 /** 10778 * Block event bubbling. 10779 * 10780 * @type { function } 10781 * @syscap SystemCapability.ArkUI.ArkUI.Full 10782 * @crossplatform 10783 * @atomicservice 10784 * @since 11 10785 */ 10786 stopPropagation: () => void; 10787 10788 /** 10789 * Intention code of a key or modifier keys. 10790 * 10791 * @type { IntentionCode } 10792 * @default IntentionCode.INTENTION_UNKNOWN 10793 * @syscap SystemCapability.ArkUI.ArkUI.Full 10794 * @since 10 10795 */ 10796 /** 10797 * Intention code of a key or modifier keys. 10798 * 10799 * @type { IntentionCode } 10800 * @default IntentionCode.INTENTION_UNKNOWN 10801 * @syscap SystemCapability.ArkUI.ArkUI.Full 10802 * @atomicservice 10803 * @since 11 10804 */ 10805 intentionCode: IntentionCode; 10806 10807 /** 10808 * Get the modifier keys press state, support 'ctrl'|'alt'|'shift'|'fn' 10809 * 10810 * @param { Array<string> } keys - indicate the modifier keys. 10811 * @returns { boolean } 10812 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 10813 * @syscap SystemCapability.ArkUI.ArkUI.Full 10814 * @crossplatform 10815 * @since 12 10816 */ 10817 /** 10818 * Get the modifier keys press state, support 'ctrl'|'alt'|'shift'|'fn' 10819 * 10820 * @param { Array<string> } keys - indicate the modifier keys. 10821 * @returns { boolean } 10822 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 10823 * @syscap SystemCapability.ArkUI.ArkUI.Full 10824 * @crossplatform 10825 * @atomicservice 10826 * @since 13 10827 */ 10828 getModifierKeyState?(keys: Array<string>): boolean; 10829 10830 /** 10831 * Unicode of a key 10832 * 10833 * @type { ?number } 10834 * @syscap SystemCapability.ArkUI.ArkUI.Full 10835 * @atomicservice 10836 * @since 14 10837 */ 10838 unicode?: number; 10839} 10840 10841/** 10842 * Overlay module options 10843 * 10844 * @interface BindOptions 10845 * @syscap SystemCapability.ArkUI.ArkUI.Full 10846 * @crossplatform 10847 * @since 10 10848 */ 10849/** 10850 * Overlay module options 10851 * 10852 * @interface BindOptions 10853 * @syscap SystemCapability.ArkUI.ArkUI.Full 10854 * @crossplatform 10855 * @atomicservice 10856 * @since 11 10857 */ 10858declare interface BindOptions { 10859 /** 10860 * Defines the background color 10861 * 10862 * @type { ?ResourceColor } 10863 * @syscap SystemCapability.ArkUI.ArkUI.Full 10864 * @crossplatform 10865 * @since 10 10866 */ 10867 /** 10868 * Defines the background color 10869 * 10870 * @type { ?ResourceColor } 10871 * @syscap SystemCapability.ArkUI.ArkUI.Full 10872 * @crossplatform 10873 * @atomicservice 10874 * @since 11 10875 */ 10876 backgroundColor?: ResourceColor; 10877 10878 /** 10879 * Callback function when overlay interface appears 10880 * 10881 * @type { ?function } 10882 * @syscap SystemCapability.ArkUI.ArkUI.Full 10883 * @crossplatform 10884 * @since 10 10885 */ 10886 /** 10887 * Callback function when overlay interface appears 10888 * 10889 * @type { ?function } 10890 * @syscap SystemCapability.ArkUI.ArkUI.Full 10891 * @crossplatform 10892 * @atomicservice 10893 * @since 11 10894 */ 10895 onAppear?: () => void; 10896 10897 /** 10898 * Callback function when overlay interface exits 10899 * 10900 * @type { ?function } 10901 * @syscap SystemCapability.ArkUI.ArkUI.Full 10902 * @crossplatform 10903 * @since 10 10904 */ 10905 /** 10906 * Callback function when overlay interface exits 10907 * 10908 * @type { ?function } 10909 * @syscap SystemCapability.ArkUI.ArkUI.Full 10910 * @crossplatform 10911 * @atomicservice 10912 * @since 11 10913 */ 10914 onDisappear?: () => void; 10915 10916 /** 10917 * Callback function before overlay animation starts. 10918 * 10919 * @type { ?function } 10920 * @syscap SystemCapability.ArkUI.ArkUI.Full 10921 * @crossplatform 10922 * @atomicservice 10923 * @since 12 10924 */ 10925 onWillAppear?: () => void; 10926 10927 /** 10928 * Callback function before overlay popAnimation starts. 10929 * 10930 * @type { ?function } 10931 * @syscap SystemCapability.ArkUI.ArkUI.Full 10932 * @crossplatform 10933 * @atomicservice 10934 * @since 12 10935 */ 10936 onWillDisappear?: () => void; 10937} 10938 10939/** 10940 * Component content cover dismiss 10941 * 10942 * @interface DismissContentCoverAction 10943 * @syscap SystemCapability.ArkUI.ArkUI.Full 10944 * @crossplatform 10945 * @atomicservice 10946 * @since 12 10947 */ 10948declare interface DismissContentCoverAction { 10949 /** 10950 * Defines content cover dismiss function 10951 * 10952 * @type { Callback<void> } 10953 * @syscap SystemCapability.ArkUI.ArkUI.Full 10954 * @crossplatform 10955 * @atomicservice 10956 * @since 12 10957 */ 10958 dismiss: Callback<void>; 10959 10960 /** 10961 * Defines content cover dismiss reason 10962 * 10963 * @type { DismissReason } 10964 * @syscap SystemCapability.ArkUI.ArkUI.Full 10965 * @crossplatform 10966 * @atomicservice 10967 * @since 12 10968 */ 10969 reason: DismissReason; 10970} 10971 10972/** 10973 * Component content cover options 10974 * 10975 * @interface ContentCoverOptions 10976 * @syscap SystemCapability.ArkUI.ArkUI.Full 10977 * @crossplatform 10978 * @since 10 10979 */ 10980/** 10981 * Component content cover options 10982 * 10983 * @interface ContentCoverOptions 10984 * @syscap SystemCapability.ArkUI.ArkUI.Full 10985 * @crossplatform 10986 * @atomicservice 10987 * @since 11 10988 */ 10989declare interface ContentCoverOptions extends BindOptions { 10990 /** 10991 * Defines transition type 10992 * 10993 * @type { ?ModalTransition } 10994 * @default ModalTransition.Default 10995 * @syscap SystemCapability.ArkUI.ArkUI.Full 10996 * @crossplatform 10997 * @since 10 10998 */ 10999 /** 11000 * Defines transition type 11001 * 11002 * @type { ?ModalTransition } 11003 * @default ModalTransition.Default 11004 * @syscap SystemCapability.ArkUI.ArkUI.Full 11005 * @crossplatform 11006 * @atomicservice 11007 * @since 11 11008 */ 11009 modalTransition?: ModalTransition, 11010 11011 /** 11012 * Callback function when the content cover interactive dismiss 11013 * 11014 * @type { ?Callback<DismissContentCoverAction> } 11015 * @syscap SystemCapability.ArkUI.ArkUI.Full 11016 * @crossplatform 11017 * @atomicservice 11018 * @since 12 11019 */ 11020 onWillDismiss?: Callback<DismissContentCoverAction>; 11021 11022 /** 11023 * Defines transition effect param 11024 * 11025 * @type { ?TransitionEffect } 11026 * @syscap SystemCapability.ArkUI.ArkUI.Full 11027 * @crossplatform 11028 * @atomicservice 11029 * @since 12 11030 */ 11031 transition?: TransitionEffect; 11032} 11033 11034/** 11035 * Component sheet title options 11036 * 11037 * @interface SheetTitleOptions 11038 * @syscap SystemCapability.ArkUI.ArkUI.Full 11039 * @crossplatform 11040 * @since 11 11041 */ 11042/** 11043 * Component sheet title options 11044 * 11045 * @interface SheetTitleOptions 11046 * @syscap SystemCapability.ArkUI.ArkUI.Full 11047 * @crossplatform 11048 * @atomicservice 11049 * @since 12 11050 */ 11051declare interface SheetTitleOptions { 11052 /** 11053 * Defines title text 11054 * 11055 * @type { ResourceStr } 11056 * @syscap SystemCapability.ArkUI.ArkUI.Full 11057 * @crossplatform 11058 * @since 11 11059 */ 11060 /** 11061 * Defines title text 11062 * 11063 * @type { ResourceStr } 11064 * @syscap SystemCapability.ArkUI.ArkUI.Full 11065 * @crossplatform 11066 * @atomicservice 11067 * @since 12 11068 */ 11069 title: ResourceStr; 11070 11071 /** 11072 * Defines subtitle text 11073 * 11074 * @type { ?ResourceStr } 11075 * @syscap SystemCapability.ArkUI.ArkUI.Full 11076 * @crossplatform 11077 * @since 11 11078 */ 11079 /** 11080 * Defines subtitle text 11081 * 11082 * @type { ?ResourceStr } 11083 * @syscap SystemCapability.ArkUI.ArkUI.Full 11084 * @crossplatform 11085 * @atomicservice 11086 * @since 12 11087 */ 11088 subtitle?: ResourceStr; 11089} 11090 11091/** 11092 * Defines the sheet type. 11093 * 11094 * @enum { number } 11095 * @syscap SystemCapability.ArkUI.ArkUI.Full 11096 * @crossplatform 11097 * @since 11 11098 */ 11099/** 11100 * Defines the sheet type. 11101 * 11102 * @enum { number } 11103 * @syscap SystemCapability.ArkUI.ArkUI.Full 11104 * @crossplatform 11105 * @atomicservice 11106 * @since 12 11107 */ 11108declare enum SheetType { 11109 /** 11110 * Defines bottom sheet type. 11111 * 11112 * @syscap SystemCapability.ArkUI.ArkUI.Full 11113 * @crossplatform 11114 * @since 11 11115 */ 11116 /** 11117 * Defines bottom sheet type. 11118 * 11119 * @syscap SystemCapability.ArkUI.ArkUI.Full 11120 * @crossplatform 11121 * @atomicservice 11122 * @since 12 11123 */ 11124 BOTTOM = 0, 11125 11126 /** 11127 * Defines center sheet type. 11128 * 11129 * @syscap SystemCapability.ArkUI.ArkUI.Full 11130 * @crossplatform 11131 * @since 11 11132 */ 11133 /** 11134 * Defines center sheet type. 11135 * 11136 * @syscap SystemCapability.ArkUI.ArkUI.Full 11137 * @crossplatform 11138 * @atomicservice 11139 * @since 12 11140 */ 11141 CENTER = 1, 11142 11143 /** 11144 * Defines popup sheet type. 11145 * 11146 * @syscap SystemCapability.ArkUI.ArkUI.Full 11147 * @crossplatform 11148 * @since 11 11149 */ 11150 /** 11151 * Defines popup sheet type. 11152 * 11153 * @syscap SystemCapability.ArkUI.ArkUI.Full 11154 * @crossplatform 11155 * @atomicservice 11156 * @since 12 11157 */ 11158 POPUP = 2, 11159} 11160 11161/** 11162 * Define the display mode of the sheet. 11163 * 11164 * @enum { number } 11165 * @syscap SystemCapability.ArkUI.ArkUI.Full 11166 * @crossplatform 11167 * @atomicservice 11168 * @since 12 11169 */ 11170declare enum SheetMode { 11171 /** 11172 * Sheet displays above all page levels. 11173 * 11174 * @syscap SystemCapability.ArkUI.ArkUI.Full 11175 * @crossplatform 11176 * @atomicservice 11177 * @since 12 11178 */ 11179 OVERLAY = 0, 11180 11181 /** 11182 * Sheet displays within the current page. 11183 * 11184 * @syscap SystemCapability.ArkUI.ArkUI.Full 11185 * @crossplatform 11186 * @atomicservice 11187 * @since 12 11188 */ 11189 EMBEDDED = 1, 11190} 11191 11192/** 11193 * Define the scroll size mode of the sheet. 11194 * 11195 * @enum { number } 11196 * @syscap SystemCapability.ArkUI.ArkUI.Full 11197 * @crossplatform 11198 * @atomicservice 11199 * @since 12 11200 */ 11201declare enum ScrollSizeMode { 11202 /** 11203 * Sheet change scroll size after the slide ends. 11204 * 11205 * @syscap SystemCapability.ArkUI.ArkUI.Full 11206 * @crossplatform 11207 * @atomicservice 11208 * @since 12 11209 */ 11210 FOLLOW_DETENT = 0, 11211 11212 /** 11213 * Sheet change scroll size during the sliding process. 11214 * 11215 * @syscap SystemCapability.ArkUI.ArkUI.Full 11216 * @crossplatform 11217 * @atomicservice 11218 * @since 12 11219 */ 11220 CONTINUOUS = 1, 11221} 11222 11223/** 11224 * Define the mode of sheet how to avoid keyboard. 11225 * 11226 * @enum { number } 11227 * @syscap SystemCapability.ArkUI.ArkUI.Full 11228 * @crossplatform 11229 * @atomicservice 11230 * @since 13 11231 */ 11232declare enum SheetKeyboardAvoidMode { 11233 /** 11234 * Sheet will not aovid keyboard. 11235 * 11236 * @syscap SystemCapability.ArkUI.ArkUI.Full 11237 * @crossplatform 11238 * @atomicservice 11239 * @since 13 11240 */ 11241 NONE = 0, 11242 11243 /** 11244 * Firstly sheet will avoid keyboard by changing its height. 11245 * And then sheet will avoid by resizing after reaching its maximum height. 11246 * 11247 * @syscap SystemCapability.ArkUI.ArkUI.Full 11248 * @crossplatform 11249 * @atomicservice 11250 * @since 13 11251 */ 11252 TRANSLATE_AND_RESIZE = 1, 11253 11254 /** 11255 * Sheet will only avoid keyboard by resizing the content. 11256 * 11257 * @syscap SystemCapability.ArkUI.ArkUI.Full 11258 * @crossplatform 11259 * @atomicservice 11260 * @since 13 11261 */ 11262 RESIZE_ONLY = 2, 11263 11264 /** 11265 * Firstly sheet will avoid keyboard by changing its height. 11266 * And then sheet will avoid keyboard by scrolling after reaching its maximum height. 11267 * 11268 * @syscap SystemCapability.ArkUI.ArkUI.Full 11269 * @crossplatform 11270 * @atomicservice 11271 * @since 13 11272 */ 11273 TRANSLATE_AND_SCROLL = 3, 11274} 11275 11276/** 11277 * Component sheet dismiss 11278 * 11279 * @interface SheetDismiss 11280 * @syscap SystemCapability.ArkUI.ArkUI.Full 11281 * @crossplatform 11282 * @since 11 11283 */ 11284/** 11285 * Component sheet dismiss 11286 * 11287 * @interface SheetDismiss 11288 * @syscap SystemCapability.ArkUI.ArkUI.Full 11289 * @crossplatform 11290 * @atomicservice 11291 * @since 12 11292 */ 11293declare interface SheetDismiss { 11294 /** 11295 * Defines sheet dismiss function 11296 * 11297 * @type { function } 11298 * @syscap SystemCapability.ArkUI.ArkUI.Full 11299 * @crossplatform 11300 * @since 11 11301 */ 11302 /** 11303 * Defines sheet dismiss function 11304 * 11305 * @type { function } 11306 * @syscap SystemCapability.ArkUI.ArkUI.Full 11307 * @crossplatform 11308 * @atomicservice 11309 * @since 12 11310 */ 11311 dismiss: () => void; 11312} 11313 11314/** 11315 * Component sheet dismiss 11316 * 11317 * @interface DismissSheetAction 11318 * @syscap SystemCapability.ArkUI.ArkUI.Full 11319 * @crossplatform 11320 * @atomicservice 11321 * @since 12 11322 */ 11323declare interface DismissSheetAction { 11324 11325 /** 11326 * Defines sheet dismiss function 11327 * 11328 * @type { Callback<void> } 11329 * @syscap SystemCapability.ArkUI.ArkUI.Full 11330 * @crossplatform 11331 * @atomicservice 11332 * @since 12 11333 */ 11334 dismiss: Callback<void>; 11335 11336 /** 11337 * Dismiss reason type. 11338 * 11339 * @type { DismissReason } 11340 * @syscap SystemCapability.ArkUI.ArkUI.Full 11341 * @crossplatform 11342 * @atomicservice 11343 * @since 12 11344 */ 11345 reason: DismissReason; 11346} 11347 11348/** 11349 * Defines sheet spring back action 11350 * 11351 * @interface SpringBackAction 11352 * @syscap SystemCapability.ArkUI.ArkUI.Full 11353 * @crossplatform 11354 * @atomicservice 11355 * @since 12 11356 */ 11357declare interface SpringBackAction { 11358 /** 11359 * Defines spring back function 11360 * 11361 * @type { Callback<void> } 11362 * @syscap SystemCapability.ArkUI.ArkUI.Full 11363 * @crossplatform 11364 * @atomicservice 11365 * @since 12 11366 */ 11367 springBack: Callback<void>; 11368} 11369 11370/** 11371 * Component sheet options 11372 * 11373 * @interface SheetOptions 11374 * @syscap SystemCapability.ArkUI.ArkUI.Full 11375 * @crossplatform 11376 * @since 10 11377 */ 11378/** 11379 * Component sheet options 11380 * 11381 * @interface SheetOptions 11382 * @syscap SystemCapability.ArkUI.ArkUI.Full 11383 * @crossplatform 11384 * @atomicservice 11385 * @since 11 11386 */ 11387declare interface SheetOptions extends BindOptions { 11388 /** 11389 * Defines sheet height 11390 * 11391 * @type { ?(SheetSize | Length) } 11392 * @default Sheet.LARGE 11393 * @syscap SystemCapability.ArkUI.ArkUI.Full 11394 * @crossplatform 11395 * @since 10 11396 */ 11397 /** 11398 * Defines sheet height 11399 * 11400 * @type { ?(SheetSize | Length) } 11401 * @default Sheet.LARGE 11402 * @syscap SystemCapability.ArkUI.ArkUI.Full 11403 * @crossplatform 11404 * @atomicservice 11405 * @since 11 11406 */ 11407 height?: SheetSize | Length; 11408 11409 /** 11410 * Defines whether the control bar is displayed. 11411 * 11412 * @type { ?boolean } 11413 * @default true 11414 * @syscap SystemCapability.ArkUI.ArkUI.Full 11415 * @crossplatform 11416 * @since 10 11417 */ 11418 /** 11419 * Defines whether the control bar is displayed. 11420 * 11421 * @type { ?boolean } 11422 * @default true 11423 * @syscap SystemCapability.ArkUI.ArkUI.Full 11424 * @crossplatform 11425 * @atomicservice 11426 * @since 11 11427 */ 11428 dragBar?: boolean; 11429 11430 /** 11431 * Defines sheet maskColor 11432 * 11433 * @type { ?ResourceColor } 11434 * @syscap SystemCapability.ArkUI.ArkUI.Full 11435 * @crossplatform 11436 * @since 10 11437 */ 11438 /** 11439 * Defines sheet maskColor 11440 * 11441 * @type { ?ResourceColor } 11442 * @syscap SystemCapability.ArkUI.ArkUI.Full 11443 * @crossplatform 11444 * @atomicservice 11445 * @since 11 11446 */ 11447 maskColor?: ResourceColor; 11448 11449 /** 11450 * Defines sheet detents 11451 * 11452 * @type { ?[(SheetSize | Length), (SheetSize | Length)?, (SheetSize | Length)?] } 11453 * @syscap SystemCapability.ArkUI.ArkUI.Full 11454 * @crossplatform 11455 * @since 11 11456 */ 11457 /** 11458 * Defines sheet detents 11459 * 11460 * @type { ?[(SheetSize | Length), (SheetSize | Length)?, (SheetSize | Length)?] } 11461 * @syscap SystemCapability.ArkUI.ArkUI.Full 11462 * @crossplatform 11463 * @atomicservice 11464 * @since 12 11465 */ 11466 detents?: [(SheetSize | Length), (SheetSize | Length)?, (SheetSize | Length)?]; 11467 11468 /** 11469 * Defines sheet background blur Style 11470 * 11471 * @type { ?BlurStyle } 11472 * @default BlurStyle.NONE 11473 * @syscap SystemCapability.ArkUI.ArkUI.Full 11474 * @crossplatform 11475 * @since 11 11476 */ 11477 /** 11478 * Defines sheet background blur Style 11479 * 11480 * @type { ?BlurStyle } 11481 * @default BlurStyle.NONE 11482 * @syscap SystemCapability.ArkUI.ArkUI.Full 11483 * @crossplatform 11484 * @atomicservice 11485 * @since 12 11486 */ 11487 blurStyle?: BlurStyle; 11488 11489 /** 11490 * Defines whether the close icon is displayed 11491 * 11492 * @type { ?(boolean | Resource) } 11493 * @default true 11494 * @syscap SystemCapability.ArkUI.ArkUI.Full 11495 * @crossplatform 11496 * @since 11 11497 */ 11498 /** 11499 * Defines whether the close icon is displayed 11500 * 11501 * @type { ?(boolean | Resource) } 11502 * @default true 11503 * @syscap SystemCapability.ArkUI.ArkUI.Full 11504 * @crossplatform 11505 * @atomicservice 11506 * @since 12 11507 */ 11508 showClose?: boolean | Resource; 11509 11510 /** 11511 * Defines the sheet prefer type 11512 * 11513 * @type { ?(SheetType.CENTER | SheetType.POPUP) } 11514 * @syscap SystemCapability.ArkUI.ArkUI.Full 11515 * @crossplatform 11516 * @since 11 11517 */ 11518 /** 11519 * Defines the sheet prefer type 11520 * 11521 * @type { ?SheetType } 11522 * @syscap SystemCapability.ArkUI.ArkUI.Full 11523 * @crossplatform 11524 * @atomicservice 11525 * @since 12 11526 */ 11527 preferType?: SheetType; 11528 11529 /** 11530 * Defines the sheet title 11531 * 11532 * @type { ?(SheetTitleOptions | CustomBuilder) } 11533 * @syscap SystemCapability.ArkUI.ArkUI.Full 11534 * @crossplatform 11535 * @since 11 11536 */ 11537 /** 11538 * Defines the sheet title 11539 * 11540 * @type { ?(SheetTitleOptions | CustomBuilder) } 11541 * @syscap SystemCapability.ArkUI.ArkUI.Full 11542 * @crossplatform 11543 * @atomicservice 11544 * @since 12 11545 */ 11546 title?: SheetTitleOptions | CustomBuilder; 11547 11548 /** 11549 * Callback function when the sheet interactive dismiss 11550 * 11551 * @type { ?function } 11552 * @syscap SystemCapability.ArkUI.ArkUI.Full 11553 * @crossplatform 11554 * @since 11 11555 */ 11556 /** 11557 * Callback function when the sheet interactive dismiss 11558 * 11559 * @type { ?function } 11560 * @syscap SystemCapability.ArkUI.ArkUI.Full 11561 * @crossplatform 11562 * @atomicservice 11563 * @since 12 11564 */ 11565 shouldDismiss?: (sheetDismiss: SheetDismiss) => void; 11566 11567 /** 11568 * Callback function when the sheet will dismiss 11569 * 11570 * @type { ?Callback<DismissSheetAction> } 11571 * @syscap SystemCapability.ArkUI.ArkUI.Full 11572 * @crossplatform 11573 * @atomicservice 11574 * @since 12 11575 */ 11576 onWillDismiss?: Callback<DismissSheetAction>; 11577 11578 /** 11579 * Sheet springs back callback when dismiss 11580 * 11581 * @type { ?Callback<SpringBackAction> } 11582 * @syscap SystemCapability.ArkUI.ArkUI.Full 11583 * @crossplatform 11584 * @atomicservice 11585 * @since 12 11586 */ 11587 onWillSpringBackWhenDismiss?: Callback<SpringBackAction>; 11588 11589 /** 11590 * Set whether interaction is allowed outside the sheet 11591 * 11592 * @type { ?boolean } 11593 * @default false 11594 * @syscap SystemCapability.ArkUI.ArkUI.Full 11595 * @crossplatform 11596 * @since 11 11597 */ 11598 /** 11599 * Set whether interaction is allowed outside the sheet 11600 * 11601 * @type { ?boolean } 11602 * @default false 11603 * @syscap SystemCapability.ArkUI.ArkUI.Full 11604 * @crossplatform 11605 * @atomicservice 11606 * @since 12 11607 */ 11608 enableOutsideInteractive?: boolean; 11609 11610 /** 11611 * Defines the sheet's width. 11612 * 11613 * @type { ?Dimension } 11614 * @syscap SystemCapability.ArkUI.ArkUI.Full 11615 * @crossplatform 11616 * @atomicservice 11617 * @since 12 11618 */ 11619 width?: Dimension; 11620 11621 /** 11622 * Defines the sheet's border width. 11623 * 11624 * @type { ?(Dimension | EdgeWidths | LocalizedEdgeWidths) } 11625 * @syscap SystemCapability.ArkUI.ArkUI.Full 11626 * @crossplatform 11627 * @atomicservice 11628 * @since 12 11629 */ 11630 borderWidth?: Dimension | EdgeWidths | LocalizedEdgeWidths; 11631 11632 /** 11633 * Defines the sheet's border color. 11634 * 11635 * @type { ?(ResourceColor | EdgeColors | LocalizedEdgeColors) } 11636 * @syscap SystemCapability.ArkUI.ArkUI.Full 11637 * @crossplatform 11638 * @atomicservice 11639 * @since 12 11640 */ 11641 borderColor?: ResourceColor | EdgeColors | LocalizedEdgeColors; 11642 11643 /** 11644 * Defines the sheet's border style. 11645 * 11646 * @type { ?(BorderStyle | EdgeStyles) } 11647 * @syscap SystemCapability.ArkUI.ArkUI.Full 11648 * @crossplatform 11649 * @atomicservice 11650 * @since 12 11651 */ 11652 borderStyle?: BorderStyle | EdgeStyles; 11653 11654 /** 11655 * Defines the sheet's shadow. 11656 * 11657 * @type { ?(ShadowOptions | ShadowStyle) } 11658 * @syscap SystemCapability.ArkUI.ArkUI.Full 11659 * @crossplatform 11660 * @atomicservice 11661 * @since 12 11662 */ 11663 shadow?: ShadowOptions | ShadowStyle; 11664 11665 /** 11666 * Called when height of the sheet is changed 11667 * 11668 * @type { ?Callback<number> } 11669 * @syscap SystemCapability.ArkUI.ArkUI.Full 11670 * @crossplatform 11671 * @atomicservice 11672 * @since 12 11673 */ 11674 onHeightDidChange?: Callback<number>; 11675 11676 /** 11677 * Determine the level sheet shows, whether sheet should be displayed within the page 11678 * 11679 * @type { ?SheetMode } 11680 * @default SheetMode.OVERLAY 11681 * @syscap SystemCapability.ArkUI.ArkUI.Full 11682 * @crossplatform 11683 * @atomicservice 11684 * @since 12 11685 */ 11686 mode?: SheetMode; 11687 11688 /** 11689 * Determine sheet scroll size mode. 11690 * 11691 * @type { ?ScrollSizeMode } 11692 * @default ScrollSizeMode.FELLOW_DETEND 11693 * @syscap SystemCapability.ArkUI.ArkUI.Full 11694 * @crossplatform 11695 * @atomicservice 11696 * @since 12 11697 */ 11698 scrollSizeMode?: ScrollSizeMode; 11699 11700 /** 11701 * Called when detents of the sheet changed 11702 * 11703 * @type { ?Callback<number> } 11704 * @default false 11705 * @syscap SystemCapability.ArkUI.ArkUI.Full 11706 * @crossplatform 11707 * @atomicservice 11708 * @since 12 11709 */ 11710 onDetentsDidChange?: Callback<number>; 11711 11712 /** 11713 * Called when width of the sheet changed 11714 * 11715 * @type { ?Callback<number> } 11716 * @syscap SystemCapability.ArkUI.ArkUI.Full 11717 * @crossplatform 11718 * @atomicservice 11719 * @since 12 11720 */ 11721 onWidthDidChange?: Callback<number>; 11722 11723 /** 11724 * Called when the sheet type changed 11725 * 11726 * @type { ?Callback<SheetType> } 11727 * @syscap SystemCapability.ArkUI.ArkUI.Full 11728 * @crossplatform 11729 * @atomicservice 11730 * @since 12 11731 */ 11732 onTypeDidChange?: Callback<SheetType>; 11733 11734 /** 11735 * The UIContext that the sheet belongs to 11736 * 11737 * @type { ?UIContext } 11738 * @syscap SystemCapability.ArkUI.ArkUI.Full 11739 * @crossplatform 11740 * @atomicservice 11741 * @since 12 11742 */ 11743 uiContext?: UIContext; 11744 11745 /** 11746 * Determine the mode of sheet how to avoid keyboard. 11747 * 11748 * @type { ?SheetKeyboardAvoidMode } 11749 * @default SheetKeyboardAvoidMode.TRANSLATE_AND_SCROLL 11750 * @syscap SystemCapability.ArkUI.ArkUI.Full 11751 * @crossplatform 11752 * @atomicservice 11753 * @since 13 11754 */ 11755 keyboardAvoidMode?: SheetKeyboardAvoidMode; 11756} 11757 11758/** 11759 * Component State Styles. 11760 * 11761 * @interface StateStyles 11762 * @syscap SystemCapability.ArkUI.ArkUI.Full 11763 * @since 8 11764 */ 11765/** 11766 * Component State Styles. 11767 * 11768 * @interface StateStyles 11769 * @syscap SystemCapability.ArkUI.ArkUI.Full 11770 * @form 11771 * @since 9 11772 */ 11773/** 11774 * Component State Styles. 11775 * 11776 * @interface StateStyles 11777 * @syscap SystemCapability.ArkUI.ArkUI.Full 11778 * @crossplatform 11779 * @form 11780 * @since 10 11781 */ 11782/** 11783 * Component State Styles. 11784 * 11785 * @interface StateStyles 11786 * @syscap SystemCapability.ArkUI.ArkUI.Full 11787 * @crossplatform 11788 * @form 11789 * @atomicservice 11790 * @since 11 11791 */ 11792declare interface StateStyles { 11793 /** 11794 * Defines normal state styles. 11795 * 11796 * @type { ?any } 11797 * @syscap SystemCapability.ArkUI.ArkUI.Full 11798 * @since 8 11799 */ 11800 /** 11801 * Defines normal state styles. 11802 * 11803 * @type { ?any } 11804 * @syscap SystemCapability.ArkUI.ArkUI.Full 11805 * @form 11806 * @since 9 11807 */ 11808 /** 11809 * Defines normal state styles. 11810 * 11811 * @type { ?any } 11812 * @syscap SystemCapability.ArkUI.ArkUI.Full 11813 * @crossplatform 11814 * @form 11815 * @since 10 11816 */ 11817 /** 11818 * Defines normal state styles. 11819 * 11820 * @type { ?any } 11821 * @syscap SystemCapability.ArkUI.ArkUI.Full 11822 * @crossplatform 11823 * @form 11824 * @atomicservice 11825 * @since 11 11826 */ 11827 normal?: any; 11828 11829 /** 11830 * Defines pressed state styles. 11831 * 11832 * @type { ?any } 11833 * @syscap SystemCapability.ArkUI.ArkUI.Full 11834 * @since 8 11835 */ 11836 /** 11837 * Defines pressed state styles. 11838 * 11839 * @type { ?any } 11840 * @syscap SystemCapability.ArkUI.ArkUI.Full 11841 * @form 11842 * @since 9 11843 */ 11844 /** 11845 * Defines pressed state styles. 11846 * 11847 * @type { ?any } 11848 * @syscap SystemCapability.ArkUI.ArkUI.Full 11849 * @crossplatform 11850 * @form 11851 * @since 10 11852 */ 11853 /** 11854 * Defines pressed state styles. 11855 * 11856 * @type { ?any } 11857 * @syscap SystemCapability.ArkUI.ArkUI.Full 11858 * @crossplatform 11859 * @form 11860 * @atomicservice 11861 * @since 11 11862 */ 11863 pressed?: any; 11864 11865 /** 11866 * Defines disabled state styles. 11867 * 11868 * @type { ?any } 11869 * @syscap SystemCapability.ArkUI.ArkUI.Full 11870 * @since 8 11871 */ 11872 /** 11873 * Defines disabled state styles. 11874 * 11875 * @type { ?any } 11876 * @syscap SystemCapability.ArkUI.ArkUI.Full 11877 * @form 11878 * @since 9 11879 */ 11880 /** 11881 * Defines disabled state styles. 11882 * 11883 * @type { ?any } 11884 * @syscap SystemCapability.ArkUI.ArkUI.Full 11885 * @crossplatform 11886 * @form 11887 * @since 10 11888 */ 11889 /** 11890 * Defines disabled state styles. 11891 * 11892 * @type { ?any } 11893 * @syscap SystemCapability.ArkUI.ArkUI.Full 11894 * @crossplatform 11895 * @form 11896 * @atomicservice 11897 * @since 11 11898 */ 11899 disabled?: any; 11900 11901 /** 11902 * Defines focused state styles. 11903 * 11904 * @type { ?any } 11905 * @syscap SystemCapability.ArkUI.ArkUI.Full 11906 * @since 8 11907 */ 11908 /** 11909 * Defines focused state styles. 11910 * 11911 * @type { ?any } 11912 * @syscap SystemCapability.ArkUI.ArkUI.Full 11913 * @form 11914 * @since 9 11915 */ 11916 /** 11917 * Defines focused state styles. 11918 * 11919 * @type { ?any } 11920 * @syscap SystemCapability.ArkUI.ArkUI.Full 11921 * @crossplatform 11922 * @form 11923 * @since 10 11924 */ 11925 /** 11926 * Defines focused state styles. 11927 * 11928 * @type { ?any } 11929 * @syscap SystemCapability.ArkUI.ArkUI.Full 11930 * @crossplatform 11931 * @form 11932 * @atomicservice 11933 * @since 11 11934 */ 11935 focused?: any; 11936 11937 /** 11938 * Defines clicked state styles. 11939 * 11940 * @type { ?any } 11941 * @syscap SystemCapability.ArkUI.ArkUI.Full 11942 * @since 8 11943 */ 11944 /** 11945 * Defines clicked state styles. 11946 * 11947 * @type { ?any } 11948 * @syscap SystemCapability.ArkUI.ArkUI.Full 11949 * @form 11950 * @since 9 11951 */ 11952 /** 11953 * Defines clicked state styles. 11954 * 11955 * @type { ?any } 11956 * @syscap SystemCapability.ArkUI.ArkUI.Full 11957 * @crossplatform 11958 * @form 11959 * @since 10 11960 */ 11961 /** 11962 * Defines clicked state styles. 11963 * 11964 * @type { ?any } 11965 * @syscap SystemCapability.ArkUI.ArkUI.Full 11966 * @crossplatform 11967 * @form 11968 * @atomicservice 11969 * @since 11 11970 */ 11971 clicked?: any; 11972 11973 /** 11974 * Defines selected state styles. 11975 * 11976 * @type { ?object } 11977 * @syscap SystemCapability.ArkUI.ArkUI.Full 11978 * @crossplatform 11979 * @form 11980 * @since 10 11981 */ 11982 /** 11983 * Defines selected state styles. 11984 * 11985 * @type { ?object } 11986 * @syscap SystemCapability.ArkUI.ArkUI.Full 11987 * @crossplatform 11988 * @form 11989 * @atomicservice 11990 * @since 11 11991 */ 11992 selected?: object; 11993} 11994 11995/** 11996 * Defines the options of popup message. 11997 * 11998 * @interface PopupMessageOptions 11999 * @syscap SystemCapability.ArkUI.ArkUI.Full 12000 * @crossplatform 12001 * @since 10 12002 */ 12003/** 12004 * Defines the options of popup message. 12005 * 12006 * @interface PopupMessageOptions 12007 * @syscap SystemCapability.ArkUI.ArkUI.Full 12008 * @crossplatform 12009 * @atomicservice 12010 * @since 11 12011 */ 12012declare interface PopupMessageOptions { 12013 /** 12014 * Sets the color of popup text. 12015 * 12016 * @type { ?ResourceColor } 12017 * @syscap SystemCapability.ArkUI.ArkUI.Full 12018 * @crossplatform 12019 * @since 10 12020 */ 12021 /** 12022 * Sets the color of popup text. 12023 * 12024 * @type { ?ResourceColor } 12025 * @syscap SystemCapability.ArkUI.ArkUI.Full 12026 * @crossplatform 12027 * @atomicservice 12028 * @since 11 12029 */ 12030 textColor?: ResourceColor; 12031 12032 /** 12033 * Sets the font of popup text. 12034 * 12035 * @type { ?Font } 12036 * @syscap SystemCapability.ArkUI.ArkUI.Full 12037 * @crossplatform 12038 * @since 10 12039 */ 12040 /** 12041 * Sets the font of popup text. 12042 * 12043 * @type { ?Font } 12044 * @syscap SystemCapability.ArkUI.ArkUI.Full 12045 * @crossplatform 12046 * @atomicservice 12047 * @since 11 12048 */ 12049 font?: Font; 12050} 12051 12052/** 12053 * Dismiss reason type. 12054 * 12055 * @enum { number } 12056 * @syscap SystemCapability.ArkUI.ArkUI.Full 12057 * @crossplatform 12058 * @atomicservice 12059 * @since 12 12060 */ 12061declare enum DismissReason { 12062 /** 12063 * Press back 12064 * 12065 * @syscap SystemCapability.ArkUI.ArkUI.Full 12066 * @crossplatform 12067 * @atomicservice 12068 * @since 12 12069 */ 12070 PRESS_BACK = 0, 12071 12072 /** 12073 * Touch component outside 12074 * 12075 * @syscap SystemCapability.ArkUI.ArkUI.Full 12076 * @crossplatform 12077 * @atomicservice 12078 * @since 12 12079 */ 12080 TOUCH_OUTSIDE = 1, 12081 12082 /** 12083 * Close button 12084 * 12085 * @syscap SystemCapability.ArkUI.ArkUI.Full 12086 * @crossplatform 12087 * @atomicservice 12088 * @since 12 12089 */ 12090 CLOSE_BUTTON = 2, 12091 12092 /** 12093 * Slide down 12094 * 12095 * @syscap SystemCapability.ArkUI.ArkUI.Full 12096 * @crossplatform 12097 * @atomicservice 12098 * @since 12 12099 */ 12100 SLIDE_DOWN = 3 12101} 12102 12103/** 12104 * Component popup dismiss 12105 * 12106 * @interface DismissPopupAction 12107 * @syscap SystemCapability.ArkUI.ArkUI.Full 12108 * @crossplatform 12109 * @atomicservice 12110 * @since 12 12111 */ 12112declare interface DismissPopupAction { 12113 /** 12114 * Defines popup dismiss function 12115 * 12116 * @type { Callback<void> } 12117 * @syscap SystemCapability.ArkUI.ArkUI.Full 12118 * @crossplatform 12119 * @atomicservice 12120 * @since 12 12121 */ 12122 dismiss: Callback<void>; 12123 12124 /** 12125 * Defines popup dismiss reason 12126 * 12127 * @type { DismissReason } 12128 * @syscap SystemCapability.ArkUI.ArkUI.Full 12129 * @crossplatform 12130 * @atomicservice 12131 * @since 12 12132 */ 12133 reason: DismissReason; 12134} 12135 12136/** 12137 * Defines the popup options. 12138 * 12139 * @interface PopupOptions 12140 * @syscap SystemCapability.ArkUI.ArkUI.Full 12141 * @since 7 12142 */ 12143/** 12144 * Defines the popup options. 12145 * 12146 * @interface PopupOptions 12147 * @syscap SystemCapability.ArkUI.ArkUI.Full 12148 * @crossplatform 12149 * @since 10 12150 */ 12151/** 12152 * Defines the popup options. 12153 * 12154 * @interface PopupOptions 12155 * @syscap SystemCapability.ArkUI.ArkUI.Full 12156 * @crossplatform 12157 * @atomicservice 12158 * @since 11 12159 */ 12160declare interface PopupOptions { 12161 /** 12162 * Information in the pop-up window. 12163 * 12164 * @type { string } 12165 * @syscap SystemCapability.ArkUI.ArkUI.Full 12166 * @since 7 12167 */ 12168 /** 12169 * Information in the pop-up window. 12170 * 12171 * @type { string } 12172 * @syscap SystemCapability.ArkUI.ArkUI.Full 12173 * @crossplatform 12174 * @since 10 12175 */ 12176 /** 12177 * Information in the pop-up window. 12178 * 12179 * @type { string } 12180 * @syscap SystemCapability.ArkUI.ArkUI.Full 12181 * @crossplatform 12182 * @atomicservice 12183 * @since 11 12184 */ 12185 message: string; 12186 12187 /** 12188 * placement On Top 12189 * 12190 * @type { ?boolean } 12191 * @syscap SystemCapability.ArkUI.ArkUI.Full 12192 * @since 7 12193 * @deprecated since 10 12194 * @useinstead PopupOptions#placement 12195 */ 12196 placementOnTop?: boolean; 12197 12198 /** 12199 * The placement of popup. 12200 * Supports all positions defined in Placement. 12201 * 12202 * @type { ?Placement } 12203 * @default Placement.Bottom 12204 * @syscap SystemCapability.ArkUI.ArkUI.Full 12205 * @crossplatform 12206 * @since 10 12207 */ 12208 /** 12209 * The placement of popup. 12210 * Supports all positions defined in Placement. 12211 * 12212 * @type { ?Placement } 12213 * @default Placement.Bottom 12214 * @syscap SystemCapability.ArkUI.ArkUI.Full 12215 * @crossplatform 12216 * @atomicservice 12217 * @since 11 12218 */ 12219 placement?: Placement; 12220 12221 /** 12222 * The first button. 12223 * 12224 * @type { ?object } 12225 * @syscap SystemCapability.ArkUI.ArkUI.Full 12226 * @since 7 12227 */ 12228 /** 12229 * The first button. 12230 * 12231 * @type { ?object } 12232 * @syscap SystemCapability.ArkUI.ArkUI.Full 12233 * @crossplatform 12234 * @since 10 12235 */ 12236 /** 12237 * The first button. 12238 * 12239 * @type { ?object } 12240 * @syscap SystemCapability.ArkUI.ArkUI.Full 12241 * @crossplatform 12242 * @atomicservice 12243 * @since 11 12244 */ 12245 primaryButton?: { 12246 /** 12247 * Button text value 12248 * 12249 * @type { string } 12250 * @syscap SystemCapability.ArkUI.ArkUI.Full 12251 * @since 7 12252 */ 12253 /** 12254 * Button text value 12255 * 12256 * @type { string } 12257 * @syscap SystemCapability.ArkUI.ArkUI.Full 12258 * @crossplatform 12259 * @since 10 12260 */ 12261 /** 12262 * Button text value 12263 * 12264 * @type { string } 12265 * @syscap SystemCapability.ArkUI.ArkUI.Full 12266 * @crossplatform 12267 * @atomicservice 12268 * @since 11 12269 */ 12270 value: string; 12271 12272 /** 12273 * action 12274 * 12275 * @type { function } 12276 * @syscap SystemCapability.ArkUI.ArkUI.Full 12277 * @since 7 12278 */ 12279 /** 12280 * action 12281 * 12282 * @type { function } 12283 * @syscap SystemCapability.ArkUI.ArkUI.Full 12284 * @crossplatform 12285 * @since 10 12286 */ 12287 /** 12288 * action 12289 * 12290 * @type { function } 12291 * @syscap SystemCapability.ArkUI.ArkUI.Full 12292 * @crossplatform 12293 * @atomicservice 12294 * @since 11 12295 */ 12296 action: () => void; 12297 }; 12298 12299 /** 12300 * The second button. 12301 * 12302 * @type { ?object } 12303 * @syscap SystemCapability.ArkUI.ArkUI.Full 12304 * @since 7 12305 */ 12306 /** 12307 * The second button. 12308 * 12309 * @type { ?object } 12310 * @syscap SystemCapability.ArkUI.ArkUI.Full 12311 * @crossplatform 12312 * @since 10 12313 */ 12314 /** 12315 * The second button. 12316 * 12317 * @type { ?object } 12318 * @syscap SystemCapability.ArkUI.ArkUI.Full 12319 * @crossplatform 12320 * @atomicservice 12321 * @since 11 12322 */ 12323 secondaryButton?: { 12324 /** 12325 * Button text value 12326 * 12327 * @type { string } 12328 * @syscap SystemCapability.ArkUI.ArkUI.Full 12329 * @since 7 12330 */ 12331 /** 12332 * Button text value 12333 * 12334 * @type { string } 12335 * @syscap SystemCapability.ArkUI.ArkUI.Full 12336 * @crossplatform 12337 * @since 10 12338 */ 12339 /** 12340 * Button text value 12341 * 12342 * @type { string } 12343 * @syscap SystemCapability.ArkUI.ArkUI.Full 12344 * @crossplatform 12345 * @atomicservice 12346 * @since 11 12347 */ 12348 value: string; 12349 12350 /** 12351 * action 12352 * 12353 * @type { function } 12354 * @syscap SystemCapability.ArkUI.ArkUI.Full 12355 * @since 7 12356 */ 12357 /** 12358 * action 12359 * 12360 * @type { function } 12361 * @syscap SystemCapability.ArkUI.ArkUI.Full 12362 * @crossplatform 12363 * @since 10 12364 */ 12365 /** 12366 * action 12367 * 12368 * @type { function } 12369 * @syscap SystemCapability.ArkUI.ArkUI.Full 12370 * @crossplatform 12371 * @atomicservice 12372 * @since 11 12373 */ 12374 action: () => void; 12375 }; 12376 12377 /** 12378 * on State Change 12379 * 12380 * @type { ?function } 12381 * @syscap SystemCapability.ArkUI.ArkUI.Full 12382 * @since 7 12383 */ 12384 /** 12385 * on State Change 12386 * 12387 * @type { ?function } 12388 * @syscap SystemCapability.ArkUI.ArkUI.Full 12389 * @crossplatform 12390 * @since 10 12391 */ 12392 /** 12393 * on State Change 12394 * 12395 * @type { ?function } 12396 * @syscap SystemCapability.ArkUI.ArkUI.Full 12397 * @crossplatform 12398 * @atomicservice 12399 * @since 11 12400 */ 12401 onStateChange?: (event: { 12402 /** 12403 * is Visible. 12404 * 12405 * @type { boolean } 12406 * @syscap SystemCapability.ArkUI.ArkUI.Full 12407 * @crossplatform 12408 * @since 10 12409 */ 12410 /** 12411 * is Visible. 12412 * 12413 * @type { boolean } 12414 * @syscap SystemCapability.ArkUI.ArkUI.Full 12415 * @crossplatform 12416 * @atomicservice 12417 * @since 11 12418 */ 12419 isVisible: boolean 12420 }) => void; 12421 12422 /** 12423 * The offset of the sharp corner of popup. 12424 * 12425 * @type { ?Length } 12426 * @syscap SystemCapability.ArkUI.ArkUI.Full 12427 * @since 9 12428 */ 12429 /** 12430 * The offset of the sharp corner of popup. 12431 * 12432 * @type { ?Length } 12433 * @syscap SystemCapability.ArkUI.ArkUI.Full 12434 * @crossplatform 12435 * @since 10 12436 */ 12437 /** 12438 * The offset of the sharp corner of popup. 12439 * 12440 * @type { ?Length } 12441 * @syscap SystemCapability.ArkUI.ArkUI.Full 12442 * @crossplatform 12443 * @atomicservice 12444 * @since 11 12445 */ 12446 arrowOffset?: Length; 12447 12448 /** 12449 * Whether to display in the sub window. 12450 * 12451 * @type { ?boolean } 12452 * @syscap SystemCapability.ArkUI.ArkUI.Full 12453 * @since 9 12454 */ 12455 /** 12456 * Whether to display in the sub window. 12457 * 12458 * @type { ?boolean } 12459 * @syscap SystemCapability.ArkUI.ArkUI.Full 12460 * @crossplatform 12461 * @since 10 12462 */ 12463 /** 12464 * Whether to display in the sub window. 12465 * 12466 * @type { ?boolean } 12467 * @syscap SystemCapability.ArkUI.ArkUI.Full 12468 * @crossplatform 12469 * @atomicservice 12470 * @since 11 12471 */ 12472 showInSubWindow?: boolean; 12473 12474 /** 12475 * The mask to block gesture events of popup. 12476 * When mask is set false, gesture events are not blocked. 12477 * When mask is set true, gesture events are blocked and mask color is transparent. 12478 * 12479 * @type { ?(boolean | { color: ResourceColor }) } 12480 * @syscap SystemCapability.ArkUI.ArkUI.Full 12481 * @crossplatform 12482 * @since 10 12483 */ 12484 /** 12485 * The mask to block gesture events of popup. 12486 * When mask is set false, gesture events are not blocked. 12487 * When mask is set true, gesture events are blocked and mask color is transparent. 12488 * 12489 * @type { ?(boolean | { color: ResourceColor }) } 12490 * @syscap SystemCapability.ArkUI.ArkUI.Full 12491 * @crossplatform 12492 * @atomicservice 12493 * @since 11 12494 */ 12495 mask?: boolean | { color: ResourceColor }; 12496 12497 /** 12498 * Sets the options of popup message. 12499 * 12500 * @type { ?PopupMessageOptions } 12501 * @syscap SystemCapability.ArkUI.ArkUI.Full 12502 * @crossplatform 12503 * @since 10 12504 */ 12505 /** 12506 * Sets the options of popup message. 12507 * 12508 * @type { ?PopupMessageOptions } 12509 * @syscap SystemCapability.ArkUI.ArkUI.Full 12510 * @crossplatform 12511 * @atomicservice 12512 * @since 11 12513 */ 12514 messageOptions?: PopupMessageOptions 12515 12516 /** 12517 * Sets the space of between the popup and target. 12518 * 12519 * @type { ?Length } 12520 * @syscap SystemCapability.ArkUI.ArkUI.Full 12521 * @crossplatform 12522 * @since 10 12523 */ 12524 /** 12525 * Sets the space of between the popup and target. 12526 * 12527 * @type { ?Length } 12528 * @syscap SystemCapability.ArkUI.ArkUI.Full 12529 * @crossplatform 12530 * @atomicservice 12531 * @since 11 12532 */ 12533 targetSpace?: Length 12534 12535 /** 12536 * whether show arrow 12537 * 12538 * @type { ?boolean } 12539 * @default true 12540 * @syscap SystemCapability.ArkUI.ArkUI.Full 12541 * @since 10 12542 */ 12543 /** 12544 * whether show arrow 12545 * 12546 * @type { ?boolean } 12547 * @default true 12548 * @syscap SystemCapability.ArkUI.ArkUI.Full 12549 * @crossplatform 12550 * @atomicservice 12551 * @since 11 12552 */ 12553 enableArrow?: boolean; 12554 /** 12555 * Sets the position offset of the popup. 12556 * 12557 * @type { ?Position } 12558 * @syscap SystemCapability.ArkUI.ArkUI.Full 12559 * @crossplatform 12560 * @since 10 12561 */ 12562 /** 12563 * Sets the position offset of the popup. 12564 * 12565 * @type { ?Position } 12566 * @syscap SystemCapability.ArkUI.ArkUI.Full 12567 * @crossplatform 12568 * @atomicservice 12569 * @since 11 12570 */ 12571 offset?: Position 12572 12573 /** 12574 * Set the background color of the popup. 12575 * 12576 * @type { ?(Color | string | Resource | number) } 12577 * @syscap SystemCapability.ArkUI.ArkUI.Full 12578 * @crossplatform 12579 * @since 11 12580 */ 12581 /** 12582 * Set the background color of the popup. 12583 * 12584 * @type { ?(Color | string | Resource | number) } 12585 * @syscap SystemCapability.ArkUI.ArkUI.Full 12586 * @crossplatform 12587 * @atomicservice 12588 * @since 12 12589 */ 12590 popupColor?: Color | string | Resource | number; 12591 12592 /** 12593 * Whether hide popup when click mask 12594 * 12595 * @type { ?boolean } 12596 * @default true 12597 * @syscap SystemCapability.ArkUI.ArkUI.Full 12598 * @crossplatform 12599 * @since 11 12600 */ 12601 /** 12602 * Whether hide popup when click mask 12603 * 12604 * @type { ?boolean } 12605 * @default true 12606 * @syscap SystemCapability.ArkUI.ArkUI.Full 12607 * @crossplatform 12608 * @atomicservice 12609 * @since 12 12610 */ 12611 autoCancel?: boolean; 12612 12613 /** 12614 * Set the width of the popup. 12615 * 12616 * @type { ?Dimension } 12617 * @syscap SystemCapability.ArkUI.ArkUI.Full 12618 * @crossplatform 12619 * @since 11 12620 */ 12621 /** 12622 * Set the width of the popup. 12623 * 12624 * @type { ?Dimension } 12625 * @syscap SystemCapability.ArkUI.ArkUI.Full 12626 * @crossplatform 12627 * @atomicservice 12628 * @since 12 12629 */ 12630 width?: Dimension; 12631 12632 /** 12633 * The position of the sharp corner of popup. 12634 * 12635 * @type { ?ArrowPointPosition } 12636 * @syscap SystemCapability.ArkUI.ArkUI.Full 12637 * @crossplatform 12638 * @since 11 12639 */ 12640 /** 12641 * The position of the sharp corner of popup. 12642 * 12643 * @type { ?ArrowPointPosition } 12644 * @syscap SystemCapability.ArkUI.ArkUI.Full 12645 * @crossplatform 12646 * @atomicservice 12647 * @since 12 12648 */ 12649 arrowPointPosition?: ArrowPointPosition; 12650 12651 /** 12652 * The width of the arrow. 12653 * 12654 * @type { ?Dimension } 12655 * @default 16.0_vp. 12656 * @syscap SystemCapability.ArkUI.ArkUI.Full 12657 * @crossplatform 12658 * @since 11 12659 */ 12660 /** 12661 * The width of the arrow. 12662 * 12663 * @type { ?Dimension } 12664 * @default 16.0_vp. 12665 * @syscap SystemCapability.ArkUI.ArkUI.Full 12666 * @crossplatform 12667 * @atomicservice 12668 * @since 12 12669 */ 12670 arrowWidth?: Dimension; 12671 12672 /** 12673 * The height of the arrow. 12674 * 12675 * @type { ?Dimension } 12676 * @default 8.0_vp. 12677 * @syscap SystemCapability.ArkUI.ArkUI.Full 12678 * @crossplatform 12679 * @since 11 12680 */ 12681 /** 12682 * The height of the arrow. 12683 * 12684 * @type { ?Dimension } 12685 * @default 8.0_vp. 12686 * @syscap SystemCapability.ArkUI.ArkUI.Full 12687 * @crossplatform 12688 * @atomicservice 12689 * @since 12 12690 */ 12691 arrowHeight?: Dimension; 12692 12693 /** 12694 * The round corners of the popup. 12695 * 12696 * @type { ?Dimension } 12697 * @default 20.0_vp. 12698 * @syscap SystemCapability.ArkUI.ArkUI.Full 12699 * @crossplatform 12700 * @since 11 12701 */ 12702 /** 12703 * The round corners of the popup. 12704 * 12705 * @type { ?Dimension } 12706 * @default 20.0_vp. 12707 * @syscap SystemCapability.ArkUI.ArkUI.Full 12708 * @crossplatform 12709 * @atomicservice 12710 * @since 12 12711 */ 12712 radius?: Dimension; 12713 12714 /** 12715 * The style of popup Shadow. 12716 * 12717 * @type { ?(ShadowOptions | ShadowStyle) } 12718 * @default ShadowStyle.OUTER_DEFAULT_MD. 12719 * @syscap SystemCapability.ArkUI.ArkUI.Full 12720 * @crossplatform 12721 * @since 11 12722 */ 12723 /** 12724 * The style of popup Shadow. 12725 * 12726 * @type { ?(ShadowOptions | ShadowStyle) } 12727 * @default ShadowStyle.OUTER_DEFAULT_MD. 12728 * @syscap SystemCapability.ArkUI.ArkUI.Full 12729 * @crossplatform 12730 * @atomicservice 12731 * @since 12 12732 */ 12733 shadow?: ShadowOptions | ShadowStyle; 12734 12735 /** 12736 * Defines popup background blur Style 12737 * 12738 * @type { ?BlurStyle } 12739 * @default BlurStyle.COMPONENT_ULTRA_THICK 12740 * @syscap SystemCapability.ArkUI.ArkUI.Full 12741 * @crossplatform 12742 * @since 11 12743 */ 12744 /** 12745 * Defines popup background blur Style 12746 * 12747 * @type { ?BlurStyle } 12748 * @default BlurStyle.COMPONENT_ULTRA_THICK 12749 * @syscap SystemCapability.ArkUI.ArkUI.Full 12750 * @crossplatform 12751 * @atomicservice 12752 * @since 12 12753 */ 12754 backgroundBlurStyle?: BlurStyle; 12755 12756 /** 12757 * Defines the transition effect of popup opening and closing 12758 * 12759 * @type { ?TransitionEffect } 12760 * @syscap SystemCapability.ArkUI.ArkUI.Full 12761 * @crossplatform 12762 * @atomicservice 12763 * @since 12 12764 */ 12765 transition?: TransitionEffect; 12766 12767 /** 12768 * Callback function when the popup interactive dismiss 12769 * 12770 * @type { ?(boolean | Callback<DismissPopupAction>) } 12771 * @syscap SystemCapability.ArkUI.ArkUI.Full 12772 * @crossplatform 12773 * @atomicservice 12774 * @since 12 12775 */ 12776 onWillDismiss?: boolean | Callback<DismissPopupAction>; 12777 12778 /** 12779 * Determine if it is compatible popup's half folded. 12780 * 12781 * @type { ?boolean } 12782 * @default false 12783 * @syscap SystemCapability.ArkUI.ArkUI.Full 12784 * @crossplatform 12785 * @atomicservice 12786 * @since 13 12787 */ 12788 enableHoverMode?: boolean; 12789 12790 /** 12791 * Determine if popup can follow the target node when it has rotation or scale. 12792 * 12793 * @type { ?boolean } 12794 * @default false 12795 * @syscap SystemCapability.ArkUI.ArkUI.Full 12796 * @crossplatform 12797 * @atomicservice 12798 * @since 14 12799 */ 12800 followTransformOfTarget?: boolean; 12801} 12802 12803/** 12804 * Defines the custom popup options. 12805 * 12806 * @interface CustomPopupOptions 12807 * @syscap SystemCapability.ArkUI.ArkUI.Full 12808 * @since 8 12809 */ 12810/** 12811 * Defines the custom popup options. 12812 * 12813 * @interface CustomPopupOptions 12814 * @syscap SystemCapability.ArkUI.ArkUI.Full 12815 * @crossplatform 12816 * @since 10 12817 */ 12818/** 12819 * Defines the custom popup options. 12820 * 12821 * @interface CustomPopupOptions 12822 * @syscap SystemCapability.ArkUI.ArkUI.Full 12823 * @crossplatform 12824 * @atomicservice 12825 * @since 11 12826 */ 12827declare interface CustomPopupOptions { 12828 /** 12829 * builder of popup 12830 * 12831 * @type { CustomBuilder } 12832 * @syscap SystemCapability.ArkUI.ArkUI.Full 12833 * @since 8 12834 */ 12835 /** 12836 * builder of popup 12837 * 12838 * @type { CustomBuilder } 12839 * @syscap SystemCapability.ArkUI.ArkUI.Full 12840 * @crossplatform 12841 * @since 10 12842 */ 12843 /** 12844 * builder of popup 12845 * 12846 * @type { CustomBuilder } 12847 * @syscap SystemCapability.ArkUI.ArkUI.Full 12848 * @crossplatform 12849 * @atomicservice 12850 * @since 11 12851 */ 12852 builder: CustomBuilder; 12853 12854 /** 12855 * placement of popup 12856 * 12857 * @type { ?Placement } 12858 * @syscap SystemCapability.ArkUI.ArkUI.Full 12859 * @since 8 12860 */ 12861 /** 12862 * placement of popup 12863 * 12864 * @type { ?Placement } 12865 * @syscap SystemCapability.ArkUI.ArkUI.Full 12866 * @crossplatform 12867 * @since 10 12868 */ 12869 /** 12870 * placement of popup 12871 * 12872 * @type { ?Placement } 12873 * @syscap SystemCapability.ArkUI.ArkUI.Full 12874 * @crossplatform 12875 * @atomicservice 12876 * @since 11 12877 */ 12878 placement?: Placement; 12879 12880 /** 12881 * mask color of popup 12882 * 12883 * @type { ?(Color | string | Resource | number) } 12884 * @syscap SystemCapability.ArkUI.ArkUI.Full 12885 * @since 8 12886 * @deprecated since 10 12887 * @useinstead CustomPopupOptions#mask 12888 */ 12889 maskColor?: Color | string | Resource | number; 12890 12891 /** 12892 * background color of popup 12893 * 12894 * @type { ?(Color | string | Resource | number) } 12895 * @syscap SystemCapability.ArkUI.ArkUI.Full 12896 * @since 8 12897 */ 12898 /** 12899 * background color of popup 12900 * 12901 * @type { ?(Color | string | Resource | number) } 12902 * @syscap SystemCapability.ArkUI.ArkUI.Full 12903 * @crossplatform 12904 * @since 10 12905 */ 12906 /** 12907 * background color of popup 12908 * 12909 * @type { ?(Color | string | Resource | number) } 12910 * @syscap SystemCapability.ArkUI.ArkUI.Full 12911 * @crossplatform 12912 * @atomicservice 12913 * @since 11 12914 */ 12915 popupColor?: Color | string | Resource | number; 12916 12917 /** 12918 * whether show arrow 12919 * 12920 * @type { ?boolean } 12921 * @syscap SystemCapability.ArkUI.ArkUI.Full 12922 * @since 8 12923 */ 12924 /** 12925 * whether show arrow 12926 * 12927 * @type { ?boolean } 12928 * @syscap SystemCapability.ArkUI.ArkUI.Full 12929 * @crossplatform 12930 * @since 10 12931 */ 12932 /** 12933 * whether show arrow 12934 * 12935 * @type { ?boolean } 12936 * @syscap SystemCapability.ArkUI.ArkUI.Full 12937 * @crossplatform 12938 * @atomicservice 12939 * @since 11 12940 */ 12941 enableArrow?: boolean; 12942 12943 /** 12944 * whether hide popup when click mask 12945 * 12946 * @type { ?boolean } 12947 * @syscap SystemCapability.ArkUI.ArkUI.Full 12948 * @since 8 12949 */ 12950 /** 12951 * whether hide popup when click mask 12952 * 12953 * @type { ?boolean } 12954 * @syscap SystemCapability.ArkUI.ArkUI.Full 12955 * @crossplatform 12956 * @since 10 12957 */ 12958 /** 12959 * whether hide popup when click mask 12960 * 12961 * @type { ?boolean } 12962 * @syscap SystemCapability.ArkUI.ArkUI.Full 12963 * @crossplatform 12964 * @atomicservice 12965 * @since 11 12966 */ 12967 autoCancel?: boolean; 12968 12969 /** 12970 * on State Change 12971 * 12972 * @type { ?function } 12973 * @syscap SystemCapability.ArkUI.ArkUI.Full 12974 * @since 8 12975 */ 12976 /** 12977 * on State Change 12978 * 12979 * @type { ?function } 12980 * @syscap SystemCapability.ArkUI.ArkUI.Full 12981 * @crossplatform 12982 * @since 10 12983 */ 12984 /** 12985 * on State Change 12986 * 12987 * @type { ?function } 12988 * @syscap SystemCapability.ArkUI.ArkUI.Full 12989 * @crossplatform 12990 * @atomicservice 12991 * @since 11 12992 */ 12993 onStateChange?: (event: { 12994 /** 12995 * is Visible. 12996 * 12997 * @type { boolean } 12998 * @syscap SystemCapability.ArkUI.ArkUI.Full 12999 * @crossplatform 13000 * @since 10 13001 */ 13002 /** 13003 * is Visible. 13004 * 13005 * @type { boolean } 13006 * @syscap SystemCapability.ArkUI.ArkUI.Full 13007 * @crossplatform 13008 * @atomicservice 13009 * @since 11 13010 */ 13011 isVisible: boolean 13012 }) => void; 13013 13014 /** 13015 * The offset of the sharp corner of popup. 13016 * 13017 * @type { ?Length } 13018 * @syscap SystemCapability.ArkUI.ArkUI.Full 13019 * @since 9 13020 */ 13021 /** 13022 * The offset of the sharp corner of popup. 13023 * 13024 * @type { ?Length } 13025 * @syscap SystemCapability.ArkUI.ArkUI.Full 13026 * @crossplatform 13027 * @since 10 13028 */ 13029 /** 13030 * The offset of the sharp corner of popup. 13031 * 13032 * @type { ?Length } 13033 * @syscap SystemCapability.ArkUI.ArkUI.Full 13034 * @crossplatform 13035 * @atomicservice 13036 * @since 11 13037 */ 13038 arrowOffset?: Length; 13039 13040 /** 13041 * Whether to display in the sub window. 13042 * 13043 * @type { ?boolean } 13044 * @syscap SystemCapability.ArkUI.ArkUI.Full 13045 * @since 9 13046 */ 13047 /** 13048 * Whether to display in the sub window. 13049 * 13050 * @type { ?boolean } 13051 * @syscap SystemCapability.ArkUI.ArkUI.Full 13052 * @crossplatform 13053 * @since 10 13054 */ 13055 /** 13056 * Whether to display in the sub window. 13057 * 13058 * @type { ?boolean } 13059 * @syscap SystemCapability.ArkUI.ArkUI.Full 13060 * @crossplatform 13061 * @atomicservice 13062 * @since 11 13063 */ 13064 showInSubWindow?: boolean; 13065 13066 /** 13067 * The mask to block gesture events of popup. 13068 * When mask is set false, gesture events are not blocked. 13069 * When mask is set true, gesture events are blocked and mask color is transparent. 13070 * 13071 * @type { ?(boolean | { color: ResourceColor }) } 13072 * @syscap SystemCapability.ArkUI.ArkUI.Full 13073 * @crossplatform 13074 * @since 10 13075 */ 13076 /** 13077 * The mask to block gesture events of popup. 13078 * When mask is set false, gesture events are not blocked. 13079 * When mask is set true, gesture events are blocked and mask color is transparent. 13080 * 13081 * @type { ?(boolean | { color: ResourceColor }) } 13082 * @syscap SystemCapability.ArkUI.ArkUI.Full 13083 * @crossplatform 13084 * @atomicservice 13085 * @since 11 13086 */ 13087 mask?: boolean | { color: ResourceColor }; 13088 13089 /** 13090 * Sets the space of between the popup and target. 13091 * 13092 * @type { ?Length } 13093 * @syscap SystemCapability.ArkUI.ArkUI.Full 13094 * @crossplatform 13095 * @since 10 13096 */ 13097 /** 13098 * Sets the space of between the popup and target. 13099 * 13100 * @type { ?Length } 13101 * @syscap SystemCapability.ArkUI.ArkUI.Full 13102 * @crossplatform 13103 * @atomicservice 13104 * @since 11 13105 */ 13106 targetSpace?: Length 13107 13108 /** 13109 * Sets the position offset of the popup. 13110 * 13111 * @type { ?Position } 13112 * @syscap SystemCapability.ArkUI.ArkUI.Full 13113 * @crossplatform 13114 * @since 10 13115 */ 13116 /** 13117 * Sets the position offset of the popup. 13118 * 13119 * @type { ?Position } 13120 * @syscap SystemCapability.ArkUI.ArkUI.Full 13121 * @crossplatform 13122 * @atomicservice 13123 * @since 11 13124 */ 13125 offset?: Position 13126 13127 /** 13128 * Set the width of the popup. 13129 * 13130 * @type { ?Dimension } 13131 * @syscap SystemCapability.ArkUI.ArkUI.Full 13132 * @crossplatform 13133 * @since 11 13134 */ 13135 /** 13136 * Set the width of the popup. 13137 * 13138 * @type { ?Dimension } 13139 * @syscap SystemCapability.ArkUI.ArkUI.Full 13140 * @crossplatform 13141 * @atomicservice 13142 * @since 12 13143 */ 13144 width?: Dimension; 13145 13146 /** 13147 * The position of the sharp corner of popup. 13148 * 13149 * @type { ?ArrowPointPosition } 13150 * @syscap SystemCapability.ArkUI.ArkUI.Full 13151 * @crossplatform 13152 * @since 11 13153 */ 13154 /** 13155 * The position of the sharp corner of popup. 13156 * 13157 * @type { ?ArrowPointPosition } 13158 * @syscap SystemCapability.ArkUI.ArkUI.Full 13159 * @crossplatform 13160 * @atomicservice 13161 * @since 12 13162 */ 13163 arrowPointPosition?: ArrowPointPosition; 13164 13165 /** 13166 * The width of the arrow. 13167 * 13168 * @type { ?Dimension } 13169 * @default 16.0_vp. 13170 * @syscap SystemCapability.ArkUI.ArkUI.Full 13171 * @crossplatform 13172 * @since 11 13173 */ 13174 /** 13175 * The width of the arrow. 13176 * 13177 * @type { ?Dimension } 13178 * @default 16.0_vp. 13179 * @syscap SystemCapability.ArkUI.ArkUI.Full 13180 * @crossplatform 13181 * @atomicservice 13182 * @since 12 13183 */ 13184 arrowWidth?: Dimension; 13185 13186 /** 13187 * The height of the arrow. 13188 * 13189 * @type { ?Dimension } 13190 * @default 8.0_vp. 13191 * @syscap SystemCapability.ArkUI.ArkUI.Full 13192 * @crossplatform 13193 * @since 11 13194 */ 13195 /** 13196 * The height of the arrow. 13197 * 13198 * @type { ?Dimension } 13199 * @default 8.0_vp. 13200 * @syscap SystemCapability.ArkUI.ArkUI.Full 13201 * @crossplatform 13202 * @atomicservice 13203 * @since 12 13204 */ 13205 arrowHeight?: Dimension; 13206 13207 /** 13208 * The round corners of the popup. 13209 * 13210 * @type { ?Dimension } 13211 * @default 20.0_vp. 13212 * @syscap SystemCapability.ArkUI.ArkUI.Full 13213 * @crossplatform 13214 * @since 11 13215 */ 13216 /** 13217 * The round corners of the popup. 13218 * 13219 * @type { ?Dimension } 13220 * @default 20.0_vp. 13221 * @syscap SystemCapability.ArkUI.ArkUI.Full 13222 * @crossplatform 13223 * @atomicservice 13224 * @since 12 13225 */ 13226 radius?: Dimension; 13227 13228 /** 13229 * The style of popup Shadow. 13230 * 13231 * @type { ?(ShadowOptions | ShadowStyle) } 13232 * @default ShadowStyle.OUTER_DEFAULT_MD. 13233 * @syscap SystemCapability.ArkUI.ArkUI.Full 13234 * @crossplatform 13235 * @since 11 13236 */ 13237 /** 13238 * The style of popup Shadow. 13239 * 13240 * @type { ?(ShadowOptions | ShadowStyle) } 13241 * @default ShadowStyle.OUTER_DEFAULT_MD. 13242 * @syscap SystemCapability.ArkUI.ArkUI.Full 13243 * @crossplatform 13244 * @atomicservice 13245 * @since 12 13246 */ 13247 shadow?: ShadowOptions | ShadowStyle; 13248 13249 /** 13250 * Defines popup background blur Style 13251 * 13252 * @type { ?BlurStyle } 13253 * @default BlurStyle.COMPONENT_ULTRA_THICK 13254 * @syscap SystemCapability.ArkUI.ArkUI.Full 13255 * @crossplatform 13256 * @since 11 13257 */ 13258 /** 13259 * Defines popup background blur Style 13260 * 13261 * @type { ?BlurStyle } 13262 * @default BlurStyle.COMPONENT_ULTRA_THICK 13263 * @syscap SystemCapability.ArkUI.ArkUI.Full 13264 * @crossplatform 13265 * @atomicservice 13266 * @since 12 13267 */ 13268 backgroundBlurStyle?: BlurStyle; 13269 13270 /** 13271 * Set popup focusable 13272 * 13273 * @type { ?boolean } 13274 * @default true 13275 * @syscap SystemCapability.ArkUI.ArkUI.Full 13276 * @crossplatform 13277 * @since 11 13278 */ 13279 /** 13280 * Set popup focusable 13281 * 13282 * @type { ?boolean } 13283 * @default true 13284 * @syscap SystemCapability.ArkUI.ArkUI.Full 13285 * @crossplatform 13286 * @atomicservice 13287 * @since 12 13288 */ 13289 focusable?: boolean; 13290 13291 /** 13292 * Defines the transition effect of popup opening and closing 13293 * 13294 * @type { ?TransitionEffect } 13295 * @syscap SystemCapability.ArkUI.ArkUI.Full 13296 * @crossplatform 13297 * @atomicservice 13298 * @since 12 13299 */ 13300 transition?: TransitionEffect; 13301 13302 /** 13303 * Callback function when the popup interactive dismiss 13304 * 13305 * @type { ?(boolean | Callback<DismissPopupAction>) } 13306 * @syscap SystemCapability.ArkUI.ArkUI.Full 13307 * @crossplatform 13308 * @atomicservice 13309 * @since 12 13310 */ 13311 onWillDismiss?: boolean | Callback<DismissPopupAction>; 13312 13313 /** 13314 * Determine if it is compatible popup's half folded. 13315 * 13316 * @type { ?boolean } 13317 * @default false 13318 * @syscap SystemCapability.ArkUI.ArkUI.Full 13319 * @crossplatform 13320 * @atomicservice 13321 * @since 13 13322 */ 13323 enableHoverMode?: boolean; 13324 13325 /** 13326 * Determine if popup can follow the target node when it has rotation or scale. 13327 * 13328 * @type { ?boolean } 13329 * @default false 13330 * @syscap SystemCapability.ArkUI.ArkUI.Full 13331 * @crossplatform 13332 * @atomicservice 13333 * @since 14 13334 */ 13335 followTransformOfTarget?: boolean; 13336} 13337 13338/** 13339 * Defines the menu preview mode. 13340 * 13341 * @enum { number } 13342 * @syscap SystemCapability.ArkUI.ArkUI.Full 13343 * @crossplatform 13344 * @since 11 13345 */ 13346/** 13347 * Defines the menu preview mode. 13348 * 13349 * @enum { number } 13350 * @syscap SystemCapability.ArkUI.ArkUI.Full 13351 * @crossplatform 13352 * @atomicservice 13353 * @since 12 13354 */ 13355declare enum MenuPreviewMode { 13356 /** 13357 * No preview content. 13358 * 13359 * @syscap SystemCapability.ArkUI.ArkUI.Full 13360 * @crossplatform 13361 * @since 11 13362 */ 13363 /** 13364 * No preview content. 13365 * 13366 * @syscap SystemCapability.ArkUI.ArkUI.Full 13367 * @crossplatform 13368 * @atomicservice 13369 * @since 12 13370 */ 13371 NONE = 0, 13372 /** 13373 * Defines image type preview content. 13374 * 13375 * @syscap SystemCapability.ArkUI.ArkUI.Full 13376 * @crossplatform 13377 * @since 11 13378 */ 13379 /** 13380 * Defines image type preview content. 13381 * 13382 * @syscap SystemCapability.ArkUI.ArkUI.Full 13383 * @crossplatform 13384 * @atomicservice 13385 * @since 12 13386 */ 13387 IMAGE = 1 13388} 13389 13390/** 13391 * Defines the animator range of start and end property. 13392 * 13393 * @typedef { [from: T, to: T] } AnimationRange<T> 13394 * @syscap SystemCapability.ArkUI.ArkUI.Full 13395 * @crossplatform 13396 * @since 11 13397 */ 13398/** 13399 * Defines the animator range of start and end property. 13400 * 13401 * @typedef { [from: T, to: T] } AnimationRange<T> 13402 * @syscap SystemCapability.ArkUI.ArkUI.Full 13403 * @crossplatform 13404 * @atomicservice 13405 * @since 12 13406 */ 13407declare type AnimationRange<T> = [from: T, to: T]; 13408 13409/** 13410 * Defines the ContextMenu's preview animator options. 13411 * 13412 * @interface ContextMenuAnimationOptions 13413 * @syscap SystemCapability.ArkUI.ArkUI.Full 13414 * @crossplatform 13415 * @since 11 13416 */ 13417/** 13418 * Defines the ContextMenu's preview animator options. 13419 * 13420 * @interface ContextMenuAnimationOptions 13421 * @syscap SystemCapability.ArkUI.ArkUI.Full 13422 * @crossplatform 13423 * @atomicservice 13424 * @since 12 13425 */ 13426interface ContextMenuAnimationOptions { 13427 /** 13428 * Sets the start animator scale and end animator scale. 13429 * 13430 * @type { ?AnimationRange<number> } 13431 * @default - 13432 * @syscap SystemCapability.ArkUI.ArkUI.Full 13433 * @crossplatform 13434 * @since 11 13435 */ 13436 /** 13437 * Sets the start animator scale and end animator scale. 13438 * 13439 * @type { ?AnimationRange<number> } 13440 * @default - 13441 * @syscap SystemCapability.ArkUI.ArkUI.Full 13442 * @crossplatform 13443 * @atomicservice 13444 * @since 12 13445 */ 13446 scale?: AnimationRange<number>; 13447 /** 13448 * Defines the transition effect of menu preview opening and closing. 13449 * 13450 * @type { ?TransitionEffect } 13451 * @syscap SystemCapability.ArkUI.ArkUI.Full 13452 * @crossplatform 13453 * @atomicservice 13454 * @since 12 13455 */ 13456 transition?: TransitionEffect; 13457 13458 /** 13459 * Sets the scale start and end animator of the image displayed before the custom builder preview is displayed. 13460 * 13461 * @type { ?AnimationRange<number> } 13462 * @syscap SystemCapability.ArkUI.ArkUI.Full 13463 * @crossplatform 13464 * @atomicservice 13465 * @since 12 13466 */ 13467 hoverScale?: AnimationRange<number>; 13468} 13469 13470/** 13471 * Defines the context menu options. 13472 * 13473 * @interface ContextMenuOptions 13474 * @syscap SystemCapability.ArkUI.ArkUI.Full 13475 * @crossplatform 13476 * @since 10 13477 */ 13478/** 13479 * Defines the context menu options. 13480 * 13481 * @interface ContextMenuOptions 13482 * @syscap SystemCapability.ArkUI.ArkUI.Full 13483 * @crossplatform 13484 * @atomicservice 13485 * @since 11 13486 */ 13487declare interface ContextMenuOptions { 13488 /** 13489 * Sets the position offset of the context menu window. 13490 * 13491 * @type { ?Position } 13492 * @default - 13493 * @syscap SystemCapability.ArkUI.ArkUI.Full 13494 * @crossplatform 13495 * @since 10 13496 */ 13497 /** 13498 * Sets the position offset of the context menu window. 13499 * 13500 * @type { ?Position } 13501 * @default - 13502 * @syscap SystemCapability.ArkUI.ArkUI.Full 13503 * @crossplatform 13504 * @atomicservice 13505 * @since 11 13506 */ 13507 offset?: Position; 13508 13509 /** 13510 * Sets the placement of the context menu window. 13511 * 13512 * @type { ?Placement } 13513 * @default - 13514 * @syscap SystemCapability.ArkUI.ArkUI.Full 13515 * @crossplatform 13516 * @since 10 13517 */ 13518 /** 13519 * Sets the placement of the context menu window. 13520 * 13521 * @type { ?Placement } 13522 * @default - 13523 * @syscap SystemCapability.ArkUI.ArkUI.Full 13524 * @crossplatform 13525 * @atomicservice 13526 * @since 11 13527 */ 13528 placement?: Placement; 13529 13530 /** 13531 * whether show arrow belong to the menu, default: false, not show arrow 13532 * 13533 * @type { ?boolean } 13534 * @default false 13535 * @syscap SystemCapability.ArkUI.ArkUI.Full 13536 * @since 10 13537 */ 13538 /** 13539 * whether show arrow belong to the menu, default: false, not show arrow 13540 * 13541 * @type { ?boolean } 13542 * @default false 13543 * @syscap SystemCapability.ArkUI.ArkUI.Full 13544 * @crossplatform 13545 * @atomicservice 13546 * @since 11 13547 */ 13548 enableArrow?: boolean; 13549 13550 /** 13551 * The horizontal offset to the left of menu or vertical offset to the top of menu 13552 * 13553 * @type { ?Length } 13554 * @default 0 13555 * @syscap SystemCapability.ArkUI.ArkUI.Full 13556 * @since 10 13557 */ 13558 /** 13559 * The horizontal offset to the left of menu or vertical offset to the top of menu 13560 * 13561 * @type { ?Length } 13562 * @default 0 13563 * @syscap SystemCapability.ArkUI.ArkUI.Full 13564 * @crossplatform 13565 * @atomicservice 13566 * @since 11 13567 */ 13568 arrowOffset?: Length; 13569 13570 /** 13571 * The preview content of context menu. 13572 * 13573 * @type { ?(MenuPreviewMode | CustomBuilder) } 13574 * @default MenuPreviewMode.NONE 13575 * @syscap SystemCapability.ArkUI.ArkUI.Full 13576 * @crossplatform 13577 * @since 11 13578 */ 13579 /** 13580 * The preview content of context menu. 13581 * 13582 * @type { ?(MenuPreviewMode | CustomBuilder) } 13583 * @default MenuPreviewMode.NONE 13584 * @syscap SystemCapability.ArkUI.ArkUI.Full 13585 * @crossplatform 13586 * @atomicservice 13587 * @since 12 13588 */ 13589 preview?: MenuPreviewMode | CustomBuilder; 13590 13591 /** 13592 * Defines the border radius of menu. 13593 * 13594 * @type { ?(Length | BorderRadiuses | LocalizedBorderRadiuses) } 13595 * @syscap SystemCapability.ArkUI.ArkUI.Full 13596 * @crossplatform 13597 * @atomicservice 13598 * @since 12 13599 */ 13600 borderRadius?: Length | BorderRadiuses | LocalizedBorderRadiuses; 13601 13602 /** 13603 * Callback function when the context menu appears. 13604 * 13605 * @type { ?function } 13606 * @syscap SystemCapability.ArkUI.ArkUI.Full 13607 * @crossplatform 13608 * @since 10 13609 */ 13610 /** 13611 * Callback function when the context menu appears. 13612 * 13613 * @type { ?function } 13614 * @syscap SystemCapability.ArkUI.ArkUI.Full 13615 * @crossplatform 13616 * @atomicservice 13617 * @since 11 13618 */ 13619 onAppear?: () => void; 13620 13621 /** 13622 * Callback function when the context menu disappear. 13623 * 13624 * @type { ?function } 13625 * @syscap SystemCapability.ArkUI.ArkUI.Full 13626 * @crossplatform 13627 * @since 10 13628 */ 13629 /** 13630 * Callback function when the context menu disappear. 13631 * 13632 * @type { ?function } 13633 * @syscap SystemCapability.ArkUI.ArkUI.Full 13634 * @crossplatform 13635 * @atomicservice 13636 * @since 11 13637 */ 13638 onDisappear?: () => void; 13639 13640 /** 13641 * Callback function before the context menu animation starts. 13642 * 13643 * @type { ?function } 13644 * @syscap SystemCapability.ArkUI.ArkUI.Full 13645 * @crossplatform 13646 * @since 11 13647 */ 13648 /** 13649 * Callback function before the context menu animation starts. 13650 * 13651 * @type { ?function } 13652 * @syscap SystemCapability.ArkUI.ArkUI.Full 13653 * @crossplatform 13654 * @atomicservice 13655 * @since 12 13656 */ 13657 aboutToAppear?: () => void; 13658 13659 /** 13660 * Callback function before the context menu popAnimation starts. 13661 * 13662 * @type { ?function } 13663 * @syscap SystemCapability.ArkUI.ArkUI.Full 13664 * @crossplatform 13665 * @since 11 13666 */ 13667 /** 13668 * Callback function before the context menu popAnimation starts. 13669 * 13670 * @type { ?function } 13671 * @syscap SystemCapability.ArkUI.ArkUI.Full 13672 * @crossplatform 13673 * @atomicservice 13674 * @since 12 13675 */ 13676 aboutToDisappear?: () => void; 13677 13678 /** 13679 * The margin of menu's layoutRegion. 13680 * 13681 * @type { ?Margin } 13682 * @syscap SystemCapability.ArkUI.ArkUI.Full 13683 * @crossplatform 13684 * @atomicservice 13685 * @since 13 13686 */ 13687 layoutRegionMargin?: Margin; 13688 13689 /** 13690 * The preview animator options. 13691 * 13692 * @type { ?ContextMenuAnimationOptions } 13693 * @syscap SystemCapability.ArkUI.ArkUI.Full 13694 * @crossplatform 13695 * @since 11 13696 */ 13697 /** 13698 * The preview animator options. 13699 * 13700 * @type { ?ContextMenuAnimationOptions } 13701 * @syscap SystemCapability.ArkUI.ArkUI.Full 13702 * @crossplatform 13703 * @atomicservice 13704 * @since 12 13705 */ 13706 previewAnimationOptions?: ContextMenuAnimationOptions; 13707 13708 /** 13709 * Defines the menu's background color 13710 * 13711 * @type { ?ResourceColor } 13712 * @default Color.Transparent 13713 * @syscap SystemCapability.ArkUI.ArkUI.Full 13714 * @crossplatform 13715 * @since 11 13716 */ 13717 /** 13718 * Defines the menu's background color 13719 * 13720 * @type { ?ResourceColor } 13721 * @default Color.Transparent 13722 * @syscap SystemCapability.ArkUI.ArkUI.Full 13723 * @crossplatform 13724 * @atomicservice 13725 * @since 12 13726 */ 13727 backgroundColor?: ResourceColor; 13728 13729 /** 13730 * Defines menu background blur Style 13731 * 13732 * @type { ?BlurStyle } 13733 * @default BlurStyle.COMPONENT_ULTRA_THICK 13734 * @syscap SystemCapability.ArkUI.ArkUI.Full 13735 * @crossplatform 13736 * @since 11 13737 */ 13738 /** 13739 * Defines menu background blur Style 13740 * 13741 * @type { ?BlurStyle } 13742 * @default BlurStyle.COMPONENT_ULTRA_THICK 13743 * @syscap SystemCapability.ArkUI.ArkUI.Full 13744 * @crossplatform 13745 * @atomicservice 13746 * @since 12 13747 */ 13748 backgroundBlurStyle?: BlurStyle; 13749 13750 /** 13751 * Defines the transition effect of menu opening and closing. 13752 * 13753 * @type { ?TransitionEffect } 13754 * @syscap SystemCapability.ArkUI.ArkUI.Full 13755 * @crossplatform 13756 * @atomicservice 13757 * @since 12 13758 */ 13759 transition?: TransitionEffect; 13760 13761 /** 13762 * Determine if it is compatible menu's half folded. 13763 * 13764 * @type { ?boolean } 13765 * @default false 13766 * @syscap SystemCapability.ArkUI.ArkUI.Full 13767 * @crossplatform 13768 * @atomicservice 13769 * @since 13 13770 */ 13771 enableHoverMode?: boolean; 13772} 13773 13774/** 13775 * Defines the menu options. 13776 * 13777 * @interface MenuOptions 13778 * @syscap SystemCapability.ArkUI.ArkUI.Full 13779 * @crossplatform 13780 * @since 10 13781 */ 13782/** 13783 * Defines the menu options. 13784 * 13785 * @interface MenuOptions 13786 * @syscap SystemCapability.ArkUI.ArkUI.Full 13787 * @crossplatform 13788 * @atomicservice 13789 * @since 11 13790 */ 13791declare interface MenuOptions extends ContextMenuOptions { 13792 /** 13793 * Sets the title of the menu window. 13794 * 13795 * @type { ?ResourceStr } 13796 * @syscap SystemCapability.ArkUI.ArkUI.Full 13797 * @crossplatform 13798 * @since 10 13799 */ 13800 /** 13801 * Sets the title of the menu window. 13802 * 13803 * @type { ?ResourceStr } 13804 * @syscap SystemCapability.ArkUI.ArkUI.Full 13805 * @crossplatform 13806 * @atomicservice 13807 * @since 11 13808 */ 13809 title?: ResourceStr; 13810 13811 /** 13812 * Whether to display in the sub window. 13813 * 13814 * @type { ?boolean } 13815 * @syscap SystemCapability.ArkUI.ArkUI.Full 13816 * @crossplatform 13817 * @since 11 13818 */ 13819 /** 13820 * Whether to display in the sub window. 13821 * 13822 * @type { ?boolean } 13823 * @syscap SystemCapability.ArkUI.ArkUI.Full 13824 * @crossplatform 13825 * @atomicservice 13826 * @since 12 13827 */ 13828 showInSubWindow?: boolean; 13829} 13830 13831/** 13832 * Defines the ProgressMask class. 13833 * 13834 * @syscap SystemCapability.ArkUI.ArkUI.Full 13835 * @crossplatform 13836 * @since 10 13837 */ 13838/** 13839 * Defines the ProgressMask class. 13840 * 13841 * @syscap SystemCapability.ArkUI.ArkUI.Full 13842 * @crossplatform 13843 * @atomicservice 13844 * @since 11 13845 */ 13846declare class ProgressMask { 13847 /** 13848 * constructor. 13849 * 13850 * @param { number } value - indicates the current value of the progress. 13851 * @param { number } total - indicates the total value of the progress. 13852 * @param { ResourceColor } color - indicates the color of the mask. 13853 * @syscap SystemCapability.ArkUI.ArkUI.Full 13854 * @crossplatform 13855 * @since 10 13856 */ 13857 /** 13858 * constructor. 13859 * 13860 * @param { number } value - indicates the current value of the progress. 13861 * @param { number } total - indicates the total value of the progress. 13862 * @param { ResourceColor } color - indicates the color of the mask. 13863 * @syscap SystemCapability.ArkUI.ArkUI.Full 13864 * @crossplatform 13865 * @atomicservice 13866 * @since 11 13867 */ 13868 constructor(value: number, total: number, color: ResourceColor); 13869 13870 /** 13871 * Update the current value of the progress. 13872 * 13873 * @param { number } value - indicates the current value of the progress. 13874 * @syscap SystemCapability.ArkUI.ArkUI.Full 13875 * @crossplatform 13876 * @since 10 13877 */ 13878 /** 13879 * Update the current value of the progress. 13880 * 13881 * @param { number } value - indicates the current value of the progress. 13882 * @syscap SystemCapability.ArkUI.ArkUI.Full 13883 * @crossplatform 13884 * @atomicservice 13885 * @since 11 13886 */ 13887 updateProgress(value: number): void; 13888 13889 /** 13890 * Update the color of the mask. 13891 * 13892 * @param { ResourceColor } value - indicates the color of the mask. 13893 * @syscap SystemCapability.ArkUI.ArkUI.Full 13894 * @crossplatform 13895 * @since 10 13896 */ 13897 /** 13898 * Update the color of the mask. 13899 * 13900 * @param { ResourceColor } value - indicates the color of the mask. 13901 * @syscap SystemCapability.ArkUI.ArkUI.Full 13902 * @crossplatform 13903 * @atomicservice 13904 * @since 11 13905 */ 13906 updateColor(value: ResourceColor): void; 13907 13908 /** 13909 * Enable the breathe animation of mask. 13910 * 13911 * @param { boolean } value 13912 * @syscap SystemCapability.ArkUI.ArkUI.Full 13913 * @crossplatform 13914 * @atomicservice 13915 * @since 12 13916 */ 13917 enableBreathingAnimation(value: boolean): void; 13918} 13919 13920/** 13921 * Defines TouchTestInfo class. 13922 * 13923 * @syscap SystemCapability.ArkUI.ArkUI.Full 13924 * @crossplatform 13925 * @since 11 13926 */ 13927/** 13928 * Defines TouchTestInfo class. 13929 * 13930 * @syscap SystemCapability.ArkUI.ArkUI.Full 13931 * @crossplatform 13932 * @atomicservice 13933 * @since 12 13934 */ 13935declare class TouchTestInfo { 13936 /** 13937 * Get the X-coordinate relative to the window. 13938 * 13939 * @type { number } 13940 * @syscap SystemCapability.ArkUI.ArkUI.Full 13941 * @crossplatform 13942 * @since 11 13943 */ 13944 /** 13945 * Get the X-coordinate relative to the window. 13946 * 13947 * @type { number } 13948 * @syscap SystemCapability.ArkUI.ArkUI.Full 13949 * @crossplatform 13950 * @atomicservice 13951 * @since 12 13952 */ 13953 windowX: number; 13954 13955 /** 13956 * Get the Y-coordinate relative to the window. 13957 * 13958 * @type { number } 13959 * @syscap SystemCapability.ArkUI.ArkUI.Full 13960 * @crossplatform 13961 * @since 11 13962 */ 13963 /** 13964 * Get the Y-coordinate relative to the window. 13965 * 13966 * @type { number } 13967 * @syscap SystemCapability.ArkUI.ArkUI.Full 13968 * @crossplatform 13969 * @atomicservice 13970 * @since 12 13971 */ 13972 windowY: number; 13973 13974 /** 13975 * Get the X-coordinate relative to the current component. 13976 * 13977 * @type { number } 13978 * @syscap SystemCapability.ArkUI.ArkUI.Full 13979 * @crossplatform 13980 * @since 11 13981 */ 13982 /** 13983 * Get the X-coordinate relative to the current component. 13984 * 13985 * @type { number } 13986 * @syscap SystemCapability.ArkUI.ArkUI.Full 13987 * @crossplatform 13988 * @atomicservice 13989 * @since 12 13990 */ 13991 parentX: number; 13992 13993 /** 13994 * Get the Y-coordinate relative to the current component. 13995 * 13996 * @type { number } 13997 * @syscap SystemCapability.ArkUI.ArkUI.Full 13998 * @crossplatform 13999 * @since 11 14000 */ 14001 /** 14002 * Get the Y-coordinate relative to the current component. 14003 * 14004 * @type { number } 14005 * @syscap SystemCapability.ArkUI.ArkUI.Full 14006 * @crossplatform 14007 * @atomicservice 14008 * @since 12 14009 */ 14010 parentY: number; 14011 14012 /** 14013 * Get the X-coordinate relative to the sub component. 14014 * 14015 * @type { number } 14016 * @syscap SystemCapability.ArkUI.ArkUI.Full 14017 * @crossplatform 14018 * @since 11 14019 */ 14020 /** 14021 * Get the X-coordinate relative to the sub component. 14022 * 14023 * @type { number } 14024 * @syscap SystemCapability.ArkUI.ArkUI.Full 14025 * @crossplatform 14026 * @atomicservice 14027 * @since 12 14028 */ 14029 x: number; 14030 14031 /** 14032 * Get the Y-coordinate relative to the sub component. 14033 * 14034 * @type { number } 14035 * @syscap SystemCapability.ArkUI.ArkUI.Full 14036 * @crossplatform 14037 * @since 11 14038 */ 14039 /** 14040 * Get the Y-coordinate relative to the sub component. 14041 * 14042 * @type { number } 14043 * @syscap SystemCapability.ArkUI.ArkUI.Full 14044 * @crossplatform 14045 * @atomicservice 14046 * @since 12 14047 */ 14048 y: number; 14049 14050 /** 14051 * Get the rectangle of sub component. 14052 * 14053 * @type { RectResult } 14054 * @syscap SystemCapability.ArkUI.ArkUI.Full 14055 * @crossplatform 14056 * @since 11 14057 */ 14058 /** 14059 * Get the rectangle of sub component. 14060 * 14061 * @type { RectResult } 14062 * @syscap SystemCapability.ArkUI.ArkUI.Full 14063 * @crossplatform 14064 * @atomicservice 14065 * @since 12 14066 */ 14067 rect: RectResult; 14068 14069 /** 14070 * Get the name of sub component. 14071 * 14072 * @type { string } 14073 * @syscap SystemCapability.ArkUI.ArkUI.Full 14074 * @crossplatform 14075 * @since 11 14076 */ 14077 /** 14078 * Get the name of sub component. 14079 * 14080 * @type { string } 14081 * @syscap SystemCapability.ArkUI.ArkUI.Full 14082 * @crossplatform 14083 * @atomicservice 14084 * @since 12 14085 */ 14086 id: string; 14087} 14088 14089/** 14090 * Defines TouchResult class. 14091 * 14092 * @syscap SystemCapability.ArkUI.ArkUI.Full 14093 * @crossplatform 14094 * @since 11 14095 */ 14096/** 14097 * Defines TouchResult class. 14098 * 14099 * @syscap SystemCapability.ArkUI.ArkUI.Full 14100 * @crossplatform 14101 * @atomicservice 14102 * @since 12 14103 */ 14104declare class TouchResult { 14105 /** 14106 * Defines the touch test strategy. 14107 * 14108 * @type { TouchTestStrategy } 14109 * @syscap SystemCapability.ArkUI.ArkUI.Full 14110 * @crossplatform 14111 * @since 11 14112 */ 14113 /** 14114 * Defines the touch test strategy. 14115 * 14116 * @type { TouchTestStrategy } 14117 * @syscap SystemCapability.ArkUI.ArkUI.Full 14118 * @crossplatform 14119 * @atomicservice 14120 * @since 12 14121 */ 14122 strategy: TouchTestStrategy; 14123 14124 /** 14125 * Defines the component's name. 14126 * 14127 * @type { ?string } 14128 * @syscap SystemCapability.ArkUI.ArkUI.Full 14129 * @crossplatform 14130 * @since 11 14131 */ 14132 /** 14133 * Defines the component's name. 14134 * 14135 * @type { ?string } 14136 * @syscap SystemCapability.ArkUI.ArkUI.Full 14137 * @crossplatform 14138 * @atomicservice 14139 * @since 12 14140 */ 14141 id?: string; 14142} 14143 14144/** 14145 * Set the edge blur effect distance of the corresponding defense line of the component 14146 * When the component expand out, no re-layout is triggered 14147 * 14148 * @interface PixelStretchEffectOptions 14149 * @syscap SystemCapability.ArkUI.ArkUI.Full 14150 * @crossplatform 14151 * @since 10 14152 */ 14153/** 14154 * Set the edge blur effect distance of the corresponding defense line of the component 14155 * When the component expand out, no re-layout is triggered 14156 * 14157 * @interface PixelStretchEffectOptions 14158 * @syscap SystemCapability.ArkUI.ArkUI.Full 14159 * @crossplatform 14160 * @atomicservice 14161 * @since 11 14162 */ 14163declare interface PixelStretchEffectOptions { 14164 /** 14165 * top property. value range (-∞, ∞) 14166 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 14167 * 14168 * @type { ?Length } 14169 * @default 0 14170 * @syscap SystemCapability.ArkUI.ArkUI.Full 14171 * @crossplatform 14172 * @since 10 14173 */ 14174 /** 14175 * top property. value range (-∞, ∞) 14176 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 14177 * 14178 * @type { ?Length } 14179 * @default 0 14180 * @syscap SystemCapability.ArkUI.ArkUI.Full 14181 * @crossplatform 14182 * @atomicservice 14183 * @since 11 14184 */ 14185 top?: Length; 14186 14187 /** 14188 * bottom property. value range (-∞, ∞) 14189 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 14190 * 14191 * @type { ?Length } 14192 * @default 0 14193 * @syscap SystemCapability.ArkUI.ArkUI.Full 14194 * @crossplatform 14195 * @since 10 14196 */ 14197 /** 14198 * bottom property. value range (-∞, ∞) 14199 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 14200 * 14201 * @type { ?Length } 14202 * @default 0 14203 * @syscap SystemCapability.ArkUI.ArkUI.Full 14204 * @crossplatform 14205 * @atomicservice 14206 * @since 11 14207 */ 14208 bottom?: Length; 14209 14210 /** 14211 * left property. value range (-∞, ∞) 14212 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 14213 * 14214 * @type { ?Length } 14215 * @default 0 14216 * @syscap SystemCapability.ArkUI.ArkUI.Full 14217 * @crossplatform 14218 * @since 10 14219 */ 14220 /** 14221 * left property. value range (-∞, ∞) 14222 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 14223 * 14224 * @type { ?Length } 14225 * @default 0 14226 * @syscap SystemCapability.ArkUI.ArkUI.Full 14227 * @crossplatform 14228 * @atomicservice 14229 * @since 11 14230 */ 14231 left?: Length; 14232 14233 /** 14234 * right property. value range (-∞, ∞) 14235 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 14236 * 14237 * @type { ?Length } 14238 * @default 0 14239 * @syscap SystemCapability.ArkUI.ArkUI.Full 14240 * @crossplatform 14241 * @since 10 14242 */ 14243 /** 14244 * right property. value range (-∞, ∞) 14245 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 14246 * 14247 * @type { ?Length } 14248 * @default 0 14249 * @syscap SystemCapability.ArkUI.ArkUI.Full 14250 * @crossplatform 14251 * @atomicservice 14252 * @since 11 14253 */ 14254 right?: Length; 14255} 14256 14257/** 14258 * Defines the click effect. 14259 * 14260 * @interface ClickEffect 14261 * @syscap SystemCapability.ArkUI.ArkUI.Full 14262 * @crossplatform 14263 * @since 10 14264 */ 14265/** 14266 * Defines the click effect. 14267 * 14268 * @interface ClickEffect 14269 * @syscap SystemCapability.ArkUI.ArkUI.Full 14270 * @crossplatform 14271 * @atomicservice 14272 * @since 11 14273 */ 14274declare interface ClickEffect { 14275 /** 14276 * Set the click effect level. 14277 * 14278 * @type { ClickEffectLevel } 14279 * @default ClickEffectLevel.Light 14280 * @syscap SystemCapability.ArkUI.ArkUI.Full 14281 * @since 10 14282 */ 14283 /** 14284 * Set the click effect level. 14285 * 14286 * @type { ClickEffectLevel } 14287 * @default ClickEffectLevel.Light 14288 * @syscap SystemCapability.ArkUI.ArkUI.Full 14289 * @atomicservice 14290 * @since 11 14291 */ 14292 level: ClickEffectLevel; 14293 14294 /** 14295 * Set scale number. 14296 * This default scale is same as the scale of click effect level. 14297 * 14298 * @type { ?number } 14299 * @syscap SystemCapability.ArkUI.ArkUI.Full 14300 * @since 10 14301 */ 14302 /** 14303 * Set scale number. 14304 * This default scale is same as the scale of click effect level. 14305 * 14306 * @type { ?number } 14307 * @syscap SystemCapability.ArkUI.ArkUI.Full 14308 * @atomicservice 14309 * @since 11 14310 */ 14311 scale?: number; 14312} 14313 14314/** 14315 * Defines the fadingEdge options. 14316 * 14317 * @typedef FadingEdgeOptions 14318 * @syscap SystemCapability.ArkUI.ArkUI.Full 14319 * @crossplatform 14320 * @atomicservice 14321 * @since 13 14322 */ 14323declare interface FadingEdgeOptions { 14324 /** 14325 * The length of FadingEdge. 14326 * 14327 * @type { LengthMetrics } 14328 * @default 32vp 14329 * @syscap SystemCapability.ArkUI.ArkUI.Full 14330 * @crossplatform 14331 * @atomicservice 14332 * @since 13 14333 */ 14334 fadingEdgeLength?: LengthMetrics; 14335} 14336 14337/** 14338 * Define nested scroll options 14339 * 14340 * @interface NestedScrollOptions 14341 * @syscap SystemCapability.ArkUI.ArkUI.Full 14342 * @since 10 14343 */ 14344/** 14345 * Define nested scroll options 14346 * 14347 * @interface NestedScrollOptions 14348 * @syscap SystemCapability.ArkUI.ArkUI.Full 14349 * @atomicservice 14350 * @since 11 14351 */ 14352declare interface NestedScrollOptions { 14353 /** 14354 * Set NestedScrollMode when the scrollable component scrolls forward 14355 * 14356 * @type { NestedScrollMode } 14357 * @syscap SystemCapability.ArkUI.ArkUI.Full 14358 * @since 10 14359 */ 14360 /** 14361 * Set NestedScrollMode when the scrollable component scrolls forward 14362 * 14363 * @type { NestedScrollMode } 14364 * @syscap SystemCapability.ArkUI.ArkUI.Full 14365 * @crossplatform 14366 * @atomicservice 14367 * @since 11 14368 */ 14369 scrollForward: NestedScrollMode; 14370 14371 /** 14372 * Set NestedScrollMode when the scrollable component scrolls backward 14373 * 14374 * @type { NestedScrollMode } 14375 * @syscap SystemCapability.ArkUI.ArkUI.Full 14376 * @since 10 14377 */ 14378 /** 14379 * Set NestedScrollMode when the scrollable component scrolls backward 14380 * 14381 * @type { NestedScrollMode } 14382 * @syscap SystemCapability.ArkUI.ArkUI.Full 14383 * @crossplatform 14384 * @atomicservice 14385 * @since 11 14386 */ 14387 scrollBackward: NestedScrollMode; 14388} 14389 14390/** 14391 * Defines the menu element. 14392 * 14393 * @interface MenuElement 14394 * @syscap SystemCapability.ArkUI.ArkUI.Full 14395 * @since 7 14396 */ 14397/** 14398 * Defines the menu element. 14399 * 14400 * @interface MenuElement 14401 * @syscap SystemCapability.ArkUI.ArkUI.Full 14402 * @crossplatform 14403 * @since 10 14404 */ 14405/** 14406 * Defines the menu element. 14407 * 14408 * @interface MenuElement 14409 * @syscap SystemCapability.ArkUI.ArkUI.Full 14410 * @crossplatform 14411 * @atomicservice 14412 * @since 11 14413 */ 14414declare interface MenuElement { 14415 /** 14416 * Sets the value of the menu element. 14417 * 14418 * @type { ResourceStr } 14419 * @syscap SystemCapability.ArkUI.ArkUI.Full 14420 * @since 7 14421 */ 14422 /** 14423 * Sets the value of the menu element. 14424 * 14425 * @type { ResourceStr } 14426 * @syscap SystemCapability.ArkUI.ArkUI.Full 14427 * @crossplatform 14428 * @since 10 14429 */ 14430 /** 14431 * Sets the value of the menu element. 14432 * 14433 * @type { ResourceStr } 14434 * @syscap SystemCapability.ArkUI.ArkUI.Full 14435 * @crossplatform 14436 * @atomicservice 14437 * @since 11 14438 */ 14439 value: ResourceStr; 14440 14441 /** 14442 * Sets the icon of the menu element. 14443 * 14444 * @type { ?ResourceStr } 14445 * @syscap SystemCapability.ArkUI.ArkUI.Full 14446 * @crossplatform 14447 * @since 10 14448 */ 14449 /** 14450 * Sets the icon of the menu element. 14451 * 14452 * @type { ?ResourceStr } 14453 * @syscap SystemCapability.ArkUI.ArkUI.Full 14454 * @crossplatform 14455 * @atomicservice 14456 * @since 11 14457 */ 14458 icon?: ResourceStr; 14459 14460 /** 14461 * Sets the symbol of the menu element. 14462 * 14463 * @type { ?SymbolGlyphModifier } 14464 * @syscap SystemCapability.ArkUI.ArkUI.Full 14465 * @crossplatform 14466 * @atomicservice 14467 * @since 12 14468 */ 14469 symbolIcon?: SymbolGlyphModifier; 14470 14471 /** 14472 * If the value is true, the menu element is available and can respond to operations such as clicking. 14473 * If the value is false, the menu element is not available and click operations are not responded. 14474 * 14475 * @type { ?boolean } 14476 * @default true 14477 * @syscap SystemCapability.ArkUI.ArkUI.Full 14478 * @crossplatform 14479 * @since 11 14480 */ 14481 /** 14482 * If the value is true, the menu element is available and can respond to operations such as clicking. 14483 * If the value is false, the menu element is not available and click operations are not responded. 14484 * 14485 * @type { ?boolean } 14486 * @default true 14487 * @syscap SystemCapability.ArkUI.ArkUI.Full 14488 * @crossplatform 14489 * @atomicservice 14490 * @since 12 14491 */ 14492 enabled?: boolean; 14493 14494 /** 14495 * Method executed by the callback. 14496 * 14497 * @type { function } 14498 * @syscap SystemCapability.ArkUI.ArkUI.Full 14499 * @since 7 14500 */ 14501 /** 14502 * Method executed by the callback. 14503 * 14504 * @type { function } 14505 * @syscap SystemCapability.ArkUI.ArkUI.Full 14506 * @crossplatform 14507 * @since 10 14508 */ 14509 /** 14510 * Method executed by the callback. 14511 * 14512 * @type { function } 14513 * @syscap SystemCapability.ArkUI.ArkUI.Full 14514 * @crossplatform 14515 * @atomicservice 14516 * @since 11 14517 */ 14518 action: () => void; 14519} 14520 14521/** 14522 * Defines the attribute modifier. 14523 * 14524 * @interface AttributeModifier<T> 14525 * @syscap SystemCapability.ArkUI.ArkUI.Full 14526 * @crossplatform 14527 * @since 11 14528 */ 14529/** 14530 * Defines the attribute modifier. 14531 * 14532 * @interface AttributeModifier<T> 14533 * @syscap SystemCapability.ArkUI.ArkUI.Full 14534 * @crossplatform 14535 * @atomicservice 14536 * @since 12 14537 */ 14538declare interface AttributeModifier<T> { 14539 14540 /** 14541 * Defines the normal update attribute function. 14542 * 14543 * @param { T } instance 14544 * @syscap SystemCapability.ArkUI.ArkUI.Full 14545 * @crossplatform 14546 * @since 11 14547 */ 14548 /** 14549 * Defines the normal update attribute function. 14550 * 14551 * @param { T } instance 14552 * @syscap SystemCapability.ArkUI.ArkUI.Full 14553 * @crossplatform 14554 * @atomicservice 14555 * @since 12 14556 */ 14557 applyNormalAttribute?(instance: T) : void; 14558 14559 /** 14560 * Defines the pressed update attribute function. 14561 * 14562 * @param { T } instance 14563 * @syscap SystemCapability.ArkUI.ArkUI.Full 14564 * @crossplatform 14565 * @since 11 14566 */ 14567 /** 14568 * Defines the pressed update attribute function. 14569 * 14570 * @param { T } instance 14571 * @syscap SystemCapability.ArkUI.ArkUI.Full 14572 * @crossplatform 14573 * @atomicservice 14574 * @since 12 14575 */ 14576 applyPressedAttribute?(instance: T) : void; 14577 14578 /** 14579 * Defines the focused update attribute function. 14580 * 14581 * @param { T } instance 14582 * @syscap SystemCapability.ArkUI.ArkUI.Full 14583 * @crossplatform 14584 * @since 11 14585 */ 14586 /** 14587 * Defines the focused update attribute function. 14588 * 14589 * @param { T } instance 14590 * @syscap SystemCapability.ArkUI.ArkUI.Full 14591 * @crossplatform 14592 * @atomicservice 14593 * @since 12 14594 */ 14595 applyFocusedAttribute?(instance: T) : void; 14596 14597 /** 14598 * Defines the disabled update attribute function. 14599 * 14600 * @param { T } instance 14601 * @syscap SystemCapability.ArkUI.ArkUI.Full 14602 * @crossplatform 14603 * @since 11 14604 */ 14605 /** 14606 * Defines the disabled update attribute function. 14607 * 14608 * @param { T } instance 14609 * @syscap SystemCapability.ArkUI.ArkUI.Full 14610 * @crossplatform 14611 * @atomicservice 14612 * @since 12 14613 */ 14614 applyDisabledAttribute?(instance: T) : void; 14615 14616 /** 14617 * Defines the selected update attribute function. 14618 * 14619 * @param { T } instance 14620 * @syscap SystemCapability.ArkUI.ArkUI.Full 14621 * @crossplatform 14622 * @since 11 14623 */ 14624 /** 14625 * Defines the selected update attribute function. 14626 * 14627 * @param { T } instance 14628 * @syscap SystemCapability.ArkUI.ArkUI.Full 14629 * @crossplatform 14630 * @atomicservice 14631 * @since 12 14632 */ 14633 applySelectedAttribute?(instance: T) : void; 14634} 14635 14636/** 14637 * Defines the content modifier. 14638 * 14639 * @interface ContentModifier 14640 * @syscap SystemCapability.ArkUI.ArkUI.Full 14641 * @crossplatform 14642 * @atomicservice 14643 * @since 12 14644 */ 14645declare interface ContentModifier<T> { 14646 14647 /** 14648 * Defining applyContent function. 14649 * 14650 * @returns { WrappedBuilder<[T]> } 14651 * @syscap SystemCapability.ArkUI.ArkUI.Full 14652 * @crossplatform 14653 * @atomicservice 14654 * @since 12 14655 */ 14656 applyContent(): WrappedBuilder<[T]> 14657} 14658 14659/** 14660 * Defines the common configuration. 14661 * 14662 * @interface CommonConfiguration 14663 * @syscap SystemCapability.ArkUI.ArkUI.Full 14664 * @crossplatform 14665 * @atomicservice 14666 * @since 12 14667 */ 14668declare interface CommonConfiguration<T> { 14669 14670 /** 14671 * If the value is true, the contentModifier is available and can respond to operations such as triggerChange. 14672 * If it is set to false, triggerChange operations are not responded. 14673 * 14674 * @type { boolean } 14675 * @syscap SystemCapability.ArkUI.ArkUI.Full 14676 * @crossplatform 14677 * @atomicservice 14678 * @since 12 14679 */ 14680 enabled: boolean, 14681 14682 /** 14683 * Obtains the contentModifier instance object 14684 * 14685 * @type { ContentModifier<T> } 14686 * @syscap SystemCapability.ArkUI.ArkUI.Full 14687 * @crossplatform 14688 * @atomicservice 14689 * @since 12 14690 */ 14691 contentModifier: ContentModifier<T> 14692} 14693 14694/** 14695 * Outline Style 14696 * 14697 * @enum { number } 14698 * @syscap SystemCapability.ArkUI.ArkUI.Full 14699 * @crossplatform 14700 * @form 14701 * @since 11 14702 */ 14703/** 14704 * Outline Style 14705 * 14706 * @enum { number } 14707 * @syscap SystemCapability.ArkUI.ArkUI.Full 14708 * @crossplatform 14709 * @form 14710 * @atomicservice 14711 * @since 12 14712 */ 14713declare enum OutlineStyle { 14714 /** 14715 * Shows as a solid line. 14716 * 14717 * @syscap SystemCapability.ArkUI.ArkUI.Full 14718 * @crossplatform 14719 * @form 14720 * @since 11 14721 */ 14722 /** 14723 * Shows as a solid line. 14724 * 14725 * @syscap SystemCapability.ArkUI.ArkUI.Full 14726 * @crossplatform 14727 * @form 14728 * @atomicservice 14729 * @since 12 14730 */ 14731 SOLID = 0, 14732 14733 /** 14734 * Shows as a series of short square dashed lines. 14735 * 14736 * @syscap SystemCapability.ArkUI.ArkUI.Full 14737 * @crossplatform 14738 * @form 14739 * @since 11 14740 */ 14741 /** 14742 * Shows as a series of short square dashed lines. 14743 * 14744 * @syscap SystemCapability.ArkUI.ArkUI.Full 14745 * @crossplatform 14746 * @form 14747 * @atomicservice 14748 * @since 12 14749 */ 14750 DASHED = 1, 14751 14752 /** 14753 * Displays as a series of dots with a radius of half the borderWidth. 14754 * 14755 * @syscap SystemCapability.ArkUI.ArkUI.Full 14756 * @crossplatform 14757 * @form 14758 * @since 11 14759 */ 14760 /** 14761 * Displays as a series of dots with a radius of half the borderWidth. 14762 * 14763 * @syscap SystemCapability.ArkUI.ArkUI.Full 14764 * @crossplatform 14765 * @form 14766 * @atomicservice 14767 * @since 12 14768 */ 14769 DOTTED = 2, 14770} 14771 14772/** 14773 * Defines the drag preview mode. 14774 * 14775 * @enum { number } 14776 * @syscap SystemCapability.ArkUI.ArkUI.Full 14777 * @since 11 14778 */ 14779/** 14780 * Defines the drag preview mode. 14781 * 14782 * @enum { number } 14783 * @syscap SystemCapability.ArkUI.ArkUI.Full 14784 * @atomicservice 14785 * @since 12 14786 */ 14787declare enum DragPreviewMode { 14788 /** 14789 * Default preview mode, let system process preview scale. 14790 * 14791 * @syscap SystemCapability.ArkUI.ArkUI.Full 14792 * @since 11 14793 */ 14794 /** 14795 * Default preview mode, let system process preview scale. 14796 * 14797 * @syscap SystemCapability.ArkUI.ArkUI.Full 14798 * @atomicservice 14799 * @since 12 14800 */ 14801 AUTO = 1, 14802 /** 14803 * Disable system scale to preview panel 14804 * 14805 * @syscap SystemCapability.ArkUI.ArkUI.Full 14806 * @since 11 14807 */ 14808 /** 14809 * Disable system scale to preview panel 14810 * 14811 * @syscap SystemCapability.ArkUI.ArkUI.Full 14812 * @atomicservice 14813 * @since 12 14814 */ 14815 DISABLE_SCALE = 2, 14816 /** 14817 * Enable the default shadow effect of preview. 14818 * 14819 * @syscap SystemCapability.ArkUI.ArkUI.Full 14820 * @atomicservice 14821 * @since 12 14822 */ 14823 ENABLE_DEFAULT_SHADOW = 3, 14824 /** 14825 * Enable the default radius effect of preview. 14826 * 14827 * @syscap SystemCapability.ArkUI.ArkUI.Full 14828 * @atomicservice 14829 * @since 12 14830 */ 14831 ENABLE_DEFAULT_RADIUS = 4, 14832} 14833 14834/** 14835 * Define the menu pop-up policy 14836 * 14837 * @enum { number } 14838 * @syscap SystemCapability.ArkUI.ArkUI.Full 14839 * @crossplatform 14840 * @atomicservice 14841 * @since 12 14842 */ 14843declare enum MenuPolicy { 14844 /** 14845 * Default value. The default logic of whether to pop up a menu depends on the scene. 14846 * 14847 * @syscap SystemCapability.ArkUI.ArkUI.Full 14848 * @crossplatform 14849 * @atomicservice 14850 * @since 12 14851 */ 14852 DEFAULT = 0, 14853 14854 /** 14855 * Hide pop up menu. 14856 * 14857 * @syscap SystemCapability.ArkUI.ArkUI.Full 14858 * @crossplatform 14859 * @atomicservice 14860 * @since 12 14861 */ 14862 HIDE = 1, 14863 14864 /** 14865 * Show pop up menu. 14866 * 14867 * @syscap SystemCapability.ArkUI.ArkUI.Full 14868 * @crossplatform 14869 * @atomicservice 14870 * @since 12 14871 */ 14872 SHOW = 2, 14873} 14874 14875/** 14876 * ImageModifier 14877 * 14878 * @typedef { import('../api/arkui/ImageModifier').ImageModifier } ImageModifier 14879 * @syscap SystemCapability.ArkUI.ArkUI.Full 14880 * @crossplatform 14881 * @atomicservice 14882 * @since 12 14883 */ 14884declare type ImageModifier = import('../api/arkui/ImageModifier').ImageModifier; 14885 14886/** 14887 * SymbolGlyphModifier 14888 * 14889 * @typedef {import('../api/arkui/SymbolGlyphModifier').SymbolGlyphModifier} SymbolGlyphModifier 14890 * @syscap SystemCapability.ArkUI.ArkUI.Full 14891 * @crossplatform 14892 * @atomicservice 14893 * @since 12 14894 */ 14895declare type SymbolGlyphModifier = import('../api/arkui/SymbolGlyphModifier').SymbolGlyphModifier; 14896 14897/** 14898 * Defines the preview options. 14899 * 14900 * @interface DragPreviewOptions 14901 * @syscap SystemCapability.ArkUI.ArkUI.Full 14902 * @since 11 14903 */ 14904/** 14905 * Defines the preview options. 14906 * 14907 * @interface DragPreviewOptions 14908 * @syscap SystemCapability.ArkUI.ArkUI.Full 14909 * @atomicservice 14910 * @since 12 14911 */ 14912declare interface DragPreviewOptions { 14913 /** 14914 * Drag preview mode. 14915 * 14916 * @type { ?DragPreviewMode } 14917 * @syscap SystemCapability.ArkUI.ArkUI.Full 14918 * @since 11 14919 */ 14920 /** 14921 * Drag preview mode. 14922 * 14923 * @type { ?(DragPreviewMode | Array<DragPreviewMode>) } 14924 * @syscap SystemCapability.ArkUI.ArkUI.Full 14925 * @atomicservice 14926 * @since 12 14927 */ 14928 mode?: DragPreviewMode | Array<DragPreviewMode>; 14929 14930 /** 14931 * Drag preview modifier. 14932 * 14933 * @type { ?ImageModifier } 14934 * @syscap SystemCapability.ArkUI.ArkUI.Full 14935 * @atomicservice 14936 * @since 12 14937 */ 14938 modifier?: ImageModifier; 14939 14940 /** 14941 * The flag for number showing. 14942 * 14943 * @type { ?(boolean | number) } 14944 * @syscap SystemCapability.ArkUI.ArkUI.Full 14945 * @atomicservice 14946 * @since 12 14947 */ 14948 numberBadge?: boolean | number; 14949} 14950 14951/** 14952 * Defines the drag options. 14953 * 14954 * @interface DragInteractionOptions 14955 * @syscap SystemCapability.ArkUI.ArkUI.Full 14956 * @atomicservice 14957 * @since 12 14958 */ 14959declare interface DragInteractionOptions { 14960 /** 14961 * Define whether to gather selected nodes in grid or list. 14962 * 14963 * @type { ?boolean } 14964 * @syscap SystemCapability.ArkUI.ArkUI.Full 14965 * @atomicservice 14966 * @since 12 14967 */ 14968 isMultiSelectionEnabled?: boolean; 14969 14970 /** 14971 * Define whether to execute animation before preview floating. 14972 * 14973 * @type { ?boolean } 14974 * @syscap SystemCapability.ArkUI.ArkUI.Full 14975 * @atomicservice 14976 * @since 12 14977 */ 14978 defaultAnimationBeforeLifting?: boolean; 14979} 14980 14981/** 14982 * Define the options of invert 14983 * 14984 * @interface InvertOptions 14985 * @syscap SystemCapability.ArkUI.ArkUI.Full 14986 * @since 11 14987 */ 14988/** 14989 * Define the options of invert 14990 * 14991 * @interface InvertOptions 14992 * @syscap SystemCapability.ArkUI.ArkUI.Full 14993 * @atomicservice 14994 * @since 12 14995 */ 14996declare interface InvertOptions { 14997 14998 /** 14999 * Defines the low value of threshold 15000 * 15001 * @type { number } 15002 * @syscap SystemCapability.ArkUI.ArkUI.Full 15003 * @crossplatform 15004 * @since 11 15005 */ 15006 /** 15007 * Defines the low value of threshold 15008 * 15009 * @type { number } 15010 * @syscap SystemCapability.ArkUI.ArkUI.Full 15011 * @crossplatform 15012 * @atomicservice 15013 * @since 12 15014 */ 15015 low: number; 15016 15017 /** 15018 * Defines the high value of threshold 15019 * 15020 * @type { number } 15021 * @syscap SystemCapability.ArkUI.ArkUI.Full 15022 * @crossplatform 15023 * @since 11 15024 */ 15025 /** 15026 * Defines the high value of threshold 15027 * 15028 * @type { number } 15029 * @syscap SystemCapability.ArkUI.ArkUI.Full 15030 * @crossplatform 15031 * @atomicservice 15032 * @since 12 15033 */ 15034 high: number; 15035 15036 /** 15037 * Defines the threshold 15038 * 15039 * @type { number } 15040 * @syscap SystemCapability.ArkUI.ArkUI.Full 15041 * @crossplatform 15042 * @since 11 15043 */ 15044 /** 15045 * Defines the threshold 15046 * 15047 * @type { number } 15048 * @syscap SystemCapability.ArkUI.ArkUI.Full 15049 * @crossplatform 15050 * @atomicservice 15051 * @since 12 15052 */ 15053 threshold: number; 15054 15055 /** 15056 *Defines the threshold range 15057 * 15058 * @type { number } 15059 * @syscap SystemCapability.ArkUI.ArkUI.Full 15060 * @crossplatform 15061 * @since 11 15062 */ 15063 /** 15064 *Defines the threshold range 15065 * 15066 * @type { number } 15067 * @syscap SystemCapability.ArkUI.ArkUI.Full 15068 * @crossplatform 15069 * @atomicservice 15070 * @since 12 15071 */ 15072 thresholdRange: number; 15073} 15074 15075/** 15076 * Import the CircleShape type object for common method. 15077 * 15078 * @typedef { import('../api/@ohos.arkui.shape').CircleShape } CircleShape 15079 * @syscap SystemCapability.ArkUI.ArkUI.Full 15080 * @crossplatform 15081 * @form 15082 * @atomicservice 15083 * @since 12 15084 */ 15085declare type CircleShape = import('../api/@ohos.arkui.shape').CircleShape; 15086 15087/** 15088 * Import the EllipseShape type object for common method. 15089 * 15090 * @typedef { import('../api/@ohos.arkui.shape').EllipseShape } EllipseShape 15091 * @syscap SystemCapability.ArkUI.ArkUI.Full 15092 * @crossplatform 15093 * @form 15094 * @atomicservice 15095 * @since 12 15096 */ 15097declare type EllipseShape = import('../api/@ohos.arkui.shape').EllipseShape; 15098 15099/** 15100 * Import the PathShape type object for common method. 15101 * 15102 * @typedef { import('../api/@ohos.arkui.shape').PathShape } PathShape 15103 * @syscap SystemCapability.ArkUI.ArkUI.Full 15104 * @crossplatform 15105 * @form 15106 * @atomicservice 15107 * @since 12 15108 */ 15109declare type PathShape = import('../api/@ohos.arkui.shape').PathShape; 15110 15111/** 15112 * Import the RectShape type object for common method. 15113 * 15114 * @typedef { import('../api/@ohos.arkui.shape').RectShape } RectShape 15115 * @syscap SystemCapability.ArkUI.ArkUI.Full 15116 * @crossplatform 15117 * @form 15118 * @atomicservice 15119 * @since 12 15120 */ 15121declare type RectShape = import('../api/@ohos.arkui.shape').RectShape; 15122 15123/** 15124 * Defines the type that can be undefined. 15125 * 15126 * @typedef { T | undefined } Optional<T> 15127 * @syscap SystemCapability.ArkUI.ArkUI.Full 15128 * @crossplatform 15129 * @form 15130 * @atomicservice 15131 * @since 12 15132 */ 15133declare type Optional<T> = T | undefined; 15134 15135/** 15136 * CommonMethod. 15137 * 15138 * @syscap SystemCapability.ArkUI.ArkUI.Full 15139 * @since 7 15140 */ 15141/** 15142 * CommonMethod. 15143 * 15144 * @syscap SystemCapability.ArkUI.ArkUI.Full 15145 * @form 15146 * @since 9 15147 */ 15148/** 15149 * CommonMethod. 15150 * 15151 * @syscap SystemCapability.ArkUI.ArkUI.Full 15152 * @crossplatform 15153 * @form 15154 * @since 10 15155 */ 15156/** 15157 * CommonMethod. 15158 * 15159 * @syscap SystemCapability.ArkUI.ArkUI.Full 15160 * @crossplatform 15161 * @form 15162 * @atomicservice 15163 * @since 11 15164 */ 15165declare class CommonMethod<T> { 15166 /** 15167 * constructor. 15168 * 15169 * @syscap SystemCapability.ArkUI.ArkUI.Full 15170 * @systemapi 15171 * @since 7 15172 */ 15173 /** 15174 * constructor. 15175 * 15176 * @syscap SystemCapability.ArkUI.ArkUI.Full 15177 * @systemapi 15178 * @form 15179 * @since 9 15180 */ 15181 constructor(); 15182 15183 /** 15184 * Sets the width of the current component. 15185 * 15186 * @param { Length } value 15187 * @returns { T } 15188 * @syscap SystemCapability.ArkUI.ArkUI.Full 15189 * @since 7 15190 */ 15191 /** 15192 * Sets the width of the current component. 15193 * 15194 * @param { Length } value 15195 * @returns { T } 15196 * @syscap SystemCapability.ArkUI.ArkUI.Full 15197 * @form 15198 * @since 9 15199 */ 15200 /** 15201 * Sets the width of the current component. 15202 * 15203 * @param { Length } value 15204 * @returns { T } 15205 * @syscap SystemCapability.ArkUI.ArkUI.Full 15206 * @crossplatform 15207 * @form 15208 * @since 10 15209 */ 15210 /** 15211 * Sets the width of the current component. 15212 * 15213 * @param { Length } value 15214 * @returns { T } 15215 * @syscap SystemCapability.ArkUI.ArkUI.Full 15216 * @crossplatform 15217 * @form 15218 * @atomicservice 15219 * @since 11 15220 */ 15221 width(value: Length): T; 15222 15223 /** 15224 * Sets the height of the current component. 15225 * 15226 * @param { Length } value 15227 * @returns { T } 15228 * @syscap SystemCapability.ArkUI.ArkUI.Full 15229 * @since 7 15230 */ 15231 /** 15232 * Sets the height of the current component. 15233 * 15234 * @param { Length } value 15235 * @returns { T } 15236 * @syscap SystemCapability.ArkUI.ArkUI.Full 15237 * @form 15238 * @since 9 15239 */ 15240 /** 15241 * Sets the height of the current component. 15242 * 15243 * @param { Length } value 15244 * @returns { T } 15245 * @syscap SystemCapability.ArkUI.ArkUI.Full 15246 * @crossplatform 15247 * @form 15248 * @since 10 15249 */ 15250 /** 15251 * Sets the height of the current component. 15252 * 15253 * @param { Length } value 15254 * @returns { T } 15255 * @syscap SystemCapability.ArkUI.ArkUI.Full 15256 * @crossplatform 15257 * @form 15258 * @atomicservice 15259 * @since 11 15260 */ 15261 height(value: Length): T; 15262 15263 /** 15264 * Sets the drawModifier of the current component. 15265 * 15266 * @param { DrawModifier | undefined } modifier - drawModifier used to draw, or undefined if it is not available. 15267 * @returns { T } 15268 * @syscap SystemCapability.ArkUI.ArkUI.Full 15269 * @crossplatform 15270 * @atomicservice 15271 * @since 12 15272 */ 15273 drawModifier(modifier: DrawModifier | undefined): T; 15274 15275 /** 15276 * Sets the custom property of the current component. 15277 * 15278 * @param { string } name - the name of the custom property. 15279 * @param { Optional<Object> } value - the value of the custom property. 15280 * @returns { T } 15281 * @syscap SystemCapability.ArkUI.ArkUI.Full 15282 * @crossplatform 15283 * @atomicservice 15284 * @since 12 15285 */ 15286 customProperty(name: string, value: Optional<Object>): T; 15287 15288 /** 15289 * Expands the safe area. 15290 * 15291 * @param { Array<SafeAreaType> } types - Indicates the types of the safe area. 15292 * @param { Array<SafeAreaEdge> } edges - Indicates the edges of the safe area. 15293 * @returns { T } The component instance. 15294 * @syscap SystemCapability.ArkUI.ArkUI.Full 15295 * @crossplatform 15296 * @since 10 15297 */ 15298 /** 15299 * Expands the safe area. 15300 * 15301 * @param { Array<SafeAreaType> } types - Indicates the types of the safe area. 15302 * @param { Array<SafeAreaEdge> } edges - Indicates the edges of the safe area. 15303 * @returns { T } The component instance. 15304 * @syscap SystemCapability.ArkUI.ArkUI.Full 15305 * @crossplatform 15306 * @atomicservice 15307 * @since 11 15308 */ 15309 expandSafeArea(types?: Array<SafeAreaType>, edges?: Array<SafeAreaEdge>): T; 15310 15311 /** 15312 * Sets the response region of the current component. 15313 * 15314 * @param { Array<Rectangle> | Rectangle } value 15315 * @returns { T } 15316 * @syscap SystemCapability.ArkUI.ArkUI.Full 15317 * @since 8 15318 */ 15319 /** 15320 * Sets the response region of the current component. 15321 * 15322 * @param { Array<Rectangle> | Rectangle } value 15323 * @returns { T } 15324 * @syscap SystemCapability.ArkUI.ArkUI.Full 15325 * @form 15326 * @since 9 15327 */ 15328 /** 15329 * Sets the response region of the current component. 15330 * 15331 * @param { Array<Rectangle> | Rectangle } value 15332 * @returns { T } 15333 * @syscap SystemCapability.ArkUI.ArkUI.Full 15334 * @crossplatform 15335 * @form 15336 * @since 10 15337 */ 15338 /** 15339 * Sets the response region of the current component. 15340 * 15341 * @param { Array<Rectangle> | Rectangle } value 15342 * @returns { T } 15343 * @syscap SystemCapability.ArkUI.ArkUI.Full 15344 * @crossplatform 15345 * @form 15346 * @atomicservice 15347 * @since 11 15348 */ 15349 responseRegion(value: Array<Rectangle> | Rectangle): T; 15350 15351 /** 15352 * Sets the mouse response region of current component 15353 * 15354 * @param { Array<Rectangle> | Rectangle } value 15355 * @returns { T } return the component attribute 15356 * @syscap SystemCapability.ArkUI.ArkUI.Full 15357 * @crossplatform 15358 * @since 10 15359 */ 15360 /** 15361 * Sets the mouse response region of current component 15362 * 15363 * @param { Array<Rectangle> | Rectangle } value 15364 * @returns { T } return the component attribute 15365 * @syscap SystemCapability.ArkUI.ArkUI.Full 15366 * @crossplatform 15367 * @atomicservice 15368 * @since 11 15369 */ 15370 mouseResponseRegion(value: Array<Rectangle> | Rectangle): T; 15371 15372 /** 15373 * The size of the current component. 15374 * 15375 * @param { SizeOptions } value 15376 * @returns { T } 15377 * @syscap SystemCapability.ArkUI.ArkUI.Full 15378 * @since 7 15379 */ 15380 /** 15381 * The size of the current component. 15382 * 15383 * @param { SizeOptions } value 15384 * @returns { T } 15385 * @syscap SystemCapability.ArkUI.ArkUI.Full 15386 * @form 15387 * @since 9 15388 */ 15389 /** 15390 * The size of the current component. 15391 * 15392 * @param { SizeOptions } value 15393 * @returns { T } 15394 * @syscap SystemCapability.ArkUI.ArkUI.Full 15395 * @crossplatform 15396 * @form 15397 * @since 10 15398 */ 15399 /** 15400 * The size of the current component. 15401 * 15402 * @param { SizeOptions } value 15403 * @returns { T } 15404 * @syscap SystemCapability.ArkUI.ArkUI.Full 15405 * @crossplatform 15406 * @form 15407 * @atomicservice 15408 * @since 11 15409 */ 15410 size(value: SizeOptions): T; 15411 15412 /** 15413 * constraint Size: 15414 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 15415 * 15416 * @param { ConstraintSizeOptions } value 15417 * @returns { T } 15418 * @syscap SystemCapability.ArkUI.ArkUI.Full 15419 * @since 7 15420 */ 15421 /** 15422 * constraint Size: 15423 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 15424 * 15425 * @param { ConstraintSizeOptions } value 15426 * @returns { T } 15427 * @syscap SystemCapability.ArkUI.ArkUI.Full 15428 * @form 15429 * @since 9 15430 */ 15431 /** 15432 * constraint Size: 15433 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 15434 * 15435 * @param { ConstraintSizeOptions } value 15436 * @returns { T } 15437 * @syscap SystemCapability.ArkUI.ArkUI.Full 15438 * @crossplatform 15439 * @form 15440 * @since 10 15441 */ 15442 /** 15443 * constraint Size: 15444 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 15445 * 15446 * @param { ConstraintSizeOptions } value 15447 * @returns { T } 15448 * @syscap SystemCapability.ArkUI.ArkUI.Full 15449 * @crossplatform 15450 * @form 15451 * @atomicservice 15452 * @since 11 15453 */ 15454 constraintSize(value: ConstraintSizeOptions): T; 15455 15456 /** 15457 * Sets the touchable of the current component 15458 * 15459 * @param { boolean } value 15460 * @returns { T } 15461 * @syscap SystemCapability.ArkUI.ArkUI.Full 15462 * @since 7 15463 * @deprecated since 9 15464 * @useinstead hitTestBehavior 15465 */ 15466 touchable(value: boolean): T; 15467 15468 /** 15469 * Defines the component's hit test behavior in touch events. 15470 * 15471 * @param { HitTestMode } value - the hit test mode. 15472 * @returns { T } 15473 * @syscap SystemCapability.ArkUI.ArkUI.Full 15474 * @since 9 15475 */ 15476 /** 15477 * Defines the component's hit test behavior in touch events. 15478 * 15479 * @param { HitTestMode } value - the hit test mode. 15480 * @returns { T } 15481 * @syscap SystemCapability.ArkUI.ArkUI.Full 15482 * @crossplatform 15483 * @since 10 15484 */ 15485 /** 15486 * Defines the component's hit test behavior in touch events. 15487 * 15488 * @param { HitTestMode } value - the hit test mode. 15489 * @returns { T } 15490 * @syscap SystemCapability.ArkUI.ArkUI.Full 15491 * @crossplatform 15492 * @atomicservice 15493 * @since 11 15494 */ 15495 hitTestBehavior(value: HitTestMode): T; 15496 15497 /** 15498 * Defines the pre-touch test of sub component in touch events. 15499 * 15500 * @param { function } event 15501 * @returns { T } 15502 * @syscap SystemCapability.ArkUI.ArkUI.Full 15503 * @crossplatform 15504 * @since 11 15505 */ 15506 /** 15507 * Defines the pre-touch test of sub component in touch events. 15508 * 15509 * @param { function } event 15510 * @returns { T } 15511 * @syscap SystemCapability.ArkUI.ArkUI.Full 15512 * @crossplatform 15513 * @atomicservice 15514 * @since 12 15515 */ 15516 onChildTouchTest(event: (value: Array<TouchTestInfo>) => TouchResult): T; 15517 15518 /** 15519 * layout Weight 15520 * 15521 * @param { number | string } value 15522 * @returns { T } 15523 * @syscap SystemCapability.ArkUI.ArkUI.Full 15524 * @since 7 15525 */ 15526 /** 15527 * layout Weight 15528 * 15529 * @param { number | string } value 15530 * @returns { T } 15531 * @syscap SystemCapability.ArkUI.ArkUI.Full 15532 * @form 15533 * @since 9 15534 */ 15535 /** 15536 * layout Weight 15537 * 15538 * @param { number | string } value 15539 * @returns { T } 15540 * @syscap SystemCapability.ArkUI.ArkUI.Full 15541 * @crossplatform 15542 * @form 15543 * @since 10 15544 */ 15545 /** 15546 * layout Weight 15547 * 15548 * @param { number | string } value 15549 * @returns { T } 15550 * @syscap SystemCapability.ArkUI.ArkUI.Full 15551 * @crossplatform 15552 * @form 15553 * @atomicservice 15554 * @since 11 15555 */ 15556 layoutWeight(value: number | string): T; 15557 15558 /** 15559 * Inner margin. 15560 * 15561 * @param { Padding | Length } value 15562 * @returns { T } 15563 * @syscap SystemCapability.ArkUI.ArkUI.Full 15564 * @since 7 15565 */ 15566 /** 15567 * Inner margin. 15568 * 15569 * @param { Padding | Length } value 15570 * @returns { T } 15571 * @syscap SystemCapability.ArkUI.ArkUI.Full 15572 * @form 15573 * @since 9 15574 */ 15575 /** 15576 * Inner margin. 15577 * 15578 * @param { Padding | Length } value 15579 * @returns { T } 15580 * @syscap SystemCapability.ArkUI.ArkUI.Full 15581 * @crossplatform 15582 * @form 15583 * @since 10 15584 */ 15585 /** 15586 * Inner margin. 15587 * 15588 * @param { Padding | Length } value 15589 * @returns { T } 15590 * @syscap SystemCapability.ArkUI.ArkUI.Full 15591 * @crossplatform 15592 * @form 15593 * @atomicservice 15594 * @since 11 15595 */ 15596 /** 15597 * Inner margin. 15598 * 15599 * @param { Padding | Length | LocalizedPadding } value 15600 * @returns { T } 15601 * @syscap SystemCapability.ArkUI.ArkUI.Full 15602 * @crossplatform 15603 * @form 15604 * @atomicservice 15605 * @since 12 15606 */ 15607 padding(value: Padding | Length | LocalizedPadding): T; 15608 15609 /** 15610 * Inner safeArea padding. 15611 * 15612 * @param { Padding | LengthMetrics | LocalizedPadding } paddingValue - Indicates safeArea padding values 15613 * @returns { T } 15614 * @syscap SystemCapability.ArkUI.ArkUI.Full 15615 * @crossplatform 15616 * @form 15617 * @atomicservice 15618 * @since 14 15619 */ 15620 safeAreaPadding(paddingValue: Padding | LengthMetrics | LocalizedPadding): T; 15621 15622 /** 15623 * Outer Margin. 15624 * 15625 * @param { Margin | Length } value 15626 * @returns { T } 15627 * @syscap SystemCapability.ArkUI.ArkUI.Full 15628 * @since 7 15629 */ 15630 /** 15631 * Outer Margin. 15632 * 15633 * @param { Margin | Length } value 15634 * @returns { T } 15635 * @syscap SystemCapability.ArkUI.ArkUI.Full 15636 * @form 15637 * @since 9 15638 */ 15639 /** 15640 * Outer Margin. 15641 * 15642 * @param { Margin | Length } value 15643 * @returns { T } 15644 * @syscap SystemCapability.ArkUI.ArkUI.Full 15645 * @crossplatform 15646 * @form 15647 * @since 10 15648 */ 15649 /** 15650 * Outer Margin. 15651 * 15652 * @param { Margin | Length } value 15653 * @returns { T } 15654 * @syscap SystemCapability.ArkUI.ArkUI.Full 15655 * @crossplatform 15656 * @form 15657 * @atomicservice 15658 * @since 11 15659 */ 15660 /** 15661 * Outer Margin. 15662 * 15663 * @param { Margin | Length | LocalizedMargin } value 15664 * @returns { T } 15665 * @syscap SystemCapability.ArkUI.ArkUI.Full 15666 * @crossplatform 15667 * @form 15668 * @atomicservice 15669 * @since 12 15670 */ 15671 margin(value: Margin | Length | LocalizedMargin): T; 15672 15673 /** 15674 * Background. 15675 * 15676 * @param { CustomBuilder } builder 15677 * @param { object } options 15678 * @returns { T } 15679 * @syscap SystemCapability.ArkUI.ArkUI.Full 15680 * @crossplatform 15681 * @since 10 15682 */ 15683 /** 15684 * Background. 15685 * 15686 * @param { CustomBuilder } builder 15687 * @param { object } options 15688 * @returns { T } 15689 * @syscap SystemCapability.ArkUI.ArkUI.Full 15690 * @crossplatform 15691 * @atomicservice 15692 * @since 11 15693 */ 15694 background(builder: CustomBuilder, options?: { align?: Alignment }): T; 15695 15696 /** 15697 * Background color 15698 * 15699 * @param { ResourceColor } value 15700 * @returns { T } 15701 * @syscap SystemCapability.ArkUI.ArkUI.Full 15702 * @since 7 15703 */ 15704 /** 15705 * Background color 15706 * 15707 * @param { ResourceColor } value 15708 * @returns { T } 15709 * @syscap SystemCapability.ArkUI.ArkUI.Full 15710 * @form 15711 * @since 9 15712 */ 15713 /** 15714 * Background color 15715 * 15716 * @param { ResourceColor } value 15717 * @returns { T } 15718 * @syscap SystemCapability.ArkUI.ArkUI.Full 15719 * @crossplatform 15720 * @form 15721 * @since 10 15722 */ 15723 /** 15724 * Background color 15725 * 15726 * @param { ResourceColor } value 15727 * @returns { T } 15728 * @syscap SystemCapability.ArkUI.ArkUI.Full 15729 * @crossplatform 15730 * @form 15731 * @atomicservice 15732 * @since 11 15733 */ 15734 backgroundColor(value: ResourceColor): T; 15735 15736 /** 15737 * PixelRound 15738 * 15739 * @param { PixelRoundPolicy } value - indicates the pixel round policy. 15740 * @returns { T } 15741 * @syscap SystemCapability.ArkUI.ArkUI.Full 15742 * @crossplatform 15743 * @form 15744 * @atomicservice 15745 * @since 11 15746 */ 15747 pixelRound(value: PixelRoundPolicy): T; 15748 15749 /** 15750 * Background image 15751 * src: Image address url 15752 * 15753 * @param { ResourceStr } src 15754 * @param { ImageRepeat } repeat 15755 * @returns { T } 15756 * @syscap SystemCapability.ArkUI.ArkUI.Full 15757 * @since 7 15758 */ 15759 /** 15760 * Background image 15761 * src: Image address url 15762 * 15763 * @param { ResourceStr } src 15764 * @param { ImageRepeat } repeat 15765 * @returns { T } 15766 * @syscap SystemCapability.ArkUI.ArkUI.Full 15767 * @form 15768 * @since 9 15769 */ 15770 /** 15771 * Background image 15772 * src: Image address url 15773 * 15774 * @param { ResourceStr } src 15775 * @param { ImageRepeat } repeat 15776 * @returns { T } 15777 * @syscap SystemCapability.ArkUI.ArkUI.Full 15778 * @crossplatform 15779 * @form 15780 * @since 10 15781 */ 15782 /** 15783 * Background image 15784 * src: Image address url 15785 * 15786 * @param { ResourceStr } src 15787 * @param { ImageRepeat } repeat 15788 * @returns { T } 15789 * @syscap SystemCapability.ArkUI.ArkUI.Full 15790 * @crossplatform 15791 * @form 15792 * @atomicservice 15793 * @since 11 15794 */ 15795 /** 15796 * Background image 15797 * src: Image address url 15798 * 15799 * @param { ResourceStr | PixelMap } src 15800 * @param { ImageRepeat } repeat 15801 * @returns { T } 15802 * @syscap SystemCapability.ArkUI.ArkUI.Full 15803 * @crossplatform 15804 * @form 15805 * @atomicservice 15806 * @since 12 15807 */ 15808 backgroundImage(src: ResourceStr | PixelMap, repeat?: ImageRepeat): T; 15809 15810 /** 15811 * Background image size 15812 * 15813 * @param { SizeOptions | ImageSize } value 15814 * @returns { T } 15815 * @syscap SystemCapability.ArkUI.ArkUI.Full 15816 * @since 7 15817 */ 15818 /** 15819 * Background image size 15820 * 15821 * @param { SizeOptions | ImageSize } value 15822 * @returns { T } 15823 * @syscap SystemCapability.ArkUI.ArkUI.Full 15824 * @form 15825 * @since 9 15826 */ 15827 /** 15828 * Background image size 15829 * 15830 * @param { SizeOptions | ImageSize } value 15831 * @returns { T } 15832 * @syscap SystemCapability.ArkUI.ArkUI.Full 15833 * @crossplatform 15834 * @form 15835 * @since 10 15836 */ 15837 /** 15838 * Background image size 15839 * 15840 * @param { SizeOptions | ImageSize } value 15841 * @returns { T } 15842 * @syscap SystemCapability.ArkUI.ArkUI.Full 15843 * @crossplatform 15844 * @form 15845 * @atomicservice 15846 * @since 11 15847 */ 15848 backgroundImageSize(value: SizeOptions | ImageSize): T; 15849 15850 /** 15851 * Background image position 15852 * x:Horizontal coordinate;y:Vertical axis coordinate. 15853 * 15854 * @param { Position | Alignment } value 15855 * @returns { T } 15856 * @syscap SystemCapability.ArkUI.ArkUI.Full 15857 * @since 7 15858 */ 15859 /** 15860 * Background image position 15861 * x:Horizontal coordinate;y:Vertical axis coordinate. 15862 * 15863 * @param { Position | Alignment } value 15864 * @returns { T } 15865 * @syscap SystemCapability.ArkUI.ArkUI.Full 15866 * @form 15867 * @since 9 15868 */ 15869 /** 15870 * Background image position 15871 * x:Horizontal coordinate;y:Vertical axis coordinate. 15872 * 15873 * @param { Position | Alignment } value 15874 * @returns { T } 15875 * @syscap SystemCapability.ArkUI.ArkUI.Full 15876 * @crossplatform 15877 * @form 15878 * @since 10 15879 */ 15880 /** 15881 * Background image position 15882 * x:Horizontal coordinate;y:Vertical axis coordinate. 15883 * 15884 * @param { Position | Alignment } value 15885 * @returns { T } 15886 * @syscap SystemCapability.ArkUI.ArkUI.Full 15887 * @crossplatform 15888 * @form 15889 * @atomicservice 15890 * @since 11 15891 */ 15892 backgroundImagePosition(value: Position | Alignment): T; 15893 15894 /** 15895 * Background blur style. 15896 * blurStyle:Blur style type. 15897 * 15898 * @param { BlurStyle } value 15899 * @param { BackgroundBlurStyleOptions } options 15900 * @returns { T } 15901 * @syscap SystemCapability.ArkUI.ArkUI.Full 15902 * @form 15903 * @since 9 15904 */ 15905 /** 15906 * Background blur style. 15907 * blurStyle:Blur style type. 15908 * 15909 * @param { BlurStyle } value 15910 * @param { BackgroundBlurStyleOptions } options 15911 * @returns { T } 15912 * @syscap SystemCapability.ArkUI.ArkUI.Full 15913 * @crossplatform 15914 * @form 15915 * @since 10 15916 */ 15917 /** 15918 * Background blur style. 15919 * blurStyle:Blur style type. 15920 * 15921 * @param { BlurStyle } value 15922 * @param { BackgroundBlurStyleOptions } options 15923 * @returns { T } 15924 * @syscap SystemCapability.ArkUI.ArkUI.Full 15925 * @crossplatform 15926 * @form 15927 * @atomicservice 15928 * @since 11 15929 */ 15930 backgroundBlurStyle(value: BlurStyle, options?: BackgroundBlurStyleOptions): T; 15931 15932 /** 15933 * options:background effect options. 15934 * 15935 * @param { BackgroundEffectOptions } options - options indicates the effect options. 15936 * @returns { T } 15937 * @syscap SystemCapability.ArkUI.ArkUI.Full 15938 * @crossplatform 15939 * @since 11 15940 */ 15941 /** 15942 * options:background effect options. 15943 * 15944 * @param { BackgroundEffectOptions } options - options indicates the effect options. 15945 * @returns { T } 15946 * @syscap SystemCapability.ArkUI.ArkUI.Full 15947 * @crossplatform 15948 * @atomicservice 15949 * @since 12 15950 */ 15951 backgroundEffect(options: BackgroundEffectOptions): T; 15952 15953 /** 15954 * Background image resizable. 15955 * value:resizable options 15956 * 15957 * @param { ResizableOptions } value - Indicates the resizable options. 15958 * @returns { T } 15959 * @syscap SystemCapability.ArkUI.ArkUI.Full 15960 * @crossplatform 15961 * @atomicservice 15962 * @since 12 15963 */ 15964 backgroundImageResizable(value: ResizableOptions): T; 15965 15966 /** 15967 * Foreground effect. 15968 * 15969 * @param { ForegroundEffectOptions } options - options indicates the effect options. 15970 * @returns { T } 15971 * @syscap SystemCapability.ArkUI.ArkUI.Full 15972 * @crossplatform 15973 * @atomicservice 15974 * @since 12 15975 */ 15976 foregroundEffect(options: ForegroundEffectOptions): T; 15977 15978 15979 /** 15980 * Unified visual effect interface. 15981 * 15982 * @param { VisualEffect } effect - Visual effect parameters. 15983 * @returns { T } 15984 * @syscap SystemCapability.ArkUI.ArkUI.Full 15985 * @crossplatform 15986 * @atomicservice 15987 * @since 12 15988 */ 15989 visualEffect(effect: VisualEffect): T; 15990 15991 /** 15992 * Filter applied to the background layer of the component. 15993 * 15994 * @param { Filter } filter - Filter effect parameters. 15995 * @returns { T } 15996 * @syscap SystemCapability.ArkUI.ArkUI.Full 15997 * @crossplatform 15998 * @atomicservice 15999 * @since 12 16000 */ 16001 backgroundFilter(filter: Filter): T; 16002 16003 /** 16004 * Filter applied to the foreground layer of the component. 16005 * 16006 * @param { Filter } filter - Filter effect parameters. 16007 * @returns { T } 16008 * @syscap SystemCapability.ArkUI.ArkUI.Full 16009 * @crossplatform 16010 * @atomicservice 16011 * @since 12 16012 */ 16013 foregroundFilter(filter: Filter): T; 16014 16015 /** 16016 * Filter applied to the compositing layer of the component. 16017 * 16018 * @param { Filter } filter - Filter effect parameters. 16019 * @returns { T } 16020 * @syscap SystemCapability.ArkUI.ArkUI.Full 16021 * @crossplatform 16022 * @atomicservice 16023 * @since 12 16024 */ 16025 compositingFilter(filter: Filter): T; 16026 16027 /** 16028 * Foreground blur style. 16029 * blurStyle:Blur style type. 16030 * 16031 * @param { BlurStyle } value 16032 * @param { ForegroundBlurStyleOptions } options 16033 * @returns { T } 16034 * @syscap SystemCapability.ArkUI.ArkUI.Full 16035 * @crossplatform 16036 * @since 10 16037 */ 16038 /** 16039 * Foreground blur style. 16040 * blurStyle:Blur style type. 16041 * 16042 * @param { BlurStyle } value 16043 * @param { ForegroundBlurStyleOptions } options 16044 * @returns { T } 16045 * @syscap SystemCapability.ArkUI.ArkUI.Full 16046 * @crossplatform 16047 * @atomicservice 16048 * @since 11 16049 */ 16050 foregroundBlurStyle(value: BlurStyle, options?: ForegroundBlurStyleOptions): T; 16051 16052 /** 16053 * Opacity 16054 * 16055 * @param { number | Resource } value 16056 * @returns { T } 16057 * @syscap SystemCapability.ArkUI.ArkUI.Full 16058 * @since 7 16059 */ 16060 /** 16061 * Opacity 16062 * 16063 * @param { number | Resource } value 16064 * @returns { T } 16065 * @syscap SystemCapability.ArkUI.ArkUI.Full 16066 * @form 16067 * @since 9 16068 */ 16069 /** 16070 * Opacity 16071 * 16072 * @param { number | Resource } value 16073 * @returns { T } 16074 * @syscap SystemCapability.ArkUI.ArkUI.Full 16075 * @crossplatform 16076 * @form 16077 * @since 10 16078 */ 16079 /** 16080 * Opacity 16081 * 16082 * @param { number | Resource } value 16083 * @returns { T } 16084 * @syscap SystemCapability.ArkUI.ArkUI.Full 16085 * @crossplatform 16086 * @form 16087 * @atomicservice 16088 * @since 11 16089 */ 16090 opacity(value: number | Resource): T; 16091 16092 /** 16093 * Opacity 16094 * width:Border width;color:Border color;radius:Border radius; 16095 * 16096 * @param { BorderOptions } value 16097 * @returns { T } 16098 * @syscap SystemCapability.ArkUI.ArkUI.Full 16099 * @since 7 16100 */ 16101 /** 16102 * Opacity 16103 * width:Border width;color:Border color;radius:Border radius; 16104 * 16105 * @param { BorderOptions } value 16106 * @returns { T } 16107 * @syscap SystemCapability.ArkUI.ArkUI.Full 16108 * @form 16109 * @since 9 16110 */ 16111 /** 16112 * Opacity 16113 * width:Border width;color:Border color;radius:Border radius; 16114 * 16115 * @param { BorderOptions } value 16116 * @returns { T } 16117 * @syscap SystemCapability.ArkUI.ArkUI.Full 16118 * @crossplatform 16119 * @form 16120 * @since 10 16121 */ 16122 /** 16123 * Opacity 16124 * width:Border width;color:Border color;radius:Border radius; 16125 * 16126 * @param { BorderOptions } value 16127 * @returns { T } 16128 * @syscap SystemCapability.ArkUI.ArkUI.Full 16129 * @crossplatform 16130 * @form 16131 * @atomicservice 16132 * @since 11 16133 */ 16134 border(value: BorderOptions): T; 16135 16136 /** 16137 * Border style 16138 * 16139 * @param { BorderStyle } value 16140 * @returns { T } 16141 * @syscap SystemCapability.ArkUI.ArkUI.Full 16142 * @since 7 16143 */ 16144 /** 16145 * Border style 16146 * 16147 * @param { BorderStyle | EdgeStyles } value 16148 * @returns { T } 16149 * @syscap SystemCapability.ArkUI.ArkUI.Full 16150 * @form 16151 * @since 9 16152 */ 16153 /** 16154 * Border style 16155 * 16156 * @param { BorderStyle | EdgeStyles } value 16157 * @returns { T } 16158 * @syscap SystemCapability.ArkUI.ArkUI.Full 16159 * @crossplatform 16160 * @form 16161 * @since 10 16162 */ 16163 /** 16164 * Border style 16165 * 16166 * @param { BorderStyle | EdgeStyles } value 16167 * @returns { T } 16168 * @syscap SystemCapability.ArkUI.ArkUI.Full 16169 * @crossplatform 16170 * @form 16171 * @atomicservice 16172 * @since 11 16173 */ 16174 borderStyle(value: BorderStyle | EdgeStyles): T; 16175 16176 /** 16177 * Border width 16178 * 16179 * @param { Length } value 16180 * @returns { T } 16181 * @syscap SystemCapability.ArkUI.ArkUI.Full 16182 * @since 7 16183 */ 16184 /** 16185 * Border width 16186 * 16187 * @param { Length | EdgeWidths } value 16188 * @returns { T } 16189 * @syscap SystemCapability.ArkUI.ArkUI.Full 16190 * @form 16191 * @since 9 16192 */ 16193 /** 16194 * Border width 16195 * 16196 * @param { Length | EdgeWidths } value 16197 * @returns { T } 16198 * @syscap SystemCapability.ArkUI.ArkUI.Full 16199 * @crossplatform 16200 * @form 16201 * @since 10 16202 */ 16203 /** 16204 * Border width 16205 * 16206 * @param { Length | EdgeWidths } value 16207 * @returns { T } 16208 * @syscap SystemCapability.ArkUI.ArkUI.Full 16209 * @crossplatform 16210 * @form 16211 * @atomicservice 16212 * @since 11 16213 */ 16214 /** 16215 * Border width 16216 * 16217 * @param { Length | EdgeWidths | LocalizedEdgeWidths } value 16218 * @returns { T } 16219 * @syscap SystemCapability.ArkUI.ArkUI.Full 16220 * @crossplatform 16221 * @form 16222 * @atomicservice 16223 * @since 12 16224 */ 16225 borderWidth(value: Length | EdgeWidths | LocalizedEdgeWidths): T; 16226 16227 /** 16228 * Border color 16229 * 16230 * @param { ResourceColor } value 16231 * @returns { T } 16232 * @syscap SystemCapability.ArkUI.ArkUI.Full 16233 * @since 7 16234 */ 16235 /** 16236 * Border color 16237 * 16238 * @param { ResourceColor | EdgeColors } value 16239 * @returns { T } 16240 * @syscap SystemCapability.ArkUI.ArkUI.Full 16241 * @form 16242 * @since 9 16243 */ 16244 /** 16245 * Border color 16246 * 16247 * @param { ResourceColor | EdgeColors } value 16248 * @returns { T } 16249 * @syscap SystemCapability.ArkUI.ArkUI.Full 16250 * @crossplatform 16251 * @form 16252 * @since 10 16253 */ 16254 /** 16255 * Border color 16256 * 16257 * @param { ResourceColor | EdgeColors } value 16258 * @returns { T } 16259 * @syscap SystemCapability.ArkUI.ArkUI.Full 16260 * @crossplatform 16261 * @form 16262 * @atomicservice 16263 * @since 11 16264 */ 16265 /** 16266 * Border color 16267 * 16268 * @param { ResourceColor | EdgeColors | LocalizedEdgeColors } value 16269 * @returns { T } 16270 * @syscap SystemCapability.ArkUI.ArkUI.Full 16271 * @crossplatform 16272 * @form 16273 * @atomicservice 16274 * @since 12 16275 */ 16276 borderColor(value: ResourceColor | EdgeColors | LocalizedEdgeColors): T; 16277 16278 /** 16279 * Border radius 16280 * 16281 * @param { Length } value 16282 * @returns { T } 16283 * @syscap SystemCapability.ArkUI.ArkUI.Full 16284 * @since 7 16285 */ 16286 /** 16287 * Border radius 16288 * 16289 * @param { Length | BorderRadiuses } value 16290 * @returns { T } 16291 * @syscap SystemCapability.ArkUI.ArkUI.Full 16292 * @form 16293 * @since 9 16294 */ 16295 /** 16296 * Border radius 16297 * 16298 * @param { Length | BorderRadiuses } value 16299 * @returns { T } 16300 * @syscap SystemCapability.ArkUI.ArkUI.Full 16301 * @crossplatform 16302 * @form 16303 * @since 10 16304 */ 16305 /** 16306 * Border radius 16307 * 16308 * @param { Length | BorderRadiuses } value 16309 * @returns { T } 16310 * @syscap SystemCapability.ArkUI.ArkUI.Full 16311 * @crossplatform 16312 * @form 16313 * @atomicservice 16314 * @since 11 16315 */ 16316 /** 16317 * Border radius 16318 * 16319 * @param { Length | BorderRadiuses | LocalizedBorderRadiuses } value 16320 * @returns { T } 16321 * @syscap SystemCapability.ArkUI.ArkUI.Full 16322 * @crossplatform 16323 * @form 16324 * @atomicservice 16325 * @since 12 16326 */ 16327 borderRadius(value: Length | BorderRadiuses | LocalizedBorderRadiuses): T; 16328 16329 /** 16330 * Border image 16331 * 16332 * @param { BorderImageOption } value 16333 * @returns { T } 16334 * @syscap SystemCapability.ArkUI.ArkUI.Full 16335 * @form 16336 * @since 9 16337 */ 16338 /** 16339 * Border image 16340 * 16341 * @param { BorderImageOption } value 16342 * @returns { T } 16343 * @syscap SystemCapability.ArkUI.ArkUI.Full 16344 * @crossplatform 16345 * @form 16346 * @since 10 16347 */ 16348 /** 16349 * Border image 16350 * 16351 * @param { BorderImageOption } value 16352 * @returns { T } 16353 * @syscap SystemCapability.ArkUI.ArkUI.Full 16354 * @crossplatform 16355 * @form 16356 * @atomicservice 16357 * @since 11 16358 */ 16359 borderImage(value: BorderImageOption): T; 16360 16361 /** 16362 * Outline 16363 * width:Outline width;color:Outline color;radius:Outline radius;style:Outline style; 16364 * 16365 * @param { OutlineOptions } value 16366 * @returns { T } 16367 * @syscap SystemCapability.ArkUI.ArkUI.Full 16368 * @crossplatform 16369 * @form 16370 * @since 11 16371 */ 16372 /** 16373 * Outline 16374 * width:Outline width;color:Outline color;radius:Outline radius;style:Outline style; 16375 * 16376 * @param { OutlineOptions } value 16377 * @returns { T } 16378 * @syscap SystemCapability.ArkUI.ArkUI.Full 16379 * @crossplatform 16380 * @form 16381 * @atomicservice 16382 * @since 12 16383 */ 16384 outline(value: OutlineOptions): T; 16385 16386 /** 16387 * Outline style 16388 * The input parameter default value is OutlineStyle.SOLID 16389 * 16390 * @param { OutlineStyle | EdgeOutlineStyles } value 16391 * @returns { T } 16392 * @syscap SystemCapability.ArkUI.ArkUI.Full 16393 * @crossplatform 16394 * @form 16395 * @since 11 16396 */ 16397 /** 16398 * Outline style 16399 * 16400 * @param { OutlineStyle | EdgeOutlineStyles } value 16401 * @returns { T } 16402 * @syscap SystemCapability.ArkUI.ArkUI.Full 16403 * @crossplatform 16404 * @form 16405 * @atomicservice 16406 * @since 12 16407 */ 16408 outlineStyle(value: OutlineStyle | EdgeOutlineStyles): T; 16409 16410 /** 16411 * Outline width 16412 * The input parameter default value is 0 16413 * 16414 * @param { Dimension | EdgeOutlineWidths } value 16415 * @returns { T } 16416 * @syscap SystemCapability.ArkUI.ArkUI.Full 16417 * @crossplatform 16418 * @form 16419 * @since 11 16420 */ 16421 /** 16422 * Outline width 16423 * 16424 * @param { Dimension | EdgeOutlineWidths } value 16425 * @returns { T } 16426 * @syscap SystemCapability.ArkUI.ArkUI.Full 16427 * @crossplatform 16428 * @form 16429 * @atomicservice 16430 * @since 12 16431 */ 16432 outlineWidth(value: Dimension | EdgeOutlineWidths): T; 16433 16434 /** 16435 * Outline color 16436 * The input parameter default value is Color.Black 16437 * 16438 * @param { ResourceColor | EdgeColors } value 16439 * @returns { T } 16440 * @syscap SystemCapability.ArkUI.ArkUI.Full 16441 * @crossplatform 16442 * @form 16443 * @since 11 16444 */ 16445 /** 16446 * Outline color 16447 * 16448 * @param { ResourceColor | EdgeColors | LocalizedEdgeColors } value 16449 * @returns { T } 16450 * @syscap SystemCapability.ArkUI.ArkUI.Full 16451 * @crossplatform 16452 * @form 16453 * @atomicservice 16454 * @since 12 16455 */ 16456 outlineColor(value: ResourceColor | EdgeColors | LocalizedEdgeColors): T; 16457 16458 /** 16459 * Outline radius 16460 * The input parameter default value is 0 16461 * 16462 * @param { Dimension | OutlineRadiuses } value 16463 * @returns { T } 16464 * @syscap SystemCapability.ArkUI.ArkUI.Full 16465 * @crossplatform 16466 * @form 16467 * @since 11 16468 */ 16469 /** 16470 * Outline radius 16471 * 16472 * @param { Dimension | OutlineRadiuses } value 16473 * @returns { T } 16474 * @syscap SystemCapability.ArkUI.ArkUI.Full 16475 * @crossplatform 16476 * @form 16477 * @atomicservice 16478 * @since 12 16479 */ 16480 outlineRadius(value: Dimension | OutlineRadiuses): T; 16481 16482 /** 16483 * Provides the general foreground color capability of UI components, and assigns color values 16484 * according to the characteristics of components. 16485 * 16486 * @param { ResourceColor | ColoringStrategy } value - indicates the color or color selection strategy 16487 * @returns { T } 16488 * @syscap SystemCapability.ArkUI.ArkUI.Full 16489 * @crossplatform 16490 * @since 10 16491 */ 16492 /** 16493 * Provides the general foreground color capability of UI components, and assigns color values 16494 * according to the characteristics of components. 16495 * 16496 * @param { ResourceColor | ColoringStrategy } value - indicates the color or color selection strategy 16497 * @returns { T } 16498 * @syscap SystemCapability.ArkUI.ArkUI.Full 16499 * @crossplatform 16500 * @atomicservice 16501 * @since 11 16502 */ 16503 foregroundColor(value: ResourceColor | ColoringStrategy): T; 16504 16505 /** 16506 * Trigger a click event when a click is clicked. 16507 * 16508 * @param { function } event 16509 * @returns { T } 16510 * @syscap SystemCapability.ArkUI.ArkUI.Full 16511 * @since 7 16512 */ 16513 /** 16514 * Trigger a click event when a click is clicked. 16515 * 16516 * @param { function } event 16517 * @returns { T } 16518 * @syscap SystemCapability.ArkUI.ArkUI.Full 16519 * @form 16520 * @since 9 16521 */ 16522 /** 16523 * Trigger a click event when a click is clicked. 16524 * 16525 * @param { function } event 16526 * @returns { T } 16527 * @syscap SystemCapability.ArkUI.ArkUI.Full 16528 * @crossplatform 16529 * @form 16530 * @since 10 16531 */ 16532 /** 16533 * Trigger a click event when a click is clicked. 16534 * 16535 * @param { function } event 16536 * @returns { T } 16537 * @syscap SystemCapability.ArkUI.ArkUI.Full 16538 * @crossplatform 16539 * @form 16540 * @atomicservice 16541 * @since 11 16542 */ 16543 onClick(event: (event: ClickEvent) => void): T; 16544 16545 /** 16546 * Trigger a click event when a click is clicked, move distance should smaller than distanceThreshold. 16547 * 16548 * @param { function } event - this function callback executed when the click action is recognized 16549 * @param { number } distanceThreshold - the distance threshold of finger's movement when detecting a click action 16550 * @returns { T } 16551 * @syscap SystemCapability.ArkUI.ArkUI.Full 16552 * @crossplatform 16553 * @form 16554 * @atomicservice 16555 * @since 12 16556 */ 16557 onClick(event: Callback<ClickEvent>, distanceThreshold: number): T; 16558 16559 /** 16560 * Trigger a hover event. 16561 * 16562 * @param { function } event 16563 * @returns { T } 16564 * @syscap SystemCapability.ArkUI.ArkUI.Full 16565 * @since 8 16566 */ 16567 /** 16568 * Trigger a hover event. 16569 * 16570 * @param { function } event 16571 * @returns { T } 16572 * @syscap SystemCapability.ArkUI.ArkUI.Full 16573 * @crossplatform 16574 * @atomicservice 16575 * @since 11 16576 */ 16577 onHover(event: (isHover: boolean, event: HoverEvent) => void): T; 16578 16579 /** 16580 * Trigger a accessibility hover event. 16581 * 16582 * @param { AccessibilityCallback } callback - A callback instance used when the component is touched after accessibility mode is enabled. 16583 * @returns { T } 16584 * @syscap SystemCapability.ArkUI.ArkUI.Full 16585 * @crossplatform 16586 * @atomicservice 16587 * @since 12 16588 */ 16589 onAccessibilityHover(callback: AccessibilityCallback): T; 16590 16591 /** 16592 * Set hover effect. 16593 * 16594 * @param { HoverEffect } value 16595 * @returns { T } 16596 * @syscap SystemCapability.ArkUI.ArkUI.Full 16597 * @since 8 16598 */ 16599 /** 16600 * Set hover effect. 16601 * 16602 * @param { HoverEffect } value 16603 * @returns { T } 16604 * @syscap SystemCapability.ArkUI.ArkUI.Full 16605 * @crossplatform 16606 * @since 10 16607 */ 16608 /** 16609 * Set hover effect. 16610 * 16611 * @param { HoverEffect } value 16612 * @returns { T } 16613 * @syscap SystemCapability.ArkUI.ArkUI.Full 16614 * @crossplatform 16615 * @atomicservice 16616 * @since 11 16617 */ 16618 hoverEffect(value: HoverEffect): T; 16619 16620 /** 16621 * Trigger a mouse event. 16622 * 16623 * @param { function } event 16624 * @returns { T } 16625 * @syscap SystemCapability.ArkUI.ArkUI.Full 16626 * @since 8 16627 */ 16628 /** 16629 * Trigger a mouse event. 16630 * 16631 * @param { function } event 16632 * @returns { T } 16633 * @syscap SystemCapability.ArkUI.ArkUI.Full 16634 * @atomicservice 16635 * @since 11 16636 */ 16637 onMouse(event: (event: MouseEvent) => void): T; 16638 16639 /** 16640 * Trigger a touch event when touched. 16641 * 16642 * @param { function } event 16643 * @returns { T } 16644 * @syscap SystemCapability.ArkUI.ArkUI.Full 16645 * @since 7 16646 */ 16647 /** 16648 * Trigger a touch event when touched. 16649 * 16650 * @param { function } event 16651 * @returns { T } 16652 * @syscap SystemCapability.ArkUI.ArkUI.Full 16653 * @crossplatform 16654 * @since 10 16655 */ 16656 /** 16657 * Trigger a touch event when touched. 16658 * 16659 * @param { function } event 16660 * @returns { T } 16661 * @syscap SystemCapability.ArkUI.ArkUI.Full 16662 * @crossplatform 16663 * @atomicservice 16664 * @since 11 16665 */ 16666 onTouch(event: (event: TouchEvent) => void): T; 16667 16668 /** 16669 * Keyboard input 16670 * 16671 * @param { function } event 16672 * @returns { T } 16673 * @syscap SystemCapability.ArkUI.ArkUI.Full 16674 * @since 7 16675 */ 16676 /** 16677 * Keyboard input 16678 * 16679 * @param { function } event 16680 * @returns { T } 16681 * @syscap SystemCapability.ArkUI.ArkUI.Full 16682 * @crossplatform 16683 * @since 10 16684 */ 16685 /** 16686 * Keyboard input 16687 * 16688 * @param { function } event 16689 * @returns { T } 16690 * @syscap SystemCapability.ArkUI.ArkUI.Full 16691 * @crossplatform 16692 * @atomicservice 16693 * @since 11 16694 */ 16695 onKeyEvent(event: (event: KeyEvent) => void): T; 16696 16697 /** 16698 * Handle keyboard events before input method events. 16699 * 16700 * @param { Callback<KeyEvent, boolean> } event 16701 * @returns { T } 16702 * @syscap SystemCapability.ArkUI.ArkUI.Full 16703 * @crossplatform 16704 * @atomicservice 16705 * @since 12 16706 */ 16707 onKeyPreIme(event: Callback<KeyEvent, boolean>): T; 16708 16709 /** 16710 * Set focusable. 16711 * 16712 * @param { boolean } value 16713 * @returns { T } 16714 * @syscap SystemCapability.ArkUI.ArkUI.Full 16715 * @since 8 16716 */ 16717 /** 16718 * Set focusable. 16719 * 16720 * @param { boolean } value 16721 * @returns { T } 16722 * @syscap SystemCapability.ArkUI.ArkUI.Full 16723 * @crossplatform 16724 * @since 10 16725 */ 16726 /** 16727 * Set focusable. 16728 * 16729 * @param { boolean } value 16730 * @returns { T } 16731 * @syscap SystemCapability.ArkUI.ArkUI.Full 16732 * @crossplatform 16733 * @atomicservice 16734 * @since 11 16735 */ 16736 focusable(value: boolean): T; 16737 16738 /** 16739 * Trigger a event when got focus. 16740 * 16741 * @param { function } event 16742 * @returns { T } 16743 * @syscap SystemCapability.ArkUI.ArkUI.Full 16744 * @since 8 16745 */ 16746 /** 16747 * Trigger a event when got focus. 16748 * 16749 * @param { function } event 16750 * @returns { T } 16751 * @syscap SystemCapability.ArkUI.ArkUI.Full 16752 * @crossplatform 16753 * @since 10 16754 */ 16755 /** 16756 * Trigger a event when got focus. 16757 * 16758 * @param { function } event 16759 * @returns { T } 16760 * @syscap SystemCapability.ArkUI.ArkUI.Full 16761 * @crossplatform 16762 * @atomicservice 16763 * @since 11 16764 */ 16765 onFocus(event: () => void): T; 16766 16767 /** 16768 * Trigger a event when lose focus. 16769 * 16770 * @param { function } event 16771 * @returns { T } 16772 * @syscap SystemCapability.ArkUI.ArkUI.Full 16773 * @since 8 16774 */ 16775 /** 16776 * Trigger a event when lose focus. 16777 * 16778 * @param { function } event 16779 * @returns { T } 16780 * @syscap SystemCapability.ArkUI.ArkUI.Full 16781 * @crossplatform 16782 * @since 10 16783 */ 16784 /** 16785 * Trigger a event when lose focus. 16786 * 16787 * @param { function } event 16788 * @returns { T } 16789 * @syscap SystemCapability.ArkUI.ArkUI.Full 16790 * @crossplatform 16791 * @atomicservice 16792 * @since 11 16793 */ 16794 onBlur(event: () => void): T; 16795 16796 /** 16797 * Set focus index by key tab. 16798 * 16799 * @param { number } index 16800 * @returns { T } 16801 * @syscap SystemCapability.ArkUI.ArkUI.Full 16802 * @since 9 16803 */ 16804 /** 16805 * Set focus index by key tab. 16806 * 16807 * @param { number } index 16808 * @returns { T } 16809 * @syscap SystemCapability.ArkUI.ArkUI.Full 16810 * @crossplatform 16811 * @since 10 16812 */ 16813 /** 16814 * Set focus index by key tab. 16815 * 16816 * @param { number } index 16817 * @returns { T } 16818 * @syscap SystemCapability.ArkUI.ArkUI.Full 16819 * @crossplatform 16820 * @atomicservice 16821 * @since 11 16822 */ 16823 tabIndex(index: number): T; 16824 16825 /** 16826 * Set default focused component when a page create. 16827 * 16828 * @param { boolean } value 16829 * @returns { T } 16830 * @syscap SystemCapability.ArkUI.ArkUI.Full 16831 * @since 9 16832 */ 16833 /** 16834 * Set default focused component when a page create. 16835 * 16836 * @param { boolean } value 16837 * @returns { T } 16838 * @syscap SystemCapability.ArkUI.ArkUI.Full 16839 * @crossplatform 16840 * @since 10 16841 */ 16842 /** 16843 * Set default focused component when a page create. 16844 * 16845 * @param { boolean } value 16846 * @returns { T } 16847 * @syscap SystemCapability.ArkUI.ArkUI.Full 16848 * @crossplatform 16849 * @atomicservice 16850 * @since 11 16851 */ 16852 defaultFocus(value: boolean): T; 16853 16854 /** 16855 * Set default focused component when focus on a focus group. 16856 * 16857 * @param { boolean } value 16858 * @returns { T } 16859 * @syscap SystemCapability.ArkUI.ArkUI.Full 16860 * @since 9 16861 */ 16862 /** 16863 * Set default focused component when focus on a focus group. 16864 * 16865 * @param { boolean } value 16866 * @returns { T } 16867 * @syscap SystemCapability.ArkUI.ArkUI.Full 16868 * @crossplatform 16869 * @since 10 16870 */ 16871 /** 16872 * Set default focused component when focus on a focus group. 16873 * 16874 * @param { boolean } value 16875 * @returns { T } 16876 * @syscap SystemCapability.ArkUI.ArkUI.Full 16877 * @crossplatform 16878 * @atomicservice 16879 * @since 11 16880 */ 16881 groupDefaultFocus(value: boolean): T; 16882 16883 /** 16884 * Set a component focused when the component be touched. 16885 * 16886 * @param { boolean } value 16887 * @returns { T } 16888 * @syscap SystemCapability.ArkUI.ArkUI.Full 16889 * @since 9 16890 */ 16891 /** 16892 * Set a component focused when the component be touched. 16893 * 16894 * @param { boolean } value 16895 * @returns { T } 16896 * @syscap SystemCapability.ArkUI.ArkUI.Full 16897 * @crossplatform 16898 * @since 10 16899 */ 16900 /** 16901 * Set a component focused when the component be touched. 16902 * 16903 * @param { boolean } value 16904 * @returns { T } 16905 * @syscap SystemCapability.ArkUI.ArkUI.Full 16906 * @crossplatform 16907 * @atomicservice 16908 * @since 11 16909 */ 16910 focusOnTouch(value: boolean): T; 16911 16912 /** 16913 * Set the component's focusBox style. 16914 * 16915 * @param { FocusBoxStyle } style 16916 * @returns { T } 16917 * @syscap SystemCapability.ArkUI.ArkUI.Full 16918 * @crossplatform 16919 * @atomicservice 16920 * @since 12 16921 */ 16922 focusBox(style: FocusBoxStyle): T; 16923 16924 /** 16925 * Set container as a focus group with a specific identifier. 16926 * 16927 * @param { string } id - focus scope identifier. 16928 * @param { boolean } [isGroup] - whether this scope is a focus group, the default value is false 16929 * @returns { T } 16930 * @syscap SystemCapability.ArkUI.ArkUI.Full 16931 * @crossplatform 16932 * @atomicservice 16933 * @since 12 16934 */ 16935 focusScopeId(id: string, isGroup?: boolean): T; 16936 /** 16937 * Set container as a focus group with a specific identifier. 16938 * 16939 * @param { string } id - focus scope identifier. 16940 * @param { boolean } [isGroup] - whether this scope is a focus group, the default value is false. 16941 * @param { boolean } [arrowStepOut] - whether the arrow keys can move focus from inside the focus group to outside, 16942 * only effective when isGroup is true, the default value is true. 16943 * @returns { T } 16944 * @syscap SystemCapability.ArkUI.ArkUI.Full 16945 * @crossplatform 16946 * @atomicservice 16947 * @since 14 16948 */ 16949 focusScopeId(id: string, isGroup?: boolean, arrowStepOut?: boolean): T; 16950 16951 /** 16952 * Set the focus priority of component in a specific focus scope. 16953 * 16954 * @param { string } scopeId 16955 * @param { FocusPriority } [priority] - the default value is AUTO 16956 * @returns { T } 16957 * @syscap SystemCapability.ArkUI.ArkUI.Full 16958 * @crossplatform 16959 * @atomicservice 16960 * @since 12 16961 */ 16962 focusScopePriority(scopeId: string, priority?: FocusPriority): T; 16963 16964 /** 16965 * animation 16966 * 16967 * @param { AnimateParam } value 16968 * @returns { T } 16969 * @syscap SystemCapability.ArkUI.ArkUI.Full 16970 * @since 7 16971 */ 16972 /** 16973 * animation 16974 * 16975 * @param { AnimateParam } value 16976 * @returns { T } 16977 * @syscap SystemCapability.ArkUI.ArkUI.Full 16978 * @form 16979 * @since 9 16980 */ 16981 /** 16982 * animation 16983 * 16984 * @param { AnimateParam } value 16985 * @returns { T } 16986 * @syscap SystemCapability.ArkUI.ArkUI.Full 16987 * @crossplatform 16988 * @form 16989 * @since 10 16990 */ 16991 /** 16992 * animation 16993 * 16994 * @param { AnimateParam } value 16995 * @returns { T } 16996 * @syscap SystemCapability.ArkUI.ArkUI.Full 16997 * @crossplatform 16998 * @form 16999 * @atomicservice 17000 * @since 11 17001 */ 17002 animation(value: AnimateParam): T; 17003 17004 /** 17005 * Transition parameter 17006 * 17007 * @param { TransitionOptions | TransitionEffect } value 17008 * @returns { T } 17009 * @syscap SystemCapability.ArkUI.ArkUI.Full 17010 * @since 7 17011 */ 17012 /** 17013 * Transition parameter 17014 * 17015 * @param { TransitionOptions | TransitionEffect } value - transition options 17016 * @returns { T } 17017 * @syscap SystemCapability.ArkUI.ArkUI.Full 17018 * @form 17019 * @since 9 17020 */ 17021 /** 17022 * Transition parameter 17023 * 17024 * @param { TransitionOptions | TransitionEffect } value - transition options or transition effect 17025 * @returns { T } 17026 * @syscap SystemCapability.ArkUI.ArkUI.Full 17027 * @crossplatform 17028 * @form 17029 * @since 10 17030 */ 17031 /** 17032 * Transition parameter 17033 * 17034 * @param { TransitionOptions | TransitionEffect } value - transition options or transition effect 17035 * @returns { T } 17036 * @syscap SystemCapability.ArkUI.ArkUI.Full 17037 * @crossplatform 17038 * @form 17039 * @atomicservice 17040 * @since 11 17041 */ 17042 transition(value: TransitionOptions | TransitionEffect): T; 17043 17044 /** 17045 * Set the transition effect of component when it appears and disappears. 17046 * 17047 * @param { TransitionEffect } effect - transition effect 17048 * @param { Optional<TransitionFinishCallback> } onFinish - transition finish callback. 17049 * @returns { T } 17050 * @syscap SystemCapability.ArkUI.ArkUI.Full 17051 * @crossplatform 17052 * @form 17053 * @atomicservice 17054 * @since 12 17055 */ 17056 transition(effect: TransitionEffect, onFinish: Optional<TransitionFinishCallback>): T; 17057 17058 /** 17059 * Bind gesture recognition. 17060 * gesture:Bound Gesture Type,mask:GestureMask; 17061 * 17062 * @param { GestureType } gesture 17063 * @param { GestureMask } mask 17064 * @returns { T } 17065 * @syscap SystemCapability.ArkUI.ArkUI.Full 17066 * @since 7 17067 */ 17068 /** 17069 * Bind gesture recognition. 17070 * gesture:Bound Gesture Type,mask:GestureMask; 17071 * 17072 * @param { GestureType } gesture 17073 * @param { GestureMask } mask 17074 * @returns { T } 17075 * @syscap SystemCapability.ArkUI.ArkUI.Full 17076 * @crossplatform 17077 * @since 10 17078 */ 17079 /** 17080 * Bind gesture recognition. 17081 * gesture:Bound Gesture Type,mask:GestureMask; 17082 * 17083 * @param { GestureType } gesture 17084 * @param { GestureMask } mask 17085 * @returns { T } 17086 * @syscap SystemCapability.ArkUI.ArkUI.Full 17087 * @crossplatform 17088 * @atomicservice 17089 * @since 11 17090 */ 17091 gesture(gesture: GestureType, mask?: GestureMask): T; 17092 17093 /** 17094 * Binding Preferential Recognition Gestures 17095 * gesture:Bound Gesture Type,mask:GestureMask; 17096 * 17097 * @param { GestureType } gesture 17098 * @param { GestureMask } mask 17099 * @returns { T } 17100 * @syscap SystemCapability.ArkUI.ArkUI.Full 17101 * @since 7 17102 */ 17103 /** 17104 * Binding Preferential Recognition Gestures 17105 * gesture:Bound Gesture Type,mask:GestureMask; 17106 * 17107 * @param { GestureType } gesture 17108 * @param { GestureMask } mask 17109 * @returns { T } 17110 * @syscap SystemCapability.ArkUI.ArkUI.Full 17111 * @crossplatform 17112 * @since 10 17113 */ 17114 /** 17115 * Binding Preferential Recognition Gestures 17116 * gesture:Bound Gesture Type,mask:GestureMask; 17117 * 17118 * @param { GestureType } gesture 17119 * @param { GestureMask } mask 17120 * @returns { T } 17121 * @syscap SystemCapability.ArkUI.ArkUI.Full 17122 * @crossplatform 17123 * @atomicservice 17124 * @since 11 17125 */ 17126 priorityGesture(gesture: GestureType, mask?: GestureMask): T; 17127 17128 /** 17129 * Binding gestures that can be triggered simultaneously with internal component gestures 17130 * gesture:Bound Gesture Type,mask:GestureMask; 17131 * 17132 * @param { GestureType } gesture 17133 * @param { GestureMask } mask 17134 * @returns { T } 17135 * @syscap SystemCapability.ArkUI.ArkUI.Full 17136 * @since 7 17137 */ 17138 /** 17139 * Binding gestures that can be triggered simultaneously with internal component gestures 17140 * gesture:Bound Gesture Type,mask:GestureMask; 17141 * 17142 * @param { GestureType } gesture 17143 * @param { GestureMask } mask 17144 * @returns { T } 17145 * @syscap SystemCapability.ArkUI.ArkUI.Full 17146 * @crossplatform 17147 * @since 10 17148 */ 17149 /** 17150 * Binding gestures that can be triggered simultaneously with internal component gestures 17151 * gesture:Bound Gesture Type,mask:GestureMask; 17152 * 17153 * @param { GestureType } gesture 17154 * @param { GestureMask } mask 17155 * @returns { T } 17156 * @syscap SystemCapability.ArkUI.ArkUI.Full 17157 * @crossplatform 17158 * @atomicservice 17159 * @since 11 17160 */ 17161 parallelGesture(gesture: GestureType, mask?: GestureMask): T; 17162 17163 /** 17164 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 17165 * The larger the blurring radius, the more blurring the content. 17166 * If the value is 0, the content blurring effect is not blurring. 17167 * 17168 * @param { number } value 17169 * @returns { T } 17170 * @syscap SystemCapability.ArkUI.ArkUI.Full 17171 * @since 7 17172 */ 17173 /** 17174 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 17175 * The larger the blurring radius, the more blurring the content. 17176 * If the value is 0, the content blurring effect is not blurring. 17177 * 17178 * @param { number } value 17179 * @returns { T } 17180 * @syscap SystemCapability.ArkUI.ArkUI.Full 17181 * @form 17182 * @since 9 17183 */ 17184 /** 17185 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 17186 * The larger the blurring radius, the more blurring the content. 17187 * If the value is 0, the content blurring effect is not blurring. 17188 * 17189 * @param { number } value 17190 * @returns { T } 17191 * @syscap SystemCapability.ArkUI.ArkUI.Full 17192 * @crossplatform 17193 * @form 17194 * @since 10 17195 */ 17196 /** 17197 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 17198 * The larger the blurring radius, the more blurring the content. 17199 * If the value is 0, the content blurring effect is not blurring. 17200 * 17201 * @param { number } value - value indicates radius of backdrop blur. 17202 * @param { BlurOptions } [options] - options indicates blur options. 17203 * @returns { T } 17204 * @syscap SystemCapability.ArkUI.ArkUI.Full 17205 * @crossplatform 17206 * @form 17207 * @atomicservice 17208 * @since 11 17209 */ 17210 blur(value: number, options?: BlurOptions): T; 17211 17212 /** 17213 * Adds the content linear gradient blurring effect for the current component. The input parameter is the blurring radius. 17214 * 17215 * @param { number } value - the blurring radius. 17216 * The larger the blurring radius, the more blurring the content, and if the value is 0, the content blurring effect is not blurring. 17217 * @param { LinearGradientBlurOptions } options - the linear gradient blur options. 17218 * @returns { T } 17219 * @syscap SystemCapability.ArkUI.ArkUI.Full 17220 * @atomicservice 17221 * @since 12 17222 */ 17223 linearGradientBlur(value: number, options: LinearGradientBlurOptions): T; 17224 17225 /** 17226 * Component motion blur interface. 17227 * 17228 * @param { MotionBlurOptions } value - the attributes of motion blur. 17229 * @returns { T } 17230 * @syscap SystemCapability.ArkUI.ArkUI.Full 17231 * @crossplatform 17232 * @atomicservice 17233 * @since 12 17234 */ 17235 motionBlur(value: MotionBlurOptions):T; 17236 17237 /** 17238 * Adds a highlight effect to the current component. 17239 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 17240 * The component is displayed as all white (percentage). 17241 * 17242 * @param { number } value 17243 * @returns { T } 17244 * @syscap SystemCapability.ArkUI.ArkUI.Full 17245 * @since 7 17246 */ 17247 /** 17248 * Adds a highlight effect to the current component. 17249 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 17250 * The component is displayed as all white (percentage). 17251 * 17252 * @param { number } value 17253 * @returns { T } 17254 * @syscap SystemCapability.ArkUI.ArkUI.Full 17255 * @form 17256 * @since 9 17257 */ 17258 /** 17259 * Adds a highlight effect to the current component. 17260 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 17261 * The component is displayed as all white (percentage). 17262 * 17263 * @param { number } value 17264 * @returns { T } 17265 * @syscap SystemCapability.ArkUI.ArkUI.Full 17266 * @crossplatform 17267 * @form 17268 * @since 10 17269 */ 17270 /** 17271 * Adds a highlight effect to the current component. 17272 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 17273 * The component is displayed as all white (percentage). 17274 * 17275 * @param { number } value 17276 * @returns { T } 17277 * @syscap SystemCapability.ArkUI.ArkUI.Full 17278 * @crossplatform 17279 * @form 17280 * @atomicservice 17281 * @since 11 17282 */ 17283 brightness(value: number): T; 17284 17285 /** 17286 * Adds a contrast effect to the current component. The input parameter is the contrast value. 17287 * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) 17288 * 17289 * @param { number } value 17290 * @returns { T } 17291 * @syscap SystemCapability.ArkUI.ArkUI.Full 17292 * @since 7 17293 */ 17294 /** 17295 * Adds a contrast effect to the current component. The input parameter is the contrast value. 17296 * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) 17297 * 17298 * @param { number } value 17299 * @returns { T } 17300 * @syscap SystemCapability.ArkUI.ArkUI.Full 17301 * @form 17302 * @since 9 17303 */ 17304 /** 17305 * Adds a contrast effect to the current component. The input parameter is the contrast value. 17306 * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) 17307 * 17308 * @param { number } value 17309 * @returns { T } 17310 * @syscap SystemCapability.ArkUI.ArkUI.Full 17311 * @crossplatform 17312 * @form 17313 * @since 10 17314 */ 17315 /** 17316 * Adds a contrast effect to the current component. The input parameter is the contrast value. 17317 * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) 17318 * 17319 * @param { number } value 17320 * @returns { T } 17321 * @syscap SystemCapability.ArkUI.ArkUI.Full 17322 * @crossplatform 17323 * @form 17324 * @atomicservice 17325 * @since 11 17326 */ 17327 contrast(value: number): T; 17328 17329 /** 17330 * Adds a grayscale effect to the current component. 17331 * 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. 17332 * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) 17333 * 17334 * @param { number } value 17335 * @returns { T } 17336 * @syscap SystemCapability.ArkUI.ArkUI.Full 17337 * @since 7 17338 */ 17339 /** 17340 * Adds a grayscale effect to the current component. 17341 * 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. 17342 * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) 17343 * 17344 * @param { number } value 17345 * @returns { T } 17346 * @syscap SystemCapability.ArkUI.ArkUI.Full 17347 * @form 17348 * @since 9 17349 */ 17350 /** 17351 * Adds a grayscale effect to the current component. 17352 * 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. 17353 * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) 17354 * 17355 * @param { number } value 17356 * @returns { T } 17357 * @syscap SystemCapability.ArkUI.ArkUI.Full 17358 * @crossplatform 17359 * @form 17360 * @since 10 17361 */ 17362 /** 17363 * Adds a grayscale effect to the current component. 17364 * 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. 17365 * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) 17366 * 17367 * @param { number } value 17368 * @returns { T } 17369 * @syscap SystemCapability.ArkUI.ArkUI.Full 17370 * @crossplatform 17371 * @form 17372 * @atomicservice 17373 * @since 11 17374 */ 17375 grayscale(value: number): T; 17376 17377 /** 17378 * Adds a color overlay effect for the current component. The input parameter is the superimposed color. 17379 * 17380 * @param { Color | string | Resource } value 17381 * @returns { T } 17382 * @syscap SystemCapability.ArkUI.ArkUI.Full 17383 * @since 7 17384 */ 17385 /** 17386 * Adds a color overlay effect for the current component. The input parameter is the superimposed color. 17387 * 17388 * @param { Color | string | Resource } value 17389 * @returns { T } 17390 * @syscap SystemCapability.ArkUI.ArkUI.Full 17391 * @form 17392 * @since 9 17393 */ 17394 /** 17395 * Adds a color overlay effect for the current component. The input parameter is the superimposed color. 17396 * 17397 * @param { Color | string | Resource } value 17398 * @returns { T } 17399 * @syscap SystemCapability.ArkUI.ArkUI.Full 17400 * @crossplatform 17401 * @form 17402 * @since 10 17403 */ 17404 /** 17405 * Adds a color overlay effect for the current component. The input parameter is the superimposed color. 17406 * 17407 * @param { Color | string | Resource } value 17408 * @returns { T } 17409 * @syscap SystemCapability.ArkUI.ArkUI.Full 17410 * @crossplatform 17411 * @form 17412 * @atomicservice 17413 * @since 11 17414 */ 17415 colorBlend(value: Color | string | Resource): T; 17416 17417 /** 17418 * Adds a saturation effect to the current component. 17419 * The saturation is the ratio of the color-containing component to the achromatic component (gray). 17420 * The larger the color-containing component, the greater the saturation. 17421 * The larger the achromatic component, the smaller the saturation. (Percentage) 17422 * 17423 * @param { number } value 17424 * @returns { T } 17425 * @syscap SystemCapability.ArkUI.ArkUI.Full 17426 * @since 7 17427 */ 17428 /** 17429 * Adds a saturation effect to the current component. 17430 * The saturation is the ratio of the color-containing component to the achromatic component (gray). 17431 * The larger the color-containing component, the greater the saturation. 17432 * The larger the achromatic component, the smaller the saturation. (Percentage) 17433 * 17434 * @param { number } value 17435 * @returns { T } 17436 * @syscap SystemCapability.ArkUI.ArkUI.Full 17437 * @form 17438 * @since 9 17439 */ 17440 /** 17441 * Adds a saturation effect to the current component. 17442 * The saturation is the ratio of the color-containing component to the achromatic component (gray). 17443 * The larger the color-containing component, the greater the saturation. 17444 * The larger the achromatic component, the smaller the saturation. (Percentage) 17445 * 17446 * @param { number } value 17447 * @returns { T } 17448 * @syscap SystemCapability.ArkUI.ArkUI.Full 17449 * @crossplatform 17450 * @form 17451 * @since 10 17452 */ 17453 /** 17454 * Adds a saturation effect to the current component. 17455 * The saturation is the ratio of the color-containing component to the achromatic component (gray). 17456 * The larger the color-containing component, the greater the saturation. 17457 * The larger the achromatic component, the smaller the saturation. (Percentage) 17458 * 17459 * @param { number } value 17460 * @returns { T } 17461 * @syscap SystemCapability.ArkUI.ArkUI.Full 17462 * @crossplatform 17463 * @form 17464 * @atomicservice 17465 * @since 11 17466 */ 17467 saturate(value: number): T; 17468 17469 /** 17470 * Converts the image to sepia. Value defines the scale of the conversion. 17471 * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) 17472 * 17473 * @param { number } value 17474 * @returns { T } 17475 * @syscap SystemCapability.ArkUI.ArkUI.Full 17476 * @since 7 17477 */ 17478 /** 17479 * Converts the image to sepia. Value defines the scale of the conversion. 17480 * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) 17481 * 17482 * @param { number } value 17483 * @returns { T } 17484 * @syscap SystemCapability.ArkUI.ArkUI.Full 17485 * @form 17486 * @since 9 17487 */ 17488 /** 17489 * Converts the image to sepia. Value defines the scale of the conversion. 17490 * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) 17491 * 17492 * @param { number } value 17493 * @returns { T } 17494 * @syscap SystemCapability.ArkUI.ArkUI.Full 17495 * @crossplatform 17496 * @form 17497 * @since 10 17498 */ 17499 /** 17500 * Converts the image to sepia. Value defines the scale of the conversion. 17501 * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) 17502 * 17503 * @param { number } value 17504 * @returns { T } 17505 * @syscap SystemCapability.ArkUI.ArkUI.Full 17506 * @crossplatform 17507 * @form 17508 * @atomicservice 17509 * @since 11 17510 */ 17511 sepia(value: number): T; 17512 17513 /** 17514 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 17515 * A value of 0% does not change the image. (Percentage) 17516 * 17517 * @param { number } value 17518 * @returns { T } 17519 * @syscap SystemCapability.ArkUI.ArkUI.Full 17520 * @since 7 17521 */ 17522 /** 17523 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 17524 * A value of 0% does not change the image. (Percentage) 17525 * 17526 * @param { number } value 17527 * @returns { T } 17528 * @syscap SystemCapability.ArkUI.ArkUI.Full 17529 * @form 17530 * @since 9 17531 */ 17532 /** 17533 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 17534 * A value of 0% does not change the image. (Percentage) 17535 * 17536 * @param { number } value 17537 * @returns { T } 17538 * @syscap SystemCapability.ArkUI.ArkUI.Full 17539 * @crossplatform 17540 * @form 17541 * @since 10 17542 */ 17543 /** 17544 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 17545 * A value of 0% does not change the image. (Percentage) 17546 * 17547 * @param { number | InvertOptions } value - value indicates the scale of the conversion or the options of invert. 17548 * @returns { T } 17549 * @syscap SystemCapability.ArkUI.ArkUI.Full 17550 * @crossplatform 17551 * @form 17552 * @atomicservice 17553 * @since 11 17554 */ 17555 invert(value: number | InvertOptions): T; 17556 17557 /** 17558 * Sets system bar effect to the component. 17559 * 17560 * @returns { T } return the component attribute. 17561 * @syscap SystemCapability.ArkUI.ArkUI.Full 17562 * @atomicservice 17563 * @since 12 17564 */ 17565 systemBarEffect(): T; 17566 17567 /** 17568 * Adds the hue rotation effect to the current component. 17569 * 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. 17570 * If the value exceeds 360deg, the image is circled again. 17571 * 17572 * @param { number | string } value 17573 * @returns { T } 17574 * @syscap SystemCapability.ArkUI.ArkUI.Full 17575 * @since 7 17576 */ 17577 /** 17578 * Adds the hue rotation effect to the current component. 17579 * 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. 17580 * If the value exceeds 360deg, the image is circled again. 17581 * 17582 * @param { number | string } value 17583 * @returns { T } 17584 * @syscap SystemCapability.ArkUI.ArkUI.Full 17585 * @form 17586 * @since 9 17587 */ 17588 /** 17589 * Adds the hue rotation effect to the current component. 17590 * 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. 17591 * If the value exceeds 360deg, the image is circled again. 17592 * 17593 * @param { number | string } value 17594 * @returns { T } 17595 * @syscap SystemCapability.ArkUI.ArkUI.Full 17596 * @crossplatform 17597 * @form 17598 * @since 10 17599 */ 17600 /** 17601 * Adds the hue rotation effect to the current component. 17602 * 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. 17603 * If the value exceeds 360deg, the image is circled again. 17604 * 17605 * @param { number | string } value 17606 * @returns { T } 17607 * @syscap SystemCapability.ArkUI.ArkUI.Full 17608 * @crossplatform 17609 * @form 17610 * @atomicservice 17611 * @since 11 17612 */ 17613 hueRotate(value: number | string): T; 17614 17615 /** 17616 * Add an attribute to control whether the shadows of the child nodes overlap each other. 17617 * 17618 * @param { boolean } value - true means the shadows of the child nodes overlap each other effect and drawn in batches. 17619 * @returns { T } 17620 * @syscap SystemCapability.ArkUI.ArkUI.Full 17621 * @crossplatform 17622 * @form 17623 * @since 11 17624 */ 17625 /** 17626 * Add an attribute to control whether the shadows of the child nodes overlap each other. 17627 * 17628 * @param { boolean } value - true means the shadows of the child nodes overlap each other effect and drawn in batches. 17629 * @returns { T } 17630 * @syscap SystemCapability.ArkUI.ArkUI.Full 17631 * @crossplatform 17632 * @form 17633 * @atomicservice 17634 * @since 12 17635 */ 17636 useShadowBatching(value: boolean): T; 17637 17638 /** 17639 * Sets whether the component should apply the effects template defined by the parent effectComponent. 17640 * If multiple parent effectComponents are found, the nearest one will be used. 17641 * If no parent effectComponent is found, this method has no effect. 17642 * 17643 * @param { boolean } value - true means the component should apply the effects template. 17644 * @returns { T } return the component attribute. 17645 * @syscap SystemCapability.ArkUI.ArkUI.Full 17646 * @atomicservice 17647 * @since 12 17648 */ 17649 useEffect(value: boolean): T; 17650 17651 /** 17652 * Adds the background blur effect for the current component. The input parameter is the blur radius. 17653 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 17654 * 17655 * @param { number } value 17656 * @returns { T } 17657 * @syscap SystemCapability.ArkUI.ArkUI.Full 17658 * @since 7 17659 */ 17660 /** 17661 * Adds the background blur effect for the current component. The input parameter is the blur radius. 17662 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 17663 * 17664 * @param { number } value 17665 * @returns { T } 17666 * @syscap SystemCapability.ArkUI.ArkUI.Full 17667 * @form 17668 * @since 9 17669 */ 17670 /** 17671 * Adds the background blur effect for the current component. The input parameter is the blur radius. 17672 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 17673 * 17674 * @param { number } value 17675 * @returns { T } 17676 * @syscap SystemCapability.ArkUI.ArkUI.Full 17677 * @crossplatform 17678 * @form 17679 * @since 10 17680 */ 17681 /** 17682 * Adds the background blur effect for the current component. The input parameter is the blur radius. 17683 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 17684 * 17685 * @param { number } value - value indicates radius of backdrop blur. 17686 * @param { BlurOptions } [options] - options indicates the backdrop blur options. 17687 * @returns { T } 17688 * @syscap SystemCapability.ArkUI.ArkUI.Full 17689 * @crossplatform 17690 * @form 17691 * @atomicservice 17692 * @since 11 17693 */ 17694 backdropBlur(value: number, options?: BlurOptions): T; 17695 17696 /** 17697 * Composite the contents of this view and its children into an offscreen cache before display in the screen. 17698 * 17699 * @param { boolean } value - if this view and its children need to composite into an offscreen cache. 17700 * @returns { T } 17701 * @syscap SystemCapability.ArkUI.ArkUI.Full 17702 * @crossplatform 17703 * @since 10 17704 */ 17705 /** 17706 * Composite the contents of this view and its children into an offscreen cache before display in the screen. 17707 * 17708 * @param { boolean } value - if this view and its children need to composite into an offscreen cache. 17709 * @returns { T } 17710 * @syscap SystemCapability.ArkUI.ArkUI.Full 17711 * @crossplatform 17712 * @atomicservice 17713 * @since 11 17714 */ 17715 /** 17716 * Composite the contents of this view and its children into an offscreen cache before display in the screen. 17717 * 17718 * @param { boolean } value - if this view and its children need to composite into an offscreen cache. 17719 * @returns { T } 17720 * @syscap SystemCapability.ArkUI.ArkUI.Full 17721 * @crossplatform 17722 * @form 17723 * @atomicservice 17724 * @since 12 17725 */ 17726 renderGroup(value: boolean): T; 17727 17728 /** 17729 * Sets whether the component should remain stationary, reusing the results of the current frame's off-screen rendering. 17730 * If the input parameter is true, the component and subcomponent changes do not affect the display. 17731 * 17732 * @param { boolean } value - true means the component should remain stationary. 17733 * @returns { T } 17734 * @syscap SystemCapability.ArkUI.ArkUI.Full 17735 * @atomicservice 17736 * @since 12 17737 */ 17738 freeze(value: boolean): T; 17739 17740 /** 17741 * Sets the translation effect during page transition. 17742 * The value is the start point of entry and end point of exit. 17743 * When this parameter is set together with slide, slide takes effect by default. 17744 * 17745 * @param { TranslateOptions } value 17746 * @returns { T } 17747 * @syscap SystemCapability.ArkUI.ArkUI.Full 17748 * @since 7 17749 */ 17750 /** 17751 * Sets the translation effect during page transition. 17752 * The value is the start point of entry and end point of exit. 17753 * When this parameter is set together with slide, slide takes effect by default. 17754 * 17755 * @param { TranslateOptions } value 17756 * @returns { T } 17757 * @syscap SystemCapability.ArkUI.ArkUI.Full 17758 * @form 17759 * @since 9 17760 */ 17761 /** 17762 * Sets the translation effect during page transition. 17763 * The value is the start point of entry and end point of exit. 17764 * When this parameter is set together with slide, slide takes effect by default. 17765 * 17766 * @param { TranslateOptions } value 17767 * @returns { T } 17768 * @syscap SystemCapability.ArkUI.ArkUI.Full 17769 * @crossplatform 17770 * @form 17771 * @since 10 17772 */ 17773 /** 17774 * Set component translation. 17775 * 17776 * @param { TranslateOptions } value default:{x:0,y:0,z:0} 17777 * @returns { T } 17778 * @syscap SystemCapability.ArkUI.ArkUI.Full 17779 * @crossplatform 17780 * @form 17781 * @atomicservice 17782 * @since 11 17783 */ 17784 translate(value: TranslateOptions): T; 17785 17786 /** 17787 * Sets the zoom effect during page transition. The value is the start point of entry and end point of exit. 17788 * 17789 * @param { ScaleOptions } value 17790 * @returns { T } 17791 * @syscap SystemCapability.ArkUI.ArkUI.Full 17792 * @since 7 17793 */ 17794 /** 17795 * Sets the zoom effect during page transition. The value is the start point of entry and end point of exit. 17796 * 17797 * @param { ScaleOptions } value 17798 * @returns { T } 17799 * @syscap SystemCapability.ArkUI.ArkUI.Full 17800 * @form 17801 * @since 9 17802 */ 17803 /** 17804 * Sets the zoom effect during page transition. The value is the start point of entry and end point of exit. 17805 * 17806 * @param { ScaleOptions } value 17807 * @returns { T } 17808 * @syscap SystemCapability.ArkUI.ArkUI.Full 17809 * @crossplatform 17810 * @form 17811 * @since 10 17812 */ 17813 /** 17814 * Set component scaling. 17815 * 17816 * @param { ScaleOptions } value default:{x:1,y:1,z:1,centerX:'50%',centerY:'50%'} 17817 * @returns { T } 17818 * @syscap SystemCapability.ArkUI.ArkUI.Full 17819 * @crossplatform 17820 * @form 17821 * @atomicservice 17822 * @since 11 17823 */ 17824 scale(value: ScaleOptions): T; 17825 17826 /** 17827 * 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. 17828 * 17829 * @param { number } value 17830 * @returns { T } 17831 * @syscap SystemCapability.ArkUI.ArkUI.Full 17832 * @since 7 17833 */ 17834 /** 17835 * 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. 17836 * 17837 * @param { number } value 17838 * @returns { T } 17839 * @syscap SystemCapability.ArkUI.ArkUI.Full 17840 * @crossplatform 17841 * @since 10 17842 */ 17843 /** 17844 * 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. 17845 * 17846 * @param { number } value 17847 * @returns { T } 17848 * @syscap SystemCapability.ArkUI.ArkUI.Full 17849 * @crossplatform 17850 * @atomicservice 17851 * @since 11 17852 */ 17853 gridSpan(value: number): T; 17854 17855 /** 17856 * 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, 17857 * the current component is located in the nth column. 17858 * 17859 * @param { number } value 17860 * @returns { T } 17861 * @syscap SystemCapability.ArkUI.ArkUI.Full 17862 * @since 7 17863 */ 17864 /** 17865 * 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, 17866 * the current component is located in the nth column. 17867 * 17868 * @param { number } value 17869 * @returns { T } 17870 * @syscap SystemCapability.ArkUI.ArkUI.Full 17871 * @crossplatform 17872 * @since 10 17873 */ 17874 /** 17875 * 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, 17876 * the current component is located in the nth column. 17877 * 17878 * @param { number } value 17879 * @returns { T } 17880 * @syscap SystemCapability.ArkUI.ArkUI.Full 17881 * @crossplatform 17882 * @atomicservice 17883 * @since 11 17884 */ 17885 gridOffset(value: number): T; 17886 17887 /** 17888 * Sets the rotation effect during assembly transition. 17889 * The values are the start point during insertion and the end point during deletion. 17890 * 17891 * @param { RotateOptions } value 17892 * @returns { T } 17893 * @syscap SystemCapability.ArkUI.ArkUI.Full 17894 * @since 7 17895 */ 17896 /** 17897 * Sets the rotation effect during assembly transition. 17898 * The values are the start point during insertion and the end point during deletion. 17899 * 17900 * @param { RotateOptions } value 17901 * @returns { T } 17902 * @syscap SystemCapability.ArkUI.ArkUI.Full 17903 * @form 17904 * @since 9 17905 */ 17906 /** 17907 * Sets the rotation effect during assembly transition. 17908 * The values are the start point during insertion and the end point during deletion. 17909 * 17910 * @param { RotateOptions } value 17911 * @returns { T } 17912 * @syscap SystemCapability.ArkUI.ArkUI.Full 17913 * @crossplatform 17914 * @form 17915 * @since 10 17916 */ 17917 /** 17918 * Set component rotation. 17919 * 17920 * @param { RotateOptions } value default:{x:0,y:0,z:0,centerX:'50%',centerY:'50%',centerZ:0,perspective:0} 17921 * @returns { T } 17922 * @syscap SystemCapability.ArkUI.ArkUI.Full 17923 * @crossplatform 17924 * @form 17925 * @atomicservice 17926 * @since 11 17927 */ 17928 rotate(value: RotateOptions): T; 17929 17930 /** 17931 * Sets the transformation matrix for the current component. 17932 * 17933 * @param { object } value 17934 * @returns { T } 17935 * @syscap SystemCapability.ArkUI.ArkUI.Full 17936 * @since 7 17937 */ 17938 /** 17939 * Sets the transformation matrix for the current component. 17940 * 17941 * @param { object } value 17942 * @returns { T } 17943 * @syscap SystemCapability.ArkUI.ArkUI.Full 17944 * @crossplatform 17945 * @since 10 17946 */ 17947 /** 17948 * Sets the transformation matrix for the current component. 17949 * 17950 * @param { object } value 17951 * @returns { T } 17952 * @syscap SystemCapability.ArkUI.ArkUI.Full 17953 * @crossplatform 17954 * @atomicservice 17955 * @since 11 17956 */ 17957 transform(value: object): T; 17958 17959 /** 17960 * This callback is triggered when a component mounts a display. 17961 * 17962 * @param { function } event 17963 * @returns { T } 17964 * @syscap SystemCapability.ArkUI.ArkUI.Full 17965 * @since 7 17966 */ 17967 /** 17968 * This callback is triggered when a component mounts a display. 17969 * 17970 * @param { function } event 17971 * @returns { T } 17972 * @syscap SystemCapability.ArkUI.ArkUI.Full 17973 * @form 17974 * @since 9 17975 */ 17976 /** 17977 * This callback is triggered when a component mounts a display. 17978 * 17979 * @param { function } event 17980 * @returns { T } 17981 * @syscap SystemCapability.ArkUI.ArkUI.Full 17982 * @crossplatform 17983 * @form 17984 * @since 10 17985 */ 17986 /** 17987 * This callback is triggered when a component mounts a display. 17988 * 17989 * @param { function } event 17990 * @returns { T } 17991 * @syscap SystemCapability.ArkUI.ArkUI.Full 17992 * @crossplatform 17993 * @form 17994 * @atomicservice 17995 * @since 11 17996 */ 17997 onAppear(event: () => void): T; 17998 17999 /** 18000 * This callback is triggered when component uninstallation disappears. 18001 * 18002 * @param { function } event 18003 * @returns { T } 18004 * @syscap SystemCapability.ArkUI.ArkUI.Full 18005 * @since 7 18006 */ 18007 /** 18008 * This callback is triggered when component uninstallation disappears. 18009 * 18010 * @param { function } event 18011 * @returns { T } 18012 * @syscap SystemCapability.ArkUI.ArkUI.Full 18013 * @form 18014 * @since 9 18015 */ 18016 /** 18017 * This callback is triggered when component uninstallation disappears. 18018 * 18019 * @param { function } event 18020 * @returns { T } 18021 * @syscap SystemCapability.ArkUI.ArkUI.Full 18022 * @crossplatform 18023 * @form 18024 * @since 10 18025 */ 18026 /** 18027 * This callback is triggered when component uninstallation disappears. 18028 * 18029 * @param { function } event 18030 * @returns { T } 18031 * @syscap SystemCapability.ArkUI.ArkUI.Full 18032 * @crossplatform 18033 * @form 18034 * @atomicservice 18035 * @since 11 18036 */ 18037 onDisAppear(event: () => void): T; 18038 18039 /** 18040 * This callback is triggered when a component mounts to view tree. 18041 * 18042 * @param { Callback<void> } callback 18043 * @returns { T } 18044 * @syscap SystemCapability.ArkUI.ArkUI.Full 18045 * @crossplatform 18046 * @atomicservice 18047 * @since 12 18048 */ 18049 onAttach(callback: Callback<void>): T; 18050 18051 /** 18052 * This callback is triggered when a component is detached from view tree. 18053 * 18054 * @param { Callback<void> } callback 18055 * @returns { T } 18056 * @syscap SystemCapability.ArkUI.ArkUI.Full 18057 * @crossplatform 18058 * @atomicservice 18059 * @since 12 18060 */ 18061 onDetach(callback: Callback<void>): T; 18062 18063 /** 18064 * This callback is triggered when the size or position of this component change finished. 18065 * 18066 * @param { function } event - event callback. 18067 * @returns { T } 18068 * @syscap SystemCapability.ArkUI.ArkUI.Full 18069 * @since 8 18070 */ 18071 /** 18072 * This callback is triggered when the size or position of this component change finished. 18073 * 18074 * @param { function } event - event callback. 18075 * @returns { T } 18076 * @syscap SystemCapability.ArkUI.ArkUI.Full 18077 * @crossplatform 18078 * @since 10 18079 */ 18080 /** 18081 * This callback is triggered when the size or position of this component change finished. 18082 * 18083 * @param { function } event - event callback. 18084 * @returns { T } 18085 * @syscap SystemCapability.ArkUI.ArkUI.Full 18086 * @crossplatform 18087 * @atomicservice 18088 * @since 11 18089 */ 18090 onAreaChange(event: (oldValue: Area, newValue: Area) => void): T; 18091 18092 /** 18093 * Controls the display or hide of the current component. 18094 * 18095 * @param { Visibility } value 18096 * @returns { T } 18097 * @syscap SystemCapability.ArkUI.ArkUI.Full 18098 * @since 7 18099 */ 18100 /** 18101 * Controls the display or hide of the current component. 18102 * 18103 * @param { Visibility } value 18104 * @returns { T } 18105 * @syscap SystemCapability.ArkUI.ArkUI.Full 18106 * @form 18107 * @since 9 18108 */ 18109 /** 18110 * Controls the display or hide of the current component. 18111 * 18112 * @param { Visibility } value 18113 * @returns { T } 18114 * @syscap SystemCapability.ArkUI.ArkUI.Full 18115 * @crossplatform 18116 * @form 18117 * @since 10 18118 */ 18119 /** 18120 * Controls the display or hide of the current component. 18121 * 18122 * @param { Visibility } value 18123 * @returns { T } 18124 * @syscap SystemCapability.ArkUI.ArkUI.Full 18125 * @crossplatform 18126 * @form 18127 * @atomicservice 18128 * @since 11 18129 */ 18130 visibility(value: Visibility): T; 18131 18132 /** 18133 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 18134 * 18135 * @param { number } value 18136 * @returns { T } 18137 * @syscap SystemCapability.ArkUI.ArkUI.Full 18138 * @since 7 18139 */ 18140 /** 18141 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 18142 * 18143 * @param { number } value 18144 * @returns { T } 18145 * @syscap SystemCapability.ArkUI.ArkUI.Full 18146 * @form 18147 * @since 9 18148 */ 18149 /** 18150 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 18151 * 18152 * @param { number } value 18153 * @returns { T } 18154 * @syscap SystemCapability.ArkUI.ArkUI.Full 18155 * @crossplatform 18156 * @form 18157 * @since 10 18158 */ 18159 /** 18160 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 18161 * 18162 * @param { number } value 18163 * @returns { T } 18164 * @syscap SystemCapability.ArkUI.ArkUI.Full 18165 * @crossplatform 18166 * @form 18167 * @atomicservice 18168 * @since 11 18169 */ 18170 flexGrow(value: number): T; 18171 18172 /** 18173 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 18174 * 18175 * @param { number } value 18176 * @returns { T } 18177 * @syscap SystemCapability.ArkUI.ArkUI.Full 18178 * @since 7 18179 */ 18180 /** 18181 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 18182 * 18183 * @param { number } value 18184 * @returns { T } 18185 * @syscap SystemCapability.ArkUI.ArkUI.Full 18186 * @form 18187 * @since 9 18188 */ 18189 /** 18190 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 18191 * 18192 * @param { number } value 18193 * @returns { T } 18194 * @syscap SystemCapability.ArkUI.ArkUI.Full 18195 * @crossplatform 18196 * @form 18197 * @since 10 18198 */ 18199 /** 18200 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 18201 * 18202 * @param { number } value 18203 * @returns { T } 18204 * @syscap SystemCapability.ArkUI.ArkUI.Full 18205 * @crossplatform 18206 * @form 18207 * @atomicservice 18208 * @since 11 18209 */ 18210 flexShrink(value: number): T; 18211 18212 /** 18213 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 18214 * 18215 * @param { number | string } value 18216 * @returns { T } 18217 * @syscap SystemCapability.ArkUI.ArkUI.Full 18218 * @since 7 18219 */ 18220 /** 18221 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 18222 * 18223 * @param { number | string } value 18224 * @returns { T } 18225 * @syscap SystemCapability.ArkUI.ArkUI.Full 18226 * @form 18227 * @since 9 18228 */ 18229 /** 18230 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 18231 * 18232 * @param { number | string } value 18233 * @returns { T } 18234 * @syscap SystemCapability.ArkUI.ArkUI.Full 18235 * @crossplatform 18236 * @form 18237 * @since 10 18238 */ 18239 /** 18240 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 18241 * 18242 * @param { number | string } value 18243 * @returns { T } 18244 * @syscap SystemCapability.ArkUI.ArkUI.Full 18245 * @crossplatform 18246 * @form 18247 * @atomicservice 18248 * @since 11 18249 */ 18250 flexBasis(value: number | string): T; 18251 18252 /** 18253 * Overrides the default configuration of alignItems in the Flex Layout container. 18254 * 18255 * @param { ItemAlign } value 18256 * @returns { T } 18257 * @syscap SystemCapability.ArkUI.ArkUI.Full 18258 * @since 7 18259 */ 18260 /** 18261 * Overrides the default configuration of alignItems in the Flex Layout container. 18262 * 18263 * @param { ItemAlign } value 18264 * @returns { T } 18265 * @syscap SystemCapability.ArkUI.ArkUI.Full 18266 * @form 18267 * @since 9 18268 */ 18269 /** 18270 * Overrides the default configuration of alignItems in the Flex Layout container. 18271 * 18272 * @param { ItemAlign } value 18273 * @returns { T } 18274 * @syscap SystemCapability.ArkUI.ArkUI.Full 18275 * @crossplatform 18276 * @form 18277 * @since 10 18278 */ 18279 /** 18280 * Overrides the default configuration of alignItems in the Flex Layout container. 18281 * 18282 * @param { ItemAlign } value 18283 * @returns { T } 18284 * @syscap SystemCapability.ArkUI.ArkUI.Full 18285 * @crossplatform 18286 * @form 18287 * @atomicservice 18288 * @since 11 18289 */ 18290 alignSelf(value: ItemAlign): T; 18291 18292 /** 18293 * 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. 18294 * 18295 * @param { number } value 18296 * @returns { T } 18297 * @syscap SystemCapability.ArkUI.ArkUI.Full 18298 * @since 7 18299 */ 18300 /** 18301 * 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. 18302 * 18303 * @param { number } value 18304 * @returns { T } 18305 * @syscap SystemCapability.ArkUI.ArkUI.Full 18306 * @form 18307 * @since 9 18308 */ 18309 /** 18310 * 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. 18311 * 18312 * @param { number } value 18313 * @returns { T } 18314 * @syscap SystemCapability.ArkUI.ArkUI.Full 18315 * @crossplatform 18316 * @form 18317 * @since 10 18318 */ 18319 /** 18320 * 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. 18321 * 18322 * @param { number } value 18323 * @returns { T } 18324 * @syscap SystemCapability.ArkUI.ArkUI.Full 18325 * @crossplatform 18326 * @form 18327 * @atomicservice 18328 * @since 11 18329 */ 18330 displayPriority(value: number): T; 18331 18332 /** 18333 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 18334 * 18335 * @param { number } value 18336 * @returns { T } 18337 * @syscap SystemCapability.ArkUI.ArkUI.Full 18338 * @since 7 18339 */ 18340 /** 18341 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 18342 * 18343 * @param { number } value 18344 * @returns { T } 18345 * @syscap SystemCapability.ArkUI.ArkUI.Full 18346 * @form 18347 * @since 9 18348 */ 18349 /** 18350 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 18351 * 18352 * @param { number } value 18353 * @returns { T } 18354 * @syscap SystemCapability.ArkUI.ArkUI.Full 18355 * @crossplatform 18356 * @form 18357 * @since 10 18358 */ 18359 /** 18360 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 18361 * 18362 * @param { number } value 18363 * @returns { T } 18364 * @syscap SystemCapability.ArkUI.ArkUI.Full 18365 * @crossplatform 18366 * @form 18367 * @atomicservice 18368 * @since 11 18369 */ 18370 zIndex(value: number): T; 18371 18372 /** 18373 * 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. 18374 * 18375 * @param { string } id 18376 * @param { sharedTransitionOptions } options 18377 * @returns { T } 18378 * @syscap SystemCapability.ArkUI.ArkUI.Full 18379 * @since 7 18380 */ 18381 /** 18382 * 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. 18383 * 18384 * @param { string } id 18385 * @param { sharedTransitionOptions } options 18386 * @returns { T } 18387 * @syscap SystemCapability.ArkUI.ArkUI.Full 18388 * @crossplatform 18389 * @since 10 18390 */ 18391 /** 18392 * 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. 18393 * 18394 * @param { string } id 18395 * @param { sharedTransitionOptions } options 18396 * @returns { T } 18397 * @syscap SystemCapability.ArkUI.ArkUI.Full 18398 * @crossplatform 18399 * @atomicservice 18400 * @since 11 18401 */ 18402 sharedTransition(id: string, options?: sharedTransitionOptions): T; 18403 18404 /** 18405 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 18406 * 18407 * @param { Direction } value 18408 * @returns { T } 18409 * @syscap SystemCapability.ArkUI.ArkUI.Full 18410 * @since 7 18411 */ 18412 /** 18413 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 18414 * 18415 * @param { Direction } value 18416 * @returns { T } 18417 * @syscap SystemCapability.ArkUI.ArkUI.Full 18418 * @form 18419 * @since 9 18420 */ 18421 /** 18422 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 18423 * 18424 * @param { Direction } value 18425 * @returns { T } 18426 * @syscap SystemCapability.ArkUI.ArkUI.Full 18427 * @crossplatform 18428 * @form 18429 * @since 10 18430 */ 18431 /** 18432 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 18433 * 18434 * @param { Direction } value 18435 * @returns { T } 18436 * @syscap SystemCapability.ArkUI.ArkUI.Full 18437 * @crossplatform 18438 * @form 18439 * @atomicservice 18440 * @since 11 18441 */ 18442 direction(value: Direction): T; 18443 18444 /** 18445 * align 18446 * 18447 * @param { Alignment } value 18448 * @returns { T } 18449 * @syscap SystemCapability.ArkUI.ArkUI.Full 18450 * @since 7 18451 */ 18452 /** 18453 * align 18454 * 18455 * @param { Alignment } value 18456 * @returns { T } 18457 * @syscap SystemCapability.ArkUI.ArkUI.Full 18458 * @form 18459 * @since 9 18460 */ 18461 /** 18462 * align 18463 * 18464 * @param { Alignment } value 18465 * @returns { T } 18466 * @syscap SystemCapability.ArkUI.ArkUI.Full 18467 * @crossplatform 18468 * @form 18469 * @since 10 18470 */ 18471 /** 18472 * align 18473 * 18474 * @param { Alignment } value 18475 * @returns { T } 18476 * @syscap SystemCapability.ArkUI.ArkUI.Full 18477 * @crossplatform 18478 * @form 18479 * @atomicservice 18480 * @since 11 18481 */ 18482 align(value: Alignment): T; 18483 18484 /** 18485 * position 18486 * 18487 * @param { Position } value 18488 * @returns { T } 18489 * @syscap SystemCapability.ArkUI.ArkUI.Full 18490 * @since 7 18491 */ 18492 /** 18493 * position 18494 * 18495 * @param { Position } value 18496 * @returns { T } 18497 * @syscap SystemCapability.ArkUI.ArkUI.Full 18498 * @form 18499 * @since 9 18500 */ 18501 /** 18502 * position 18503 * 18504 * @param { Position } value 18505 * @returns { T } 18506 * @syscap SystemCapability.ArkUI.ArkUI.Full 18507 * @crossplatform 18508 * @form 18509 * @since 10 18510 */ 18511 /** 18512 * position 18513 * 18514 * @param { Position } value 18515 * @returns { T } 18516 * @syscap SystemCapability.ArkUI.ArkUI.Full 18517 * @crossplatform 18518 * @form 18519 * @atomicservice 18520 * @since 11 18521 */ 18522 /** 18523 * position 18524 * 18525 * @param { Position | Edges | LocalizedEdges } value 18526 * @returns { T } 18527 * @syscap SystemCapability.ArkUI.ArkUI.Full 18528 * @crossplatform 18529 * @form 18530 * @atomicservice 18531 * @since 12 18532 */ 18533 position(value: Position | Edges | LocalizedEdges): T; 18534 18535 /** 18536 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 18537 * 18538 * @param { Position } value 18539 * @returns { T } 18540 * @syscap SystemCapability.ArkUI.ArkUI.Full 18541 * @since 7 18542 */ 18543 /** 18544 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 18545 * 18546 * @param { Position } value 18547 * @returns { T } 18548 * @syscap SystemCapability.ArkUI.ArkUI.Full 18549 * @form 18550 * @since 9 18551 */ 18552 /** 18553 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 18554 * 18555 * @param { Position } value 18556 * @returns { T } 18557 * @syscap SystemCapability.ArkUI.ArkUI.Full 18558 * @crossplatform 18559 * @form 18560 * @since 10 18561 */ 18562 /** 18563 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 18564 * 18565 * @param { Position } value 18566 * @returns { T } 18567 * @syscap SystemCapability.ArkUI.ArkUI.Full 18568 * @crossplatform 18569 * @form 18570 * @atomicservice 18571 * @since 11 18572 */ 18573 /** 18574 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 18575 * 18576 * @param { Position | LocalizedPosition} value 18577 * @returns { T } 18578 * @syscap SystemCapability.ArkUI.ArkUI.Full 18579 * @crossplatform 18580 * @form 18581 * @atomicservice 18582 * @since 12 18583 */ 18584 markAnchor(value: Position | LocalizedPosition): T; 18585 18586 /** 18587 * Coordinate offset relative to the layout completion position. 18588 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 18589 * 18590 * @param { Position } value 18591 * @returns { T } 18592 * @syscap SystemCapability.ArkUI.ArkUI.Full 18593 * @since 7 18594 */ 18595 /** 18596 * Coordinate offset relative to the layout completion position. 18597 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 18598 * 18599 * @param { Position } value 18600 * @returns { T } 18601 * @syscap SystemCapability.ArkUI.ArkUI.Full 18602 * @form 18603 * @since 9 18604 */ 18605 /** 18606 * Coordinate offset relative to the layout completion position. 18607 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 18608 * 18609 * @param { Position } value 18610 * @returns { T } 18611 * @syscap SystemCapability.ArkUI.ArkUI.Full 18612 * @crossplatform 18613 * @form 18614 * @since 10 18615 */ 18616 /** 18617 * Coordinate offset relative to the layout completion position. 18618 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 18619 * 18620 * @param { Position } value 18621 * @returns { T } 18622 * @syscap SystemCapability.ArkUI.ArkUI.Full 18623 * @crossplatform 18624 * @form 18625 * @atomicservice 18626 * @since 11 18627 */ 18628 /** 18629 * Coordinate offset relative to the layout completion position. 18630 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 18631 * 18632 * @param { Position | Edges | LocalizedEdges } value 18633 * @returns { T } 18634 * @syscap SystemCapability.ArkUI.ArkUI.Full 18635 * @crossplatform 18636 * @form 18637 * @atomicservice 18638 * @since 12 18639 */ 18640 offset(value: Position | Edges | LocalizedEdges): T; 18641 18642 /** 18643 * If the value is true, the component is available and can respond to operations such as clicking. 18644 * If it is set to false, click operations are not responded. 18645 * 18646 * @param { boolean } value 18647 * @returns { T } 18648 * @syscap SystemCapability.ArkUI.ArkUI.Full 18649 * @since 7 18650 */ 18651 /** 18652 * If the value is true, the component is available and can respond to operations such as clicking. 18653 * If it is set to false, click operations are not responded. 18654 * 18655 * @param { boolean } value 18656 * @returns { T } 18657 * @syscap SystemCapability.ArkUI.ArkUI.Full 18658 * @form 18659 * @since 9 18660 */ 18661 /** 18662 * If the value is true, the component is available and can respond to operations such as clicking. 18663 * If it is set to false, click operations are not responded. 18664 * 18665 * @param { boolean } value 18666 * @returns { T } 18667 * @syscap SystemCapability.ArkUI.ArkUI.Full 18668 * @crossplatform 18669 * @form 18670 * @since 10 18671 */ 18672 /** 18673 * If the value is true, the component is available and can respond to operations such as clicking. 18674 * If it is set to false, click operations are not responded. 18675 * 18676 * @param { boolean } value 18677 * @returns { T } 18678 * @syscap SystemCapability.ArkUI.ArkUI.Full 18679 * @crossplatform 18680 * @form 18681 * @atomicservice 18682 * @since 11 18683 */ 18684 enabled(value: boolean): T; 18685 18686 /** 18687 * Sets the number of occupied columns and offset columns for a specific device width type. 18688 * 18689 * @param { object } value 18690 * @returns { T } 18691 * @syscap SystemCapability.ArkUI.ArkUI.Full 18692 * @since 7 18693 * @deprecated since 9 18694 * @useinstead grid_col/GridColColumnOption and grid_row/GridRowColumnOption 18695 */ 18696 useSizeType(value: { 18697 xs?: number | { span: number; offset: number }; 18698 sm?: number | { span: number; offset: number }; 18699 md?: number | { span: number; offset: number }; 18700 lg?: number | { span: number; offset: number }; 18701 }): T; 18702 18703 /** 18704 * Specifies the alignRules of relative container 18705 * 18706 * @param { AlignRuleOption } value 18707 * @returns { T } 18708 * @syscap SystemCapability.ArkUI.ArkUI.Full 18709 * @form 18710 * @since 9 18711 */ 18712 /** 18713 * Specifies the alignRules of relative container 18714 * 18715 * @param { AlignRuleOption } value 18716 * @returns { T } 18717 * @syscap SystemCapability.ArkUI.ArkUI.Full 18718 * @crossplatform 18719 * @form 18720 * @since 10 18721 */ 18722 /** 18723 * Specifies the alignRules of relative container 18724 * 18725 * @param { AlignRuleOption } value 18726 * @returns { T } 18727 * @syscap SystemCapability.ArkUI.ArkUI.Full 18728 * @crossplatform 18729 * @form 18730 * @atomicservice 18731 * @since 11 18732 */ 18733 alignRules(value: AlignRuleOption): T; 18734 18735 /** 18736 * Specifies the localized alignRules of relative container 18737 * 18738 * @param { LocalizedAlignRuleOptions } alignRule 18739 * @returns { T } 18740 * @syscap SystemCapability.ArkUI.ArkUI.Full 18741 * @crossplatform 18742 * @form 18743 * @atomicservice 18744 * @since 12 18745 */ 18746 alignRules(alignRule: LocalizedAlignRuleOptions): T; 18747 18748 /** 18749 * Specifies the direction and style of chain in relative container 18750 * 18751 * @param { Axis } direction - indicates direction of the chain 18752 * @param { ChainStyle } style - indicates style of the chain 18753 * @returns { T } 18754 * @syscap SystemCapability.ArkUI.ArkUI.Full 18755 * @crossplatform 18756 * @atomicservice 18757 * @since 12 18758 */ 18759 chainMode(direction: Axis, style: ChainStyle): T; 18760 18761 /** 18762 * Specifies the aspect ratio of the current component. 18763 * 18764 * @param { number } value 18765 * @returns { T } 18766 * @syscap SystemCapability.ArkUI.ArkUI.Full 18767 * @since 7 18768 */ 18769 /** 18770 * Specifies the aspect ratio of the current component. 18771 * 18772 * @param { number } value 18773 * @returns { T } 18774 * @syscap SystemCapability.ArkUI.ArkUI.Full 18775 * @form 18776 * @since 9 18777 */ 18778 /** 18779 * Specifies the aspect ratio of the current component. 18780 * 18781 * @param { number } value 18782 * @returns { T } 18783 * @syscap SystemCapability.ArkUI.ArkUI.Full 18784 * @crossplatform 18785 * @form 18786 * @since 10 18787 */ 18788 /** 18789 * Specifies the aspect ratio of the current component. 18790 * 18791 * @param { number } value 18792 * @returns { T } 18793 * @syscap SystemCapability.ArkUI.ArkUI.Full 18794 * @crossplatform 18795 * @form 18796 * @atomicservice 18797 * @since 11 18798 */ 18799 aspectRatio(value: number): T; 18800 18801 /** 18802 * The click effect level and scale number. 18803 * 18804 * @param { ClickEffect | null } value 18805 * @returns { T } return the component attribute. 18806 * @syscap SystemCapability.ArkUI.ArkUI.Full 18807 * @crossplatform 18808 * @since 10 18809 */ 18810 /** 18811 * The click effect level and scale number. 18812 * 18813 * @param { ClickEffect | null } value 18814 * @returns { T } return the component attribute. 18815 * @syscap SystemCapability.ArkUI.ArkUI.Full 18816 * @crossplatform 18817 * @atomicservice 18818 * @since 11 18819 */ 18820 clickEffect(value: ClickEffect | null): T; 18821 18822 /** 18823 * After a listener is bound, the component can be dragged. After the drag occurs, a callback is triggered. 18824 * (To be triggered, press and hold for 170 milliseconds (ms)) 18825 * 18826 * @param { function } event 18827 * @returns { T } 18828 * @syscap SystemCapability.ArkUI.ArkUI.Full 18829 * @since 8 18830 */ 18831 /** 18832 * After a listener is bound, the component can be dragged. After the drag occurs, a callback is triggered. 18833 * (To be triggered, press and hold for 170 milliseconds (ms)) 18834 * 18835 * @param { function } event 18836 * @returns { T } 18837 * @syscap SystemCapability.ArkUI.ArkUI.Full 18838 * @atomicservice 18839 * @since 11 18840 */ 18841 /** 18842 * After a listener is bound, the component can be dragged. After the drag occurs, a callback is triggered. 18843 * (To be triggered, press and hold for 170 milliseconds (ms)) 18844 * 18845 * @param { function } event 18846 * @returns { T } 18847 * @syscap SystemCapability.ArkUI.ArkUI.Full 18848 * @crossplatform 18849 * @atomicservice 18850 * @since 13 18851 */ 18852 onDragStart(event: (event: DragEvent, extraParams?: string) => CustomBuilder | DragItemInfo): T; 18853 18854 /** 18855 * After binding, a callback is triggered when the component is dragged to the range of the component. 18856 * 18857 * @param { function } event 18858 * @returns { T } 18859 * @syscap SystemCapability.ArkUI.ArkUI.Full 18860 * @since 8 18861 */ 18862 /** 18863 * After binding, a callback is triggered when the component is dragged to the range of the component. 18864 * 18865 * @param { function } event 18866 * @returns { T } 18867 * @syscap SystemCapability.ArkUI.ArkUI.Full 18868 * @atomicservice 18869 * @since 11 18870 */ 18871 /** 18872 * After binding, a callback is triggered when the component is dragged to the range of the component. 18873 * 18874 * @param { function } event 18875 * @returns { T } 18876 * @syscap SystemCapability.ArkUI.ArkUI.Full 18877 * @crossplatform 18878 * @atomicservice 18879 * @since 13 18880 */ 18881 onDragEnter(event: (event: DragEvent, extraParams?: string) => void): T; 18882 18883 /** 18884 * After binding, a callback is triggered when the drag moves within the range of a placeable component. 18885 * 18886 * @param { function } event 18887 * @returns { T } 18888 * @syscap SystemCapability.ArkUI.ArkUI.Full 18889 * @since 8 18890 */ 18891 /** 18892 * After binding, a callback is triggered when the drag moves within the range of a placeable component. 18893 * 18894 * @param { function } event 18895 * @returns { T } 18896 * @syscap SystemCapability.ArkUI.ArkUI.Full 18897 * @atomicservice 18898 * @since 11 18899 */ 18900 /** 18901 * After binding, a callback is triggered when the drag moves within the range of a placeable component. 18902 * 18903 * @param { function } event 18904 * @returns { T } 18905 * @syscap SystemCapability.ArkUI.ArkUI.Full 18906 * @crossplatform 18907 * @atomicservice 18908 * @since 13 18909 */ 18910 onDragMove(event: (event: DragEvent, extraParams?: string) => void): T; 18911 18912 /** 18913 * After binding, a callback is triggered when the component is dragged out of the component range. 18914 * 18915 * @param { function } event 18916 * @returns { T } 18917 * @syscap SystemCapability.ArkUI.ArkUI.Full 18918 * @since 8 18919 */ 18920 /** 18921 * After binding, a callback is triggered when the component is dragged out of the component range. 18922 * 18923 * @param { function } event 18924 * @returns { T } 18925 * @syscap SystemCapability.ArkUI.ArkUI.Full 18926 * @atomicservice 18927 * @since 11 18928 */ 18929 /** 18930 * After binding, a callback is triggered when the component is dragged out of the component range. 18931 * 18932 * @param { function } event 18933 * @returns { T } 18934 * @syscap SystemCapability.ArkUI.ArkUI.Full 18935 * @crossplatform 18936 * @atomicservice 18937 * @since 13 18938 */ 18939 onDragLeave(event: (event: DragEvent, extraParams?: string) => void): T; 18940 18941 /** 18942 * The component bound to this event can be used as the drag release target. 18943 * This callback is triggered when the drag behavior is stopped within the scope of the component. 18944 * 18945 * @param { function } event 18946 * @returns { T } 18947 * @syscap SystemCapability.ArkUI.ArkUI.Full 18948 * @since 8 18949 */ 18950 /** 18951 * The component bound to this event can be used as the drag release target. 18952 * This callback is triggered when the drag behavior is stopped within the scope of the component. 18953 * 18954 * @param { function } event 18955 * @returns { T } 18956 * @syscap SystemCapability.ArkUI.ArkUI.Full 18957 * @atomicservice 18958 * @since 11 18959 */ 18960 /** 18961 * The component bound to this event can be used as the drag release target. 18962 * This callback is triggered when the drag behavior is stopped within the scope of the component. 18963 * 18964 * @param { function } event 18965 * @returns { T } 18966 * @syscap SystemCapability.ArkUI.ArkUI.Full 18967 * @crossplatform 18968 * @atomicservice 18969 * @since 13 18970 */ 18971 onDrop(event: (event: DragEvent, extraParams?: string) => void): T; 18972 18973 /** 18974 * This function is called when the drag event is end. 18975 * 18976 * @param { function } event - indicates the function to be called. 18977 * @returns { T } property value of type T. 18978 * @syscap SystemCapability.ArkUI.ArkUI.Full 18979 * @since 10 18980 */ 18981 /** 18982 * This function is called when the drag event is end. 18983 * 18984 * @param { function } event - indicates the function to be called. 18985 * @returns { T } property value of type T. 18986 * @syscap SystemCapability.ArkUI.ArkUI.Full 18987 * @atomicservice 18988 * @since 11 18989 */ 18990 /** 18991 * This function is called when the drag event is end. 18992 * 18993 * @param { function } event - indicates the function to be called. 18994 * @returns { T } property value of type T. 18995 * @syscap SystemCapability.ArkUI.ArkUI.Full 18996 * @crossplatform 18997 * @atomicservice 18998 * @since 13 18999 */ 19000 onDragEnd(event: (event: DragEvent, extraParams?: string) => void): T; 19001 19002 /** 19003 * Allowed drop uniformData type for this node. 19004 * 19005 * @param { Array<UniformDataType> } value - the uniformData type for this node. 19006 * @returns { T } property value of type T. 19007 * @syscap SystemCapability.ArkUI.ArkUI.Full 19008 * @crossplatform 19009 * @since 10 19010 */ 19011 /** 19012 * Allowed drop uniformData type for this node. 19013 * 19014 * @param { Array<UniformDataType> } value - the uniformData type for this node. 19015 * @returns { T } property value of type T. 19016 * @syscap SystemCapability.ArkUI.ArkUI.Full 19017 * @crossplatform 19018 * @atomicservice 19019 * @since 11 19020 */ 19021 /** 19022 * Allowed drop uniformData type for this node. 19023 * 19024 * @param { Array<UniformDataType> | null } value - the uniformData type for this node. 19025 * @returns { T } property value of type T. 19026 * @syscap SystemCapability.ArkUI.ArkUI.Full 19027 * @crossplatform 19028 * @atomicservice 19029 * @since 12 19030 */ 19031 allowDrop(value: Array<UniformDataType> | null): T; 19032 19033 /** 19034 * Enable the selectable area can be dragged. 19035 * 19036 * @param { boolean } value - true means the area can be dragged, false means the area can't be dragged. 19037 * @returns { T } property value of type T. 19038 * @syscap SystemCapability.ArkUI.ArkUI.Full 19039 * @since 10 19040 */ 19041 /** 19042 * Enable the selectable area can be dragged. 19043 * 19044 * @param { boolean } value - true means the area can be dragged, false means the area can't be dragged. 19045 * @returns { T } property value of type T. 19046 * @syscap SystemCapability.ArkUI.ArkUI.Full 19047 * @crossplatform 19048 * @atomicservice 19049 * @since 11 19050 */ 19051 draggable(value: boolean): T; 19052 19053 /** 19054 * Set preview of the component for dragging process 19055 * 19056 * @param { CustomBuilder | DragItemInfo } value - preview of the component for dragging process 19057 * @returns { T } property value of type T. 19058 * @syscap SystemCapability.ArkUI.ArkUI.Full 19059 * @since 11 19060 */ 19061 /** 19062 * Set preview of the component for dragging process 19063 * 19064 * @param { CustomBuilder | DragItemInfo | string } value - preview of the component for dragging process 19065 * @returns { T } property value of type T. 19066 * @syscap SystemCapability.ArkUI.ArkUI.Full 19067 * @atomicservice 19068 * @since 12 19069 */ 19070 dragPreview(value: CustomBuilder | DragItemInfo | string): T; 19071 19072 /** 19073 * Set the selectable area drag preview options. 19074 * 19075 * @param { DragPreviewOptions } value - preview options value. 19076 * @returns { T } property value of type T. 19077 * @syscap SystemCapability.ArkUI.ArkUI.Full 19078 * @since 11 19079 */ 19080 /** 19081 * Set the selectable area drag preview options. 19082 * 19083 * @param { DragPreviewOptions } value - preview options value. 19084 * @param { DragInteractionOptions } options - drag interaction options value. 19085 * @returns { T } property value of type T. 19086 * @syscap SystemCapability.ArkUI.ArkUI.Full 19087 * @atomicservice 19088 * @since 12 19089 */ 19090 dragPreviewOptions(value: DragPreviewOptions, options?: DragInteractionOptions): T; 19091 19092 /** 19093 * After binding, a callback is triggered when the preDrag status change finished. 19094 * 19095 * @param { Callback<PreDragStatus> } callback callback - The callback will be triggered when the preDrag status change. 19096 * @returns { T } property value of type T. 19097 * @syscap SystemCapability.ArkUI.ArkUI.Full 19098 * @atomicservice 19099 * @since 12 19100 */ 19101 onPreDrag(callback: Callback<PreDragStatus>): T; 19102 19103 /** 19104 * Add mask text to the current component. The layout is the same as that of the current component. 19105 * 19106 * @param { string } value 19107 * @param { object } options 19108 * @returns { T } 19109 * @syscap SystemCapability.ArkUI.ArkUI.Full 19110 * @since 7 19111 */ 19112 /** 19113 * Add mask text to the current component. The layout is the same as that of the current component. 19114 * 19115 * @param { string } value 19116 * @param { object } options 19117 * @returns { T } 19118 * @syscap SystemCapability.ArkUI.ArkUI.Full 19119 * @form 19120 * @since 9 19121 */ 19122 /** 19123 * Add mask text to the current component. The layout is the same as that of the current component. 19124 * 19125 * @param { string | CustomBuilder } value 19126 * @param { object } options 19127 * @returns { T } 19128 * @syscap SystemCapability.ArkUI.ArkUI.Full 19129 * @crossplatform 19130 * @form 19131 * @since 10 19132 */ 19133 /** 19134 * Add mask text to the current component. The layout is the same as that of the current component. 19135 * 19136 * @param { string | CustomBuilder } value 19137 * @param { object } options 19138 * @returns { T } 19139 * @syscap SystemCapability.ArkUI.ArkUI.Full 19140 * @crossplatform 19141 * @form 19142 * @atomicservice 19143 * @since 11 19144 */ 19145 /** 19146 * Add mask text to the current component. The layout is the same as that of the current component. 19147 * 19148 * @param { string | CustomBuilder | ComponentContent } value 19149 * @param { OverlayOptions } options 19150 * @returns { T } 19151 * @syscap SystemCapability.ArkUI.ArkUI.Full 19152 * @crossplatform 19153 * @form 19154 * @atomicservice 19155 * @since 12 19156 */ 19157 overlay(value: string | CustomBuilder | ComponentContent, options?: OverlayOptions): T; 19158 19159 /** 19160 * Linear Gradient 19161 * angle: Angle of Linear Gradient. The default value is 180; 19162 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 19163 * colors: Color description for gradients. 19164 * repeating: repeating. The default value is false 19165 * 19166 * @param { object } value 19167 * @returns { T } 19168 * @syscap SystemCapability.ArkUI.ArkUI.Full 19169 * @since 7 19170 */ 19171 /** 19172 * Linear Gradient 19173 * angle: Angle of Linear Gradient. The default value is 180; 19174 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 19175 * colors: Color description for gradients. 19176 * repeating: repeating. The default value is false 19177 * 19178 * @param { object } value 19179 * @returns { T } 19180 * @syscap SystemCapability.ArkUI.ArkUI.Full 19181 * @form 19182 * @since 9 19183 */ 19184 /** 19185 * Linear Gradient 19186 * angle: Angle of Linear Gradient. The default value is 180; 19187 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 19188 * colors: Color description for gradients. 19189 * repeating: repeating. The default value is false 19190 * 19191 * @param { object } value 19192 * @returns { T } 19193 * @syscap SystemCapability.ArkUI.ArkUI.Full 19194 * @crossplatform 19195 * @form 19196 * @since 10 19197 */ 19198 /** 19199 * Linear Gradient 19200 * angle: Angle of Linear Gradient. The default value is 180; 19201 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 19202 * colors: Color description for gradients. 19203 * repeating: repeating. The default value is false 19204 * 19205 * @param { object } value 19206 * @returns { T } 19207 * @syscap SystemCapability.ArkUI.ArkUI.Full 19208 * @crossplatform 19209 * @form 19210 * @atomicservice 19211 * @since 11 19212 */ 19213 /** 19214 * Linear Gradient 19215 * angle: Angle of Linear Gradient. The default value is 180; 19216 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 19217 * colors: Color description for gradients. 19218 * repeating: repeating. The default value is false 19219 * 19220 * @param { object } value 19221 * @returns { T } 19222 * @syscap SystemCapability.ArkUI.ArkUI.Full 19223 * @crossplatform 19224 * @form 19225 * @atomicservice 19226 * @since 12 19227 */ 19228 linearGradient(value: { 19229 angle?: number | string; 19230 direction?: GradientDirection; 19231 colors: Array<[ResourceColor, number]>; 19232 repeating?: boolean; 19233 }): T; 19234 19235 /** 19236 * Angle Gradient 19237 * center:is the center point of the angle gradient 19238 * start:Start point of angle gradient. The default value is 0 19239 * end:End point of angle gradient. The default value is 0 19240 * number:number 19241 * rotating:rotating. The default value is 0 19242 * colors:Color description for gradients 19243 * repeating:repeating. The default value is false 19244 * 19245 * @param { object } value 19246 * @returns { T } 19247 * @syscap SystemCapability.ArkUI.ArkUI.Full 19248 * @since 7 19249 */ 19250 /** 19251 * Angle Gradient 19252 * center:is the center point of the angle gradient 19253 * start:Start point of angle gradient. The default value is 0 19254 * end:End point of angle gradient. The default value is 0 19255 * number:number 19256 * rotating:rotating. The default value is 0 19257 * colors:Color description for gradients 19258 * repeating:repeating. The default value is false 19259 * 19260 * @param { object } value 19261 * @returns { T } 19262 * @syscap SystemCapability.ArkUI.ArkUI.Full 19263 * @form 19264 * @since 9 19265 */ 19266 /** 19267 * Angle Gradient 19268 * center:is the center point of the angle gradient 19269 * start:Start point of angle gradient. The default value is 0 19270 * end:End point of angle gradient. The default value is 0 19271 * number:number 19272 * rotating:rotating. The default value is 0 19273 * colors:Color description for gradients 19274 * repeating:repeating. The default value is false 19275 * 19276 * @param { object } value 19277 * @returns { T } 19278 * @syscap SystemCapability.ArkUI.ArkUI.Full 19279 * @crossplatform 19280 * @form 19281 * @since 10 19282 */ 19283 /** 19284 * Angle Gradient 19285 * center:is the center point of the angle gradient 19286 * start:Start point of angle gradient. The default value is 0 19287 * end:End point of angle gradient. The default value is 0 19288 * number:number 19289 * rotating:rotating. The default value is 0 19290 * colors:Color description for gradients 19291 * repeating:repeating. The default value is false 19292 * 19293 * @param { object } value 19294 * @returns { T } 19295 * @syscap SystemCapability.ArkUI.ArkUI.Full 19296 * @crossplatform 19297 * @form 19298 * @atomicservice 19299 * @since 11 19300 */ 19301 /** 19302 * Angle Gradient 19303 * center:is the center point of the angle gradient 19304 * start:Start point of angle gradient. The default value is 0 19305 * end:End point of angle gradient. The default value is 0 19306 * number:number 19307 * rotating:rotating. The default value is 0 19308 * colors:Color description for gradients 19309 * repeating:repeating. The default value is false 19310 * 19311 * @param { object } value 19312 * @returns { T } 19313 * @syscap SystemCapability.ArkUI.ArkUI.Full 19314 * @crossplatform 19315 * @form 19316 * @atomicservice 19317 * @since 12 19318 */ 19319 sweepGradient(value: { 19320 center: [Length, Length]; 19321 start?: number | string; 19322 end?: number | string; 19323 rotation?: number | string; 19324 colors: Array<[ResourceColor, number]>; 19325 repeating?: boolean; 19326 }): T; 19327 19328 /** 19329 * Radial Gradient 19330 * center:Center point of radial gradient 19331 * radius:Radius of Radial Gradient. value range [0, +∞) 19332 * colors:Color description for gradients 19333 * repeating: Refill. The default value is false 19334 * 19335 * @param { object } value 19336 * @returns { T } 19337 * @syscap SystemCapability.ArkUI.ArkUI.Full 19338 * @since 7 19339 */ 19340 /** 19341 * Radial Gradient 19342 * center:Center point of radial gradient 19343 * radius:Radius of Radial Gradient. value range [0, +∞) 19344 * colors:Color description for gradients 19345 * repeating: Refill. The default value is false 19346 * 19347 * @param { object } value 19348 * @returns { T } 19349 * @syscap SystemCapability.ArkUI.ArkUI.Full 19350 * @form 19351 * @since 9 19352 */ 19353 /** 19354 * Radial Gradient 19355 * center:Center point of radial gradient 19356 * radius:Radius of Radial Gradient. value range [0, +∞) 19357 * colors:Color description for gradients 19358 * repeating: Refill. The default value is false 19359 * 19360 * @param { object } value 19361 * @returns { T } 19362 * @syscap SystemCapability.ArkUI.ArkUI.Full 19363 * @crossplatform 19364 * @form 19365 * @since 10 19366 */ 19367 /** 19368 * Radial Gradient 19369 * center:Center point of radial gradient 19370 * radius:Radius of Radial Gradient. value range [0, +∞) 19371 * colors:Color description for gradients 19372 * repeating: Refill. The default value is false 19373 * 19374 * @param { object } value 19375 * @returns { T } 19376 * @syscap SystemCapability.ArkUI.ArkUI.Full 19377 * @crossplatform 19378 * @form 19379 * @atomicservice 19380 * @since 11 19381 */ 19382 /** 19383 * Radial Gradient 19384 * center:Center point of radial gradient 19385 * radius:Radius of Radial Gradient. value range [0, +∞) 19386 * colors:Color description for gradients 19387 * repeating: Refill. The default value is false 19388 * 19389 * @param { object } value 19390 * @returns { T } 19391 * @syscap SystemCapability.ArkUI.ArkUI.Full 19392 * @crossplatform 19393 * @form 19394 * @atomicservice 19395 * @since 12 19396 */ 19397 radialGradient(value: { 19398 center: [Length, Length]; 19399 radius: number | string; 19400 colors: Array<[ResourceColor, number]>; 19401 repeating?: boolean; 19402 }): T; 19403 19404 /** 19405 * Set the motion path of the component 19406 * path:Motion path for displacement animation, using the svg path string. 19407 * from:Start point of the motion path. The default value is 0.0. 19408 * to:End point of the motion path. The default value is 1.0. 19409 * rotatable:Whether to follow the path for rotation. 19410 * 19411 * @param { MotionPathOptions } value 19412 * @returns { T } 19413 * @syscap SystemCapability.ArkUI.ArkUI.Full 19414 * @since 7 19415 */ 19416 /** 19417 * Set the motion path of the component 19418 * path:Motion path for displacement animation, using the svg path string. 19419 * from:Start point of the motion path. The default value is 0.0. 19420 * to:End point of the motion path. The default value is 1.0. 19421 * rotatable:Whether to follow the path for rotation. 19422 * 19423 * @param { MotionPathOptions } value 19424 * @returns { T } 19425 * @syscap SystemCapability.ArkUI.ArkUI.Full 19426 * @crossplatform 19427 * @since 10 19428 */ 19429 /** 19430 * Set the motion path of the component 19431 * path:Motion path for displacement animation, using the svg path string. 19432 * from:Start point of the motion path. The default value is 0.0. 19433 * to:End point of the motion path. The default value is 1.0. 19434 * rotatable:Whether to follow the path for rotation. 19435 * 19436 * @param { MotionPathOptions } value 19437 * @returns { T } 19438 * @syscap SystemCapability.ArkUI.ArkUI.Full 19439 * @crossplatform 19440 * @atomicservice 19441 * @since 11 19442 */ 19443 motionPath(value: MotionPathOptions): T; 19444 19445 /** 19446 * Add a shadow effect to the current component 19447 * 19448 * @param { ShadowOptions } value 19449 * @returns { T } 19450 * @syscap SystemCapability.ArkUI.ArkUI.Full 19451 * @since 7 19452 */ 19453 /** 19454 * Add a shadow effect to the current component 19455 * 19456 * @param { ShadowOptions } value 19457 * @returns { T } 19458 * @syscap SystemCapability.ArkUI.ArkUI.Full 19459 * @form 19460 * @since 9 19461 */ 19462 /** 19463 * Add a shadow effect to the current component 19464 * 19465 * @param { ShadowOptions | ShadowStyle } value 19466 * @returns { T } 19467 * @syscap SystemCapability.ArkUI.ArkUI.Full 19468 * @crossplatform 19469 * @form 19470 * @since 10 19471 */ 19472 /** 19473 * Add a shadow effect to the current component 19474 * 19475 * @param { ShadowOptions | ShadowStyle } value 19476 * @returns { T } 19477 * @syscap SystemCapability.ArkUI.ArkUI.Full 19478 * @crossplatform 19479 * @form 19480 * @atomicservice 19481 * @since 11 19482 */ 19483 shadow(value: ShadowOptions | ShadowStyle): T; 19484 19485 /** 19486 * Add a blendMode effect to the current component 19487 * 19488 * @param { BlendMode } value - Different hybrid modes 19489 * @param { BlendApplyType } [type] - Different blend apply type 19490 * @returns { T } 19491 * @syscap SystemCapability.ArkUI.ArkUI.Full 19492 * @crossplatform 19493 * @form 19494 * @since 11 19495 */ 19496 /** 19497 * Add a blendMode effect to the current component 19498 * 19499 * @param { BlendMode } value - Different hybrid modes 19500 * @param { BlendApplyType } [type] - Different blend apply type 19501 * @returns { T } 19502 * @syscap SystemCapability.ArkUI.ArkUI.Full 19503 * @crossplatform 19504 * @form 19505 * @atomicservice 19506 * @since 12 19507 */ 19508 blendMode(value: BlendMode, type?: BlendApplyType): T; 19509 19510 /** 19511 * Add a blendMode effect to the current component.Cannot be used together with the blendMode interface. 19512 * 19513 * @param { BlendMode | Blender } effect - When the effect type is BlendMode type, define Different hybrid modes. 19514 * When the effect type is Blender type, Define the corresponding blending effect. 19515 * @param { BlendApplyType } [type] - Different blend apply type 19516 * @returns { T } 19517 * @syscap SystemCapability.ArkUI.ArkUI.Full 19518 * @systemapi 19519 * @form 19520 * @since 13 19521 */ 19522 advancedBlendMode(effect: BlendMode | Blender, type?: BlendApplyType): T; 19523 19524 /** 19525 * Whether to crop the sub components beyond the current component range. 19526 * 19527 * @param { boolean } value 19528 * @returns { T } 19529 * @syscap SystemCapability.ArkUI.ArkUI.Full 19530 * @crossplatform 19531 * @form 19532 * @atomicservice 19533 * @since 12 19534 */ 19535 clip(value: boolean): T; 19536 19537 /** 19538 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 19539 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 19540 * 19541 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value 19542 * @returns { T } 19543 * @syscap SystemCapability.ArkUI.ArkUI.Full 19544 * @since 7 19545 */ 19546 /** 19547 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 19548 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 19549 * 19550 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value 19551 * @returns { T } 19552 * @syscap SystemCapability.ArkUI.ArkUI.Full 19553 * @form 19554 * @since 9 19555 */ 19556 /** 19557 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 19558 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 19559 * 19560 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value 19561 * @returns { T } 19562 * @syscap SystemCapability.ArkUI.ArkUI.Full 19563 * @crossplatform 19564 * @form 19565 * @since 10 19566 */ 19567 /** 19568 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 19569 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 19570 * 19571 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value 19572 * @returns { T } 19573 * @syscap SystemCapability.ArkUI.ArkUI.Full 19574 * @crossplatform 19575 * @form 19576 * @atomicservice 19577 * @since 11 19578 * @deprecated since 12 19579 * @useinstead CommonMethod#clipShape 19580 */ 19581 clip(value: boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute): T; 19582 19583 /** 19584 * The current component is cropped according to the specified shape. 19585 * 19586 * @param { CircleShape | EllipseShape | PathShape | RectShape } value - indicates the shape of the clip. 19587 * @returns { T } 19588 * @syscap SystemCapability.ArkUI.ArkUI.Full 19589 * @crossplatform 19590 * @form 19591 * @atomicservice 19592 * @since 12 19593 */ 19594 clipShape(value: CircleShape | EllipseShape | PathShape | RectShape): T; 19595 19596 /** 19597 * Sets the mask of the current component. 19598 * 19599 * @param { ProgressMask } value 19600 * @returns { T } 19601 * @syscap SystemCapability.ArkUI.ArkUI.Full 19602 * @crossplatform 19603 * @atomicservice 19604 * @since 12 19605 */ 19606 mask(value: ProgressMask): T; 19607 19608 /** 19609 * Applies a mask of the specified shape to the current assembly. 19610 * 19611 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value 19612 * @returns { T } 19613 * @syscap SystemCapability.ArkUI.ArkUI.Full 19614 * @since 7 19615 */ 19616 /** 19617 * Applies a mask of the specified shape to the current assembly. 19618 * 19619 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value - indicates the shape of the mask. 19620 * @returns { T } 19621 * @syscap SystemCapability.ArkUI.ArkUI.Full 19622 * @form 19623 * @since 9 19624 */ 19625 /** 19626 * Applies a mask of the specified shape to the current assembly. 19627 * 19628 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value - indicates the shape of the mask. 19629 * @returns { T } 19630 * @syscap SystemCapability.ArkUI.ArkUI.Full 19631 * @crossplatform 19632 * @form 19633 * @since 10 19634 */ 19635 /** 19636 * Applies a mask of the specified shape to the current assembly. 19637 * 19638 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value - indicates the shape of the mask. 19639 * @returns { T } 19640 * @syscap SystemCapability.ArkUI.ArkUI.Full 19641 * @crossplatform 19642 * @form 19643 * @atomicservice 19644 * @since 11 19645 * @deprecated since 12 19646 * @useinstead CommonMethod#maskShape 19647 */ 19648 mask(value: CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask): T; 19649 19650 /** 19651 * Applies a mask of the specified shape to the current assembly. 19652 * 19653 * @param { CircleShape | EllipseShape | PathShape | RectShape } value - indicates the shape of the mask. 19654 * @returns { T } 19655 * @syscap SystemCapability.ArkUI.ArkUI.Full 19656 * @crossplatform 19657 * @form 19658 * @atomicservice 19659 * @since 12 19660 */ 19661 maskShape(value: CircleShape | EllipseShape | PathShape | RectShape): T; 19662 19663 /** 19664 * Key. User can set an key to the component to identify it. 19665 * 19666 * @param { string } value 19667 * @returns { T } 19668 * @syscap SystemCapability.ArkUI.ArkUI.Full 19669 * @atomicservice 19670 * @since 12 19671 * @test 19672 */ 19673 key(value: string): T; 19674 19675 /** 19676 * Id. User can set an id to the component to identify it. 19677 * 19678 * @param { string } value 19679 * @returns { T } 19680 * @syscap SystemCapability.ArkUI.ArkUI.Full 19681 * @since 8 19682 */ 19683 /** 19684 * Id. User can set an id to the component to identify it. 19685 * 19686 * @param { string } value 19687 * @returns { T } 19688 * @syscap SystemCapability.ArkUI.ArkUI.Full 19689 * @form 19690 * @since 9 19691 */ 19692 /** 19693 * Id. User can set an id to the component to identify it. 19694 * 19695 * @param { string } value 19696 * @returns { T } 19697 * @syscap SystemCapability.ArkUI.ArkUI.Full 19698 * @crossplatform 19699 * @form 19700 * @since 10 19701 */ 19702 /** 19703 * Id. User can set an id to the component to identify it. 19704 * 19705 * @param { string } value 19706 * @returns { T } 19707 * @syscap SystemCapability.ArkUI.ArkUI.Full 19708 * @crossplatform 19709 * @form 19710 * @atomicservice 19711 * @since 11 19712 */ 19713 id(value: string): T; 19714 19715 /** 19716 * geometryTransition 19717 * 19718 * @param { string } id 19719 * @returns { T } 19720 * @syscap SystemCapability.ArkUI.ArkUI.Full 19721 * @since 7 19722 */ 19723 /** 19724 * geometryTransition 19725 * 19726 * @param { string } id 19727 * @returns { T } 19728 * @syscap SystemCapability.ArkUI.ArkUI.Full 19729 * @crossplatform 19730 * @since 10 19731 */ 19732 /** 19733 * geometryTransition 19734 * 19735 * @param { string } id 19736 * @returns { T } 19737 * @syscap SystemCapability.ArkUI.ArkUI.Full 19738 * @crossplatform 19739 * @atomicservice 19740 * @since 11 19741 */ 19742 geometryTransition(id: string): T; 19743 /** 19744 * Shared geometry transition 19745 * 19746 * @param { string } id - geometry transition id 19747 * @param { GeometryTransitionOptions } options - Indicates the options of geometry transition. 19748 * @returns { T } 19749 * @syscap SystemCapability.ArkUI.ArkUI.Full 19750 * @crossplatform 19751 * @since 11 19752 */ 19753 /** 19754 * Shared geometry transition 19755 * 19756 * @param { string } id - geometry transition id 19757 * @param { GeometryTransitionOptions } options - Indicates the options of geometry transition. 19758 * @returns { T } 19759 * @syscap SystemCapability.ArkUI.ArkUI.Full 19760 * @crossplatform 19761 * @atomicservice 19762 * @since 12 19763 */ 19764 geometryTransition(id: string, options?: GeometryTransitionOptions): T; 19765 19766 /** 19767 * Popup control 19768 * 19769 * @param { boolean } show 19770 * @param { PopupOptions } popup 19771 * @returns { T } 19772 * @syscap SystemCapability.ArkUI.ArkUI.Full 19773 * @since 7 19774 */ 19775 /** 19776 * Popup control 19777 * 19778 * @param { boolean } show 19779 * @param { PopupOptions | CustomPopupOptions } popup 19780 * @returns { T } 19781 * @syscap SystemCapability.ArkUI.ArkUI.Full 19782 * @since 8 19783 */ 19784 /** 19785 * Popup control 19786 * 19787 * @param { boolean } show 19788 * @param { PopupOptions | CustomPopupOptions } popup 19789 * @returns { T } 19790 * @syscap SystemCapability.ArkUI.ArkUI.Full 19791 * @crossplatform 19792 * @atomicservice 19793 * @since 11 19794 */ 19795 bindPopup(show: boolean, popup: PopupOptions | CustomPopupOptions): T; 19796 19797 /** 19798 * Menu control 19799 * 19800 * @param { { value: ResourceStr; icon?: ResourceStr; action: () => void }[] | CustomBuilder } content 19801 * action: () => void }[] | CustomBuilder } content - Indicates the content of menu. 19802 * @param { MenuOptions } options 19803 * @returns { T } 19804 * @syscap SystemCapability.ArkUI.ArkUI.Full 19805 * @since 7 19806 */ 19807 /** 19808 * Menu control 19809 * 19810 * @param { { value: ResourceStr; icon?: ResourceStr; action: () => void }[] | CustomBuilder } content 19811 * action: () => void }[] | CustomBuilder } content - Indicates the content of menu. 19812 * @param { MenuOptions } options - Indicates the options of menu. 19813 * @returns { T } 19814 * @syscap SystemCapability.ArkUI.ArkUI.Full 19815 * @crossplatform 19816 * @since 10 19817 */ 19818 /** 19819 * Menu control 19820 * 19821 * @param { Array<MenuElement> | CustomBuilder } content - Indicates the content of menu. 19822 * @param { MenuOptions } options - Indicates the options of menu. 19823 * @returns { T } 19824 * @syscap SystemCapability.ArkUI.ArkUI.Full 19825 * @crossplatform 19826 * @atomicservice 19827 * @since 11 19828 */ 19829 bindMenu(content: Array<MenuElement> | CustomBuilder, options?: MenuOptions): T; 19830 19831 /** 19832 * Menu control 19833 * 19834 * @param { boolean } isShow true means display menu, false means hide menu. 19835 * @param { Array<MenuElement> | CustomBuilder } content - Indicates the content of menu. 19836 * @param { MenuOptions } options - Indicates the options of menu. 19837 * @returns { T } 19838 * @syscap SystemCapability.ArkUI.ArkUI.Full 19839 * @crossplatform 19840 * @since 11 19841 */ 19842 /** 19843 * Menu control 19844 * 19845 * @param { boolean } isShow true means display menu, false means hide menu. 19846 * @param { Array<MenuElement> | CustomBuilder } content - Indicates the content of menu. 19847 * @param { MenuOptions } options - Indicates the options of menu. 19848 * @returns { T } 19849 * @syscap SystemCapability.ArkUI.ArkUI.Full 19850 * @crossplatform 19851 * @atomicservice 19852 * @since 12 19853 */ 19854 bindMenu(isShow: boolean, content: Array<MenuElement> | CustomBuilder, options?: MenuOptions): T; 19855 19856 /** 19857 * ContextMenu control 19858 * 19859 * @param { CustomBuilder } content 19860 * @param { ResponseType } responseType 19861 * @param { ContextMenuOptions } options 19862 * @returns { T } 19863 * @syscap SystemCapability.ArkUI.ArkUI.Full 19864 * @since 8 19865 */ 19866 /** 19867 * ContextMenu control 19868 * 19869 * @param { CustomBuilder } content - Indicates the content of context menu. 19870 * @param { ResponseType } responseType - Indicates response type of context menu. 19871 * @param { ContextMenuOptions } options - Indicates the options of context menu. 19872 * @returns { T } 19873 * @syscap SystemCapability.ArkUI.ArkUI.Full 19874 * @crossplatform 19875 * @since 10 19876 */ 19877 /** 19878 * ContextMenu control 19879 * 19880 * @param { CustomBuilder } content - Indicates the content of context menu. 19881 * @param { ResponseType } responseType - Indicates response type of context menu. 19882 * @param { ContextMenuOptions } options - Indicates the options of context menu. 19883 * @returns { T } 19884 * @syscap SystemCapability.ArkUI.ArkUI.Full 19885 * @crossplatform 19886 * @atomicservice 19887 * @since 11 19888 */ 19889 bindContextMenu(content: CustomBuilder, responseType: ResponseType, options?: ContextMenuOptions): T; 19890 19891 /** 19892 * ContextMenu control 19893 * 19894 * @param { boolean } isShown - true means display content, false means hide content. 19895 * @param { CustomBuilder } content - Indicates the content of context menu. 19896 * @param { ContextMenuOptions } [options] - Indicates the options of context menu. 19897 * @returns { T } 19898 * @syscap SystemCapability.ArkUI.ArkUI.Full 19899 * @crossplatform 19900 * @atomicservice 19901 * @since 12 19902 */ 19903 bindContextMenu(isShown: boolean, content: CustomBuilder, options?: ContextMenuOptions): T; 19904 19905 /** 19906 * Bind content cover 19907 * 19908 * @param { boolean } isShow - true means display content, false means hide content. 19909 * @param { CustomBuilder } builder - the content to be displayed. 19910 * @param { ModalTransition } type - transition type. 19911 * @returns { T } 19912 * @syscap SystemCapability.ArkUI.ArkUI.Full 19913 * @crossplatform 19914 * @since 10 19915 */ 19916 /** 19917 * Bind content cover 19918 * 19919 * @param { boolean } isShow - true means display content, false means hide content. 19920 * @param { CustomBuilder } builder - the content to be displayed. 19921 * @param { ModalTransition } type - transition type. 19922 * @returns { T } 19923 * @syscap SystemCapability.ArkUI.ArkUI.Full 19924 * @crossplatform 19925 * @atomicservice 19926 * @since 11 19927 */ 19928 /** 19929 * Bind content cover 19930 * 19931 * @param { Optional<boolean> } isShow - true means display content, false means hide content. 19932 * @param { CustomBuilder } builder - the content to be displayed. 19933 * @param { ModalTransition } [type] - transition type. 19934 * @returns { T } 19935 * @syscap SystemCapability.ArkUI.ArkUI.Full 19936 * @crossplatform 19937 * @atomicservice 19938 * @since 12 19939 */ 19940 bindContentCover(isShow: Optional<boolean>, builder: CustomBuilder, type?: ModalTransition): T; 19941 19942 /** 19943 * Bind content cover 19944 * 19945 * @param { boolean } isShow - true means display content, false means hide content. 19946 * @param { CustomBuilder } builder - the content to be displayed. 19947 * @param { ContentCoverOptions } options - options of content cover. 19948 * @returns { T } 19949 * @syscap SystemCapability.ArkUI.ArkUI.Full 19950 * @crossplatform 19951 * @since 10 19952 */ 19953 /** 19954 * Bind content cover 19955 * 19956 * @param { boolean } isShow - true means display content, false means hide content. 19957 * @param { CustomBuilder } builder - the content to be displayed. 19958 * @param { ContentCoverOptions } options - options of content cover. 19959 * @returns { T } 19960 * @syscap SystemCapability.ArkUI.ArkUI.Full 19961 * @crossplatform 19962 * @atomicservice 19963 * @since 11 19964 */ 19965 /** 19966 * Bind content cover 19967 * 19968 * @param { Optional<boolean> } isShow - true means display content, false means hide content. 19969 * @param { CustomBuilder } builder - the content to be displayed. 19970 * @param { ContentCoverOptions } [options] - options of content cover. 19971 * @returns { T } 19972 * @syscap SystemCapability.ArkUI.ArkUI.Full 19973 * @crossplatform 19974 * @atomicservice 19975 * @since 12 19976 */ 19977 bindContentCover(isShow: Optional<boolean>, builder: CustomBuilder, options?: ContentCoverOptions): T; 19978 19979 /** 19980 * Bind sheet 19981 * 19982 * @param { boolean } isShow - true means display sheet, false means hide sheet. 19983 * @param { CustomBuilder } builder - the sheet to be displayed. 19984 * @param { SheetOptions } options - options of sheet. 19985 * @returns { T } - template type 19986 * @syscap SystemCapability.ArkUI.ArkUI.Full 19987 * @crossplatform 19988 * @since 10 19989 */ 19990 /** 19991 * Bind sheet 19992 * 19993 * @param { boolean } isShow - true means display sheet, false means hide sheet. 19994 * @param { CustomBuilder } builder - the sheet to be displayed. 19995 * @param { SheetOptions } options - options of sheet. 19996 * @returns { T } - template type 19997 * @syscap SystemCapability.ArkUI.ArkUI.Full 19998 * @crossplatform 19999 * @atomicservice 20000 * @since 11 20001 */ 20002 /** 20003 * Bind sheet 20004 * 20005 * @param { Optional<boolean> } isShow - true means display sheet, false means hide sheet. 20006 * @param { CustomBuilder } builder - the sheet to be displayed. 20007 * @param { SheetOptions } [options] - options of sheet. 20008 * @returns { T } - template type 20009 * @syscap SystemCapability.ArkUI.ArkUI.Full 20010 * @crossplatform 20011 * @atomicservice 20012 * @since 12 20013 */ 20014 bindSheet(isShow: Optional<boolean>, builder: CustomBuilder, options?: SheetOptions): T; 20015 20016 /** 20017 * Sets styles for component state. 20018 * 20019 * @param { StateStyles } value 20020 * @returns { T } 20021 * @syscap SystemCapability.ArkUI.ArkUI.Full 20022 * @since 8 20023 */ 20024 /** 20025 * Sets styles for component state. 20026 * 20027 * @param { StateStyles } value 20028 * @returns { T } 20029 * @syscap SystemCapability.ArkUI.ArkUI.Full 20030 * @form 20031 * @since 9 20032 */ 20033 /** 20034 * Sets styles for component state. 20035 * 20036 * @param { StateStyles } value 20037 * @returns { T } 20038 * @syscap SystemCapability.ArkUI.ArkUI.Full 20039 * @crossplatform 20040 * @form 20041 * @since 10 20042 */ 20043 /** 20044 * Sets styles for component state. 20045 * 20046 * @param { StateStyles } value 20047 * @returns { T } 20048 * @syscap SystemCapability.ArkUI.ArkUI.Full 20049 * @crossplatform 20050 * @form 20051 * @atomicservice 20052 * @since 11 20053 */ 20054 stateStyles(value: StateStyles): T; 20055 20056 /** 20057 * id for distribute identification. 20058 * 20059 * @param { number } value 20060 * @returns { T } 20061 * @syscap SystemCapability.ArkUI.ArkUI.Full 20062 * @since 8 20063 */ 20064 /** 20065 * id for distribute identification. 20066 * 20067 * @param { number } value 20068 * @returns { T } 20069 * @syscap SystemCapability.ArkUI.ArkUI.Full 20070 * @crossplatform 20071 * @atomicservice 20072 * @since 11 20073 */ 20074 restoreId(value: number): T; 20075 20076 /** 20077 * Trigger a visible area change event. 20078 * 20079 * @param { Array<number> } ratios 20080 * @param { function } event 20081 * @returns { T } 20082 * @syscap SystemCapability.ArkUI.ArkUI.Full 20083 * @since 9 20084 */ 20085 /** 20086 * Trigger a visible area change event. 20087 * 20088 * @param { Array<number> } ratios 20089 * @param { function } event 20090 * @returns { T } 20091 * @syscap SystemCapability.ArkUI.ArkUI.Full 20092 * @crossplatform 20093 * @since 10 20094 */ 20095 /** 20096 * Trigger a visible area change event. 20097 * 20098 * @param { Array<number> } ratios 20099 * @param { function } event 20100 * @returns { T } 20101 * @syscap SystemCapability.ArkUI.ArkUI.Full 20102 * @crossplatform 20103 * @atomicservice 20104 * @since 11 20105 */ 20106 /** 20107 * Trigger a visible area change event. 20108 * 20109 * @param { Array<number> } ratios 20110 * @param { VisibleAreaChangeCallback } event 20111 * @returns { T } 20112 * @syscap SystemCapability.ArkUI.ArkUI.Full 20113 * @crossplatform 20114 * @atomicservice 20115 * @since 13 20116 */ 20117 onVisibleAreaChange(ratios: Array<number>, event: VisibleAreaChangeCallback): T; 20118 20119 /** 20120 * Set the spherical effect of the component. 20121 * 20122 * @param { number } value - set the degree of spherical effect, value range [0, 1]. 20123 * If the value is 0, the component keep same, else the value is 1, component are fully spherical. 20124 * @returns { T } 20125 * @syscap SystemCapability.ArkUI.ArkUI.Full 20126 * @crossplatform 20127 * @atomicservice 20128 * @since 12 20129 */ 20130 sphericalEffect(value: number): T; 20131 20132 /** 20133 * Set the light up effect of the component 20134 * 20135 * @param { number } value - set the degree to which the component lights up, value range [0, 1]. 20136 * The color brightness in the component rendering content area is greater than the value and can be displayed, otherwise it will not be displayed. 20137 * @returns { T } 20138 * @syscap SystemCapability.ArkUI.ArkUI.Full 20139 * @crossplatform 20140 * @atomicservice 20141 * @since 12 20142 */ 20143 lightUpEffect(value: number): T; 20144 20145 /** 20146 * Set the edge pixel stretch effect of the Component. 20147 * 20148 * @param { PixelStretchEffectOptions } options 20149 * @returns { T } 20150 * @syscap SystemCapability.ArkUI.ArkUI.Full 20151 * @crossplatform 20152 * @atomicservice 20153 * @since 12 20154 */ 20155 pixelStretchEffect(options: PixelStretchEffectOptions): T; 20156 20157 /** 20158 * Sets hot keys 20159 * 20160 * @param { string | FunctionKey } value - Character of the combination key. 20161 * @param { Array<ModifierKey> } keys - The modifier keys modify the action of key when the key are pressed at the same time. 20162 * @param { function } [action] - Callback function, triggered when the shortcut keyboard is pressed. 20163 * @returns { T } 20164 * @syscap SystemCapability.ArkUI.ArkUI.Full 20165 * @crossplatform 20166 * @since 10 20167 */ 20168 /** 20169 * Sets hot keys 20170 * 20171 * @param { string | FunctionKey } value - Character of the combination key. 20172 * @param { Array<ModifierKey> } keys - The modifier keys modify the action of key when the key are pressed at the same time. 20173 * @param { function } [action] - Callback function, triggered when the shortcut keyboard is pressed. 20174 * @returns { T } 20175 * @syscap SystemCapability.ArkUI.ArkUI.Full 20176 * @crossplatform 20177 * @atomicservice 20178 * @since 11 20179 */ 20180 keyboardShortcut(value: string | FunctionKey, keys: Array<ModifierKey>, action?: () => void): T; 20181 20182 /** 20183 * Sets accessibilityGroup 20184 * 20185 * @param { boolean } value - set group with accessibility 20186 * @returns { T } 20187 * @syscap SystemCapability.ArkUI.ArkUI.Full 20188 * @crossplatform 20189 * @since 10 20190 */ 20191 /** 20192 * Sets accessibilityGroup 20193 * 20194 * @param { boolean } value - set group with accessibility 20195 * @returns { T } 20196 * @syscap SystemCapability.ArkUI.ArkUI.Full 20197 * @crossplatform 20198 * @atomicservice 20199 * @since 11 20200 */ 20201 /** 20202 * Sets accessibilityGroup 20203 * 20204 * @param { boolean } value - set group with accessibility 20205 * @returns { T } 20206 * @syscap SystemCapability.ArkUI.ArkUI.Full 20207 * @crossplatform 20208 * @form 20209 * @atomicservice 20210 * @since 12 20211 */ 20212 accessibilityGroup(value: boolean): T; 20213 20214 /** 20215 * Sets accessibilityText 20216 * 20217 * @param { string } value - set accessibility text 20218 * @returns { T } 20219 * @syscap SystemCapability.ArkUI.ArkUI.Full 20220 * @crossplatform 20221 * @since 10 20222 */ 20223 /** 20224 * Sets accessibilityText 20225 * 20226 * @param { string } value - set accessibility text 20227 * @returns { T } 20228 * @syscap SystemCapability.ArkUI.ArkUI.Full 20229 * @crossplatform 20230 * @atomicservice 20231 * @since 11 20232 */ 20233 /** 20234 * Sets accessibilityText 20235 * 20236 * @param { string } value - set accessibility text 20237 * @returns { T } 20238 * @syscap SystemCapability.ArkUI.ArkUI.Full 20239 * @crossplatform 20240 * @form 20241 * @atomicservice 20242 * @since 12 20243 */ 20244 accessibilityText(value: string): T; 20245 20246 /** 20247 * Sets accessibilityText 20248 * 20249 * @param { Resource } text - set accessibility text 20250 * @returns { T } 20251 * @syscap SystemCapability.ArkUI.ArkUI.Full 20252 * @crossplatform 20253 * @form 20254 * @atomicservice 20255 * @since 12 20256 */ 20257 accessibilityText(text: Resource): T; 20258 20259 /** 20260 * Sets accessibilityTextHint 20261 * 20262 * @param { string } value - set accessibility text hint 20263 * @returns { T } 20264 * @syscap SystemCapability.ArkUI.ArkUI.Full 20265 * @crossplatform 20266 * @form 20267 * @atomicservice 20268 * @since 12 20269 */ 20270 accessibilityTextHint(value: string): T; 20271 20272 /** 20273 * Sets accessibilityDescription 20274 * 20275 * @param { string } value - set description of accessibility 20276 * @returns { T } 20277 * @syscap SystemCapability.ArkUI.ArkUI.Full 20278 * @crossplatform 20279 * @since 10 20280 */ 20281 /** 20282 * Sets accessibilityDescription 20283 * 20284 * @param { string } value - set description of accessibility 20285 * @returns { T } 20286 * @syscap SystemCapability.ArkUI.ArkUI.Full 20287 * @crossplatform 20288 * @atomicservice 20289 * @since 11 20290 */ 20291 /** 20292 * Sets accessibilityDescription 20293 * 20294 * @param { string } value - set description of accessibility 20295 * @returns { T } 20296 * @syscap SystemCapability.ArkUI.ArkUI.Full 20297 * @crossplatform 20298 * @form 20299 * @atomicservice 20300 * @since 12 20301 */ 20302 accessibilityDescription(value: string): T; 20303 20304 /** 20305 * Sets accessibilityDescription 20306 * 20307 * @param { Resource } description - set description of accessibility 20308 * @returns { T } 20309 * @syscap SystemCapability.ArkUI.ArkUI.Full 20310 * @crossplatform 20311 * @form 20312 * @atomicservice 20313 * @since 12 20314 */ 20315 accessibilityDescription(description: Resource): T; 20316 20317 /** 20318 * Sets accessibilityLevel 20319 * 20320 * @param { string } value - set accessibility level 20321 * @returns { T } 20322 * @syscap SystemCapability.ArkUI.ArkUI.Full 20323 * @crossplatform 20324 * @since 10 20325 */ 20326 /** 20327 * Sets accessibilityLevel 20328 * 20329 * @param { string } value - set accessibility level 20330 * @returns { T } 20331 * @syscap SystemCapability.ArkUI.ArkUI.Full 20332 * @crossplatform 20333 * @atomicservice 20334 * @since 11 20335 */ 20336 /** 20337 * Sets accessibilityLevel 20338 * 20339 * @param { string } value - set accessibility level 20340 * @returns { T } 20341 * @syscap SystemCapability.ArkUI.ArkUI.Full 20342 * @crossplatform 20343 * @form 20344 * @atomicservice 20345 * @since 12 20346 */ 20347 accessibilityLevel(value: string): T; 20348 20349 /** 20350 * Sets accessibilityVirtualNode 20351 * 20352 * @param { CustomBuilder } builder - set virtual node of accessibility 20353 * @returns { T } 20354 * @syscap SystemCapability.ArkUI.ArkUI.Full 20355 * @crossplatform 20356 * @atomicservice 20357 * @since 11 20358 */ 20359 /** 20360 * Sets accessibilityVirtualNode 20361 * 20362 * @param { CustomBuilder } builder - set virtual node of accessibility 20363 * @returns { T } 20364 * @syscap SystemCapability.ArkUI.ArkUI.Full 20365 * @crossplatform 20366 * @form 20367 * @atomicservice 20368 * @since 12 20369 */ 20370 accessibilityVirtualNode(builder: CustomBuilder): T; 20371 20372 /** 20373 * Sets accessibilityChecked 20374 * 20375 * @param { boolean } isCheck - set accessibility checked status 20376 * @returns { T } 20377 * @syscap SystemCapability.ArkUI.ArkUI.Full 20378 * @crossplatform 20379 * @form 20380 * @atomicservice 20381 * @since 14 20382 */ 20383 accessibilityChecked(isCheck: boolean): T; 20384 20385 /** 20386 * Sets accessibilitySelected 20387 * 20388 * @param { boolean } isSelect - set accessibility selected status 20389 * @returns { T } 20390 * @syscap SystemCapability.ArkUI.ArkUI.Full 20391 * @crossplatform 20392 * @form 20393 * @atomicservice 20394 * @since 14 20395 */ 20396 accessibilitySelected(isSelect: boolean): T; 20397 20398 /** 20399 * Sets obscured 20400 * 20401 * @param { Array<ObscuredReasons> } reasons - reasons of obscuration 20402 * @returns { T } 20403 * @syscap SystemCapability.ArkUI.ArkUI.Full 20404 * @crossplatform 20405 * @since 10 20406 */ 20407 /** 20408 * Sets obscured 20409 * 20410 * @param { Array<ObscuredReasons> } reasons - reasons of obscuration 20411 * @returns { T } 20412 * @syscap SystemCapability.ArkUI.ArkUI.Full 20413 * @crossplatform 20414 * @atomicservice 20415 * @since 11 20416 */ 20417 obscured(reasons: Array<ObscuredReasons>): T; 20418 20419 /** 20420 * Reuse id is used for identify the reuse type for each custom node. 20421 * 20422 * @param { string } id - The id for reusable custom node. 20423 * @returns { T } 20424 * @syscap SystemCapability.ArkUI.ArkUI.Full 20425 * @crossplatform 20426 * @since 10 20427 */ 20428 /** 20429 * Reuse id is used for identify the reuse type for each custom node. 20430 * 20431 * @param { string } id - The id for reusable custom node. 20432 * @returns { T } 20433 * @syscap SystemCapability.ArkUI.ArkUI.Full 20434 * @crossplatform 20435 * @atomicservice 20436 * @since 11 20437 */ 20438 reuseId(id: string): T; 20439 20440 /** 20441 * Sets how content is drawn within nodes duration animation 20442 * 20443 * @param { RenderFit } fitMode - The render fit mode of content. 20444 * @returns { T } 20445 * @syscap SystemCapability.ArkUI.ArkUI.Full 20446 * @crossplatform 20447 * @since 10 20448 */ 20449 /** 20450 * Sets how content is drawn within nodes duration animation 20451 * 20452 * @param { RenderFit } fitMode - The render fit mode of content. 20453 * @returns { T } 20454 * @syscap SystemCapability.ArkUI.ArkUI.Full 20455 * @crossplatform 20456 * @atomicservice 20457 * @since 11 20458 */ 20459 renderFit(fitMode: RenderFit): T; 20460 20461 /** 20462 * Sets the attribute modifier. 20463 * 20464 * @param { AttributeModifier<T> } modifier 20465 * @returns { T } 20466 * @syscap SystemCapability.ArkUI.ArkUI.Full 20467 * @crossplatform 20468 * @since 11 20469 */ 20470 /** 20471 * Sets the attribute modifier. 20472 * 20473 * @param { AttributeModifier<T> } modifier 20474 * @returns { T } 20475 * @syscap SystemCapability.ArkUI.ArkUI.Full 20476 * @crossplatform 20477 * @atomicservice 20478 * @since 12 20479 */ 20480 attributeModifier(modifier: AttributeModifier<T>): T; 20481 20482 /** 20483 * Sets the gesture modifier. 20484 * 20485 * @param { GestureModifier } modifier 20486 * @returns { T } 20487 * @syscap SystemCapability.ArkUI.ArkUI.Full 20488 * @crossplatform 20489 * @atomicservice 20490 * @since 12 20491 */ 20492 gestureModifier(modifier: GestureModifier): T; 20493 20494 /** 20495 * Adds a background dynamic light up effect to the current component. 20496 * 20497 * @param { BackgroundBrightnessOptions } params - params indicates BackgroundBrightnessOptions 20498 * @returns { T } 20499 * @syscap SystemCapability.ArkUI.ArkUI.Full 20500 * @atomicservice 20501 * @since 12 20502 */ 20503 backgroundBrightness(params: BackgroundBrightnessOptions): T; 20504 20505 /** 20506 * When a gesture bound to this component will be accepted, a user-defined callback is triggered to get the result 20507 * 20508 * @param { function } callback - A callback instance used when a gesture bound to this component will be accepted. 20509 * @returns { T } 20510 * @syscap SystemCapability.ArkUI.ArkUI.Full 20511 * @crossplatform 20512 * @since 11 20513 */ 20514 /** 20515 * When a gesture bound to this component will be accepted, a user-defined callback is triggered to get the result 20516 * 20517 * @param { function } callback - A callback instance used when a gesture bound to this component will be accepted. 20518 * @returns { T } 20519 * @syscap SystemCapability.ArkUI.ArkUI.Full 20520 * @crossplatform 20521 * @atomicservice 20522 * @since 12 20523 */ 20524 onGestureJudgeBegin(callback: (gestureInfo: GestureInfo, event: BaseGestureEvent) => GestureJudgeResult): T; 20525 20526 /** 20527 * When a gesture bound to this component will be accepted, a user-defined callback is triggered to get the result 20528 * 20529 * @param { GestureRecognizerJudgeBeginCallback } callback - A callback instance used when a gesture bound to this component will be accepted. 20530 * @returns { T } 20531 * @syscap SystemCapability.ArkUI.ArkUI.Full 20532 * @crossplatform 20533 * @atomicservice 20534 * @since 12 20535 */ 20536 onGestureRecognizerJudgeBegin(callback: GestureRecognizerJudgeBeginCallback): T; 20537 20538 /** 20539 * When a gesture bound to this component will be accepted, a user-defined callback is triggered to get the result 20540 * 20541 * @param { GestureRecognizerJudgeBeginCallback } callback - A callback instance used when a gesture bound to this component will be accepted. 20542 * @param { boolean } exposeInnerGesture - This parameter is a flag. This flag determines whether to expose internal gestures. 20543 * @returns { T } 20544 * @syscap SystemCapability.ArkUI.ArkUI.Full 20545 * @crossplatform 20546 * @atomicservice 20547 * 20548 * @since 14 20549 */ 20550 onGestureRecognizerJudgeBegin(callback: GestureRecognizerJudgeBeginCallback, exposeInnerGesture: boolean): T; 20551 20552 /** 20553 * In the touch test phase, the recognizer is selected to form a parallel relationship with other recognizers on the response chain. 20554 * 20555 * @param { ShouldBuiltInRecognizerParallelWithCallback } callback - A callback instance used when a component is doing touch test. 20556 * @returns { T } 20557 * @syscap SystemCapability.ArkUI.ArkUI.Full 20558 * @crossplatform 20559 * @atomicservice 20560 * @since 12 20561 */ 20562 shouldBuiltInRecognizerParallelWith(callback: ShouldBuiltInRecognizerParallelWithCallback): T; 20563 20564 /** 20565 * Events are monopolized by components. 20566 * 20567 * @param { boolean } monopolize - indicate the monopoly of events 20568 * @returns { T } 20569 * @syscap SystemCapability.ArkUI.ArkUI.Full 20570 * @crossplatform 20571 * @since 11 20572 */ 20573 /** 20574 * Events are monopolized by components. 20575 * 20576 * @param { boolean } monopolize - indicate the monopoly of events 20577 * @returns { T } 20578 * @syscap SystemCapability.ArkUI.ArkUI.Full 20579 * @crossplatform 20580 * @atomicservice 20581 * @since 12 20582 */ 20583 monopolizeEvents(monopolize: boolean): T; 20584 20585 /** 20586 * When the component does a touch test, a user-defined callback is triggered. 20587 * 20588 * @param { Callback<TouchEvent, HitTestMode> } callback - A callback instance used when the component does a touch test. 20589 * @returns { T } 20590 * @syscap SystemCapability.ArkUI.ArkUI.Full 20591 * @crossplatform 20592 * @atomicservice 20593 * @since 12 20594 */ 20595 onTouchIntercept(callback: Callback<TouchEvent, HitTestMode>): T; 20596 20597 /** 20598 * This callback is triggered when the size of this component change finished. 20599 * 20600 * @param { SizeChangeCallback } event - event callback. 20601 * @returns { T } 20602 * @syscap SystemCapability.ArkUI.ArkUI.Full 20603 * @crossplatform 20604 * @form 20605 * @atomicservice 20606 * @since 12 20607 */ 20608 onSizeChange(event: SizeChangeCallback): T; 20609} 20610 20611/** 20612 * CommonAttribute for ide. 20613 * 20614 * @extends CommonMethod<CommonAttribute> 20615 * @syscap SystemCapability.ArkUI.ArkUI.Full 20616 * @since 7 20617 */ 20618/** 20619 * CommonAttribute for ide. 20620 * 20621 * @extends CommonMethod<CommonAttribute> 20622 * @syscap SystemCapability.ArkUI.ArkUI.Full 20623 * @form 20624 * @since 9 20625 */ 20626/** 20627 * CommonAttribute for ide. 20628 * 20629 * @extends CommonMethod<CommonAttribute> 20630 * @syscap SystemCapability.ArkUI.ArkUI.Full 20631 * @crossplatform 20632 * @form 20633 * @since 10 20634 */ 20635/** 20636 * CommonAttribute for ide. 20637 * 20638 * @extends CommonMethod<CommonAttribute> 20639 * @syscap SystemCapability.ArkUI.ArkUI.Full 20640 * @crossplatform 20641 * @form 20642 * @atomicservice 20643 * @since 11 20644 */ 20645declare class CommonAttribute extends CommonMethod<CommonAttribute> {} 20646 20647/** 20648 * CommonInterface for ide. 20649 * 20650 * @interface CommonInterface 20651 * @syscap SystemCapability.ArkUI.ArkUI.Full 20652 * @since 7 20653 */ 20654/** 20655 * CommonInterface for ide. 20656 * 20657 * @interface CommonInterface 20658 * @syscap SystemCapability.ArkUI.ArkUI.Full 20659 * @form 20660 * @since 9 20661 */ 20662/** 20663 * CommonInterface for ide. 20664 * 20665 * @interface CommonInterface 20666 * @syscap SystemCapability.ArkUI.ArkUI.Full 20667 * @crossplatform 20668 * @form 20669 * @since 10 20670 */ 20671/** 20672 * CommonInterface for ide. 20673 * 20674 * @interface CommonInterface 20675 * @syscap SystemCapability.ArkUI.ArkUI.Full 20676 * @crossplatform 20677 * @form 20678 * @atomicservice 20679 * @since 11 20680 */ 20681interface CommonInterface { 20682 /** 20683 * Constructor. 20684 * 20685 * @returns { CommonAttribute } 20686 * @syscap SystemCapability.ArkUI.ArkUI.Full 20687 * @since 7 20688 */ 20689 /** 20690 * Constructor 20691 * 20692 * @returns { CommonAttribute } 20693 * @syscap SystemCapability.ArkUI.ArkUI.Full 20694 * @form 20695 * @since 9 20696 */ 20697 /** 20698 * Constructor 20699 * 20700 * @returns { CommonAttribute } 20701 * @syscap SystemCapability.ArkUI.ArkUI.Full 20702 * @crossplatform 20703 * @form 20704 * @since 10 20705 */ 20706 /** 20707 * Constructor 20708 * 20709 * @returns { CommonAttribute } 20710 * @syscap SystemCapability.ArkUI.ArkUI.Full 20711 * @crossplatform 20712 * @form 20713 * @atomicservice 20714 * @since 11 20715 */ 20716 (): CommonAttribute; 20717} 20718 20719/** 20720 * CommonInstance for ide. 20721 * 20722 * @syscap SystemCapability.ArkUI.ArkUI.Full 20723 * @since 7 20724 */ 20725/** 20726 * CommonInstance for ide. 20727 * 20728 * @syscap SystemCapability.ArkUI.ArkUI.Full 20729 * @form 20730 * @since 9 20731 */ 20732/** 20733 * CommonInstance for ide. 20734 * 20735 * @syscap SystemCapability.ArkUI.ArkUI.Full 20736 * @crossplatform 20737 * @form 20738 * @since 10 20739 */ 20740/** 20741 * CommonInstance for ide. 20742 * 20743 * @syscap SystemCapability.ArkUI.ArkUI.Full 20744 * @crossplatform 20745 * @form 20746 * @atomicservice 20747 * @since 11 20748 */ 20749declare const CommonInstance: CommonAttribute; 20750 20751/** 20752 * Common for ide. 20753 * 20754 * @syscap SystemCapability.ArkUI.ArkUI.Full 20755 * @since 7 20756 */ 20757/** 20758 * Common for ide. 20759 * 20760 * @syscap SystemCapability.ArkUI.ArkUI.Full 20761 * @form 20762 * @since 9 20763 */ 20764/** 20765 * Common for ide. 20766 * 20767 * @syscap SystemCapability.ArkUI.ArkUI.Full 20768 * @crossplatform 20769 * @form 20770 * @since 10 20771 */ 20772/** 20773 * Common for ide. 20774 * 20775 * @syscap SystemCapability.ArkUI.ArkUI.Full 20776 * @crossplatform 20777 * @form 20778 * @atomicservice 20779 * @since 11 20780 */ 20781declare const Common: CommonInterface; 20782 20783/** 20784 * Defines the CustomBuilder Type. 20785 * 20786 * @typedef { (() => any) | void } CustomBuilder 20787 * @syscap SystemCapability.ArkUI.ArkUI.Full 20788 * @since 8 20789 */ 20790/** 20791 * Defines the CustomBuilder Type. 20792 * 20793 * @typedef { (() => any) | void } CustomBuilder 20794 * @syscap SystemCapability.ArkUI.ArkUI.Full 20795 * @form 20796 * @since 9 20797 */ 20798/** 20799 * Defines the CustomBuilder Type. 20800 * 20801 * @typedef { (() => any) | void } CustomBuilder 20802 * @syscap SystemCapability.ArkUI.ArkUI.Full 20803 * @crossplatform 20804 * @form 20805 * @since 10 20806 */ 20807/** 20808 * Defines the CustomBuilder Type. 20809 * 20810 * @typedef { (() => any) | void } CustomBuilder 20811 * @syscap SystemCapability.ArkUI.ArkUI.Full 20812 * @crossplatform 20813 * @form 20814 * @atomicservice 20815 * @since 11 20816 */ 20817declare type CustomBuilder = (() => any) | void; 20818 20819/** 20820 * Defines the OverlayOptions interface. 20821 * 20822 * @typedef OverlayOptions 20823 * @syscap SystemCapability.ArkUI.ArkUI.Full 20824 * @crossplatform 20825 * @form 20826 * @atomicservice 20827 * @since 12 20828 */ 20829declare interface OverlayOptions { 20830 /** 20831 * Defines align type. 20832 * 20833 * @type { ?Alignment } 20834 * @syscap SystemCapability.ArkUI.ArkUI.Full 20835 * @since 7 20836 */ 20837 /** 20838 * Defines align type. 20839 * 20840 * @type { ?Alignment } 20841 * @syscap SystemCapability.ArkUI.ArkUI.Full 20842 * @form 20843 * @since 9 20844 */ 20845 /** 20846 * Defines align type. 20847 * 20848 * @type { ?Alignment } 20849 * @syscap SystemCapability.ArkUI.ArkUI.Full 20850 * @crossplatform 20851 * @form 20852 * @since 10 20853 */ 20854 /** 20855 * Defines align type. 20856 * 20857 * @type { ?Alignment } 20858 * @syscap SystemCapability.ArkUI.ArkUI.Full 20859 * @crossplatform 20860 * @form 20861 * @atomicservice 20862 * @since 11 20863 */ 20864 align?: Alignment; 20865 20866 /** 20867 * Defines offset type. 20868 * 20869 * @type { ?OverlayOffset } 20870 * @syscap SystemCapability.ArkUI.ArkUI.Full 20871 * @since 7 20872 */ 20873 /** 20874 * Defines offset type. 20875 * 20876 * @type { ?OverlayOffset } 20877 * @syscap SystemCapability.ArkUI.ArkUI.Full 20878 * @form 20879 * @since 9 20880 */ 20881 /** 20882 * Defines offset type. 20883 * 20884 * @type { ?OverlayOffset } 20885 * @syscap SystemCapability.ArkUI.ArkUI.Full 20886 * @crossplatform 20887 * @form 20888 * @since 10 20889 */ 20890 /** 20891 * Defines offset type. 20892 * 20893 * @type { ?OverlayOffset } 20894 * @syscap SystemCapability.ArkUI.ArkUI.Full 20895 * @crossplatform 20896 * @form 20897 * @atomicservice 20898 * @since 11 20899 */ 20900 offset?: OverlayOffset; 20901} 20902 20903/** 20904 * Defines the OverlayOffset. 20905 * 20906 * @typedef OverlayOffset 20907 * @syscap SystemCapability.ArkUI.ArkUI.Full 20908 * @crossplatform 20909 * @form 20910 * @atomicservice 20911 * @since 12 20912 */ 20913declare interface OverlayOffset { 20914 /** 20915 * Defines x. 20916 * 20917 * @type { ?number } 20918 * @syscap SystemCapability.ArkUI.ArkUI.Full 20919 * @since 7 20920 */ 20921 /** 20922 * Defines x. 20923 * 20924 * @type { ?number } 20925 * @syscap SystemCapability.ArkUI.ArkUI.Full 20926 * @form 20927 * @since 9 20928 */ 20929 /** 20930 * Defines x. 20931 * 20932 * @type { ?number } 20933 * @syscap SystemCapability.ArkUI.ArkUI.Full 20934 * @crossplatform 20935 * @form 20936 * @since 10 20937 */ 20938 /** 20939 * Defines x. 20940 * 20941 * @type { ?number } 20942 * @syscap SystemCapability.ArkUI.ArkUI.Full 20943 * @crossplatform 20944 * @form 20945 * @atomicservice 20946 * @since 11 20947 */ 20948 x?: number; 20949 /** 20950 * Defines y. 20951 * 20952 * @type { ?number } 20953 * @syscap SystemCapability.ArkUI.ArkUI.Full 20954 * @since 7 20955 */ 20956 /** 20957 * Defines y. 20958 * 20959 * @type { ?number } 20960 * @syscap SystemCapability.ArkUI.ArkUI.Full 20961 * @form 20962 * @since 9 20963 */ 20964 /** 20965 * Defines y. 20966 * 20967 * @type { ?number } 20968 * @syscap SystemCapability.ArkUI.ArkUI.Full 20969 * @crossplatform 20970 * @form 20971 * @since 10 20972 */ 20973 /** 20974 * Defines y. 20975 * 20976 * @type { ?number } 20977 * @syscap SystemCapability.ArkUI.ArkUI.Full 20978 * @crossplatform 20979 * @form 20980 * @atomicservice 20981 * @since 11 20982 */ 20983 y?: number; 20984} 20985 20986/** 20987 * Defines the segment of blur. 20988 * The first element in the tuple means fraction. 20989 * The range of this value is [0,1]. A value of 1 means opaque and 0 means completely transparent. 20990 * The second element means the stop position. 20991 * The range of this value is [0,1]. A value of 1 means region ending position and 0 means region starting position. 20992 * 20993 * @typedef { [ number, number ] } FractionStop 20994 * @syscap SystemCapability.ArkUI.ArkUI.Full 20995 * @atomicservice 20996 * @since 12 20997 */ 20998declare type FractionStop = [ number, number ]; 20999 21000/** 21001 * CommonShapeMethod 21002 * 21003 * @extends CommonMethod<T> 21004 * @syscap SystemCapability.ArkUI.ArkUI.Full 21005 * @since 7 21006 */ 21007/** 21008 * CommonShapeMethod 21009 * 21010 * @extends CommonMethod<T> 21011 * @syscap SystemCapability.ArkUI.ArkUI.Full 21012 * @form 21013 * @since 9 21014 */ 21015/** 21016 * CommonShapeMethod 21017 * 21018 * @extends CommonMethod<T> 21019 * @syscap SystemCapability.ArkUI.ArkUI.Full 21020 * @crossplatform 21021 * @form 21022 * @since 10 21023 */ 21024/** 21025 * CommonShapeMethod 21026 * 21027 * @extends CommonMethod<T> 21028 * @syscap SystemCapability.ArkUI.ArkUI.Full 21029 * @crossplatform 21030 * @form 21031 * @atomicservice 21032 * @since 11 21033 */ 21034declare class CommonShapeMethod<T> extends CommonMethod<T> { 21035 /** 21036 * constructor. 21037 * 21038 * @syscap SystemCapability.ArkUI.ArkUI.Full 21039 * @systemapi 21040 * @since 7 21041 */ 21042 /** 21043 * constructor. 21044 * 21045 * @syscap SystemCapability.ArkUI.ArkUI.Full 21046 * @systemapi 21047 * @form 21048 * @since 9 21049 */ 21050 constructor(); 21051 21052 /** 21053 * border Color 21054 * 21055 * @param { ResourceColor } value 21056 * @returns { T } 21057 * @syscap SystemCapability.ArkUI.ArkUI.Full 21058 * @since 7 21059 */ 21060 /** 21061 * border Color 21062 * 21063 * @param { ResourceColor } value 21064 * @returns { T } 21065 * @syscap SystemCapability.ArkUI.ArkUI.Full 21066 * @form 21067 * @since 9 21068 */ 21069 /** 21070 * border Color 21071 * 21072 * @param { ResourceColor } value 21073 * @returns { T } 21074 * @syscap SystemCapability.ArkUI.ArkUI.Full 21075 * @crossplatform 21076 * @form 21077 * @since 10 21078 */ 21079 /** 21080 * border Color 21081 * 21082 * @param { ResourceColor } value 21083 * @returns { T } 21084 * @syscap SystemCapability.ArkUI.ArkUI.Full 21085 * @crossplatform 21086 * @form 21087 * @atomicservice 21088 * @since 11 21089 */ 21090 stroke(value: ResourceColor): T; 21091 21092 /** 21093 * Fill color. 21094 * 21095 * @param { ResourceColor } value 21096 * @returns { T } 21097 * @syscap SystemCapability.ArkUI.ArkUI.Full 21098 * @since 7 21099 */ 21100 /** 21101 * Fill color. 21102 * 21103 * @param { ResourceColor } value 21104 * @returns { T } 21105 * @syscap SystemCapability.ArkUI.ArkUI.Full 21106 * @form 21107 * @since 9 21108 */ 21109 /** 21110 * Fill color. 21111 * 21112 * @param { ResourceColor } value 21113 * @returns { T } 21114 * @syscap SystemCapability.ArkUI.ArkUI.Full 21115 * @crossplatform 21116 * @form 21117 * @since 10 21118 */ 21119 /** 21120 * Fill color. 21121 * 21122 * @param { ResourceColor } value 21123 * @returns { T } 21124 * @syscap SystemCapability.ArkUI.ArkUI.Full 21125 * @crossplatform 21126 * @form 21127 * @atomicservice 21128 * @since 11 21129 */ 21130 fill(value: ResourceColor): T; 21131 21132 /** 21133 * Offset from the start point of the border drawing. 21134 * 21135 * @param { number | string } value 21136 * @returns { T } 21137 * @syscap SystemCapability.ArkUI.ArkUI.Full 21138 * @since 7 21139 */ 21140 /** 21141 * Offset from the start point of the border drawing. 21142 * 21143 * @param { number | string } value 21144 * @returns { T } 21145 * @syscap SystemCapability.ArkUI.ArkUI.Full 21146 * @form 21147 * @since 9 21148 */ 21149 /** 21150 * Offset from the start point of the border drawing. 21151 * 21152 * @param { number | string } value 21153 * @returns { T } 21154 * @syscap SystemCapability.ArkUI.ArkUI.Full 21155 * @crossplatform 21156 * @form 21157 * @since 10 21158 */ 21159 /** 21160 * Offset from the start point of the border drawing. 21161 * 21162 * @param { number | string } value 21163 * @returns { T } 21164 * @syscap SystemCapability.ArkUI.ArkUI.Full 21165 * @crossplatform 21166 * @form 21167 * @atomicservice 21168 * @since 11 21169 */ 21170 strokeDashOffset(value: number | string): T; 21171 21172 /** 21173 * Path endpoint drawing style. 21174 * 21175 * @param { LineCapStyle } value 21176 * @returns { T } 21177 * @syscap SystemCapability.ArkUI.ArkUI.Full 21178 * @since 7 21179 */ 21180 /** 21181 * Path endpoint drawing style. 21182 * 21183 * @param { LineCapStyle } value 21184 * @returns { T } 21185 * @syscap SystemCapability.ArkUI.ArkUI.Full 21186 * @form 21187 * @since 9 21188 */ 21189 /** 21190 * Path endpoint drawing style. 21191 * 21192 * @param { LineCapStyle } value 21193 * @returns { T } 21194 * @syscap SystemCapability.ArkUI.ArkUI.Full 21195 * @crossplatform 21196 * @form 21197 * @since 10 21198 */ 21199 /** 21200 * Path endpoint drawing style. 21201 * 21202 * @param { LineCapStyle } value 21203 * @returns { T } 21204 * @syscap SystemCapability.ArkUI.ArkUI.Full 21205 * @crossplatform 21206 * @form 21207 * @atomicservice 21208 * @since 11 21209 */ 21210 strokeLineCap(value: LineCapStyle): T; 21211 21212 /** 21213 * Border corner drawing style. 21214 * 21215 * @param { LineJoinStyle } value 21216 * @returns { T } 21217 * @syscap SystemCapability.ArkUI.ArkUI.Full 21218 * @since 7 21219 */ 21220 /** 21221 * Border corner drawing style. 21222 * 21223 * @param { LineJoinStyle } value 21224 * @returns { T } 21225 * @syscap SystemCapability.ArkUI.ArkUI.Full 21226 * @form 21227 * @since 9 21228 */ 21229 /** 21230 * Border corner drawing style. 21231 * 21232 * @param { LineJoinStyle } value 21233 * @returns { T } 21234 * @syscap SystemCapability.ArkUI.ArkUI.Full 21235 * @crossplatform 21236 * @form 21237 * @since 10 21238 */ 21239 /** 21240 * Border corner drawing style. 21241 * 21242 * @param { LineJoinStyle } value 21243 * @returns { T } 21244 * @syscap SystemCapability.ArkUI.ArkUI.Full 21245 * @crossplatform 21246 * @form 21247 * @atomicservice 21248 * @since 11 21249 */ 21250 strokeLineJoin(value: LineJoinStyle): T; 21251 21252 /** 21253 * Limits for drawing acute angles as bevels 21254 * 21255 * @param { number | string } value 21256 * @returns { T } 21257 * @syscap SystemCapability.ArkUI.ArkUI.Full 21258 * @since 7 21259 */ 21260 /** 21261 * Limits for drawing acute angles as bevels 21262 * 21263 * @param { number | string } value 21264 * @returns { T } 21265 * @syscap SystemCapability.ArkUI.ArkUI.Full 21266 * @form 21267 * @since 9 21268 */ 21269 /** 21270 * Limits for drawing acute angles as bevels 21271 * 21272 * @param { number | string } value 21273 * @returns { T } 21274 * @syscap SystemCapability.ArkUI.ArkUI.Full 21275 * @crossplatform 21276 * @form 21277 * @since 10 21278 */ 21279 /** 21280 * Limits for drawing acute angles as bevels 21281 * 21282 * @param { number | string } value 21283 * @returns { T } 21284 * @syscap SystemCapability.ArkUI.ArkUI.Full 21285 * @crossplatform 21286 * @form 21287 * @atomicservice 21288 * @since 11 21289 */ 21290 strokeMiterLimit(value: number | string): T; 21291 21292 /** 21293 * Sets the opacity of the border. 21294 * 21295 * @param { number | string | Resource } value 21296 * @returns { T } 21297 * @syscap SystemCapability.ArkUI.ArkUI.Full 21298 * @since 7 21299 */ 21300 /** 21301 * Sets the opacity of the border. 21302 * 21303 * @param { number | string | Resource } value 21304 * @returns { T } 21305 * @syscap SystemCapability.ArkUI.ArkUI.Full 21306 * @form 21307 * @since 9 21308 */ 21309 /** 21310 * Sets the opacity of the border. 21311 * 21312 * @param { number | string | Resource } value 21313 * @returns { T } 21314 * @syscap SystemCapability.ArkUI.ArkUI.Full 21315 * @crossplatform 21316 * @form 21317 * @since 10 21318 */ 21319 /** 21320 * Sets the opacity of the border. 21321 * 21322 * @param { number | string | Resource } value 21323 * @returns { T } 21324 * @syscap SystemCapability.ArkUI.ArkUI.Full 21325 * @crossplatform 21326 * @form 21327 * @atomicservice 21328 * @since 11 21329 */ 21330 strokeOpacity(value: number | string | Resource): T; 21331 21332 /** 21333 * fill Opacity 21334 * 21335 * @param { number | string | Resource } value 21336 * @returns { T } 21337 * @syscap SystemCapability.ArkUI.ArkUI.Full 21338 * @since 7 21339 */ 21340 /** 21341 * fill Opacity 21342 * 21343 * @param { number | string | Resource } value 21344 * @returns { T } 21345 * @syscap SystemCapability.ArkUI.ArkUI.Full 21346 * @form 21347 * @since 9 21348 */ 21349 /** 21350 * fill Opacity 21351 * 21352 * @param { number | string | Resource } value 21353 * @returns { T } 21354 * @syscap SystemCapability.ArkUI.ArkUI.Full 21355 * @crossplatform 21356 * @form 21357 * @since 10 21358 */ 21359 /** 21360 * fill Opacity 21361 * 21362 * @param { number | string | Resource } value 21363 * @returns { T } 21364 * @syscap SystemCapability.ArkUI.ArkUI.Full 21365 * @crossplatform 21366 * @form 21367 * @atomicservice 21368 * @since 11 21369 */ 21370 fillOpacity(value: number | string | Resource): T; 21371 21372 /** 21373 * Sets the width of the dividing line. 21374 * 21375 * @param { Length } value 21376 * @returns { T } 21377 * @syscap SystemCapability.ArkUI.ArkUI.Full 21378 * @since 7 21379 */ 21380 /** 21381 * Sets the width of the dividing line. 21382 * 21383 * @param { Length } value 21384 * @returns { T } 21385 * @syscap SystemCapability.ArkUI.ArkUI.Full 21386 * @form 21387 * @since 9 21388 */ 21389 /** 21390 * Sets the width of the dividing line. 21391 * 21392 * @param { Length } value 21393 * @returns { T } 21394 * @syscap SystemCapability.ArkUI.ArkUI.Full 21395 * @crossplatform 21396 * @form 21397 * @since 10 21398 */ 21399 /** 21400 * Sets the width of the dividing line. 21401 * 21402 * @param { Length } value 21403 * @returns { T } 21404 * @syscap SystemCapability.ArkUI.ArkUI.Full 21405 * @crossplatform 21406 * @form 21407 * @atomicservice 21408 * @since 11 21409 */ 21410 strokeWidth(value: Length): T; 21411 21412 /** 21413 * Indicates whether to enable anti-aliasing 21414 * 21415 * @param { boolean } value 21416 * @returns { T } 21417 * @syscap SystemCapability.ArkUI.ArkUI.Full 21418 * @since 7 21419 */ 21420 /** 21421 * Indicates whether to enable anti-aliasing 21422 * 21423 * @param { boolean } value 21424 * @returns { T } 21425 * @syscap SystemCapability.ArkUI.ArkUI.Full 21426 * @form 21427 * @since 9 21428 */ 21429 /** 21430 * Indicates whether to enable anti-aliasing 21431 * 21432 * @param { boolean } value 21433 * @returns { T } 21434 * @syscap SystemCapability.ArkUI.ArkUI.Full 21435 * @crossplatform 21436 * @form 21437 * @since 10 21438 */ 21439 /** 21440 * Indicates whether to enable anti-aliasing 21441 * 21442 * @param { boolean } value 21443 * @returns { T } 21444 * @syscap SystemCapability.ArkUI.ArkUI.Full 21445 * @crossplatform 21446 * @form 21447 * @atomicservice 21448 * @since 11 21449 */ 21450 antiAlias(value: boolean): T; 21451 21452 /** 21453 * Sets the gap for the border. 21454 * 21455 * @param { Array<any> } value 21456 * @returns { T } 21457 * @syscap SystemCapability.ArkUI.ArkUI.Full 21458 * @since 7 21459 */ 21460 /** 21461 * Sets the gap for the border. 21462 * 21463 * @param { Array<any> } value 21464 * @returns { T } 21465 * @syscap SystemCapability.ArkUI.ArkUI.Full 21466 * @form 21467 * @since 9 21468 */ 21469 /** 21470 * Sets the gap for the border. 21471 * 21472 * @param { Array<any> } value 21473 * @returns { T } 21474 * @syscap SystemCapability.ArkUI.ArkUI.Full 21475 * @crossplatform 21476 * @form 21477 * @since 10 21478 */ 21479 /** 21480 * Sets the gap for the border. 21481 * 21482 * @param { Array<any> } value 21483 * @returns { T } 21484 * @syscap SystemCapability.ArkUI.ArkUI.Full 21485 * @crossplatform 21486 * @form 21487 * @atomicservice 21488 * @since 11 21489 */ 21490 strokeDashArray(value: Array<any>): T; 21491} 21492 21493/** 21494 * Linear Gradient Interface 21495 * 21496 * @interface LinearGradient 21497 * @syscap SystemCapability.ArkUI.ArkUI.Full 21498 * @since 9 21499 */ 21500/** 21501 * Linear Gradient Interface 21502 * 21503 * @interface LinearGradient 21504 * @syscap SystemCapability.ArkUI.ArkUI.Full 21505 * @crossplatform 21506 * @since 10 21507 */ 21508/** 21509 * Linear Gradient Interface 21510 * 21511 * @interface LinearGradient 21512 * @syscap SystemCapability.ArkUI.ArkUI.Full 21513 * @crossplatform 21514 * @atomicservice 21515 * @since 11 21516 */ 21517declare interface LinearGradient { 21518 /** 21519 * Linear Gradient Angle 21520 * 21521 * @type { ?(number | string) } 21522 * @syscap SystemCapability.ArkUI.ArkUI.Full 21523 * @since 9 21524 */ 21525 /** 21526 * Linear Gradient Angle 21527 * 21528 * @type { ?(number | string) } 21529 * @syscap SystemCapability.ArkUI.ArkUI.Full 21530 * @crossplatform 21531 * @since 10 21532 */ 21533 /** 21534 * Linear Gradient Angle 21535 * 21536 * @type { ?(number | string) } 21537 * @syscap SystemCapability.ArkUI.ArkUI.Full 21538 * @crossplatform 21539 * @atomicservice 21540 * @since 11 21541 */ 21542 angle?: number | string; 21543 /** 21544 * Linear Gradient Direction 21545 * 21546 * @type { ?GradientDirection } 21547 * @syscap SystemCapability.ArkUI.ArkUI.Full 21548 * @since 9 21549 */ 21550 /** 21551 * Linear Gradient Direction 21552 * 21553 * @type { ?GradientDirection } 21554 * @syscap SystemCapability.ArkUI.ArkUI.Full 21555 * @crossplatform 21556 * @since 10 21557 */ 21558 /** 21559 * Linear Gradient Direction 21560 * 21561 * @type { ?GradientDirection } 21562 * @syscap SystemCapability.ArkUI.ArkUI.Full 21563 * @crossplatform 21564 * @atomicservice 21565 * @since 11 21566 */ 21567 direction?: GradientDirection; 21568 /** 21569 * Linear Gradient Colors 21570 * 21571 * @type { Array<any> } 21572 * @syscap SystemCapability.ArkUI.ArkUI.Full 21573 * @since 9 21574 */ 21575 /** 21576 * Linear Gradient Colors 21577 * 21578 * @type { Array<any> } 21579 * @syscap SystemCapability.ArkUI.ArkUI.Full 21580 * @crossplatform 21581 * @since 10 21582 */ 21583 /** 21584 * Linear Gradient Colors 21585 * 21586 * @type { Array<any> } 21587 * @syscap SystemCapability.ArkUI.ArkUI.Full 21588 * @crossplatform 21589 * @atomicservice 21590 * @since 11 21591 */ 21592 /** 21593 * Linear Gradient Colors 21594 * 21595 * @type { Array<[ResourceColor, number]> } 21596 * @syscap SystemCapability.ArkUI.ArkUI.Full 21597 * @crossplatform 21598 * @atomicservice 21599 * @since 12 21600 */ 21601 colors: Array<[ResourceColor, number]>; 21602 /** 21603 * Linear Gradient Repeating 21604 * 21605 * @type { ?boolean } 21606 * @syscap SystemCapability.ArkUI.ArkUI.Full 21607 * @since 9 21608 */ 21609 /** 21610 * Linear Gradient Repeating 21611 * 21612 * @type { ?boolean } 21613 * @syscap SystemCapability.ArkUI.ArkUI.Full 21614 * @crossplatform 21615 * @since 10 21616 */ 21617 /** 21618 * Linear Gradient Repeating 21619 * 21620 * @type { ?boolean } 21621 * @syscap SystemCapability.ArkUI.ArkUI.Full 21622 * @crossplatform 21623 * @atomicservice 21624 * @since 11 21625 */ 21626 repeating?: boolean; 21627} 21628 21629/** 21630 * Defines the pixel round property. 21631 * 21632 * @interface PixelRoundPolicy 21633 * @syscap SystemCapability.ArkUI.ArkUI.Full 21634 * @crossplatform 21635 * @form 21636 * @atomicservice 21637 * @since 11 21638 */ 21639declare interface PixelRoundPolicy { 21640 /** 21641 * start property. 21642 * 21643 * @type { ?PixelRoundCalcPolicy } 21644 * @default PixelRoundCalcPolicy.NO_FORCE_ROUND 21645 * @syscap SystemCapability.ArkUI.ArkUI.Full 21646 * @crossplatform 21647 * @form 21648 * @atomicservice 21649 * @since 11 21650 */ 21651 start?: PixelRoundCalcPolicy; 21652 21653 /** 21654 * top property. 21655 * 21656 * @type { ?PixelRoundCalcPolicy } 21657 * @default PixelRoundCalcPolicy.NO_FORCE_ROUND 21658 * @syscap SystemCapability.ArkUI.ArkUI.Full 21659 * @crossplatform 21660 * @form 21661 * @atomicservice 21662 * @since 11 21663 */ 21664 top?: PixelRoundCalcPolicy; 21665 21666 /** 21667 * end property. 21668 * 21669 * @type { ?PixelRoundCalcPolicy } 21670 * @default PixelRoundCalcPolicy.NO_FORCE_ROUND 21671 * @syscap SystemCapability.ArkUI.ArkUI.Full 21672 * @crossplatform 21673 * @form 21674 * @atomicservice 21675 * @since 11 21676 */ 21677 end?: PixelRoundCalcPolicy; 21678 21679 /** 21680 * bottom property. 21681 * 21682 * @type { ?PixelRoundCalcPolicy } 21683 * @default PixelRoundCalcPolicy.NO_FORCE_ROUND 21684 * @syscap SystemCapability.ArkUI.ArkUI.Full 21685 * @crossplatform 21686 * @form 21687 * @atomicservice 21688 * @since 11 21689 */ 21690 bottom?: PixelRoundCalcPolicy; 21691} 21692 21693/** 21694 * Linear Gradient Blur Interface 21695 * 21696 * @interface LinearGradientBlurOptions 21697 * @syscap SystemCapability.ArkUI.ArkUI.Full 21698 * @atomicservice 21699 * @since 12 21700 */ 21701declare interface LinearGradientBlurOptions { 21702 /** 21703 * Percentage of blurring effect. 21704 * 21705 * @type { FractionStop[] } 21706 * @syscap SystemCapability.ArkUI.ArkUI.Full 21707 * @atomicservice 21708 * @since 12 21709 */ 21710 fractionStops: FractionStop[]; 21711 /** 21712 * Direction of linear gradient blur. 21713 * 21714 * @type { GradientDirection } 21715 * @syscap SystemCapability.ArkUI.ArkUI.Full 21716 * @atomicservice 21717 * @since 12 21718 */ 21719 direction: GradientDirection; 21720} 21721 21722/** 21723 * Define motion blur anchor coordinates. 21724 * 21725 * @interface MotionBlurAnchor 21726 * @syscap SystemCapability.ArkUI.ArkUI.Full 21727 * @crossplatform 21728 * @atomicservice 21729 * @since 12 21730 */ 21731declare interface MotionBlurAnchor { 21732 /** 21733 * Define anchor coordinate x-value.Value range [0.0, 1.0]. 21734 * 21735 * @type { number } 21736 * @syscap SystemCapability.ArkUI.ArkUI.Full 21737 * @atomicservice 21738 * @since 12 21739 */ 21740 x: number; 21741 /** 21742 * Define anchor coordinate y-value.Value range [0.0, 1.0]. 21743 * 21744 * @type { number } 21745 * @syscap SystemCapability.ArkUI.ArkUI.Full 21746 * @atomicservice 21747 * @since 12 21748 */ 21749 y: number; 21750} 21751 21752/** 21753 * Define motion blur options. 21754 * 21755 * @interface MotionBlurOptions 21756 * @syscap SystemCapability.ArkUI.ArkUI.Full 21757 * @crossplatform 21758 * @atomicservice 21759 * @since 12 21760 */ 21761declare interface MotionBlurOptions { 21762 /** 21763 * Define the size of motion blur radius.The range of this value is [0.0, ∞). 21764 * 21765 * @type { number } 21766 * @syscap SystemCapability.ArkUI.ArkUI.Full 21767 * @atomicservice 21768 * @since 12 21769 */ 21770 radius: number; 21771 /** 21772 * Define motion blur anchor coordinates. 21773 * 21774 * @type { MotionBlurAnchor } 21775 * @syscap SystemCapability.ArkUI.ArkUI.Full 21776 * @atomicservice 21777 * @since 12 21778 */ 21779 anchor: MotionBlurAnchor; 21780} 21781 21782/** 21783 * Sub component border info. 21784 * 21785 * @interface LayoutBorderInfo 21786 * @syscap SystemCapability.ArkUI.ArkUI.Full 21787 * @form 21788 * @since 9 21789 * @deprecated since 10 21790 */ 21791declare interface LayoutBorderInfo { 21792 /** 21793 * Sub component borderWidth info. 21794 * 21795 * @type { EdgeWidths } 21796 * @syscap SystemCapability.ArkUI.ArkUI.Full 21797 * @form 21798 * @since 9 21799 * @deprecated since 10 21800 */ 21801 borderWidth: EdgeWidths; 21802 21803 /** 21804 * Sub component margin info. 21805 * 21806 * @type { Margin } 21807 * @syscap SystemCapability.ArkUI.ArkUI.Full 21808 * @form 21809 * @since 9 21810 * @deprecated since 10 21811 */ 21812 margin: Margin, 21813 21814 /** 21815 * Sub component padding info. 21816 * 21817 * @type { Padding } 21818 * @syscap SystemCapability.ArkUI.ArkUI.Full 21819 * @form 21820 * @since 9 21821 * @deprecated since 10 21822 */ 21823 padding: Padding, 21824} 21825 21826/** 21827 * Sub component layout info. 21828 * 21829 * @interface LayoutInfo 21830 * @syscap SystemCapability.ArkUI.ArkUI.Full 21831 * @form 21832 * @since 9 21833 * @deprecated since 10 21834 */ 21835declare interface LayoutInfo { 21836 /** 21837 * Sub component position info. 21838 * 21839 * @type { Position } 21840 * @syscap SystemCapability.ArkUI.ArkUI.Full 21841 * @form 21842 * @since 9 21843 * @deprecated since 10 21844 */ 21845 position: Position, 21846 21847 /** 21848 * Sub component constraint info. 21849 * 21850 * @type { ConstraintSizeOptions } 21851 * @syscap SystemCapability.ArkUI.ArkUI.Full 21852 * @form 21853 * @since 9 21854 * @deprecated since 10 21855 */ 21856 constraint: ConstraintSizeOptions, 21857} 21858 21859/** 21860 * Sub component info passed from framework when layout and measure happens. 21861 * 21862 * @interface LayoutChild 21863 * @syscap SystemCapability.ArkUI.ArkUI.Full 21864 * @form 21865 * @since 9 21866 * @deprecated since 10 21867 */ 21868declare interface LayoutChild { 21869 /** 21870 * Sub component name. 21871 * 21872 * @type { string } 21873 * @syscap SystemCapability.ArkUI.ArkUI.Full 21874 * @form 21875 * @since 9 21876 * @deprecated since 10 21877 */ 21878 name: string, 21879 21880 /** 21881 * Sub component id. 21882 * 21883 * @type { string } 21884 * @syscap SystemCapability.ArkUI.ArkUI.Full 21885 * @form 21886 * @since 9 21887 * @deprecated since 10 21888 */ 21889 id: string, 21890 21891 /** 21892 * Sub component constraint. 21893 * 21894 * @type { ConstraintSizeOptions } 21895 * @syscap SystemCapability.ArkUI.ArkUI.Full 21896 * @form 21897 * @since 9 21898 * @deprecated since 10 21899 */ 21900 constraint: ConstraintSizeOptions, 21901 21902 /** 21903 * Sub component border info. 21904 * 21905 * @type { LayoutBorderInfo } 21906 * @syscap SystemCapability.ArkUI.ArkUI.Full 21907 * @form 21908 * @since 9 21909 * @deprecated since 10 21910 */ 21911 borderInfo: LayoutBorderInfo, 21912 21913 /** 21914 * Sub component position. 21915 * 21916 * @type { Position } 21917 * @syscap SystemCapability.ArkUI.ArkUI.Full 21918 * @form 21919 * @since 9 21920 * @deprecated since 10 21921 */ 21922 position: Position, 21923 21924 /** 21925 * Call this measure method in onMeasure callback to supply sub component size. 21926 * 21927 * @param { ConstraintSizeOptions } childConstraint 21928 * @syscap SystemCapability.ArkUI.ArkUI.Full 21929 * @form 21930 * @since 9 21931 * @deprecated since 10 21932 */ 21933 measure(childConstraint: ConstraintSizeOptions), 21934 21935 /** 21936 * Call this layout method in onLayout callback to assign layout info to sub component. 21937 * 21938 * @param { LayoutInfo } childLayoutInfo 21939 * @syscap SystemCapability.ArkUI.ArkUI.Full 21940 * @form 21941 * @since 9 21942 * @deprecated since 10 21943 */ 21944 layout(childLayoutInfo: LayoutInfo), 21945} 21946 21947/** 21948 * Sub component layout info. 21949 * 21950 * @interface GeometryInfo 21951 * @syscap SystemCapability.ArkUI.ArkUI.Full 21952 * @crossplatform 21953 * @since 10 21954 */ 21955/** 21956 * Sub component layout info. 21957 * 21958 * @interface GeometryInfo 21959 * @syscap SystemCapability.ArkUI.ArkUI.Full 21960 * @crossplatform 21961 * @atomicservice 21962 * @since 11 21963 */ 21964declare interface GeometryInfo extends SizeResult { 21965 /** 21966 * Sub component borderWidth info. 21967 * 21968 * @type { EdgeWidth } 21969 * @syscap SystemCapability.ArkUI.ArkUI.Full 21970 * @crossplatform 21971 * @since 10 21972 */ 21973 /** 21974 * Sub component borderWidth info. 21975 * 21976 * @type { EdgeWidth } 21977 * @syscap SystemCapability.ArkUI.ArkUI.Full 21978 * @crossplatform 21979 * @atomicservice 21980 * @since 11 21981 */ 21982 borderWidth: EdgeWidth; 21983 21984 /** 21985 * Sub component margin info. 21986 * 21987 * @type { Margin } 21988 * @syscap SystemCapability.ArkUI.ArkUI.Full 21989 * @crossplatform 21990 * @since 10 21991 */ 21992 /** 21993 * Sub component margin info. 21994 * 21995 * @type { Margin } 21996 * @syscap SystemCapability.ArkUI.ArkUI.Full 21997 * @crossplatform 21998 * @atomicservice 21999 * @since 11 22000 */ 22001 margin: Margin, 22002 22003 /** 22004 * Sub component padding info. 22005 * 22006 * @type { Padding } 22007 * @syscap SystemCapability.ArkUI.ArkUI.Full 22008 * @crossplatform 22009 * @since 10 22010 */ 22011 /** 22012 * Sub component padding info. 22013 * 22014 * @type { Padding } 22015 * @syscap SystemCapability.ArkUI.ArkUI.Full 22016 * @crossplatform 22017 * @atomicservice 22018 * @since 11 22019 */ 22020 padding: Padding, 22021} 22022 22023/** 22024 * Sub component info passed from framework when layout happens. 22025 * 22026 * @interface Layoutable 22027 * @syscap SystemCapability.ArkUI.ArkUI.Full 22028 * @crossplatform 22029 * @since 10 22030 */ 22031/** 22032 * Sub component info passed from framework when layout happens. 22033 * 22034 * @interface Layoutable 22035 * @syscap SystemCapability.ArkUI.ArkUI.Full 22036 * @crossplatform 22037 * @atomicservice 22038 * @since 11 22039 */ 22040declare interface Layoutable { 22041 /** 22042 * Measurement result of the child component. 22043 * 22044 * @type { MeasureResult } 22045 * @syscap SystemCapability.ArkUI.ArkUI.Full 22046 * @crossplatform 22047 * @since 10 22048 */ 22049 /** 22050 * Measurement result of the child component. 22051 * 22052 * @type { MeasureResult } 22053 * @syscap SystemCapability.ArkUI.ArkUI.Full 22054 * @crossplatform 22055 * @atomicservice 22056 * @since 11 22057 */ 22058 measureResult: MeasureResult, 22059 22060 /** 22061 * Call this layout method in onLayout callback to assign layout info to sub component. 22062 * 22063 * @param { Position } position 22064 * @syscap SystemCapability.ArkUI.ArkUI.Full 22065 * @crossplatform 22066 * @since 10 22067 */ 22068 /** 22069 * Call this layout method in onLayout callback to assign layout info to sub component. 22070 * 22071 * @param { Position } position 22072 * @syscap SystemCapability.ArkUI.ArkUI.Full 22073 * @crossplatform 22074 * @atomicservice 22075 * @since 11 22076 */ 22077 layout(position: Position): void, 22078 22079 /** 22080 * Call this method to get the margin of sub component. 22081 * 22082 * @returns { DirectionalEdgesT<number> } the margin of sub component, unit is vp 22083 * @syscap SystemCapability.ArkUI.ArkUI.Full 22084 * @crossplatform 22085 * @atomicservice 22086 * @since 12 22087 */ 22088 getMargin() : DirectionalEdgesT<number>, 22089 22090 /** 22091 * Call this method to get the padding of sub component. 22092 * 22093 * @returns { DirectionalEdgesT<number> } the padding of sub component, unit is vp 22094 * @syscap SystemCapability.ArkUI.ArkUI.Full 22095 * @crossplatform 22096 * @atomicservice 22097 * @since 12 22098 */ 22099 getPadding() : DirectionalEdgesT<number>, 22100 22101 /** 22102 * Call this method to get the borderWidth of sub component. 22103 * 22104 * @returns { DirectionalEdgesT<number> } the borderWidth of sub component, unit is vp 22105 * @syscap SystemCapability.ArkUI.ArkUI.Full 22106 * @crossplatform 22107 * @atomicservice 22108 * @since 12 22109 */ 22110 getBorderWidth() : DirectionalEdgesT<number>, 22111} 22112 22113/** 22114 * Sub component info passed from framework when measure happens. 22115 * 22116 * @interface Measurable 22117 * @syscap SystemCapability.ArkUI.ArkUI.Full 22118 * @crossplatform 22119 * @since 10 22120 */ 22121/** 22122 * Sub component info passed from framework when measure happens. 22123 * 22124 * @interface Measurable 22125 * @syscap SystemCapability.ArkUI.ArkUI.Full 22126 * @crossplatform 22127 * @atomicservice 22128 * @since 11 22129 */ 22130declare interface Measurable { 22131 /** 22132 * Call this measure method in onMeasure callback to supply sub component size. 22133 * 22134 * @param { ConstraintSizeOptions } constraint 22135 * @returns { MeasureResult } 22136 * @syscap SystemCapability.ArkUI.ArkUI.Full 22137 * @crossplatform 22138 * @since 10 22139 */ 22140 /** 22141 * Call this measure method in onMeasure callback to supply sub component size. 22142 * 22143 * @param { ConstraintSizeOptions } constraint 22144 * @returns { MeasureResult } 22145 * @syscap SystemCapability.ArkUI.ArkUI.Full 22146 * @crossplatform 22147 * @atomicservice 22148 * @since 11 22149 */ 22150 measure(constraint: ConstraintSizeOptions) : MeasureResult, 22151 22152 /** 22153 * Call this method to get the margin of sub component. 22154 * 22155 * @returns { DirectionalEdgesT<number> } the margin of sub component, unit is vp 22156 * @syscap SystemCapability.ArkUI.ArkUI.Full 22157 * @crossplatform 22158 * @atomicservice 22159 * @since 12 22160 */ 22161 getMargin() : DirectionalEdgesT<number>, 22162 22163 /** 22164 * Call this method to get the padding of sub component. 22165 * 22166 * @returns { DirectionalEdgesT<number> } the padding of sub component, unit is vp 22167 * @syscap SystemCapability.ArkUI.ArkUI.Full 22168 * @crossplatform 22169 * @atomicservice 22170 * @since 12 22171 */ 22172 getPadding() : DirectionalEdgesT<number>, 22173 22174 /** 22175 * Call this method to get the borderWidth of sub component. 22176 * 22177 * @returns { DirectionalEdgesT<number> } the borderWidth of sub component, unit is vp 22178 * @syscap SystemCapability.ArkUI.ArkUI.Full 22179 * @crossplatform 22180 * @atomicservice 22181 * @since 12 22182 */ 22183 getBorderWidth() : DirectionalEdgesT<number>, 22184} 22185 22186/** 22187 * Sub component SizeResult info. 22188 * 22189 * @interface SizeResult 22190 * @syscap SystemCapability.ArkUI.ArkUI.Full 22191 * @crossplatform 22192 * @since 10 22193 */ 22194/** 22195 * Sub component SizeResult info. 22196 * 22197 * @interface SizeResult 22198 * @syscap SystemCapability.ArkUI.ArkUI.Full 22199 * @crossplatform 22200 * @atomicservice 22201 * @since 11 22202 */ 22203declare interface SizeResult { 22204 /** 22205 * Width obtained from the measurement result. 22206 * 22207 * @type { number } 22208 * @syscap SystemCapability.ArkUI.ArkUI.Full 22209 * @crossplatform 22210 * @since 10 22211 */ 22212 /** 22213 * Width obtained from the measurement result. 22214 * 22215 * @type { number } 22216 * @syscap SystemCapability.ArkUI.ArkUI.Full 22217 * @crossplatform 22218 * @atomicservice 22219 * @since 11 22220 */ 22221 width: number, 22222 22223 /** 22224 * Height obtained from the measurement result. 22225 * 22226 * @type { number } 22227 * @syscap SystemCapability.ArkUI.ArkUI.Full 22228 * @crossplatform 22229 * @since 10 22230 */ 22231 /** 22232 * Height obtained from the measurement result. 22233 * 22234 * @type { number } 22235 * @syscap SystemCapability.ArkUI.ArkUI.Full 22236 * @crossplatform 22237 * @atomicservice 22238 * @since 11 22239 */ 22240 height: number, 22241} 22242 22243/** 22244 * Sub component MeasureResult info. 22245 * 22246 * @interface MeasureResult 22247 * @syscap SystemCapability.ArkUI.ArkUI.Full 22248 * @crossplatform 22249 * @since 10 22250 */ 22251/** 22252 * Sub component MeasureResult info. 22253 * 22254 * @interface MeasureResult 22255 * @syscap SystemCapability.ArkUI.ArkUI.Full 22256 * @crossplatform 22257 * @atomicservice 22258 * @since 11 22259 */ 22260declare interface MeasureResult extends SizeResult { 22261 22262} 22263 22264/** 22265 * The navigation destination information. 22266 * 22267 * @syscap SystemCapability.ArkUI.ArkUI.Full 22268 * @crossplatform 22269 * @since 11 22270 */ 22271/** 22272 * The navigation destination information. 22273 * 22274 * @typedef {import('../api/@ohos.arkui.observer').default.NavDestinationInfo} NavDestinationInfo 22275 * @syscap SystemCapability.ArkUI.ArkUI.Full 22276 * @crossplatform 22277 * @atomicservice 22278 * @since 12 22279 */ 22280declare type NavDestinationInfo = import('../api/@ohos.arkui.observer').default.NavDestinationInfo; 22281 22282/** 22283 * The navigation information. 22284 * 22285 * @typedef {import('../api/@ohos.arkui.observer').default.NavigationInfo} NavigationInfo 22286 * @syscap SystemCapability.ArkUI.ArkUI.Full 22287 * @crossplatform 22288 * @atomicservice 22289 * @since 12 22290 */ 22291declare type NavigationInfo = import('../api/@ohos.arkui.observer').default.NavigationInfo; 22292 22293/** 22294 * The router page information. 22295 * 22296 * @typedef {import('../api/@ohos.arkui.observer').default.RouterPageInfo} RouterPageInfo 22297 * @syscap SystemCapability.ArkUI.ArkUI.Full 22298 * @crossplatform 22299 * @atomicservice 22300 * @since 12 22301 */ 22302declare type RouterPageInfo = import('../api/@ohos.arkui.observer').default.RouterPageInfo; 22303 22304/** 22305 * UIContext 22306 * 22307 * @syscap SystemCapability.ArkUI.ArkUI.Full 22308 * @crossplatform 22309 * @since 11 22310 */ 22311/** 22312 * UIContext 22313 * 22314 * @typedef { import('../api/@ohos.arkui.UIContext').UIContext } UIContext 22315 * @syscap SystemCapability.ArkUI.ArkUI.Full 22316 * @crossplatform 22317 * @atomicservice 22318 * @since 12 22319 */ 22320declare type UIContext = import('../api/@ohos.arkui.UIContext').UIContext; 22321 22322/** 22323 * DrawContext 22324 * 22325 * @typedef { import('../api/arkui/Graphics').DrawContext } DrawContext 22326 * @syscap SystemCapability.ArkUI.ArkUI.Full 22327 * @crossplatform 22328 * @atomicservice 22329 * @since 12 22330 */ 22331declare type DrawContext = import('../api/arkui/Graphics').DrawContext; 22332 22333/** 22334 * VisualEffect 22335 * 22336 * @typedef { import('../api/@ohos.graphics.uiEffect').default.VisualEffect } VisualEffect 22337 * @syscap SystemCapability.ArkUI.ArkUI.Full 22338 * @crossplatform 22339 * @atomicservice 22340 * @since 12 22341 */ 22342declare type VisualEffect = import('../api/@ohos.graphics.uiEffect').default.VisualEffect; 22343 22344 22345/** 22346 * Filter 22347 * 22348 * @typedef { import('../api/@ohos.graphics.uiEffect').default.Filter } Filter 22349 * @syscap SystemCapability.ArkUI.ArkUI.Full 22350 * @crossplatform 22351 * @atomicservice 22352 * @since 12 22353 */ 22354declare type Filter = import('../api/@ohos.graphics.uiEffect').default.Filter; 22355 22356/** 22357 * Blender 22358 * 22359 * @typedef { import('../api/@ohos.graphics.uiEffect').default.Blender } Blender 22360 * @syscap SystemCapability.ArkUI.ArkUI.Full 22361 * @systemapi 22362 * @form 22363 * @since 13 22364 */ 22365declare type Blender = import('../api/@ohos.graphics.uiEffect').default.Blender; 22366 22367/** 22368 * ComponentContent. 22369 * 22370 * @typedef {import('../api/arkui/ComponentContent').ComponentContent<T>} ComponentContent<T = Object> 22371 * @syscap SystemCapability.ArkUI.ArkUI.Full 22372 * @crossplatform 22373 * @atomicservice 22374 * @since 12 22375 */ 22376declare type ComponentContent<T = Object> = import('../api/arkui/ComponentContent').ComponentContent<T>; 22377 22378/** 22379 * Theme. 22380 * 22381 * @typedef {import('../api/@ohos.arkui.theme').Theme} Theme 22382 * @syscap SystemCapability.ArkUI.ArkUI.Full 22383 * @crossplatform 22384 * @atomicservice 22385 * @since 12 22386 */ 22387declare type Theme = import('../api/@ohos.arkui.theme').Theme; 22388 22389/** 22390 * Custom Component 22391 * 22392 * @extends CommonAttribute 22393 * @syscap SystemCapability.ArkUI.ArkUI.Full 22394 * @since 7 22395 */ 22396/** 22397 * Custom Component 22398 * 22399 * @extends CommonAttribute 22400 * @syscap SystemCapability.ArkUI.ArkUI.Full 22401 * @form 22402 * @since 9 22403 */ 22404/** 22405 * Custom Component 22406 * 22407 * @extends CommonAttribute 22408 * @syscap SystemCapability.ArkUI.ArkUI.Full 22409 * @crossplatform 22410 * @form 22411 * @since 10 22412 */ 22413/** 22414 * Custom Component 22415 * 22416 * @extends CommonAttribute 22417 * @syscap SystemCapability.ArkUI.ArkUI.Full 22418 * @crossplatform 22419 * @form 22420 * @atomicservice 22421 * @since 11 22422 */ 22423declare class CustomComponent extends CommonAttribute { 22424 /** 22425 * Customize the pop-up content constructor. 22426 * 22427 * @syscap SystemCapability.ArkUI.ArkUI.Full 22428 * @since 7 22429 */ 22430 /** 22431 * Customize the pop-up content constructor. 22432 * 22433 * @syscap SystemCapability.ArkUI.ArkUI.Full 22434 * @form 22435 * @since 9 22436 */ 22437 /** 22438 * Customize the pop-up content constructor. 22439 * 22440 * @syscap SystemCapability.ArkUI.ArkUI.Full 22441 * @crossplatform 22442 * @form 22443 * @since 10 22444 */ 22445 /** 22446 * Customize the pop-up content constructor. 22447 * 22448 * @syscap SystemCapability.ArkUI.ArkUI.Full 22449 * @crossplatform 22450 * @form 22451 * @atomicservice 22452 * @since 11 22453 */ 22454 build(): void; 22455 22456 /** 22457 * aboutToAppear Method 22458 * 22459 * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. 22460 * 22461 * @syscap SystemCapability.ArkUI.ArkUI.Full 22462 * @since 7 22463 */ 22464 /** 22465 * aboutToAppear Method 22466 * 22467 * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. 22468 * 22469 * @syscap SystemCapability.ArkUI.ArkUI.Full 22470 * @form 22471 * @since 9 22472 */ 22473 /** 22474 * aboutToAppear Method 22475 * 22476 * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. 22477 * 22478 * @syscap SystemCapability.ArkUI.ArkUI.Full 22479 * @crossplatform 22480 * @form 22481 * @since 10 22482 */ 22483 /** 22484 * aboutToAppear Method 22485 * 22486 * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. 22487 * 22488 * @syscap SystemCapability.ArkUI.ArkUI.Full 22489 * @crossplatform 22490 * @form 22491 * @atomicservice 22492 * @since 11 22493 */ 22494 aboutToAppear?(): void; 22495 22496 /** 22497 * aboutToDisappear Method 22498 * 22499 * The aboutToDisappear function executes before a custom component is destroyed. 22500 * 22501 * @syscap SystemCapability.ArkUI.ArkUI.Full 22502 * @since 7 22503 */ 22504 /** 22505 * aboutToDisappear Method 22506 * 22507 * The aboutToDisappear function executes before a custom component is destroyed. 22508 * 22509 * @syscap SystemCapability.ArkUI.ArkUI.Full 22510 * @form 22511 * @since 9 22512 */ 22513 /** 22514 * aboutToDisappear Method 22515 * 22516 * The aboutToDisappear function executes before a custom component is destroyed. 22517 * 22518 * @syscap SystemCapability.ArkUI.ArkUI.Full 22519 * @crossplatform 22520 * @form 22521 * @since 10 22522 */ 22523 /** 22524 * aboutToDisappear Method 22525 * 22526 * The aboutToDisappear function executes before a custom component is destroyed. 22527 * 22528 * @syscap SystemCapability.ArkUI.ArkUI.Full 22529 * @crossplatform 22530 * @form 22531 * @atomicservice 22532 * @since 11 22533 */ 22534 aboutToDisappear?(): void; 22535 22536 /** 22537 * aboutToReuse Method 22538 * 22539 * @param { object } params - Custom component init params. 22540 * @syscap SystemCapability.ArkUI.ArkUI.Full 22541 * @crossplatform 22542 * @since 10 22543 */ 22544 /** 22545 * aboutToReuse Method 22546 * 22547 * @param { object } params - Custom component init params. 22548 * @syscap SystemCapability.ArkUI.ArkUI.Full 22549 * @crossplatform 22550 * @atomicservice 22551 * @since 11 22552 */ 22553 aboutToReuse?(params: { [key: string]: unknown }): void; 22554 22555 /** 22556 * aboutToRecycle Method 22557 * 22558 * @syscap SystemCapability.ArkUI.ArkUI.Full 22559 * @crossplatform 22560 * @since 10 22561 */ 22562 /** 22563 * aboutToRecycle Method 22564 * 22565 * @syscap SystemCapability.ArkUI.ArkUI.Full 22566 * @crossplatform 22567 * @atomicservice 22568 * @since 11 22569 */ 22570 aboutToRecycle?(): void; 22571 22572 /** 22573 * The onWillApplyTheme function is a custom hook to get active theme object from the context 22574 * 22575 * @param { Theme } theme - Custom theme init params. 22576 * @syscap SystemCapability.ArkUI.ArkUI.Full 22577 * @crossplatform 22578 * @atomicservice 22579 * @since 12 22580 */ 22581 onWillApplyTheme?(theme: Theme): void; 22582 22583 /** 22584 * Custom component override this method to layout each of its sub components. 22585 * 22586 * @param { Array<LayoutChild> } children 22587 * @param { ConstraintSizeOptions } constraint 22588 * @syscap SystemCapability.ArkUI.ArkUI.Full 22589 * @form 22590 * @since 9 22591 * @deprecated since 10 22592 * @useinstead CustomComponent#onPlaceChildren 22593 */ 22594 onLayout?(children: Array<LayoutChild>, constraint: ConstraintSizeOptions): void; 22595 22596 /** 22597 * Custom component override this method to layout each of its sub components. 22598 * 22599 * @param { GeometryInfo } selfLayoutInfo 22600 * @param { Array<Layoutable> } children 22601 * @param { ConstraintSizeOptions } constraint 22602 * @syscap SystemCapability.ArkUI.ArkUI.Full 22603 * @crossplatform 22604 * @since 10 22605 */ 22606 /** 22607 * Custom component override this method to layout each of its sub components. 22608 * 22609 * @param { GeometryInfo } selfLayoutInfo 22610 * @param { Array<Layoutable> } children 22611 * @param { ConstraintSizeOptions } constraint 22612 * @syscap SystemCapability.ArkUI.ArkUI.Full 22613 * @crossplatform 22614 * @atomicservice 22615 * @since 11 22616 */ 22617 onPlaceChildren?(selfLayoutInfo: GeometryInfo, children: Array<Layoutable>, constraint: ConstraintSizeOptions): void; 22618 22619 /** 22620 * Custom component override this method to measure each of its sub components. 22621 * 22622 * @param { Array<LayoutChild> } children 22623 * @param { ConstraintSizeOptions } constraint 22624 * @syscap SystemCapability.ArkUI.ArkUI.Full 22625 * @form 22626 * @since 9 22627 * @deprecated since 10 22628 * @useinstead CustomComponent#onMeasureSize 22629 */ 22630 onMeasure?(children: Array<LayoutChild>, constraint: ConstraintSizeOptions): void; 22631 22632 /** 22633 * Custom component override this method to measure each of its sub components. 22634 * @param { GeometryInfo } selfLayoutInfo 22635 * @param { Array<Measurable> } children - indicate the measure child 22636 * @param { ConstraintSizeOptions } constraint - indicate child constraint size 22637 * @returns { SizeResult } 22638 * @syscap SystemCapability.ArkUI.ArkUI.Full 22639 * @crossplatform 22640 * @since 10 22641 */ 22642 /** 22643 * Custom component override this method to measure each of its sub components. 22644 * @param { GeometryInfo } selfLayoutInfo 22645 * @param { Array<Measurable> } children - indicate the measure child 22646 * @param { ConstraintSizeOptions } constraint - indicate child constraint size 22647 * @returns { SizeResult } 22648 * @syscap SystemCapability.ArkUI.ArkUI.Full 22649 * @crossplatform 22650 * @atomicservice 22651 * @since 11 22652 */ 22653 onMeasureSize?(selfLayoutInfo: GeometryInfo, children: Array<Measurable>, constraint: ConstraintSizeOptions): SizeResult; 22654 22655 /** 22656 * onPageShow Method 22657 * 22658 * The page is triggered once each time it is displayed, including scenarios such as the routing process and the application entering the foreground 22659 * 22660 * @syscap SystemCapability.ArkUI.ArkUI.Full 22661 * @since 7 22662 */ 22663 /** 22664 * onPageShow Method 22665 * 22666 * The page is triggered once each time it is displayed, including scenarios such as the routing process and the application entering the foreground 22667 * 22668 * @syscap SystemCapability.ArkUI.ArkUI.Full 22669 * @crossplatform 22670 * @since 10 22671 */ 22672 /** 22673 * onPageShow Method 22674 * 22675 * The page is triggered once each time it is displayed, including scenarios such as the routing process and the application entering the foreground 22676 * 22677 * @syscap SystemCapability.ArkUI.ArkUI.Full 22678 * @crossplatform 22679 * @atomicservice 22680 * @since 11 22681 */ 22682 onPageShow?(): void; 22683 22684 /** 22685 * onPageHide Method 22686 * 22687 * It is triggered once each time the page is hidden, including scenarios such as the routing process and the application entering the background 22688 * 22689 * @syscap SystemCapability.ArkUI.ArkUI.Full 22690 * @since 7 22691 */ 22692 /** 22693 * onPageHide Method 22694 * 22695 * It is triggered once each time the page is hidden, including scenarios such as the routing process and the application entering the background 22696 * 22697 * @syscap SystemCapability.ArkUI.ArkUI.Full 22698 * @crossplatform 22699 * @since 10 22700 */ 22701 /** 22702 * onPageHide Method 22703 * 22704 * It is triggered once each time the page is hidden, including scenarios such as the routing process and the application entering the background 22705 * 22706 * @syscap SystemCapability.ArkUI.ArkUI.Full 22707 * @crossplatform 22708 * @atomicservice 22709 * @since 11 22710 */ 22711 onPageHide?(): void; 22712 22713 /** 22714 * onFormRecycle Method, this is only for ArkTS form, if form was marked recyclable by form user, when system memory is low, 22715 * it will be recycled after calling this method, you should return a string of params that you wish to be saved, it will be 22716 * passed back as params in onFormRecover, in which you can recover the form 22717 * 22718 * @returns { string } status data of ArkTS form UI, this data will be passed in when recover form later 22719 * @syscap SystemCapability.ArkUI.ArkUI.Full 22720 * @crossplatform 22721 * @form 22722 * @since 11 22723 */ 22724 /** 22725 * onFormRecycle Method, this is only for ArkTS form, if form was marked recyclable by form user, when system memory is low, 22726 * it will be recycled after calling this method, you should return a string of params that you wish to be saved, it will be 22727 * passed back as params in onFormRecover, in which you can recover the form 22728 * 22729 * @returns { string } status data of ArkTS form UI, this data will be passed in when recover form later 22730 * @syscap SystemCapability.ArkUI.ArkUI.Full 22731 * @crossplatform 22732 * @form 22733 * @atomicservice 22734 * @since 12 22735 */ 22736 onFormRecycle?(): string; 22737 22738 /** 22739 * onFormRecover Method, this is only for ArkTS form 22740 * 22741 * @param { string } statusData - indicate status data of ArkTS form UI, which is acquired by calling onFormRecycle, it is used to recover form 22742 * @syscap SystemCapability.ArkUI.ArkUI.Full 22743 * @crossplatform 22744 * @form 22745 * @since 11 22746 */ 22747 /** 22748 * onFormRecover Method, this is only for ArkTS form 22749 * 22750 * @param { string } statusData - indicate status data of ArkTS form UI, which is acquired by calling onFormRecycle, it is used to recover form 22751 * @syscap SystemCapability.ArkUI.ArkUI.Full 22752 * @crossplatform 22753 * @form 22754 * @atomicservice 22755 * @since 12 22756 */ 22757 onFormRecover?(statusData: string): void; 22758 22759 /** 22760 * onBackPress Method 22761 * 22762 * Triggered when the user clicks the back button 22763 * 22764 * @returns { void | boolean } 22765 * @syscap SystemCapability.ArkUI.ArkUI.Full 22766 * @since 7 22767 */ 22768 /** 22769 * onBackPress Method 22770 * 22771 * Triggered when the user clicks the back button 22772 * 22773 * @returns { void | boolean } true means that the page itself processes the return logic. 22774 * false means that the default return logic is used. 22775 * If no value is returned, the default return logic is used. 22776 * @syscap SystemCapability.ArkUI.ArkUI.Full 22777 * @crossplatform 22778 * @since 10 22779 */ 22780 /** 22781 * onBackPress Method 22782 * 22783 * Triggered when the user clicks the back button 22784 * 22785 * @returns { void | boolean } true means that the page itself processes the return logic. 22786 * false means that the default return logic is used. 22787 * If no value is returned, the default return logic is used. 22788 * @syscap SystemCapability.ArkUI.ArkUI.Full 22789 * @crossplatform 22790 * @atomicservice 22791 * @since 11 22792 */ 22793 onBackPress?(): void | boolean; 22794 22795 /** 22796 * PageTransition Method. 22797 * Implement Animation when enter this page or move to other pages. 22798 * 22799 * @syscap SystemCapability.ArkUI.ArkUI.Full 22800 * @since 9 22801 */ 22802 /** 22803 * PageTransition Method. 22804 * Implement Animation when enter this page or move to other pages. 22805 * 22806 * @syscap SystemCapability.ArkUI.ArkUI.Full 22807 * @crossplatform 22808 * @since 10 22809 */ 22810 /** 22811 * PageTransition Method. 22812 * Implement Animation when enter this page or move to other pages. 22813 * 22814 * @syscap SystemCapability.ArkUI.ArkUI.Full 22815 * @crossplatform 22816 * @atomicservice 22817 * @since 11 22818 */ 22819 pageTransition?(): void; 22820 22821 /** 22822 * Get current UIContext 22823 * 22824 * @returns { UIContext } The UIContext that the custom component belongs to. 22825 * @syscap SystemCapability.ArkUI.ArkUI.Full 22826 * @crossplatform 22827 * @since 11 22828 */ 22829 /** 22830 * Get current UIContext 22831 * 22832 * @returns { UIContext } The UIContext that the custom component belongs to. 22833 * @syscap SystemCapability.ArkUI.ArkUI.Full 22834 * @crossplatform 22835 * @atomicservice 22836 * @since 12 22837 */ 22838 getUIContext(): UIContext; 22839 22840 /** 22841 * Get uniqueId of the custom component. 22842 * 22843 * @returns { number } - The uniqueId of the custom component. 22844 * @syscap SystemCapability.ArkUI.ArkUI.Full 22845 * @crossplatform 22846 * @atomicservice 22847 * @since 12 22848 */ 22849 getUniqueId(): number; 22850 22851 /** 22852 * Queries the navigation destination information. 22853 * 22854 * @returns { NavDestinationInfo | undefined } The navigation destination information, or undefined if it is not available. 22855 * @syscap SystemCapability.ArkUI.ArkUI.Full 22856 * @crossplatform 22857 * @since 11 22858 */ 22859 /** 22860 * Queries the navigation destination information. 22861 * 22862 * @returns { NavDestinationInfo | undefined } The navigation destination information, or undefined if it is not available. 22863 * @syscap SystemCapability.ArkUI.ArkUI.Full 22864 * @crossplatform 22865 * @atomicservice 22866 * @since 12 22867 */ 22868 queryNavDestinationInfo(): NavDestinationInfo | undefined; 22869 22870 /** 22871 * Query the navigation information of the current custom component. 22872 * 22873 * @returns { NavigationInfo | undefined } The navigation information, or undefined if it is not available 22874 * @syscap SystemCapability.ArkUI.ArkUI.Full 22875 * @crossplatform 22876 * @atomicservice 22877 * @since 12 22878 */ 22879 queryNavigationInfo(): NavigationInfo | undefined; 22880 22881 /** 22882 * Query the router page information of the current custom component. 22883 * 22884 * @returns { RouterPageInfo | undefined } The router page information, or undefined if it is not available. 22885 * @syscap SystemCapability.ArkUI.ArkUI.Full 22886 * @crossplatform 22887 * @atomicservice 22888 * @since 12 22889 */ 22890 queryRouterPageInfo(): RouterPageInfo | undefined; 22891 22892 /** 22893 * The callback method after the custom component is built. 22894 * 22895 * Triggered when the custom component has been built. 22896 * 22897 * @syscap SystemCapability.ArkUI.ArkUI.Full 22898 * @crossplatform 22899 * @atomicservice 22900 * @since 12 22901 */ 22902 onDidBuild?(): void; 22903} 22904 22905/** 22906 * View 22907 * 22908 * @syscap SystemCapability.ArkUI.ArkUI.Full 22909 * @systemapi 22910 * @since 7 22911 */ 22912/** 22913 * View 22914 * 22915 * @syscap SystemCapability.ArkUI.ArkUI.Full 22916 * @systemapi 22917 * @form 22918 * @since 9 22919 */ 22920declare class View { 22921 /** 22922 * Just use for generate tsbundle 22923 * 22924 * @param { any } value 22925 * @returns { any } 22926 * @syscap SystemCapability.ArkUI.ArkUI.Full 22927 * @systemapi 22928 * @since 7 22929 */ 22930 /** 22931 * Just use for generate tsbundle 22932 * 22933 * @param { any } value 22934 * @returns { any } 22935 * @syscap SystemCapability.ArkUI.ArkUI.Full 22936 * @systemapi 22937 * @form 22938 * @since 9 22939 */ 22940 create(value: any): any; 22941} 22942 22943/** 22944 * Rect info. 22945 * 22946 * @interface RectResult 22947 * @syscap SystemCapability.ArkUI.ArkUI.Full 22948 * @crossplatform 22949 * @since 10 22950 */ 22951/** 22952 * Rect info. 22953 * 22954 * @interface RectResult 22955 * @syscap SystemCapability.ArkUI.ArkUI.Full 22956 * @crossplatform 22957 * @atomicservice 22958 * @since 11 22959 */ 22960declare interface RectResult { 22961 /** 22962 * x:Horizontal coordinate relative to the component. 22963 * 22964 * @type { number } 22965 * @syscap SystemCapability.ArkUI.ArkUI.Full 22966 * @since 10 22967 */ 22968 /** 22969 * x:Horizontal coordinate relative to the component. 22970 * 22971 * @type { number } 22972 * @syscap SystemCapability.ArkUI.ArkUI.Full 22973 * @crossplatform 22974 * @atomicservice 22975 * @since 11 22976 */ 22977 x: number; 22978 22979 /** 22980 * y:Vertical axis coordinate relative to the component. 22981 * 22982 * @type { number } 22983 * @syscap SystemCapability.ArkUI.ArkUI.Full 22984 * @since 10 22985 */ 22986 /** 22987 * y:Vertical axis coordinate relative to the component. 22988 * 22989 * @type { number } 22990 * @syscap SystemCapability.ArkUI.ArkUI.Full 22991 * @crossplatform 22992 * @atomicservice 22993 * @since 11 22994 */ 22995 y: number; 22996 22997 /** 22998 * Get the width of the current textRect. 22999 * 23000 * @type { number } 23001 * @syscap SystemCapability.ArkUI.ArkUI.Full 23002 * @since 10 23003 */ 23004 /** 23005 * Get the width of the current textRect. 23006 * 23007 * @type { number } 23008 * @syscap SystemCapability.ArkUI.ArkUI.Full 23009 * @crossplatform 23010 * @atomicservice 23011 * @since 11 23012 */ 23013 width: number; 23014 23015 /** 23016 * Get the height of the current textRect. 23017 * 23018 * @type { number } 23019 * @syscap SystemCapability.ArkUI.ArkUI.Full 23020 * @since 10 23021 */ 23022 /** 23023 * Get the height of the current textRect. 23024 * 23025 * @type { number } 23026 * @syscap SystemCapability.ArkUI.ArkUI.Full 23027 * @crossplatform 23028 * @atomicservice 23029 * @since 11 23030 */ 23031 height: number; 23032} 23033 23034/** 23035 * CaretOffset info. 23036 * 23037 * @interface CaretOffset 23038 * @syscap SystemCapability.ArkUI.ArkUI.Full 23039 * @crossplatform 23040 * @since 11 23041 */ 23042/** 23043 * CaretOffset info. 23044 * 23045 * @interface CaretOffset 23046 * @syscap SystemCapability.ArkUI.ArkUI.Full 23047 * @crossplatform 23048 * @atomicservice 23049 * @since 12 23050 */ 23051declare interface CaretOffset { 23052 /** 23053 * Get the index of the CaretOffset 23054 * 23055 * @type { number } 23056 * @syscap SystemCapability.ArkUI.ArkUI.Full 23057 * @since 11 23058 */ 23059 /** 23060 * Get the index of the CaretOffset 23061 * 23062 * @type { number } 23063 * @syscap SystemCapability.ArkUI.ArkUI.Full 23064 * @atomicservice 23065 * @since 12 23066 */ 23067 index: number; 23068 23069 /** 23070 * Get the x of the relative position. 23071 * 23072 * @type { number } 23073 * @syscap SystemCapability.ArkUI.ArkUI.Full 23074 * @since 11 23075 */ 23076 /** 23077 * Get the x of the relative position. 23078 * 23079 * @type { number } 23080 * @syscap SystemCapability.ArkUI.ArkUI.Full 23081 * @atomicservice 23082 * @since 12 23083 */ 23084 x: number; 23085 23086 /** 23087 * Get the y of the relative position. 23088 * 23089 * @type { number } 23090 * @syscap SystemCapability.ArkUI.ArkUI.Full 23091 * @since 11 23092 */ 23093 /** 23094 * Get the y of the relative position. 23095 * 23096 * @type { number } 23097 * @syscap SystemCapability.ArkUI.ArkUI.Full 23098 * @atomicservice 23099 * @since 12 23100 */ 23101 y: number; 23102} 23103 23104/** 23105 * TextContentControllerBase 23106 * 23107 * @syscap SystemCapability.ArkUI.ArkUI.Full 23108 * @crossplatform 23109 * @since 10 23110 */ 23111/** 23112 * TextContentControllerBase 23113 * 23114 * @syscap SystemCapability.ArkUI.ArkUI.Full 23115 * @crossplatform 23116 * @atomicservice 23117 * @since 11 23118 */ 23119declare abstract class TextContentControllerBase { 23120 /** 23121 * Get the index and relative position of the CaretOffset. 23122 * 23123 * @returns { CaretOffset } index and relative position of the CaretOffset. 23124 * @syscap SystemCapability.ArkUI.ArkUI.Full 23125 * @crossplatform 23126 * @since 11 23127 */ 23128 /** 23129 * Get the index and relative position of the CaretOffset. 23130 * 23131 * @returns { CaretOffset } index and relative position of the CaretOffset. 23132 * @syscap SystemCapability.ArkUI.ArkUI.Full 23133 * @crossplatform 23134 * @atomicservice 23135 * @since 12 23136 */ 23137 getCaretOffset() : CaretOffset; 23138 23139 /** 23140 * Get the start and end positions of the text content. 23141 * 23142 * @returns { RectResult } Text content rect. 23143 * @syscap SystemCapability.ArkUI.ArkUI.Full 23144 * @crossplatform 23145 * @since 10 23146 */ 23147 /** 23148 * Get the start and end positions of the text content. 23149 * 23150 * @returns { RectResult } Text content rect. 23151 * @syscap SystemCapability.ArkUI.ArkUI.Full 23152 * @crossplatform 23153 * @atomicservice 23154 * @since 11 23155 */ 23156 getTextContentRect() : RectResult; 23157 23158 /** 23159 * Get the lines number of the text content. 23160 * 23161 * @returns { number } Text content line count 23162 * @syscap SystemCapability.ArkUI.ArkUI.Full 23163 * @crossplatform 23164 * @since 10 23165 */ 23166 /** 23167 * Get the lines number of the text content. 23168 * 23169 * @returns { number } Text content line count 23170 * @syscap SystemCapability.ArkUI.ArkUI.Full 23171 * @crossplatform 23172 * @atomicservice 23173 * @since 11 23174 */ 23175 getTextContentLineCount() : number; 23176} 23177 23178/** 23179 * Enum of scrollable containers' content clip mode. 23180 * 23181 * @enum { number } 23182 * @syscap SystemCapability.ArkUI.ArkUI.Full 23183 * @crossplatform 23184 * @atomicservice 23185 * @since 14 23186 */ 23187declare enum ContentClipMode { 23188 /** 23189 * Clip to content rect inside margin & padding. 23190 * 23191 * @syscap SystemCapability.ArkUI.ArkUI.Full 23192 * @crossplatform 23193 * @atomicservice 23194 * @since 14 23195 */ 23196 CONTENT_ONLY = 0, 23197 23198 /** 23199 * Clip to scrollable's outer rect, including padding but inside margin. 23200 * 23201 * @syscap SystemCapability.ArkUI.ArkUI.Full 23202 * @crossplatform 23203 * @atomicservice 23204 * @since 14 23205 */ 23206 BOUNDARY = 1, 23207 23208 /** 23209 * Clip to the safeArea of scrollable container. 23210 * 23211 * @syscap SystemCapability.ArkUI.ArkUI.Full 23212 * @crossplatform 23213 * @atomicservice 23214 * @since 14 23215 */ 23216 SAFE_AREA = 2, 23217} 23218 23219/** 23220 * CommonScrollableMethod 23221 * 23222 * @extends CommonMethod<T> 23223 * @syscap SystemCapability.ArkUI.ArkUI.Full 23224 * @crossplatform 23225 * @atomicservice 23226 * @since 11 23227 */ 23228/** 23229 * CommonScrollableMethod 23230 * 23231 * @extends CommonMethod<T> 23232 * @syscap SystemCapability.ArkUI.ArkUI.Full 23233 * @crossplatform 23234 * @form 23235 * @atomicservice 23236 * @since 12 23237 */ 23238declare class ScrollableCommonMethod<T> extends CommonMethod<T> { 23239 /** 23240 * Scrollbar status. 23241 * 23242 * @param { BarState } barState - Scrollbar status. 23243 * @returns { T } 23244 * @syscap SystemCapability.ArkUI.ArkUI.Full 23245 * @crossplatform 23246 * @atomicservice 23247 * @since 11 23248 */ 23249 scrollBar(barState: BarState): T; 23250 23251 /** 23252 * Color of the scrollbar. 23253 * 23254 * @param { Color | number | string } color - Color of the scrollbar. 23255 * @returns { T } 23256 * @syscap SystemCapability.ArkUI.ArkUI.Full 23257 * @crossplatform 23258 * @atomicservice 23259 * @since 11 23260 */ 23261 scrollBarColor(color: Color | number | string): T; 23262 23263 /** 23264 * Width of the scrollbar. 23265 * 23266 * @param { number | string } value - Width of the scrollbar. 23267 * @returns { T } 23268 * @syscap SystemCapability.ArkUI.ArkUI.Full 23269 * @crossplatform 23270 * @atomicservice 23271 * @since 11 23272 */ 23273 scrollBarWidth(value: number | string): T; 23274 23275 /** 23276 * Edge scrolling effect. 23277 * 23278 * @param { EdgeEffect } edgeEffect - edge scrolling effect. 23279 * @param { EdgeEffectOptions } options - edge scrolling effect options. 23280 * @returns { T } 23281 * @syscap SystemCapability.ArkUI.ArkUI.Full 23282 * @crossplatform 23283 * @atomicservice 23284 * @since 11 23285 */ 23286 edgeEffect(edgeEffect: EdgeEffect, options?: EdgeEffectOptions): T; 23287 23288 /** 23289 * Called when setting whether to enable fading Edge effect. 23290 * 23291 * @param { Optional<boolean> } enabled - Whether to turn on the edge fade effect 23292 * @param { FadingEdgeOptions } [options] - The options of fadingEdge. 23293 * @returns { T } 23294 * @syscap SystemCapability.ArkUI.ArkUI.Full 23295 * @crossplatform 23296 * @atomicservice 23297 * @since 13 23298 */ 23299 fadingEdge(enabled: Optional<boolean>, options?: FadingEdgeOptions): T; 23300 23301 /** 23302 * Nested scrolling options. 23303 * 23304 * @param { NestedScrollOptions } value - options for nested scrolling. 23305 * @returns { T } 23306 * @syscap SystemCapability.ArkUI.ArkUI.Full 23307 * @crossplatform 23308 * @atomicservice 23309 * @since 11 23310 */ 23311 nestedScroll(value: NestedScrollOptions): T; 23312 23313 /** 23314 * Whether to support scroll gestures by finger or mouse. 23315 * 23316 * @param { boolean } value - Whether to support scroll gestures by finger or mouse. 23317 * @returns { T } 23318 * @syscap SystemCapability.ArkUI.ArkUI.Full 23319 * @crossplatform 23320 * @atomicservice 23321 * @since 11 23322 */ 23323 enableScrollInteraction(value: boolean): T; 23324 23325 /** 23326 * Friction coefficient. 23327 * 23328 * @param { number | Resource } value - friction coefficient. 23329 * @returns { T } 23330 * @syscap SystemCapability.ArkUI.ArkUI.Full 23331 * @crossplatform 23332 * @atomicservice 23333 * @since 11 23334 */ 23335 friction(value: number | Resource): T; 23336 23337 /** 23338 * Called when the scrollable scrolls. 23339 * 23340 * @param { function } event - callback of scrollable, 23341 * scrollOffset is offset per frame scrolling, ScrollState is current scroll state. 23342 * @returns { T } 23343 * @syscap SystemCapability.ArkUI.ArkUI.Full 23344 * @crossplatform 23345 * @atomicservice 23346 * @since 11 23347 * @deprecated since 12 23348 * @useinstead ScrollableCommonMethod#onDidScroll 23349 */ 23350 onScroll(event: (scrollOffset: number, scrollState: ScrollState) => void): T; 23351 23352 /** 23353 * Called when the scrollable will scroll. 23354 * 23355 * @param { Optional<OnWillScrollCallback> } handler - callback of scrollable. 23356 * @returns { T } 23357 * @syscap SystemCapability.ArkUI.ArkUI.Full 23358 * @crossplatform 23359 * @atomicservice 23360 * @since 12 23361 */ 23362 onWillScroll(handler: Optional<OnWillScrollCallback>): T; 23363 23364 /** 23365 * Called when the scrollable did scroll. 23366 * 23367 * @param { OnScrollCallback } handler - callback of scrollable, 23368 * scrollOffset is offset this frame did scroll, scrollState is current scroll state. 23369 * @returns { T } 23370 * @syscap SystemCapability.ArkUI.ArkUI.Full 23371 * @crossplatform 23372 * @form 23373 * @atomicservice 23374 * @since 12 23375 */ 23376 onDidScroll(handler: OnScrollCallback): T; 23377 23378 /** 23379 * Called when the scrollable reaches the start position. 23380 * 23381 * @param { function } event - Callback function, triggered when the scrollable reaches the start position. 23382 * @returns { T } 23383 * @syscap SystemCapability.ArkUI.ArkUI.Full 23384 * @crossplatform 23385 * @atomicservice 23386 * @since 11 23387 */ 23388 onReachStart(event: () => void): T; 23389 23390 /** 23391 * Called when the scrollable reaches the end position. 23392 * 23393 * @param { function } event - Callback function, triggered when the scrollable reaches the end position. 23394 * @returns { T } 23395 * @syscap SystemCapability.ArkUI.ArkUI.Full 23396 * @crossplatform 23397 * @atomicservice 23398 * @since 11 23399 */ 23400 onReachEnd(event: () => void): T; 23401 23402 /** 23403 * Called when the scrollable starts scrolling. 23404 * 23405 * @param { function } event - Callback function, triggered when the scrollable starts scrolling. 23406 * @returns { T } 23407 * @syscap SystemCapability.ArkUI.ArkUI.Full 23408 * @crossplatform 23409 * @atomicservice 23410 * @since 11 23411 */ 23412 onScrollStart(event: () => void): T; 23413 23414 /** 23415 * Called when the scrollable stops scrolling. 23416 * 23417 * @param { function } event - Callback function, triggered when the scrollable stops scrolling. 23418 * @returns { T } 23419 * @syscap SystemCapability.ArkUI.ArkUI.Full 23420 * @crossplatform 23421 * @atomicservice 23422 * @since 11 23423 */ 23424 onScrollStop(event: () => void): T; 23425 23426 /** 23427 * Limit the max speed when fling. 23428 * 23429 * @param { number } speedLimit - Max fling speed, the minimum value is 0, the maximum value is not limited. 23430 * The unit is vp/s. 23431 * @returns { T } 23432 * @syscap SystemCapability.ArkUI.ArkUI.Full 23433 * @crossplatform 23434 * @atomicservice 23435 * @since 11 23436 */ 23437 flingSpeedLimit(speedLimit: number): T; 23438 23439 /** 23440 * Clip the content of the scrollable container, excluding background. 23441 * 23442 * @param { ContentClipMode | RectShape } clip - A value from enum ContentClipMode or a customized clip rect. 23443 * @returns { T } 23444 * @syscap SystemCapability.ArkUI.ArkUI.Full 23445 * @crossplatform 23446 * @atomicservice 23447 * @since 14 23448 */ 23449 clipContent(clip: ContentClipMode | RectShape): T; 23450} 23451 23452/** 23453 * The actual offset by which the scrollable scrolls. 23454 * @syscap SystemCapability.ArkUI.ArkUI.Full 23455 * @crossplatform 23456 * @atomicservice 23457 * @since 12 23458 */ 23459declare class ScrollResult { 23460 /** 23461 * Actual offset by which the scrollable scrolls in vp. 23462 * @type { number } 23463 * @syscap SystemCapability.ArkUI.ArkUI.Full 23464 * @crossplatform 23465 * @atomicservice 23466 * @since 12 23467 */ 23468 offsetRemain: number; 23469} 23470 23471/** 23472 * Called before scroll to allow developer to control real offset the Scrollable can scroll. 23473 * 23474 * @typedef { function } OnWillScrollCallback 23475 * @param { number } scrollOffset - offset this frame will scroll, which may or may not be reached. 23476 * @param { ScrollState } scrollState - current scroll state. 23477 * @param { ScrollSource } scrollSource - source of current scroll. 23478 * @returns { void | ScrollResult } the remain offset for the scrollable, 23479 * same as scrollOffset when no ScrollResult is returned. 23480 * @syscap SystemCapability.ArkUI.ArkUI.Full 23481 * @crossplatform 23482 * @atomicservice 23483 * @since 12 23484 */ 23485declare type OnWillScrollCallback = 23486(scrollOffset: number, scrollState: ScrollState, scrollSource: ScrollSource) => void | ScrollResult; 23487 23488/** 23489 * On scroll callback using in scrollable onDidScroll. 23490 * 23491 * @typedef { function } OnScrollCallback 23492 * @param { number } scrollOffset - offset this frame did scroll. 23493 * @param { ScrollState } scrollState - current scroll state. 23494 * @syscap SystemCapability.ArkUI.ArkUI.Full 23495 * @crossplatform 23496 * @form 23497 * @atomicservice 23498 * @since 12 23499 */ 23500declare type OnScrollCallback = (scrollOffset: number, scrollState: ScrollState) => void; 23501 23502/** 23503 * Defines the onMove callback. 23504 * 23505 * @typedef { function } OnMoveHandler 23506 * @param { number } from - Index number for moving elements. 23507 * @param { number } to - Target index number for moving elements. 23508 * @syscap SystemCapability.ArkUI.ArkUI.Full 23509 * @crossplatform 23510 * @atomicservice 23511 * @since 12 23512 */ 23513declare type OnMoveHandler = (from: number, to: number) => void; 23514 23515/** 23516 * Define DynamicNode. 23517 * 23518 * @syscap SystemCapability.ArkUI.ArkUI.Full 23519 * @crossplatform 23520 * @atomicservice 23521 * @since 12 23522 */ 23523declare class DynamicNode<T> { 23524 /** 23525 * Set the move action. 23526 * 23527 * @param { Optional<OnMoveHandler> } handler 23528 * @returns { T } 23529 * @syscap SystemCapability.ArkUI.ArkUI.Full 23530 * @crossplatform 23531 * @atomicservice 23532 * @since 12 23533 */ 23534 onMove(handler: Optional<OnMoveHandler>): T; 23535} 23536 23537/** 23538 * Define EdgeEffect Options. 23539 * 23540 * @interface EdgeEffectOptions 23541 * @syscap SystemCapability.ArkUI.ArkUI.Full 23542 * @crossplatform 23543 * @since 11 23544 */ 23545/** 23546 * Define EdgeEffect Options. 23547 * 23548 * @interface EdgeEffectOptions 23549 * @syscap SystemCapability.ArkUI.ArkUI.Full 23550 * @crossplatform 23551 * @atomicservice 23552 * @since 12 23553 */ 23554declare interface EdgeEffectOptions { 23555 /** 23556 * Enable Sliding effect when component does not full screen. 23557 * 23558 * @type { boolean } 23559 * @syscap SystemCapability.ArkUI.ArkUI.Full 23560 * @crossplatform 23561 * @since 11 23562 */ 23563 /** 23564 * Enable Sliding effect when component does not full screen. 23565 * 23566 * @type { boolean } 23567 * @syscap SystemCapability.ArkUI.ArkUI.Full 23568 * @crossplatform 23569 * @atomicservice 23570 * @since 12 23571 */ 23572 alwaysEnabled: boolean; 23573} 23574 23575/** 23576 * Indicates children main size. 23577 * 23578 * @syscap SystemCapability.ArkUI.ArkUI.Full 23579 * @crossplatform 23580 * @atomicservice 23581 * @since 12 23582 */ 23583declare class ChildrenMainSize { 23584 /** 23585 * Creates an instance of ChildrenMainSize. 23586 * 23587 * @param { number } childDefaultSize - default main size, in vp. If the main axis is vertical, it indicates height. 23588 * If the main axis is horizontal, it indicates width. 23589 * @throws { BusinessError } 401 - Parameter error. Possible causes: 23590 * <br> 1. Mandatory parameters are left unspecified. 23591 * <br> 2. Incorrect parameters types. 23592 * <br> 3. Parameter verification failed. 23593 * @syscap SystemCapability.ArkUI.ArkUI.Full 23594 * @crossplatform 23595 * @atomicservice 23596 * @since 12 23597 */ 23598 constructor(childDefaultSize: number); 23599 23600 /** 23601 * Set default size. 23602 * 23603 * @param { number } value - default main size, in vp. If the main axis is vertical, it indicates height. 23604 * If the main axis is horizontal, it indicates width. 23605 * @throws { BusinessError } 401 - Parameter error. Possible causes: 23606 * <br> 1. Mandatory parameters are left unspecified. 23607 * <br> 2. Incorrect parameters types. 23608 * <br> 3. Parameter verification failed. 23609 * @syscap SystemCapability.ArkUI.ArkUI.Full 23610 * @crossplatform 23611 * @atomicservice 23612 * @since 12 23613 */ 23614 set childDefaultSize(value: number); 23615 23616 /** 23617 * Get default size 23618 * 23619 * @returns { number } - default main size, in vp. If the main axis is vertical, it indicates height. 23620 * If the main axis is horizontal, it indicates width. 23621 * @syscap SystemCapability.ArkUI.ArkUI.Full 23622 * @crossplatform 23623 * @atomicservice 23624 * @since 12 23625 */ 23626 get childDefaultSize(): number; 23627 23628 /** 23629 * Changes children main size by removing or replacing existing elements and/or adding new elements in place. 23630 * 23631 * @param { number } start - Zero-based index at which to start changing the children main size. 23632 * @param { number } [deleteCount] - Indicating the number of children main size to remove from start. 23633 * @param { Array<number> } [childrenSize] - Add the new children main size, beginning from start. 23634 * @throws { BusinessError } 401 - Parameter error. Possible causes: 23635 * <br> 1. Mandatory parameters are left unspecified. 23636 * <br> 2. Incorrect parameters types. 23637 * <br> 3. Parameter verification failed. 23638 * @syscap SystemCapability.ArkUI.ArkUI.Full 23639 * @crossplatform 23640 * @atomicservice 23641 * @since 12 23642 * @example splice(1, 0, [100]), Insert a child after first child, the child's main size is 100vp. 23643 * splice(1, 1), Delete the second child. 23644 * splice(1, 2, [100, 100]), Change the main size of the second and third children to 100vp. 23645 */ 23646 splice(start: number, deleteCount?: number, childrenSize?: Array<number>): void; 23647 23648 /** 23649 * Updates main size for specified child. 23650 * 23651 * @param { number } index - index of child to be updated. 23652 * @param { number } childSize - new section options. 23653 * @throws { BusinessError } 401 - Parameter error. Possible causes: 23654 * <br> 1. Mandatory parameters are left unspecified. 23655 * <br> 2. Incorrect parameters types. 23656 * <br> 3. Parameter verification failed. 23657 * @syscap SystemCapability.ArkUI.ArkUI.Full 23658 * @crossplatform 23659 * @atomicservice 23660 * @since 12 23661 */ 23662 update(index: number, childSize: number): void; 23663} 23664 23665/** 23666 * Define BackgroundBrightness Options. 23667 * 23668 * @interface BackgroundBrightnessOptions 23669 * @syscap SystemCapability.ArkUI.ArkUI.Full 23670 * @atomicservice 23671 * @since 12 23672 */ 23673declare interface BackgroundBrightnessOptions { 23674 23675 /** 23676 * Rate represents the rate at which lightUpDegree 23677 * decreases with increasing pixel brightness. 23678 * 23679 * @type { number } -The default value is 0.0, value range: (0.0, +∞). 23680 * @syscap SystemCapability.ArkUI.ArkUI.Full 23681 * @atomicservice 23682 * @since 12 23683 */ 23684 rate: number; 23685 23686 /** 23687 * LightUpDegree represents the degree of brightness 23688 * of the rgb value changes when its brightness 23689 * is 0. 23690 * 23691 * @type { number } -The default value is 0.0, value range: [-1.0, 1.0]. 23692 * @syscap SystemCapability.ArkUI.ArkUI.Full 23693 * @atomicservice 23694 * @since 12 23695 */ 23696 lightUpDegree: number; 23697} 23698 23699/** 23700 * PointLightStyle info 23701 * 23702 * @interface PointLightStyle 23703 * @syscap SystemCapability.ArkUI.ArkUI.Full 23704 * @systemapi 23705 * @since 11 23706 */ 23707declare interface PointLightStyle { 23708 /** 23709 * Defines the PointLight light intensity and position. 23710 * 23711 * @type { ?LightSource } 23712 * @default undefined 23713 * @syscap SystemCapability.ArkUI.ArkUI.Full 23714 * @systemapi 23715 * @since 11 23716 */ 23717 lightSource?: LightSource; 23718 /** 23719 * Defines the PointLight illuminated type. 23720 * 23721 * @type { ?IlluminatedType } 23722 * @default IlluminatedType.NONE 23723 * @syscap SystemCapability.ArkUI.ArkUI.Full 23724 * @systemapi 23725 * @since 11 23726 */ 23727 illuminated?: IlluminatedType; 23728 /** 23729 * Defines the PointLight bloom. 23730 * 23731 * @type { ?number } 23732 * @default 0 23733 * @syscap SystemCapability.ArkUI.ArkUI.Full 23734 * @systemapi 23735 * @since 11 23736 */ 23737 bloom?: number; 23738} 23739 23740/** 23741 * LightSource info 23742 * 23743 * @interface LightSource 23744 * @syscap SystemCapability.ArkUI.ArkUI.Full 23745 * @systemapi 23746 * @since 11 23747 */ 23748declare interface LightSource { 23749 /** 23750 * Defines the PointLight light positionX. 23751 * 23752 * @type { Dimension } 23753 * @syscap SystemCapability.ArkUI.ArkUI.Full 23754 * @systemapi 23755 * @since 11 23756 */ 23757 positionX: Dimension; 23758 /** 23759 * Defines the PointLight light positionX. 23760 * 23761 * @type { Dimension } 23762 * @syscap SystemCapability.ArkUI.ArkUI.Full 23763 * @systemapi 23764 * @since 11 23765 */ 23766 positionY: Dimension; 23767 /** 23768 * Defines the PointLight light positionX. 23769 * 23770 * @type { Dimension } 23771 * @syscap SystemCapability.ArkUI.ArkUI.Full 23772 * @systemapi 23773 * @since 11 23774 */ 23775 positionZ: Dimension; 23776 /** 23777 * Defines the PointLight light intensity. 23778 * 23779 * @type { number } 23780 * @syscap SystemCapability.ArkUI.ArkUI.Full 23781 * @systemapi 23782 * @since 11 23783 */ 23784 intensity: number; 23785 /** 23786 * Defines the PointLight light color. 23787 * 23788 * @type { ?ResourceColor } 23789 * @syscap SystemCapability.ArkUI.ArkUI.Full 23790 * @systemapi 23791 * @since 12 23792 */ 23793 color?: ResourceColor; 23794} 23795 23796/** 23797 * Defining wrapBuilder function. 23798 * @param { function } builder 23799 * @returns { WrappedBuilder<Args> } 23800 * @syscap SystemCapability.ArkUI.ArkUI.Full 23801 * @crossplatform 23802 * @since 11 23803 */ 23804/** 23805 * Defining wrapBuilder function. 23806 * @param { function } builder 23807 * @returns { WrappedBuilder<Args> } 23808 * @syscap SystemCapability.ArkUI.ArkUI.Full 23809 * @crossplatform 23810 * @atomicservice 23811 * @since 12 23812 */ 23813declare function wrapBuilder<Args extends Object[]>(builder: (...args: Args) => void): WrappedBuilder<Args>; 23814 23815/** 23816 * Defines the WrappedBuilder class. 23817 * @syscap SystemCapability.ArkUI.ArkUI.Full 23818 * @crossplatform 23819 * @since 11 23820 */ 23821/** 23822 * Defines the WrappedBuilder class. 23823 * @syscap SystemCapability.ArkUI.ArkUI.Full 23824 * @crossplatform 23825 * @atomicservice 23826 * @since 12 23827 */ 23828declare class WrappedBuilder<Args extends Object[]> { 23829 /** 23830 * @type { function } 23831 * @syscap SystemCapability.ArkUI.ArkUI.Full 23832 * @crossplatform 23833 * @since 11 23834 */ 23835 /** 23836 * @type { function } 23837 * @syscap SystemCapability.ArkUI.ArkUI.Full 23838 * @crossplatform 23839 * @atomicservice 23840 * @since 12 23841 */ 23842 builder: (...args: Args) => void; 23843 23844 /** 23845 * @param { function } builder 23846 * @syscap SystemCapability.ArkUI.ArkUI.Full 23847 * @crossplatform 23848 * @since 11 23849 */ 23850 /** 23851 * @param { function } builder 23852 * @syscap SystemCapability.ArkUI.ArkUI.Full 23853 * @crossplatform 23854 * @atomicservice 23855 * @since 12 23856 */ 23857 constructor(builder: (...args: Args) => void); 23858} 23859 23860 23861/** 23862 * Defines the overall animation parameters of the keyframe animation. 23863 * 23864 * @interface KeyframeAnimateParam 23865 * @syscap SystemCapability.ArkUI.ArkUI.Full 23866 * @crossplatform 23867 * @since 11 23868 */ 23869/** 23870 * Defines the overall animation parameters of the keyframe animation. 23871 * 23872 * @interface KeyframeAnimateParam 23873 * @syscap SystemCapability.ArkUI.ArkUI.Full 23874 * @crossplatform 23875 * @atomicservice 23876 * @since 12 23877 */ 23878declare interface KeyframeAnimateParam { 23879 /** 23880 * Animation delay time, in ms. 23881 * 23882 * @type { ?number } 23883 * @default 0 23884 * @syscap SystemCapability.ArkUI.ArkUI.Full 23885 * @crossplatform 23886 * @since 11 23887 */ 23888 /** 23889 * Animation delay time, in ms. 23890 * 23891 * @type { ?number } 23892 * @default 0 23893 * @syscap SystemCapability.ArkUI.ArkUI.Full 23894 * @crossplatform 23895 * @atomicservice 23896 * @since 12 23897 */ 23898 delay?: number; 23899 23900 /** 23901 * Animation iterations. When set to -1, the animation playing it repeatedly. The value range is greater than or equal to -1. 23902 * 23903 * @type { ?number } 23904 * @default 1 23905 * @syscap SystemCapability.ArkUI.ArkUI.Full 23906 * @crossplatform 23907 * @since 11 23908 */ 23909 /** 23910 * Animation iterations. When set to -1, the animation playing it repeatedly. The value range is greater than or equal to -1. 23911 * 23912 * @type { ?number } 23913 * @default 1 23914 * @syscap SystemCapability.ArkUI.ArkUI.Full 23915 * @crossplatform 23916 * @atomicservice 23917 * @since 12 23918 */ 23919 iterations?: number; 23920 23921 /** 23922 * Callback invoked when the whole keyframe animation is complete or the ability is about to enter the background. 23923 * 23924 * @type { ?function } 23925 * @syscap SystemCapability.ArkUI.ArkUI.Full 23926 * @crossplatform 23927 * @since 11 23928 */ 23929 /** 23930 * Callback invoked when the whole keyframe animation is complete or the ability is about to enter the background. 23931 * 23932 * @type { ?function } 23933 * @syscap SystemCapability.ArkUI.ArkUI.Full 23934 * @crossplatform 23935 * @atomicservice 23936 * @since 12 23937 */ 23938 onFinish?: () => void; 23939} 23940 23941/** 23942 * Defines a keyframe state. 23943 * 23944 * @interface KeyframeState 23945 * @syscap SystemCapability.ArkUI.ArkUI.Full 23946 * @crossplatform 23947 * @since 11 23948 */ 23949/** 23950 * Defines a keyframe state. 23951 * 23952 * @interface KeyframeState 23953 * @syscap SystemCapability.ArkUI.ArkUI.Full 23954 * @crossplatform 23955 * @atomicservice 23956 * @since 12 23957 */ 23958declare interface KeyframeState { 23959 /** 23960 * Animation duration of this keyframe, in ms. 23961 * 23962 * @type { number } 23963 * @syscap SystemCapability.ArkUI.ArkUI.Full 23964 * @crossplatform 23965 * @since 11 23966 */ 23967 /** 23968 * Animation duration of this keyframe, in ms. 23969 * 23970 * @type { number } 23971 * @syscap SystemCapability.ArkUI.ArkUI.Full 23972 * @crossplatform 23973 * @atomicservice 23974 * @since 12 23975 */ 23976 duration: number; 23977 23978 /** 23979 * Animation curve of this keyframe. 23980 * 23981 * @type { ?(Curve | string | ICurve) } 23982 * @syscap SystemCapability.ArkUI.ArkUI.Full 23983 * @crossplatform 23984 * @since 11 23985 */ 23986 /** 23987 * Animation curve of this keyframe. 23988 * 23989 * @type { ?(Curve | string | ICurve) } 23990 * @syscap SystemCapability.ArkUI.ArkUI.Full 23991 * @crossplatform 23992 * @atomicservice 23993 * @since 12 23994 */ 23995 curve?: Curve | string | ICurve; 23996 23997 /** 23998 * The closure function to specify the terminating state of this keyframe. 23999 * 24000 * @type { function } 24001 * @syscap SystemCapability.ArkUI.ArkUI.Full 24002 * @crossplatform 24003 * @since 11 24004 */ 24005 /** 24006 * The closure function to specify the terminating state of this keyframe. 24007 * 24008 * @type { function } 24009 * @syscap SystemCapability.ArkUI.ArkUI.Full 24010 * @crossplatform 24011 * @atomicservice 24012 * @since 12 24013 */ 24014 event: () => void; 24015} 24016 24017 24018/** 24019 * Defines the basic callback. 24020 * 24021 * @typedef Callback 24022 * @syscap SystemCapability.ArkUI.ArkUI.Full 24023 * @crossplatform 24024 * @atomicservice 24025 * @since 12 24026 */ 24027declare interface Callback<T, V = void> { 24028 /** 24029 * Defines the callback info. 24030 * 24031 * @param { T } data - the data will be used in the callback. 24032 * @returns { V } - Returns result of the callback. 24033 * @syscap SystemCapability.ArkUI.ArkUI.Full 24034 * @crossplatform 24035 * @atomicservice 24036 * @since 12 24037 */ 24038 (data: T): V; 24039} 24040 24041/** 24042 * Defines the callback type used in hover events. 24043 * The value of isHover indicates whether the mouse is hovering over the component. 24044 * The value of event contains information about HoverEvent. 24045 * 24046 * @typedef HoverCallback 24047 * @param { boolean } isHover 24048 * @param { HoverEvent} event 24049 * @syscap SystemCapability.ArkUI.ArkUI.Full 24050 * @crossplatform 24051 * @atomicservice 24052 * @since 12 24053 */ 24054declare type HoverCallback = (isHover: boolean, event: HoverEvent) => void 24055 24056/** 24057 * Defines the callback type used in accessibility hover events. 24058 * The value of isHover indicates whether the touch is hovering over the component. 24059 * The value of event contains information about AccessibilityHoverEvent. 24060 * 24061 * @typedef { function } 24062 * @param { boolean } isHover 24063 * @param { AccessibilityHoverEvent } event 24064 * @syscap SystemCapability.ArkUI.ArkUI.Full 24065 * @crossplatform 24066 * @atomicservice 24067 * @since 12 24068 */ 24069declare type AccessibilityCallback = (isHover: boolean, event: AccessibilityHoverEvent) => void 24070 24071/** 24072 * Defines the options about VisibleAreaEvent. 24073 * 24074 * @interface VisibleAreaEventOptions 24075 * @syscap SystemCapability.ArkUI.ArkUI.Full 24076 * @crossplatform 24077 * @atomicservice 24078 * @since 12 24079 */ 24080declare interface VisibleAreaEventOptions { 24081 /** 24082 * Each number in ratios indicates the value of visibility ratio. Each number in the Array value range in [0, 1]. 24083 * 24084 * @type { Array<number> } 24085 * @syscap SystemCapability.ArkUI.ArkUI.Full 24086 * @crossplatform 24087 * @atomicservice 24088 * @since 12 24089 */ 24090 ratios: Array<number>; 24091 24092 /** 24093 * The value of expectedUpdateInterval indicates desired update period(ms). 24094 * 24095 * @type { ?number } 24096 * @default 1000 24097 * @syscap SystemCapability.ArkUI.ArkUI.Full 24098 * @crossplatform 24099 * @atomicservice 24100 * @since 12 24101 */ 24102 expectedUpdateInterval?: number; 24103} 24104 24105/** 24106 * Defines the callback type used in VisibleAreaChange events. 24107 * 24108 * @typedef { function } VisibleAreaChangeCallback 24109 * @param { boolean } isVisible - Indicates the ratio of the visible area to its own area compared to the last change. 24110 * It is true as the ratio increases and false as the ratio decreases. 24111 * @param { number } currentRatio - The value of currentRatio indicates the visibility ratio of the current component. 24112 * @syscap SystemCapability.ArkUI.ArkUI.Full 24113 * @crossplatform 24114 * @atomicservice 24115 * @since 12 24116 */ 24117/** 24118 * Defines the callback type used in VisibleAreaChange events. 24119 * 24120 * @typedef { function } VisibleAreaChangeCallback 24121 * @param { boolean } isExpanding - Indicates the ratio of the visible area to its own area compared to the last change. 24122 * It is true as the ratio increases and false as the ratio decreases. 24123 * @param { number } currentRatio - The value of currentRatio indicates the visibility ratio of the current component. 24124 * @syscap SystemCapability.ArkUI.ArkUI.Full 24125 * @crossplatform 24126 * @atomicservice 24127 * @since 13 24128 */ 24129declare type VisibleAreaChangeCallback = (isExpanding: boolean, currentRatio: number) => void; 24130 24131/** 24132 * Defines a UICommonEvent which is used to set different common event to target component. 24133 * 24134 * @interface UICommonEvent 24135 * @syscap SystemCapability.ArkUI.ArkUI.Full 24136 * @crossplatform 24137 * @atomicservice 24138 * @since 12 24139 */ 24140declare interface UICommonEvent { 24141 /** 24142 * Set or reset the callback which will be triggered a click event when clicked. 24143 * 24144 * @param { Callback<ClickEvent> | undefined } callback - The callback about the click event. If set undefined will reset the target callback. 24145 * @syscap SystemCapability.ArkUI.ArkUI.Full 24146 * @crossplatform 24147 * @atomicservice 24148 * @since 12 24149 */ 24150 setOnClick(callback: Callback<ClickEvent> | undefined): void; 24151 24152 /** 24153 * Set or reset the callback which will be triggered a touch event when touched. 24154 * 24155 * @param { Callback<TouchEvent> | undefined } callback - The callback about the touch event. If set undefined will reset the target callback. 24156 * @syscap SystemCapability.ArkUI.ArkUI.Full 24157 * @crossplatform 24158 * @atomicservice 24159 * @since 12 24160 */ 24161 setOnTouch(callback: Callback<TouchEvent> | undefined): void; 24162 24163 /** 24164 * Set or reset the callback is triggered when a component mounts a display. 24165 * 24166 * @param { Callback<void> | undefined } callback - The callback will be triggered when a component mounts a display. If set undefined will reset the target callback. 24167 * @syscap SystemCapability.ArkUI.ArkUI.Full 24168 * @crossplatform 24169 * @atomicservice 24170 * @since 12 24171 */ 24172 setOnAppear(callback: Callback<void> | undefined): void; 24173 24174 /** 24175 * Set or reset the callback is triggered when component uninstallation disappears. 24176 * 24177 * @param { Callback<void> | undefined } callback - The callback will be triggered when component uninstallation disappears. If set undefined will reset the target callback. 24178 * @syscap SystemCapability.ArkUI.ArkUI.Full 24179 * @crossplatform 24180 * @atomicservice 24181 * @since 12 24182 */ 24183 setOnDisappear(callback: Callback<void> | undefined): void; 24184 24185 24186 /** 24187 * Set or reset the callback is triggered when component has keyboard input. 24188 * 24189 * @param { Callback<KeyEvent> | undefined } callback - The callback will be triggered when has keyboard input. If set undefined will reset the target callback. 24190 * @syscap SystemCapability.ArkUI.ArkUI.Full 24191 * @crossplatform 24192 * @atomicservice 24193 * @since 12 24194 */ 24195 setOnKeyEvent(callback: Callback<KeyEvent> | undefined): void; 24196 24197 /** 24198 * Set or reset the callback which is triggered when component get focus. 24199 * 24200 * @param { Callback<void> | undefined } callback - The callback will be triggered when a component get focus. If set undefined will reset the target callback. 24201 * @syscap SystemCapability.ArkUI.ArkUI.Full 24202 * @crossplatform 24203 * @atomicservice 24204 * @since 12 24205 */ 24206 setOnFocus(callback: Callback<void> | undefined): void; 24207 24208 /** 24209 * Set or reset the callback which is triggered when lose focus. 24210 * 24211 * @param { Callback<void> | undefined } callback - The callback will be triggered when a component lose focus. If set undefined will reset the target callback. 24212 * @syscap SystemCapability.ArkUI.ArkUI.Full 24213 * @crossplatform 24214 * @atomicservice 24215 * @since 12 24216 */ 24217 setOnBlur(callback: Callback<void> | undefined): void; 24218 24219 /** 24220 * Set or reset the callback which is triggered when has a hover event. 24221 * 24222 * @param { HoverCallback | undefined } callback - The callback will be triggered when has a hover event. If set undefined will reset the target callback. 24223 * @syscap SystemCapability.ArkUI.ArkUI.Full 24224 * @crossplatform 24225 * @atomicservice 24226 * @since 12 24227 */ 24228 setOnHover(callback: HoverCallback | undefined): void; 24229 24230 /** 24231 * Set or reset the callback which is triggered when has a mouse event. 24232 * 24233 * @param { Callback<MouseEvent> | undefined } callback - The callback will be triggered when has mouse input. If set undefined will reset the target callback. 24234 * @syscap SystemCapability.ArkUI.ArkUI.Full 24235 * @crossplatform 24236 * @atomicservice 24237 * @since 12 24238 */ 24239 setOnMouse(callback: Callback<MouseEvent> | undefined): void; 24240 24241 /** 24242 * Set or reset the callback which is triggered when the size of component changed. 24243 * 24244 * @param { SizeChangeCallback | undefined } callback - The callback will be triggered when the size of component changed. If set undefined will reset the target callback. 24245 * @syscap SystemCapability.ArkUI.ArkUI.Full 24246 * @crossplatform 24247 * @atomicservice 24248 * @since 12 24249 */ 24250 setOnSizeChange(callback: SizeChangeCallback | undefined): void; 24251 24252 /** 24253 * Set or reset the callback which is triggered when the visibleArea of component changed. 24254 * 24255 * @param { VisibleAreaEventOptions } options - The options for the visibility event. 24256 * @param { VisibleAreaChangeCallback | undefined } event - The callback will be triggered when the visibleArea of component changed and get close to any number in ratios defined by options. 24257 * If set undefined will reset the target callback. 24258 * @syscap SystemCapability.ArkUI.ArkUI.Full 24259 * @crossplatform 24260 * @atomicservice 24261 * @since 12 24262 */ 24263 setOnVisibleAreaApproximateChange(options: VisibleAreaEventOptions, event: VisibleAreaChangeCallback | undefined): void; 24264} 24265 24266/** 24267 * Defines a UIGestureEvent which is used to set different gestures to target component. 24268 * 24269 * @interface UIGestureEvent 24270 * @syscap SystemCapability.ArkUI.ArkUI.Full 24271 * @crossplatform 24272 * @atomicservice 24273 * @since 12 24274 */ 24275declare interface UIGestureEvent { 24276 /** 24277 * Add a gesture bound to the component. 24278 * 24279 * @param { GestureHandler<T> } gesture - gesture indicates the gesture bound to a component. 24280 * @param { GesturePriority } priority - priority indicates the gesture's priority. 24281 * @param { GestureMask } mask - mask indicates the gesture's GestureMask value. 24282 * @syscap SystemCapability.ArkUI.ArkUI.Full 24283 * @crossplatform 24284 * @atomicservice 24285 * @since 12 24286 */ 24287 addGesture<T>(gesture: GestureHandler<T>, priority?: GesturePriority, mask?: GestureMask): void; 24288 24289 /** 24290 * Add a parallel gesture bound to the component. 24291 * 24292 * @param { GestureHandler<T> } gesture - gesture indicates the gesture bound to a component. 24293 * @param { GestureMask } mask - mask indicates the gesture's GestureMask value. 24294 * @syscap SystemCapability.ArkUI.ArkUI.Full 24295 * @crossplatform 24296 * @atomicservice 24297 * @since 12 24298 */ 24299 addParallelGesture<T>(gesture: GestureHandler<T>, mask?: GestureMask): void; 24300 24301 /** 24302 * Remove the gesture that is bound to the component and marked as tag. 24303 * 24304 * @param { string } tag - tag indicates the gesture's tag. 24305 * @syscap SystemCapability.ArkUI.ArkUI.Full 24306 * @crossplatform 24307 * @atomicservice 24308 * @since 12 24309 */ 24310 removeGestureByTag(tag: string): void; 24311 24312 /** 24313 * Clear gestures bound to the component. 24314 * 24315 * @syscap SystemCapability.ArkUI.ArkUI.Full 24316 * @crossplatform 24317 * @atomicservice 24318 * @since 12 24319 */ 24320 clearGestures(): void; 24321} 24322 24323/** 24324 * Defines the gesture modifier. 24325 * 24326 * @interface GestureModifier 24327 * @syscap SystemCapability.ArkUI.ArkUI.Full 24328 * @crossplatform 24329 * @atomicservice 24330 * @since 12 24331 */ 24332declare interface GestureModifier { 24333 /** 24334 * Defines the gesture update function. 24335 * 24336 * @param { UIGestureEvent } event 24337 * @syscap SystemCapability.ArkUI.ArkUI.Full 24338 * @crossplatform 24339 * @atomicservice 24340 * @since 12 24341 */ 24342 applyGesture(event: UIGestureEvent): void; 24343} 24344 24345/** 24346 * Defines the selection options. 24347 * 24348 * @interface SelectionOptions 24349 * @syscap SystemCapability.ArkUI.ArkUI.Full 24350 * @crossplatform 24351 * @atomicservice 24352 * @since 12 24353 */ 24354declare interface SelectionOptions { 24355 /** 24356 * Menu pop-up policy. 24357 * 24358 * @type { ?MenuPolicy } 24359 * @syscap SystemCapability.ArkUI.ArkUI.Full 24360 * @crossplatform 24361 * @atomicservice 24362 * @since 12 24363 */ 24364 menuPolicy?: MenuPolicy; 24365} 24366 24367/** 24368 * enum keyboard avoid mode 24369 * 24370 * @enum { number } 24371 * @syscap SystemCapability.ArkUI.ArkUI.Full 24372 * @crossplatform 24373 * @atomicservice 24374 * @since 12 24375 */ 24376declare enum KeyboardAvoidMode { 24377 /** 24378 * Defines avoid keyboard when keyboard shows. 24379 * 24380 * @syscap SystemCapability.ArkUI.ArkUI.Full 24381 * @crossplatform 24382 * @atomicservice 24383 * @since 12 24384 */ 24385 DEFAULT = 0, 24386 24387 /** 24388 * Defines not avoid keyboard when keyboard shows. 24389 * 24390 * @syscap SystemCapability.ArkUI.ArkUI.Full 24391 * @crossplatform 24392 * @atomicservice 24393 * @since 12 24394 */ 24395 NONE = 1, 24396} 24397 24398/** 24399 * Enumerates the type of area in hover mode. 24400 * 24401 * @enum { number } 24402 * @syscap SystemCapability.ArkUI.ArkUI.Full 24403 * @crossplatform 24404 * @atomicservice 24405 * @since 13 24406 */ 24407declare enum HoverModeAreaType { 24408 24409 /** 24410 * Layout top half screen when the phone in hover mode. 24411 * 24412 * @syscap SystemCapability.ArkUI.ArkUI.Full 24413 * @crossplatform 24414 * @atomicservice 24415 * @since 13 24416 */ 24417 TOP_SCREEN = 0, 24418 24419 /** 24420 * Layout bottom half screen when the phone in hover mode. 24421 * 24422 * @syscap SystemCapability.ArkUI.ArkUI.Full 24423 * @crossplatform 24424 * @atomicservice 24425 * @since 13 24426 */ 24427 BOTTOM_SCREEN = 1, 24428} 24429