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 * @syscap SystemCapability.ArkUI.ArkUI.Full 2706 * @crossplatform 2707 * @atomicservice 2708 * @since 12 2709 */ 2710 follow?: boolean; 2711 /** 2712 * Defines movement strategy of source and target in the hierarchy during geometry transition. 2713 * 2714 * @type { ?TransitionHierarchyStrategy } 2715 * @default TransitionHierarchyStrategy.ADAPTIVE 2716 * @syscap SystemCapability.ArkUI.ArkUI.Full 2717 * @systemapi 2718 * @atomicservice 2719 * @since 12 2720 */ 2721 /** 2722 * Defines movement strategy of source and target in the hierarchy during geometry transition. 2723 * 2724 * @type { ?TransitionHierarchyStrategy } 2725 * @default TransitionHierarchyStrategy.ADAPTIVE 2726 * @syscap SystemCapability.ArkUI.ArkUI.Full 2727 * @systemapi 2728 * @since 13 2729 */ 2730 hierarchyStrategy?: TransitionHierarchyStrategy 2731} 2732 2733/** 2734 * Source and target are two matched elements during the geometry transition. 2735 * The animation starts at the source and ends at the target. 2736 * TransitionHierarchyStrategy enumeration defines how levels of source and target elements 2737 * would be changed in the hierarchy during the geometry transition. 2738 * 2739 * @enum { number } 2740 * @syscap SystemCapability.ArkUI.ArkUI.Full 2741 * @systemapi 2742 * @atomicservice 2743 * @since 12 2744 */ 2745/** 2746 * Source and target are two matched elements during the geometry transition. 2747 * The animation starts at the source and ends at the target. 2748 * TransitionHierarchyStrategy enumeration defines how levels of source and target elements 2749 * would be changed in the hierarchy during the geometry transition. 2750 * 2751 * @enum { number } 2752 * @syscap SystemCapability.ArkUI.ArkUI.Full 2753 * @systemapi 2754 * @since 13 2755 */ 2756declare enum TransitionHierarchyStrategy { 2757 /** 2758 * None mode. 2759 * Source and target staty in the original level in the hierarchy during geometry transition. 2760 * 2761 * @syscap SystemCapability.ArkUI.ArkUI.Full 2762 * @systemapi 2763 * @atomicservice 2764 * @since 12 2765 */ 2766 /** 2767 * None mode. 2768 * Source and target staty in the original level in the hierarchy during geometry transition. 2769 * 2770 * @syscap SystemCapability.ArkUI.ArkUI.Full 2771 * @systemapi 2772 * @since 13 2773 */ 2774 NONE = 0, 2775 2776 /** 2777 * ADAPTIVE mode. 2778 * Lower level one of source and target is elevated to higher level of both, 2779 * indicating that two elements are in same high level. 2780 * 2781 * @syscap SystemCapability.ArkUI.ArkUI.Full 2782 * @systemapi 2783 * @atomicservice 2784 * @since 12 2785 */ 2786 /** 2787 * ADAPTIVE mode. 2788 * Lower level one of source and target is elevated to higher level of both, 2789 * indicating that two elements are in same high level. 2790 * 2791 * @syscap SystemCapability.ArkUI.ArkUI.Full 2792 * @systemapi 2793 * @since 13 2794 */ 2795 ADAPTIVE = 1, 2796} 2797 2798/** 2799 * Defines the options of translate. 2800 * 2801 * @interface TranslateOptions 2802 * @syscap SystemCapability.ArkUI.ArkUI.Full 2803 * @since 7 2804 */ 2805/** 2806 * Defines the options of translate. 2807 * 2808 * @interface TranslateOptions 2809 * @syscap SystemCapability.ArkUI.ArkUI.Full 2810 * @form 2811 * @since 9 2812 */ 2813/** 2814 * Defines the options of translate. 2815 * 2816 * @interface TranslateOptions 2817 * @syscap SystemCapability.ArkUI.ArkUI.Full 2818 * @crossplatform 2819 * @form 2820 * @since 10 2821 */ 2822/** 2823 * Defines the options of translate. 2824 * 2825 * @interface TranslateOptions 2826 * @syscap SystemCapability.ArkUI.ArkUI.Full 2827 * @crossplatform 2828 * @form 2829 * @atomicservice 2830 * @since 11 2831 */ 2832declare interface TranslateOptions { 2833 /** 2834 * The param of x direction. 2835 * 2836 * @type { ?(number | string) } 2837 * @syscap SystemCapability.ArkUI.ArkUI.Full 2838 * @since 7 2839 */ 2840 /** 2841 * The param of x direction. 2842 * 2843 * @type { ?(number | string) } 2844 * @syscap SystemCapability.ArkUI.ArkUI.Full 2845 * @form 2846 * @since 9 2847 */ 2848 /** 2849 * The param of x direction. 2850 * 2851 * @type { ?(number | string) } 2852 * @syscap SystemCapability.ArkUI.ArkUI.Full 2853 * @crossplatform 2854 * @form 2855 * @since 10 2856 */ 2857 /** 2858 * The param of x direction. 2859 * 2860 * @type { ?(number | string) } 2861 * @syscap SystemCapability.ArkUI.ArkUI.Full 2862 * @crossplatform 2863 * @form 2864 * @atomicservice 2865 * @since 11 2866 */ 2867 x?: number | string; 2868 2869 /** 2870 * The param of y direction. 2871 * 2872 * @type { ?(number | string) } 2873 * @syscap SystemCapability.ArkUI.ArkUI.Full 2874 * @since 7 2875 */ 2876 /** 2877 * The param of y direction. 2878 * 2879 * @type { ?(number | string) } 2880 * @syscap SystemCapability.ArkUI.ArkUI.Full 2881 * @form 2882 * @since 9 2883 */ 2884 /** 2885 * The param of y direction. 2886 * 2887 * @type { ?(number | string) } 2888 * @syscap SystemCapability.ArkUI.ArkUI.Full 2889 * @crossplatform 2890 * @form 2891 * @since 10 2892 */ 2893 /** 2894 * The param of y direction. 2895 * 2896 * @type { ?(number | string) } 2897 * @syscap SystemCapability.ArkUI.ArkUI.Full 2898 * @crossplatform 2899 * @form 2900 * @atomicservice 2901 * @since 11 2902 */ 2903 y?: number | string; 2904 2905 /** 2906 * The param of z direction. 2907 * 2908 * @type { ?(number | string) } 2909 * @syscap SystemCapability.ArkUI.ArkUI.Full 2910 * @since 7 2911 */ 2912 /** 2913 * The param of z direction. 2914 * 2915 * @type { ?(number | string) } 2916 * @syscap SystemCapability.ArkUI.ArkUI.Full 2917 * @form 2918 * @since 9 2919 */ 2920 /** 2921 * The param of z direction. 2922 * 2923 * @type { ?(number | string) } 2924 * @syscap SystemCapability.ArkUI.ArkUI.Full 2925 * @crossplatform 2926 * @form 2927 * @since 10 2928 */ 2929 /** 2930 * The param of z direction. 2931 * 2932 * @type { ?(number | string) } 2933 * @syscap SystemCapability.ArkUI.ArkUI.Full 2934 * @crossplatform 2935 * @form 2936 * @atomicservice 2937 * @since 11 2938 */ 2939 z?: number | string; 2940} 2941 2942/** 2943 * Defines the options of scale. 2944 * 2945 * @interface ScaleOptions 2946 * @syscap SystemCapability.ArkUI.ArkUI.Full 2947 * @since 7 2948 */ 2949/** 2950 * Defines the options of scale. 2951 * 2952 * @interface ScaleOptions 2953 * @syscap SystemCapability.ArkUI.ArkUI.Full 2954 * @form 2955 * @since 9 2956 */ 2957/** 2958 * Defines the options of scale. 2959 * 2960 * @interface ScaleOptions 2961 * @syscap SystemCapability.ArkUI.ArkUI.Full 2962 * @crossplatform 2963 * @form 2964 * @since 10 2965 */ 2966/** 2967 * Defines the options of scale. 2968 * 2969 * @interface ScaleOptions 2970 * @syscap SystemCapability.ArkUI.ArkUI.Full 2971 * @crossplatform 2972 * @form 2973 * @atomicservice 2974 * @since 11 2975 */ 2976declare interface ScaleOptions { 2977 /** 2978 * The param of x direction. 2979 * 2980 * @type { ?number } 2981 * @syscap SystemCapability.ArkUI.ArkUI.Full 2982 * @since 7 2983 */ 2984 /** 2985 * The param of x direction. 2986 * 2987 * @type { ?number } 2988 * @syscap SystemCapability.ArkUI.ArkUI.Full 2989 * @form 2990 * @since 9 2991 */ 2992 /** 2993 * The param of x direction. 2994 * 2995 * @type { ?number } 2996 * @syscap SystemCapability.ArkUI.ArkUI.Full 2997 * @crossplatform 2998 * @form 2999 * @since 10 3000 */ 3001 /** 3002 * The param of x direction. 3003 * 3004 * @type { ?number } 3005 * @syscap SystemCapability.ArkUI.ArkUI.Full 3006 * @crossplatform 3007 * @form 3008 * @atomicservice 3009 * @since 11 3010 */ 3011 x?: number; 3012 3013 /** 3014 * The param of y direction. 3015 * 3016 * @type { ?number } 3017 * @syscap SystemCapability.ArkUI.ArkUI.Full 3018 * @since 7 3019 */ 3020 /** 3021 * The param of y direction. 3022 * 3023 * @type { ?number } 3024 * @syscap SystemCapability.ArkUI.ArkUI.Full 3025 * @form 3026 * @since 9 3027 */ 3028 /** 3029 * The param of y direction. 3030 * 3031 * @type { ?number } 3032 * @syscap SystemCapability.ArkUI.ArkUI.Full 3033 * @crossplatform 3034 * @form 3035 * @since 10 3036 */ 3037 /** 3038 * The param of y direction. 3039 * 3040 * @type { ?number } 3041 * @syscap SystemCapability.ArkUI.ArkUI.Full 3042 * @crossplatform 3043 * @form 3044 * @atomicservice 3045 * @since 11 3046 */ 3047 y?: number; 3048 3049 /** 3050 * The param of z direction. 3051 * 3052 * @type { ?number } 3053 * @syscap SystemCapability.ArkUI.ArkUI.Full 3054 * @since 7 3055 */ 3056 /** 3057 * The param of z direction. 3058 * 3059 * @type { ?number } 3060 * @syscap SystemCapability.ArkUI.ArkUI.Full 3061 * @form 3062 * @since 9 3063 */ 3064 /** 3065 * The param of z direction. 3066 * 3067 * @type { ?number } 3068 * @syscap SystemCapability.ArkUI.ArkUI.Full 3069 * @crossplatform 3070 * @form 3071 * @since 10 3072 */ 3073 /** 3074 * The param of z direction. 3075 * 3076 * @type { ?number } 3077 * @syscap SystemCapability.ArkUI.ArkUI.Full 3078 * @crossplatform 3079 * @form 3080 * @atomicservice 3081 * @since 11 3082 */ 3083 z?: number; 3084 3085 /** 3086 * The param of center point of x. 3087 * 3088 * @type { ?(number | string) } 3089 * @syscap SystemCapability.ArkUI.ArkUI.Full 3090 * @since 7 3091 */ 3092 /** 3093 * The param of center point of x. 3094 * 3095 * @type { ?(number | string) } 3096 * @syscap SystemCapability.ArkUI.ArkUI.Full 3097 * @form 3098 * @since 9 3099 */ 3100 /** 3101 * The param of center point of x. 3102 * 3103 * @type { ?(number | string) } 3104 * @syscap SystemCapability.ArkUI.ArkUI.Full 3105 * @crossplatform 3106 * @form 3107 * @since 10 3108 */ 3109 /** 3110 * The param of center point of x. 3111 * 3112 * @type { ?(number | string) } 3113 * @syscap SystemCapability.ArkUI.ArkUI.Full 3114 * @crossplatform 3115 * @form 3116 * @atomicservice 3117 * @since 11 3118 */ 3119 centerX?: number | string; 3120 3121 /** 3122 * The param of center point of y. 3123 * 3124 * @type { ?(number | string) } 3125 * @syscap SystemCapability.ArkUI.ArkUI.Full 3126 * @since 7 3127 */ 3128 /** 3129 * The param of center point of y. 3130 * 3131 * @type { ?(number | string) } 3132 * @syscap SystemCapability.ArkUI.ArkUI.Full 3133 * @form 3134 * @since 9 3135 */ 3136 /** 3137 * The param of center point of y. 3138 * 3139 * @type { ?(number | string) } 3140 * @syscap SystemCapability.ArkUI.ArkUI.Full 3141 * @crossplatform 3142 * @form 3143 * @since 10 3144 */ 3145 /** 3146 * The param of center point of y. 3147 * 3148 * @type { ?(number | string) } 3149 * @syscap SystemCapability.ArkUI.ArkUI.Full 3150 * @crossplatform 3151 * @form 3152 * @atomicservice 3153 * @since 11 3154 */ 3155 centerY?: number | string; 3156} 3157 3158/** 3159 * Defines the align rule options of relative container. 3160 * 3161 * @interface AlignRuleOption 3162 * @syscap SystemCapability.ArkUI.ArkUI.Full 3163 * @form 3164 * @since 9 3165 */ 3166/** 3167 * Defines the align rule options of relative container. 3168 * 3169 * @interface AlignRuleOption 3170 * @syscap SystemCapability.ArkUI.ArkUI.Full 3171 * @crossplatform 3172 * @form 3173 * @since 10 3174 */ 3175/** 3176 * Defines the align rule options of relative container. 3177 * 3178 * @interface AlignRuleOption 3179 * @syscap SystemCapability.ArkUI.ArkUI.Full 3180 * @crossplatform 3181 * @form 3182 * @atomicservice 3183 * @since 11 3184 */ 3185declare interface AlignRuleOption { 3186 /** 3187 * The param of left align. 3188 * 3189 * @type { ?object } 3190 * @syscap SystemCapability.ArkUI.ArkUI.Full 3191 * @form 3192 * @since 9 3193 */ 3194 /** 3195 * The param of left align. 3196 * 3197 * @type { ?object } 3198 * @syscap SystemCapability.ArkUI.ArkUI.Full 3199 * @crossplatform 3200 * @form 3201 * @since 10 3202 */ 3203 /** 3204 * The param of left align. 3205 * 3206 * @type { ?object } 3207 * @syscap SystemCapability.ArkUI.ArkUI.Full 3208 * @crossplatform 3209 * @form 3210 * @atomicservice 3211 * @since 11 3212 */ 3213 left?: { anchor: string, align: HorizontalAlign }; 3214 3215 /** 3216 * The param of right align. 3217 * 3218 * @type { ?object } 3219 * @syscap SystemCapability.ArkUI.ArkUI.Full 3220 * @form 3221 * @since 9 3222 */ 3223 /** 3224 * The param of right align. 3225 * 3226 * @type { ?object } 3227 * @syscap SystemCapability.ArkUI.ArkUI.Full 3228 * @crossplatform 3229 * @form 3230 * @since 10 3231 */ 3232 /** 3233 * The param of right align. 3234 * 3235 * @type { ?object } 3236 * @syscap SystemCapability.ArkUI.ArkUI.Full 3237 * @crossplatform 3238 * @form 3239 * @atomicservice 3240 * @since 11 3241 */ 3242 right?: { anchor: string, align: HorizontalAlign }; 3243 3244 /** 3245 * The param of middle align. 3246 * 3247 * @type { ?object } 3248 * @syscap SystemCapability.ArkUI.ArkUI.Full 3249 * @form 3250 * @since 9 3251 */ 3252 /** 3253 * The param of middle align. 3254 * 3255 * @type { ?object } 3256 * @syscap SystemCapability.ArkUI.ArkUI.Full 3257 * @crossplatform 3258 * @form 3259 * @since 10 3260 */ 3261 /** 3262 * The param of middle align. 3263 * 3264 * @type { ?object } 3265 * @syscap SystemCapability.ArkUI.ArkUI.Full 3266 * @crossplatform 3267 * @form 3268 * @atomicservice 3269 * @since 11 3270 */ 3271 middle?: { anchor: string, align: HorizontalAlign }; 3272 3273 /** 3274 * The param of top align. 3275 * 3276 * @type { ?object } 3277 * @syscap SystemCapability.ArkUI.ArkUI.Full 3278 * @form 3279 * @since 9 3280 */ 3281 /** 3282 * The param of top align. 3283 * 3284 * @type { ?object } 3285 * @syscap SystemCapability.ArkUI.ArkUI.Full 3286 * @crossplatform 3287 * @form 3288 * @since 10 3289 */ 3290 /** 3291 * The param of top align. 3292 * 3293 * @type { ?object } 3294 * @syscap SystemCapability.ArkUI.ArkUI.Full 3295 * @crossplatform 3296 * @form 3297 * @atomicservice 3298 * @since 11 3299 */ 3300 top?: { anchor: string, align: VerticalAlign }; 3301 3302 /** 3303 * The param of bottom align. 3304 * 3305 * @type { ?object } 3306 * @syscap SystemCapability.ArkUI.ArkUI.Full 3307 * @form 3308 * @since 9 3309 */ 3310 /** 3311 * The param of bottom align. 3312 * 3313 * @type { ?object } 3314 * @syscap SystemCapability.ArkUI.ArkUI.Full 3315 * @form 3316 * @since 10 3317 */ 3318 /** 3319 * The param of bottom align. 3320 * 3321 * @type { ?object } 3322 * @syscap SystemCapability.ArkUI.ArkUI.Full 3323 * @form 3324 * @atomicservice 3325 * @since 11 3326 */ 3327 bottom?: { anchor: string, align: VerticalAlign }; 3328 3329 /** 3330 * The param of center align. 3331 * 3332 * @type { ?object } 3333 * @syscap SystemCapability.ArkUI.ArkUI.Full 3334 * @form 3335 * @since 9 3336 */ 3337 /** 3338 * The param of center align. 3339 * 3340 * @type { ?object } 3341 * @syscap SystemCapability.ArkUI.ArkUI.Full 3342 * @crossplatform 3343 * @form 3344 * @since 10 3345 */ 3346 /** 3347 * The param of center align. 3348 * 3349 * @type { ?object } 3350 * @syscap SystemCapability.ArkUI.ArkUI.Full 3351 * @crossplatform 3352 * @form 3353 * @atomicservice 3354 * @since 11 3355 */ 3356 center?: { anchor: string, align: VerticalAlign }; 3357 3358 /** 3359 * Defines the bias ratio in horizontal and vertical direction. 3360 * 3361 * @type { ?Bias } 3362 * @default {horizontal:0.5,vertical:0.5} 3363 * @syscap SystemCapability.ArkUI.ArkUI.Full 3364 * @crossplatform 3365 * @form 3366 * @since 11 3367 */ 3368 /** 3369 * Defines the bias ratio in horizontal and vertical direction. 3370 * 3371 * @type { ?Bias } 3372 * @default {horizontal:0.5,vertical:0.5} 3373 * @syscap SystemCapability.ArkUI.ArkUI.Full 3374 * @crossplatform 3375 * @form 3376 * @atomicservice 3377 * @since 12 3378 */ 3379 bias?: Bias; 3380} 3381 3382/** 3383 * Defines the localized horizontal align param of relative container. 3384 * 3385 * @interface LocalizedHorizontalAlignParam 3386 * @syscap SystemCapability.ArkUI.ArkUI.Full 3387 * @crossplatform 3388 * @atomicservice 3389 * @since 12 3390 */ 3391declare interface LocalizedHorizontalAlignParam { 3392 /** 3393 * The anchor of localized align param. 3394 * 3395 * @type { string } 3396 * @syscap SystemCapability.ArkUI.ArkUI.Full 3397 * @crossplatform 3398 * @atomicservice 3399 * @since 12 3400 */ 3401 anchor: string; 3402 3403 /** 3404 * The align of localized align param. 3405 * 3406 * @type { HorizontalAlign } 3407 * @syscap SystemCapability.ArkUI.ArkUI.Full 3408 * @crossplatform 3409 * @atomicservice 3410 * @since 12 3411 */ 3412 align: HorizontalAlign; 3413} 3414 3415/** 3416 * Defines the localized vertical align param of relative container. 3417 * 3418 * @interface LocalizedVerticalAlignParam 3419 * @syscap SystemCapability.ArkUI.ArkUI.Full 3420 * @crossplatform 3421 * @atomicservice 3422 * @since 12 3423 */ 3424declare interface LocalizedVerticalAlignParam { 3425 /** 3426 * The anchor of localized align param. 3427 * 3428 * @type { string } 3429 * @syscap SystemCapability.ArkUI.ArkUI.Full 3430 * @crossplatform 3431 * @atomicservice 3432 * @since 12 3433 */ 3434 anchor: string; 3435 3436 /** 3437 * The align of localized align param. 3438 * 3439 * @type { VerticalAlign } 3440 * @syscap SystemCapability.ArkUI.ArkUI.Full 3441 * @crossplatform 3442 * @atomicservice 3443 * @since 12 3444 */ 3445 align: VerticalAlign; 3446} 3447 3448/** 3449 * Defines the Localized align rule options of relative container. 3450 * 3451 * @interface LocalizedAlignRuleOptions 3452 * @syscap SystemCapability.ArkUI.ArkUI.Full 3453 * @crossplatform 3454 * @atomicservice 3455 * @since 12 3456 */ 3457declare interface LocalizedAlignRuleOptions { 3458 /** 3459 * The param of start align. 3460 * 3461 * @type { ?LocalizedHorizontalAlignParam } 3462 * @syscap SystemCapability.ArkUI.ArkUI.Full 3463 * @crossplatform 3464 * @atomicservice 3465 * @since 12 3466 */ 3467 start?: LocalizedHorizontalAlignParam; 3468 3469 /** 3470 * The param of end align. 3471 * 3472 * @type { ?LocalizedHorizontalAlignParam } 3473 * @syscap SystemCapability.ArkUI.ArkUI.Full 3474 * @crossplatform 3475 * @atomicservice 3476 * @since 12 3477 */ 3478 end?: LocalizedHorizontalAlignParam; 3479 3480 /** 3481 * The param of middle align. 3482 * 3483 * @type { ?LocalizedHorizontalAlignParam } 3484 * @syscap SystemCapability.ArkUI.ArkUI.Full 3485 * @crossplatform 3486 * @atomicservice 3487 * @since 12 3488 */ 3489 middle?: LocalizedHorizontalAlignParam; 3490 3491 /** 3492 * The param of top align. 3493 * 3494 * @type { ?LocalizedVerticalAlignParam } 3495 * @syscap SystemCapability.ArkUI.ArkUI.Full 3496 * @crossplatform 3497 * @atomicservice 3498 * @since 12 3499 */ 3500 top?: LocalizedVerticalAlignParam; 3501 3502 /** 3503 * The param of bottom align. 3504 * 3505 * @type { ?LocalizedVerticalAlignParam } 3506 * @syscap SystemCapability.ArkUI.ArkUI.Full 3507 * @crossplatform 3508 * @atomicservice 3509 * @since 12 3510 */ 3511 bottom?: LocalizedVerticalAlignParam; 3512 3513 /** 3514 * The param of center align. 3515 * 3516 * @type { ?LocalizedVerticalAlignParam } 3517 * @syscap SystemCapability.ArkUI.ArkUI.Full 3518 * @crossplatform 3519 * @atomicservice 3520 * @since 12 3521 */ 3522 center?: LocalizedVerticalAlignParam; 3523 3524 /** 3525 * Defines the bias ratio in horizontal and vertical direction. 3526 * 3527 * @type { ?Bias } 3528 * @default {horizontal:0.5,vertical:0.5} 3529 * @syscap SystemCapability.ArkUI.ArkUI.Full 3530 * @crossplatform 3531 * @atomicservice 3532 * @since 12 3533 */ 3534 bias?: Bias; 3535} 3536 3537/** 3538 * Defines the style of the chain in relative container. 3539 * 3540 * @enum { number } 3541 * @syscap SystemCapability.ArkUI.ArkUI.Full 3542 * @crossplatform 3543 * @atomicservice 3544 * @since 12 3545 */ 3546declare enum ChainStyle { 3547 /** 3548 * Elements of the chain will be spread out. 3549 * 3550 * @syscap SystemCapability.ArkUI.ArkUI.Full 3551 * @crossplatform 3552 * @atomicservice 3553 * @since 12 3554 */ 3555 SPREAD, 3556 3557 /** 3558 * Elements except chain's head and tail will be spread out. 3559 * 3560 * @syscap SystemCapability.ArkUI.ArkUI.Full 3561 * @crossplatform 3562 * @atomicservice 3563 * @since 12 3564 */ 3565 SPREAD_INSIDE, 3566 3567 /** 3568 * Elements of the chain will be packed together. 3569 * 3570 * @syscap SystemCapability.ArkUI.ArkUI.Full 3571 * @crossplatform 3572 * @atomicservice 3573 * @since 12 3574 */ 3575 PACKED, 3576} 3577 3578/** 3579 * The param of rotate. 3580 * 3581 * @interface RotateOptions 3582 * @syscap SystemCapability.ArkUI.ArkUI.Full 3583 * @since 7 3584 */ 3585/** 3586 * The param of rotate. 3587 * 3588 * @interface RotateOptions 3589 * @syscap SystemCapability.ArkUI.ArkUI.Full 3590 * @form 3591 * @since 9 3592 */ 3593/** 3594 * The param of rotate. 3595 * 3596 * @interface RotateOptions 3597 * @syscap SystemCapability.ArkUI.ArkUI.Full 3598 * @crossplatform 3599 * @form 3600 * @since 10 3601 */ 3602/** 3603 * The param of rotate. 3604 * 3605 * @interface RotateOptions 3606 * @syscap SystemCapability.ArkUI.ArkUI.Full 3607 * @crossplatform 3608 * @form 3609 * @atomicservice 3610 * @since 11 3611 */ 3612declare interface RotateOptions { 3613 /** 3614 * The param of x direction. 3615 * 3616 * @type { ?number } 3617 * @syscap SystemCapability.ArkUI.ArkUI.Full 3618 * @since 7 3619 */ 3620 /** 3621 * The param of x direction. 3622 * 3623 * @type { ?number } 3624 * @syscap SystemCapability.ArkUI.ArkUI.Full 3625 * @form 3626 * @since 9 3627 */ 3628 /** 3629 * The param of x direction. 3630 * 3631 * @type { ?number } 3632 * @syscap SystemCapability.ArkUI.ArkUI.Full 3633 * @crossplatform 3634 * @form 3635 * @since 10 3636 */ 3637 /** 3638 * The param of x direction. 3639 * 3640 * @type { ?number } 3641 * @syscap SystemCapability.ArkUI.ArkUI.Full 3642 * @crossplatform 3643 * @form 3644 * @atomicservice 3645 * @since 11 3646 */ 3647 x?: number; 3648 3649 /** 3650 * The param of y direction. 3651 * 3652 * @type { ?number } 3653 * @syscap SystemCapability.ArkUI.ArkUI.Full 3654 * @since 7 3655 */ 3656 /** 3657 * The param of y direction. 3658 * 3659 * @type { ?number } 3660 * @syscap SystemCapability.ArkUI.ArkUI.Full 3661 * @form 3662 * @since 9 3663 */ 3664 /** 3665 * The param of y direction. 3666 * 3667 * @type { ?number } 3668 * @syscap SystemCapability.ArkUI.ArkUI.Full 3669 * @crossplatform 3670 * @form 3671 * @since 10 3672 */ 3673 /** 3674 * The param of y direction. 3675 * 3676 * @type { ?number } 3677 * @syscap SystemCapability.ArkUI.ArkUI.Full 3678 * @crossplatform 3679 * @form 3680 * @atomicservice 3681 * @since 11 3682 */ 3683 y?: number; 3684 3685 /** 3686 * The param of z direction. 3687 * 3688 * @type { ?number } 3689 * @syscap SystemCapability.ArkUI.ArkUI.Full 3690 * @since 7 3691 */ 3692 /** 3693 * The param of z direction. 3694 * 3695 * @type { ?number } 3696 * @syscap SystemCapability.ArkUI.ArkUI.Full 3697 * @form 3698 * @since 9 3699 */ 3700 /** 3701 * The param of z direction. 3702 * 3703 * @type { ?number } 3704 * @syscap SystemCapability.ArkUI.ArkUI.Full 3705 * @crossplatform 3706 * @form 3707 * @since 10 3708 */ 3709 /** 3710 * The param of z direction. 3711 * 3712 * @type { ?number } 3713 * @syscap SystemCapability.ArkUI.ArkUI.Full 3714 * @crossplatform 3715 * @form 3716 * @atomicservice 3717 * @since 11 3718 */ 3719 z?: number; 3720 3721 /** 3722 * The param of center point of x. 3723 * 3724 * @type { ?(number | string) } 3725 * @syscap SystemCapability.ArkUI.ArkUI.Full 3726 * @since 7 3727 */ 3728 /** 3729 * The param of center point of x. 3730 * 3731 * @type { ?(number | string) } 3732 * @syscap SystemCapability.ArkUI.ArkUI.Full 3733 * @form 3734 * @since 9 3735 */ 3736 /** 3737 * The param of center point of x. 3738 * 3739 * @type { ?(number | string) } 3740 * @syscap SystemCapability.ArkUI.ArkUI.Full 3741 * @crossplatform 3742 * @form 3743 * @since 10 3744 */ 3745 /** 3746 * The param of center point of x. 3747 * 3748 * @type { ?(number | string) } 3749 * @syscap SystemCapability.ArkUI.ArkUI.Full 3750 * @crossplatform 3751 * @form 3752 * @atomicservice 3753 * @since 11 3754 */ 3755 centerX?: number | string; 3756 3757 /** 3758 * The param of center point of y. 3759 * 3760 * @type { ?(number | string) } 3761 * @syscap SystemCapability.ArkUI.ArkUI.Full 3762 * @since 7 3763 */ 3764 /** 3765 * The param of center point of y. 3766 * 3767 * @type { ?(number | string) } 3768 * @syscap SystemCapability.ArkUI.ArkUI.Full 3769 * @since 9 3770 */ 3771 /** 3772 * The param of center point of y. 3773 * 3774 * @type { ?(number | string) } 3775 * @syscap SystemCapability.ArkUI.ArkUI.Full 3776 * @crossplatform 3777 * @form 3778 * @since 10 3779 */ 3780 /** 3781 * The param of center point of y. 3782 * 3783 * @type { ?(number | string) } 3784 * @syscap SystemCapability.ArkUI.ArkUI.Full 3785 * @crossplatform 3786 * @form 3787 * @atomicservice 3788 * @since 11 3789 */ 3790 centerY?: number | string; 3791 3792 /** 3793 * The param of center point of z. 3794 * 3795 * @type { ?number } 3796 * @default 0 3797 * @syscap SystemCapability.ArkUI.ArkUI.Full 3798 * @crossplatform 3799 * @form 3800 * @since 10 3801 */ 3802 /** 3803 * The param of center point of z. 3804 * 3805 * @type { ?number } 3806 * @default 0 3807 * @syscap SystemCapability.ArkUI.ArkUI.Full 3808 * @crossplatform 3809 * @form 3810 * @atomicservice 3811 * @since 11 3812 */ 3813 centerZ?: number; 3814 3815 /** 3816 * The param of camera distance, value range (-∞, ∞). 3817 * @type { ?number } 3818 * @default 0 3819 * @syscap SystemCapability.ArkUI.ArkUI.Full 3820 * @crossplatform 3821 * @form 3822 * @since 10 3823 */ 3824 /** 3825 * The param of camera distance, value range (-∞, ∞). 3826 * @type { ?number } 3827 * @default 0 3828 * @syscap SystemCapability.ArkUI.ArkUI.Full 3829 * @crossplatform 3830 * @form 3831 * @atomicservice 3832 * @since 11 3833 */ 3834 perspective?: number; 3835 3836 /** 3837 * The param of angle. 3838 * 3839 * @type { number | string } 3840 * @syscap SystemCapability.ArkUI.ArkUI.Full 3841 * @since 7 3842 */ 3843 /** 3844 * The param of angle. 3845 * 3846 * @type { number | string } 3847 * @syscap SystemCapability.ArkUI.ArkUI.Full 3848 * @form 3849 * @since 9 3850 */ 3851 /** 3852 * The param of angle. 3853 * 3854 * @type { number | string } 3855 * @syscap SystemCapability.ArkUI.ArkUI.Full 3856 * @crossplatform 3857 * @form 3858 * @since 10 3859 */ 3860 /** 3861 * The param of angle. 3862 * 3863 * @type { number | string } 3864 * @syscap SystemCapability.ArkUI.ArkUI.Full 3865 * @crossplatform 3866 * @form 3867 * @atomicservice 3868 * @since 11 3869 */ 3870 angle: number | string; 3871} 3872 3873/** 3874 * Defines the param of transition. 3875 * 3876 * @interface TransitionOptions 3877 * @syscap SystemCapability.ArkUI.ArkUI.Full 3878 * @since 7 3879 * @deprecated since 10 3880 * @useinstead TransitionEffect 3881 */ 3882declare interface TransitionOptions { 3883 /** 3884 * Defines the param of type. 3885 * 3886 * @type { ?TransitionType } 3887 * @syscap SystemCapability.ArkUI.ArkUI.Full 3888 * @since 7 3889 * @deprecated since 10 3890 */ 3891 type?: TransitionType; 3892 /** 3893 * Defines the param of opacity. 3894 * 3895 * @type { ?number } 3896 * @syscap SystemCapability.ArkUI.ArkUI.Full 3897 * @since 7 3898 * @deprecated since 10 3899 */ 3900 opacity?: number; 3901 /** 3902 * Defines the param of translate. 3903 * 3904 * @type { ?TranslateOptions } 3905 * @syscap SystemCapability.ArkUI.ArkUI.Full 3906 * @since 7 3907 * @deprecated since 10 3908 */ 3909 translate?: TranslateOptions; 3910 /** 3911 * Defines the param of scale. 3912 * 3913 * @type { ?ScaleOptions } 3914 * @syscap SystemCapability.ArkUI.ArkUI.Full 3915 * @since 7 3916 * @deprecated since 10 3917 */ 3918 scale?: ScaleOptions; 3919 /** 3920 * Defines the param of rotate. 3921 * 3922 * @type { ?RotateOptions } 3923 * @syscap SystemCapability.ArkUI.ArkUI.Full 3924 * @since 7 3925 * @deprecated since 10 3926 */ 3927 rotate?: RotateOptions; 3928} 3929 3930/** 3931 * Defines the Edge object. 3932 * 3933 * @enum { number } 3934 * @syscap SystemCapability.ArkUI.ArkUI.Full 3935 * @crossplatform 3936 * @form 3937 * @since 10 3938 */ 3939/** 3940 * Defines the Edge object. 3941 * 3942 * @enum { number } 3943 * @syscap SystemCapability.ArkUI.ArkUI.Full 3944 * @crossplatform 3945 * @form 3946 * @atomicservice 3947 * @since 11 3948 */ 3949declare enum TransitionEdge { 3950 /** 3951 * Top edge 3952 * 3953 * @syscap SystemCapability.ArkUI.ArkUI.Full 3954 * @crossplatform 3955 * @form 3956 * @since 10 3957 */ 3958 /** 3959 * Top edge 3960 * 3961 * @syscap SystemCapability.ArkUI.ArkUI.Full 3962 * @crossplatform 3963 * @form 3964 * @atomicservice 3965 * @since 11 3966 */ 3967 TOP, 3968 3969 /** 3970 * Bottom edge 3971 * 3972 * @syscap SystemCapability.ArkUI.ArkUI.Full 3973 * @crossplatform 3974 * @form 3975 * @since 10 3976 */ 3977 /** 3978 * Bottom edge 3979 * 3980 * @syscap SystemCapability.ArkUI.ArkUI.Full 3981 * @crossplatform 3982 * @form 3983 * @atomicservice 3984 * @since 11 3985 */ 3986 BOTTOM, 3987 3988 /** 3989 * Start edge 3990 * 3991 * @syscap SystemCapability.ArkUI.ArkUI.Full 3992 * @crossplatform 3993 * @form 3994 * @since 10 3995 */ 3996 /** 3997 * Start edge 3998 * 3999 * @syscap SystemCapability.ArkUI.ArkUI.Full 4000 * @crossplatform 4001 * @form 4002 * @atomicservice 4003 * @since 11 4004 */ 4005 START, 4006 4007 /** 4008 * End edge 4009 * 4010 * @syscap SystemCapability.ArkUI.ArkUI.Full 4011 * @crossplatform 4012 * @form 4013 * @since 10 4014 */ 4015 /** 4016 * End edge 4017 * 4018 * @syscap SystemCapability.ArkUI.ArkUI.Full 4019 * @crossplatform 4020 * @form 4021 * @atomicservice 4022 * @since 11 4023 */ 4024 END 4025} 4026 4027/** 4028 * Defines all transition effects. 4029 * 4030 * @typedef { object } TransitionEffects 4031 * @syscap SystemCapability.ArkUI.ArkUI.Full 4032 * @crossplatform 4033 * @form 4034 * @since 10 4035 */ 4036/** 4037 * Defines all transition effects. 4038 * 4039 * @typedef { object } TransitionEffects 4040 * @syscap SystemCapability.ArkUI.ArkUI.Full 4041 * @crossplatform 4042 * @form 4043 * @atomicservice 4044 * @since 11 4045 */ 4046declare type TransitionEffects = { 4047 identity: undefined; 4048 opacity: number; 4049 slideSwitch: undefined; 4050 move: TransitionEdge; 4051 translate: TranslateOptions; 4052 rotate: RotateOptions; 4053 scale: ScaleOptions; 4054 asymmetric: { 4055 appear: TransitionEffect; 4056 disappear: TransitionEffect; 4057 }; 4058}; 4059 4060/** 4061 * Defined the draw modifier of node. Provides draw callbacks for the associated Node. 4062 * 4063 * @syscap SystemCapability.ArkUI.ArkUI.Full 4064 * @crossplatform 4065 * @atomicservice 4066 * @since 12 4067 */ 4068declare class DrawModifier { 4069 /** 4070 * drawBehind Method. Executed before drawing associated Node. 4071 * 4072 * @param { DrawContext } drawContext - The drawContext used to draw. 4073 * @syscap SystemCapability.ArkUI.ArkUI.Full 4074 * @crossplatform 4075 * @atomicservice 4076 * @since 12 4077 */ 4078 drawBehind?(drawContext: DrawContext): void; 4079 4080 /** 4081 * drawContent Method. Executed when associated Node is drawing, the default drawContent method will be replaced 4082 * if this method is set. 4083 * 4084 * @param { DrawContext } drawContext - The drawContext used to draw. 4085 * @syscap SystemCapability.ArkUI.ArkUI.Full 4086 * @crossplatform 4087 * @atomicservice 4088 * @since 12 4089 */ 4090 drawContent?(drawContext: DrawContext): void; 4091 4092 /** 4093 * drawFront Method. Executed after drawing associated Node. 4094 * 4095 * @param { DrawContext } drawContext - The drawContext used to draw. 4096 * @syscap SystemCapability.ArkUI.ArkUI.Full 4097 * @crossplatform 4098 * @atomicservice 4099 * @since 12 4100 */ 4101 drawFront?(drawContext: DrawContext): void; 4102 4103 /** 4104 * Invalidate the component, which will cause a re-render of the component. 4105 * 4106 * @syscap SystemCapability.ArkUI.ArkUI.Full 4107 * @crossplatform 4108 * @atomicservice 4109 * @since 12 4110 */ 4111 invalidate(): void; 4112} 4113 4114/** 4115 * Defines the transition effect 4116 * 4117 * @syscap SystemCapability.ArkUI.ArkUI.Full 4118 * @crossplatform 4119 * @form 4120 * @since 10 4121 */ 4122/** 4123 * Defines the transition effect 4124 * 4125 * @syscap SystemCapability.ArkUI.ArkUI.Full 4126 * @crossplatform 4127 * @form 4128 * @atomicservice 4129 * @since 11 4130 */ 4131declare class TransitionEffect< 4132 Type extends keyof TransitionEffects = keyof TransitionEffects, 4133 Effect extends TransitionEffects[Type] = TransitionEffects[Type] 4134> { 4135 /** 4136 * Disables the transition effect 4137 * 4138 * @type { TransitionEffect<"identity"> } 4139 * @readonly 4140 * @static 4141 * @syscap SystemCapability.ArkUI.ArkUI.Full 4142 * @crossplatform 4143 * @form 4144 * @since 10 4145 */ 4146 /** 4147 * Disables the transition effect 4148 * 4149 * @type { TransitionEffect<"identity"> } 4150 * @readonly 4151 * @static 4152 * @syscap SystemCapability.ArkUI.ArkUI.Full 4153 * @crossplatform 4154 * @form 4155 * @atomicservice 4156 * @since 11 4157 */ 4158 static readonly IDENTITY: TransitionEffect<"identity">; 4159 4160 /** 4161 * Specifies a transition effect with transparency of 0, which is equivalent to TransitionEffect.opacity(0). 4162 * 4163 * @type { TransitionEffect<"opacity"> } 4164 * @readonly 4165 * @static 4166 * @syscap SystemCapability.ArkUI.ArkUI.Full 4167 * @crossplatform 4168 * @form 4169 * @since 10 4170 */ 4171 /** 4172 * Specifies a transition effect with transparency of 0, which is equivalent to TransitionEffect.opacity(0). 4173 * 4174 * @type { TransitionEffect<"opacity"> } 4175 * @readonly 4176 * @static 4177 * @syscap SystemCapability.ArkUI.ArkUI.Full 4178 * @crossplatform 4179 * @form 4180 * @atomicservice 4181 * @since 11 4182 */ 4183 static readonly OPACITY: TransitionEffect<"opacity">; 4184 4185 /** 4186 * Defines a slide transition effect 4187 * 4188 * @type { TransitionEffect< 4189 * "asymmetric", 4190 * {appear: TransitionEffect<"move", TransitionEdge>; 4191 * disappear: TransitionEffect<"move", TransitionEdge>; 4192 * }> } 4193 * @readonly 4194 * @static 4195 * @syscap SystemCapability.ArkUI.ArkUI.Full 4196 * @crossplatform 4197 * @form 4198 * @since 10 4199 */ 4200 /** 4201 * Defines a slide transition effect 4202 * 4203 * @type { TransitionEffect< 4204 * "asymmetric", 4205 * {appear: TransitionEffect<"move", TransitionEdge>; 4206 * disappear: TransitionEffect<"move", TransitionEdge>; 4207 * }> } 4208 * @readonly 4209 * @static 4210 * @syscap SystemCapability.ArkUI.ArkUI.Full 4211 * @crossplatform 4212 * @form 4213 * @atomicservice 4214 * @since 11 4215 */ 4216 static readonly SLIDE: TransitionEffect< 4217 "asymmetric", 4218 { 4219 appear: TransitionEffect<"move", TransitionEdge>; 4220 disappear: TransitionEffect<"move", TransitionEdge>; 4221 } 4222 >; 4223 4224 /** 4225 * Specify a transition effect where the element enters by shrinking first and then expanding as it slides in from the right, 4226 * and exits by shrinking first and then expanding as it slides out to the left, with a minimum scale ratio of 0.8. 4227 * It comes with default animation parameters, which can also be overridden. 4228 * The default animation duration is set to 600ms, and the specified animation curve is cubicBezierCurve(0.24, 0.0, 0.50, 1.0). 4229 * 4230 * @type { TransitionEffect<"slideSwitch"> } 4231 * @readonly 4232 * @static 4233 * @syscap SystemCapability.ArkUI.ArkUI.Full 4234 * @crossplatform 4235 * @form 4236 * @since 10 4237 */ 4238 /** 4239 * Specify a transition effect where the element enters by shrinking first and then expanding as it slides in from the right, 4240 * and exits by shrinking first and then expanding as it slides out to the left, with a minimum scale ratio of 0.8. 4241 * It comes with default animation parameters, which can also be overridden. 4242 * The default animation duration is set to 600ms, and the specified animation curve is cubicBezierCurve(0.24, 0.0, 0.50, 1.0). 4243 * 4244 * @type { TransitionEffect<"slideSwitch"> } 4245 * @readonly 4246 * @static 4247 * @syscap SystemCapability.ArkUI.ArkUI.Full 4248 * @crossplatform 4249 * @form 4250 * @atomicservice 4251 * @since 11 4252 */ 4253 static readonly SLIDE_SWITCH: TransitionEffect<"slideSwitch">; 4254 4255 /** 4256 * Creates a translate transition effect 4257 * 4258 * @param { TranslateOptions } options - translate options 4259 * @returns { TransitionEffect<"translate"> } 4260 * @syscap SystemCapability.ArkUI.ArkUI.Full 4261 * @crossplatform 4262 * @form 4263 * @since 10 4264 */ 4265 /** 4266 * Creates a translate transition effect 4267 * 4268 * @param { TranslateOptions } options - translate options 4269 * @returns { TransitionEffect<"translate"> } 4270 * @syscap SystemCapability.ArkUI.ArkUI.Full 4271 * @crossplatform 4272 * @form 4273 * @atomicservice 4274 * @since 11 4275 */ 4276 static translate(options: TranslateOptions): TransitionEffect<"translate">; 4277 4278 /** 4279 * Creates a rotation transition effect 4280 * 4281 * @param { RotateOptions } options - rotate options 4282 * Set the rotation effect for component transitions when inserting and deleting. 4283 * The value represents the starting rotation point for the inserting animation and the ending rotation point for the deleting animation. 4284 * -x: Horizontal component of the rotational vector. 4285 * -y: Vertical component of the rotational vector. 4286 * -z: Vertical component of the rotational vector. 4287 * -centerX, centerY specify the rotation center point, with default values of "50%", 4288 * meaning that the default rotation center point is the center point of the component. 4289 * -The center point of (0, 0) represents the upper-left corner of the component. 4290 * -centerZ refers to the Z-axis anchor point. The default value of centerZ is 0. 4291 * -perspective indicates the visual distance. The perspective property does not support transition animation. 4292 * @returns { TransitionEffect<"rotate"> } 4293 * @syscap SystemCapability.ArkUI.ArkUI.Full 4294 * @crossplatform 4295 * @form 4296 * @since 10 4297 */ 4298 /** 4299 * Creates a rotation transition effect 4300 * 4301 * @param { RotateOptions } options - rotate options 4302 * Set the rotation effect for component transitions when inserting and deleting. 4303 * The value represents the starting rotation point for the inserting animation and the ending rotation point for the deleting animation. 4304 * -x: Horizontal component of the rotational vector. 4305 * -y: Vertical component of the rotational vector. 4306 * -z: Vertical component of the rotational vector. 4307 * -centerX, centerY specify the rotation center point, with default values of "50%", 4308 * meaning that the default rotation center point is the center point of the component. 4309 * -The center point of (0, 0) represents the upper-left corner of the component. 4310 * -centerZ refers to the Z-axis anchor point. The default value of centerZ is 0. 4311 * -perspective indicates the visual distance. The perspective property does not support transition animation. 4312 * @returns { TransitionEffect<"rotate"> } 4313 * @syscap SystemCapability.ArkUI.ArkUI.Full 4314 * @crossplatform 4315 * @form 4316 * @atomicservice 4317 * @since 11 4318 */ 4319 static rotate(options: RotateOptions): TransitionEffect<"rotate">; 4320 4321 /** 4322 * Creates a scale transition effect 4323 * 4324 * @param { ScaleOptions } options - scale options 4325 * @returns { TransitionEffect<"scale"> } 4326 * @syscap SystemCapability.ArkUI.ArkUI.Full 4327 * @crossplatform 4328 * @form 4329 * @since 10 4330 */ 4331 /** 4332 * Creates a scale transition effect 4333 * 4334 * @param { ScaleOptions } options - scale options 4335 * @returns { TransitionEffect<"scale"> } 4336 * @syscap SystemCapability.ArkUI.ArkUI.Full 4337 * @crossplatform 4338 * @form 4339 * @atomicservice 4340 * @since 11 4341 */ 4342 static scale(options: ScaleOptions): TransitionEffect<"scale">; 4343 4344 /** 4345 * Creates an opacity transition effect with alpha value 4346 * 4347 * @param { number } alpha - opacity alpha value, value range [0, 1]. 4348 * @returns { TransitionEffect<"opacity"> } 4349 * @syscap SystemCapability.ArkUI.ArkUI.Full 4350 * @crossplatform 4351 * @form 4352 * @since 10 4353 */ 4354 /** 4355 * Creates an opacity transition effect with alpha value 4356 * 4357 * @param { number } alpha - opacity alpha value, value range [0, 1]. 4358 * @returns { TransitionEffect<"opacity"> } 4359 * @syscap SystemCapability.ArkUI.ArkUI.Full 4360 * @crossplatform 4361 * @form 4362 * @atomicservice 4363 * @since 11 4364 */ 4365 /** 4366 * Creates an opacity transition effect with alpha value 4367 * 4368 * @param { number } alpha - opacity alpha value, value range [0, 1]. 4369 * Illegal values less than 0 are treated as 0, and illegal values greater than 1 are treated as 1. 4370 * @returns { TransitionEffect<"opacity"> } 4371 * @syscap SystemCapability.ArkUI.ArkUI.Full 4372 * @crossplatform 4373 * @form 4374 * @atomicservice 4375 * @since 12 4376 */ 4377 static opacity(alpha: number): TransitionEffect<"opacity">; 4378 4379 /** 4380 * Creates a move transition effect 4381 * 4382 * @param { TransitionEdge } edge - the edge that component will move to 4383 * @returns { TransitionEffect<"move"> } 4384 * @syscap SystemCapability.ArkUI.ArkUI.Full 4385 * @crossplatform 4386 * @form 4387 * @since 10 4388 */ 4389 /** 4390 * Creates a move transition effect 4391 * 4392 * @param { TransitionEdge } edge - the edge that component will move to 4393 * @returns { TransitionEffect<"move"> } 4394 * @syscap SystemCapability.ArkUI.ArkUI.Full 4395 * @crossplatform 4396 * @form 4397 * @atomicservice 4398 * @since 11 4399 */ 4400 static move(edge: TransitionEdge): TransitionEffect<"move">; 4401 4402 /** 4403 * Creates an asymmetric transition effect 4404 * 4405 * @param { TransitionEffect } appear - the transition which will be attached when the component is appear 4406 * @param { TransitionEffect } disappear - the transition which will be attached when the component is disappear 4407 * @returns { TransitionEffect<"asymmetric"> } 4408 * @syscap SystemCapability.ArkUI.ArkUI.Full 4409 * @crossplatform 4410 * @form 4411 * @since 10 4412 */ 4413 /** 4414 * Creates an asymmetric transition effect 4415 * 4416 * @param { TransitionEffect } appear - the transition which will be attached when the component is appear 4417 * @param { TransitionEffect } disappear - the transition which will be attached when the component is disappear 4418 * @returns { TransitionEffect<"asymmetric"> } 4419 * @syscap SystemCapability.ArkUI.ArkUI.Full 4420 * @crossplatform 4421 * @form 4422 * @atomicservice 4423 * @since 11 4424 */ 4425 static asymmetric( 4426 appear: TransitionEffect, 4427 disappear: TransitionEffect 4428 ): TransitionEffect<"asymmetric">; 4429 4430 /** 4431 * TransitionEffect constructor 4432 * 4433 * @param { Type } type - transition type 4434 * @param { Effect } effect - transition options 4435 * @syscap SystemCapability.ArkUI.ArkUI.Full 4436 * @crossplatform 4437 * @form 4438 * @since 10 4439 */ 4440 /** 4441 * TransitionEffect constructor 4442 * 4443 * @param { Type } type - transition type 4444 * @param { Effect } effect - transition options 4445 * @syscap SystemCapability.ArkUI.ArkUI.Full 4446 * @crossplatform 4447 * @form 4448 * @atomicservice 4449 * @since 11 4450 */ 4451 constructor(type: Type, effect: Effect); 4452 4453 /** 4454 * Set the animation of current transition effect 4455 * 4456 * @param { AnimateParam } value - animation parameters 4457 * @returns { TransitionEffect } 4458 * @syscap SystemCapability.ArkUI.ArkUI.Full 4459 * @crossplatform 4460 * @form 4461 * @since 10 4462 */ 4463 /** 4464 * Set the animation of current transition effect 4465 * 4466 * @param { AnimateParam } value - animation parameters 4467 * @returns { TransitionEffect } 4468 * @syscap SystemCapability.ArkUI.ArkUI.Full 4469 * @crossplatform 4470 * @form 4471 * @atomicservice 4472 * @since 11 4473 */ 4474 animation(value: AnimateParam): TransitionEffect; 4475 4476 /** 4477 * Combines another transition effect 4478 * 4479 * @param { TransitionEffect } transitionEffect - transition effect which is be combined 4480 * @returns { TransitionEffect } combined transition effect 4481 * @syscap SystemCapability.ArkUI.ArkUI.Full 4482 * @crossplatform 4483 * @form 4484 * @since 10 4485 */ 4486 /** 4487 * Combines another transition effect 4488 * 4489 * @param { TransitionEffect } transitionEffect - transition effect which is be combined 4490 * @returns { TransitionEffect } combined transition effect 4491 * @syscap SystemCapability.ArkUI.ArkUI.Full 4492 * @crossplatform 4493 * @form 4494 * @atomicservice 4495 * @since 11 4496 */ 4497 combine(transitionEffect: TransitionEffect): TransitionEffect; 4498} 4499 4500/** 4501 * Define Preview property 4502 * 4503 * @interface PreviewParams 4504 * @syscap SystemCapability.ArkUI.ArkUI.Full 4505 * @form 4506 * @since 9 4507 */ 4508/** 4509 * Define Preview property 4510 * 4511 * @interface PreviewParams 4512 * @syscap SystemCapability.ArkUI.ArkUI.Full 4513 * @crossplatform 4514 * @form 4515 * @atomicservice 4516 * @since 11 4517 */ 4518interface PreviewParams { 4519 /** 4520 * Define Preview title 4521 * 4522 * @type { ?string } 4523 * @syscap SystemCapability.ArkUI.ArkUI.Full 4524 * @form 4525 * @since 9 4526 */ 4527 /** 4528 * Define Preview title 4529 * 4530 * @type { ?string } 4531 * @syscap SystemCapability.ArkUI.ArkUI.Full 4532 * @crossplatform 4533 * @form 4534 * @atomicservice 4535 * @since 11 4536 */ 4537 title?: string; 4538 4539 /** 4540 * Define Preview width 4541 * 4542 * @type { ?number } 4543 * @syscap SystemCapability.ArkUI.ArkUI.Full 4544 * @form 4545 * @since 9 4546 */ 4547 /** 4548 * Define Preview width 4549 * 4550 * @type { ?number } 4551 * @syscap SystemCapability.ArkUI.ArkUI.Full 4552 * @crossplatform 4553 * @form 4554 * @atomicservice 4555 * @since 11 4556 */ 4557 width?: number; 4558 4559 /** 4560 * Define Preview height 4561 * 4562 * @type { ?number } 4563 * @syscap SystemCapability.ArkUI.ArkUI.Full 4564 * @form 4565 * @since 9 4566 */ 4567 /** 4568 * Define Preview height 4569 * 4570 * @type { ?number } 4571 * @syscap SystemCapability.ArkUI.ArkUI.Full 4572 * @crossplatform 4573 * @form 4574 * @atomicservice 4575 * @since 11 4576 */ 4577 height?: number; 4578 4579 /** 4580 * Define Preview locale 4581 * 4582 * @type { ?string } 4583 * @syscap SystemCapability.ArkUI.ArkUI.Full 4584 * @form 4585 * @since 9 4586 */ 4587 /** 4588 * Define Preview locale 4589 * 4590 * @type { ?string } 4591 * @syscap SystemCapability.ArkUI.ArkUI.Full 4592 * @form 4593 * @atomicservice 4594 * @since 11 4595 */ 4596 locale?: string; 4597 4598 /** 4599 * Define Preview colorMode 4600 * 4601 * @type { ?string } 4602 * @syscap SystemCapability.ArkUI.ArkUI.Full 4603 * @form 4604 * @since 9 4605 */ 4606 /** 4607 * Define Preview colorMode 4608 * 4609 * @type { ?string } 4610 * @syscap SystemCapability.ArkUI.ArkUI.Full 4611 * @crossplatform 4612 * @form 4613 * @atomicservice 4614 * @since 11 4615 */ 4616 colorMode?: string; 4617 4618 /** 4619 * Define Preview deviceType 4620 * 4621 * @type { ?string } 4622 * @syscap SystemCapability.ArkUI.ArkUI.Full 4623 * @form 4624 * @since 9 4625 */ 4626 /** 4627 * Define Preview deviceType 4628 * 4629 * @type { ?string } 4630 * @syscap SystemCapability.ArkUI.ArkUI.Full 4631 * @form 4632 * @atomicservice 4633 * @since 11 4634 */ 4635 deviceType?: string; 4636 4637 /** 4638 * Define Preview dpi 4639 * 4640 * @type { ?number } 4641 * @syscap SystemCapability.ArkUI.ArkUI.Full 4642 * @form 4643 * @since 9 4644 */ 4645 /** 4646 * Define Preview dpi 4647 * 4648 * @type { ?number } 4649 * @syscap SystemCapability.ArkUI.ArkUI.Full 4650 * @form 4651 * @atomicservice 4652 * @since 11 4653 */ 4654 dpi?: number; 4655 4656 /** 4657 * Define Preview orientation 4658 * 4659 * @type { ?string } 4660 * @syscap SystemCapability.ArkUI.ArkUI.Full 4661 * @form 4662 * @since 9 4663 */ 4664 /** 4665 * Define Preview orientation 4666 * 4667 * @type { ?string } 4668 * @syscap SystemCapability.ArkUI.ArkUI.Full 4669 * @form 4670 * @atomicservice 4671 * @since 11 4672 */ 4673 orientation?: string; 4674 4675 /** 4676 * Define Preview roundScreen 4677 * 4678 * @type { ?boolean } 4679 * @syscap SystemCapability.ArkUI.ArkUI.Full 4680 * @form 4681 * @since 9 4682 */ 4683 /** 4684 * Define Preview roundScreen 4685 * 4686 * @type { ?boolean } 4687 * @syscap SystemCapability.ArkUI.ArkUI.Full 4688 * @form 4689 * @atomicservice 4690 * @since 11 4691 */ 4692 roundScreen?: boolean; 4693} 4694 4695/** 4696 * ItemDragInfo object description 4697 * 4698 * @interface ItemDragInfo 4699 * @syscap SystemCapability.ArkUI.ArkUI.Full 4700 * @since 8 4701 */ 4702/** 4703 * ItemDragInfo object description 4704 * 4705 * @interface ItemDragInfo 4706 * @syscap SystemCapability.ArkUI.ArkUI.Full 4707 * @crossplatform 4708 * @since 10 4709 */ 4710/** 4711 * ItemDragInfo object description 4712 * 4713 * @interface ItemDragInfo 4714 * @syscap SystemCapability.ArkUI.ArkUI.Full 4715 * @crossplatform 4716 * @atomicservice 4717 * @since 11 4718 */ 4719declare interface ItemDragInfo { 4720 /** 4721 * Obtains the X coordinate of the drag window, in vp. 4722 * 4723 * @type { number } 4724 * @syscap SystemCapability.ArkUI.ArkUI.Full 4725 * @since 8 4726 */ 4727 /** 4728 * Obtains the X coordinate of the drag window, in vp. 4729 * 4730 * @type { number } 4731 * @syscap SystemCapability.ArkUI.ArkUI.Full 4732 * @crossplatform 4733 * @since 10 4734 */ 4735 /** 4736 * Obtains the X coordinate of the drag window, in vp. 4737 * 4738 * @type { number } 4739 * @syscap SystemCapability.ArkUI.ArkUI.Full 4740 * @crossplatform 4741 * @atomicservice 4742 * @since 11 4743 */ 4744 x: number; 4745 4746 /** 4747 * Obtains the Y coordinate of the drag window, in vp. 4748 * 4749 * @type { number } 4750 * @syscap SystemCapability.ArkUI.ArkUI.Full 4751 * @since 8 4752 */ 4753 /** 4754 * Obtains the Y coordinate of the drag window, in vp. 4755 * 4756 * @type { number } 4757 * @syscap SystemCapability.ArkUI.ArkUI.Full 4758 * @crossplatform 4759 * @since 10 4760 */ 4761 /** 4762 * Obtains the Y coordinate of the drag window, in vp. 4763 * 4764 * @type { number } 4765 * @syscap SystemCapability.ArkUI.ArkUI.Full 4766 * @crossplatform 4767 * @atomicservice 4768 * @since 11 4769 */ 4770 y: number; 4771} 4772 4773/** 4774 * Defines the drag status before drag action. 4775 * 4776 * @enum { number } 4777 * @syscap SystemCapability.ArkUI.ArkUI.Full 4778 * @atomicservice 4779 * @since 12 4780 */ 4781declare enum PreDragStatus { 4782 /** 4783 * Define the status for user prepare to start long press gesture. 4784 * 4785 * @syscap SystemCapability.ArkUI.ArkUI.Full 4786 * @atomicservice 4787 * @since 12 4788 */ 4789 ACTION_DETECTING_STATUS = 0, 4790 4791 /** 4792 * Define the status for user can start drag action. 4793 * 4794 * @syscap SystemCapability.ArkUI.ArkUI.Full 4795 * @atomicservice 4796 * @since 12 4797 */ 4798 READY_TO_TRIGGER_DRAG_ACTION = 1, 4799 4800 /** 4801 * Define the status for dragItem lift animation started. 4802 * 4803 * @syscap SystemCapability.ArkUI.ArkUI.Full 4804 * @atomicservice 4805 * @since 12 4806 */ 4807 PREVIEW_LIFT_STARTED = 2, 4808 4809 /** 4810 * Define the status for dragItem lift animation finished. 4811 * 4812 * @syscap SystemCapability.ArkUI.ArkUI.Full 4813 * @atomicservice 4814 * @since 12 4815 */ 4816 PREVIEW_LIFT_FINISHED = 3, 4817 4818 /** 4819 * Define the status for dragItem landing animation started. 4820 * 4821 * @syscap SystemCapability.ArkUI.ArkUI.Full 4822 * @atomicservice 4823 * @since 12 4824 */ 4825 PREVIEW_LANDING_STARTED = 4, 4826 4827 /** 4828 * Define the status for dragItem landing animation finished. 4829 * 4830 * @syscap SystemCapability.ArkUI.ArkUI.Full 4831 * @atomicservice 4832 * @since 12 4833 */ 4834 PREVIEW_LANDING_FINISHED = 5, 4835 4836 /** 4837 * Define the status for user cancel drag action. 4838 * 4839 * @syscap SystemCapability.ArkUI.ArkUI.Full 4840 * @atomicservice 4841 * @since 12 4842 */ 4843 ACTION_CANCELED_BEFORE_DRAG = 6, 4844} 4845 4846/** 4847 * DragItemInfo object description 4848 * 4849 * @interface DragItemInfo 4850 * @syscap SystemCapability.ArkUI.ArkUI.Full 4851 * @since 8 4852 */ 4853/** 4854 * DragItemInfo object description 4855 * 4856 * @interface DragItemInfo 4857 * @syscap SystemCapability.ArkUI.ArkUI.Full 4858 * @atomicservice 4859 * @since 11 4860 */ 4861declare interface DragItemInfo { 4862 /** 4863 * Uses the pixelMap object for drawing. 4864 * 4865 * @type { ?PixelMap } 4866 * @syscap SystemCapability.ArkUI.ArkUI.Full 4867 * @since 8 4868 */ 4869 /** 4870 * Uses the pixelMap object for drawing. 4871 * 4872 * @type { ?PixelMap } 4873 * @syscap SystemCapability.ArkUI.ArkUI.Full 4874 * @atomicservice 4875 * @since 11 4876 */ 4877 pixelMap?: PixelMap; 4878 4879 /** 4880 * Uses the custom builder for drawing, if pixelMap is set, this value is ignored. 4881 * 4882 * @type { ?CustomBuilder } 4883 * @syscap SystemCapability.ArkUI.ArkUI.Full 4884 * @since 8 4885 */ 4886 /** 4887 * Uses the custom builder for drawing, if pixelMap is set, this value is ignored. 4888 * 4889 * @type { ?CustomBuilder } 4890 * @syscap SystemCapability.ArkUI.ArkUI.Full 4891 * @atomicservice 4892 * @since 11 4893 */ 4894 builder?: CustomBuilder; 4895 4896 /** 4897 * Sets the extra info for drag event. 4898 * 4899 * @type { ?string } 4900 * @syscap SystemCapability.ArkUI.ArkUI.Full 4901 * @since 8 4902 */ 4903 /** 4904 * Sets the extra info for drag event. 4905 * 4906 * @type { ?string } 4907 * @syscap SystemCapability.ArkUI.ArkUI.Full 4908 * @atomicservice 4909 * @since 11 4910 */ 4911 extraInfo?: string; 4912} 4913 4914/** 4915 * Defining animation function. 4916 * 4917 * @param { AnimateParam } value 4918 * @param { function } event 4919 * @syscap SystemCapability.ArkUI.ArkUI.Full 4920 * @since 7 4921 */ 4922/** 4923 * Defining animation function. 4924 * 4925 * @param { AnimateParam } value 4926 * @param { function } event 4927 * @syscap SystemCapability.ArkUI.ArkUI.Full 4928 * @form 4929 * @since 9 4930 */ 4931/** 4932 * Defining animation function. 4933 * 4934 * @param { AnimateParam } value 4935 * @param { function } event 4936 * @syscap SystemCapability.ArkUI.ArkUI.Full 4937 * @crossplatform 4938 * @form 4939 * @since 10 4940 */ 4941/** 4942 * Defining animation function. 4943 * 4944 * @param { AnimateParam } value 4945 * @param { function } event 4946 * @syscap SystemCapability.ArkUI.ArkUI.Full 4947 * @crossplatform 4948 * @form 4949 * @atomicservice 4950 * @since 11 4951 */ 4952declare function animateTo(value: AnimateParam, event: () => void): void; 4953 4954/** 4955 * Define animation functions for immediate distribution. 4956 * 4957 * @param { AnimateParam } value - Set animation effect parameters. 4958 * @param { function } event - Specify the closure function that displays dynamic effects, 4959 * and the system will automatically insert transition animations for state changes caused by the closure function. 4960 * @syscap SystemCapability.ArkUI.ArkUI.Full 4961 * @atomicservice 4962 * @since 12 4963 */ 4964declare function animateToImmediately(value: AnimateParam, event: () => void): void; 4965 4966/** 4967 * Converts a value in vp units to a value in px. 4968 * 4969 * @param { number } value 4970 * @returns { number } 4971 * @syscap SystemCapability.ArkUI.ArkUI.Full 4972 * @since 7 4973 */ 4974/** 4975 * Converts a value in vp units to a value in px. 4976 * 4977 * @param { number } value 4978 * @returns { number } 4979 * @syscap SystemCapability.ArkUI.ArkUI.Full 4980 * @form 4981 * @since 9 4982 */ 4983/** 4984 * Converts a value in vp units to a value in px. 4985 * 4986 * @param { number } value 4987 * @returns { number } 4988 * @syscap SystemCapability.ArkUI.ArkUI.Full 4989 * @crossplatform 4990 * @form 4991 * @since 10 4992 */ 4993/** 4994 * Converts a value in vp units to a value in px. 4995 * 4996 * @param { number } value 4997 * @returns { number } 4998 * @syscap SystemCapability.ArkUI.ArkUI.Full 4999 * @crossplatform 5000 * @form 5001 * @atomicservice 5002 * @since 11 5003 */ 5004declare function vp2px(value: number): number; 5005 5006/** 5007 * Converts a number in units of px to a number in units of vp. 5008 * 5009 * @param { number } value 5010 * @returns { number } 5011 * @syscap SystemCapability.ArkUI.ArkUI.Full 5012 * @since 7 5013 */ 5014/** 5015 * Converts a number in units of px to a number in units of vp. 5016 * 5017 * @param { number } value 5018 * @returns { number } 5019 * @syscap SystemCapability.ArkUI.ArkUI.Full 5020 * @form 5021 * @since 9 5022 */ 5023/** 5024 * Converts a number in units of px to a number in units of vp. 5025 * 5026 * @param { number } value 5027 * @returns { number } 5028 * @syscap SystemCapability.ArkUI.ArkUI.Full 5029 * @crossplatform 5030 * @form 5031 * @since 10 5032 */ 5033/** 5034 * Converts a number in units of px to a number in units of vp. 5035 * 5036 * @param { number } value 5037 * @returns { number } 5038 * @syscap SystemCapability.ArkUI.ArkUI.Full 5039 * @crossplatform 5040 * @form 5041 * @atomicservice 5042 * @since 11 5043 */ 5044declare function px2vp(value: number): number; 5045 5046/** 5047 * Converts a number in fp units to a number in px. 5048 * 5049 * @param { number } value 5050 * @returns { number } 5051 * @syscap SystemCapability.ArkUI.ArkUI.Full 5052 * @since 7 5053 */ 5054/** 5055 * Converts a number in fp units to a number in px. 5056 * 5057 * @param { number } value 5058 * @returns { number } 5059 * @syscap SystemCapability.ArkUI.ArkUI.Full 5060 * @form 5061 * @since 9 5062 */ 5063/** 5064 * Converts a number in fp units to a number in px. 5065 * 5066 * @param { number } value 5067 * @returns { number } 5068 * @syscap SystemCapability.ArkUI.ArkUI.Full 5069 * @crossplatform 5070 * @form 5071 * @since 10 5072 */ 5073/** 5074 * Converts a number in fp units to a number in px. 5075 * 5076 * @param { number } value 5077 * @returns { number } 5078 * @syscap SystemCapability.ArkUI.ArkUI.Full 5079 * @crossplatform 5080 * @form 5081 * @atomicservice 5082 * @since 11 5083 */ 5084declare function fp2px(value: number): number; 5085 5086/** 5087 * Converts a number in units of px to a number in units of fp. 5088 * 5089 * @param { number } value 5090 * @returns { number } 5091 * @syscap SystemCapability.ArkUI.ArkUI.Full 5092 * @since 7 5093 */ 5094/** 5095 * Converts a number in units of px to a number in units of fp. 5096 * 5097 * @param { number } value 5098 * @returns { number } 5099 * @syscap SystemCapability.ArkUI.ArkUI.Full 5100 * @form 5101 * @since 9 5102 */ 5103/** 5104 * Converts a number in units of px to a number in units of fp. 5105 * 5106 * @param { number } value 5107 * @returns { number } 5108 * @syscap SystemCapability.ArkUI.ArkUI.Full 5109 * @crossplatform 5110 * @form 5111 * @since 10 5112 */ 5113/** 5114 * Converts a number in units of px to a number in units of fp. 5115 * 5116 * @param { number } value 5117 * @returns { number } 5118 * @syscap SystemCapability.ArkUI.ArkUI.Full 5119 * @crossplatform 5120 * @form 5121 * @atomicservice 5122 * @since 11 5123 */ 5124declare function px2fp(value: number): number; 5125 5126/** 5127 * Converts a number in units of lpx to a number in units of px. 5128 * 5129 * @param { number } value 5130 * @returns { number } 5131 * @syscap SystemCapability.ArkUI.ArkUI.Full 5132 * @since 7 5133 */ 5134/** 5135 * Converts a number in units of lpx to a number in units of px. 5136 * 5137 * @param { number } value 5138 * @returns { number } 5139 * @syscap SystemCapability.ArkUI.ArkUI.Full 5140 * @form 5141 * @since 9 5142 */ 5143/** 5144 * Converts a number in units of lpx to a number in units of px. 5145 * 5146 * @param { number } value 5147 * @returns { number } 5148 * @syscap SystemCapability.ArkUI.ArkUI.Full 5149 * @crossplatform 5150 * @form 5151 * @since 10 5152 */ 5153/** 5154 * Converts a number in units of lpx to a number in units of px. 5155 * 5156 * @param { number } value 5157 * @returns { number } 5158 * @syscap SystemCapability.ArkUI.ArkUI.Full 5159 * @crossplatform 5160 * @form 5161 * @atomicservice 5162 * @since 11 5163 */ 5164declare function lpx2px(value: number): number; 5165 5166/** 5167 * Converts a number in units of px to a number in units of lpx. 5168 * 5169 * @param { number } value 5170 * @returns { number } 5171 * @syscap SystemCapability.ArkUI.ArkUI.Full 5172 * @since 7 5173 */ 5174/** 5175 * Converts a number in units of px to a number in units of lpx. 5176 * 5177 * @param { number } value 5178 * @returns { number } 5179 * @syscap SystemCapability.ArkUI.ArkUI.Full 5180 * @form 5181 * @since 9 5182 */ 5183/** 5184 * Converts a number in units of px to a number in units of lpx. 5185 * 5186 * @param { number } value 5187 * @returns { number } 5188 * @syscap SystemCapability.ArkUI.ArkUI.Full 5189 * @crossplatform 5190 * @form 5191 * @since 10 5192 */ 5193/** 5194 * Converts a number in units of px to a number in units of lpx. 5195 * 5196 * @param { number } value 5197 * @returns { number } 5198 * @syscap SystemCapability.ArkUI.ArkUI.Full 5199 * @crossplatform 5200 * @form 5201 * @atomicservice 5202 * @since 11 5203 */ 5204declare function px2lpx(value: number): number; 5205 5206/** 5207 * Defines the namespace of focus controller. 5208 * 5209 * @namespace focusControl 5210 * @syscap SystemCapability.ArkUI.ArkUI.Full 5211 * @crossplatform 5212 * @form 5213 * @since 9 5214 */ 5215/** 5216 * Defines the namespace of focus controller. 5217 * 5218 * @namespace focusControl 5219 * @syscap SystemCapability.ArkUI.ArkUI.Full 5220 * @crossplatform 5221 * @form 5222 * @atomicservice 5223 * @since 11 5224 */ 5225declare namespace focusControl { 5226 /** 5227 * Request focus to the specific component by param: 'id/key'. 5228 * 5229 * @param { string } value 5230 * @returns { boolean } 5231 * @syscap SystemCapability.ArkUI.ArkUI.Full 5232 * @since 9 5233 */ 5234 /** 5235 * Request focus to the specific component by param: 'id/key'. 5236 * 5237 * @param { string } value 5238 * @returns { boolean } 5239 * @syscap SystemCapability.ArkUI.ArkUI.Full 5240 * @crossplatform 5241 * @since 10 5242 */ 5243 /** 5244 * Request focus to the specific component by param: 'id/key'. 5245 * 5246 * @param { string } value 5247 * @returns { boolean } 5248 * @syscap SystemCapability.ArkUI.ArkUI.Full 5249 * @crossplatform 5250 * @atomicservice 5251 * @since 11 5252 */ 5253 function requestFocus(value: string): boolean; 5254} 5255 5256/** 5257 * Import the PointerStyle type object for setCursor. 5258 * 5259 * @typedef { import('../api/@ohos.multimodalInput.pointer').default.PointerStyle } PointerStyle 5260 * @syscap SystemCapability.ArkUI.ArkUI.Full 5261 * @since 11 5262 */ 5263/** 5264 * Import the PointerStyle type object for setCursor. 5265 * 5266 * @typedef { import('../api/@ohos.multimodalInput.pointer').default.PointerStyle } PointerStyle 5267 * @syscap SystemCapability.ArkUI.ArkUI.Full 5268 * @atomicservice 5269 * @since 12 5270 */ 5271declare type PointerStyle = import('../api/@ohos.multimodalInput.pointer').default.PointerStyle; 5272 5273/** 5274 * CursorControl 5275 * 5276 * @namespace cursorControl 5277 * @syscap SystemCapability.ArkUI.ArkUI.Full 5278 * @since 11 5279 */ 5280/** 5281 * CursorControl 5282 * 5283 * @namespace cursorControl 5284 * @syscap SystemCapability.ArkUI.ArkUI.Full 5285 * @atomicservice 5286 * @since 12 5287 */ 5288declare namespace cursorControl { 5289 5290 /** 5291 * Change the mouse cursor style by param: 'PointerStyle'. 5292 * 5293 * @param { PointerStyle } value 5294 * @syscap SystemCapability.ArkUI.ArkUI.Full 5295 * @crossplatform 5296 * @since 11 5297 */ 5298 /** 5299 * Change the mouse cursor style by param: 'PointerStyle'. 5300 * 5301 * @param { PointerStyle } value 5302 * @syscap SystemCapability.ArkUI.ArkUI.Full 5303 * @crossplatform 5304 * @atomicservice 5305 * @since 12 5306 */ 5307 function setCursor(value: PointerStyle): void; 5308 5309 /** 5310 * Restore the default mouse cursor style. 5311 * 5312 * @syscap SystemCapability.ArkUI.ArkUI.Full 5313 * @crossplatform 5314 * @since 11 5315 */ 5316 /** 5317 * Restore the default mouse cursor style. 5318 * 5319 * @syscap SystemCapability.ArkUI.ArkUI.Full 5320 * @crossplatform 5321 * @atomicservice 5322 * @since 12 5323 */ 5324 function restoreDefault(): void; 5325} 5326 5327/** 5328 * Defines the event target. 5329 * 5330 * @interface EventTarget 5331 * @syscap SystemCapability.ArkUI.ArkUI.Full 5332 * @since 8 5333 */ 5334/** 5335 * Defines the event target. 5336 * 5337 * @interface EventTarget 5338 * @syscap SystemCapability.ArkUI.ArkUI.Full 5339 * @form 5340 * @since 9 5341 */ 5342/** 5343 * Defines the event target. 5344 * 5345 * @interface EventTarget 5346 * @syscap SystemCapability.ArkUI.ArkUI.Full 5347 * @crossplatform 5348 * @form 5349 * @since 10 5350 */ 5351/** 5352 * Defines the event target. 5353 * 5354 * @interface EventTarget 5355 * @syscap SystemCapability.ArkUI.ArkUI.Full 5356 * @crossplatform 5357 * @form 5358 * @atomicservice 5359 * @since 11 5360 */ 5361declare interface EventTarget { 5362 /** 5363 * Area of current target. 5364 * 5365 * @type { Area } 5366 * @syscap SystemCapability.ArkUI.ArkUI.Full 5367 * @since 8 5368 */ 5369 /** 5370 * Area of current target. 5371 * 5372 * @type { Area } 5373 * @syscap SystemCapability.ArkUI.ArkUI.Full 5374 * @form 5375 * @since 9 5376 */ 5377 /** 5378 * Area of current target. 5379 * 5380 * @type { Area } 5381 * @syscap SystemCapability.ArkUI.ArkUI.Full 5382 * @crossplatform 5383 * @form 5384 * @since 10 5385 */ 5386 /** 5387 * Area of current target. 5388 * 5389 * @type { Area } 5390 * @syscap SystemCapability.ArkUI.ArkUI.Full 5391 * @crossplatform 5392 * @form 5393 * @atomicservice 5394 * @since 11 5395 */ 5396 area: Area; 5397} 5398 5399/** 5400 * Defines the event source type. 5401 * 5402 * @enum { number } 5403 * @syscap SystemCapability.ArkUI.ArkUI.Full 5404 * @since 8 5405 */ 5406/** 5407 * Defines the event source type. 5408 * 5409 * @enum { number } 5410 * @syscap SystemCapability.ArkUI.ArkUI.Full 5411 * @crossplatform 5412 * @since 10 5413 */ 5414/** 5415 * Defines the event source type. 5416 * 5417 * @enum { number } 5418 * @syscap SystemCapability.ArkUI.ArkUI.Full 5419 * @crossplatform 5420 * @atomicservice 5421 * @since 11 5422 */ 5423declare enum SourceType { 5424 /** 5425 * Unknown type. 5426 * 5427 * @syscap SystemCapability.ArkUI.ArkUI.Full 5428 * @since 8 5429 */ 5430 /** 5431 * Unknown type. 5432 * 5433 * @syscap SystemCapability.ArkUI.ArkUI.Full 5434 * @crossplatform 5435 * @since 10 5436 */ 5437 /** 5438 * Unknown type. 5439 * 5440 * @syscap SystemCapability.ArkUI.ArkUI.Full 5441 * @crossplatform 5442 * @atomicservice 5443 * @since 11 5444 */ 5445 Unknown, 5446 5447 /** 5448 * The mouse type. 5449 * 5450 * @syscap SystemCapability.ArkUI.ArkUI.Full 5451 * @since 8 5452 */ 5453 /** 5454 * The mouse type. 5455 * 5456 * @syscap SystemCapability.ArkUI.ArkUI.Full 5457 * @crossplatform 5458 * @since 10 5459 */ 5460 /** 5461 * The mouse type. 5462 * 5463 * @syscap SystemCapability.ArkUI.ArkUI.Full 5464 * @crossplatform 5465 * @atomicservice 5466 * @since 11 5467 */ 5468 Mouse, 5469 5470 /** 5471 * The touch screen type. 5472 * 5473 * @syscap SystemCapability.ArkUI.ArkUI.Full 5474 * @since 8 5475 */ 5476 /** 5477 * The touch screen type. 5478 * 5479 * @syscap SystemCapability.ArkUI.ArkUI.Full 5480 * @crossplatform 5481 * @since 10 5482 */ 5483 /** 5484 * The touch screen type. 5485 * 5486 * @syscap SystemCapability.ArkUI.ArkUI.Full 5487 * @crossplatform 5488 * @atomicservice 5489 * @since 11 5490 */ 5491 TouchScreen, 5492} 5493 5494/** 5495 * Defines the event tool type. 5496 * 5497 * @enum { number } 5498 * @syscap SystemCapability.ArkUI.ArkUI.Full 5499 * @since 9 5500 */ 5501/** 5502 * Defines the event tool type. 5503 * 5504 * @enum { number } 5505 * @syscap SystemCapability.ArkUI.ArkUI.Full 5506 * @crossplatform 5507 * @since 10 5508 */ 5509/** 5510 * Defines the event tool type. 5511 * 5512 * @enum { number } 5513 * @syscap SystemCapability.ArkUI.ArkUI.Full 5514 * @crossplatform 5515 * @atomicservice 5516 * @since 11 5517 */ 5518declare enum SourceTool { 5519 /** 5520 * Unknown type. 5521 * 5522 * @syscap SystemCapability.ArkUI.ArkUI.Full 5523 * @since 9 5524 */ 5525 /** 5526 * Unknown type. 5527 * 5528 * @syscap SystemCapability.ArkUI.ArkUI.Full 5529 * @crossplatform 5530 * @since 10 5531 */ 5532 /** 5533 * Unknown type. 5534 * 5535 * @syscap SystemCapability.ArkUI.ArkUI.Full 5536 * @crossplatform 5537 * @atomicservice 5538 * @since 11 5539 */ 5540 Unknown, 5541 5542 /** 5543 * The finger type. 5544 * 5545 * @syscap SystemCapability.ArkUI.ArkUI.Full 5546 * @since 9 5547 */ 5548 /** 5549 * The finger type. 5550 * 5551 * @syscap SystemCapability.ArkUI.ArkUI.Full 5552 * @crossplatform 5553 * @since 10 5554 */ 5555 /** 5556 * The finger type. 5557 * 5558 * @syscap SystemCapability.ArkUI.ArkUI.Full 5559 * @crossplatform 5560 * @atomicservice 5561 * @since 11 5562 */ 5563 Finger, 5564 5565 /** 5566 * The pen type. 5567 * 5568 * @syscap SystemCapability.ArkUI.ArkUI.Full 5569 * @since 9 5570 */ 5571 /** 5572 * The pen type. 5573 * 5574 * @syscap SystemCapability.ArkUI.ArkUI.Full 5575 * @crossplatform 5576 * @since 10 5577 */ 5578 /** 5579 * The pen type. 5580 * 5581 * @syscap SystemCapability.ArkUI.ArkUI.Full 5582 * @crossplatform 5583 * @atomicservice 5584 * @since 11 5585 */ 5586 Pen, 5587 5588 /** 5589 * The mouse type. 5590 * 5591 * @syscap SystemCapability.ArkUI.ArkUI.Full 5592 * @crossplatform 5593 * @atomicservice 5594 * @since 12 5595 */ 5596 MOUSE, 5597 5598 /** 5599 * The touchpad type. 5600 * 5601 * @syscap SystemCapability.ArkUI.ArkUI.Full 5602 * @crossplatform 5603 * @atomicservice 5604 * @since 12 5605 */ 5606 TOUCHPAD, 5607 5608 /** 5609 * The joystick type. 5610 * 5611 * @syscap SystemCapability.ArkUI.ArkUI.Full 5612 * @crossplatform 5613 * @atomicservice 5614 * @since 12 5615 */ 5616 JOYSTICK, 5617} 5618 5619/** 5620 * Defines the Border Image Repeat Mode. 5621 * 5622 * @enum { number } 5623 * @syscap SystemCapability.ArkUI.ArkUI.Full 5624 * @form 5625 * @since 9 5626 */ 5627/** 5628 * Defines the Border Image Repeat Mode. 5629 * 5630 * @enum { number } 5631 * @syscap SystemCapability.ArkUI.ArkUI.Full 5632 * @crossplatform 5633 * @form 5634 * @since 10 5635 */ 5636/** 5637 * Defines the Border Image Repeat Mode. 5638 * 5639 * @enum { number } 5640 * @syscap SystemCapability.ArkUI.ArkUI.Full 5641 * @crossplatform 5642 * @form 5643 * @atomicservice 5644 * @since 11 5645 */ 5646declare enum RepeatMode { 5647 /** 5648 * Repeat mode. 5649 * 5650 * @syscap SystemCapability.ArkUI.ArkUI.Full 5651 * @form 5652 * @since 9 5653 */ 5654 /** 5655 * Repeat mode. 5656 * 5657 * @syscap SystemCapability.ArkUI.ArkUI.Full 5658 * @crossplatform 5659 * @form 5660 * @since 10 5661 */ 5662 /** 5663 * Repeat mode. 5664 * 5665 * @syscap SystemCapability.ArkUI.ArkUI.Full 5666 * @crossplatform 5667 * @form 5668 * @atomicservice 5669 * @since 11 5670 */ 5671 Repeat, 5672 5673 /** 5674 * Stretch mode. 5675 * 5676 * @syscap SystemCapability.ArkUI.ArkUI.Full 5677 * @form 5678 * @since 9 5679 */ 5680 /** 5681 * Stretch mode. 5682 * 5683 * @syscap SystemCapability.ArkUI.ArkUI.Full 5684 * @crossplatform 5685 * @form 5686 * @since 10 5687 */ 5688 /** 5689 * Stretch mode. 5690 * 5691 * @syscap SystemCapability.ArkUI.ArkUI.Full 5692 * @crossplatform 5693 * @form 5694 * @atomicservice 5695 * @since 11 5696 */ 5697 Stretch, 5698 5699 /** 5700 * Round mode. 5701 * 5702 * @syscap SystemCapability.ArkUI.ArkUI.Full 5703 * @form 5704 * @since 9 5705 */ 5706 /** 5707 * Round mode. 5708 * 5709 * @syscap SystemCapability.ArkUI.ArkUI.Full 5710 * @crossplatform 5711 * @form 5712 * @since 10 5713 */ 5714 /** 5715 * Round mode. 5716 * 5717 * @syscap SystemCapability.ArkUI.ArkUI.Full 5718 * @crossplatform 5719 * @form 5720 * @atomicservice 5721 * @since 11 5722 */ 5723 Round, 5724 5725 /** 5726 * Space mode. 5727 * 5728 * @syscap SystemCapability.ArkUI.ArkUI.Full 5729 * @form 5730 * @since 9 5731 */ 5732 /** 5733 * Space mode. 5734 * 5735 * @syscap SystemCapability.ArkUI.ArkUI.Full 5736 * @crossplatform 5737 * @form 5738 * @since 10 5739 */ 5740 /** 5741 * Space mode. 5742 * 5743 * @syscap SystemCapability.ArkUI.ArkUI.Full 5744 * @crossplatform 5745 * @form 5746 * @atomicservice 5747 * @since 11 5748 */ 5749 Space, 5750} 5751 5752/** 5753 * enum Blur style 5754 * 5755 * @enum { number } 5756 * @syscap SystemCapability.ArkUI.ArkUI.Full 5757 * @form 5758 * @since 9 5759 */ 5760/** 5761 * enum Blur style 5762 * 5763 * @enum { number } 5764 * @syscap SystemCapability.ArkUI.ArkUI.Full 5765 * @crossplatform 5766 * @form 5767 * @since 10 5768 */ 5769/** 5770 * enum Blur style 5771 * 5772 * @enum { number } 5773 * @syscap SystemCapability.ArkUI.ArkUI.Full 5774 * @crossplatform 5775 * @form 5776 * @atomicservice 5777 * @since 11 5778 */ 5779declare enum BlurStyle { 5780 /** 5781 * Defines the thin card material. 5782 * 5783 * @syscap SystemCapability.ArkUI.ArkUI.Full 5784 * @form 5785 * @since 9 5786 */ 5787 /** 5788 * Defines the thin card material. 5789 * 5790 * @syscap SystemCapability.ArkUI.ArkUI.Full 5791 * @crossplatform 5792 * @form 5793 * @since 10 5794 */ 5795 /** 5796 * Defines the thin card material. 5797 * 5798 * @syscap SystemCapability.ArkUI.ArkUI.Full 5799 * @crossplatform 5800 * @form 5801 * @atomicservice 5802 * @since 11 5803 */ 5804 Thin, 5805 5806 /** 5807 * Defines the regular card material. 5808 * 5809 * @syscap SystemCapability.ArkUI.ArkUI.Full 5810 * @form 5811 * @since 9 5812 */ 5813 /** 5814 * Defines the regular card material. 5815 * 5816 * @syscap SystemCapability.ArkUI.ArkUI.Full 5817 * @crossplatform 5818 * @form 5819 * @since 10 5820 */ 5821 /** 5822 * Defines the regular card material. 5823 * 5824 * @syscap SystemCapability.ArkUI.ArkUI.Full 5825 * @crossplatform 5826 * @form 5827 * @atomicservice 5828 * @since 11 5829 */ 5830 Regular, 5831 5832 /** 5833 * Defines the thick card material. 5834 * 5835 * @syscap SystemCapability.ArkUI.ArkUI.Full 5836 * @form 5837 * @since 9 5838 */ 5839 /** 5840 * Defines the thick card material. 5841 * 5842 * @syscap SystemCapability.ArkUI.ArkUI.Full 5843 * @crossplatform 5844 * @form 5845 * @since 10 5846 */ 5847 /** 5848 * Defines the thick card material. 5849 * 5850 * @syscap SystemCapability.ArkUI.ArkUI.Full 5851 * @crossplatform 5852 * @form 5853 * @atomicservice 5854 * @since 11 5855 */ 5856 Thick, 5857 5858 /** 5859 * Defines the thin background material. 5860 * 5861 * @syscap SystemCapability.ArkUI.ArkUI.Full 5862 * @crossplatform 5863 * @since 10 5864 */ 5865 /** 5866 * Defines the thin background material. 5867 * 5868 * @syscap SystemCapability.ArkUI.ArkUI.Full 5869 * @crossplatform 5870 * @form 5871 * @atomicservice 5872 * @since 11 5873 */ 5874 BACKGROUND_THIN, 5875 5876 /** 5877 * Defines the thin regular material. 5878 * 5879 * @syscap SystemCapability.ArkUI.ArkUI.Full 5880 * @crossplatform 5881 * @since 10 5882 */ 5883 /** 5884 * Defines the thin regular material. 5885 * 5886 * @syscap SystemCapability.ArkUI.ArkUI.Full 5887 * @crossplatform 5888 * @form 5889 * @atomicservice 5890 * @since 11 5891 */ 5892 BACKGROUND_REGULAR, 5893 5894 /** 5895 * Defines the thin thick material. 5896 * 5897 * @syscap SystemCapability.ArkUI.ArkUI.Full 5898 * @crossplatform 5899 * @since 10 5900 */ 5901 /** 5902 * Defines the thin thick material. 5903 * 5904 * @syscap SystemCapability.ArkUI.ArkUI.Full 5905 * @crossplatform 5906 * @form 5907 * @atomicservice 5908 * @since 11 5909 */ 5910 BACKGROUND_THICK, 5911 5912 /** 5913 * Defines the thin ultra thick material. 5914 * 5915 * @syscap SystemCapability.ArkUI.ArkUI.Full 5916 * @crossplatform 5917 * @since 10 5918 */ 5919 /** 5920 * Defines the thin ultra thick material. 5921 * 5922 * @syscap SystemCapability.ArkUI.ArkUI.Full 5923 * @crossplatform 5924 * @form 5925 * @atomicservice 5926 * @since 11 5927 */ 5928 BACKGROUND_ULTRA_THICK, 5929 5930 /** 5931 * Defines none material. 5932 * 5933 * @syscap SystemCapability.ArkUI.ArkUI.Full 5934 * @crossplatform 5935 * @form 5936 * @since 10 5937 */ 5938 /** 5939 * Defines none material. 5940 * 5941 * @syscap SystemCapability.ArkUI.ArkUI.Full 5942 * @crossplatform 5943 * @form 5944 * @atomicservice 5945 * @since 11 5946 */ 5947 NONE, 5948 5949 /** 5950 * Defines the ultra thin component material. 5951 * 5952 * @syscap SystemCapability.ArkUI.ArkUI.Full 5953 * @crossplatform 5954 * @form 5955 * @since 11 5956 */ 5957 /** 5958 * Defines the ultra thin component material. 5959 * 5960 * @syscap SystemCapability.ArkUI.ArkUI.Full 5961 * @crossplatform 5962 * @form 5963 * @atomicservice 5964 * @since 12 5965 */ 5966 COMPONENT_ULTRA_THIN = 8, 5967 5968 /** 5969 * Defines the thin component material. 5970 * 5971 * @syscap SystemCapability.ArkUI.ArkUI.Full 5972 * @crossplatform 5973 * @form 5974 * @since 11 5975 */ 5976 /** 5977 * Defines the thin component material. 5978 * 5979 * @syscap SystemCapability.ArkUI.ArkUI.Full 5980 * @crossplatform 5981 * @form 5982 * @atomicservice 5983 * @since 12 5984 */ 5985 COMPONENT_THIN = 9, 5986 5987 /** 5988 * Defines the regular component material. 5989 * 5990 * @syscap SystemCapability.ArkUI.ArkUI.Full 5991 * @crossplatform 5992 * @form 5993 * @since 11 5994 */ 5995 /** 5996 * Defines the regular component material. 5997 * 5998 * @syscap SystemCapability.ArkUI.ArkUI.Full 5999 * @crossplatform 6000 * @form 6001 * @atomicservice 6002 * @since 12 6003 */ 6004 COMPONENT_REGULAR = 10, 6005 6006 /** 6007 * Defines the thick component material. 6008 * 6009 * @syscap SystemCapability.ArkUI.ArkUI.Full 6010 * @crossplatform 6011 * @form 6012 * @since 11 6013 */ 6014 /** 6015 * Defines the thick component material. 6016 * 6017 * @syscap SystemCapability.ArkUI.ArkUI.Full 6018 * @crossplatform 6019 * @form 6020 * @atomicservice 6021 * @since 12 6022 */ 6023 COMPONENT_THICK = 11, 6024 6025 /** 6026 * Defines the ultra thick component material. 6027 * 6028 * @syscap SystemCapability.ArkUI.ArkUI.Full 6029 * @crossplatform 6030 * @form 6031 * @since 11 6032 */ 6033 /** 6034 * Defines the ultra thick component material. 6035 * 6036 * @syscap SystemCapability.ArkUI.ArkUI.Full 6037 * @crossplatform 6038 * @form 6039 * @atomicservice 6040 * @since 12 6041 */ 6042 COMPONENT_ULTRA_THICK = 12, 6043} 6044 6045/** 6046 * enum color mode 6047 * 6048 * @enum { number } 6049 * @syscap SystemCapability.ArkUI.ArkUI.Full 6050 * @crossplatform 6051 * @since 10 6052 */ 6053/** 6054 * enum color mode 6055 * 6056 * @enum { number } 6057 * @syscap SystemCapability.ArkUI.ArkUI.Full 6058 * @crossplatform 6059 * @atomicservice 6060 * @since 11 6061 */ 6062declare enum ThemeColorMode { 6063 /** 6064 * Defines the mode which is follow up with system. 6065 * 6066 * @syscap SystemCapability.ArkUI.ArkUI.Full 6067 * @crossplatform 6068 * @since 10 6069 */ 6070 /** 6071 * Defines the mode which is follow up with system. 6072 * 6073 * @syscap SystemCapability.ArkUI.ArkUI.Full 6074 * @crossplatform 6075 * @atomicservice 6076 * @since 11 6077 */ 6078 SYSTEM, 6079 6080 /** 6081 * Defines the light mode. 6082 * 6083 * @syscap SystemCapability.ArkUI.ArkUI.Full 6084 * @crossplatform 6085 * @since 10 6086 */ 6087 /** 6088 * Defines the light mode. 6089 * 6090 * @syscap SystemCapability.ArkUI.ArkUI.Full 6091 * @crossplatform 6092 * @atomicservice 6093 * @since 11 6094 */ 6095 LIGHT, 6096 6097 /** 6098 * Defines the dark mode. 6099 * 6100 * @syscap SystemCapability.ArkUI.ArkUI.Full 6101 * @crossplatform 6102 * @since 10 6103 */ 6104 /** 6105 * Defines the dark mode. 6106 * 6107 * @syscap SystemCapability.ArkUI.ArkUI.Full 6108 * @crossplatform 6109 * @atomicservice 6110 * @since 11 6111 */ 6112 DARK, 6113} 6114 6115/** 6116 * Defines adaptive color 6117 * 6118 * @enum { number } 6119 * @syscap SystemCapability.ArkUI.ArkUI.Full 6120 * @crossplatform 6121 * @since 10 6122 */ 6123/** 6124 * Defines adaptive color 6125 * 6126 * @enum { number } 6127 * @syscap SystemCapability.ArkUI.ArkUI.Full 6128 * @crossplatform 6129 * @atomicservice 6130 * @since 11 6131 */ 6132declare enum AdaptiveColor { 6133 /** 6134 * Defines the fixed value color adaptive mode. 6135 * 6136 * @syscap SystemCapability.ArkUI.ArkUI.Full 6137 * @crossplatform 6138 * @since 10 6139 */ 6140 /** 6141 * Defines the fixed value color adaptive mode. 6142 * 6143 * @syscap SystemCapability.ArkUI.ArkUI.Full 6144 * @crossplatform 6145 * @atomicservice 6146 * @since 11 6147 */ 6148 DEFAULT, 6149 6150 /** 6151 * Defines the background average color adaptive mode. 6152 * 6153 * @syscap SystemCapability.ArkUI.ArkUI.Full 6154 * @crossplatform 6155 * @since 10 6156 */ 6157 /** 6158 * Defines the background average color adaptive mode. 6159 * 6160 * @syscap SystemCapability.ArkUI.ArkUI.Full 6161 * @crossplatform 6162 * @atomicservice 6163 * @since 11 6164 */ 6165 AVERAGE, 6166} 6167 6168/** 6169 * Defines modal transition type. 6170 * 6171 * @enum { number } 6172 * @syscap SystemCapability.ArkUI.ArkUI.Full 6173 * @crossplatform 6174 * @since 10 6175 */ 6176/** 6177 * Defines modal transition type. 6178 * 6179 * @enum { number } 6180 * @syscap SystemCapability.ArkUI.ArkUI.Full 6181 * @crossplatform 6182 * @atomicservice 6183 * @since 11 6184 */ 6185declare enum ModalTransition { 6186 /** 6187 * Use default animation. 6188 * 6189 * @syscap SystemCapability.ArkUI.ArkUI.Full 6190 * @crossplatform 6191 * @since 10 6192 */ 6193 /** 6194 * Use default animation. 6195 * 6196 * @syscap SystemCapability.ArkUI.ArkUI.Full 6197 * @crossplatform 6198 * @atomicservice 6199 * @since 11 6200 */ 6201 DEFAULT, 6202 6203 /** 6204 * Use none animation. 6205 * 6206 * @syscap SystemCapability.ArkUI.ArkUI.Full 6207 * @crossplatform 6208 * @since 10 6209 */ 6210 /** 6211 * Use none animation. 6212 * 6213 * @syscap SystemCapability.ArkUI.ArkUI.Full 6214 * @crossplatform 6215 * @atomicservice 6216 * @since 11 6217 */ 6218 NONE, 6219 6220 /** 6221 * Use alpha animation. 6222 * 6223 * @syscap SystemCapability.ArkUI.ArkUI.Full 6224 * @crossplatform 6225 * @since 10 6226 */ 6227 /** 6228 * Use alpha animation. 6229 * 6230 * @syscap SystemCapability.ArkUI.ArkUI.Full 6231 * @crossplatform 6232 * @atomicservice 6233 * @since 11 6234 */ 6235 ALPHA, 6236} 6237 6238/** 6239 * Defines the options of backgroundBlurStyle 6240 * 6241 * @interface BackgroundBlurStyleOptions 6242 * @syscap SystemCapability.ArkUI.ArkUI.Full 6243 * @crossplatform 6244 * @since 10 6245 */ 6246/** 6247 * Defines the options of backgroundBlurStyle 6248 * 6249 * @interface BackgroundBlurStyleOptions 6250 * @syscap SystemCapability.ArkUI.ArkUI.Full 6251 * @crossplatform 6252 * @atomicservice 6253 * @since 11 6254 */ 6255declare interface BackgroundBlurStyleOptions extends BlurStyleOptions {} 6256 6257/** 6258 * Defines the options of ForegroundBlurStyle 6259 * 6260 * @interface ForegroundBlurStyleOptions 6261 * @syscap SystemCapability.ArkUI.ArkUI.Full 6262 * @crossplatform 6263 * @since 10 6264 */ 6265/** 6266 * Defines the options of ForegroundBlurStyle 6267 * 6268 * @interface ForegroundBlurStyleOptions 6269 * @syscap SystemCapability.ArkUI.ArkUI.Full 6270 * @crossplatform 6271 * @atomicservice 6272 * @since 11 6273 */ 6274declare interface ForegroundBlurStyleOptions extends BlurStyleOptions {} 6275 6276 6277/** 6278 * Defines the options of blur 6279 * 6280 * @interface BlurOptions 6281 * @syscap SystemCapability.ArkUI.ArkUI.Full 6282 * @crossplatform 6283 * @since 11 6284 */ 6285/** 6286 * Defines the options of blur 6287 * 6288 * @interface BlurOptions 6289 * @syscap SystemCapability.ArkUI.ArkUI.Full 6290 * @crossplatform 6291 * @atomicservice 6292 * @since 12 6293 */ 6294declare interface BlurOptions { 6295 /** 6296 * Fuzzy gray scale parameter. 6297 * @type { [number, number] } 6298 * @syscap SystemCapability.ArkUI.ArkUI.Full 6299 * @crossplatform 6300 * @since 11 6301 */ 6302 /** 6303 * Fuzzy gray scale parameter. 6304 * @type { [number, number] } 6305 * @syscap SystemCapability.ArkUI.ArkUI.Full 6306 * @crossplatform 6307 * @atomicservice 6308 * @since 12 6309 */ 6310 grayscale: [number, number]; 6311} 6312 6313/** 6314 * Defines the options of blurStyle 6315 * 6316 * @interface BlurStyleOptions 6317 * @syscap SystemCapability.ArkUI.ArkUI.Full 6318 * @crossplatform 6319 * @since 10 6320 */ 6321/** 6322 * Defines the options of blurStyle 6323 * 6324 * @interface BlurStyleOptions 6325 * @syscap SystemCapability.ArkUI.ArkUI.Full 6326 * @crossplatform 6327 * @atomicservice 6328 * @since 11 6329 */ 6330declare interface BlurStyleOptions { 6331 /** 6332 * color mode 6333 * 6334 * @type { ?ThemeColorMode } 6335 * @default ThemeColorMode.SYSTEM 6336 * @syscap SystemCapability.ArkUI.ArkUI.Full 6337 * @since 10 6338 */ 6339 /** 6340 * color mode 6341 * 6342 * @type { ?ThemeColorMode } 6343 * @default ThemeColorMode.SYSTEM 6344 * @syscap SystemCapability.ArkUI.ArkUI.Full 6345 * @crossplatform 6346 * @atomicservice 6347 * @since 11 6348 */ 6349 colorMode?: ThemeColorMode; 6350 6351 /** 6352 * adaptive color 6353 * 6354 * @type { ?AdaptiveColor } 6355 * @default AdaptiveColor.DEFAULT 6356 * @syscap SystemCapability.ArkUI.ArkUI.Full 6357 * @since 10 6358 */ 6359 /** 6360 * adaptive color 6361 * 6362 * @type { ?AdaptiveColor } 6363 * @default AdaptiveColor.DEFAULT 6364 * @syscap SystemCapability.ArkUI.ArkUI.Full 6365 * @crossplatform 6366 * @atomicservice 6367 * @since 11 6368 */ 6369 adaptiveColor?: AdaptiveColor; 6370 6371 /** 6372 * Define the scale of blur effect. 6373 * The range of value is [0, 1]. The larger the value, the more obvious the blurring effect. 6374 * A value of 0 indicates no blur effect and a value of 1 indicates a complete blur effect. 6375 * 6376 * @type { ?number } 6377 * @default 1.0 6378 * @syscap SystemCapability.ArkUI.ArkUI.Full 6379 * @atomicservice 6380 * @since 12 6381 */ 6382 scale?: number; 6383 6384 /** 6385 * Defines the options of blur 6386 * 6387 * @type { ?BlurOptions } 6388 * @default { grayScale: [0,0] } 6389 * @syscap SystemCapability.ArkUI.ArkUI.Full 6390 * @crossplatform 6391 * @since 11 6392 */ 6393 /** 6394 * Defines the options of blur 6395 * 6396 * @type { ?BlurOptions } 6397 * @default { grayScale: [0,0] } 6398 * @syscap SystemCapability.ArkUI.ArkUI.Full 6399 * @crossplatform 6400 * @atomicservice 6401 * @since 12 6402 */ 6403 blurOptions?: BlurOptions; 6404} 6405 6406/** 6407 * Defines the options of BackgroundEffect 6408 * 6409 * @interface BackgroundEffectOptions 6410 * @syscap SystemCapability.ArkUI.ArkUI.Full 6411 * @crossplatform 6412 * @since 11 6413 */ 6414/** 6415 * Defines the options of BackgroundEffect 6416 * 6417 * @interface BackgroundEffectOptions 6418 * @syscap SystemCapability.ArkUI.ArkUI.Full 6419 * @crossplatform 6420 * @atomicservice 6421 * @since 12 6422 */ 6423declare interface BackgroundEffectOptions { 6424 6425 /** 6426 * Define the radius size of BackgroundEffect.The range of this value is [0, ∞) 6427 * 6428 * @type { number } 6429 * @syscap SystemCapability.ArkUI.ArkUI.Full 6430 * @crossplatform 6431 * @since 11 6432 */ 6433 /** 6434 * Define the radius size of BackgroundEffect.The range of this value is [0, ∞) 6435 * 6436 * @type { number } 6437 * @syscap SystemCapability.ArkUI.ArkUI.Full 6438 * @crossplatform 6439 * @atomicservice 6440 * @since 12 6441 */ 6442 radius: number; 6443 6444 /** 6445 * Define the saturation of BackgroundEffect. Value range [0, ∞) 6446 * 6447 * @type { ?number } 6448 * @default 1 6449 * @syscap SystemCapability.ArkUI.ArkUI.Full 6450 * @crossplatform 6451 * @since 11 6452 */ 6453 /** 6454 * Define the saturation of BackgroundEffect. Value range [0, ∞) 6455 * 6456 * @type { ?number } 6457 * @default 1 6458 * @syscap SystemCapability.ArkUI.ArkUI.Full 6459 * @crossplatform 6460 * @atomicservice 6461 * @since 12 6462 */ 6463 saturation?: number; 6464 6465 /** 6466 * Define the brightness of BackgroundEffect. Value range [0, ∞) 6467 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 6468 * @type { ?number } 6469 * @default 1 6470 * @syscap SystemCapability.ArkUI.ArkUI.Full 6471 * @crossplatform 6472 * @since 11 6473 */ 6474 /** 6475 * Define the brightness of BackgroundEffect. Value range [0, ∞) 6476 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 6477 * @type { ?number } 6478 * @default 1 6479 * @syscap SystemCapability.ArkUI.ArkUI.Full 6480 * @crossplatform 6481 * @atomicservice 6482 * @since 12 6483 */ 6484 brightness?: number; 6485 6486 /** 6487 * color the brightness of BackgroundEffect. 6488 * 6489 * @type { ?ResourceColor } 6490 * @default Color.Transparent 6491 * @syscap SystemCapability.ArkUI.ArkUI.Full 6492 * @crossplatform 6493 * @since 11 6494 */ 6495 /** 6496 * color the brightness of BackgroundEffect. 6497 * 6498 * @type { ?ResourceColor } 6499 * @default Color.Transparent 6500 * @syscap SystemCapability.ArkUI.ArkUI.Full 6501 * @crossplatform 6502 * @atomicservice 6503 * @since 12 6504 */ 6505 color?: ResourceColor; 6506 6507 /** 6508 * Define the adaptiveColor of BackgroundEffect. 6509 * 6510 * @type { ?AdaptiveColor } 6511 * @default AdaptiveColor.DEFAULT 6512 * @syscap SystemCapability.ArkUI.ArkUI.Full 6513 * @crossplatform 6514 * @since 11 6515 */ 6516 /** 6517 * Define the adaptiveColor of BackgroundEffect. 6518 * 6519 * @type { ?AdaptiveColor } 6520 * @default AdaptiveColor.DEFAULT 6521 * @syscap SystemCapability.ArkUI.ArkUI.Full 6522 * @crossplatform 6523 * @atomicservice 6524 * @since 12 6525 */ 6526 adaptiveColor?: AdaptiveColor; 6527 6528 /** 6529 * Define the blurOptions of BackgroundEffect. 6530 * 6531 * @type { ?BlurOptions } 6532 * @default { grayScale: [0,1] } 6533 * @syscap SystemCapability.ArkUI.ArkUI.Full 6534 * @crossplatform 6535 * @since 11 6536 */ 6537 /** 6538 * Define the blurOptions of BackgroundEffect. 6539 * 6540 * @type { ?BlurOptions } 6541 * @default { grayScale: [0,0] } 6542 * @syscap SystemCapability.ArkUI.ArkUI.Full 6543 * @crossplatform 6544 * @atomicservice 6545 * @since 12 6546 */ 6547 blurOptions?: BlurOptions; 6548} 6549 6550/** 6551 * Defines the options of ForegroundEffect 6552 * 6553 * @interface ForegroundEffectOptions 6554 * @syscap SystemCapability.ArkUI.ArkUI.Full 6555 * @crossplatform 6556 * @atomicservice 6557 * @since 12 6558 */ 6559declare interface ForegroundEffectOptions { 6560 6561 /** 6562 * Define the radius size of ForegroundEffect.The range of this value is [0, ∞) 6563 * 6564 * @type { number } 6565 * @syscap SystemCapability.ArkUI.ArkUI.Full 6566 * @crossplatform 6567 * @atomicservice 6568 * @since 12 6569 */ 6570 radius: number; 6571} 6572 6573/** 6574 * Provide an interface for the text style of picker 6575 * 6576 * @interface PickerTextStyle 6577 * @syscap SystemCapability.ArkUI.ArkUI.Full 6578 * @crossplatform 6579 * @since 10 6580 */ 6581/** 6582 * Provide an interface for the text style of picker 6583 * 6584 * @interface PickerTextStyle 6585 * @syscap SystemCapability.ArkUI.ArkUI.Full 6586 * @crossplatform 6587 * @atomicservice 6588 * @since 11 6589 */ 6590declare interface PickerTextStyle { 6591 /** 6592 * Define the text color of picker. 6593 * 6594 * @type { ?ResourceColor } 6595 * @syscap SystemCapability.ArkUI.ArkUI.Full 6596 * @crossplatform 6597 * @since 10 6598 */ 6599 /** 6600 * Define the text color of picker. 6601 * 6602 * @type { ?ResourceColor } 6603 * @syscap SystemCapability.ArkUI.ArkUI.Full 6604 * @crossplatform 6605 * @atomicservice 6606 * @since 11 6607 */ 6608 color?: ResourceColor; 6609 6610 /** 6611 * Define the text font of picker. 6612 * Only support size and weight. 6613 * 6614 * @type { ?Font } 6615 * @syscap SystemCapability.ArkUI.ArkUI.Full 6616 * @crossplatform 6617 * @since 10 6618 */ 6619 /** 6620 * Define the text font of picker. 6621 * Only support size and weight. 6622 * 6623 * @type { ?Font } 6624 * @syscap SystemCapability.ArkUI.ArkUI.Full 6625 * @crossplatform 6626 * @atomicservice 6627 * @since 11 6628 */ 6629 font?: Font; 6630} 6631 6632/** 6633 * Provide an interface for the button style of picker 6634 * 6635 * @interface PickerDialogButtonStyle 6636 * @syscap SystemCapability.ArkUI.ArkUI.Full 6637 * @crossplatform 6638 * @atomicservice 6639 * @since 12 6640 */ 6641declare interface PickerDialogButtonStyle { 6642 /** 6643 * Describes the button style. 6644 * 6645 * @type { ?ButtonType } 6646 * @syscap SystemCapability.ArkUI.ArkUI.Full 6647 * @crossplatform 6648 * @atomicservice 6649 * @since 12 6650 */ 6651 type?: ButtonType; 6652 6653 /** 6654 * Describes the button style. 6655 * 6656 * @type { ?ButtonStyleMode } 6657 * @syscap SystemCapability.ArkUI.ArkUI.Full 6658 * @crossplatform 6659 * @atomicservice 6660 * @since 12 6661 */ 6662 style?: ButtonStyleMode; 6663 6664 /** 6665 * Describes the button role. 6666 * 6667 * @type { ?ButtonRole } 6668 * @syscap SystemCapability.ArkUI.ArkUI.Full 6669 * @crossplatform 6670 * @atomicservice 6671 * @since 12 6672 */ 6673 role?: ButtonRole; 6674 6675 /** 6676 * Describes the button text size. 6677 * 6678 * @type { ?Length } 6679 * @syscap SystemCapability.ArkUI.ArkUI.Full 6680 * @crossplatform 6681 * @atomicservice 6682 * @since 12 6683 */ 6684 fontSize?: Length; 6685 6686 /** 6687 * Describes the button text color. 6688 * 6689 * @type { ?ResourceColor } 6690 * @syscap SystemCapability.ArkUI.ArkUI.Full 6691 * @crossplatform 6692 * @atomicservice 6693 * @since 12 6694 */ 6695 fontColor?: ResourceColor; 6696 6697 /** 6698 * Describes the button font weight. 6699 * 6700 * @type { ?(FontWeight | number | string) } 6701 * @syscap SystemCapability.ArkUI.ArkUI.Full 6702 * @crossplatform 6703 * @atomicservice 6704 * @since 12 6705 */ 6706 fontWeight?: FontWeight | number | string; 6707 6708 /** 6709 * Describes the button font style. 6710 * 6711 * @type { ?FontStyle } 6712 * @syscap SystemCapability.ArkUI.ArkUI.Full 6713 * @crossplatform 6714 * @atomicservice 6715 * @since 12 6716 */ 6717 fontStyle?: FontStyle; 6718 6719 /** 6720 * Describes the button font family. 6721 * 6722 * @type { ?(Resource | string) } 6723 * @syscap SystemCapability.ArkUI.ArkUI.Full 6724 * @crossplatform 6725 * @atomicservice 6726 * @since 12 6727 */ 6728 fontFamily?: Resource | string; 6729 6730 /** 6731 * Describes the button background color. 6732 * 6733 * @type { ?ResourceColor } 6734 * @syscap SystemCapability.ArkUI.ArkUI.Full 6735 * @crossplatform 6736 * @atomicservice 6737 * @since 12 6738 */ 6739 backgroundColor?: ResourceColor; 6740 6741 /** 6742 * Describes the button border radius. 6743 * 6744 * @type { ?(Length | BorderRadiuses) } 6745 * @syscap SystemCapability.ArkUI.ArkUI.Full 6746 * @crossplatform 6747 * @atomicservice 6748 * @since 12 6749 */ 6750 borderRadius?: Length | BorderRadiuses; 6751 6752 /** 6753 * Define whether the button default to responding to the Enter key 6754 * 6755 * @type { ?boolean } 6756 * @syscap SystemCapability.ArkUI.ArkUI.Full 6757 * @crossplatform 6758 * @atomicservice 6759 * @since 12 6760 */ 6761 primary?: boolean; 6762} 6763 6764/** 6765 * Define the type of shadow 6766 * 6767 * @enum { number } 6768 * @syscap SystemCapability.ArkUI.ArkUI.Full 6769 * @crossplatform 6770 * @since 10 6771 */ 6772/** 6773 * Define the type of shadow 6774 * 6775 * @enum { number } 6776 * @syscap SystemCapability.ArkUI.ArkUI.Full 6777 * @crossplatform 6778 * @atomicservice 6779 * @since 11 6780 */ 6781declare enum ShadowType { 6782 /** 6783 * Define a color type of shadow 6784 * 6785 * @syscap SystemCapability.ArkUI.ArkUI.Full 6786 * @crossplatform 6787 * @since 10 6788 */ 6789 /** 6790 * Define a color type of shadow 6791 * 6792 * @syscap SystemCapability.ArkUI.ArkUI.Full 6793 * @crossplatform 6794 * @atomicservice 6795 * @since 11 6796 */ 6797 COLOR, 6798 6799 /** 6800 * Define a blur type of shadow 6801 * 6802 * @syscap SystemCapability.ArkUI.ArkUI.Full 6803 * @crossplatform 6804 * @since 10 6805 */ 6806 /** 6807 * Define a blur type of shadow 6808 * 6809 * @syscap SystemCapability.ArkUI.ArkUI.Full 6810 * @crossplatform 6811 * @atomicservice 6812 * @since 11 6813 */ 6814 BLUR, 6815} 6816 6817/** 6818 * Define the options of shadow 6819 * 6820 * @interface ShadowOptions 6821 * @syscap SystemCapability.ArkUI.ArkUI.Full 6822 * @since 7 6823 */ 6824/** 6825 * Define the options of shadow 6826 * 6827 * @interface ShadowOptions 6828 * @syscap SystemCapability.ArkUI.ArkUI.Full 6829 * @form 6830 * @since 9 6831 */ 6832/** 6833 * Define the options of shadow 6834 * 6835 * @interface ShadowOptions 6836 * @syscap SystemCapability.ArkUI.ArkUI.Full 6837 * @crossplatform 6838 * @form 6839 * @since 10 6840 */ 6841/** 6842 * Define the options of shadow 6843 * 6844 * @interface ShadowOptions 6845 * @syscap SystemCapability.ArkUI.ArkUI.Full 6846 * @crossplatform 6847 * @form 6848 * @atomicservice 6849 * @since 11 6850 */ 6851declare interface ShadowOptions { 6852 /** 6853 * Define the radius size of shadow 6854 * 6855 * @type { number | Resource } 6856 * @syscap SystemCapability.ArkUI.ArkUI.Full 6857 * @since 7 6858 */ 6859 /** 6860 * Define the radius size of shadow 6861 * 6862 * @type { number | Resource } 6863 * @syscap SystemCapability.ArkUI.ArkUI.Full 6864 * @form 6865 * @since 9 6866 */ 6867 /** 6868 * Define the radius size of shadow 6869 * 6870 * @type { number | Resource } 6871 * @syscap SystemCapability.ArkUI.ArkUI.Full 6872 * @crossplatform 6873 * @form 6874 * @since 10 6875 */ 6876 /** 6877 * Define the radius size of shadow 6878 * 6879 * @type { number | Resource } 6880 * @syscap SystemCapability.ArkUI.ArkUI.Full 6881 * @crossplatform 6882 * @form 6883 * @atomicservice 6884 * @since 11 6885 */ 6886 radius: number | Resource; 6887 6888 /** 6889 * Define the type of shadow 6890 * 6891 * @type { ?ShadowType } 6892 * @default ShadowType.COLOR 6893 * @syscap SystemCapability.ArkUI.ArkUI.Full 6894 * @crossplatform 6895 * @since 10 6896 */ 6897 /** 6898 * Define the type of shadow 6899 * 6900 * @type { ?ShadowType } 6901 * @default ShadowType.COLOR 6902 * @syscap SystemCapability.ArkUI.ArkUI.Full 6903 * @crossplatform 6904 * @atomicservice 6905 * @since 11 6906 */ 6907 type?: ShadowType; 6908 6909 /** 6910 * Define the color of shadow 6911 * 6912 * @type { ?(Color | string | Resource) } 6913 * @syscap SystemCapability.ArkUI.ArkUI.Full 6914 * @since 7 6915 */ 6916 /** 6917 * Define the color of shadow 6918 * 6919 * @type { ?(Color | string | Resource) } 6920 * @syscap SystemCapability.ArkUI.ArkUI.Full 6921 * @form 6922 * @since 9 6923 */ 6924 /** 6925 * Define the color of shadow 6926 * 6927 * @type { ?(Color | string | Resource) } 6928 * @syscap SystemCapability.ArkUI.ArkUI.Full 6929 * @crossplatform 6930 * @form 6931 * @since 10 6932 */ 6933 /** 6934 * Define the color or the color strategy of shadow 6935 * 6936 * @type { ?(Color | string | Resource| ColoringStrategy) } 6937 * @syscap SystemCapability.ArkUI.ArkUI.Full 6938 * @crossplatform 6939 * @form 6940 * @atomicservice 6941 * @since 11 6942 */ 6943 color?: Color | string | Resource | ColoringStrategy; 6944 6945 /** 6946 * Define the horizontal offset size of shadow 6947 * 6948 * @type { ?(number | Resource) } 6949 * @syscap SystemCapability.ArkUI.ArkUI.Full 6950 * @since 7 6951 */ 6952 /** 6953 * Define the horizontal offset size of shadow 6954 * 6955 * @type { ?(number | Resource) } 6956 * @syscap SystemCapability.ArkUI.ArkUI.Full 6957 * @form 6958 * @since 9 6959 */ 6960 /** 6961 * Define the horizontal offset size of shadow 6962 * 6963 * @type { ?(number | Resource) } 6964 * @syscap SystemCapability.ArkUI.ArkUI.Full 6965 * @crossplatform 6966 * @form 6967 * @since 10 6968 */ 6969 /** 6970 * Define the horizontal offset size of shadow 6971 * 6972 * @type { ?(number | Resource) } 6973 * @syscap SystemCapability.ArkUI.ArkUI.Full 6974 * @crossplatform 6975 * @form 6976 * @atomicservice 6977 * @since 11 6978 */ 6979 offsetX?: number | Resource; 6980 6981 /** 6982 * Define the vertical offset size of shadow 6983 * 6984 * @type { ?(number | Resource) } 6985 * @syscap SystemCapability.ArkUI.ArkUI.Full 6986 * @since 7 6987 */ 6988 /** 6989 * Define the vertical offset size of shadow 6990 * 6991 * @type { ?(number | Resource) } 6992 * @syscap SystemCapability.ArkUI.ArkUI.Full 6993 * @form 6994 * @since 9 6995 */ 6996 /** 6997 * Define the vertical offset size of shadow 6998 * 6999 * @type { ?(number | Resource) } 7000 * @syscap SystemCapability.ArkUI.ArkUI.Full 7001 * @crossplatform 7002 * @form 7003 * @since 10 7004 */ 7005 /** 7006 * Define the vertical offset size of shadow 7007 * 7008 * @type { ?(number | Resource) } 7009 * @syscap SystemCapability.ArkUI.ArkUI.Full 7010 * @crossplatform 7011 * @form 7012 * @atomicservice 7013 * @since 11 7014 */ 7015 offsetY?: number | Resource; 7016 7017 /** 7018 * Define whether the shadow should fill the area 7019 * 7020 * @type { ?boolean } 7021 * @default false 7022 * @syscap SystemCapability.ArkUI.ArkUI.Full 7023 * @crossplatform 7024 * @since 11 7025 */ 7026 /** 7027 * Define whether the shadow should fill the area 7028 * 7029 * @type { ?boolean } 7030 * @default false 7031 * @syscap SystemCapability.ArkUI.ArkUI.Full 7032 * @crossplatform 7033 * @atomicservice 7034 * @since 12 7035 */ 7036 fill?: boolean; 7037} 7038 7039/** 7040 * enum Shadow style 7041 * 7042 * @enum { number } 7043 * @syscap SystemCapability.ArkUI.ArkUI.Full 7044 * @crossplatform 7045 * @since 10 7046 */ 7047/** 7048 * enum Shadow style 7049 * 7050 * @enum { number } 7051 * @syscap SystemCapability.ArkUI.ArkUI.Full 7052 * @crossplatform 7053 * @atomicservice 7054 * @since 11 7055 */ 7056declare enum ShadowStyle { 7057 /** 7058 * Defines the super small default shadow style. 7059 * 7060 * @syscap SystemCapability.ArkUI.ArkUI.Full 7061 * @crossplatform 7062 * @since 10 7063 */ 7064 /** 7065 * Defines the super small default shadow style. 7066 * 7067 * @syscap SystemCapability.ArkUI.ArkUI.Full 7068 * @crossplatform 7069 * @atomicservice 7070 * @since 11 7071 */ 7072 OUTER_DEFAULT_XS, 7073 7074 /** 7075 * Defines the small default shadow style. 7076 * 7077 * @syscap SystemCapability.ArkUI.ArkUI.Full 7078 * @crossplatform 7079 * @since 10 7080 */ 7081 /** 7082 * Defines the small default shadow style. 7083 * 7084 * @syscap SystemCapability.ArkUI.ArkUI.Full 7085 * @crossplatform 7086 * @atomicservice 7087 * @since 11 7088 */ 7089 OUTER_DEFAULT_SM, 7090 7091 /** 7092 * Defines the medium default shadow style. 7093 * 7094 * @syscap SystemCapability.ArkUI.ArkUI.Full 7095 * @crossplatform 7096 * @since 10 7097 */ 7098 /** 7099 * Defines the medium default shadow style. 7100 * 7101 * @syscap SystemCapability.ArkUI.ArkUI.Full 7102 * @crossplatform 7103 * @atomicservice 7104 * @since 11 7105 */ 7106 OUTER_DEFAULT_MD, 7107 7108 /** 7109 * Defines the large default shadow style. 7110 * 7111 * @syscap SystemCapability.ArkUI.ArkUI.Full 7112 * @crossplatform 7113 * @since 10 7114 */ 7115 /** 7116 * Defines the large default shadow style. 7117 * 7118 * @syscap SystemCapability.ArkUI.ArkUI.Full 7119 * @crossplatform 7120 * @atomicservice 7121 * @since 11 7122 */ 7123 OUTER_DEFAULT_LG, 7124 7125 /** 7126 * Defines the small floating shadow style. 7127 * 7128 * @syscap SystemCapability.ArkUI.ArkUI.Full 7129 * @crossplatform 7130 * @since 10 7131 */ 7132 /** 7133 * Defines the small floating shadow style. 7134 * 7135 * @syscap SystemCapability.ArkUI.ArkUI.Full 7136 * @crossplatform 7137 * @atomicservice 7138 * @since 11 7139 */ 7140 OUTER_FLOATING_SM, 7141 7142 /** 7143 * Defines the medium floating shadow style. 7144 * 7145 * @syscap SystemCapability.ArkUI.ArkUI.Full 7146 * @crossplatform 7147 * @since 10 7148 */ 7149 /** 7150 * Defines the medium floating shadow style. 7151 * 7152 * @syscap SystemCapability.ArkUI.ArkUI.Full 7153 * @crossplatform 7154 * @atomicservice 7155 * @since 11 7156 */ 7157 OUTER_FLOATING_MD, 7158} 7159 7160/** 7161 * Defines the options of Shadow. 7162 * 7163 * @interface MultiShadowOptions 7164 * @syscap SystemCapability.ArkUI.ArkUI.Full 7165 * @crossplatform 7166 * @since 10 7167 */ 7168/** 7169 * Defines the options of Shadow. 7170 * 7171 * @interface MultiShadowOptions 7172 * @syscap SystemCapability.ArkUI.ArkUI.Full 7173 * @crossplatform 7174 * @atomicservice 7175 * @since 11 7176 */ 7177declare interface MultiShadowOptions { 7178 /** 7179 * Current shadow radius. 7180 * 7181 * @type { ?(number | Resource) } 7182 * @default 5 7183 * @syscap SystemCapability.ArkUI.ArkUI.Full 7184 * @crossplatform 7185 * @since 10 7186 */ 7187 /** 7188 * Current shadow radius. 7189 * 7190 * @type { ?(number | Resource) } 7191 * @default 20 7192 * @syscap SystemCapability.ArkUI.ArkUI.Full 7193 * @crossplatform 7194 * @atomicservice 7195 * @since 11 7196 */ 7197 radius?: number | Resource; 7198 7199 /** 7200 * Current shadow offsetX. 7201 * 7202 * @type { ?(number | Resource) } 7203 * @default 5 7204 * @syscap SystemCapability.ArkUI.ArkUI.Full 7205 * @crossplatform 7206 * @since 10 7207 */ 7208 /** 7209 * Current shadow offsetX. 7210 * 7211 * @type { ?(number | Resource) } 7212 * @default 5 7213 * @syscap SystemCapability.ArkUI.ArkUI.Full 7214 * @crossplatform 7215 * @atomicservice 7216 * @since 11 7217 */ 7218 offsetX?: number | Resource; 7219 7220 /** 7221 * Current shadow offsetY 7222 * 7223 * @type { ?(number | Resource) } 7224 * @default 5 7225 * @syscap SystemCapability.ArkUI.ArkUI.Full 7226 * @crossplatform 7227 * @since 10 7228 */ 7229 /** 7230 * Current shadow offsetY 7231 * 7232 * @type { ?(number | Resource) } 7233 * @default 5 7234 * @syscap SystemCapability.ArkUI.ArkUI.Full 7235 * @crossplatform 7236 * @atomicservice 7237 * @since 11 7238 */ 7239 offsetY?: number | Resource; 7240} 7241 7242/** 7243 * Enumerates the safe area types. 7244 * 7245 * @enum { number } 7246 * @syscap SystemCapability.ArkUI.ArkUI.Full 7247 * @since 10 7248 */ 7249/** 7250 * Enumerates the safe area types. 7251 * 7252 * @enum { number } 7253 * @syscap SystemCapability.ArkUI.ArkUI.Full 7254 * @crossplatform 7255 * @atomicservice 7256 * @since 11 7257 */ 7258declare enum SafeAreaType { 7259 /** 7260 * Default area of the system, including the status bar and navigation bar. 7261 * 7262 * @syscap SystemCapability.ArkUI.ArkUI.Full 7263 * @since 10 7264 */ 7265 /** 7266 * Default area of the system, including the status bar and navigation bar. 7267 * 7268 * @syscap SystemCapability.ArkUI.ArkUI.Full 7269 * @crossplatform 7270 * @atomicservice 7271 * @since 11 7272 */ 7273 SYSTEM, 7274 7275 /** 7276 * Notch or punch hole. 7277 * 7278 * @syscap SystemCapability.ArkUI.ArkUI.Full 7279 * @since 10 7280 */ 7281 /** 7282 * Notch or punch hole. 7283 * 7284 * @syscap SystemCapability.ArkUI.ArkUI.Full 7285 * @crossplatform 7286 * @atomicservice 7287 * @since 11 7288 */ 7289 CUTOUT, 7290 7291 /** 7292 * Soft keyboard area. 7293 * 7294 * @syscap SystemCapability.ArkUI.ArkUI.Full 7295 * @since 10 7296 */ 7297 /** 7298 * Soft keyboard area. 7299 * 7300 * @syscap SystemCapability.ArkUI.ArkUI.Full 7301 * @crossplatform 7302 * @atomicservice 7303 * @since 11 7304 */ 7305 KEYBOARD 7306} 7307 7308/** 7309 * Enumerates the safe area edges. 7310 * 7311 * @enum { number } 7312 * @syscap SystemCapability.ArkUI.ArkUI.Full 7313 * @since 10 7314 */ 7315/** 7316 * Enumerates the safe area edges. 7317 * 7318 * @enum { number } 7319 * @syscap SystemCapability.ArkUI.ArkUI.Full 7320 * @crossplatform 7321 * @atomicservice 7322 * @since 11 7323 */ 7324declare enum SafeAreaEdge { 7325 /** 7326 * Top edge of the safe area. 7327 * 7328 * @syscap SystemCapability.ArkUI.ArkUI.Full 7329 * @since 10 7330 */ 7331 /** 7332 * Top edge of the safe area. 7333 * 7334 * @syscap SystemCapability.ArkUI.ArkUI.Full 7335 * @crossplatform 7336 * @atomicservice 7337 * @since 11 7338 */ 7339 TOP, 7340 7341 /** 7342 * Bottom edge of the safe area. 7343 * 7344 * @syscap SystemCapability.ArkUI.ArkUI.Full 7345 * @since 10 7346 */ 7347 /** 7348 * Bottom edge of the safe area. 7349 * 7350 * @syscap SystemCapability.ArkUI.ArkUI.Full 7351 * @crossplatform 7352 * @atomicservice 7353 * @since 11 7354 */ 7355 BOTTOM, 7356 7357 /** 7358 * Start edge of the safe area. 7359 * 7360 * @syscap SystemCapability.ArkUI.ArkUI.Full 7361 * @since 10 7362 */ 7363 /** 7364 * Start edge of the safe area. 7365 * 7366 * @syscap SystemCapability.ArkUI.ArkUI.Full 7367 * @crossplatform 7368 * @atomicservice 7369 * @since 11 7370 */ 7371 START, 7372 7373 /** 7374 * End edge of the safe area. 7375 * 7376 * @syscap SystemCapability.ArkUI.ArkUI.Full 7377 * @since 10 7378 */ 7379 /** 7380 * End edge of the safe area. 7381 * 7382 * @syscap SystemCapability.ArkUI.ArkUI.Full 7383 * @crossplatform 7384 * @atomicservice 7385 * @since 11 7386 */ 7387 END 7388} 7389 7390/** 7391 * Enumerates the safe area types can be ignored. 7392 * 7393 * @enum { number } 7394 * @syscap SystemCapability.ArkUI.ArkUI.Full 7395 * @crossplatform 7396 * @atomicservice 7397 * @since 12 7398 */ 7399declare enum LayoutSafeAreaType { 7400 /** 7401 * Default area of the system, including the status bar and navigation bar. 7402 * 7403 * @syscap SystemCapability.ArkUI.ArkUI.Full 7404 * @crossplatform 7405 * @atomicservice 7406 * @since 12 7407 */ 7408 SYSTEM = 0, 7409} 7410 7411/** 7412 * Enumerates the safe area edges can be ignored. 7413 * 7414 * @enum { number } 7415 * @syscap SystemCapability.ArkUI.ArkUI.Full 7416 * @crossplatform 7417 * @atomicservice 7418 * @since 12 7419 */ 7420declare enum LayoutSafeAreaEdge { 7421 /** 7422 * Top edge of the safe area. 7423 * 7424 * @syscap SystemCapability.ArkUI.ArkUI.Full 7425 * @crossplatform 7426 * @atomicservice 7427 * @since 12 7428 */ 7429 TOP = 0, 7430 7431 /** 7432 * Bottom edge of the safe area. 7433 * 7434 * @syscap SystemCapability.ArkUI.ArkUI.Full 7435 * @crossplatform 7436 * @atomicservice 7437 * @since 12 7438 */ 7439 BOTTOM = 1, 7440} 7441 7442/** 7443 * Defines sheet size type. 7444 * 7445 * @enum { number } 7446 * @syscap SystemCapability.ArkUI.ArkUI.Full 7447 * @crossplatform 7448 * @since 10 7449 */ 7450/** 7451 * Defines sheet size type. 7452 * 7453 * @enum { number } 7454 * @syscap SystemCapability.ArkUI.ArkUI.Full 7455 * @crossplatform 7456 * @atomicservice 7457 * @since 11 7458 */ 7459declare enum SheetSize { 7460 /** 7461 * Defines the sheet size medium height type. The height is half the screen height 7462 * 7463 * @syscap SystemCapability.ArkUI.ArkUI.Full 7464 * @crossplatform 7465 * @since 10 7466 */ 7467 /** 7468 * Defines the sheet size medium height type. The height is half the screen height 7469 * 7470 * @syscap SystemCapability.ArkUI.ArkUI.Full 7471 * @crossplatform 7472 * @atomicservice 7473 * @since 11 7474 */ 7475 MEDIUM, 7476 7477 /** 7478 * Defines the sheet size large height type. The height is almost screen height. 7479 * 7480 * @syscap SystemCapability.ArkUI.ArkUI.Full 7481 * @crossplatform 7482 * @since 10 7483 */ 7484 /** 7485 * Defines the sheet size large height type. The height is almost screen height. 7486 * 7487 * @syscap SystemCapability.ArkUI.ArkUI.Full 7488 * @crossplatform 7489 * @atomicservice 7490 * @since 11 7491 */ 7492 LARGE, 7493 7494 /** 7495 * Defines the sheet size fit content height type. The height fit content. 7496 * 7497 * @syscap SystemCapability.ArkUI.ArkUI.Full 7498 * @crossplatform 7499 * @since 11 7500 */ 7501 /** 7502 * Defines the sheet size fit content height type. The height fit content. 7503 * 7504 * @syscap SystemCapability.ArkUI.ArkUI.Full 7505 * @crossplatform 7506 * @atomicservice 7507 * @since 12 7508 */ 7509 FIT_CONTENT = 2, 7510} 7511 7512/** 7513 * Defines the base event. 7514 * 7515 * @interface BaseEvent 7516 * @syscap SystemCapability.ArkUI.ArkUI.Full 7517 * @since 8 7518 */ 7519/** 7520 * Defines the base event. 7521 * 7522 * @interface BaseEvent 7523 * @syscap SystemCapability.ArkUI.ArkUI.Full 7524 * @form 7525 * @since 9 7526 */ 7527/** 7528 * Defines the base event. 7529 * 7530 * @interface BaseEvent 7531 * @syscap SystemCapability.ArkUI.ArkUI.Full 7532 * @crossplatform 7533 * @form 7534 * @since 10 7535 */ 7536/** 7537 * Defines the base event. 7538 * 7539 * @interface BaseEvent 7540 * @syscap SystemCapability.ArkUI.ArkUI.Full 7541 * @crossplatform 7542 * @form 7543 * @atomicservice 7544 * @since 11 7545 */ 7546declare interface BaseEvent { 7547 /** 7548 * Defines the current target which fires this event. 7549 * 7550 * @type { EventTarget } 7551 * @syscap SystemCapability.ArkUI.ArkUI.Full 7552 * @since 8 7553 */ 7554 /** 7555 * Defines the current target which fires this event. 7556 * 7557 * @type { EventTarget } 7558 * @syscap SystemCapability.ArkUI.ArkUI.Full 7559 * @form 7560 * @since 9 7561 */ 7562 /** 7563 * Defines the current target which fires this event. 7564 * 7565 * @type { EventTarget } 7566 * @syscap SystemCapability.ArkUI.ArkUI.Full 7567 * @crossplatform 7568 * @form 7569 * @since 10 7570 */ 7571 /** 7572 * Defines the current target which fires this event. 7573 * 7574 * @type { EventTarget } 7575 * @syscap SystemCapability.ArkUI.ArkUI.Full 7576 * @crossplatform 7577 * @form 7578 * @atomicservice 7579 * @since 11 7580 */ 7581 target: EventTarget; 7582 7583 /** 7584 * Event timestamp. 7585 * 7586 * @type { number } 7587 * @syscap SystemCapability.ArkUI.ArkUI.Full 7588 * @since 8 7589 */ 7590 /** 7591 * Event timestamp. 7592 * 7593 * @type { number } 7594 * @syscap SystemCapability.ArkUI.ArkUI.Full 7595 * @form 7596 * @since 9 7597 */ 7598 /** 7599 * Event timestamp. 7600 * 7601 * @type { number } 7602 * @syscap SystemCapability.ArkUI.ArkUI.Full 7603 * @crossplatform 7604 * @form 7605 * @since 10 7606 */ 7607 /** 7608 * Event timestamp. 7609 * 7610 * @type { number } 7611 * @syscap SystemCapability.ArkUI.ArkUI.Full 7612 * @crossplatform 7613 * @form 7614 * @atomicservice 7615 * @since 11 7616 */ 7617 timestamp: number; 7618 7619 /** 7620 * the event source info. 7621 * 7622 * @type { SourceType } 7623 * @syscap SystemCapability.ArkUI.ArkUI.Full 7624 * @since 8 7625 */ 7626 /** 7627 * the event source info. 7628 * 7629 * @type { SourceType } 7630 * @syscap SystemCapability.ArkUI.ArkUI.Full 7631 * @form 7632 * @since 9 7633 */ 7634 /** 7635 * the event source info. 7636 * 7637 * @type { SourceType } 7638 * @syscap SystemCapability.ArkUI.ArkUI.Full 7639 * @crossplatform 7640 * @form 7641 * @since 10 7642 */ 7643 /** 7644 * the event source info. 7645 * 7646 * @type { SourceType } 7647 * @syscap SystemCapability.ArkUI.ArkUI.Full 7648 * @crossplatform 7649 * @form 7650 * @atomicservice 7651 * @since 11 7652 */ 7653 source: SourceType; 7654 7655 /** 7656 * the Horizontal axis coordinate. 7657 * 7658 * @type { number } 7659 * @syscap SystemCapability.ArkUI.ArkUI.Full 7660 * @crossplatform 7661 * @form 7662 * @atomicservice 7663 * @since 12 7664 */ 7665 axisHorizontal?: number; 7666 7667 /** 7668 * the Vertical axis coordinate. 7669 * 7670 * @type { number } 7671 * @syscap SystemCapability.ArkUI.ArkUI.Full 7672 * @crossplatform 7673 * @form 7674 * @atomicservice 7675 * @since 12 7676 */ 7677 axisVertical?: number; 7678 7679 /** 7680 * Touch pressure. 7681 * 7682 * @type { number } 7683 * @syscap SystemCapability.ArkUI.ArkUI.Full 7684 * @form 7685 * @since 9 7686 */ 7687 /** 7688 * Touch pressure. 7689 * 7690 * @type { number } 7691 * @syscap SystemCapability.ArkUI.ArkUI.Full 7692 * @crossplatform 7693 * @form 7694 * @since 10 7695 */ 7696 /** 7697 * Touch pressure. 7698 * 7699 * @type { number } 7700 * @syscap SystemCapability.ArkUI.ArkUI.Full 7701 * @crossplatform 7702 * @form 7703 * @atomicservice 7704 * @since 11 7705 */ 7706 pressure: number; 7707 7708 /** 7709 * The angle between pencil projection on plane-X-Y and axis-Z. 7710 * 7711 * @type { number } 7712 * @syscap SystemCapability.ArkUI.ArkUI.Full 7713 * @form 7714 * @since 9 7715 */ 7716 /** 7717 * The angle between pencil projection on plane-X-Y and axis-Z. 7718 * 7719 * @type { number } 7720 * @syscap SystemCapability.ArkUI.ArkUI.Full 7721 * @crossplatform 7722 * @form 7723 * @since 10 7724 */ 7725 /** 7726 * The angle between pencil projection on plane-X-Y and axis-Z. 7727 * 7728 * @type { number } 7729 * @syscap SystemCapability.ArkUI.ArkUI.Full 7730 * @crossplatform 7731 * @form 7732 * @atomicservice 7733 * @since 11 7734 */ 7735 tiltX: number; 7736 7737 /** 7738 * The angle between pencil projection on plane-Y-Z and axis-Z. 7739 * 7740 * @type { number } 7741 * @syscap SystemCapability.ArkUI.ArkUI.Full 7742 * @form 7743 * @since 9 7744 */ 7745 /** 7746 * The angle between pencil projection on plane-Y-Z and axis-Z. 7747 * 7748 * @type { number } 7749 * @syscap SystemCapability.ArkUI.ArkUI.Full 7750 * @crossplatform 7751 * @form 7752 * @since 10 7753 */ 7754 /** 7755 * The angle between pencil projection on plane-Y-Z and axis-Z. 7756 * 7757 * @type { number } 7758 * @syscap SystemCapability.ArkUI.ArkUI.Full 7759 * @crossplatform 7760 * @form 7761 * @atomicservice 7762 * @since 11 7763 */ 7764 tiltY: number; 7765 7766 /** 7767 * The event tool type info. 7768 * 7769 * @type { SourceTool } 7770 * @syscap SystemCapability.ArkUI.ArkUI.Full 7771 * @form 7772 * @since 9 7773 */ 7774 /** 7775 * The event tool type info. 7776 * 7777 * @type { SourceTool } 7778 * @syscap SystemCapability.ArkUI.ArkUI.Full 7779 * @crossplatform 7780 * @form 7781 * @since 10 7782 */ 7783 /** 7784 * The event tool type info. 7785 * 7786 * @type { SourceTool } 7787 * @syscap SystemCapability.ArkUI.ArkUI.Full 7788 * @crossplatform 7789 * @form 7790 * @atomicservice 7791 * @since 11 7792 */ 7793 sourceTool: SourceTool; 7794 7795 /** 7796 * Query the ModifierKey press state, support 'ctrl'|'alt'|'shift'|'fn' 7797 * 7798 * @param { Array<string> } keys - indicate the keys of the ModifierKey. 7799 * @returns { boolean } 7800 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 7801 * @syscap SystemCapability.ArkUI.ArkUI.Full 7802 * @crossplatform 7803 * @atomicservice 7804 * @since 12 7805 */ 7806 getModifierKeyState?(keys: Array<string>): boolean; 7807 7808 /** 7809 * Indicates the ID of the input device that triggers the current event. 7810 * 7811 * @type { ?number } [deviceId] The ID of the input device that triggers the current event 7812 * @syscap SystemCapability.ArkUI.ArkUI.Full 7813 * @crossplatform 7814 * @atomicservice 7815 * @since 12 7816 */ 7817 deviceId?: number; 7818} 7819 7820/** 7821 * Border image option 7822 * 7823 * @interface BorderImageOption 7824 * @syscap SystemCapability.ArkUI.ArkUI.Full 7825 * @form 7826 * @since 9 7827 */ 7828/** 7829 * Border image option 7830 * 7831 * @interface BorderImageOption 7832 * @syscap SystemCapability.ArkUI.ArkUI.Full 7833 * @crossplatform 7834 * @form 7835 * @since 10 7836 */ 7837/** 7838 * Border image option 7839 * 7840 * @interface BorderImageOption 7841 * @syscap SystemCapability.ArkUI.ArkUI.Full 7842 * @crossplatform 7843 * @form 7844 * @atomicservice 7845 * @since 11 7846 */ 7847declare interface BorderImageOption { 7848 /** 7849 * Border image slice 7850 * 7851 * @type { ?(Length | EdgeWidths) } 7852 * @syscap SystemCapability.ArkUI.ArkUI.Full 7853 * @form 7854 * @since 9 7855 */ 7856 /** 7857 * Border image slice 7858 * 7859 * @type { ?(Length | EdgeWidths) } 7860 * @syscap SystemCapability.ArkUI.ArkUI.Full 7861 * @crossplatform 7862 * @form 7863 * @since 10 7864 */ 7865 /** 7866 * Border image slice 7867 * 7868 * @type { ?(Length | EdgeWidths) } 7869 * @syscap SystemCapability.ArkUI.ArkUI.Full 7870 * @crossplatform 7871 * @form 7872 * @atomicservice 7873 * @since 11 7874 */ 7875 /** 7876 * Border image slice 7877 * 7878 * @type { ?(Length | EdgeWidths | LocalizedEdgeWidths) } 7879 * @syscap SystemCapability.ArkUI.ArkUI.Full 7880 * @crossplatform 7881 * @form 7882 * @atomicservice 7883 * @since 12 7884 */ 7885 slice?: Length | EdgeWidths | LocalizedEdgeWidths, 7886 7887 /** 7888 * Border image repeat 7889 * 7890 * @type { ?RepeatMode } 7891 * @syscap SystemCapability.ArkUI.ArkUI.Full 7892 * @form 7893 * @since 9 7894 */ 7895 /** 7896 * Border image repeat 7897 * 7898 * @type { ?RepeatMode } 7899 * @syscap SystemCapability.ArkUI.ArkUI.Full 7900 * @crossplatform 7901 * @form 7902 * @since 10 7903 */ 7904 /** 7905 * Border image repeat 7906 * 7907 * @type { ?RepeatMode } 7908 * @syscap SystemCapability.ArkUI.ArkUI.Full 7909 * @crossplatform 7910 * @form 7911 * @atomicservice 7912 * @since 11 7913 */ 7914 repeat?: RepeatMode, 7915 7916 /** 7917 * Border image source 7918 * 7919 * @type { ?(string | Resource | LinearGradient) } 7920 * @syscap SystemCapability.ArkUI.ArkUI.Full 7921 * @form 7922 * @since 9 7923 */ 7924 /** 7925 * Border image source 7926 * 7927 * @type { ?(string | Resource | LinearGradient) } 7928 * @syscap SystemCapability.ArkUI.ArkUI.Full 7929 * @crossplatform 7930 * @form 7931 * @since 10 7932 */ 7933 /** 7934 * Border image source 7935 * 7936 * @type { ?(string | Resource | LinearGradient) } 7937 * @syscap SystemCapability.ArkUI.ArkUI.Full 7938 * @crossplatform 7939 * @form 7940 * @atomicservice 7941 * @since 11 7942 */ 7943 source?: string | Resource | LinearGradient, 7944 7945 /** 7946 * Border image width 7947 * 7948 * @type { ?(Length | EdgeWidths) } 7949 * @syscap SystemCapability.ArkUI.ArkUI.Full 7950 * @form 7951 * @since 9 7952 */ 7953 /** 7954 * Border image width 7955 * 7956 * @type { ?(Length | EdgeWidths) } 7957 * @syscap SystemCapability.ArkUI.ArkUI.Full 7958 * @crossplatform 7959 * @form 7960 * @since 10 7961 */ 7962 /** 7963 * Border image width 7964 * 7965 * @type { ?(Length | EdgeWidths) } 7966 * @syscap SystemCapability.ArkUI.ArkUI.Full 7967 * @crossplatform 7968 * @form 7969 * @atomicservice 7970 * @since 11 7971 */ 7972 /** 7973 * Border image width 7974 * 7975 * @type { ?(Length | EdgeWidths | LocalizedEdgeWidths) } 7976 * @syscap SystemCapability.ArkUI.ArkUI.Full 7977 * @crossplatform 7978 * @form 7979 * @atomicservice 7980 * @since 12 7981 */ 7982 width?: Length | EdgeWidths | LocalizedEdgeWidths, 7983 7984 /** 7985 * Border image outset 7986 * 7987 * @type { ?(Length | EdgeWidths) } 7988 * @syscap SystemCapability.ArkUI.ArkUI.Full 7989 * @form 7990 * @since 9 7991 */ 7992 /** 7993 * Border image outset 7994 * 7995 * @type { ?(Length | EdgeWidths) } 7996 * @syscap SystemCapability.ArkUI.ArkUI.Full 7997 * @crossplatform 7998 * @form 7999 * @since 10 8000 */ 8001 /** 8002 * Border image outset 8003 * 8004 * @type { ?(Length | EdgeWidths) } 8005 * @syscap SystemCapability.ArkUI.ArkUI.Full 8006 * @crossplatform 8007 * @form 8008 * @atomicservice 8009 * @since 11 8010 */ 8011 /** 8012 * Border image outset 8013 * 8014 * @type { ?(Length | EdgeWidths | LocalizedEdgeWidths) } 8015 * @syscap SystemCapability.ArkUI.ArkUI.Full 8016 * @crossplatform 8017 * @form 8018 * @atomicservice 8019 * @since 12 8020 */ 8021 outset?: Length | EdgeWidths | LocalizedEdgeWidths, 8022 8023 /** 8024 * Border image center fill 8025 * 8026 * @type { ?boolean } 8027 * @syscap SystemCapability.ArkUI.ArkUI.Full 8028 * @form 8029 * @since 9 8030 */ 8031 /** 8032 * Border image center fill 8033 * 8034 * @type { ?boolean } 8035 * @syscap SystemCapability.ArkUI.ArkUI.Full 8036 * @crossplatform 8037 * @form 8038 * @since 10 8039 */ 8040 /** 8041 * Border image center fill 8042 * 8043 * @type { ?boolean } 8044 * @syscap SystemCapability.ArkUI.ArkUI.Full 8045 * @crossplatform 8046 * @form 8047 * @atomicservice 8048 * @since 11 8049 */ 8050 fill?: boolean 8051} 8052 8053/** 8054 * The tap action triggers this method invocation. 8055 * 8056 * @interface ClickEvent 8057 * @syscap SystemCapability.ArkUI.ArkUI.Full 8058 * @since 7 8059 */ 8060/** 8061 * The tap action triggers this method invocation. 8062 * 8063 * @interface ClickEvent 8064 * @syscap SystemCapability.ArkUI.ArkUI.Full 8065 * @form 8066 * @since 9 8067 */ 8068/** 8069 * The tap action triggers this method invocation. 8070 * 8071 * @interface ClickEvent 8072 * @syscap SystemCapability.ArkUI.ArkUI.Full 8073 * @crossplatform 8074 * @form 8075 * @since 10 8076 */ 8077/** 8078 * The tap action triggers this method invocation. 8079 * 8080 * @interface ClickEvent 8081 * @syscap SystemCapability.ArkUI.ArkUI.Full 8082 * @crossplatform 8083 * @form 8084 * @atomicservice 8085 * @since 11 8086 */ 8087declare interface ClickEvent extends BaseEvent { 8088 /** 8089 * X coordinate of the click point relative to the left edge of the device screen. 8090 * 8091 * @type { number } 8092 * @syscap SystemCapability.ArkUI.ArkUI.Full 8093 * @crossplatform 8094 * @since 10 8095 */ 8096 /** 8097 * X coordinate of the click point relative to the left edge of the device screen. 8098 * 8099 * @type { number } 8100 * @syscap SystemCapability.ArkUI.ArkUI.Full 8101 * @crossplatform 8102 * @atomicservice 8103 * @since 11 8104 */ 8105 displayX: number; 8106 8107 /** 8108 * Y coordinate of the click point relative to the upper edge of the device screen. 8109 * 8110 * @type { number } 8111 * @syscap SystemCapability.ArkUI.ArkUI.Full 8112 * @crossplatform 8113 * @since 10 8114 */ 8115 /** 8116 * Y coordinate of the click point relative to the upper edge of the device screen. 8117 * 8118 * @type { number } 8119 * @syscap SystemCapability.ArkUI.ArkUI.Full 8120 * @crossplatform 8121 * @atomicservice 8122 * @since 11 8123 */ 8124 displayY: number; 8125 8126 /** 8127 * X coordinate of the click point relative to the left edge of the current window. 8128 * 8129 * @type { number } 8130 * @syscap SystemCapability.ArkUI.ArkUI.Full 8131 * @crossplatform 8132 * @since 10 8133 */ 8134 /** 8135 * X coordinate of the click point relative to the left edge of the current window. 8136 * 8137 * @type { number } 8138 * @syscap SystemCapability.ArkUI.ArkUI.Full 8139 * @crossplatform 8140 * @atomicservice 8141 * @since 11 8142 */ 8143 windowX: number; 8144 8145 /** 8146 * Y coordinate of the click point relative to the upper edge of the current window. 8147 * 8148 * @type { number } 8149 * @syscap SystemCapability.ArkUI.ArkUI.Full 8150 * @crossplatform 8151 * @since 10 8152 */ 8153 /** 8154 * Y coordinate of the click point relative to the upper edge of the current window. 8155 * 8156 * @type { number } 8157 * @syscap SystemCapability.ArkUI.ArkUI.Full 8158 * @crossplatform 8159 * @atomicservice 8160 * @since 11 8161 */ 8162 windowY: number; 8163 8164 /** 8165 * X coordinate of the click point relative to the left edge of the current window. 8166 * 8167 * @type { number } 8168 * @syscap SystemCapability.ArkUI.ArkUI.Full 8169 * @since 7 8170 * @deprecated since 10 8171 * @useinstead ClickEvent#windowX 8172 */ 8173 screenX: number; 8174 8175 /** 8176 * Y coordinate of the click point relative to the upper edge of the current window. 8177 * 8178 * @type { number } 8179 * @syscap SystemCapability.ArkUI.ArkUI.Full 8180 * @since 7 8181 * @deprecated since 10 8182 * @useinstead ClickEvent#windowY 8183 */ 8184 screenY: number; 8185 8186 /** 8187 * X coordinate of the click point relative to the left edge of the clicked element. 8188 * 8189 * @type { number } 8190 * @syscap SystemCapability.ArkUI.ArkUI.Full 8191 * @since 7 8192 */ 8193 /** 8194 * X coordinate of the click point relative to the left edge of the clicked element. 8195 * 8196 * @type { number } 8197 * @syscap SystemCapability.ArkUI.ArkUI.Full 8198 * @form 8199 * @since 9 8200 */ 8201 /** 8202 * X coordinate of the click point relative to the left edge of the clicked element. 8203 * 8204 * @type { number } 8205 * @syscap SystemCapability.ArkUI.ArkUI.Full 8206 * @crossplatform 8207 * @form 8208 * @since 10 8209 */ 8210 /** 8211 * X coordinate of the click point relative to the left edge of the clicked element. 8212 * 8213 * @type { number } 8214 * @syscap SystemCapability.ArkUI.ArkUI.Full 8215 * @crossplatform 8216 * @form 8217 * @atomicservice 8218 * @since 11 8219 */ 8220 x: number; 8221 8222 /** 8223 * Y coordinate of the click point relative to the upper edge of the clicked element. 8224 * 8225 * @type { number } 8226 * @syscap SystemCapability.ArkUI.ArkUI.Full 8227 * @since 7 8228 */ 8229 /** 8230 * Y coordinate of the click point relative to the left edge of the clicked element. 8231 * 8232 * @type { number } 8233 * @syscap SystemCapability.ArkUI.ArkUI.Full 8234 * @form 8235 * @since 9 8236 */ 8237 /** 8238 * Y coordinate of the click point relative to the left edge of the clicked element. 8239 * 8240 * @type { number } 8241 * @syscap SystemCapability.ArkUI.ArkUI.Full 8242 * @crossplatform 8243 * @form 8244 * @since 10 8245 */ 8246 /** 8247 * Y coordinate of the click point relative to the left edge of the clicked element. 8248 * 8249 * @type { number } 8250 * @syscap SystemCapability.ArkUI.ArkUI.Full 8251 * @crossplatform 8252 * @form 8253 * @atomicservice 8254 * @since 11 8255 */ 8256 y: number; 8257 8258 /** 8259 * Prevent the default function. 8260 * 8261 * @type { function } 8262 * @syscap SystemCapability.ArkUI.ArkUI.Full 8263 * @crossplatform 8264 * @atomicservice 8265 * @since 12 8266 */ 8267 preventDefault: () => void; 8268} 8269 8270/** 8271 * The hover action triggers this method invocation. 8272 * 8273 * @interface HoverEvent 8274 * @syscap SystemCapability.ArkUI.ArkUI.Full 8275 * @since 10 8276 */ 8277/** 8278 * The hover action triggers this method invocation. 8279 * 8280 * @interface HoverEvent 8281 * @syscap SystemCapability.ArkUI.ArkUI.Full 8282 * @atomicservice 8283 * @since 11 8284 */ 8285declare interface HoverEvent extends BaseEvent { 8286 /** 8287 * The blocking hover event pops up. 8288 * 8289 * @type { function } 8290 * @syscap SystemCapability.ArkUI.ArkUI.Full 8291 * @since 10 8292 */ 8293 /** 8294 * The blocking hover event pops up. 8295 * 8296 * @type { function } 8297 * @syscap SystemCapability.ArkUI.ArkUI.Full 8298 * @atomicservice 8299 * @since 11 8300 */ 8301 stopPropagation: () => void; 8302} 8303 8304/** 8305 * The mouse click action triggers this method invocation. 8306 * 8307 * @interface MouseEvent 8308 * @syscap SystemCapability.ArkUI.ArkUI.Full 8309 * @since 8 8310 */ 8311/** 8312 * The mouse click action triggers this method invocation. 8313 * 8314 * @interface MouseEvent 8315 * @syscap SystemCapability.ArkUI.ArkUI.Full 8316 * @atomicservice 8317 * @since 11 8318 */ 8319declare interface MouseEvent extends BaseEvent { 8320 /** 8321 * Mouse button of the click event. 8322 * 8323 * @type { MouseButton } 8324 * @syscap SystemCapability.ArkUI.ArkUI.Full 8325 * @since 8 8326 */ 8327 /** 8328 * Mouse button of the click event. 8329 * 8330 * @type { MouseButton } 8331 * @syscap SystemCapability.ArkUI.ArkUI.Full 8332 * @atomicservice 8333 * @since 11 8334 */ 8335 button: MouseButton; 8336 8337 /** 8338 * Mouse action of the click event. 8339 * 8340 * @type { MouseAction } 8341 * @syscap SystemCapability.ArkUI.ArkUI.Full 8342 * @since 8 8343 */ 8344 /** 8345 * Mouse action of the click event. 8346 * 8347 * @type { MouseAction } 8348 * @syscap SystemCapability.ArkUI.ArkUI.Full 8349 * @atomicservice 8350 * @since 11 8351 */ 8352 action: MouseAction; 8353 8354 /** 8355 * X coordinate of the mouse point relative to the left edge of the device screen. 8356 * 8357 * @type { number } 8358 * @syscap SystemCapability.ArkUI.ArkUI.Full 8359 * @since 10 8360 */ 8361 /** 8362 * X coordinate of the mouse point relative to the left edge of the device screen. 8363 * 8364 * @type { number } 8365 * @syscap SystemCapability.ArkUI.ArkUI.Full 8366 * @atomicservice 8367 * @since 11 8368 */ 8369 displayX: number; 8370 8371 /** 8372 * Y coordinate of the mouse point relative to the upper edge of the device screen. 8373 * 8374 * @type { number } 8375 * @syscap SystemCapability.ArkUI.ArkUI.Full 8376 * @since 10 8377 */ 8378 /** 8379 * Y coordinate of the mouse point relative to the upper edge of the device screen. 8380 * 8381 * @type { number } 8382 * @syscap SystemCapability.ArkUI.ArkUI.Full 8383 * @atomicservice 8384 * @since 11 8385 */ 8386 displayY: number; 8387 8388 /** 8389 * X coordinate of the mouse point relative to the left edge of the current window. 8390 * 8391 * @type { number } 8392 * @syscap SystemCapability.ArkUI.ArkUI.Full 8393 * @since 10 8394 */ 8395 /** 8396 * X coordinate of the mouse point relative to the left edge of the current window. 8397 * 8398 * @type { number } 8399 * @syscap SystemCapability.ArkUI.ArkUI.Full 8400 * @atomicservice 8401 * @since 11 8402 */ 8403 windowX: number; 8404 8405 /** 8406 * Y coordinate of the mouse point relative to the upper edge of the current window. 8407 * 8408 * @type { number } 8409 * @syscap SystemCapability.ArkUI.ArkUI.Full 8410 * @since 10 8411 */ 8412 /** 8413 * Y coordinate of the mouse point relative to the upper edge of the current window. 8414 * 8415 * @type { number } 8416 * @syscap SystemCapability.ArkUI.ArkUI.Full 8417 * @atomicservice 8418 * @since 11 8419 */ 8420 windowY: number; 8421 8422 /** 8423 * X coordinate of the mouse point relative to the left edge of the current window. 8424 * 8425 * @type { number } 8426 * @syscap SystemCapability.ArkUI.ArkUI.Full 8427 * @since 8 8428 * @deprecated since 10 8429 * @useinstead MouseEvent#windowX 8430 */ 8431 screenX: number; 8432 8433 /** 8434 * Y coordinate of the mouse point relative to the upper edge of the current window. 8435 * 8436 * @type { number } 8437 * @syscap SystemCapability.ArkUI.ArkUI.Full 8438 * @since 8 8439 * @deprecated since 10 8440 * @useinstead MouseEvent#windowY 8441 */ 8442 screenY: number; 8443 8444 /** 8445 * X coordinate of the mouse point relative to the left edge of the mouse hit element. 8446 * 8447 * @type { number } 8448 * @syscap SystemCapability.ArkUI.ArkUI.Full 8449 * @since 8 8450 */ 8451 /** 8452 * X coordinate of the mouse point relative to the left edge of the mouse hit element. 8453 * 8454 * @type { number } 8455 * @syscap SystemCapability.ArkUI.ArkUI.Full 8456 * @atomicservice 8457 * @since 11 8458 */ 8459 x: number; 8460 8461 /** 8462 * Y coordinate of the mouse point relative to the upper edge of the mouse hit element. 8463 * 8464 * @type { number } 8465 * @syscap SystemCapability.ArkUI.ArkUI.Full 8466 * @since 8 8467 */ 8468 /** 8469 * Y coordinate of the mouse point relative to the upper edge of the mouse hit element. 8470 * 8471 * @type { number } 8472 * @syscap SystemCapability.ArkUI.ArkUI.Full 8473 * @atomicservice 8474 * @since 11 8475 */ 8476 y: number; 8477 8478 /** 8479 * The blocking event pops up. 8480 * 8481 * @type { function } 8482 * @syscap SystemCapability.ArkUI.ArkUI.Full 8483 * @since 8 8484 */ 8485 /** 8486 * The blocking event pops up. 8487 * 8488 * @type { function } 8489 * @syscap SystemCapability.ArkUI.ArkUI.Full 8490 * @atomicservice 8491 * @since 11 8492 */ 8493 stopPropagation: () => void; 8494} 8495 8496/** 8497 * The accessibility hover action triggers this method invocation. 8498 * 8499 * @typedef AccessibilityHoverEvent 8500 * @extends BaseEvent 8501 * @syscap SystemCapability.ArkUI.ArkUI.Full 8502 * @atomicservice 8503 * @since 12 8504 */ 8505declare interface AccessibilityHoverEvent extends BaseEvent { 8506 /** 8507 * Type of the accessibility hover event. 8508 * 8509 * @type { AccessibilityHoverType } 8510 * @syscap SystemCapability.ArkUI.ArkUI.Full 8511 * @atomicservice 8512 * @since 12 8513 */ 8514 type: AccessibilityHoverType; 8515 8516 /** 8517 * X coordinate of the accessibility hover point relative to the left edge of the event hit element. 8518 * 8519 * @type { number } 8520 * @syscap SystemCapability.ArkUI.ArkUI.Full 8521 * @atomicservice 8522 * @since 12 8523 */ 8524 x: number; 8525 8526 /** 8527 * Y coordinate of the accessibility hover point relative to the upper edge of the event hit element. 8528 * 8529 * @type { number } 8530 * @syscap SystemCapability.ArkUI.ArkUI.Full 8531 * @atomicservice 8532 * @since 12 8533 */ 8534 y: number; 8535 8536 /** 8537 * X coordinate of the accessibility hover point relative to the left edge of the device screen. 8538 * 8539 * @type { number } 8540 * @syscap SystemCapability.ArkUI.ArkUI.Full 8541 * @atomicservice 8542 * @since 12 8543 */ 8544 displayX: number; 8545 8546 /** 8547 * Y coordinate of the accessibility hover point relative to the upper edge of the device screen. 8548 * 8549 * @type { number } 8550 * @syscap SystemCapability.ArkUI.ArkUI.Full 8551 * @atomicservice 8552 * @since 12 8553 */ 8554 displayY: number; 8555 8556 /** 8557 * X coordinate of the accessibility hover point relative to the left edge of the current window. 8558 * 8559 * @type { number } 8560 * @syscap SystemCapability.ArkUI.ArkUI.Full 8561 * @atomicservice 8562 * @since 12 8563 */ 8564 windowX: number; 8565 8566 /** 8567 * Y coordinate of the accessibility hover point relative to the upper edge of the current window. 8568 * 8569 * @type { number } 8570 * @syscap SystemCapability.ArkUI.ArkUI.Full 8571 * @atomicservice 8572 * @since 12 8573 */ 8574 windowY: number; 8575} 8576 8577/** 8578 * Type of the touch event. 8579 * 8580 * @interface TouchObject 8581 * @syscap SystemCapability.ArkUI.ArkUI.Full 8582 * @since 7 8583 */ 8584/** 8585 * Type of the touch event. 8586 * 8587 * @interface TouchObject 8588 * @syscap SystemCapability.ArkUI.ArkUI.Full 8589 * @crossplatform 8590 * @since 10 8591 */ 8592/** 8593 * Type of the touch event. 8594 * 8595 * @interface TouchObject 8596 * @syscap SystemCapability.ArkUI.ArkUI.Full 8597 * @crossplatform 8598 * @atomicservice 8599 * @since 11 8600 */ 8601declare interface TouchObject { 8602 /** 8603 * Type of the touch event. 8604 * 8605 * @type { TouchType } 8606 * @syscap SystemCapability.ArkUI.ArkUI.Full 8607 * @since 7 8608 */ 8609 /** 8610 * Type of the touch event. 8611 * 8612 * @type { TouchType } 8613 * @syscap SystemCapability.ArkUI.ArkUI.Full 8614 * @crossplatform 8615 * @since 10 8616 */ 8617 /** 8618 * Type of the touch event. 8619 * 8620 * @type { TouchType } 8621 * @syscap SystemCapability.ArkUI.ArkUI.Full 8622 * @crossplatform 8623 * @atomicservice 8624 * @since 11 8625 */ 8626 type: TouchType; 8627 8628 /** 8629 * Finger unique identifier. 8630 * 8631 * @type { number } 8632 * @syscap SystemCapability.ArkUI.ArkUI.Full 8633 * @since 7 8634 */ 8635 /** 8636 * Finger unique identifier. 8637 * 8638 * @type { number } 8639 * @syscap SystemCapability.ArkUI.ArkUI.Full 8640 * @crossplatform 8641 * @since 10 8642 */ 8643 /** 8644 * Finger unique identifier. 8645 * 8646 * @type { number } 8647 * @syscap SystemCapability.ArkUI.ArkUI.Full 8648 * @crossplatform 8649 * @atomicservice 8650 * @since 11 8651 */ 8652 id: number; 8653 8654 /** 8655 * X coordinate of the touch point relative to the left edge of the device screen. 8656 * 8657 * @type { number } 8658 * @syscap SystemCapability.ArkUI.ArkUI.Full 8659 * @crossplatform 8660 * @since 10 8661 */ 8662 /** 8663 * X coordinate of the touch point relative to the left edge of the device screen. 8664 * 8665 * @type { number } 8666 * @syscap SystemCapability.ArkUI.ArkUI.Full 8667 * @crossplatform 8668 * @atomicservice 8669 * @since 11 8670 */ 8671 displayX: number; 8672 8673 /** 8674 * Y coordinate of the touch point relative to the upper edge of the device screen. 8675 * 8676 * @type { number } 8677 * @syscap SystemCapability.ArkUI.ArkUI.Full 8678 * @crossplatform 8679 * @since 10 8680 */ 8681 /** 8682 * Y coordinate of the touch point relative to the upper edge of the device screen. 8683 * 8684 * @type { number } 8685 * @syscap SystemCapability.ArkUI.ArkUI.Full 8686 * @crossplatform 8687 * @atomicservice 8688 * @since 11 8689 */ 8690 displayY: number; 8691 8692 /** 8693 * X coordinate of the touch point relative to the left edge of the current window. 8694 * 8695 * @type { number } 8696 * @syscap SystemCapability.ArkUI.ArkUI.Full 8697 * @crossplatform 8698 * @since 10 8699 */ 8700 /** 8701 * X coordinate of the touch point relative to the left edge of the current window. 8702 * 8703 * @type { number } 8704 * @syscap SystemCapability.ArkUI.ArkUI.Full 8705 * @crossplatform 8706 * @atomicservice 8707 * @since 11 8708 */ 8709 windowX: number; 8710 8711 /** 8712 * Y coordinate of the touch point relative to the upper edge of the current window. 8713 * 8714 * @type { number } 8715 * @syscap SystemCapability.ArkUI.ArkUI.Full 8716 * @crossplatform 8717 * @since 10 8718 */ 8719 /** 8720 * Y coordinate of the touch point relative to the upper edge of the current window. 8721 * 8722 * @type { number } 8723 * @syscap SystemCapability.ArkUI.ArkUI.Full 8724 * @crossplatform 8725 * @atomicservice 8726 * @since 11 8727 */ 8728 windowY: number; 8729 8730 /** 8731 * X coordinate of the touch point relative to the left edge of the current window. 8732 * 8733 * @type { number } 8734 * @syscap SystemCapability.ArkUI.ArkUI.Full 8735 * @since 7 8736 * @deprecated since 10 8737 * @useinstead TouchObject#windowX 8738 */ 8739 screenX: number; 8740 8741 /** 8742 * Y coordinate of the touch point relative to the upper edge of the current window. 8743 * 8744 * @type { number } 8745 * @syscap SystemCapability.ArkUI.ArkUI.Full 8746 * @since 7 8747 * @deprecated since 10 8748 * @useinstead TouchObject#windowY 8749 */ 8750 screenY: number; 8751 8752 /** 8753 * X coordinate of the touch point relative to the left edge of the touched element. 8754 * 8755 * @type { number } 8756 * @syscap SystemCapability.ArkUI.ArkUI.Full 8757 * @since 7 8758 */ 8759 /** 8760 * X coordinate of the touch point relative to the left edge of the touched element. 8761 * 8762 * @type { number } 8763 * @syscap SystemCapability.ArkUI.ArkUI.Full 8764 * @crossplatform 8765 * @since 10 8766 */ 8767 /** 8768 * X coordinate of the touch point relative to the left edge of the touched element. 8769 * 8770 * @type { number } 8771 * @syscap SystemCapability.ArkUI.ArkUI.Full 8772 * @crossplatform 8773 * @atomicservice 8774 * @since 11 8775 */ 8776 x: number; 8777 8778 /** 8779 * Y coordinate of the touch point relative to the upper edge of the touched element. 8780 * 8781 * @type { number } 8782 * @syscap SystemCapability.ArkUI.ArkUI.Full 8783 * @since 7 8784 */ 8785 /** 8786 * Y coordinate of the touch point relative to the upper edge of the touched element. 8787 * 8788 * @type { number } 8789 * @syscap SystemCapability.ArkUI.ArkUI.Full 8790 * @crossplatform 8791 * @since 10 8792 */ 8793 /** 8794 * Y coordinate of the touch point relative to the upper edge of the touched element. 8795 * 8796 * @type { number } 8797 * @syscap SystemCapability.ArkUI.ArkUI.Full 8798 * @crossplatform 8799 * @atomicservice 8800 * @since 11 8801 */ 8802 y: number; 8803} 8804 8805/** 8806 * TouchObject getHistoricalPoints Function Parameters 8807 * 8808 * @interface HistoricalPoint 8809 * @syscap SystemCapability.ArkUI.ArkUI.Full 8810 * @crossplatform 8811 * @since 10 8812 */ 8813/** 8814 * TouchObject getHistoricalPoints Function Parameters 8815 * 8816 * @interface HistoricalPoint 8817 * @syscap SystemCapability.ArkUI.ArkUI.Full 8818 * @crossplatform 8819 * @atomicservice 8820 * @since 11 8821 */ 8822declare interface HistoricalPoint { 8823 /** 8824 * The base touchObject information of historicalPoint 8825 * 8826 * @type { TouchObject } 8827 * @syscap SystemCapability.ArkUI.ArkUI.Full 8828 * @crossplatform 8829 * @since 10 8830 */ 8831 /** 8832 * The base touchObject information of historicalPoint 8833 * 8834 * @type { TouchObject } 8835 * @syscap SystemCapability.ArkUI.ArkUI.Full 8836 * @crossplatform 8837 * @atomicservice 8838 * @since 11 8839 */ 8840 touchObject: TouchObject; 8841 8842 /** 8843 * Contact area between the finger pad and the screen. 8844 * 8845 * @type { number } 8846 * @syscap SystemCapability.ArkUI.ArkUI.Full 8847 * @crossplatform 8848 * @since 10 8849 */ 8850 /** 8851 * Contact area between the finger pad and the screen. 8852 * 8853 * @type { number } 8854 * @syscap SystemCapability.ArkUI.ArkUI.Full 8855 * @crossplatform 8856 * @atomicservice 8857 * @since 11 8858 */ 8859 size: number; 8860 8861 /** 8862 * Pressure of the touch event. 8863 * 8864 * @type { number } 8865 * @syscap SystemCapability.ArkUI.ArkUI.Full 8866 * @crossplatform 8867 * @since 10 8868 */ 8869 /** 8870 * Pressure of the touch event. 8871 * 8872 * @type { number } 8873 * @syscap SystemCapability.ArkUI.ArkUI.Full 8874 * @crossplatform 8875 * @atomicservice 8876 * @since 11 8877 */ 8878 force: number; 8879 8880 /** 8881 * Timestamp of the touch event. 8882 * 8883 * @type { number } 8884 * @syscap SystemCapability.ArkUI.ArkUI.Full 8885 * @crossplatform 8886 * @since 10 8887 */ 8888 /** 8889 * Timestamp of the touch event. 8890 * 8891 * @type { number } 8892 * @syscap SystemCapability.ArkUI.ArkUI.Full 8893 * @crossplatform 8894 * @atomicservice 8895 * @since 11 8896 */ 8897 timestamp: number; 8898} 8899 8900/** 8901 * Touch Action Function Parameters 8902 * 8903 * @interface TouchEvent 8904 * @syscap SystemCapability.ArkUI.ArkUI.Full 8905 * @since 7 8906 */ 8907/** 8908 * Touch Action Function Parameters 8909 * 8910 * @interface TouchEvent 8911 * @syscap SystemCapability.ArkUI.ArkUI.Full 8912 * @crossplatform 8913 * @since 10 8914 */ 8915/** 8916 * Touch Action Function Parameters 8917 * 8918 * @interface TouchEvent 8919 * @syscap SystemCapability.ArkUI.ArkUI.Full 8920 * @crossplatform 8921 * @atomicservice 8922 * @since 11 8923 */ 8924declare interface TouchEvent extends BaseEvent { 8925 /** 8926 * Type of the touch event. 8927 * 8928 * @type { TouchType } 8929 * @syscap SystemCapability.ArkUI.ArkUI.Full 8930 * @since 7 8931 */ 8932 /** 8933 * Type of the touch event. 8934 * 8935 * @type { TouchType } 8936 * @syscap SystemCapability.ArkUI.ArkUI.Full 8937 * @crossplatform 8938 * @since 10 8939 */ 8940 /** 8941 * Type of the touch event. 8942 * 8943 * @type { TouchType } 8944 * @syscap SystemCapability.ArkUI.ArkUI.Full 8945 * @crossplatform 8946 * @atomicservice 8947 * @since 11 8948 */ 8949 type: TouchType; 8950 8951 /** 8952 * All finger information. 8953 * 8954 * @type { TouchObject[] } 8955 * @syscap SystemCapability.ArkUI.ArkUI.Full 8956 * @since 7 8957 */ 8958 /** 8959 * All finger information. 8960 * 8961 * @type { TouchObject[] } 8962 * @syscap SystemCapability.ArkUI.ArkUI.Full 8963 * @crossplatform 8964 * @since 10 8965 */ 8966 /** 8967 * All finger information. 8968 * 8969 * @type { TouchObject[] } 8970 * @syscap SystemCapability.ArkUI.ArkUI.Full 8971 * @crossplatform 8972 * @atomicservice 8973 * @since 11 8974 */ 8975 touches: TouchObject[]; 8976 8977 /** 8978 * Indicates the current changed finger information. 8979 * 8980 * @type { TouchObject[] } 8981 * @syscap SystemCapability.ArkUI.ArkUI.Full 8982 * @since 7 8983 */ 8984 /** 8985 * Indicates the current changed finger information. 8986 * 8987 * @type { TouchObject[] } 8988 * @syscap SystemCapability.ArkUI.ArkUI.Full 8989 * @crossplatform 8990 * @since 10 8991 */ 8992 /** 8993 * Indicates the current changed finger information. 8994 * 8995 * @type { TouchObject[] } 8996 * @syscap SystemCapability.ArkUI.ArkUI.Full 8997 * @crossplatform 8998 * @atomicservice 8999 * @since 11 9000 */ 9001 changedTouches: TouchObject[]; 9002 9003 /** 9004 * The blocking event pops up. 9005 * 9006 * @type { function } 9007 * @syscap SystemCapability.ArkUI.ArkUI.Full 9008 * @since 7 9009 */ 9010 /** 9011 * The blocking event pops up. 9012 * 9013 * @type { function } 9014 * @syscap SystemCapability.ArkUI.ArkUI.Full 9015 * @crossplatform 9016 * @since 10 9017 */ 9018 /** 9019 * The blocking event pops up. 9020 * 9021 * @type { function } 9022 * @syscap SystemCapability.ArkUI.ArkUI.Full 9023 * @crossplatform 9024 * @atomicservice 9025 * @since 11 9026 */ 9027 stopPropagation: () => void; 9028 9029 /** 9030 * Get the historical points. 9031 * 9032 * @returns { Array<HistoricalPoint> } - return all historical points. 9033 * @syscap SystemCapability.ArkUI.ArkUI.Full 9034 * @crossplatform 9035 * @since 10 9036 */ 9037 /** 9038 * Get the historical points. 9039 * 9040 * @returns { Array<HistoricalPoint> } - return all historical points. 9041 * @syscap SystemCapability.ArkUI.ArkUI.Full 9042 * @crossplatform 9043 * @atomicservice 9044 * @since 11 9045 */ 9046 getHistoricalPoints(): Array<HistoricalPoint>; 9047 9048 /** 9049 * Prevent the default function. 9050 * 9051 * @type { function } 9052 * @syscap SystemCapability.ArkUI.ArkUI.Full 9053 * @crossplatform 9054 * @atomicservice 9055 * @since 12 9056 */ 9057 preventDefault: () => void; 9058} 9059 9060/** 9061 * Defines the callback type used in onSizeChange. 9062 * The value of oldValue is last size of the component. 9063 * The value of newValue is new size of the component. 9064 * 9065 * @typedef { function } SizeChangeCallback 9066 * @syscap SystemCapability.ArkUI.ArkUI.Full 9067 * @crossplatform 9068 * @form 9069 * @atomicservice 9070 * @since 12 9071 */ 9072declare type SizeChangeCallback = (oldValue: SizeOptions, newValue: SizeOptions) => void; 9073 9074/** 9075 * Defines the callback type used in onGestureRecognizerJudgeBegin. 9076 * 9077 * @typedef { function } GestureRecognizerJudgeBeginCallback 9078 * @param { BaseGestureEvent } event - the event information 9079 * @param { GestureRecognizer } current - the current gesture recognizer of the component 9080 * @param { Array<GestureRecognizer> } recognizers - the gesture recognizers of the component on the response chain 9081 * @returns { GestureJudgeResult } the gesture judge result 9082 * @syscap SystemCapability.ArkUI.ArkUI.Full 9083 * @crossplatform 9084 * @atomicservice 9085 * @since 12 9086 */ 9087declare type GestureRecognizerJudgeBeginCallback = (event: BaseGestureEvent, current: GestureRecognizer, recognizers: Array<GestureRecognizer>) => GestureJudgeResult; 9088 9089/** 9090 * Defines the callback type used in shouldBuiltInRecognizerParallelWith. 9091 * 9092 * @typedef { function } ShouldBuiltInRecognizerParallelWithCallback 9093 * @param { GestureRecognizer } current - the current gesture recognizer of the component 9094 * @param { Array<GestureRecognizer> } others - the gesture recognizers of the component on the response chain 9095 * @returns { GestureRecognizer } gesture recognizer of the component 9096 * @syscap SystemCapability.ArkUI.ArkUI.Full 9097 * @crossplatform 9098 * @atomicservice 9099 * @since 12 9100 */ 9101declare type ShouldBuiltInRecognizerParallelWithCallback = (current: GestureRecognizer, others: Array<GestureRecognizer>) => GestureRecognizer; 9102 9103/** 9104 * Defines the finish callback type used in transition. 9105 * 9106 * @typedef { function } TransitionFinishCallback 9107 * @param { boolean } transitionIn - a boolean value indicates whether it is the callback of transitionIn or transitionOut. 9108 * @syscap SystemCapability.ArkUI.ArkUI.Full 9109 * @crossplatform 9110 * @form 9111 * @atomicservice 9112 * @since 12 9113 */ 9114declare type TransitionFinishCallback = (transitionIn: boolean) => void; 9115 9116/** 9117 * Defines the PixelMap type object for ui component. 9118 * 9119 * @syscap SystemCapability.ArkUI.ArkUI.Full 9120 * @since 7 9121 */ 9122/** 9123 * Defines the PixelMap type object for ui component. 9124 * 9125 * @syscap SystemCapability.ArkUI.ArkUI.Full 9126 * @crossplatform 9127 * @since 10 9128 */ 9129/** 9130 * Defines the PixelMap type object for ui component. 9131 * 9132 * @typedef { import('../api/@ohos.multimedia.image').default.PixelMap } PixelMap 9133 * @syscap SystemCapability.ArkUI.ArkUI.Full 9134 * @crossplatform 9135 * @atomicservice 9136 * @since 11 9137 */ 9138declare type PixelMap = import('../api/@ohos.multimedia.image').default.PixelMap; 9139 9140/** 9141 * pixelmap object with release function. 9142 * 9143 * @interface PixelMapMock 9144 * @syscap SystemCapability.ArkUI.ArkUI.Full 9145 * @systemapi 9146 * @since 7 9147 */ 9148declare interface PixelMapMock { 9149 /** 9150 * release function. 9151 * 9152 * @syscap SystemCapability.ArkUI.ArkUI.Full 9153 * @systemapi 9154 * @since 7 9155 */ 9156 release(): void; 9157} 9158 9159/** 9160 * Enum for Drag Behavior. 9161 * 9162 * @enum { number } 9163 * @syscap SystemCapability.ArkUI.ArkUI.Full 9164 * @since 10 9165 */ 9166/** 9167 * Enum for Drag Behavior. 9168 * 9169 * @enum { number } 9170 * @syscap SystemCapability.ArkUI.ArkUI.Full 9171 * @atomicservice 9172 * @since 11 9173 */ 9174declare enum DragBehavior { 9175 /** 9176 * If drag use copy event, then set DragBehavior.COPY. 9177 * 9178 * @syscap SystemCapability.ArkUI.ArkUI.Full 9179 * @since 10 9180 */ 9181 /** 9182 * If drag use copy event, then set DragBehavior.COPY. 9183 * 9184 * @syscap SystemCapability.ArkUI.ArkUI.Full 9185 * @atomicservice 9186 * @since 11 9187 */ 9188 COPY, 9189 /** 9190 * If drag use move event, then set DragBehavior.MOVE. 9191 * 9192 * @syscap SystemCapability.ArkUI.ArkUI.Full 9193 * @since 10 9194 */ 9195 /** 9196 * If drag use move event, then set DragBehavior.MOVE. 9197 * 9198 * @syscap SystemCapability.ArkUI.ArkUI.Full 9199 * @atomicservice 9200 * @since 11 9201 */ 9202 MOVE 9203} 9204 9205/** 9206 * Import the UnifiedData type object for ui component. 9207 * 9208 * @typedef { import('../api/@ohos.data.unifiedDataChannel').default.UnifiedData } UnifiedData 9209 * @syscap SystemCapability.ArkUI.ArkUI.Full 9210 * @crossplatform 9211 * @since 10 9212 */ 9213/** 9214 * Import the UnifiedData type object for ui component. 9215 * 9216 * @typedef { import('../api/@ohos.data.unifiedDataChannel').default.UnifiedData } UnifiedData 9217 * @syscap SystemCapability.ArkUI.ArkUI.Full 9218 * @crossplatform 9219 * @atomicservice 9220 * @since 11 9221 */ 9222declare type UnifiedData = import('../api/@ohos.data.unifiedDataChannel').default.UnifiedData; 9223 9224/** 9225 * Import the Summary type object for ui component. 9226 * 9227 * @typedef { import('../api/@ohos.data.unifiedDataChannel').default.Summary } Summary 9228 * @syscap SystemCapability.ArkUI.ArkUI.Full 9229 * @since 10 9230 */ 9231/** 9232 * Import the Summary type object for ui component. 9233 * 9234 * @typedef { import('../api/@ohos.data.unifiedDataChannel').default.Summary } Summary 9235 * @syscap SystemCapability.ArkUI.ArkUI.Full 9236 * @atomicservice 9237 * @since 11 9238 */ 9239declare type Summary = import('../api/@ohos.data.unifiedDataChannel').default.Summary; 9240 9241/** 9242 * Import the UniformDataType type object for ui component. 9243 * 9244 * @typedef { import('../api/@ohos.data.uniformTypeDescriptor').default.UniformDataType } UniformDataType 9245 * @syscap SystemCapability.ArkUI.ArkUI.Full 9246 * @since 10 9247 */ 9248/** 9249 * Import the UniformDataType type object for ui component. 9250 * 9251 * @typedef { import('../api/@ohos.data.uniformTypeDescriptor').default.UniformDataType } UniformDataType 9252 * @syscap SystemCapability.ArkUI.ArkUI.Full 9253 * @atomicservice 9254 * @since 11 9255 */ 9256declare type UniformDataType = import('../api/@ohos.data.uniformTypeDescriptor').default.UniformDataType; 9257 9258/** 9259 * Enum for Drag Result. 9260 * 9261 * @enum { number } 9262 * @syscap SystemCapability.ArkUI.ArkUI.Full 9263 * @since 10 9264 */ 9265/** 9266 * Enum for Drag Result. 9267 * 9268 * @enum { number } 9269 * @syscap SystemCapability.ArkUI.ArkUI.Full 9270 * @atomicservice 9271 * @since 11 9272 */ 9273declare enum DragResult { 9274 /** 9275 * If the drag is successful, return DragResult.DRAG_SUCCESSFUL. 9276 * 9277 * @syscap SystemCapability.ArkUI.ArkUI.Full 9278 * @since 10 9279 */ 9280 /** 9281 * If the drag is successful, return DragResult.DRAG_SUCCESSFUL. 9282 * 9283 * @syscap SystemCapability.ArkUI.ArkUI.Full 9284 * @atomicservice 9285 * @since 11 9286 */ 9287 DRAG_SUCCESSFUL = 0, 9288 /** 9289 * If drag fail, return DragResult.DRAG_FAILED. 9290 * 9291 * @syscap SystemCapability.ArkUI.ArkUI.Full 9292 * @since 10 9293 */ 9294 /** 9295 * If drag fail, return DragResult.DRAG_FAILED. 9296 * 9297 * @syscap SystemCapability.ArkUI.ArkUI.Full 9298 * @atomicservice 9299 * @since 11 9300 */ 9301 DRAG_FAILED = 1, 9302 /** 9303 * If drag action cancel, return DragResult.DRAG_CANCELED. 9304 * 9305 * @syscap SystemCapability.ArkUI.ArkUI.Full 9306 * @since 10 9307 */ 9308 /** 9309 * If drag action cancel, return DragResult.DRAG_CANCELED. 9310 * 9311 * @syscap SystemCapability.ArkUI.ArkUI.Full 9312 * @atomicservice 9313 * @since 11 9314 */ 9315 DRAG_CANCELED = 2, 9316 /** 9317 * If node allow drop in, return DragResult.DROP_ENABLED. 9318 * 9319 * @syscap SystemCapability.ArkUI.ArkUI.Full 9320 * @since 10 9321 */ 9322 /** 9323 * If node allow drop in, return DragResult.DROP_ENABLED. 9324 * 9325 * @syscap SystemCapability.ArkUI.ArkUI.Full 9326 * @atomicservice 9327 * @since 11 9328 */ 9329 DROP_ENABLED = 3, 9330 /** 9331 * If node don't allow drop in, return DragResult.DROP_DISABLED. 9332 * 9333 * @syscap SystemCapability.ArkUI.ArkUI.Full 9334 * @since 10 9335 */ 9336 /** 9337 * If node don't allow drop in, return DragResult.DROP_DISABLED. 9338 * 9339 * @syscap SystemCapability.ArkUI.ArkUI.Full 9340 * @atomicservice 9341 * @since 11 9342 */ 9343 DROP_DISABLED = 4 9344} 9345 9346/** 9347 * Enum for BlendMode. 9348 * Blend modes for compositing current component 9349 * with overlapping content. Use overlapping content 9350 * as dst, current component as src. 9351 * 9352 * @enum { number } 9353 * @syscap SystemCapability.ArkUI.ArkUI.Full 9354 * @crossplatform 9355 * @form 9356 * @since 11 9357 */ 9358/** 9359 * Enum for BlendMode. 9360 * Blend modes for compositing current component 9361 * with overlapping content. Use overlapping content 9362 * as dst, current component as src. 9363 * 9364 * @enum { number } 9365 * @syscap SystemCapability.ArkUI.ArkUI.Full 9366 * @crossplatform 9367 * @form 9368 * @atomicservice 9369 * @since 12 9370 */ 9371declare enum BlendMode { 9372 /** 9373 * Hybrid mode does not take effect 9374 * 9375 * @syscap SystemCapability.ArkUI.ArkUI.Full 9376 * @crossplatform 9377 * @form 9378 * @since 11 9379 */ 9380 /** 9381 * Hybrid mode does not take effect 9382 * 9383 * @syscap SystemCapability.ArkUI.ArkUI.Full 9384 * @crossplatform 9385 * @form 9386 * @atomicservice 9387 * @since 12 9388 */ 9389 NONE = 0, 9390 /** 9391 * Clear destination color covered by the source to 0. 9392 * 9393 * @syscap SystemCapability.ArkUI.ArkUI.Full 9394 * @crossplatform 9395 * @form 9396 * @since 11 9397 */ 9398 /** 9399 * Clear destination color covered by the source to 0. 9400 * 9401 * @syscap SystemCapability.ArkUI.ArkUI.Full 9402 * @crossplatform 9403 * @form 9404 * @atomicservice 9405 * @since 12 9406 */ 9407 CLEAR = 1, 9408 /** 9409 * r = s 9410 * 9411 * @syscap SystemCapability.ArkUI.ArkUI.Full 9412 * @crossplatform 9413 * @form 9414 * @since 11 9415 */ 9416 /** 9417 * r = s 9418 * 9419 * @syscap SystemCapability.ArkUI.ArkUI.Full 9420 * @crossplatform 9421 * @form 9422 * @atomicservice 9423 * @since 12 9424 */ 9425 SRC = 2, 9426 /** 9427 * r = d 9428 * 9429 * @syscap SystemCapability.ArkUI.ArkUI.Full 9430 * @crossplatform 9431 * @form 9432 * @since 11 9433 */ 9434 /** 9435 * r = d 9436 * 9437 * @syscap SystemCapability.ArkUI.ArkUI.Full 9438 * @crossplatform 9439 * @form 9440 * @atomicservice 9441 * @since 12 9442 */ 9443 DST = 3, 9444 /** 9445 * r = s + (1 - sa) * d 9446 * 9447 * @syscap SystemCapability.ArkUI.ArkUI.Full 9448 * @crossplatform 9449 * @form 9450 * @since 11 9451 */ 9452 /** 9453 * r = s + (1 - sa) * d 9454 * 9455 * @syscap SystemCapability.ArkUI.ArkUI.Full 9456 * @crossplatform 9457 * @form 9458 * @atomicservice 9459 * @since 12 9460 */ 9461 SRC_OVER = 4, 9462 /** 9463 * r = d + (1 - da) * s 9464 * 9465 * @syscap SystemCapability.ArkUI.ArkUI.Full 9466 * @crossplatform 9467 * @form 9468 * @since 11 9469 */ 9470 /** 9471 * r = d + (1 - da) * s 9472 * 9473 * @syscap SystemCapability.ArkUI.ArkUI.Full 9474 * @crossplatform 9475 * @form 9476 * @atomicservice 9477 * @since 12 9478 */ 9479 DST_OVER = 5, 9480 /** 9481 * r = s * da 9482 * 9483 * @syscap SystemCapability.ArkUI.ArkUI.Full 9484 * @crossplatform 9485 * @form 9486 * @since 11 9487 */ 9488 /** 9489 * r = s * da 9490 * 9491 * @syscap SystemCapability.ArkUI.ArkUI.Full 9492 * @crossplatform 9493 * @form 9494 * @atomicservice 9495 * @since 12 9496 */ 9497 SRC_IN = 6, 9498 /** 9499 * r = d * sa 9500 * 9501 * @syscap SystemCapability.ArkUI.ArkUI.Full 9502 * @crossplatform 9503 * @form 9504 * @since 11 9505 */ 9506 /** 9507 * r = d * sa 9508 * 9509 * @syscap SystemCapability.ArkUI.ArkUI.Full 9510 * @crossplatform 9511 * @form 9512 * @atomicservice 9513 * @since 12 9514 */ 9515 DST_IN = 7, 9516 /** 9517 * r = s * (1 - da) 9518 * 9519 * @syscap SystemCapability.ArkUI.ArkUI.Full 9520 * @crossplatform 9521 * @form 9522 * @since 11 9523 */ 9524 /** 9525 * r = s * (1 - da) 9526 * 9527 * @syscap SystemCapability.ArkUI.ArkUI.Full 9528 * @crossplatform 9529 * @form 9530 * @atomicservice 9531 * @since 12 9532 */ 9533 SRC_OUT = 8, 9534 /** 9535 * r = d * (1 - sa) 9536 * 9537 * @syscap SystemCapability.ArkUI.ArkUI.Full 9538 * @crossplatform 9539 * @form 9540 * @since 11 9541 */ 9542 /** 9543 * r = d * (1 - sa) 9544 * 9545 * @syscap SystemCapability.ArkUI.ArkUI.Full 9546 * @crossplatform 9547 * @form 9548 * @atomicservice 9549 * @since 12 9550 */ 9551 DST_OUT = 9, 9552 /** 9553 * r = s * da + d * (1 - sa) 9554 * 9555 * @syscap SystemCapability.ArkUI.ArkUI.Full 9556 * @crossplatform 9557 * @form 9558 * @since 11 9559 */ 9560 /** 9561 * r = s * da + d * (1 - sa) 9562 * 9563 * @syscap SystemCapability.ArkUI.ArkUI.Full 9564 * @crossplatform 9565 * @form 9566 * @atomicservice 9567 * @since 12 9568 */ 9569 SRC_ATOP = 10, 9570 /** 9571 * r = d * sa + s * (1 - da) 9572 * 9573 * @syscap SystemCapability.ArkUI.ArkUI.Full 9574 * @crossplatform 9575 * @form 9576 * @since 11 9577 */ 9578 /** 9579 * r = d * sa + s * (1 - da) 9580 * 9581 * @syscap SystemCapability.ArkUI.ArkUI.Full 9582 * @crossplatform 9583 * @form 9584 * @atomicservice 9585 * @since 12 9586 */ 9587 DST_ATOP = 11, 9588 /** 9589 * r = s * (1 - da) + d * (1 - sa) 9590 * 9591 * @syscap SystemCapability.ArkUI.ArkUI.Full 9592 * @crossplatform 9593 * @form 9594 * @since 11 9595 */ 9596 /** 9597 * r = s * (1 - da) + d * (1 - sa) 9598 * 9599 * @syscap SystemCapability.ArkUI.ArkUI.Full 9600 * @crossplatform 9601 * @form 9602 * @atomicservice 9603 * @since 12 9604 */ 9605 XOR = 12, 9606 /** 9607 * r = min(s + d, 1) 9608 * 9609 * @syscap SystemCapability.ArkUI.ArkUI.Full 9610 * @crossplatform 9611 * @form 9612 * @since 11 9613 */ 9614 /** 9615 * r = min(s + d, 1) 9616 * 9617 * @syscap SystemCapability.ArkUI.ArkUI.Full 9618 * @crossplatform 9619 * @form 9620 * @atomicservice 9621 * @since 12 9622 */ 9623 PLUS = 13, 9624 /** 9625 * r = s * d 9626 * 9627 * @syscap SystemCapability.ArkUI.ArkUI.Full 9628 * @crossplatform 9629 * @form 9630 * @since 11 9631 */ 9632 /** 9633 * r = s * d 9634 * 9635 * @syscap SystemCapability.ArkUI.ArkUI.Full 9636 * @crossplatform 9637 * @form 9638 * @atomicservice 9639 * @since 12 9640 */ 9641 MODULATE = 14, 9642 /** 9643 * r = s + d - s * d 9644 * 9645 * @syscap SystemCapability.ArkUI.ArkUI.Full 9646 * @crossplatform 9647 * @form 9648 * @since 11 9649 */ 9650 /** 9651 * r = s + d - s * d 9652 * 9653 * @syscap SystemCapability.ArkUI.ArkUI.Full 9654 * @crossplatform 9655 * @form 9656 * @atomicservice 9657 * @since 12 9658 */ 9659 SCREEN = 15, 9660 /** 9661 * multiply or screen, depending on destination 9662 * 9663 * @syscap SystemCapability.ArkUI.ArkUI.Full 9664 * @crossplatform 9665 * @form 9666 * @since 11 9667 */ 9668 /** 9669 * multiply or screen, depending on destination 9670 * 9671 * @syscap SystemCapability.ArkUI.ArkUI.Full 9672 * @crossplatform 9673 * @form 9674 * @atomicservice 9675 * @since 12 9676 */ 9677 OVERLAY = 16, 9678 /** 9679 * rc = s + d - max(s * da, d * sa), ra = kSrcOver 9680 * 9681 * @syscap SystemCapability.ArkUI.ArkUI.Full 9682 * @crossplatform 9683 * @form 9684 * @since 11 9685 */ 9686 /** 9687 * rc = s + d - max(s * da, d * sa), ra = kSrcOver 9688 * 9689 * @syscap SystemCapability.ArkUI.ArkUI.Full 9690 * @crossplatform 9691 * @form 9692 * @atomicservice 9693 * @since 12 9694 */ 9695 DARKEN = 17, 9696 /** 9697 * rc = s + d - min(s * da, d * sa), ra = kSrcOver 9698 * 9699 * @syscap SystemCapability.ArkUI.ArkUI.Full 9700 * @crossplatform 9701 * @form 9702 * @since 11 9703 */ 9704 /** 9705 * rc = s + d - min(s * da, d * sa), ra = kSrcOver 9706 * 9707 * @syscap SystemCapability.ArkUI.ArkUI.Full 9708 * @crossplatform 9709 * @form 9710 * @atomicservice 9711 * @since 12 9712 */ 9713 LIGHTEN = 18, 9714 /** 9715 * brighten destination to reflect source 9716 * 9717 * @syscap SystemCapability.ArkUI.ArkUI.Full 9718 * @crossplatform 9719 * @form 9720 * @since 11 9721 */ 9722 /** 9723 * brighten destination to reflect source 9724 * 9725 * @syscap SystemCapability.ArkUI.ArkUI.Full 9726 * @crossplatform 9727 * @form 9728 * @atomicservice 9729 * @since 12 9730 */ 9731 COLOR_DODGE = 19, 9732 /** 9733 * darken destination to reflect source 9734 * 9735 * @syscap SystemCapability.ArkUI.ArkUI.Full 9736 * @crossplatform 9737 * @form 9738 * @since 11 9739 */ 9740 /** 9741 * darken destination to reflect source 9742 * 9743 * @syscap SystemCapability.ArkUI.ArkUI.Full 9744 * @crossplatform 9745 * @form 9746 * @atomicservice 9747 * @since 12 9748 */ 9749 COLOR_BURN = 20, 9750 /** 9751 * multiply or screen, depending on source 9752 * 9753 * @syscap SystemCapability.ArkUI.ArkUI.Full 9754 * @crossplatform 9755 * @form 9756 * @since 11 9757 */ 9758 /** 9759 * multiply or screen, depending on source 9760 * 9761 * @syscap SystemCapability.ArkUI.ArkUI.Full 9762 * @crossplatform 9763 * @form 9764 * @atomicservice 9765 * @since 12 9766 */ 9767 HARD_LIGHT = 21, 9768 /** 9769 * lighten or darken, depending on source 9770 * 9771 * @syscap SystemCapability.ArkUI.ArkUI.Full 9772 * @crossplatform 9773 * @form 9774 * @since 11 9775 */ 9776 /** 9777 * lighten or darken, depending on source 9778 * 9779 * @syscap SystemCapability.ArkUI.ArkUI.Full 9780 * @crossplatform 9781 * @form 9782 * @atomicservice 9783 * @since 12 9784 */ 9785 SOFT_LIGHT = 22, 9786 /** 9787 * rc = s + d - 2 * (min(s * da, d * sa)), ra = kSrcOver 9788 * 9789 * @syscap SystemCapability.ArkUI.ArkUI.Full 9790 * @crossplatform 9791 * @form 9792 * @since 11 9793 */ 9794 /** 9795 * rc = s + d - 2 * (min(s * da, d * sa)), ra = kSrcOver 9796 * 9797 * @syscap SystemCapability.ArkUI.ArkUI.Full 9798 * @crossplatform 9799 * @form 9800 * @atomicservice 9801 * @since 12 9802 */ 9803 DIFFERENCE = 23, 9804 /** 9805 * rc = s + d - two(s * d), ra = kSrcOver 9806 * 9807 * @syscap SystemCapability.ArkUI.ArkUI.Full 9808 * @crossplatform 9809 * @form 9810 * @since 11 9811 */ 9812 /** 9813 * rc = s + d - two(s * d), ra = kSrcOver 9814 * 9815 * @syscap SystemCapability.ArkUI.ArkUI.Full 9816 * @crossplatform 9817 * @form 9818 * @atomicservice 9819 * @since 12 9820 */ 9821 EXCLUSION = 24, 9822 /** 9823 * r = s * (1 - da) + d * (1 - sa) + s * d 9824 * 9825 * @syscap SystemCapability.ArkUI.ArkUI.Full 9826 * @crossplatform 9827 * @form 9828 * @since 11 9829 */ 9830 /** 9831 * r = s * (1 - da) + d * (1 - sa) + s * d 9832 * 9833 * @syscap SystemCapability.ArkUI.ArkUI.Full 9834 * @crossplatform 9835 * @form 9836 * @atomicservice 9837 * @since 12 9838 */ 9839 MULTIPLY = 25, 9840 /** 9841 * hue of source with saturation and luminosity of destination 9842 * 9843 * @syscap SystemCapability.ArkUI.ArkUI.Full 9844 * @crossplatform 9845 * @form 9846 * @since 11 9847 */ 9848 /** 9849 * hue of source with saturation and luminosity of destination 9850 * 9851 * @syscap SystemCapability.ArkUI.ArkUI.Full 9852 * @crossplatform 9853 * @form 9854 * @atomicservice 9855 * @since 12 9856 */ 9857 HUE = 26, 9858 /** 9859 * saturation of source with hue and luminosity of destination 9860 * 9861 * @syscap SystemCapability.ArkUI.ArkUI.Full 9862 * @crossplatform 9863 * @form 9864 * @since 11 9865 */ 9866 /** 9867 * saturation of source with hue and luminosity of destination 9868 * 9869 * @syscap SystemCapability.ArkUI.ArkUI.Full 9870 * @crossplatform 9871 * @form 9872 * @atomicservice 9873 * @since 12 9874 */ 9875 SATURATION = 27, 9876 /** 9877 * hue and saturation of source with luminosity of destination 9878 * 9879 * @syscap SystemCapability.ArkUI.ArkUI.Full 9880 * @crossplatform 9881 * @form 9882 * @since 11 9883 */ 9884 /** 9885 * hue and saturation of source with luminosity of destination 9886 * 9887 * @syscap SystemCapability.ArkUI.ArkUI.Full 9888 * @crossplatform 9889 * @form 9890 * @atomicservice 9891 * @since 12 9892 */ 9893 COLOR = 28, 9894 /** 9895 * luminosity of source with hue and saturation of destination 9896 * 9897 * @syscap SystemCapability.ArkUI.ArkUI.Full 9898 * @crossplatform 9899 * @form 9900 * @since 11 9901 */ 9902 /** 9903 * luminosity of source with hue and saturation of destination 9904 * 9905 * @syscap SystemCapability.ArkUI.ArkUI.Full 9906 * @crossplatform 9907 * @form 9908 * @atomicservice 9909 * @since 12 9910 */ 9911 LUMINOSITY = 29 9912} 9913 9914/** 9915 * Enum for BlendApplyType. 9916 * Indicate how to apply specified blend mode to 9917 * the view's content. 9918 * 9919 * @enum { number } 9920 * @syscap SystemCapability.ArkUI.ArkUI.Full 9921 * @crossplatform 9922 * @form 9923 * @since 11 9924 */ 9925/** 9926 * Enum for BlendApplyType. 9927 * Indicate how to apply specified blend mode to 9928 * the view's content. 9929 * 9930 * @enum { number } 9931 * @syscap SystemCapability.ArkUI.ArkUI.Full 9932 * @crossplatform 9933 * @form 9934 * @atomicservice 9935 * @since 12 9936 */ 9937declare enum BlendApplyType { 9938 /** 9939 * Blend view's content in sequence over dst 9940 * 9941 * @syscap SystemCapability.ArkUI.ArkUI.Full 9942 * @crossplatform 9943 * @form 9944 * @since 11 9945 */ 9946 /** 9947 * Blend view's content in sequence over dst 9948 * 9949 * @syscap SystemCapability.ArkUI.ArkUI.Full 9950 * @crossplatform 9951 * @form 9952 * @atomicservice 9953 * @since 12 9954 */ 9955 FAST = 0, 9956 9957 /** 9958 * Composite this views's contents into an 9959 * offscreen image and then blend over dst 9960 * 9961 * @syscap SystemCapability.ArkUI.ArkUI.Full 9962 * @crossplatform 9963 * @form 9964 * @since 11 9965 */ 9966 /** 9967 * Composite this views's contents into an 9968 * offscreen image and then blend over dst 9969 * 9970 * @syscap SystemCapability.ArkUI.ArkUI.Full 9971 * @crossplatform 9972 * @form 9973 * @atomicservice 9974 * @since 12 9975 */ 9976 OFFSCREEN = 1, 9977} 9978 9979/** 9980 * DragEvent object description 9981 * 9982 * @interface DragEvent 9983 * @syscap SystemCapability.ArkUI.ArkUI.Full 9984 * @since 7 9985 */ 9986/** 9987 * DragEvent object description 9988 * 9989 * @interface DragEvent 9990 * @syscap SystemCapability.ArkUI.ArkUI.Full 9991 * @atomicservice 9992 * @since 11 9993 */ 9994declare interface DragEvent { 9995 /** 9996 * X coordinate of the touch point relative to the left edge of the device screen. 9997 * 9998 * @returns { number } 9999 * @syscap SystemCapability.ArkUI.ArkUI.Full 10000 * @since 10 10001 */ 10002 /** 10003 * X coordinate of the touch point relative to the left edge of the device screen. 10004 * 10005 * @returns { number } 10006 * @syscap SystemCapability.ArkUI.ArkUI.Full 10007 * @atomicservice 10008 * @since 11 10009 */ 10010 getDisplayX(): number; 10011 10012 /** 10013 * Y coordinate of the touch point relative to the upper edge of the device screen. 10014 * 10015 * @returns { number } 10016 * @syscap SystemCapability.ArkUI.ArkUI.Full 10017 * @since 10 10018 */ 10019 /** 10020 * Y coordinate of the touch point relative to the upper edge of the device screen. 10021 * 10022 * @returns { number } 10023 * @syscap SystemCapability.ArkUI.ArkUI.Full 10024 * @atomicservice 10025 * @since 11 10026 */ 10027 getDisplayY(): number; 10028 10029 /** 10030 * X coordinate of the touch point relative to the left edge of the current window. 10031 * 10032 * @returns { number } 10033 * @syscap SystemCapability.ArkUI.ArkUI.Full 10034 * @since 10 10035 */ 10036 /** 10037 * X coordinate of the touch point relative to the left edge of the current window. 10038 * 10039 * @returns { number } 10040 * @syscap SystemCapability.ArkUI.ArkUI.Full 10041 * @atomicservice 10042 * @since 11 10043 */ 10044 getWindowX(): number; 10045 10046 /** 10047 * Y coordinate of the touch point relative to the left edge of the current window. 10048 * 10049 * @returns { number } 10050 * @syscap SystemCapability.ArkUI.ArkUI.Full 10051 * @since 10 10052 */ 10053 /** 10054 * Y coordinate of the touch point relative to the left edge of the current window. 10055 * 10056 * @returns { number } 10057 * @syscap SystemCapability.ArkUI.ArkUI.Full 10058 * @atomicservice 10059 * @since 11 10060 */ 10061 getWindowY(): number; 10062 10063 /** 10064 * X coordinate of the touch point relative to the left edge of the current window. in vp. 10065 * 10066 * @returns { number } 10067 * @syscap SystemCapability.ArkUI.ArkUI.Full 10068 * @since 7 10069 * @deprecated since 10 10070 * @useinstead DragEvent#getWindowX 10071 */ 10072 getX(): number; 10073 10074 /** 10075 * Y coordinate of the touch point relative to the left edge of the current window. in vp. 10076 * 10077 * @returns { number } 10078 * @syscap SystemCapability.ArkUI.ArkUI.Full 10079 * @since 7 10080 * @deprecated since 10 10081 * @useinstead DragEvent#getWindowY 10082 */ 10083 getY(): number; 10084 10085 /** 10086 * If copy is COPY, this DragEvent is a copy event. 10087 * @type { DragBehavior } Operation, if use copy then set COPY, else set MOVE. 10088 * @default COPY 10089 * @syscap SystemCapability.ArkUI.ArkUI.Full 10090 * @since 10 10091 */ 10092 /** 10093 * If copy is COPY, this DragEvent is a copy event. 10094 * @type { DragBehavior } Operation, if use copy then set COPY, else set MOVE. 10095 * @default COPY 10096 * @syscap SystemCapability.ArkUI.ArkUI.Full 10097 * @atomicservice 10098 * @since 11 10099 */ 10100 dragBehavior: DragBehavior; 10101 10102 /** 10103 * If useCustomDropAnimation is true, System will not use drop animation. 10104 * 10105 * @type { boolean } 10106 * @syscap SystemCapability.ArkUI.ArkUI.Full 10107 * @since 10 10108 */ 10109 /** 10110 * If useCustomDropAnimation is true, System will not use drop animation. 10111 * 10112 * @type { boolean } 10113 * @syscap SystemCapability.ArkUI.ArkUI.Full 10114 * @atomicservice 10115 * @since 11 10116 */ 10117 useCustomDropAnimation: boolean; 10118 10119 /** 10120 * Set dragData into DragEvent. 10121 * 10122 * @param { UnifiedData } unifiedData - dragData. 10123 * @syscap SystemCapability.ArkUI.ArkUI.Full 10124 * @crossplatform 10125 * @since 10 10126 */ 10127 /** 10128 * Set dragData into DragEvent. 10129 * 10130 * @param { UnifiedData } unifiedData - dragData. 10131 * @syscap SystemCapability.ArkUI.ArkUI.Full 10132 * @crossplatform 10133 * @atomicservice 10134 * @since 11 10135 */ 10136 setData(unifiedData: UnifiedData): void; 10137 10138 /** 10139 * Get dragData from DragEvent. 10140 * 10141 * @returns { UnifiedData } - get dragData. 10142 * @throws { BusinessError } 190001 - Data not found. 10143 * @throws { BusinessError } 190002 - Data error. 10144 * @syscap SystemCapability.ArkUI.ArkUI.Full 10145 * @crossplatform 10146 * @since 10 10147 */ 10148 /** 10149 * Get dragData from DragEvent. 10150 * 10151 * @returns { UnifiedData } - get dragData. 10152 * @throws { BusinessError } 190001 - Data not found. 10153 * @throws { BusinessError } 190002 - Data error. 10154 * @syscap SystemCapability.ArkUI.ArkUI.Full 10155 * @crossplatform 10156 * @atomicservice 10157 * @since 11 10158 */ 10159 getData(): UnifiedData; 10160 10161 /** 10162 * Get dragData summary from DragEvent. 10163 * 10164 * @returns { Summary } - get Summary Data. 10165 * @syscap SystemCapability.ArkUI.ArkUI.Full 10166 * @crossplatform 10167 * @since 10 10168 */ 10169 /** 10170 * Get dragData summary from DragEvent. 10171 * 10172 * @returns { Summary } - get Summary Data. 10173 * @syscap SystemCapability.ArkUI.ArkUI.Full 10174 * @crossplatform 10175 * @atomicservice 10176 * @since 11 10177 */ 10178 getSummary(): Summary; 10179 10180 /** 10181 * Set dragEvent result to DragEvent. 10182 * 10183 * @param { DragResult } dragResult - the return of dragEvent. 10184 * @syscap SystemCapability.ArkUI.ArkUI.Full 10185 * @since 10 10186 */ 10187 /** 10188 * Set dragEvent result to DragEvent. 10189 * 10190 * @param { DragResult } dragResult - the return of dragEvent. 10191 * @syscap SystemCapability.ArkUI.ArkUI.Full 10192 * @atomicservice 10193 * @since 11 10194 */ 10195 setResult(dragResult: DragResult): void; 10196 10197 /** 10198 * Get dragEvent result from DragEvent. 10199 * 10200 * @returns { DragResult } - dragResult Data. 10201 * @syscap SystemCapability.ArkUI.ArkUI.Full 10202 * @since 10 10203 */ 10204 /** 10205 * Get dragEvent result from DragEvent. 10206 * 10207 * @returns { DragResult } - dragResult Data. 10208 * @syscap SystemCapability.ArkUI.ArkUI.Full 10209 * @atomicservice 10210 * @since 11 10211 */ 10212 getResult(): DragResult; 10213 10214 /** 10215 * Get the rectangle of drag window. 10216 * 10217 * @returns { Rectangle } - getPreview rectangle. 10218 * @syscap SystemCapability.ArkUI.ArkUI.Full 10219 * @since 10 10220 */ 10221 /** 10222 * Get the rectangle of drag window. 10223 * 10224 * @returns { Rectangle } - getPreview rectangle. 10225 * @syscap SystemCapability.ArkUI.ArkUI.Full 10226 * @atomicservice 10227 * @since 11 10228 */ 10229 getPreviewRect(): Rectangle; 10230 10231 /** 10232 * Get the x axis velocity of drag gesture. 10233 * 10234 * @returns { number } - get x axis velocity. 10235 * @syscap SystemCapability.ArkUI.ArkUI.Full 10236 * @crossplatform 10237 * @since 10 10238 */ 10239 /** 10240 * Get the x axis velocity of drag gesture. 10241 * 10242 * @returns { number } - get x axis velocity. 10243 * @syscap SystemCapability.ArkUI.ArkUI.Full 10244 * @crossplatform 10245 * @atomicservice 10246 * @since 11 10247 */ 10248 getVelocityX(): number; 10249 10250 /** 10251 * Get the y axis velocity of drag gesture. 10252 * 10253 * @returns { number } - get y axis velocity. 10254 * @syscap SystemCapability.ArkUI.ArkUI.Full 10255 * @crossplatform 10256 * @since 10 10257 */ 10258 /** 10259 * Get the y axis velocity of drag gesture. 10260 * 10261 * @returns { number } - get y axis velocity. 10262 * @syscap SystemCapability.ArkUI.ArkUI.Full 10263 * @crossplatform 10264 * @atomicservice 10265 * @since 11 10266 */ 10267 getVelocityY(): number; 10268 10269 /** 10270 * Get the velocity of drag gesture. 10271 * 10272 * @returns { number } - get velocity. 10273 * @syscap SystemCapability.ArkUI.ArkUI.Full 10274 * @crossplatform 10275 * @since 10 10276 */ 10277 /** 10278 * Get the velocity of drag gesture. 10279 * 10280 * @returns { number } - get velocity. 10281 * @syscap SystemCapability.ArkUI.ArkUI.Full 10282 * @crossplatform 10283 * @atomicservice 10284 * @since 11 10285 */ 10286 getVelocity(): number; 10287 10288 /** 10289 * Query the ModifierKey press state, support 'ctrl'|'alt'|'shift'|'fn' 10290 * 10291 * @param { Array<string> } keys - indicate the keys of the ModifierKey. 10292 * @returns { boolean } 10293 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 10294 * @syscap SystemCapability.ArkUI.ArkUI.Full 10295 * @crossplatform 10296 * @since 12 10297 */ 10298 /** 10299 * Query the ModifierKey press state, support 'ctrl'|'alt'|'shift'|'fn' 10300 * 10301 * @param { Array<string> } keys - indicate the keys of the ModifierKey. 10302 * @returns { boolean } 10303 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 10304 * @syscap SystemCapability.ArkUI.ArkUI.Full 10305 * @crossplatform 10306 * @atomicservice 10307 * @since 13 10308 */ 10309 getModifierKeyState?(keys: Array<string>): boolean; 10310} 10311 10312/** 10313 * Import the IntentionCode type object for IntentionCode. 10314 * 10315 * @typedef { import('../api/@ohos.multimodalInput.intentionCode').IntentionCode } IntentionCode 10316 * @syscap SystemCapability.ArkUI.ArkUI.Full 10317 * @since 10 10318 */ 10319/** 10320 * Import the IntentionCode type object for IntentionCode. 10321 * 10322 * @typedef { import('../api/@ohos.multimodalInput.intentionCode').IntentionCode } IntentionCode 10323 * @syscap SystemCapability.ArkUI.ArkUI.Full 10324 * @atomicservice 10325 * @since 11 10326 */ 10327declare type IntentionCode = import('../api/@ohos.multimodalInput.intentionCode').IntentionCode; 10328 10329/** 10330 * KeyEvent object description: 10331 * 10332 * @interface KeyEvent 10333 * @syscap SystemCapability.ArkUI.ArkUI.Full 10334 * @since 7 10335 */ 10336/** 10337 * KeyEvent object description: 10338 * 10339 * @interface KeyEvent 10340 * @syscap SystemCapability.ArkUI.ArkUI.Full 10341 * @crossplatform 10342 * @since 10 10343 */ 10344/** 10345 * KeyEvent object description: 10346 * 10347 * @interface KeyEvent 10348 * @syscap SystemCapability.ArkUI.ArkUI.Full 10349 * @crossplatform 10350 * @atomicservice 10351 * @since 11 10352 */ 10353declare interface KeyEvent { 10354 /** 10355 * Type of a key. 10356 * 10357 * @type { KeyType } 10358 * @syscap SystemCapability.ArkUI.ArkUI.Full 10359 * @since 7 10360 */ 10361 /** 10362 * Type of a key. 10363 * 10364 * @type { KeyType } 10365 * @syscap SystemCapability.ArkUI.ArkUI.Full 10366 * @crossplatform 10367 * @since 10 10368 */ 10369 /** 10370 * Type of a key. 10371 * 10372 * @type { KeyType } 10373 * @syscap SystemCapability.ArkUI.ArkUI.Full 10374 * @crossplatform 10375 * @atomicservice 10376 * @since 11 10377 */ 10378 type: KeyType; 10379 10380 /** 10381 * Key code of a key 10382 * 10383 * @type { number } 10384 * @syscap SystemCapability.ArkUI.ArkUI.Full 10385 * @since 7 10386 */ 10387 /** 10388 * Key code of a key 10389 * 10390 * @type { number } 10391 * @syscap SystemCapability.ArkUI.ArkUI.Full 10392 * @crossplatform 10393 * @since 10 10394 */ 10395 /** 10396 * Key code of a key 10397 * 10398 * @type { number } 10399 * @syscap SystemCapability.ArkUI.ArkUI.Full 10400 * @crossplatform 10401 * @atomicservice 10402 * @since 11 10403 */ 10404 keyCode: number; 10405 10406 /** 10407 * Key value of a key. 10408 * 10409 * @type { string } 10410 * @syscap SystemCapability.ArkUI.ArkUI.Full 10411 * @since 7 10412 */ 10413 /** 10414 * Key value of a key. 10415 * 10416 * @type { string } 10417 * @syscap SystemCapability.ArkUI.ArkUI.Full 10418 * @crossplatform 10419 * @since 10 10420 */ 10421 /** 10422 * Key value of a key. 10423 * 10424 * @type { string } 10425 * @syscap SystemCapability.ArkUI.ArkUI.Full 10426 * @crossplatform 10427 * @atomicservice 10428 * @since 11 10429 */ 10430 keyText: string; 10431 10432 /** 10433 * Type of the input device that triggers the current key, such as the keyboard or handle. 10434 * 10435 * @type { KeySource } 10436 * @syscap SystemCapability.ArkUI.ArkUI.Full 10437 * @since 7 10438 */ 10439 /** 10440 * Type of the input device that triggers the current key, such as the keyboard or handle. 10441 * 10442 * @type { KeySource } 10443 * @syscap SystemCapability.ArkUI.ArkUI.Full 10444 * @crossplatform 10445 * @since 10 10446 */ 10447 /** 10448 * Type of the input device that triggers the current key, such as the keyboard or handle. 10449 * 10450 * @type { KeySource } 10451 * @syscap SystemCapability.ArkUI.ArkUI.Full 10452 * @crossplatform 10453 * @atomicservice 10454 * @since 11 10455 */ 10456 keySource: KeySource; 10457 10458 /** 10459 * Indicates the ID of the input device that triggers the current key. 10460 * 10461 * @type { number } 10462 * @syscap SystemCapability.ArkUI.ArkUI.Full 10463 * @since 7 10464 */ 10465 /** 10466 * Indicates the ID of the input device that triggers the current key. 10467 * 10468 * @type { number } 10469 * @syscap SystemCapability.ArkUI.ArkUI.Full 10470 * @crossplatform 10471 * @since 10 10472 */ 10473 /** 10474 * Indicates the ID of the input device that triggers the current key. 10475 * 10476 * @type { number } 10477 * @syscap SystemCapability.ArkUI.ArkUI.Full 10478 * @crossplatform 10479 * @atomicservice 10480 * @since 11 10481 */ 10482 deviceId: number; 10483 10484 /** 10485 * Indicates the status of the key when the key is pressed. 10486 * The value 1 indicates the pressed state, and the value 0 indicates the unpressed state. 10487 * 10488 * @type { number } 10489 * @syscap SystemCapability.ArkUI.ArkUI.Full 10490 * @since 7 10491 */ 10492 /** 10493 * Indicates the status of the key when the key is pressed. 10494 * The value 1 indicates the pressed state, and the value 0 indicates the unpressed state. 10495 * 10496 * @type { number } 10497 * @syscap SystemCapability.ArkUI.ArkUI.Full 10498 * @crossplatform 10499 * @since 10 10500 */ 10501 /** 10502 * Indicates the status of the key when the key is pressed. 10503 * The value 1 indicates the pressed state, and the value 0 indicates the unpressed state. 10504 * 10505 * @type { number } 10506 * @syscap SystemCapability.ArkUI.ArkUI.Full 10507 * @crossplatform 10508 * @atomicservice 10509 * @since 11 10510 */ 10511 metaKey: number; 10512 10513 /** 10514 * Timestamp when the key was pressed. 10515 * 10516 * @type { number } 10517 * @syscap SystemCapability.ArkUI.ArkUI.Full 10518 * @since 7 10519 */ 10520 /** 10521 * Timestamp when the key was pressed. 10522 * 10523 * @type { number } 10524 * @syscap SystemCapability.ArkUI.ArkUI.Full 10525 * @crossplatform 10526 * @since 10 10527 */ 10528 /** 10529 * Timestamp when the key was pressed. 10530 * 10531 * @type { number } 10532 * @syscap SystemCapability.ArkUI.ArkUI.Full 10533 * @crossplatform 10534 * @atomicservice 10535 * @since 11 10536 */ 10537 timestamp: number; 10538 10539 /** 10540 * Block event bubbling. 10541 * 10542 * @type { function } 10543 * @syscap SystemCapability.ArkUI.ArkUI.Full 10544 * @since 7 10545 */ 10546 /** 10547 * Block event bubbling. 10548 * 10549 * @type { function } 10550 * @syscap SystemCapability.ArkUI.ArkUI.Full 10551 * @crossplatform 10552 * @since 10 10553 */ 10554 /** 10555 * Block event bubbling. 10556 * 10557 * @type { function } 10558 * @syscap SystemCapability.ArkUI.ArkUI.Full 10559 * @crossplatform 10560 * @atomicservice 10561 * @since 11 10562 */ 10563 stopPropagation: () => void; 10564 10565 /** 10566 * Intention code of a key or modifier keys. 10567 * 10568 * @type { IntentionCode } 10569 * @default IntentionCode.INTENTION_UNKNOWN 10570 * @syscap SystemCapability.ArkUI.ArkUI.Full 10571 * @since 10 10572 */ 10573 /** 10574 * Intention code of a key or modifier keys. 10575 * 10576 * @type { IntentionCode } 10577 * @default IntentionCode.INTENTION_UNKNOWN 10578 * @syscap SystemCapability.ArkUI.ArkUI.Full 10579 * @atomicservice 10580 * @since 11 10581 */ 10582 intentionCode: IntentionCode; 10583 10584 /** 10585 * Get the modifier keys press state, support 'ctrl'|'alt'|'shift'|'fn' 10586 * 10587 * @param { Array<string> } keys - indicate the modifier keys. 10588 * @returns { boolean } 10589 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 10590 * @syscap SystemCapability.ArkUI.ArkUI.Full 10591 * @crossplatform 10592 * @since 12 10593 */ 10594 /** 10595 * Get the modifier keys press state, support 'ctrl'|'alt'|'shift'|'fn' 10596 * 10597 * @param { Array<string> } keys - indicate the modifier keys. 10598 * @returns { boolean } 10599 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 10600 * @syscap SystemCapability.ArkUI.ArkUI.Full 10601 * @crossplatform 10602 * @atomicservice 10603 * @since 13 10604 */ 10605 getModifierKeyState?(keys: Array<string>): boolean; 10606} 10607 10608/** 10609 * Overlay module options 10610 * 10611 * @interface BindOptions 10612 * @syscap SystemCapability.ArkUI.ArkUI.Full 10613 * @crossplatform 10614 * @since 10 10615 */ 10616/** 10617 * Overlay module options 10618 * 10619 * @interface BindOptions 10620 * @syscap SystemCapability.ArkUI.ArkUI.Full 10621 * @crossplatform 10622 * @atomicservice 10623 * @since 11 10624 */ 10625declare interface BindOptions { 10626 /** 10627 * Defines the background color 10628 * 10629 * @type { ?ResourceColor } 10630 * @syscap SystemCapability.ArkUI.ArkUI.Full 10631 * @crossplatform 10632 * @since 10 10633 */ 10634 /** 10635 * Defines the background color 10636 * 10637 * @type { ?ResourceColor } 10638 * @syscap SystemCapability.ArkUI.ArkUI.Full 10639 * @crossplatform 10640 * @atomicservice 10641 * @since 11 10642 */ 10643 backgroundColor?: ResourceColor; 10644 10645 /** 10646 * Callback function when overlay interface appears 10647 * 10648 * @type { ?function } 10649 * @syscap SystemCapability.ArkUI.ArkUI.Full 10650 * @crossplatform 10651 * @since 10 10652 */ 10653 /** 10654 * Callback function when overlay interface appears 10655 * 10656 * @type { ?function } 10657 * @syscap SystemCapability.ArkUI.ArkUI.Full 10658 * @crossplatform 10659 * @atomicservice 10660 * @since 11 10661 */ 10662 onAppear?: () => void; 10663 10664 /** 10665 * Callback function when overlay interface exits 10666 * 10667 * @type { ?function } 10668 * @syscap SystemCapability.ArkUI.ArkUI.Full 10669 * @crossplatform 10670 * @since 10 10671 */ 10672 /** 10673 * Callback function when overlay interface exits 10674 * 10675 * @type { ?function } 10676 * @syscap SystemCapability.ArkUI.ArkUI.Full 10677 * @crossplatform 10678 * @atomicservice 10679 * @since 11 10680 */ 10681 onDisappear?: () => void; 10682 10683 /** 10684 * Callback function before overlay animation starts. 10685 * 10686 * @type { ?function } 10687 * @syscap SystemCapability.ArkUI.ArkUI.Full 10688 * @crossplatform 10689 * @atomicservice 10690 * @since 12 10691 */ 10692 onWillAppear?: () => void; 10693 10694 /** 10695 * Callback function before overlay popAnimation starts. 10696 * 10697 * @type { ?function } 10698 * @syscap SystemCapability.ArkUI.ArkUI.Full 10699 * @crossplatform 10700 * @atomicservice 10701 * @since 12 10702 */ 10703 onWillDisappear?: () => void; 10704} 10705 10706/** 10707 * Component content cover dismiss 10708 * 10709 * @interface DismissContentCoverAction 10710 * @syscap SystemCapability.ArkUI.ArkUI.Full 10711 * @crossplatform 10712 * @atomicservice 10713 * @since 12 10714 */ 10715declare interface DismissContentCoverAction { 10716 /** 10717 * Defines content cover dismiss function 10718 * 10719 * @type { Callback<void> } 10720 * @syscap SystemCapability.ArkUI.ArkUI.Full 10721 * @crossplatform 10722 * @atomicservice 10723 * @since 12 10724 */ 10725 dismiss: Callback<void>; 10726 10727 /** 10728 * Defines content cover dismiss reason 10729 * 10730 * @type { DismissReason } 10731 * @syscap SystemCapability.ArkUI.ArkUI.Full 10732 * @crossplatform 10733 * @atomicservice 10734 * @since 12 10735 */ 10736 reason: DismissReason; 10737} 10738 10739/** 10740 * Component content cover options 10741 * 10742 * @interface ContentCoverOptions 10743 * @syscap SystemCapability.ArkUI.ArkUI.Full 10744 * @crossplatform 10745 * @since 10 10746 */ 10747/** 10748 * Component content cover options 10749 * 10750 * @interface ContentCoverOptions 10751 * @syscap SystemCapability.ArkUI.ArkUI.Full 10752 * @crossplatform 10753 * @atomicservice 10754 * @since 11 10755 */ 10756declare interface ContentCoverOptions extends BindOptions { 10757 /** 10758 * Defines transition type 10759 * 10760 * @type { ?ModalTransition } 10761 * @default ModalTransition.Default 10762 * @syscap SystemCapability.ArkUI.ArkUI.Full 10763 * @crossplatform 10764 * @since 10 10765 */ 10766 /** 10767 * Defines transition type 10768 * 10769 * @type { ?ModalTransition } 10770 * @default ModalTransition.Default 10771 * @syscap SystemCapability.ArkUI.ArkUI.Full 10772 * @crossplatform 10773 * @atomicservice 10774 * @since 11 10775 */ 10776 modalTransition?: ModalTransition, 10777 10778 /** 10779 * Callback function when the content cover interactive dismiss 10780 * 10781 * @type { ?Callback<DismissContentCoverAction> } 10782 * @syscap SystemCapability.ArkUI.ArkUI.Full 10783 * @crossplatform 10784 * @atomicservice 10785 * @since 12 10786 */ 10787 onWillDismiss?: Callback<DismissContentCoverAction>; 10788 10789 /** 10790 * Defines transition effect param 10791 * 10792 * @type { ?TransitionEffect } 10793 * @syscap SystemCapability.ArkUI.ArkUI.Full 10794 * @crossplatform 10795 * @atomicservice 10796 * @since 12 10797 */ 10798 transition?: TransitionEffect; 10799} 10800 10801/** 10802 * Component sheet title options 10803 * 10804 * @interface SheetTitleOptions 10805 * @syscap SystemCapability.ArkUI.ArkUI.Full 10806 * @crossplatform 10807 * @since 11 10808 */ 10809/** 10810 * Component sheet title options 10811 * 10812 * @interface SheetTitleOptions 10813 * @syscap SystemCapability.ArkUI.ArkUI.Full 10814 * @crossplatform 10815 * @atomicservice 10816 * @since 12 10817 */ 10818declare interface SheetTitleOptions { 10819 /** 10820 * Defines title text 10821 * 10822 * @type { ResourceStr } 10823 * @syscap SystemCapability.ArkUI.ArkUI.Full 10824 * @crossplatform 10825 * @since 11 10826 */ 10827 /** 10828 * Defines title text 10829 * 10830 * @type { ResourceStr } 10831 * @syscap SystemCapability.ArkUI.ArkUI.Full 10832 * @crossplatform 10833 * @atomicservice 10834 * @since 12 10835 */ 10836 title: ResourceStr; 10837 10838 /** 10839 * Defines subtitle text 10840 * 10841 * @type { ?ResourceStr } 10842 * @syscap SystemCapability.ArkUI.ArkUI.Full 10843 * @crossplatform 10844 * @since 11 10845 */ 10846 /** 10847 * Defines subtitle text 10848 * 10849 * @type { ?ResourceStr } 10850 * @syscap SystemCapability.ArkUI.ArkUI.Full 10851 * @crossplatform 10852 * @atomicservice 10853 * @since 12 10854 */ 10855 subtitle?: ResourceStr; 10856} 10857 10858/** 10859 * Defines the sheet type. 10860 * 10861 * @enum { number } 10862 * @syscap SystemCapability.ArkUI.ArkUI.Full 10863 * @crossplatform 10864 * @since 11 10865 */ 10866/** 10867 * Defines the sheet type. 10868 * 10869 * @enum { number } 10870 * @syscap SystemCapability.ArkUI.ArkUI.Full 10871 * @crossplatform 10872 * @atomicservice 10873 * @since 12 10874 */ 10875declare enum SheetType { 10876 /** 10877 * Defines bottom sheet type. 10878 * 10879 * @syscap SystemCapability.ArkUI.ArkUI.Full 10880 * @crossplatform 10881 * @since 11 10882 */ 10883 /** 10884 * Defines bottom sheet type. 10885 * 10886 * @syscap SystemCapability.ArkUI.ArkUI.Full 10887 * @crossplatform 10888 * @atomicservice 10889 * @since 12 10890 */ 10891 BOTTOM = 0, 10892 10893 /** 10894 * Defines center sheet type. 10895 * 10896 * @syscap SystemCapability.ArkUI.ArkUI.Full 10897 * @crossplatform 10898 * @since 11 10899 */ 10900 /** 10901 * Defines center sheet type. 10902 * 10903 * @syscap SystemCapability.ArkUI.ArkUI.Full 10904 * @crossplatform 10905 * @atomicservice 10906 * @since 12 10907 */ 10908 CENTER = 1, 10909 10910 /** 10911 * Defines popup sheet type. 10912 * 10913 * @syscap SystemCapability.ArkUI.ArkUI.Full 10914 * @crossplatform 10915 * @since 11 10916 */ 10917 /** 10918 * Defines popup sheet type. 10919 * 10920 * @syscap SystemCapability.ArkUI.ArkUI.Full 10921 * @crossplatform 10922 * @atomicservice 10923 * @since 12 10924 */ 10925 POPUP = 2, 10926} 10927 10928/** 10929 * Define the display mode of the sheet. 10930 * 10931 * @enum { number } 10932 * @syscap SystemCapability.ArkUI.ArkUI.Full 10933 * @crossplatform 10934 * @atomicservice 10935 * @since 12 10936 */ 10937declare enum SheetMode { 10938 /** 10939 * Sheet displays above all page levels. 10940 * 10941 * @syscap SystemCapability.ArkUI.ArkUI.Full 10942 * @crossplatform 10943 * @atomicservice 10944 * @since 12 10945 */ 10946 OVERLAY = 0, 10947 10948 /** 10949 * Sheet displays within the current page. 10950 * 10951 * @syscap SystemCapability.ArkUI.ArkUI.Full 10952 * @crossplatform 10953 * @atomicservice 10954 * @since 12 10955 */ 10956 EMBEDDED = 1, 10957} 10958 10959/** 10960 * Define the scroll size mode of the sheet. 10961 * 10962 * @enum { number } 10963 * @syscap SystemCapability.ArkUI.ArkUI.Full 10964 * @crossplatform 10965 * @atomicservice 10966 * @since 12 10967 */ 10968declare enum ScrollSizeMode { 10969 /** 10970 * Sheet change scroll size after the slide ends. 10971 * 10972 * @syscap SystemCapability.ArkUI.ArkUI.Full 10973 * @crossplatform 10974 * @atomicservice 10975 * @since 12 10976 */ 10977 FOLLOW_DETENT = 0, 10978 10979 /** 10980 * Sheet change scroll size during the sliding process. 10981 * 10982 * @syscap SystemCapability.ArkUI.ArkUI.Full 10983 * @crossplatform 10984 * @atomicservice 10985 * @since 12 10986 */ 10987 CONTINUOUS = 1, 10988} 10989 10990/** 10991 * Define the mode of sheet how to avoid keyboard. 10992 * 10993 * @enum { number } 10994 * @syscap SystemCapability.ArkUI.ArkUI.Full 10995 * @crossplatform 10996 * @atomicservice 10997 * @since 13 10998 */ 10999declare enum SheetKeyboardAvoidMode { 11000 /** 11001 * Sheet will not aovid keyboard. 11002 * 11003 * @syscap SystemCapability.ArkUI.ArkUI.Full 11004 * @crossplatform 11005 * @atomicservice 11006 * @since 13 11007 */ 11008 NONE = 0, 11009 11010 /** 11011 * Firstly sheet will avoid keyboard by changing its height. 11012 * And then sheet will avoid by resizing after reaching its maximum height. 11013 * 11014 * @syscap SystemCapability.ArkUI.ArkUI.Full 11015 * @crossplatform 11016 * @atomicservice 11017 * @since 13 11018 */ 11019 TRANSLATE_AND_RESIZE = 1, 11020 11021 /** 11022 * Sheet will only avoid keyboard by resizing the content. 11023 * 11024 * @syscap SystemCapability.ArkUI.ArkUI.Full 11025 * @crossplatform 11026 * @atomicservice 11027 * @since 13 11028 */ 11029 RESIZE_ONLY = 2, 11030 11031 /** 11032 * Firstly sheet will avoid keyboard by changing its height. 11033 * And then sheet will avoid keyboard by scrolling after reaching its maximum height. 11034 * 11035 * @syscap SystemCapability.ArkUI.ArkUI.Full 11036 * @crossplatform 11037 * @atomicservice 11038 * @since 13 11039 */ 11040 TRANSLATE_AND_SCROLL = 3, 11041} 11042 11043/** 11044 * Component sheet dismiss 11045 * 11046 * @interface SheetDismiss 11047 * @syscap SystemCapability.ArkUI.ArkUI.Full 11048 * @crossplatform 11049 * @since 11 11050 */ 11051/** 11052 * Component sheet dismiss 11053 * 11054 * @interface SheetDismiss 11055 * @syscap SystemCapability.ArkUI.ArkUI.Full 11056 * @crossplatform 11057 * @atomicservice 11058 * @since 12 11059 */ 11060declare interface SheetDismiss { 11061 /** 11062 * Defines sheet dismiss function 11063 * 11064 * @type { function } 11065 * @syscap SystemCapability.ArkUI.ArkUI.Full 11066 * @crossplatform 11067 * @since 11 11068 */ 11069 /** 11070 * Defines sheet dismiss function 11071 * 11072 * @type { function } 11073 * @syscap SystemCapability.ArkUI.ArkUI.Full 11074 * @crossplatform 11075 * @atomicservice 11076 * @since 12 11077 */ 11078 dismiss: () => void; 11079} 11080 11081/** 11082 * Component sheet dismiss 11083 * 11084 * @interface DismissSheetAction 11085 * @syscap SystemCapability.ArkUI.ArkUI.Full 11086 * @crossplatform 11087 * @atomicservice 11088 * @since 12 11089 */ 11090declare interface DismissSheetAction { 11091 11092 /** 11093 * Defines sheet dismiss function 11094 * 11095 * @type { Callback<void> } 11096 * @syscap SystemCapability.ArkUI.ArkUI.Full 11097 * @crossplatform 11098 * @atomicservice 11099 * @since 12 11100 */ 11101 dismiss: Callback<void>; 11102 11103 /** 11104 * Dismiss reason type. 11105 * 11106 * @type { DismissReason } 11107 * @syscap SystemCapability.ArkUI.ArkUI.Full 11108 * @crossplatform 11109 * @atomicservice 11110 * @since 12 11111 */ 11112 reason: DismissReason; 11113} 11114 11115/** 11116 * Defines sheet spring back action 11117 * 11118 * @interface SpringBackAction 11119 * @syscap SystemCapability.ArkUI.ArkUI.Full 11120 * @crossplatform 11121 * @atomicservice 11122 * @since 12 11123 */ 11124declare interface SpringBackAction { 11125 /** 11126 * Defines spring back function 11127 * 11128 * @type { Callback<void> } 11129 * @syscap SystemCapability.ArkUI.ArkUI.Full 11130 * @crossplatform 11131 * @atomicservice 11132 * @since 12 11133 */ 11134 springBack: Callback<void>; 11135} 11136 11137/** 11138 * Component sheet options 11139 * 11140 * @interface SheetOptions 11141 * @syscap SystemCapability.ArkUI.ArkUI.Full 11142 * @crossplatform 11143 * @since 10 11144 */ 11145/** 11146 * Component sheet options 11147 * 11148 * @interface SheetOptions 11149 * @syscap SystemCapability.ArkUI.ArkUI.Full 11150 * @crossplatform 11151 * @atomicservice 11152 * @since 11 11153 */ 11154declare interface SheetOptions extends BindOptions { 11155 /** 11156 * Defines sheet height 11157 * 11158 * @type { ?(SheetSize | Length) } 11159 * @default Sheet.LARGE 11160 * @syscap SystemCapability.ArkUI.ArkUI.Full 11161 * @crossplatform 11162 * @since 10 11163 */ 11164 /** 11165 * Defines sheet height 11166 * 11167 * @type { ?(SheetSize | Length) } 11168 * @default Sheet.LARGE 11169 * @syscap SystemCapability.ArkUI.ArkUI.Full 11170 * @crossplatform 11171 * @atomicservice 11172 * @since 11 11173 */ 11174 height?: SheetSize | Length; 11175 11176 /** 11177 * Defines whether the control bar is displayed. 11178 * 11179 * @type { ?boolean } 11180 * @default true 11181 * @syscap SystemCapability.ArkUI.ArkUI.Full 11182 * @crossplatform 11183 * @since 10 11184 */ 11185 /** 11186 * Defines whether the control bar is displayed. 11187 * 11188 * @type { ?boolean } 11189 * @default true 11190 * @syscap SystemCapability.ArkUI.ArkUI.Full 11191 * @crossplatform 11192 * @atomicservice 11193 * @since 11 11194 */ 11195 dragBar?: boolean; 11196 11197 /** 11198 * Defines sheet maskColor 11199 * 11200 * @type { ?ResourceColor } 11201 * @syscap SystemCapability.ArkUI.ArkUI.Full 11202 * @crossplatform 11203 * @since 10 11204 */ 11205 /** 11206 * Defines sheet maskColor 11207 * 11208 * @type { ?ResourceColor } 11209 * @syscap SystemCapability.ArkUI.ArkUI.Full 11210 * @crossplatform 11211 * @atomicservice 11212 * @since 11 11213 */ 11214 maskColor?: ResourceColor; 11215 11216 /** 11217 * Defines sheet detents 11218 * 11219 * @type { ?[(SheetSize | Length), (SheetSize | Length)?, (SheetSize | Length)?] } 11220 * @syscap SystemCapability.ArkUI.ArkUI.Full 11221 * @crossplatform 11222 * @since 11 11223 */ 11224 /** 11225 * Defines sheet detents 11226 * 11227 * @type { ?[(SheetSize | Length), (SheetSize | Length)?, (SheetSize | Length)?] } 11228 * @syscap SystemCapability.ArkUI.ArkUI.Full 11229 * @crossplatform 11230 * @atomicservice 11231 * @since 12 11232 */ 11233 detents?: [(SheetSize | Length), (SheetSize | Length)?, (SheetSize | Length)?]; 11234 11235 /** 11236 * Defines sheet background blur Style 11237 * 11238 * @type { ?BlurStyle } 11239 * @default BlurStyle.NONE 11240 * @syscap SystemCapability.ArkUI.ArkUI.Full 11241 * @crossplatform 11242 * @since 11 11243 */ 11244 /** 11245 * Defines sheet background blur Style 11246 * 11247 * @type { ?BlurStyle } 11248 * @default BlurStyle.NONE 11249 * @syscap SystemCapability.ArkUI.ArkUI.Full 11250 * @crossplatform 11251 * @atomicservice 11252 * @since 12 11253 */ 11254 blurStyle?: BlurStyle; 11255 11256 /** 11257 * Defines whether the close icon is displayed 11258 * 11259 * @type { ?(boolean | Resource) } 11260 * @default true 11261 * @syscap SystemCapability.ArkUI.ArkUI.Full 11262 * @crossplatform 11263 * @since 11 11264 */ 11265 /** 11266 * Defines whether the close icon is displayed 11267 * 11268 * @type { ?(boolean | Resource) } 11269 * @default true 11270 * @syscap SystemCapability.ArkUI.ArkUI.Full 11271 * @crossplatform 11272 * @atomicservice 11273 * @since 12 11274 */ 11275 showClose?: boolean | Resource; 11276 11277 /** 11278 * Defines the sheet prefer type 11279 * 11280 * @type { ?(SheetType.CENTER | SheetType.POPUP) } 11281 * @syscap SystemCapability.ArkUI.ArkUI.Full 11282 * @crossplatform 11283 * @since 11 11284 */ 11285 /** 11286 * Defines the sheet prefer type 11287 * 11288 * @type { ?SheetType } 11289 * @syscap SystemCapability.ArkUI.ArkUI.Full 11290 * @crossplatform 11291 * @atomicservice 11292 * @since 12 11293 */ 11294 preferType?: SheetType; 11295 11296 /** 11297 * Defines the sheet title 11298 * 11299 * @type { ?(SheetTitleOptions | CustomBuilder) } 11300 * @syscap SystemCapability.ArkUI.ArkUI.Full 11301 * @crossplatform 11302 * @since 11 11303 */ 11304 /** 11305 * Defines the sheet title 11306 * 11307 * @type { ?(SheetTitleOptions | CustomBuilder) } 11308 * @syscap SystemCapability.ArkUI.ArkUI.Full 11309 * @crossplatform 11310 * @atomicservice 11311 * @since 12 11312 */ 11313 title?: SheetTitleOptions | CustomBuilder; 11314 11315 /** 11316 * Callback function when the sheet interactive dismiss 11317 * 11318 * @type { ?function } 11319 * @syscap SystemCapability.ArkUI.ArkUI.Full 11320 * @crossplatform 11321 * @since 11 11322 */ 11323 /** 11324 * Callback function when the sheet interactive dismiss 11325 * 11326 * @type { ?function } 11327 * @syscap SystemCapability.ArkUI.ArkUI.Full 11328 * @crossplatform 11329 * @atomicservice 11330 * @since 12 11331 */ 11332 shouldDismiss?: (sheetDismiss: SheetDismiss) => void; 11333 11334 /** 11335 * Callback function when the sheet will dismiss 11336 * 11337 * @type { ?Callback<DismissSheetAction> } 11338 * @syscap SystemCapability.ArkUI.ArkUI.Full 11339 * @crossplatform 11340 * @atomicservice 11341 * @since 12 11342 */ 11343 onWillDismiss?: Callback<DismissSheetAction>; 11344 11345 /** 11346 * Sheet springs back callback when dismiss 11347 * 11348 * @type { ?Callback<SpringBackAction> } 11349 * @syscap SystemCapability.ArkUI.ArkUI.Full 11350 * @crossplatform 11351 * @atomicservice 11352 * @since 12 11353 */ 11354 onWillSpringBackWhenDismiss?: Callback<SpringBackAction>; 11355 11356 /** 11357 * Set whether interaction is allowed outside the sheet 11358 * 11359 * @type { ?boolean } 11360 * @default false 11361 * @syscap SystemCapability.ArkUI.ArkUI.Full 11362 * @crossplatform 11363 * @since 11 11364 */ 11365 /** 11366 * Set whether interaction is allowed outside the sheet 11367 * 11368 * @type { ?boolean } 11369 * @default false 11370 * @syscap SystemCapability.ArkUI.ArkUI.Full 11371 * @crossplatform 11372 * @atomicservice 11373 * @since 12 11374 */ 11375 enableOutsideInteractive?: boolean; 11376 11377 /** 11378 * Defines the sheet's width. 11379 * 11380 * @type { ?Dimension } 11381 * @syscap SystemCapability.ArkUI.ArkUI.Full 11382 * @crossplatform 11383 * @atomicservice 11384 * @since 12 11385 */ 11386 width?: Dimension; 11387 11388 /** 11389 * Defines the sheet's border width. 11390 * 11391 * @type { ?(Dimension | EdgeWidths | LocalizedEdgeWidths) } 11392 * @syscap SystemCapability.ArkUI.ArkUI.Full 11393 * @crossplatform 11394 * @atomicservice 11395 * @since 12 11396 */ 11397 borderWidth?: Dimension | EdgeWidths | LocalizedEdgeWidths; 11398 11399 /** 11400 * Defines the sheet's border color. 11401 * 11402 * @type { ?(ResourceColor | EdgeColors | LocalizedEdgeColors) } 11403 * @syscap SystemCapability.ArkUI.ArkUI.Full 11404 * @crossplatform 11405 * @atomicservice 11406 * @since 12 11407 */ 11408 borderColor?: ResourceColor | EdgeColors | LocalizedEdgeColors; 11409 11410 /** 11411 * Defines the sheet's border style. 11412 * 11413 * @type { ?(BorderStyle | EdgeStyles) } 11414 * @syscap SystemCapability.ArkUI.ArkUI.Full 11415 * @crossplatform 11416 * @atomicservice 11417 * @since 12 11418 */ 11419 borderStyle?: BorderStyle | EdgeStyles; 11420 11421 /** 11422 * Defines the sheet's shadow. 11423 * 11424 * @type { ?(ShadowOptions | ShadowStyle) } 11425 * @syscap SystemCapability.ArkUI.ArkUI.Full 11426 * @crossplatform 11427 * @atomicservice 11428 * @since 12 11429 */ 11430 shadow?: ShadowOptions | ShadowStyle; 11431 11432 /** 11433 * Called when height of the sheet is changed 11434 * 11435 * @type { ?Callback<number> } 11436 * @syscap SystemCapability.ArkUI.ArkUI.Full 11437 * @crossplatform 11438 * @atomicservice 11439 * @since 12 11440 */ 11441 onHeightDidChange?: Callback<number>; 11442 11443 /** 11444 * Determine the level sheet shows, whether sheet should be displayed within the page 11445 * 11446 * @type { ?SheetMode } 11447 * @default SheetMode.OVERLAY 11448 * @syscap SystemCapability.ArkUI.ArkUI.Full 11449 * @crossplatform 11450 * @atomicservice 11451 * @since 12 11452 */ 11453 mode?: SheetMode; 11454 11455 /** 11456 * Determine sheet scroll size mode. 11457 * 11458 * @type { ?ScrollSizeMode } 11459 * @default ScrollSizeMode.FELLOW_DETEND 11460 * @syscap SystemCapability.ArkUI.ArkUI.Full 11461 * @crossplatform 11462 * @atomicservice 11463 * @since 12 11464 */ 11465 scrollSizeMode?: ScrollSizeMode; 11466 11467 /** 11468 * Called when detents of the sheet changed 11469 * 11470 * @type { ?Callback<number> } 11471 * @syscap SystemCapability.ArkUI.ArkUI.Full 11472 * @crossplatform 11473 * @atomicservice 11474 * @since 12 11475 */ 11476 onDetentsDidChange?: Callback<number>; 11477 11478 /** 11479 * Called when width of the sheet changed 11480 * 11481 * @type { ?Callback<number> } 11482 * @syscap SystemCapability.ArkUI.ArkUI.Full 11483 * @crossplatform 11484 * @atomicservice 11485 * @since 12 11486 */ 11487 onWidthDidChange?: Callback<number>; 11488 11489 /** 11490 * Called when the sheet type changed 11491 * 11492 * @type { ?Callback<SheetType> } 11493 * @syscap SystemCapability.ArkUI.ArkUI.Full 11494 * @crossplatform 11495 * @atomicservice 11496 * @since 12 11497 */ 11498 onTypeDidChange?: Callback<SheetType>; 11499 11500 /** 11501 * The UIContext that the sheet belongs to 11502 * 11503 * @type { ?UIContext } 11504 * @syscap SystemCapability.ArkUI.ArkUI.Full 11505 * @crossplatform 11506 * @atomicservice 11507 * @since 12 11508 */ 11509 uiContext?: UIContext; 11510 11511 /** 11512 * Determine the mode of sheet how to avoid keyboard. 11513 * 11514 * @type { ?SheetKeyboardAvoidMode } 11515 * @default SheetKeyboardAvoidMode.TRANSLATE_AND_SCROLL 11516 * @syscap SystemCapability.ArkUI.ArkUI.Full 11517 * @crossplatform 11518 * @atomicservice 11519 * @since 13 11520 */ 11521 keyboardAvoidMode?: SheetKeyboardAvoidMode; 11522} 11523 11524/** 11525 * Component State Styles. 11526 * 11527 * @interface StateStyles 11528 * @syscap SystemCapability.ArkUI.ArkUI.Full 11529 * @since 8 11530 */ 11531/** 11532 * Component State Styles. 11533 * 11534 * @interface StateStyles 11535 * @syscap SystemCapability.ArkUI.ArkUI.Full 11536 * @form 11537 * @since 9 11538 */ 11539/** 11540 * Component State Styles. 11541 * 11542 * @interface StateStyles 11543 * @syscap SystemCapability.ArkUI.ArkUI.Full 11544 * @crossplatform 11545 * @form 11546 * @since 10 11547 */ 11548/** 11549 * Component State Styles. 11550 * 11551 * @interface StateStyles 11552 * @syscap SystemCapability.ArkUI.ArkUI.Full 11553 * @crossplatform 11554 * @form 11555 * @atomicservice 11556 * @since 11 11557 */ 11558declare interface StateStyles { 11559 /** 11560 * Defines normal state styles. 11561 * 11562 * @type { ?any } 11563 * @syscap SystemCapability.ArkUI.ArkUI.Full 11564 * @since 8 11565 */ 11566 /** 11567 * Defines normal state styles. 11568 * 11569 * @type { ?any } 11570 * @syscap SystemCapability.ArkUI.ArkUI.Full 11571 * @form 11572 * @since 9 11573 */ 11574 /** 11575 * Defines normal state styles. 11576 * 11577 * @type { ?any } 11578 * @syscap SystemCapability.ArkUI.ArkUI.Full 11579 * @crossplatform 11580 * @form 11581 * @since 10 11582 */ 11583 /** 11584 * Defines normal state styles. 11585 * 11586 * @type { ?any } 11587 * @syscap SystemCapability.ArkUI.ArkUI.Full 11588 * @crossplatform 11589 * @form 11590 * @atomicservice 11591 * @since 11 11592 */ 11593 normal?: any; 11594 11595 /** 11596 * Defines pressed state styles. 11597 * 11598 * @type { ?any } 11599 * @syscap SystemCapability.ArkUI.ArkUI.Full 11600 * @since 8 11601 */ 11602 /** 11603 * Defines pressed state styles. 11604 * 11605 * @type { ?any } 11606 * @syscap SystemCapability.ArkUI.ArkUI.Full 11607 * @form 11608 * @since 9 11609 */ 11610 /** 11611 * Defines pressed state styles. 11612 * 11613 * @type { ?any } 11614 * @syscap SystemCapability.ArkUI.ArkUI.Full 11615 * @crossplatform 11616 * @form 11617 * @since 10 11618 */ 11619 /** 11620 * Defines pressed state styles. 11621 * 11622 * @type { ?any } 11623 * @syscap SystemCapability.ArkUI.ArkUI.Full 11624 * @crossplatform 11625 * @form 11626 * @atomicservice 11627 * @since 11 11628 */ 11629 pressed?: any; 11630 11631 /** 11632 * Defines disabled state styles. 11633 * 11634 * @type { ?any } 11635 * @syscap SystemCapability.ArkUI.ArkUI.Full 11636 * @since 8 11637 */ 11638 /** 11639 * Defines disabled state styles. 11640 * 11641 * @type { ?any } 11642 * @syscap SystemCapability.ArkUI.ArkUI.Full 11643 * @form 11644 * @since 9 11645 */ 11646 /** 11647 * Defines disabled state styles. 11648 * 11649 * @type { ?any } 11650 * @syscap SystemCapability.ArkUI.ArkUI.Full 11651 * @crossplatform 11652 * @form 11653 * @since 10 11654 */ 11655 /** 11656 * Defines disabled state styles. 11657 * 11658 * @type { ?any } 11659 * @syscap SystemCapability.ArkUI.ArkUI.Full 11660 * @crossplatform 11661 * @form 11662 * @atomicservice 11663 * @since 11 11664 */ 11665 disabled?: any; 11666 11667 /** 11668 * Defines focused state styles. 11669 * 11670 * @type { ?any } 11671 * @syscap SystemCapability.ArkUI.ArkUI.Full 11672 * @since 8 11673 */ 11674 /** 11675 * Defines focused state styles. 11676 * 11677 * @type { ?any } 11678 * @syscap SystemCapability.ArkUI.ArkUI.Full 11679 * @form 11680 * @since 9 11681 */ 11682 /** 11683 * Defines focused state styles. 11684 * 11685 * @type { ?any } 11686 * @syscap SystemCapability.ArkUI.ArkUI.Full 11687 * @crossplatform 11688 * @form 11689 * @since 10 11690 */ 11691 /** 11692 * Defines focused state styles. 11693 * 11694 * @type { ?any } 11695 * @syscap SystemCapability.ArkUI.ArkUI.Full 11696 * @crossplatform 11697 * @form 11698 * @atomicservice 11699 * @since 11 11700 */ 11701 focused?: any; 11702 11703 /** 11704 * Defines clicked state styles. 11705 * 11706 * @type { ?any } 11707 * @syscap SystemCapability.ArkUI.ArkUI.Full 11708 * @since 8 11709 */ 11710 /** 11711 * Defines clicked state styles. 11712 * 11713 * @type { ?any } 11714 * @syscap SystemCapability.ArkUI.ArkUI.Full 11715 * @form 11716 * @since 9 11717 */ 11718 /** 11719 * Defines clicked state styles. 11720 * 11721 * @type { ?any } 11722 * @syscap SystemCapability.ArkUI.ArkUI.Full 11723 * @crossplatform 11724 * @form 11725 * @since 10 11726 */ 11727 /** 11728 * Defines clicked state styles. 11729 * 11730 * @type { ?any } 11731 * @syscap SystemCapability.ArkUI.ArkUI.Full 11732 * @crossplatform 11733 * @form 11734 * @atomicservice 11735 * @since 11 11736 */ 11737 clicked?: any; 11738 11739 /** 11740 * Defines selected state styles. 11741 * 11742 * @type { ?object } 11743 * @syscap SystemCapability.ArkUI.ArkUI.Full 11744 * @crossplatform 11745 * @form 11746 * @since 10 11747 */ 11748 /** 11749 * Defines selected state styles. 11750 * 11751 * @type { ?object } 11752 * @syscap SystemCapability.ArkUI.ArkUI.Full 11753 * @crossplatform 11754 * @form 11755 * @atomicservice 11756 * @since 11 11757 */ 11758 selected?: object; 11759} 11760 11761/** 11762 * Defines the options of popup message. 11763 * 11764 * @interface PopupMessageOptions 11765 * @syscap SystemCapability.ArkUI.ArkUI.Full 11766 * @crossplatform 11767 * @since 10 11768 */ 11769/** 11770 * Defines the options of popup message. 11771 * 11772 * @interface PopupMessageOptions 11773 * @syscap SystemCapability.ArkUI.ArkUI.Full 11774 * @crossplatform 11775 * @atomicservice 11776 * @since 11 11777 */ 11778declare interface PopupMessageOptions { 11779 /** 11780 * Sets the color of popup text. 11781 * 11782 * @type { ?ResourceColor } 11783 * @syscap SystemCapability.ArkUI.ArkUI.Full 11784 * @crossplatform 11785 * @since 10 11786 */ 11787 /** 11788 * Sets the color of popup text. 11789 * 11790 * @type { ?ResourceColor } 11791 * @syscap SystemCapability.ArkUI.ArkUI.Full 11792 * @crossplatform 11793 * @atomicservice 11794 * @since 11 11795 */ 11796 textColor?: ResourceColor; 11797 11798 /** 11799 * Sets the font of popup text. 11800 * 11801 * @type { ?Font } 11802 * @syscap SystemCapability.ArkUI.ArkUI.Full 11803 * @crossplatform 11804 * @since 10 11805 */ 11806 /** 11807 * Sets the font of popup text. 11808 * 11809 * @type { ?Font } 11810 * @syscap SystemCapability.ArkUI.ArkUI.Full 11811 * @crossplatform 11812 * @atomicservice 11813 * @since 11 11814 */ 11815 font?: Font; 11816} 11817 11818/** 11819 * Dismiss reason type. 11820 * 11821 * @enum { number } 11822 * @syscap SystemCapability.ArkUI.ArkUI.Full 11823 * @crossplatform 11824 * @atomicservice 11825 * @since 12 11826 */ 11827declare enum DismissReason { 11828 /** 11829 * Press back 11830 * 11831 * @syscap SystemCapability.ArkUI.ArkUI.Full 11832 * @crossplatform 11833 * @atomicservice 11834 * @since 12 11835 */ 11836 PRESS_BACK = 0, 11837 11838 /** 11839 * Touch component outside 11840 * 11841 * @syscap SystemCapability.ArkUI.ArkUI.Full 11842 * @crossplatform 11843 * @atomicservice 11844 * @since 12 11845 */ 11846 TOUCH_OUTSIDE = 1, 11847 11848 /** 11849 * Close button 11850 * 11851 * @syscap SystemCapability.ArkUI.ArkUI.Full 11852 * @crossplatform 11853 * @atomicservice 11854 * @since 12 11855 */ 11856 CLOSE_BUTTON = 2, 11857 11858 /** 11859 * Slide down 11860 * 11861 * @syscap SystemCapability.ArkUI.ArkUI.Full 11862 * @crossplatform 11863 * @atomicservice 11864 * @since 12 11865 */ 11866 SLIDE_DOWN = 3 11867} 11868 11869/** 11870 * Component popup dismiss 11871 * 11872 * @interface DismissPopupAction 11873 * @syscap SystemCapability.ArkUI.ArkUI.Full 11874 * @crossplatform 11875 * @atomicservice 11876 * @since 12 11877 */ 11878declare interface DismissPopupAction { 11879 /** 11880 * Defines popup dismiss function 11881 * 11882 * @type { Callback<void> } 11883 * @syscap SystemCapability.ArkUI.ArkUI.Full 11884 * @crossplatform 11885 * @atomicservice 11886 * @since 12 11887 */ 11888 dismiss: Callback<void>; 11889 11890 /** 11891 * Defines popup dismiss reason 11892 * 11893 * @type { DismissReason } 11894 * @syscap SystemCapability.ArkUI.ArkUI.Full 11895 * @crossplatform 11896 * @atomicservice 11897 * @since 12 11898 */ 11899 reason: DismissReason; 11900} 11901 11902/** 11903 * Defines the popup options. 11904 * 11905 * @interface PopupOptions 11906 * @syscap SystemCapability.ArkUI.ArkUI.Full 11907 * @since 7 11908 */ 11909/** 11910 * Defines the popup options. 11911 * 11912 * @interface PopupOptions 11913 * @syscap SystemCapability.ArkUI.ArkUI.Full 11914 * @crossplatform 11915 * @since 10 11916 */ 11917/** 11918 * Defines the popup options. 11919 * 11920 * @interface PopupOptions 11921 * @syscap SystemCapability.ArkUI.ArkUI.Full 11922 * @crossplatform 11923 * @atomicservice 11924 * @since 11 11925 */ 11926declare interface PopupOptions { 11927 /** 11928 * Information in the pop-up window. 11929 * 11930 * @type { string } 11931 * @syscap SystemCapability.ArkUI.ArkUI.Full 11932 * @since 7 11933 */ 11934 /** 11935 * Information in the pop-up window. 11936 * 11937 * @type { string } 11938 * @syscap SystemCapability.ArkUI.ArkUI.Full 11939 * @crossplatform 11940 * @since 10 11941 */ 11942 /** 11943 * Information in the pop-up window. 11944 * 11945 * @type { string } 11946 * @syscap SystemCapability.ArkUI.ArkUI.Full 11947 * @crossplatform 11948 * @atomicservice 11949 * @since 11 11950 */ 11951 message: string; 11952 11953 /** 11954 * placement On Top 11955 * 11956 * @type { ?boolean } 11957 * @syscap SystemCapability.ArkUI.ArkUI.Full 11958 * @since 7 11959 * @deprecated since 10 11960 * @useinstead PopupOptions#placement 11961 */ 11962 placementOnTop?: boolean; 11963 11964 /** 11965 * The placement of popup. 11966 * Supports all positions defined in Placement. 11967 * 11968 * @type { ?Placement } 11969 * @default Placement.Bottom 11970 * @syscap SystemCapability.ArkUI.ArkUI.Full 11971 * @crossplatform 11972 * @since 10 11973 */ 11974 /** 11975 * The placement of popup. 11976 * Supports all positions defined in Placement. 11977 * 11978 * @type { ?Placement } 11979 * @default Placement.Bottom 11980 * @syscap SystemCapability.ArkUI.ArkUI.Full 11981 * @crossplatform 11982 * @atomicservice 11983 * @since 11 11984 */ 11985 placement?: Placement; 11986 11987 /** 11988 * The first button. 11989 * 11990 * @type { ?object } 11991 * @syscap SystemCapability.ArkUI.ArkUI.Full 11992 * @since 7 11993 */ 11994 /** 11995 * The first button. 11996 * 11997 * @type { ?object } 11998 * @syscap SystemCapability.ArkUI.ArkUI.Full 11999 * @crossplatform 12000 * @since 10 12001 */ 12002 /** 12003 * The first button. 12004 * 12005 * @type { ?object } 12006 * @syscap SystemCapability.ArkUI.ArkUI.Full 12007 * @crossplatform 12008 * @atomicservice 12009 * @since 11 12010 */ 12011 primaryButton?: { 12012 /** 12013 * Button text value 12014 * 12015 * @type { string } 12016 * @syscap SystemCapability.ArkUI.ArkUI.Full 12017 * @since 7 12018 */ 12019 /** 12020 * Button text value 12021 * 12022 * @type { string } 12023 * @syscap SystemCapability.ArkUI.ArkUI.Full 12024 * @crossplatform 12025 * @since 10 12026 */ 12027 /** 12028 * Button text value 12029 * 12030 * @type { string } 12031 * @syscap SystemCapability.ArkUI.ArkUI.Full 12032 * @crossplatform 12033 * @atomicservice 12034 * @since 11 12035 */ 12036 value: string; 12037 12038 /** 12039 * action 12040 * 12041 * @type { function } 12042 * @syscap SystemCapability.ArkUI.ArkUI.Full 12043 * @since 7 12044 */ 12045 /** 12046 * action 12047 * 12048 * @type { function } 12049 * @syscap SystemCapability.ArkUI.ArkUI.Full 12050 * @crossplatform 12051 * @since 10 12052 */ 12053 /** 12054 * action 12055 * 12056 * @type { function } 12057 * @syscap SystemCapability.ArkUI.ArkUI.Full 12058 * @crossplatform 12059 * @atomicservice 12060 * @since 11 12061 */ 12062 action: () => void; 12063 }; 12064 12065 /** 12066 * The second button. 12067 * 12068 * @type { ?object } 12069 * @syscap SystemCapability.ArkUI.ArkUI.Full 12070 * @since 7 12071 */ 12072 /** 12073 * The second button. 12074 * 12075 * @type { ?object } 12076 * @syscap SystemCapability.ArkUI.ArkUI.Full 12077 * @crossplatform 12078 * @since 10 12079 */ 12080 /** 12081 * The second button. 12082 * 12083 * @type { ?object } 12084 * @syscap SystemCapability.ArkUI.ArkUI.Full 12085 * @crossplatform 12086 * @atomicservice 12087 * @since 11 12088 */ 12089 secondaryButton?: { 12090 /** 12091 * Button text value 12092 * 12093 * @type { string } 12094 * @syscap SystemCapability.ArkUI.ArkUI.Full 12095 * @since 7 12096 */ 12097 /** 12098 * Button text value 12099 * 12100 * @type { string } 12101 * @syscap SystemCapability.ArkUI.ArkUI.Full 12102 * @crossplatform 12103 * @since 10 12104 */ 12105 /** 12106 * Button text value 12107 * 12108 * @type { string } 12109 * @syscap SystemCapability.ArkUI.ArkUI.Full 12110 * @crossplatform 12111 * @atomicservice 12112 * @since 11 12113 */ 12114 value: string; 12115 12116 /** 12117 * action 12118 * 12119 * @type { function } 12120 * @syscap SystemCapability.ArkUI.ArkUI.Full 12121 * @since 7 12122 */ 12123 /** 12124 * action 12125 * 12126 * @type { function } 12127 * @syscap SystemCapability.ArkUI.ArkUI.Full 12128 * @crossplatform 12129 * @since 10 12130 */ 12131 /** 12132 * action 12133 * 12134 * @type { function } 12135 * @syscap SystemCapability.ArkUI.ArkUI.Full 12136 * @crossplatform 12137 * @atomicservice 12138 * @since 11 12139 */ 12140 action: () => void; 12141 }; 12142 12143 /** 12144 * on State Change 12145 * 12146 * @type { ?function } 12147 * @syscap SystemCapability.ArkUI.ArkUI.Full 12148 * @since 7 12149 */ 12150 /** 12151 * on State Change 12152 * 12153 * @type { ?function } 12154 * @syscap SystemCapability.ArkUI.ArkUI.Full 12155 * @crossplatform 12156 * @since 10 12157 */ 12158 /** 12159 * on State Change 12160 * 12161 * @type { ?function } 12162 * @syscap SystemCapability.ArkUI.ArkUI.Full 12163 * @crossplatform 12164 * @atomicservice 12165 * @since 11 12166 */ 12167 onStateChange?: (event: { 12168 /** 12169 * is Visible. 12170 * 12171 * @type { boolean } 12172 * @syscap SystemCapability.ArkUI.ArkUI.Full 12173 * @crossplatform 12174 * @since 10 12175 */ 12176 /** 12177 * is Visible. 12178 * 12179 * @type { boolean } 12180 * @syscap SystemCapability.ArkUI.ArkUI.Full 12181 * @crossplatform 12182 * @atomicservice 12183 * @since 11 12184 */ 12185 isVisible: boolean 12186 }) => void; 12187 12188 /** 12189 * The offset of the sharp corner of popup. 12190 * 12191 * @type { ?Length } 12192 * @syscap SystemCapability.ArkUI.ArkUI.Full 12193 * @since 9 12194 */ 12195 /** 12196 * The offset of the sharp corner of popup. 12197 * 12198 * @type { ?Length } 12199 * @syscap SystemCapability.ArkUI.ArkUI.Full 12200 * @crossplatform 12201 * @since 10 12202 */ 12203 /** 12204 * The offset of the sharp corner of popup. 12205 * 12206 * @type { ?Length } 12207 * @syscap SystemCapability.ArkUI.ArkUI.Full 12208 * @crossplatform 12209 * @atomicservice 12210 * @since 11 12211 */ 12212 arrowOffset?: Length; 12213 12214 /** 12215 * Whether to display in the sub window. 12216 * 12217 * @type { ?boolean } 12218 * @syscap SystemCapability.ArkUI.ArkUI.Full 12219 * @since 9 12220 */ 12221 /** 12222 * Whether to display in the sub window. 12223 * 12224 * @type { ?boolean } 12225 * @syscap SystemCapability.ArkUI.ArkUI.Full 12226 * @crossplatform 12227 * @since 10 12228 */ 12229 /** 12230 * Whether to display in the sub window. 12231 * 12232 * @type { ?boolean } 12233 * @syscap SystemCapability.ArkUI.ArkUI.Full 12234 * @crossplatform 12235 * @atomicservice 12236 * @since 11 12237 */ 12238 showInSubWindow?: boolean; 12239 12240 /** 12241 * The mask to block gesture events of popup. 12242 * When mask is set false, gesture events are not blocked. 12243 * When mask is set true, gesture events are blocked and mask color is transparent. 12244 * 12245 * @type { ?(boolean | { color: ResourceColor }) } 12246 * @syscap SystemCapability.ArkUI.ArkUI.Full 12247 * @crossplatform 12248 * @since 10 12249 */ 12250 /** 12251 * The mask to block gesture events of popup. 12252 * When mask is set false, gesture events are not blocked. 12253 * When mask is set true, gesture events are blocked and mask color is transparent. 12254 * 12255 * @type { ?(boolean | { color: ResourceColor }) } 12256 * @syscap SystemCapability.ArkUI.ArkUI.Full 12257 * @crossplatform 12258 * @atomicservice 12259 * @since 11 12260 */ 12261 mask?: boolean | { color: ResourceColor }; 12262 12263 /** 12264 * Sets the options of popup message. 12265 * 12266 * @type { ?PopupMessageOptions } 12267 * @syscap SystemCapability.ArkUI.ArkUI.Full 12268 * @crossplatform 12269 * @since 10 12270 */ 12271 /** 12272 * Sets the options of popup message. 12273 * 12274 * @type { ?PopupMessageOptions } 12275 * @syscap SystemCapability.ArkUI.ArkUI.Full 12276 * @crossplatform 12277 * @atomicservice 12278 * @since 11 12279 */ 12280 messageOptions?: PopupMessageOptions 12281 12282 /** 12283 * Sets the space of between the popup and target. 12284 * 12285 * @type { ?Length } 12286 * @syscap SystemCapability.ArkUI.ArkUI.Full 12287 * @crossplatform 12288 * @since 10 12289 */ 12290 /** 12291 * Sets the space of between the popup and target. 12292 * 12293 * @type { ?Length } 12294 * @syscap SystemCapability.ArkUI.ArkUI.Full 12295 * @crossplatform 12296 * @atomicservice 12297 * @since 11 12298 */ 12299 targetSpace?: Length 12300 12301 /** 12302 * whether show arrow 12303 * 12304 * @type { ?boolean } 12305 * @default true 12306 * @syscap SystemCapability.ArkUI.ArkUI.Full 12307 * @since 10 12308 */ 12309 /** 12310 * whether show arrow 12311 * 12312 * @type { ?boolean } 12313 * @default true 12314 * @syscap SystemCapability.ArkUI.ArkUI.Full 12315 * @crossplatform 12316 * @atomicservice 12317 * @since 11 12318 */ 12319 enableArrow?: boolean; 12320 /** 12321 * Sets the position offset of the popup. 12322 * 12323 * @type { ?Position } 12324 * @syscap SystemCapability.ArkUI.ArkUI.Full 12325 * @crossplatform 12326 * @since 10 12327 */ 12328 /** 12329 * Sets the position offset of the popup. 12330 * 12331 * @type { ?Position } 12332 * @syscap SystemCapability.ArkUI.ArkUI.Full 12333 * @crossplatform 12334 * @atomicservice 12335 * @since 11 12336 */ 12337 offset?: Position 12338 12339 /** 12340 * Set the background color of the popup. 12341 * 12342 * @type { ?(Color | string | Resource | number) } 12343 * @syscap SystemCapability.ArkUI.ArkUI.Full 12344 * @crossplatform 12345 * @since 11 12346 */ 12347 /** 12348 * Set the background color of the popup. 12349 * 12350 * @type { ?(Color | string | Resource | number) } 12351 * @syscap SystemCapability.ArkUI.ArkUI.Full 12352 * @crossplatform 12353 * @atomicservice 12354 * @since 12 12355 */ 12356 popupColor?: Color | string | Resource | number; 12357 12358 /** 12359 * Whether hide popup when click mask 12360 * 12361 * @type { ?boolean } 12362 * @default true 12363 * @syscap SystemCapability.ArkUI.ArkUI.Full 12364 * @crossplatform 12365 * @since 11 12366 */ 12367 /** 12368 * Whether hide popup when click mask 12369 * 12370 * @type { ?boolean } 12371 * @default true 12372 * @syscap SystemCapability.ArkUI.ArkUI.Full 12373 * @crossplatform 12374 * @atomicservice 12375 * @since 12 12376 */ 12377 autoCancel?: boolean; 12378 12379 /** 12380 * Set the width of the popup. 12381 * 12382 * @type { ?Dimension } 12383 * @syscap SystemCapability.ArkUI.ArkUI.Full 12384 * @crossplatform 12385 * @since 11 12386 */ 12387 /** 12388 * Set the width of the popup. 12389 * 12390 * @type { ?Dimension } 12391 * @syscap SystemCapability.ArkUI.ArkUI.Full 12392 * @crossplatform 12393 * @atomicservice 12394 * @since 12 12395 */ 12396 width?: Dimension; 12397 12398 /** 12399 * The position of the sharp corner of popup. 12400 * 12401 * @type { ?ArrowPointPosition } 12402 * @syscap SystemCapability.ArkUI.ArkUI.Full 12403 * @crossplatform 12404 * @since 11 12405 */ 12406 /** 12407 * The position of the sharp corner of popup. 12408 * 12409 * @type { ?ArrowPointPosition } 12410 * @syscap SystemCapability.ArkUI.ArkUI.Full 12411 * @crossplatform 12412 * @atomicservice 12413 * @since 12 12414 */ 12415 arrowPointPosition?: ArrowPointPosition; 12416 12417 /** 12418 * The width of the arrow. 12419 * 12420 * @type { ?Dimension } 12421 * @default 16.0_vp. 12422 * @syscap SystemCapability.ArkUI.ArkUI.Full 12423 * @crossplatform 12424 * @since 11 12425 */ 12426 /** 12427 * The width of the arrow. 12428 * 12429 * @type { ?Dimension } 12430 * @default 16.0_vp. 12431 * @syscap SystemCapability.ArkUI.ArkUI.Full 12432 * @crossplatform 12433 * @atomicservice 12434 * @since 12 12435 */ 12436 arrowWidth?: Dimension; 12437 12438 /** 12439 * The height of the arrow. 12440 * 12441 * @type { ?Dimension } 12442 * @default 8.0_vp. 12443 * @syscap SystemCapability.ArkUI.ArkUI.Full 12444 * @crossplatform 12445 * @since 11 12446 */ 12447 /** 12448 * The height of the arrow. 12449 * 12450 * @type { ?Dimension } 12451 * @default 8.0_vp. 12452 * @syscap SystemCapability.ArkUI.ArkUI.Full 12453 * @crossplatform 12454 * @atomicservice 12455 * @since 12 12456 */ 12457 arrowHeight?: Dimension; 12458 12459 /** 12460 * The round corners of the popup. 12461 * 12462 * @type { ?Dimension } 12463 * @default 20.0_vp. 12464 * @syscap SystemCapability.ArkUI.ArkUI.Full 12465 * @crossplatform 12466 * @since 11 12467 */ 12468 /** 12469 * The round corners of the popup. 12470 * 12471 * @type { ?Dimension } 12472 * @default 20.0_vp. 12473 * @syscap SystemCapability.ArkUI.ArkUI.Full 12474 * @crossplatform 12475 * @atomicservice 12476 * @since 12 12477 */ 12478 radius?: Dimension; 12479 12480 /** 12481 * The style of popup Shadow. 12482 * 12483 * @type { ?(ShadowOptions | ShadowStyle) } 12484 * @default ShadowStyle.OUTER_DEFAULT_MD. 12485 * @syscap SystemCapability.ArkUI.ArkUI.Full 12486 * @crossplatform 12487 * @since 11 12488 */ 12489 /** 12490 * The style of popup Shadow. 12491 * 12492 * @type { ?(ShadowOptions | ShadowStyle) } 12493 * @default ShadowStyle.OUTER_DEFAULT_MD. 12494 * @syscap SystemCapability.ArkUI.ArkUI.Full 12495 * @crossplatform 12496 * @atomicservice 12497 * @since 12 12498 */ 12499 shadow?: ShadowOptions | ShadowStyle; 12500 12501 /** 12502 * Defines popup background blur Style 12503 * 12504 * @type { ?BlurStyle } 12505 * @default BlurStyle.COMPONENT_ULTRA_THICK 12506 * @syscap SystemCapability.ArkUI.ArkUI.Full 12507 * @crossplatform 12508 * @since 11 12509 */ 12510 /** 12511 * Defines popup background blur Style 12512 * 12513 * @type { ?BlurStyle } 12514 * @default BlurStyle.COMPONENT_ULTRA_THICK 12515 * @syscap SystemCapability.ArkUI.ArkUI.Full 12516 * @crossplatform 12517 * @atomicservice 12518 * @since 12 12519 */ 12520 backgroundBlurStyle?: BlurStyle; 12521 12522 /** 12523 * Defines the transition effect of popup opening and closing 12524 * 12525 * @type { ?TransitionEffect } 12526 * @syscap SystemCapability.ArkUI.ArkUI.Full 12527 * @crossplatform 12528 * @atomicservice 12529 * @since 12 12530 */ 12531 transition?: TransitionEffect; 12532 12533 /** 12534 * Callback function when the popup interactive dismiss 12535 * 12536 * @type { ?(boolean | Callback<DismissPopupAction>) } 12537 * @syscap SystemCapability.ArkUI.ArkUI.Full 12538 * @crossplatform 12539 * @atomicservice 12540 * @since 12 12541 */ 12542 onWillDismiss?: boolean | Callback<DismissPopupAction>; 12543 12544 /** 12545 * Determine if popup can follow the target node when it has rotation or scale. 12546 * 12547 * @type { ?boolean } 12548 * @default false 12549 * @syscap SystemCapability.ArkUI.ArkUI.Full 12550 * @crossplatform 12551 * @atomicservice 12552 * @since 13 12553 */ 12554 followTransformOfTarget?: boolean; 12555} 12556 12557/** 12558 * Defines the custom popup options. 12559 * 12560 * @interface CustomPopupOptions 12561 * @syscap SystemCapability.ArkUI.ArkUI.Full 12562 * @since 8 12563 */ 12564/** 12565 * Defines the custom popup options. 12566 * 12567 * @interface CustomPopupOptions 12568 * @syscap SystemCapability.ArkUI.ArkUI.Full 12569 * @crossplatform 12570 * @since 10 12571 */ 12572/** 12573 * Defines the custom popup options. 12574 * 12575 * @interface CustomPopupOptions 12576 * @syscap SystemCapability.ArkUI.ArkUI.Full 12577 * @crossplatform 12578 * @atomicservice 12579 * @since 11 12580 */ 12581declare interface CustomPopupOptions { 12582 /** 12583 * builder of popup 12584 * 12585 * @type { CustomBuilder } 12586 * @syscap SystemCapability.ArkUI.ArkUI.Full 12587 * @since 8 12588 */ 12589 /** 12590 * builder of popup 12591 * 12592 * @type { CustomBuilder } 12593 * @syscap SystemCapability.ArkUI.ArkUI.Full 12594 * @crossplatform 12595 * @since 10 12596 */ 12597 /** 12598 * builder of popup 12599 * 12600 * @type { CustomBuilder } 12601 * @syscap SystemCapability.ArkUI.ArkUI.Full 12602 * @crossplatform 12603 * @atomicservice 12604 * @since 11 12605 */ 12606 builder: CustomBuilder; 12607 12608 /** 12609 * placement of popup 12610 * 12611 * @type { ?Placement } 12612 * @syscap SystemCapability.ArkUI.ArkUI.Full 12613 * @since 8 12614 */ 12615 /** 12616 * placement of popup 12617 * 12618 * @type { ?Placement } 12619 * @syscap SystemCapability.ArkUI.ArkUI.Full 12620 * @crossplatform 12621 * @since 10 12622 */ 12623 /** 12624 * placement of popup 12625 * 12626 * @type { ?Placement } 12627 * @syscap SystemCapability.ArkUI.ArkUI.Full 12628 * @crossplatform 12629 * @atomicservice 12630 * @since 11 12631 */ 12632 placement?: Placement; 12633 12634 /** 12635 * mask color of popup 12636 * 12637 * @type { ?(Color | string | Resource | number) } 12638 * @syscap SystemCapability.ArkUI.ArkUI.Full 12639 * @since 8 12640 * @deprecated since 10 12641 * @useinstead CustomPopupOptions#mask 12642 */ 12643 maskColor?: Color | string | Resource | number; 12644 12645 /** 12646 * background color of popup 12647 * 12648 * @type { ?(Color | string | Resource | number) } 12649 * @syscap SystemCapability.ArkUI.ArkUI.Full 12650 * @since 8 12651 */ 12652 /** 12653 * background color of popup 12654 * 12655 * @type { ?(Color | string | Resource | number) } 12656 * @syscap SystemCapability.ArkUI.ArkUI.Full 12657 * @crossplatform 12658 * @since 10 12659 */ 12660 /** 12661 * background color of popup 12662 * 12663 * @type { ?(Color | string | Resource | number) } 12664 * @syscap SystemCapability.ArkUI.ArkUI.Full 12665 * @crossplatform 12666 * @atomicservice 12667 * @since 11 12668 */ 12669 popupColor?: Color | string | Resource | number; 12670 12671 /** 12672 * whether show arrow 12673 * 12674 * @type { ?boolean } 12675 * @syscap SystemCapability.ArkUI.ArkUI.Full 12676 * @since 8 12677 */ 12678 /** 12679 * whether show arrow 12680 * 12681 * @type { ?boolean } 12682 * @syscap SystemCapability.ArkUI.ArkUI.Full 12683 * @crossplatform 12684 * @since 10 12685 */ 12686 /** 12687 * whether show arrow 12688 * 12689 * @type { ?boolean } 12690 * @syscap SystemCapability.ArkUI.ArkUI.Full 12691 * @crossplatform 12692 * @atomicservice 12693 * @since 11 12694 */ 12695 enableArrow?: boolean; 12696 12697 /** 12698 * whether hide popup when click mask 12699 * 12700 * @type { ?boolean } 12701 * @syscap SystemCapability.ArkUI.ArkUI.Full 12702 * @since 8 12703 */ 12704 /** 12705 * whether hide popup when click mask 12706 * 12707 * @type { ?boolean } 12708 * @syscap SystemCapability.ArkUI.ArkUI.Full 12709 * @crossplatform 12710 * @since 10 12711 */ 12712 /** 12713 * whether hide popup when click mask 12714 * 12715 * @type { ?boolean } 12716 * @syscap SystemCapability.ArkUI.ArkUI.Full 12717 * @crossplatform 12718 * @atomicservice 12719 * @since 11 12720 */ 12721 autoCancel?: boolean; 12722 12723 /** 12724 * on State Change 12725 * 12726 * @type { ?function } 12727 * @syscap SystemCapability.ArkUI.ArkUI.Full 12728 * @since 8 12729 */ 12730 /** 12731 * on State Change 12732 * 12733 * @type { ?function } 12734 * @syscap SystemCapability.ArkUI.ArkUI.Full 12735 * @crossplatform 12736 * @since 10 12737 */ 12738 /** 12739 * on State Change 12740 * 12741 * @type { ?function } 12742 * @syscap SystemCapability.ArkUI.ArkUI.Full 12743 * @crossplatform 12744 * @atomicservice 12745 * @since 11 12746 */ 12747 onStateChange?: (event: { 12748 /** 12749 * is Visible. 12750 * 12751 * @type { boolean } 12752 * @syscap SystemCapability.ArkUI.ArkUI.Full 12753 * @crossplatform 12754 * @since 10 12755 */ 12756 /** 12757 * is Visible. 12758 * 12759 * @type { boolean } 12760 * @syscap SystemCapability.ArkUI.ArkUI.Full 12761 * @crossplatform 12762 * @atomicservice 12763 * @since 11 12764 */ 12765 isVisible: boolean 12766 }) => void; 12767 12768 /** 12769 * The offset of the sharp corner of popup. 12770 * 12771 * @type { ?Length } 12772 * @syscap SystemCapability.ArkUI.ArkUI.Full 12773 * @since 9 12774 */ 12775 /** 12776 * The offset of the sharp corner of popup. 12777 * 12778 * @type { ?Length } 12779 * @syscap SystemCapability.ArkUI.ArkUI.Full 12780 * @crossplatform 12781 * @since 10 12782 */ 12783 /** 12784 * The offset of the sharp corner of popup. 12785 * 12786 * @type { ?Length } 12787 * @syscap SystemCapability.ArkUI.ArkUI.Full 12788 * @crossplatform 12789 * @atomicservice 12790 * @since 11 12791 */ 12792 arrowOffset?: Length; 12793 12794 /** 12795 * Whether to display in the sub window. 12796 * 12797 * @type { ?boolean } 12798 * @syscap SystemCapability.ArkUI.ArkUI.Full 12799 * @since 9 12800 */ 12801 /** 12802 * Whether to display in the sub window. 12803 * 12804 * @type { ?boolean } 12805 * @syscap SystemCapability.ArkUI.ArkUI.Full 12806 * @crossplatform 12807 * @since 10 12808 */ 12809 /** 12810 * Whether to display in the sub window. 12811 * 12812 * @type { ?boolean } 12813 * @syscap SystemCapability.ArkUI.ArkUI.Full 12814 * @crossplatform 12815 * @atomicservice 12816 * @since 11 12817 */ 12818 showInSubWindow?: boolean; 12819 12820 /** 12821 * The mask to block gesture events of popup. 12822 * When mask is set false, gesture events are not blocked. 12823 * When mask is set true, gesture events are blocked and mask color is transparent. 12824 * 12825 * @type { ?(boolean | { color: ResourceColor }) } 12826 * @syscap SystemCapability.ArkUI.ArkUI.Full 12827 * @crossplatform 12828 * @since 10 12829 */ 12830 /** 12831 * The mask to block gesture events of popup. 12832 * When mask is set false, gesture events are not blocked. 12833 * When mask is set true, gesture events are blocked and mask color is transparent. 12834 * 12835 * @type { ?(boolean | { color: ResourceColor }) } 12836 * @syscap SystemCapability.ArkUI.ArkUI.Full 12837 * @crossplatform 12838 * @atomicservice 12839 * @since 11 12840 */ 12841 mask?: boolean | { color: ResourceColor }; 12842 12843 /** 12844 * Sets the space of between the popup and target. 12845 * 12846 * @type { ?Length } 12847 * @syscap SystemCapability.ArkUI.ArkUI.Full 12848 * @crossplatform 12849 * @since 10 12850 */ 12851 /** 12852 * Sets the space of between the popup and target. 12853 * 12854 * @type { ?Length } 12855 * @syscap SystemCapability.ArkUI.ArkUI.Full 12856 * @crossplatform 12857 * @atomicservice 12858 * @since 11 12859 */ 12860 targetSpace?: Length 12861 12862 /** 12863 * Sets the position offset of the popup. 12864 * 12865 * @type { ?Position } 12866 * @syscap SystemCapability.ArkUI.ArkUI.Full 12867 * @crossplatform 12868 * @since 10 12869 */ 12870 /** 12871 * Sets the position offset of the popup. 12872 * 12873 * @type { ?Position } 12874 * @syscap SystemCapability.ArkUI.ArkUI.Full 12875 * @crossplatform 12876 * @atomicservice 12877 * @since 11 12878 */ 12879 offset?: Position 12880 12881 /** 12882 * Set the width of the popup. 12883 * 12884 * @type { ?Dimension } 12885 * @syscap SystemCapability.ArkUI.ArkUI.Full 12886 * @crossplatform 12887 * @since 11 12888 */ 12889 /** 12890 * Set the width of the popup. 12891 * 12892 * @type { ?Dimension } 12893 * @syscap SystemCapability.ArkUI.ArkUI.Full 12894 * @crossplatform 12895 * @atomicservice 12896 * @since 12 12897 */ 12898 width?: Dimension; 12899 12900 /** 12901 * The position of the sharp corner of popup. 12902 * 12903 * @type { ?ArrowPointPosition } 12904 * @syscap SystemCapability.ArkUI.ArkUI.Full 12905 * @crossplatform 12906 * @since 11 12907 */ 12908 /** 12909 * The position of the sharp corner of popup. 12910 * 12911 * @type { ?ArrowPointPosition } 12912 * @syscap SystemCapability.ArkUI.ArkUI.Full 12913 * @crossplatform 12914 * @atomicservice 12915 * @since 12 12916 */ 12917 arrowPointPosition?: ArrowPointPosition; 12918 12919 /** 12920 * The width of the arrow. 12921 * 12922 * @type { ?Dimension } 12923 * @default 16.0_vp. 12924 * @syscap SystemCapability.ArkUI.ArkUI.Full 12925 * @crossplatform 12926 * @since 11 12927 */ 12928 /** 12929 * The width of the arrow. 12930 * 12931 * @type { ?Dimension } 12932 * @default 16.0_vp. 12933 * @syscap SystemCapability.ArkUI.ArkUI.Full 12934 * @crossplatform 12935 * @atomicservice 12936 * @since 12 12937 */ 12938 arrowWidth?: Dimension; 12939 12940 /** 12941 * The height of the arrow. 12942 * 12943 * @type { ?Dimension } 12944 * @default 8.0_vp. 12945 * @syscap SystemCapability.ArkUI.ArkUI.Full 12946 * @crossplatform 12947 * @since 11 12948 */ 12949 /** 12950 * The height of the arrow. 12951 * 12952 * @type { ?Dimension } 12953 * @default 8.0_vp. 12954 * @syscap SystemCapability.ArkUI.ArkUI.Full 12955 * @crossplatform 12956 * @atomicservice 12957 * @since 12 12958 */ 12959 arrowHeight?: Dimension; 12960 12961 /** 12962 * The round corners of the popup. 12963 * 12964 * @type { ?Dimension } 12965 * @default 20.0_vp. 12966 * @syscap SystemCapability.ArkUI.ArkUI.Full 12967 * @crossplatform 12968 * @since 11 12969 */ 12970 /** 12971 * The round corners of the popup. 12972 * 12973 * @type { ?Dimension } 12974 * @default 20.0_vp. 12975 * @syscap SystemCapability.ArkUI.ArkUI.Full 12976 * @crossplatform 12977 * @atomicservice 12978 * @since 12 12979 */ 12980 radius?: Dimension; 12981 12982 /** 12983 * The style of popup Shadow. 12984 * 12985 * @type { ?(ShadowOptions | ShadowStyle) } 12986 * @default ShadowStyle.OUTER_DEFAULT_MD. 12987 * @syscap SystemCapability.ArkUI.ArkUI.Full 12988 * @crossplatform 12989 * @since 11 12990 */ 12991 /** 12992 * The style of popup Shadow. 12993 * 12994 * @type { ?(ShadowOptions | ShadowStyle) } 12995 * @default ShadowStyle.OUTER_DEFAULT_MD. 12996 * @syscap SystemCapability.ArkUI.ArkUI.Full 12997 * @crossplatform 12998 * @atomicservice 12999 * @since 12 13000 */ 13001 shadow?: ShadowOptions | ShadowStyle; 13002 13003 /** 13004 * Defines popup background blur Style 13005 * 13006 * @type { ?BlurStyle } 13007 * @default BlurStyle.COMPONENT_ULTRA_THICK 13008 * @syscap SystemCapability.ArkUI.ArkUI.Full 13009 * @crossplatform 13010 * @since 11 13011 */ 13012 /** 13013 * Defines popup background blur Style 13014 * 13015 * @type { ?BlurStyle } 13016 * @default BlurStyle.COMPONENT_ULTRA_THICK 13017 * @syscap SystemCapability.ArkUI.ArkUI.Full 13018 * @crossplatform 13019 * @atomicservice 13020 * @since 12 13021 */ 13022 backgroundBlurStyle?: BlurStyle; 13023 13024 /** 13025 * Set popup focusable 13026 * 13027 * @type { ?boolean } 13028 * @default true 13029 * @syscap SystemCapability.ArkUI.ArkUI.Full 13030 * @crossplatform 13031 * @since 11 13032 */ 13033 /** 13034 * Set popup focusable 13035 * 13036 * @type { ?boolean } 13037 * @default true 13038 * @syscap SystemCapability.ArkUI.ArkUI.Full 13039 * @crossplatform 13040 * @atomicservice 13041 * @since 12 13042 */ 13043 focusable?: boolean; 13044 13045 /** 13046 * Defines the transition effect of popup opening and closing 13047 * 13048 * @type { ?TransitionEffect } 13049 * @syscap SystemCapability.ArkUI.ArkUI.Full 13050 * @crossplatform 13051 * @atomicservice 13052 * @since 12 13053 */ 13054 transition?: TransitionEffect; 13055 13056 /** 13057 * Callback function when the popup interactive dismiss 13058 * 13059 * @type { ?(boolean | Callback<DismissPopupAction>) } 13060 * @syscap SystemCapability.ArkUI.ArkUI.Full 13061 * @crossplatform 13062 * @atomicservice 13063 * @since 12 13064 */ 13065 onWillDismiss?: boolean | Callback<DismissPopupAction>; 13066 13067 /** 13068 * Determine if popup can follow the target node when it has rotation or scale. 13069 * 13070 * @type { ?boolean } 13071 * @default false 13072 * @syscap SystemCapability.ArkUI.ArkUI.Full 13073 * @crossplatform 13074 * @atomicservice 13075 * @since 13 13076 */ 13077 followTransformOfTarget?: boolean; 13078} 13079 13080/** 13081 * Defines the menu preview mode. 13082 * 13083 * @enum { number } 13084 * @syscap SystemCapability.ArkUI.ArkUI.Full 13085 * @crossplatform 13086 * @since 11 13087 */ 13088/** 13089 * Defines the menu preview mode. 13090 * 13091 * @enum { number } 13092 * @syscap SystemCapability.ArkUI.ArkUI.Full 13093 * @crossplatform 13094 * @atomicservice 13095 * @since 12 13096 */ 13097declare enum MenuPreviewMode { 13098 /** 13099 * No preview content. 13100 * 13101 * @syscap SystemCapability.ArkUI.ArkUI.Full 13102 * @crossplatform 13103 * @since 11 13104 */ 13105 /** 13106 * No preview content. 13107 * 13108 * @syscap SystemCapability.ArkUI.ArkUI.Full 13109 * @crossplatform 13110 * @atomicservice 13111 * @since 12 13112 */ 13113 NONE = 0, 13114 /** 13115 * Defines image type preview content. 13116 * 13117 * @syscap SystemCapability.ArkUI.ArkUI.Full 13118 * @crossplatform 13119 * @since 11 13120 */ 13121 /** 13122 * Defines image type preview content. 13123 * 13124 * @syscap SystemCapability.ArkUI.ArkUI.Full 13125 * @crossplatform 13126 * @atomicservice 13127 * @since 12 13128 */ 13129 IMAGE = 1 13130} 13131 13132/** 13133 * Defines the animator range of start and end property. 13134 * 13135 * @typedef { [from: T, to: T] } AnimationRange<T> 13136 * @syscap SystemCapability.ArkUI.ArkUI.Full 13137 * @crossplatform 13138 * @since 11 13139 */ 13140/** 13141 * Defines the animator range of start and end property. 13142 * 13143 * @typedef { [from: T, to: T] } AnimationRange<T> 13144 * @syscap SystemCapability.ArkUI.ArkUI.Full 13145 * @crossplatform 13146 * @atomicservice 13147 * @since 12 13148 */ 13149declare type AnimationRange<T> = [from: T, to: T]; 13150 13151/** 13152 * Defines the ContextMenu's preview animator options. 13153 * 13154 * @interface ContextMenuAnimationOptions 13155 * @syscap SystemCapability.ArkUI.ArkUI.Full 13156 * @crossplatform 13157 * @since 11 13158 */ 13159/** 13160 * Defines the ContextMenu's preview animator options. 13161 * 13162 * @interface ContextMenuAnimationOptions 13163 * @syscap SystemCapability.ArkUI.ArkUI.Full 13164 * @crossplatform 13165 * @atomicservice 13166 * @since 12 13167 */ 13168interface ContextMenuAnimationOptions { 13169 /** 13170 * Sets the start animator scale and end animator scale. 13171 * 13172 * @type { ?AnimationRange<number> } 13173 * @default - 13174 * @syscap SystemCapability.ArkUI.ArkUI.Full 13175 * @crossplatform 13176 * @since 11 13177 */ 13178 /** 13179 * Sets the start animator scale and end animator scale. 13180 * 13181 * @type { ?AnimationRange<number> } 13182 * @default - 13183 * @syscap SystemCapability.ArkUI.ArkUI.Full 13184 * @crossplatform 13185 * @atomicservice 13186 * @since 12 13187 */ 13188 scale?: AnimationRange<number>; 13189 /** 13190 * Defines the transition effect of menu preview opening and closing. 13191 * 13192 * @type { ?TransitionEffect } 13193 * @syscap SystemCapability.ArkUI.ArkUI.Full 13194 * @crossplatform 13195 * @atomicservice 13196 * @since 12 13197 */ 13198 transition?: TransitionEffect; 13199 13200 /** 13201 * Sets the scale start and end animator of the image displayed before the custom builder preview is displayed. 13202 * 13203 * @type { ?AnimationRange<number> } 13204 * @syscap SystemCapability.ArkUI.ArkUI.Full 13205 * @crossplatform 13206 * @atomicservice 13207 * @since 12 13208 */ 13209 hoverScale?: AnimationRange<number>; 13210} 13211 13212/** 13213 * Defines the context menu options. 13214 * 13215 * @interface ContextMenuOptions 13216 * @syscap SystemCapability.ArkUI.ArkUI.Full 13217 * @crossplatform 13218 * @since 10 13219 */ 13220/** 13221 * Defines the context menu options. 13222 * 13223 * @interface ContextMenuOptions 13224 * @syscap SystemCapability.ArkUI.ArkUI.Full 13225 * @crossplatform 13226 * @atomicservice 13227 * @since 11 13228 */ 13229declare interface ContextMenuOptions { 13230 /** 13231 * Sets the position offset of the context menu window. 13232 * 13233 * @type { ?Position } 13234 * @default - 13235 * @syscap SystemCapability.ArkUI.ArkUI.Full 13236 * @crossplatform 13237 * @since 10 13238 */ 13239 /** 13240 * Sets the position offset of the context menu window. 13241 * 13242 * @type { ?Position } 13243 * @default - 13244 * @syscap SystemCapability.ArkUI.ArkUI.Full 13245 * @crossplatform 13246 * @atomicservice 13247 * @since 11 13248 */ 13249 offset?: Position; 13250 13251 /** 13252 * Sets the placement of the context menu window. 13253 * 13254 * @type { ?Placement } 13255 * @default - 13256 * @syscap SystemCapability.ArkUI.ArkUI.Full 13257 * @crossplatform 13258 * @since 10 13259 */ 13260 /** 13261 * Sets the placement of the context menu window. 13262 * 13263 * @type { ?Placement } 13264 * @default - 13265 * @syscap SystemCapability.ArkUI.ArkUI.Full 13266 * @crossplatform 13267 * @atomicservice 13268 * @since 11 13269 */ 13270 placement?: Placement; 13271 13272 /** 13273 * whether show arrow belong to the menu, default: false, not show arrow 13274 * 13275 * @type { ?boolean } 13276 * @default false 13277 * @syscap SystemCapability.ArkUI.ArkUI.Full 13278 * @since 10 13279 */ 13280 /** 13281 * whether show arrow belong to the menu, default: false, not show arrow 13282 * 13283 * @type { ?boolean } 13284 * @default false 13285 * @syscap SystemCapability.ArkUI.ArkUI.Full 13286 * @crossplatform 13287 * @atomicservice 13288 * @since 11 13289 */ 13290 enableArrow?: boolean; 13291 13292 /** 13293 * The horizontal offset to the left of menu or vertical offset to the top of menu 13294 * 13295 * @type { ?Length } 13296 * @default 0 13297 * @syscap SystemCapability.ArkUI.ArkUI.Full 13298 * @since 10 13299 */ 13300 /** 13301 * The horizontal offset to the left of menu or vertical offset to the top of menu 13302 * 13303 * @type { ?Length } 13304 * @default 0 13305 * @syscap SystemCapability.ArkUI.ArkUI.Full 13306 * @crossplatform 13307 * @atomicservice 13308 * @since 11 13309 */ 13310 arrowOffset?: Length; 13311 13312 /** 13313 * The preview content of context menu. 13314 * 13315 * @type { ?(MenuPreviewMode | CustomBuilder) } 13316 * @default MenuPreviewMode.NONE 13317 * @syscap SystemCapability.ArkUI.ArkUI.Full 13318 * @crossplatform 13319 * @since 11 13320 */ 13321 /** 13322 * The preview content of context menu. 13323 * 13324 * @type { ?(MenuPreviewMode | CustomBuilder) } 13325 * @default MenuPreviewMode.NONE 13326 * @syscap SystemCapability.ArkUI.ArkUI.Full 13327 * @crossplatform 13328 * @atomicservice 13329 * @since 12 13330 */ 13331 preview?: MenuPreviewMode | CustomBuilder; 13332 13333 /** 13334 * Defines the border radius of menu. 13335 * 13336 * @type { ?(Length | BorderRadiuses | LocalizedBorderRadiuses) } 13337 * @syscap SystemCapability.ArkUI.ArkUI.Full 13338 * @crossplatform 13339 * @atomicservice 13340 * @since 12 13341 */ 13342 borderRadius?: Length | BorderRadiuses | LocalizedBorderRadiuses; 13343 13344 /** 13345 * Callback function when the context menu appears. 13346 * 13347 * @type { ?function } 13348 * @syscap SystemCapability.ArkUI.ArkUI.Full 13349 * @crossplatform 13350 * @since 10 13351 */ 13352 /** 13353 * Callback function when the context menu appears. 13354 * 13355 * @type { ?function } 13356 * @syscap SystemCapability.ArkUI.ArkUI.Full 13357 * @crossplatform 13358 * @atomicservice 13359 * @since 11 13360 */ 13361 onAppear?: () => void; 13362 13363 /** 13364 * Callback function when the context menu disappear. 13365 * 13366 * @type { ?function } 13367 * @syscap SystemCapability.ArkUI.ArkUI.Full 13368 * @crossplatform 13369 * @since 10 13370 */ 13371 /** 13372 * Callback function when the context menu disappear. 13373 * 13374 * @type { ?function } 13375 * @syscap SystemCapability.ArkUI.ArkUI.Full 13376 * @crossplatform 13377 * @atomicservice 13378 * @since 11 13379 */ 13380 onDisappear?: () => void; 13381 13382 /** 13383 * Callback function before the context menu animation starts. 13384 * 13385 * @type { ?function } 13386 * @syscap SystemCapability.ArkUI.ArkUI.Full 13387 * @crossplatform 13388 * @since 11 13389 */ 13390 /** 13391 * Callback function before the context menu animation starts. 13392 * 13393 * @type { ?function } 13394 * @syscap SystemCapability.ArkUI.ArkUI.Full 13395 * @crossplatform 13396 * @atomicservice 13397 * @since 12 13398 */ 13399 aboutToAppear?: () => void; 13400 13401 /** 13402 * Callback function before the context menu popAnimation starts. 13403 * 13404 * @type { ?function } 13405 * @syscap SystemCapability.ArkUI.ArkUI.Full 13406 * @crossplatform 13407 * @since 11 13408 */ 13409 /** 13410 * Callback function before the context menu popAnimation starts. 13411 * 13412 * @type { ?function } 13413 * @syscap SystemCapability.ArkUI.ArkUI.Full 13414 * @crossplatform 13415 * @atomicservice 13416 * @since 12 13417 */ 13418 aboutToDisappear?: () => void; 13419 13420 /** 13421 * The margin of menu's layoutRegion. 13422 * 13423 * @type { ?Margin } 13424 * @syscap SystemCapability.ArkUI.ArkUI.Full 13425 * @crossplatform 13426 * @atomicservice 13427 * @since 13 13428 */ 13429 layoutRegionMargin?: Margin; 13430 13431 /** 13432 * The preview animator options. 13433 * 13434 * @type { ?ContextMenuAnimationOptions } 13435 * @syscap SystemCapability.ArkUI.ArkUI.Full 13436 * @crossplatform 13437 * @since 11 13438 */ 13439 /** 13440 * The preview animator options. 13441 * 13442 * @type { ?ContextMenuAnimationOptions } 13443 * @syscap SystemCapability.ArkUI.ArkUI.Full 13444 * @crossplatform 13445 * @atomicservice 13446 * @since 12 13447 */ 13448 previewAnimationOptions?: ContextMenuAnimationOptions; 13449 13450 /** 13451 * Defines the menu's background color 13452 * 13453 * @type { ?ResourceColor } 13454 * @default Color.Transparent 13455 * @syscap SystemCapability.ArkUI.ArkUI.Full 13456 * @crossplatform 13457 * @since 11 13458 */ 13459 /** 13460 * Defines the menu's background color 13461 * 13462 * @type { ?ResourceColor } 13463 * @default Color.Transparent 13464 * @syscap SystemCapability.ArkUI.ArkUI.Full 13465 * @crossplatform 13466 * @atomicservice 13467 * @since 12 13468 */ 13469 backgroundColor?: ResourceColor; 13470 13471 /** 13472 * Defines menu background blur Style 13473 * 13474 * @type { ?BlurStyle } 13475 * @default BlurStyle.COMPONENT_ULTRA_THICK 13476 * @syscap SystemCapability.ArkUI.ArkUI.Full 13477 * @crossplatform 13478 * @since 11 13479 */ 13480 /** 13481 * Defines menu background blur Style 13482 * 13483 * @type { ?BlurStyle } 13484 * @default BlurStyle.COMPONENT_ULTRA_THICK 13485 * @syscap SystemCapability.ArkUI.ArkUI.Full 13486 * @crossplatform 13487 * @atomicservice 13488 * @since 12 13489 */ 13490 backgroundBlurStyle?: BlurStyle; 13491 13492 /** 13493 * Defines the transition effect of menu opening and closing. 13494 * 13495 * @type { ?TransitionEffect } 13496 * @syscap SystemCapability.ArkUI.ArkUI.Full 13497 * @crossplatform 13498 * @atomicservice 13499 * @since 12 13500 */ 13501 transition?: TransitionEffect; 13502} 13503 13504/** 13505 * Defines the menu options. 13506 * 13507 * @interface MenuOptions 13508 * @syscap SystemCapability.ArkUI.ArkUI.Full 13509 * @crossplatform 13510 * @since 10 13511 */ 13512/** 13513 * Defines the menu options. 13514 * 13515 * @interface MenuOptions 13516 * @syscap SystemCapability.ArkUI.ArkUI.Full 13517 * @crossplatform 13518 * @atomicservice 13519 * @since 11 13520 */ 13521declare interface MenuOptions extends ContextMenuOptions { 13522 /** 13523 * Sets the title of the menu window. 13524 * 13525 * @type { ?ResourceStr } 13526 * @syscap SystemCapability.ArkUI.ArkUI.Full 13527 * @crossplatform 13528 * @since 10 13529 */ 13530 /** 13531 * Sets the title of the menu window. 13532 * 13533 * @type { ?ResourceStr } 13534 * @syscap SystemCapability.ArkUI.ArkUI.Full 13535 * @crossplatform 13536 * @atomicservice 13537 * @since 11 13538 */ 13539 title?: ResourceStr; 13540 13541 /** 13542 * Whether to display in the sub window. 13543 * 13544 * @type { ?boolean } 13545 * @syscap SystemCapability.ArkUI.ArkUI.Full 13546 * @crossplatform 13547 * @since 11 13548 */ 13549 /** 13550 * Whether to display in the sub window. 13551 * 13552 * @type { ?boolean } 13553 * @syscap SystemCapability.ArkUI.ArkUI.Full 13554 * @crossplatform 13555 * @atomicservice 13556 * @since 12 13557 */ 13558 showInSubWindow?: boolean; 13559} 13560 13561/** 13562 * Defines the ProgressMask class. 13563 * 13564 * @syscap SystemCapability.ArkUI.ArkUI.Full 13565 * @crossplatform 13566 * @since 10 13567 */ 13568/** 13569 * Defines the ProgressMask class. 13570 * 13571 * @syscap SystemCapability.ArkUI.ArkUI.Full 13572 * @crossplatform 13573 * @atomicservice 13574 * @since 11 13575 */ 13576declare class ProgressMask { 13577 /** 13578 * constructor. 13579 * 13580 * @param { number } value - indicates the current value of the progress. 13581 * @param { number } total - indicates the total value of the progress. 13582 * @param { ResourceColor } color - indicates the color of the mask. 13583 * @syscap SystemCapability.ArkUI.ArkUI.Full 13584 * @crossplatform 13585 * @since 10 13586 */ 13587 /** 13588 * constructor. 13589 * 13590 * @param { number } value - indicates the current value of the progress. 13591 * @param { number } total - indicates the total value of the progress. 13592 * @param { ResourceColor } color - indicates the color of the mask. 13593 * @syscap SystemCapability.ArkUI.ArkUI.Full 13594 * @crossplatform 13595 * @atomicservice 13596 * @since 11 13597 */ 13598 constructor(value: number, total: number, color: ResourceColor); 13599 13600 /** 13601 * Update the current value of the progress. 13602 * 13603 * @param { number } value - indicates the current value of the progress. 13604 * @syscap SystemCapability.ArkUI.ArkUI.Full 13605 * @crossplatform 13606 * @since 10 13607 */ 13608 /** 13609 * Update the current value of the progress. 13610 * 13611 * @param { number } value - indicates the current value of the progress. 13612 * @syscap SystemCapability.ArkUI.ArkUI.Full 13613 * @crossplatform 13614 * @atomicservice 13615 * @since 11 13616 */ 13617 updateProgress(value: number): void; 13618 13619 /** 13620 * Update the color of the mask. 13621 * 13622 * @param { ResourceColor } value - indicates the color of the mask. 13623 * @syscap SystemCapability.ArkUI.ArkUI.Full 13624 * @crossplatform 13625 * @since 10 13626 */ 13627 /** 13628 * Update the color of the mask. 13629 * 13630 * @param { ResourceColor } value - indicates the color of the mask. 13631 * @syscap SystemCapability.ArkUI.ArkUI.Full 13632 * @crossplatform 13633 * @atomicservice 13634 * @since 11 13635 */ 13636 updateColor(value: ResourceColor): void; 13637 13638 /** 13639 * Enable the breathe animation of mask. 13640 * 13641 * @param { boolean } value 13642 * @syscap SystemCapability.ArkUI.ArkUI.Full 13643 * @crossplatform 13644 * @atomicservice 13645 * @since 12 13646 */ 13647 enableBreathingAnimation(value: boolean): void; 13648} 13649 13650/** 13651 * Defines TouchTestInfo class. 13652 * 13653 * @syscap SystemCapability.ArkUI.ArkUI.Full 13654 * @crossplatform 13655 * @since 11 13656 */ 13657/** 13658 * Defines TouchTestInfo class. 13659 * 13660 * @syscap SystemCapability.ArkUI.ArkUI.Full 13661 * @crossplatform 13662 * @atomicservice 13663 * @since 12 13664 */ 13665declare class TouchTestInfo { 13666 /** 13667 * Get the X-coordinate relative to the window. 13668 * 13669 * @type { number } 13670 * @syscap SystemCapability.ArkUI.ArkUI.Full 13671 * @crossplatform 13672 * @since 11 13673 */ 13674 /** 13675 * Get the X-coordinate relative to the window. 13676 * 13677 * @type { number } 13678 * @syscap SystemCapability.ArkUI.ArkUI.Full 13679 * @crossplatform 13680 * @atomicservice 13681 * @since 12 13682 */ 13683 windowX: number; 13684 13685 /** 13686 * Get the Y-coordinate relative to the window. 13687 * 13688 * @type { number } 13689 * @syscap SystemCapability.ArkUI.ArkUI.Full 13690 * @crossplatform 13691 * @since 11 13692 */ 13693 /** 13694 * Get the Y-coordinate relative to the window. 13695 * 13696 * @type { number } 13697 * @syscap SystemCapability.ArkUI.ArkUI.Full 13698 * @crossplatform 13699 * @atomicservice 13700 * @since 12 13701 */ 13702 windowY: number; 13703 13704 /** 13705 * Get the X-coordinate relative to the current component. 13706 * 13707 * @type { number } 13708 * @syscap SystemCapability.ArkUI.ArkUI.Full 13709 * @crossplatform 13710 * @since 11 13711 */ 13712 /** 13713 * Get the X-coordinate relative to the current component. 13714 * 13715 * @type { number } 13716 * @syscap SystemCapability.ArkUI.ArkUI.Full 13717 * @crossplatform 13718 * @atomicservice 13719 * @since 12 13720 */ 13721 parentX: number; 13722 13723 /** 13724 * Get the Y-coordinate relative to the current component. 13725 * 13726 * @type { number } 13727 * @syscap SystemCapability.ArkUI.ArkUI.Full 13728 * @crossplatform 13729 * @since 11 13730 */ 13731 /** 13732 * Get the Y-coordinate relative to the current component. 13733 * 13734 * @type { number } 13735 * @syscap SystemCapability.ArkUI.ArkUI.Full 13736 * @crossplatform 13737 * @atomicservice 13738 * @since 12 13739 */ 13740 parentY: number; 13741 13742 /** 13743 * Get the X-coordinate relative to the sub component. 13744 * 13745 * @type { number } 13746 * @syscap SystemCapability.ArkUI.ArkUI.Full 13747 * @crossplatform 13748 * @since 11 13749 */ 13750 /** 13751 * Get the X-coordinate relative to the sub component. 13752 * 13753 * @type { number } 13754 * @syscap SystemCapability.ArkUI.ArkUI.Full 13755 * @crossplatform 13756 * @atomicservice 13757 * @since 12 13758 */ 13759 x: number; 13760 13761 /** 13762 * Get the Y-coordinate relative to the sub component. 13763 * 13764 * @type { number } 13765 * @syscap SystemCapability.ArkUI.ArkUI.Full 13766 * @crossplatform 13767 * @since 11 13768 */ 13769 /** 13770 * Get the Y-coordinate relative to the sub component. 13771 * 13772 * @type { number } 13773 * @syscap SystemCapability.ArkUI.ArkUI.Full 13774 * @crossplatform 13775 * @atomicservice 13776 * @since 12 13777 */ 13778 y: number; 13779 13780 /** 13781 * Get the rectangle of sub component. 13782 * 13783 * @type { RectResult } 13784 * @syscap SystemCapability.ArkUI.ArkUI.Full 13785 * @crossplatform 13786 * @since 11 13787 */ 13788 /** 13789 * Get the rectangle of sub component. 13790 * 13791 * @type { RectResult } 13792 * @syscap SystemCapability.ArkUI.ArkUI.Full 13793 * @crossplatform 13794 * @atomicservice 13795 * @since 12 13796 */ 13797 rect: RectResult; 13798 13799 /** 13800 * Get the name of sub component. 13801 * 13802 * @type { string } 13803 * @syscap SystemCapability.ArkUI.ArkUI.Full 13804 * @crossplatform 13805 * @since 11 13806 */ 13807 /** 13808 * Get the name of sub component. 13809 * 13810 * @type { string } 13811 * @syscap SystemCapability.ArkUI.ArkUI.Full 13812 * @crossplatform 13813 * @atomicservice 13814 * @since 12 13815 */ 13816 id: string; 13817} 13818 13819/** 13820 * Defines TouchResult class. 13821 * 13822 * @syscap SystemCapability.ArkUI.ArkUI.Full 13823 * @crossplatform 13824 * @since 11 13825 */ 13826/** 13827 * Defines TouchResult class. 13828 * 13829 * @syscap SystemCapability.ArkUI.ArkUI.Full 13830 * @crossplatform 13831 * @atomicservice 13832 * @since 12 13833 */ 13834declare class TouchResult { 13835 /** 13836 * Defines the touch test strategy. 13837 * 13838 * @type { TouchTestStrategy } 13839 * @syscap SystemCapability.ArkUI.ArkUI.Full 13840 * @crossplatform 13841 * @since 11 13842 */ 13843 /** 13844 * Defines the touch test strategy. 13845 * 13846 * @type { TouchTestStrategy } 13847 * @syscap SystemCapability.ArkUI.ArkUI.Full 13848 * @crossplatform 13849 * @atomicservice 13850 * @since 12 13851 */ 13852 strategy: TouchTestStrategy; 13853 13854 /** 13855 * Defines the component's name. 13856 * 13857 * @type { ?string } 13858 * @syscap SystemCapability.ArkUI.ArkUI.Full 13859 * @crossplatform 13860 * @since 11 13861 */ 13862 /** 13863 * Defines the component's name. 13864 * 13865 * @type { ?string } 13866 * @syscap SystemCapability.ArkUI.ArkUI.Full 13867 * @crossplatform 13868 * @atomicservice 13869 * @since 12 13870 */ 13871 id?: string; 13872} 13873 13874/** 13875 * Set the edge blur effect distance of the corresponding defense line of the component 13876 * When the component expand out, no re-layout is triggered 13877 * 13878 * @interface PixelStretchEffectOptions 13879 * @syscap SystemCapability.ArkUI.ArkUI.Full 13880 * @crossplatform 13881 * @since 10 13882 */ 13883/** 13884 * Set the edge blur effect distance of the corresponding defense line of the component 13885 * When the component expand out, no re-layout is triggered 13886 * 13887 * @interface PixelStretchEffectOptions 13888 * @syscap SystemCapability.ArkUI.ArkUI.Full 13889 * @crossplatform 13890 * @atomicservice 13891 * @since 11 13892 */ 13893declare interface PixelStretchEffectOptions { 13894 /** 13895 * top property. value range (-∞, ∞) 13896 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 13897 * 13898 * @type { ?Length } 13899 * @default 0 13900 * @syscap SystemCapability.ArkUI.ArkUI.Full 13901 * @crossplatform 13902 * @since 10 13903 */ 13904 /** 13905 * top property. value range (-∞, ∞) 13906 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 13907 * 13908 * @type { ?Length } 13909 * @default 0 13910 * @syscap SystemCapability.ArkUI.ArkUI.Full 13911 * @crossplatform 13912 * @atomicservice 13913 * @since 11 13914 */ 13915 top?: Length; 13916 13917 /** 13918 * bottom property. value range (-∞, ∞) 13919 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 13920 * 13921 * @type { ?Length } 13922 * @default 0 13923 * @syscap SystemCapability.ArkUI.ArkUI.Full 13924 * @crossplatform 13925 * @since 10 13926 */ 13927 /** 13928 * bottom property. value range (-∞, ∞) 13929 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 13930 * 13931 * @type { ?Length } 13932 * @default 0 13933 * @syscap SystemCapability.ArkUI.ArkUI.Full 13934 * @crossplatform 13935 * @atomicservice 13936 * @since 11 13937 */ 13938 bottom?: Length; 13939 13940 /** 13941 * left property. value range (-∞, ∞) 13942 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 13943 * 13944 * @type { ?Length } 13945 * @default 0 13946 * @syscap SystemCapability.ArkUI.ArkUI.Full 13947 * @crossplatform 13948 * @since 10 13949 */ 13950 /** 13951 * left property. value range (-∞, ∞) 13952 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 13953 * 13954 * @type { ?Length } 13955 * @default 0 13956 * @syscap SystemCapability.ArkUI.ArkUI.Full 13957 * @crossplatform 13958 * @atomicservice 13959 * @since 11 13960 */ 13961 left?: Length; 13962 13963 /** 13964 * right property. value range (-∞, ∞) 13965 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 13966 * 13967 * @type { ?Length } 13968 * @default 0 13969 * @syscap SystemCapability.ArkUI.ArkUI.Full 13970 * @crossplatform 13971 * @since 10 13972 */ 13973 /** 13974 * right property. value range (-∞, ∞) 13975 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 13976 * 13977 * @type { ?Length } 13978 * @default 0 13979 * @syscap SystemCapability.ArkUI.ArkUI.Full 13980 * @crossplatform 13981 * @atomicservice 13982 * @since 11 13983 */ 13984 right?: Length; 13985} 13986 13987/** 13988 * Defines the click effect. 13989 * 13990 * @interface ClickEffect 13991 * @syscap SystemCapability.ArkUI.ArkUI.Full 13992 * @crossplatform 13993 * @since 10 13994 */ 13995/** 13996 * Defines the click effect. 13997 * 13998 * @interface ClickEffect 13999 * @syscap SystemCapability.ArkUI.ArkUI.Full 14000 * @crossplatform 14001 * @atomicservice 14002 * @since 11 14003 */ 14004declare interface ClickEffect { 14005 /** 14006 * Set the click effect level. 14007 * 14008 * @type { ClickEffectLevel } 14009 * @default ClickEffectLevel.Light 14010 * @syscap SystemCapability.ArkUI.ArkUI.Full 14011 * @since 10 14012 */ 14013 /** 14014 * Set the click effect level. 14015 * 14016 * @type { ClickEffectLevel } 14017 * @default ClickEffectLevel.Light 14018 * @syscap SystemCapability.ArkUI.ArkUI.Full 14019 * @atomicservice 14020 * @since 11 14021 */ 14022 level: ClickEffectLevel; 14023 14024 /** 14025 * Set scale number. 14026 * This default scale is same as the scale of click effect level. 14027 * 14028 * @type { ?number } 14029 * @syscap SystemCapability.ArkUI.ArkUI.Full 14030 * @since 10 14031 */ 14032 /** 14033 * Set scale number. 14034 * This default scale is same as the scale of click effect level. 14035 * 14036 * @type { ?number } 14037 * @syscap SystemCapability.ArkUI.ArkUI.Full 14038 * @atomicservice 14039 * @since 11 14040 */ 14041 scale?: number; 14042} 14043 14044/** 14045 * Define nested scroll options 14046 * 14047 * @interface NestedScrollOptions 14048 * @syscap SystemCapability.ArkUI.ArkUI.Full 14049 * @since 10 14050 */ 14051/** 14052 * Define nested scroll options 14053 * 14054 * @interface NestedScrollOptions 14055 * @syscap SystemCapability.ArkUI.ArkUI.Full 14056 * @atomicservice 14057 * @since 11 14058 */ 14059declare interface NestedScrollOptions { 14060 /** 14061 * Set NestedScrollMode when the scrollable component scrolls forward 14062 * 14063 * @type { NestedScrollMode } 14064 * @syscap SystemCapability.ArkUI.ArkUI.Full 14065 * @since 10 14066 */ 14067 /** 14068 * Set NestedScrollMode when the scrollable component scrolls forward 14069 * 14070 * @type { NestedScrollMode } 14071 * @syscap SystemCapability.ArkUI.ArkUI.Full 14072 * @crossplatform 14073 * @atomicservice 14074 * @since 11 14075 */ 14076 scrollForward: NestedScrollMode; 14077 14078 /** 14079 * Set NestedScrollMode when the scrollable component scrolls backward 14080 * 14081 * @type { NestedScrollMode } 14082 * @syscap SystemCapability.ArkUI.ArkUI.Full 14083 * @since 10 14084 */ 14085 /** 14086 * Set NestedScrollMode when the scrollable component scrolls backward 14087 * 14088 * @type { NestedScrollMode } 14089 * @syscap SystemCapability.ArkUI.ArkUI.Full 14090 * @crossplatform 14091 * @atomicservice 14092 * @since 11 14093 */ 14094 scrollBackward: NestedScrollMode; 14095} 14096 14097/** 14098 * Defines the menu element. 14099 * 14100 * @interface MenuElement 14101 * @syscap SystemCapability.ArkUI.ArkUI.Full 14102 * @since 7 14103 */ 14104/** 14105 * Defines the menu element. 14106 * 14107 * @interface MenuElement 14108 * @syscap SystemCapability.ArkUI.ArkUI.Full 14109 * @crossplatform 14110 * @since 10 14111 */ 14112/** 14113 * Defines the menu element. 14114 * 14115 * @interface MenuElement 14116 * @syscap SystemCapability.ArkUI.ArkUI.Full 14117 * @crossplatform 14118 * @atomicservice 14119 * @since 11 14120 */ 14121declare interface MenuElement { 14122 /** 14123 * Sets the value of the menu element. 14124 * 14125 * @type { ResourceStr } 14126 * @syscap SystemCapability.ArkUI.ArkUI.Full 14127 * @since 7 14128 */ 14129 /** 14130 * Sets the value of the menu element. 14131 * 14132 * @type { ResourceStr } 14133 * @syscap SystemCapability.ArkUI.ArkUI.Full 14134 * @crossplatform 14135 * @since 10 14136 */ 14137 /** 14138 * Sets the value of the menu element. 14139 * 14140 * @type { ResourceStr } 14141 * @syscap SystemCapability.ArkUI.ArkUI.Full 14142 * @crossplatform 14143 * @atomicservice 14144 * @since 11 14145 */ 14146 value: ResourceStr; 14147 14148 /** 14149 * Sets the icon of the menu element. 14150 * 14151 * @type { ?ResourceStr } 14152 * @syscap SystemCapability.ArkUI.ArkUI.Full 14153 * @crossplatform 14154 * @since 10 14155 */ 14156 /** 14157 * Sets the icon of the menu element. 14158 * 14159 * @type { ?ResourceStr } 14160 * @syscap SystemCapability.ArkUI.ArkUI.Full 14161 * @crossplatform 14162 * @atomicservice 14163 * @since 11 14164 */ 14165 icon?: ResourceStr; 14166 14167 /** 14168 * Sets the symbol of the menu element. 14169 * 14170 * @type { ?SymbolGlyphModifier } 14171 * @syscap SystemCapability.ArkUI.ArkUI.Full 14172 * @crossplatform 14173 * @atomicservice 14174 * @since 12 14175 */ 14176 symbolIcon?: SymbolGlyphModifier; 14177 14178 /** 14179 * If the value is true, the menu element is available and can respond to operations such as clicking. 14180 * If the value is false, the menu element is not available and click operations are not responded. 14181 * 14182 * @type { ?boolean } 14183 * @default true 14184 * @syscap SystemCapability.ArkUI.ArkUI.Full 14185 * @crossplatform 14186 * @since 11 14187 */ 14188 /** 14189 * If the value is true, the menu element is available and can respond to operations such as clicking. 14190 * If the value is false, the menu element is not available and click operations are not responded. 14191 * 14192 * @type { ?boolean } 14193 * @default true 14194 * @syscap SystemCapability.ArkUI.ArkUI.Full 14195 * @crossplatform 14196 * @atomicservice 14197 * @since 12 14198 */ 14199 enabled?: boolean; 14200 14201 /** 14202 * Method executed by the callback. 14203 * 14204 * @type { function } 14205 * @syscap SystemCapability.ArkUI.ArkUI.Full 14206 * @since 7 14207 */ 14208 /** 14209 * Method executed by the callback. 14210 * 14211 * @type { function } 14212 * @syscap SystemCapability.ArkUI.ArkUI.Full 14213 * @crossplatform 14214 * @since 10 14215 */ 14216 /** 14217 * Method executed by the callback. 14218 * 14219 * @type { function } 14220 * @syscap SystemCapability.ArkUI.ArkUI.Full 14221 * @crossplatform 14222 * @atomicservice 14223 * @since 11 14224 */ 14225 action: () => void; 14226} 14227 14228/** 14229 * Defines the attribute modifier. 14230 * 14231 * @interface AttributeModifier<T> 14232 * @syscap SystemCapability.ArkUI.ArkUI.Full 14233 * @crossplatform 14234 * @since 11 14235 */ 14236/** 14237 * Defines the attribute modifier. 14238 * 14239 * @interface AttributeModifier<T> 14240 * @syscap SystemCapability.ArkUI.ArkUI.Full 14241 * @crossplatform 14242 * @atomicservice 14243 * @since 12 14244 */ 14245declare interface AttributeModifier<T> { 14246 14247 /** 14248 * Defines the normal update attribute function. 14249 * 14250 * @param { T } instance 14251 * @syscap SystemCapability.ArkUI.ArkUI.Full 14252 * @crossplatform 14253 * @since 11 14254 */ 14255 /** 14256 * Defines the normal update attribute function. 14257 * 14258 * @param { T } instance 14259 * @syscap SystemCapability.ArkUI.ArkUI.Full 14260 * @crossplatform 14261 * @atomicservice 14262 * @since 12 14263 */ 14264 applyNormalAttribute?(instance: T) : void; 14265 14266 /** 14267 * Defines the pressed update attribute function. 14268 * 14269 * @param { T } instance 14270 * @syscap SystemCapability.ArkUI.ArkUI.Full 14271 * @crossplatform 14272 * @since 11 14273 */ 14274 /** 14275 * Defines the pressed update attribute function. 14276 * 14277 * @param { T } instance 14278 * @syscap SystemCapability.ArkUI.ArkUI.Full 14279 * @crossplatform 14280 * @atomicservice 14281 * @since 12 14282 */ 14283 applyPressedAttribute?(instance: T) : void; 14284 14285 /** 14286 * Defines the focused update attribute function. 14287 * 14288 * @param { T } instance 14289 * @syscap SystemCapability.ArkUI.ArkUI.Full 14290 * @crossplatform 14291 * @since 11 14292 */ 14293 /** 14294 * Defines the focused update attribute function. 14295 * 14296 * @param { T } instance 14297 * @syscap SystemCapability.ArkUI.ArkUI.Full 14298 * @crossplatform 14299 * @atomicservice 14300 * @since 12 14301 */ 14302 applyFocusedAttribute?(instance: T) : void; 14303 14304 /** 14305 * Defines the disabled update attribute function. 14306 * 14307 * @param { T } instance 14308 * @syscap SystemCapability.ArkUI.ArkUI.Full 14309 * @crossplatform 14310 * @since 11 14311 */ 14312 /** 14313 * Defines the disabled update attribute function. 14314 * 14315 * @param { T } instance 14316 * @syscap SystemCapability.ArkUI.ArkUI.Full 14317 * @crossplatform 14318 * @atomicservice 14319 * @since 12 14320 */ 14321 applyDisabledAttribute?(instance: T) : void; 14322 14323 /** 14324 * Defines the selected update attribute function. 14325 * 14326 * @param { T } instance 14327 * @syscap SystemCapability.ArkUI.ArkUI.Full 14328 * @crossplatform 14329 * @since 11 14330 */ 14331 /** 14332 * Defines the selected update attribute function. 14333 * 14334 * @param { T } instance 14335 * @syscap SystemCapability.ArkUI.ArkUI.Full 14336 * @crossplatform 14337 * @atomicservice 14338 * @since 12 14339 */ 14340 applySelectedAttribute?(instance: T) : void; 14341} 14342 14343/** 14344 * Defines the content modifier. 14345 * 14346 * @interface ContentModifier 14347 * @syscap SystemCapability.ArkUI.ArkUI.Full 14348 * @crossplatform 14349 * @atomicservice 14350 * @since 12 14351 */ 14352declare interface ContentModifier<T> { 14353 14354 /** 14355 * Defining applyContent function. 14356 * 14357 * @returns { WrappedBuilder<[T]> } 14358 * @syscap SystemCapability.ArkUI.ArkUI.Full 14359 * @crossplatform 14360 * @atomicservice 14361 * @since 12 14362 */ 14363 applyContent(): WrappedBuilder<[T]> 14364} 14365 14366/** 14367 * Defines the common configuration. 14368 * 14369 * @interface CommonConfiguration 14370 * @syscap SystemCapability.ArkUI.ArkUI.Full 14371 * @crossplatform 14372 * @atomicservice 14373 * @since 12 14374 */ 14375declare interface CommonConfiguration<T> { 14376 14377 /** 14378 * If the value is true, the contentModifier is available and can respond to operations such as triggerChange. 14379 * If it is set to false, triggerChange operations are not responded. 14380 * 14381 * @type { boolean } 14382 * @syscap SystemCapability.ArkUI.ArkUI.Full 14383 * @crossplatform 14384 * @atomicservice 14385 * @since 12 14386 */ 14387 enabled: boolean, 14388 14389 /** 14390 * Obtains the contentModifier instance object 14391 * 14392 * @type { ContentModifier<T> } 14393 * @syscap SystemCapability.ArkUI.ArkUI.Full 14394 * @crossplatform 14395 * @atomicservice 14396 * @since 12 14397 */ 14398 contentModifier: ContentModifier<T> 14399} 14400 14401/** 14402 * Outline Style 14403 * 14404 * @enum { number } 14405 * @syscap SystemCapability.ArkUI.ArkUI.Full 14406 * @crossplatform 14407 * @form 14408 * @since 11 14409 */ 14410/** 14411 * Outline Style 14412 * 14413 * @enum { number } 14414 * @syscap SystemCapability.ArkUI.ArkUI.Full 14415 * @crossplatform 14416 * @form 14417 * @atomicservice 14418 * @since 12 14419 */ 14420declare enum OutlineStyle { 14421 /** 14422 * Shows as a solid line. 14423 * 14424 * @syscap SystemCapability.ArkUI.ArkUI.Full 14425 * @crossplatform 14426 * @form 14427 * @since 11 14428 */ 14429 /** 14430 * Shows as a solid line. 14431 * 14432 * @syscap SystemCapability.ArkUI.ArkUI.Full 14433 * @crossplatform 14434 * @form 14435 * @atomicservice 14436 * @since 12 14437 */ 14438 SOLID = 0, 14439 14440 /** 14441 * Shows as a series of short square dashed lines. 14442 * 14443 * @syscap SystemCapability.ArkUI.ArkUI.Full 14444 * @crossplatform 14445 * @form 14446 * @since 11 14447 */ 14448 /** 14449 * Shows as a series of short square dashed lines. 14450 * 14451 * @syscap SystemCapability.ArkUI.ArkUI.Full 14452 * @crossplatform 14453 * @form 14454 * @atomicservice 14455 * @since 12 14456 */ 14457 DASHED = 1, 14458 14459 /** 14460 * Displays as a series of dots with a radius of half the borderWidth. 14461 * 14462 * @syscap SystemCapability.ArkUI.ArkUI.Full 14463 * @crossplatform 14464 * @form 14465 * @since 11 14466 */ 14467 /** 14468 * Displays as a series of dots with a radius of half the borderWidth. 14469 * 14470 * @syscap SystemCapability.ArkUI.ArkUI.Full 14471 * @crossplatform 14472 * @form 14473 * @atomicservice 14474 * @since 12 14475 */ 14476 DOTTED = 2, 14477} 14478 14479/** 14480 * Defines the drag preview mode. 14481 * 14482 * @enum { number } 14483 * @syscap SystemCapability.ArkUI.ArkUI.Full 14484 * @since 11 14485 */ 14486/** 14487 * Defines the drag preview mode. 14488 * 14489 * @enum { number } 14490 * @syscap SystemCapability.ArkUI.ArkUI.Full 14491 * @atomicservice 14492 * @since 12 14493 */ 14494declare enum DragPreviewMode { 14495 /** 14496 * Default preview mode, let system process preview scale. 14497 * 14498 * @syscap SystemCapability.ArkUI.ArkUI.Full 14499 * @since 11 14500 */ 14501 /** 14502 * Default preview mode, let system process preview scale. 14503 * 14504 * @syscap SystemCapability.ArkUI.ArkUI.Full 14505 * @atomicservice 14506 * @since 12 14507 */ 14508 AUTO = 1, 14509 /** 14510 * Disable system scale to preview panel 14511 * 14512 * @syscap SystemCapability.ArkUI.ArkUI.Full 14513 * @since 11 14514 */ 14515 /** 14516 * Disable system scale to preview panel 14517 * 14518 * @syscap SystemCapability.ArkUI.ArkUI.Full 14519 * @atomicservice 14520 * @since 12 14521 */ 14522 DISABLE_SCALE = 2, 14523 /** 14524 * Enable the default shadow effect of preview. 14525 * 14526 * @syscap SystemCapability.ArkUI.ArkUI.Full 14527 * @atomicservice 14528 * @since 12 14529 */ 14530 ENABLE_DEFAULT_SHADOW = 3, 14531 /** 14532 * Enable the default radius effect of preview. 14533 * 14534 * @syscap SystemCapability.ArkUI.ArkUI.Full 14535 * @atomicservice 14536 * @since 12 14537 */ 14538 ENABLE_DEFAULT_RADIUS = 4, 14539} 14540 14541/** 14542 * Define the menu pop-up policy 14543 * 14544 * @enum { number } 14545 * @syscap SystemCapability.ArkUI.ArkUI.Full 14546 * @crossplatform 14547 * @atomicservice 14548 * @since 12 14549 */ 14550declare enum MenuPolicy { 14551 /** 14552 * Default value. The default logic of whether to pop up a menu depends on the scene. 14553 * 14554 * @syscap SystemCapability.ArkUI.ArkUI.Full 14555 * @crossplatform 14556 * @atomicservice 14557 * @since 12 14558 */ 14559 DEFAULT = 0, 14560 14561 /** 14562 * Hide pop up menu. 14563 * 14564 * @syscap SystemCapability.ArkUI.ArkUI.Full 14565 * @crossplatform 14566 * @atomicservice 14567 * @since 12 14568 */ 14569 HIDE = 1, 14570 14571 /** 14572 * Show pop up menu. 14573 * 14574 * @syscap SystemCapability.ArkUI.ArkUI.Full 14575 * @crossplatform 14576 * @atomicservice 14577 * @since 12 14578 */ 14579 SHOW = 2, 14580} 14581 14582/** 14583 * ImageModifier 14584 * 14585 * @typedef { import('../api/arkui/ImageModifier').ImageModifier } ImageModifier 14586 * @syscap SystemCapability.ArkUI.ArkUI.Full 14587 * @crossplatform 14588 * @atomicservice 14589 * @since 12 14590 */ 14591declare type ImageModifier = import('../api/arkui/ImageModifier').ImageModifier; 14592 14593/** 14594 * SymbolGlyphModifier 14595 * 14596 * @typedef {import('../api/arkui/SymbolGlyphModifier').SymbolGlyphModifier} SymbolGlyphModifier 14597 * @syscap SystemCapability.ArkUI.ArkUI.Full 14598 * @crossplatform 14599 * @atomicservice 14600 * @since 12 14601 */ 14602declare type SymbolGlyphModifier = import('../api/arkui/SymbolGlyphModifier').SymbolGlyphModifier; 14603 14604/** 14605 * Defines the preview options. 14606 * 14607 * @interface DragPreviewOptions 14608 * @syscap SystemCapability.ArkUI.ArkUI.Full 14609 * @since 11 14610 */ 14611/** 14612 * Defines the preview options. 14613 * 14614 * @interface DragPreviewOptions 14615 * @syscap SystemCapability.ArkUI.ArkUI.Full 14616 * @atomicservice 14617 * @since 12 14618 */ 14619declare interface DragPreviewOptions { 14620 /** 14621 * Drag preview mode. 14622 * 14623 * @type { ?DragPreviewMode } 14624 * @syscap SystemCapability.ArkUI.ArkUI.Full 14625 * @since 11 14626 */ 14627 /** 14628 * Drag preview mode. 14629 * 14630 * @type { ?(DragPreviewMode | Array<DragPreviewMode>) } 14631 * @syscap SystemCapability.ArkUI.ArkUI.Full 14632 * @atomicservice 14633 * @since 12 14634 */ 14635 mode?: DragPreviewMode | Array<DragPreviewMode>; 14636 14637 /** 14638 * Drag preview modifier. 14639 * 14640 * @type { ?ImageModifier } 14641 * @syscap SystemCapability.ArkUI.ArkUI.Full 14642 * @atomicservice 14643 * @since 12 14644 */ 14645 modifier?: ImageModifier; 14646 14647 /** 14648 * The flag for number showing. 14649 * 14650 * @type { ?(boolean | number) } 14651 * @syscap SystemCapability.ArkUI.ArkUI.Full 14652 * @atomicservice 14653 * @since 12 14654 */ 14655 numberBadge?: boolean | number; 14656} 14657 14658/** 14659 * Defines the drag options. 14660 * 14661 * @interface DragInteractionOptions 14662 * @syscap SystemCapability.ArkUI.ArkUI.Full 14663 * @atomicservice 14664 * @since 12 14665 */ 14666declare interface DragInteractionOptions { 14667 /** 14668 * Define whether to gather selected nodes in grid or list. 14669 * 14670 * @type { ?boolean } 14671 * @syscap SystemCapability.ArkUI.ArkUI.Full 14672 * @atomicservice 14673 * @since 12 14674 */ 14675 isMultiSelectionEnabled?: boolean; 14676 14677 /** 14678 * Define whether to execute animation before preview floating. 14679 * 14680 * @type { ?boolean } 14681 * @syscap SystemCapability.ArkUI.ArkUI.Full 14682 * @atomicservice 14683 * @since 12 14684 */ 14685 defaultAnimationBeforeLifting?: boolean; 14686} 14687 14688/** 14689 * Define the options of invert 14690 * 14691 * @interface InvertOptions 14692 * @syscap SystemCapability.ArkUI.ArkUI.Full 14693 * @since 11 14694 */ 14695/** 14696 * Define the options of invert 14697 * 14698 * @interface InvertOptions 14699 * @syscap SystemCapability.ArkUI.ArkUI.Full 14700 * @atomicservice 14701 * @since 12 14702 */ 14703declare interface InvertOptions { 14704 14705 /** 14706 * Defines the low value of threshold 14707 * 14708 * @type { number } 14709 * @syscap SystemCapability.ArkUI.ArkUI.Full 14710 * @crossplatform 14711 * @since 11 14712 */ 14713 /** 14714 * Defines the low value of threshold 14715 * 14716 * @type { number } 14717 * @syscap SystemCapability.ArkUI.ArkUI.Full 14718 * @crossplatform 14719 * @atomicservice 14720 * @since 12 14721 */ 14722 low: number; 14723 14724 /** 14725 * Defines the high value of threshold 14726 * 14727 * @type { number } 14728 * @syscap SystemCapability.ArkUI.ArkUI.Full 14729 * @crossplatform 14730 * @since 11 14731 */ 14732 /** 14733 * Defines the high value of threshold 14734 * 14735 * @type { number } 14736 * @syscap SystemCapability.ArkUI.ArkUI.Full 14737 * @crossplatform 14738 * @atomicservice 14739 * @since 12 14740 */ 14741 high: number; 14742 14743 /** 14744 * Defines the threshold 14745 * 14746 * @type { number } 14747 * @syscap SystemCapability.ArkUI.ArkUI.Full 14748 * @crossplatform 14749 * @since 11 14750 */ 14751 /** 14752 * Defines the threshold 14753 * 14754 * @type { number } 14755 * @syscap SystemCapability.ArkUI.ArkUI.Full 14756 * @crossplatform 14757 * @atomicservice 14758 * @since 12 14759 */ 14760 threshold: number; 14761 14762 /** 14763 *Defines the threshold range 14764 * 14765 * @type { number } 14766 * @syscap SystemCapability.ArkUI.ArkUI.Full 14767 * @crossplatform 14768 * @since 11 14769 */ 14770 /** 14771 *Defines the threshold range 14772 * 14773 * @type { number } 14774 * @syscap SystemCapability.ArkUI.ArkUI.Full 14775 * @crossplatform 14776 * @atomicservice 14777 * @since 12 14778 */ 14779 thresholdRange: number; 14780} 14781 14782/** 14783 * Import the CircleShape type object for common method. 14784 * 14785 * @typedef { import('../api/@ohos.arkui.shape').CircleShape } CircleShape 14786 * @syscap SystemCapability.ArkUI.ArkUI.Full 14787 * @crossplatform 14788 * @form 14789 * @atomicservice 14790 * @since 12 14791 */ 14792declare type CircleShape = import('../api/@ohos.arkui.shape').CircleShape; 14793 14794/** 14795 * Import the EllipseShape type object for common method. 14796 * 14797 * @typedef { import('../api/@ohos.arkui.shape').EllipseShape } EllipseShape 14798 * @syscap SystemCapability.ArkUI.ArkUI.Full 14799 * @crossplatform 14800 * @form 14801 * @atomicservice 14802 * @since 12 14803 */ 14804declare type EllipseShape = import('../api/@ohos.arkui.shape').EllipseShape; 14805 14806/** 14807 * Import the PathShape type object for common method. 14808 * 14809 * @typedef { import('../api/@ohos.arkui.shape').PathShape } PathShape 14810 * @syscap SystemCapability.ArkUI.ArkUI.Full 14811 * @crossplatform 14812 * @form 14813 * @atomicservice 14814 * @since 12 14815 */ 14816declare type PathShape = import('../api/@ohos.arkui.shape').PathShape; 14817 14818/** 14819 * Import the RectShape type object for common method. 14820 * 14821 * @typedef { import('../api/@ohos.arkui.shape').RectShape } RectShape 14822 * @syscap SystemCapability.ArkUI.ArkUI.Full 14823 * @crossplatform 14824 * @form 14825 * @atomicservice 14826 * @since 12 14827 */ 14828declare type RectShape = import('../api/@ohos.arkui.shape').RectShape; 14829 14830/** 14831 * Defines the type that can be undefined. 14832 * 14833 * @typedef { T | undefined } Optional<T> 14834 * @syscap SystemCapability.ArkUI.ArkUI.Full 14835 * @crossplatform 14836 * @form 14837 * @atomicservice 14838 * @since 12 14839 */ 14840declare type Optional<T> = T | undefined; 14841 14842/** 14843 * CommonMethod. 14844 * 14845 * @syscap SystemCapability.ArkUI.ArkUI.Full 14846 * @since 7 14847 */ 14848/** 14849 * CommonMethod. 14850 * 14851 * @syscap SystemCapability.ArkUI.ArkUI.Full 14852 * @form 14853 * @since 9 14854 */ 14855/** 14856 * CommonMethod. 14857 * 14858 * @syscap SystemCapability.ArkUI.ArkUI.Full 14859 * @crossplatform 14860 * @form 14861 * @since 10 14862 */ 14863/** 14864 * CommonMethod. 14865 * 14866 * @syscap SystemCapability.ArkUI.ArkUI.Full 14867 * @crossplatform 14868 * @form 14869 * @atomicservice 14870 * @since 11 14871 */ 14872declare class CommonMethod<T> { 14873 /** 14874 * constructor. 14875 * 14876 * @syscap SystemCapability.ArkUI.ArkUI.Full 14877 * @systemapi 14878 * @since 7 14879 */ 14880 /** 14881 * constructor. 14882 * 14883 * @syscap SystemCapability.ArkUI.ArkUI.Full 14884 * @systemapi 14885 * @form 14886 * @since 9 14887 */ 14888 constructor(); 14889 14890 /** 14891 * Sets the width of the current component. 14892 * 14893 * @param { Length } value 14894 * @returns { T } 14895 * @syscap SystemCapability.ArkUI.ArkUI.Full 14896 * @since 7 14897 */ 14898 /** 14899 * Sets the width of the current component. 14900 * 14901 * @param { Length } value 14902 * @returns { T } 14903 * @syscap SystemCapability.ArkUI.ArkUI.Full 14904 * @form 14905 * @since 9 14906 */ 14907 /** 14908 * Sets the width of the current component. 14909 * 14910 * @param { Length } value 14911 * @returns { T } 14912 * @syscap SystemCapability.ArkUI.ArkUI.Full 14913 * @crossplatform 14914 * @form 14915 * @since 10 14916 */ 14917 /** 14918 * Sets the width of the current component. 14919 * 14920 * @param { Length } value 14921 * @returns { T } 14922 * @syscap SystemCapability.ArkUI.ArkUI.Full 14923 * @crossplatform 14924 * @form 14925 * @atomicservice 14926 * @since 11 14927 */ 14928 width(value: Length): T; 14929 14930 /** 14931 * Sets the height of the current component. 14932 * 14933 * @param { Length } value 14934 * @returns { T } 14935 * @syscap SystemCapability.ArkUI.ArkUI.Full 14936 * @since 7 14937 */ 14938 /** 14939 * Sets the height of the current component. 14940 * 14941 * @param { Length } value 14942 * @returns { T } 14943 * @syscap SystemCapability.ArkUI.ArkUI.Full 14944 * @form 14945 * @since 9 14946 */ 14947 /** 14948 * Sets the height of the current component. 14949 * 14950 * @param { Length } value 14951 * @returns { T } 14952 * @syscap SystemCapability.ArkUI.ArkUI.Full 14953 * @crossplatform 14954 * @form 14955 * @since 10 14956 */ 14957 /** 14958 * Sets the height of the current component. 14959 * 14960 * @param { Length } value 14961 * @returns { T } 14962 * @syscap SystemCapability.ArkUI.ArkUI.Full 14963 * @crossplatform 14964 * @form 14965 * @atomicservice 14966 * @since 11 14967 */ 14968 height(value: Length): T; 14969 14970 /** 14971 * Sets the drawModifier of the current component. 14972 * 14973 * @param { DrawModifier | undefined } modifier - drawModifier used to draw, or undefined if it is not available. 14974 * @returns { T } 14975 * @syscap SystemCapability.ArkUI.ArkUI.Full 14976 * @crossplatform 14977 * @atomicservice 14978 * @since 12 14979 */ 14980 drawModifier(modifier: DrawModifier | undefined): T; 14981 14982 /** 14983 * Sets the custom property of the current component. 14984 * 14985 * @param { string } name - the name of the custom property. 14986 * @param { Optional<Object> } value - the value of the custom property. 14987 * @returns { T } 14988 * @syscap SystemCapability.ArkUI.ArkUI.Full 14989 * @crossplatform 14990 * @atomicservice 14991 * @since 12 14992 */ 14993 customProperty(name: string, value: Optional<Object>): T; 14994 14995 /** 14996 * Expands the safe area. 14997 * 14998 * @param { Array<SafeAreaType> } types - Indicates the types of the safe area. 14999 * @param { Array<SafeAreaEdge> } edges - Indicates the edges of the safe area. 15000 * @returns { T } The component instance. 15001 * @syscap SystemCapability.ArkUI.ArkUI.Full 15002 * @crossplatform 15003 * @since 10 15004 */ 15005 /** 15006 * Expands the safe area. 15007 * 15008 * @param { Array<SafeAreaType> } types - Indicates the types of the safe area. 15009 * @param { Array<SafeAreaEdge> } edges - Indicates the edges of the safe area. 15010 * @returns { T } The component instance. 15011 * @syscap SystemCapability.ArkUI.ArkUI.Full 15012 * @crossplatform 15013 * @atomicservice 15014 * @since 11 15015 */ 15016 expandSafeArea(types?: Array<SafeAreaType>, edges?: Array<SafeAreaEdge>): T; 15017 15018 /** 15019 * Sets the response region of the current component. 15020 * 15021 * @param { Array<Rectangle> | Rectangle } value 15022 * @returns { T } 15023 * @syscap SystemCapability.ArkUI.ArkUI.Full 15024 * @since 8 15025 */ 15026 /** 15027 * Sets the response region of the current component. 15028 * 15029 * @param { Array<Rectangle> | Rectangle } value 15030 * @returns { T } 15031 * @syscap SystemCapability.ArkUI.ArkUI.Full 15032 * @form 15033 * @since 9 15034 */ 15035 /** 15036 * Sets the response region of the current component. 15037 * 15038 * @param { Array<Rectangle> | Rectangle } value 15039 * @returns { T } 15040 * @syscap SystemCapability.ArkUI.ArkUI.Full 15041 * @crossplatform 15042 * @form 15043 * @since 10 15044 */ 15045 /** 15046 * Sets the response region of the current component. 15047 * 15048 * @param { Array<Rectangle> | Rectangle } value 15049 * @returns { T } 15050 * @syscap SystemCapability.ArkUI.ArkUI.Full 15051 * @crossplatform 15052 * @form 15053 * @atomicservice 15054 * @since 11 15055 */ 15056 responseRegion(value: Array<Rectangle> | Rectangle): T; 15057 15058 /** 15059 * Sets the mouse response region of current component 15060 * 15061 * @param { Array<Rectangle> | Rectangle } value 15062 * @returns { T } return the component attribute 15063 * @syscap SystemCapability.ArkUI.ArkUI.Full 15064 * @crossplatform 15065 * @since 10 15066 */ 15067 /** 15068 * Sets the mouse response region of current component 15069 * 15070 * @param { Array<Rectangle> | Rectangle } value 15071 * @returns { T } return the component attribute 15072 * @syscap SystemCapability.ArkUI.ArkUI.Full 15073 * @crossplatform 15074 * @atomicservice 15075 * @since 11 15076 */ 15077 mouseResponseRegion(value: Array<Rectangle> | Rectangle): T; 15078 15079 /** 15080 * The size of the current component. 15081 * 15082 * @param { SizeOptions } value 15083 * @returns { T } 15084 * @syscap SystemCapability.ArkUI.ArkUI.Full 15085 * @since 7 15086 */ 15087 /** 15088 * The size of the current component. 15089 * 15090 * @param { SizeOptions } value 15091 * @returns { T } 15092 * @syscap SystemCapability.ArkUI.ArkUI.Full 15093 * @form 15094 * @since 9 15095 */ 15096 /** 15097 * The size of the current component. 15098 * 15099 * @param { SizeOptions } value 15100 * @returns { T } 15101 * @syscap SystemCapability.ArkUI.ArkUI.Full 15102 * @crossplatform 15103 * @form 15104 * @since 10 15105 */ 15106 /** 15107 * The size of the current component. 15108 * 15109 * @param { SizeOptions } value 15110 * @returns { T } 15111 * @syscap SystemCapability.ArkUI.ArkUI.Full 15112 * @crossplatform 15113 * @form 15114 * @atomicservice 15115 * @since 11 15116 */ 15117 size(value: SizeOptions): T; 15118 15119 /** 15120 * constraint Size: 15121 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 15122 * 15123 * @param { ConstraintSizeOptions } value 15124 * @returns { T } 15125 * @syscap SystemCapability.ArkUI.ArkUI.Full 15126 * @since 7 15127 */ 15128 /** 15129 * constraint Size: 15130 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 15131 * 15132 * @param { ConstraintSizeOptions } value 15133 * @returns { T } 15134 * @syscap SystemCapability.ArkUI.ArkUI.Full 15135 * @form 15136 * @since 9 15137 */ 15138 /** 15139 * constraint Size: 15140 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 15141 * 15142 * @param { ConstraintSizeOptions } value 15143 * @returns { T } 15144 * @syscap SystemCapability.ArkUI.ArkUI.Full 15145 * @crossplatform 15146 * @form 15147 * @since 10 15148 */ 15149 /** 15150 * constraint Size: 15151 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 15152 * 15153 * @param { ConstraintSizeOptions } value 15154 * @returns { T } 15155 * @syscap SystemCapability.ArkUI.ArkUI.Full 15156 * @crossplatform 15157 * @form 15158 * @atomicservice 15159 * @since 11 15160 */ 15161 constraintSize(value: ConstraintSizeOptions): T; 15162 15163 /** 15164 * Sets the touchable of the current component 15165 * 15166 * @param { boolean } value 15167 * @returns { T } 15168 * @syscap SystemCapability.ArkUI.ArkUI.Full 15169 * @since 7 15170 * @deprecated since 9 15171 * @useinstead hitTestBehavior 15172 */ 15173 touchable(value: boolean): T; 15174 15175 /** 15176 * Defines the component's hit test behavior in touch events. 15177 * 15178 * @param { HitTestMode } value - the hit test mode. 15179 * @returns { T } 15180 * @syscap SystemCapability.ArkUI.ArkUI.Full 15181 * @since 9 15182 */ 15183 /** 15184 * Defines the component's hit test behavior in touch events. 15185 * 15186 * @param { HitTestMode } value - the hit test mode. 15187 * @returns { T } 15188 * @syscap SystemCapability.ArkUI.ArkUI.Full 15189 * @crossplatform 15190 * @since 10 15191 */ 15192 /** 15193 * Defines the component's hit test behavior in touch events. 15194 * 15195 * @param { HitTestMode } value - the hit test mode. 15196 * @returns { T } 15197 * @syscap SystemCapability.ArkUI.ArkUI.Full 15198 * @crossplatform 15199 * @atomicservice 15200 * @since 11 15201 */ 15202 hitTestBehavior(value: HitTestMode): T; 15203 15204 /** 15205 * Defines the pre-touch test of sub component in touch events. 15206 * 15207 * @param { function } event 15208 * @returns { T } 15209 * @syscap SystemCapability.ArkUI.ArkUI.Full 15210 * @crossplatform 15211 * @since 11 15212 */ 15213 /** 15214 * Defines the pre-touch test of sub component in touch events. 15215 * 15216 * @param { function } event 15217 * @returns { T } 15218 * @syscap SystemCapability.ArkUI.ArkUI.Full 15219 * @crossplatform 15220 * @atomicservice 15221 * @since 12 15222 */ 15223 onChildTouchTest(event: (value: Array<TouchTestInfo>) => TouchResult): T; 15224 15225 /** 15226 * layout Weight 15227 * 15228 * @param { number | string } value 15229 * @returns { T } 15230 * @syscap SystemCapability.ArkUI.ArkUI.Full 15231 * @since 7 15232 */ 15233 /** 15234 * layout Weight 15235 * 15236 * @param { number | string } value 15237 * @returns { T } 15238 * @syscap SystemCapability.ArkUI.ArkUI.Full 15239 * @form 15240 * @since 9 15241 */ 15242 /** 15243 * layout Weight 15244 * 15245 * @param { number | string } value 15246 * @returns { T } 15247 * @syscap SystemCapability.ArkUI.ArkUI.Full 15248 * @crossplatform 15249 * @form 15250 * @since 10 15251 */ 15252 /** 15253 * layout Weight 15254 * 15255 * @param { number | string } value 15256 * @returns { T } 15257 * @syscap SystemCapability.ArkUI.ArkUI.Full 15258 * @crossplatform 15259 * @form 15260 * @atomicservice 15261 * @since 11 15262 */ 15263 layoutWeight(value: number | string): T; 15264 15265 /** 15266 * Inner margin. 15267 * 15268 * @param { Padding | Length } value 15269 * @returns { T } 15270 * @syscap SystemCapability.ArkUI.ArkUI.Full 15271 * @since 7 15272 */ 15273 /** 15274 * Inner margin. 15275 * 15276 * @param { Padding | Length } value 15277 * @returns { T } 15278 * @syscap SystemCapability.ArkUI.ArkUI.Full 15279 * @form 15280 * @since 9 15281 */ 15282 /** 15283 * Inner margin. 15284 * 15285 * @param { Padding | Length } value 15286 * @returns { T } 15287 * @syscap SystemCapability.ArkUI.ArkUI.Full 15288 * @crossplatform 15289 * @form 15290 * @since 10 15291 */ 15292 /** 15293 * Inner margin. 15294 * 15295 * @param { Padding | Length } value 15296 * @returns { T } 15297 * @syscap SystemCapability.ArkUI.ArkUI.Full 15298 * @crossplatform 15299 * @form 15300 * @atomicservice 15301 * @since 11 15302 */ 15303 /** 15304 * Inner margin. 15305 * 15306 * @param { Padding | Length | LocalizedPadding } value 15307 * @returns { T } 15308 * @syscap SystemCapability.ArkUI.ArkUI.Full 15309 * @crossplatform 15310 * @form 15311 * @atomicservice 15312 * @since 12 15313 */ 15314 padding(value: Padding | Length | LocalizedPadding): T; 15315 15316 /** 15317 * Outer Margin. 15318 * 15319 * @param { Margin | Length } value 15320 * @returns { T } 15321 * @syscap SystemCapability.ArkUI.ArkUI.Full 15322 * @since 7 15323 */ 15324 /** 15325 * Outer Margin. 15326 * 15327 * @param { Margin | Length } value 15328 * @returns { T } 15329 * @syscap SystemCapability.ArkUI.ArkUI.Full 15330 * @form 15331 * @since 9 15332 */ 15333 /** 15334 * Outer Margin. 15335 * 15336 * @param { Margin | Length } value 15337 * @returns { T } 15338 * @syscap SystemCapability.ArkUI.ArkUI.Full 15339 * @crossplatform 15340 * @form 15341 * @since 10 15342 */ 15343 /** 15344 * Outer Margin. 15345 * 15346 * @param { Margin | Length } value 15347 * @returns { T } 15348 * @syscap SystemCapability.ArkUI.ArkUI.Full 15349 * @crossplatform 15350 * @form 15351 * @atomicservice 15352 * @since 11 15353 */ 15354 /** 15355 * Outer Margin. 15356 * 15357 * @param { Margin | Length | LocalizedMargin } value 15358 * @returns { T } 15359 * @syscap SystemCapability.ArkUI.ArkUI.Full 15360 * @crossplatform 15361 * @form 15362 * @atomicservice 15363 * @since 12 15364 */ 15365 margin(value: Margin | Length | LocalizedMargin): T; 15366 15367 /** 15368 * Background. 15369 * 15370 * @param { CustomBuilder } builder 15371 * @param { object } options 15372 * @returns { T } 15373 * @syscap SystemCapability.ArkUI.ArkUI.Full 15374 * @crossplatform 15375 * @since 10 15376 */ 15377 /** 15378 * Background. 15379 * 15380 * @param { CustomBuilder } builder 15381 * @param { object } options 15382 * @returns { T } 15383 * @syscap SystemCapability.ArkUI.ArkUI.Full 15384 * @crossplatform 15385 * @atomicservice 15386 * @since 11 15387 */ 15388 background(builder: CustomBuilder, options?: { align?: Alignment }): T; 15389 15390 /** 15391 * Background color 15392 * 15393 * @param { ResourceColor } value 15394 * @returns { T } 15395 * @syscap SystemCapability.ArkUI.ArkUI.Full 15396 * @since 7 15397 */ 15398 /** 15399 * Background color 15400 * 15401 * @param { ResourceColor } value 15402 * @returns { T } 15403 * @syscap SystemCapability.ArkUI.ArkUI.Full 15404 * @form 15405 * @since 9 15406 */ 15407 /** 15408 * Background color 15409 * 15410 * @param { ResourceColor } value 15411 * @returns { T } 15412 * @syscap SystemCapability.ArkUI.ArkUI.Full 15413 * @crossplatform 15414 * @form 15415 * @since 10 15416 */ 15417 /** 15418 * Background color 15419 * 15420 * @param { ResourceColor } value 15421 * @returns { T } 15422 * @syscap SystemCapability.ArkUI.ArkUI.Full 15423 * @crossplatform 15424 * @form 15425 * @atomicservice 15426 * @since 11 15427 */ 15428 backgroundColor(value: ResourceColor): T; 15429 15430 /** 15431 * PixelRound 15432 * 15433 * @param { PixelRoundPolicy } value - indicates the pixel round policy. 15434 * @returns { T } 15435 * @syscap SystemCapability.ArkUI.ArkUI.Full 15436 * @crossplatform 15437 * @form 15438 * @atomicservice 15439 * @since 11 15440 */ 15441 pixelRound(value: PixelRoundPolicy): T; 15442 15443 /** 15444 * Background image 15445 * src: Image address url 15446 * 15447 * @param { ResourceStr } src 15448 * @param { ImageRepeat } repeat 15449 * @returns { T } 15450 * @syscap SystemCapability.ArkUI.ArkUI.Full 15451 * @since 7 15452 */ 15453 /** 15454 * Background image 15455 * src: Image address url 15456 * 15457 * @param { ResourceStr } src 15458 * @param { ImageRepeat } repeat 15459 * @returns { T } 15460 * @syscap SystemCapability.ArkUI.ArkUI.Full 15461 * @form 15462 * @since 9 15463 */ 15464 /** 15465 * Background image 15466 * src: Image address url 15467 * 15468 * @param { ResourceStr } src 15469 * @param { ImageRepeat } repeat 15470 * @returns { T } 15471 * @syscap SystemCapability.ArkUI.ArkUI.Full 15472 * @crossplatform 15473 * @form 15474 * @since 10 15475 */ 15476 /** 15477 * Background image 15478 * src: Image address url 15479 * 15480 * @param { ResourceStr } src 15481 * @param { ImageRepeat } repeat 15482 * @returns { T } 15483 * @syscap SystemCapability.ArkUI.ArkUI.Full 15484 * @crossplatform 15485 * @form 15486 * @atomicservice 15487 * @since 11 15488 */ 15489 /** 15490 * Background image 15491 * src: Image address url 15492 * 15493 * @param { ResourceStr | PixelMap } src 15494 * @param { ImageRepeat } repeat 15495 * @returns { T } 15496 * @syscap SystemCapability.ArkUI.ArkUI.Full 15497 * @crossplatform 15498 * @form 15499 * @atomicservice 15500 * @since 12 15501 */ 15502 backgroundImage(src: ResourceStr | PixelMap, repeat?: ImageRepeat): T; 15503 15504 /** 15505 * Background image size 15506 * 15507 * @param { SizeOptions | ImageSize } value 15508 * @returns { T } 15509 * @syscap SystemCapability.ArkUI.ArkUI.Full 15510 * @since 7 15511 */ 15512 /** 15513 * Background image size 15514 * 15515 * @param { SizeOptions | ImageSize } value 15516 * @returns { T } 15517 * @syscap SystemCapability.ArkUI.ArkUI.Full 15518 * @form 15519 * @since 9 15520 */ 15521 /** 15522 * Background image size 15523 * 15524 * @param { SizeOptions | ImageSize } value 15525 * @returns { T } 15526 * @syscap SystemCapability.ArkUI.ArkUI.Full 15527 * @crossplatform 15528 * @form 15529 * @since 10 15530 */ 15531 /** 15532 * Background image size 15533 * 15534 * @param { SizeOptions | ImageSize } value 15535 * @returns { T } 15536 * @syscap SystemCapability.ArkUI.ArkUI.Full 15537 * @crossplatform 15538 * @form 15539 * @atomicservice 15540 * @since 11 15541 */ 15542 backgroundImageSize(value: SizeOptions | ImageSize): T; 15543 15544 /** 15545 * Background image position 15546 * x:Horizontal coordinate;y:Vertical axis coordinate. 15547 * 15548 * @param { Position | Alignment } value 15549 * @returns { T } 15550 * @syscap SystemCapability.ArkUI.ArkUI.Full 15551 * @since 7 15552 */ 15553 /** 15554 * Background image position 15555 * x:Horizontal coordinate;y:Vertical axis coordinate. 15556 * 15557 * @param { Position | Alignment } value 15558 * @returns { T } 15559 * @syscap SystemCapability.ArkUI.ArkUI.Full 15560 * @form 15561 * @since 9 15562 */ 15563 /** 15564 * Background image position 15565 * x:Horizontal coordinate;y:Vertical axis coordinate. 15566 * 15567 * @param { Position | Alignment } value 15568 * @returns { T } 15569 * @syscap SystemCapability.ArkUI.ArkUI.Full 15570 * @crossplatform 15571 * @form 15572 * @since 10 15573 */ 15574 /** 15575 * Background image position 15576 * x:Horizontal coordinate;y:Vertical axis coordinate. 15577 * 15578 * @param { Position | Alignment } value 15579 * @returns { T } 15580 * @syscap SystemCapability.ArkUI.ArkUI.Full 15581 * @crossplatform 15582 * @form 15583 * @atomicservice 15584 * @since 11 15585 */ 15586 backgroundImagePosition(value: Position | Alignment): T; 15587 15588 /** 15589 * Background blur style. 15590 * blurStyle:Blur style type. 15591 * 15592 * @param { BlurStyle } value 15593 * @param { BackgroundBlurStyleOptions } options 15594 * @returns { T } 15595 * @syscap SystemCapability.ArkUI.ArkUI.Full 15596 * @form 15597 * @since 9 15598 */ 15599 /** 15600 * Background blur style. 15601 * blurStyle:Blur style type. 15602 * 15603 * @param { BlurStyle } value 15604 * @param { BackgroundBlurStyleOptions } options 15605 * @returns { T } 15606 * @syscap SystemCapability.ArkUI.ArkUI.Full 15607 * @crossplatform 15608 * @form 15609 * @since 10 15610 */ 15611 /** 15612 * Background blur style. 15613 * blurStyle:Blur style type. 15614 * 15615 * @param { BlurStyle } value 15616 * @param { BackgroundBlurStyleOptions } options 15617 * @returns { T } 15618 * @syscap SystemCapability.ArkUI.ArkUI.Full 15619 * @crossplatform 15620 * @form 15621 * @atomicservice 15622 * @since 11 15623 */ 15624 backgroundBlurStyle(value: BlurStyle, options?: BackgroundBlurStyleOptions): T; 15625 15626 /** 15627 * options:background effect options. 15628 * 15629 * @param { BackgroundEffectOptions } options - options indicates the effect options. 15630 * @returns { T } 15631 * @syscap SystemCapability.ArkUI.ArkUI.Full 15632 * @crossplatform 15633 * @since 11 15634 */ 15635 /** 15636 * options:background effect options. 15637 * 15638 * @param { BackgroundEffectOptions } options - options indicates the effect options. 15639 * @returns { T } 15640 * @syscap SystemCapability.ArkUI.ArkUI.Full 15641 * @crossplatform 15642 * @atomicservice 15643 * @since 12 15644 */ 15645 backgroundEffect(options: BackgroundEffectOptions): T; 15646 15647 /** 15648 * Background image resizable. 15649 * value:resizable options 15650 * 15651 * @param { ResizableOptions } value - Indicates the resizable options. 15652 * @returns { T } 15653 * @syscap SystemCapability.ArkUI.ArkUI.Full 15654 * @crossplatform 15655 * @atomicservice 15656 * @since 12 15657 */ 15658 backgroundImageResizable(value: ResizableOptions): T; 15659 15660 /** 15661 * Foreground effect. 15662 * 15663 * @param { ForegroundEffectOptions } options - options indicates the effect options. 15664 * @returns { T } 15665 * @syscap SystemCapability.ArkUI.ArkUI.Full 15666 * @crossplatform 15667 * @atomicservice 15668 * @since 12 15669 */ 15670 foregroundEffect(options: ForegroundEffectOptions): T; 15671 15672 15673 /** 15674 * Unified visual effect interface. 15675 * 15676 * @param { VisualEffect } effect - Visual effect parameters. 15677 * @returns { T } 15678 * @syscap SystemCapability.ArkUI.ArkUI.Full 15679 * @crossplatform 15680 * @atomicservice 15681 * @since 12 15682 */ 15683 visualEffect(effect: VisualEffect): T; 15684 15685 /** 15686 * Filter applied to the background layer of the component. 15687 * 15688 * @param { Filter } filter - Filter effect parameters. 15689 * @returns { T } 15690 * @syscap SystemCapability.ArkUI.ArkUI.Full 15691 * @crossplatform 15692 * @atomicservice 15693 * @since 12 15694 */ 15695 backgroundFilter(filter: Filter): T; 15696 15697 /** 15698 * Filter applied to the foreground layer of the component. 15699 * 15700 * @param { Filter } filter - Filter effect parameters. 15701 * @returns { T } 15702 * @syscap SystemCapability.ArkUI.ArkUI.Full 15703 * @crossplatform 15704 * @atomicservice 15705 * @since 12 15706 */ 15707 foregroundFilter(filter: Filter): T; 15708 15709 /** 15710 * Filter applied to the compositing layer of the component. 15711 * 15712 * @param { Filter } filter - Filter effect parameters. 15713 * @returns { T } 15714 * @syscap SystemCapability.ArkUI.ArkUI.Full 15715 * @crossplatform 15716 * @atomicservice 15717 * @since 12 15718 */ 15719 compositingFilter(filter: Filter): T; 15720 15721 /** 15722 * Foreground blur style. 15723 * blurStyle:Blur style type. 15724 * 15725 * @param { BlurStyle } value 15726 * @param { ForegroundBlurStyleOptions } options 15727 * @returns { T } 15728 * @syscap SystemCapability.ArkUI.ArkUI.Full 15729 * @crossplatform 15730 * @since 10 15731 */ 15732 /** 15733 * Foreground blur style. 15734 * blurStyle:Blur style type. 15735 * 15736 * @param { BlurStyle } value 15737 * @param { ForegroundBlurStyleOptions } options 15738 * @returns { T } 15739 * @syscap SystemCapability.ArkUI.ArkUI.Full 15740 * @crossplatform 15741 * @atomicservice 15742 * @since 11 15743 */ 15744 foregroundBlurStyle(value: BlurStyle, options?: ForegroundBlurStyleOptions): T; 15745 15746 /** 15747 * Opacity 15748 * 15749 * @param { number | Resource } value 15750 * @returns { T } 15751 * @syscap SystemCapability.ArkUI.ArkUI.Full 15752 * @since 7 15753 */ 15754 /** 15755 * Opacity 15756 * 15757 * @param { number | Resource } value 15758 * @returns { T } 15759 * @syscap SystemCapability.ArkUI.ArkUI.Full 15760 * @form 15761 * @since 9 15762 */ 15763 /** 15764 * Opacity 15765 * 15766 * @param { number | Resource } value 15767 * @returns { T } 15768 * @syscap SystemCapability.ArkUI.ArkUI.Full 15769 * @crossplatform 15770 * @form 15771 * @since 10 15772 */ 15773 /** 15774 * Opacity 15775 * 15776 * @param { number | Resource } value 15777 * @returns { T } 15778 * @syscap SystemCapability.ArkUI.ArkUI.Full 15779 * @crossplatform 15780 * @form 15781 * @atomicservice 15782 * @since 11 15783 */ 15784 opacity(value: number | Resource): T; 15785 15786 /** 15787 * Opacity 15788 * width:Border width;color:Border color;radius:Border radius; 15789 * 15790 * @param { BorderOptions } value 15791 * @returns { T } 15792 * @syscap SystemCapability.ArkUI.ArkUI.Full 15793 * @since 7 15794 */ 15795 /** 15796 * Opacity 15797 * width:Border width;color:Border color;radius:Border radius; 15798 * 15799 * @param { BorderOptions } value 15800 * @returns { T } 15801 * @syscap SystemCapability.ArkUI.ArkUI.Full 15802 * @form 15803 * @since 9 15804 */ 15805 /** 15806 * Opacity 15807 * width:Border width;color:Border color;radius:Border radius; 15808 * 15809 * @param { BorderOptions } value 15810 * @returns { T } 15811 * @syscap SystemCapability.ArkUI.ArkUI.Full 15812 * @crossplatform 15813 * @form 15814 * @since 10 15815 */ 15816 /** 15817 * Opacity 15818 * width:Border width;color:Border color;radius:Border radius; 15819 * 15820 * @param { BorderOptions } value 15821 * @returns { T } 15822 * @syscap SystemCapability.ArkUI.ArkUI.Full 15823 * @crossplatform 15824 * @form 15825 * @atomicservice 15826 * @since 11 15827 */ 15828 border(value: BorderOptions): T; 15829 15830 /** 15831 * Border style 15832 * 15833 * @param { BorderStyle } value 15834 * @returns { T } 15835 * @syscap SystemCapability.ArkUI.ArkUI.Full 15836 * @since 7 15837 */ 15838 /** 15839 * Border style 15840 * 15841 * @param { BorderStyle | EdgeStyles } value 15842 * @returns { T } 15843 * @syscap SystemCapability.ArkUI.ArkUI.Full 15844 * @form 15845 * @since 9 15846 */ 15847 /** 15848 * Border style 15849 * 15850 * @param { BorderStyle | EdgeStyles } value 15851 * @returns { T } 15852 * @syscap SystemCapability.ArkUI.ArkUI.Full 15853 * @crossplatform 15854 * @form 15855 * @since 10 15856 */ 15857 /** 15858 * Border style 15859 * 15860 * @param { BorderStyle | EdgeStyles } value 15861 * @returns { T } 15862 * @syscap SystemCapability.ArkUI.ArkUI.Full 15863 * @crossplatform 15864 * @form 15865 * @atomicservice 15866 * @since 11 15867 */ 15868 borderStyle(value: BorderStyle | EdgeStyles): T; 15869 15870 /** 15871 * Border width 15872 * 15873 * @param { Length } value 15874 * @returns { T } 15875 * @syscap SystemCapability.ArkUI.ArkUI.Full 15876 * @since 7 15877 */ 15878 /** 15879 * Border width 15880 * 15881 * @param { Length | EdgeWidths } value 15882 * @returns { T } 15883 * @syscap SystemCapability.ArkUI.ArkUI.Full 15884 * @form 15885 * @since 9 15886 */ 15887 /** 15888 * Border width 15889 * 15890 * @param { Length | EdgeWidths } value 15891 * @returns { T } 15892 * @syscap SystemCapability.ArkUI.ArkUI.Full 15893 * @crossplatform 15894 * @form 15895 * @since 10 15896 */ 15897 /** 15898 * Border width 15899 * 15900 * @param { Length | EdgeWidths } value 15901 * @returns { T } 15902 * @syscap SystemCapability.ArkUI.ArkUI.Full 15903 * @crossplatform 15904 * @form 15905 * @atomicservice 15906 * @since 11 15907 */ 15908 /** 15909 * Border width 15910 * 15911 * @param { Length | EdgeWidths | LocalizedEdgeWidths } value 15912 * @returns { T } 15913 * @syscap SystemCapability.ArkUI.ArkUI.Full 15914 * @crossplatform 15915 * @form 15916 * @atomicservice 15917 * @since 12 15918 */ 15919 borderWidth(value: Length | EdgeWidths | LocalizedEdgeWidths): T; 15920 15921 /** 15922 * Border color 15923 * 15924 * @param { ResourceColor } value 15925 * @returns { T } 15926 * @syscap SystemCapability.ArkUI.ArkUI.Full 15927 * @since 7 15928 */ 15929 /** 15930 * Border color 15931 * 15932 * @param { ResourceColor | EdgeColors } value 15933 * @returns { T } 15934 * @syscap SystemCapability.ArkUI.ArkUI.Full 15935 * @form 15936 * @since 9 15937 */ 15938 /** 15939 * Border color 15940 * 15941 * @param { ResourceColor | EdgeColors } value 15942 * @returns { T } 15943 * @syscap SystemCapability.ArkUI.ArkUI.Full 15944 * @crossplatform 15945 * @form 15946 * @since 10 15947 */ 15948 /** 15949 * Border color 15950 * 15951 * @param { ResourceColor | EdgeColors } value 15952 * @returns { T } 15953 * @syscap SystemCapability.ArkUI.ArkUI.Full 15954 * @crossplatform 15955 * @form 15956 * @atomicservice 15957 * @since 11 15958 */ 15959 /** 15960 * Border color 15961 * 15962 * @param { ResourceColor | EdgeColors | LocalizedEdgeColors } value 15963 * @returns { T } 15964 * @syscap SystemCapability.ArkUI.ArkUI.Full 15965 * @crossplatform 15966 * @form 15967 * @atomicservice 15968 * @since 12 15969 */ 15970 borderColor(value: ResourceColor | EdgeColors | LocalizedEdgeColors): T; 15971 15972 /** 15973 * Border radius 15974 * 15975 * @param { Length } value 15976 * @returns { T } 15977 * @syscap SystemCapability.ArkUI.ArkUI.Full 15978 * @since 7 15979 */ 15980 /** 15981 * Border radius 15982 * 15983 * @param { Length | BorderRadiuses } value 15984 * @returns { T } 15985 * @syscap SystemCapability.ArkUI.ArkUI.Full 15986 * @form 15987 * @since 9 15988 */ 15989 /** 15990 * Border radius 15991 * 15992 * @param { Length | BorderRadiuses } value 15993 * @returns { T } 15994 * @syscap SystemCapability.ArkUI.ArkUI.Full 15995 * @crossplatform 15996 * @form 15997 * @since 10 15998 */ 15999 /** 16000 * Border radius 16001 * 16002 * @param { Length | BorderRadiuses } value 16003 * @returns { T } 16004 * @syscap SystemCapability.ArkUI.ArkUI.Full 16005 * @crossplatform 16006 * @form 16007 * @atomicservice 16008 * @since 11 16009 */ 16010 /** 16011 * Border radius 16012 * 16013 * @param { Length | BorderRadiuses | LocalizedBorderRadiuses } value 16014 * @returns { T } 16015 * @syscap SystemCapability.ArkUI.ArkUI.Full 16016 * @crossplatform 16017 * @form 16018 * @atomicservice 16019 * @since 12 16020 */ 16021 borderRadius(value: Length | BorderRadiuses | LocalizedBorderRadiuses): T; 16022 16023 /** 16024 * Border image 16025 * 16026 * @param { BorderImageOption } value 16027 * @returns { T } 16028 * @syscap SystemCapability.ArkUI.ArkUI.Full 16029 * @form 16030 * @since 9 16031 */ 16032 /** 16033 * Border image 16034 * 16035 * @param { BorderImageOption } value 16036 * @returns { T } 16037 * @syscap SystemCapability.ArkUI.ArkUI.Full 16038 * @crossplatform 16039 * @form 16040 * @since 10 16041 */ 16042 /** 16043 * Border image 16044 * 16045 * @param { BorderImageOption } value 16046 * @returns { T } 16047 * @syscap SystemCapability.ArkUI.ArkUI.Full 16048 * @crossplatform 16049 * @form 16050 * @atomicservice 16051 * @since 11 16052 */ 16053 borderImage(value: BorderImageOption): T; 16054 16055 /** 16056 * Outline 16057 * width:Outline width;color:Outline color;radius:Outline radius;style:Outline style; 16058 * 16059 * @param { OutlineOptions } value 16060 * @returns { T } 16061 * @syscap SystemCapability.ArkUI.ArkUI.Full 16062 * @crossplatform 16063 * @form 16064 * @since 11 16065 */ 16066 /** 16067 * Outline 16068 * width:Outline width;color:Outline color;radius:Outline radius;style:Outline style; 16069 * 16070 * @param { OutlineOptions } value 16071 * @returns { T } 16072 * @syscap SystemCapability.ArkUI.ArkUI.Full 16073 * @crossplatform 16074 * @form 16075 * @atomicservice 16076 * @since 12 16077 */ 16078 outline(value: OutlineOptions): T; 16079 16080 /** 16081 * Outline style 16082 * The input parameter default value is OutlineStyle.SOLID 16083 * 16084 * @param { OutlineStyle | EdgeOutlineStyles } value 16085 * @returns { T } 16086 * @syscap SystemCapability.ArkUI.ArkUI.Full 16087 * @crossplatform 16088 * @form 16089 * @since 11 16090 */ 16091 /** 16092 * Outline style 16093 * 16094 * @param { OutlineStyle | EdgeOutlineStyles } value 16095 * @returns { T } 16096 * @syscap SystemCapability.ArkUI.ArkUI.Full 16097 * @crossplatform 16098 * @form 16099 * @atomicservice 16100 * @since 12 16101 */ 16102 outlineStyle(value: OutlineStyle | EdgeOutlineStyles): T; 16103 16104 /** 16105 * Outline width 16106 * The input parameter default value is 0 16107 * 16108 * @param { Dimension | EdgeOutlineWidths } value 16109 * @returns { T } 16110 * @syscap SystemCapability.ArkUI.ArkUI.Full 16111 * @crossplatform 16112 * @form 16113 * @since 11 16114 */ 16115 /** 16116 * Outline width 16117 * 16118 * @param { Dimension | EdgeOutlineWidths } value 16119 * @returns { T } 16120 * @syscap SystemCapability.ArkUI.ArkUI.Full 16121 * @crossplatform 16122 * @form 16123 * @atomicservice 16124 * @since 12 16125 */ 16126 outlineWidth(value: Dimension | EdgeOutlineWidths): T; 16127 16128 /** 16129 * Outline color 16130 * The input parameter default value is Color.Black 16131 * 16132 * @param { ResourceColor | EdgeColors } value 16133 * @returns { T } 16134 * @syscap SystemCapability.ArkUI.ArkUI.Full 16135 * @crossplatform 16136 * @form 16137 * @since 11 16138 */ 16139 /** 16140 * Outline color 16141 * 16142 * @param { ResourceColor | EdgeColors | LocalizedEdgeColors } value 16143 * @returns { T } 16144 * @syscap SystemCapability.ArkUI.ArkUI.Full 16145 * @crossplatform 16146 * @form 16147 * @atomicservice 16148 * @since 12 16149 */ 16150 outlineColor(value: ResourceColor | EdgeColors | LocalizedEdgeColors): T; 16151 16152 /** 16153 * Outline radius 16154 * The input parameter default value is 0 16155 * 16156 * @param { Dimension | OutlineRadiuses } value 16157 * @returns { T } 16158 * @syscap SystemCapability.ArkUI.ArkUI.Full 16159 * @crossplatform 16160 * @form 16161 * @since 11 16162 */ 16163 /** 16164 * Outline radius 16165 * 16166 * @param { Dimension | OutlineRadiuses } value 16167 * @returns { T } 16168 * @syscap SystemCapability.ArkUI.ArkUI.Full 16169 * @crossplatform 16170 * @form 16171 * @atomicservice 16172 * @since 12 16173 */ 16174 outlineRadius(value: Dimension | OutlineRadiuses): T; 16175 16176 /** 16177 * Provides the general foreground color capability of UI components, and assigns color values 16178 * according to the characteristics of components. 16179 * 16180 * @param { ResourceColor | ColoringStrategy } value - indicates the color or color selection strategy 16181 * @returns { T } 16182 * @syscap SystemCapability.ArkUI.ArkUI.Full 16183 * @crossplatform 16184 * @since 10 16185 */ 16186 /** 16187 * Provides the general foreground color capability of UI components, and assigns color values 16188 * according to the characteristics of components. 16189 * 16190 * @param { ResourceColor | ColoringStrategy } value - indicates the color or color selection strategy 16191 * @returns { T } 16192 * @syscap SystemCapability.ArkUI.ArkUI.Full 16193 * @crossplatform 16194 * @atomicservice 16195 * @since 11 16196 */ 16197 foregroundColor(value: ResourceColor | ColoringStrategy): T; 16198 16199 /** 16200 * Trigger a click event when a click is clicked. 16201 * 16202 * @param { function } event 16203 * @returns { T } 16204 * @syscap SystemCapability.ArkUI.ArkUI.Full 16205 * @since 7 16206 */ 16207 /** 16208 * Trigger a click event when a click is clicked. 16209 * 16210 * @param { function } event 16211 * @returns { T } 16212 * @syscap SystemCapability.ArkUI.ArkUI.Full 16213 * @form 16214 * @since 9 16215 */ 16216 /** 16217 * Trigger a click event when a click is clicked. 16218 * 16219 * @param { function } event 16220 * @returns { T } 16221 * @syscap SystemCapability.ArkUI.ArkUI.Full 16222 * @crossplatform 16223 * @form 16224 * @since 10 16225 */ 16226 /** 16227 * Trigger a click event when a click is clicked. 16228 * 16229 * @param { function } event 16230 * @returns { T } 16231 * @syscap SystemCapability.ArkUI.ArkUI.Full 16232 * @crossplatform 16233 * @form 16234 * @atomicservice 16235 * @since 11 16236 */ 16237 onClick(event: (event: ClickEvent) => void): T; 16238 16239 /** 16240 * Trigger a click event when a click is clicked, move distance should smaller than distanceThreshold. 16241 * 16242 * @param { function } event - this function callback executed when the click action is recognized 16243 * @param { number } distanceThreshold - the distance threshold of finger's movement when detecting a click action 16244 * @returns { T } 16245 * @syscap SystemCapability.ArkUI.ArkUI.Full 16246 * @crossplatform 16247 * @form 16248 * @atomicservice 16249 * @since 12 16250 */ 16251 onClick(event: Callback<ClickEvent>, distanceThreshold: number): T; 16252 16253 /** 16254 * Trigger a hover event. 16255 * 16256 * @param { function } event 16257 * @returns { T } 16258 * @syscap SystemCapability.ArkUI.ArkUI.Full 16259 * @since 8 16260 */ 16261 /** 16262 * Trigger a hover event. 16263 * 16264 * @param { function } event 16265 * @returns { T } 16266 * @syscap SystemCapability.ArkUI.ArkUI.Full 16267 * @crossplatform 16268 * @atomicservice 16269 * @since 11 16270 */ 16271 onHover(event: (isHover: boolean, event: HoverEvent) => void): T; 16272 16273 /** 16274 * Trigger a accessibility hover event. 16275 * 16276 * @param { AccessibilityCallback } callback - A callback instance used when the component is touched after accessibility mode is enabled. 16277 * @returns { T } 16278 * @syscap SystemCapability.ArkUI.ArkUI.Full 16279 * @crossplatform 16280 * @atomicservice 16281 * @since 12 16282 */ 16283 onAccessibilityHover(callback: AccessibilityCallback): T; 16284 16285 /** 16286 * Set hover effect. 16287 * 16288 * @param { HoverEffect } value 16289 * @returns { T } 16290 * @syscap SystemCapability.ArkUI.ArkUI.Full 16291 * @since 8 16292 */ 16293 /** 16294 * Set hover effect. 16295 * 16296 * @param { HoverEffect } value 16297 * @returns { T } 16298 * @syscap SystemCapability.ArkUI.ArkUI.Full 16299 * @crossplatform 16300 * @since 10 16301 */ 16302 /** 16303 * Set hover effect. 16304 * 16305 * @param { HoverEffect } value 16306 * @returns { T } 16307 * @syscap SystemCapability.ArkUI.ArkUI.Full 16308 * @crossplatform 16309 * @atomicservice 16310 * @since 11 16311 */ 16312 hoverEffect(value: HoverEffect): T; 16313 16314 /** 16315 * Trigger a mouse event. 16316 * 16317 * @param { function } event 16318 * @returns { T } 16319 * @syscap SystemCapability.ArkUI.ArkUI.Full 16320 * @since 8 16321 */ 16322 /** 16323 * Trigger a mouse event. 16324 * 16325 * @param { function } event 16326 * @returns { T } 16327 * @syscap SystemCapability.ArkUI.ArkUI.Full 16328 * @atomicservice 16329 * @since 11 16330 */ 16331 onMouse(event: (event: MouseEvent) => void): T; 16332 16333 /** 16334 * Trigger a touch event when touched. 16335 * 16336 * @param { function } event 16337 * @returns { T } 16338 * @syscap SystemCapability.ArkUI.ArkUI.Full 16339 * @since 7 16340 */ 16341 /** 16342 * Trigger a touch event when touched. 16343 * 16344 * @param { function } event 16345 * @returns { T } 16346 * @syscap SystemCapability.ArkUI.ArkUI.Full 16347 * @crossplatform 16348 * @since 10 16349 */ 16350 /** 16351 * Trigger a touch event when touched. 16352 * 16353 * @param { function } event 16354 * @returns { T } 16355 * @syscap SystemCapability.ArkUI.ArkUI.Full 16356 * @crossplatform 16357 * @atomicservice 16358 * @since 11 16359 */ 16360 onTouch(event: (event: TouchEvent) => void): T; 16361 16362 /** 16363 * Keyboard input 16364 * 16365 * @param { function } event 16366 * @returns { T } 16367 * @syscap SystemCapability.ArkUI.ArkUI.Full 16368 * @since 7 16369 */ 16370 /** 16371 * Keyboard input 16372 * 16373 * @param { function } event 16374 * @returns { T } 16375 * @syscap SystemCapability.ArkUI.ArkUI.Full 16376 * @crossplatform 16377 * @since 10 16378 */ 16379 /** 16380 * Keyboard input 16381 * 16382 * @param { function } event 16383 * @returns { T } 16384 * @syscap SystemCapability.ArkUI.ArkUI.Full 16385 * @crossplatform 16386 * @atomicservice 16387 * @since 11 16388 */ 16389 onKeyEvent(event: (event: KeyEvent) => void): T; 16390 16391 /** 16392 * Handle keyboard events before input method events. 16393 * 16394 * @param { Callback<KeyEvent, boolean> } event 16395 * @returns { T } 16396 * @syscap SystemCapability.ArkUI.ArkUI.Full 16397 * @crossplatform 16398 * @atomicservice 16399 * @since 12 16400 */ 16401 onKeyPreIme(event: Callback<KeyEvent, boolean>): T; 16402 16403 /** 16404 * Set focusable. 16405 * 16406 * @param { boolean } value 16407 * @returns { T } 16408 * @syscap SystemCapability.ArkUI.ArkUI.Full 16409 * @since 8 16410 */ 16411 /** 16412 * Set focusable. 16413 * 16414 * @param { boolean } value 16415 * @returns { T } 16416 * @syscap SystemCapability.ArkUI.ArkUI.Full 16417 * @crossplatform 16418 * @since 10 16419 */ 16420 /** 16421 * Set focusable. 16422 * 16423 * @param { boolean } value 16424 * @returns { T } 16425 * @syscap SystemCapability.ArkUI.ArkUI.Full 16426 * @crossplatform 16427 * @atomicservice 16428 * @since 11 16429 */ 16430 focusable(value: boolean): T; 16431 16432 /** 16433 * Trigger a event when got focus. 16434 * 16435 * @param { function } event 16436 * @returns { T } 16437 * @syscap SystemCapability.ArkUI.ArkUI.Full 16438 * @since 8 16439 */ 16440 /** 16441 * Trigger a event when got focus. 16442 * 16443 * @param { function } event 16444 * @returns { T } 16445 * @syscap SystemCapability.ArkUI.ArkUI.Full 16446 * @crossplatform 16447 * @since 10 16448 */ 16449 /** 16450 * Trigger a event when got focus. 16451 * 16452 * @param { function } event 16453 * @returns { T } 16454 * @syscap SystemCapability.ArkUI.ArkUI.Full 16455 * @crossplatform 16456 * @atomicservice 16457 * @since 11 16458 */ 16459 onFocus(event: () => void): T; 16460 16461 /** 16462 * Trigger a event when lose focus. 16463 * 16464 * @param { function } event 16465 * @returns { T } 16466 * @syscap SystemCapability.ArkUI.ArkUI.Full 16467 * @since 8 16468 */ 16469 /** 16470 * Trigger a event when lose focus. 16471 * 16472 * @param { function } event 16473 * @returns { T } 16474 * @syscap SystemCapability.ArkUI.ArkUI.Full 16475 * @crossplatform 16476 * @since 10 16477 */ 16478 /** 16479 * Trigger a event when lose focus. 16480 * 16481 * @param { function } event 16482 * @returns { T } 16483 * @syscap SystemCapability.ArkUI.ArkUI.Full 16484 * @crossplatform 16485 * @atomicservice 16486 * @since 11 16487 */ 16488 onBlur(event: () => void): T; 16489 16490 /** 16491 * Set focus index by key tab. 16492 * 16493 * @param { number } index 16494 * @returns { T } 16495 * @syscap SystemCapability.ArkUI.ArkUI.Full 16496 * @since 9 16497 */ 16498 /** 16499 * Set focus index by key tab. 16500 * 16501 * @param { number } index 16502 * @returns { T } 16503 * @syscap SystemCapability.ArkUI.ArkUI.Full 16504 * @crossplatform 16505 * @since 10 16506 */ 16507 /** 16508 * Set focus index by key tab. 16509 * 16510 * @param { number } index 16511 * @returns { T } 16512 * @syscap SystemCapability.ArkUI.ArkUI.Full 16513 * @crossplatform 16514 * @atomicservice 16515 * @since 11 16516 */ 16517 tabIndex(index: number): T; 16518 16519 /** 16520 * Set default focused component when a page create. 16521 * 16522 * @param { boolean } value 16523 * @returns { T } 16524 * @syscap SystemCapability.ArkUI.ArkUI.Full 16525 * @since 9 16526 */ 16527 /** 16528 * Set default focused component when a page create. 16529 * 16530 * @param { boolean } value 16531 * @returns { T } 16532 * @syscap SystemCapability.ArkUI.ArkUI.Full 16533 * @crossplatform 16534 * @since 10 16535 */ 16536 /** 16537 * Set default focused component when a page create. 16538 * 16539 * @param { boolean } value 16540 * @returns { T } 16541 * @syscap SystemCapability.ArkUI.ArkUI.Full 16542 * @crossplatform 16543 * @atomicservice 16544 * @since 11 16545 */ 16546 defaultFocus(value: boolean): T; 16547 16548 /** 16549 * Set default focused component when focus on a focus group. 16550 * 16551 * @param { boolean } value 16552 * @returns { T } 16553 * @syscap SystemCapability.ArkUI.ArkUI.Full 16554 * @since 9 16555 */ 16556 /** 16557 * Set default focused component when focus on a focus group. 16558 * 16559 * @param { boolean } value 16560 * @returns { T } 16561 * @syscap SystemCapability.ArkUI.ArkUI.Full 16562 * @crossplatform 16563 * @since 10 16564 */ 16565 /** 16566 * Set default focused component when focus on a focus group. 16567 * 16568 * @param { boolean } value 16569 * @returns { T } 16570 * @syscap SystemCapability.ArkUI.ArkUI.Full 16571 * @crossplatform 16572 * @atomicservice 16573 * @since 11 16574 */ 16575 groupDefaultFocus(value: boolean): T; 16576 16577 /** 16578 * Set a component focused when the component be touched. 16579 * 16580 * @param { boolean } value 16581 * @returns { T } 16582 * @syscap SystemCapability.ArkUI.ArkUI.Full 16583 * @since 9 16584 */ 16585 /** 16586 * Set a component focused when the component be touched. 16587 * 16588 * @param { boolean } value 16589 * @returns { T } 16590 * @syscap SystemCapability.ArkUI.ArkUI.Full 16591 * @crossplatform 16592 * @since 10 16593 */ 16594 /** 16595 * Set a component focused when the component be touched. 16596 * 16597 * @param { boolean } value 16598 * @returns { T } 16599 * @syscap SystemCapability.ArkUI.ArkUI.Full 16600 * @crossplatform 16601 * @atomicservice 16602 * @since 11 16603 */ 16604 focusOnTouch(value: boolean): T; 16605 16606 /** 16607 * Set the component's focusBox style. 16608 * 16609 * @param { FocusBoxStyle } style 16610 * @returns { T } 16611 * @syscap SystemCapability.ArkUI.ArkUI.Full 16612 * @crossplatform 16613 * @atomicservice 16614 * @since 12 16615 */ 16616 focusBox(style: FocusBoxStyle): T; 16617 16618 /** 16619 * Set container as a focus group with a specific identifier. 16620 * 16621 * @param { string } id - focus scope identifier. 16622 * @param { boolean } [isGroup] - whether this scope is a focus group, the default value is false 16623 * @returns { T } 16624 * @syscap SystemCapability.ArkUI.ArkUI.Full 16625 * @crossplatform 16626 * @atomicservice 16627 * @since 12 16628 */ 16629 focusScopeId(id: string, isGroup?: boolean): T; 16630 16631 /** 16632 * Set the focus priority of component in a specific focus scope. 16633 * 16634 * @param { string } scopeId 16635 * @param { FocusPriority } [priority] - the default value is AUTO 16636 * @returns { T } 16637 * @syscap SystemCapability.ArkUI.ArkUI.Full 16638 * @crossplatform 16639 * @atomicservice 16640 * @since 12 16641 */ 16642 focusScopePriority(scopeId: string, priority?: FocusPriority): T; 16643 16644 /** 16645 * animation 16646 * 16647 * @param { AnimateParam } value 16648 * @returns { T } 16649 * @syscap SystemCapability.ArkUI.ArkUI.Full 16650 * @since 7 16651 */ 16652 /** 16653 * animation 16654 * 16655 * @param { AnimateParam } value 16656 * @returns { T } 16657 * @syscap SystemCapability.ArkUI.ArkUI.Full 16658 * @form 16659 * @since 9 16660 */ 16661 /** 16662 * animation 16663 * 16664 * @param { AnimateParam } value 16665 * @returns { T } 16666 * @syscap SystemCapability.ArkUI.ArkUI.Full 16667 * @crossplatform 16668 * @form 16669 * @since 10 16670 */ 16671 /** 16672 * animation 16673 * 16674 * @param { AnimateParam } value 16675 * @returns { T } 16676 * @syscap SystemCapability.ArkUI.ArkUI.Full 16677 * @crossplatform 16678 * @form 16679 * @atomicservice 16680 * @since 11 16681 */ 16682 animation(value: AnimateParam): T; 16683 16684 /** 16685 * Transition parameter 16686 * 16687 * @param { TransitionOptions | TransitionEffect } value 16688 * @returns { T } 16689 * @syscap SystemCapability.ArkUI.ArkUI.Full 16690 * @since 7 16691 */ 16692 /** 16693 * Transition parameter 16694 * 16695 * @param { TransitionOptions | TransitionEffect } value - transition options 16696 * @returns { T } 16697 * @syscap SystemCapability.ArkUI.ArkUI.Full 16698 * @form 16699 * @since 9 16700 */ 16701 /** 16702 * Transition parameter 16703 * 16704 * @param { TransitionOptions | TransitionEffect } value - transition options or transition effect 16705 * @returns { T } 16706 * @syscap SystemCapability.ArkUI.ArkUI.Full 16707 * @crossplatform 16708 * @form 16709 * @since 10 16710 */ 16711 /** 16712 * Transition parameter 16713 * 16714 * @param { TransitionOptions | TransitionEffect } value - transition options or transition effect 16715 * @returns { T } 16716 * @syscap SystemCapability.ArkUI.ArkUI.Full 16717 * @crossplatform 16718 * @form 16719 * @atomicservice 16720 * @since 11 16721 */ 16722 transition(value: TransitionOptions | TransitionEffect): T; 16723 16724 /** 16725 * Set the transition effect of component when it appears and disappears. 16726 * 16727 * @param { TransitionEffect } effect - transition effect 16728 * @param { Optional<TransitionFinishCallback> } onFinish - transition finish callback. 16729 * @returns { T } 16730 * @syscap SystemCapability.ArkUI.ArkUI.Full 16731 * @crossplatform 16732 * @form 16733 * @atomicservice 16734 * @since 12 16735 */ 16736 transition(effect: TransitionEffect, onFinish: Optional<TransitionFinishCallback>): T; 16737 16738 /** 16739 * Bind gesture recognition. 16740 * gesture:Bound Gesture Type,mask:GestureMask; 16741 * 16742 * @param { GestureType } gesture 16743 * @param { GestureMask } mask 16744 * @returns { T } 16745 * @syscap SystemCapability.ArkUI.ArkUI.Full 16746 * @since 7 16747 */ 16748 /** 16749 * Bind gesture recognition. 16750 * gesture:Bound Gesture Type,mask:GestureMask; 16751 * 16752 * @param { GestureType } gesture 16753 * @param { GestureMask } mask 16754 * @returns { T } 16755 * @syscap SystemCapability.ArkUI.ArkUI.Full 16756 * @crossplatform 16757 * @since 10 16758 */ 16759 /** 16760 * Bind gesture recognition. 16761 * gesture:Bound Gesture Type,mask:GestureMask; 16762 * 16763 * @param { GestureType } gesture 16764 * @param { GestureMask } mask 16765 * @returns { T } 16766 * @syscap SystemCapability.ArkUI.ArkUI.Full 16767 * @crossplatform 16768 * @atomicservice 16769 * @since 11 16770 */ 16771 gesture(gesture: GestureType, mask?: GestureMask): T; 16772 16773 /** 16774 * Binding Preferential Recognition Gestures 16775 * gesture:Bound Gesture Type,mask:GestureMask; 16776 * 16777 * @param { GestureType } gesture 16778 * @param { GestureMask } mask 16779 * @returns { T } 16780 * @syscap SystemCapability.ArkUI.ArkUI.Full 16781 * @since 7 16782 */ 16783 /** 16784 * Binding Preferential Recognition Gestures 16785 * gesture:Bound Gesture Type,mask:GestureMask; 16786 * 16787 * @param { GestureType } gesture 16788 * @param { GestureMask } mask 16789 * @returns { T } 16790 * @syscap SystemCapability.ArkUI.ArkUI.Full 16791 * @crossplatform 16792 * @since 10 16793 */ 16794 /** 16795 * Binding Preferential Recognition Gestures 16796 * gesture:Bound Gesture Type,mask:GestureMask; 16797 * 16798 * @param { GestureType } gesture 16799 * @param { GestureMask } mask 16800 * @returns { T } 16801 * @syscap SystemCapability.ArkUI.ArkUI.Full 16802 * @crossplatform 16803 * @atomicservice 16804 * @since 11 16805 */ 16806 priorityGesture(gesture: GestureType, mask?: GestureMask): T; 16807 16808 /** 16809 * Binding gestures that can be triggered simultaneously with internal component gestures 16810 * gesture:Bound Gesture Type,mask:GestureMask; 16811 * 16812 * @param { GestureType } gesture 16813 * @param { GestureMask } mask 16814 * @returns { T } 16815 * @syscap SystemCapability.ArkUI.ArkUI.Full 16816 * @since 7 16817 */ 16818 /** 16819 * Binding gestures that can be triggered simultaneously with internal component gestures 16820 * gesture:Bound Gesture Type,mask:GestureMask; 16821 * 16822 * @param { GestureType } gesture 16823 * @param { GestureMask } mask 16824 * @returns { T } 16825 * @syscap SystemCapability.ArkUI.ArkUI.Full 16826 * @crossplatform 16827 * @since 10 16828 */ 16829 /** 16830 * Binding gestures that can be triggered simultaneously with internal component gestures 16831 * gesture:Bound Gesture Type,mask:GestureMask; 16832 * 16833 * @param { GestureType } gesture 16834 * @param { GestureMask } mask 16835 * @returns { T } 16836 * @syscap SystemCapability.ArkUI.ArkUI.Full 16837 * @crossplatform 16838 * @atomicservice 16839 * @since 11 16840 */ 16841 parallelGesture(gesture: GestureType, mask?: GestureMask): T; 16842 16843 /** 16844 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 16845 * The larger the blurring radius, the more blurring the content. 16846 * If the value is 0, the content blurring effect is not blurring. 16847 * 16848 * @param { number } value 16849 * @returns { T } 16850 * @syscap SystemCapability.ArkUI.ArkUI.Full 16851 * @since 7 16852 */ 16853 /** 16854 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 16855 * The larger the blurring radius, the more blurring the content. 16856 * If the value is 0, the content blurring effect is not blurring. 16857 * 16858 * @param { number } value 16859 * @returns { T } 16860 * @syscap SystemCapability.ArkUI.ArkUI.Full 16861 * @form 16862 * @since 9 16863 */ 16864 /** 16865 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 16866 * The larger the blurring radius, the more blurring the content. 16867 * If the value is 0, the content blurring effect is not blurring. 16868 * 16869 * @param { number } value 16870 * @returns { T } 16871 * @syscap SystemCapability.ArkUI.ArkUI.Full 16872 * @crossplatform 16873 * @form 16874 * @since 10 16875 */ 16876 /** 16877 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 16878 * The larger the blurring radius, the more blurring the content. 16879 * If the value is 0, the content blurring effect is not blurring. 16880 * 16881 * @param { number } value - value indicates radius of backdrop blur. 16882 * @param { BlurOptions } [options] - options indicates blur options. 16883 * @returns { T } 16884 * @syscap SystemCapability.ArkUI.ArkUI.Full 16885 * @crossplatform 16886 * @form 16887 * @atomicservice 16888 * @since 11 16889 */ 16890 blur(value: number, options?: BlurOptions): T; 16891 16892 /** 16893 * Adds the content linear gradient blurring effect for the current component. The input parameter is the blurring radius. 16894 * 16895 * @param { number } value - the blurring radius. 16896 * The larger the blurring radius, the more blurring the content, and if the value is 0, the content blurring effect is not blurring. 16897 * @param { LinearGradientBlurOptions } options - the linear gradient blur options. 16898 * @returns { T } 16899 * @syscap SystemCapability.ArkUI.ArkUI.Full 16900 * @atomicservice 16901 * @since 12 16902 */ 16903 linearGradientBlur(value: number, options: LinearGradientBlurOptions): T; 16904 16905 /** 16906 * Component motion blur interface. 16907 * 16908 * @param { MotionBlurOptions } value - the attributes of motion blur. 16909 * @returns { T } 16910 * @syscap SystemCapability.ArkUI.ArkUI.Full 16911 * @crossplatform 16912 * @atomicservice 16913 * @since 12 16914 */ 16915 motionBlur(value: MotionBlurOptions):T; 16916 16917 /** 16918 * Adds a highlight effect to the current component. 16919 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 16920 * The component is displayed as all white (percentage). 16921 * 16922 * @param { number } value 16923 * @returns { T } 16924 * @syscap SystemCapability.ArkUI.ArkUI.Full 16925 * @since 7 16926 */ 16927 /** 16928 * Adds a highlight effect to the current component. 16929 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 16930 * The component is displayed as all white (percentage). 16931 * 16932 * @param { number } value 16933 * @returns { T } 16934 * @syscap SystemCapability.ArkUI.ArkUI.Full 16935 * @form 16936 * @since 9 16937 */ 16938 /** 16939 * Adds a highlight effect to the current component. 16940 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 16941 * The component is displayed as all white (percentage). 16942 * 16943 * @param { number } value 16944 * @returns { T } 16945 * @syscap SystemCapability.ArkUI.ArkUI.Full 16946 * @crossplatform 16947 * @form 16948 * @since 10 16949 */ 16950 /** 16951 * Adds a highlight effect to the current component. 16952 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 16953 * The component is displayed as all white (percentage). 16954 * 16955 * @param { number } value 16956 * @returns { T } 16957 * @syscap SystemCapability.ArkUI.ArkUI.Full 16958 * @crossplatform 16959 * @form 16960 * @atomicservice 16961 * @since 11 16962 */ 16963 brightness(value: number): T; 16964 16965 /** 16966 * Adds a contrast effect to the current component. The input parameter is the contrast value. 16967 * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) 16968 * 16969 * @param { number } value 16970 * @returns { T } 16971 * @syscap SystemCapability.ArkUI.ArkUI.Full 16972 * @since 7 16973 */ 16974 /** 16975 * Adds a contrast effect to the current component. The input parameter is the contrast value. 16976 * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) 16977 * 16978 * @param { number } value 16979 * @returns { T } 16980 * @syscap SystemCapability.ArkUI.ArkUI.Full 16981 * @form 16982 * @since 9 16983 */ 16984 /** 16985 * Adds a contrast effect to the current component. The input parameter is the contrast value. 16986 * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) 16987 * 16988 * @param { number } value 16989 * @returns { T } 16990 * @syscap SystemCapability.ArkUI.ArkUI.Full 16991 * @crossplatform 16992 * @form 16993 * @since 10 16994 */ 16995 /** 16996 * Adds a contrast effect to the current component. The input parameter is the contrast value. 16997 * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) 16998 * 16999 * @param { number } value 17000 * @returns { T } 17001 * @syscap SystemCapability.ArkUI.ArkUI.Full 17002 * @crossplatform 17003 * @form 17004 * @atomicservice 17005 * @since 11 17006 */ 17007 contrast(value: number): T; 17008 17009 /** 17010 * Adds a grayscale effect to the current component. 17011 * 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. 17012 * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) 17013 * 17014 * @param { number } value 17015 * @returns { T } 17016 * @syscap SystemCapability.ArkUI.ArkUI.Full 17017 * @since 7 17018 */ 17019 /** 17020 * Adds a grayscale effect to the current component. 17021 * 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. 17022 * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) 17023 * 17024 * @param { number } value 17025 * @returns { T } 17026 * @syscap SystemCapability.ArkUI.ArkUI.Full 17027 * @form 17028 * @since 9 17029 */ 17030 /** 17031 * Adds a grayscale effect to the current component. 17032 * 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. 17033 * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) 17034 * 17035 * @param { number } value 17036 * @returns { T } 17037 * @syscap SystemCapability.ArkUI.ArkUI.Full 17038 * @crossplatform 17039 * @form 17040 * @since 10 17041 */ 17042 /** 17043 * Adds a grayscale effect to the current component. 17044 * 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. 17045 * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) 17046 * 17047 * @param { number } value 17048 * @returns { T } 17049 * @syscap SystemCapability.ArkUI.ArkUI.Full 17050 * @crossplatform 17051 * @form 17052 * @atomicservice 17053 * @since 11 17054 */ 17055 grayscale(value: number): T; 17056 17057 /** 17058 * Adds a color overlay effect for the current component. The input parameter is the superimposed color. 17059 * 17060 * @param { Color | string | Resource } value 17061 * @returns { T } 17062 * @syscap SystemCapability.ArkUI.ArkUI.Full 17063 * @since 7 17064 */ 17065 /** 17066 * Adds a color overlay effect for the current component. The input parameter is the superimposed color. 17067 * 17068 * @param { Color | string | Resource } value 17069 * @returns { T } 17070 * @syscap SystemCapability.ArkUI.ArkUI.Full 17071 * @form 17072 * @since 9 17073 */ 17074 /** 17075 * Adds a color overlay effect for the current component. The input parameter is the superimposed color. 17076 * 17077 * @param { Color | string | Resource } value 17078 * @returns { T } 17079 * @syscap SystemCapability.ArkUI.ArkUI.Full 17080 * @crossplatform 17081 * @form 17082 * @since 10 17083 */ 17084 /** 17085 * Adds a color overlay effect for the current component. The input parameter is the superimposed color. 17086 * 17087 * @param { Color | string | Resource } value 17088 * @returns { T } 17089 * @syscap SystemCapability.ArkUI.ArkUI.Full 17090 * @crossplatform 17091 * @form 17092 * @atomicservice 17093 * @since 11 17094 */ 17095 colorBlend(value: Color | string | Resource): T; 17096 17097 /** 17098 * Adds a saturation effect to the current component. 17099 * The saturation is the ratio of the color-containing component to the achromatic component (gray). 17100 * The larger the color-containing component, the greater the saturation. 17101 * The larger the achromatic component, the smaller the saturation. (Percentage) 17102 * 17103 * @param { number } value 17104 * @returns { T } 17105 * @syscap SystemCapability.ArkUI.ArkUI.Full 17106 * @since 7 17107 */ 17108 /** 17109 * Adds a saturation effect to the current component. 17110 * The saturation is the ratio of the color-containing component to the achromatic component (gray). 17111 * The larger the color-containing component, the greater the saturation. 17112 * The larger the achromatic component, the smaller the saturation. (Percentage) 17113 * 17114 * @param { number } value 17115 * @returns { T } 17116 * @syscap SystemCapability.ArkUI.ArkUI.Full 17117 * @form 17118 * @since 9 17119 */ 17120 /** 17121 * Adds a saturation effect to the current component. 17122 * The saturation is the ratio of the color-containing component to the achromatic component (gray). 17123 * The larger the color-containing component, the greater the saturation. 17124 * The larger the achromatic component, the smaller the saturation. (Percentage) 17125 * 17126 * @param { number } value 17127 * @returns { T } 17128 * @syscap SystemCapability.ArkUI.ArkUI.Full 17129 * @crossplatform 17130 * @form 17131 * @since 10 17132 */ 17133 /** 17134 * Adds a saturation effect to the current component. 17135 * The saturation is the ratio of the color-containing component to the achromatic component (gray). 17136 * The larger the color-containing component, the greater the saturation. 17137 * The larger the achromatic component, the smaller the saturation. (Percentage) 17138 * 17139 * @param { number } value 17140 * @returns { T } 17141 * @syscap SystemCapability.ArkUI.ArkUI.Full 17142 * @crossplatform 17143 * @form 17144 * @atomicservice 17145 * @since 11 17146 */ 17147 saturate(value: number): T; 17148 17149 /** 17150 * Converts the image to sepia. Value defines the scale of the conversion. 17151 * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) 17152 * 17153 * @param { number } value 17154 * @returns { T } 17155 * @syscap SystemCapability.ArkUI.ArkUI.Full 17156 * @since 7 17157 */ 17158 /** 17159 * Converts the image to sepia. Value defines the scale of the conversion. 17160 * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) 17161 * 17162 * @param { number } value 17163 * @returns { T } 17164 * @syscap SystemCapability.ArkUI.ArkUI.Full 17165 * @form 17166 * @since 9 17167 */ 17168 /** 17169 * Converts the image to sepia. Value defines the scale of the conversion. 17170 * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) 17171 * 17172 * @param { number } value 17173 * @returns { T } 17174 * @syscap SystemCapability.ArkUI.ArkUI.Full 17175 * @crossplatform 17176 * @form 17177 * @since 10 17178 */ 17179 /** 17180 * Converts the image to sepia. Value defines the scale of the conversion. 17181 * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) 17182 * 17183 * @param { number } value 17184 * @returns { T } 17185 * @syscap SystemCapability.ArkUI.ArkUI.Full 17186 * @crossplatform 17187 * @form 17188 * @atomicservice 17189 * @since 11 17190 */ 17191 sepia(value: number): T; 17192 17193 /** 17194 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 17195 * A value of 0% does not change the image. (Percentage) 17196 * 17197 * @param { number } value 17198 * @returns { T } 17199 * @syscap SystemCapability.ArkUI.ArkUI.Full 17200 * @since 7 17201 */ 17202 /** 17203 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 17204 * A value of 0% does not change the image. (Percentage) 17205 * 17206 * @param { number } value 17207 * @returns { T } 17208 * @syscap SystemCapability.ArkUI.ArkUI.Full 17209 * @form 17210 * @since 9 17211 */ 17212 /** 17213 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 17214 * A value of 0% does not change the image. (Percentage) 17215 * 17216 * @param { number } value 17217 * @returns { T } 17218 * @syscap SystemCapability.ArkUI.ArkUI.Full 17219 * @crossplatform 17220 * @form 17221 * @since 10 17222 */ 17223 /** 17224 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 17225 * A value of 0% does not change the image. (Percentage) 17226 * 17227 * @param { number | InvertOptions } value - value indicates the scale of the conversion or the options of invert. 17228 * @returns { T } 17229 * @syscap SystemCapability.ArkUI.ArkUI.Full 17230 * @crossplatform 17231 * @form 17232 * @atomicservice 17233 * @since 11 17234 */ 17235 invert(value: number | InvertOptions): T; 17236 17237 /** 17238 * Sets system bar effect to the component. 17239 * 17240 * @returns { T } return the component attribute. 17241 * @syscap SystemCapability.ArkUI.ArkUI.Full 17242 * @atomicservice 17243 * @since 12 17244 */ 17245 systemBarEffect(): T; 17246 17247 /** 17248 * Adds the hue rotation effect to the current component. 17249 * 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. 17250 * If the value exceeds 360deg, the image is circled again. 17251 * 17252 * @param { number | string } value 17253 * @returns { T } 17254 * @syscap SystemCapability.ArkUI.ArkUI.Full 17255 * @since 7 17256 */ 17257 /** 17258 * Adds the hue rotation effect to the current component. 17259 * 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. 17260 * If the value exceeds 360deg, the image is circled again. 17261 * 17262 * @param { number | string } value 17263 * @returns { T } 17264 * @syscap SystemCapability.ArkUI.ArkUI.Full 17265 * @form 17266 * @since 9 17267 */ 17268 /** 17269 * Adds the hue rotation effect to the current component. 17270 * 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. 17271 * If the value exceeds 360deg, the image is circled again. 17272 * 17273 * @param { number | string } value 17274 * @returns { T } 17275 * @syscap SystemCapability.ArkUI.ArkUI.Full 17276 * @crossplatform 17277 * @form 17278 * @since 10 17279 */ 17280 /** 17281 * Adds the hue rotation effect to the current component. 17282 * 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. 17283 * If the value exceeds 360deg, the image is circled again. 17284 * 17285 * @param { number | string } value 17286 * @returns { T } 17287 * @syscap SystemCapability.ArkUI.ArkUI.Full 17288 * @crossplatform 17289 * @form 17290 * @atomicservice 17291 * @since 11 17292 */ 17293 hueRotate(value: number | string): T; 17294 17295 /** 17296 * Add an attribute to control whether the shadows of the child nodes overlap each other. 17297 * 17298 * @param { boolean } value - true means the shadows of the child nodes overlap each other effect and drawn in batches. 17299 * @returns { T } 17300 * @syscap SystemCapability.ArkUI.ArkUI.Full 17301 * @crossplatform 17302 * @form 17303 * @since 11 17304 */ 17305 /** 17306 * Add an attribute to control whether the shadows of the child nodes overlap each other. 17307 * 17308 * @param { boolean } value - true means the shadows of the child nodes overlap each other effect and drawn in batches. 17309 * @returns { T } 17310 * @syscap SystemCapability.ArkUI.ArkUI.Full 17311 * @crossplatform 17312 * @form 17313 * @atomicservice 17314 * @since 12 17315 */ 17316 useShadowBatching(value: boolean): T; 17317 17318 /** 17319 * Sets whether the component should apply the effects template defined by the parent effectComponent. 17320 * If multiple parent effectComponents are found, the nearest one will be used. 17321 * If no parent effectComponent is found, this method has no effect. 17322 * 17323 * @param { boolean } value - true means the component should apply the effects template. 17324 * @returns { T } return the component attribute. 17325 * @syscap SystemCapability.ArkUI.ArkUI.Full 17326 * @atomicservice 17327 * @since 12 17328 */ 17329 useEffect(value: boolean): T; 17330 17331 /** 17332 * Adds the background blur effect for the current component. The input parameter is the blur radius. 17333 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 17334 * 17335 * @param { number } value 17336 * @returns { T } 17337 * @syscap SystemCapability.ArkUI.ArkUI.Full 17338 * @since 7 17339 */ 17340 /** 17341 * Adds the background blur effect for the current component. The input parameter is the blur radius. 17342 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 17343 * 17344 * @param { number } value 17345 * @returns { T } 17346 * @syscap SystemCapability.ArkUI.ArkUI.Full 17347 * @form 17348 * @since 9 17349 */ 17350 /** 17351 * Adds the background blur effect for the current component. The input parameter is the blur radius. 17352 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 17353 * 17354 * @param { number } value 17355 * @returns { T } 17356 * @syscap SystemCapability.ArkUI.ArkUI.Full 17357 * @crossplatform 17358 * @form 17359 * @since 10 17360 */ 17361 /** 17362 * Adds the background blur effect for the current component. The input parameter is the blur radius. 17363 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 17364 * 17365 * @param { number } value - value indicates radius of backdrop blur. 17366 * @param { BlurOptions } [options] - options indicates the backdrop blur options. 17367 * @returns { T } 17368 * @syscap SystemCapability.ArkUI.ArkUI.Full 17369 * @crossplatform 17370 * @form 17371 * @atomicservice 17372 * @since 11 17373 */ 17374 backdropBlur(value: number, options?: BlurOptions): T; 17375 17376 /** 17377 * Composite the contents of this view and its children into an offscreen cache before display in the screen. 17378 * 17379 * @param { boolean } value - if this view and its children need to composite into an offscreen cache. 17380 * @returns { T } 17381 * @syscap SystemCapability.ArkUI.ArkUI.Full 17382 * @crossplatform 17383 * @since 10 17384 */ 17385 /** 17386 * Composite the contents of this view and its children into an offscreen cache before display in the screen. 17387 * 17388 * @param { boolean } value - if this view and its children need to composite into an offscreen cache. 17389 * @returns { T } 17390 * @syscap SystemCapability.ArkUI.ArkUI.Full 17391 * @crossplatform 17392 * @atomicservice 17393 * @since 11 17394 */ 17395 /** 17396 * Composite the contents of this view and its children into an offscreen cache before display in the screen. 17397 * 17398 * @param { boolean } value - if this view and its children need to composite into an offscreen cache. 17399 * @returns { T } 17400 * @syscap SystemCapability.ArkUI.ArkUI.Full 17401 * @crossplatform 17402 * @form 17403 * @atomicservice 17404 * @since 12 17405 */ 17406 renderGroup(value: boolean): T; 17407 17408 /** 17409 * Sets whether the component should remain stationary, reusing the results of the current frame's off-screen rendering. 17410 * If the input parameter is true, the component and subcomponent changes do not affect the display. 17411 * 17412 * @param { boolean } value - true means the component should remain stationary. 17413 * @returns { T } 17414 * @syscap SystemCapability.ArkUI.ArkUI.Full 17415 * @atomicservice 17416 * @since 12 17417 */ 17418 freeze(value: boolean): T; 17419 17420 /** 17421 * Sets the translation effect during page transition. 17422 * The value is the start point of entry and end point of exit. 17423 * When this parameter is set together with slide, slide takes effect by default. 17424 * 17425 * @param { TranslateOptions } value 17426 * @returns { T } 17427 * @syscap SystemCapability.ArkUI.ArkUI.Full 17428 * @since 7 17429 */ 17430 /** 17431 * Sets the translation effect during page transition. 17432 * The value is the start point of entry and end point of exit. 17433 * When this parameter is set together with slide, slide takes effect by default. 17434 * 17435 * @param { TranslateOptions } value 17436 * @returns { T } 17437 * @syscap SystemCapability.ArkUI.ArkUI.Full 17438 * @form 17439 * @since 9 17440 */ 17441 /** 17442 * Sets the translation effect during page transition. 17443 * The value is the start point of entry and end point of exit. 17444 * When this parameter is set together with slide, slide takes effect by default. 17445 * 17446 * @param { TranslateOptions } value 17447 * @returns { T } 17448 * @syscap SystemCapability.ArkUI.ArkUI.Full 17449 * @crossplatform 17450 * @form 17451 * @since 10 17452 */ 17453 /** 17454 * Set component translation. 17455 * 17456 * @param { TranslateOptions } value default:{x:0,y:0,z:0} 17457 * @returns { T } 17458 * @syscap SystemCapability.ArkUI.ArkUI.Full 17459 * @crossplatform 17460 * @form 17461 * @atomicservice 17462 * @since 11 17463 */ 17464 translate(value: TranslateOptions): T; 17465 17466 /** 17467 * Sets the zoom effect during page transition. The value is the start point of entry and end point of exit. 17468 * 17469 * @param { ScaleOptions } value 17470 * @returns { T } 17471 * @syscap SystemCapability.ArkUI.ArkUI.Full 17472 * @since 7 17473 */ 17474 /** 17475 * Sets the zoom effect during page transition. The value is the start point of entry and end point of exit. 17476 * 17477 * @param { ScaleOptions } value 17478 * @returns { T } 17479 * @syscap SystemCapability.ArkUI.ArkUI.Full 17480 * @form 17481 * @since 9 17482 */ 17483 /** 17484 * Sets the zoom effect during page transition. The value is the start point of entry and end point of exit. 17485 * 17486 * @param { ScaleOptions } value 17487 * @returns { T } 17488 * @syscap SystemCapability.ArkUI.ArkUI.Full 17489 * @crossplatform 17490 * @form 17491 * @since 10 17492 */ 17493 /** 17494 * Set component scaling. 17495 * 17496 * @param { ScaleOptions } value default:{x:1,y:1,z:1,centerX:'50%',centerY:'50%'} 17497 * @returns { T } 17498 * @syscap SystemCapability.ArkUI.ArkUI.Full 17499 * @crossplatform 17500 * @form 17501 * @atomicservice 17502 * @since 11 17503 */ 17504 scale(value: ScaleOptions): T; 17505 17506 /** 17507 * 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. 17508 * 17509 * @param { number } value 17510 * @returns { T } 17511 * @syscap SystemCapability.ArkUI.ArkUI.Full 17512 * @since 7 17513 */ 17514 /** 17515 * 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. 17516 * 17517 * @param { number } value 17518 * @returns { T } 17519 * @syscap SystemCapability.ArkUI.ArkUI.Full 17520 * @crossplatform 17521 * @since 10 17522 */ 17523 /** 17524 * 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. 17525 * 17526 * @param { number } value 17527 * @returns { T } 17528 * @syscap SystemCapability.ArkUI.ArkUI.Full 17529 * @crossplatform 17530 * @atomicservice 17531 * @since 11 17532 */ 17533 gridSpan(value: number): T; 17534 17535 /** 17536 * 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, 17537 * the current component is located in the nth column. 17538 * 17539 * @param { number } value 17540 * @returns { T } 17541 * @syscap SystemCapability.ArkUI.ArkUI.Full 17542 * @since 7 17543 */ 17544 /** 17545 * 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, 17546 * the current component is located in the nth column. 17547 * 17548 * @param { number } value 17549 * @returns { T } 17550 * @syscap SystemCapability.ArkUI.ArkUI.Full 17551 * @crossplatform 17552 * @since 10 17553 */ 17554 /** 17555 * 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, 17556 * the current component is located in the nth column. 17557 * 17558 * @param { number } value 17559 * @returns { T } 17560 * @syscap SystemCapability.ArkUI.ArkUI.Full 17561 * @crossplatform 17562 * @atomicservice 17563 * @since 11 17564 */ 17565 gridOffset(value: number): T; 17566 17567 /** 17568 * Sets the rotation effect during assembly transition. 17569 * The values are the start point during insertion and the end point during deletion. 17570 * 17571 * @param { RotateOptions } value 17572 * @returns { T } 17573 * @syscap SystemCapability.ArkUI.ArkUI.Full 17574 * @since 7 17575 */ 17576 /** 17577 * Sets the rotation effect during assembly transition. 17578 * The values are the start point during insertion and the end point during deletion. 17579 * 17580 * @param { RotateOptions } value 17581 * @returns { T } 17582 * @syscap SystemCapability.ArkUI.ArkUI.Full 17583 * @form 17584 * @since 9 17585 */ 17586 /** 17587 * Sets the rotation effect during assembly transition. 17588 * The values are the start point during insertion and the end point during deletion. 17589 * 17590 * @param { RotateOptions } value 17591 * @returns { T } 17592 * @syscap SystemCapability.ArkUI.ArkUI.Full 17593 * @crossplatform 17594 * @form 17595 * @since 10 17596 */ 17597 /** 17598 * Set component rotation. 17599 * 17600 * @param { RotateOptions } value default:{x:0,y:0,z:0,centerX:'50%',centerY:'50%',centerZ:0,perspective:0} 17601 * @returns { T } 17602 * @syscap SystemCapability.ArkUI.ArkUI.Full 17603 * @crossplatform 17604 * @form 17605 * @atomicservice 17606 * @since 11 17607 */ 17608 rotate(value: RotateOptions): T; 17609 17610 /** 17611 * Sets the transformation matrix for the current component. 17612 * 17613 * @param { object } value 17614 * @returns { T } 17615 * @syscap SystemCapability.ArkUI.ArkUI.Full 17616 * @since 7 17617 */ 17618 /** 17619 * Sets the transformation matrix for the current component. 17620 * 17621 * @param { object } value 17622 * @returns { T } 17623 * @syscap SystemCapability.ArkUI.ArkUI.Full 17624 * @crossplatform 17625 * @since 10 17626 */ 17627 /** 17628 * Sets the transformation matrix for the current component. 17629 * 17630 * @param { object } value 17631 * @returns { T } 17632 * @syscap SystemCapability.ArkUI.ArkUI.Full 17633 * @crossplatform 17634 * @atomicservice 17635 * @since 11 17636 */ 17637 transform(value: object): T; 17638 17639 /** 17640 * This callback is triggered when a component mounts a display. 17641 * 17642 * @param { function } event 17643 * @returns { T } 17644 * @syscap SystemCapability.ArkUI.ArkUI.Full 17645 * @since 7 17646 */ 17647 /** 17648 * This callback is triggered when a component mounts a display. 17649 * 17650 * @param { function } event 17651 * @returns { T } 17652 * @syscap SystemCapability.ArkUI.ArkUI.Full 17653 * @form 17654 * @since 9 17655 */ 17656 /** 17657 * This callback is triggered when a component mounts a display. 17658 * 17659 * @param { function } event 17660 * @returns { T } 17661 * @syscap SystemCapability.ArkUI.ArkUI.Full 17662 * @crossplatform 17663 * @form 17664 * @since 10 17665 */ 17666 /** 17667 * This callback is triggered when a component mounts a display. 17668 * 17669 * @param { function } event 17670 * @returns { T } 17671 * @syscap SystemCapability.ArkUI.ArkUI.Full 17672 * @crossplatform 17673 * @form 17674 * @atomicservice 17675 * @since 11 17676 */ 17677 onAppear(event: () => void): T; 17678 17679 /** 17680 * This callback is triggered when component uninstallation disappears. 17681 * 17682 * @param { function } event 17683 * @returns { T } 17684 * @syscap SystemCapability.ArkUI.ArkUI.Full 17685 * @since 7 17686 */ 17687 /** 17688 * This callback is triggered when component uninstallation disappears. 17689 * 17690 * @param { function } event 17691 * @returns { T } 17692 * @syscap SystemCapability.ArkUI.ArkUI.Full 17693 * @form 17694 * @since 9 17695 */ 17696 /** 17697 * This callback is triggered when component uninstallation disappears. 17698 * 17699 * @param { function } event 17700 * @returns { T } 17701 * @syscap SystemCapability.ArkUI.ArkUI.Full 17702 * @crossplatform 17703 * @form 17704 * @since 10 17705 */ 17706 /** 17707 * This callback is triggered when component uninstallation disappears. 17708 * 17709 * @param { function } event 17710 * @returns { T } 17711 * @syscap SystemCapability.ArkUI.ArkUI.Full 17712 * @crossplatform 17713 * @form 17714 * @atomicservice 17715 * @since 11 17716 */ 17717 onDisAppear(event: () => void): T; 17718 17719 /** 17720 * This callback is triggered when a component mounts to view tree. 17721 * 17722 * @param { Callback<void> } callback 17723 * @returns { T } 17724 * @syscap SystemCapability.ArkUI.ArkUI.Full 17725 * @crossplatform 17726 * @atomicservice 17727 * @since 12 17728 */ 17729 onAttach(callback: Callback<void>): T; 17730 17731 /** 17732 * This callback is triggered when a component is detached from view tree. 17733 * 17734 * @param { Callback<void> } callback 17735 * @returns { T } 17736 * @syscap SystemCapability.ArkUI.ArkUI.Full 17737 * @crossplatform 17738 * @atomicservice 17739 * @since 12 17740 */ 17741 onDetach(callback: Callback<void>): T; 17742 17743 /** 17744 * This callback is triggered when the size or position of this component change finished. 17745 * 17746 * @param { function } event - event callback. 17747 * @returns { T } 17748 * @syscap SystemCapability.ArkUI.ArkUI.Full 17749 * @since 8 17750 */ 17751 /** 17752 * This callback is triggered when the size or position of this component change finished. 17753 * 17754 * @param { function } event - event callback. 17755 * @returns { T } 17756 * @syscap SystemCapability.ArkUI.ArkUI.Full 17757 * @crossplatform 17758 * @since 10 17759 */ 17760 /** 17761 * This callback is triggered when the size or position of this component change finished. 17762 * 17763 * @param { function } event - event callback. 17764 * @returns { T } 17765 * @syscap SystemCapability.ArkUI.ArkUI.Full 17766 * @crossplatform 17767 * @atomicservice 17768 * @since 11 17769 */ 17770 onAreaChange(event: (oldValue: Area, newValue: Area) => void): T; 17771 17772 /** 17773 * Controls the display or hide of the current component. 17774 * 17775 * @param { Visibility } value 17776 * @returns { T } 17777 * @syscap SystemCapability.ArkUI.ArkUI.Full 17778 * @since 7 17779 */ 17780 /** 17781 * Controls the display or hide of the current component. 17782 * 17783 * @param { Visibility } value 17784 * @returns { T } 17785 * @syscap SystemCapability.ArkUI.ArkUI.Full 17786 * @form 17787 * @since 9 17788 */ 17789 /** 17790 * Controls the display or hide of the current component. 17791 * 17792 * @param { Visibility } value 17793 * @returns { T } 17794 * @syscap SystemCapability.ArkUI.ArkUI.Full 17795 * @crossplatform 17796 * @form 17797 * @since 10 17798 */ 17799 /** 17800 * Controls the display or hide of the current component. 17801 * 17802 * @param { Visibility } value 17803 * @returns { T } 17804 * @syscap SystemCapability.ArkUI.ArkUI.Full 17805 * @crossplatform 17806 * @form 17807 * @atomicservice 17808 * @since 11 17809 */ 17810 visibility(value: Visibility): T; 17811 17812 /** 17813 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 17814 * 17815 * @param { number } value 17816 * @returns { T } 17817 * @syscap SystemCapability.ArkUI.ArkUI.Full 17818 * @since 7 17819 */ 17820 /** 17821 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 17822 * 17823 * @param { number } value 17824 * @returns { T } 17825 * @syscap SystemCapability.ArkUI.ArkUI.Full 17826 * @form 17827 * @since 9 17828 */ 17829 /** 17830 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 17831 * 17832 * @param { number } value 17833 * @returns { T } 17834 * @syscap SystemCapability.ArkUI.ArkUI.Full 17835 * @crossplatform 17836 * @form 17837 * @since 10 17838 */ 17839 /** 17840 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 17841 * 17842 * @param { number } value 17843 * @returns { T } 17844 * @syscap SystemCapability.ArkUI.ArkUI.Full 17845 * @crossplatform 17846 * @form 17847 * @atomicservice 17848 * @since 11 17849 */ 17850 flexGrow(value: number): T; 17851 17852 /** 17853 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 17854 * 17855 * @param { number } value 17856 * @returns { T } 17857 * @syscap SystemCapability.ArkUI.ArkUI.Full 17858 * @since 7 17859 */ 17860 /** 17861 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 17862 * 17863 * @param { number } value 17864 * @returns { T } 17865 * @syscap SystemCapability.ArkUI.ArkUI.Full 17866 * @form 17867 * @since 9 17868 */ 17869 /** 17870 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 17871 * 17872 * @param { number } value 17873 * @returns { T } 17874 * @syscap SystemCapability.ArkUI.ArkUI.Full 17875 * @crossplatform 17876 * @form 17877 * @since 10 17878 */ 17879 /** 17880 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 17881 * 17882 * @param { number } value 17883 * @returns { T } 17884 * @syscap SystemCapability.ArkUI.ArkUI.Full 17885 * @crossplatform 17886 * @form 17887 * @atomicservice 17888 * @since 11 17889 */ 17890 flexShrink(value: number): T; 17891 17892 /** 17893 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 17894 * 17895 * @param { number | string } value 17896 * @returns { T } 17897 * @syscap SystemCapability.ArkUI.ArkUI.Full 17898 * @since 7 17899 */ 17900 /** 17901 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 17902 * 17903 * @param { number | string } value 17904 * @returns { T } 17905 * @syscap SystemCapability.ArkUI.ArkUI.Full 17906 * @form 17907 * @since 9 17908 */ 17909 /** 17910 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 17911 * 17912 * @param { number | string } value 17913 * @returns { T } 17914 * @syscap SystemCapability.ArkUI.ArkUI.Full 17915 * @crossplatform 17916 * @form 17917 * @since 10 17918 */ 17919 /** 17920 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 17921 * 17922 * @param { number | string } value 17923 * @returns { T } 17924 * @syscap SystemCapability.ArkUI.ArkUI.Full 17925 * @crossplatform 17926 * @form 17927 * @atomicservice 17928 * @since 11 17929 */ 17930 flexBasis(value: number | string): T; 17931 17932 /** 17933 * Overrides the default configuration of alignItems in the Flex Layout container. 17934 * 17935 * @param { ItemAlign } value 17936 * @returns { T } 17937 * @syscap SystemCapability.ArkUI.ArkUI.Full 17938 * @since 7 17939 */ 17940 /** 17941 * Overrides the default configuration of alignItems in the Flex Layout container. 17942 * 17943 * @param { ItemAlign } value 17944 * @returns { T } 17945 * @syscap SystemCapability.ArkUI.ArkUI.Full 17946 * @form 17947 * @since 9 17948 */ 17949 /** 17950 * Overrides the default configuration of alignItems in the Flex Layout container. 17951 * 17952 * @param { ItemAlign } value 17953 * @returns { T } 17954 * @syscap SystemCapability.ArkUI.ArkUI.Full 17955 * @crossplatform 17956 * @form 17957 * @since 10 17958 */ 17959 /** 17960 * Overrides the default configuration of alignItems in the Flex Layout container. 17961 * 17962 * @param { ItemAlign } value 17963 * @returns { T } 17964 * @syscap SystemCapability.ArkUI.ArkUI.Full 17965 * @crossplatform 17966 * @form 17967 * @atomicservice 17968 * @since 11 17969 */ 17970 alignSelf(value: ItemAlign): T; 17971 17972 /** 17973 * 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. 17974 * 17975 * @param { number } value 17976 * @returns { T } 17977 * @syscap SystemCapability.ArkUI.ArkUI.Full 17978 * @since 7 17979 */ 17980 /** 17981 * 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. 17982 * 17983 * @param { number } value 17984 * @returns { T } 17985 * @syscap SystemCapability.ArkUI.ArkUI.Full 17986 * @form 17987 * @since 9 17988 */ 17989 /** 17990 * 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. 17991 * 17992 * @param { number } value 17993 * @returns { T } 17994 * @syscap SystemCapability.ArkUI.ArkUI.Full 17995 * @crossplatform 17996 * @form 17997 * @since 10 17998 */ 17999 /** 18000 * 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. 18001 * 18002 * @param { number } value 18003 * @returns { T } 18004 * @syscap SystemCapability.ArkUI.ArkUI.Full 18005 * @crossplatform 18006 * @form 18007 * @atomicservice 18008 * @since 11 18009 */ 18010 displayPriority(value: number): T; 18011 18012 /** 18013 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 18014 * 18015 * @param { number } value 18016 * @returns { T } 18017 * @syscap SystemCapability.ArkUI.ArkUI.Full 18018 * @since 7 18019 */ 18020 /** 18021 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 18022 * 18023 * @param { number } value 18024 * @returns { T } 18025 * @syscap SystemCapability.ArkUI.ArkUI.Full 18026 * @form 18027 * @since 9 18028 */ 18029 /** 18030 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 18031 * 18032 * @param { number } value 18033 * @returns { T } 18034 * @syscap SystemCapability.ArkUI.ArkUI.Full 18035 * @crossplatform 18036 * @form 18037 * @since 10 18038 */ 18039 /** 18040 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 18041 * 18042 * @param { number } value 18043 * @returns { T } 18044 * @syscap SystemCapability.ArkUI.ArkUI.Full 18045 * @crossplatform 18046 * @form 18047 * @atomicservice 18048 * @since 11 18049 */ 18050 zIndex(value: number): T; 18051 18052 /** 18053 * 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. 18054 * 18055 * @param { string } id 18056 * @param { sharedTransitionOptions } options 18057 * @returns { T } 18058 * @syscap SystemCapability.ArkUI.ArkUI.Full 18059 * @since 7 18060 */ 18061 /** 18062 * 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. 18063 * 18064 * @param { string } id 18065 * @param { sharedTransitionOptions } options 18066 * @returns { T } 18067 * @syscap SystemCapability.ArkUI.ArkUI.Full 18068 * @crossplatform 18069 * @since 10 18070 */ 18071 /** 18072 * 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. 18073 * 18074 * @param { string } id 18075 * @param { sharedTransitionOptions } options 18076 * @returns { T } 18077 * @syscap SystemCapability.ArkUI.ArkUI.Full 18078 * @crossplatform 18079 * @atomicservice 18080 * @since 11 18081 */ 18082 sharedTransition(id: string, options?: sharedTransitionOptions): T; 18083 18084 /** 18085 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 18086 * 18087 * @param { Direction } value 18088 * @returns { T } 18089 * @syscap SystemCapability.ArkUI.ArkUI.Full 18090 * @since 7 18091 */ 18092 /** 18093 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 18094 * 18095 * @param { Direction } value 18096 * @returns { T } 18097 * @syscap SystemCapability.ArkUI.ArkUI.Full 18098 * @form 18099 * @since 9 18100 */ 18101 /** 18102 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 18103 * 18104 * @param { Direction } value 18105 * @returns { T } 18106 * @syscap SystemCapability.ArkUI.ArkUI.Full 18107 * @crossplatform 18108 * @form 18109 * @since 10 18110 */ 18111 /** 18112 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 18113 * 18114 * @param { Direction } value 18115 * @returns { T } 18116 * @syscap SystemCapability.ArkUI.ArkUI.Full 18117 * @crossplatform 18118 * @form 18119 * @atomicservice 18120 * @since 11 18121 */ 18122 direction(value: Direction): T; 18123 18124 /** 18125 * align 18126 * 18127 * @param { Alignment } value 18128 * @returns { T } 18129 * @syscap SystemCapability.ArkUI.ArkUI.Full 18130 * @since 7 18131 */ 18132 /** 18133 * align 18134 * 18135 * @param { Alignment } value 18136 * @returns { T } 18137 * @syscap SystemCapability.ArkUI.ArkUI.Full 18138 * @form 18139 * @since 9 18140 */ 18141 /** 18142 * align 18143 * 18144 * @param { Alignment } value 18145 * @returns { T } 18146 * @syscap SystemCapability.ArkUI.ArkUI.Full 18147 * @crossplatform 18148 * @form 18149 * @since 10 18150 */ 18151 /** 18152 * align 18153 * 18154 * @param { Alignment } value 18155 * @returns { T } 18156 * @syscap SystemCapability.ArkUI.ArkUI.Full 18157 * @crossplatform 18158 * @form 18159 * @atomicservice 18160 * @since 11 18161 */ 18162 align(value: Alignment): T; 18163 18164 /** 18165 * position 18166 * 18167 * @param { Position } value 18168 * @returns { T } 18169 * @syscap SystemCapability.ArkUI.ArkUI.Full 18170 * @since 7 18171 */ 18172 /** 18173 * position 18174 * 18175 * @param { Position } value 18176 * @returns { T } 18177 * @syscap SystemCapability.ArkUI.ArkUI.Full 18178 * @form 18179 * @since 9 18180 */ 18181 /** 18182 * position 18183 * 18184 * @param { Position } value 18185 * @returns { T } 18186 * @syscap SystemCapability.ArkUI.ArkUI.Full 18187 * @crossplatform 18188 * @form 18189 * @since 10 18190 */ 18191 /** 18192 * position 18193 * 18194 * @param { Position } value 18195 * @returns { T } 18196 * @syscap SystemCapability.ArkUI.ArkUI.Full 18197 * @crossplatform 18198 * @form 18199 * @atomicservice 18200 * @since 11 18201 */ 18202 /** 18203 * position 18204 * 18205 * @param { Position | Edges | LocalizedEdges } value 18206 * @returns { T } 18207 * @syscap SystemCapability.ArkUI.ArkUI.Full 18208 * @crossplatform 18209 * @form 18210 * @atomicservice 18211 * @since 12 18212 */ 18213 position(value: Position | Edges | LocalizedEdges): T; 18214 18215 /** 18216 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 18217 * 18218 * @param { Position } value 18219 * @returns { T } 18220 * @syscap SystemCapability.ArkUI.ArkUI.Full 18221 * @since 7 18222 */ 18223 /** 18224 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 18225 * 18226 * @param { Position } value 18227 * @returns { T } 18228 * @syscap SystemCapability.ArkUI.ArkUI.Full 18229 * @form 18230 * @since 9 18231 */ 18232 /** 18233 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 18234 * 18235 * @param { Position } value 18236 * @returns { T } 18237 * @syscap SystemCapability.ArkUI.ArkUI.Full 18238 * @crossplatform 18239 * @form 18240 * @since 10 18241 */ 18242 /** 18243 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 18244 * 18245 * @param { Position } value 18246 * @returns { T } 18247 * @syscap SystemCapability.ArkUI.ArkUI.Full 18248 * @crossplatform 18249 * @form 18250 * @atomicservice 18251 * @since 11 18252 */ 18253 /** 18254 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 18255 * 18256 * @param { Position | LocalizedPosition} value 18257 * @returns { T } 18258 * @syscap SystemCapability.ArkUI.ArkUI.Full 18259 * @crossplatform 18260 * @form 18261 * @atomicservice 18262 * @since 12 18263 */ 18264 markAnchor(value: Position | LocalizedPosition): T; 18265 18266 /** 18267 * Coordinate offset relative to the layout completion position. 18268 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 18269 * 18270 * @param { Position } value 18271 * @returns { T } 18272 * @syscap SystemCapability.ArkUI.ArkUI.Full 18273 * @since 7 18274 */ 18275 /** 18276 * Coordinate offset relative to the layout completion position. 18277 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 18278 * 18279 * @param { Position } value 18280 * @returns { T } 18281 * @syscap SystemCapability.ArkUI.ArkUI.Full 18282 * @form 18283 * @since 9 18284 */ 18285 /** 18286 * Coordinate offset relative to the layout completion position. 18287 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 18288 * 18289 * @param { Position } value 18290 * @returns { T } 18291 * @syscap SystemCapability.ArkUI.ArkUI.Full 18292 * @crossplatform 18293 * @form 18294 * @since 10 18295 */ 18296 /** 18297 * Coordinate offset relative to the layout completion position. 18298 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 18299 * 18300 * @param { Position } value 18301 * @returns { T } 18302 * @syscap SystemCapability.ArkUI.ArkUI.Full 18303 * @crossplatform 18304 * @form 18305 * @atomicservice 18306 * @since 11 18307 */ 18308 /** 18309 * Coordinate offset relative to the layout completion position. 18310 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 18311 * 18312 * @param { Position | Edges | LocalizedEdges } value 18313 * @returns { T } 18314 * @syscap SystemCapability.ArkUI.ArkUI.Full 18315 * @crossplatform 18316 * @form 18317 * @atomicservice 18318 * @since 12 18319 */ 18320 offset(value: Position | Edges | LocalizedEdges): T; 18321 18322 /** 18323 * If the value is true, the component is available and can respond to operations such as clicking. 18324 * If it is set to false, click operations are not responded. 18325 * 18326 * @param { boolean } value 18327 * @returns { T } 18328 * @syscap SystemCapability.ArkUI.ArkUI.Full 18329 * @since 7 18330 */ 18331 /** 18332 * If the value is true, the component is available and can respond to operations such as clicking. 18333 * If it is set to false, click operations are not responded. 18334 * 18335 * @param { boolean } value 18336 * @returns { T } 18337 * @syscap SystemCapability.ArkUI.ArkUI.Full 18338 * @form 18339 * @since 9 18340 */ 18341 /** 18342 * If the value is true, the component is available and can respond to operations such as clicking. 18343 * If it is set to false, click operations are not responded. 18344 * 18345 * @param { boolean } value 18346 * @returns { T } 18347 * @syscap SystemCapability.ArkUI.ArkUI.Full 18348 * @crossplatform 18349 * @form 18350 * @since 10 18351 */ 18352 /** 18353 * If the value is true, the component is available and can respond to operations such as clicking. 18354 * If it is set to false, click operations are not responded. 18355 * 18356 * @param { boolean } value 18357 * @returns { T } 18358 * @syscap SystemCapability.ArkUI.ArkUI.Full 18359 * @crossplatform 18360 * @form 18361 * @atomicservice 18362 * @since 11 18363 */ 18364 enabled(value: boolean): T; 18365 18366 /** 18367 * Sets the number of occupied columns and offset columns for a specific device width type. 18368 * 18369 * @param { object } value 18370 * @returns { T } 18371 * @syscap SystemCapability.ArkUI.ArkUI.Full 18372 * @since 7 18373 * @deprecated since 9 18374 * @useinstead grid_col/GridColColumnOption and grid_row/GridRowColumnOption 18375 */ 18376 useSizeType(value: { 18377 xs?: number | { span: number; offset: number }; 18378 sm?: number | { span: number; offset: number }; 18379 md?: number | { span: number; offset: number }; 18380 lg?: number | { span: number; offset: number }; 18381 }): T; 18382 18383 /** 18384 * Specifies the alignRules of relative container 18385 * 18386 * @param { AlignRuleOption } value 18387 * @returns { T } 18388 * @syscap SystemCapability.ArkUI.ArkUI.Full 18389 * @form 18390 * @since 9 18391 */ 18392 /** 18393 * Specifies the alignRules of relative container 18394 * 18395 * @param { AlignRuleOption } value 18396 * @returns { T } 18397 * @syscap SystemCapability.ArkUI.ArkUI.Full 18398 * @crossplatform 18399 * @form 18400 * @since 10 18401 */ 18402 /** 18403 * Specifies the alignRules of relative container 18404 * 18405 * @param { AlignRuleOption } value 18406 * @returns { T } 18407 * @syscap SystemCapability.ArkUI.ArkUI.Full 18408 * @crossplatform 18409 * @form 18410 * @atomicservice 18411 * @since 11 18412 */ 18413 alignRules(value: AlignRuleOption): T; 18414 18415 /** 18416 * Specifies the localized alignRules of relative container 18417 * 18418 * @param { LocalizedAlignRuleOptions } alignRule 18419 * @returns { T } 18420 * @syscap SystemCapability.ArkUI.ArkUI.Full 18421 * @crossplatform 18422 * @form 18423 * @atomicservice 18424 * @since 12 18425 */ 18426 alignRules(alignRule: LocalizedAlignRuleOptions): T; 18427 18428 /** 18429 * Specifies the direction and style of chain in relative container 18430 * 18431 * @param { Axis } direction - indicates direction of the chain 18432 * @param { ChainStyle } style - indicates style of the chain 18433 * @returns { T } 18434 * @syscap SystemCapability.ArkUI.ArkUI.Full 18435 * @crossplatform 18436 * @atomicservice 18437 * @since 12 18438 */ 18439 chainMode(direction: Axis, style: ChainStyle): T; 18440 18441 /** 18442 * Specifies the aspect ratio of the current component. 18443 * 18444 * @param { number } value 18445 * @returns { T } 18446 * @syscap SystemCapability.ArkUI.ArkUI.Full 18447 * @since 7 18448 */ 18449 /** 18450 * Specifies the aspect ratio of the current component. 18451 * 18452 * @param { number } value 18453 * @returns { T } 18454 * @syscap SystemCapability.ArkUI.ArkUI.Full 18455 * @form 18456 * @since 9 18457 */ 18458 /** 18459 * Specifies the aspect ratio of the current component. 18460 * 18461 * @param { number } value 18462 * @returns { T } 18463 * @syscap SystemCapability.ArkUI.ArkUI.Full 18464 * @crossplatform 18465 * @form 18466 * @since 10 18467 */ 18468 /** 18469 * Specifies the aspect ratio of the current component. 18470 * 18471 * @param { number } value 18472 * @returns { T } 18473 * @syscap SystemCapability.ArkUI.ArkUI.Full 18474 * @crossplatform 18475 * @form 18476 * @atomicservice 18477 * @since 11 18478 */ 18479 aspectRatio(value: number): T; 18480 18481 /** 18482 * The click effect level and scale number. 18483 * 18484 * @param { ClickEffect | null } value 18485 * @returns { T } return the component attribute. 18486 * @syscap SystemCapability.ArkUI.ArkUI.Full 18487 * @crossplatform 18488 * @since 10 18489 */ 18490 /** 18491 * The click effect level and scale number. 18492 * 18493 * @param { ClickEffect | null } value 18494 * @returns { T } return the component attribute. 18495 * @syscap SystemCapability.ArkUI.ArkUI.Full 18496 * @crossplatform 18497 * @atomicservice 18498 * @since 11 18499 */ 18500 clickEffect(value: ClickEffect | null): T; 18501 18502 /** 18503 * After a listener is bound, the component can be dragged. After the drag occurs, a callback is triggered. 18504 * (To be triggered, press and hold for 170 milliseconds (ms)) 18505 * 18506 * @param { function } event 18507 * @returns { T } 18508 * @syscap SystemCapability.ArkUI.ArkUI.Full 18509 * @since 8 18510 */ 18511 /** 18512 * After a listener is bound, the component can be dragged. After the drag occurs, a callback is triggered. 18513 * (To be triggered, press and hold for 170 milliseconds (ms)) 18514 * 18515 * @param { function } event 18516 * @returns { T } 18517 * @syscap SystemCapability.ArkUI.ArkUI.Full 18518 * @atomicservice 18519 * @since 11 18520 */ 18521 onDragStart(event: (event: DragEvent, extraParams?: string) => CustomBuilder | DragItemInfo): T; 18522 18523 /** 18524 * After binding, a callback is triggered when the component is dragged to the range of the component. 18525 * 18526 * @param { function } event 18527 * @returns { T } 18528 * @syscap SystemCapability.ArkUI.ArkUI.Full 18529 * @since 8 18530 */ 18531 /** 18532 * After binding, a callback is triggered when the component is dragged to the range of the component. 18533 * 18534 * @param { function } event 18535 * @returns { T } 18536 * @syscap SystemCapability.ArkUI.ArkUI.Full 18537 * @atomicservice 18538 * @since 11 18539 */ 18540 onDragEnter(event: (event: DragEvent, extraParams?: string) => void): T; 18541 18542 /** 18543 * After binding, a callback is triggered when the drag moves within the range of a placeable component. 18544 * 18545 * @param { function } event 18546 * @returns { T } 18547 * @syscap SystemCapability.ArkUI.ArkUI.Full 18548 * @since 8 18549 */ 18550 /** 18551 * After binding, a callback is triggered when the drag moves within the range of a placeable component. 18552 * 18553 * @param { function } event 18554 * @returns { T } 18555 * @syscap SystemCapability.ArkUI.ArkUI.Full 18556 * @atomicservice 18557 * @since 11 18558 */ 18559 onDragMove(event: (event: DragEvent, extraParams?: string) => void): T; 18560 18561 /** 18562 * After binding, a callback is triggered when the component is dragged out of the component range. 18563 * 18564 * @param { function } event 18565 * @returns { T } 18566 * @syscap SystemCapability.ArkUI.ArkUI.Full 18567 * @since 8 18568 */ 18569 /** 18570 * After binding, a callback is triggered when the component is dragged out of the component range. 18571 * 18572 * @param { function } event 18573 * @returns { T } 18574 * @syscap SystemCapability.ArkUI.ArkUI.Full 18575 * @atomicservice 18576 * @since 11 18577 */ 18578 onDragLeave(event: (event: DragEvent, extraParams?: string) => void): T; 18579 18580 /** 18581 * The component bound to this event can be used as the drag release target. 18582 * This callback is triggered when the drag behavior is stopped within the scope of the component. 18583 * 18584 * @param { function } event 18585 * @returns { T } 18586 * @syscap SystemCapability.ArkUI.ArkUI.Full 18587 * @since 8 18588 */ 18589 /** 18590 * The component bound to this event can be used as the drag release target. 18591 * This callback is triggered when the drag behavior is stopped within the scope of the component. 18592 * 18593 * @param { function } event 18594 * @returns { T } 18595 * @syscap SystemCapability.ArkUI.ArkUI.Full 18596 * @atomicservice 18597 * @since 11 18598 */ 18599 onDrop(event: (event: DragEvent, extraParams?: string) => void): T; 18600 18601 /** 18602 * This function is called when the drag event is end. 18603 * 18604 * @param { function } event - indicates the function to be called. 18605 * @returns { T } property value of type T. 18606 * @syscap SystemCapability.ArkUI.ArkUI.Full 18607 * @since 10 18608 */ 18609 /** 18610 * This function is called when the drag event is end. 18611 * 18612 * @param { function } event - indicates the function to be called. 18613 * @returns { T } property value of type T. 18614 * @syscap SystemCapability.ArkUI.ArkUI.Full 18615 * @atomicservice 18616 * @since 11 18617 */ 18618 onDragEnd(event: (event: DragEvent, extraParams?: string) => void): T; 18619 18620 /** 18621 * Allowed drop uniformData type for this node. 18622 * 18623 * @param { Array<UniformDataType> } value - the uniformData type for this node. 18624 * @returns { T } property value of type T. 18625 * @syscap SystemCapability.ArkUI.ArkUI.Full 18626 * @crossplatform 18627 * @since 10 18628 */ 18629 /** 18630 * Allowed drop uniformData type for this node. 18631 * 18632 * @param { Array<UniformDataType> } value - the uniformData type for this node. 18633 * @returns { T } property value of type T. 18634 * @syscap SystemCapability.ArkUI.ArkUI.Full 18635 * @crossplatform 18636 * @atomicservice 18637 * @since 11 18638 */ 18639 /** 18640 * Allowed drop uniformData type for this node. 18641 * 18642 * @param { Array<UniformDataType> | null } value - the uniformData type for this node. 18643 * @returns { T } property value of type T. 18644 * @syscap SystemCapability.ArkUI.ArkUI.Full 18645 * @crossplatform 18646 * @atomicservice 18647 * @since 12 18648 */ 18649 allowDrop(value: Array<UniformDataType> | null): T; 18650 18651 /** 18652 * Enable the selectable area can be dragged. 18653 * 18654 * @param { boolean } value - true means the area can be dragged, false means the area can't be dragged. 18655 * @returns { T } property value of type T. 18656 * @syscap SystemCapability.ArkUI.ArkUI.Full 18657 * @since 10 18658 */ 18659 /** 18660 * Enable the selectable area can be dragged. 18661 * 18662 * @param { boolean } value - true means the area can be dragged, false means the area can't be dragged. 18663 * @returns { T } property value of type T. 18664 * @syscap SystemCapability.ArkUI.ArkUI.Full 18665 * @crossplatform 18666 * @atomicservice 18667 * @since 11 18668 */ 18669 draggable(value: boolean): T; 18670 18671 /** 18672 * Set preview of the component for dragging process 18673 * 18674 * @param { CustomBuilder | DragItemInfo } value - preview of the component for dragging process 18675 * @returns { T } property value of type T. 18676 * @syscap SystemCapability.ArkUI.ArkUI.Full 18677 * @since 11 18678 */ 18679 /** 18680 * Set preview of the component for dragging process 18681 * 18682 * @param { CustomBuilder | DragItemInfo | string } value - preview of the component for dragging process 18683 * @returns { T } property value of type T. 18684 * @syscap SystemCapability.ArkUI.ArkUI.Full 18685 * @atomicservice 18686 * @since 12 18687 */ 18688 dragPreview(value: CustomBuilder | DragItemInfo | string): T; 18689 18690 /** 18691 * Set the selectable area drag preview options. 18692 * 18693 * @param { DragPreviewOptions } value - preview options value. 18694 * @returns { T } property value of type T. 18695 * @syscap SystemCapability.ArkUI.ArkUI.Full 18696 * @since 11 18697 */ 18698 /** 18699 * Set the selectable area drag preview options. 18700 * 18701 * @param { DragPreviewOptions } value - preview options value. 18702 * @param { DragInteractionOptions } options - drag interaction options value. 18703 * @returns { T } property value of type T. 18704 * @syscap SystemCapability.ArkUI.ArkUI.Full 18705 * @atomicservice 18706 * @since 12 18707 */ 18708 dragPreviewOptions(value: DragPreviewOptions, options?: DragInteractionOptions): T; 18709 18710 /** 18711 * After binding, a callback is triggered when the preDrag status change finished. 18712 * 18713 * @param { Callback<PreDragStatus> } callback callback - The callback will be triggered when the preDrag status change. 18714 * @returns { T } property value of type T. 18715 * @syscap SystemCapability.ArkUI.ArkUI.Full 18716 * @atomicservice 18717 * @since 12 18718 */ 18719 onPreDrag(callback: Callback<PreDragStatus>): T; 18720 18721 /** 18722 * Add mask text to the current component. The layout is the same as that of the current component. 18723 * 18724 * @param { string } value 18725 * @param { object } options 18726 * @returns { T } 18727 * @syscap SystemCapability.ArkUI.ArkUI.Full 18728 * @since 7 18729 */ 18730 /** 18731 * Add mask text to the current component. The layout is the same as that of the current component. 18732 * 18733 * @param { string } value 18734 * @param { object } options 18735 * @returns { T } 18736 * @syscap SystemCapability.ArkUI.ArkUI.Full 18737 * @form 18738 * @since 9 18739 */ 18740 /** 18741 * Add mask text to the current component. The layout is the same as that of the current component. 18742 * 18743 * @param { string | CustomBuilder } value 18744 * @param { object } options 18745 * @returns { T } 18746 * @syscap SystemCapability.ArkUI.ArkUI.Full 18747 * @crossplatform 18748 * @form 18749 * @since 10 18750 */ 18751 /** 18752 * Add mask text to the current component. The layout is the same as that of the current component. 18753 * 18754 * @param { string | CustomBuilder } value 18755 * @param { object } options 18756 * @returns { T } 18757 * @syscap SystemCapability.ArkUI.ArkUI.Full 18758 * @crossplatform 18759 * @form 18760 * @atomicservice 18761 * @since 11 18762 */ 18763 /** 18764 * Add mask text to the current component. The layout is the same as that of the current component. 18765 * 18766 * @param { string | CustomBuilder | ComponentContent } value 18767 * @param { OverlayOptions } options 18768 * @returns { T } 18769 * @syscap SystemCapability.ArkUI.ArkUI.Full 18770 * @crossplatform 18771 * @form 18772 * @atomicservice 18773 * @since 12 18774 */ 18775 overlay(value: string | CustomBuilder | ComponentContent, options?: OverlayOptions): T; 18776 18777 /** 18778 * Linear Gradient 18779 * angle: Angle of Linear Gradient. The default value is 180; 18780 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 18781 * colors: Color description for gradients. 18782 * repeating: repeating. The default value is false 18783 * 18784 * @param { object } value 18785 * @returns { T } 18786 * @syscap SystemCapability.ArkUI.ArkUI.Full 18787 * @since 7 18788 */ 18789 /** 18790 * Linear Gradient 18791 * angle: Angle of Linear Gradient. The default value is 180; 18792 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 18793 * colors: Color description for gradients. 18794 * repeating: repeating. The default value is false 18795 * 18796 * @param { object } value 18797 * @returns { T } 18798 * @syscap SystemCapability.ArkUI.ArkUI.Full 18799 * @form 18800 * @since 9 18801 */ 18802 /** 18803 * Linear Gradient 18804 * angle: Angle of Linear Gradient. The default value is 180; 18805 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 18806 * colors: Color description for gradients. 18807 * repeating: repeating. The default value is false 18808 * 18809 * @param { object } value 18810 * @returns { T } 18811 * @syscap SystemCapability.ArkUI.ArkUI.Full 18812 * @crossplatform 18813 * @form 18814 * @since 10 18815 */ 18816 /** 18817 * Linear Gradient 18818 * angle: Angle of Linear Gradient. The default value is 180; 18819 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 18820 * colors: Color description for gradients. 18821 * repeating: repeating. The default value is false 18822 * 18823 * @param { object } value 18824 * @returns { T } 18825 * @syscap SystemCapability.ArkUI.ArkUI.Full 18826 * @crossplatform 18827 * @form 18828 * @atomicservice 18829 * @since 11 18830 */ 18831 /** 18832 * Linear Gradient 18833 * angle: Angle of Linear Gradient; direction:Direction of Linear Gradient; colors:Color description for gradients,repeating:repeating. 18834 * 18835 * @param { object } value 18836 * @returns { T } 18837 * @syscap SystemCapability.ArkUI.ArkUI.Full 18838 * @crossplatform 18839 * @form 18840 * @atomicservice 18841 * @since 12 18842 */ 18843 linearGradient(value: { 18844 angle?: number | string; 18845 direction?: GradientDirection; 18846 colors: Array<[ResourceColor, number]>; 18847 repeating?: boolean; 18848 }): T; 18849 18850 /** 18851 * Angle Gradient 18852 * center:is the center point of the angle gradient 18853 * start:Start point of angle gradient. The default value is 0 18854 * end:End point of angle gradient. The default value is 0 18855 * number:number 18856 * rotating:rotating. The default value is 0 18857 * colors:Color description for gradients 18858 * repeating:repeating. The default value is false 18859 * 18860 * @param { object } value 18861 * @returns { T } 18862 * @syscap SystemCapability.ArkUI.ArkUI.Full 18863 * @since 7 18864 */ 18865 /** 18866 * Angle Gradient 18867 * center:is the center point of the angle gradient 18868 * start:Start point of angle gradient. The default value is 0 18869 * end:End point of angle gradient. The default value is 0 18870 * number:number 18871 * rotating:rotating. The default value is 0 18872 * colors:Color description for gradients 18873 * repeating:repeating. The default value is false 18874 * 18875 * @param { object } value 18876 * @returns { T } 18877 * @syscap SystemCapability.ArkUI.ArkUI.Full 18878 * @form 18879 * @since 9 18880 */ 18881 /** 18882 * Angle Gradient 18883 * center:is the center point of the angle gradient 18884 * start:Start point of angle gradient. The default value is 0 18885 * end:End point of angle gradient. The default value is 0 18886 * number:number 18887 * rotating:rotating. The default value is 0 18888 * colors:Color description for gradients 18889 * repeating:repeating. The default value is false 18890 * 18891 * @param { object } value 18892 * @returns { T } 18893 * @syscap SystemCapability.ArkUI.ArkUI.Full 18894 * @crossplatform 18895 * @form 18896 * @since 10 18897 */ 18898 /** 18899 * Angle Gradient 18900 * center:is the center point of the angle gradient 18901 * start:Start point of angle gradient. The default value is 0 18902 * end:End point of angle gradient. The default value is 0 18903 * number:number 18904 * rotating:rotating. The default value is 0 18905 * colors:Color description for gradients 18906 * repeating:repeating. The default value is false 18907 * 18908 * @param { object } value 18909 * @returns { T } 18910 * @syscap SystemCapability.ArkUI.ArkUI.Full 18911 * @crossplatform 18912 * @form 18913 * @atomicservice 18914 * @since 11 18915 */ 18916 /** 18917 * Angle Gradient 18918 * center:is the center point of the angle gradient 18919 * start:Start point of angle gradient 18920 * end:End point of angle gradient 18921 * number:number 18922 * rotating:rotating 18923 * colors:Color description for gradients 18924 * repeating:repeating 18925 * 18926 * @param { object } value 18927 * @returns { T } 18928 * @syscap SystemCapability.ArkUI.ArkUI.Full 18929 * @crossplatform 18930 * @form 18931 * @atomicservice 18932 * @since 12 18933 */ 18934 sweepGradient(value: { 18935 center: [Length, Length]; 18936 start?: number | string; 18937 end?: number | string; 18938 rotation?: number | string; 18939 colors: Array<[ResourceColor, number]>; 18940 repeating?: boolean; 18941 }): T; 18942 18943 /** 18944 * Radial Gradient 18945 * center:Center point of radial gradient 18946 * radius:Radius of Radial Gradient. value range [0, +∞) 18947 * colors:Color description for gradients 18948 * repeating: Refill. The default value is false 18949 * 18950 * @param { object } value 18951 * @returns { T } 18952 * @syscap SystemCapability.ArkUI.ArkUI.Full 18953 * @since 7 18954 */ 18955 /** 18956 * Radial Gradient 18957 * center:Center point of radial gradient 18958 * radius:Radius of Radial Gradient. value range [0, +∞) 18959 * colors:Color description for gradients 18960 * repeating: Refill. The default value is false 18961 * 18962 * @param { object } value 18963 * @returns { T } 18964 * @syscap SystemCapability.ArkUI.ArkUI.Full 18965 * @form 18966 * @since 9 18967 */ 18968 /** 18969 * Radial Gradient 18970 * center:Center point of radial gradient 18971 * radius:Radius of Radial Gradient. value range [0, +∞) 18972 * colors:Color description for gradients 18973 * repeating: Refill. The default value is false 18974 * 18975 * @param { object } value 18976 * @returns { T } 18977 * @syscap SystemCapability.ArkUI.ArkUI.Full 18978 * @crossplatform 18979 * @form 18980 * @since 10 18981 */ 18982 /** 18983 * Radial Gradient 18984 * center:Center point of radial gradient 18985 * radius:Radius of Radial Gradient. value range [0, +∞) 18986 * colors:Color description for gradients 18987 * repeating: Refill. The default value is false 18988 * 18989 * @param { object } value 18990 * @returns { T } 18991 * @syscap SystemCapability.ArkUI.ArkUI.Full 18992 * @crossplatform 18993 * @form 18994 * @atomicservice 18995 * @since 11 18996 */ 18997 /** 18998 * Radial Gradient 18999 * center:Center point of radial gradient 19000 * radius:Radius of Radial Gradient 19001 * colors:Color description for gradients 19002 * repeating: Refill 19003 * 19004 * @param { object } value 19005 * @returns { T } 19006 * @syscap SystemCapability.ArkUI.ArkUI.Full 19007 * @crossplatform 19008 * @form 19009 * @atomicservice 19010 * @since 12 19011 */ 19012 radialGradient(value: { 19013 center: [Length, Length]; 19014 radius: number | string; 19015 colors: Array<[ResourceColor, number]>; 19016 repeating?: boolean; 19017 }): T; 19018 19019 /** 19020 * Set the motion path of the component 19021 * path:Motion path for displacement animation, using the svg path string. 19022 * from:Start point of the motion path. The default value is 0.0. 19023 * to:End point of the motion path. The default value is 1.0. 19024 * rotatable:Whether to follow the path for rotation. 19025 * 19026 * @param { MotionPathOptions } value 19027 * @returns { T } 19028 * @syscap SystemCapability.ArkUI.ArkUI.Full 19029 * @since 7 19030 */ 19031 /** 19032 * Set the motion path of the component 19033 * path:Motion path for displacement animation, using the svg path string. 19034 * from:Start point of the motion path. The default value is 0.0. 19035 * to:End point of the motion path. The default value is 1.0. 19036 * rotatable:Whether to follow the path for rotation. 19037 * 19038 * @param { MotionPathOptions } value 19039 * @returns { T } 19040 * @syscap SystemCapability.ArkUI.ArkUI.Full 19041 * @crossplatform 19042 * @since 10 19043 */ 19044 /** 19045 * Set the motion path of the component 19046 * path:Motion path for displacement animation, using the svg path string. 19047 * from:Start point of the motion path. The default value is 0.0. 19048 * to:End point of the motion path. The default value is 1.0. 19049 * rotatable:Whether to follow the path for rotation. 19050 * 19051 * @param { MotionPathOptions } value 19052 * @returns { T } 19053 * @syscap SystemCapability.ArkUI.ArkUI.Full 19054 * @crossplatform 19055 * @atomicservice 19056 * @since 11 19057 */ 19058 motionPath(value: MotionPathOptions): T; 19059 19060 /** 19061 * Add a shadow effect to the current component 19062 * 19063 * @param { ShadowOptions } value 19064 * @returns { T } 19065 * @syscap SystemCapability.ArkUI.ArkUI.Full 19066 * @since 7 19067 */ 19068 /** 19069 * Add a shadow effect to the current component 19070 * 19071 * @param { ShadowOptions } value 19072 * @returns { T } 19073 * @syscap SystemCapability.ArkUI.ArkUI.Full 19074 * @form 19075 * @since 9 19076 */ 19077 /** 19078 * Add a shadow effect to the current component 19079 * 19080 * @param { ShadowOptions | ShadowStyle } value 19081 * @returns { T } 19082 * @syscap SystemCapability.ArkUI.ArkUI.Full 19083 * @crossplatform 19084 * @form 19085 * @since 10 19086 */ 19087 /** 19088 * Add a shadow effect to the current component 19089 * 19090 * @param { ShadowOptions | ShadowStyle } value 19091 * @returns { T } 19092 * @syscap SystemCapability.ArkUI.ArkUI.Full 19093 * @crossplatform 19094 * @form 19095 * @atomicservice 19096 * @since 11 19097 */ 19098 shadow(value: ShadowOptions | ShadowStyle): T; 19099 19100 /** 19101 * Add a blendMode effect to the current component 19102 * 19103 * @param { BlendMode } value - Different hybrid modes 19104 * @param { BlendApplyType } [type] - Different blend apply type 19105 * @returns { T } 19106 * @syscap SystemCapability.ArkUI.ArkUI.Full 19107 * @crossplatform 19108 * @form 19109 * @since 11 19110 */ 19111 /** 19112 * Add a blendMode effect to the current component 19113 * 19114 * @param { BlendMode } value - Different hybrid modes 19115 * @param { BlendApplyType } [type] - Different blend apply type 19116 * @returns { T } 19117 * @syscap SystemCapability.ArkUI.ArkUI.Full 19118 * @crossplatform 19119 * @form 19120 * @atomicservice 19121 * @since 12 19122 */ 19123 blendMode(value: BlendMode, type?: BlendApplyType): T; 19124 19125 /** 19126 * Add a blendMode effect to the current component.Cannot be used together with the blendMode interface. 19127 * 19128 * @param { BlendMode | Blender } effect - When the effect type is BlendMode type, define Different hybrid modes. 19129 * When the effect type is Blender type, Define the corresponding blending effect. 19130 * @param { BlendApplyType } [type] - Different blend apply type 19131 * @returns { T } 19132 * @syscap SystemCapability.ArkUI.ArkUI.Full 19133 * @systemapi 19134 * @form 19135 * @since 13 19136 */ 19137 advancedBlendMode(effect: BlendMode | Blender, type?: BlendApplyType): T; 19138 19139 /** 19140 * Whether to crop the sub components beyond the current component range. 19141 * 19142 * @param { boolean } value 19143 * @returns { T } 19144 * @syscap SystemCapability.ArkUI.ArkUI.Full 19145 * @crossplatform 19146 * @form 19147 * @atomicservice 19148 * @since 12 19149 */ 19150 clip(value: boolean): T; 19151 19152 /** 19153 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 19154 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 19155 * 19156 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value 19157 * @returns { T } 19158 * @syscap SystemCapability.ArkUI.ArkUI.Full 19159 * @since 7 19160 */ 19161 /** 19162 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 19163 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 19164 * 19165 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value 19166 * @returns { T } 19167 * @syscap SystemCapability.ArkUI.ArkUI.Full 19168 * @form 19169 * @since 9 19170 */ 19171 /** 19172 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 19173 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 19174 * 19175 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value 19176 * @returns { T } 19177 * @syscap SystemCapability.ArkUI.ArkUI.Full 19178 * @crossplatform 19179 * @form 19180 * @since 10 19181 */ 19182 /** 19183 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 19184 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 19185 * 19186 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value 19187 * @returns { T } 19188 * @syscap SystemCapability.ArkUI.ArkUI.Full 19189 * @crossplatform 19190 * @form 19191 * @atomicservice 19192 * @since 11 19193 * @deprecated since 12 19194 * @useinstead CommonMethod#clipShape 19195 */ 19196 clip(value: boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute): T; 19197 19198 /** 19199 * The current component is cropped according to the specified shape. 19200 * 19201 * @param { CircleShape | EllipseShape | PathShape | RectShape } value - indicates the shape of the clip. 19202 * @returns { T } 19203 * @syscap SystemCapability.ArkUI.ArkUI.Full 19204 * @crossplatform 19205 * @form 19206 * @atomicservice 19207 * @since 12 19208 */ 19209 clipShape(value: CircleShape | EllipseShape | PathShape | RectShape): T; 19210 19211 /** 19212 * Sets the mask of the current component. 19213 * 19214 * @param { ProgressMask } value 19215 * @returns { T } 19216 * @syscap SystemCapability.ArkUI.ArkUI.Full 19217 * @crossplatform 19218 * @atomicservice 19219 * @since 12 19220 */ 19221 mask(value: ProgressMask): T; 19222 19223 /** 19224 * Applies a mask of the specified shape to the current assembly. 19225 * 19226 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value 19227 * @returns { T } 19228 * @syscap SystemCapability.ArkUI.ArkUI.Full 19229 * @since 7 19230 */ 19231 /** 19232 * Applies a mask of the specified shape to the current assembly. 19233 * 19234 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value - indicates the shape of the mask. 19235 * @returns { T } 19236 * @syscap SystemCapability.ArkUI.ArkUI.Full 19237 * @form 19238 * @since 9 19239 */ 19240 /** 19241 * Applies a mask of the specified shape to the current assembly. 19242 * 19243 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value - indicates the shape of the mask. 19244 * @returns { T } 19245 * @syscap SystemCapability.ArkUI.ArkUI.Full 19246 * @crossplatform 19247 * @form 19248 * @since 10 19249 */ 19250 /** 19251 * Applies a mask of the specified shape to the current assembly. 19252 * 19253 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value - indicates the shape of the mask. 19254 * @returns { T } 19255 * @syscap SystemCapability.ArkUI.ArkUI.Full 19256 * @crossplatform 19257 * @form 19258 * @atomicservice 19259 * @since 11 19260 * @deprecated since 12 19261 * @useinstead CommonMethod#maskShape 19262 */ 19263 mask(value: CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask): T; 19264 19265 /** 19266 * Applies a mask of the specified shape to the current assembly. 19267 * 19268 * @param { CircleShape | EllipseShape | PathShape | RectShape } value - indicates the shape of the mask. 19269 * @returns { T } 19270 * @syscap SystemCapability.ArkUI.ArkUI.Full 19271 * @crossplatform 19272 * @form 19273 * @atomicservice 19274 * @since 12 19275 */ 19276 maskShape(value: CircleShape | EllipseShape | PathShape | RectShape): T; 19277 19278 /** 19279 * Key. User can set an key to the component to identify it. 19280 * 19281 * @param { string } value 19282 * @returns { T } 19283 * @syscap SystemCapability.ArkUI.ArkUI.Full 19284 * @atomicservice 19285 * @since 12 19286 * @test 19287 */ 19288 key(value: string): T; 19289 19290 /** 19291 * Id. User can set an id to the component to identify it. 19292 * 19293 * @param { string } value 19294 * @returns { T } 19295 * @syscap SystemCapability.ArkUI.ArkUI.Full 19296 * @since 8 19297 */ 19298 /** 19299 * Id. User can set an id to the component to identify it. 19300 * 19301 * @param { string } value 19302 * @returns { T } 19303 * @syscap SystemCapability.ArkUI.ArkUI.Full 19304 * @form 19305 * @since 9 19306 */ 19307 /** 19308 * Id. User can set an id to the component to identify it. 19309 * 19310 * @param { string } value 19311 * @returns { T } 19312 * @syscap SystemCapability.ArkUI.ArkUI.Full 19313 * @crossplatform 19314 * @form 19315 * @since 10 19316 */ 19317 /** 19318 * Id. User can set an id to the component to identify it. 19319 * 19320 * @param { string } value 19321 * @returns { T } 19322 * @syscap SystemCapability.ArkUI.ArkUI.Full 19323 * @crossplatform 19324 * @form 19325 * @atomicservice 19326 * @since 11 19327 */ 19328 id(value: string): T; 19329 19330 /** 19331 * geometryTransition 19332 * 19333 * @param { string } id 19334 * @returns { T } 19335 * @syscap SystemCapability.ArkUI.ArkUI.Full 19336 * @since 7 19337 */ 19338 /** 19339 * geometryTransition 19340 * 19341 * @param { string } id 19342 * @returns { T } 19343 * @syscap SystemCapability.ArkUI.ArkUI.Full 19344 * @crossplatform 19345 * @since 10 19346 */ 19347 /** 19348 * geometryTransition 19349 * 19350 * @param { string } id 19351 * @returns { T } 19352 * @syscap SystemCapability.ArkUI.ArkUI.Full 19353 * @crossplatform 19354 * @atomicservice 19355 * @since 11 19356 */ 19357 geometryTransition(id: string): T; 19358 /** 19359 * Shared geometry transition 19360 * 19361 * @param { string } id - geometry transition id 19362 * @param { GeometryTransitionOptions } options - Indicates the options of geometry transition. 19363 * @returns { T } 19364 * @syscap SystemCapability.ArkUI.ArkUI.Full 19365 * @crossplatform 19366 * @since 11 19367 */ 19368 /** 19369 * Shared geometry transition 19370 * 19371 * @param { string } id - geometry transition id 19372 * @param { GeometryTransitionOptions } options - Indicates the options of geometry transition. 19373 * @returns { T } 19374 * @syscap SystemCapability.ArkUI.ArkUI.Full 19375 * @crossplatform 19376 * @atomicservice 19377 * @since 12 19378 */ 19379 geometryTransition(id: string, options?: GeometryTransitionOptions): T; 19380 19381 /** 19382 * Popup control 19383 * 19384 * @param { boolean } show 19385 * @param { PopupOptions } popup 19386 * @returns { T } 19387 * @syscap SystemCapability.ArkUI.ArkUI.Full 19388 * @since 7 19389 */ 19390 /** 19391 * Popup control 19392 * 19393 * @param { boolean } show 19394 * @param { PopupOptions | CustomPopupOptions } popup 19395 * @returns { T } 19396 * @syscap SystemCapability.ArkUI.ArkUI.Full 19397 * @since 8 19398 */ 19399 /** 19400 * Popup control 19401 * 19402 * @param { boolean } show 19403 * @param { PopupOptions | CustomPopupOptions } popup 19404 * @returns { T } 19405 * @syscap SystemCapability.ArkUI.ArkUI.Full 19406 * @crossplatform 19407 * @atomicservice 19408 * @since 11 19409 */ 19410 bindPopup(show: boolean, popup: PopupOptions | CustomPopupOptions): T; 19411 19412 /** 19413 * Menu control 19414 * 19415 * @param { { value: ResourceStr; icon?: ResourceStr; action: () => void }[] | CustomBuilder } content 19416 * action: () => void }[] | CustomBuilder } content - Indicates the content of menu. 19417 * @param { MenuOptions } options 19418 * @returns { T } 19419 * @syscap SystemCapability.ArkUI.ArkUI.Full 19420 * @since 7 19421 */ 19422 /** 19423 * Menu control 19424 * 19425 * @param { { value: ResourceStr; icon?: ResourceStr; action: () => void }[] | CustomBuilder } content 19426 * action: () => void }[] | CustomBuilder } content - Indicates the content of menu. 19427 * @param { MenuOptions } options - Indicates the options of menu. 19428 * @returns { T } 19429 * @syscap SystemCapability.ArkUI.ArkUI.Full 19430 * @crossplatform 19431 * @since 10 19432 */ 19433 /** 19434 * Menu control 19435 * 19436 * @param { Array<MenuElement> | CustomBuilder } content - Indicates the content of menu. 19437 * @param { MenuOptions } options - Indicates the options of menu. 19438 * @returns { T } 19439 * @syscap SystemCapability.ArkUI.ArkUI.Full 19440 * @crossplatform 19441 * @atomicservice 19442 * @since 11 19443 */ 19444 bindMenu(content: Array<MenuElement> | CustomBuilder, options?: MenuOptions): T; 19445 19446 /** 19447 * Menu control 19448 * 19449 * @param { boolean } isShow true means display menu, false means hide menu. 19450 * @param { Array<MenuElement> | CustomBuilder } content - Indicates the content of menu. 19451 * @param { MenuOptions } options - Indicates the options of menu. 19452 * @returns { T } 19453 * @syscap SystemCapability.ArkUI.ArkUI.Full 19454 * @crossplatform 19455 * @since 11 19456 */ 19457 /** 19458 * Menu control 19459 * 19460 * @param { boolean } isShow true means display menu, false means hide menu. 19461 * @param { Array<MenuElement> | CustomBuilder } content - Indicates the content of menu. 19462 * @param { MenuOptions } options - Indicates the options of menu. 19463 * @returns { T } 19464 * @syscap SystemCapability.ArkUI.ArkUI.Full 19465 * @crossplatform 19466 * @atomicservice 19467 * @since 12 19468 */ 19469 bindMenu(isShow: boolean, content: Array<MenuElement> | CustomBuilder, options?: MenuOptions): T; 19470 19471 /** 19472 * ContextMenu control 19473 * 19474 * @param { CustomBuilder } content 19475 * @param { ResponseType } responseType 19476 * @param { ContextMenuOptions } options 19477 * @returns { T } 19478 * @syscap SystemCapability.ArkUI.ArkUI.Full 19479 * @since 8 19480 */ 19481 /** 19482 * ContextMenu control 19483 * 19484 * @param { CustomBuilder } content - Indicates the content of context menu. 19485 * @param { ResponseType } responseType - Indicates response type of context menu. 19486 * @param { ContextMenuOptions } options - Indicates the options of context menu. 19487 * @returns { T } 19488 * @syscap SystemCapability.ArkUI.ArkUI.Full 19489 * @crossplatform 19490 * @since 10 19491 */ 19492 /** 19493 * ContextMenu control 19494 * 19495 * @param { CustomBuilder } content - Indicates the content of context menu. 19496 * @param { ResponseType } responseType - Indicates response type of context menu. 19497 * @param { ContextMenuOptions } options - Indicates the options of context menu. 19498 * @returns { T } 19499 * @syscap SystemCapability.ArkUI.ArkUI.Full 19500 * @crossplatform 19501 * @atomicservice 19502 * @since 11 19503 */ 19504 bindContextMenu(content: CustomBuilder, responseType: ResponseType, options?: ContextMenuOptions): T; 19505 19506 /** 19507 * ContextMenu control 19508 * 19509 * @param { boolean } isShown - true means display content, false means hide content. 19510 * @param { CustomBuilder } content - Indicates the content of context menu. 19511 * @param { ContextMenuOptions } [options] - Indicates the options of context menu. 19512 * @returns { T } 19513 * @syscap SystemCapability.ArkUI.ArkUI.Full 19514 * @crossplatform 19515 * @atomicservice 19516 * @since 12 19517 */ 19518 bindContextMenu(isShown: boolean, content: CustomBuilder, options?: ContextMenuOptions): T; 19519 19520 /** 19521 * Bind content cover 19522 * 19523 * @param { boolean } isShow - true means display content, false means hide content. 19524 * @param { CustomBuilder } builder - the content to be displayed. 19525 * @param { ModalTransition } type - transition type. 19526 * @returns { T } 19527 * @syscap SystemCapability.ArkUI.ArkUI.Full 19528 * @crossplatform 19529 * @since 10 19530 */ 19531 /** 19532 * Bind content cover 19533 * 19534 * @param { boolean } isShow - true means display content, false means hide content. 19535 * @param { CustomBuilder } builder - the content to be displayed. 19536 * @param { ModalTransition } type - transition type. 19537 * @returns { T } 19538 * @syscap SystemCapability.ArkUI.ArkUI.Full 19539 * @crossplatform 19540 * @atomicservice 19541 * @since 11 19542 */ 19543 bindContentCover(isShow: boolean, builder: CustomBuilder, type?: ModalTransition): T; 19544 19545 /** 19546 * Bind content cover 19547 * 19548 * @param { boolean } isShow - true means display content, false means hide content. 19549 * @param { CustomBuilder } builder - the content to be displayed. 19550 * @param { ContentCoverOptions } options - options of content cover. 19551 * @returns { T } 19552 * @syscap SystemCapability.ArkUI.ArkUI.Full 19553 * @crossplatform 19554 * @since 10 19555 */ 19556 /** 19557 * Bind content cover 19558 * 19559 * @param { boolean } isShow - true means display content, false means hide content. 19560 * @param { CustomBuilder } builder - the content to be displayed. 19561 * @param { ContentCoverOptions } options - options of content cover. 19562 * @returns { T } 19563 * @syscap SystemCapability.ArkUI.ArkUI.Full 19564 * @crossplatform 19565 * @atomicservice 19566 * @since 11 19567 */ 19568 bindContentCover(isShow: boolean, builder: CustomBuilder, options?: ContentCoverOptions): T; 19569 19570 /** 19571 * Bind sheet 19572 * 19573 * @param { boolean } isShow - true means display sheet, false means hide sheet. 19574 * @param { CustomBuilder } builder - the sheet to be displayed. 19575 * @param { SheetOptions } options - options of sheet. 19576 * @returns { T } - template type 19577 * @syscap SystemCapability.ArkUI.ArkUI.Full 19578 * @crossplatform 19579 * @since 10 19580 */ 19581 /** 19582 * Bind sheet 19583 * 19584 * @param { boolean } isShow - true means display sheet, false means hide sheet. 19585 * @param { CustomBuilder } builder - the sheet to be displayed. 19586 * @param { SheetOptions } options - options of sheet. 19587 * @returns { T } - template type 19588 * @syscap SystemCapability.ArkUI.ArkUI.Full 19589 * @crossplatform 19590 * @atomicservice 19591 * @since 11 19592 */ 19593 bindSheet(isShow: boolean, builder: CustomBuilder, options?: SheetOptions): T; 19594 19595 /** 19596 * Sets styles for component state. 19597 * 19598 * @param { StateStyles } value 19599 * @returns { T } 19600 * @syscap SystemCapability.ArkUI.ArkUI.Full 19601 * @since 8 19602 */ 19603 /** 19604 * Sets styles for component state. 19605 * 19606 * @param { StateStyles } value 19607 * @returns { T } 19608 * @syscap SystemCapability.ArkUI.ArkUI.Full 19609 * @form 19610 * @since 9 19611 */ 19612 /** 19613 * Sets styles for component state. 19614 * 19615 * @param { StateStyles } value 19616 * @returns { T } 19617 * @syscap SystemCapability.ArkUI.ArkUI.Full 19618 * @crossplatform 19619 * @form 19620 * @since 10 19621 */ 19622 /** 19623 * Sets styles for component state. 19624 * 19625 * @param { StateStyles } value 19626 * @returns { T } 19627 * @syscap SystemCapability.ArkUI.ArkUI.Full 19628 * @crossplatform 19629 * @form 19630 * @atomicservice 19631 * @since 11 19632 */ 19633 stateStyles(value: StateStyles): T; 19634 19635 /** 19636 * id for distribute identification. 19637 * 19638 * @param { number } value 19639 * @returns { T } 19640 * @syscap SystemCapability.ArkUI.ArkUI.Full 19641 * @since 8 19642 */ 19643 /** 19644 * id for distribute identification. 19645 * 19646 * @param { number } value 19647 * @returns { T } 19648 * @syscap SystemCapability.ArkUI.ArkUI.Full 19649 * @crossplatform 19650 * @atomicservice 19651 * @since 11 19652 */ 19653 restoreId(value: number): T; 19654 19655 /** 19656 * Trigger a visible area change event. 19657 * 19658 * @param { Array<number> } ratios 19659 * @param { function } event 19660 * @returns { T } 19661 * @syscap SystemCapability.ArkUI.ArkUI.Full 19662 * @since 9 19663 */ 19664 /** 19665 * Trigger a visible area change event. 19666 * 19667 * @param { Array<number> } ratios 19668 * @param { function } event 19669 * @returns { T } 19670 * @syscap SystemCapability.ArkUI.ArkUI.Full 19671 * @crossplatform 19672 * @since 10 19673 */ 19674 /** 19675 * Trigger a visible area change event. 19676 * 19677 * @param { Array<number> } ratios 19678 * @param { function } event 19679 * @returns { T } 19680 * @syscap SystemCapability.ArkUI.ArkUI.Full 19681 * @crossplatform 19682 * @atomicservice 19683 * @since 11 19684 */ 19685 /** 19686 * Trigger a visible area change event. 19687 * 19688 * @param { Array<number> } ratios 19689 * @param { VisibleAreaChangeCallback } event 19690 * @returns { T } 19691 * @syscap SystemCapability.ArkUI.ArkUI.Full 19692 * @crossplatform 19693 * @atomicservice 19694 * @since 13 19695 */ 19696 onVisibleAreaChange(ratios: Array<number>, event: VisibleAreaChangeCallback): T; 19697 19698 /** 19699 * Set the spherical effect of the component. 19700 * 19701 * @param { number } value - set the degree of spherical effect, value range [0, 1]. 19702 * If the value is 0, the component keep same, else the value is 1, component are fully spherical. 19703 * @returns { T } 19704 * @syscap SystemCapability.ArkUI.ArkUI.Full 19705 * @crossplatform 19706 * @atomicservice 19707 * @since 12 19708 */ 19709 sphericalEffect(value: number): T; 19710 19711 /** 19712 * Set the light up effect of the component 19713 * 19714 * @param { number } value - set the degree to which the component lights up, value range [0, 1]. 19715 * The color brightness in the component rendering content area is greater than the value and can be displayed, otherwise it will not be displayed. 19716 * @returns { T } 19717 * @syscap SystemCapability.ArkUI.ArkUI.Full 19718 * @crossplatform 19719 * @atomicservice 19720 * @since 12 19721 */ 19722 lightUpEffect(value: number): T; 19723 19724 /** 19725 * Set the edge pixel stretch effect of the Component. 19726 * 19727 * @param { PixelStretchEffectOptions } options 19728 * @returns { T } 19729 * @syscap SystemCapability.ArkUI.ArkUI.Full 19730 * @crossplatform 19731 * @atomicservice 19732 * @since 12 19733 */ 19734 pixelStretchEffect(options: PixelStretchEffectOptions): T; 19735 19736 /** 19737 * Sets hot keys 19738 * 19739 * @param { string | FunctionKey } value - Character of the combination key. 19740 * @param { Array<ModifierKey> } keys - The modifier keys modify the action of key when the key are pressed at the same time. 19741 * @param { function } [action] - Callback function, triggered when the shortcut keyboard is pressed. 19742 * @returns { T } 19743 * @syscap SystemCapability.ArkUI.ArkUI.Full 19744 * @crossplatform 19745 * @since 10 19746 */ 19747 /** 19748 * Sets hot keys 19749 * 19750 * @param { string | FunctionKey } value - Character of the combination key. 19751 * @param { Array<ModifierKey> } keys - The modifier keys modify the action of key when the key are pressed at the same time. 19752 * @param { function } [action] - Callback function, triggered when the shortcut keyboard is pressed. 19753 * @returns { T } 19754 * @syscap SystemCapability.ArkUI.ArkUI.Full 19755 * @crossplatform 19756 * @atomicservice 19757 * @since 11 19758 */ 19759 keyboardShortcut(value: string | FunctionKey, keys: Array<ModifierKey>, action?: () => void): T; 19760 19761 /** 19762 * Sets accessibilityGroup 19763 * 19764 * @param { boolean } value - set group with accessibility 19765 * @returns { T } 19766 * @syscap SystemCapability.ArkUI.ArkUI.Full 19767 * @crossplatform 19768 * @since 10 19769 */ 19770 /** 19771 * Sets accessibilityGroup 19772 * 19773 * @param { boolean } value - set group with accessibility 19774 * @returns { T } 19775 * @syscap SystemCapability.ArkUI.ArkUI.Full 19776 * @crossplatform 19777 * @atomicservice 19778 * @since 11 19779 */ 19780 /** 19781 * Sets accessibilityGroup 19782 * 19783 * @param { boolean } value - set group with accessibility 19784 * @returns { T } 19785 * @syscap SystemCapability.ArkUI.ArkUI.Full 19786 * @crossplatform 19787 * @form 19788 * @atomicservice 19789 * @since 12 19790 */ 19791 accessibilityGroup(value: boolean): T; 19792 19793 /** 19794 * Sets accessibilityText 19795 * 19796 * @param { string } value - set accessibility text 19797 * @returns { T } 19798 * @syscap SystemCapability.ArkUI.ArkUI.Full 19799 * @crossplatform 19800 * @since 10 19801 */ 19802 /** 19803 * Sets accessibilityText 19804 * 19805 * @param { string } value - set accessibility text 19806 * @returns { T } 19807 * @syscap SystemCapability.ArkUI.ArkUI.Full 19808 * @crossplatform 19809 * @atomicservice 19810 * @since 11 19811 */ 19812 /** 19813 * Sets accessibilityText 19814 * 19815 * @param { string } value - set accessibility text 19816 * @returns { T } 19817 * @syscap SystemCapability.ArkUI.ArkUI.Full 19818 * @crossplatform 19819 * @form 19820 * @atomicservice 19821 * @since 12 19822 */ 19823 accessibilityText(value: string): T; 19824 19825 /** 19826 * Sets accessibilityText 19827 * 19828 * @param { Resource } text - set accessibility text 19829 * @returns { T } 19830 * @syscap SystemCapability.ArkUI.ArkUI.Full 19831 * @crossplatform 19832 * @form 19833 * @atomicservice 19834 * @since 12 19835 */ 19836 accessibilityText(text: Resource): T; 19837 19838 /** 19839 * Sets accessibilityTextHint 19840 * 19841 * @param { string } value - set accessibility text hint 19842 * @returns { T } 19843 * @syscap SystemCapability.ArkUI.ArkUI.Full 19844 * @crossplatform 19845 * @form 19846 * @atomicservice 19847 * @since 12 19848 */ 19849 accessibilityTextHint(value: string): T; 19850 19851 /** 19852 * Sets accessibilityDescription 19853 * 19854 * @param { string } value - set description of accessibility 19855 * @returns { T } 19856 * @syscap SystemCapability.ArkUI.ArkUI.Full 19857 * @crossplatform 19858 * @since 10 19859 */ 19860 /** 19861 * Sets accessibilityDescription 19862 * 19863 * @param { string } value - set description of accessibility 19864 * @returns { T } 19865 * @syscap SystemCapability.ArkUI.ArkUI.Full 19866 * @crossplatform 19867 * @atomicservice 19868 * @since 11 19869 */ 19870 /** 19871 * Sets accessibilityDescription 19872 * 19873 * @param { string } value - set description of accessibility 19874 * @returns { T } 19875 * @syscap SystemCapability.ArkUI.ArkUI.Full 19876 * @crossplatform 19877 * @form 19878 * @atomicservice 19879 * @since 12 19880 */ 19881 accessibilityDescription(value: string): T; 19882 19883 /** 19884 * Sets accessibilityDescription 19885 * 19886 * @param { Resource } description - set description of accessibility 19887 * @returns { T } 19888 * @syscap SystemCapability.ArkUI.ArkUI.Full 19889 * @crossplatform 19890 * @form 19891 * @atomicservice 19892 * @since 12 19893 */ 19894 accessibilityDescription(description: Resource): T; 19895 19896 /** 19897 * Sets accessibilityLevel 19898 * 19899 * @param { string } value - set accessibility level 19900 * @returns { T } 19901 * @syscap SystemCapability.ArkUI.ArkUI.Full 19902 * @crossplatform 19903 * @since 10 19904 */ 19905 /** 19906 * Sets accessibilityLevel 19907 * 19908 * @param { string } value - set accessibility level 19909 * @returns { T } 19910 * @syscap SystemCapability.ArkUI.ArkUI.Full 19911 * @crossplatform 19912 * @atomicservice 19913 * @since 11 19914 */ 19915 /** 19916 * Sets accessibilityLevel 19917 * 19918 * @param { string } value - set accessibility level 19919 * @returns { T } 19920 * @syscap SystemCapability.ArkUI.ArkUI.Full 19921 * @crossplatform 19922 * @form 19923 * @atomicservice 19924 * @since 12 19925 */ 19926 accessibilityLevel(value: string): T; 19927 19928 /** 19929 * Sets accessibilityVirtualNode 19930 * 19931 * @param { CustomBuilder } builder - set virtual node of accessibility 19932 * @returns { T } 19933 * @syscap SystemCapability.ArkUI.ArkUI.Full 19934 * @crossplatform 19935 * @atomicservice 19936 * @since 11 19937 */ 19938 /** 19939 * Sets accessibilityVirtualNode 19940 * 19941 * @param { CustomBuilder } builder - set virtual node of accessibility 19942 * @returns { T } 19943 * @syscap SystemCapability.ArkUI.ArkUI.Full 19944 * @crossplatform 19945 * @form 19946 * @atomicservice 19947 * @since 12 19948 */ 19949 accessibilityVirtualNode(builder: CustomBuilder): T; 19950 19951 /** 19952 * Sets accessibilityChecked 19953 * 19954 * @param { boolean } isCheck - set accessibility checked status 19955 * @returns { T } 19956 * @syscap SystemCapability.ArkUI.ArkUI.Full 19957 * @crossplatform 19958 * @form 19959 * @atomicservice 19960 * @since 13 19961 */ 19962 accessibilityChecked(isCheck: boolean): T; 19963 19964 /** 19965 * Sets accessibilitySelected 19966 * 19967 * @param { boolean } isSelect - set accessibility selected status 19968 * @returns { T } 19969 * @syscap SystemCapability.ArkUI.ArkUI.Full 19970 * @crossplatform 19971 * @form 19972 * @atomicservice 19973 * @since 13 19974 */ 19975 accessibilitySelected(isSelect: boolean): T; 19976 19977 /** 19978 * Sets obscured 19979 * 19980 * @param { Array<ObscuredReasons> } reasons - reasons of obscuration 19981 * @returns { T } 19982 * @syscap SystemCapability.ArkUI.ArkUI.Full 19983 * @crossplatform 19984 * @since 10 19985 */ 19986 /** 19987 * Sets obscured 19988 * 19989 * @param { Array<ObscuredReasons> } reasons - reasons of obscuration 19990 * @returns { T } 19991 * @syscap SystemCapability.ArkUI.ArkUI.Full 19992 * @crossplatform 19993 * @atomicservice 19994 * @since 11 19995 */ 19996 obscured(reasons: Array<ObscuredReasons>): T; 19997 19998 /** 19999 * Reuse id is used for identify the reuse type for each custom node. 20000 * 20001 * @param { string } id - The id for reusable custom node. 20002 * @returns { T } 20003 * @syscap SystemCapability.ArkUI.ArkUI.Full 20004 * @crossplatform 20005 * @since 10 20006 */ 20007 /** 20008 * Reuse id is used for identify the reuse type for each custom node. 20009 * 20010 * @param { string } id - The id for reusable custom node. 20011 * @returns { T } 20012 * @syscap SystemCapability.ArkUI.ArkUI.Full 20013 * @crossplatform 20014 * @atomicservice 20015 * @since 11 20016 */ 20017 reuseId(id: string): T; 20018 20019 /** 20020 * Sets how content is drawn within nodes duration animation 20021 * 20022 * @param { RenderFit } fitMode - The render fit mode of content. 20023 * @returns { T } 20024 * @syscap SystemCapability.ArkUI.ArkUI.Full 20025 * @crossplatform 20026 * @since 10 20027 */ 20028 /** 20029 * Sets how content is drawn within nodes duration animation 20030 * 20031 * @param { RenderFit } fitMode - The render fit mode of content. 20032 * @returns { T } 20033 * @syscap SystemCapability.ArkUI.ArkUI.Full 20034 * @crossplatform 20035 * @atomicservice 20036 * @since 11 20037 */ 20038 renderFit(fitMode: RenderFit): T; 20039 20040 /** 20041 * Sets the attribute modifier. 20042 * 20043 * @param { AttributeModifier<T> } modifier 20044 * @returns { T } 20045 * @syscap SystemCapability.ArkUI.ArkUI.Full 20046 * @crossplatform 20047 * @since 11 20048 */ 20049 /** 20050 * Sets the attribute modifier. 20051 * 20052 * @param { AttributeModifier<T> } modifier 20053 * @returns { T } 20054 * @syscap SystemCapability.ArkUI.ArkUI.Full 20055 * @crossplatform 20056 * @atomicservice 20057 * @since 12 20058 */ 20059 attributeModifier(modifier: AttributeModifier<T>): T; 20060 20061 /** 20062 * Sets the gesture modifier. 20063 * 20064 * @param { GestureModifier } modifier 20065 * @returns { T } 20066 * @syscap SystemCapability.ArkUI.ArkUI.Full 20067 * @crossplatform 20068 * @atomicservice 20069 * @since 12 20070 */ 20071 gestureModifier(modifier: GestureModifier): T; 20072 20073 /** 20074 * Adds a background dynamic light up effect to the current component. 20075 * 20076 * @param { BackgroundBrightnessOptions } params - params indicates BackgroundBrightnessOptions 20077 * @returns { T } 20078 * @syscap SystemCapability.ArkUI.ArkUI.Full 20079 * @atomicservice 20080 * @since 12 20081 */ 20082 backgroundBrightness(params: BackgroundBrightnessOptions): T; 20083 20084 /** 20085 * When a gesture bound to this component will be accepted, a user-defined callback is triggered to get the result 20086 * 20087 * @param { function } callback - A callback instance used when a gesture bound to this component will be accepted. 20088 * @returns { T } 20089 * @syscap SystemCapability.ArkUI.ArkUI.Full 20090 * @crossplatform 20091 * @since 11 20092 */ 20093 /** 20094 * When a gesture bound to this component will be accepted, a user-defined callback is triggered to get the result 20095 * 20096 * @param { function } callback - A callback instance used when a gesture bound to this component will be accepted. 20097 * @returns { T } 20098 * @syscap SystemCapability.ArkUI.ArkUI.Full 20099 * @crossplatform 20100 * @atomicservice 20101 * @since 12 20102 */ 20103 onGestureJudgeBegin(callback: (gestureInfo: GestureInfo, event: BaseGestureEvent) => GestureJudgeResult): T; 20104 20105 /** 20106 * When a gesture bound to this component will be accepted, a user-defined callback is triggered to get the result 20107 * 20108 * @param { GestureRecognizerJudgeBeginCallback } callback - A callback instance used when a gesture bound to this component will be accepted. 20109 * @returns { T } 20110 * @syscap SystemCapability.ArkUI.ArkUI.Full 20111 * @crossplatform 20112 * @atomicservice 20113 * @since 12 20114 */ 20115 onGestureRecognizerJudgeBegin(callback: GestureRecognizerJudgeBeginCallback): T; 20116 20117 /** 20118 * When a gesture bound to this component will be accepted, a user-defined callback is triggered to get the result 20119 * 20120 * @param { GestureRecognizerJudgeBeginCallback } callback - A callback instance used when a gesture bound to this component will be accepted. 20121 * @param { boolean } exposeInnerGesture - This parameter is a flag. This flag determines whether to expose internal gestures. 20122 * @returns { T } 20123 * @syscap SystemCapability.ArkUI.ArkUI.Full 20124 * @crossplatform 20125 * @atomicservice 20126 * 20127 * @since 13 20128 */ 20129 onGestureRecognizerJudgeBegin(callback: GestureRecognizerJudgeBeginCallback, exposeInnerGesture: boolean): T; 20130 20131 /** 20132 * In the touch test phase, the recognizer is selected to form a parallel relationship with other recognizers on the response chain. 20133 * 20134 * @param { ShouldBuiltInRecognizerParallelWithCallback } callback - A callback instance used when a component is doing touch test. 20135 * @returns { T } 20136 * @syscap SystemCapability.ArkUI.ArkUI.Full 20137 * @crossplatform 20138 * @atomicservice 20139 * @since 12 20140 */ 20141 shouldBuiltInRecognizerParallelWith(callback: ShouldBuiltInRecognizerParallelWithCallback): T; 20142 20143 /** 20144 * Events are monopolized by components. 20145 * 20146 * @param { boolean } monopolize - indicate the monopoly of events 20147 * @returns { T } 20148 * @syscap SystemCapability.ArkUI.ArkUI.Full 20149 * @crossplatform 20150 * @since 11 20151 */ 20152 /** 20153 * Events are monopolized by components. 20154 * 20155 * @param { boolean } monopolize - indicate the monopoly of events 20156 * @returns { T } 20157 * @syscap SystemCapability.ArkUI.ArkUI.Full 20158 * @crossplatform 20159 * @atomicservice 20160 * @since 12 20161 */ 20162 monopolizeEvents(monopolize: boolean): T; 20163 20164 /** 20165 * When the component does a touch test, a user-defined callback is triggered. 20166 * 20167 * @param { Callback<TouchEvent, HitTestMode> } callback - A callback instance used when the component does a touch test. 20168 * @returns { T } 20169 * @syscap SystemCapability.ArkUI.ArkUI.Full 20170 * @crossplatform 20171 * @atomicservice 20172 * @since 12 20173 */ 20174 onTouchIntercept(callback: Callback<TouchEvent, HitTestMode>): T; 20175 20176 /** 20177 * This callback is triggered when the size of this component change finished. 20178 * 20179 * @param { SizeChangeCallback } event - event callback. 20180 * @returns { T } 20181 * @syscap SystemCapability.ArkUI.ArkUI.Full 20182 * @crossplatform 20183 * @form 20184 * @atomicservice 20185 * @since 12 20186 */ 20187 onSizeChange(event: SizeChangeCallback): T; 20188} 20189 20190/** 20191 * CommonAttribute for ide. 20192 * 20193 * @extends CommonMethod<CommonAttribute> 20194 * @syscap SystemCapability.ArkUI.ArkUI.Full 20195 * @since 7 20196 */ 20197/** 20198 * CommonAttribute for ide. 20199 * 20200 * @extends CommonMethod<CommonAttribute> 20201 * @syscap SystemCapability.ArkUI.ArkUI.Full 20202 * @form 20203 * @since 9 20204 */ 20205/** 20206 * CommonAttribute for ide. 20207 * 20208 * @extends CommonMethod<CommonAttribute> 20209 * @syscap SystemCapability.ArkUI.ArkUI.Full 20210 * @crossplatform 20211 * @form 20212 * @since 10 20213 */ 20214/** 20215 * CommonAttribute for ide. 20216 * 20217 * @extends CommonMethod<CommonAttribute> 20218 * @syscap SystemCapability.ArkUI.ArkUI.Full 20219 * @crossplatform 20220 * @form 20221 * @atomicservice 20222 * @since 11 20223 */ 20224declare class CommonAttribute extends CommonMethod<CommonAttribute> {} 20225 20226/** 20227 * CommonInterface for ide. 20228 * 20229 * @interface CommonInterface 20230 * @syscap SystemCapability.ArkUI.ArkUI.Full 20231 * @since 7 20232 */ 20233/** 20234 * CommonInterface for ide. 20235 * 20236 * @interface CommonInterface 20237 * @syscap SystemCapability.ArkUI.ArkUI.Full 20238 * @form 20239 * @since 9 20240 */ 20241/** 20242 * CommonInterface for ide. 20243 * 20244 * @interface CommonInterface 20245 * @syscap SystemCapability.ArkUI.ArkUI.Full 20246 * @crossplatform 20247 * @form 20248 * @since 10 20249 */ 20250/** 20251 * CommonInterface for ide. 20252 * 20253 * @interface CommonInterface 20254 * @syscap SystemCapability.ArkUI.ArkUI.Full 20255 * @crossplatform 20256 * @form 20257 * @atomicservice 20258 * @since 11 20259 */ 20260interface CommonInterface { 20261 /** 20262 * Constructor. 20263 * 20264 * @returns { CommonAttribute } 20265 * @syscap SystemCapability.ArkUI.ArkUI.Full 20266 * @since 7 20267 */ 20268 /** 20269 * Constructor 20270 * 20271 * @returns { CommonAttribute } 20272 * @syscap SystemCapability.ArkUI.ArkUI.Full 20273 * @form 20274 * @since 9 20275 */ 20276 /** 20277 * Constructor 20278 * 20279 * @returns { CommonAttribute } 20280 * @syscap SystemCapability.ArkUI.ArkUI.Full 20281 * @crossplatform 20282 * @form 20283 * @since 10 20284 */ 20285 /** 20286 * Constructor 20287 * 20288 * @returns { CommonAttribute } 20289 * @syscap SystemCapability.ArkUI.ArkUI.Full 20290 * @crossplatform 20291 * @form 20292 * @atomicservice 20293 * @since 11 20294 */ 20295 (): CommonAttribute; 20296} 20297 20298/** 20299 * CommonInstance for ide. 20300 * 20301 * @syscap SystemCapability.ArkUI.ArkUI.Full 20302 * @since 7 20303 */ 20304/** 20305 * CommonInstance for ide. 20306 * 20307 * @syscap SystemCapability.ArkUI.ArkUI.Full 20308 * @form 20309 * @since 9 20310 */ 20311/** 20312 * CommonInstance for ide. 20313 * 20314 * @syscap SystemCapability.ArkUI.ArkUI.Full 20315 * @crossplatform 20316 * @form 20317 * @since 10 20318 */ 20319/** 20320 * CommonInstance for ide. 20321 * 20322 * @syscap SystemCapability.ArkUI.ArkUI.Full 20323 * @crossplatform 20324 * @form 20325 * @atomicservice 20326 * @since 11 20327 */ 20328declare const CommonInstance: CommonAttribute; 20329 20330/** 20331 * Common for ide. 20332 * 20333 * @syscap SystemCapability.ArkUI.ArkUI.Full 20334 * @since 7 20335 */ 20336/** 20337 * Common for ide. 20338 * 20339 * @syscap SystemCapability.ArkUI.ArkUI.Full 20340 * @form 20341 * @since 9 20342 */ 20343/** 20344 * Common for ide. 20345 * 20346 * @syscap SystemCapability.ArkUI.ArkUI.Full 20347 * @crossplatform 20348 * @form 20349 * @since 10 20350 */ 20351/** 20352 * Common for ide. 20353 * 20354 * @syscap SystemCapability.ArkUI.ArkUI.Full 20355 * @crossplatform 20356 * @form 20357 * @atomicservice 20358 * @since 11 20359 */ 20360declare const Common: CommonInterface; 20361 20362/** 20363 * Defines the CustomBuilder Type. 20364 * 20365 * @typedef { (() => any) | void } CustomBuilder 20366 * @syscap SystemCapability.ArkUI.ArkUI.Full 20367 * @since 8 20368 */ 20369/** 20370 * Defines the CustomBuilder Type. 20371 * 20372 * @typedef { (() => any) | void } CustomBuilder 20373 * @syscap SystemCapability.ArkUI.ArkUI.Full 20374 * @form 20375 * @since 9 20376 */ 20377/** 20378 * Defines the CustomBuilder Type. 20379 * 20380 * @typedef { (() => any) | void } CustomBuilder 20381 * @syscap SystemCapability.ArkUI.ArkUI.Full 20382 * @crossplatform 20383 * @form 20384 * @since 10 20385 */ 20386/** 20387 * Defines the CustomBuilder Type. 20388 * 20389 * @typedef { (() => any) | void } CustomBuilder 20390 * @syscap SystemCapability.ArkUI.ArkUI.Full 20391 * @crossplatform 20392 * @form 20393 * @atomicservice 20394 * @since 11 20395 */ 20396declare type CustomBuilder = (() => any) | void; 20397 20398/** 20399 * Defines the OverlayOptions interface. 20400 * 20401 * @typedef OverlayOptions 20402 * @syscap SystemCapability.ArkUI.ArkUI.Full 20403 * @crossplatform 20404 * @form 20405 * @atomicservice 20406 * @since 12 20407 */ 20408declare interface OverlayOptions { 20409 /** 20410 * Defines align type. 20411 * 20412 * @type { ?Alignment } 20413 * @syscap SystemCapability.ArkUI.ArkUI.Full 20414 * @since 7 20415 */ 20416 /** 20417 * Defines align type. 20418 * 20419 * @type { ?Alignment } 20420 * @syscap SystemCapability.ArkUI.ArkUI.Full 20421 * @form 20422 * @since 9 20423 */ 20424 /** 20425 * Defines align type. 20426 * 20427 * @type { ?Alignment } 20428 * @syscap SystemCapability.ArkUI.ArkUI.Full 20429 * @crossplatform 20430 * @form 20431 * @since 10 20432 */ 20433 /** 20434 * Defines align type. 20435 * 20436 * @type { ?Alignment } 20437 * @syscap SystemCapability.ArkUI.ArkUI.Full 20438 * @crossplatform 20439 * @form 20440 * @atomicservice 20441 * @since 11 20442 */ 20443 align?: Alignment; 20444 20445 /** 20446 * Defines offset type. 20447 * 20448 * @type { ?OverlayOffset } 20449 * @syscap SystemCapability.ArkUI.ArkUI.Full 20450 * @since 7 20451 */ 20452 /** 20453 * Defines offset type. 20454 * 20455 * @type { ?OverlayOffset } 20456 * @syscap SystemCapability.ArkUI.ArkUI.Full 20457 * @form 20458 * @since 9 20459 */ 20460 /** 20461 * Defines offset type. 20462 * 20463 * @type { ?OverlayOffset } 20464 * @syscap SystemCapability.ArkUI.ArkUI.Full 20465 * @crossplatform 20466 * @form 20467 * @since 10 20468 */ 20469 /** 20470 * Defines offset type. 20471 * 20472 * @type { ?OverlayOffset } 20473 * @syscap SystemCapability.ArkUI.ArkUI.Full 20474 * @crossplatform 20475 * @form 20476 * @atomicservice 20477 * @since 11 20478 */ 20479 offset?: OverlayOffset; 20480} 20481 20482/** 20483 * Defines the OverlayOffset. 20484 * 20485 * @typedef OverlayOffset 20486 * @syscap SystemCapability.ArkUI.ArkUI.Full 20487 * @crossplatform 20488 * @form 20489 * @atomicservice 20490 * @since 12 20491 */ 20492declare interface OverlayOffset { 20493 /** 20494 * Defines x. 20495 * 20496 * @type { ?number } 20497 * @syscap SystemCapability.ArkUI.ArkUI.Full 20498 * @since 7 20499 */ 20500 /** 20501 * Defines x. 20502 * 20503 * @type { ?number } 20504 * @syscap SystemCapability.ArkUI.ArkUI.Full 20505 * @form 20506 * @since 9 20507 */ 20508 /** 20509 * Defines x. 20510 * 20511 * @type { ?number } 20512 * @syscap SystemCapability.ArkUI.ArkUI.Full 20513 * @crossplatform 20514 * @form 20515 * @since 10 20516 */ 20517 /** 20518 * Defines x. 20519 * 20520 * @type { ?number } 20521 * @syscap SystemCapability.ArkUI.ArkUI.Full 20522 * @crossplatform 20523 * @form 20524 * @atomicservice 20525 * @since 11 20526 */ 20527 x?: number; 20528 /** 20529 * Defines y. 20530 * 20531 * @type { ?number } 20532 * @syscap SystemCapability.ArkUI.ArkUI.Full 20533 * @since 7 20534 */ 20535 /** 20536 * Defines y. 20537 * 20538 * @type { ?number } 20539 * @syscap SystemCapability.ArkUI.ArkUI.Full 20540 * @form 20541 * @since 9 20542 */ 20543 /** 20544 * Defines y. 20545 * 20546 * @type { ?number } 20547 * @syscap SystemCapability.ArkUI.ArkUI.Full 20548 * @crossplatform 20549 * @form 20550 * @since 10 20551 */ 20552 /** 20553 * Defines y. 20554 * 20555 * @type { ?number } 20556 * @syscap SystemCapability.ArkUI.ArkUI.Full 20557 * @crossplatform 20558 * @form 20559 * @atomicservice 20560 * @since 11 20561 */ 20562 y?: number; 20563} 20564 20565/** 20566 * Defines the segment of blur. 20567 * The first element in the tuple means fraction. 20568 * The range of this value is [0,1]. A value of 1 means opaque and 0 means completely transparent. 20569 * The second element means the stop position. 20570 * The range of this value is [0,1]. A value of 1 means region ending position and 0 means region starting position. 20571 * 20572 * @typedef { [ number, number ] } FractionStop 20573 * @syscap SystemCapability.ArkUI.ArkUI.Full 20574 * @atomicservice 20575 * @since 12 20576 */ 20577declare type FractionStop = [ number, number ]; 20578 20579/** 20580 * CommonShapeMethod 20581 * 20582 * @extends CommonMethod<T> 20583 * @syscap SystemCapability.ArkUI.ArkUI.Full 20584 * @since 7 20585 */ 20586/** 20587 * CommonShapeMethod 20588 * 20589 * @extends CommonMethod<T> 20590 * @syscap SystemCapability.ArkUI.ArkUI.Full 20591 * @form 20592 * @since 9 20593 */ 20594/** 20595 * CommonShapeMethod 20596 * 20597 * @extends CommonMethod<T> 20598 * @syscap SystemCapability.ArkUI.ArkUI.Full 20599 * @crossplatform 20600 * @form 20601 * @since 10 20602 */ 20603/** 20604 * CommonShapeMethod 20605 * 20606 * @extends CommonMethod<T> 20607 * @syscap SystemCapability.ArkUI.ArkUI.Full 20608 * @crossplatform 20609 * @form 20610 * @atomicservice 20611 * @since 11 20612 */ 20613declare class CommonShapeMethod<T> extends CommonMethod<T> { 20614 /** 20615 * constructor. 20616 * 20617 * @syscap SystemCapability.ArkUI.ArkUI.Full 20618 * @systemapi 20619 * @since 7 20620 */ 20621 /** 20622 * constructor. 20623 * 20624 * @syscap SystemCapability.ArkUI.ArkUI.Full 20625 * @systemapi 20626 * @form 20627 * @since 9 20628 */ 20629 constructor(); 20630 20631 /** 20632 * border Color 20633 * 20634 * @param { ResourceColor } value 20635 * @returns { T } 20636 * @syscap SystemCapability.ArkUI.ArkUI.Full 20637 * @since 7 20638 */ 20639 /** 20640 * border Color 20641 * 20642 * @param { ResourceColor } value 20643 * @returns { T } 20644 * @syscap SystemCapability.ArkUI.ArkUI.Full 20645 * @form 20646 * @since 9 20647 */ 20648 /** 20649 * border Color 20650 * 20651 * @param { ResourceColor } value 20652 * @returns { T } 20653 * @syscap SystemCapability.ArkUI.ArkUI.Full 20654 * @crossplatform 20655 * @form 20656 * @since 10 20657 */ 20658 /** 20659 * border Color 20660 * 20661 * @param { ResourceColor } value 20662 * @returns { T } 20663 * @syscap SystemCapability.ArkUI.ArkUI.Full 20664 * @crossplatform 20665 * @form 20666 * @atomicservice 20667 * @since 11 20668 */ 20669 stroke(value: ResourceColor): T; 20670 20671 /** 20672 * Fill color. 20673 * 20674 * @param { ResourceColor } value 20675 * @returns { T } 20676 * @syscap SystemCapability.ArkUI.ArkUI.Full 20677 * @since 7 20678 */ 20679 /** 20680 * Fill color. 20681 * 20682 * @param { ResourceColor } value 20683 * @returns { T } 20684 * @syscap SystemCapability.ArkUI.ArkUI.Full 20685 * @form 20686 * @since 9 20687 */ 20688 /** 20689 * Fill color. 20690 * 20691 * @param { ResourceColor } value 20692 * @returns { T } 20693 * @syscap SystemCapability.ArkUI.ArkUI.Full 20694 * @crossplatform 20695 * @form 20696 * @since 10 20697 */ 20698 /** 20699 * Fill color. 20700 * 20701 * @param { ResourceColor } value 20702 * @returns { T } 20703 * @syscap SystemCapability.ArkUI.ArkUI.Full 20704 * @crossplatform 20705 * @form 20706 * @atomicservice 20707 * @since 11 20708 */ 20709 fill(value: ResourceColor): T; 20710 20711 /** 20712 * Offset from the start point of the border drawing. 20713 * 20714 * @param { number | string } value 20715 * @returns { T } 20716 * @syscap SystemCapability.ArkUI.ArkUI.Full 20717 * @since 7 20718 */ 20719 /** 20720 * Offset from the start point of the border drawing. 20721 * 20722 * @param { number | string } value 20723 * @returns { T } 20724 * @syscap SystemCapability.ArkUI.ArkUI.Full 20725 * @form 20726 * @since 9 20727 */ 20728 /** 20729 * Offset from the start point of the border drawing. 20730 * 20731 * @param { number | string } value 20732 * @returns { T } 20733 * @syscap SystemCapability.ArkUI.ArkUI.Full 20734 * @crossplatform 20735 * @form 20736 * @since 10 20737 */ 20738 /** 20739 * Offset from the start point of the border drawing. 20740 * 20741 * @param { number | string } value 20742 * @returns { T } 20743 * @syscap SystemCapability.ArkUI.ArkUI.Full 20744 * @crossplatform 20745 * @form 20746 * @atomicservice 20747 * @since 11 20748 */ 20749 strokeDashOffset(value: number | string): T; 20750 20751 /** 20752 * Path endpoint drawing style. 20753 * 20754 * @param { LineCapStyle } value 20755 * @returns { T } 20756 * @syscap SystemCapability.ArkUI.ArkUI.Full 20757 * @since 7 20758 */ 20759 /** 20760 * Path endpoint drawing style. 20761 * 20762 * @param { LineCapStyle } value 20763 * @returns { T } 20764 * @syscap SystemCapability.ArkUI.ArkUI.Full 20765 * @form 20766 * @since 9 20767 */ 20768 /** 20769 * Path endpoint drawing style. 20770 * 20771 * @param { LineCapStyle } value 20772 * @returns { T } 20773 * @syscap SystemCapability.ArkUI.ArkUI.Full 20774 * @crossplatform 20775 * @form 20776 * @since 10 20777 */ 20778 /** 20779 * Path endpoint drawing style. 20780 * 20781 * @param { LineCapStyle } value 20782 * @returns { T } 20783 * @syscap SystemCapability.ArkUI.ArkUI.Full 20784 * @crossplatform 20785 * @form 20786 * @atomicservice 20787 * @since 11 20788 */ 20789 strokeLineCap(value: LineCapStyle): T; 20790 20791 /** 20792 * Border corner drawing style. 20793 * 20794 * @param { LineJoinStyle } value 20795 * @returns { T } 20796 * @syscap SystemCapability.ArkUI.ArkUI.Full 20797 * @since 7 20798 */ 20799 /** 20800 * Border corner drawing style. 20801 * 20802 * @param { LineJoinStyle } value 20803 * @returns { T } 20804 * @syscap SystemCapability.ArkUI.ArkUI.Full 20805 * @form 20806 * @since 9 20807 */ 20808 /** 20809 * Border corner drawing style. 20810 * 20811 * @param { LineJoinStyle } value 20812 * @returns { T } 20813 * @syscap SystemCapability.ArkUI.ArkUI.Full 20814 * @crossplatform 20815 * @form 20816 * @since 10 20817 */ 20818 /** 20819 * Border corner drawing style. 20820 * 20821 * @param { LineJoinStyle } value 20822 * @returns { T } 20823 * @syscap SystemCapability.ArkUI.ArkUI.Full 20824 * @crossplatform 20825 * @form 20826 * @atomicservice 20827 * @since 11 20828 */ 20829 strokeLineJoin(value: LineJoinStyle): T; 20830 20831 /** 20832 * Limits for drawing acute angles as bevels 20833 * 20834 * @param { number | string } value 20835 * @returns { T } 20836 * @syscap SystemCapability.ArkUI.ArkUI.Full 20837 * @since 7 20838 */ 20839 /** 20840 * Limits for drawing acute angles as bevels 20841 * 20842 * @param { number | string } value 20843 * @returns { T } 20844 * @syscap SystemCapability.ArkUI.ArkUI.Full 20845 * @form 20846 * @since 9 20847 */ 20848 /** 20849 * Limits for drawing acute angles as bevels 20850 * 20851 * @param { number | string } value 20852 * @returns { T } 20853 * @syscap SystemCapability.ArkUI.ArkUI.Full 20854 * @crossplatform 20855 * @form 20856 * @since 10 20857 */ 20858 /** 20859 * Limits for drawing acute angles as bevels 20860 * 20861 * @param { number | string } value 20862 * @returns { T } 20863 * @syscap SystemCapability.ArkUI.ArkUI.Full 20864 * @crossplatform 20865 * @form 20866 * @atomicservice 20867 * @since 11 20868 */ 20869 strokeMiterLimit(value: number | string): T; 20870 20871 /** 20872 * Sets the opacity of the border. 20873 * 20874 * @param { number | string | Resource } value 20875 * @returns { T } 20876 * @syscap SystemCapability.ArkUI.ArkUI.Full 20877 * @since 7 20878 */ 20879 /** 20880 * Sets the opacity of the border. 20881 * 20882 * @param { number | string | Resource } value 20883 * @returns { T } 20884 * @syscap SystemCapability.ArkUI.ArkUI.Full 20885 * @form 20886 * @since 9 20887 */ 20888 /** 20889 * Sets the opacity of the border. 20890 * 20891 * @param { number | string | Resource } value 20892 * @returns { T } 20893 * @syscap SystemCapability.ArkUI.ArkUI.Full 20894 * @crossplatform 20895 * @form 20896 * @since 10 20897 */ 20898 /** 20899 * Sets the opacity of the border. 20900 * 20901 * @param { number | string | Resource } value 20902 * @returns { T } 20903 * @syscap SystemCapability.ArkUI.ArkUI.Full 20904 * @crossplatform 20905 * @form 20906 * @atomicservice 20907 * @since 11 20908 */ 20909 strokeOpacity(value: number | string | Resource): T; 20910 20911 /** 20912 * fill Opacity 20913 * 20914 * @param { number | string | Resource } value 20915 * @returns { T } 20916 * @syscap SystemCapability.ArkUI.ArkUI.Full 20917 * @since 7 20918 */ 20919 /** 20920 * fill Opacity 20921 * 20922 * @param { number | string | Resource } value 20923 * @returns { T } 20924 * @syscap SystemCapability.ArkUI.ArkUI.Full 20925 * @form 20926 * @since 9 20927 */ 20928 /** 20929 * fill Opacity 20930 * 20931 * @param { number | string | Resource } value 20932 * @returns { T } 20933 * @syscap SystemCapability.ArkUI.ArkUI.Full 20934 * @crossplatform 20935 * @form 20936 * @since 10 20937 */ 20938 /** 20939 * fill Opacity 20940 * 20941 * @param { number | string | Resource } value 20942 * @returns { T } 20943 * @syscap SystemCapability.ArkUI.ArkUI.Full 20944 * @crossplatform 20945 * @form 20946 * @atomicservice 20947 * @since 11 20948 */ 20949 fillOpacity(value: number | string | Resource): T; 20950 20951 /** 20952 * Sets the width of the dividing line. 20953 * 20954 * @param { Length } value 20955 * @returns { T } 20956 * @syscap SystemCapability.ArkUI.ArkUI.Full 20957 * @since 7 20958 */ 20959 /** 20960 * Sets the width of the dividing line. 20961 * 20962 * @param { Length } value 20963 * @returns { T } 20964 * @syscap SystemCapability.ArkUI.ArkUI.Full 20965 * @form 20966 * @since 9 20967 */ 20968 /** 20969 * Sets the width of the dividing line. 20970 * 20971 * @param { Length } value 20972 * @returns { T } 20973 * @syscap SystemCapability.ArkUI.ArkUI.Full 20974 * @crossplatform 20975 * @form 20976 * @since 10 20977 */ 20978 /** 20979 * Sets the width of the dividing line. 20980 * 20981 * @param { Length } value 20982 * @returns { T } 20983 * @syscap SystemCapability.ArkUI.ArkUI.Full 20984 * @crossplatform 20985 * @form 20986 * @atomicservice 20987 * @since 11 20988 */ 20989 strokeWidth(value: Length): T; 20990 20991 /** 20992 * Indicates whether to enable anti-aliasing 20993 * 20994 * @param { boolean } value 20995 * @returns { T } 20996 * @syscap SystemCapability.ArkUI.ArkUI.Full 20997 * @since 7 20998 */ 20999 /** 21000 * Indicates whether to enable anti-aliasing 21001 * 21002 * @param { boolean } value 21003 * @returns { T } 21004 * @syscap SystemCapability.ArkUI.ArkUI.Full 21005 * @form 21006 * @since 9 21007 */ 21008 /** 21009 * Indicates whether to enable anti-aliasing 21010 * 21011 * @param { boolean } value 21012 * @returns { T } 21013 * @syscap SystemCapability.ArkUI.ArkUI.Full 21014 * @crossplatform 21015 * @form 21016 * @since 10 21017 */ 21018 /** 21019 * Indicates whether to enable anti-aliasing 21020 * 21021 * @param { boolean } value 21022 * @returns { T } 21023 * @syscap SystemCapability.ArkUI.ArkUI.Full 21024 * @crossplatform 21025 * @form 21026 * @atomicservice 21027 * @since 11 21028 */ 21029 antiAlias(value: boolean): T; 21030 21031 /** 21032 * Sets the gap for the border. 21033 * 21034 * @param { Array<any> } value 21035 * @returns { T } 21036 * @syscap SystemCapability.ArkUI.ArkUI.Full 21037 * @since 7 21038 */ 21039 /** 21040 * Sets the gap for the border. 21041 * 21042 * @param { Array<any> } value 21043 * @returns { T } 21044 * @syscap SystemCapability.ArkUI.ArkUI.Full 21045 * @form 21046 * @since 9 21047 */ 21048 /** 21049 * Sets the gap for the border. 21050 * 21051 * @param { Array<any> } value 21052 * @returns { T } 21053 * @syscap SystemCapability.ArkUI.ArkUI.Full 21054 * @crossplatform 21055 * @form 21056 * @since 10 21057 */ 21058 /** 21059 * Sets the gap for the border. 21060 * 21061 * @param { Array<any> } value 21062 * @returns { T } 21063 * @syscap SystemCapability.ArkUI.ArkUI.Full 21064 * @crossplatform 21065 * @form 21066 * @atomicservice 21067 * @since 11 21068 */ 21069 strokeDashArray(value: Array<any>): T; 21070} 21071 21072/** 21073 * Linear Gradient Interface 21074 * 21075 * @interface LinearGradient 21076 * @syscap SystemCapability.ArkUI.ArkUI.Full 21077 * @since 9 21078 */ 21079/** 21080 * Linear Gradient Interface 21081 * 21082 * @interface LinearGradient 21083 * @syscap SystemCapability.ArkUI.ArkUI.Full 21084 * @crossplatform 21085 * @since 10 21086 */ 21087/** 21088 * Linear Gradient Interface 21089 * 21090 * @interface LinearGradient 21091 * @syscap SystemCapability.ArkUI.ArkUI.Full 21092 * @crossplatform 21093 * @atomicservice 21094 * @since 11 21095 */ 21096declare interface LinearGradient { 21097 /** 21098 * Linear Gradient Angle 21099 * 21100 * @type { ?(number | string) } 21101 * @syscap SystemCapability.ArkUI.ArkUI.Full 21102 * @since 9 21103 */ 21104 /** 21105 * Linear Gradient Angle 21106 * 21107 * @type { ?(number | string) } 21108 * @syscap SystemCapability.ArkUI.ArkUI.Full 21109 * @crossplatform 21110 * @since 10 21111 */ 21112 /** 21113 * Linear Gradient Angle 21114 * 21115 * @type { ?(number | string) } 21116 * @syscap SystemCapability.ArkUI.ArkUI.Full 21117 * @crossplatform 21118 * @atomicservice 21119 * @since 11 21120 */ 21121 angle?: number | string; 21122 /** 21123 * Linear Gradient Direction 21124 * 21125 * @type { ?GradientDirection } 21126 * @syscap SystemCapability.ArkUI.ArkUI.Full 21127 * @since 9 21128 */ 21129 /** 21130 * Linear Gradient Direction 21131 * 21132 * @type { ?GradientDirection } 21133 * @syscap SystemCapability.ArkUI.ArkUI.Full 21134 * @crossplatform 21135 * @since 10 21136 */ 21137 /** 21138 * Linear Gradient Direction 21139 * 21140 * @type { ?GradientDirection } 21141 * @syscap SystemCapability.ArkUI.ArkUI.Full 21142 * @crossplatform 21143 * @atomicservice 21144 * @since 11 21145 */ 21146 direction?: GradientDirection; 21147 /** 21148 * Linear Gradient Colors 21149 * 21150 * @type { Array<any> } 21151 * @syscap SystemCapability.ArkUI.ArkUI.Full 21152 * @since 9 21153 */ 21154 /** 21155 * Linear Gradient Colors 21156 * 21157 * @type { Array<any> } 21158 * @syscap SystemCapability.ArkUI.ArkUI.Full 21159 * @crossplatform 21160 * @since 10 21161 */ 21162 /** 21163 * Linear Gradient Colors 21164 * 21165 * @type { Array<any> } 21166 * @syscap SystemCapability.ArkUI.ArkUI.Full 21167 * @crossplatform 21168 * @atomicservice 21169 * @since 11 21170 */ 21171 /** 21172 * Linear Gradient Colors 21173 * 21174 * @type { Array<[ResourceColor, number]> } 21175 * @syscap SystemCapability.ArkUI.ArkUI.Full 21176 * @crossplatform 21177 * @atomicservice 21178 * @since 12 21179 */ 21180 colors: Array<[ResourceColor, number]>; 21181 /** 21182 * Linear Gradient Repeating 21183 * 21184 * @type { ?boolean } 21185 * @syscap SystemCapability.ArkUI.ArkUI.Full 21186 * @since 9 21187 */ 21188 /** 21189 * Linear Gradient Repeating 21190 * 21191 * @type { ?boolean } 21192 * @syscap SystemCapability.ArkUI.ArkUI.Full 21193 * @crossplatform 21194 * @since 10 21195 */ 21196 /** 21197 * Linear Gradient Repeating 21198 * 21199 * @type { ?boolean } 21200 * @syscap SystemCapability.ArkUI.ArkUI.Full 21201 * @crossplatform 21202 * @atomicservice 21203 * @since 11 21204 */ 21205 repeating?: boolean; 21206} 21207 21208/** 21209 * Defines the pixel round property. 21210 * 21211 * @interface PixelRoundPolicy 21212 * @syscap SystemCapability.ArkUI.ArkUI.Full 21213 * @crossplatform 21214 * @form 21215 * @atomicservice 21216 * @since 11 21217 */ 21218declare interface PixelRoundPolicy { 21219 /** 21220 * start property. 21221 * 21222 * @type { ?PixelRoundCalcPolicy } 21223 * @default PixelRoundCalcPolicy.NO_FORCE_ROUND 21224 * @syscap SystemCapability.ArkUI.ArkUI.Full 21225 * @crossplatform 21226 * @form 21227 * @atomicservice 21228 * @since 11 21229 */ 21230 start?: PixelRoundCalcPolicy; 21231 21232 /** 21233 * top property. 21234 * 21235 * @type { ?PixelRoundCalcPolicy } 21236 * @default PixelRoundCalcPolicy.NO_FORCE_ROUND 21237 * @syscap SystemCapability.ArkUI.ArkUI.Full 21238 * @crossplatform 21239 * @form 21240 * @atomicservice 21241 * @since 11 21242 */ 21243 top?: PixelRoundCalcPolicy; 21244 21245 /** 21246 * end property. 21247 * 21248 * @type { ?PixelRoundCalcPolicy } 21249 * @default PixelRoundCalcPolicy.NO_FORCE_ROUND 21250 * @syscap SystemCapability.ArkUI.ArkUI.Full 21251 * @crossplatform 21252 * @form 21253 * @atomicservice 21254 * @since 11 21255 */ 21256 end?: PixelRoundCalcPolicy; 21257 21258 /** 21259 * bottom property. 21260 * 21261 * @type { ?PixelRoundCalcPolicy } 21262 * @default PixelRoundCalcPolicy.NO_FORCE_ROUND 21263 * @syscap SystemCapability.ArkUI.ArkUI.Full 21264 * @crossplatform 21265 * @form 21266 * @atomicservice 21267 * @since 11 21268 */ 21269 bottom?: PixelRoundCalcPolicy; 21270} 21271 21272/** 21273 * Linear Gradient Blur Interface 21274 * 21275 * @interface LinearGradientBlurOptions 21276 * @syscap SystemCapability.ArkUI.ArkUI.Full 21277 * @atomicservice 21278 * @since 12 21279 */ 21280declare interface LinearGradientBlurOptions { 21281 /** 21282 * Percentage of blurring effect. 21283 * 21284 * @type { FractionStop[] } 21285 * @syscap SystemCapability.ArkUI.ArkUI.Full 21286 * @atomicservice 21287 * @since 12 21288 */ 21289 fractionStops: FractionStop[]; 21290 /** 21291 * Direction of linear gradient blur. 21292 * 21293 * @type { GradientDirection } 21294 * @syscap SystemCapability.ArkUI.ArkUI.Full 21295 * @atomicservice 21296 * @since 12 21297 */ 21298 direction: GradientDirection; 21299} 21300 21301/** 21302 * Define motion blur anchor coordinates. 21303 * 21304 * @interface MotionBlurAnchor 21305 * @syscap SystemCapability.ArkUI.ArkUI.Full 21306 * @crossplatform 21307 * @atomicservice 21308 * @since 12 21309 */ 21310declare interface MotionBlurAnchor { 21311 /** 21312 * Define anchor coordinate x-value.Value range [0.0, 1.0]. 21313 * 21314 * @type { number } 21315 * @syscap SystemCapability.ArkUI.ArkUI.Full 21316 * @atomicservice 21317 * @since 12 21318 */ 21319 x: number; 21320 /** 21321 * Define anchor coordinate y-value.Value range [0.0, 1.0]. 21322 * 21323 * @type { number } 21324 * @syscap SystemCapability.ArkUI.ArkUI.Full 21325 * @atomicservice 21326 * @since 12 21327 */ 21328 y: number; 21329} 21330 21331/** 21332 * Define motion blur options. 21333 * 21334 * @interface MotionBlurOptions 21335 * @syscap SystemCapability.ArkUI.ArkUI.Full 21336 * @crossplatform 21337 * @atomicservice 21338 * @since 12 21339 */ 21340declare interface MotionBlurOptions { 21341 /** 21342 * Define the size of motion blur radius.The range of this value is [0.0, ∞). 21343 * 21344 * @type { number } 21345 * @syscap SystemCapability.ArkUI.ArkUI.Full 21346 * @atomicservice 21347 * @since 12 21348 */ 21349 radius: number; 21350 /** 21351 * Define motion blur anchor coordinates. 21352 * 21353 * @type { MotionBlurAnchor } 21354 * @syscap SystemCapability.ArkUI.ArkUI.Full 21355 * @atomicservice 21356 * @since 12 21357 */ 21358 anchor: MotionBlurAnchor; 21359} 21360 21361/** 21362 * Sub component border info. 21363 * 21364 * @interface LayoutBorderInfo 21365 * @syscap SystemCapability.ArkUI.ArkUI.Full 21366 * @form 21367 * @since 9 21368 * @deprecated since 10 21369 */ 21370declare interface LayoutBorderInfo { 21371 /** 21372 * Sub component borderWidth info. 21373 * 21374 * @type { EdgeWidths } 21375 * @syscap SystemCapability.ArkUI.ArkUI.Full 21376 * @form 21377 * @since 9 21378 * @deprecated since 10 21379 */ 21380 borderWidth: EdgeWidths; 21381 21382 /** 21383 * Sub component margin info. 21384 * 21385 * @type { Margin } 21386 * @syscap SystemCapability.ArkUI.ArkUI.Full 21387 * @form 21388 * @since 9 21389 * @deprecated since 10 21390 */ 21391 margin: Margin, 21392 21393 /** 21394 * Sub component padding info. 21395 * 21396 * @type { Padding } 21397 * @syscap SystemCapability.ArkUI.ArkUI.Full 21398 * @form 21399 * @since 9 21400 * @deprecated since 10 21401 */ 21402 padding: Padding, 21403} 21404 21405/** 21406 * Sub component layout info. 21407 * 21408 * @interface LayoutInfo 21409 * @syscap SystemCapability.ArkUI.ArkUI.Full 21410 * @form 21411 * @since 9 21412 * @deprecated since 10 21413 */ 21414declare interface LayoutInfo { 21415 /** 21416 * Sub component position info. 21417 * 21418 * @type { Position } 21419 * @syscap SystemCapability.ArkUI.ArkUI.Full 21420 * @form 21421 * @since 9 21422 * @deprecated since 10 21423 */ 21424 position: Position, 21425 21426 /** 21427 * Sub component constraint info. 21428 * 21429 * @type { ConstraintSizeOptions } 21430 * @syscap SystemCapability.ArkUI.ArkUI.Full 21431 * @form 21432 * @since 9 21433 * @deprecated since 10 21434 */ 21435 constraint: ConstraintSizeOptions, 21436} 21437 21438/** 21439 * Sub component info passed from framework when layout and measure happens. 21440 * 21441 * @interface LayoutChild 21442 * @syscap SystemCapability.ArkUI.ArkUI.Full 21443 * @form 21444 * @since 9 21445 * @deprecated since 10 21446 */ 21447declare interface LayoutChild { 21448 /** 21449 * Sub component name. 21450 * 21451 * @type { string } 21452 * @syscap SystemCapability.ArkUI.ArkUI.Full 21453 * @form 21454 * @since 9 21455 * @deprecated since 10 21456 */ 21457 name: string, 21458 21459 /** 21460 * Sub component id. 21461 * 21462 * @type { string } 21463 * @syscap SystemCapability.ArkUI.ArkUI.Full 21464 * @form 21465 * @since 9 21466 * @deprecated since 10 21467 */ 21468 id: string, 21469 21470 /** 21471 * Sub component constraint. 21472 * 21473 * @type { ConstraintSizeOptions } 21474 * @syscap SystemCapability.ArkUI.ArkUI.Full 21475 * @form 21476 * @since 9 21477 * @deprecated since 10 21478 */ 21479 constraint: ConstraintSizeOptions, 21480 21481 /** 21482 * Sub component border info. 21483 * 21484 * @type { LayoutBorderInfo } 21485 * @syscap SystemCapability.ArkUI.ArkUI.Full 21486 * @form 21487 * @since 9 21488 * @deprecated since 10 21489 */ 21490 borderInfo: LayoutBorderInfo, 21491 21492 /** 21493 * Sub component position. 21494 * 21495 * @type { Position } 21496 * @syscap SystemCapability.ArkUI.ArkUI.Full 21497 * @form 21498 * @since 9 21499 * @deprecated since 10 21500 */ 21501 position: Position, 21502 21503 /** 21504 * Call this measure method in onMeasure callback to supply sub component size. 21505 * 21506 * @param { ConstraintSizeOptions } childConstraint 21507 * @syscap SystemCapability.ArkUI.ArkUI.Full 21508 * @form 21509 * @since 9 21510 * @deprecated since 10 21511 */ 21512 measure(childConstraint: ConstraintSizeOptions), 21513 21514 /** 21515 * Call this layout method in onLayout callback to assign layout info to sub component. 21516 * 21517 * @param { LayoutInfo } childLayoutInfo 21518 * @syscap SystemCapability.ArkUI.ArkUI.Full 21519 * @form 21520 * @since 9 21521 * @deprecated since 10 21522 */ 21523 layout(childLayoutInfo: LayoutInfo), 21524} 21525 21526/** 21527 * Sub component layout info. 21528 * 21529 * @interface GeometryInfo 21530 * @syscap SystemCapability.ArkUI.ArkUI.Full 21531 * @crossplatform 21532 * @since 10 21533 */ 21534/** 21535 * Sub component layout info. 21536 * 21537 * @interface GeometryInfo 21538 * @syscap SystemCapability.ArkUI.ArkUI.Full 21539 * @crossplatform 21540 * @atomicservice 21541 * @since 11 21542 */ 21543declare interface GeometryInfo extends SizeResult { 21544 /** 21545 * Sub component borderWidth info. 21546 * 21547 * @type { EdgeWidth } 21548 * @syscap SystemCapability.ArkUI.ArkUI.Full 21549 * @crossplatform 21550 * @since 10 21551 */ 21552 /** 21553 * Sub component borderWidth info. 21554 * 21555 * @type { EdgeWidth } 21556 * @syscap SystemCapability.ArkUI.ArkUI.Full 21557 * @crossplatform 21558 * @atomicservice 21559 * @since 11 21560 */ 21561 borderWidth: EdgeWidth; 21562 21563 /** 21564 * Sub component margin info. 21565 * 21566 * @type { Margin } 21567 * @syscap SystemCapability.ArkUI.ArkUI.Full 21568 * @crossplatform 21569 * @since 10 21570 */ 21571 /** 21572 * Sub component margin info. 21573 * 21574 * @type { Margin } 21575 * @syscap SystemCapability.ArkUI.ArkUI.Full 21576 * @crossplatform 21577 * @atomicservice 21578 * @since 11 21579 */ 21580 margin: Margin, 21581 21582 /** 21583 * Sub component padding info. 21584 * 21585 * @type { Padding } 21586 * @syscap SystemCapability.ArkUI.ArkUI.Full 21587 * @crossplatform 21588 * @since 10 21589 */ 21590 /** 21591 * Sub component padding info. 21592 * 21593 * @type { Padding } 21594 * @syscap SystemCapability.ArkUI.ArkUI.Full 21595 * @crossplatform 21596 * @atomicservice 21597 * @since 11 21598 */ 21599 padding: Padding, 21600} 21601 21602/** 21603 * Sub component info passed from framework when layout happens. 21604 * 21605 * @interface Layoutable 21606 * @syscap SystemCapability.ArkUI.ArkUI.Full 21607 * @crossplatform 21608 * @since 10 21609 */ 21610/** 21611 * Sub component info passed from framework when layout happens. 21612 * 21613 * @interface Layoutable 21614 * @syscap SystemCapability.ArkUI.ArkUI.Full 21615 * @crossplatform 21616 * @atomicservice 21617 * @since 11 21618 */ 21619declare interface Layoutable { 21620 /** 21621 * Measurement result of the child component. 21622 * 21623 * @type { MeasureResult } 21624 * @syscap SystemCapability.ArkUI.ArkUI.Full 21625 * @crossplatform 21626 * @since 10 21627 */ 21628 /** 21629 * Measurement result of the child component. 21630 * 21631 * @type { MeasureResult } 21632 * @syscap SystemCapability.ArkUI.ArkUI.Full 21633 * @crossplatform 21634 * @atomicservice 21635 * @since 11 21636 */ 21637 measureResult: MeasureResult, 21638 21639 /** 21640 * Call this layout method in onLayout callback to assign layout info to sub component. 21641 * 21642 * @param { Position } position 21643 * @syscap SystemCapability.ArkUI.ArkUI.Full 21644 * @crossplatform 21645 * @since 10 21646 */ 21647 /** 21648 * Call this layout method in onLayout callback to assign layout info to sub component. 21649 * 21650 * @param { Position } position 21651 * @syscap SystemCapability.ArkUI.ArkUI.Full 21652 * @crossplatform 21653 * @atomicservice 21654 * @since 11 21655 */ 21656 layout(position: Position): void, 21657 21658 /** 21659 * Call this method to get the margin of sub component. 21660 * 21661 * @returns { DirectionalEdgesT<number> } the margin of sub component, unit is vp 21662 * @syscap SystemCapability.ArkUI.ArkUI.Full 21663 * @crossplatform 21664 * @atomicservice 21665 * @since 12 21666 */ 21667 getMargin() : DirectionalEdgesT<number>, 21668 21669 /** 21670 * Call this method to get the padding of sub component. 21671 * 21672 * @returns { DirectionalEdgesT<number> } the padding of sub component, unit is vp 21673 * @syscap SystemCapability.ArkUI.ArkUI.Full 21674 * @crossplatform 21675 * @atomicservice 21676 * @since 12 21677 */ 21678 getPadding() : DirectionalEdgesT<number>, 21679 21680 /** 21681 * Call this method to get the borderWidth of sub component. 21682 * 21683 * @returns { DirectionalEdgesT<number> } the borderWidth of sub component, unit is vp 21684 * @syscap SystemCapability.ArkUI.ArkUI.Full 21685 * @crossplatform 21686 * @atomicservice 21687 * @since 12 21688 */ 21689 getBorderWidth() : DirectionalEdgesT<number>, 21690} 21691 21692/** 21693 * Sub component info passed from framework when measure happens. 21694 * 21695 * @interface Measurable 21696 * @syscap SystemCapability.ArkUI.ArkUI.Full 21697 * @crossplatform 21698 * @since 10 21699 */ 21700/** 21701 * Sub component info passed from framework when measure happens. 21702 * 21703 * @interface Measurable 21704 * @syscap SystemCapability.ArkUI.ArkUI.Full 21705 * @crossplatform 21706 * @atomicservice 21707 * @since 11 21708 */ 21709declare interface Measurable { 21710 /** 21711 * Call this measure method in onMeasure callback to supply sub component size. 21712 * 21713 * @param { ConstraintSizeOptions } constraint 21714 * @returns { MeasureResult } 21715 * @syscap SystemCapability.ArkUI.ArkUI.Full 21716 * @crossplatform 21717 * @since 10 21718 */ 21719 /** 21720 * Call this measure method in onMeasure callback to supply sub component size. 21721 * 21722 * @param { ConstraintSizeOptions } constraint 21723 * @returns { MeasureResult } 21724 * @syscap SystemCapability.ArkUI.ArkUI.Full 21725 * @crossplatform 21726 * @atomicservice 21727 * @since 11 21728 */ 21729 measure(constraint: ConstraintSizeOptions) : MeasureResult, 21730 21731 /** 21732 * Call this method to get the margin of sub component. 21733 * 21734 * @returns { DirectionalEdgesT<number> } the margin of sub component, unit is vp 21735 * @syscap SystemCapability.ArkUI.ArkUI.Full 21736 * @crossplatform 21737 * @atomicservice 21738 * @since 12 21739 */ 21740 getMargin() : DirectionalEdgesT<number>, 21741 21742 /** 21743 * Call this method to get the padding of sub component. 21744 * 21745 * @returns { DirectionalEdgesT<number> } the padding of sub component, unit is vp 21746 * @syscap SystemCapability.ArkUI.ArkUI.Full 21747 * @crossplatform 21748 * @atomicservice 21749 * @since 12 21750 */ 21751 getPadding() : DirectionalEdgesT<number>, 21752 21753 /** 21754 * Call this method to get the borderWidth of sub component. 21755 * 21756 * @returns { DirectionalEdgesT<number> } the borderWidth of sub component, unit is vp 21757 * @syscap SystemCapability.ArkUI.ArkUI.Full 21758 * @crossplatform 21759 * @atomicservice 21760 * @since 12 21761 */ 21762 getBorderWidth() : DirectionalEdgesT<number>, 21763} 21764 21765/** 21766 * Sub component SizeResult info. 21767 * 21768 * @interface SizeResult 21769 * @syscap SystemCapability.ArkUI.ArkUI.Full 21770 * @crossplatform 21771 * @since 10 21772 */ 21773/** 21774 * Sub component SizeResult info. 21775 * 21776 * @interface SizeResult 21777 * @syscap SystemCapability.ArkUI.ArkUI.Full 21778 * @crossplatform 21779 * @atomicservice 21780 * @since 11 21781 */ 21782declare interface SizeResult { 21783 /** 21784 * Width obtained from the measurement result. 21785 * 21786 * @type { number } 21787 * @syscap SystemCapability.ArkUI.ArkUI.Full 21788 * @crossplatform 21789 * @since 10 21790 */ 21791 /** 21792 * Width obtained from the measurement result. 21793 * 21794 * @type { number } 21795 * @syscap SystemCapability.ArkUI.ArkUI.Full 21796 * @crossplatform 21797 * @atomicservice 21798 * @since 11 21799 */ 21800 width: number, 21801 21802 /** 21803 * Height obtained from the measurement result. 21804 * 21805 * @type { number } 21806 * @syscap SystemCapability.ArkUI.ArkUI.Full 21807 * @crossplatform 21808 * @since 10 21809 */ 21810 /** 21811 * Height obtained from the measurement result. 21812 * 21813 * @type { number } 21814 * @syscap SystemCapability.ArkUI.ArkUI.Full 21815 * @crossplatform 21816 * @atomicservice 21817 * @since 11 21818 */ 21819 height: number, 21820} 21821 21822/** 21823 * Sub component MeasureResult info. 21824 * 21825 * @interface MeasureResult 21826 * @syscap SystemCapability.ArkUI.ArkUI.Full 21827 * @crossplatform 21828 * @since 10 21829 */ 21830/** 21831 * Sub component MeasureResult info. 21832 * 21833 * @interface MeasureResult 21834 * @syscap SystemCapability.ArkUI.ArkUI.Full 21835 * @crossplatform 21836 * @atomicservice 21837 * @since 11 21838 */ 21839declare interface MeasureResult extends SizeResult { 21840 21841} 21842 21843/** 21844 * The navigation destination information. 21845 * 21846 * @syscap SystemCapability.ArkUI.ArkUI.Full 21847 * @crossplatform 21848 * @since 11 21849 */ 21850/** 21851 * The navigation destination information. 21852 * 21853 * @typedef {import('../api/@ohos.arkui.observer').default.NavDestinationInfo} NavDestinationInfo 21854 * @syscap SystemCapability.ArkUI.ArkUI.Full 21855 * @crossplatform 21856 * @atomicservice 21857 * @since 12 21858 */ 21859declare type NavDestinationInfo = import('../api/@ohos.arkui.observer').default.NavDestinationInfo; 21860 21861/** 21862 * The navigation information. 21863 * 21864 * @typedef {import('../api/@ohos.arkui.observer').default.NavigationInfo} NavigationInfo 21865 * @syscap SystemCapability.ArkUI.ArkUI.Full 21866 * @crossplatform 21867 * @atomicservice 21868 * @since 12 21869 */ 21870declare type NavigationInfo = import('../api/@ohos.arkui.observer').default.NavigationInfo; 21871 21872/** 21873 * The router page information. 21874 * 21875 * @typedef {import('../api/@ohos.arkui.observer').default.RouterPageInfo} RouterPageInfo 21876 * @syscap SystemCapability.ArkUI.ArkUI.Full 21877 * @crossplatform 21878 * @atomicservice 21879 * @since 12 21880 */ 21881 declare type RouterPageInfo = import('../api/@ohos.arkui.observer').default.RouterPageInfo; 21882 21883/** 21884 * UIContext 21885 * 21886 * @syscap SystemCapability.ArkUI.ArkUI.Full 21887 * @crossplatform 21888 * @since 11 21889 */ 21890/** 21891 * UIContext 21892 * 21893 * @typedef { import('../api/@ohos.arkui.UIContext').UIContext } UIContext 21894 * @syscap SystemCapability.ArkUI.ArkUI.Full 21895 * @crossplatform 21896 * @atomicservice 21897 * @since 12 21898 */ 21899declare type UIContext = import('../api/@ohos.arkui.UIContext').UIContext; 21900 21901/** 21902 * DrawContext 21903 * 21904 * @typedef { import('../api/arkui/Graphics').DrawContext } DrawContext 21905 * @syscap SystemCapability.ArkUI.ArkUI.Full 21906 * @crossplatform 21907 * @atomicservice 21908 * @since 12 21909 */ 21910declare type DrawContext = import('../api/arkui/Graphics').DrawContext; 21911 21912/** 21913 * VisualEffect 21914 * 21915 * @typedef { import('../api/@ohos.graphics.uiEffect').default.VisualEffect } VisualEffect 21916 * @syscap SystemCapability.ArkUI.ArkUI.Full 21917 * @crossplatform 21918 * @atomicservice 21919 * @since 12 21920 */ 21921declare type VisualEffect = import('../api/@ohos.graphics.uiEffect').default.VisualEffect; 21922 21923 21924/** 21925 * Filter 21926 * 21927 * @typedef { import('../api/@ohos.graphics.uiEffect').default.Filter } Filter 21928 * @syscap SystemCapability.ArkUI.ArkUI.Full 21929 * @crossplatform 21930 * @atomicservice 21931 * @since 12 21932 */ 21933declare type Filter = import('../api/@ohos.graphics.uiEffect').default.Filter; 21934 21935/** 21936 * Blender 21937 * 21938 * @typedef { import('../api/@ohos.graphics.uiEffect').default.Blender } Blender 21939 * @syscap SystemCapability.ArkUI.ArkUI.Full 21940 * @systemapi 21941 * @form 21942 * @since 13 21943 */ 21944declare type Blender = import('../api/@ohos.graphics.uiEffect').default.Blender; 21945 21946/** 21947 * ComponentContent. 21948 * 21949 * @typedef {import('../api/arkui/ComponentContent').ComponentContent<T>} ComponentContent<T = Object> 21950 * @syscap SystemCapability.ArkUI.ArkUI.Full 21951 * @crossplatform 21952 * @atomicservice 21953 * @since 12 21954 */ 21955declare type ComponentContent<T = Object> = import('../api/arkui/ComponentContent').ComponentContent<T>; 21956 21957/** 21958 * Theme. 21959 * 21960 * @typedef {import('../api/@ohos.arkui.theme').Theme} Theme 21961 * @syscap SystemCapability.ArkUI.ArkUI.Full 21962 * @crossplatform 21963 * @atomicservice 21964 * @since 12 21965 */ 21966declare type Theme = import('../api/@ohos.arkui.theme').Theme; 21967 21968/** 21969 * Custom Component 21970 * 21971 * @extends CommonAttribute 21972 * @syscap SystemCapability.ArkUI.ArkUI.Full 21973 * @since 7 21974 */ 21975/** 21976 * Custom Component 21977 * 21978 * @extends CommonAttribute 21979 * @syscap SystemCapability.ArkUI.ArkUI.Full 21980 * @form 21981 * @since 9 21982 */ 21983/** 21984 * Custom Component 21985 * 21986 * @extends CommonAttribute 21987 * @syscap SystemCapability.ArkUI.ArkUI.Full 21988 * @crossplatform 21989 * @form 21990 * @since 10 21991 */ 21992/** 21993 * Custom Component 21994 * 21995 * @extends CommonAttribute 21996 * @syscap SystemCapability.ArkUI.ArkUI.Full 21997 * @crossplatform 21998 * @form 21999 * @atomicservice 22000 * @since 11 22001 */ 22002declare class CustomComponent extends CommonAttribute { 22003 /** 22004 * Customize the pop-up content constructor. 22005 * 22006 * @syscap SystemCapability.ArkUI.ArkUI.Full 22007 * @since 7 22008 */ 22009 /** 22010 * Customize the pop-up content constructor. 22011 * 22012 * @syscap SystemCapability.ArkUI.ArkUI.Full 22013 * @form 22014 * @since 9 22015 */ 22016 /** 22017 * Customize the pop-up content constructor. 22018 * 22019 * @syscap SystemCapability.ArkUI.ArkUI.Full 22020 * @crossplatform 22021 * @form 22022 * @since 10 22023 */ 22024 /** 22025 * Customize the pop-up content constructor. 22026 * 22027 * @syscap SystemCapability.ArkUI.ArkUI.Full 22028 * @crossplatform 22029 * @form 22030 * @atomicservice 22031 * @since 11 22032 */ 22033 build(): void; 22034 22035 /** 22036 * aboutToAppear Method 22037 * 22038 * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. 22039 * 22040 * @syscap SystemCapability.ArkUI.ArkUI.Full 22041 * @since 7 22042 */ 22043 /** 22044 * aboutToAppear Method 22045 * 22046 * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. 22047 * 22048 * @syscap SystemCapability.ArkUI.ArkUI.Full 22049 * @form 22050 * @since 9 22051 */ 22052 /** 22053 * aboutToAppear Method 22054 * 22055 * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. 22056 * 22057 * @syscap SystemCapability.ArkUI.ArkUI.Full 22058 * @crossplatform 22059 * @form 22060 * @since 10 22061 */ 22062 /** 22063 * aboutToAppear Method 22064 * 22065 * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. 22066 * 22067 * @syscap SystemCapability.ArkUI.ArkUI.Full 22068 * @crossplatform 22069 * @form 22070 * @atomicservice 22071 * @since 11 22072 */ 22073 aboutToAppear?(): void; 22074 22075 /** 22076 * aboutToDisappear Method 22077 * 22078 * The aboutToDisappear function executes before a custom component is destroyed. 22079 * 22080 * @syscap SystemCapability.ArkUI.ArkUI.Full 22081 * @since 7 22082 */ 22083 /** 22084 * aboutToDisappear Method 22085 * 22086 * The aboutToDisappear function executes before a custom component is destroyed. 22087 * 22088 * @syscap SystemCapability.ArkUI.ArkUI.Full 22089 * @form 22090 * @since 9 22091 */ 22092 /** 22093 * aboutToDisappear Method 22094 * 22095 * The aboutToDisappear function executes before a custom component is destroyed. 22096 * 22097 * @syscap SystemCapability.ArkUI.ArkUI.Full 22098 * @crossplatform 22099 * @form 22100 * @since 10 22101 */ 22102 /** 22103 * aboutToDisappear Method 22104 * 22105 * The aboutToDisappear function executes before a custom component is destroyed. 22106 * 22107 * @syscap SystemCapability.ArkUI.ArkUI.Full 22108 * @crossplatform 22109 * @form 22110 * @atomicservice 22111 * @since 11 22112 */ 22113 aboutToDisappear?(): void; 22114 22115 /** 22116 * aboutToReuse Method 22117 * 22118 * @param { object } params - Custom component init params. 22119 * @syscap SystemCapability.ArkUI.ArkUI.Full 22120 * @crossplatform 22121 * @since 10 22122 */ 22123 /** 22124 * aboutToReuse Method 22125 * 22126 * @param { object } params - Custom component init params. 22127 * @syscap SystemCapability.ArkUI.ArkUI.Full 22128 * @crossplatform 22129 * @atomicservice 22130 * @since 11 22131 */ 22132 aboutToReuse?(params: { [key: string]: unknown }): void; 22133 22134 /** 22135 * aboutToRecycle Method 22136 * 22137 * @syscap SystemCapability.ArkUI.ArkUI.Full 22138 * @crossplatform 22139 * @since 10 22140 */ 22141 /** 22142 * aboutToRecycle Method 22143 * 22144 * @syscap SystemCapability.ArkUI.ArkUI.Full 22145 * @crossplatform 22146 * @atomicservice 22147 * @since 11 22148 */ 22149 aboutToRecycle?(): void; 22150 22151 /** 22152 * The onWillApplyTheme function is a custom hook to get active theme object from the context 22153 * 22154 * @param { Theme } theme - Custom theme init params. 22155 * @syscap SystemCapability.ArkUI.ArkUI.Full 22156 * @crossplatform 22157 * @atomicservice 22158 * @since 12 22159 */ 22160 onWillApplyTheme?(theme: Theme): void; 22161 22162 /** 22163 * Custom component override this method to layout each of its sub components. 22164 * 22165 * @param { Array<LayoutChild> } children 22166 * @param { ConstraintSizeOptions } constraint 22167 * @syscap SystemCapability.ArkUI.ArkUI.Full 22168 * @form 22169 * @since 9 22170 * @deprecated since 10 22171 * @useinstead CustomComponent#onPlaceChildren 22172 */ 22173 onLayout?(children: Array<LayoutChild>, constraint: ConstraintSizeOptions): void; 22174 22175 /** 22176 * Custom component override this method to layout each of its sub components. 22177 * 22178 * @param { GeometryInfo } selfLayoutInfo 22179 * @param { Array<Layoutable> } children 22180 * @param { ConstraintSizeOptions } constraint 22181 * @syscap SystemCapability.ArkUI.ArkUI.Full 22182 * @crossplatform 22183 * @since 10 22184 */ 22185 /** 22186 * Custom component override this method to layout each of its sub components. 22187 * 22188 * @param { GeometryInfo } selfLayoutInfo 22189 * @param { Array<Layoutable> } children 22190 * @param { ConstraintSizeOptions } constraint 22191 * @syscap SystemCapability.ArkUI.ArkUI.Full 22192 * @crossplatform 22193 * @atomicservice 22194 * @since 11 22195 */ 22196 onPlaceChildren?(selfLayoutInfo: GeometryInfo, children: Array<Layoutable>, constraint: ConstraintSizeOptions): void; 22197 22198 /** 22199 * Custom component override this method to measure each of its sub components. 22200 * 22201 * @param { Array<LayoutChild> } children 22202 * @param { ConstraintSizeOptions } constraint 22203 * @syscap SystemCapability.ArkUI.ArkUI.Full 22204 * @form 22205 * @since 9 22206 * @deprecated since 10 22207 * @useinstead CustomComponent#onMeasureSize 22208 */ 22209 onMeasure?(children: Array<LayoutChild>, constraint: ConstraintSizeOptions): void; 22210 22211 /** 22212 * Custom component override this method to measure each of its sub components. 22213 * @param { GeometryInfo } selfLayoutInfo 22214 * @param { Array<Measurable> } children - indicate the measure child 22215 * @param { ConstraintSizeOptions } constraint - indicate child constraint size 22216 * @returns { SizeResult } 22217 * @syscap SystemCapability.ArkUI.ArkUI.Full 22218 * @crossplatform 22219 * @since 10 22220 */ 22221 /** 22222 * Custom component override this method to measure each of its sub components. 22223 * @param { GeometryInfo } selfLayoutInfo 22224 * @param { Array<Measurable> } children - indicate the measure child 22225 * @param { ConstraintSizeOptions } constraint - indicate child constraint size 22226 * @returns { SizeResult } 22227 * @syscap SystemCapability.ArkUI.ArkUI.Full 22228 * @crossplatform 22229 * @atomicservice 22230 * @since 11 22231 */ 22232 onMeasureSize?(selfLayoutInfo: GeometryInfo, children: Array<Measurable>, constraint: ConstraintSizeOptions): SizeResult; 22233 22234 /** 22235 * onPageShow Method 22236 * 22237 * The page is triggered once each time it is displayed, including scenarios such as the routing process and the application entering the foreground 22238 * 22239 * @syscap SystemCapability.ArkUI.ArkUI.Full 22240 * @since 7 22241 */ 22242 /** 22243 * onPageShow Method 22244 * 22245 * The page is triggered once each time it is displayed, including scenarios such as the routing process and the application entering the foreground 22246 * 22247 * @syscap SystemCapability.ArkUI.ArkUI.Full 22248 * @crossplatform 22249 * @since 10 22250 */ 22251 /** 22252 * onPageShow Method 22253 * 22254 * The page is triggered once each time it is displayed, including scenarios such as the routing process and the application entering the foreground 22255 * 22256 * @syscap SystemCapability.ArkUI.ArkUI.Full 22257 * @crossplatform 22258 * @atomicservice 22259 * @since 11 22260 */ 22261 onPageShow?(): void; 22262 22263 /** 22264 * onPageHide Method 22265 * 22266 * It is triggered once each time the page is hidden, including scenarios such as the routing process and the application entering the background 22267 * 22268 * @syscap SystemCapability.ArkUI.ArkUI.Full 22269 * @since 7 22270 */ 22271 /** 22272 * onPageHide Method 22273 * 22274 * It is triggered once each time the page is hidden, including scenarios such as the routing process and the application entering the background 22275 * 22276 * @syscap SystemCapability.ArkUI.ArkUI.Full 22277 * @crossplatform 22278 * @since 10 22279 */ 22280 /** 22281 * onPageHide Method 22282 * 22283 * It is triggered once each time the page is hidden, including scenarios such as the routing process and the application entering the background 22284 * 22285 * @syscap SystemCapability.ArkUI.ArkUI.Full 22286 * @crossplatform 22287 * @atomicservice 22288 * @since 11 22289 */ 22290 onPageHide?(): void; 22291 22292 /** 22293 * onFormRecycle Method, this is only for ArkTS form, if form was marked recyclable by form user, when system memory is low, 22294 * it will be recycled after calling this method, you should return a string of params that you wish to be saved, it will be 22295 * passed back as params in onFormRecover, in which you can recover the form 22296 * 22297 * @returns { string } status data of ArkTS form UI, this data will be passed in when recover form later 22298 * @syscap SystemCapability.ArkUI.ArkUI.Full 22299 * @crossplatform 22300 * @form 22301 * @since 11 22302 */ 22303 /** 22304 * onFormRecycle Method, this is only for ArkTS form, if form was marked recyclable by form user, when system memory is low, 22305 * it will be recycled after calling this method, you should return a string of params that you wish to be saved, it will be 22306 * passed back as params in onFormRecover, in which you can recover the form 22307 * 22308 * @returns { string } status data of ArkTS form UI, this data will be passed in when recover form later 22309 * @syscap SystemCapability.ArkUI.ArkUI.Full 22310 * @crossplatform 22311 * @form 22312 * @atomicservice 22313 * @since 12 22314 */ 22315 onFormRecycle?(): string; 22316 22317 /** 22318 * onFormRecover Method, this is only for ArkTS form 22319 * 22320 * @param { string } statusData - indicate status data of ArkTS form UI, which is acquired by calling onFormRecycle, it is used to recover form 22321 * @syscap SystemCapability.ArkUI.ArkUI.Full 22322 * @crossplatform 22323 * @form 22324 * @since 11 22325 */ 22326 /** 22327 * onFormRecover Method, this is only for ArkTS form 22328 * 22329 * @param { string } statusData - indicate status data of ArkTS form UI, which is acquired by calling onFormRecycle, it is used to recover form 22330 * @syscap SystemCapability.ArkUI.ArkUI.Full 22331 * @crossplatform 22332 * @form 22333 * @atomicservice 22334 * @since 12 22335 */ 22336 onFormRecover?(statusData: string): void; 22337 22338 /** 22339 * onBackPress Method 22340 * 22341 * Triggered when the user clicks the back button 22342 * 22343 * @returns { void | boolean } 22344 * @syscap SystemCapability.ArkUI.ArkUI.Full 22345 * @since 7 22346 */ 22347 /** 22348 * onBackPress Method 22349 * 22350 * Triggered when the user clicks the back button 22351 * 22352 * @returns { void | boolean } true means that the page itself processes the return logic. 22353 * false means that the default return logic is used. 22354 * If no value is returned, the default return logic is used. 22355 * @syscap SystemCapability.ArkUI.ArkUI.Full 22356 * @crossplatform 22357 * @since 10 22358 */ 22359 /** 22360 * onBackPress Method 22361 * 22362 * Triggered when the user clicks the back button 22363 * 22364 * @returns { void | boolean } true means that the page itself processes the return logic. 22365 * false means that the default return logic is used. 22366 * If no value is returned, the default return logic is used. 22367 * @syscap SystemCapability.ArkUI.ArkUI.Full 22368 * @crossplatform 22369 * @atomicservice 22370 * @since 11 22371 */ 22372 onBackPress?(): void | boolean; 22373 22374 /** 22375 * PageTransition Method. 22376 * Implement Animation when enter this page or move to other pages. 22377 * 22378 * @syscap SystemCapability.ArkUI.ArkUI.Full 22379 * @since 9 22380 */ 22381 /** 22382 * PageTransition Method. 22383 * Implement Animation when enter this page or move to other pages. 22384 * 22385 * @syscap SystemCapability.ArkUI.ArkUI.Full 22386 * @crossplatform 22387 * @since 10 22388 */ 22389 /** 22390 * PageTransition Method. 22391 * Implement Animation when enter this page or move to other pages. 22392 * 22393 * @syscap SystemCapability.ArkUI.ArkUI.Full 22394 * @crossplatform 22395 * @atomicservice 22396 * @since 11 22397 */ 22398 pageTransition?(): void; 22399 22400 /** 22401 * Get current UIContext 22402 * 22403 * @returns { UIContext } The UIContext that the custom component belongs to. 22404 * @syscap SystemCapability.ArkUI.ArkUI.Full 22405 * @crossplatform 22406 * @since 11 22407 */ 22408 /** 22409 * Get current UIContext 22410 * 22411 * @returns { UIContext } The UIContext that the custom component belongs to. 22412 * @syscap SystemCapability.ArkUI.ArkUI.Full 22413 * @crossplatform 22414 * @atomicservice 22415 * @since 12 22416 */ 22417 getUIContext(): UIContext; 22418 22419 /** 22420 * Get uniqueId of the custom component. 22421 * 22422 * @returns { number } - The uniqueId of the custom component. 22423 * @syscap SystemCapability.ArkUI.ArkUI.Full 22424 * @crossplatform 22425 * @atomicservice 22426 * @since 12 22427 */ 22428 getUniqueId(): number; 22429 22430 /** 22431 * Queries the navigation destination information. 22432 * 22433 * @returns { NavDestinationInfo | undefined } The navigation destination information, or undefined if it is not available. 22434 * @syscap SystemCapability.ArkUI.ArkUI.Full 22435 * @crossplatform 22436 * @since 11 22437 */ 22438 /** 22439 * Queries the navigation destination information. 22440 * 22441 * @returns { NavDestinationInfo | undefined } The navigation destination information, or undefined if it is not available. 22442 * @syscap SystemCapability.ArkUI.ArkUI.Full 22443 * @crossplatform 22444 * @atomicservice 22445 * @since 12 22446 */ 22447 queryNavDestinationInfo(): NavDestinationInfo | undefined; 22448 22449 /** 22450 * Query the navigation information of the current custom component. 22451 * 22452 * @returns { NavigationInfo | undefined } The navigation information, or undefined if it is not available 22453 * @syscap SystemCapability.ArkUI.ArkUI.Full 22454 * @crossplatform 22455 * @atomicservice 22456 * @since 12 22457 */ 22458 queryNavigationInfo(): NavigationInfo | undefined; 22459 22460 /** 22461 * Query the router page information of the current custom component. 22462 * 22463 * @returns { RouterPageInfo | undefined } The router page information, or undefined if it is not available. 22464 * @syscap SystemCapability.ArkUI.ArkUI.Full 22465 * @crossplatform 22466 * @atomicservice 22467 * @since 12 22468 */ 22469 queryRouterPageInfo(): RouterPageInfo | undefined; 22470 22471 /** 22472 * The callback method after the custom component is built. 22473 * 22474 * Triggered when the custom component has been built. 22475 * 22476 * @syscap SystemCapability.ArkUI.ArkUI.Full 22477 * @crossplatform 22478 * @atomicservice 22479 * @since 12 22480 */ 22481 onDidBuild?(): void; 22482} 22483 22484/** 22485 * View 22486 * 22487 * @syscap SystemCapability.ArkUI.ArkUI.Full 22488 * @systemapi 22489 * @since 7 22490 */ 22491/** 22492 * View 22493 * 22494 * @syscap SystemCapability.ArkUI.ArkUI.Full 22495 * @systemapi 22496 * @form 22497 * @since 9 22498 */ 22499declare class View { 22500 /** 22501 * Just use for generate tsbundle 22502 * 22503 * @param { any } value 22504 * @returns { any } 22505 * @syscap SystemCapability.ArkUI.ArkUI.Full 22506 * @systemapi 22507 * @since 7 22508 */ 22509 /** 22510 * Just use for generate tsbundle 22511 * 22512 * @param { any } value 22513 * @returns { any } 22514 * @syscap SystemCapability.ArkUI.ArkUI.Full 22515 * @systemapi 22516 * @form 22517 * @since 9 22518 */ 22519 create(value: any): any; 22520} 22521 22522/** 22523 * Rect info. 22524 * 22525 * @interface RectResult 22526 * @syscap SystemCapability.ArkUI.ArkUI.Full 22527 * @crossplatform 22528 * @since 10 22529 */ 22530/** 22531 * Rect info. 22532 * 22533 * @interface RectResult 22534 * @syscap SystemCapability.ArkUI.ArkUI.Full 22535 * @crossplatform 22536 * @atomicservice 22537 * @since 11 22538 */ 22539declare interface RectResult { 22540 /** 22541 * x:Horizontal coordinate relative to the component. 22542 * 22543 * @type { number } 22544 * @syscap SystemCapability.ArkUI.ArkUI.Full 22545 * @since 10 22546 */ 22547 /** 22548 * x:Horizontal coordinate relative to the component. 22549 * 22550 * @type { number } 22551 * @syscap SystemCapability.ArkUI.ArkUI.Full 22552 * @crossplatform 22553 * @atomicservice 22554 * @since 11 22555 */ 22556 x: number; 22557 22558 /** 22559 * y:Vertical axis coordinate relative to the component. 22560 * 22561 * @type { number } 22562 * @syscap SystemCapability.ArkUI.ArkUI.Full 22563 * @since 10 22564 */ 22565 /** 22566 * y:Vertical axis coordinate relative to the component. 22567 * 22568 * @type { number } 22569 * @syscap SystemCapability.ArkUI.ArkUI.Full 22570 * @crossplatform 22571 * @atomicservice 22572 * @since 11 22573 */ 22574 y: number; 22575 22576 /** 22577 * Get the width of the current textRect. 22578 * 22579 * @type { number } 22580 * @syscap SystemCapability.ArkUI.ArkUI.Full 22581 * @since 10 22582 */ 22583 /** 22584 * Get the width of the current textRect. 22585 * 22586 * @type { number } 22587 * @syscap SystemCapability.ArkUI.ArkUI.Full 22588 * @crossplatform 22589 * @atomicservice 22590 * @since 11 22591 */ 22592 width: number; 22593 22594 /** 22595 * Get the height of the current textRect. 22596 * 22597 * @type { number } 22598 * @syscap SystemCapability.ArkUI.ArkUI.Full 22599 * @since 10 22600 */ 22601 /** 22602 * Get the height of the current textRect. 22603 * 22604 * @type { number } 22605 * @syscap SystemCapability.ArkUI.ArkUI.Full 22606 * @crossplatform 22607 * @atomicservice 22608 * @since 11 22609 */ 22610 height: number; 22611} 22612 22613/** 22614 * CaretOffset info. 22615 * 22616 * @interface CaretOffset 22617 * @syscap SystemCapability.ArkUI.ArkUI.Full 22618 * @crossplatform 22619 * @since 11 22620 */ 22621/** 22622 * CaretOffset info. 22623 * 22624 * @interface CaretOffset 22625 * @syscap SystemCapability.ArkUI.ArkUI.Full 22626 * @crossplatform 22627 * @atomicservice 22628 * @since 12 22629 */ 22630declare interface CaretOffset { 22631 /** 22632 * Get the index of the CaretOffset 22633 * 22634 * @type { number } 22635 * @syscap SystemCapability.ArkUI.ArkUI.Full 22636 * @since 11 22637 */ 22638 /** 22639 * Get the index of the CaretOffset 22640 * 22641 * @type { number } 22642 * @syscap SystemCapability.ArkUI.ArkUI.Full 22643 * @atomicservice 22644 * @since 12 22645 */ 22646 index: number; 22647 22648 /** 22649 * Get the x of the relative position. 22650 * 22651 * @type { number } 22652 * @syscap SystemCapability.ArkUI.ArkUI.Full 22653 * @since 11 22654 */ 22655 /** 22656 * Get the x of the relative position. 22657 * 22658 * @type { number } 22659 * @syscap SystemCapability.ArkUI.ArkUI.Full 22660 * @atomicservice 22661 * @since 12 22662 */ 22663 x: number; 22664 22665 /** 22666 * Get the y of the relative position. 22667 * 22668 * @type { number } 22669 * @syscap SystemCapability.ArkUI.ArkUI.Full 22670 * @since 11 22671 */ 22672 /** 22673 * Get the y of the relative position. 22674 * 22675 * @type { number } 22676 * @syscap SystemCapability.ArkUI.ArkUI.Full 22677 * @atomicservice 22678 * @since 12 22679 */ 22680 y: number; 22681} 22682 22683/** 22684 * TextContentControllerBase 22685 * 22686 * @syscap SystemCapability.ArkUI.ArkUI.Full 22687 * @crossplatform 22688 * @since 10 22689 */ 22690/** 22691 * TextContentControllerBase 22692 * 22693 * @syscap SystemCapability.ArkUI.ArkUI.Full 22694 * @crossplatform 22695 * @atomicservice 22696 * @since 11 22697 */ 22698declare abstract class TextContentControllerBase { 22699 /** 22700 * Get the index and relative position of the CaretOffset. 22701 * 22702 * @returns { CaretOffset } index and relative position of the CaretOffset. 22703 * @syscap SystemCapability.ArkUI.ArkUI.Full 22704 * @crossplatform 22705 * @since 11 22706 */ 22707 /** 22708 * Get the index and relative position of the CaretOffset. 22709 * 22710 * @returns { CaretOffset } index and relative position of the CaretOffset. 22711 * @syscap SystemCapability.ArkUI.ArkUI.Full 22712 * @crossplatform 22713 * @atomicservice 22714 * @since 12 22715 */ 22716 getCaretOffset() : CaretOffset; 22717 22718 /** 22719 * Get the start and end positions of the text content. 22720 * 22721 * @returns { RectResult } Text content rect. 22722 * @syscap SystemCapability.ArkUI.ArkUI.Full 22723 * @crossplatform 22724 * @since 10 22725 */ 22726 /** 22727 * Get the start and end positions of the text content. 22728 * 22729 * @returns { RectResult } Text content rect. 22730 * @syscap SystemCapability.ArkUI.ArkUI.Full 22731 * @crossplatform 22732 * @atomicservice 22733 * @since 11 22734 */ 22735 getTextContentRect() : RectResult; 22736 22737 /** 22738 * Get the lines number of the text content. 22739 * 22740 * @returns { number } Text content line count 22741 * @syscap SystemCapability.ArkUI.ArkUI.Full 22742 * @crossplatform 22743 * @since 10 22744 */ 22745 /** 22746 * Get the lines number of the text content. 22747 * 22748 * @returns { number } Text content line count 22749 * @syscap SystemCapability.ArkUI.ArkUI.Full 22750 * @crossplatform 22751 * @atomicservice 22752 * @since 11 22753 */ 22754 getTextContentLineCount() : number; 22755} 22756 22757/** 22758 * CommonScrollableMethod 22759 * 22760 * @extends CommonMethod<T> 22761 * @syscap SystemCapability.ArkUI.ArkUI.Full 22762 * @crossplatform 22763 * @atomicservice 22764 * @since 11 22765 */ 22766/** 22767 * CommonScrollableMethod 22768 * 22769 * @extends CommonMethod<T> 22770 * @syscap SystemCapability.ArkUI.ArkUI.Full 22771 * @crossplatform 22772 * @form 22773 * @atomicservice 22774 * @since 12 22775 */ 22776declare class ScrollableCommonMethod<T> extends CommonMethod<T> { 22777 /** 22778 * Scrollbar status. 22779 * 22780 * @param { BarState } barState - Scrollbar status. 22781 * @returns { T } 22782 * @syscap SystemCapability.ArkUI.ArkUI.Full 22783 * @crossplatform 22784 * @atomicservice 22785 * @since 11 22786 */ 22787 scrollBar(barState: BarState): T; 22788 22789 /** 22790 * Color of the scrollbar. 22791 * 22792 * @param { Color | number | string } color - Color of the scrollbar. 22793 * @returns { T } 22794 * @syscap SystemCapability.ArkUI.ArkUI.Full 22795 * @crossplatform 22796 * @atomicservice 22797 * @since 11 22798 */ 22799 scrollBarColor(color: Color | number | string): T; 22800 22801 /** 22802 * Width of the scrollbar. 22803 * 22804 * @param { number | string } value - Width of the scrollbar. 22805 * @returns { T } 22806 * @syscap SystemCapability.ArkUI.ArkUI.Full 22807 * @crossplatform 22808 * @atomicservice 22809 * @since 11 22810 */ 22811 scrollBarWidth(value: number | string): T; 22812 22813 /** 22814 * Edge scrolling effect. 22815 * 22816 * @param { EdgeEffect } edgeEffect - edge scrolling effect. 22817 * @param { EdgeEffectOptions } options - edge scrolling effect options. 22818 * @returns { T } 22819 * @syscap SystemCapability.ArkUI.ArkUI.Full 22820 * @crossplatform 22821 * @atomicservice 22822 * @since 11 22823 */ 22824 edgeEffect(edgeEffect: EdgeEffect, options?: EdgeEffectOptions): T; 22825 22826 /** 22827 * Nested scrolling options. 22828 * 22829 * @param { NestedScrollOptions } value - options for nested scrolling. 22830 * @returns { T } 22831 * @syscap SystemCapability.ArkUI.ArkUI.Full 22832 * @crossplatform 22833 * @atomicservice 22834 * @since 11 22835 */ 22836 nestedScroll(value: NestedScrollOptions): T; 22837 22838 /** 22839 * Whether to support scroll gestures by finger or mouse. 22840 * 22841 * @param { boolean } value - Whether to support scroll gestures by finger or mouse. 22842 * @returns { T } 22843 * @syscap SystemCapability.ArkUI.ArkUI.Full 22844 * @crossplatform 22845 * @atomicservice 22846 * @since 11 22847 */ 22848 enableScrollInteraction(value: boolean): T; 22849 22850 /** 22851 * Friction coefficient. 22852 * 22853 * @param { number | Resource } value - friction coefficient. 22854 * @returns { T } 22855 * @syscap SystemCapability.ArkUI.ArkUI.Full 22856 * @crossplatform 22857 * @atomicservice 22858 * @since 11 22859 */ 22860 friction(value: number | Resource): T; 22861 22862 /** 22863 * Called when the scrollable scrolls. 22864 * 22865 * @param { function } event - callback of scrollable, 22866 * scrollOffset is offset per frame scrolling, ScrollState is current scroll state. 22867 * @returns { T } 22868 * @syscap SystemCapability.ArkUI.ArkUI.Full 22869 * @crossplatform 22870 * @atomicservice 22871 * @since 11 22872 * @deprecated since 12 22873 * @useinstead ScrollableCommonMethod#onDidScroll 22874 */ 22875 onScroll(event: (scrollOffset: number, scrollState: ScrollState) => void): T; 22876 22877 /** 22878 * Called when the scrollable will scroll. 22879 * 22880 * @param { Optional<OnWillScrollCallback> } handler - callback of scrollable. 22881 * @returns { T } 22882 * @syscap SystemCapability.ArkUI.ArkUI.Full 22883 * @crossplatform 22884 * @atomicservice 22885 * @since 12 22886 */ 22887 onWillScroll(handler: Optional<OnWillScrollCallback>): T; 22888 22889 /** 22890 * Called when the scrollable did scroll. 22891 * 22892 * @param { OnScrollCallback } handler - callback of scrollable, 22893 * scrollOffset is offset this frame did scroll, scrollState is current scroll state. 22894 * @returns { T } 22895 * @syscap SystemCapability.ArkUI.ArkUI.Full 22896 * @crossplatform 22897 * @form 22898 * @atomicservice 22899 * @since 12 22900 */ 22901 onDidScroll(handler: OnScrollCallback): T; 22902 22903 /** 22904 * Called when the scrollable reaches the start position. 22905 * 22906 * @param { function } event - Callback function, triggered when the scrollable reaches the start position. 22907 * @returns { T } 22908 * @syscap SystemCapability.ArkUI.ArkUI.Full 22909 * @crossplatform 22910 * @atomicservice 22911 * @since 11 22912 */ 22913 onReachStart(event: () => void): T; 22914 22915 /** 22916 * Called when the scrollable reaches the end position. 22917 * 22918 * @param { function } event - Callback function, triggered when the scrollable reaches the end position. 22919 * @returns { T } 22920 * @syscap SystemCapability.ArkUI.ArkUI.Full 22921 * @crossplatform 22922 * @atomicservice 22923 * @since 11 22924 */ 22925 onReachEnd(event: () => void): T; 22926 22927 /** 22928 * Called when the scrollable starts scrolling. 22929 * 22930 * @param { function } event - Callback function, triggered when the scrollable starts scrolling. 22931 * @returns { T } 22932 * @syscap SystemCapability.ArkUI.ArkUI.Full 22933 * @crossplatform 22934 * @atomicservice 22935 * @since 11 22936 */ 22937 onScrollStart(event: () => void): T; 22938 22939 /** 22940 * Called when the scrollable stops scrolling. 22941 * 22942 * @param { function } event - Callback function, triggered when the scrollable stops scrolling. 22943 * @returns { T } 22944 * @syscap SystemCapability.ArkUI.ArkUI.Full 22945 * @crossplatform 22946 * @atomicservice 22947 * @since 11 22948 */ 22949 onScrollStop(event: () => void): T; 22950 22951 /** 22952 * Limit the max speed when fling. 22953 * 22954 * @param { number } speedLimit - Max fling speed, the minimum value is 0, the maximum value is not limited. 22955 * The unit is vp/s. 22956 * @returns { T } 22957 * @syscap SystemCapability.ArkUI.ArkUI.Full 22958 * @crossplatform 22959 * @atomicservice 22960 * @since 11 22961 */ 22962 flingSpeedLimit(speedLimit: number): T; 22963} 22964 22965/** 22966 * The actual offset by which the scrollable scrolls. 22967 * @syscap SystemCapability.ArkUI.ArkUI.Full 22968 * @crossplatform 22969 * @atomicservice 22970 * @since 12 22971 */ 22972declare class ScrollResult { 22973 /** 22974 * Actual offset by which the scrollable scrolls in vp. 22975 * @type { number } 22976 * @syscap SystemCapability.ArkUI.ArkUI.Full 22977 * @crossplatform 22978 * @atomicservice 22979 * @since 12 22980 */ 22981 offsetRemain: number; 22982} 22983 22984/** 22985 * Called before scroll to allow developer to control real offset the Scrollable can scroll. 22986 * 22987 * @typedef { function } OnWillScrollCallback 22988 * @param { number } scrollOffset - offset this frame will scroll, which may or may not be reached. 22989 * @param { ScrollState } scrollState - current scroll state. 22990 * @param { ScrollSource } scrollSource - source of current scroll. 22991 * @returns { void | ScrollResult } the remain offset for the scrollable, 22992 * same as scrollOffset when no ScrollResult is returned. 22993 * @syscap SystemCapability.ArkUI.ArkUI.Full 22994 * @crossplatform 22995 * @atomicservice 22996 * @since 12 22997 */ 22998declare type OnWillScrollCallback = 22999(scrollOffset: number, scrollState: ScrollState, scrollSource: ScrollSource) => void | ScrollResult; 23000 23001/** 23002 * On scroll callback using in scrollable onDidScroll. 23003 * 23004 * @typedef { function } OnScrollCallback 23005 * @param { number } scrollOffset - offset this frame did scroll. 23006 * @param { ScrollState } scrollState - current scroll state. 23007 * @syscap SystemCapability.ArkUI.ArkUI.Full 23008 * @crossplatform 23009 * @form 23010 * @atomicservice 23011 * @since 12 23012 */ 23013declare type OnScrollCallback = (scrollOffset: number, scrollState: ScrollState) => void; 23014 23015/** 23016 * Defines the onMove callback. 23017 * 23018 * @typedef { function } OnMoveHandler 23019 * @param { number } from - Index number for moving elements. 23020 * @param { number } to - Target index number for moving elements. 23021 * @syscap SystemCapability.ArkUI.ArkUI.Full 23022 * @crossplatform 23023 * @atomicservice 23024 * @since 12 23025 */ 23026declare type OnMoveHandler = (from: number, to: number) => void 23027 23028/** 23029 * Define DynamicNode. 23030 * 23031 * @syscap SystemCapability.ArkUI.ArkUI.Full 23032 * @crossplatform 23033 * @atomicservice 23034 * @since 12 23035 */ 23036declare class DynamicNode<T> { 23037 /** 23038 * Set the move action. 23039 * 23040 * @param { Optional<OnMoveHandler> } handler 23041 * @returns { T } 23042 * @syscap SystemCapability.ArkUI.ArkUI.Full 23043 * @crossplatform 23044 * @atomicservice 23045 * @since 12 23046 */ 23047 onMove(handler: Optional<OnMoveHandler>): T 23048} 23049 23050/** 23051 * Define EdgeEffect Options. 23052 * 23053 * @interface EdgeEffectOptions 23054 * @syscap SystemCapability.ArkUI.ArkUI.Full 23055 * @crossplatform 23056 * @since 11 23057 */ 23058/** 23059 * Define EdgeEffect Options. 23060 * 23061 * @interface EdgeEffectOptions 23062 * @syscap SystemCapability.ArkUI.ArkUI.Full 23063 * @crossplatform 23064 * @atomicservice 23065 * @since 12 23066 */ 23067declare interface EdgeEffectOptions { 23068 /** 23069 * Enable Sliding effect when component does not full screen. 23070 * 23071 * @type { boolean } 23072 * @syscap SystemCapability.ArkUI.ArkUI.Full 23073 * @crossplatform 23074 * @since 11 23075 */ 23076 /** 23077 * Enable Sliding effect when component does not full screen. 23078 * 23079 * @type { boolean } 23080 * @syscap SystemCapability.ArkUI.ArkUI.Full 23081 * @crossplatform 23082 * @atomicservice 23083 * @since 12 23084 */ 23085 alwaysEnabled: boolean; 23086} 23087 23088/** 23089 * Indicates children main size. 23090 * 23091 * @syscap SystemCapability.ArkUI.ArkUI.Full 23092 * @crossplatform 23093 * @atomicservice 23094 * @since 12 23095 */ 23096declare class ChildrenMainSize { 23097 /** 23098 * Creates an instance of ChildrenMainSize. 23099 * 23100 * @param { number } childDefaultSize - default main size, in vp. If the main axis is vertical, it indicates height. 23101 * If the main axis is horizontal, it indicates width. 23102 * @throws { BusinessError } 401 - Parameter error. Possible causes: 23103 * <br> 1. Mandatory parameters are left unspecified. 23104 * <br> 2. Incorrect parameters types. 23105 * <br> 3. Parameter verification failed. 23106 * @syscap SystemCapability.ArkUI.ArkUI.Full 23107 * @crossplatform 23108 * @atomicservice 23109 * @since 12 23110 */ 23111 constructor(childDefaultSize: number); 23112 23113 /** 23114 * Set default size. 23115 * 23116 * @param { number } value - default main size, in vp. If the main axis is vertical, it indicates height. 23117 * If the main axis is horizontal, it indicates width. 23118 * @throws { BusinessError } 401 - Parameter error. Possible causes: 23119 * <br> 1. Mandatory parameters are left unspecified. 23120 * <br> 2. Incorrect parameters types. 23121 * <br> 3. Parameter verification failed. 23122 * @syscap SystemCapability.ArkUI.ArkUI.Full 23123 * @crossplatform 23124 * @atomicservice 23125 * @since 12 23126 */ 23127 set childDefaultSize(value: number); 23128 23129 /** 23130 * Get default size 23131 * 23132 * @returns { number } - default main size, in vp. If the main axis is vertical, it indicates height. 23133 * If the main axis is horizontal, it indicates width. 23134 * @syscap SystemCapability.ArkUI.ArkUI.Full 23135 * @crossplatform 23136 * @atomicservice 23137 * @since 12 23138 */ 23139 get childDefaultSize(): number; 23140 23141 /** 23142 * Changes children main size by removing or replacing existing elements and/or adding new elements in place. 23143 * 23144 * @param { number } start - Zero-based index at which to start changing the children main size. 23145 * @param { number } [deleteCount] - Indicating the number of children main size to remove from start. 23146 * @param { Array<number> } [childrenSize] - Add the new children main size, beginning from start. 23147 * @throws { BusinessError } 401 - Parameter error. Possible causes: 23148 * <br> 1. Mandatory parameters are left unspecified. 23149 * <br> 2. Incorrect parameters types. 23150 * <br> 3. Parameter verification failed. 23151 * @syscap SystemCapability.ArkUI.ArkUI.Full 23152 * @crossplatform 23153 * @atomicservice 23154 * @since 12 23155 * @example splice(1, 0, [100]), Insert a child after first child, the child's main size is 100vp. 23156 * splice(1, 1), Delete the second child. 23157 * splice(1, 2, [100, 100]), Change the main size of the second and third children to 100vp. 23158 */ 23159 splice(start: number, deleteCount?: number, childrenSize?: Array<number>): void; 23160 23161 /** 23162 * Updates main size for specified child. 23163 * 23164 * @param { number } index - index of child to be updated. 23165 * @param { number } childSize - new section options. 23166 * @throws { BusinessError } 401 - Parameter error. Possible causes: 23167 * <br> 1. Mandatory parameters are left unspecified. 23168 * <br> 2. Incorrect parameters types. 23169 * <br> 3. Parameter verification failed. 23170 * @syscap SystemCapability.ArkUI.ArkUI.Full 23171 * @crossplatform 23172 * @atomicservice 23173 * @since 12 23174 */ 23175 update(index: number, childSize: number): void; 23176} 23177 23178/** 23179 * Define BackgroundBrightness Options. 23180 * 23181 * @interface BackgroundBrightnessOptions 23182 * @syscap SystemCapability.ArkUI.ArkUI.Full 23183 * @atomicservice 23184 * @since 12 23185 */ 23186declare interface BackgroundBrightnessOptions { 23187 23188 /** 23189 * Rate represents the rate at which lightUpDegree 23190 * decreases with increasing pixel brightness. 23191 * 23192 * @type { number } -The default value is 0.0, value range: (0.0, +∞). 23193 * @syscap SystemCapability.ArkUI.ArkUI.Full 23194 * @atomicservice 23195 * @since 12 23196 */ 23197 rate: number; 23198 23199 /** 23200 * LightUpDegree represents the degree of brightness 23201 * of the rgb value changes when its brightness 23202 * is 0. 23203 * 23204 * @type { number } -The default value is 0.0, value range: [-1.0, 1.0]. 23205 * @syscap SystemCapability.ArkUI.ArkUI.Full 23206 * @atomicservice 23207 * @since 12 23208 */ 23209 lightUpDegree: number; 23210} 23211 23212/** 23213 * PointLightStyle info 23214 * 23215 * @interface PointLightStyle 23216 * @syscap SystemCapability.ArkUI.ArkUI.Full 23217 * @systemapi 23218 * @since 11 23219 */ 23220declare interface PointLightStyle { 23221 /** 23222 * Defines the PointLight light intensity and position. 23223 * 23224 * @type { ?LightSource } 23225 * @default undefined 23226 * @syscap SystemCapability.ArkUI.ArkUI.Full 23227 * @systemapi 23228 * @since 11 23229 */ 23230 lightSource?: LightSource; 23231 /** 23232 * Defines the PointLight illuminated type. 23233 * 23234 * @type { ?IlluminatedType } 23235 * @default IlluminatedType.NONE 23236 * @syscap SystemCapability.ArkUI.ArkUI.Full 23237 * @systemapi 23238 * @since 11 23239 */ 23240 illuminated?: IlluminatedType; 23241 /** 23242 * Defines the PointLight bloom. 23243 * 23244 * @type { ?number } 23245 * @default 0 23246 * @syscap SystemCapability.ArkUI.ArkUI.Full 23247 * @systemapi 23248 * @since 11 23249 */ 23250 bloom?: number; 23251} 23252 23253/** 23254 * LightSource info 23255 * 23256 * @interface LightSource 23257 * @syscap SystemCapability.ArkUI.ArkUI.Full 23258 * @systemapi 23259 * @since 11 23260 */ 23261declare interface LightSource { 23262 /** 23263 * Defines the PointLight light positionX. 23264 * 23265 * @type { Dimension } 23266 * @syscap SystemCapability.ArkUI.ArkUI.Full 23267 * @systemapi 23268 * @since 11 23269 */ 23270 positionX: Dimension; 23271 /** 23272 * Defines the PointLight light positionX. 23273 * 23274 * @type { Dimension } 23275 * @syscap SystemCapability.ArkUI.ArkUI.Full 23276 * @systemapi 23277 * @since 11 23278 */ 23279 positionY: Dimension; 23280 /** 23281 * Defines the PointLight light positionX. 23282 * 23283 * @type { Dimension } 23284 * @syscap SystemCapability.ArkUI.ArkUI.Full 23285 * @systemapi 23286 * @since 11 23287 */ 23288 positionZ: Dimension; 23289 /** 23290 * Defines the PointLight light intensity. 23291 * 23292 * @type { number } 23293 * @syscap SystemCapability.ArkUI.ArkUI.Full 23294 * @systemapi 23295 * @since 11 23296 */ 23297 intensity: number; 23298 /** 23299 * Defines the PointLight light color. 23300 * 23301 * @type { ?ResourceColor } 23302 * @syscap SystemCapability.ArkUI.ArkUI.Full 23303 * @systemapi 23304 * @since 12 23305 */ 23306 color?: ResourceColor; 23307} 23308 23309/** 23310 * Defining wrapBuilder function. 23311 * @param { function } builder 23312 * @returns { WrappedBuilder<Args> } 23313 * @syscap SystemCapability.ArkUI.ArkUI.Full 23314 * @crossplatform 23315 * @since 11 23316 */ 23317/** 23318 * Defining wrapBuilder function. 23319 * @param { function } builder 23320 * @returns { WrappedBuilder<Args> } 23321 * @syscap SystemCapability.ArkUI.ArkUI.Full 23322 * @crossplatform 23323 * @atomicservice 23324 * @since 12 23325 */ 23326declare function wrapBuilder<Args extends Object[]>(builder: (...args: Args) => void): WrappedBuilder<Args>; 23327 23328/** 23329 * Defines the WrappedBuilder class. 23330 * @syscap SystemCapability.ArkUI.ArkUI.Full 23331 * @crossplatform 23332 * @since 11 23333 */ 23334/** 23335 * Defines the WrappedBuilder class. 23336 * @syscap SystemCapability.ArkUI.ArkUI.Full 23337 * @crossplatform 23338 * @atomicservice 23339 * @since 12 23340 */ 23341declare class WrappedBuilder<Args extends Object[]> { 23342 /** 23343 * @type { function } 23344 * @syscap SystemCapability.ArkUI.ArkUI.Full 23345 * @crossplatform 23346 * @since 11 23347 */ 23348 /** 23349 * @type { function } 23350 * @syscap SystemCapability.ArkUI.ArkUI.Full 23351 * @crossplatform 23352 * @atomicservice 23353 * @since 12 23354 */ 23355 builder: (...args: Args) => void; 23356 23357 /** 23358 * @param { function } builder 23359 * @syscap SystemCapability.ArkUI.ArkUI.Full 23360 * @crossplatform 23361 * @since 11 23362 */ 23363 /** 23364 * @param { function } builder 23365 * @syscap SystemCapability.ArkUI.ArkUI.Full 23366 * @crossplatform 23367 * @atomicservice 23368 * @since 12 23369 */ 23370 constructor(builder: (...args: Args) => void); 23371} 23372 23373 23374/** 23375 * Defines the overall animation parameters of the keyframe animation. 23376 * 23377 * @interface KeyframeAnimateParam 23378 * @syscap SystemCapability.ArkUI.ArkUI.Full 23379 * @crossplatform 23380 * @since 11 23381 */ 23382/** 23383 * Defines the overall animation parameters of the keyframe animation. 23384 * 23385 * @interface KeyframeAnimateParam 23386 * @syscap SystemCapability.ArkUI.ArkUI.Full 23387 * @crossplatform 23388 * @atomicservice 23389 * @since 12 23390 */ 23391declare interface KeyframeAnimateParam { 23392 /** 23393 * Animation delay time, in ms. 23394 * 23395 * @type { ?number } 23396 * @default 0 23397 * @syscap SystemCapability.ArkUI.ArkUI.Full 23398 * @crossplatform 23399 * @since 11 23400 */ 23401 /** 23402 * Animation delay time, in ms. 23403 * 23404 * @type { ?number } 23405 * @default 0 23406 * @syscap SystemCapability.ArkUI.ArkUI.Full 23407 * @crossplatform 23408 * @atomicservice 23409 * @since 12 23410 */ 23411 delay?: number; 23412 23413 /** 23414 * Animation iterations. When set to -1, the animation playing it repeatedly. The value range is greater than or equal to -1. 23415 * 23416 * @type { ?number } 23417 * @default 1 23418 * @syscap SystemCapability.ArkUI.ArkUI.Full 23419 * @crossplatform 23420 * @since 11 23421 */ 23422 /** 23423 * Animation iterations. When set to -1, the animation playing it repeatedly. The value range is greater than or equal to -1. 23424 * 23425 * @type { ?number } 23426 * @default 1 23427 * @syscap SystemCapability.ArkUI.ArkUI.Full 23428 * @crossplatform 23429 * @atomicservice 23430 * @since 12 23431 */ 23432 iterations?: number; 23433 23434 /** 23435 * Callback invoked when the whole keyframe animation is complete or the ability is about to enter the background. 23436 * 23437 * @type { ?function } 23438 * @syscap SystemCapability.ArkUI.ArkUI.Full 23439 * @crossplatform 23440 * @since 11 23441 */ 23442 /** 23443 * Callback invoked when the whole keyframe animation is complete or the ability is about to enter the background. 23444 * 23445 * @type { ?function } 23446 * @syscap SystemCapability.ArkUI.ArkUI.Full 23447 * @crossplatform 23448 * @atomicservice 23449 * @since 12 23450 */ 23451 onFinish?: () => void; 23452} 23453 23454/** 23455 * Defines a keyframe state. 23456 * 23457 * @interface KeyframeState 23458 * @syscap SystemCapability.ArkUI.ArkUI.Full 23459 * @crossplatform 23460 * @since 11 23461 */ 23462/** 23463 * Defines a keyframe state. 23464 * 23465 * @interface KeyframeState 23466 * @syscap SystemCapability.ArkUI.ArkUI.Full 23467 * @crossplatform 23468 * @atomicservice 23469 * @since 12 23470 */ 23471declare interface KeyframeState { 23472 /** 23473 * Animation duration of this keyframe, in ms. 23474 * 23475 * @type { number } 23476 * @syscap SystemCapability.ArkUI.ArkUI.Full 23477 * @crossplatform 23478 * @since 11 23479 */ 23480 /** 23481 * Animation duration of this keyframe, in ms. 23482 * 23483 * @type { number } 23484 * @syscap SystemCapability.ArkUI.ArkUI.Full 23485 * @crossplatform 23486 * @atomicservice 23487 * @since 12 23488 */ 23489 duration: number; 23490 23491 /** 23492 * Animation curve of this keyframe. 23493 * 23494 * @type { ?(Curve | string | ICurve) } 23495 * @syscap SystemCapability.ArkUI.ArkUI.Full 23496 * @crossplatform 23497 * @since 11 23498 */ 23499 /** 23500 * Animation curve of this keyframe. 23501 * 23502 * @type { ?(Curve | string | ICurve) } 23503 * @syscap SystemCapability.ArkUI.ArkUI.Full 23504 * @crossplatform 23505 * @atomicservice 23506 * @since 12 23507 */ 23508 curve?: Curve | string | ICurve; 23509 23510 /** 23511 * The closure function to specify the terminating state of this keyframe. 23512 * 23513 * @type { function } 23514 * @syscap SystemCapability.ArkUI.ArkUI.Full 23515 * @crossplatform 23516 * @since 11 23517 */ 23518 /** 23519 * The closure function to specify the terminating state of this keyframe. 23520 * 23521 * @type { function } 23522 * @syscap SystemCapability.ArkUI.ArkUI.Full 23523 * @crossplatform 23524 * @atomicservice 23525 * @since 12 23526 */ 23527 event: () => void; 23528} 23529 23530 23531/** 23532 * Defines the basic callback. 23533 * 23534 * @typedef Callback 23535 * @syscap SystemCapability.ArkUI.ArkUI.Full 23536 * @crossplatform 23537 * @atomicservice 23538 * @since 12 23539 */ 23540declare interface Callback<T, V = void> { 23541 /** 23542 * Defines the callback info. 23543 * 23544 * @param { T } data - the data will be used in the callback. 23545 * @returns { V } - Returns result of the callback. 23546 * @syscap SystemCapability.ArkUI.ArkUI.Full 23547 * @crossplatform 23548 * @atomicservice 23549 * @since 12 23550 */ 23551 (data: T): V; 23552} 23553 23554/** 23555 * Defines the callback type used in hover events. 23556 * The value of isHover indicates whether the mouse is hovering over the component. 23557 * The value of event contains information about HoverEvent. 23558 * 23559 * @typedef HoverCallback 23560 * @param { boolean } isHover 23561 * @param { HoverEvent} event 23562 * @syscap SystemCapability.ArkUI.ArkUI.Full 23563 * @crossplatform 23564 * @atomicservice 23565 * @since 12 23566 */ 23567declare type HoverCallback = (isHover: boolean, event: HoverEvent) => void 23568 23569/** 23570 * Defines the callback type used in accessibility hover events. 23571 * The value of isHover indicates whether the touch is hovering over the component. 23572 * The value of event contains information about AccessibilityHoverEvent. 23573 * 23574 * @typedef { function } 23575 * @syscap SystemCapability.ArkUI.ArkUI.Full 23576 * @crossplatform 23577 * @atomicservice 23578 * @since 12 23579 */ 23580declare type AccessibilityCallback = (isHover: boolean, event: AccessibilityHoverEvent) => void; 23581 23582/** 23583 * Defines the options about VisibleAreaEvent. 23584 * 23585 * @interface VisibleAreaEventOptions 23586 * @syscap SystemCapability.ArkUI.ArkUI.Full 23587 * @crossplatform 23588 * @atomicservice 23589 * @since 12 23590 */ 23591declare interface VisibleAreaEventOptions { 23592 /** 23593 * Each number in ratios indicates the value of visibility ratio. Each number in the Array value range in [0, 1]. 23594 * 23595 * @type { Array<number> } 23596 * @syscap SystemCapability.ArkUI.ArkUI.Full 23597 * @crossplatform 23598 * @atomicservice 23599 * @since 12 23600 */ 23601 ratios: Array<number>; 23602 23603 /** 23604 * The value of expectedUpdateInterval indicates desired update period(ms). 23605 * 23606 * @type { ?number } 23607 * @default 1000 23608 * @syscap SystemCapability.ArkUI.ArkUI.Full 23609 * @crossplatform 23610 * @atomicservice 23611 * @since 12 23612 */ 23613 expectedUpdateInterval?: number; 23614} 23615 23616/** 23617 * Defines the callback type used in VisibleAreaChange events. 23618 * 23619 * @typedef { function } VisibleAreaChangeCallback 23620 * @param { boolean } isVisible - Indicates the ratio of the visible area to its own area compared to the last change. 23621 * It is true as the ratio increases and false as the ratio decreases. 23622 * @param { number } currentRatio - The value of currentRatio indicates the visibility ratio of the current component. 23623 * @syscap SystemCapability.ArkUI.ArkUI.Full 23624 * @crossplatform 23625 * @atomicservice 23626 * @since 12 23627 */ 23628/** 23629 * Defines the callback type used in VisibleAreaChange events. 23630 * 23631 * @typedef { function } VisibleAreaChangeCallback 23632 * @param { boolean } isExpanding - Indicates the ratio of the visible area to its own area compared to the last change. 23633 * It is true as the ratio increases and false as the ratio decreases. 23634 * @param { number } currentRatio - The value of currentRatio indicates the visibility ratio of the current component. 23635 * @syscap SystemCapability.ArkUI.ArkUI.Full 23636 * @crossplatform 23637 * @atomicservice 23638 * @since 13 23639 */ 23640declare type VisibleAreaChangeCallback = (isExpanding: boolean, currentRatio: number) => void; 23641 23642/** 23643 * Defines a UICommonEvent which is used to set different common event to target component. 23644 * 23645 * @interface UICommonEvent 23646 * @syscap SystemCapability.ArkUI.ArkUI.Full 23647 * @crossplatform 23648 * @atomicservice 23649 * @since 12 23650 */ 23651declare interface UICommonEvent { 23652 /** 23653 * Set or reset the callback which will be triggered a click event when clicked. 23654 * 23655 * @param { Callback<ClickEvent> | undefined } callback - The callback about the click event. If set undefined will reset the target callback. 23656 * @syscap SystemCapability.ArkUI.ArkUI.Full 23657 * @crossplatform 23658 * @atomicservice 23659 * @since 12 23660 */ 23661 setOnClick(callback: Callback<ClickEvent> | undefined): void; 23662 23663 /** 23664 * Set or reset the callback which will be triggered a touch event when touched. 23665 * 23666 * @param { Callback<TouchEvent> | undefined } callback - The callback about the touch event. If set undefined will reset the target callback. 23667 * @syscap SystemCapability.ArkUI.ArkUI.Full 23668 * @crossplatform 23669 * @atomicservice 23670 * @since 12 23671 */ 23672 setOnTouch(callback: Callback<TouchEvent> | undefined): void; 23673 23674 /** 23675 * Set or reset the callback is triggered when a component mounts a display. 23676 * 23677 * @param { Callback<void> | undefined } callback - The callback will be triggered when a component mounts a display. If set undefined will reset the target callback. 23678 * @syscap SystemCapability.ArkUI.ArkUI.Full 23679 * @crossplatform 23680 * @atomicservice 23681 * @since 12 23682 */ 23683 setOnAppear(callback: Callback<void> | undefined): void; 23684 23685 /** 23686 * Set or reset the callback is triggered when component uninstallation disappears. 23687 * 23688 * @param { Callback<void> | undefined } callback - The callback will be triggered when component uninstallation disappears. If set undefined will reset the target callback. 23689 * @syscap SystemCapability.ArkUI.ArkUI.Full 23690 * @crossplatform 23691 * @atomicservice 23692 * @since 12 23693 */ 23694 setOnDisappear(callback: Callback<void> | undefined): void; 23695 23696 23697 /** 23698 * Set or reset the callback is triggered when component has keyboard input. 23699 * 23700 * @param { Callback<KeyEvent> | undefined } callback - The callback will be triggered when has keyboard input. If set undefined will reset the target callback. 23701 * @syscap SystemCapability.ArkUI.ArkUI.Full 23702 * @crossplatform 23703 * @atomicservice 23704 * @since 12 23705 */ 23706 setOnKeyEvent(callback: Callback<KeyEvent> | undefined): void; 23707 23708 /** 23709 * Set or reset the callback which is triggered when component get focus. 23710 * 23711 * @param { Callback<void> | undefined } callback - The callback will be triggered when a component get focus. If set undefined will reset the target callback. 23712 * @syscap SystemCapability.ArkUI.ArkUI.Full 23713 * @crossplatform 23714 * @atomicservice 23715 * @since 12 23716 */ 23717 setOnFocus(callback: Callback<void> | undefined): void; 23718 23719 /** 23720 * Set or reset the callback which is triggered when lose focus. 23721 * 23722 * @param { Callback<void> | undefined } callback - The callback will be triggered when a component lose focus. If set undefined will reset the target callback. 23723 * @syscap SystemCapability.ArkUI.ArkUI.Full 23724 * @crossplatform 23725 * @atomicservice 23726 * @since 12 23727 */ 23728 setOnBlur(callback: Callback<void> | undefined): void; 23729 23730 /** 23731 * Set or reset the callback which is triggered when has a hover event. 23732 * 23733 * @param { HoverCallback | undefined } callback - The callback will be triggered when has a hover event. If set undefined will reset the target callback. 23734 * @syscap SystemCapability.ArkUI.ArkUI.Full 23735 * @crossplatform 23736 * @atomicservice 23737 * @since 12 23738 */ 23739 setOnHover(callback: HoverCallback | undefined): void; 23740 23741 /** 23742 * Set or reset the callback which is triggered when has a mouse event. 23743 * 23744 * @param { Callback<MouseEvent> | undefined } callback - The callback will be triggered when has mouse input. If set undefined will reset the target callback. 23745 * @syscap SystemCapability.ArkUI.ArkUI.Full 23746 * @crossplatform 23747 * @atomicservice 23748 * @since 12 23749 */ 23750 setOnMouse(callback: Callback<MouseEvent> | undefined): void; 23751 23752 /** 23753 * Set or reset the callback which is triggered when the size of component changed. 23754 * 23755 * @param { SizeChangeCallback | undefined } callback - The callback will be triggered when the size of component changed. If set undefined will reset the target callback. 23756 * @syscap SystemCapability.ArkUI.ArkUI.Full 23757 * @crossplatform 23758 * @atomicservice 23759 * @since 12 23760 */ 23761 setOnSizeChange(callback: SizeChangeCallback | undefined): void; 23762 23763 /** 23764 * Set or reset the callback which is triggered when the visibleArea of component changed. 23765 * 23766 * @param { VisibleAreaEventOptions } options - The options for the visibility event. 23767 * @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. 23768 * If set undefined will reset the target callback. 23769 * @syscap SystemCapability.ArkUI.ArkUI.Full 23770 * @crossplatform 23771 * @atomicservice 23772 * @since 12 23773 */ 23774 setOnVisibleAreaApproximateChange(options: VisibleAreaEventOptions, event: VisibleAreaChangeCallback | undefined): void; 23775} 23776 23777/** 23778 * Defines a UIGestureEvent which is used to set different gestures to target component. 23779 * 23780 * @interface UIGestureEvent 23781 * @syscap SystemCapability.ArkUI.ArkUI.Full 23782 * @crossplatform 23783 * @atomicservice 23784 * @since 12 23785 */ 23786declare interface UIGestureEvent { 23787 /** 23788 * Add a gesture bound to the component. 23789 * 23790 * @param { GestureHandler<T> } gesture - gesture indicates the gesture bound to a component. 23791 * @param { GesturePriority } priority - priority indicates the gesture's priority. 23792 * @param { GestureMask } mask - mask indicates the gesture's GestureMask value. 23793 * @syscap SystemCapability.ArkUI.ArkUI.Full 23794 * @crossplatform 23795 * @atomicservice 23796 * @since 12 23797 */ 23798 addGesture<T>(gesture: GestureHandler<T>, priority?: GesturePriority, mask?: GestureMask): void; 23799 23800 /** 23801 * Add a parallel gesture bound to the component. 23802 * 23803 * @param { GestureHandler<T> } gesture - gesture indicates the gesture bound to a component. 23804 * @param { GestureMask } mask - mask indicates the gesture's GestureMask value. 23805 * @syscap SystemCapability.ArkUI.ArkUI.Full 23806 * @crossplatform 23807 * @atomicservice 23808 * @since 12 23809 */ 23810 addParallelGesture<T>(gesture: GestureHandler<T>, mask?: GestureMask): void; 23811 23812 /** 23813 * Remove the gesture that is bound to the component and marked as tag. 23814 * 23815 * @param { string } tag - tag indicates the gesture's tag. 23816 * @syscap SystemCapability.ArkUI.ArkUI.Full 23817 * @crossplatform 23818 * @atomicservice 23819 * @since 12 23820 */ 23821 removeGestureByTag(tag: string): void; 23822 23823 /** 23824 * Clear gestures bound to the component. 23825 * 23826 * @syscap SystemCapability.ArkUI.ArkUI.Full 23827 * @crossplatform 23828 * @atomicservice 23829 * @since 12 23830 */ 23831 clearGestures(): void; 23832} 23833 23834/** 23835 * Defines the gesture modifier. 23836 * 23837 * @interface GestureModifier 23838 * @syscap SystemCapability.ArkUI.ArkUI.Full 23839 * @crossplatform 23840 * @atomicservice 23841 * @since 12 23842 */ 23843declare interface GestureModifier { 23844 /** 23845 * Defines the gesture update function. 23846 * 23847 * @param { UIGestureEvent } event 23848 * @syscap SystemCapability.ArkUI.ArkUI.Full 23849 * @crossplatform 23850 * @atomicservice 23851 * @since 12 23852 */ 23853 applyGesture(event: UIGestureEvent): void; 23854} 23855 23856/** 23857 * Defines the selection options. 23858 * 23859 * @interface SelectionOptions 23860 * @syscap SystemCapability.ArkUI.ArkUI.Full 23861 * @crossplatform 23862 * @atomicservice 23863 * @since 12 23864 */ 23865declare interface SelectionOptions { 23866 /** 23867 * Menu pop-up policy. 23868 * 23869 * @type { ?MenuPolicy } 23870 * @syscap SystemCapability.ArkUI.ArkUI.Full 23871 * @crossplatform 23872 * @atomicservice 23873 * @since 12 23874 */ 23875 menuPolicy?: MenuPolicy; 23876} 23877 23878/** 23879 * enum keyboard avoid mode 23880 * 23881 * @enum { number } 23882 * @syscap SystemCapability.ArkUI.ArkUI.Full 23883 * @crossplatform 23884 * @atomicservice 23885 * @since 12 23886 */ 23887declare enum KeyboardAvoidMode { 23888 /** 23889 * Defines avoid keyboard when keyboard shows. 23890 * 23891 * @syscap SystemCapability.ArkUI.ArkUI.Full 23892 * @crossplatform 23893 * @atomicservice 23894 * @since 12 23895 */ 23896 DEFAULT = 0, 23897 23898 /** 23899 * Defines not avoid keyboard when keyboard shows. 23900 * 23901 * @syscap SystemCapability.ArkUI.ArkUI.Full 23902 * @crossplatform 23903 * @atomicservice 23904 * @since 12 23905 */ 23906 NONE = 1, 23907} 23908