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 * @readonly 1421 * @syscap SystemCapability.ArkUI.ArkUI.Full 1422 * @since 7 1423 */ 1424 /** 1425 * Set colorMode. 1426 * 1427 * @type { string } 1428 * @readonly 1429 * @syscap SystemCapability.ArkUI.ArkUI.Full 1430 * @form 1431 * @since 9 1432 */ 1433 /** 1434 * Set colorMode. 1435 * 1436 * @type { string } 1437 * @readonly 1438 * @syscap SystemCapability.ArkUI.ArkUI.Full 1439 * @crossplatform 1440 * @form 1441 * @since 10 1442 */ 1443 /** 1444 * Set colorMode. 1445 * 1446 * @type { string } 1447 * @readonly 1448 * @syscap SystemCapability.ArkUI.ArkUI.Full 1449 * @crossplatform 1450 * @form 1451 * @atomicservice 1452 * @since 11 1453 */ 1454 readonly colorMode: string; 1455 1456 /** 1457 * Set fontScale. 1458 * 1459 * @type { number } 1460 * @readonly 1461 * @syscap SystemCapability.ArkUI.ArkUI.Full 1462 * @since 7 1463 */ 1464 /** 1465 * Set fontScale. 1466 * 1467 * @type { number } 1468 * @readonly 1469 * @syscap SystemCapability.ArkUI.ArkUI.Full 1470 * @form 1471 * @since 9 1472 */ 1473 /** 1474 * Set fontScale. 1475 * 1476 * @type { number } 1477 * @readonly 1478 * @syscap SystemCapability.ArkUI.ArkUI.Full 1479 * @crossplatform 1480 * @form 1481 * @since 10 1482 */ 1483 /** 1484 * Set fontScale. 1485 * 1486 * @type { number } 1487 * @readonly 1488 * @syscap SystemCapability.ArkUI.ArkUI.Full 1489 * @crossplatform 1490 * @form 1491 * @atomicservice 1492 * @since 11 1493 */ 1494 readonly fontScale: number; 1495} 1496 1497/** 1498 * Defines the data type of the interface restriction. 1499 * 1500 * @interface Rectangle 1501 * @syscap SystemCapability.ArkUI.ArkUI.Full 1502 * @since 8 1503 */ 1504/** 1505 * Defines the data type of the interface restriction. 1506 * 1507 * @interface Rectangle 1508 * @syscap SystemCapability.ArkUI.ArkUI.Full 1509 * @form 1510 * @since 9 1511 */ 1512/** 1513 * Defines the data type of the interface restriction. 1514 * 1515 * @interface Rectangle 1516 * @syscap SystemCapability.ArkUI.ArkUI.Full 1517 * @crossplatform 1518 * @form 1519 * @since 10 1520 */ 1521/** 1522 * Defines the data type of the interface restriction. 1523 * 1524 * @interface Rectangle 1525 * @syscap SystemCapability.ArkUI.ArkUI.Full 1526 * @crossplatform 1527 * @form 1528 * @atomicservice 1529 * @since 11 1530 */ 1531declare interface Rectangle { 1532 /** 1533 * x:Horizontal coordinate 1534 * 1535 * @type { ?Length } 1536 * @syscap SystemCapability.ArkUI.ArkUI.Full 1537 * @since 8 1538 */ 1539 /** 1540 * x:Horizontal coordinate 1541 * 1542 * @type { ?Length } 1543 * @syscap SystemCapability.ArkUI.ArkUI.Full 1544 * @form 1545 * @since 9 1546 */ 1547 /** 1548 * x:Horizontal coordinate 1549 * 1550 * @type { ?Length } 1551 * @syscap SystemCapability.ArkUI.ArkUI.Full 1552 * @crossplatform 1553 * @form 1554 * @since 10 1555 */ 1556 /** 1557 * x:Horizontal coordinate 1558 * 1559 * @type { ?Length } 1560 * @syscap SystemCapability.ArkUI.ArkUI.Full 1561 * @crossplatform 1562 * @form 1563 * @atomicservice 1564 * @since 11 1565 */ 1566 x?: Length; 1567 1568 /** 1569 * y:Vertical axis coordinate. 1570 * 1571 * @type { ?Length } 1572 * @syscap SystemCapability.ArkUI.ArkUI.Full 1573 * @since 8 1574 */ 1575 /** 1576 * y:Vertical axis coordinate. 1577 * 1578 * @type { ?Length } 1579 * @syscap SystemCapability.ArkUI.ArkUI.Full 1580 * @form 1581 * @since 9 1582 */ 1583 /** 1584 * y:Vertical axis coordinate. 1585 * 1586 * @type { ?Length } 1587 * @syscap SystemCapability.ArkUI.ArkUI.Full 1588 * @crossplatform 1589 * @form 1590 * @since 10 1591 */ 1592 /** 1593 * y:Vertical axis coordinate. 1594 * 1595 * @type { ?Length } 1596 * @syscap SystemCapability.ArkUI.ArkUI.Full 1597 * @crossplatform 1598 * @form 1599 * @atomicservice 1600 * @since 11 1601 */ 1602 y?: Length; 1603 1604 /** 1605 * Sets the width of the current touchRect. 1606 * 1607 * @type { ?Length } 1608 * @syscap SystemCapability.ArkUI.ArkUI.Full 1609 * @since 8 1610 */ 1611 /** 1612 * Sets the width of the current touchRect. 1613 * 1614 * @type { ?Length } 1615 * @syscap SystemCapability.ArkUI.ArkUI.Full 1616 * @form 1617 * @since 9 1618 */ 1619 /** 1620 * Sets the width of the current touchRect. 1621 * 1622 * @type { ?Length } 1623 * @syscap SystemCapability.ArkUI.ArkUI.Full 1624 * @crossplatform 1625 * @form 1626 * @since 10 1627 */ 1628 /** 1629 * Sets the width of the current touchRect. 1630 * 1631 * @type { ?Length } 1632 * @syscap SystemCapability.ArkUI.ArkUI.Full 1633 * @crossplatform 1634 * @form 1635 * @atomicservice 1636 * @since 11 1637 */ 1638 width?: Length; 1639 1640 /** 1641 * Sets the height of the current touchRect. 1642 * 1643 * @type { ?Length } 1644 * @syscap SystemCapability.ArkUI.ArkUI.Full 1645 * @since 8 1646 */ 1647 /** 1648 * Sets the height of the current touchRect. 1649 * 1650 * @type { ?Length } 1651 * @syscap SystemCapability.ArkUI.ArkUI.Full 1652 * @form 1653 * @since 9 1654 */ 1655 /** 1656 * Sets the height of the current touchRect. 1657 * 1658 * @type { ?Length } 1659 * @syscap SystemCapability.ArkUI.ArkUI.Full 1660 * @crossplatform 1661 * @form 1662 * @since 10 1663 */ 1664 /** 1665 * Sets the height of the current touchRect. 1666 * 1667 * @type { ?Length } 1668 * @syscap SystemCapability.ArkUI.ArkUI.Full 1669 * @crossplatform 1670 * @form 1671 * @atomicservice 1672 * @since 11 1673 */ 1674 height?: Length; 1675} 1676 1677/** 1678 * Interface for ExpectedFrameRateRange. 1679 * 1680 * @interface ExpectedFrameRateRange 1681 * @syscap SystemCapability.ArkUI.ArkUI.Full 1682 * @since 11 1683 */ 1684/** 1685 * Interface for ExpectedFrameRateRange. 1686 * 1687 * @interface ExpectedFrameRateRange 1688 * @syscap SystemCapability.ArkUI.ArkUI.Full 1689 * @atomicservice 1690 * @since 12 1691 */ 1692declare interface ExpectedFrameRateRange { 1693 /** 1694 * The minimum animation drawing FPS. 1695 * The minimum value should be less than or equal to the maximum value. 1696 * @type { number } 1697 * @syscap SystemCapability.ArkUI.ArkUI.Full 1698 * @since 11 1699 */ 1700 /** 1701 * The minimum animation drawing FPS. 1702 * The minimum value should be less than or equal to the maximum value. 1703 * @type { number } 1704 * @syscap SystemCapability.ArkUI.ArkUI.Full 1705 * @atomicservice 1706 * @since 12 1707 */ 1708 min: number, 1709 /** 1710 * The maximum animation drawing FPS. 1711 * The maximum value should be greater than or equal to the minimum value. 1712 * @type { number } 1713 * @syscap SystemCapability.ArkUI.ArkUI.Full 1714 * @since 11 1715 */ 1716 /** 1717 * The maximum animation drawing FPS. 1718 * The maximum value should be greater than or equal to the minimum value. 1719 * @type { number } 1720 * @syscap SystemCapability.ArkUI.ArkUI.Full 1721 * @atomicservice 1722 * @since 12 1723 */ 1724 max: number, 1725 /** 1726 * The expected frame rate of dynamical callback rate range. 1727 * The value should be between the minimum and maximum value. 1728 * Otherwise, the actual callback rate will be dynamically 1729 * adjusted to better align with other animation sources. 1730 * @type { number } 1731 * @syscap SystemCapability.ArkUI.ArkUI.Full 1732 * @since 11 1733 */ 1734 /** 1735 * The expected frame rate of dynamical callback rate range. 1736 * The value should be between the minimum and maximum value. 1737 * Otherwise, the actual callback rate will be dynamically 1738 * adjusted to better align with other animation sources. 1739 * @type { number } 1740 * @syscap SystemCapability.ArkUI.ArkUI.Full 1741 * @atomicservice 1742 * @since 12 1743 */ 1744 expected: number, 1745} 1746 1747/** 1748 * global $r function 1749 * 1750 * @param { string } value 1751 * @param { any[] } params 1752 * @returns { Resource } 1753 * @syscap SystemCapability.ArkUI.ArkUI.Full 1754 * @since 7 1755 */ 1756/** 1757 * global $r function 1758 * 1759 * @param { string } value 1760 * @param { any[] } params 1761 * @returns { Resource } 1762 * @syscap SystemCapability.ArkUI.ArkUI.Full 1763 * @form 1764 * @since 9 1765 */ 1766/** 1767 * global $r function 1768 * 1769 * @param { string } value 1770 * @param { any[] } params 1771 * @returns { Resource } 1772 * @syscap SystemCapability.ArkUI.ArkUI.Full 1773 * @crossplatform 1774 * @form 1775 * @since 10 1776 */ 1777/** 1778 * global $r function 1779 * 1780 * @param { string } value 1781 * @param { any[] } params 1782 * @returns { Resource } 1783 * @syscap SystemCapability.ArkUI.ArkUI.Full 1784 * @crossplatform 1785 * @form 1786 * @atomicservice 1787 * @since 11 1788 */ 1789declare function $r(value: string, ...params: any[]): Resource; 1790 1791/** 1792 * global $rawfile function 1793 * 1794 * @param { string } value 1795 * @returns { Resource } 1796 * @syscap SystemCapability.ArkUI.ArkUI.Full 1797 * @since 7 1798 */ 1799/** 1800 * global $rawfile function 1801 * 1802 * @param { string } value 1803 * @returns { Resource } 1804 * @syscap SystemCapability.ArkUI.ArkUI.Full 1805 * @form 1806 * @since 9 1807 */ 1808/** 1809 * global $rawfile function 1810 * 1811 * @param { string } value 1812 * @returns { Resource } 1813 * @syscap SystemCapability.ArkUI.ArkUI.Full 1814 * @crossplatform 1815 * @form 1816 * @since 10 1817 */ 1818/** 1819 * global $rawfile function 1820 * 1821 * @param { string } value 1822 * @returns { Resource } 1823 * @syscap SystemCapability.ArkUI.ArkUI.Full 1824 * @crossplatform 1825 * @form 1826 * @atomicservice 1827 * @since 11 1828 */ 1829declare function $rawfile(value: string): Resource; 1830 1831/** 1832 * Enum for FinishCallbackType. 1833 * 1834 * @enum { number } 1835 * @syscap SystemCapability.ArkUI.ArkUI.Full 1836 * @crossplatform 1837 * @form 1838 * @since 11 1839 */ 1840/** 1841 * Enum for FinishCallbackType. 1842 * 1843 * @enum { number } 1844 * @syscap SystemCapability.ArkUI.ArkUI.Full 1845 * @crossplatform 1846 * @form 1847 * @atomicservice 1848 * @since 12 1849 */ 1850declare enum FinishCallbackType { 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 * @since 11 1858 */ 1859 /** 1860 * When the entire animation ends and will be removed immediately, the callback is triggered. 1861 * 1862 * @syscap SystemCapability.ArkUI.ArkUI.Full 1863 * @crossplatform 1864 * @form 1865 * @atomicservice 1866 * @since 12 1867 */ 1868 REMOVED = 0, 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 * @since 11 1876 */ 1877 /** 1878 * When the animation is logically down but may still be in its long tail, the callback is triggered. 1879 * 1880 * @syscap SystemCapability.ArkUI.ArkUI.Full 1881 * @crossplatform 1882 * @form 1883 * @atomicservice 1884 * @since 12 1885 */ 1886 LOGICALLY = 1, 1887} 1888 1889/** 1890 * Defines the touch test strategy object. 1891 * 1892 * @enum { number } 1893 * @syscap SystemCapability.ArkUI.ArkUI.Full 1894 * @crossplatform 1895 * @form 1896 * @since 11 1897 */ 1898/** 1899 * Defines the touch test strategy object. 1900 * 1901 * @enum { number } 1902 * @syscap SystemCapability.ArkUI.ArkUI.Full 1903 * @crossplatform 1904 * @form 1905 * @atomicservice 1906 * @since 12 1907 */ 1908declare enum TouchTestStrategy { 1909 /** 1910 * Do framework touch test. 1911 * 1912 * @syscap SystemCapability.ArkUI.ArkUI.Full 1913 * @crossplatform 1914 * @form 1915 * @since 11 1916 */ 1917 /** 1918 * Do framework touch test. 1919 * 1920 * @syscap SystemCapability.ArkUI.ArkUI.Full 1921 * @crossplatform 1922 * @form 1923 * @atomicservice 1924 * @since 12 1925 */ 1926 DEFAULT = 0, 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 * @since 11 1935 */ 1936 /** 1937 * Specify the component to do touch test and follow the framework touch test 1938 * 1939 * @syscap SystemCapability.ArkUI.ArkUI.Full 1940 * @crossplatform 1941 * @form 1942 * @atomicservice 1943 * @since 12 1944 */ 1945 FORWARD_COMPETITION = 1, 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 * @since 11 1954 */ 1955 /** 1956 * Specify the component to do touch test and not follow the framework touch test 1957 * 1958 * @syscap SystemCapability.ArkUI.ArkUI.Full 1959 * @crossplatform 1960 * @form 1961 * @atomicservice 1962 * @since 12 1963 */ 1964 FORWARD = 2 1965} 1966 1967/** 1968 * Defines the animate function params. 1969 * 1970 * @interface AnimateParam 1971 * @syscap SystemCapability.ArkUI.ArkUI.Full 1972 * @since 7 1973 */ 1974/** 1975 * Defines the animate function params. 1976 * 1977 * @interface AnimateParam 1978 * @syscap SystemCapability.ArkUI.ArkUI.Full 1979 * @form 1980 * @since 9 1981 */ 1982/** 1983 * Defines the animate function params. 1984 * 1985 * @interface AnimateParam 1986 * @syscap SystemCapability.ArkUI.ArkUI.Full 1987 * @crossplatform 1988 * @form 1989 * @since 10 1990 */ 1991/** 1992 * Defines the animate function params. 1993 * 1994 * @interface AnimateParam 1995 * @syscap SystemCapability.ArkUI.ArkUI.Full 1996 * @crossplatform 1997 * @form 1998 * @atomicservice 1999 * @since 11 2000 */ 2001declare interface AnimateParam { 2002 /** 2003 * Animation duration, in ms. 2004 * 2005 * @type { ?number } 2006 * @default 1000 2007 * @syscap SystemCapability.ArkUI.ArkUI.Full 2008 * @since 7 2009 */ 2010 /** 2011 * Animation duration, in ms. 2012 * 2013 * @type { ?number } 2014 * @default 1000 2015 * @syscap SystemCapability.ArkUI.ArkUI.Full 2016 * @form 2017 * @since 9 2018 */ 2019 /** 2020 * Animation duration, in ms. 2021 * 2022 * @type { ?number } 2023 * @default 1000 2024 * @syscap SystemCapability.ArkUI.ArkUI.Full 2025 * @crossplatform 2026 * @form 2027 * @since 10 2028 */ 2029 /** 2030 * Animation duration, in ms. 2031 * 2032 * @type { ?number } 2033 * @default 1000 2034 * @syscap SystemCapability.ArkUI.ArkUI.Full 2035 * @crossplatform 2036 * @form 2037 * @atomicservice 2038 * @since 11 2039 */ 2040 duration?: number; 2041 /** 2042 * Animation playback speed. A larger value indicates faster animation playback, and a smaller value indicates slower 2043 * animation playback. The value 0 means that there is no animation. 2044 * 2045 * @type { ?number } 2046 * @default 1.0 2047 * @syscap SystemCapability.ArkUI.ArkUI.Full 2048 * @since 7 2049 */ 2050 /** 2051 * Animation playback speed. A larger value indicates faster animation playback, and a smaller value indicates slower 2052 * animation playback. The value 0 means that there is no animation. 2053 * 2054 * @type { ?number } 2055 * @default 1.0 2056 * @syscap SystemCapability.ArkUI.ArkUI.Full 2057 * @crossplatform 2058 * @since 10 2059 */ 2060 /** 2061 * Animation playback speed. A larger value indicates faster animation playback, and a smaller value indicates slower 2062 * animation playback. The value 0 means that there is no animation. 2063 * 2064 * @type { ?number } 2065 * @default 1.0 2066 * @syscap SystemCapability.ArkUI.ArkUI.Full 2067 * @crossplatform 2068 * @atomicservice 2069 * @since 11 2070 */ 2071 tempo?: number; 2072 /** 2073 * Animation curve. 2074 * 2075 * @type { ?(Curve | string) } 2076 * @default Curve.EaseInOut 2077 * @syscap SystemCapability.ArkUI.ArkUI.Full 2078 * @since 7 2079 */ 2080 /** 2081 * Animation curve. 2082 * 2083 * @type { ?(Curve | string | ICurve) } 2084 * @default Curve.EaseInOut 2085 * @syscap SystemCapability.ArkUI.ArkUI.Full 2086 * @form 2087 * @since 9 2088 */ 2089 /** 2090 * Animation curve. 2091 * 2092 * @type { ?(Curve | string | ICurve) } 2093 * @default Curve.EaseInOut 2094 * @syscap SystemCapability.ArkUI.ArkUI.Full 2095 * @crossplatform 2096 * @form 2097 * @since 10 2098 */ 2099 /** 2100 * Animation curve. 2101 * 2102 * @type { ?(Curve | string | ICurve) } 2103 * @default Curve.EaseInOut 2104 * @syscap SystemCapability.ArkUI.ArkUI.Full 2105 * @crossplatform 2106 * @form 2107 * @atomicservice 2108 * @since 11 2109 */ 2110 curve?: Curve | string | ICurve; 2111 2112 /** 2113 * Animation plays with delay,when set to a negative number, the animation plays in advance. 2114 * 2115 * @type { ?number } 2116 * @default 0 2117 * @syscap SystemCapability.ArkUI.ArkUI.Full 2118 * @since 7 2119 */ 2120 /** 2121 * Animation delay time, in ms. 2122 * 2123 * @type { ?number } 2124 * @default 0 2125 * @syscap SystemCapability.ArkUI.ArkUI.Full 2126 * @crossplatform 2127 * @since 10 2128 */ 2129 /** 2130 * Animation delay time, in ms. 2131 * 2132 * @type { ?number } 2133 * @default 0 2134 * @syscap SystemCapability.ArkUI.ArkUI.Full 2135 * @crossplatform 2136 * @atomicservice 2137 * @since 11 2138 */ 2139 delay?: number; 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 * @since 7 2148 */ 2149 /** 2150 * Animation iterations. When set to -1, the animation playing it repeatedly. The value range is greater than or equal to -1. 2151 * 2152 * @type { ?number } 2153 * @default 1 2154 * @syscap SystemCapability.ArkUI.ArkUI.Full 2155 * @crossplatform 2156 * @since 10 2157 */ 2158 /** 2159 * Animation iterations. When set to -1, the animation playing it repeatedly. The value range is greater than or equal to -1. 2160 * 2161 * @type { ?number } 2162 * @default 1 2163 * @syscap SystemCapability.ArkUI.ArkUI.Full 2164 * @crossplatform 2165 * @atomicservice 2166 * @since 11 2167 */ 2168 iterations?: number; 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 * @since 7 2177 */ 2178 /** 2179 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 2180 * 2181 * @type { ?PlayMode } 2182 * @default PlayMode.Normal 2183 * @syscap SystemCapability.ArkUI.ArkUI.Full 2184 * @form 2185 * @since 9 2186 */ 2187 /** 2188 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 2189 * 2190 * @type { ?PlayMode } 2191 * @default PlayMode.Normal 2192 * @syscap SystemCapability.ArkUI.ArkUI.Full 2193 * @crossplatform 2194 * @form 2195 * @since 10 2196 */ 2197 /** 2198 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 2199 * 2200 * @type { ?PlayMode } 2201 * @default PlayMode.Normal 2202 * @syscap SystemCapability.ArkUI.ArkUI.Full 2203 * @crossplatform 2204 * @form 2205 * @atomicservice 2206 * @since 11 2207 */ 2208 playMode?: PlayMode; 2209 2210 /** 2211 * Callback invoked when the animation playback is complete or the ability is about to enter the background. 2212 * 2213 * @type { ?function } 2214 * @syscap SystemCapability.ArkUI.ArkUI.Full 2215 * @since 7 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 * @form 2223 * @since 9 2224 */ 2225 /** 2226 * Callback invoked when the animation playback is complete or the ability is about to enter the background. 2227 * 2228 * @type { ?function } 2229 * @syscap SystemCapability.ArkUI.ArkUI.Full 2230 * @crossplatform 2231 * @form 2232 * @since 10 2233 */ 2234 /** 2235 * Callback invoked when the animation playback is complete or the ability is about to enter the background. 2236 * 2237 * @type { ?function } 2238 * @syscap SystemCapability.ArkUI.ArkUI.Full 2239 * @crossplatform 2240 * @form 2241 * @atomicservice 2242 * @since 11 2243 */ 2244 onFinish?: () => void; 2245 2246 /** 2247 * Define the type of onFinish callback in animation. 2248 * 2249 * @type { ?FinishCallbackType } 2250 * @syscap SystemCapability.ArkUI.ArkUI.Full 2251 * @crossplatform 2252 * @form 2253 * @since 11 2254 */ 2255 /** 2256 * Define the type of onFinish callback in animation. 2257 * 2258 * @type { ?FinishCallbackType } 2259 * @syscap SystemCapability.ArkUI.ArkUI.Full 2260 * @crossplatform 2261 * @form 2262 * @atomicservice 2263 * @since 12 2264 */ 2265 finishCallbackType?: FinishCallbackType; 2266 2267 /** 2268 * Indicates expectedFrameRateRange including minimum、maximum and expected frame rate. 2269 * 2270 * @type { ?ExpectedFrameRateRange } 2271 * @syscap SystemCapability.ArkUI.ArkUI.Full 2272 * @since 11 2273 */ 2274 /** 2275 * Indicates expectedFrameRateRange including minimum、maximum and expected frame rate. 2276 * 2277 * @type { ?ExpectedFrameRateRange } 2278 * @syscap SystemCapability.ArkUI.ArkUI.Full 2279 * @atomicservice 2280 * @since 12 2281 */ 2282 expectedFrameRateRange?: ExpectedFrameRateRange; 2283} 2284 2285/** 2286 * Interface for curve object. 2287 * 2288 * @interface ICurve 2289 * @syscap SystemCapability.ArkUI.ArkUI.Full 2290 * @form 2291 * @since 9 2292 */ 2293/** 2294 * Interface for curve object. 2295 * 2296 * @interface ICurve 2297 * @syscap SystemCapability.ArkUI.ArkUI.Full 2298 * @crossplatform 2299 * @form 2300 * @since 10 2301 */ 2302/** 2303 * Interface for curve object. 2304 * 2305 * @interface ICurve 2306 * @syscap SystemCapability.ArkUI.ArkUI.Full 2307 * @crossplatform 2308 * @form 2309 * @atomicservice 2310 * @since 11 2311 */ 2312interface ICurve { 2313 /** 2314 * Get curve value by fraction. 2315 * 2316 * @param { number } fraction - Indicates the current normalized time parameter. Value range: [0, 1]. 2317 * Note: If the value is less than 0, it will be processed as 0. If the value is greater than 1, 1 is used. 2318 * @returns { number } 2319 * @syscap SystemCapability.ArkUI.ArkUI.Full 2320 * @form 2321 * @since 9 2322 */ 2323 /** 2324 * Get curve value by fraction. 2325 * 2326 * @param { number } fraction - Indicates the current normalized time parameter. Value range: [0, 1]. 2327 * Note: If the value is less than 0, it will be processed as 0. If the value is greater than 1, 1 is used. 2328 * @returns { number } 2329 * @syscap SystemCapability.ArkUI.ArkUI.Full 2330 * @crossplatform 2331 * @form 2332 * @since 10 2333 */ 2334 /** 2335 * Get curve value by fraction. 2336 * 2337 * @param { number } fraction - Indicates the current normalized time parameter. Value range: [0, 1]. 2338 * Note: If the value is less than 0, it will be processed as 0. If the value is greater than 1, 1 is used. 2339 * @returns { number } 2340 * @syscap SystemCapability.ArkUI.ArkUI.Full 2341 * @crossplatform 2342 * @form 2343 * @atomicservice 2344 * @since 11 2345 */ 2346 interpolate(fraction: number): number; 2347} 2348 2349/** 2350 * Defines the motion path options. 2351 * 2352 * @interface MotionPathOptions 2353 * @syscap SystemCapability.ArkUI.ArkUI.Full 2354 * @since 7 2355 */ 2356/** 2357 * Defines the motion path options. 2358 * 2359 * @interface MotionPathOptions 2360 * @syscap SystemCapability.ArkUI.ArkUI.Full 2361 * @crossplatform 2362 * @since 10 2363 */ 2364/** 2365 * Defines the motion path options. 2366 * 2367 * @interface MotionPathOptions 2368 * @syscap SystemCapability.ArkUI.ArkUI.Full 2369 * @crossplatform 2370 * @atomicservice 2371 * @since 11 2372 */ 2373declare interface MotionPathOptions { 2374 /** 2375 * The path info. 2376 * 2377 * @type { string } 2378 * @syscap SystemCapability.ArkUI.ArkUI.Full 2379 * @since 7 2380 */ 2381 /** 2382 * The path info. 2383 * 2384 * @type { string } 2385 * @syscap SystemCapability.ArkUI.ArkUI.Full 2386 * @crossplatform 2387 * @since 10 2388 */ 2389 /** 2390 * The path info. 2391 * 2392 * @type { string } 2393 * @syscap SystemCapability.ArkUI.ArkUI.Full 2394 * @crossplatform 2395 * @atomicservice 2396 * @since 11 2397 */ 2398 path: string; 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 * @since 7 2407 */ 2408 /** 2409 * The origin point info in range [0,1). 2410 * 2411 * @type { ?number } 2412 * @default 0.0 2413 * @syscap SystemCapability.ArkUI.ArkUI.Full 2414 * @crossplatform 2415 * @since 10 2416 */ 2417 /** 2418 * The origin point info in range [0,1). 2419 * 2420 * @type { ?number } 2421 * @default 0.0 2422 * @syscap SystemCapability.ArkUI.ArkUI.Full 2423 * @crossplatform 2424 * @atomicservice 2425 * @since 11 2426 */ 2427 from?: number; 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 * @since 7 2436 */ 2437 /** 2438 * he distance point info in range (0,1]. 2439 * 2440 * @type { ?number } 2441 * @default 1.0 2442 * @syscap SystemCapability.ArkUI.ArkUI.Full 2443 * @crossplatform 2444 * @since 10 2445 */ 2446 /** 2447 * The distance point info in range (0,1]. 2448 * 2449 * @type { ?number } 2450 * @default 1.0 2451 * @syscap SystemCapability.ArkUI.ArkUI.Full 2452 * @crossplatform 2453 * @atomicservice 2454 * @since 11 2455 */ 2456 to?: number; 2457 2458 /** 2459 * The rotate info. 2460 * 2461 * @type { ?boolean } 2462 * @default false 2463 * @syscap SystemCapability.ArkUI.ArkUI.Full 2464 * @since 7 2465 */ 2466 /** 2467 * The rotate info. 2468 * 2469 * @type { ?boolean } 2470 * @default false 2471 * @syscap SystemCapability.ArkUI.ArkUI.Full 2472 * @crossplatform 2473 * @since 10 2474 */ 2475 /** 2476 * The rotate info. 2477 * 2478 * @type { ?boolean } 2479 * @default false 2480 * @syscap SystemCapability.ArkUI.ArkUI.Full 2481 * @crossplatform 2482 * @atomicservice 2483 * @since 11 2484 */ 2485 rotatable?: boolean; 2486} 2487 2488/** 2489 * Defines the shard transition function params. 2490 * 2491 * @interface sharedTransitionOptions 2492 * @syscap SystemCapability.ArkUI.ArkUI.Full 2493 * @since 7 2494 */ 2495/** 2496 * Defines the shard transition function params. 2497 * 2498 * @interface sharedTransitionOptions 2499 * @syscap SystemCapability.ArkUI.ArkUI.Full 2500 * @crossplatform 2501 * @since 10 2502 */ 2503/** 2504 * Defines the shard transition function params. 2505 * 2506 * @interface sharedTransitionOptions 2507 * @syscap SystemCapability.ArkUI.ArkUI.Full 2508 * @crossplatform 2509 * @atomicservice 2510 * @since 11 2511 */ 2512declare interface sharedTransitionOptions { 2513 /** 2514 * Animation duration, in ms. 2515 * 2516 * @type { ?number } 2517 * @default 1000 2518 * @syscap SystemCapability.ArkUI.ArkUI.Full 2519 * @since 7 2520 */ 2521 /** 2522 * Animation duration, in ms. 2523 * 2524 * @type { ?number } 2525 * @default 1000 2526 * @syscap SystemCapability.ArkUI.ArkUI.Full 2527 * @crossplatform 2528 * @since 10 2529 */ 2530 /** 2531 * Animation duration, in ms. 2532 * 2533 * @type { ?number } 2534 * @default 1000 2535 * @syscap SystemCapability.ArkUI.ArkUI.Full 2536 * @crossplatform 2537 * @atomicservice 2538 * @since 11 2539 */ 2540 duration?: number; 2541 2542 /** 2543 * Animation duration, in ms. 2544 * 2545 * @type { ?(Curve | string | ICurve) } 2546 * @default 1000 2547 * @syscap SystemCapability.ArkUI.ArkUI.Full 2548 * @since 7 2549 */ 2550 /** 2551 * Animation curve. 2552 * 2553 * @type { ?(Curve | string | ICurve) } 2554 * @default 1000 2555 * @syscap SystemCapability.ArkUI.ArkUI.Full 2556 * @crossplatform 2557 * @since 10 2558 */ 2559 /** 2560 * Animation curve. 2561 * 2562 * @type { ?(Curve | string | ICurve) } 2563 * @default 1000 2564 * @syscap SystemCapability.ArkUI.ArkUI.Full 2565 * @crossplatform 2566 * @atomicservice 2567 * @since 11 2568 */ 2569 curve?: Curve | string | ICurve; 2570 2571 /** 2572 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 2573 * 2574 * @type { ?number } 2575 * @default 0 2576 * @syscap SystemCapability.ArkUI.ArkUI.Full 2577 * @since 7 2578 */ 2579 /** 2580 * Animation delay time, in ms. 2581 * 2582 * @type { ?number } 2583 * @default 0 2584 * @syscap SystemCapability.ArkUI.ArkUI.Full 2585 * @crossplatform 2586 * @since 10 2587 */ 2588 /** 2589 * Animation delay time, in ms. 2590 * 2591 * @type { ?number } 2592 * @default 0 2593 * @syscap SystemCapability.ArkUI.ArkUI.Full 2594 * @crossplatform 2595 * @atomicservice 2596 * @since 11 2597 */ 2598 delay?: number; 2599 2600 /** 2601 * The motion path info. 2602 * 2603 * @type { ?MotionPathOptions } 2604 * @syscap SystemCapability.ArkUI.ArkUI.Full 2605 * @since 7 2606 */ 2607 /** 2608 * The motion path info. 2609 * 2610 * @type { ?MotionPathOptions } 2611 * @syscap SystemCapability.ArkUI.ArkUI.Full 2612 * @crossplatform 2613 * @since 10 2614 */ 2615 /** 2616 * The motion path info. 2617 * 2618 * @type { ?MotionPathOptions } 2619 * @syscap SystemCapability.ArkUI.ArkUI.Full 2620 * @crossplatform 2621 * @atomicservice 2622 * @since 11 2623 */ 2624 motionPath?: MotionPathOptions; 2625 2626 /** 2627 * Z index info. 2628 * 2629 * @type { ?number } 2630 * @syscap SystemCapability.ArkUI.ArkUI.Full 2631 * @since 7 2632 */ 2633 /** 2634 * Z index info. 2635 * 2636 * @type { ?number } 2637 * @syscap SystemCapability.ArkUI.ArkUI.Full 2638 * @crossplatform 2639 * @since 10 2640 */ 2641 /** 2642 * Z index info. 2643 * 2644 * @type { ?number } 2645 * @syscap SystemCapability.ArkUI.ArkUI.Full 2646 * @crossplatform 2647 * @atomicservice 2648 * @since 11 2649 */ 2650 zIndex?: number; 2651 2652 /** 2653 * the animate type. 2654 * 2655 * @type { ?SharedTransitionEffectType } 2656 * @default SharedTransitionEffectType.Exchange 2657 * @syscap SystemCapability.ArkUI.ArkUI.Full 2658 * @since 7 2659 */ 2660 /** 2661 * the animate type. 2662 * 2663 * @type { ?SharedTransitionEffectType } 2664 * @default SharedTransitionEffectType.Exchange 2665 * @syscap SystemCapability.ArkUI.ArkUI.Full 2666 * @crossplatform 2667 * @since 10 2668 */ 2669 /** 2670 * the animate type. 2671 * 2672 * @type { ?SharedTransitionEffectType } 2673 * @default SharedTransitionEffectType.Exchange 2674 * @syscap SystemCapability.ArkUI.ArkUI.Full 2675 * @crossplatform 2676 * @atomicservice 2677 * @since 11 2678 */ 2679 type?: SharedTransitionEffectType; 2680} 2681 2682/** 2683 * Defines the options of geometry transition. 2684 * 2685 * @interface GeometryTransitionOptions 2686 * @syscap SystemCapability.ArkUI.ArkUI.Full 2687 * @crossplatform 2688 * @since 11 2689 */ 2690/** 2691 * Defines the options of geometry transition. 2692 * 2693 * @interface GeometryTransitionOptions 2694 * @syscap SystemCapability.ArkUI.ArkUI.Full 2695 * @crossplatform 2696 * @atomicservice 2697 * @since 12 2698 */ 2699declare interface GeometryTransitionOptions { 2700 /** 2701 * whether follow target for the component still in the hierarchy, default: false, stay current. 2702 * 2703 * @type { ?boolean } 2704 * @default false 2705 * @syscap SystemCapability.ArkUI.ArkUI.Full 2706 * @crossplatform 2707 * @since 11 2708 */ 2709 /** 2710 * whether follow target for the component still in the hierarchy, default: false, stay current. 2711 * 2712 * @type { ?boolean } 2713 * @default false 2714 * @syscap SystemCapability.ArkUI.ArkUI.Full 2715 * @crossplatform 2716 * @atomicservice 2717 * @since 12 2718 */ 2719 follow?: boolean; 2720 /** 2721 * Defines movement strategy of source and target in the hierarchy during geometry transition. 2722 * 2723 * @type { ?TransitionHierarchyStrategy } 2724 * @default TransitionHierarchyStrategy.ADAPTIVE 2725 * @syscap SystemCapability.ArkUI.ArkUI.Full 2726 * @systemapi 2727 * @atomicservice 2728 * @since 12 2729 */ 2730 /** 2731 * Defines movement strategy of source and target in the hierarchy during geometry transition. 2732 * 2733 * @type { ?TransitionHierarchyStrategy } 2734 * @default TransitionHierarchyStrategy.ADAPTIVE 2735 * @syscap SystemCapability.ArkUI.ArkUI.Full 2736 * @systemapi 2737 * @since 13 2738 */ 2739 hierarchyStrategy?: TransitionHierarchyStrategy 2740} 2741 2742/** 2743 * Source and target are two matched elements during the geometry transition. 2744 * The animation starts at the source and ends at the target. 2745 * TransitionHierarchyStrategy enumeration defines how levels of source and target elements 2746 * would be changed in the hierarchy during the geometry transition. 2747 * 2748 * @enum { number } 2749 * @syscap SystemCapability.ArkUI.ArkUI.Full 2750 * @systemapi 2751 * @atomicservice 2752 * @since 12 2753 */ 2754/** 2755 * Source and target are two matched elements during the geometry transition. 2756 * The animation starts at the source and ends at the target. 2757 * TransitionHierarchyStrategy enumeration defines how levels of source and target elements 2758 * would be changed in the hierarchy during the geometry transition. 2759 * 2760 * @enum { number } 2761 * @syscap SystemCapability.ArkUI.ArkUI.Full 2762 * @systemapi 2763 * @since 13 2764 */ 2765declare enum TransitionHierarchyStrategy { 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 * @atomicservice 2773 * @since 12 2774 */ 2775 /** 2776 * None mode. 2777 * Source and target staty in the original level in the hierarchy during geometry transition. 2778 * 2779 * @syscap SystemCapability.ArkUI.ArkUI.Full 2780 * @systemapi 2781 * @since 13 2782 */ 2783 NONE = 0, 2784 2785 /** 2786 * ADAPTIVE mode. 2787 * Lower level one of source and target is elevated to higher level of both, 2788 * indicating that two elements are in same high level. 2789 * 2790 * @syscap SystemCapability.ArkUI.ArkUI.Full 2791 * @systemapi 2792 * @atomicservice 2793 * @since 12 2794 */ 2795 /** 2796 * ADAPTIVE mode. 2797 * Lower level one of source and target is elevated to higher level of both, 2798 * indicating that two elements are in same high level. 2799 * 2800 * @syscap SystemCapability.ArkUI.ArkUI.Full 2801 * @systemapi 2802 * @since 13 2803 */ 2804 ADAPTIVE = 1, 2805} 2806 2807/** 2808 * Defines the options of translate. 2809 * 2810 * @interface TranslateOptions 2811 * @syscap SystemCapability.ArkUI.ArkUI.Full 2812 * @since 7 2813 */ 2814/** 2815 * Defines the options of translate. 2816 * 2817 * @interface TranslateOptions 2818 * @syscap SystemCapability.ArkUI.ArkUI.Full 2819 * @form 2820 * @since 9 2821 */ 2822/** 2823 * Defines the options of translate. 2824 * 2825 * @interface TranslateOptions 2826 * @syscap SystemCapability.ArkUI.ArkUI.Full 2827 * @crossplatform 2828 * @form 2829 * @since 10 2830 */ 2831/** 2832 * Defines the options of translate. 2833 * 2834 * @interface TranslateOptions 2835 * @syscap SystemCapability.ArkUI.ArkUI.Full 2836 * @crossplatform 2837 * @form 2838 * @atomicservice 2839 * @since 11 2840 */ 2841declare interface TranslateOptions { 2842 /** 2843 * The param of x direction. 2844 * 2845 * @type { ?(number | string) } 2846 * @syscap SystemCapability.ArkUI.ArkUI.Full 2847 * @since 7 2848 */ 2849 /** 2850 * The param of x direction. 2851 * 2852 * @type { ?(number | string) } 2853 * @syscap SystemCapability.ArkUI.ArkUI.Full 2854 * @form 2855 * @since 9 2856 */ 2857 /** 2858 * The param of x direction. 2859 * 2860 * @type { ?(number | string) } 2861 * @syscap SystemCapability.ArkUI.ArkUI.Full 2862 * @crossplatform 2863 * @form 2864 * @since 10 2865 */ 2866 /** 2867 * The param of x direction. 2868 * 2869 * @type { ?(number | string) } 2870 * @syscap SystemCapability.ArkUI.ArkUI.Full 2871 * @crossplatform 2872 * @form 2873 * @atomicservice 2874 * @since 11 2875 */ 2876 x?: number | string; 2877 2878 /** 2879 * The param of y direction. 2880 * 2881 * @type { ?(number | string) } 2882 * @syscap SystemCapability.ArkUI.ArkUI.Full 2883 * @since 7 2884 */ 2885 /** 2886 * The param of y direction. 2887 * 2888 * @type { ?(number | string) } 2889 * @syscap SystemCapability.ArkUI.ArkUI.Full 2890 * @form 2891 * @since 9 2892 */ 2893 /** 2894 * The param of y direction. 2895 * 2896 * @type { ?(number | string) } 2897 * @syscap SystemCapability.ArkUI.ArkUI.Full 2898 * @crossplatform 2899 * @form 2900 * @since 10 2901 */ 2902 /** 2903 * The param of y direction. 2904 * 2905 * @type { ?(number | string) } 2906 * @syscap SystemCapability.ArkUI.ArkUI.Full 2907 * @crossplatform 2908 * @form 2909 * @atomicservice 2910 * @since 11 2911 */ 2912 y?: number | string; 2913 2914 /** 2915 * The param of z direction. 2916 * 2917 * @type { ?(number | string) } 2918 * @syscap SystemCapability.ArkUI.ArkUI.Full 2919 * @since 7 2920 */ 2921 /** 2922 * The param of z direction. 2923 * 2924 * @type { ?(number | string) } 2925 * @syscap SystemCapability.ArkUI.ArkUI.Full 2926 * @form 2927 * @since 9 2928 */ 2929 /** 2930 * The param of z direction. 2931 * 2932 * @type { ?(number | string) } 2933 * @syscap SystemCapability.ArkUI.ArkUI.Full 2934 * @crossplatform 2935 * @form 2936 * @since 10 2937 */ 2938 /** 2939 * The param of z direction. 2940 * 2941 * @type { ?(number | string) } 2942 * @syscap SystemCapability.ArkUI.ArkUI.Full 2943 * @crossplatform 2944 * @form 2945 * @atomicservice 2946 * @since 11 2947 */ 2948 z?: number | string; 2949} 2950 2951/** 2952 * Defines the options of scale. 2953 * 2954 * @interface ScaleOptions 2955 * @syscap SystemCapability.ArkUI.ArkUI.Full 2956 * @since 7 2957 */ 2958/** 2959 * Defines the options of scale. 2960 * 2961 * @interface ScaleOptions 2962 * @syscap SystemCapability.ArkUI.ArkUI.Full 2963 * @form 2964 * @since 9 2965 */ 2966/** 2967 * Defines the options of scale. 2968 * 2969 * @interface ScaleOptions 2970 * @syscap SystemCapability.ArkUI.ArkUI.Full 2971 * @crossplatform 2972 * @form 2973 * @since 10 2974 */ 2975/** 2976 * Defines the options of scale. 2977 * 2978 * @interface ScaleOptions 2979 * @syscap SystemCapability.ArkUI.ArkUI.Full 2980 * @crossplatform 2981 * @form 2982 * @atomicservice 2983 * @since 11 2984 */ 2985declare interface ScaleOptions { 2986 /** 2987 * The param of x direction. 2988 * 2989 * @type { ?number } 2990 * @syscap SystemCapability.ArkUI.ArkUI.Full 2991 * @since 7 2992 */ 2993 /** 2994 * The param of x direction. 2995 * 2996 * @type { ?number } 2997 * @syscap SystemCapability.ArkUI.ArkUI.Full 2998 * @form 2999 * @since 9 3000 */ 3001 /** 3002 * The param of x direction. 3003 * 3004 * @type { ?number } 3005 * @syscap SystemCapability.ArkUI.ArkUI.Full 3006 * @crossplatform 3007 * @form 3008 * @since 10 3009 */ 3010 /** 3011 * The param of x direction. 3012 * 3013 * @type { ?number } 3014 * @syscap SystemCapability.ArkUI.ArkUI.Full 3015 * @crossplatform 3016 * @form 3017 * @atomicservice 3018 * @since 11 3019 */ 3020 x?: number; 3021 3022 /** 3023 * The param of y direction. 3024 * 3025 * @type { ?number } 3026 * @syscap SystemCapability.ArkUI.ArkUI.Full 3027 * @since 7 3028 */ 3029 /** 3030 * The param of y direction. 3031 * 3032 * @type { ?number } 3033 * @syscap SystemCapability.ArkUI.ArkUI.Full 3034 * @form 3035 * @since 9 3036 */ 3037 /** 3038 * The param of y direction. 3039 * 3040 * @type { ?number } 3041 * @syscap SystemCapability.ArkUI.ArkUI.Full 3042 * @crossplatform 3043 * @form 3044 * @since 10 3045 */ 3046 /** 3047 * The param of y direction. 3048 * 3049 * @type { ?number } 3050 * @syscap SystemCapability.ArkUI.ArkUI.Full 3051 * @crossplatform 3052 * @form 3053 * @atomicservice 3054 * @since 11 3055 */ 3056 y?: number; 3057 3058 /** 3059 * The param of z direction. 3060 * 3061 * @type { ?number } 3062 * @syscap SystemCapability.ArkUI.ArkUI.Full 3063 * @since 7 3064 */ 3065 /** 3066 * The param of z direction. 3067 * 3068 * @type { ?number } 3069 * @syscap SystemCapability.ArkUI.ArkUI.Full 3070 * @form 3071 * @since 9 3072 */ 3073 /** 3074 * The param of z direction. 3075 * 3076 * @type { ?number } 3077 * @syscap SystemCapability.ArkUI.ArkUI.Full 3078 * @crossplatform 3079 * @form 3080 * @since 10 3081 */ 3082 /** 3083 * The param of z direction. 3084 * 3085 * @type { ?number } 3086 * @syscap SystemCapability.ArkUI.ArkUI.Full 3087 * @crossplatform 3088 * @form 3089 * @atomicservice 3090 * @since 11 3091 */ 3092 z?: number; 3093 3094 /** 3095 * The param of center point of x. 3096 * 3097 * @type { ?(number | string) } 3098 * @syscap SystemCapability.ArkUI.ArkUI.Full 3099 * @since 7 3100 */ 3101 /** 3102 * The param of center point of x. 3103 * 3104 * @type { ?(number | string) } 3105 * @syscap SystemCapability.ArkUI.ArkUI.Full 3106 * @form 3107 * @since 9 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 * @since 10 3117 */ 3118 /** 3119 * The param of center point of x. 3120 * 3121 * @type { ?(number | string) } 3122 * @syscap SystemCapability.ArkUI.ArkUI.Full 3123 * @crossplatform 3124 * @form 3125 * @atomicservice 3126 * @since 11 3127 */ 3128 centerX?: number | string; 3129 3130 /** 3131 * The param of center point of y. 3132 * 3133 * @type { ?(number | string) } 3134 * @syscap SystemCapability.ArkUI.ArkUI.Full 3135 * @since 7 3136 */ 3137 /** 3138 * The param of center point of y. 3139 * 3140 * @type { ?(number | string) } 3141 * @syscap SystemCapability.ArkUI.ArkUI.Full 3142 * @form 3143 * @since 9 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 * @since 10 3153 */ 3154 /** 3155 * The param of center point of y. 3156 * 3157 * @type { ?(number | string) } 3158 * @syscap SystemCapability.ArkUI.ArkUI.Full 3159 * @crossplatform 3160 * @form 3161 * @atomicservice 3162 * @since 11 3163 */ 3164 centerY?: number | string; 3165} 3166 3167/** 3168 * Defines the align rule options of relative container. 3169 * 3170 * @interface AlignRuleOption 3171 * @syscap SystemCapability.ArkUI.ArkUI.Full 3172 * @form 3173 * @since 9 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 * @since 10 3183 */ 3184/** 3185 * Defines the align rule options of relative container. 3186 * 3187 * @interface AlignRuleOption 3188 * @syscap SystemCapability.ArkUI.ArkUI.Full 3189 * @crossplatform 3190 * @form 3191 * @atomicservice 3192 * @since 11 3193 */ 3194declare interface AlignRuleOption { 3195 /** 3196 * The param of left align. 3197 * 3198 * @type { ?object } 3199 * @syscap SystemCapability.ArkUI.ArkUI.Full 3200 * @form 3201 * @since 9 3202 */ 3203 /** 3204 * The param of left align. 3205 * 3206 * @type { ?object } 3207 * @syscap SystemCapability.ArkUI.ArkUI.Full 3208 * @crossplatform 3209 * @form 3210 * @since 10 3211 */ 3212 /** 3213 * The param of left align. 3214 * 3215 * @type { ?object } 3216 * @syscap SystemCapability.ArkUI.ArkUI.Full 3217 * @crossplatform 3218 * @form 3219 * @atomicservice 3220 * @since 11 3221 */ 3222 left?: { anchor: string, align: HorizontalAlign }; 3223 3224 /** 3225 * The param of right align. 3226 * 3227 * @type { ?object } 3228 * @syscap SystemCapability.ArkUI.ArkUI.Full 3229 * @form 3230 * @since 9 3231 */ 3232 /** 3233 * The param of right align. 3234 * 3235 * @type { ?object } 3236 * @syscap SystemCapability.ArkUI.ArkUI.Full 3237 * @crossplatform 3238 * @form 3239 * @since 10 3240 */ 3241 /** 3242 * The param of right align. 3243 * 3244 * @type { ?object } 3245 * @syscap SystemCapability.ArkUI.ArkUI.Full 3246 * @crossplatform 3247 * @form 3248 * @atomicservice 3249 * @since 11 3250 */ 3251 right?: { anchor: string, align: HorizontalAlign }; 3252 3253 /** 3254 * The param of middle align. 3255 * 3256 * @type { ?object } 3257 * @syscap SystemCapability.ArkUI.ArkUI.Full 3258 * @form 3259 * @since 9 3260 */ 3261 /** 3262 * The param of middle align. 3263 * 3264 * @type { ?object } 3265 * @syscap SystemCapability.ArkUI.ArkUI.Full 3266 * @crossplatform 3267 * @form 3268 * @since 10 3269 */ 3270 /** 3271 * The param of middle align. 3272 * 3273 * @type { ?object } 3274 * @syscap SystemCapability.ArkUI.ArkUI.Full 3275 * @crossplatform 3276 * @form 3277 * @atomicservice 3278 * @since 11 3279 */ 3280 middle?: { anchor: string, align: HorizontalAlign }; 3281 3282 /** 3283 * The param of top align. 3284 * 3285 * @type { ?object } 3286 * @syscap SystemCapability.ArkUI.ArkUI.Full 3287 * @form 3288 * @since 9 3289 */ 3290 /** 3291 * The param of top align. 3292 * 3293 * @type { ?object } 3294 * @syscap SystemCapability.ArkUI.ArkUI.Full 3295 * @crossplatform 3296 * @form 3297 * @since 10 3298 */ 3299 /** 3300 * The param of top align. 3301 * 3302 * @type { ?object } 3303 * @syscap SystemCapability.ArkUI.ArkUI.Full 3304 * @crossplatform 3305 * @form 3306 * @atomicservice 3307 * @since 11 3308 */ 3309 top?: { anchor: string, align: VerticalAlign }; 3310 3311 /** 3312 * The param of bottom align. 3313 * 3314 * @type { ?object } 3315 * @syscap SystemCapability.ArkUI.ArkUI.Full 3316 * @form 3317 * @since 9 3318 */ 3319 /** 3320 * The param of bottom align. 3321 * 3322 * @type { ?object } 3323 * @syscap SystemCapability.ArkUI.ArkUI.Full 3324 * @form 3325 * @since 10 3326 */ 3327 /** 3328 * The param of bottom align. 3329 * 3330 * @type { ?object } 3331 * @syscap SystemCapability.ArkUI.ArkUI.Full 3332 * @form 3333 * @atomicservice 3334 * @since 11 3335 */ 3336 bottom?: { anchor: string, align: VerticalAlign }; 3337 3338 /** 3339 * The param of center align. 3340 * 3341 * @type { ?object } 3342 * @syscap SystemCapability.ArkUI.ArkUI.Full 3343 * @form 3344 * @since 9 3345 */ 3346 /** 3347 * The param of center align. 3348 * 3349 * @type { ?object } 3350 * @syscap SystemCapability.ArkUI.ArkUI.Full 3351 * @crossplatform 3352 * @form 3353 * @since 10 3354 */ 3355 /** 3356 * The param of center align. 3357 * 3358 * @type { ?object } 3359 * @syscap SystemCapability.ArkUI.ArkUI.Full 3360 * @crossplatform 3361 * @form 3362 * @atomicservice 3363 * @since 11 3364 */ 3365 center?: { anchor: string, align: VerticalAlign }; 3366 3367 /** 3368 * Defines the bias ratio in horizontal and vertical direction. 3369 * 3370 * @type { ?Bias } 3371 * @default {horizontal:0.5,vertical:0.5} 3372 * @syscap SystemCapability.ArkUI.ArkUI.Full 3373 * @crossplatform 3374 * @form 3375 * @since 11 3376 */ 3377 /** 3378 * Defines the bias ratio in horizontal and vertical direction. 3379 * 3380 * @type { ?Bias } 3381 * @default {horizontal:0.5,vertical:0.5} 3382 * @syscap SystemCapability.ArkUI.ArkUI.Full 3383 * @crossplatform 3384 * @form 3385 * @atomicservice 3386 * @since 12 3387 */ 3388 bias?: Bias; 3389} 3390 3391/** 3392 * Defines the localized horizontal align param of relative container. 3393 * 3394 * @interface LocalizedHorizontalAlignParam 3395 * @syscap SystemCapability.ArkUI.ArkUI.Full 3396 * @crossplatform 3397 * @atomicservice 3398 * @since 12 3399 */ 3400declare interface LocalizedHorizontalAlignParam { 3401 /** 3402 * The anchor of localized align param. 3403 * 3404 * @type { string } 3405 * @syscap SystemCapability.ArkUI.ArkUI.Full 3406 * @crossplatform 3407 * @atomicservice 3408 * @since 12 3409 */ 3410 anchor: string; 3411 3412 /** 3413 * The align of localized align param. 3414 * 3415 * @type { HorizontalAlign } 3416 * @syscap SystemCapability.ArkUI.ArkUI.Full 3417 * @crossplatform 3418 * @atomicservice 3419 * @since 12 3420 */ 3421 align: HorizontalAlign; 3422} 3423 3424/** 3425 * Defines the localized vertical align param of relative container. 3426 * 3427 * @interface LocalizedVerticalAlignParam 3428 * @syscap SystemCapability.ArkUI.ArkUI.Full 3429 * @crossplatform 3430 * @atomicservice 3431 * @since 12 3432 */ 3433declare interface LocalizedVerticalAlignParam { 3434 /** 3435 * The anchor of localized align param. 3436 * 3437 * @type { string } 3438 * @syscap SystemCapability.ArkUI.ArkUI.Full 3439 * @crossplatform 3440 * @atomicservice 3441 * @since 12 3442 */ 3443 anchor: string; 3444 3445 /** 3446 * The align of localized align param. 3447 * 3448 * @type { VerticalAlign } 3449 * @syscap SystemCapability.ArkUI.ArkUI.Full 3450 * @crossplatform 3451 * @atomicservice 3452 * @since 12 3453 */ 3454 align: VerticalAlign; 3455} 3456 3457/** 3458 * Defines the Localized align rule options of relative container. 3459 * 3460 * @interface LocalizedAlignRuleOptions 3461 * @syscap SystemCapability.ArkUI.ArkUI.Full 3462 * @crossplatform 3463 * @atomicservice 3464 * @since 12 3465 */ 3466declare interface LocalizedAlignRuleOptions { 3467 /** 3468 * The param of start align. 3469 * 3470 * @type { ?LocalizedHorizontalAlignParam } 3471 * @syscap SystemCapability.ArkUI.ArkUI.Full 3472 * @crossplatform 3473 * @atomicservice 3474 * @since 12 3475 */ 3476 start?: LocalizedHorizontalAlignParam; 3477 3478 /** 3479 * The param of end align. 3480 * 3481 * @type { ?LocalizedHorizontalAlignParam } 3482 * @syscap SystemCapability.ArkUI.ArkUI.Full 3483 * @crossplatform 3484 * @atomicservice 3485 * @since 12 3486 */ 3487 end?: LocalizedHorizontalAlignParam; 3488 3489 /** 3490 * The param of middle align. 3491 * 3492 * @type { ?LocalizedHorizontalAlignParam } 3493 * @syscap SystemCapability.ArkUI.ArkUI.Full 3494 * @crossplatform 3495 * @atomicservice 3496 * @since 12 3497 */ 3498 middle?: LocalizedHorizontalAlignParam; 3499 3500 /** 3501 * The param of top align. 3502 * 3503 * @type { ?LocalizedVerticalAlignParam } 3504 * @syscap SystemCapability.ArkUI.ArkUI.Full 3505 * @crossplatform 3506 * @atomicservice 3507 * @since 12 3508 */ 3509 top?: LocalizedVerticalAlignParam; 3510 3511 /** 3512 * The param of bottom align. 3513 * 3514 * @type { ?LocalizedVerticalAlignParam } 3515 * @syscap SystemCapability.ArkUI.ArkUI.Full 3516 * @crossplatform 3517 * @atomicservice 3518 * @since 12 3519 */ 3520 bottom?: LocalizedVerticalAlignParam; 3521 3522 /** 3523 * The param of center align. 3524 * 3525 * @type { ?LocalizedVerticalAlignParam } 3526 * @syscap SystemCapability.ArkUI.ArkUI.Full 3527 * @crossplatform 3528 * @atomicservice 3529 * @since 12 3530 */ 3531 center?: LocalizedVerticalAlignParam; 3532 3533 /** 3534 * Defines the bias ratio in horizontal and vertical direction. 3535 * 3536 * @type { ?Bias } 3537 * @default {horizontal:0.5,vertical:0.5} 3538 * @syscap SystemCapability.ArkUI.ArkUI.Full 3539 * @crossplatform 3540 * @atomicservice 3541 * @since 12 3542 */ 3543 bias?: Bias; 3544} 3545 3546/** 3547 * Defines the style of the chain in relative container. 3548 * 3549 * @enum { number } 3550 * @syscap SystemCapability.ArkUI.ArkUI.Full 3551 * @crossplatform 3552 * @atomicservice 3553 * @since 12 3554 */ 3555declare enum ChainStyle { 3556 /** 3557 * Elements of the chain will be spread out. 3558 * 3559 * @syscap SystemCapability.ArkUI.ArkUI.Full 3560 * @crossplatform 3561 * @atomicservice 3562 * @since 12 3563 */ 3564 SPREAD, 3565 3566 /** 3567 * Elements except chain's head and tail will be spread out. 3568 * 3569 * @syscap SystemCapability.ArkUI.ArkUI.Full 3570 * @crossplatform 3571 * @atomicservice 3572 * @since 12 3573 */ 3574 SPREAD_INSIDE, 3575 3576 /** 3577 * Elements of the chain will be packed together. 3578 * 3579 * @syscap SystemCapability.ArkUI.ArkUI.Full 3580 * @crossplatform 3581 * @atomicservice 3582 * @since 12 3583 */ 3584 PACKED, 3585} 3586 3587/** 3588 * The param of rotate. 3589 * 3590 * @interface RotateOptions 3591 * @syscap SystemCapability.ArkUI.ArkUI.Full 3592 * @since 7 3593 */ 3594/** 3595 * The param of rotate. 3596 * 3597 * @interface RotateOptions 3598 * @syscap SystemCapability.ArkUI.ArkUI.Full 3599 * @form 3600 * @since 9 3601 */ 3602/** 3603 * The param of rotate. 3604 * 3605 * @interface RotateOptions 3606 * @syscap SystemCapability.ArkUI.ArkUI.Full 3607 * @crossplatform 3608 * @form 3609 * @since 10 3610 */ 3611/** 3612 * The param of rotate. 3613 * 3614 * @interface RotateOptions 3615 * @syscap SystemCapability.ArkUI.ArkUI.Full 3616 * @crossplatform 3617 * @form 3618 * @atomicservice 3619 * @since 11 3620 */ 3621declare interface RotateOptions { 3622 /** 3623 * The param of x direction. 3624 * 3625 * @type { ?number } 3626 * @syscap SystemCapability.ArkUI.ArkUI.Full 3627 * @since 7 3628 */ 3629 /** 3630 * The param of x direction. 3631 * 3632 * @type { ?number } 3633 * @syscap SystemCapability.ArkUI.ArkUI.Full 3634 * @form 3635 * @since 9 3636 */ 3637 /** 3638 * The param of x direction. 3639 * 3640 * @type { ?number } 3641 * @syscap SystemCapability.ArkUI.ArkUI.Full 3642 * @crossplatform 3643 * @form 3644 * @since 10 3645 */ 3646 /** 3647 * The param of x direction. 3648 * 3649 * @type { ?number } 3650 * @syscap SystemCapability.ArkUI.ArkUI.Full 3651 * @crossplatform 3652 * @form 3653 * @atomicservice 3654 * @since 11 3655 */ 3656 x?: number; 3657 3658 /** 3659 * The param of y direction. 3660 * 3661 * @type { ?number } 3662 * @syscap SystemCapability.ArkUI.ArkUI.Full 3663 * @since 7 3664 */ 3665 /** 3666 * The param of y direction. 3667 * 3668 * @type { ?number } 3669 * @syscap SystemCapability.ArkUI.ArkUI.Full 3670 * @form 3671 * @since 9 3672 */ 3673 /** 3674 * The param of y direction. 3675 * 3676 * @type { ?number } 3677 * @syscap SystemCapability.ArkUI.ArkUI.Full 3678 * @crossplatform 3679 * @form 3680 * @since 10 3681 */ 3682 /** 3683 * The param of y direction. 3684 * 3685 * @type { ?number } 3686 * @syscap SystemCapability.ArkUI.ArkUI.Full 3687 * @crossplatform 3688 * @form 3689 * @atomicservice 3690 * @since 11 3691 */ 3692 y?: number; 3693 3694 /** 3695 * The param of z direction. 3696 * 3697 * @type { ?number } 3698 * @syscap SystemCapability.ArkUI.ArkUI.Full 3699 * @since 7 3700 */ 3701 /** 3702 * The param of z direction. 3703 * 3704 * @type { ?number } 3705 * @syscap SystemCapability.ArkUI.ArkUI.Full 3706 * @form 3707 * @since 9 3708 */ 3709 /** 3710 * The param of z direction. 3711 * 3712 * @type { ?number } 3713 * @syscap SystemCapability.ArkUI.ArkUI.Full 3714 * @crossplatform 3715 * @form 3716 * @since 10 3717 */ 3718 /** 3719 * The param of z direction. 3720 * 3721 * @type { ?number } 3722 * @syscap SystemCapability.ArkUI.ArkUI.Full 3723 * @crossplatform 3724 * @form 3725 * @atomicservice 3726 * @since 11 3727 */ 3728 z?: number; 3729 3730 /** 3731 * The param of center point of x. 3732 * 3733 * @type { ?(number | string) } 3734 * @syscap SystemCapability.ArkUI.ArkUI.Full 3735 * @since 7 3736 */ 3737 /** 3738 * The param of center point of x. 3739 * 3740 * @type { ?(number | string) } 3741 * @syscap SystemCapability.ArkUI.ArkUI.Full 3742 * @form 3743 * @since 9 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 * @since 10 3753 */ 3754 /** 3755 * The param of center point of x. 3756 * 3757 * @type { ?(number | string) } 3758 * @syscap SystemCapability.ArkUI.ArkUI.Full 3759 * @crossplatform 3760 * @form 3761 * @atomicservice 3762 * @since 11 3763 */ 3764 centerX?: number | string; 3765 3766 /** 3767 * The param of center point of y. 3768 * 3769 * @type { ?(number | string) } 3770 * @syscap SystemCapability.ArkUI.ArkUI.Full 3771 * @since 7 3772 */ 3773 /** 3774 * The param of center point of y. 3775 * 3776 * @type { ?(number | string) } 3777 * @syscap SystemCapability.ArkUI.ArkUI.Full 3778 * @since 9 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 * @since 10 3788 */ 3789 /** 3790 * The param of center point of y. 3791 * 3792 * @type { ?(number | string) } 3793 * @syscap SystemCapability.ArkUI.ArkUI.Full 3794 * @crossplatform 3795 * @form 3796 * @atomicservice 3797 * @since 11 3798 */ 3799 centerY?: number | string; 3800 3801 /** 3802 * The param of center point of z. 3803 * 3804 * @type { ?number } 3805 * @default 0 3806 * @syscap SystemCapability.ArkUI.ArkUI.Full 3807 * @crossplatform 3808 * @form 3809 * @since 10 3810 */ 3811 /** 3812 * The param of center point of z. 3813 * 3814 * @type { ?number } 3815 * @default 0 3816 * @syscap SystemCapability.ArkUI.ArkUI.Full 3817 * @crossplatform 3818 * @form 3819 * @atomicservice 3820 * @since 11 3821 */ 3822 centerZ?: number; 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 * @since 10 3832 */ 3833 /** 3834 * The param of camera distance, value range (-∞, ∞). 3835 * @type { ?number } 3836 * @default 0 3837 * @syscap SystemCapability.ArkUI.ArkUI.Full 3838 * @crossplatform 3839 * @form 3840 * @atomicservice 3841 * @since 11 3842 */ 3843 perspective?: number; 3844 3845 /** 3846 * The param of angle. 3847 * 3848 * @type { number | string } 3849 * @syscap SystemCapability.ArkUI.ArkUI.Full 3850 * @since 7 3851 */ 3852 /** 3853 * The param of angle. 3854 * 3855 * @type { number | string } 3856 * @syscap SystemCapability.ArkUI.ArkUI.Full 3857 * @form 3858 * @since 9 3859 */ 3860 /** 3861 * The param of angle. 3862 * 3863 * @type { number | string } 3864 * @syscap SystemCapability.ArkUI.ArkUI.Full 3865 * @crossplatform 3866 * @form 3867 * @since 10 3868 */ 3869 /** 3870 * The param of angle. 3871 * 3872 * @type { number | string } 3873 * @syscap SystemCapability.ArkUI.ArkUI.Full 3874 * @crossplatform 3875 * @form 3876 * @atomicservice 3877 * @since 11 3878 */ 3879 angle: number | string; 3880} 3881 3882/** 3883 * Defines the param of transition. 3884 * 3885 * @interface TransitionOptions 3886 * @syscap SystemCapability.ArkUI.ArkUI.Full 3887 * @since 7 3888 * @deprecated since 10 3889 * @useinstead TransitionEffect 3890 */ 3891declare interface TransitionOptions { 3892 /** 3893 * Defines the param of type. 3894 * 3895 * @type { ?TransitionType } 3896 * @syscap SystemCapability.ArkUI.ArkUI.Full 3897 * @since 7 3898 * @deprecated since 10 3899 */ 3900 type?: TransitionType; 3901 /** 3902 * Defines the param of opacity. 3903 * 3904 * @type { ?number } 3905 * @syscap SystemCapability.ArkUI.ArkUI.Full 3906 * @since 7 3907 * @deprecated since 10 3908 */ 3909 opacity?: number; 3910 /** 3911 * Defines the param of translate. 3912 * 3913 * @type { ?TranslateOptions } 3914 * @syscap SystemCapability.ArkUI.ArkUI.Full 3915 * @since 7 3916 * @deprecated since 10 3917 */ 3918 translate?: TranslateOptions; 3919 /** 3920 * Defines the param of scale. 3921 * 3922 * @type { ?ScaleOptions } 3923 * @syscap SystemCapability.ArkUI.ArkUI.Full 3924 * @since 7 3925 * @deprecated since 10 3926 */ 3927 scale?: ScaleOptions; 3928 /** 3929 * Defines the param of rotate. 3930 * 3931 * @type { ?RotateOptions } 3932 * @syscap SystemCapability.ArkUI.ArkUI.Full 3933 * @since 7 3934 * @deprecated since 10 3935 */ 3936 rotate?: RotateOptions; 3937} 3938 3939/** 3940 * Defines the Edge object. 3941 * 3942 * @enum { number } 3943 * @syscap SystemCapability.ArkUI.ArkUI.Full 3944 * @crossplatform 3945 * @form 3946 * @since 10 3947 */ 3948/** 3949 * Defines the Edge object. 3950 * 3951 * @enum { number } 3952 * @syscap SystemCapability.ArkUI.ArkUI.Full 3953 * @crossplatform 3954 * @form 3955 * @atomicservice 3956 * @since 11 3957 */ 3958declare enum TransitionEdge { 3959 /** 3960 * Top edge 3961 * 3962 * @syscap SystemCapability.ArkUI.ArkUI.Full 3963 * @crossplatform 3964 * @form 3965 * @since 10 3966 */ 3967 /** 3968 * Top edge 3969 * 3970 * @syscap SystemCapability.ArkUI.ArkUI.Full 3971 * @crossplatform 3972 * @form 3973 * @atomicservice 3974 * @since 11 3975 */ 3976 TOP, 3977 3978 /** 3979 * Bottom edge 3980 * 3981 * @syscap SystemCapability.ArkUI.ArkUI.Full 3982 * @crossplatform 3983 * @form 3984 * @since 10 3985 */ 3986 /** 3987 * Bottom edge 3988 * 3989 * @syscap SystemCapability.ArkUI.ArkUI.Full 3990 * @crossplatform 3991 * @form 3992 * @atomicservice 3993 * @since 11 3994 */ 3995 BOTTOM, 3996 3997 /** 3998 * Start edge 3999 * 4000 * @syscap SystemCapability.ArkUI.ArkUI.Full 4001 * @crossplatform 4002 * @form 4003 * @since 10 4004 */ 4005 /** 4006 * Start edge 4007 * 4008 * @syscap SystemCapability.ArkUI.ArkUI.Full 4009 * @crossplatform 4010 * @form 4011 * @atomicservice 4012 * @since 11 4013 */ 4014 START, 4015 4016 /** 4017 * End edge 4018 * 4019 * @syscap SystemCapability.ArkUI.ArkUI.Full 4020 * @crossplatform 4021 * @form 4022 * @since 10 4023 */ 4024 /** 4025 * End edge 4026 * 4027 * @syscap SystemCapability.ArkUI.ArkUI.Full 4028 * @crossplatform 4029 * @form 4030 * @atomicservice 4031 * @since 11 4032 */ 4033 END 4034} 4035 4036/** 4037 * Defines all transition effects. 4038 * 4039 * @typedef { object } TransitionEffects 4040 * @syscap SystemCapability.ArkUI.ArkUI.Full 4041 * @crossplatform 4042 * @form 4043 * @since 10 4044 */ 4045/** 4046 * Defines all transition effects. 4047 * 4048 * @typedef { object } TransitionEffects 4049 * @syscap SystemCapability.ArkUI.ArkUI.Full 4050 * @crossplatform 4051 * @form 4052 * @atomicservice 4053 * @since 11 4054 */ 4055declare type TransitionEffects = { 4056 identity: undefined; 4057 opacity: number; 4058 slideSwitch: undefined; 4059 move: TransitionEdge; 4060 translate: TranslateOptions; 4061 rotate: RotateOptions; 4062 scale: ScaleOptions; 4063 asymmetric: { 4064 appear: TransitionEffect; 4065 disappear: TransitionEffect; 4066 }; 4067}; 4068 4069/** 4070 * Defined the draw modifier of node. Provides draw callbacks for the associated Node. 4071 * 4072 * @syscap SystemCapability.ArkUI.ArkUI.Full 4073 * @crossplatform 4074 * @atomicservice 4075 * @since 12 4076 */ 4077declare class DrawModifier { 4078 /** 4079 * drawBehind Method. Executed before drawing associated Node. 4080 * 4081 * @param { DrawContext } drawContext - The drawContext used to draw. 4082 * @syscap SystemCapability.ArkUI.ArkUI.Full 4083 * @crossplatform 4084 * @atomicservice 4085 * @since 12 4086 */ 4087 drawBehind?(drawContext: DrawContext): void; 4088 4089 /** 4090 * drawContent Method. Executed when associated Node is drawing, the default drawContent method will be replaced 4091 * if this method is set. 4092 * 4093 * @param { DrawContext } drawContext - The drawContext used to draw. 4094 * @syscap SystemCapability.ArkUI.ArkUI.Full 4095 * @crossplatform 4096 * @atomicservice 4097 * @since 12 4098 */ 4099 drawContent?(drawContext: DrawContext): void; 4100 4101 /** 4102 * drawFront Method. Executed after drawing associated Node. 4103 * 4104 * @param { DrawContext } drawContext - The drawContext used to draw. 4105 * @syscap SystemCapability.ArkUI.ArkUI.Full 4106 * @crossplatform 4107 * @atomicservice 4108 * @since 12 4109 */ 4110 drawFront?(drawContext: DrawContext): void; 4111 4112 /** 4113 * Invalidate the component, which will cause a re-render of the component. 4114 * 4115 * @syscap SystemCapability.ArkUI.ArkUI.Full 4116 * @crossplatform 4117 * @atomicservice 4118 * @since 12 4119 */ 4120 invalidate(): void; 4121} 4122 4123/** 4124 * Defines the transition effect 4125 * 4126 * @syscap SystemCapability.ArkUI.ArkUI.Full 4127 * @crossplatform 4128 * @form 4129 * @since 10 4130 */ 4131/** 4132 * Defines the transition effect 4133 * 4134 * @syscap SystemCapability.ArkUI.ArkUI.Full 4135 * @crossplatform 4136 * @form 4137 * @atomicservice 4138 * @since 11 4139 */ 4140declare class TransitionEffect< 4141 Type extends keyof TransitionEffects = keyof TransitionEffects, 4142 Effect extends TransitionEffects[Type] = TransitionEffects[Type] 4143> { 4144 /** 4145 * Disables the transition effect 4146 * 4147 * @type { TransitionEffect<"identity"> } 4148 * @readonly 4149 * @static 4150 * @syscap SystemCapability.ArkUI.ArkUI.Full 4151 * @crossplatform 4152 * @form 4153 * @since 10 4154 */ 4155 /** 4156 * Disables the transition effect 4157 * 4158 * @type { TransitionEffect<"identity"> } 4159 * @readonly 4160 * @static 4161 * @syscap SystemCapability.ArkUI.ArkUI.Full 4162 * @crossplatform 4163 * @form 4164 * @atomicservice 4165 * @since 11 4166 */ 4167 static readonly IDENTITY: TransitionEffect<"identity">; 4168 4169 /** 4170 * Specifies a transition effect with transparency of 0, which is equivalent to TransitionEffect.opacity(0). 4171 * 4172 * @type { TransitionEffect<"opacity"> } 4173 * @readonly 4174 * @static 4175 * @syscap SystemCapability.ArkUI.ArkUI.Full 4176 * @crossplatform 4177 * @form 4178 * @since 10 4179 */ 4180 /** 4181 * Specifies a transition effect with transparency of 0, which is equivalent to TransitionEffect.opacity(0). 4182 * 4183 * @type { TransitionEffect<"opacity"> } 4184 * @readonly 4185 * @static 4186 * @syscap SystemCapability.ArkUI.ArkUI.Full 4187 * @crossplatform 4188 * @form 4189 * @atomicservice 4190 * @since 11 4191 */ 4192 static readonly OPACITY: TransitionEffect<"opacity">; 4193 4194 /** 4195 * Defines a slide transition effect 4196 * 4197 * @type { TransitionEffect< 4198 * "asymmetric", 4199 * {appear: TransitionEffect<"move", TransitionEdge>; 4200 * disappear: TransitionEffect<"move", TransitionEdge>; 4201 * }> } 4202 * @readonly 4203 * @static 4204 * @syscap SystemCapability.ArkUI.ArkUI.Full 4205 * @crossplatform 4206 * @form 4207 * @since 10 4208 */ 4209 /** 4210 * Defines a slide transition effect 4211 * 4212 * @type { TransitionEffect< 4213 * "asymmetric", 4214 * {appear: TransitionEffect<"move", TransitionEdge>; 4215 * disappear: TransitionEffect<"move", TransitionEdge>; 4216 * }> } 4217 * @readonly 4218 * @static 4219 * @syscap SystemCapability.ArkUI.ArkUI.Full 4220 * @crossplatform 4221 * @form 4222 * @atomicservice 4223 * @since 11 4224 */ 4225 static readonly SLIDE: TransitionEffect< 4226 "asymmetric", 4227 { 4228 appear: TransitionEffect<"move", TransitionEdge>; 4229 disappear: TransitionEffect<"move", TransitionEdge>; 4230 } 4231 >; 4232 4233 /** 4234 * Specify a transition effect where the element enters by shrinking first and then expanding as it slides in from the right, 4235 * and exits by shrinking first and then expanding as it slides out to the left, with a minimum scale ratio of 0.8. 4236 * It comes with default animation parameters, which can also be overridden. 4237 * The default animation duration is set to 600ms, and the specified animation curve is cubicBezierCurve(0.24, 0.0, 0.50, 1.0). 4238 * 4239 * @type { TransitionEffect<"slideSwitch"> } 4240 * @readonly 4241 * @static 4242 * @syscap SystemCapability.ArkUI.ArkUI.Full 4243 * @crossplatform 4244 * @form 4245 * @since 10 4246 */ 4247 /** 4248 * Specify a transition effect where the element enters by shrinking first and then expanding as it slides in from the right, 4249 * and exits by shrinking first and then expanding as it slides out to the left, with a minimum scale ratio of 0.8. 4250 * It comes with default animation parameters, which can also be overridden. 4251 * The default animation duration is set to 600ms, and the specified animation curve is cubicBezierCurve(0.24, 0.0, 0.50, 1.0). 4252 * 4253 * @type { TransitionEffect<"slideSwitch"> } 4254 * @readonly 4255 * @static 4256 * @syscap SystemCapability.ArkUI.ArkUI.Full 4257 * @crossplatform 4258 * @form 4259 * @atomicservice 4260 * @since 11 4261 */ 4262 static readonly SLIDE_SWITCH: TransitionEffect<"slideSwitch">; 4263 4264 /** 4265 * Creates a translate transition effect 4266 * 4267 * @param { TranslateOptions } options - translate options 4268 * @returns { TransitionEffect<"translate"> } 4269 * @syscap SystemCapability.ArkUI.ArkUI.Full 4270 * @crossplatform 4271 * @form 4272 * @since 10 4273 */ 4274 /** 4275 * Creates a translate transition effect 4276 * 4277 * @param { TranslateOptions } options - translate options 4278 * @returns { TransitionEffect<"translate"> } 4279 * @syscap SystemCapability.ArkUI.ArkUI.Full 4280 * @crossplatform 4281 * @form 4282 * @atomicservice 4283 * @since 11 4284 */ 4285 static translate(options: TranslateOptions): TransitionEffect<"translate">; 4286 4287 /** 4288 * Creates a rotation transition effect 4289 * 4290 * @param { RotateOptions } options - rotate options 4291 * Set the rotation effect for component transitions when inserting and deleting. 4292 * The value represents the starting rotation point for the inserting animation and the ending rotation point for the deleting animation. 4293 * -x: Horizontal component of the rotational vector. 4294 * -y: Vertical component of the rotational vector. 4295 * -z: Vertical component of the rotational vector. 4296 * -centerX, centerY specify the rotation center point, with default values of "50%", 4297 * meaning that the default rotation center point is the center point of the component. 4298 * -The center point of (0, 0) represents the upper-left corner of the component. 4299 * -centerZ refers to the Z-axis anchor point. The default value of centerZ is 0. 4300 * -perspective indicates the visual distance. The perspective property does not support transition animation. 4301 * @returns { TransitionEffect<"rotate"> } 4302 * @syscap SystemCapability.ArkUI.ArkUI.Full 4303 * @crossplatform 4304 * @form 4305 * @since 10 4306 */ 4307 /** 4308 * Creates a rotation transition effect 4309 * 4310 * @param { RotateOptions } options - rotate options 4311 * Set the rotation effect for component transitions when inserting and deleting. 4312 * The value represents the starting rotation point for the inserting animation and the ending rotation point for the deleting animation. 4313 * -x: Horizontal component of the rotational vector. 4314 * -y: Vertical component of the rotational vector. 4315 * -z: Vertical component of the rotational vector. 4316 * -centerX, centerY specify the rotation center point, with default values of "50%", 4317 * meaning that the default rotation center point is the center point of the component. 4318 * -The center point of (0, 0) represents the upper-left corner of the component. 4319 * -centerZ refers to the Z-axis anchor point. The default value of centerZ is 0. 4320 * -perspective indicates the visual distance. The perspective property does not support transition animation. 4321 * @returns { TransitionEffect<"rotate"> } 4322 * @syscap SystemCapability.ArkUI.ArkUI.Full 4323 * @crossplatform 4324 * @form 4325 * @atomicservice 4326 * @since 11 4327 */ 4328 static rotate(options: RotateOptions): TransitionEffect<"rotate">; 4329 4330 /** 4331 * Creates a scale transition effect 4332 * 4333 * @param { ScaleOptions } options - scale options 4334 * @returns { TransitionEffect<"scale"> } 4335 * @syscap SystemCapability.ArkUI.ArkUI.Full 4336 * @crossplatform 4337 * @form 4338 * @since 10 4339 */ 4340 /** 4341 * Creates a scale transition effect 4342 * 4343 * @param { ScaleOptions } options - scale options 4344 * @returns { TransitionEffect<"scale"> } 4345 * @syscap SystemCapability.ArkUI.ArkUI.Full 4346 * @crossplatform 4347 * @form 4348 * @atomicservice 4349 * @since 11 4350 */ 4351 static scale(options: ScaleOptions): TransitionEffect<"scale">; 4352 4353 /** 4354 * Creates an opacity transition effect with alpha value 4355 * 4356 * @param { number } alpha - opacity alpha value, value range [0, 1]. 4357 * @returns { TransitionEffect<"opacity"> } 4358 * @syscap SystemCapability.ArkUI.ArkUI.Full 4359 * @crossplatform 4360 * @form 4361 * @since 10 4362 */ 4363 /** 4364 * Creates an opacity transition effect with alpha value 4365 * 4366 * @param { number } alpha - opacity alpha value, value range [0, 1]. 4367 * @returns { TransitionEffect<"opacity"> } 4368 * @syscap SystemCapability.ArkUI.ArkUI.Full 4369 * @crossplatform 4370 * @form 4371 * @atomicservice 4372 * @since 11 4373 */ 4374 /** 4375 * Creates an opacity transition effect with alpha value 4376 * 4377 * @param { number } alpha - opacity alpha value, value range [0, 1]. 4378 * Illegal values less than 0 are treated as 0, and illegal values greater than 1 are treated as 1. 4379 * @returns { TransitionEffect<"opacity"> } 4380 * @syscap SystemCapability.ArkUI.ArkUI.Full 4381 * @crossplatform 4382 * @form 4383 * @atomicservice 4384 * @since 12 4385 */ 4386 static opacity(alpha: number): TransitionEffect<"opacity">; 4387 4388 /** 4389 * Creates a move transition effect 4390 * 4391 * @param { TransitionEdge } edge - the edge that component will move to 4392 * @returns { TransitionEffect<"move"> } 4393 * @syscap SystemCapability.ArkUI.ArkUI.Full 4394 * @crossplatform 4395 * @form 4396 * @since 10 4397 */ 4398 /** 4399 * Creates a move transition effect 4400 * 4401 * @param { TransitionEdge } edge - the edge that component will move to 4402 * @returns { TransitionEffect<"move"> } 4403 * @syscap SystemCapability.ArkUI.ArkUI.Full 4404 * @crossplatform 4405 * @form 4406 * @atomicservice 4407 * @since 11 4408 */ 4409 static move(edge: TransitionEdge): TransitionEffect<"move">; 4410 4411 /** 4412 * Creates an asymmetric transition effect 4413 * 4414 * @param { TransitionEffect } appear - the transition which will be attached when the component is appear 4415 * @param { TransitionEffect } disappear - the transition which will be attached when the component is disappear 4416 * @returns { TransitionEffect<"asymmetric"> } 4417 * @syscap SystemCapability.ArkUI.ArkUI.Full 4418 * @crossplatform 4419 * @form 4420 * @since 10 4421 */ 4422 /** 4423 * Creates an asymmetric transition effect 4424 * 4425 * @param { TransitionEffect } appear - the transition which will be attached when the component is appear 4426 * @param { TransitionEffect } disappear - the transition which will be attached when the component is disappear 4427 * @returns { TransitionEffect<"asymmetric"> } 4428 * @syscap SystemCapability.ArkUI.ArkUI.Full 4429 * @crossplatform 4430 * @form 4431 * @atomicservice 4432 * @since 11 4433 */ 4434 static asymmetric( 4435 appear: TransitionEffect, 4436 disappear: TransitionEffect 4437 ): TransitionEffect<"asymmetric">; 4438 4439 /** 4440 * TransitionEffect constructor 4441 * 4442 * @param { Type } type - transition type 4443 * @param { Effect } effect - transition options 4444 * @syscap SystemCapability.ArkUI.ArkUI.Full 4445 * @crossplatform 4446 * @form 4447 * @since 10 4448 */ 4449 /** 4450 * TransitionEffect constructor 4451 * 4452 * @param { Type } type - transition type 4453 * @param { Effect } effect - transition options 4454 * @syscap SystemCapability.ArkUI.ArkUI.Full 4455 * @crossplatform 4456 * @form 4457 * @atomicservice 4458 * @since 11 4459 */ 4460 constructor(type: Type, effect: Effect); 4461 4462 /** 4463 * Set the animation of current transition effect 4464 * 4465 * @param { AnimateParam } value - animation parameters 4466 * @returns { TransitionEffect } 4467 * @syscap SystemCapability.ArkUI.ArkUI.Full 4468 * @crossplatform 4469 * @form 4470 * @since 10 4471 */ 4472 /** 4473 * Set the animation of current transition effect 4474 * 4475 * @param { AnimateParam } value - animation parameters 4476 * @returns { TransitionEffect } 4477 * @syscap SystemCapability.ArkUI.ArkUI.Full 4478 * @crossplatform 4479 * @form 4480 * @atomicservice 4481 * @since 11 4482 */ 4483 animation(value: AnimateParam): TransitionEffect; 4484 4485 /** 4486 * Combines another transition effect 4487 * 4488 * @param { TransitionEffect } transitionEffect - transition effect which is be combined 4489 * @returns { TransitionEffect } combined transition effect 4490 * @syscap SystemCapability.ArkUI.ArkUI.Full 4491 * @crossplatform 4492 * @form 4493 * @since 10 4494 */ 4495 /** 4496 * Combines another transition effect 4497 * 4498 * @param { TransitionEffect } transitionEffect - transition effect which is be combined 4499 * @returns { TransitionEffect } combined transition effect 4500 * @syscap SystemCapability.ArkUI.ArkUI.Full 4501 * @crossplatform 4502 * @form 4503 * @atomicservice 4504 * @since 11 4505 */ 4506 combine(transitionEffect: TransitionEffect): TransitionEffect; 4507} 4508 4509/** 4510 * Define Preview property 4511 * 4512 * @interface PreviewParams 4513 * @syscap SystemCapability.ArkUI.ArkUI.Full 4514 * @form 4515 * @since 9 4516 */ 4517/** 4518 * Define Preview property 4519 * 4520 * @interface PreviewParams 4521 * @syscap SystemCapability.ArkUI.ArkUI.Full 4522 * @crossplatform 4523 * @form 4524 * @atomicservice 4525 * @since 11 4526 */ 4527interface PreviewParams { 4528 /** 4529 * Define Preview title 4530 * 4531 * @type { ?string } 4532 * @syscap SystemCapability.ArkUI.ArkUI.Full 4533 * @form 4534 * @since 9 4535 */ 4536 /** 4537 * Define Preview title 4538 * 4539 * @type { ?string } 4540 * @syscap SystemCapability.ArkUI.ArkUI.Full 4541 * @crossplatform 4542 * @form 4543 * @atomicservice 4544 * @since 11 4545 */ 4546 title?: string; 4547 4548 /** 4549 * Define Preview width 4550 * 4551 * @type { ?number } 4552 * @syscap SystemCapability.ArkUI.ArkUI.Full 4553 * @form 4554 * @since 9 4555 */ 4556 /** 4557 * Define Preview width 4558 * 4559 * @type { ?number } 4560 * @syscap SystemCapability.ArkUI.ArkUI.Full 4561 * @crossplatform 4562 * @form 4563 * @atomicservice 4564 * @since 11 4565 */ 4566 width?: number; 4567 4568 /** 4569 * Define Preview height 4570 * 4571 * @type { ?number } 4572 * @syscap SystemCapability.ArkUI.ArkUI.Full 4573 * @form 4574 * @since 9 4575 */ 4576 /** 4577 * Define Preview height 4578 * 4579 * @type { ?number } 4580 * @syscap SystemCapability.ArkUI.ArkUI.Full 4581 * @crossplatform 4582 * @form 4583 * @atomicservice 4584 * @since 11 4585 */ 4586 height?: number; 4587 4588 /** 4589 * Define Preview locale 4590 * 4591 * @type { ?string } 4592 * @syscap SystemCapability.ArkUI.ArkUI.Full 4593 * @form 4594 * @since 9 4595 */ 4596 /** 4597 * Define Preview locale 4598 * 4599 * @type { ?string } 4600 * @syscap SystemCapability.ArkUI.ArkUI.Full 4601 * @form 4602 * @atomicservice 4603 * @since 11 4604 */ 4605 locale?: string; 4606 4607 /** 4608 * Define Preview colorMode 4609 * 4610 * @type { ?string } 4611 * @syscap SystemCapability.ArkUI.ArkUI.Full 4612 * @form 4613 * @since 9 4614 */ 4615 /** 4616 * Define Preview colorMode 4617 * 4618 * @type { ?string } 4619 * @syscap SystemCapability.ArkUI.ArkUI.Full 4620 * @crossplatform 4621 * @form 4622 * @atomicservice 4623 * @since 11 4624 */ 4625 colorMode?: string; 4626 4627 /** 4628 * Define Preview deviceType 4629 * 4630 * @type { ?string } 4631 * @syscap SystemCapability.ArkUI.ArkUI.Full 4632 * @form 4633 * @since 9 4634 */ 4635 /** 4636 * Define Preview deviceType 4637 * 4638 * @type { ?string } 4639 * @syscap SystemCapability.ArkUI.ArkUI.Full 4640 * @form 4641 * @atomicservice 4642 * @since 11 4643 */ 4644 deviceType?: string; 4645 4646 /** 4647 * Define Preview dpi 4648 * 4649 * @type { ?number } 4650 * @syscap SystemCapability.ArkUI.ArkUI.Full 4651 * @form 4652 * @since 9 4653 */ 4654 /** 4655 * Define Preview dpi 4656 * 4657 * @type { ?number } 4658 * @syscap SystemCapability.ArkUI.ArkUI.Full 4659 * @form 4660 * @atomicservice 4661 * @since 11 4662 */ 4663 dpi?: number; 4664 4665 /** 4666 * Define Preview orientation 4667 * 4668 * @type { ?string } 4669 * @syscap SystemCapability.ArkUI.ArkUI.Full 4670 * @form 4671 * @since 9 4672 */ 4673 /** 4674 * Define Preview orientation 4675 * 4676 * @type { ?string } 4677 * @syscap SystemCapability.ArkUI.ArkUI.Full 4678 * @form 4679 * @atomicservice 4680 * @since 11 4681 */ 4682 orientation?: string; 4683 4684 /** 4685 * Define Preview roundScreen 4686 * 4687 * @type { ?boolean } 4688 * @syscap SystemCapability.ArkUI.ArkUI.Full 4689 * @form 4690 * @since 9 4691 */ 4692 /** 4693 * Define Preview roundScreen 4694 * 4695 * @type { ?boolean } 4696 * @syscap SystemCapability.ArkUI.ArkUI.Full 4697 * @form 4698 * @atomicservice 4699 * @since 11 4700 */ 4701 roundScreen?: boolean; 4702} 4703 4704/** 4705 * ItemDragInfo object description 4706 * 4707 * @interface ItemDragInfo 4708 * @syscap SystemCapability.ArkUI.ArkUI.Full 4709 * @since 8 4710 */ 4711/** 4712 * ItemDragInfo object description 4713 * 4714 * @interface ItemDragInfo 4715 * @syscap SystemCapability.ArkUI.ArkUI.Full 4716 * @crossplatform 4717 * @since 10 4718 */ 4719/** 4720 * ItemDragInfo object description 4721 * 4722 * @interface ItemDragInfo 4723 * @syscap SystemCapability.ArkUI.ArkUI.Full 4724 * @crossplatform 4725 * @atomicservice 4726 * @since 11 4727 */ 4728declare interface ItemDragInfo { 4729 /** 4730 * Obtains the X coordinate of the drag window, in vp. 4731 * 4732 * @type { number } 4733 * @syscap SystemCapability.ArkUI.ArkUI.Full 4734 * @since 8 4735 */ 4736 /** 4737 * Obtains the X coordinate of the drag window, in vp. 4738 * 4739 * @type { number } 4740 * @syscap SystemCapability.ArkUI.ArkUI.Full 4741 * @crossplatform 4742 * @since 10 4743 */ 4744 /** 4745 * Obtains the X coordinate of the drag window, in vp. 4746 * 4747 * @type { number } 4748 * @syscap SystemCapability.ArkUI.ArkUI.Full 4749 * @crossplatform 4750 * @atomicservice 4751 * @since 11 4752 */ 4753 x: number; 4754 4755 /** 4756 * Obtains the Y coordinate of the drag window, in vp. 4757 * 4758 * @type { number } 4759 * @syscap SystemCapability.ArkUI.ArkUI.Full 4760 * @since 8 4761 */ 4762 /** 4763 * Obtains the Y coordinate of the drag window, in vp. 4764 * 4765 * @type { number } 4766 * @syscap SystemCapability.ArkUI.ArkUI.Full 4767 * @crossplatform 4768 * @since 10 4769 */ 4770 /** 4771 * Obtains the Y coordinate of the drag window, in vp. 4772 * 4773 * @type { number } 4774 * @syscap SystemCapability.ArkUI.ArkUI.Full 4775 * @crossplatform 4776 * @atomicservice 4777 * @since 11 4778 */ 4779 y: number; 4780} 4781 4782/** 4783 * Enum of using the effects template mode. 4784 * 4785 * @enum { number } 4786 * @syscap SystemCapability.ArkUI.ArkUI.Full 4787 * @atomicservice 4788 * @since 14 4789 */ 4790declare enum EffectType { 4791 /** 4792 * Define use the effects template defined by the parent effectComponent. 4793 * 4794 * @syscap SystemCapability.ArkUI.ArkUI.Full 4795 * @atomicservice 4796 * @since 14 4797 */ 4798 DEFAULT = 0, 4799 /** 4800 * Define use the effects template defined by the window. 4801 * 4802 * @syscap SystemCapability.ArkUI.ArkUI.Full 4803 * @atomicservice 4804 * @since 14 4805 */ 4806 WINDOW_EFFECT = 1, 4807} 4808 4809/** 4810 * Defines the drag status before drag action. 4811 * 4812 * @enum { number } 4813 * @syscap SystemCapability.ArkUI.ArkUI.Full 4814 * @atomicservice 4815 * @since 12 4816 */ 4817declare enum PreDragStatus { 4818 /** 4819 * Define the status for user prepare to start long press gesture. 4820 * 4821 * @syscap SystemCapability.ArkUI.ArkUI.Full 4822 * @atomicservice 4823 * @since 12 4824 */ 4825 ACTION_DETECTING_STATUS = 0, 4826 4827 /** 4828 * Define the status for user can start drag action. 4829 * 4830 * @syscap SystemCapability.ArkUI.ArkUI.Full 4831 * @atomicservice 4832 * @since 12 4833 */ 4834 READY_TO_TRIGGER_DRAG_ACTION = 1, 4835 4836 /** 4837 * Define the status for dragItem lift animation started. 4838 * 4839 * @syscap SystemCapability.ArkUI.ArkUI.Full 4840 * @atomicservice 4841 * @since 12 4842 */ 4843 PREVIEW_LIFT_STARTED = 2, 4844 4845 /** 4846 * Define the status for dragItem lift animation finished. 4847 * 4848 * @syscap SystemCapability.ArkUI.ArkUI.Full 4849 * @atomicservice 4850 * @since 12 4851 */ 4852 PREVIEW_LIFT_FINISHED = 3, 4853 4854 /** 4855 * Define the status for dragItem landing animation started. 4856 * 4857 * @syscap SystemCapability.ArkUI.ArkUI.Full 4858 * @atomicservice 4859 * @since 12 4860 */ 4861 PREVIEW_LANDING_STARTED = 4, 4862 4863 /** 4864 * Define the status for dragItem landing animation finished. 4865 * 4866 * @syscap SystemCapability.ArkUI.ArkUI.Full 4867 * @atomicservice 4868 * @since 12 4869 */ 4870 PREVIEW_LANDING_FINISHED = 5, 4871 4872 /** 4873 * Define the status for user cancel drag action. 4874 * 4875 * @syscap SystemCapability.ArkUI.ArkUI.Full 4876 * @atomicservice 4877 * @since 12 4878 */ 4879 ACTION_CANCELED_BEFORE_DRAG = 6, 4880} 4881 4882/** 4883 * DragItemInfo object description 4884 * 4885 * @interface DragItemInfo 4886 * @syscap SystemCapability.ArkUI.ArkUI.Full 4887 * @since 8 4888 */ 4889/** 4890 * DragItemInfo object description 4891 * 4892 * @interface DragItemInfo 4893 * @syscap SystemCapability.ArkUI.ArkUI.Full 4894 * @atomicservice 4895 * @since 11 4896 */ 4897/** 4898 * DragItemInfo object description 4899 * 4900 * @interface DragItemInfo 4901 * @syscap SystemCapability.ArkUI.ArkUI.Full 4902 * @crossplatform 4903 * @atomicservice 4904 * @since 14 4905 */ 4906declare interface DragItemInfo { 4907 /** 4908 * Uses the pixelMap object for drawing. 4909 * 4910 * @type { ?PixelMap } 4911 * @syscap SystemCapability.ArkUI.ArkUI.Full 4912 * @since 8 4913 */ 4914 /** 4915 * Uses the pixelMap object for drawing. 4916 * 4917 * @type { ?PixelMap } 4918 * @syscap SystemCapability.ArkUI.ArkUI.Full 4919 * @atomicservice 4920 * @since 11 4921 */ 4922 /** 4923 * Uses the pixelMap object for drawing. 4924 * 4925 * @type { ?PixelMap } 4926 * @syscap SystemCapability.ArkUI.ArkUI.Full 4927 * @crossplatform 4928 * @atomicservice 4929 * @since 14 4930 */ 4931 pixelMap?: PixelMap; 4932 4933 /** 4934 * Uses the custom builder for drawing, if pixelMap is set, this value is ignored. 4935 * 4936 * @type { ?CustomBuilder } 4937 * @syscap SystemCapability.ArkUI.ArkUI.Full 4938 * @since 8 4939 */ 4940 /** 4941 * Uses the custom builder for drawing, if pixelMap is set, this value is ignored. 4942 * 4943 * @type { ?CustomBuilder } 4944 * @syscap SystemCapability.ArkUI.ArkUI.Full 4945 * @atomicservice 4946 * @since 11 4947 */ 4948 /** 4949 * Uses the custom builder for drawing, if pixelMap is set, this value is ignored. 4950 * 4951 * @type { ?CustomBuilder } 4952 * @syscap SystemCapability.ArkUI.ArkUI.Full 4953 * @crossplatform 4954 * @atomicservice 4955 * @since 14 4956 */ 4957 builder?: CustomBuilder; 4958 4959 /** 4960 * Sets the extra info for drag event. 4961 * 4962 * @type { ?string } 4963 * @syscap SystemCapability.ArkUI.ArkUI.Full 4964 * @since 8 4965 */ 4966 /** 4967 * Sets the extra info for drag event. 4968 * 4969 * @type { ?string } 4970 * @syscap SystemCapability.ArkUI.ArkUI.Full 4971 * @atomicservice 4972 * @since 11 4973 */ 4974 /** 4975 * Sets the extra info for drag event. 4976 * 4977 * @type { ?string } 4978 * @syscap SystemCapability.ArkUI.ArkUI.Full 4979 * @crossplatform 4980 * @atomicservice 4981 * @since 14 4982 */ 4983 extraInfo?: string; 4984} 4985 4986/** 4987 * Defining animation function. 4988 * 4989 * @param { AnimateParam } value 4990 * @param { function } event 4991 * @syscap SystemCapability.ArkUI.ArkUI.Full 4992 * @since 7 4993 */ 4994/** 4995 * Defining animation function. 4996 * 4997 * @param { AnimateParam } value 4998 * @param { function } event 4999 * @syscap SystemCapability.ArkUI.ArkUI.Full 5000 * @form 5001 * @since 9 5002 */ 5003/** 5004 * Defining animation function. 5005 * 5006 * @param { AnimateParam } value 5007 * @param { function } event 5008 * @syscap SystemCapability.ArkUI.ArkUI.Full 5009 * @crossplatform 5010 * @form 5011 * @since 10 5012 */ 5013/** 5014 * Defining animation function. 5015 * 5016 * @param { AnimateParam } value 5017 * @param { function } event 5018 * @syscap SystemCapability.ArkUI.ArkUI.Full 5019 * @crossplatform 5020 * @form 5021 * @atomicservice 5022 * @since 11 5023 */ 5024declare function animateTo(value: AnimateParam, event: () => void): void; 5025 5026/** 5027 * Define animation functions for immediate distribution. 5028 * 5029 * @param { AnimateParam } value - Set animation effect parameters. 5030 * @param { function } event - Specify the closure function that displays dynamic effects, 5031 * and the system will automatically insert transition animations for state changes caused by the closure function. 5032 * @syscap SystemCapability.ArkUI.ArkUI.Full 5033 * @atomicservice 5034 * @since 12 5035 */ 5036declare function animateToImmediately(value: AnimateParam, event: () => void): void; 5037 5038/** 5039 * Converts a value in vp units to a value in px. 5040 * 5041 * @param { number } value 5042 * @returns { number } 5043 * @syscap SystemCapability.ArkUI.ArkUI.Full 5044 * @since 7 5045 */ 5046/** 5047 * Converts a value in vp units to a value in px. 5048 * 5049 * @param { number } value 5050 * @returns { number } 5051 * @syscap SystemCapability.ArkUI.ArkUI.Full 5052 * @form 5053 * @since 9 5054 */ 5055/** 5056 * Converts a value in vp units to a value in px. 5057 * 5058 * @param { number } value 5059 * @returns { number } 5060 * @syscap SystemCapability.ArkUI.ArkUI.Full 5061 * @crossplatform 5062 * @form 5063 * @since 10 5064 */ 5065/** 5066 * Converts a value in vp units to a value in px. 5067 * 5068 * @param { number } value 5069 * @returns { number } 5070 * @syscap SystemCapability.ArkUI.ArkUI.Full 5071 * @crossplatform 5072 * @form 5073 * @atomicservice 5074 * @since 11 5075 */ 5076declare function vp2px(value: number): number; 5077 5078/** 5079 * Converts a number in units of px to a number in units of vp. 5080 * 5081 * @param { number } value 5082 * @returns { number } 5083 * @syscap SystemCapability.ArkUI.ArkUI.Full 5084 * @since 7 5085 */ 5086/** 5087 * Converts a number in units of px to a number in units of vp. 5088 * 5089 * @param { number } value 5090 * @returns { number } 5091 * @syscap SystemCapability.ArkUI.ArkUI.Full 5092 * @form 5093 * @since 9 5094 */ 5095/** 5096 * Converts a number in units of px to a number in units of vp. 5097 * 5098 * @param { number } value 5099 * @returns { number } 5100 * @syscap SystemCapability.ArkUI.ArkUI.Full 5101 * @crossplatform 5102 * @form 5103 * @since 10 5104 */ 5105/** 5106 * Converts a number in units of px to a number in units of vp. 5107 * 5108 * @param { number } value 5109 * @returns { number } 5110 * @syscap SystemCapability.ArkUI.ArkUI.Full 5111 * @crossplatform 5112 * @form 5113 * @atomicservice 5114 * @since 11 5115 */ 5116declare function px2vp(value: number): number; 5117 5118/** 5119 * Converts a number in fp units to a number in px. 5120 * 5121 * @param { number } value 5122 * @returns { number } 5123 * @syscap SystemCapability.ArkUI.ArkUI.Full 5124 * @since 7 5125 */ 5126/** 5127 * Converts a number in fp units to a number in px. 5128 * 5129 * @param { number } value 5130 * @returns { number } 5131 * @syscap SystemCapability.ArkUI.ArkUI.Full 5132 * @form 5133 * @since 9 5134 */ 5135/** 5136 * Converts a number in fp units to a number in px. 5137 * 5138 * @param { number } value 5139 * @returns { number } 5140 * @syscap SystemCapability.ArkUI.ArkUI.Full 5141 * @crossplatform 5142 * @form 5143 * @since 10 5144 */ 5145/** 5146 * Converts a number in fp units to a number in px. 5147 * 5148 * @param { number } value 5149 * @returns { number } 5150 * @syscap SystemCapability.ArkUI.ArkUI.Full 5151 * @crossplatform 5152 * @form 5153 * @atomicservice 5154 * @since 11 5155 */ 5156declare function fp2px(value: number): number; 5157 5158/** 5159 * Converts a number in units of px to a number in units of fp. 5160 * 5161 * @param { number } value 5162 * @returns { number } 5163 * @syscap SystemCapability.ArkUI.ArkUI.Full 5164 * @since 7 5165 */ 5166/** 5167 * Converts a number in units of px to a number in units of fp. 5168 * 5169 * @param { number } value 5170 * @returns { number } 5171 * @syscap SystemCapability.ArkUI.ArkUI.Full 5172 * @form 5173 * @since 9 5174 */ 5175/** 5176 * Converts a number in units of px to a number in units of fp. 5177 * 5178 * @param { number } value 5179 * @returns { number } 5180 * @syscap SystemCapability.ArkUI.ArkUI.Full 5181 * @crossplatform 5182 * @form 5183 * @since 10 5184 */ 5185/** 5186 * Converts a number in units of px to a number in units of fp. 5187 * 5188 * @param { number } value 5189 * @returns { number } 5190 * @syscap SystemCapability.ArkUI.ArkUI.Full 5191 * @crossplatform 5192 * @form 5193 * @atomicservice 5194 * @since 11 5195 */ 5196declare function px2fp(value: number): number; 5197 5198/** 5199 * Converts a number in units of lpx to a number in units of px. 5200 * 5201 * @param { number } value 5202 * @returns { number } 5203 * @syscap SystemCapability.ArkUI.ArkUI.Full 5204 * @since 7 5205 */ 5206/** 5207 * Converts a number in units of lpx to a number in units of px. 5208 * 5209 * @param { number } value 5210 * @returns { number } 5211 * @syscap SystemCapability.ArkUI.ArkUI.Full 5212 * @form 5213 * @since 9 5214 */ 5215/** 5216 * Converts a number in units of lpx to a number in units of px. 5217 * 5218 * @param { number } value 5219 * @returns { number } 5220 * @syscap SystemCapability.ArkUI.ArkUI.Full 5221 * @crossplatform 5222 * @form 5223 * @since 10 5224 */ 5225/** 5226 * Converts a number in units of lpx to a number in units of px. 5227 * 5228 * @param { number } value 5229 * @returns { number } 5230 * @syscap SystemCapability.ArkUI.ArkUI.Full 5231 * @crossplatform 5232 * @form 5233 * @atomicservice 5234 * @since 11 5235 */ 5236declare function lpx2px(value: number): number; 5237 5238/** 5239 * Converts a number in units of px to a number in units of lpx. 5240 * 5241 * @param { number } value 5242 * @returns { number } 5243 * @syscap SystemCapability.ArkUI.ArkUI.Full 5244 * @since 7 5245 */ 5246/** 5247 * Converts a number in units of px to a number in units of lpx. 5248 * 5249 * @param { number } value 5250 * @returns { number } 5251 * @syscap SystemCapability.ArkUI.ArkUI.Full 5252 * @form 5253 * @since 9 5254 */ 5255/** 5256 * Converts a number in units of px to a number in units of lpx. 5257 * 5258 * @param { number } value 5259 * @returns { number } 5260 * @syscap SystemCapability.ArkUI.ArkUI.Full 5261 * @crossplatform 5262 * @form 5263 * @since 10 5264 */ 5265/** 5266 * Converts a number in units of px to a number in units of lpx. 5267 * 5268 * @param { number } value 5269 * @returns { number } 5270 * @syscap SystemCapability.ArkUI.ArkUI.Full 5271 * @crossplatform 5272 * @form 5273 * @atomicservice 5274 * @since 11 5275 */ 5276declare function px2lpx(value: number): number; 5277 5278/** 5279 * Defines the namespace of focus controller. 5280 * 5281 * @namespace focusControl 5282 * @syscap SystemCapability.ArkUI.ArkUI.Full 5283 * @crossplatform 5284 * @form 5285 * @since 9 5286 */ 5287/** 5288 * Defines the namespace of focus controller. 5289 * 5290 * @namespace focusControl 5291 * @syscap SystemCapability.ArkUI.ArkUI.Full 5292 * @crossplatform 5293 * @form 5294 * @atomicservice 5295 * @since 11 5296 */ 5297declare namespace focusControl { 5298 /** 5299 * Request focus to the specific component by param: 'id/key'. 5300 * 5301 * @param { string } value 5302 * @returns { boolean } 5303 * @syscap SystemCapability.ArkUI.ArkUI.Full 5304 * @since 9 5305 */ 5306 /** 5307 * Request focus to the specific component by param: 'id/key'. 5308 * 5309 * @param { string } value 5310 * @returns { boolean } 5311 * @syscap SystemCapability.ArkUI.ArkUI.Full 5312 * @crossplatform 5313 * @since 10 5314 */ 5315 /** 5316 * Request focus to the specific component by param: 'id/key'. 5317 * 5318 * @param { string } value 5319 * @returns { boolean } 5320 * @syscap SystemCapability.ArkUI.ArkUI.Full 5321 * @crossplatform 5322 * @atomicservice 5323 * @since 11 5324 */ 5325 function requestFocus(value: string): boolean; 5326} 5327 5328/** 5329 * Import the PointerStyle type object for setCursor. 5330 * 5331 * @typedef { import('../api/@ohos.multimodalInput.pointer').default.PointerStyle } PointerStyle 5332 * @syscap SystemCapability.ArkUI.ArkUI.Full 5333 * @since 11 5334 */ 5335/** 5336 * Import the PointerStyle type object for setCursor. 5337 * 5338 * @typedef { import('../api/@ohos.multimodalInput.pointer').default.PointerStyle } PointerStyle 5339 * @syscap SystemCapability.ArkUI.ArkUI.Full 5340 * @atomicservice 5341 * @since 12 5342 */ 5343declare type PointerStyle = import('../api/@ohos.multimodalInput.pointer').default.PointerStyle; 5344 5345/** 5346 * CursorControl 5347 * 5348 * @namespace cursorControl 5349 * @syscap SystemCapability.ArkUI.ArkUI.Full 5350 * @since 11 5351 */ 5352/** 5353 * CursorControl 5354 * 5355 * @namespace cursorControl 5356 * @syscap SystemCapability.ArkUI.ArkUI.Full 5357 * @atomicservice 5358 * @since 12 5359 */ 5360declare namespace cursorControl { 5361 5362 /** 5363 * Change the mouse cursor style by param: 'PointerStyle'. 5364 * 5365 * @param { PointerStyle } value 5366 * @syscap SystemCapability.ArkUI.ArkUI.Full 5367 * @crossplatform 5368 * @since 11 5369 */ 5370 /** 5371 * Change the mouse cursor style by param: 'PointerStyle'. 5372 * 5373 * @param { PointerStyle } value 5374 * @syscap SystemCapability.ArkUI.ArkUI.Full 5375 * @crossplatform 5376 * @atomicservice 5377 * @since 12 5378 */ 5379 function setCursor(value: PointerStyle): void; 5380 5381 /** 5382 * Restore the default mouse cursor style. 5383 * 5384 * @syscap SystemCapability.ArkUI.ArkUI.Full 5385 * @crossplatform 5386 * @since 11 5387 */ 5388 /** 5389 * Restore the default mouse cursor style. 5390 * 5391 * @syscap SystemCapability.ArkUI.ArkUI.Full 5392 * @crossplatform 5393 * @atomicservice 5394 * @since 12 5395 */ 5396 function restoreDefault(): void; 5397} 5398 5399/** 5400 * Defines the event target. 5401 * 5402 * @interface EventTarget 5403 * @syscap SystemCapability.ArkUI.ArkUI.Full 5404 * @since 8 5405 */ 5406/** 5407 * Defines the event target. 5408 * 5409 * @interface EventTarget 5410 * @syscap SystemCapability.ArkUI.ArkUI.Full 5411 * @form 5412 * @since 9 5413 */ 5414/** 5415 * Defines the event target. 5416 * 5417 * @interface EventTarget 5418 * @syscap SystemCapability.ArkUI.ArkUI.Full 5419 * @crossplatform 5420 * @form 5421 * @since 10 5422 */ 5423/** 5424 * Defines the event target. 5425 * 5426 * @interface EventTarget 5427 * @syscap SystemCapability.ArkUI.ArkUI.Full 5428 * @crossplatform 5429 * @form 5430 * @atomicservice 5431 * @since 11 5432 */ 5433declare interface EventTarget { 5434 /** 5435 * Area of current target. 5436 * 5437 * @type { Area } 5438 * @syscap SystemCapability.ArkUI.ArkUI.Full 5439 * @since 8 5440 */ 5441 /** 5442 * Area of current target. 5443 * 5444 * @type { Area } 5445 * @syscap SystemCapability.ArkUI.ArkUI.Full 5446 * @form 5447 * @since 9 5448 */ 5449 /** 5450 * Area of current target. 5451 * 5452 * @type { Area } 5453 * @syscap SystemCapability.ArkUI.ArkUI.Full 5454 * @crossplatform 5455 * @form 5456 * @since 10 5457 */ 5458 /** 5459 * Area of current target. 5460 * 5461 * @type { Area } 5462 * @syscap SystemCapability.ArkUI.ArkUI.Full 5463 * @crossplatform 5464 * @form 5465 * @atomicservice 5466 * @since 11 5467 */ 5468 area: Area; 5469 5470 /** 5471 * Node id of current target. 5472 * 5473 * @type { ?string } 5474 * @syscap SystemCapability.ArkUI.ArkUI.Full 5475 * @crossplatform 5476 * @form 5477 * @atomicservice 5478 * @since 15 5479 */ 5480 id?: string; 5481} 5482 5483/** 5484 * Defines the event source type. 5485 * 5486 * @enum { number } 5487 * @syscap SystemCapability.ArkUI.ArkUI.Full 5488 * @since 8 5489 */ 5490/** 5491 * Defines the event source type. 5492 * 5493 * @enum { number } 5494 * @syscap SystemCapability.ArkUI.ArkUI.Full 5495 * @crossplatform 5496 * @since 10 5497 */ 5498/** 5499 * Defines the event source type. 5500 * 5501 * @enum { number } 5502 * @syscap SystemCapability.ArkUI.ArkUI.Full 5503 * @crossplatform 5504 * @atomicservice 5505 * @since 11 5506 */ 5507declare enum SourceType { 5508 /** 5509 * Unknown type. 5510 * 5511 * @syscap SystemCapability.ArkUI.ArkUI.Full 5512 * @since 8 5513 */ 5514 /** 5515 * Unknown type. 5516 * 5517 * @syscap SystemCapability.ArkUI.ArkUI.Full 5518 * @crossplatform 5519 * @since 10 5520 */ 5521 /** 5522 * Unknown type. 5523 * 5524 * @syscap SystemCapability.ArkUI.ArkUI.Full 5525 * @crossplatform 5526 * @atomicservice 5527 * @since 11 5528 */ 5529 Unknown, 5530 5531 /** 5532 * The mouse type. 5533 * 5534 * @syscap SystemCapability.ArkUI.ArkUI.Full 5535 * @since 8 5536 */ 5537 /** 5538 * The mouse type. 5539 * 5540 * @syscap SystemCapability.ArkUI.ArkUI.Full 5541 * @crossplatform 5542 * @since 10 5543 */ 5544 /** 5545 * The mouse type. 5546 * 5547 * @syscap SystemCapability.ArkUI.ArkUI.Full 5548 * @crossplatform 5549 * @atomicservice 5550 * @since 11 5551 */ 5552 Mouse, 5553 5554 /** 5555 * The touch screen type. 5556 * 5557 * @syscap SystemCapability.ArkUI.ArkUI.Full 5558 * @since 8 5559 */ 5560 /** 5561 * The touch screen type. 5562 * 5563 * @syscap SystemCapability.ArkUI.ArkUI.Full 5564 * @crossplatform 5565 * @since 10 5566 */ 5567 /** 5568 * The touch screen type. 5569 * 5570 * @syscap SystemCapability.ArkUI.ArkUI.Full 5571 * @crossplatform 5572 * @atomicservice 5573 * @since 11 5574 */ 5575 TouchScreen, 5576} 5577 5578/** 5579 * Defines the event tool type. 5580 * 5581 * @enum { number } 5582 * @syscap SystemCapability.ArkUI.ArkUI.Full 5583 * @since 9 5584 */ 5585/** 5586 * Defines the event tool type. 5587 * 5588 * @enum { number } 5589 * @syscap SystemCapability.ArkUI.ArkUI.Full 5590 * @crossplatform 5591 * @since 10 5592 */ 5593/** 5594 * Defines the event tool type. 5595 * 5596 * @enum { number } 5597 * @syscap SystemCapability.ArkUI.ArkUI.Full 5598 * @crossplatform 5599 * @atomicservice 5600 * @since 11 5601 */ 5602declare enum SourceTool { 5603 /** 5604 * Unknown type. 5605 * 5606 * @syscap SystemCapability.ArkUI.ArkUI.Full 5607 * @since 9 5608 */ 5609 /** 5610 * Unknown type. 5611 * 5612 * @syscap SystemCapability.ArkUI.ArkUI.Full 5613 * @crossplatform 5614 * @since 10 5615 */ 5616 /** 5617 * Unknown type. 5618 * 5619 * @syscap SystemCapability.ArkUI.ArkUI.Full 5620 * @crossplatform 5621 * @atomicservice 5622 * @since 11 5623 */ 5624 Unknown, 5625 5626 /** 5627 * The finger type. 5628 * 5629 * @syscap SystemCapability.ArkUI.ArkUI.Full 5630 * @since 9 5631 */ 5632 /** 5633 * The finger type. 5634 * 5635 * @syscap SystemCapability.ArkUI.ArkUI.Full 5636 * @crossplatform 5637 * @since 10 5638 */ 5639 /** 5640 * The finger type. 5641 * 5642 * @syscap SystemCapability.ArkUI.ArkUI.Full 5643 * @crossplatform 5644 * @atomicservice 5645 * @since 11 5646 */ 5647 Finger, 5648 5649 /** 5650 * The pen type. 5651 * 5652 * @syscap SystemCapability.ArkUI.ArkUI.Full 5653 * @since 9 5654 */ 5655 /** 5656 * The pen type. 5657 * 5658 * @syscap SystemCapability.ArkUI.ArkUI.Full 5659 * @crossplatform 5660 * @since 10 5661 */ 5662 /** 5663 * The pen type. 5664 * 5665 * @syscap SystemCapability.ArkUI.ArkUI.Full 5666 * @crossplatform 5667 * @atomicservice 5668 * @since 11 5669 */ 5670 Pen, 5671 5672 /** 5673 * The mouse type. 5674 * 5675 * @syscap SystemCapability.ArkUI.ArkUI.Full 5676 * @crossplatform 5677 * @atomicservice 5678 * @since 12 5679 */ 5680 MOUSE, 5681 5682 /** 5683 * The touchpad type. 5684 * 5685 * @syscap SystemCapability.ArkUI.ArkUI.Full 5686 * @crossplatform 5687 * @atomicservice 5688 * @since 12 5689 */ 5690 TOUCHPAD, 5691 5692 /** 5693 * The joystick type. 5694 * 5695 * @syscap SystemCapability.ArkUI.ArkUI.Full 5696 * @crossplatform 5697 * @atomicservice 5698 * @since 12 5699 */ 5700 JOYSTICK, 5701} 5702 5703/** 5704 * Defines the Border Image Repeat Mode. 5705 * 5706 * @enum { number } 5707 * @syscap SystemCapability.ArkUI.ArkUI.Full 5708 * @form 5709 * @since 9 5710 */ 5711/** 5712 * Defines the Border Image Repeat Mode. 5713 * 5714 * @enum { number } 5715 * @syscap SystemCapability.ArkUI.ArkUI.Full 5716 * @crossplatform 5717 * @form 5718 * @since 10 5719 */ 5720/** 5721 * Defines the Border Image Repeat Mode. 5722 * 5723 * @enum { number } 5724 * @syscap SystemCapability.ArkUI.ArkUI.Full 5725 * @crossplatform 5726 * @form 5727 * @atomicservice 5728 * @since 11 5729 */ 5730declare enum RepeatMode { 5731 /** 5732 * Repeat mode. 5733 * 5734 * @syscap SystemCapability.ArkUI.ArkUI.Full 5735 * @form 5736 * @since 9 5737 */ 5738 /** 5739 * Repeat mode. 5740 * 5741 * @syscap SystemCapability.ArkUI.ArkUI.Full 5742 * @crossplatform 5743 * @form 5744 * @since 10 5745 */ 5746 /** 5747 * Repeat mode. 5748 * 5749 * @syscap SystemCapability.ArkUI.ArkUI.Full 5750 * @crossplatform 5751 * @form 5752 * @atomicservice 5753 * @since 11 5754 */ 5755 Repeat, 5756 5757 /** 5758 * Stretch mode. 5759 * 5760 * @syscap SystemCapability.ArkUI.ArkUI.Full 5761 * @form 5762 * @since 9 5763 */ 5764 /** 5765 * Stretch mode. 5766 * 5767 * @syscap SystemCapability.ArkUI.ArkUI.Full 5768 * @crossplatform 5769 * @form 5770 * @since 10 5771 */ 5772 /** 5773 * Stretch mode. 5774 * 5775 * @syscap SystemCapability.ArkUI.ArkUI.Full 5776 * @crossplatform 5777 * @form 5778 * @atomicservice 5779 * @since 11 5780 */ 5781 Stretch, 5782 5783 /** 5784 * Round mode. 5785 * 5786 * @syscap SystemCapability.ArkUI.ArkUI.Full 5787 * @form 5788 * @since 9 5789 */ 5790 /** 5791 * Round mode. 5792 * 5793 * @syscap SystemCapability.ArkUI.ArkUI.Full 5794 * @crossplatform 5795 * @form 5796 * @since 10 5797 */ 5798 /** 5799 * Round mode. 5800 * 5801 * @syscap SystemCapability.ArkUI.ArkUI.Full 5802 * @crossplatform 5803 * @form 5804 * @atomicservice 5805 * @since 11 5806 */ 5807 Round, 5808 5809 /** 5810 * Space mode. 5811 * 5812 * @syscap SystemCapability.ArkUI.ArkUI.Full 5813 * @form 5814 * @since 9 5815 */ 5816 /** 5817 * Space mode. 5818 * 5819 * @syscap SystemCapability.ArkUI.ArkUI.Full 5820 * @crossplatform 5821 * @form 5822 * @since 10 5823 */ 5824 /** 5825 * Space mode. 5826 * 5827 * @syscap SystemCapability.ArkUI.ArkUI.Full 5828 * @crossplatform 5829 * @form 5830 * @atomicservice 5831 * @since 11 5832 */ 5833 Space, 5834} 5835 5836/** 5837 * enum Blur style 5838 * 5839 * @enum { number } 5840 * @syscap SystemCapability.ArkUI.ArkUI.Full 5841 * @form 5842 * @since 9 5843 */ 5844/** 5845 * enum Blur style 5846 * 5847 * @enum { number } 5848 * @syscap SystemCapability.ArkUI.ArkUI.Full 5849 * @crossplatform 5850 * @form 5851 * @since 10 5852 */ 5853/** 5854 * enum Blur style 5855 * 5856 * @enum { number } 5857 * @syscap SystemCapability.ArkUI.ArkUI.Full 5858 * @crossplatform 5859 * @form 5860 * @atomicservice 5861 * @since 11 5862 */ 5863declare enum BlurStyle { 5864 /** 5865 * Defines the thin card material. 5866 * 5867 * @syscap SystemCapability.ArkUI.ArkUI.Full 5868 * @form 5869 * @since 9 5870 */ 5871 /** 5872 * Defines the thin card material. 5873 * 5874 * @syscap SystemCapability.ArkUI.ArkUI.Full 5875 * @crossplatform 5876 * @form 5877 * @since 10 5878 */ 5879 /** 5880 * Defines the thin card material. 5881 * 5882 * @syscap SystemCapability.ArkUI.ArkUI.Full 5883 * @crossplatform 5884 * @form 5885 * @atomicservice 5886 * @since 11 5887 */ 5888 Thin, 5889 5890 /** 5891 * Defines the regular card material. 5892 * 5893 * @syscap SystemCapability.ArkUI.ArkUI.Full 5894 * @form 5895 * @since 9 5896 */ 5897 /** 5898 * Defines the regular card material. 5899 * 5900 * @syscap SystemCapability.ArkUI.ArkUI.Full 5901 * @crossplatform 5902 * @form 5903 * @since 10 5904 */ 5905 /** 5906 * Defines the regular card material. 5907 * 5908 * @syscap SystemCapability.ArkUI.ArkUI.Full 5909 * @crossplatform 5910 * @form 5911 * @atomicservice 5912 * @since 11 5913 */ 5914 Regular, 5915 5916 /** 5917 * Defines the thick card material. 5918 * 5919 * @syscap SystemCapability.ArkUI.ArkUI.Full 5920 * @form 5921 * @since 9 5922 */ 5923 /** 5924 * Defines the thick card material. 5925 * 5926 * @syscap SystemCapability.ArkUI.ArkUI.Full 5927 * @crossplatform 5928 * @form 5929 * @since 10 5930 */ 5931 /** 5932 * Defines the thick card material. 5933 * 5934 * @syscap SystemCapability.ArkUI.ArkUI.Full 5935 * @crossplatform 5936 * @form 5937 * @atomicservice 5938 * @since 11 5939 */ 5940 Thick, 5941 5942 /** 5943 * Defines the thin background material. 5944 * 5945 * @syscap SystemCapability.ArkUI.ArkUI.Full 5946 * @crossplatform 5947 * @since 10 5948 */ 5949 /** 5950 * Defines the thin background material. 5951 * 5952 * @syscap SystemCapability.ArkUI.ArkUI.Full 5953 * @crossplatform 5954 * @form 5955 * @atomicservice 5956 * @since 11 5957 */ 5958 BACKGROUND_THIN, 5959 5960 /** 5961 * Defines the thin regular material. 5962 * 5963 * @syscap SystemCapability.ArkUI.ArkUI.Full 5964 * @crossplatform 5965 * @since 10 5966 */ 5967 /** 5968 * Defines the thin regular material. 5969 * 5970 * @syscap SystemCapability.ArkUI.ArkUI.Full 5971 * @crossplatform 5972 * @form 5973 * @atomicservice 5974 * @since 11 5975 */ 5976 BACKGROUND_REGULAR, 5977 5978 /** 5979 * Defines the thin thick material. 5980 * 5981 * @syscap SystemCapability.ArkUI.ArkUI.Full 5982 * @crossplatform 5983 * @since 10 5984 */ 5985 /** 5986 * Defines the thin thick material. 5987 * 5988 * @syscap SystemCapability.ArkUI.ArkUI.Full 5989 * @crossplatform 5990 * @form 5991 * @atomicservice 5992 * @since 11 5993 */ 5994 BACKGROUND_THICK, 5995 5996 /** 5997 * Defines the thin ultra thick material. 5998 * 5999 * @syscap SystemCapability.ArkUI.ArkUI.Full 6000 * @crossplatform 6001 * @since 10 6002 */ 6003 /** 6004 * Defines the thin ultra thick material. 6005 * 6006 * @syscap SystemCapability.ArkUI.ArkUI.Full 6007 * @crossplatform 6008 * @form 6009 * @atomicservice 6010 * @since 11 6011 */ 6012 BACKGROUND_ULTRA_THICK, 6013 6014 /** 6015 * Defines none material. 6016 * 6017 * @syscap SystemCapability.ArkUI.ArkUI.Full 6018 * @crossplatform 6019 * @form 6020 * @since 10 6021 */ 6022 /** 6023 * Defines none material. 6024 * 6025 * @syscap SystemCapability.ArkUI.ArkUI.Full 6026 * @crossplatform 6027 * @form 6028 * @atomicservice 6029 * @since 11 6030 */ 6031 NONE, 6032 6033 /** 6034 * Defines the ultra thin component material. 6035 * 6036 * @syscap SystemCapability.ArkUI.ArkUI.Full 6037 * @crossplatform 6038 * @form 6039 * @since 11 6040 */ 6041 /** 6042 * Defines the ultra thin component material. 6043 * 6044 * @syscap SystemCapability.ArkUI.ArkUI.Full 6045 * @crossplatform 6046 * @form 6047 * @atomicservice 6048 * @since 12 6049 */ 6050 COMPONENT_ULTRA_THIN = 8, 6051 6052 /** 6053 * Defines the thin component material. 6054 * 6055 * @syscap SystemCapability.ArkUI.ArkUI.Full 6056 * @crossplatform 6057 * @form 6058 * @since 11 6059 */ 6060 /** 6061 * Defines the thin component material. 6062 * 6063 * @syscap SystemCapability.ArkUI.ArkUI.Full 6064 * @crossplatform 6065 * @form 6066 * @atomicservice 6067 * @since 12 6068 */ 6069 COMPONENT_THIN = 9, 6070 6071 /** 6072 * Defines the regular component material. 6073 * 6074 * @syscap SystemCapability.ArkUI.ArkUI.Full 6075 * @crossplatform 6076 * @form 6077 * @since 11 6078 */ 6079 /** 6080 * Defines the regular component material. 6081 * 6082 * @syscap SystemCapability.ArkUI.ArkUI.Full 6083 * @crossplatform 6084 * @form 6085 * @atomicservice 6086 * @since 12 6087 */ 6088 COMPONENT_REGULAR = 10, 6089 6090 /** 6091 * Defines the thick component material. 6092 * 6093 * @syscap SystemCapability.ArkUI.ArkUI.Full 6094 * @crossplatform 6095 * @form 6096 * @since 11 6097 */ 6098 /** 6099 * Defines the thick component material. 6100 * 6101 * @syscap SystemCapability.ArkUI.ArkUI.Full 6102 * @crossplatform 6103 * @form 6104 * @atomicservice 6105 * @since 12 6106 */ 6107 COMPONENT_THICK = 11, 6108 6109 /** 6110 * Defines the ultra thick component material. 6111 * 6112 * @syscap SystemCapability.ArkUI.ArkUI.Full 6113 * @crossplatform 6114 * @form 6115 * @since 11 6116 */ 6117 /** 6118 * Defines the ultra thick component material. 6119 * 6120 * @syscap SystemCapability.ArkUI.ArkUI.Full 6121 * @crossplatform 6122 * @form 6123 * @atomicservice 6124 * @since 12 6125 */ 6126 COMPONENT_ULTRA_THICK = 12, 6127} 6128 6129/** 6130 * Enumerates the policies for activating the blur style. 6131 * 6132 * @enum { number } 6133 * @syscap SystemCapability.ArkUI.ArkUI.Full 6134 * @crossplatform 6135 * @atomicservice 6136 * @since 14 6137 */ 6138declare enum BlurStyleActivePolicy { 6139 /** 6140 * The component has the blur effect only when the window is focused. 6141 * 6142 * @syscap SystemCapability.ArkUI.ArkUI.Full 6143 * @crossplatform 6144 * @atomicservice 6145 * @since 14 6146 */ 6147 FOLLOWS_WINDOW_ACTIVE_STATE = 0, 6148 6149 /** 6150 * The component always has the blur effect, regardless of whether the window is focused. 6151 * 6152 * @syscap SystemCapability.ArkUI.ArkUI.Full 6153 * @crossplatform 6154 * @atomicservice 6155 * @since 14 6156 */ 6157 ALWAYS_ACTIVE = 1, 6158 6159 /** 6160 * The component does not have the blur effect, regardless of whether the window is focused. 6161 * 6162 * @syscap SystemCapability.ArkUI.ArkUI.Full 6163 * @crossplatform 6164 * @atomicservice 6165 * @since 14 6166 */ 6167 ALWAYS_INACTIVE = 2, 6168} 6169 6170/** 6171 * enum color mode 6172 * 6173 * @enum { number } 6174 * @syscap SystemCapability.ArkUI.ArkUI.Full 6175 * @crossplatform 6176 * @since 10 6177 */ 6178/** 6179 * enum color mode 6180 * 6181 * @enum { number } 6182 * @syscap SystemCapability.ArkUI.ArkUI.Full 6183 * @crossplatform 6184 * @atomicservice 6185 * @since 11 6186 */ 6187declare enum ThemeColorMode { 6188 /** 6189 * Defines the mode which is follow up with system. 6190 * 6191 * @syscap SystemCapability.ArkUI.ArkUI.Full 6192 * @crossplatform 6193 * @since 10 6194 */ 6195 /** 6196 * Defines the mode which is follow up with system. 6197 * 6198 * @syscap SystemCapability.ArkUI.ArkUI.Full 6199 * @crossplatform 6200 * @atomicservice 6201 * @since 11 6202 */ 6203 SYSTEM, 6204 6205 /** 6206 * Defines the light mode. 6207 * 6208 * @syscap SystemCapability.ArkUI.ArkUI.Full 6209 * @crossplatform 6210 * @since 10 6211 */ 6212 /** 6213 * Defines the light mode. 6214 * 6215 * @syscap SystemCapability.ArkUI.ArkUI.Full 6216 * @crossplatform 6217 * @atomicservice 6218 * @since 11 6219 */ 6220 LIGHT, 6221 6222 /** 6223 * Defines the dark mode. 6224 * 6225 * @syscap SystemCapability.ArkUI.ArkUI.Full 6226 * @crossplatform 6227 * @since 10 6228 */ 6229 /** 6230 * Defines the dark mode. 6231 * 6232 * @syscap SystemCapability.ArkUI.ArkUI.Full 6233 * @crossplatform 6234 * @atomicservice 6235 * @since 11 6236 */ 6237 DARK, 6238} 6239 6240/** 6241 * Defines adaptive color 6242 * 6243 * @enum { number } 6244 * @syscap SystemCapability.ArkUI.ArkUI.Full 6245 * @crossplatform 6246 * @since 10 6247 */ 6248/** 6249 * Defines adaptive color 6250 * 6251 * @enum { number } 6252 * @syscap SystemCapability.ArkUI.ArkUI.Full 6253 * @crossplatform 6254 * @atomicservice 6255 * @since 11 6256 */ 6257declare enum AdaptiveColor { 6258 /** 6259 * Defines the fixed value color adaptive mode. 6260 * 6261 * @syscap SystemCapability.ArkUI.ArkUI.Full 6262 * @crossplatform 6263 * @since 10 6264 */ 6265 /** 6266 * Defines the fixed value color adaptive mode. 6267 * 6268 * @syscap SystemCapability.ArkUI.ArkUI.Full 6269 * @crossplatform 6270 * @atomicservice 6271 * @since 11 6272 */ 6273 DEFAULT, 6274 6275 /** 6276 * Defines the background average color adaptive mode. 6277 * 6278 * @syscap SystemCapability.ArkUI.ArkUI.Full 6279 * @crossplatform 6280 * @since 10 6281 */ 6282 /** 6283 * Defines the background average color adaptive mode. 6284 * 6285 * @syscap SystemCapability.ArkUI.ArkUI.Full 6286 * @crossplatform 6287 * @atomicservice 6288 * @since 11 6289 */ 6290 AVERAGE, 6291} 6292 6293/** 6294 * Defines modal transition type. 6295 * 6296 * @enum { number } 6297 * @syscap SystemCapability.ArkUI.ArkUI.Full 6298 * @crossplatform 6299 * @since 10 6300 */ 6301/** 6302 * Defines modal transition type. 6303 * 6304 * @enum { number } 6305 * @syscap SystemCapability.ArkUI.ArkUI.Full 6306 * @crossplatform 6307 * @atomicservice 6308 * @since 11 6309 */ 6310declare enum ModalTransition { 6311 /** 6312 * Use default animation. 6313 * 6314 * @syscap SystemCapability.ArkUI.ArkUI.Full 6315 * @crossplatform 6316 * @since 10 6317 */ 6318 /** 6319 * Use default animation. 6320 * 6321 * @syscap SystemCapability.ArkUI.ArkUI.Full 6322 * @crossplatform 6323 * @atomicservice 6324 * @since 11 6325 */ 6326 DEFAULT, 6327 6328 /** 6329 * Use none animation. 6330 * 6331 * @syscap SystemCapability.ArkUI.ArkUI.Full 6332 * @crossplatform 6333 * @since 10 6334 */ 6335 /** 6336 * Use none animation. 6337 * 6338 * @syscap SystemCapability.ArkUI.ArkUI.Full 6339 * @crossplatform 6340 * @atomicservice 6341 * @since 11 6342 */ 6343 NONE, 6344 6345 /** 6346 * Use alpha animation. 6347 * 6348 * @syscap SystemCapability.ArkUI.ArkUI.Full 6349 * @crossplatform 6350 * @since 10 6351 */ 6352 /** 6353 * Use alpha animation. 6354 * 6355 * @syscap SystemCapability.ArkUI.ArkUI.Full 6356 * @crossplatform 6357 * @atomicservice 6358 * @since 11 6359 */ 6360 ALPHA, 6361} 6362 6363/** 6364 * Defines the options of backgroundBlurStyle 6365 * 6366 * @extends BlurStyleOption 6367 * @interface BackgroundBlurStyleOptions 6368 * @syscap SystemCapability.ArkUI.ArkUI.Full 6369 * @crossplatform 6370 * @since 10 6371 */ 6372/** 6373 * Defines the options of backgroundBlurStyle 6374 * 6375 * @extends BlurStyleOption 6376 * @interface BackgroundBlurStyleOptions 6377 * @syscap SystemCapability.ArkUI.ArkUI.Full 6378 * @crossplatform 6379 * @atomicservice 6380 * @since 11 6381 */ 6382declare interface BackgroundBlurStyleOptions extends BlurStyleOptions { 6383 /** 6384 * Defines the policy for activating the blur style. 6385 * 6386 * @type { ?BlurStyleActivePolicy } 6387 * @default BlurStyleActivePolicy.ALWAYS_ACTIVE 6388 * @syscap SystemCapability.ArkUI.ArkUI.Full 6389 * @crossplatform 6390 * @atomicservice 6391 * @since 14 6392 */ 6393 policy?: BlurStyleActivePolicy; 6394 6395 /** 6396 * Color of the background effect when the window is not focused. 6397 * 6398 * @type { ?ResourceColor } 6399 * @default Color.Transparent 6400 * @syscap SystemCapability.ArkUI.ArkUI.Full 6401 * @crossplatform 6402 * @atomicservice 6403 * @since 14 6404 */ 6405 inactiveColor?: ResourceColor; 6406} 6407 6408/** 6409 * Defines the options of ForegroundBlurStyle 6410 * 6411 * @extends BlurStyleOptions 6412 * @interface ForegroundBlurStyleOptions 6413 * @syscap SystemCapability.ArkUI.ArkUI.Full 6414 * @crossplatform 6415 * @since 10 6416 */ 6417/** 6418 * Defines the options of ForegroundBlurStyle 6419 * 6420 * @extends BlurStyleOptions 6421 * @interface ForegroundBlurStyleOptions 6422 * @syscap SystemCapability.ArkUI.ArkUI.Full 6423 * @crossplatform 6424 * @atomicservice 6425 * @since 11 6426 */ 6427declare interface ForegroundBlurStyleOptions extends BlurStyleOptions {} 6428 6429 6430/** 6431 * Defines the options of blur 6432 * 6433 * @interface BlurOptions 6434 * @syscap SystemCapability.ArkUI.ArkUI.Full 6435 * @crossplatform 6436 * @since 11 6437 */ 6438/** 6439 * Defines the options of blur 6440 * 6441 * @interface BlurOptions 6442 * @syscap SystemCapability.ArkUI.ArkUI.Full 6443 * @crossplatform 6444 * @atomicservice 6445 * @since 12 6446 */ 6447declare interface BlurOptions { 6448 /** 6449 * Fuzzy gray scale parameter. 6450 * @type { [number, number] } 6451 * @syscap SystemCapability.ArkUI.ArkUI.Full 6452 * @crossplatform 6453 * @since 11 6454 */ 6455 /** 6456 * Fuzzy gray scale parameter. 6457 * @type { [number, number] } 6458 * @syscap SystemCapability.ArkUI.ArkUI.Full 6459 * @crossplatform 6460 * @atomicservice 6461 * @since 12 6462 */ 6463 grayscale: [number, number]; 6464} 6465 6466/** 6467 * Defines the options of blurStyle 6468 * 6469 * @interface BlurStyleOptions 6470 * @syscap SystemCapability.ArkUI.ArkUI.Full 6471 * @crossplatform 6472 * @since 10 6473 */ 6474/** 6475 * Defines the options of blurStyle 6476 * 6477 * @interface BlurStyleOptions 6478 * @syscap SystemCapability.ArkUI.ArkUI.Full 6479 * @crossplatform 6480 * @atomicservice 6481 * @since 11 6482 */ 6483declare interface BlurStyleOptions { 6484 /** 6485 * color mode 6486 * 6487 * @type { ?ThemeColorMode } 6488 * @default ThemeColorMode.SYSTEM 6489 * @syscap SystemCapability.ArkUI.ArkUI.Full 6490 * @since 10 6491 */ 6492 /** 6493 * color mode 6494 * 6495 * @type { ?ThemeColorMode } 6496 * @default ThemeColorMode.SYSTEM 6497 * @syscap SystemCapability.ArkUI.ArkUI.Full 6498 * @crossplatform 6499 * @atomicservice 6500 * @since 11 6501 */ 6502 colorMode?: ThemeColorMode; 6503 6504 /** 6505 * adaptive color 6506 * 6507 * @type { ?AdaptiveColor } 6508 * @default AdaptiveColor.DEFAULT 6509 * @syscap SystemCapability.ArkUI.ArkUI.Full 6510 * @since 10 6511 */ 6512 /** 6513 * adaptive color 6514 * 6515 * @type { ?AdaptiveColor } 6516 * @default AdaptiveColor.DEFAULT 6517 * @syscap SystemCapability.ArkUI.ArkUI.Full 6518 * @crossplatform 6519 * @atomicservice 6520 * @since 11 6521 */ 6522 adaptiveColor?: AdaptiveColor; 6523 6524 /** 6525 * Define the scale of blur effect. 6526 * The range of value is [0, 1]. The larger the value, the more obvious the blurring effect. 6527 * A value of 0 indicates no blur effect and a value of 1 indicates a complete blur effect. 6528 * 6529 * @type { ?number } 6530 * @default 1.0 6531 * @syscap SystemCapability.ArkUI.ArkUI.Full 6532 * @atomicservice 6533 * @since 12 6534 */ 6535 scale?: number; 6536 6537 /** 6538 * Defines the options of blur 6539 * 6540 * @type { ?BlurOptions } 6541 * @default { grayScale: [0,0] } 6542 * @syscap SystemCapability.ArkUI.ArkUI.Full 6543 * @crossplatform 6544 * @since 11 6545 */ 6546 /** 6547 * Defines the options of blur 6548 * 6549 * @type { ?BlurOptions } 6550 * @default { grayScale: [0,0] } 6551 * @syscap SystemCapability.ArkUI.ArkUI.Full 6552 * @crossplatform 6553 * @atomicservice 6554 * @since 12 6555 */ 6556 blurOptions?: BlurOptions; 6557} 6558 6559/** 6560 * Defines the options of BackgroundEffect 6561 * 6562 * @interface BackgroundEffectOptions 6563 * @syscap SystemCapability.ArkUI.ArkUI.Full 6564 * @crossplatform 6565 * @since 11 6566 */ 6567/** 6568 * Defines the options of BackgroundEffect 6569 * 6570 * @interface BackgroundEffectOptions 6571 * @syscap SystemCapability.ArkUI.ArkUI.Full 6572 * @crossplatform 6573 * @atomicservice 6574 * @since 12 6575 */ 6576declare interface BackgroundEffectOptions { 6577 6578 /** 6579 * Define the radius size of BackgroundEffect.The range of this value is [0, ∞) 6580 * 6581 * @type { number } 6582 * @syscap SystemCapability.ArkUI.ArkUI.Full 6583 * @crossplatform 6584 * @since 11 6585 */ 6586 /** 6587 * Define the radius size of BackgroundEffect.The range of this value is [0, ∞) 6588 * 6589 * @type { number } 6590 * @syscap SystemCapability.ArkUI.ArkUI.Full 6591 * @crossplatform 6592 * @atomicservice 6593 * @since 12 6594 */ 6595 radius: number; 6596 6597 /** 6598 * Define the saturation of BackgroundEffect. Value range [0, ∞) 6599 * 6600 * @type { ?number } 6601 * @default 1 6602 * @syscap SystemCapability.ArkUI.ArkUI.Full 6603 * @crossplatform 6604 * @since 11 6605 */ 6606 /** 6607 * Define the saturation of BackgroundEffect. Value range [0, ∞) 6608 * 6609 * @type { ?number } 6610 * @default 1 6611 * @syscap SystemCapability.ArkUI.ArkUI.Full 6612 * @crossplatform 6613 * @atomicservice 6614 * @since 12 6615 */ 6616 saturation?: number; 6617 6618 /** 6619 * Define the brightness of BackgroundEffect. Value range [0, ∞) 6620 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 6621 * @type { ?number } 6622 * @default 1 6623 * @syscap SystemCapability.ArkUI.ArkUI.Full 6624 * @crossplatform 6625 * @since 11 6626 */ 6627 /** 6628 * Define the brightness of BackgroundEffect. Value range [0, ∞) 6629 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 6630 * @type { ?number } 6631 * @default 1 6632 * @syscap SystemCapability.ArkUI.ArkUI.Full 6633 * @crossplatform 6634 * @atomicservice 6635 * @since 12 6636 */ 6637 brightness?: number; 6638 6639 /** 6640 * color the brightness of BackgroundEffect. 6641 * 6642 * @type { ?ResourceColor } 6643 * @default Color.Transparent 6644 * @syscap SystemCapability.ArkUI.ArkUI.Full 6645 * @crossplatform 6646 * @since 11 6647 */ 6648 /** 6649 * color the brightness of BackgroundEffect. 6650 * 6651 * @type { ?ResourceColor } 6652 * @default Color.Transparent 6653 * @syscap SystemCapability.ArkUI.ArkUI.Full 6654 * @crossplatform 6655 * @atomicservice 6656 * @since 12 6657 */ 6658 color?: ResourceColor; 6659 6660 /** 6661 * Define the adaptiveColor of BackgroundEffect. 6662 * 6663 * @type { ?AdaptiveColor } 6664 * @default AdaptiveColor.DEFAULT 6665 * @syscap SystemCapability.ArkUI.ArkUI.Full 6666 * @crossplatform 6667 * @since 11 6668 */ 6669 /** 6670 * Define the adaptiveColor of BackgroundEffect. 6671 * 6672 * @type { ?AdaptiveColor } 6673 * @default AdaptiveColor.DEFAULT 6674 * @syscap SystemCapability.ArkUI.ArkUI.Full 6675 * @crossplatform 6676 * @atomicservice 6677 * @since 12 6678 */ 6679 adaptiveColor?: AdaptiveColor; 6680 6681 /** 6682 * Define the blurOptions of BackgroundEffect. 6683 * 6684 * @type { ?BlurOptions } 6685 * @default { grayScale: [0,1] } 6686 * @syscap SystemCapability.ArkUI.ArkUI.Full 6687 * @crossplatform 6688 * @since 11 6689 */ 6690 /** 6691 * Define the blurOptions of BackgroundEffect. 6692 * 6693 * @type { ?BlurOptions } 6694 * @default { grayScale: [0,0] } 6695 * @syscap SystemCapability.ArkUI.ArkUI.Full 6696 * @crossplatform 6697 * @atomicservice 6698 * @since 12 6699 */ 6700 blurOptions?: BlurOptions; 6701 6702 /** 6703 * Defines the policy for activating the blur style. 6704 * 6705 * @type { ?BlurStyleActivePolicy } 6706 * @default BlurStyleActivePolicy.ALWAYS_ACTIVE 6707 * @syscap SystemCapability.ArkUI.ArkUI.Full 6708 * @crossplatform 6709 * @atomicservice 6710 * @since 14 6711 */ 6712 policy?: BlurStyleActivePolicy; 6713 6714 /** 6715 * Color of the background effect when the window is not focused. 6716 * 6717 * @type { ?ResourceColor } 6718 * @default Color.Transparent 6719 * @syscap SystemCapability.ArkUI.ArkUI.Full 6720 * @crossplatform 6721 * @atomicservice 6722 * @since 14 6723 */ 6724 inactiveColor?: ResourceColor; 6725} 6726 6727/** 6728 * Defines the options of ForegroundEffect 6729 * 6730 * @interface ForegroundEffectOptions 6731 * @syscap SystemCapability.ArkUI.ArkUI.Full 6732 * @crossplatform 6733 * @atomicservice 6734 * @since 12 6735 */ 6736declare interface ForegroundEffectOptions { 6737 6738 /** 6739 * Define the radius size of ForegroundEffect.The range of this value is [0, ∞) 6740 * 6741 * @type { number } 6742 * @syscap SystemCapability.ArkUI.ArkUI.Full 6743 * @crossplatform 6744 * @atomicservice 6745 * @since 12 6746 */ 6747 radius: number; 6748} 6749 6750/** 6751 * Provide an interface for the text style of picker 6752 * 6753 * @interface PickerTextStyle 6754 * @syscap SystemCapability.ArkUI.ArkUI.Full 6755 * @crossplatform 6756 * @since 10 6757 */ 6758/** 6759 * Provide an interface for the text style of picker 6760 * 6761 * @interface PickerTextStyle 6762 * @syscap SystemCapability.ArkUI.ArkUI.Full 6763 * @crossplatform 6764 * @atomicservice 6765 * @since 11 6766 */ 6767declare interface PickerTextStyle { 6768 /** 6769 * Define the text color of picker. 6770 * 6771 * @type { ?ResourceColor } 6772 * @syscap SystemCapability.ArkUI.ArkUI.Full 6773 * @crossplatform 6774 * @since 10 6775 */ 6776 /** 6777 * Define the text color of picker. 6778 * 6779 * @type { ?ResourceColor } 6780 * @syscap SystemCapability.ArkUI.ArkUI.Full 6781 * @crossplatform 6782 * @atomicservice 6783 * @since 11 6784 */ 6785 color?: ResourceColor; 6786 6787 /** 6788 * Define the text font of picker. 6789 * Only support size and weight. 6790 * 6791 * @type { ?Font } 6792 * @syscap SystemCapability.ArkUI.ArkUI.Full 6793 * @crossplatform 6794 * @since 10 6795 */ 6796 /** 6797 * Define the text font of picker. 6798 * Only support size and weight. 6799 * 6800 * @type { ?Font } 6801 * @syscap SystemCapability.ArkUI.ArkUI.Full 6802 * @crossplatform 6803 * @atomicservice 6804 * @since 11 6805 */ 6806 font?: Font; 6807} 6808 6809/** 6810 * Provide an interface for the button style of picker 6811 * 6812 * @interface PickerDialogButtonStyle 6813 * @syscap SystemCapability.ArkUI.ArkUI.Full 6814 * @crossplatform 6815 * @atomicservice 6816 * @since 12 6817 */ 6818declare interface PickerDialogButtonStyle { 6819 /** 6820 * Describes the button style. 6821 * 6822 * @type { ?ButtonType } 6823 * @syscap SystemCapability.ArkUI.ArkUI.Full 6824 * @crossplatform 6825 * @atomicservice 6826 * @since 12 6827 */ 6828 type?: ButtonType; 6829 6830 /** 6831 * Describes the button style. 6832 * 6833 * @type { ?ButtonStyleMode } 6834 * @syscap SystemCapability.ArkUI.ArkUI.Full 6835 * @crossplatform 6836 * @atomicservice 6837 * @since 12 6838 */ 6839 style?: ButtonStyleMode; 6840 6841 /** 6842 * Describes the button role. 6843 * 6844 * @type { ?ButtonRole } 6845 * @syscap SystemCapability.ArkUI.ArkUI.Full 6846 * @crossplatform 6847 * @atomicservice 6848 * @since 12 6849 */ 6850 role?: ButtonRole; 6851 6852 /** 6853 * Describes the button text size. 6854 * 6855 * @type { ?Length } 6856 * @syscap SystemCapability.ArkUI.ArkUI.Full 6857 * @crossplatform 6858 * @atomicservice 6859 * @since 12 6860 */ 6861 fontSize?: Length; 6862 6863 /** 6864 * Describes the button text color. 6865 * 6866 * @type { ?ResourceColor } 6867 * @syscap SystemCapability.ArkUI.ArkUI.Full 6868 * @crossplatform 6869 * @atomicservice 6870 * @since 12 6871 */ 6872 fontColor?: ResourceColor; 6873 6874 /** 6875 * Describes the button font weight. 6876 * 6877 * @type { ?(FontWeight | number | string) } 6878 * @syscap SystemCapability.ArkUI.ArkUI.Full 6879 * @crossplatform 6880 * @atomicservice 6881 * @since 12 6882 */ 6883 fontWeight?: FontWeight | number | string; 6884 6885 /** 6886 * Describes the button font style. 6887 * 6888 * @type { ?FontStyle } 6889 * @syscap SystemCapability.ArkUI.ArkUI.Full 6890 * @crossplatform 6891 * @atomicservice 6892 * @since 12 6893 */ 6894 fontStyle?: FontStyle; 6895 6896 /** 6897 * Describes the button font family. 6898 * 6899 * @type { ?(Resource | string) } 6900 * @syscap SystemCapability.ArkUI.ArkUI.Full 6901 * @crossplatform 6902 * @atomicservice 6903 * @since 12 6904 */ 6905 fontFamily?: Resource | string; 6906 6907 /** 6908 * Describes the button background color. 6909 * 6910 * @type { ?ResourceColor } 6911 * @syscap SystemCapability.ArkUI.ArkUI.Full 6912 * @crossplatform 6913 * @atomicservice 6914 * @since 12 6915 */ 6916 backgroundColor?: ResourceColor; 6917 6918 /** 6919 * Describes the button border radius. 6920 * 6921 * @type { ?(Length | BorderRadiuses) } 6922 * @syscap SystemCapability.ArkUI.ArkUI.Full 6923 * @crossplatform 6924 * @atomicservice 6925 * @since 12 6926 */ 6927 borderRadius?: Length | BorderRadiuses; 6928 6929 /** 6930 * Define whether the button default to responding to the Enter key 6931 * 6932 * @type { ?boolean } 6933 * @syscap SystemCapability.ArkUI.ArkUI.Full 6934 * @crossplatform 6935 * @atomicservice 6936 * @since 12 6937 */ 6938 primary?: boolean; 6939} 6940 6941/** 6942 * Define the type of shadow 6943 * 6944 * @enum { number } 6945 * @syscap SystemCapability.ArkUI.ArkUI.Full 6946 * @crossplatform 6947 * @since 10 6948 */ 6949/** 6950 * Define the type of shadow 6951 * 6952 * @enum { number } 6953 * @syscap SystemCapability.ArkUI.ArkUI.Full 6954 * @crossplatform 6955 * @atomicservice 6956 * @since 11 6957 */ 6958declare enum ShadowType { 6959 /** 6960 * Define a color type of shadow 6961 * 6962 * @syscap SystemCapability.ArkUI.ArkUI.Full 6963 * @crossplatform 6964 * @since 10 6965 */ 6966 /** 6967 * Define a color type of shadow 6968 * 6969 * @syscap SystemCapability.ArkUI.ArkUI.Full 6970 * @crossplatform 6971 * @atomicservice 6972 * @since 11 6973 */ 6974 COLOR, 6975 6976 /** 6977 * Define a blur type of shadow 6978 * 6979 * @syscap SystemCapability.ArkUI.ArkUI.Full 6980 * @crossplatform 6981 * @since 10 6982 */ 6983 /** 6984 * Define a blur type of shadow 6985 * 6986 * @syscap SystemCapability.ArkUI.ArkUI.Full 6987 * @crossplatform 6988 * @atomicservice 6989 * @since 11 6990 */ 6991 BLUR, 6992} 6993 6994/** 6995 * Define the options of shadow 6996 * 6997 * @interface ShadowOptions 6998 * @syscap SystemCapability.ArkUI.ArkUI.Full 6999 * @since 7 7000 */ 7001/** 7002 * Define the options of shadow 7003 * 7004 * @interface ShadowOptions 7005 * @syscap SystemCapability.ArkUI.ArkUI.Full 7006 * @form 7007 * @since 9 7008 */ 7009/** 7010 * Define the options of shadow 7011 * 7012 * @interface ShadowOptions 7013 * @syscap SystemCapability.ArkUI.ArkUI.Full 7014 * @crossplatform 7015 * @form 7016 * @since 10 7017 */ 7018/** 7019 * Define the options of shadow 7020 * 7021 * @interface ShadowOptions 7022 * @syscap SystemCapability.ArkUI.ArkUI.Full 7023 * @crossplatform 7024 * @form 7025 * @atomicservice 7026 * @since 11 7027 */ 7028declare interface ShadowOptions { 7029 /** 7030 * Define the radius size of shadow 7031 * 7032 * @type { number | Resource } 7033 * @syscap SystemCapability.ArkUI.ArkUI.Full 7034 * @since 7 7035 */ 7036 /** 7037 * Define the radius size of shadow 7038 * 7039 * @type { number | Resource } 7040 * @syscap SystemCapability.ArkUI.ArkUI.Full 7041 * @form 7042 * @since 9 7043 */ 7044 /** 7045 * Define the radius size of shadow 7046 * 7047 * @type { number | Resource } 7048 * @syscap SystemCapability.ArkUI.ArkUI.Full 7049 * @crossplatform 7050 * @form 7051 * @since 10 7052 */ 7053 /** 7054 * Define the radius size of shadow 7055 * 7056 * @type { number | Resource } 7057 * @syscap SystemCapability.ArkUI.ArkUI.Full 7058 * @crossplatform 7059 * @form 7060 * @atomicservice 7061 * @since 11 7062 */ 7063 radius: number | Resource; 7064 7065 /** 7066 * Define the type of shadow 7067 * 7068 * @type { ?ShadowType } 7069 * @default ShadowType.COLOR 7070 * @syscap SystemCapability.ArkUI.ArkUI.Full 7071 * @crossplatform 7072 * @since 10 7073 */ 7074 /** 7075 * Define the type of shadow 7076 * 7077 * @type { ?ShadowType } 7078 * @default ShadowType.COLOR 7079 * @syscap SystemCapability.ArkUI.ArkUI.Full 7080 * @crossplatform 7081 * @atomicservice 7082 * @since 11 7083 */ 7084 type?: ShadowType; 7085 7086 /** 7087 * Define the color of shadow 7088 * 7089 * @type { ?(Color | string | Resource) } 7090 * @syscap SystemCapability.ArkUI.ArkUI.Full 7091 * @since 7 7092 */ 7093 /** 7094 * Define the color of shadow 7095 * 7096 * @type { ?(Color | string | Resource) } 7097 * @syscap SystemCapability.ArkUI.ArkUI.Full 7098 * @form 7099 * @since 9 7100 */ 7101 /** 7102 * Define the color of shadow 7103 * 7104 * @type { ?(Color | string | Resource) } 7105 * @syscap SystemCapability.ArkUI.ArkUI.Full 7106 * @crossplatform 7107 * @form 7108 * @since 10 7109 */ 7110 /** 7111 * Define the color or the color strategy of shadow 7112 * 7113 * @type { ?(Color | string | Resource| ColoringStrategy) } 7114 * @syscap SystemCapability.ArkUI.ArkUI.Full 7115 * @crossplatform 7116 * @form 7117 * @atomicservice 7118 * @since 11 7119 */ 7120 color?: Color | string | Resource | ColoringStrategy; 7121 7122 /** 7123 * Define the horizontal offset size of shadow 7124 * 7125 * @type { ?(number | Resource) } 7126 * @syscap SystemCapability.ArkUI.ArkUI.Full 7127 * @since 7 7128 */ 7129 /** 7130 * Define the horizontal offset size of shadow 7131 * 7132 * @type { ?(number | Resource) } 7133 * @syscap SystemCapability.ArkUI.ArkUI.Full 7134 * @form 7135 * @since 9 7136 */ 7137 /** 7138 * Define the horizontal offset size of shadow 7139 * 7140 * @type { ?(number | Resource) } 7141 * @syscap SystemCapability.ArkUI.ArkUI.Full 7142 * @crossplatform 7143 * @form 7144 * @since 10 7145 */ 7146 /** 7147 * Define the horizontal offset size of shadow 7148 * 7149 * @type { ?(number | Resource) } 7150 * @syscap SystemCapability.ArkUI.ArkUI.Full 7151 * @crossplatform 7152 * @form 7153 * @atomicservice 7154 * @since 11 7155 */ 7156 offsetX?: number | Resource; 7157 7158 /** 7159 * Define the vertical offset size of shadow 7160 * 7161 * @type { ?(number | Resource) } 7162 * @syscap SystemCapability.ArkUI.ArkUI.Full 7163 * @since 7 7164 */ 7165 /** 7166 * Define the vertical offset size of shadow 7167 * 7168 * @type { ?(number | Resource) } 7169 * @syscap SystemCapability.ArkUI.ArkUI.Full 7170 * @form 7171 * @since 9 7172 */ 7173 /** 7174 * Define the vertical offset size of shadow 7175 * 7176 * @type { ?(number | Resource) } 7177 * @syscap SystemCapability.ArkUI.ArkUI.Full 7178 * @crossplatform 7179 * @form 7180 * @since 10 7181 */ 7182 /** 7183 * Define the vertical offset size of shadow 7184 * 7185 * @type { ?(number | Resource) } 7186 * @syscap SystemCapability.ArkUI.ArkUI.Full 7187 * @crossplatform 7188 * @form 7189 * @atomicservice 7190 * @since 11 7191 */ 7192 offsetY?: number | Resource; 7193 7194 /** 7195 * Define whether the shadow should fill the area 7196 * 7197 * @type { ?boolean } 7198 * @default false 7199 * @syscap SystemCapability.ArkUI.ArkUI.Full 7200 * @crossplatform 7201 * @since 11 7202 */ 7203 /** 7204 * Define whether the shadow should fill the area 7205 * 7206 * @type { ?boolean } 7207 * @default false 7208 * @syscap SystemCapability.ArkUI.ArkUI.Full 7209 * @crossplatform 7210 * @atomicservice 7211 * @since 12 7212 */ 7213 fill?: boolean; 7214} 7215 7216/** 7217 * enum Shadow style 7218 * 7219 * @enum { number } 7220 * @syscap SystemCapability.ArkUI.ArkUI.Full 7221 * @crossplatform 7222 * @since 10 7223 */ 7224/** 7225 * enum Shadow style 7226 * 7227 * @enum { number } 7228 * @syscap SystemCapability.ArkUI.ArkUI.Full 7229 * @crossplatform 7230 * @atomicservice 7231 * @since 11 7232 */ 7233declare enum ShadowStyle { 7234 /** 7235 * Defines the super small default shadow style. 7236 * 7237 * @syscap SystemCapability.ArkUI.ArkUI.Full 7238 * @crossplatform 7239 * @since 10 7240 */ 7241 /** 7242 * Defines the super small default shadow style. 7243 * 7244 * @syscap SystemCapability.ArkUI.ArkUI.Full 7245 * @crossplatform 7246 * @atomicservice 7247 * @since 11 7248 */ 7249 OUTER_DEFAULT_XS, 7250 7251 /** 7252 * Defines the small default shadow style. 7253 * 7254 * @syscap SystemCapability.ArkUI.ArkUI.Full 7255 * @crossplatform 7256 * @since 10 7257 */ 7258 /** 7259 * Defines the small default shadow style. 7260 * 7261 * @syscap SystemCapability.ArkUI.ArkUI.Full 7262 * @crossplatform 7263 * @atomicservice 7264 * @since 11 7265 */ 7266 OUTER_DEFAULT_SM, 7267 7268 /** 7269 * Defines the medium default shadow style. 7270 * 7271 * @syscap SystemCapability.ArkUI.ArkUI.Full 7272 * @crossplatform 7273 * @since 10 7274 */ 7275 /** 7276 * Defines the medium default shadow style. 7277 * 7278 * @syscap SystemCapability.ArkUI.ArkUI.Full 7279 * @crossplatform 7280 * @atomicservice 7281 * @since 11 7282 */ 7283 OUTER_DEFAULT_MD, 7284 7285 /** 7286 * Defines the large default shadow style. 7287 * 7288 * @syscap SystemCapability.ArkUI.ArkUI.Full 7289 * @crossplatform 7290 * @since 10 7291 */ 7292 /** 7293 * Defines the large default shadow style. 7294 * 7295 * @syscap SystemCapability.ArkUI.ArkUI.Full 7296 * @crossplatform 7297 * @atomicservice 7298 * @since 11 7299 */ 7300 OUTER_DEFAULT_LG, 7301 7302 /** 7303 * Defines the small floating shadow style. 7304 * 7305 * @syscap SystemCapability.ArkUI.ArkUI.Full 7306 * @crossplatform 7307 * @since 10 7308 */ 7309 /** 7310 * Defines the small floating shadow style. 7311 * 7312 * @syscap SystemCapability.ArkUI.ArkUI.Full 7313 * @crossplatform 7314 * @atomicservice 7315 * @since 11 7316 */ 7317 OUTER_FLOATING_SM, 7318 7319 /** 7320 * Defines the medium floating shadow style. 7321 * 7322 * @syscap SystemCapability.ArkUI.ArkUI.Full 7323 * @crossplatform 7324 * @since 10 7325 */ 7326 /** 7327 * Defines the medium floating shadow style. 7328 * 7329 * @syscap SystemCapability.ArkUI.ArkUI.Full 7330 * @crossplatform 7331 * @atomicservice 7332 * @since 11 7333 */ 7334 OUTER_FLOATING_MD, 7335} 7336 7337/** 7338 * Defines the options of Shadow. 7339 * 7340 * @interface MultiShadowOptions 7341 * @syscap SystemCapability.ArkUI.ArkUI.Full 7342 * @crossplatform 7343 * @since 10 7344 */ 7345/** 7346 * Defines the options of Shadow. 7347 * 7348 * @interface MultiShadowOptions 7349 * @syscap SystemCapability.ArkUI.ArkUI.Full 7350 * @crossplatform 7351 * @atomicservice 7352 * @since 11 7353 */ 7354declare interface MultiShadowOptions { 7355 /** 7356 * Current shadow radius. 7357 * 7358 * @type { ?(number | Resource) } 7359 * @default 5 7360 * @syscap SystemCapability.ArkUI.ArkUI.Full 7361 * @crossplatform 7362 * @since 10 7363 */ 7364 /** 7365 * Current shadow radius. 7366 * 7367 * @type { ?(number | Resource) } 7368 * @default 20 7369 * @syscap SystemCapability.ArkUI.ArkUI.Full 7370 * @crossplatform 7371 * @atomicservice 7372 * @since 11 7373 */ 7374 radius?: number | Resource; 7375 7376 /** 7377 * Current shadow offsetX. 7378 * 7379 * @type { ?(number | Resource) } 7380 * @default 5 7381 * @syscap SystemCapability.ArkUI.ArkUI.Full 7382 * @crossplatform 7383 * @since 10 7384 */ 7385 /** 7386 * Current shadow offsetX. 7387 * 7388 * @type { ?(number | Resource) } 7389 * @default 5 7390 * @syscap SystemCapability.ArkUI.ArkUI.Full 7391 * @crossplatform 7392 * @atomicservice 7393 * @since 11 7394 */ 7395 offsetX?: number | Resource; 7396 7397 /** 7398 * Current shadow offsetY 7399 * 7400 * @type { ?(number | Resource) } 7401 * @default 5 7402 * @syscap SystemCapability.ArkUI.ArkUI.Full 7403 * @crossplatform 7404 * @since 10 7405 */ 7406 /** 7407 * Current shadow offsetY 7408 * 7409 * @type { ?(number | Resource) } 7410 * @default 5 7411 * @syscap SystemCapability.ArkUI.ArkUI.Full 7412 * @crossplatform 7413 * @atomicservice 7414 * @since 11 7415 */ 7416 offsetY?: number | Resource; 7417} 7418 7419/** 7420 * Enumerates the safe area types. 7421 * 7422 * @enum { number } 7423 * @syscap SystemCapability.ArkUI.ArkUI.Full 7424 * @since 10 7425 */ 7426/** 7427 * Enumerates the safe area types. 7428 * 7429 * @enum { number } 7430 * @syscap SystemCapability.ArkUI.ArkUI.Full 7431 * @crossplatform 7432 * @atomicservice 7433 * @since 11 7434 */ 7435declare enum SafeAreaType { 7436 /** 7437 * Default area of the system, including the status bar and navigation bar. 7438 * 7439 * @syscap SystemCapability.ArkUI.ArkUI.Full 7440 * @since 10 7441 */ 7442 /** 7443 * Default area of the system, including the status bar and navigation bar. 7444 * 7445 * @syscap SystemCapability.ArkUI.ArkUI.Full 7446 * @crossplatform 7447 * @atomicservice 7448 * @since 11 7449 */ 7450 SYSTEM, 7451 7452 /** 7453 * Notch or punch hole. 7454 * 7455 * @syscap SystemCapability.ArkUI.ArkUI.Full 7456 * @since 10 7457 */ 7458 /** 7459 * Notch or punch hole. 7460 * 7461 * @syscap SystemCapability.ArkUI.ArkUI.Full 7462 * @crossplatform 7463 * @atomicservice 7464 * @since 11 7465 */ 7466 CUTOUT, 7467 7468 /** 7469 * Soft keyboard area. 7470 * 7471 * @syscap SystemCapability.ArkUI.ArkUI.Full 7472 * @since 10 7473 */ 7474 /** 7475 * Soft keyboard area. 7476 * 7477 * @syscap SystemCapability.ArkUI.ArkUI.Full 7478 * @crossplatform 7479 * @atomicservice 7480 * @since 11 7481 */ 7482 KEYBOARD 7483} 7484 7485/** 7486 * Enumerates the safe area edges. 7487 * 7488 * @enum { number } 7489 * @syscap SystemCapability.ArkUI.ArkUI.Full 7490 * @since 10 7491 */ 7492/** 7493 * Enumerates the safe area edges. 7494 * 7495 * @enum { number } 7496 * @syscap SystemCapability.ArkUI.ArkUI.Full 7497 * @crossplatform 7498 * @atomicservice 7499 * @since 11 7500 */ 7501declare enum SafeAreaEdge { 7502 /** 7503 * Top edge of the safe area. 7504 * 7505 * @syscap SystemCapability.ArkUI.ArkUI.Full 7506 * @since 10 7507 */ 7508 /** 7509 * Top edge of the safe area. 7510 * 7511 * @syscap SystemCapability.ArkUI.ArkUI.Full 7512 * @crossplatform 7513 * @atomicservice 7514 * @since 11 7515 */ 7516 TOP, 7517 7518 /** 7519 * Bottom edge of the safe area. 7520 * 7521 * @syscap SystemCapability.ArkUI.ArkUI.Full 7522 * @since 10 7523 */ 7524 /** 7525 * Bottom edge of the safe area. 7526 * 7527 * @syscap SystemCapability.ArkUI.ArkUI.Full 7528 * @crossplatform 7529 * @atomicservice 7530 * @since 11 7531 */ 7532 BOTTOM, 7533 7534 /** 7535 * Start edge of the safe area. 7536 * 7537 * @syscap SystemCapability.ArkUI.ArkUI.Full 7538 * @since 10 7539 */ 7540 /** 7541 * Start edge of the safe area. 7542 * 7543 * @syscap SystemCapability.ArkUI.ArkUI.Full 7544 * @crossplatform 7545 * @atomicservice 7546 * @since 11 7547 */ 7548 START, 7549 7550 /** 7551 * End edge of the safe area. 7552 * 7553 * @syscap SystemCapability.ArkUI.ArkUI.Full 7554 * @since 10 7555 */ 7556 /** 7557 * End edge of the safe area. 7558 * 7559 * @syscap SystemCapability.ArkUI.ArkUI.Full 7560 * @crossplatform 7561 * @atomicservice 7562 * @since 11 7563 */ 7564 END 7565} 7566 7567/** 7568 * Enumerates the safe area types can be ignored. 7569 * 7570 * @enum { number } 7571 * @syscap SystemCapability.ArkUI.ArkUI.Full 7572 * @crossplatform 7573 * @atomicservice 7574 * @since 12 7575 */ 7576declare enum LayoutSafeAreaType { 7577 /** 7578 * Default area of the system, including the status bar and navigation bar. 7579 * 7580 * @syscap SystemCapability.ArkUI.ArkUI.Full 7581 * @crossplatform 7582 * @atomicservice 7583 * @since 12 7584 */ 7585 SYSTEM = 0, 7586} 7587 7588/** 7589 * Enumerates the safe area edges can be ignored. 7590 * 7591 * @enum { number } 7592 * @syscap SystemCapability.ArkUI.ArkUI.Full 7593 * @crossplatform 7594 * @atomicservice 7595 * @since 12 7596 */ 7597declare enum LayoutSafeAreaEdge { 7598 /** 7599 * Top edge of the safe area. 7600 * 7601 * @syscap SystemCapability.ArkUI.ArkUI.Full 7602 * @crossplatform 7603 * @atomicservice 7604 * @since 12 7605 */ 7606 TOP = 0, 7607 7608 /** 7609 * Bottom edge of the safe area. 7610 * 7611 * @syscap SystemCapability.ArkUI.ArkUI.Full 7612 * @crossplatform 7613 * @atomicservice 7614 * @since 12 7615 */ 7616 BOTTOM = 1, 7617} 7618 7619/** 7620 * Defines sheet size type. 7621 * 7622 * @enum { number } 7623 * @syscap SystemCapability.ArkUI.ArkUI.Full 7624 * @crossplatform 7625 * @since 10 7626 */ 7627/** 7628 * Defines sheet size type. 7629 * 7630 * @enum { number } 7631 * @syscap SystemCapability.ArkUI.ArkUI.Full 7632 * @crossplatform 7633 * @atomicservice 7634 * @since 11 7635 */ 7636declare enum SheetSize { 7637 /** 7638 * Defines the sheet size medium height type. The height is half the screen height 7639 * 7640 * @syscap SystemCapability.ArkUI.ArkUI.Full 7641 * @crossplatform 7642 * @since 10 7643 */ 7644 /** 7645 * Defines the sheet size medium height type. The height is half the screen height 7646 * 7647 * @syscap SystemCapability.ArkUI.ArkUI.Full 7648 * @crossplatform 7649 * @atomicservice 7650 * @since 11 7651 */ 7652 MEDIUM, 7653 7654 /** 7655 * Defines the sheet size large height type. The height is almost screen height. 7656 * 7657 * @syscap SystemCapability.ArkUI.ArkUI.Full 7658 * @crossplatform 7659 * @since 10 7660 */ 7661 /** 7662 * Defines the sheet size large height type. The height is almost screen height. 7663 * 7664 * @syscap SystemCapability.ArkUI.ArkUI.Full 7665 * @crossplatform 7666 * @atomicservice 7667 * @since 11 7668 */ 7669 LARGE, 7670 7671 /** 7672 * Defines the sheet size fit content height type. The height fit content. 7673 * 7674 * @syscap SystemCapability.ArkUI.ArkUI.Full 7675 * @crossplatform 7676 * @since 11 7677 */ 7678 /** 7679 * Defines the sheet size fit content height type. The height fit content. 7680 * 7681 * @syscap SystemCapability.ArkUI.ArkUI.Full 7682 * @crossplatform 7683 * @atomicservice 7684 * @since 12 7685 */ 7686 FIT_CONTENT = 2, 7687} 7688 7689/** 7690 * Defines the base event. 7691 * 7692 * @interface BaseEvent 7693 * @syscap SystemCapability.ArkUI.ArkUI.Full 7694 * @since 8 7695 */ 7696/** 7697 * Defines the base event. 7698 * 7699 * @interface BaseEvent 7700 * @syscap SystemCapability.ArkUI.ArkUI.Full 7701 * @form 7702 * @since 9 7703 */ 7704/** 7705 * Defines the base event. 7706 * 7707 * @interface BaseEvent 7708 * @syscap SystemCapability.ArkUI.ArkUI.Full 7709 * @crossplatform 7710 * @form 7711 * @since 10 7712 */ 7713/** 7714 * Defines the base event. 7715 * 7716 * @interface BaseEvent 7717 * @syscap SystemCapability.ArkUI.ArkUI.Full 7718 * @crossplatform 7719 * @form 7720 * @atomicservice 7721 * @since 11 7722 */ 7723declare interface BaseEvent { 7724 /** 7725 * Defines the current target which fires this event. 7726 * 7727 * @type { EventTarget } 7728 * @syscap SystemCapability.ArkUI.ArkUI.Full 7729 * @since 8 7730 */ 7731 /** 7732 * Defines the current target which fires this event. 7733 * 7734 * @type { EventTarget } 7735 * @syscap SystemCapability.ArkUI.ArkUI.Full 7736 * @form 7737 * @since 9 7738 */ 7739 /** 7740 * Defines the current target which fires this event. 7741 * 7742 * @type { EventTarget } 7743 * @syscap SystemCapability.ArkUI.ArkUI.Full 7744 * @crossplatform 7745 * @form 7746 * @since 10 7747 */ 7748 /** 7749 * Defines the current target which fires this event. 7750 * 7751 * @type { EventTarget } 7752 * @syscap SystemCapability.ArkUI.ArkUI.Full 7753 * @crossplatform 7754 * @form 7755 * @atomicservice 7756 * @since 11 7757 */ 7758 target: EventTarget; 7759 7760 /** 7761 * Event timestamp. 7762 * 7763 * @type { number } 7764 * @syscap SystemCapability.ArkUI.ArkUI.Full 7765 * @since 8 7766 */ 7767 /** 7768 * Event timestamp. 7769 * 7770 * @type { number } 7771 * @syscap SystemCapability.ArkUI.ArkUI.Full 7772 * @form 7773 * @since 9 7774 */ 7775 /** 7776 * Event timestamp. 7777 * 7778 * @type { number } 7779 * @syscap SystemCapability.ArkUI.ArkUI.Full 7780 * @crossplatform 7781 * @form 7782 * @since 10 7783 */ 7784 /** 7785 * Event timestamp. 7786 * 7787 * @type { number } 7788 * @syscap SystemCapability.ArkUI.ArkUI.Full 7789 * @crossplatform 7790 * @form 7791 * @atomicservice 7792 * @since 11 7793 */ 7794 timestamp: number; 7795 7796 /** 7797 * the event source info. 7798 * 7799 * @type { SourceType } 7800 * @syscap SystemCapability.ArkUI.ArkUI.Full 7801 * @since 8 7802 */ 7803 /** 7804 * the event source info. 7805 * 7806 * @type { SourceType } 7807 * @syscap SystemCapability.ArkUI.ArkUI.Full 7808 * @form 7809 * @since 9 7810 */ 7811 /** 7812 * the event source info. 7813 * 7814 * @type { SourceType } 7815 * @syscap SystemCapability.ArkUI.ArkUI.Full 7816 * @crossplatform 7817 * @form 7818 * @since 10 7819 */ 7820 /** 7821 * the event source info. 7822 * 7823 * @type { SourceType } 7824 * @syscap SystemCapability.ArkUI.ArkUI.Full 7825 * @crossplatform 7826 * @form 7827 * @atomicservice 7828 * @since 11 7829 */ 7830 source: SourceType; 7831 7832 /** 7833 * the Horizontal axis coordinate. 7834 * 7835 * @type { number } 7836 * @syscap SystemCapability.ArkUI.ArkUI.Full 7837 * @crossplatform 7838 * @form 7839 * @atomicservice 7840 * @since 12 7841 */ 7842 axisHorizontal?: number; 7843 7844 /** 7845 * the Vertical axis coordinate. 7846 * 7847 * @type { number } 7848 * @syscap SystemCapability.ArkUI.ArkUI.Full 7849 * @crossplatform 7850 * @form 7851 * @atomicservice 7852 * @since 12 7853 */ 7854 axisVertical?: number; 7855 7856 /** 7857 * Touch pressure. 7858 * 7859 * @type { number } 7860 * @syscap SystemCapability.ArkUI.ArkUI.Full 7861 * @form 7862 * @since 9 7863 */ 7864 /** 7865 * Touch pressure. 7866 * 7867 * @type { number } 7868 * @syscap SystemCapability.ArkUI.ArkUI.Full 7869 * @crossplatform 7870 * @form 7871 * @since 10 7872 */ 7873 /** 7874 * Touch pressure. 7875 * 7876 * @type { number } 7877 * @syscap SystemCapability.ArkUI.ArkUI.Full 7878 * @crossplatform 7879 * @form 7880 * @atomicservice 7881 * @since 11 7882 */ 7883 pressure: number; 7884 7885 /** 7886 * The angle between pencil projection on plane-X-Y and axis-Z. 7887 * 7888 * @type { number } 7889 * @syscap SystemCapability.ArkUI.ArkUI.Full 7890 * @form 7891 * @since 9 7892 */ 7893 /** 7894 * The angle between pencil projection on plane-X-Y and axis-Z. 7895 * 7896 * @type { number } 7897 * @syscap SystemCapability.ArkUI.ArkUI.Full 7898 * @crossplatform 7899 * @form 7900 * @since 10 7901 */ 7902 /** 7903 * The angle between pencil projection on plane-X-Y and axis-Z. 7904 * 7905 * @type { number } 7906 * @syscap SystemCapability.ArkUI.ArkUI.Full 7907 * @crossplatform 7908 * @form 7909 * @atomicservice 7910 * @since 11 7911 */ 7912 tiltX: number; 7913 7914 /** 7915 * The angle between pencil projection on plane-Y-Z and axis-Z. 7916 * 7917 * @type { number } 7918 * @syscap SystemCapability.ArkUI.ArkUI.Full 7919 * @form 7920 * @since 9 7921 */ 7922 /** 7923 * The angle between pencil projection on plane-Y-Z and axis-Z. 7924 * 7925 * @type { number } 7926 * @syscap SystemCapability.ArkUI.ArkUI.Full 7927 * @crossplatform 7928 * @form 7929 * @since 10 7930 */ 7931 /** 7932 * The angle between pencil projection on plane-Y-Z and axis-Z. 7933 * 7934 * @type { number } 7935 * @syscap SystemCapability.ArkUI.ArkUI.Full 7936 * @crossplatform 7937 * @form 7938 * @atomicservice 7939 * @since 11 7940 */ 7941 tiltY: number; 7942 7943 /** 7944 * The event tool type info. 7945 * 7946 * @type { SourceTool } 7947 * @syscap SystemCapability.ArkUI.ArkUI.Full 7948 * @form 7949 * @since 9 7950 */ 7951 /** 7952 * The event tool type info. 7953 * 7954 * @type { SourceTool } 7955 * @syscap SystemCapability.ArkUI.ArkUI.Full 7956 * @crossplatform 7957 * @form 7958 * @since 10 7959 */ 7960 /** 7961 * The event tool type info. 7962 * 7963 * @type { SourceTool } 7964 * @syscap SystemCapability.ArkUI.ArkUI.Full 7965 * @crossplatform 7966 * @form 7967 * @atomicservice 7968 * @since 11 7969 */ 7970 sourceTool: SourceTool; 7971 7972 /** 7973 * Query the ModifierKey press state, support 'ctrl'|'alt'|'shift'|'fn' 7974 * 7975 * @param { Array<string> } keys - indicate the keys of the ModifierKey. 7976 * @returns { boolean } 7977 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 7978 * @syscap SystemCapability.ArkUI.ArkUI.Full 7979 * @crossplatform 7980 * @atomicservice 7981 * @since 12 7982 */ 7983 getModifierKeyState?(keys: Array<string>): boolean; 7984 7985 /** 7986 * Indicates the ID of the input device that triggers the current event. 7987 * 7988 * @type { ?number } [deviceId] The ID of the input device that triggers the current event 7989 * @syscap SystemCapability.ArkUI.ArkUI.Full 7990 * @crossplatform 7991 * @atomicservice 7992 * @since 12 7993 */ 7994 deviceId?: number; 7995 7996 /** 7997 * Indicates the screen ID on which the event occurred. 7998 * 7999 * @type { ?number } [targetDisplayId] The screen ID on which the event occurred. 8000 * @syscap SystemCapability.ArkUI.ArkUI.Full 8001 * @crossplatform 8002 * @atomicservice 8003 * @since 15 8004 */ 8005 targetDisplayId?: number; 8006} 8007 8008/** 8009 * Border image option 8010 * 8011 * @interface BorderImageOption 8012 * @syscap SystemCapability.ArkUI.ArkUI.Full 8013 * @form 8014 * @since 9 8015 */ 8016/** 8017 * Border image option 8018 * 8019 * @interface BorderImageOption 8020 * @syscap SystemCapability.ArkUI.ArkUI.Full 8021 * @crossplatform 8022 * @form 8023 * @since 10 8024 */ 8025/** 8026 * Border image option 8027 * 8028 * @interface BorderImageOption 8029 * @syscap SystemCapability.ArkUI.ArkUI.Full 8030 * @crossplatform 8031 * @form 8032 * @atomicservice 8033 * @since 11 8034 */ 8035declare interface BorderImageOption { 8036 /** 8037 * Border image slice 8038 * 8039 * @type { ?(Length | EdgeWidths) } 8040 * @syscap SystemCapability.ArkUI.ArkUI.Full 8041 * @form 8042 * @since 9 8043 */ 8044 /** 8045 * Border image slice 8046 * 8047 * @type { ?(Length | EdgeWidths) } 8048 * @syscap SystemCapability.ArkUI.ArkUI.Full 8049 * @crossplatform 8050 * @form 8051 * @since 10 8052 */ 8053 /** 8054 * Border image slice 8055 * 8056 * @type { ?(Length | EdgeWidths) } 8057 * @syscap SystemCapability.ArkUI.ArkUI.Full 8058 * @crossplatform 8059 * @form 8060 * @atomicservice 8061 * @since 11 8062 */ 8063 /** 8064 * Border image slice 8065 * 8066 * @type { ?(Length | EdgeWidths | LocalizedEdgeWidths) } 8067 * @syscap SystemCapability.ArkUI.ArkUI.Full 8068 * @crossplatform 8069 * @form 8070 * @atomicservice 8071 * @since 12 8072 */ 8073 slice?: Length | EdgeWidths | LocalizedEdgeWidths, 8074 8075 /** 8076 * Border image repeat 8077 * 8078 * @type { ?RepeatMode } 8079 * @syscap SystemCapability.ArkUI.ArkUI.Full 8080 * @form 8081 * @since 9 8082 */ 8083 /** 8084 * Border image repeat 8085 * 8086 * @type { ?RepeatMode } 8087 * @syscap SystemCapability.ArkUI.ArkUI.Full 8088 * @crossplatform 8089 * @form 8090 * @since 10 8091 */ 8092 /** 8093 * Border image repeat 8094 * 8095 * @type { ?RepeatMode } 8096 * @syscap SystemCapability.ArkUI.ArkUI.Full 8097 * @crossplatform 8098 * @form 8099 * @atomicservice 8100 * @since 11 8101 */ 8102 repeat?: RepeatMode, 8103 8104 /** 8105 * Border image source 8106 * 8107 * @type { ?(string | Resource | LinearGradient) } 8108 * @syscap SystemCapability.ArkUI.ArkUI.Full 8109 * @form 8110 * @since 9 8111 */ 8112 /** 8113 * Border image source 8114 * 8115 * @type { ?(string | Resource | LinearGradient) } 8116 * @syscap SystemCapability.ArkUI.ArkUI.Full 8117 * @crossplatform 8118 * @form 8119 * @since 10 8120 */ 8121 /** 8122 * Border image source 8123 * 8124 * @type { ?(string | Resource | LinearGradient) } 8125 * @syscap SystemCapability.ArkUI.ArkUI.Full 8126 * @crossplatform 8127 * @form 8128 * @atomicservice 8129 * @since 11 8130 */ 8131 source?: string | Resource | LinearGradient, 8132 8133 /** 8134 * Border image width 8135 * 8136 * @type { ?(Length | EdgeWidths) } 8137 * @syscap SystemCapability.ArkUI.ArkUI.Full 8138 * @form 8139 * @since 9 8140 */ 8141 /** 8142 * Border image width 8143 * 8144 * @type { ?(Length | EdgeWidths) } 8145 * @syscap SystemCapability.ArkUI.ArkUI.Full 8146 * @crossplatform 8147 * @form 8148 * @since 10 8149 */ 8150 /** 8151 * Border image width 8152 * 8153 * @type { ?(Length | EdgeWidths) } 8154 * @syscap SystemCapability.ArkUI.ArkUI.Full 8155 * @crossplatform 8156 * @form 8157 * @atomicservice 8158 * @since 11 8159 */ 8160 /** 8161 * Border image width 8162 * 8163 * @type { ?(Length | EdgeWidths | LocalizedEdgeWidths) } 8164 * @syscap SystemCapability.ArkUI.ArkUI.Full 8165 * @crossplatform 8166 * @form 8167 * @atomicservice 8168 * @since 12 8169 */ 8170 width?: Length | EdgeWidths | LocalizedEdgeWidths, 8171 8172 /** 8173 * Border image outset 8174 * 8175 * @type { ?(Length | EdgeWidths) } 8176 * @syscap SystemCapability.ArkUI.ArkUI.Full 8177 * @form 8178 * @since 9 8179 */ 8180 /** 8181 * Border image outset 8182 * 8183 * @type { ?(Length | EdgeWidths) } 8184 * @syscap SystemCapability.ArkUI.ArkUI.Full 8185 * @crossplatform 8186 * @form 8187 * @since 10 8188 */ 8189 /** 8190 * Border image outset 8191 * 8192 * @type { ?(Length | EdgeWidths) } 8193 * @syscap SystemCapability.ArkUI.ArkUI.Full 8194 * @crossplatform 8195 * @form 8196 * @atomicservice 8197 * @since 11 8198 */ 8199 /** 8200 * Border image outset 8201 * 8202 * @type { ?(Length | EdgeWidths | LocalizedEdgeWidths) } 8203 * @syscap SystemCapability.ArkUI.ArkUI.Full 8204 * @crossplatform 8205 * @form 8206 * @atomicservice 8207 * @since 12 8208 */ 8209 outset?: Length | EdgeWidths | LocalizedEdgeWidths, 8210 8211 /** 8212 * Border image center fill 8213 * 8214 * @type { ?boolean } 8215 * @syscap SystemCapability.ArkUI.ArkUI.Full 8216 * @form 8217 * @since 9 8218 */ 8219 /** 8220 * Border image center fill 8221 * 8222 * @type { ?boolean } 8223 * @syscap SystemCapability.ArkUI.ArkUI.Full 8224 * @crossplatform 8225 * @form 8226 * @since 10 8227 */ 8228 /** 8229 * Border image center fill 8230 * 8231 * @type { ?boolean } 8232 * @syscap SystemCapability.ArkUI.ArkUI.Full 8233 * @crossplatform 8234 * @form 8235 * @atomicservice 8236 * @since 11 8237 */ 8238 fill?: boolean 8239} 8240 8241/** 8242 * Defines the policy of Layout 8243 * 8244 * @syscap SystemCapability.ArkUI.ArkUI.Full 8245 * @crossplatform 8246 * @form 8247 * @atomicservice 8248 * @since 15 8249 */ 8250declare class LayoutPolicy { 8251 /** 8252 * The component fills its parent which means its size is as large as its parent. 8253 * 8254 * @type { LayoutPolicy } 8255 * @readonly 8256 * @static 8257 * @syscap SystemCapability.ArkUI.ArkUI.Full 8258 * @crossplatform 8259 * @form 8260 * @atomicservice 8261 * @since 15 8262 */ 8263 static readonly matchParent: LayoutPolicy; 8264} 8265 8266/** 8267 * The tap action triggers this method invocation. 8268 * 8269 * @extends BaseEvent 8270 * @interface ClickEvent 8271 * @syscap SystemCapability.ArkUI.ArkUI.Full 8272 * @since 7 8273 */ 8274/** 8275 * The tap action triggers this method invocation. 8276 * 8277 * @extends BaseEvent 8278 * @interface ClickEvent 8279 * @syscap SystemCapability.ArkUI.ArkUI.Full 8280 * @form 8281 * @since 9 8282 */ 8283/** 8284 * The tap action triggers this method invocation. 8285 * 8286 * @extends BaseEvent 8287 * @interface ClickEvent 8288 * @syscap SystemCapability.ArkUI.ArkUI.Full 8289 * @crossplatform 8290 * @form 8291 * @since 10 8292 */ 8293/** 8294 * The tap action triggers this method invocation. 8295 * 8296 * @extends BaseEvent 8297 * @interface ClickEvent 8298 * @syscap SystemCapability.ArkUI.ArkUI.Full 8299 * @crossplatform 8300 * @form 8301 * @atomicservice 8302 * @since 11 8303 */ 8304declare interface ClickEvent extends BaseEvent { 8305 /** 8306 * X coordinate of the click point relative to the left edge of the device screen. 8307 * 8308 * @type { number } 8309 * @syscap SystemCapability.ArkUI.ArkUI.Full 8310 * @crossplatform 8311 * @since 10 8312 */ 8313 /** 8314 * X coordinate of the click point relative to the left edge of the device screen. 8315 * 8316 * @type { number } 8317 * @syscap SystemCapability.ArkUI.ArkUI.Full 8318 * @crossplatform 8319 * @atomicservice 8320 * @since 11 8321 */ 8322 displayX: number; 8323 8324 /** 8325 * Y coordinate of the click point relative to the upper edge of the device screen. 8326 * 8327 * @type { number } 8328 * @syscap SystemCapability.ArkUI.ArkUI.Full 8329 * @crossplatform 8330 * @since 10 8331 */ 8332 /** 8333 * Y coordinate of the click point relative to the upper edge of the device screen. 8334 * 8335 * @type { number } 8336 * @syscap SystemCapability.ArkUI.ArkUI.Full 8337 * @crossplatform 8338 * @atomicservice 8339 * @since 11 8340 */ 8341 displayY: number; 8342 8343 /** 8344 * X coordinate of the click point relative to the left edge of the current window. 8345 * 8346 * @type { number } 8347 * @syscap SystemCapability.ArkUI.ArkUI.Full 8348 * @crossplatform 8349 * @since 10 8350 */ 8351 /** 8352 * X coordinate of the click point relative to the left edge of the current window. 8353 * 8354 * @type { number } 8355 * @syscap SystemCapability.ArkUI.ArkUI.Full 8356 * @crossplatform 8357 * @atomicservice 8358 * @since 11 8359 */ 8360 windowX: number; 8361 8362 /** 8363 * Y coordinate of the click point relative to the upper edge of the current window. 8364 * 8365 * @type { number } 8366 * @syscap SystemCapability.ArkUI.ArkUI.Full 8367 * @crossplatform 8368 * @since 10 8369 */ 8370 /** 8371 * Y coordinate of the click point relative to the upper edge of the current window. 8372 * 8373 * @type { number } 8374 * @syscap SystemCapability.ArkUI.ArkUI.Full 8375 * @crossplatform 8376 * @atomicservice 8377 * @since 11 8378 */ 8379 windowY: number; 8380 8381 /** 8382 * X coordinate of the click point relative to the left edge of the current window. 8383 * 8384 * @type { number } 8385 * @syscap SystemCapability.ArkUI.ArkUI.Full 8386 * @since 7 8387 * @deprecated since 10 8388 * @useinstead ClickEvent#windowX 8389 */ 8390 screenX: number; 8391 8392 /** 8393 * Y coordinate of the click point relative to the upper edge of the current window. 8394 * 8395 * @type { number } 8396 * @syscap SystemCapability.ArkUI.ArkUI.Full 8397 * @since 7 8398 * @deprecated since 10 8399 * @useinstead ClickEvent#windowY 8400 */ 8401 screenY: number; 8402 8403 /** 8404 * X coordinate of the click point relative to the left edge of the clicked element. 8405 * 8406 * @type { number } 8407 * @syscap SystemCapability.ArkUI.ArkUI.Full 8408 * @since 7 8409 */ 8410 /** 8411 * X coordinate of the click point relative to the left edge of the clicked element. 8412 * 8413 * @type { number } 8414 * @syscap SystemCapability.ArkUI.ArkUI.Full 8415 * @form 8416 * @since 9 8417 */ 8418 /** 8419 * X coordinate of the click point relative to the left edge of the clicked element. 8420 * 8421 * @type { number } 8422 * @syscap SystemCapability.ArkUI.ArkUI.Full 8423 * @crossplatform 8424 * @form 8425 * @since 10 8426 */ 8427 /** 8428 * X coordinate of the click point relative to the left edge of the clicked element. 8429 * 8430 * @type { number } 8431 * @syscap SystemCapability.ArkUI.ArkUI.Full 8432 * @crossplatform 8433 * @form 8434 * @atomicservice 8435 * @since 11 8436 */ 8437 x: number; 8438 8439 /** 8440 * Y coordinate of the click point relative to the upper edge of the clicked element. 8441 * 8442 * @type { number } 8443 * @syscap SystemCapability.ArkUI.ArkUI.Full 8444 * @since 7 8445 */ 8446 /** 8447 * Y coordinate of the click point relative to the left edge of the clicked element. 8448 * 8449 * @type { number } 8450 * @syscap SystemCapability.ArkUI.ArkUI.Full 8451 * @form 8452 * @since 9 8453 */ 8454 /** 8455 * Y coordinate of the click point relative to the left edge of the clicked element. 8456 * 8457 * @type { number } 8458 * @syscap SystemCapability.ArkUI.ArkUI.Full 8459 * @crossplatform 8460 * @form 8461 * @since 10 8462 */ 8463 /** 8464 * Y coordinate of the click point relative to the left edge of the clicked element. 8465 * 8466 * @type { number } 8467 * @syscap SystemCapability.ArkUI.ArkUI.Full 8468 * @crossplatform 8469 * @form 8470 * @atomicservice 8471 * @since 11 8472 */ 8473 y: number; 8474 8475 /** 8476 * Type of the touch hand. 8477 * 8478 * @type { InteractionHand } 8479 * @syscap SystemCapability.ArkUI.ArkUI.Full 8480 * @crossplatform 8481 * @atomicservice 8482 * @since 15 8483 */ 8484 hand?: InteractionHand; 8485 8486 /** 8487 * Prevent the default function. 8488 * 8489 * @type { function } 8490 * @syscap SystemCapability.ArkUI.ArkUI.Full 8491 * @crossplatform 8492 * @atomicservice 8493 * @since 12 8494 */ 8495 preventDefault: () => void; 8496} 8497 8498/** 8499 * The hover action triggers this method invocation. 8500 * 8501 * @extends BaseEvent 8502 * @interface HoverEvent 8503 * @syscap SystemCapability.ArkUI.ArkUI.Full 8504 * @since 10 8505 */ 8506/** 8507 * The hover action triggers this method invocation. 8508 * 8509 * @extends BaseEvent 8510 * @interface HoverEvent 8511 * @syscap SystemCapability.ArkUI.ArkUI.Full 8512 * @atomicservice 8513 * @since 11 8514 */ 8515declare interface HoverEvent extends BaseEvent { 8516 /** 8517 * X coordinate of the hover point relative to the left edge of the hover element. 8518 * 8519 * @type { number } 8520 * @syscap SystemCapability.ArkUI.ArkUI.Full 8521 * @atomicservice 8522 * @since 15 8523 */ 8524 x?: number; 8525 8526 /** 8527 * Y coordinate of the hover point relative to the upper edge of the hover element. 8528 * 8529 * @type { number } 8530 * @syscap SystemCapability.ArkUI.ArkUI.Full 8531 * @atomicservice 8532 * @since 15 8533 */ 8534 y?: number; 8535 8536 /** 8537 * X coordinate of the hover point relative to the left edge of the current window. 8538 * 8539 * @type { number } 8540 * @syscap SystemCapability.ArkUI.ArkUI.Full 8541 * @atomicservice 8542 * @since 15 8543 */ 8544 windowX?: number; 8545 8546 /** 8547 * Y coordinate of the hover point relative to the upper edge of the current window. 8548 * 8549 * @type { number } 8550 * @syscap SystemCapability.ArkUI.ArkUI.Full 8551 * @atomicservice 8552 * @since 15 8553 */ 8554 windowY?: number; 8555 8556 /** 8557 * X coordinate of the hover point relative to the left edge of the device screen. 8558 * 8559 * @type { number } 8560 * @syscap SystemCapability.ArkUI.ArkUI.Full 8561 * @atomicservice 8562 * @since 15 8563 */ 8564 displayX?: number; 8565 8566 /** 8567 * Y coordinate of the hover point relative to the upper edge of the device screen. 8568 * 8569 * @type { number } 8570 * @syscap SystemCapability.ArkUI.ArkUI.Full 8571 * @atomicservice 8572 * @since 15 8573 */ 8574 displayY?: number; 8575 8576 /** 8577 * The blocking hover event pops up. 8578 * 8579 * @type { function } 8580 * @syscap SystemCapability.ArkUI.ArkUI.Full 8581 * @since 10 8582 */ 8583 /** 8584 * The blocking hover event pops up. 8585 * 8586 * @type { function } 8587 * @syscap SystemCapability.ArkUI.ArkUI.Full 8588 * @atomicservice 8589 * @since 11 8590 */ 8591 stopPropagation: () => void; 8592} 8593 8594/** 8595 * The mouse click action triggers this method invocation. 8596 * 8597 * @extends BaseEvent 8598 * @interface MouseEvent 8599 * @syscap SystemCapability.ArkUI.ArkUI.Full 8600 * @since 8 8601 */ 8602/** 8603 * The mouse click action triggers this method invocation. 8604 * 8605 * @extends BaseEvent 8606 * @interface MouseEvent 8607 * @syscap SystemCapability.ArkUI.ArkUI.Full 8608 * @atomicservice 8609 * @since 11 8610 */ 8611declare interface MouseEvent extends BaseEvent { 8612 /** 8613 * Mouse button of the click event. 8614 * 8615 * @type { MouseButton } 8616 * @syscap SystemCapability.ArkUI.ArkUI.Full 8617 * @since 8 8618 */ 8619 /** 8620 * Mouse button of the click event. 8621 * 8622 * @type { MouseButton } 8623 * @syscap SystemCapability.ArkUI.ArkUI.Full 8624 * @atomicservice 8625 * @since 11 8626 */ 8627 button: MouseButton; 8628 8629 /** 8630 * Mouse action of the click event. 8631 * 8632 * @type { MouseAction } 8633 * @syscap SystemCapability.ArkUI.ArkUI.Full 8634 * @since 8 8635 */ 8636 /** 8637 * Mouse action of the click event. 8638 * 8639 * @type { MouseAction } 8640 * @syscap SystemCapability.ArkUI.ArkUI.Full 8641 * @atomicservice 8642 * @since 11 8643 */ 8644 action: MouseAction; 8645 8646 /** 8647 * X coordinate of the mouse point relative to the left edge of the device screen. 8648 * 8649 * @type { number } 8650 * @syscap SystemCapability.ArkUI.ArkUI.Full 8651 * @since 10 8652 */ 8653 /** 8654 * X coordinate of the mouse point relative to the left edge of the device screen. 8655 * 8656 * @type { number } 8657 * @syscap SystemCapability.ArkUI.ArkUI.Full 8658 * @atomicservice 8659 * @since 11 8660 */ 8661 displayX: number; 8662 8663 /** 8664 * Y coordinate of the mouse point relative to the upper edge of the device screen. 8665 * 8666 * @type { number } 8667 * @syscap SystemCapability.ArkUI.ArkUI.Full 8668 * @since 10 8669 */ 8670 /** 8671 * Y coordinate of the mouse point relative to the upper edge of the device screen. 8672 * 8673 * @type { number } 8674 * @syscap SystemCapability.ArkUI.ArkUI.Full 8675 * @atomicservice 8676 * @since 11 8677 */ 8678 displayY: number; 8679 8680 /** 8681 * X coordinate of the mouse point relative to the left edge of the current window. 8682 * 8683 * @type { number } 8684 * @syscap SystemCapability.ArkUI.ArkUI.Full 8685 * @since 10 8686 */ 8687 /** 8688 * X coordinate of the mouse point relative to the left edge of the current window. 8689 * 8690 * @type { number } 8691 * @syscap SystemCapability.ArkUI.ArkUI.Full 8692 * @atomicservice 8693 * @since 11 8694 */ 8695 windowX: number; 8696 8697 /** 8698 * Y coordinate of the mouse point relative to the upper edge of the current window. 8699 * 8700 * @type { number } 8701 * @syscap SystemCapability.ArkUI.ArkUI.Full 8702 * @since 10 8703 */ 8704 /** 8705 * Y coordinate of the mouse point relative to the upper edge of the current window. 8706 * 8707 * @type { number } 8708 * @syscap SystemCapability.ArkUI.ArkUI.Full 8709 * @atomicservice 8710 * @since 11 8711 */ 8712 windowY: number; 8713 8714 /** 8715 * X coordinate of the mouse point relative to the left edge of the current window. 8716 * 8717 * @type { number } 8718 * @syscap SystemCapability.ArkUI.ArkUI.Full 8719 * @since 8 8720 * @deprecated since 10 8721 * @useinstead MouseEvent#windowX 8722 */ 8723 screenX: number; 8724 8725 /** 8726 * Y coordinate of the mouse point relative to the upper edge of the current window. 8727 * 8728 * @type { number } 8729 * @syscap SystemCapability.ArkUI.ArkUI.Full 8730 * @since 8 8731 * @deprecated since 10 8732 * @useinstead MouseEvent#windowY 8733 */ 8734 screenY: number; 8735 8736 /** 8737 * X coordinate of the mouse point relative to the left edge of the mouse hit element. 8738 * 8739 * @type { number } 8740 * @syscap SystemCapability.ArkUI.ArkUI.Full 8741 * @since 8 8742 */ 8743 /** 8744 * X coordinate of the mouse point relative to the left edge of the mouse hit element. 8745 * 8746 * @type { number } 8747 * @syscap SystemCapability.ArkUI.ArkUI.Full 8748 * @atomicservice 8749 * @since 11 8750 */ 8751 x: number; 8752 8753 /** 8754 * Y coordinate of the mouse point relative to the upper edge of the mouse hit element. 8755 * 8756 * @type { number } 8757 * @syscap SystemCapability.ArkUI.ArkUI.Full 8758 * @since 8 8759 */ 8760 /** 8761 * Y coordinate of the mouse point relative to the upper edge of the mouse hit element. 8762 * 8763 * @type { number } 8764 * @syscap SystemCapability.ArkUI.ArkUI.Full 8765 * @atomicservice 8766 * @since 11 8767 */ 8768 y: number; 8769 8770 /** 8771 * The blocking event pops up. 8772 * 8773 * @type { function } 8774 * @syscap SystemCapability.ArkUI.ArkUI.Full 8775 * @since 8 8776 */ 8777 /** 8778 * The blocking event pops up. 8779 * 8780 * @type { function } 8781 * @syscap SystemCapability.ArkUI.ArkUI.Full 8782 * @atomicservice 8783 * @since 11 8784 */ 8785 stopPropagation: () => void; 8786 8787 /** 8788 * X axis offset relative to the previous reported mouse pointer position. When the mouse pointer is at 8789 * the edge of the screen, the value may be less than the difference of the X coordinate reported twice. 8790 * 8791 * @type { ?number } 8792 * @syscap SystemCapability.ArkUI.ArkUI.Full 8793 * @atomicservice 8794 * @since 15 8795 */ 8796 rawDeltaX?: number; 8797 8798 /** 8799 * Y axis offset relative to the previous reported mouse pointer position. When the mouse pointer is at 8800 * the edge of the screen, the value may be less than the difference of the Y coordinate reported twice. 8801 * 8802 * @type { ?number } 8803 * @syscap SystemCapability.ArkUI.ArkUI.Full 8804 * @atomicservice 8805 * @since 15 8806 */ 8807 rawDeltaY?: number; 8808 8809 /** 8810 * The pressed buttons of the mouse event. 8811 * 8812 * @type { ?MouseButton[] } 8813 * @syscap SystemCapability.ArkUI.ArkUI.Full 8814 * @atomicservice 8815 * @since 15 8816 */ 8817 pressedButtons?: MouseButton[]; 8818} 8819 8820/** 8821 * The accessibility hover action triggers this method invocation. 8822 * 8823 * @extends BaseEvent 8824 * @typedef AccessibilityHoverEvent 8825 * @syscap SystemCapability.ArkUI.ArkUI.Full 8826 * @atomicservice 8827 * @since 12 8828 */ 8829declare interface AccessibilityHoverEvent extends BaseEvent { 8830 /** 8831 * Type of the accessibility hover event. 8832 * 8833 * @type { AccessibilityHoverType } 8834 * @syscap SystemCapability.ArkUI.ArkUI.Full 8835 * @atomicservice 8836 * @since 12 8837 */ 8838 type: AccessibilityHoverType; 8839 8840 /** 8841 * X coordinate of the accessibility hover point relative to the left edge of the event hit element. 8842 * 8843 * @type { number } 8844 * @syscap SystemCapability.ArkUI.ArkUI.Full 8845 * @atomicservice 8846 * @since 12 8847 */ 8848 x: number; 8849 8850 /** 8851 * Y coordinate of the accessibility hover point relative to the upper edge of the event hit element. 8852 * 8853 * @type { number } 8854 * @syscap SystemCapability.ArkUI.ArkUI.Full 8855 * @atomicservice 8856 * @since 12 8857 */ 8858 y: number; 8859 8860 /** 8861 * X coordinate of the accessibility hover point relative to the left edge of the device screen. 8862 * 8863 * @type { number } 8864 * @syscap SystemCapability.ArkUI.ArkUI.Full 8865 * @atomicservice 8866 * @since 12 8867 */ 8868 displayX: number; 8869 8870 /** 8871 * Y coordinate of the accessibility hover point relative to the upper edge of the device screen. 8872 * 8873 * @type { number } 8874 * @syscap SystemCapability.ArkUI.ArkUI.Full 8875 * @atomicservice 8876 * @since 12 8877 */ 8878 displayY: number; 8879 8880 /** 8881 * X coordinate of the accessibility hover point relative to the left edge of the current window. 8882 * 8883 * @type { number } 8884 * @syscap SystemCapability.ArkUI.ArkUI.Full 8885 * @atomicservice 8886 * @since 12 8887 */ 8888 windowX: number; 8889 8890 /** 8891 * Y coordinate of the accessibility hover point relative to the upper edge of the current window. 8892 * 8893 * @type { number } 8894 * @syscap SystemCapability.ArkUI.ArkUI.Full 8895 * @atomicservice 8896 * @since 12 8897 */ 8898 windowY: number; 8899} 8900 8901/** 8902 * Type of the touch event. 8903 * 8904 * @interface TouchObject 8905 * @syscap SystemCapability.ArkUI.ArkUI.Full 8906 * @since 7 8907 */ 8908/** 8909 * Type of the touch event. 8910 * 8911 * @interface TouchObject 8912 * @syscap SystemCapability.ArkUI.ArkUI.Full 8913 * @crossplatform 8914 * @since 10 8915 */ 8916/** 8917 * Type of the touch event. 8918 * 8919 * @interface TouchObject 8920 * @syscap SystemCapability.ArkUI.ArkUI.Full 8921 * @crossplatform 8922 * @atomicservice 8923 * @since 11 8924 */ 8925declare interface TouchObject { 8926 /** 8927 * Type of the touch event. 8928 * 8929 * @type { TouchType } 8930 * @syscap SystemCapability.ArkUI.ArkUI.Full 8931 * @since 7 8932 */ 8933 /** 8934 * Type of the touch event. 8935 * 8936 * @type { TouchType } 8937 * @syscap SystemCapability.ArkUI.ArkUI.Full 8938 * @crossplatform 8939 * @since 10 8940 */ 8941 /** 8942 * Type of the touch event. 8943 * 8944 * @type { TouchType } 8945 * @syscap SystemCapability.ArkUI.ArkUI.Full 8946 * @crossplatform 8947 * @atomicservice 8948 * @since 11 8949 */ 8950 type: TouchType; 8951 8952 /** 8953 * Finger unique identifier. 8954 * 8955 * @type { number } 8956 * @syscap SystemCapability.ArkUI.ArkUI.Full 8957 * @since 7 8958 */ 8959 /** 8960 * Finger unique identifier. 8961 * 8962 * @type { number } 8963 * @syscap SystemCapability.ArkUI.ArkUI.Full 8964 * @crossplatform 8965 * @since 10 8966 */ 8967 /** 8968 * Finger unique identifier. 8969 * 8970 * @type { number } 8971 * @syscap SystemCapability.ArkUI.ArkUI.Full 8972 * @crossplatform 8973 * @atomicservice 8974 * @since 11 8975 */ 8976 id: number; 8977 8978 /** 8979 * X coordinate of the touch point relative to the left edge of the device screen. 8980 * 8981 * @type { number } 8982 * @syscap SystemCapability.ArkUI.ArkUI.Full 8983 * @crossplatform 8984 * @since 10 8985 */ 8986 /** 8987 * X coordinate of the touch point relative to the left edge of the device screen. 8988 * 8989 * @type { number } 8990 * @syscap SystemCapability.ArkUI.ArkUI.Full 8991 * @crossplatform 8992 * @atomicservice 8993 * @since 11 8994 */ 8995 displayX: number; 8996 8997 /** 8998 * Y coordinate of the touch point relative to the upper edge of the device screen. 8999 * 9000 * @type { number } 9001 * @syscap SystemCapability.ArkUI.ArkUI.Full 9002 * @crossplatform 9003 * @since 10 9004 */ 9005 /** 9006 * Y coordinate of the touch point relative to the upper edge of the device screen. 9007 * 9008 * @type { number } 9009 * @syscap SystemCapability.ArkUI.ArkUI.Full 9010 * @crossplatform 9011 * @atomicservice 9012 * @since 11 9013 */ 9014 displayY: number; 9015 9016 /** 9017 * X coordinate of the touch point relative to the left edge of the current window. 9018 * 9019 * @type { number } 9020 * @syscap SystemCapability.ArkUI.ArkUI.Full 9021 * @crossplatform 9022 * @since 10 9023 */ 9024 /** 9025 * X coordinate of the touch point relative to the left edge of the current window. 9026 * 9027 * @type { number } 9028 * @syscap SystemCapability.ArkUI.ArkUI.Full 9029 * @crossplatform 9030 * @atomicservice 9031 * @since 11 9032 */ 9033 windowX: number; 9034 9035 /** 9036 * Y coordinate of the touch point relative to the upper edge of the current window. 9037 * 9038 * @type { number } 9039 * @syscap SystemCapability.ArkUI.ArkUI.Full 9040 * @crossplatform 9041 * @since 10 9042 */ 9043 /** 9044 * Y coordinate of the touch point relative to the upper edge of the current window. 9045 * 9046 * @type { number } 9047 * @syscap SystemCapability.ArkUI.ArkUI.Full 9048 * @crossplatform 9049 * @atomicservice 9050 * @since 11 9051 */ 9052 windowY: number; 9053 9054 /** 9055 * X coordinate of the touch point relative to the left edge of the current window. 9056 * 9057 * @type { number } 9058 * @syscap SystemCapability.ArkUI.ArkUI.Full 9059 * @since 7 9060 * @deprecated since 10 9061 * @useinstead TouchObject#windowX 9062 */ 9063 screenX: number; 9064 9065 /** 9066 * Y coordinate of the touch point relative to the upper edge of the current window. 9067 * 9068 * @type { number } 9069 * @syscap SystemCapability.ArkUI.ArkUI.Full 9070 * @since 7 9071 * @deprecated since 10 9072 * @useinstead TouchObject#windowY 9073 */ 9074 screenY: number; 9075 9076 /** 9077 * X coordinate of the touch point relative to the left edge of the touched element. 9078 * 9079 * @type { number } 9080 * @syscap SystemCapability.ArkUI.ArkUI.Full 9081 * @since 7 9082 */ 9083 /** 9084 * X coordinate of the touch point relative to the left edge of the touched element. 9085 * 9086 * @type { number } 9087 * @syscap SystemCapability.ArkUI.ArkUI.Full 9088 * @crossplatform 9089 * @since 10 9090 */ 9091 /** 9092 * X coordinate of the touch point relative to the left edge of the touched element. 9093 * 9094 * @type { number } 9095 * @syscap SystemCapability.ArkUI.ArkUI.Full 9096 * @crossplatform 9097 * @atomicservice 9098 * @since 11 9099 */ 9100 x: number; 9101 9102 /** 9103 * Y coordinate of the touch point relative to the upper edge of the touched element. 9104 * 9105 * @type { number } 9106 * @syscap SystemCapability.ArkUI.ArkUI.Full 9107 * @since 7 9108 */ 9109 /** 9110 * Y coordinate of the touch point relative to the upper edge of the touched element. 9111 * 9112 * @type { number } 9113 * @syscap SystemCapability.ArkUI.ArkUI.Full 9114 * @crossplatform 9115 * @since 10 9116 */ 9117 /** 9118 * Y coordinate of the touch point relative to the upper edge of the touched element. 9119 * 9120 * @type { number } 9121 * @syscap SystemCapability.ArkUI.ArkUI.Full 9122 * @crossplatform 9123 * @atomicservice 9124 * @since 11 9125 */ 9126 y: number; 9127 9128 /** 9129 * Type of the touch hand. 9130 * 9131 * @type { InteractionHand } 9132 * @syscap SystemCapability.ArkUI.ArkUI.Full 9133 * @crossplatform 9134 * @atomicservice 9135 * @since 15 9136 */ 9137 hand?: InteractionHand; 9138 9139 /** 9140 * Time stamp when the touch point is pressed. 9141 * 9142 * @type { ?number } 9143 * @syscap SystemCapability.ArkUI.ArkUI.Full 9144 * @crossplatform 9145 * @atomicservice 9146 * @since 15 9147 */ 9148 pressedTime?: number; 9149 /** 9150 * Pressure of a specific touch point. 9151 * 9152 * @type { ?number } 9153 * @syscap SystemCapability.ArkUI.ArkUI.Full 9154 * @crossplatform 9155 * @atomicservice 9156 * @since 15 9157 */ 9158 pressure?: number; 9159 9160 /** 9161 * Width of the contact area when touch is pressed of a specific touch point. 9162 * 9163 * @type { ?number } 9164 * @syscap SystemCapability.ArkUI.ArkUI.Full 9165 * @crossplatform 9166 * @atomicservice 9167 * @since 15 9168 */ 9169 width?: number; 9170 9171 /** 9172 * Height of the contact area when touch is pressed of a specific touch point. 9173 * 9174 * @type { ?number } 9175 * @syscap SystemCapability.ArkUI.ArkUI.Full 9176 * @crossplatform 9177 * @atomicservice 9178 * @since 15 9179 */ 9180 height?: number; 9181} 9182 9183/** 9184 * TouchObject getHistoricalPoints Function Parameters 9185 * 9186 * @interface HistoricalPoint 9187 * @syscap SystemCapability.ArkUI.ArkUI.Full 9188 * @crossplatform 9189 * @since 10 9190 */ 9191/** 9192 * TouchObject getHistoricalPoints Function Parameters 9193 * 9194 * @interface HistoricalPoint 9195 * @syscap SystemCapability.ArkUI.ArkUI.Full 9196 * @crossplatform 9197 * @atomicservice 9198 * @since 11 9199 */ 9200declare interface HistoricalPoint { 9201 /** 9202 * The base touchObject information of historicalPoint 9203 * 9204 * @type { TouchObject } 9205 * @syscap SystemCapability.ArkUI.ArkUI.Full 9206 * @crossplatform 9207 * @since 10 9208 */ 9209 /** 9210 * The base touchObject information of historicalPoint 9211 * 9212 * @type { TouchObject } 9213 * @syscap SystemCapability.ArkUI.ArkUI.Full 9214 * @crossplatform 9215 * @atomicservice 9216 * @since 11 9217 */ 9218 touchObject: TouchObject; 9219 9220 /** 9221 * Contact area between the finger pad and the screen. 9222 * 9223 * @type { number } 9224 * @syscap SystemCapability.ArkUI.ArkUI.Full 9225 * @crossplatform 9226 * @since 10 9227 */ 9228 /** 9229 * Contact area between the finger pad and the screen. 9230 * 9231 * @type { number } 9232 * @syscap SystemCapability.ArkUI.ArkUI.Full 9233 * @crossplatform 9234 * @atomicservice 9235 * @since 11 9236 */ 9237 size: number; 9238 9239 /** 9240 * Pressure of the touch event. 9241 * 9242 * @type { number } 9243 * @syscap SystemCapability.ArkUI.ArkUI.Full 9244 * @crossplatform 9245 * @since 10 9246 */ 9247 /** 9248 * Pressure of the touch event. 9249 * 9250 * @type { number } 9251 * @syscap SystemCapability.ArkUI.ArkUI.Full 9252 * @crossplatform 9253 * @atomicservice 9254 * @since 11 9255 */ 9256 force: number; 9257 9258 /** 9259 * Timestamp of the touch event. 9260 * 9261 * @type { number } 9262 * @syscap SystemCapability.ArkUI.ArkUI.Full 9263 * @crossplatform 9264 * @since 10 9265 */ 9266 /** 9267 * Timestamp of the touch event. 9268 * 9269 * @type { number } 9270 * @syscap SystemCapability.ArkUI.ArkUI.Full 9271 * @crossplatform 9272 * @atomicservice 9273 * @since 11 9274 */ 9275 timestamp: number; 9276} 9277 9278/** 9279 * Touch Action Function Parameters 9280 * 9281 * @extends BaseEvent 9282 * @interface TouchEvent 9283 * @syscap SystemCapability.ArkUI.ArkUI.Full 9284 * @since 7 9285 */ 9286/** 9287 * Touch Action Function Parameters 9288 * 9289 * @extends BaseEvent 9290 * @interface TouchEvent 9291 * @syscap SystemCapability.ArkUI.ArkUI.Full 9292 * @crossplatform 9293 * @since 10 9294 */ 9295/** 9296 * Touch Action Function Parameters 9297 * 9298 * @extends BaseEvent 9299 * @interface TouchEvent 9300 * @syscap SystemCapability.ArkUI.ArkUI.Full 9301 * @crossplatform 9302 * @atomicservice 9303 * @since 11 9304 */ 9305declare interface TouchEvent extends BaseEvent { 9306 /** 9307 * Type of the touch event. 9308 * 9309 * @type { TouchType } 9310 * @syscap SystemCapability.ArkUI.ArkUI.Full 9311 * @since 7 9312 */ 9313 /** 9314 * Type of the touch event. 9315 * 9316 * @type { TouchType } 9317 * @syscap SystemCapability.ArkUI.ArkUI.Full 9318 * @crossplatform 9319 * @since 10 9320 */ 9321 /** 9322 * Type of the touch event. 9323 * 9324 * @type { TouchType } 9325 * @syscap SystemCapability.ArkUI.ArkUI.Full 9326 * @crossplatform 9327 * @atomicservice 9328 * @since 11 9329 */ 9330 type: TouchType; 9331 9332 /** 9333 * All finger information. 9334 * 9335 * @type { TouchObject[] } 9336 * @syscap SystemCapability.ArkUI.ArkUI.Full 9337 * @since 7 9338 */ 9339 /** 9340 * All finger information. 9341 * 9342 * @type { TouchObject[] } 9343 * @syscap SystemCapability.ArkUI.ArkUI.Full 9344 * @crossplatform 9345 * @since 10 9346 */ 9347 /** 9348 * All finger information. 9349 * 9350 * @type { TouchObject[] } 9351 * @syscap SystemCapability.ArkUI.ArkUI.Full 9352 * @crossplatform 9353 * @atomicservice 9354 * @since 11 9355 */ 9356 touches: TouchObject[]; 9357 9358 /** 9359 * Indicates the current changed finger information. 9360 * 9361 * @type { TouchObject[] } 9362 * @syscap SystemCapability.ArkUI.ArkUI.Full 9363 * @since 7 9364 */ 9365 /** 9366 * Indicates the current changed finger information. 9367 * 9368 * @type { TouchObject[] } 9369 * @syscap SystemCapability.ArkUI.ArkUI.Full 9370 * @crossplatform 9371 * @since 10 9372 */ 9373 /** 9374 * Indicates the current changed finger information. 9375 * 9376 * @type { TouchObject[] } 9377 * @syscap SystemCapability.ArkUI.ArkUI.Full 9378 * @crossplatform 9379 * @atomicservice 9380 * @since 11 9381 */ 9382 changedTouches: TouchObject[]; 9383 9384 /** 9385 * The blocking event pops up. 9386 * 9387 * @type { function } 9388 * @syscap SystemCapability.ArkUI.ArkUI.Full 9389 * @since 7 9390 */ 9391 /** 9392 * The blocking event pops up. 9393 * 9394 * @type { function } 9395 * @syscap SystemCapability.ArkUI.ArkUI.Full 9396 * @crossplatform 9397 * @since 10 9398 */ 9399 /** 9400 * The blocking event pops up. 9401 * 9402 * @type { function } 9403 * @syscap SystemCapability.ArkUI.ArkUI.Full 9404 * @crossplatform 9405 * @atomicservice 9406 * @since 11 9407 */ 9408 stopPropagation: () => void; 9409 9410 /** 9411 * Get the historical points. 9412 * 9413 * @returns { Array<HistoricalPoint> } - return all historical points. 9414 * @syscap SystemCapability.ArkUI.ArkUI.Full 9415 * @crossplatform 9416 * @since 10 9417 */ 9418 /** 9419 * Get the historical points. 9420 * 9421 * @returns { Array<HistoricalPoint> } - return all historical points. 9422 * @syscap SystemCapability.ArkUI.ArkUI.Full 9423 * @crossplatform 9424 * @atomicservice 9425 * @since 11 9426 */ 9427 getHistoricalPoints(): Array<HistoricalPoint>; 9428 9429 /** 9430 * Prevent the default function. 9431 * 9432 * @type { function } 9433 * @syscap SystemCapability.ArkUI.ArkUI.Full 9434 * @crossplatform 9435 * @atomicservice 9436 * @since 12 9437 */ 9438 preventDefault: () => void; 9439} 9440 9441/** 9442 * Defines the callback type used in onSizeChange. 9443 * The value of oldValue is last size of the component. 9444 * The value of newValue is new size of the component. 9445 * 9446 * @typedef { function } SizeChangeCallback 9447 * @syscap SystemCapability.ArkUI.ArkUI.Full 9448 * @crossplatform 9449 * @form 9450 * @atomicservice 9451 * @since 12 9452 */ 9453declare type SizeChangeCallback = (oldValue: SizeOptions, newValue: SizeOptions) => void; 9454 9455/** 9456 * Defines the callback type used in onGestureRecognizerJudgeBegin. 9457 * 9458 * @typedef { function } GestureRecognizerJudgeBeginCallback 9459 * @param { BaseGestureEvent } event - the event information 9460 * @param { GestureRecognizer } current - the current gesture recognizer of the component 9461 * @param { Array<GestureRecognizer> } recognizers - the gesture recognizers of the component on the response chain 9462 * @returns { GestureJudgeResult } the gesture judge result 9463 * @syscap SystemCapability.ArkUI.ArkUI.Full 9464 * @crossplatform 9465 * @atomicservice 9466 * @since 12 9467 */ 9468declare type GestureRecognizerJudgeBeginCallback = (event: BaseGestureEvent, current: GestureRecognizer, recognizers: Array<GestureRecognizer>) => GestureJudgeResult; 9469 9470/** 9471 * Defines the callback type used in shouldBuiltInRecognizerParallelWith. 9472 * 9473 * @typedef { function } ShouldBuiltInRecognizerParallelWithCallback 9474 * @param { GestureRecognizer } current - the current gesture recognizer of the component 9475 * @param { Array<GestureRecognizer> } others - the gesture recognizers of the component on the response chain 9476 * @returns { GestureRecognizer } gesture recognizer of the component 9477 * @syscap SystemCapability.ArkUI.ArkUI.Full 9478 * @crossplatform 9479 * @atomicservice 9480 * @since 12 9481 */ 9482declare type ShouldBuiltInRecognizerParallelWithCallback = (current: GestureRecognizer, others: Array<GestureRecognizer>) => GestureRecognizer; 9483 9484/** 9485 * Defines the finish callback type used in transition. 9486 * 9487 * @typedef { function } TransitionFinishCallback 9488 * @param { boolean } transitionIn - a boolean value indicates whether it is the callback of transitionIn or transitionOut. 9489 * @syscap SystemCapability.ArkUI.ArkUI.Full 9490 * @crossplatform 9491 * @form 9492 * @atomicservice 9493 * @since 12 9494 */ 9495declare type TransitionFinishCallback = (transitionIn: boolean) => void; 9496 9497/** 9498 * Defines the PixelMap type object for ui component. 9499 * 9500 * @syscap SystemCapability.ArkUI.ArkUI.Full 9501 * @since 7 9502 */ 9503/** 9504 * Defines the PixelMap type object for ui component. 9505 * 9506 * @syscap SystemCapability.ArkUI.ArkUI.Full 9507 * @crossplatform 9508 * @since 10 9509 */ 9510/** 9511 * Defines the PixelMap type object for ui component. 9512 * 9513 * @typedef { import('../api/@ohos.multimedia.image').default.PixelMap } PixelMap 9514 * @syscap SystemCapability.ArkUI.ArkUI.Full 9515 * @crossplatform 9516 * @atomicservice 9517 * @since 11 9518 */ 9519declare type PixelMap = import('../api/@ohos.multimedia.image').default.PixelMap; 9520 9521/** 9522 * pixelmap object with release function. 9523 * 9524 * @interface PixelMapMock 9525 * @syscap SystemCapability.ArkUI.ArkUI.Full 9526 * @systemapi 9527 * @since 7 9528 */ 9529declare interface PixelMapMock { 9530 /** 9531 * release function. 9532 * 9533 * @syscap SystemCapability.ArkUI.ArkUI.Full 9534 * @systemapi 9535 * @since 7 9536 */ 9537 release(): void; 9538} 9539 9540/** 9541 * Enum for Drag Behavior. 9542 * 9543 * @enum { number } 9544 * @syscap SystemCapability.ArkUI.ArkUI.Full 9545 * @since 10 9546 */ 9547/** 9548 * Enum for Drag Behavior. 9549 * 9550 * @enum { number } 9551 * @syscap SystemCapability.ArkUI.ArkUI.Full 9552 * @atomicservice 9553 * @since 11 9554 */ 9555declare enum DragBehavior { 9556 /** 9557 * If drag use copy event, then set DragBehavior.COPY. 9558 * 9559 * @syscap SystemCapability.ArkUI.ArkUI.Full 9560 * @since 10 9561 */ 9562 /** 9563 * If drag use copy event, then set DragBehavior.COPY. 9564 * 9565 * @syscap SystemCapability.ArkUI.ArkUI.Full 9566 * @atomicservice 9567 * @since 11 9568 */ 9569 COPY, 9570 /** 9571 * If drag use move event, then set DragBehavior.MOVE. 9572 * 9573 * @syscap SystemCapability.ArkUI.ArkUI.Full 9574 * @since 10 9575 */ 9576 /** 9577 * If drag use move event, then set DragBehavior.MOVE. 9578 * 9579 * @syscap SystemCapability.ArkUI.ArkUI.Full 9580 * @atomicservice 9581 * @since 11 9582 */ 9583 MOVE 9584} 9585 9586/** 9587 * Import the UnifiedData type object for ui component. 9588 * 9589 * @typedef { import('../api/@ohos.data.unifiedDataChannel').default.UnifiedData } UnifiedData 9590 * @syscap SystemCapability.ArkUI.ArkUI.Full 9591 * @crossplatform 9592 * @since 10 9593 */ 9594/** 9595 * Import the UnifiedData type object for ui component. 9596 * 9597 * @typedef { import('../api/@ohos.data.unifiedDataChannel').default.UnifiedData } UnifiedData 9598 * @syscap SystemCapability.ArkUI.ArkUI.Full 9599 * @crossplatform 9600 * @atomicservice 9601 * @since 11 9602 */ 9603declare type UnifiedData = import('../api/@ohos.data.unifiedDataChannel').default.UnifiedData; 9604 9605/** 9606 * Import the Summary type object for ui component. 9607 * 9608 * @typedef { import('../api/@ohos.data.unifiedDataChannel').default.Summary } Summary 9609 * @syscap SystemCapability.ArkUI.ArkUI.Full 9610 * @since 10 9611 */ 9612/** 9613 * Import the Summary type object for ui component. 9614 * 9615 * @typedef { import('../api/@ohos.data.unifiedDataChannel').default.Summary } Summary 9616 * @syscap SystemCapability.ArkUI.ArkUI.Full 9617 * @atomicservice 9618 * @since 11 9619 */ 9620declare type Summary = import('../api/@ohos.data.unifiedDataChannel').default.Summary; 9621 9622/** 9623 * Import the UniformDataType type object for ui component. 9624 * 9625 * @typedef { import('../api/@ohos.data.uniformTypeDescriptor').default.UniformDataType } UniformDataType 9626 * @syscap SystemCapability.ArkUI.ArkUI.Full 9627 * @since 10 9628 */ 9629/** 9630 * Import the UniformDataType type object for ui component. 9631 * 9632 * @typedef { import('../api/@ohos.data.uniformTypeDescriptor').default.UniformDataType } UniformDataType 9633 * @syscap SystemCapability.ArkUI.ArkUI.Full 9634 * @atomicservice 9635 * @since 11 9636 */ 9637declare type UniformDataType = import('../api/@ohos.data.uniformTypeDescriptor').default.UniformDataType; 9638 9639/** 9640 * Import the GetDataParams type object for ui component. 9641 * 9642 * @typedef { import('../api/@ohos.data.unifiedDataChannel').default.GetDataParams } GetDataParams 9643 * @syscap SystemCapability.ArkUI.ArkUI.Full 9644 * @crossplatform 9645 * @atomicservice 9646 * @since 15 9647 */ 9648declare type DataSyncOptions = import('../api/@ohos.data.unifiedDataChannel').default.GetDataParams; 9649 9650/** 9651 * Enum for Drag Result. 9652 * 9653 * @enum { number } 9654 * @syscap SystemCapability.ArkUI.ArkUI.Full 9655 * @since 10 9656 */ 9657/** 9658 * Enum for Drag Result. 9659 * 9660 * @enum { number } 9661 * @syscap SystemCapability.ArkUI.ArkUI.Full 9662 * @atomicservice 9663 * @since 11 9664 */ 9665/** 9666 * Enum for Drag Result. 9667 * 9668 * @enum { number } 9669 * @syscap SystemCapability.ArkUI.ArkUI.Full 9670 * @crossplatform 9671 * @atomicservice 9672 * @since 14 9673 */ 9674declare enum DragResult { 9675 /** 9676 * If the drag is successful, return DragResult.DRAG_SUCCESSFUL. 9677 * 9678 * @syscap SystemCapability.ArkUI.ArkUI.Full 9679 * @since 10 9680 */ 9681 /** 9682 * If the drag is successful, return DragResult.DRAG_SUCCESSFUL. 9683 * 9684 * @syscap SystemCapability.ArkUI.ArkUI.Full 9685 * @atomicservice 9686 * @since 11 9687 */ 9688 /** 9689 * If the drag is successful, return DragResult.DRAG_SUCCESSFUL. 9690 * 9691 * @syscap SystemCapability.ArkUI.ArkUI.Full 9692 * @crossplatform 9693 * @atomicservice 9694 * @since 14 9695 */ 9696 DRAG_SUCCESSFUL = 0, 9697 /** 9698 * If drag fail, return DragResult.DRAG_FAILED. 9699 * 9700 * @syscap SystemCapability.ArkUI.ArkUI.Full 9701 * @since 10 9702 */ 9703 /** 9704 * If drag fail, return DragResult.DRAG_FAILED. 9705 * 9706 * @syscap SystemCapability.ArkUI.ArkUI.Full 9707 * @atomicservice 9708 * @since 11 9709 */ 9710 /** 9711 * If drag fail, return DragResult.DRAG_FAILED. 9712 * 9713 * @syscap SystemCapability.ArkUI.ArkUI.Full 9714 * @crossplatform 9715 * @atomicservice 9716 * @since 14 9717 */ 9718 DRAG_FAILED = 1, 9719 /** 9720 * If drag action cancel, return DragResult.DRAG_CANCELED. 9721 * 9722 * @syscap SystemCapability.ArkUI.ArkUI.Full 9723 * @since 10 9724 */ 9725 /** 9726 * If drag action cancel, return DragResult.DRAG_CANCELED. 9727 * 9728 * @syscap SystemCapability.ArkUI.ArkUI.Full 9729 * @atomicservice 9730 * @since 11 9731 */ 9732 DRAG_CANCELED = 2, 9733 /** 9734 * If node allow drop in, return DragResult.DROP_ENABLED. 9735 * 9736 * @syscap SystemCapability.ArkUI.ArkUI.Full 9737 * @since 10 9738 */ 9739 /** 9740 * If node allow drop in, return DragResult.DROP_ENABLED. 9741 * 9742 * @syscap SystemCapability.ArkUI.ArkUI.Full 9743 * @atomicservice 9744 * @since 11 9745 */ 9746 DROP_ENABLED = 3, 9747 /** 9748 * If node don't allow drop in, return DragResult.DROP_DISABLED. 9749 * 9750 * @syscap SystemCapability.ArkUI.ArkUI.Full 9751 * @since 10 9752 */ 9753 /** 9754 * If node don't allow drop in, return DragResult.DROP_DISABLED. 9755 * 9756 * @syscap SystemCapability.ArkUI.ArkUI.Full 9757 * @atomicservice 9758 * @since 11 9759 */ 9760 DROP_DISABLED = 4 9761} 9762 9763/** 9764 * Enum for BlendMode. 9765 * Blend modes for compositing current component 9766 * with overlapping content. Use overlapping content 9767 * as dst, current component as src. 9768 * 9769 * @enum { number } 9770 * @syscap SystemCapability.ArkUI.ArkUI.Full 9771 * @crossplatform 9772 * @form 9773 * @since 11 9774 */ 9775/** 9776 * Enum for BlendMode. 9777 * Blend modes for compositing current component 9778 * with overlapping content. Use overlapping content 9779 * as dst, current component as src. 9780 * 9781 * @enum { number } 9782 * @syscap SystemCapability.ArkUI.ArkUI.Full 9783 * @crossplatform 9784 * @form 9785 * @atomicservice 9786 * @since 12 9787 */ 9788declare enum BlendMode { 9789 /** 9790 * Hybrid mode does not take effect 9791 * 9792 * @syscap SystemCapability.ArkUI.ArkUI.Full 9793 * @crossplatform 9794 * @form 9795 * @since 11 9796 */ 9797 /** 9798 * Hybrid mode does not take effect 9799 * 9800 * @syscap SystemCapability.ArkUI.ArkUI.Full 9801 * @crossplatform 9802 * @form 9803 * @atomicservice 9804 * @since 12 9805 */ 9806 NONE = 0, 9807 /** 9808 * Clear destination color covered by the source to 0. 9809 * 9810 * @syscap SystemCapability.ArkUI.ArkUI.Full 9811 * @crossplatform 9812 * @form 9813 * @since 11 9814 */ 9815 /** 9816 * Clear destination color covered by the source to 0. 9817 * 9818 * @syscap SystemCapability.ArkUI.ArkUI.Full 9819 * @crossplatform 9820 * @form 9821 * @atomicservice 9822 * @since 12 9823 */ 9824 CLEAR = 1, 9825 /** 9826 * r = s 9827 * 9828 * @syscap SystemCapability.ArkUI.ArkUI.Full 9829 * @crossplatform 9830 * @form 9831 * @since 11 9832 */ 9833 /** 9834 * r = s 9835 * 9836 * @syscap SystemCapability.ArkUI.ArkUI.Full 9837 * @crossplatform 9838 * @form 9839 * @atomicservice 9840 * @since 12 9841 */ 9842 SRC = 2, 9843 /** 9844 * r = d 9845 * 9846 * @syscap SystemCapability.ArkUI.ArkUI.Full 9847 * @crossplatform 9848 * @form 9849 * @since 11 9850 */ 9851 /** 9852 * r = d 9853 * 9854 * @syscap SystemCapability.ArkUI.ArkUI.Full 9855 * @crossplatform 9856 * @form 9857 * @atomicservice 9858 * @since 12 9859 */ 9860 DST = 3, 9861 /** 9862 * r = s + (1 - sa) * d 9863 * 9864 * @syscap SystemCapability.ArkUI.ArkUI.Full 9865 * @crossplatform 9866 * @form 9867 * @since 11 9868 */ 9869 /** 9870 * r = s + (1 - sa) * d 9871 * 9872 * @syscap SystemCapability.ArkUI.ArkUI.Full 9873 * @crossplatform 9874 * @form 9875 * @atomicservice 9876 * @since 12 9877 */ 9878 SRC_OVER = 4, 9879 /** 9880 * r = d + (1 - da) * s 9881 * 9882 * @syscap SystemCapability.ArkUI.ArkUI.Full 9883 * @crossplatform 9884 * @form 9885 * @since 11 9886 */ 9887 /** 9888 * r = d + (1 - da) * s 9889 * 9890 * @syscap SystemCapability.ArkUI.ArkUI.Full 9891 * @crossplatform 9892 * @form 9893 * @atomicservice 9894 * @since 12 9895 */ 9896 DST_OVER = 5, 9897 /** 9898 * r = s * da 9899 * 9900 * @syscap SystemCapability.ArkUI.ArkUI.Full 9901 * @crossplatform 9902 * @form 9903 * @since 11 9904 */ 9905 /** 9906 * r = s * da 9907 * 9908 * @syscap SystemCapability.ArkUI.ArkUI.Full 9909 * @crossplatform 9910 * @form 9911 * @atomicservice 9912 * @since 12 9913 */ 9914 SRC_IN = 6, 9915 /** 9916 * r = d * sa 9917 * 9918 * @syscap SystemCapability.ArkUI.ArkUI.Full 9919 * @crossplatform 9920 * @form 9921 * @since 11 9922 */ 9923 /** 9924 * r = d * sa 9925 * 9926 * @syscap SystemCapability.ArkUI.ArkUI.Full 9927 * @crossplatform 9928 * @form 9929 * @atomicservice 9930 * @since 12 9931 */ 9932 DST_IN = 7, 9933 /** 9934 * r = s * (1 - da) 9935 * 9936 * @syscap SystemCapability.ArkUI.ArkUI.Full 9937 * @crossplatform 9938 * @form 9939 * @since 11 9940 */ 9941 /** 9942 * r = s * (1 - da) 9943 * 9944 * @syscap SystemCapability.ArkUI.ArkUI.Full 9945 * @crossplatform 9946 * @form 9947 * @atomicservice 9948 * @since 12 9949 */ 9950 SRC_OUT = 8, 9951 /** 9952 * r = d * (1 - sa) 9953 * 9954 * @syscap SystemCapability.ArkUI.ArkUI.Full 9955 * @crossplatform 9956 * @form 9957 * @since 11 9958 */ 9959 /** 9960 * r = d * (1 - sa) 9961 * 9962 * @syscap SystemCapability.ArkUI.ArkUI.Full 9963 * @crossplatform 9964 * @form 9965 * @atomicservice 9966 * @since 12 9967 */ 9968 DST_OUT = 9, 9969 /** 9970 * r = s * da + d * (1 - sa) 9971 * 9972 * @syscap SystemCapability.ArkUI.ArkUI.Full 9973 * @crossplatform 9974 * @form 9975 * @since 11 9976 */ 9977 /** 9978 * r = s * da + d * (1 - sa) 9979 * 9980 * @syscap SystemCapability.ArkUI.ArkUI.Full 9981 * @crossplatform 9982 * @form 9983 * @atomicservice 9984 * @since 12 9985 */ 9986 SRC_ATOP = 10, 9987 /** 9988 * r = d * sa + s * (1 - da) 9989 * 9990 * @syscap SystemCapability.ArkUI.ArkUI.Full 9991 * @crossplatform 9992 * @form 9993 * @since 11 9994 */ 9995 /** 9996 * r = d * sa + s * (1 - da) 9997 * 9998 * @syscap SystemCapability.ArkUI.ArkUI.Full 9999 * @crossplatform 10000 * @form 10001 * @atomicservice 10002 * @since 12 10003 */ 10004 DST_ATOP = 11, 10005 /** 10006 * r = s * (1 - da) + d * (1 - sa) 10007 * 10008 * @syscap SystemCapability.ArkUI.ArkUI.Full 10009 * @crossplatform 10010 * @form 10011 * @since 11 10012 */ 10013 /** 10014 * r = s * (1 - da) + d * (1 - sa) 10015 * 10016 * @syscap SystemCapability.ArkUI.ArkUI.Full 10017 * @crossplatform 10018 * @form 10019 * @atomicservice 10020 * @since 12 10021 */ 10022 XOR = 12, 10023 /** 10024 * r = min(s + d, 1) 10025 * 10026 * @syscap SystemCapability.ArkUI.ArkUI.Full 10027 * @crossplatform 10028 * @form 10029 * @since 11 10030 */ 10031 /** 10032 * r = min(s + d, 1) 10033 * 10034 * @syscap SystemCapability.ArkUI.ArkUI.Full 10035 * @crossplatform 10036 * @form 10037 * @atomicservice 10038 * @since 12 10039 */ 10040 PLUS = 13, 10041 /** 10042 * r = s * d 10043 * 10044 * @syscap SystemCapability.ArkUI.ArkUI.Full 10045 * @crossplatform 10046 * @form 10047 * @since 11 10048 */ 10049 /** 10050 * r = s * d 10051 * 10052 * @syscap SystemCapability.ArkUI.ArkUI.Full 10053 * @crossplatform 10054 * @form 10055 * @atomicservice 10056 * @since 12 10057 */ 10058 MODULATE = 14, 10059 /** 10060 * r = s + d - s * d 10061 * 10062 * @syscap SystemCapability.ArkUI.ArkUI.Full 10063 * @crossplatform 10064 * @form 10065 * @since 11 10066 */ 10067 /** 10068 * r = s + d - s * d 10069 * 10070 * @syscap SystemCapability.ArkUI.ArkUI.Full 10071 * @crossplatform 10072 * @form 10073 * @atomicservice 10074 * @since 12 10075 */ 10076 SCREEN = 15, 10077 /** 10078 * multiply or screen, depending on destination 10079 * 10080 * @syscap SystemCapability.ArkUI.ArkUI.Full 10081 * @crossplatform 10082 * @form 10083 * @since 11 10084 */ 10085 /** 10086 * multiply or screen, depending on destination 10087 * 10088 * @syscap SystemCapability.ArkUI.ArkUI.Full 10089 * @crossplatform 10090 * @form 10091 * @atomicservice 10092 * @since 12 10093 */ 10094 OVERLAY = 16, 10095 /** 10096 * rc = s + d - max(s * da, d * sa), ra = kSrcOver 10097 * 10098 * @syscap SystemCapability.ArkUI.ArkUI.Full 10099 * @crossplatform 10100 * @form 10101 * @since 11 10102 */ 10103 /** 10104 * rc = s + d - max(s * da, d * sa), ra = kSrcOver 10105 * 10106 * @syscap SystemCapability.ArkUI.ArkUI.Full 10107 * @crossplatform 10108 * @form 10109 * @atomicservice 10110 * @since 12 10111 */ 10112 DARKEN = 17, 10113 /** 10114 * rc = s + d - min(s * da, d * sa), ra = kSrcOver 10115 * 10116 * @syscap SystemCapability.ArkUI.ArkUI.Full 10117 * @crossplatform 10118 * @form 10119 * @since 11 10120 */ 10121 /** 10122 * rc = s + d - min(s * da, d * sa), ra = kSrcOver 10123 * 10124 * @syscap SystemCapability.ArkUI.ArkUI.Full 10125 * @crossplatform 10126 * @form 10127 * @atomicservice 10128 * @since 12 10129 */ 10130 LIGHTEN = 18, 10131 /** 10132 * brighten destination to reflect source 10133 * 10134 * @syscap SystemCapability.ArkUI.ArkUI.Full 10135 * @crossplatform 10136 * @form 10137 * @since 11 10138 */ 10139 /** 10140 * brighten destination to reflect source 10141 * 10142 * @syscap SystemCapability.ArkUI.ArkUI.Full 10143 * @crossplatform 10144 * @form 10145 * @atomicservice 10146 * @since 12 10147 */ 10148 COLOR_DODGE = 19, 10149 /** 10150 * darken destination to reflect source 10151 * 10152 * @syscap SystemCapability.ArkUI.ArkUI.Full 10153 * @crossplatform 10154 * @form 10155 * @since 11 10156 */ 10157 /** 10158 * darken destination to reflect source 10159 * 10160 * @syscap SystemCapability.ArkUI.ArkUI.Full 10161 * @crossplatform 10162 * @form 10163 * @atomicservice 10164 * @since 12 10165 */ 10166 COLOR_BURN = 20, 10167 /** 10168 * multiply or screen, depending on source 10169 * 10170 * @syscap SystemCapability.ArkUI.ArkUI.Full 10171 * @crossplatform 10172 * @form 10173 * @since 11 10174 */ 10175 /** 10176 * multiply or screen, depending on source 10177 * 10178 * @syscap SystemCapability.ArkUI.ArkUI.Full 10179 * @crossplatform 10180 * @form 10181 * @atomicservice 10182 * @since 12 10183 */ 10184 HARD_LIGHT = 21, 10185 /** 10186 * lighten or darken, depending on source 10187 * 10188 * @syscap SystemCapability.ArkUI.ArkUI.Full 10189 * @crossplatform 10190 * @form 10191 * @since 11 10192 */ 10193 /** 10194 * lighten or darken, depending on source 10195 * 10196 * @syscap SystemCapability.ArkUI.ArkUI.Full 10197 * @crossplatform 10198 * @form 10199 * @atomicservice 10200 * @since 12 10201 */ 10202 SOFT_LIGHT = 22, 10203 /** 10204 * rc = s + d - 2 * (min(s * da, d * sa)), ra = kSrcOver 10205 * 10206 * @syscap SystemCapability.ArkUI.ArkUI.Full 10207 * @crossplatform 10208 * @form 10209 * @since 11 10210 */ 10211 /** 10212 * rc = s + d - 2 * (min(s * da, d * sa)), ra = kSrcOver 10213 * 10214 * @syscap SystemCapability.ArkUI.ArkUI.Full 10215 * @crossplatform 10216 * @form 10217 * @atomicservice 10218 * @since 12 10219 */ 10220 DIFFERENCE = 23, 10221 /** 10222 * rc = s + d - two(s * d), ra = kSrcOver 10223 * 10224 * @syscap SystemCapability.ArkUI.ArkUI.Full 10225 * @crossplatform 10226 * @form 10227 * @since 11 10228 */ 10229 /** 10230 * rc = s + d - two(s * d), ra = kSrcOver 10231 * 10232 * @syscap SystemCapability.ArkUI.ArkUI.Full 10233 * @crossplatform 10234 * @form 10235 * @atomicservice 10236 * @since 12 10237 */ 10238 EXCLUSION = 24, 10239 /** 10240 * r = s * (1 - da) + d * (1 - sa) + s * d 10241 * 10242 * @syscap SystemCapability.ArkUI.ArkUI.Full 10243 * @crossplatform 10244 * @form 10245 * @since 11 10246 */ 10247 /** 10248 * r = s * (1 - da) + d * (1 - sa) + s * d 10249 * 10250 * @syscap SystemCapability.ArkUI.ArkUI.Full 10251 * @crossplatform 10252 * @form 10253 * @atomicservice 10254 * @since 12 10255 */ 10256 MULTIPLY = 25, 10257 /** 10258 * hue of source with saturation and luminosity of destination 10259 * 10260 * @syscap SystemCapability.ArkUI.ArkUI.Full 10261 * @crossplatform 10262 * @form 10263 * @since 11 10264 */ 10265 /** 10266 * hue of source with saturation and luminosity of destination 10267 * 10268 * @syscap SystemCapability.ArkUI.ArkUI.Full 10269 * @crossplatform 10270 * @form 10271 * @atomicservice 10272 * @since 12 10273 */ 10274 HUE = 26, 10275 /** 10276 * saturation of source with hue and luminosity of destination 10277 * 10278 * @syscap SystemCapability.ArkUI.ArkUI.Full 10279 * @crossplatform 10280 * @form 10281 * @since 11 10282 */ 10283 /** 10284 * saturation of source with hue and luminosity of destination 10285 * 10286 * @syscap SystemCapability.ArkUI.ArkUI.Full 10287 * @crossplatform 10288 * @form 10289 * @atomicservice 10290 * @since 12 10291 */ 10292 SATURATION = 27, 10293 /** 10294 * hue and saturation of source with luminosity of destination 10295 * 10296 * @syscap SystemCapability.ArkUI.ArkUI.Full 10297 * @crossplatform 10298 * @form 10299 * @since 11 10300 */ 10301 /** 10302 * hue and saturation of source with luminosity of destination 10303 * 10304 * @syscap SystemCapability.ArkUI.ArkUI.Full 10305 * @crossplatform 10306 * @form 10307 * @atomicservice 10308 * @since 12 10309 */ 10310 COLOR = 28, 10311 /** 10312 * luminosity of source with hue and saturation of destination 10313 * 10314 * @syscap SystemCapability.ArkUI.ArkUI.Full 10315 * @crossplatform 10316 * @form 10317 * @since 11 10318 */ 10319 /** 10320 * luminosity of source with hue and saturation of destination 10321 * 10322 * @syscap SystemCapability.ArkUI.ArkUI.Full 10323 * @crossplatform 10324 * @form 10325 * @atomicservice 10326 * @since 12 10327 */ 10328 LUMINOSITY = 29 10329} 10330 10331/** 10332 * Enum for BlendApplyType. 10333 * Indicate how to apply specified blend mode to 10334 * the view's content. 10335 * 10336 * @enum { number } 10337 * @syscap SystemCapability.ArkUI.ArkUI.Full 10338 * @crossplatform 10339 * @form 10340 * @since 11 10341 */ 10342/** 10343 * Enum for BlendApplyType. 10344 * Indicate how to apply specified blend mode to 10345 * the view's content. 10346 * 10347 * @enum { number } 10348 * @syscap SystemCapability.ArkUI.ArkUI.Full 10349 * @crossplatform 10350 * @form 10351 * @atomicservice 10352 * @since 12 10353 */ 10354declare enum BlendApplyType { 10355 /** 10356 * Blend view's content in sequence over dst 10357 * 10358 * @syscap SystemCapability.ArkUI.ArkUI.Full 10359 * @crossplatform 10360 * @form 10361 * @since 11 10362 */ 10363 /** 10364 * Blend view's content in sequence over dst 10365 * 10366 * @syscap SystemCapability.ArkUI.ArkUI.Full 10367 * @crossplatform 10368 * @form 10369 * @atomicservice 10370 * @since 12 10371 */ 10372 FAST = 0, 10373 10374 /** 10375 * Composite this views's contents into an 10376 * offscreen image and then blend over dst 10377 * 10378 * @syscap SystemCapability.ArkUI.ArkUI.Full 10379 * @crossplatform 10380 * @form 10381 * @since 11 10382 */ 10383 /** 10384 * Composite this views's contents into an 10385 * offscreen image and then blend over dst 10386 * 10387 * @syscap SystemCapability.ArkUI.ArkUI.Full 10388 * @crossplatform 10389 * @form 10390 * @atomicservice 10391 * @since 12 10392 */ 10393 OFFSCREEN = 1, 10394} 10395 10396/** 10397 * DragEvent object description 10398 * 10399 * @interface DragEvent 10400 * @syscap SystemCapability.ArkUI.ArkUI.Full 10401 * @since 7 10402 */ 10403/** 10404 * DragEvent object description 10405 * 10406 * @interface DragEvent 10407 * @syscap SystemCapability.ArkUI.ArkUI.Full 10408 * @atomicservice 10409 * @since 11 10410 */ 10411/** 10412 * DragEvent object description 10413 * 10414 * @interface DragEvent 10415 * @syscap SystemCapability.ArkUI.ArkUI.Full 10416 * @crossplatform 10417 * @atomicservice 10418 * @since 14 10419 */ 10420declare interface DragEvent { 10421 /** 10422 * X coordinate of the touch point relative to the left edge of the device screen. 10423 * 10424 * @returns { number } 10425 * @syscap SystemCapability.ArkUI.ArkUI.Full 10426 * @since 10 10427 */ 10428 /** 10429 * X coordinate of the touch point relative to the left edge of the device screen. 10430 * 10431 * @returns { number } 10432 * @syscap SystemCapability.ArkUI.ArkUI.Full 10433 * @atomicservice 10434 * @since 11 10435 */ 10436 /** 10437 * X coordinate of the touch point relative to the left edge of the device screen. 10438 * 10439 * @returns { number } 10440 * @syscap SystemCapability.ArkUI.ArkUI.Full 10441 * @crossplatform 10442 * @atomicservice 10443 * @since 14 10444 */ 10445 getDisplayX(): number; 10446 10447 /** 10448 * Y coordinate of the touch point relative to the upper edge of the device screen. 10449 * 10450 * @returns { number } 10451 * @syscap SystemCapability.ArkUI.ArkUI.Full 10452 * @since 10 10453 */ 10454 /** 10455 * Y coordinate of the touch point relative to the upper edge of the device screen. 10456 * 10457 * @returns { number } 10458 * @syscap SystemCapability.ArkUI.ArkUI.Full 10459 * @atomicservice 10460 * @since 11 10461 */ 10462 /** 10463 * Y coordinate of the touch point relative to the upper edge of the device screen. 10464 * 10465 * @returns { number } 10466 * @syscap SystemCapability.ArkUI.ArkUI.Full 10467 * @crossplatform 10468 * @atomicservice 10469 * @since 14 10470 */ 10471 getDisplayY(): number; 10472 10473 /** 10474 * X coordinate of the touch point relative to the left edge of the current window. 10475 * 10476 * @returns { number } 10477 * @syscap SystemCapability.ArkUI.ArkUI.Full 10478 * @since 10 10479 */ 10480 /** 10481 * X coordinate of the touch point relative to the left edge of the current window. 10482 * 10483 * @returns { number } 10484 * @syscap SystemCapability.ArkUI.ArkUI.Full 10485 * @atomicservice 10486 * @since 11 10487 */ 10488 /** 10489 * X coordinate of the touch point relative to the left edge of the current window. 10490 * 10491 * @returns { number } 10492 * @syscap SystemCapability.ArkUI.ArkUI.Full 10493 * @crossplatform 10494 * @atomicservice 10495 * @since 14 10496 */ 10497 getWindowX(): number; 10498 10499 /** 10500 * Y coordinate of the touch point relative to the left edge of the current window. 10501 * 10502 * @returns { number } 10503 * @syscap SystemCapability.ArkUI.ArkUI.Full 10504 * @since 10 10505 */ 10506 /** 10507 * Y coordinate of the touch point relative to the left edge of the current window. 10508 * 10509 * @returns { number } 10510 * @syscap SystemCapability.ArkUI.ArkUI.Full 10511 * @atomicservice 10512 * @since 11 10513 */ 10514 /** 10515 * Y coordinate of the touch point relative to the left edge of the current window. 10516 * 10517 * @returns { number } 10518 * @syscap SystemCapability.ArkUI.ArkUI.Full 10519 * @crossplatform 10520 * @atomicservice 10521 * @since 14 10522 */ 10523 getWindowY(): number; 10524 10525 /** 10526 * X coordinate of the touch point relative to the left edge of the current window. in vp. 10527 * 10528 * @returns { number } 10529 * @syscap SystemCapability.ArkUI.ArkUI.Full 10530 * @since 7 10531 * @deprecated since 10 10532 * @useinstead DragEvent#getWindowX 10533 */ 10534 getX(): number; 10535 10536 /** 10537 * Y coordinate of the touch point relative to the left edge of the current window. in vp. 10538 * 10539 * @returns { number } 10540 * @syscap SystemCapability.ArkUI.ArkUI.Full 10541 * @since 7 10542 * @deprecated since 10 10543 * @useinstead DragEvent#getWindowY 10544 */ 10545 getY(): number; 10546 10547 /** 10548 * If copy is COPY, this DragEvent is a copy event. 10549 * @type { DragBehavior } Operation, if use copy then set COPY, else set MOVE. 10550 * @default COPY 10551 * @syscap SystemCapability.ArkUI.ArkUI.Full 10552 * @since 10 10553 */ 10554 /** 10555 * If copy is COPY, this DragEvent is a copy event. 10556 * @type { DragBehavior } Operation, if use copy then set COPY, else set MOVE. 10557 * @default COPY 10558 * @syscap SystemCapability.ArkUI.ArkUI.Full 10559 * @atomicservice 10560 * @since 11 10561 */ 10562 dragBehavior: DragBehavior; 10563 10564 /** 10565 * If useCustomDropAnimation is true, System will not use drop animation. 10566 * 10567 * @type { boolean } 10568 * @syscap SystemCapability.ArkUI.ArkUI.Full 10569 * @since 10 10570 */ 10571 /** 10572 * If useCustomDropAnimation is true, System will not use drop animation. 10573 * 10574 * @type { boolean } 10575 * @syscap SystemCapability.ArkUI.ArkUI.Full 10576 * @atomicservice 10577 * @since 11 10578 */ 10579 useCustomDropAnimation: boolean; 10580 10581 /** 10582 * Set dragData into DragEvent. 10583 * 10584 * @param { UnifiedData } unifiedData - dragData. 10585 * @syscap SystemCapability.ArkUI.ArkUI.Full 10586 * @crossplatform 10587 * @since 10 10588 */ 10589 /** 10590 * Set dragData into DragEvent. 10591 * 10592 * @param { UnifiedData } unifiedData - dragData. 10593 * @syscap SystemCapability.ArkUI.ArkUI.Full 10594 * @crossplatform 10595 * @atomicservice 10596 * @since 11 10597 */ 10598 setData(unifiedData: UnifiedData): void; 10599 10600 /** 10601 * Get dragData from DragEvent. 10602 * 10603 * @returns { UnifiedData } - get dragData. 10604 * @throws { BusinessError } 190001 - Data not found. 10605 * @throws { BusinessError } 190002 - Data error. 10606 * @syscap SystemCapability.ArkUI.ArkUI.Full 10607 * @crossplatform 10608 * @since 10 10609 */ 10610 /** 10611 * Get dragData from DragEvent. 10612 * 10613 * @returns { UnifiedData } - get dragData. 10614 * @throws { BusinessError } 190001 - Data not found. 10615 * @throws { BusinessError } 190002 - Data error. 10616 * @syscap SystemCapability.ArkUI.ArkUI.Full 10617 * @crossplatform 10618 * @atomicservice 10619 * @since 11 10620 */ 10621 getData(): UnifiedData; 10622 10623 /** 10624 * Get dragData summary from DragEvent. 10625 * 10626 * @returns { Summary } - get Summary Data. 10627 * @syscap SystemCapability.ArkUI.ArkUI.Full 10628 * @crossplatform 10629 * @since 10 10630 */ 10631 /** 10632 * Get dragData summary from DragEvent. 10633 * 10634 * @returns { Summary } - get Summary Data. 10635 * @syscap SystemCapability.ArkUI.ArkUI.Full 10636 * @crossplatform 10637 * @atomicservice 10638 * @since 11 10639 */ 10640 getSummary(): Summary; 10641 10642 /** 10643 * Set dragEvent result to DragEvent. 10644 * 10645 * @param { DragResult } dragResult - the return of dragEvent. 10646 * @syscap SystemCapability.ArkUI.ArkUI.Full 10647 * @since 10 10648 */ 10649 /** 10650 * Set dragEvent result to DragEvent. 10651 * 10652 * @param { DragResult } dragResult - the return of dragEvent. 10653 * @syscap SystemCapability.ArkUI.ArkUI.Full 10654 * @atomicservice 10655 * @since 11 10656 */ 10657 /** 10658 * Set dragEvent result to DragEvent. 10659 * 10660 * @param { DragResult } dragResult - the return of dragEvent. 10661 * @syscap SystemCapability.ArkUI.ArkUI.Full 10662 * @crossplatform 10663 * @atomicservice 10664 * @since 14 10665 */ 10666 setResult(dragResult: DragResult): void; 10667 10668 /** 10669 * Get dragEvent result from DragEvent. 10670 * 10671 * @returns { DragResult } - dragResult Data. 10672 * @syscap SystemCapability.ArkUI.ArkUI.Full 10673 * @since 10 10674 */ 10675 /** 10676 * Get dragEvent result from DragEvent. 10677 * 10678 * @returns { DragResult } - dragResult Data. 10679 * @syscap SystemCapability.ArkUI.ArkUI.Full 10680 * @atomicservice 10681 * @since 11 10682 */ 10683 /** 10684 * Get dragEvent result from DragEvent. 10685 * 10686 * @returns { DragResult } - dragResult Data. 10687 * @syscap SystemCapability.ArkUI.ArkUI.Full 10688 * @crossplatform 10689 * @atomicservice 10690 * @since 14 10691 */ 10692 getResult(): DragResult; 10693 10694 /** 10695 * Get the rectangle of drag window. 10696 * 10697 * @returns { Rectangle } - getPreview rectangle. 10698 * @syscap SystemCapability.ArkUI.ArkUI.Full 10699 * @since 10 10700 */ 10701 /** 10702 * Get the rectangle of drag window. 10703 * 10704 * @returns { Rectangle } - getPreview rectangle. 10705 * @syscap SystemCapability.ArkUI.ArkUI.Full 10706 * @atomicservice 10707 * @since 11 10708 */ 10709 /** 10710 * Get the rectangle of drag window. 10711 * 10712 * @returns { Rectangle } - getPreview rectangle. 10713 * @syscap SystemCapability.ArkUI.ArkUI.Full 10714 * @crossplatform 10715 * @atomicservice 10716 * @since 14 10717 */ 10718 getPreviewRect(): Rectangle; 10719 10720 /** 10721 * Get the x axis velocity of drag gesture. 10722 * 10723 * @returns { number } - get x axis velocity. 10724 * @syscap SystemCapability.ArkUI.ArkUI.Full 10725 * @crossplatform 10726 * @since 10 10727 */ 10728 /** 10729 * Get the x axis velocity of drag gesture. 10730 * 10731 * @returns { number } - get x axis velocity. 10732 * @syscap SystemCapability.ArkUI.ArkUI.Full 10733 * @crossplatform 10734 * @atomicservice 10735 * @since 11 10736 */ 10737 getVelocityX(): number; 10738 10739 /** 10740 * Get the y axis velocity of drag gesture. 10741 * 10742 * @returns { number } - get y axis velocity. 10743 * @syscap SystemCapability.ArkUI.ArkUI.Full 10744 * @crossplatform 10745 * @since 10 10746 */ 10747 /** 10748 * Get the y axis velocity of drag gesture. 10749 * 10750 * @returns { number } - get y axis velocity. 10751 * @syscap SystemCapability.ArkUI.ArkUI.Full 10752 * @crossplatform 10753 * @atomicservice 10754 * @since 11 10755 */ 10756 getVelocityY(): number; 10757 10758 /** 10759 * Get the velocity of drag gesture. 10760 * 10761 * @returns { number } - get velocity. 10762 * @syscap SystemCapability.ArkUI.ArkUI.Full 10763 * @crossplatform 10764 * @since 10 10765 */ 10766 /** 10767 * Get the velocity of drag gesture. 10768 * 10769 * @returns { number } - get velocity. 10770 * @syscap SystemCapability.ArkUI.ArkUI.Full 10771 * @crossplatform 10772 * @atomicservice 10773 * @since 11 10774 */ 10775 getVelocity(): number; 10776 10777 /** 10778 * Query the ModifierKey press state, support 'ctrl'|'alt'|'shift'|'fn' 10779 * 10780 * @param { Array<string> } keys - indicate the keys of the ModifierKey. 10781 * @returns { boolean } 10782 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 10783 * @syscap SystemCapability.ArkUI.ArkUI.Full 10784 * @crossplatform 10785 * @since 12 10786 */ 10787 /** 10788 * Query the ModifierKey press state, support 'ctrl'|'alt'|'shift'|'fn' 10789 * 10790 * @param { Array<string> } keys - indicate the keys of the ModifierKey. 10791 * @returns { boolean } 10792 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 10793 * @syscap SystemCapability.ArkUI.ArkUI.Full 10794 * @crossplatform 10795 * @atomicservice 10796 * @since 13 10797 */ 10798 getModifierKeyState?(keys: Array<string>): boolean; 10799 10800 /** 10801 * Request the drag data to be synchronized to caller, can be notified with the synchronization progress. 10802 * Only can be used in onDrop event processing. 10803 * 10804 * @param { DataSyncOptions } options - the data sync options. 10805 * @returns { string } The data key returned by system, which can be used as the identify of the request. 10806 * @throws { BusinessError } 401 - Parameter error. 10807 * @throws { BusinessError } 190003 - Operation no allowed for current pharse. 10808 * @syscap SystemCapability.ArkUI.ArkUI.Full 10809 * @atomicservice 10810 * @since 15 10811 */ 10812 startDataLoading(options: DataSyncOptions): string; 10813} 10814 10815/** 10816 * The event callback function for drag and drop common interfaces. 10817 * @typedef { function } OnDragEventCallback 10818 * @param { DragEvent } event - the event object indicating current drag status. 10819 * @param { string } [extraParams] - extra information set by user or system. 10820 * @syscap SystemCapability.ArkUI.ArkUI.Full 10821 * @crossplatform 10822 * @atomicservice 10823 * @since 15 10824 */ 10825declare type OnDragEventCallback = (event: DragEvent, extraParams?: string) => void; 10826 10827/** 10828 * Defines the options for the drop handling. 10829 * 10830 * @interface DropOptions 10831 * @syscap SystemCapability.ArkUI.ArkUI.Full 10832 * @crossplatform 10833 * @atomicservice 10834 * @since 15 10835 */ 10836declare interface DropOptions { 10837 10838 /** 10839 * Indicating to disable the UDMF data prefetch action by system or not. 10840 * The system will try to fetch data before calling user's onDrop for some situation, 10841 * it will retry to get data until the max time limit (2.4s for now) reaches, 10842 * this's useful for the cross device draging operation, as the system helps to eliminate 10843 * the communication instability, but it's redundant for startDataLoading method, as this 10844 * method will take care the data fetching with asynchronous mechanism, so must set this 10845 * field to true if using startDataLoading in onDrop to avoid the data is fetched before 10846 * onDrop executing unexpectedly. 10847 * 10848 * @type { boolean } 10849 * @syscap SystemCapability.ArkUI.ArkUI.Full 10850 * @crossplatform 10851 * @atomicservice 10852 * @since 15 10853 */ 10854 disableDataPrefetch?: boolean; 10855} 10856 10857/** 10858 * Import the IntentionCode type object for IntentionCode. 10859 * 10860 * @typedef { import('../api/@ohos.multimodalInput.intentionCode').IntentionCode } IntentionCode 10861 * @syscap SystemCapability.ArkUI.ArkUI.Full 10862 * @since 10 10863 */ 10864/** 10865 * Import the IntentionCode type object for IntentionCode. 10866 * 10867 * @typedef { import('../api/@ohos.multimodalInput.intentionCode').IntentionCode } IntentionCode 10868 * @syscap SystemCapability.ArkUI.ArkUI.Full 10869 * @atomicservice 10870 * @since 11 10871 */ 10872declare type IntentionCode = import('../api/@ohos.multimodalInput.intentionCode').IntentionCode; 10873 10874/** 10875 * KeyEvent object description: 10876 * 10877 * @interface KeyEvent 10878 * @syscap SystemCapability.ArkUI.ArkUI.Full 10879 * @since 7 10880 */ 10881/** 10882 * KeyEvent object description: 10883 * 10884 * @interface KeyEvent 10885 * @syscap SystemCapability.ArkUI.ArkUI.Full 10886 * @crossplatform 10887 * @since 10 10888 */ 10889/** 10890 * KeyEvent object description: 10891 * 10892 * @interface KeyEvent 10893 * @syscap SystemCapability.ArkUI.ArkUI.Full 10894 * @crossplatform 10895 * @atomicservice 10896 * @since 11 10897 */ 10898declare interface KeyEvent { 10899 /** 10900 * Type of a key. 10901 * 10902 * @type { KeyType } 10903 * @syscap SystemCapability.ArkUI.ArkUI.Full 10904 * @since 7 10905 */ 10906 /** 10907 * Type of a key. 10908 * 10909 * @type { KeyType } 10910 * @syscap SystemCapability.ArkUI.ArkUI.Full 10911 * @crossplatform 10912 * @since 10 10913 */ 10914 /** 10915 * Type of a key. 10916 * 10917 * @type { KeyType } 10918 * @syscap SystemCapability.ArkUI.ArkUI.Full 10919 * @crossplatform 10920 * @atomicservice 10921 * @since 11 10922 */ 10923 type: KeyType; 10924 10925 /** 10926 * Key code of a key 10927 * 10928 * @type { number } 10929 * @syscap SystemCapability.ArkUI.ArkUI.Full 10930 * @since 7 10931 */ 10932 /** 10933 * Key code of a key 10934 * 10935 * @type { number } 10936 * @syscap SystemCapability.ArkUI.ArkUI.Full 10937 * @crossplatform 10938 * @since 10 10939 */ 10940 /** 10941 * Key code of a key 10942 * 10943 * @type { number } 10944 * @syscap SystemCapability.ArkUI.ArkUI.Full 10945 * @crossplatform 10946 * @atomicservice 10947 * @since 11 10948 */ 10949 keyCode: number; 10950 10951 /** 10952 * Key value of a key. 10953 * 10954 * @type { string } 10955 * @syscap SystemCapability.ArkUI.ArkUI.Full 10956 * @since 7 10957 */ 10958 /** 10959 * Key value of a key. 10960 * 10961 * @type { string } 10962 * @syscap SystemCapability.ArkUI.ArkUI.Full 10963 * @crossplatform 10964 * @since 10 10965 */ 10966 /** 10967 * Key value of a key. 10968 * 10969 * @type { string } 10970 * @syscap SystemCapability.ArkUI.ArkUI.Full 10971 * @crossplatform 10972 * @atomicservice 10973 * @since 11 10974 */ 10975 keyText: string; 10976 10977 /** 10978 * Type of the input device that triggers the current key, such as the keyboard or handle. 10979 * 10980 * @type { KeySource } 10981 * @syscap SystemCapability.ArkUI.ArkUI.Full 10982 * @since 7 10983 */ 10984 /** 10985 * Type of the input device that triggers the current key, such as the keyboard or handle. 10986 * 10987 * @type { KeySource } 10988 * @syscap SystemCapability.ArkUI.ArkUI.Full 10989 * @crossplatform 10990 * @since 10 10991 */ 10992 /** 10993 * Type of the input device that triggers the current key, such as the keyboard or handle. 10994 * 10995 * @type { KeySource } 10996 * @syscap SystemCapability.ArkUI.ArkUI.Full 10997 * @crossplatform 10998 * @atomicservice 10999 * @since 11 11000 */ 11001 keySource: KeySource; 11002 11003 /** 11004 * Indicates the ID of the input device that triggers the current key. 11005 * 11006 * @type { number } 11007 * @syscap SystemCapability.ArkUI.ArkUI.Full 11008 * @since 7 11009 */ 11010 /** 11011 * Indicates the ID of the input device that triggers the current key. 11012 * 11013 * @type { number } 11014 * @syscap SystemCapability.ArkUI.ArkUI.Full 11015 * @crossplatform 11016 * @since 10 11017 */ 11018 /** 11019 * Indicates the ID of the input device that triggers the current key. 11020 * 11021 * @type { number } 11022 * @syscap SystemCapability.ArkUI.ArkUI.Full 11023 * @crossplatform 11024 * @atomicservice 11025 * @since 11 11026 */ 11027 deviceId: number; 11028 11029 /** 11030 * Indicates the status of the key when the key is pressed. 11031 * The value 1 indicates the pressed state, and the value 0 indicates the unpressed state. 11032 * 11033 * @type { number } 11034 * @syscap SystemCapability.ArkUI.ArkUI.Full 11035 * @since 7 11036 */ 11037 /** 11038 * Indicates the status of the key when the key is pressed. 11039 * The value 1 indicates the pressed state, and the value 0 indicates the unpressed state. 11040 * 11041 * @type { number } 11042 * @syscap SystemCapability.ArkUI.ArkUI.Full 11043 * @crossplatform 11044 * @since 10 11045 */ 11046 /** 11047 * Indicates the status of the key when the key is pressed. 11048 * The value 1 indicates the pressed state, and the value 0 indicates the unpressed state. 11049 * 11050 * @type { number } 11051 * @syscap SystemCapability.ArkUI.ArkUI.Full 11052 * @crossplatform 11053 * @atomicservice 11054 * @since 11 11055 */ 11056 metaKey: number; 11057 11058 /** 11059 * Timestamp when the key was pressed. 11060 * 11061 * @type { number } 11062 * @syscap SystemCapability.ArkUI.ArkUI.Full 11063 * @since 7 11064 */ 11065 /** 11066 * Timestamp when the key was pressed. 11067 * 11068 * @type { number } 11069 * @syscap SystemCapability.ArkUI.ArkUI.Full 11070 * @crossplatform 11071 * @since 10 11072 */ 11073 /** 11074 * Timestamp when the key was pressed. 11075 * 11076 * @type { number } 11077 * @syscap SystemCapability.ArkUI.ArkUI.Full 11078 * @crossplatform 11079 * @atomicservice 11080 * @since 11 11081 */ 11082 timestamp: number; 11083 11084 /** 11085 * Block event bubbling. 11086 * 11087 * @type { function } 11088 * @syscap SystemCapability.ArkUI.ArkUI.Full 11089 * @since 7 11090 */ 11091 /** 11092 * Block event bubbling. 11093 * 11094 * @type { function } 11095 * @syscap SystemCapability.ArkUI.ArkUI.Full 11096 * @crossplatform 11097 * @since 10 11098 */ 11099 /** 11100 * Block event bubbling. 11101 * 11102 * @type { function } 11103 * @syscap SystemCapability.ArkUI.ArkUI.Full 11104 * @crossplatform 11105 * @atomicservice 11106 * @since 11 11107 */ 11108 stopPropagation: () => void; 11109 11110 /** 11111 * Intention code of a key or modifier keys. 11112 * 11113 * @type { IntentionCode } 11114 * @default IntentionCode.INTENTION_UNKNOWN 11115 * @syscap SystemCapability.ArkUI.ArkUI.Full 11116 * @since 10 11117 */ 11118 /** 11119 * Intention code of a key or modifier keys. 11120 * 11121 * @type { IntentionCode } 11122 * @default IntentionCode.INTENTION_UNKNOWN 11123 * @syscap SystemCapability.ArkUI.ArkUI.Full 11124 * @atomicservice 11125 * @since 11 11126 */ 11127 intentionCode: IntentionCode; 11128 11129 /** 11130 * Get the modifier keys press state, support 'ctrl'|'alt'|'shift'|'fn' 11131 * 11132 * @param { Array<string> } keys - indicate the modifier keys. 11133 * @returns { boolean } 11134 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 11135 * @syscap SystemCapability.ArkUI.ArkUI.Full 11136 * @crossplatform 11137 * @since 12 11138 */ 11139 /** 11140 * Get the modifier keys press state, support 'ctrl'|'alt'|'shift'|'fn' 11141 * 11142 * @param { Array<string> } keys - indicate the modifier keys. 11143 * @returns { boolean } 11144 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 11145 * @syscap SystemCapability.ArkUI.ArkUI.Full 11146 * @crossplatform 11147 * @atomicservice 11148 * @since 13 11149 */ 11150 getModifierKeyState?(keys: Array<string>): boolean; 11151 11152 /** 11153 * Unicode of a key 11154 * 11155 * @type { ?number } 11156 * @syscap SystemCapability.ArkUI.ArkUI.Full 11157 * @atomicservice 11158 * @since 14 11159 */ 11160 unicode?: number; 11161} 11162 11163/** 11164 * Focus axis event object description. 11165 * 11166 * @extends BaseEvent 11167 * @interface FocusAxisEvent 11168 * @syscap SystemCapability.ArkUI.ArkUI.Full 11169 * @atomicservice 11170 * @since 15 11171 */ 11172declare interface FocusAxisEvent extends BaseEvent { 11173 /** 11174 * The axis values of axis event. 11175 * 11176 * @type { Map<AxisModel, number> } 11177 * @syscap SystemCapability.ArkUI.ArkUI.Full 11178 * @atomicservice 11179 * @since 15 11180 */ 11181 axisMap: Map<AxisModel, number>; 11182 11183 /** 11184 * The blocking event pops up. 11185 * 11186 * @type { Callback<void> } 11187 * @syscap SystemCapability.ArkUI.ArkUI.Full 11188 * @atomicservice 11189 * @since 15 11190 */ 11191 stopPropagation: Callback<void>; 11192} 11193 11194/** 11195 * Overlay module options 11196 * 11197 * @interface BindOptions 11198 * @syscap SystemCapability.ArkUI.ArkUI.Full 11199 * @crossplatform 11200 * @since 10 11201 */ 11202/** 11203 * Overlay module options 11204 * 11205 * @interface BindOptions 11206 * @syscap SystemCapability.ArkUI.ArkUI.Full 11207 * @crossplatform 11208 * @atomicservice 11209 * @since 11 11210 */ 11211declare interface BindOptions { 11212 /** 11213 * Defines the background color 11214 * 11215 * @type { ?ResourceColor } 11216 * @syscap SystemCapability.ArkUI.ArkUI.Full 11217 * @crossplatform 11218 * @since 10 11219 */ 11220 /** 11221 * Defines the background color 11222 * 11223 * @type { ?ResourceColor } 11224 * @syscap SystemCapability.ArkUI.ArkUI.Full 11225 * @crossplatform 11226 * @atomicservice 11227 * @since 11 11228 */ 11229 backgroundColor?: ResourceColor; 11230 11231 /** 11232 * Callback function when overlay interface appears 11233 * 11234 * @type { ?function } 11235 * @syscap SystemCapability.ArkUI.ArkUI.Full 11236 * @crossplatform 11237 * @since 10 11238 */ 11239 /** 11240 * Callback function when overlay interface appears 11241 * 11242 * @type { ?function } 11243 * @syscap SystemCapability.ArkUI.ArkUI.Full 11244 * @crossplatform 11245 * @atomicservice 11246 * @since 11 11247 */ 11248 onAppear?: () => void; 11249 11250 /** 11251 * Callback function when overlay interface exits 11252 * 11253 * @type { ?function } 11254 * @syscap SystemCapability.ArkUI.ArkUI.Full 11255 * @crossplatform 11256 * @since 10 11257 */ 11258 /** 11259 * Callback function when overlay interface exits 11260 * 11261 * @type { ?function } 11262 * @syscap SystemCapability.ArkUI.ArkUI.Full 11263 * @crossplatform 11264 * @atomicservice 11265 * @since 11 11266 */ 11267 onDisappear?: () => void; 11268 11269 /** 11270 * Callback function before overlay animation starts. 11271 * 11272 * @type { ?function } 11273 * @syscap SystemCapability.ArkUI.ArkUI.Full 11274 * @crossplatform 11275 * @atomicservice 11276 * @since 12 11277 */ 11278 onWillAppear?: () => void; 11279 11280 /** 11281 * Callback function before overlay popAnimation starts. 11282 * 11283 * @type { ?function } 11284 * @syscap SystemCapability.ArkUI.ArkUI.Full 11285 * @crossplatform 11286 * @atomicservice 11287 * @since 12 11288 */ 11289 onWillDisappear?: () => void; 11290} 11291 11292/** 11293 * Component content cover dismiss 11294 * 11295 * @interface DismissContentCoverAction 11296 * @syscap SystemCapability.ArkUI.ArkUI.Full 11297 * @crossplatform 11298 * @atomicservice 11299 * @since 12 11300 */ 11301declare interface DismissContentCoverAction { 11302 /** 11303 * Defines content cover dismiss function 11304 * 11305 * @type { Callback<void> } 11306 * @syscap SystemCapability.ArkUI.ArkUI.Full 11307 * @crossplatform 11308 * @atomicservice 11309 * @since 12 11310 */ 11311 dismiss: Callback<void>; 11312 11313 /** 11314 * Defines content cover dismiss reason 11315 * 11316 * @type { DismissReason } 11317 * @syscap SystemCapability.ArkUI.ArkUI.Full 11318 * @crossplatform 11319 * @atomicservice 11320 * @since 12 11321 */ 11322 reason: DismissReason; 11323} 11324 11325/** 11326 * Component content cover options 11327 * 11328 * @interface ContentCoverOptions 11329 * @syscap SystemCapability.ArkUI.ArkUI.Full 11330 * @crossplatform 11331 * @since 10 11332 */ 11333/** 11334 * Component content cover options 11335 * 11336 * @interface ContentCoverOptions 11337 * @syscap SystemCapability.ArkUI.ArkUI.Full 11338 * @crossplatform 11339 * @atomicservice 11340 * @since 11 11341 */ 11342declare interface ContentCoverOptions extends BindOptions { 11343 /** 11344 * Defines transition type 11345 * 11346 * @type { ?ModalTransition } 11347 * @default ModalTransition.Default 11348 * @syscap SystemCapability.ArkUI.ArkUI.Full 11349 * @crossplatform 11350 * @since 10 11351 */ 11352 /** 11353 * Defines transition type 11354 * 11355 * @type { ?ModalTransition } 11356 * @default ModalTransition.Default 11357 * @syscap SystemCapability.ArkUI.ArkUI.Full 11358 * @crossplatform 11359 * @atomicservice 11360 * @since 11 11361 */ 11362 modalTransition?: ModalTransition, 11363 11364 /** 11365 * Callback function when the content cover interactive dismiss 11366 * 11367 * @type { ?Callback<DismissContentCoverAction> } 11368 * @syscap SystemCapability.ArkUI.ArkUI.Full 11369 * @crossplatform 11370 * @atomicservice 11371 * @since 12 11372 */ 11373 onWillDismiss?: Callback<DismissContentCoverAction>; 11374 11375 /** 11376 * Defines transition effect param 11377 * 11378 * @type { ?TransitionEffect } 11379 * @syscap SystemCapability.ArkUI.ArkUI.Full 11380 * @crossplatform 11381 * @atomicservice 11382 * @since 12 11383 */ 11384 transition?: TransitionEffect; 11385} 11386 11387/** 11388 * Component sheet title options 11389 * 11390 * @interface SheetTitleOptions 11391 * @syscap SystemCapability.ArkUI.ArkUI.Full 11392 * @crossplatform 11393 * @since 11 11394 */ 11395/** 11396 * Component sheet title options 11397 * 11398 * @interface SheetTitleOptions 11399 * @syscap SystemCapability.ArkUI.ArkUI.Full 11400 * @crossplatform 11401 * @atomicservice 11402 * @since 12 11403 */ 11404declare interface SheetTitleOptions { 11405 /** 11406 * Defines title text 11407 * 11408 * @type { ResourceStr } 11409 * @syscap SystemCapability.ArkUI.ArkUI.Full 11410 * @crossplatform 11411 * @since 11 11412 */ 11413 /** 11414 * Defines title text 11415 * 11416 * @type { ResourceStr } 11417 * @syscap SystemCapability.ArkUI.ArkUI.Full 11418 * @crossplatform 11419 * @atomicservice 11420 * @since 12 11421 */ 11422 title: ResourceStr; 11423 11424 /** 11425 * Defines subtitle text 11426 * 11427 * @type { ?ResourceStr } 11428 * @syscap SystemCapability.ArkUI.ArkUI.Full 11429 * @crossplatform 11430 * @since 11 11431 */ 11432 /** 11433 * Defines subtitle text 11434 * 11435 * @type { ?ResourceStr } 11436 * @syscap SystemCapability.ArkUI.ArkUI.Full 11437 * @crossplatform 11438 * @atomicservice 11439 * @since 12 11440 */ 11441 subtitle?: ResourceStr; 11442} 11443 11444/** 11445 * Defines the sheet type. 11446 * 11447 * @enum { number } 11448 * @syscap SystemCapability.ArkUI.ArkUI.Full 11449 * @crossplatform 11450 * @since 11 11451 */ 11452/** 11453 * Defines the sheet type. 11454 * 11455 * @enum { number } 11456 * @syscap SystemCapability.ArkUI.ArkUI.Full 11457 * @crossplatform 11458 * @atomicservice 11459 * @since 12 11460 */ 11461declare enum SheetType { 11462 /** 11463 * Defines bottom sheet type. 11464 * 11465 * @syscap SystemCapability.ArkUI.ArkUI.Full 11466 * @crossplatform 11467 * @since 11 11468 */ 11469 /** 11470 * Defines bottom sheet type. 11471 * 11472 * @syscap SystemCapability.ArkUI.ArkUI.Full 11473 * @crossplatform 11474 * @atomicservice 11475 * @since 12 11476 */ 11477 BOTTOM = 0, 11478 11479 /** 11480 * Defines center sheet type. 11481 * 11482 * @syscap SystemCapability.ArkUI.ArkUI.Full 11483 * @crossplatform 11484 * @since 11 11485 */ 11486 /** 11487 * Defines center sheet type. 11488 * 11489 * @syscap SystemCapability.ArkUI.ArkUI.Full 11490 * @crossplatform 11491 * @atomicservice 11492 * @since 12 11493 */ 11494 CENTER = 1, 11495 11496 /** 11497 * Defines popup sheet type. 11498 * 11499 * @syscap SystemCapability.ArkUI.ArkUI.Full 11500 * @crossplatform 11501 * @since 11 11502 */ 11503 /** 11504 * Defines popup sheet type. 11505 * 11506 * @syscap SystemCapability.ArkUI.ArkUI.Full 11507 * @crossplatform 11508 * @atomicservice 11509 * @since 12 11510 */ 11511 POPUP = 2, 11512} 11513 11514/** 11515 * Define the display mode of the sheet. 11516 * 11517 * @enum { number } 11518 * @syscap SystemCapability.ArkUI.ArkUI.Full 11519 * @crossplatform 11520 * @atomicservice 11521 * @since 12 11522 */ 11523declare enum SheetMode { 11524 /** 11525 * Sheet displays above all page levels. 11526 * 11527 * @syscap SystemCapability.ArkUI.ArkUI.Full 11528 * @crossplatform 11529 * @atomicservice 11530 * @since 12 11531 */ 11532 OVERLAY = 0, 11533 11534 /** 11535 * Sheet displays within the current page. 11536 * 11537 * @syscap SystemCapability.ArkUI.ArkUI.Full 11538 * @crossplatform 11539 * @atomicservice 11540 * @since 12 11541 */ 11542 EMBEDDED = 1, 11543} 11544 11545/** 11546 * Define the scroll size mode of the sheet. 11547 * 11548 * @enum { number } 11549 * @syscap SystemCapability.ArkUI.ArkUI.Full 11550 * @crossplatform 11551 * @atomicservice 11552 * @since 12 11553 */ 11554declare enum ScrollSizeMode { 11555 /** 11556 * Sheet change scroll size after the slide ends. 11557 * 11558 * @syscap SystemCapability.ArkUI.ArkUI.Full 11559 * @crossplatform 11560 * @atomicservice 11561 * @since 12 11562 */ 11563 FOLLOW_DETENT = 0, 11564 11565 /** 11566 * Sheet change scroll size during the sliding process. 11567 * 11568 * @syscap SystemCapability.ArkUI.ArkUI.Full 11569 * @crossplatform 11570 * @atomicservice 11571 * @since 12 11572 */ 11573 CONTINUOUS = 1, 11574} 11575 11576/** 11577 * Define the mode of sheet how to avoid keyboard. 11578 * 11579 * @enum { number } 11580 * @syscap SystemCapability.ArkUI.ArkUI.Full 11581 * @crossplatform 11582 * @atomicservice 11583 * @since 13 11584 */ 11585declare enum SheetKeyboardAvoidMode { 11586 /** 11587 * Sheet will not aovid keyboard. 11588 * 11589 * @syscap SystemCapability.ArkUI.ArkUI.Full 11590 * @crossplatform 11591 * @atomicservice 11592 * @since 13 11593 */ 11594 NONE = 0, 11595 11596 /** 11597 * Firstly sheet will avoid keyboard by changing its height. 11598 * And then sheet will avoid by resizing after reaching its maximum height. 11599 * 11600 * @syscap SystemCapability.ArkUI.ArkUI.Full 11601 * @crossplatform 11602 * @atomicservice 11603 * @since 13 11604 */ 11605 TRANSLATE_AND_RESIZE = 1, 11606 11607 /** 11608 * Sheet will only avoid keyboard by resizing the content. 11609 * 11610 * @syscap SystemCapability.ArkUI.ArkUI.Full 11611 * @crossplatform 11612 * @atomicservice 11613 * @since 13 11614 */ 11615 RESIZE_ONLY = 2, 11616 11617 /** 11618 * Firstly sheet will avoid keyboard by changing its height. 11619 * And then sheet will avoid keyboard by scrolling after reaching its maximum height. 11620 * 11621 * @syscap SystemCapability.ArkUI.ArkUI.Full 11622 * @crossplatform 11623 * @atomicservice 11624 * @since 13 11625 */ 11626 TRANSLATE_AND_SCROLL = 3, 11627} 11628 11629/** 11630 * Component sheet dismiss 11631 * 11632 * @interface SheetDismiss 11633 * @syscap SystemCapability.ArkUI.ArkUI.Full 11634 * @crossplatform 11635 * @since 11 11636 */ 11637/** 11638 * Component sheet dismiss 11639 * 11640 * @interface SheetDismiss 11641 * @syscap SystemCapability.ArkUI.ArkUI.Full 11642 * @crossplatform 11643 * @atomicservice 11644 * @since 12 11645 */ 11646declare interface SheetDismiss { 11647 /** 11648 * Defines sheet dismiss function 11649 * 11650 * @type { function } 11651 * @syscap SystemCapability.ArkUI.ArkUI.Full 11652 * @crossplatform 11653 * @since 11 11654 */ 11655 /** 11656 * Defines sheet dismiss function 11657 * 11658 * @type { function } 11659 * @syscap SystemCapability.ArkUI.ArkUI.Full 11660 * @crossplatform 11661 * @atomicservice 11662 * @since 12 11663 */ 11664 dismiss: () => void; 11665} 11666 11667/** 11668 * Component sheet dismiss 11669 * 11670 * @interface DismissSheetAction 11671 * @syscap SystemCapability.ArkUI.ArkUI.Full 11672 * @crossplatform 11673 * @atomicservice 11674 * @since 12 11675 */ 11676declare interface DismissSheetAction { 11677 11678 /** 11679 * Defines sheet dismiss function 11680 * 11681 * @type { Callback<void> } 11682 * @syscap SystemCapability.ArkUI.ArkUI.Full 11683 * @crossplatform 11684 * @atomicservice 11685 * @since 12 11686 */ 11687 dismiss: Callback<void>; 11688 11689 /** 11690 * Dismiss reason type. 11691 * 11692 * @type { DismissReason } 11693 * @syscap SystemCapability.ArkUI.ArkUI.Full 11694 * @crossplatform 11695 * @atomicservice 11696 * @since 12 11697 */ 11698 reason: DismissReason; 11699} 11700 11701/** 11702 * Defines sheet spring back action 11703 * 11704 * @interface SpringBackAction 11705 * @syscap SystemCapability.ArkUI.ArkUI.Full 11706 * @crossplatform 11707 * @atomicservice 11708 * @since 12 11709 */ 11710declare interface SpringBackAction { 11711 /** 11712 * Defines spring back function 11713 * 11714 * @type { Callback<void> } 11715 * @syscap SystemCapability.ArkUI.ArkUI.Full 11716 * @crossplatform 11717 * @atomicservice 11718 * @since 12 11719 */ 11720 springBack: Callback<void>; 11721} 11722 11723/** 11724 * Component sheet options 11725 * 11726 * @interface SheetOptions 11727 * @syscap SystemCapability.ArkUI.ArkUI.Full 11728 * @crossplatform 11729 * @since 10 11730 */ 11731/** 11732 * Component sheet options 11733 * 11734 * @interface SheetOptions 11735 * @syscap SystemCapability.ArkUI.ArkUI.Full 11736 * @crossplatform 11737 * @atomicservice 11738 * @since 11 11739 */ 11740declare interface SheetOptions extends BindOptions { 11741 /** 11742 * Defines sheet height 11743 * 11744 * @type { ?(SheetSize | Length) } 11745 * @default Sheet.LARGE 11746 * @syscap SystemCapability.ArkUI.ArkUI.Full 11747 * @crossplatform 11748 * @since 10 11749 */ 11750 /** 11751 * Defines sheet height 11752 * 11753 * @type { ?(SheetSize | Length) } 11754 * @default Sheet.LARGE 11755 * @syscap SystemCapability.ArkUI.ArkUI.Full 11756 * @crossplatform 11757 * @atomicservice 11758 * @since 11 11759 */ 11760 height?: SheetSize | Length; 11761 11762 /** 11763 * Defines whether the control bar is displayed. 11764 * 11765 * @type { ?boolean } 11766 * @default true 11767 * @syscap SystemCapability.ArkUI.ArkUI.Full 11768 * @crossplatform 11769 * @since 10 11770 */ 11771 /** 11772 * Defines whether the control bar is displayed. 11773 * 11774 * @type { ?boolean } 11775 * @default true 11776 * @syscap SystemCapability.ArkUI.ArkUI.Full 11777 * @crossplatform 11778 * @atomicservice 11779 * @since 11 11780 */ 11781 dragBar?: boolean; 11782 11783 /** 11784 * Defines sheet maskColor 11785 * 11786 * @type { ?ResourceColor } 11787 * @syscap SystemCapability.ArkUI.ArkUI.Full 11788 * @crossplatform 11789 * @since 10 11790 */ 11791 /** 11792 * Defines sheet maskColor 11793 * 11794 * @type { ?ResourceColor } 11795 * @syscap SystemCapability.ArkUI.ArkUI.Full 11796 * @crossplatform 11797 * @atomicservice 11798 * @since 11 11799 */ 11800 maskColor?: ResourceColor; 11801 11802 /** 11803 * Defines sheet detents 11804 * 11805 * @type { ?[(SheetSize | Length), (SheetSize | Length)?, (SheetSize | Length)?] } 11806 * @syscap SystemCapability.ArkUI.ArkUI.Full 11807 * @crossplatform 11808 * @since 11 11809 */ 11810 /** 11811 * Defines sheet detents 11812 * 11813 * @type { ?[(SheetSize | Length), (SheetSize | Length)?, (SheetSize | Length)?] } 11814 * @syscap SystemCapability.ArkUI.ArkUI.Full 11815 * @crossplatform 11816 * @atomicservice 11817 * @since 12 11818 */ 11819 detents?: [(SheetSize | Length), (SheetSize | Length)?, (SheetSize | Length)?]; 11820 11821 /** 11822 * Defines sheet background blur Style 11823 * 11824 * @type { ?BlurStyle } 11825 * @default BlurStyle.NONE 11826 * @syscap SystemCapability.ArkUI.ArkUI.Full 11827 * @crossplatform 11828 * @since 11 11829 */ 11830 /** 11831 * Defines sheet background blur Style 11832 * 11833 * @type { ?BlurStyle } 11834 * @default BlurStyle.NONE 11835 * @syscap SystemCapability.ArkUI.ArkUI.Full 11836 * @crossplatform 11837 * @atomicservice 11838 * @since 12 11839 */ 11840 blurStyle?: BlurStyle; 11841 11842 /** 11843 * Defines whether the close icon is displayed 11844 * 11845 * @type { ?(boolean | Resource) } 11846 * @default true 11847 * @syscap SystemCapability.ArkUI.ArkUI.Full 11848 * @crossplatform 11849 * @since 11 11850 */ 11851 /** 11852 * Defines whether the close icon is displayed 11853 * 11854 * @type { ?(boolean | Resource) } 11855 * @default true 11856 * @syscap SystemCapability.ArkUI.ArkUI.Full 11857 * @crossplatform 11858 * @atomicservice 11859 * @since 12 11860 */ 11861 showClose?: boolean | Resource; 11862 11863 /** 11864 * Defines the sheet prefer type 11865 * 11866 * @type { ?(SheetType.CENTER | SheetType.POPUP) } 11867 * @syscap SystemCapability.ArkUI.ArkUI.Full 11868 * @crossplatform 11869 * @since 11 11870 */ 11871 /** 11872 * Defines the sheet prefer type 11873 * 11874 * @type { ?SheetType } 11875 * @syscap SystemCapability.ArkUI.ArkUI.Full 11876 * @crossplatform 11877 * @atomicservice 11878 * @since 12 11879 */ 11880 preferType?: SheetType; 11881 11882 /** 11883 * Defines the sheet title 11884 * 11885 * @type { ?(SheetTitleOptions | CustomBuilder) } 11886 * @syscap SystemCapability.ArkUI.ArkUI.Full 11887 * @crossplatform 11888 * @since 11 11889 */ 11890 /** 11891 * Defines the sheet title 11892 * 11893 * @type { ?(SheetTitleOptions | CustomBuilder) } 11894 * @syscap SystemCapability.ArkUI.ArkUI.Full 11895 * @crossplatform 11896 * @atomicservice 11897 * @since 12 11898 */ 11899 title?: SheetTitleOptions | CustomBuilder; 11900 11901 /** 11902 * Callback function when the sheet interactive dismiss 11903 * 11904 * @type { ?function } 11905 * @syscap SystemCapability.ArkUI.ArkUI.Full 11906 * @crossplatform 11907 * @since 11 11908 */ 11909 /** 11910 * Callback function when the sheet interactive dismiss 11911 * 11912 * @type { ?function } 11913 * @syscap SystemCapability.ArkUI.ArkUI.Full 11914 * @crossplatform 11915 * @atomicservice 11916 * @since 12 11917 */ 11918 shouldDismiss?: (sheetDismiss: SheetDismiss) => void; 11919 11920 /** 11921 * Callback function when the sheet will dismiss 11922 * 11923 * @type { ?Callback<DismissSheetAction> } 11924 * @syscap SystemCapability.ArkUI.ArkUI.Full 11925 * @crossplatform 11926 * @atomicservice 11927 * @since 12 11928 */ 11929 onWillDismiss?: Callback<DismissSheetAction>; 11930 11931 /** 11932 * Sheet springs back callback when dismiss 11933 * 11934 * @type { ?Callback<SpringBackAction> } 11935 * @syscap SystemCapability.ArkUI.ArkUI.Full 11936 * @crossplatform 11937 * @atomicservice 11938 * @since 12 11939 */ 11940 onWillSpringBackWhenDismiss?: Callback<SpringBackAction>; 11941 11942 /** 11943 * Set whether interaction is allowed outside the sheet 11944 * 11945 * @type { ?boolean } 11946 * @default false 11947 * @syscap SystemCapability.ArkUI.ArkUI.Full 11948 * @crossplatform 11949 * @since 11 11950 */ 11951 /** 11952 * Set whether interaction is allowed outside the sheet 11953 * 11954 * @type { ?boolean } 11955 * @default false 11956 * @syscap SystemCapability.ArkUI.ArkUI.Full 11957 * @crossplatform 11958 * @atomicservice 11959 * @since 12 11960 */ 11961 enableOutsideInteractive?: boolean; 11962 11963 /** 11964 * Defines the sheet's width. 11965 * 11966 * @type { ?Dimension } 11967 * @syscap SystemCapability.ArkUI.ArkUI.Full 11968 * @crossplatform 11969 * @atomicservice 11970 * @since 12 11971 */ 11972 width?: Dimension; 11973 11974 /** 11975 * Defines the sheet's border width. 11976 * 11977 * @type { ?(Dimension | EdgeWidths | LocalizedEdgeWidths) } 11978 * @syscap SystemCapability.ArkUI.ArkUI.Full 11979 * @crossplatform 11980 * @atomicservice 11981 * @since 12 11982 */ 11983 borderWidth?: Dimension | EdgeWidths | LocalizedEdgeWidths; 11984 11985 /** 11986 * Defines the sheet's border color. 11987 * 11988 * @type { ?(ResourceColor | EdgeColors | LocalizedEdgeColors) } 11989 * @syscap SystemCapability.ArkUI.ArkUI.Full 11990 * @crossplatform 11991 * @atomicservice 11992 * @since 12 11993 */ 11994 borderColor?: ResourceColor | EdgeColors | LocalizedEdgeColors; 11995 11996 /** 11997 * Defines the sheet's border style. 11998 * 11999 * @type { ?(BorderStyle | EdgeStyles) } 12000 * @syscap SystemCapability.ArkUI.ArkUI.Full 12001 * @crossplatform 12002 * @atomicservice 12003 * @since 12 12004 */ 12005 borderStyle?: BorderStyle | EdgeStyles; 12006 12007 /** 12008 * Defines the sheet's shadow. 12009 * 12010 * @type { ?(ShadowOptions | ShadowStyle) } 12011 * @syscap SystemCapability.ArkUI.ArkUI.Full 12012 * @crossplatform 12013 * @atomicservice 12014 * @since 12 12015 */ 12016 shadow?: ShadowOptions | ShadowStyle; 12017 12018 /** 12019 * Called when height of the sheet is changed 12020 * 12021 * @type { ?Callback<number> } 12022 * @syscap SystemCapability.ArkUI.ArkUI.Full 12023 * @crossplatform 12024 * @atomicservice 12025 * @since 12 12026 */ 12027 onHeightDidChange?: Callback<number>; 12028 12029 /** 12030 * Determine the level sheet shows, whether sheet should be displayed within the page 12031 * 12032 * @type { ?SheetMode } 12033 * @default SheetMode.OVERLAY 12034 * @syscap SystemCapability.ArkUI.ArkUI.Full 12035 * @crossplatform 12036 * @atomicservice 12037 * @since 12 12038 */ 12039 mode?: SheetMode; 12040 12041 /** 12042 * Determine sheet scroll size mode. 12043 * 12044 * @type { ?ScrollSizeMode } 12045 * @default ScrollSizeMode.FELLOW_DETEND 12046 * @syscap SystemCapability.ArkUI.ArkUI.Full 12047 * @crossplatform 12048 * @atomicservice 12049 * @since 12 12050 */ 12051 scrollSizeMode?: ScrollSizeMode; 12052 12053 /** 12054 * Called when detents of the sheet changed 12055 * 12056 * @type { ?Callback<number> } 12057 * @syscap SystemCapability.ArkUI.ArkUI.Full 12058 * @crossplatform 12059 * @atomicservice 12060 * @since 12 12061 */ 12062 onDetentsDidChange?: Callback<number>; 12063 12064 /** 12065 * Called when width of the sheet changed 12066 * 12067 * @type { ?Callback<number> } 12068 * @syscap SystemCapability.ArkUI.ArkUI.Full 12069 * @crossplatform 12070 * @atomicservice 12071 * @since 12 12072 */ 12073 onWidthDidChange?: Callback<number>; 12074 12075 /** 12076 * Called when the sheet type changed 12077 * 12078 * @type { ?Callback<SheetType> } 12079 * @syscap SystemCapability.ArkUI.ArkUI.Full 12080 * @crossplatform 12081 * @atomicservice 12082 * @since 12 12083 */ 12084 onTypeDidChange?: Callback<SheetType>; 12085 12086 /** 12087 * The UIContext that the sheet belongs to 12088 * 12089 * @type { ?UIContext } 12090 * @syscap SystemCapability.ArkUI.ArkUI.Full 12091 * @crossplatform 12092 * @atomicservice 12093 * @since 12 12094 */ 12095 uiContext?: UIContext; 12096 12097 /** 12098 * Determine the mode of sheet how to avoid keyboard. 12099 * 12100 * @type { ?SheetKeyboardAvoidMode } 12101 * @default SheetKeyboardAvoidMode.TRANSLATE_AND_SCROLL 12102 * @syscap SystemCapability.ArkUI.ArkUI.Full 12103 * @crossplatform 12104 * @atomicservice 12105 * @since 13 12106 */ 12107 keyboardAvoidMode?: SheetKeyboardAvoidMode; 12108 12109 /** 12110 * Defines whether to respond to the hover mode. 12111 * 12112 * @type { ?boolean } 12113 * @default false 12114 * @syscap SystemCapability.ArkUI.ArkUI.Full 12115 * @crossplatform 12116 * @atomicservice 12117 * @since 14 12118 */ 12119 enableHoverMode?: boolean; 12120 12121 /** 12122 * Defines the sheet's display area in hover mode. 12123 * 12124 * @type { ?HoverModeAreaType } 12125 * @default HoverModeAreaType.BOTTOM_SCREEN 12126 * @syscap SystemCapability.ArkUI.ArkUI.Full 12127 * @crossplatform 12128 * @atomicservice 12129 * @since 14 12130 */ 12131 hoverModeArea?: HoverModeAreaType; 12132 12133 /** 12134 * Sets the position offset of the bindSheet. 12135 * 12136 * @type { ?Position } 12137 * @syscap SystemCapability.ArkUI.ArkUI.Full 12138 * @systemapi 12139 * @since 14 12140 */ 12141 offset?: Position 12142 12143 /** 12144 * Defines sheet radius 12145 * 12146 * @type { ?(LengthMetrics | BorderRadiuses | LocalizedBorderRadiuses) } 12147 * @syscap SystemCapability.ArkUI.ArkUI.Full 12148 * @crossplatform 12149 * @atomicservice 12150 * @since 15 12151 */ 12152 radius?: LengthMetrics | BorderRadiuses | LocalizedBorderRadiuses; 12153 12154 /** 12155 * Select a detent from detents property 12156 * 12157 * @type { ?(SheetSize | Length) } 12158 * @default detents[0] 12159 * @syscap SystemCapability.ArkUI.ArkUI.Full 12160 * @crossplatform 12161 * @atomicservice 12162 * @since 15 12163 */ 12164 detentSelection?: SheetSize | Length; 12165} 12166 12167/** 12168 * Component State Styles. 12169 * 12170 * @interface StateStyles 12171 * @syscap SystemCapability.ArkUI.ArkUI.Full 12172 * @since 8 12173 */ 12174/** 12175 * Component State Styles. 12176 * 12177 * @interface StateStyles 12178 * @syscap SystemCapability.ArkUI.ArkUI.Full 12179 * @form 12180 * @since 9 12181 */ 12182/** 12183 * Component State Styles. 12184 * 12185 * @interface StateStyles 12186 * @syscap SystemCapability.ArkUI.ArkUI.Full 12187 * @crossplatform 12188 * @form 12189 * @since 10 12190 */ 12191/** 12192 * Component State Styles. 12193 * 12194 * @interface StateStyles 12195 * @syscap SystemCapability.ArkUI.ArkUI.Full 12196 * @crossplatform 12197 * @form 12198 * @atomicservice 12199 * @since 11 12200 */ 12201declare interface StateStyles { 12202 /** 12203 * Defines normal state styles. 12204 * 12205 * @type { ?any } 12206 * @syscap SystemCapability.ArkUI.ArkUI.Full 12207 * @since 8 12208 */ 12209 /** 12210 * Defines normal state styles. 12211 * 12212 * @type { ?any } 12213 * @syscap SystemCapability.ArkUI.ArkUI.Full 12214 * @form 12215 * @since 9 12216 */ 12217 /** 12218 * Defines normal state styles. 12219 * 12220 * @type { ?any } 12221 * @syscap SystemCapability.ArkUI.ArkUI.Full 12222 * @crossplatform 12223 * @form 12224 * @since 10 12225 */ 12226 /** 12227 * Defines normal state styles. 12228 * 12229 * @type { ?any } 12230 * @syscap SystemCapability.ArkUI.ArkUI.Full 12231 * @crossplatform 12232 * @form 12233 * @atomicservice 12234 * @since 11 12235 */ 12236 normal?: any; 12237 12238 /** 12239 * Defines pressed state styles. 12240 * 12241 * @type { ?any } 12242 * @syscap SystemCapability.ArkUI.ArkUI.Full 12243 * @since 8 12244 */ 12245 /** 12246 * Defines pressed state styles. 12247 * 12248 * @type { ?any } 12249 * @syscap SystemCapability.ArkUI.ArkUI.Full 12250 * @form 12251 * @since 9 12252 */ 12253 /** 12254 * Defines pressed state styles. 12255 * 12256 * @type { ?any } 12257 * @syscap SystemCapability.ArkUI.ArkUI.Full 12258 * @crossplatform 12259 * @form 12260 * @since 10 12261 */ 12262 /** 12263 * Defines pressed state styles. 12264 * 12265 * @type { ?any } 12266 * @syscap SystemCapability.ArkUI.ArkUI.Full 12267 * @crossplatform 12268 * @form 12269 * @atomicservice 12270 * @since 11 12271 */ 12272 pressed?: any; 12273 12274 /** 12275 * Defines disabled state styles. 12276 * 12277 * @type { ?any } 12278 * @syscap SystemCapability.ArkUI.ArkUI.Full 12279 * @since 8 12280 */ 12281 /** 12282 * Defines disabled state styles. 12283 * 12284 * @type { ?any } 12285 * @syscap SystemCapability.ArkUI.ArkUI.Full 12286 * @form 12287 * @since 9 12288 */ 12289 /** 12290 * Defines disabled state styles. 12291 * 12292 * @type { ?any } 12293 * @syscap SystemCapability.ArkUI.ArkUI.Full 12294 * @crossplatform 12295 * @form 12296 * @since 10 12297 */ 12298 /** 12299 * Defines disabled state styles. 12300 * 12301 * @type { ?any } 12302 * @syscap SystemCapability.ArkUI.ArkUI.Full 12303 * @crossplatform 12304 * @form 12305 * @atomicservice 12306 * @since 11 12307 */ 12308 disabled?: any; 12309 12310 /** 12311 * Defines focused state styles. 12312 * 12313 * @type { ?any } 12314 * @syscap SystemCapability.ArkUI.ArkUI.Full 12315 * @since 8 12316 */ 12317 /** 12318 * Defines focused state styles. 12319 * 12320 * @type { ?any } 12321 * @syscap SystemCapability.ArkUI.ArkUI.Full 12322 * @form 12323 * @since 9 12324 */ 12325 /** 12326 * Defines focused state styles. 12327 * 12328 * @type { ?any } 12329 * @syscap SystemCapability.ArkUI.ArkUI.Full 12330 * @crossplatform 12331 * @form 12332 * @since 10 12333 */ 12334 /** 12335 * Defines focused state styles. 12336 * 12337 * @type { ?any } 12338 * @syscap SystemCapability.ArkUI.ArkUI.Full 12339 * @crossplatform 12340 * @form 12341 * @atomicservice 12342 * @since 11 12343 */ 12344 focused?: any; 12345 12346 /** 12347 * Defines clicked state styles. 12348 * 12349 * @type { ?any } 12350 * @syscap SystemCapability.ArkUI.ArkUI.Full 12351 * @since 8 12352 */ 12353 /** 12354 * Defines clicked state styles. 12355 * 12356 * @type { ?any } 12357 * @syscap SystemCapability.ArkUI.ArkUI.Full 12358 * @form 12359 * @since 9 12360 */ 12361 /** 12362 * Defines clicked state styles. 12363 * 12364 * @type { ?any } 12365 * @syscap SystemCapability.ArkUI.ArkUI.Full 12366 * @crossplatform 12367 * @form 12368 * @since 10 12369 */ 12370 /** 12371 * Defines clicked state styles. 12372 * 12373 * @type { ?any } 12374 * @syscap SystemCapability.ArkUI.ArkUI.Full 12375 * @crossplatform 12376 * @form 12377 * @atomicservice 12378 * @since 11 12379 */ 12380 clicked?: any; 12381 12382 /** 12383 * Defines selected state styles. 12384 * 12385 * @type { ?object } 12386 * @syscap SystemCapability.ArkUI.ArkUI.Full 12387 * @crossplatform 12388 * @form 12389 * @since 10 12390 */ 12391 /** 12392 * Defines selected state styles. 12393 * 12394 * @type { ?object } 12395 * @syscap SystemCapability.ArkUI.ArkUI.Full 12396 * @crossplatform 12397 * @form 12398 * @atomicservice 12399 * @since 11 12400 */ 12401 selected?: object; 12402} 12403 12404/** 12405 * Defines the options of popup message. 12406 * 12407 * @interface PopupMessageOptions 12408 * @syscap SystemCapability.ArkUI.ArkUI.Full 12409 * @crossplatform 12410 * @since 10 12411 */ 12412/** 12413 * Defines the options of popup message. 12414 * 12415 * @interface PopupMessageOptions 12416 * @syscap SystemCapability.ArkUI.ArkUI.Full 12417 * @crossplatform 12418 * @atomicservice 12419 * @since 11 12420 */ 12421declare interface PopupMessageOptions { 12422 /** 12423 * Sets the color of popup text. 12424 * 12425 * @type { ?ResourceColor } 12426 * @syscap SystemCapability.ArkUI.ArkUI.Full 12427 * @crossplatform 12428 * @since 10 12429 */ 12430 /** 12431 * Sets the color of popup text. 12432 * 12433 * @type { ?ResourceColor } 12434 * @syscap SystemCapability.ArkUI.ArkUI.Full 12435 * @crossplatform 12436 * @atomicservice 12437 * @since 11 12438 */ 12439 textColor?: ResourceColor; 12440 12441 /** 12442 * Sets the font of popup text. 12443 * 12444 * @type { ?Font } 12445 * @syscap SystemCapability.ArkUI.ArkUI.Full 12446 * @crossplatform 12447 * @since 10 12448 */ 12449 /** 12450 * Sets the font of popup text. 12451 * 12452 * @type { ?Font } 12453 * @syscap SystemCapability.ArkUI.ArkUI.Full 12454 * @crossplatform 12455 * @atomicservice 12456 * @since 11 12457 */ 12458 font?: Font; 12459} 12460 12461/** 12462 * Dismiss reason type. 12463 * 12464 * @enum { number } 12465 * @syscap SystemCapability.ArkUI.ArkUI.Full 12466 * @crossplatform 12467 * @atomicservice 12468 * @since 12 12469 */ 12470declare enum DismissReason { 12471 /** 12472 * Press back 12473 * 12474 * @syscap SystemCapability.ArkUI.ArkUI.Full 12475 * @crossplatform 12476 * @atomicservice 12477 * @since 12 12478 */ 12479 PRESS_BACK = 0, 12480 12481 /** 12482 * Touch component outside 12483 * 12484 * @syscap SystemCapability.ArkUI.ArkUI.Full 12485 * @crossplatform 12486 * @atomicservice 12487 * @since 12 12488 */ 12489 TOUCH_OUTSIDE = 1, 12490 12491 /** 12492 * Close button 12493 * 12494 * @syscap SystemCapability.ArkUI.ArkUI.Full 12495 * @crossplatform 12496 * @atomicservice 12497 * @since 12 12498 */ 12499 CLOSE_BUTTON = 2, 12500 12501 /** 12502 * Slide down 12503 * 12504 * @syscap SystemCapability.ArkUI.ArkUI.Full 12505 * @crossplatform 12506 * @atomicservice 12507 * @since 12 12508 */ 12509 SLIDE_DOWN = 3 12510} 12511 12512/** 12513 * Component popup dismiss 12514 * 12515 * @interface DismissPopupAction 12516 * @syscap SystemCapability.ArkUI.ArkUI.Full 12517 * @crossplatform 12518 * @atomicservice 12519 * @since 12 12520 */ 12521declare interface DismissPopupAction { 12522 /** 12523 * Defines popup dismiss function 12524 * 12525 * @type { Callback<void> } 12526 * @syscap SystemCapability.ArkUI.ArkUI.Full 12527 * @crossplatform 12528 * @atomicservice 12529 * @since 12 12530 */ 12531 dismiss: Callback<void>; 12532 12533 /** 12534 * Defines popup dismiss reason 12535 * 12536 * @type { DismissReason } 12537 * @syscap SystemCapability.ArkUI.ArkUI.Full 12538 * @crossplatform 12539 * @atomicservice 12540 * @since 12 12541 */ 12542 reason: DismissReason; 12543} 12544 12545/** 12546 * Defines the popup options. 12547 * 12548 * @interface PopupOptions 12549 * @syscap SystemCapability.ArkUI.ArkUI.Full 12550 * @since 7 12551 */ 12552/** 12553 * Defines the popup options. 12554 * 12555 * @interface PopupOptions 12556 * @syscap SystemCapability.ArkUI.ArkUI.Full 12557 * @crossplatform 12558 * @since 10 12559 */ 12560/** 12561 * Defines the popup options. 12562 * 12563 * @interface PopupOptions 12564 * @syscap SystemCapability.ArkUI.ArkUI.Full 12565 * @crossplatform 12566 * @atomicservice 12567 * @since 11 12568 */ 12569declare interface PopupOptions { 12570 /** 12571 * Information in the pop-up window. 12572 * 12573 * @type { string } 12574 * @syscap SystemCapability.ArkUI.ArkUI.Full 12575 * @since 7 12576 */ 12577 /** 12578 * Information in the pop-up window. 12579 * 12580 * @type { string } 12581 * @syscap SystemCapability.ArkUI.ArkUI.Full 12582 * @crossplatform 12583 * @since 10 12584 */ 12585 /** 12586 * Information in the pop-up window. 12587 * 12588 * @type { string } 12589 * @syscap SystemCapability.ArkUI.ArkUI.Full 12590 * @crossplatform 12591 * @atomicservice 12592 * @since 11 12593 */ 12594 message: string; 12595 12596 /** 12597 * placement On Top 12598 * 12599 * @type { ?boolean } 12600 * @syscap SystemCapability.ArkUI.ArkUI.Full 12601 * @since 7 12602 * @deprecated since 10 12603 * @useinstead PopupOptions#placement 12604 */ 12605 placementOnTop?: boolean; 12606 12607 /** 12608 * The placement of popup. 12609 * Supports all positions defined in Placement. 12610 * 12611 * @type { ?Placement } 12612 * @default Placement.Bottom 12613 * @syscap SystemCapability.ArkUI.ArkUI.Full 12614 * @crossplatform 12615 * @since 10 12616 */ 12617 /** 12618 * The placement of popup. 12619 * Supports all positions defined in Placement. 12620 * 12621 * @type { ?Placement } 12622 * @default Placement.Bottom 12623 * @syscap SystemCapability.ArkUI.ArkUI.Full 12624 * @crossplatform 12625 * @atomicservice 12626 * @since 11 12627 */ 12628 placement?: Placement; 12629 12630 /** 12631 * The first button. 12632 * 12633 * @type { ?object } 12634 * @syscap SystemCapability.ArkUI.ArkUI.Full 12635 * @since 7 12636 */ 12637 /** 12638 * The first button. 12639 * 12640 * @type { ?object } 12641 * @syscap SystemCapability.ArkUI.ArkUI.Full 12642 * @crossplatform 12643 * @since 10 12644 */ 12645 /** 12646 * The first button. 12647 * 12648 * @type { ?object } 12649 * @syscap SystemCapability.ArkUI.ArkUI.Full 12650 * @crossplatform 12651 * @atomicservice 12652 * @since 11 12653 */ 12654 primaryButton?: { 12655 /** 12656 * Button text value 12657 * 12658 * @type { string } 12659 * @syscap SystemCapability.ArkUI.ArkUI.Full 12660 * @since 7 12661 */ 12662 /** 12663 * Button text value 12664 * 12665 * @type { string } 12666 * @syscap SystemCapability.ArkUI.ArkUI.Full 12667 * @crossplatform 12668 * @since 10 12669 */ 12670 /** 12671 * Button text value 12672 * 12673 * @type { string } 12674 * @syscap SystemCapability.ArkUI.ArkUI.Full 12675 * @crossplatform 12676 * @atomicservice 12677 * @since 11 12678 */ 12679 value: string; 12680 12681 /** 12682 * action 12683 * 12684 * @type { function } 12685 * @syscap SystemCapability.ArkUI.ArkUI.Full 12686 * @since 7 12687 */ 12688 /** 12689 * action 12690 * 12691 * @type { function } 12692 * @syscap SystemCapability.ArkUI.ArkUI.Full 12693 * @crossplatform 12694 * @since 10 12695 */ 12696 /** 12697 * action 12698 * 12699 * @type { function } 12700 * @syscap SystemCapability.ArkUI.ArkUI.Full 12701 * @crossplatform 12702 * @atomicservice 12703 * @since 11 12704 */ 12705 action: () => void; 12706 }; 12707 12708 /** 12709 * The second button. 12710 * 12711 * @type { ?object } 12712 * @syscap SystemCapability.ArkUI.ArkUI.Full 12713 * @since 7 12714 */ 12715 /** 12716 * The second button. 12717 * 12718 * @type { ?object } 12719 * @syscap SystemCapability.ArkUI.ArkUI.Full 12720 * @crossplatform 12721 * @since 10 12722 */ 12723 /** 12724 * The second button. 12725 * 12726 * @type { ?object } 12727 * @syscap SystemCapability.ArkUI.ArkUI.Full 12728 * @crossplatform 12729 * @atomicservice 12730 * @since 11 12731 */ 12732 secondaryButton?: { 12733 /** 12734 * Button text value 12735 * 12736 * @type { string } 12737 * @syscap SystemCapability.ArkUI.ArkUI.Full 12738 * @since 7 12739 */ 12740 /** 12741 * Button text value 12742 * 12743 * @type { string } 12744 * @syscap SystemCapability.ArkUI.ArkUI.Full 12745 * @crossplatform 12746 * @since 10 12747 */ 12748 /** 12749 * Button text value 12750 * 12751 * @type { string } 12752 * @syscap SystemCapability.ArkUI.ArkUI.Full 12753 * @crossplatform 12754 * @atomicservice 12755 * @since 11 12756 */ 12757 value: string; 12758 12759 /** 12760 * action 12761 * 12762 * @type { function } 12763 * @syscap SystemCapability.ArkUI.ArkUI.Full 12764 * @since 7 12765 */ 12766 /** 12767 * action 12768 * 12769 * @type { function } 12770 * @syscap SystemCapability.ArkUI.ArkUI.Full 12771 * @crossplatform 12772 * @since 10 12773 */ 12774 /** 12775 * action 12776 * 12777 * @type { function } 12778 * @syscap SystemCapability.ArkUI.ArkUI.Full 12779 * @crossplatform 12780 * @atomicservice 12781 * @since 11 12782 */ 12783 action: () => void; 12784 }; 12785 12786 /** 12787 * on State Change 12788 * 12789 * @type { ?function } 12790 * @syscap SystemCapability.ArkUI.ArkUI.Full 12791 * @since 7 12792 */ 12793 /** 12794 * on State Change 12795 * 12796 * @type { ?function } 12797 * @syscap SystemCapability.ArkUI.ArkUI.Full 12798 * @crossplatform 12799 * @since 10 12800 */ 12801 /** 12802 * on State Change 12803 * 12804 * @type { ?function } 12805 * @syscap SystemCapability.ArkUI.ArkUI.Full 12806 * @crossplatform 12807 * @atomicservice 12808 * @since 11 12809 */ 12810 onStateChange?: (event: { 12811 /** 12812 * is Visible. 12813 * 12814 * @type { boolean } 12815 * @syscap SystemCapability.ArkUI.ArkUI.Full 12816 * @crossplatform 12817 * @since 10 12818 */ 12819 /** 12820 * is Visible. 12821 * 12822 * @type { boolean } 12823 * @syscap SystemCapability.ArkUI.ArkUI.Full 12824 * @crossplatform 12825 * @atomicservice 12826 * @since 11 12827 */ 12828 isVisible: boolean 12829 }) => void; 12830 12831 /** 12832 * The offset of the sharp corner of popup. 12833 * 12834 * @type { ?Length } 12835 * @syscap SystemCapability.ArkUI.ArkUI.Full 12836 * @since 9 12837 */ 12838 /** 12839 * The offset of the sharp corner of popup. 12840 * 12841 * @type { ?Length } 12842 * @syscap SystemCapability.ArkUI.ArkUI.Full 12843 * @crossplatform 12844 * @since 10 12845 */ 12846 /** 12847 * The offset of the sharp corner of popup. 12848 * 12849 * @type { ?Length } 12850 * @syscap SystemCapability.ArkUI.ArkUI.Full 12851 * @crossplatform 12852 * @atomicservice 12853 * @since 11 12854 */ 12855 arrowOffset?: Length; 12856 12857 /** 12858 * Whether to display in the sub window. 12859 * 12860 * @type { ?boolean } 12861 * @syscap SystemCapability.ArkUI.ArkUI.Full 12862 * @since 9 12863 */ 12864 /** 12865 * Whether to display in the sub window. 12866 * 12867 * @type { ?boolean } 12868 * @syscap SystemCapability.ArkUI.ArkUI.Full 12869 * @crossplatform 12870 * @since 10 12871 */ 12872 /** 12873 * Whether to display in the sub window. 12874 * 12875 * @type { ?boolean } 12876 * @syscap SystemCapability.ArkUI.ArkUI.Full 12877 * @crossplatform 12878 * @atomicservice 12879 * @since 11 12880 */ 12881 showInSubWindow?: boolean; 12882 12883 /** 12884 * The mask to block gesture events of popup. 12885 * When mask is set false, gesture events are not blocked. 12886 * When mask is set true, gesture events are blocked and mask color is transparent. 12887 * 12888 * @type { ?(boolean | { color: ResourceColor }) } 12889 * @syscap SystemCapability.ArkUI.ArkUI.Full 12890 * @crossplatform 12891 * @since 10 12892 */ 12893 /** 12894 * The mask to block gesture events of popup. 12895 * When mask is set false, gesture events are not blocked. 12896 * When mask is set true, gesture events are blocked and mask color is transparent. 12897 * 12898 * @type { ?(boolean | { color: ResourceColor }) } 12899 * @syscap SystemCapability.ArkUI.ArkUI.Full 12900 * @crossplatform 12901 * @atomicservice 12902 * @since 11 12903 */ 12904 mask?: boolean | { color: ResourceColor }; 12905 12906 /** 12907 * Sets the options of popup message. 12908 * 12909 * @type { ?PopupMessageOptions } 12910 * @syscap SystemCapability.ArkUI.ArkUI.Full 12911 * @crossplatform 12912 * @since 10 12913 */ 12914 /** 12915 * Sets the options of popup message. 12916 * 12917 * @type { ?PopupMessageOptions } 12918 * @syscap SystemCapability.ArkUI.ArkUI.Full 12919 * @crossplatform 12920 * @atomicservice 12921 * @since 11 12922 */ 12923 messageOptions?: PopupMessageOptions 12924 12925 /** 12926 * Sets the space of between the popup and target. 12927 * 12928 * @type { ?Length } 12929 * @syscap SystemCapability.ArkUI.ArkUI.Full 12930 * @crossplatform 12931 * @since 10 12932 */ 12933 /** 12934 * Sets the space of between the popup and target. 12935 * 12936 * @type { ?Length } 12937 * @syscap SystemCapability.ArkUI.ArkUI.Full 12938 * @crossplatform 12939 * @atomicservice 12940 * @since 11 12941 */ 12942 targetSpace?: Length 12943 12944 /** 12945 * whether show arrow 12946 * 12947 * @type { ?boolean } 12948 * @default true 12949 * @syscap SystemCapability.ArkUI.ArkUI.Full 12950 * @since 10 12951 */ 12952 /** 12953 * whether show arrow 12954 * 12955 * @type { ?boolean } 12956 * @default true 12957 * @syscap SystemCapability.ArkUI.ArkUI.Full 12958 * @crossplatform 12959 * @atomicservice 12960 * @since 11 12961 */ 12962 enableArrow?: boolean; 12963 /** 12964 * Sets the position offset of the popup. 12965 * 12966 * @type { ?Position } 12967 * @syscap SystemCapability.ArkUI.ArkUI.Full 12968 * @crossplatform 12969 * @since 10 12970 */ 12971 /** 12972 * Sets the position offset of the popup. 12973 * 12974 * @type { ?Position } 12975 * @syscap SystemCapability.ArkUI.ArkUI.Full 12976 * @crossplatform 12977 * @atomicservice 12978 * @since 11 12979 */ 12980 offset?: Position 12981 12982 /** 12983 * Set the background color of the popup. 12984 * 12985 * @type { ?(Color | string | Resource | number) } 12986 * @syscap SystemCapability.ArkUI.ArkUI.Full 12987 * @crossplatform 12988 * @since 11 12989 */ 12990 /** 12991 * Set the background color of the popup. 12992 * 12993 * @type { ?(Color | string | Resource | number) } 12994 * @syscap SystemCapability.ArkUI.ArkUI.Full 12995 * @crossplatform 12996 * @atomicservice 12997 * @since 12 12998 */ 12999 popupColor?: Color | string | Resource | number; 13000 13001 /** 13002 * Whether hide popup when click mask 13003 * 13004 * @type { ?boolean } 13005 * @default true 13006 * @syscap SystemCapability.ArkUI.ArkUI.Full 13007 * @crossplatform 13008 * @since 11 13009 */ 13010 /** 13011 * Whether hide popup when click mask 13012 * 13013 * @type { ?boolean } 13014 * @default true 13015 * @syscap SystemCapability.ArkUI.ArkUI.Full 13016 * @crossplatform 13017 * @atomicservice 13018 * @since 12 13019 */ 13020 autoCancel?: boolean; 13021 13022 /** 13023 * Set the width of the popup. 13024 * 13025 * @type { ?Dimension } 13026 * @syscap SystemCapability.ArkUI.ArkUI.Full 13027 * @crossplatform 13028 * @since 11 13029 */ 13030 /** 13031 * Set the width of the popup. 13032 * 13033 * @type { ?Dimension } 13034 * @syscap SystemCapability.ArkUI.ArkUI.Full 13035 * @crossplatform 13036 * @atomicservice 13037 * @since 12 13038 */ 13039 width?: Dimension; 13040 13041 /** 13042 * The position of the sharp corner of popup. 13043 * 13044 * @type { ?ArrowPointPosition } 13045 * @syscap SystemCapability.ArkUI.ArkUI.Full 13046 * @crossplatform 13047 * @since 11 13048 */ 13049 /** 13050 * The position of the sharp corner of popup. 13051 * 13052 * @type { ?ArrowPointPosition } 13053 * @syscap SystemCapability.ArkUI.ArkUI.Full 13054 * @crossplatform 13055 * @atomicservice 13056 * @since 12 13057 */ 13058 arrowPointPosition?: ArrowPointPosition; 13059 13060 /** 13061 * The width of the arrow. 13062 * 13063 * @type { ?Dimension } 13064 * @default 16.0_vp. 13065 * @syscap SystemCapability.ArkUI.ArkUI.Full 13066 * @crossplatform 13067 * @since 11 13068 */ 13069 /** 13070 * The width of the arrow. 13071 * 13072 * @type { ?Dimension } 13073 * @default 16.0_vp. 13074 * @syscap SystemCapability.ArkUI.ArkUI.Full 13075 * @crossplatform 13076 * @atomicservice 13077 * @since 12 13078 */ 13079 arrowWidth?: Dimension; 13080 13081 /** 13082 * The height of the arrow. 13083 * 13084 * @type { ?Dimension } 13085 * @default 8.0_vp. 13086 * @syscap SystemCapability.ArkUI.ArkUI.Full 13087 * @crossplatform 13088 * @since 11 13089 */ 13090 /** 13091 * The height of the arrow. 13092 * 13093 * @type { ?Dimension } 13094 * @default 8.0_vp. 13095 * @syscap SystemCapability.ArkUI.ArkUI.Full 13096 * @crossplatform 13097 * @atomicservice 13098 * @since 12 13099 */ 13100 arrowHeight?: Dimension; 13101 13102 /** 13103 * The round corners of the popup. 13104 * 13105 * @type { ?Dimension } 13106 * @default 20.0_vp. 13107 * @syscap SystemCapability.ArkUI.ArkUI.Full 13108 * @crossplatform 13109 * @since 11 13110 */ 13111 /** 13112 * The round corners of the popup. 13113 * 13114 * @type { ?Dimension } 13115 * @default 20.0_vp. 13116 * @syscap SystemCapability.ArkUI.ArkUI.Full 13117 * @crossplatform 13118 * @atomicservice 13119 * @since 12 13120 */ 13121 radius?: Dimension; 13122 13123 /** 13124 * The style of popup Shadow. 13125 * 13126 * @type { ?(ShadowOptions | ShadowStyle) } 13127 * @default ShadowStyle.OUTER_DEFAULT_MD. 13128 * @syscap SystemCapability.ArkUI.ArkUI.Full 13129 * @crossplatform 13130 * @since 11 13131 */ 13132 /** 13133 * The style of popup Shadow. 13134 * 13135 * @type { ?(ShadowOptions | ShadowStyle) } 13136 * @default ShadowStyle.OUTER_DEFAULT_MD. 13137 * @syscap SystemCapability.ArkUI.ArkUI.Full 13138 * @crossplatform 13139 * @atomicservice 13140 * @since 12 13141 */ 13142 shadow?: ShadowOptions | ShadowStyle; 13143 13144 /** 13145 * Defines popup background blur Style 13146 * 13147 * @type { ?BlurStyle } 13148 * @default BlurStyle.COMPONENT_ULTRA_THICK 13149 * @syscap SystemCapability.ArkUI.ArkUI.Full 13150 * @crossplatform 13151 * @since 11 13152 */ 13153 /** 13154 * Defines popup background blur Style 13155 * 13156 * @type { ?BlurStyle } 13157 * @default BlurStyle.COMPONENT_ULTRA_THICK 13158 * @syscap SystemCapability.ArkUI.ArkUI.Full 13159 * @crossplatform 13160 * @atomicservice 13161 * @since 12 13162 */ 13163 backgroundBlurStyle?: BlurStyle; 13164 13165 /** 13166 * Defines the transition effect of popup opening and closing 13167 * 13168 * @type { ?TransitionEffect } 13169 * @syscap SystemCapability.ArkUI.ArkUI.Full 13170 * @crossplatform 13171 * @atomicservice 13172 * @since 12 13173 */ 13174 transition?: TransitionEffect; 13175 13176 /** 13177 * Callback function when the popup interactive dismiss 13178 * 13179 * @type { ?(boolean | Callback<DismissPopupAction>) } 13180 * @syscap SystemCapability.ArkUI.ArkUI.Full 13181 * @crossplatform 13182 * @atomicservice 13183 * @since 12 13184 */ 13185 onWillDismiss?: boolean | Callback<DismissPopupAction>; 13186 13187 /** 13188 * Determine if popup can follow the target node when it has rotation or scale. 13189 * 13190 * @type { ?boolean } 13191 * @default false 13192 * @syscap SystemCapability.ArkUI.ArkUI.Full 13193 * @crossplatform 13194 * @atomicservice 13195 * @since 13 13196 */ 13197 followTransformOfTarget?: boolean; 13198 13199 /** 13200 * Define the popup avoid keyboard mode. 13201 * 13202 * @type { ?KeyboardAvoidMode } 13203 * @default KeyboardAvoidMode.NONE 13204 * @syscap SystemCapability.ArkUI.ArkUI.Full 13205 * @crossplatform 13206 * @atomicservice 13207 * @since 15 13208 */ 13209 keyboardAvoidMode?: KeyboardAvoidMode; 13210} 13211 13212/** 13213 * Defines the custom popup options. 13214 * 13215 * @interface CustomPopupOptions 13216 * @syscap SystemCapability.ArkUI.ArkUI.Full 13217 * @since 8 13218 */ 13219/** 13220 * Defines the custom popup options. 13221 * 13222 * @interface CustomPopupOptions 13223 * @syscap SystemCapability.ArkUI.ArkUI.Full 13224 * @crossplatform 13225 * @since 10 13226 */ 13227/** 13228 * Defines the custom popup options. 13229 * 13230 * @interface CustomPopupOptions 13231 * @syscap SystemCapability.ArkUI.ArkUI.Full 13232 * @crossplatform 13233 * @atomicservice 13234 * @since 11 13235 */ 13236declare interface CustomPopupOptions { 13237 /** 13238 * builder of popup 13239 * 13240 * @type { CustomBuilder } 13241 * @syscap SystemCapability.ArkUI.ArkUI.Full 13242 * @since 8 13243 */ 13244 /** 13245 * builder of popup 13246 * 13247 * @type { CustomBuilder } 13248 * @syscap SystemCapability.ArkUI.ArkUI.Full 13249 * @crossplatform 13250 * @since 10 13251 */ 13252 /** 13253 * builder of popup 13254 * 13255 * @type { CustomBuilder } 13256 * @syscap SystemCapability.ArkUI.ArkUI.Full 13257 * @crossplatform 13258 * @atomicservice 13259 * @since 11 13260 */ 13261 builder: CustomBuilder; 13262 13263 /** 13264 * placement of popup 13265 * 13266 * @type { ?Placement } 13267 * @syscap SystemCapability.ArkUI.ArkUI.Full 13268 * @since 8 13269 */ 13270 /** 13271 * placement of popup 13272 * 13273 * @type { ?Placement } 13274 * @syscap SystemCapability.ArkUI.ArkUI.Full 13275 * @crossplatform 13276 * @since 10 13277 */ 13278 /** 13279 * placement of popup 13280 * 13281 * @type { ?Placement } 13282 * @syscap SystemCapability.ArkUI.ArkUI.Full 13283 * @crossplatform 13284 * @atomicservice 13285 * @since 11 13286 */ 13287 placement?: Placement; 13288 13289 /** 13290 * mask color of popup 13291 * 13292 * @type { ?(Color | string | Resource | number) } 13293 * @syscap SystemCapability.ArkUI.ArkUI.Full 13294 * @since 8 13295 * @deprecated since 10 13296 * @useinstead CustomPopupOptions#mask 13297 */ 13298 maskColor?: Color | string | Resource | number; 13299 13300 /** 13301 * background color of popup 13302 * 13303 * @type { ?(Color | string | Resource | number) } 13304 * @syscap SystemCapability.ArkUI.ArkUI.Full 13305 * @since 8 13306 */ 13307 /** 13308 * background color of popup 13309 * 13310 * @type { ?(Color | string | Resource | number) } 13311 * @syscap SystemCapability.ArkUI.ArkUI.Full 13312 * @crossplatform 13313 * @since 10 13314 */ 13315 /** 13316 * background color of popup 13317 * 13318 * @type { ?(Color | string | Resource | number) } 13319 * @syscap SystemCapability.ArkUI.ArkUI.Full 13320 * @crossplatform 13321 * @atomicservice 13322 * @since 11 13323 */ 13324 popupColor?: Color | string | Resource | number; 13325 13326 /** 13327 * whether show arrow 13328 * 13329 * @type { ?boolean } 13330 * @syscap SystemCapability.ArkUI.ArkUI.Full 13331 * @since 8 13332 */ 13333 /** 13334 * whether show arrow 13335 * 13336 * @type { ?boolean } 13337 * @syscap SystemCapability.ArkUI.ArkUI.Full 13338 * @crossplatform 13339 * @since 10 13340 */ 13341 /** 13342 * whether show arrow 13343 * 13344 * @type { ?boolean } 13345 * @syscap SystemCapability.ArkUI.ArkUI.Full 13346 * @crossplatform 13347 * @atomicservice 13348 * @since 11 13349 */ 13350 enableArrow?: boolean; 13351 13352 /** 13353 * whether hide popup when click mask 13354 * 13355 * @type { ?boolean } 13356 * @syscap SystemCapability.ArkUI.ArkUI.Full 13357 * @since 8 13358 */ 13359 /** 13360 * whether hide popup when click mask 13361 * 13362 * @type { ?boolean } 13363 * @syscap SystemCapability.ArkUI.ArkUI.Full 13364 * @crossplatform 13365 * @since 10 13366 */ 13367 /** 13368 * whether hide popup when click mask 13369 * 13370 * @type { ?boolean } 13371 * @syscap SystemCapability.ArkUI.ArkUI.Full 13372 * @crossplatform 13373 * @atomicservice 13374 * @since 11 13375 */ 13376 autoCancel?: boolean; 13377 13378 /** 13379 * on State Change 13380 * 13381 * @type { ?function } 13382 * @syscap SystemCapability.ArkUI.ArkUI.Full 13383 * @since 8 13384 */ 13385 /** 13386 * on State Change 13387 * 13388 * @type { ?function } 13389 * @syscap SystemCapability.ArkUI.ArkUI.Full 13390 * @crossplatform 13391 * @since 10 13392 */ 13393 /** 13394 * on State Change 13395 * 13396 * @type { ?function } 13397 * @syscap SystemCapability.ArkUI.ArkUI.Full 13398 * @crossplatform 13399 * @atomicservice 13400 * @since 11 13401 */ 13402 onStateChange?: (event: { 13403 /** 13404 * is Visible. 13405 * 13406 * @type { boolean } 13407 * @syscap SystemCapability.ArkUI.ArkUI.Full 13408 * @crossplatform 13409 * @since 10 13410 */ 13411 /** 13412 * is Visible. 13413 * 13414 * @type { boolean } 13415 * @syscap SystemCapability.ArkUI.ArkUI.Full 13416 * @crossplatform 13417 * @atomicservice 13418 * @since 11 13419 */ 13420 isVisible: boolean 13421 }) => void; 13422 13423 /** 13424 * The offset of the sharp corner of popup. 13425 * 13426 * @type { ?Length } 13427 * @syscap SystemCapability.ArkUI.ArkUI.Full 13428 * @since 9 13429 */ 13430 /** 13431 * The offset of the sharp corner of popup. 13432 * 13433 * @type { ?Length } 13434 * @syscap SystemCapability.ArkUI.ArkUI.Full 13435 * @crossplatform 13436 * @since 10 13437 */ 13438 /** 13439 * The offset of the sharp corner of popup. 13440 * 13441 * @type { ?Length } 13442 * @syscap SystemCapability.ArkUI.ArkUI.Full 13443 * @crossplatform 13444 * @atomicservice 13445 * @since 11 13446 */ 13447 arrowOffset?: Length; 13448 13449 /** 13450 * Whether to display in the sub window. 13451 * 13452 * @type { ?boolean } 13453 * @syscap SystemCapability.ArkUI.ArkUI.Full 13454 * @since 9 13455 */ 13456 /** 13457 * Whether to display in the sub window. 13458 * 13459 * @type { ?boolean } 13460 * @syscap SystemCapability.ArkUI.ArkUI.Full 13461 * @crossplatform 13462 * @since 10 13463 */ 13464 /** 13465 * Whether to display in the sub window. 13466 * 13467 * @type { ?boolean } 13468 * @syscap SystemCapability.ArkUI.ArkUI.Full 13469 * @crossplatform 13470 * @atomicservice 13471 * @since 11 13472 */ 13473 showInSubWindow?: boolean; 13474 13475 /** 13476 * The mask to block gesture events of popup. 13477 * When mask is set false, gesture events are not blocked. 13478 * When mask is set true, gesture events are blocked and mask color is transparent. 13479 * 13480 * @type { ?(boolean | { color: ResourceColor }) } 13481 * @syscap SystemCapability.ArkUI.ArkUI.Full 13482 * @crossplatform 13483 * @since 10 13484 */ 13485 /** 13486 * The mask to block gesture events of popup. 13487 * When mask is set false, gesture events are not blocked. 13488 * When mask is set true, gesture events are blocked and mask color is transparent. 13489 * 13490 * @type { ?(boolean | { color: ResourceColor }) } 13491 * @syscap SystemCapability.ArkUI.ArkUI.Full 13492 * @crossplatform 13493 * @atomicservice 13494 * @since 11 13495 */ 13496 mask?: boolean | { color: ResourceColor }; 13497 13498 /** 13499 * Sets the space of between the popup and target. 13500 * 13501 * @type { ?Length } 13502 * @syscap SystemCapability.ArkUI.ArkUI.Full 13503 * @crossplatform 13504 * @since 10 13505 */ 13506 /** 13507 * Sets the space of between the popup and target. 13508 * 13509 * @type { ?Length } 13510 * @syscap SystemCapability.ArkUI.ArkUI.Full 13511 * @crossplatform 13512 * @atomicservice 13513 * @since 11 13514 */ 13515 targetSpace?: Length 13516 13517 /** 13518 * Sets the position offset of the popup. 13519 * 13520 * @type { ?Position } 13521 * @syscap SystemCapability.ArkUI.ArkUI.Full 13522 * @crossplatform 13523 * @since 10 13524 */ 13525 /** 13526 * Sets the position offset of the popup. 13527 * 13528 * @type { ?Position } 13529 * @syscap SystemCapability.ArkUI.ArkUI.Full 13530 * @crossplatform 13531 * @atomicservice 13532 * @since 11 13533 */ 13534 offset?: Position 13535 13536 /** 13537 * Set the width of the popup. 13538 * 13539 * @type { ?Dimension } 13540 * @syscap SystemCapability.ArkUI.ArkUI.Full 13541 * @crossplatform 13542 * @since 11 13543 */ 13544 /** 13545 * Set the width of the popup. 13546 * 13547 * @type { ?Dimension } 13548 * @syscap SystemCapability.ArkUI.ArkUI.Full 13549 * @crossplatform 13550 * @atomicservice 13551 * @since 12 13552 */ 13553 width?: Dimension; 13554 13555 /** 13556 * The position of the sharp corner of popup. 13557 * 13558 * @type { ?ArrowPointPosition } 13559 * @syscap SystemCapability.ArkUI.ArkUI.Full 13560 * @crossplatform 13561 * @since 11 13562 */ 13563 /** 13564 * The position of the sharp corner of popup. 13565 * 13566 * @type { ?ArrowPointPosition } 13567 * @syscap SystemCapability.ArkUI.ArkUI.Full 13568 * @crossplatform 13569 * @atomicservice 13570 * @since 12 13571 */ 13572 arrowPointPosition?: ArrowPointPosition; 13573 13574 /** 13575 * The width of the arrow. 13576 * 13577 * @type { ?Dimension } 13578 * @default 16.0_vp. 13579 * @syscap SystemCapability.ArkUI.ArkUI.Full 13580 * @crossplatform 13581 * @since 11 13582 */ 13583 /** 13584 * The width of the arrow. 13585 * 13586 * @type { ?Dimension } 13587 * @default 16.0_vp. 13588 * @syscap SystemCapability.ArkUI.ArkUI.Full 13589 * @crossplatform 13590 * @atomicservice 13591 * @since 12 13592 */ 13593 arrowWidth?: Dimension; 13594 13595 /** 13596 * The height of the arrow. 13597 * 13598 * @type { ?Dimension } 13599 * @default 8.0_vp. 13600 * @syscap SystemCapability.ArkUI.ArkUI.Full 13601 * @crossplatform 13602 * @since 11 13603 */ 13604 /** 13605 * The height of the arrow. 13606 * 13607 * @type { ?Dimension } 13608 * @default 8.0_vp. 13609 * @syscap SystemCapability.ArkUI.ArkUI.Full 13610 * @crossplatform 13611 * @atomicservice 13612 * @since 12 13613 */ 13614 arrowHeight?: Dimension; 13615 13616 /** 13617 * The round corners of the popup. 13618 * 13619 * @type { ?Dimension } 13620 * @default 20.0_vp. 13621 * @syscap SystemCapability.ArkUI.ArkUI.Full 13622 * @crossplatform 13623 * @since 11 13624 */ 13625 /** 13626 * The round corners of the popup. 13627 * 13628 * @type { ?Dimension } 13629 * @default 20.0_vp. 13630 * @syscap SystemCapability.ArkUI.ArkUI.Full 13631 * @crossplatform 13632 * @atomicservice 13633 * @since 12 13634 */ 13635 radius?: Dimension; 13636 13637 /** 13638 * The style of popup Shadow. 13639 * 13640 * @type { ?(ShadowOptions | ShadowStyle) } 13641 * @default ShadowStyle.OUTER_DEFAULT_MD. 13642 * @syscap SystemCapability.ArkUI.ArkUI.Full 13643 * @crossplatform 13644 * @since 11 13645 */ 13646 /** 13647 * The style of popup Shadow. 13648 * 13649 * @type { ?(ShadowOptions | ShadowStyle) } 13650 * @default ShadowStyle.OUTER_DEFAULT_MD. 13651 * @syscap SystemCapability.ArkUI.ArkUI.Full 13652 * @crossplatform 13653 * @atomicservice 13654 * @since 12 13655 */ 13656 shadow?: ShadowOptions | ShadowStyle; 13657 13658 /** 13659 * Defines popup background blur Style 13660 * 13661 * @type { ?BlurStyle } 13662 * @default BlurStyle.COMPONENT_ULTRA_THICK 13663 * @syscap SystemCapability.ArkUI.ArkUI.Full 13664 * @crossplatform 13665 * @since 11 13666 */ 13667 /** 13668 * Defines popup background blur Style 13669 * 13670 * @type { ?BlurStyle } 13671 * @default BlurStyle.COMPONENT_ULTRA_THICK 13672 * @syscap SystemCapability.ArkUI.ArkUI.Full 13673 * @crossplatform 13674 * @atomicservice 13675 * @since 12 13676 */ 13677 backgroundBlurStyle?: BlurStyle; 13678 13679 /** 13680 * Set popup focusable 13681 * 13682 * @type { ?boolean } 13683 * @default true 13684 * @syscap SystemCapability.ArkUI.ArkUI.Full 13685 * @crossplatform 13686 * @since 11 13687 */ 13688 /** 13689 * Set popup focusable 13690 * 13691 * @type { ?boolean } 13692 * @default true 13693 * @syscap SystemCapability.ArkUI.ArkUI.Full 13694 * @crossplatform 13695 * @atomicservice 13696 * @since 12 13697 */ 13698 focusable?: boolean; 13699 13700 /** 13701 * Defines the transition effect of popup opening and closing 13702 * 13703 * @type { ?TransitionEffect } 13704 * @syscap SystemCapability.ArkUI.ArkUI.Full 13705 * @crossplatform 13706 * @atomicservice 13707 * @since 12 13708 */ 13709 transition?: TransitionEffect; 13710 13711 /** 13712 * Callback function when the popup interactive dismiss 13713 * 13714 * @type { ?(boolean | Callback<DismissPopupAction>) } 13715 * @syscap SystemCapability.ArkUI.ArkUI.Full 13716 * @crossplatform 13717 * @atomicservice 13718 * @since 12 13719 */ 13720 onWillDismiss?: boolean | Callback<DismissPopupAction>; 13721 13722 /** 13723 * Determine if popup can follow the target node when it has rotation or scale. 13724 * 13725 * @type { ?boolean } 13726 * @default false 13727 * @syscap SystemCapability.ArkUI.ArkUI.Full 13728 * @crossplatform 13729 * @atomicservice 13730 * @since 13 13731 */ 13732 followTransformOfTarget?: boolean; 13733 13734 /** 13735 * Define the popup avoid keyboard mode. 13736 * 13737 * @type { ?KeyboardAvoidMode } 13738 * @default KeyboardAvoidMode.NONE 13739 * @syscap SystemCapability.ArkUI.ArkUI.Full 13740 * @crossplatform 13741 * @atomicservice 13742 * @since 15 13743 */ 13744 keyboardAvoidMode?: KeyboardAvoidMode; 13745} 13746 13747/** 13748 * Defines the menu preview mode. 13749 * 13750 * @enum { number } 13751 * @syscap SystemCapability.ArkUI.ArkUI.Full 13752 * @crossplatform 13753 * @since 11 13754 */ 13755/** 13756 * Defines the menu preview mode. 13757 * 13758 * @enum { number } 13759 * @syscap SystemCapability.ArkUI.ArkUI.Full 13760 * @crossplatform 13761 * @atomicservice 13762 * @since 12 13763 */ 13764declare enum MenuPreviewMode { 13765 /** 13766 * No preview content. 13767 * 13768 * @syscap SystemCapability.ArkUI.ArkUI.Full 13769 * @crossplatform 13770 * @since 11 13771 */ 13772 /** 13773 * No preview content. 13774 * 13775 * @syscap SystemCapability.ArkUI.ArkUI.Full 13776 * @crossplatform 13777 * @atomicservice 13778 * @since 12 13779 */ 13780 NONE = 0, 13781 /** 13782 * Defines image type preview content. 13783 * 13784 * @syscap SystemCapability.ArkUI.ArkUI.Full 13785 * @crossplatform 13786 * @since 11 13787 */ 13788 /** 13789 * Defines image type preview content. 13790 * 13791 * @syscap SystemCapability.ArkUI.ArkUI.Full 13792 * @crossplatform 13793 * @atomicservice 13794 * @since 12 13795 */ 13796 IMAGE = 1 13797} 13798 13799/** 13800 * Defines the animator range of start and end property. 13801 * 13802 * @typedef { [from: T, to: T] } AnimationRange<T> 13803 * @syscap SystemCapability.ArkUI.ArkUI.Full 13804 * @crossplatform 13805 * @since 11 13806 */ 13807/** 13808 * Defines the animator range of start and end property. 13809 * 13810 * @typedef { [from: T, to: T] } AnimationRange<T> 13811 * @syscap SystemCapability.ArkUI.ArkUI.Full 13812 * @crossplatform 13813 * @atomicservice 13814 * @since 12 13815 */ 13816declare type AnimationRange<T> = [from: T, to: T]; 13817 13818/** 13819 * Defines the ContextMenu's preview animator options. 13820 * 13821 * @interface ContextMenuAnimationOptions 13822 * @syscap SystemCapability.ArkUI.ArkUI.Full 13823 * @crossplatform 13824 * @since 11 13825 */ 13826/** 13827 * Defines the ContextMenu's preview animator options. 13828 * 13829 * @interface ContextMenuAnimationOptions 13830 * @syscap SystemCapability.ArkUI.ArkUI.Full 13831 * @crossplatform 13832 * @atomicservice 13833 * @since 12 13834 */ 13835interface ContextMenuAnimationOptions { 13836 /** 13837 * Sets the start animator scale and end animator scale. 13838 * 13839 * @type { ?AnimationRange<number> } 13840 * @default - 13841 * @syscap SystemCapability.ArkUI.ArkUI.Full 13842 * @crossplatform 13843 * @since 11 13844 */ 13845 /** 13846 * Sets the start animator scale and end animator scale. 13847 * 13848 * @type { ?AnimationRange<number> } 13849 * @default - 13850 * @syscap SystemCapability.ArkUI.ArkUI.Full 13851 * @crossplatform 13852 * @atomicservice 13853 * @since 12 13854 */ 13855 scale?: AnimationRange<number>; 13856 /** 13857 * Defines the transition effect of menu preview opening and closing. 13858 * 13859 * @type { ?TransitionEffect } 13860 * @syscap SystemCapability.ArkUI.ArkUI.Full 13861 * @crossplatform 13862 * @atomicservice 13863 * @since 12 13864 */ 13865 transition?: TransitionEffect; 13866 13867 /** 13868 * Sets the scale start and end animator of the image displayed before the custom builder preview is displayed. 13869 * 13870 * @type { ?AnimationRange<number> } 13871 * @syscap SystemCapability.ArkUI.ArkUI.Full 13872 * @crossplatform 13873 * @atomicservice 13874 * @since 12 13875 */ 13876 hoverScale?: AnimationRange<number>; 13877} 13878 13879/** 13880 * Defines the context menu options. 13881 * 13882 * @interface ContextMenuOptions 13883 * @syscap SystemCapability.ArkUI.ArkUI.Full 13884 * @crossplatform 13885 * @since 10 13886 */ 13887/** 13888 * Defines the context menu options. 13889 * 13890 * @interface ContextMenuOptions 13891 * @syscap SystemCapability.ArkUI.ArkUI.Full 13892 * @crossplatform 13893 * @atomicservice 13894 * @since 11 13895 */ 13896declare interface ContextMenuOptions { 13897 /** 13898 * Sets the position offset of the context menu window. 13899 * 13900 * @type { ?Position } 13901 * @default - 13902 * @syscap SystemCapability.ArkUI.ArkUI.Full 13903 * @crossplatform 13904 * @since 10 13905 */ 13906 /** 13907 * Sets the position offset of the context menu window. 13908 * 13909 * @type { ?Position } 13910 * @default - 13911 * @syscap SystemCapability.ArkUI.ArkUI.Full 13912 * @crossplatform 13913 * @atomicservice 13914 * @since 11 13915 */ 13916 offset?: Position; 13917 13918 /** 13919 * Sets the placement of the context menu window. 13920 * 13921 * @type { ?Placement } 13922 * @default - 13923 * @syscap SystemCapability.ArkUI.ArkUI.Full 13924 * @crossplatform 13925 * @since 10 13926 */ 13927 /** 13928 * Sets the placement of the context menu window. 13929 * 13930 * @type { ?Placement } 13931 * @default - 13932 * @syscap SystemCapability.ArkUI.ArkUI.Full 13933 * @crossplatform 13934 * @atomicservice 13935 * @since 11 13936 */ 13937 placement?: Placement; 13938 13939 /** 13940 * whether show arrow belong to the menu, default: false, not show arrow 13941 * 13942 * @type { ?boolean } 13943 * @default false 13944 * @syscap SystemCapability.ArkUI.ArkUI.Full 13945 * @since 10 13946 */ 13947 /** 13948 * whether show arrow belong to the menu, default: false, not show arrow 13949 * 13950 * @type { ?boolean } 13951 * @default false 13952 * @syscap SystemCapability.ArkUI.ArkUI.Full 13953 * @crossplatform 13954 * @atomicservice 13955 * @since 11 13956 */ 13957 enableArrow?: boolean; 13958 13959 /** 13960 * The horizontal offset to the left of menu or vertical offset to the top of menu 13961 * 13962 * @type { ?Length } 13963 * @default 0 13964 * @syscap SystemCapability.ArkUI.ArkUI.Full 13965 * @since 10 13966 */ 13967 /** 13968 * The horizontal offset to the left of menu or vertical offset to the top of menu 13969 * 13970 * @type { ?Length } 13971 * @default 0 13972 * @syscap SystemCapability.ArkUI.ArkUI.Full 13973 * @crossplatform 13974 * @atomicservice 13975 * @since 11 13976 */ 13977 arrowOffset?: Length; 13978 13979 /** 13980 * The preview content of context menu. 13981 * 13982 * @type { ?(MenuPreviewMode | CustomBuilder) } 13983 * @default MenuPreviewMode.NONE 13984 * @syscap SystemCapability.ArkUI.ArkUI.Full 13985 * @crossplatform 13986 * @since 11 13987 */ 13988 /** 13989 * The preview content of context menu. 13990 * 13991 * @type { ?(MenuPreviewMode | CustomBuilder) } 13992 * @default MenuPreviewMode.NONE 13993 * @syscap SystemCapability.ArkUI.ArkUI.Full 13994 * @crossplatform 13995 * @atomicservice 13996 * @since 12 13997 */ 13998 preview?: MenuPreviewMode | CustomBuilder; 13999 14000 /** 14001 * Defines the border radius of menu. 14002 * 14003 * @type { ?(Length | BorderRadiuses | LocalizedBorderRadiuses) } 14004 * @syscap SystemCapability.ArkUI.ArkUI.Full 14005 * @crossplatform 14006 * @atomicservice 14007 * @since 12 14008 */ 14009 borderRadius?: Length | BorderRadiuses | LocalizedBorderRadiuses; 14010 14011 /** 14012 * Callback function when the context menu appears. 14013 * 14014 * @type { ?function } 14015 * @syscap SystemCapability.ArkUI.ArkUI.Full 14016 * @crossplatform 14017 * @since 10 14018 */ 14019 /** 14020 * Callback function when the context menu appears. 14021 * 14022 * @type { ?function } 14023 * @syscap SystemCapability.ArkUI.ArkUI.Full 14024 * @crossplatform 14025 * @atomicservice 14026 * @since 11 14027 */ 14028 onAppear?: () => void; 14029 14030 /** 14031 * Callback function when the context menu disappear. 14032 * 14033 * @type { ?function } 14034 * @syscap SystemCapability.ArkUI.ArkUI.Full 14035 * @crossplatform 14036 * @since 10 14037 */ 14038 /** 14039 * Callback function when the context menu disappear. 14040 * 14041 * @type { ?function } 14042 * @syscap SystemCapability.ArkUI.ArkUI.Full 14043 * @crossplatform 14044 * @atomicservice 14045 * @since 11 14046 */ 14047 onDisappear?: () => void; 14048 14049 /** 14050 * Callback function before the context menu animation starts. 14051 * 14052 * @type { ?function } 14053 * @syscap SystemCapability.ArkUI.ArkUI.Full 14054 * @crossplatform 14055 * @since 11 14056 */ 14057 /** 14058 * Callback function before the context menu animation starts. 14059 * 14060 * @type { ?function } 14061 * @syscap SystemCapability.ArkUI.ArkUI.Full 14062 * @crossplatform 14063 * @atomicservice 14064 * @since 12 14065 */ 14066 aboutToAppear?: () => void; 14067 14068 /** 14069 * Callback function before the context menu popAnimation starts. 14070 * 14071 * @type { ?function } 14072 * @syscap SystemCapability.ArkUI.ArkUI.Full 14073 * @crossplatform 14074 * @since 11 14075 */ 14076 /** 14077 * Callback function before the context menu popAnimation starts. 14078 * 14079 * @type { ?function } 14080 * @syscap SystemCapability.ArkUI.ArkUI.Full 14081 * @crossplatform 14082 * @atomicservice 14083 * @since 12 14084 */ 14085 aboutToDisappear?: () => void; 14086 14087 /** 14088 * The margin of menu's layoutRegion. 14089 * 14090 * @type { ?Margin } 14091 * @syscap SystemCapability.ArkUI.ArkUI.Full 14092 * @crossplatform 14093 * @atomicservice 14094 * @since 13 14095 */ 14096 layoutRegionMargin?: Margin; 14097 14098 /** 14099 * The preview animator options. 14100 * 14101 * @type { ?ContextMenuAnimationOptions } 14102 * @syscap SystemCapability.ArkUI.ArkUI.Full 14103 * @crossplatform 14104 * @since 11 14105 */ 14106 /** 14107 * The preview animator options. 14108 * 14109 * @type { ?ContextMenuAnimationOptions } 14110 * @syscap SystemCapability.ArkUI.ArkUI.Full 14111 * @crossplatform 14112 * @atomicservice 14113 * @since 12 14114 */ 14115 previewAnimationOptions?: ContextMenuAnimationOptions; 14116 14117 /** 14118 * Defines the menu's background color 14119 * 14120 * @type { ?ResourceColor } 14121 * @default Color.Transparent 14122 * @syscap SystemCapability.ArkUI.ArkUI.Full 14123 * @crossplatform 14124 * @since 11 14125 */ 14126 /** 14127 * Defines the menu's background color 14128 * 14129 * @type { ?ResourceColor } 14130 * @default Color.Transparent 14131 * @syscap SystemCapability.ArkUI.ArkUI.Full 14132 * @crossplatform 14133 * @atomicservice 14134 * @since 12 14135 */ 14136 backgroundColor?: ResourceColor; 14137 14138 /** 14139 * Defines menu background blur Style 14140 * 14141 * @type { ?BlurStyle } 14142 * @default BlurStyle.COMPONENT_ULTRA_THICK 14143 * @syscap SystemCapability.ArkUI.ArkUI.Full 14144 * @crossplatform 14145 * @since 11 14146 */ 14147 /** 14148 * Defines menu background blur Style 14149 * 14150 * @type { ?BlurStyle } 14151 * @default BlurStyle.COMPONENT_ULTRA_THICK 14152 * @syscap SystemCapability.ArkUI.ArkUI.Full 14153 * @crossplatform 14154 * @atomicservice 14155 * @since 12 14156 */ 14157 backgroundBlurStyle?: BlurStyle; 14158 14159 /** 14160 * Defines the transition effect of menu opening and closing. 14161 * 14162 * @type { ?TransitionEffect } 14163 * @syscap SystemCapability.ArkUI.ArkUI.Full 14164 * @crossplatform 14165 * @atomicservice 14166 * @since 12 14167 */ 14168 transition?: TransitionEffect; 14169} 14170 14171/** 14172 * Defines the menu options. 14173 * 14174 * @extends ContextMenuOptions 14175 * @interface MenuOptions 14176 * @syscap SystemCapability.ArkUI.ArkUI.Full 14177 * @crossplatform 14178 * @since 10 14179 */ 14180/** 14181 * Defines the menu options. 14182 * 14183 * @extends ContextMenuOptions 14184 * @interface MenuOptions 14185 * @syscap SystemCapability.ArkUI.ArkUI.Full 14186 * @crossplatform 14187 * @atomicservice 14188 * @since 11 14189 */ 14190declare interface MenuOptions extends ContextMenuOptions { 14191 /** 14192 * Sets the title of the menu window. 14193 * 14194 * @type { ?ResourceStr } 14195 * @syscap SystemCapability.ArkUI.ArkUI.Full 14196 * @crossplatform 14197 * @since 10 14198 */ 14199 /** 14200 * Sets the title of the menu window. 14201 * 14202 * @type { ?ResourceStr } 14203 * @syscap SystemCapability.ArkUI.ArkUI.Full 14204 * @crossplatform 14205 * @atomicservice 14206 * @since 11 14207 */ 14208 title?: ResourceStr; 14209 14210 /** 14211 * Whether to display in the sub window. 14212 * 14213 * @type { ?boolean } 14214 * @syscap SystemCapability.ArkUI.ArkUI.Full 14215 * @crossplatform 14216 * @since 11 14217 */ 14218 /** 14219 * Whether to display in the sub window. 14220 * 14221 * @type { ?boolean } 14222 * @syscap SystemCapability.ArkUI.ArkUI.Full 14223 * @crossplatform 14224 * @atomicservice 14225 * @since 12 14226 */ 14227 showInSubWindow?: boolean; 14228} 14229 14230/** 14231 * Defines the ProgressMask class. 14232 * 14233 * @syscap SystemCapability.ArkUI.ArkUI.Full 14234 * @crossplatform 14235 * @since 10 14236 */ 14237/** 14238 * Defines the ProgressMask class. 14239 * 14240 * @syscap SystemCapability.ArkUI.ArkUI.Full 14241 * @crossplatform 14242 * @atomicservice 14243 * @since 11 14244 */ 14245declare class ProgressMask { 14246 /** 14247 * constructor. 14248 * 14249 * @param { number } value - indicates the current value of the progress. 14250 * @param { number } total - indicates the total value of the progress. 14251 * @param { ResourceColor } color - indicates the color of the mask. 14252 * @syscap SystemCapability.ArkUI.ArkUI.Full 14253 * @crossplatform 14254 * @since 10 14255 */ 14256 /** 14257 * constructor. 14258 * 14259 * @param { number } value - indicates the current value of the progress. 14260 * @param { number } total - indicates the total value of the progress. 14261 * @param { ResourceColor } color - indicates the color of the mask. 14262 * @syscap SystemCapability.ArkUI.ArkUI.Full 14263 * @crossplatform 14264 * @atomicservice 14265 * @since 11 14266 */ 14267 constructor(value: number, total: number, color: ResourceColor); 14268 14269 /** 14270 * Update the current value of the progress. 14271 * 14272 * @param { number } value - indicates the current value of the progress. 14273 * @syscap SystemCapability.ArkUI.ArkUI.Full 14274 * @crossplatform 14275 * @since 10 14276 */ 14277 /** 14278 * Update the current value of the progress. 14279 * 14280 * @param { number } value - indicates the current value of the progress. 14281 * @syscap SystemCapability.ArkUI.ArkUI.Full 14282 * @crossplatform 14283 * @atomicservice 14284 * @since 11 14285 */ 14286 updateProgress(value: number): void; 14287 14288 /** 14289 * Update the color of the mask. 14290 * 14291 * @param { ResourceColor } value - indicates the color of the mask. 14292 * @syscap SystemCapability.ArkUI.ArkUI.Full 14293 * @crossplatform 14294 * @since 10 14295 */ 14296 /** 14297 * Update the color of the mask. 14298 * 14299 * @param { ResourceColor } value - indicates the color of the mask. 14300 * @syscap SystemCapability.ArkUI.ArkUI.Full 14301 * @crossplatform 14302 * @atomicservice 14303 * @since 11 14304 */ 14305 updateColor(value: ResourceColor): void; 14306 14307 /** 14308 * Enable the breathe animation of mask. 14309 * 14310 * @param { boolean } value 14311 * @syscap SystemCapability.ArkUI.ArkUI.Full 14312 * @crossplatform 14313 * @atomicservice 14314 * @since 12 14315 */ 14316 enableBreathingAnimation(value: boolean): void; 14317} 14318 14319/** 14320 * Defines TouchTestInfo class. 14321 * 14322 * @syscap SystemCapability.ArkUI.ArkUI.Full 14323 * @crossplatform 14324 * @since 11 14325 */ 14326/** 14327 * Defines TouchTestInfo class. 14328 * 14329 * @syscap SystemCapability.ArkUI.ArkUI.Full 14330 * @crossplatform 14331 * @atomicservice 14332 * @since 12 14333 */ 14334declare class TouchTestInfo { 14335 /** 14336 * Get the X-coordinate relative to the window. 14337 * 14338 * @type { number } 14339 * @syscap SystemCapability.ArkUI.ArkUI.Full 14340 * @crossplatform 14341 * @since 11 14342 */ 14343 /** 14344 * Get the X-coordinate relative to the window. 14345 * 14346 * @type { number } 14347 * @syscap SystemCapability.ArkUI.ArkUI.Full 14348 * @crossplatform 14349 * @atomicservice 14350 * @since 12 14351 */ 14352 windowX: number; 14353 14354 /** 14355 * Get the Y-coordinate relative to the window. 14356 * 14357 * @type { number } 14358 * @syscap SystemCapability.ArkUI.ArkUI.Full 14359 * @crossplatform 14360 * @since 11 14361 */ 14362 /** 14363 * Get the Y-coordinate relative to the window. 14364 * 14365 * @type { number } 14366 * @syscap SystemCapability.ArkUI.ArkUI.Full 14367 * @crossplatform 14368 * @atomicservice 14369 * @since 12 14370 */ 14371 windowY: number; 14372 14373 /** 14374 * Get the X-coordinate relative to the current component. 14375 * 14376 * @type { number } 14377 * @syscap SystemCapability.ArkUI.ArkUI.Full 14378 * @crossplatform 14379 * @since 11 14380 */ 14381 /** 14382 * Get the X-coordinate relative to the current component. 14383 * 14384 * @type { number } 14385 * @syscap SystemCapability.ArkUI.ArkUI.Full 14386 * @crossplatform 14387 * @atomicservice 14388 * @since 12 14389 */ 14390 parentX: number; 14391 14392 /** 14393 * Get the Y-coordinate relative to the current component. 14394 * 14395 * @type { number } 14396 * @syscap SystemCapability.ArkUI.ArkUI.Full 14397 * @crossplatform 14398 * @since 11 14399 */ 14400 /** 14401 * Get the Y-coordinate relative to the current component. 14402 * 14403 * @type { number } 14404 * @syscap SystemCapability.ArkUI.ArkUI.Full 14405 * @crossplatform 14406 * @atomicservice 14407 * @since 12 14408 */ 14409 parentY: number; 14410 14411 /** 14412 * Get the X-coordinate relative to the sub component. 14413 * 14414 * @type { number } 14415 * @syscap SystemCapability.ArkUI.ArkUI.Full 14416 * @crossplatform 14417 * @since 11 14418 */ 14419 /** 14420 * Get the X-coordinate relative to the sub component. 14421 * 14422 * @type { number } 14423 * @syscap SystemCapability.ArkUI.ArkUI.Full 14424 * @crossplatform 14425 * @atomicservice 14426 * @since 12 14427 */ 14428 x: number; 14429 14430 /** 14431 * Get the Y-coordinate relative to the sub component. 14432 * 14433 * @type { number } 14434 * @syscap SystemCapability.ArkUI.ArkUI.Full 14435 * @crossplatform 14436 * @since 11 14437 */ 14438 /** 14439 * Get the Y-coordinate relative to the sub component. 14440 * 14441 * @type { number } 14442 * @syscap SystemCapability.ArkUI.ArkUI.Full 14443 * @crossplatform 14444 * @atomicservice 14445 * @since 12 14446 */ 14447 y: number; 14448 14449 /** 14450 * Get the rectangle of sub component. 14451 * 14452 * @type { RectResult } 14453 * @syscap SystemCapability.ArkUI.ArkUI.Full 14454 * @crossplatform 14455 * @since 11 14456 */ 14457 /** 14458 * Get the rectangle of sub component. 14459 * 14460 * @type { RectResult } 14461 * @syscap SystemCapability.ArkUI.ArkUI.Full 14462 * @crossplatform 14463 * @atomicservice 14464 * @since 12 14465 */ 14466 rect: RectResult; 14467 14468 /** 14469 * Get the name of sub component. 14470 * 14471 * @type { string } 14472 * @syscap SystemCapability.ArkUI.ArkUI.Full 14473 * @crossplatform 14474 * @since 11 14475 */ 14476 /** 14477 * Get the name of sub component. 14478 * 14479 * @type { string } 14480 * @syscap SystemCapability.ArkUI.ArkUI.Full 14481 * @crossplatform 14482 * @atomicservice 14483 * @since 12 14484 */ 14485 id: string; 14486} 14487 14488/** 14489 * Defines TouchResult class. 14490 * 14491 * @syscap SystemCapability.ArkUI.ArkUI.Full 14492 * @crossplatform 14493 * @since 11 14494 */ 14495/** 14496 * Defines TouchResult class. 14497 * 14498 * @syscap SystemCapability.ArkUI.ArkUI.Full 14499 * @crossplatform 14500 * @atomicservice 14501 * @since 12 14502 */ 14503declare class TouchResult { 14504 /** 14505 * Defines the touch test strategy. 14506 * 14507 * @type { TouchTestStrategy } 14508 * @syscap SystemCapability.ArkUI.ArkUI.Full 14509 * @crossplatform 14510 * @since 11 14511 */ 14512 /** 14513 * Defines the touch test strategy. 14514 * 14515 * @type { TouchTestStrategy } 14516 * @syscap SystemCapability.ArkUI.ArkUI.Full 14517 * @crossplatform 14518 * @atomicservice 14519 * @since 12 14520 */ 14521 strategy: TouchTestStrategy; 14522 14523 /** 14524 * Defines the component's name. 14525 * 14526 * @type { ?string } 14527 * @syscap SystemCapability.ArkUI.ArkUI.Full 14528 * @crossplatform 14529 * @since 11 14530 */ 14531 /** 14532 * Defines the component's name. 14533 * 14534 * @type { ?string } 14535 * @syscap SystemCapability.ArkUI.ArkUI.Full 14536 * @crossplatform 14537 * @atomicservice 14538 * @since 12 14539 */ 14540 id?: string; 14541} 14542 14543/** 14544 * Set the edge blur effect distance of the corresponding defense line of the component 14545 * When the component expand out, no re-layout is triggered 14546 * 14547 * @interface PixelStretchEffectOptions 14548 * @syscap SystemCapability.ArkUI.ArkUI.Full 14549 * @crossplatform 14550 * @since 10 14551 */ 14552/** 14553 * Set the edge blur effect distance of the corresponding defense line of the component 14554 * When the component expand out, no re-layout is triggered 14555 * 14556 * @interface PixelStretchEffectOptions 14557 * @syscap SystemCapability.ArkUI.ArkUI.Full 14558 * @crossplatform 14559 * @atomicservice 14560 * @since 11 14561 */ 14562declare interface PixelStretchEffectOptions { 14563 /** 14564 * top property. value range (-∞, ∞) 14565 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 14566 * 14567 * @type { ?Length } 14568 * @default 0 14569 * @syscap SystemCapability.ArkUI.ArkUI.Full 14570 * @crossplatform 14571 * @since 10 14572 */ 14573 /** 14574 * top property. value range (-∞, ∞) 14575 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 14576 * 14577 * @type { ?Length } 14578 * @default 0 14579 * @syscap SystemCapability.ArkUI.ArkUI.Full 14580 * @crossplatform 14581 * @atomicservice 14582 * @since 11 14583 */ 14584 top?: Length; 14585 14586 /** 14587 * bottom property. value range (-∞, ∞) 14588 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 14589 * 14590 * @type { ?Length } 14591 * @default 0 14592 * @syscap SystemCapability.ArkUI.ArkUI.Full 14593 * @crossplatform 14594 * @since 10 14595 */ 14596 /** 14597 * bottom property. value range (-∞, ∞) 14598 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 14599 * 14600 * @type { ?Length } 14601 * @default 0 14602 * @syscap SystemCapability.ArkUI.ArkUI.Full 14603 * @crossplatform 14604 * @atomicservice 14605 * @since 11 14606 */ 14607 bottom?: Length; 14608 14609 /** 14610 * left property. value range (-∞, ∞) 14611 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 14612 * 14613 * @type { ?Length } 14614 * @default 0 14615 * @syscap SystemCapability.ArkUI.ArkUI.Full 14616 * @crossplatform 14617 * @since 10 14618 */ 14619 /** 14620 * left property. value range (-∞, ∞) 14621 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 14622 * 14623 * @type { ?Length } 14624 * @default 0 14625 * @syscap SystemCapability.ArkUI.ArkUI.Full 14626 * @crossplatform 14627 * @atomicservice 14628 * @since 11 14629 */ 14630 left?: Length; 14631 14632 /** 14633 * right property. value range (-∞, ∞) 14634 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 14635 * 14636 * @type { ?Length } 14637 * @default 0 14638 * @syscap SystemCapability.ArkUI.ArkUI.Full 14639 * @crossplatform 14640 * @since 10 14641 */ 14642 /** 14643 * right property. value range (-∞, ∞) 14644 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 14645 * 14646 * @type { ?Length } 14647 * @default 0 14648 * @syscap SystemCapability.ArkUI.ArkUI.Full 14649 * @crossplatform 14650 * @atomicservice 14651 * @since 11 14652 */ 14653 right?: Length; 14654} 14655 14656/** 14657 * Defines the click effect. 14658 * 14659 * @interface ClickEffect 14660 * @syscap SystemCapability.ArkUI.ArkUI.Full 14661 * @crossplatform 14662 * @since 10 14663 */ 14664/** 14665 * Defines the click effect. 14666 * 14667 * @interface ClickEffect 14668 * @syscap SystemCapability.ArkUI.ArkUI.Full 14669 * @crossplatform 14670 * @atomicservice 14671 * @since 11 14672 */ 14673declare interface ClickEffect { 14674 /** 14675 * Set the click effect level. 14676 * 14677 * @type { ClickEffectLevel } 14678 * @default ClickEffectLevel.Light 14679 * @syscap SystemCapability.ArkUI.ArkUI.Full 14680 * @since 10 14681 */ 14682 /** 14683 * Set the click effect level. 14684 * 14685 * @type { ClickEffectLevel } 14686 * @default ClickEffectLevel.Light 14687 * @syscap SystemCapability.ArkUI.ArkUI.Full 14688 * @atomicservice 14689 * @since 11 14690 */ 14691 level: ClickEffectLevel; 14692 14693 /** 14694 * Set scale number. 14695 * This default scale is same as the scale of click effect level. 14696 * 14697 * @type { ?number } 14698 * @syscap SystemCapability.ArkUI.ArkUI.Full 14699 * @since 10 14700 */ 14701 /** 14702 * Set scale number. 14703 * This default scale is same as the scale of click effect level. 14704 * 14705 * @type { ?number } 14706 * @syscap SystemCapability.ArkUI.ArkUI.Full 14707 * @atomicservice 14708 * @since 11 14709 */ 14710 scale?: number; 14711} 14712 14713/** 14714 * Defines the fadingEdge options. 14715 * 14716 * @typedef FadingEdgeOptions 14717 * @syscap SystemCapability.ArkUI.ArkUI.Full 14718 * @crossplatform 14719 * @atomicservice 14720 * @since 14 14721 */ 14722declare interface FadingEdgeOptions { 14723 /** 14724 * The length of FadingEdge. 14725 * 14726 * @type { LengthMetrics } 14727 * @default 32vp 14728 * @syscap SystemCapability.ArkUI.ArkUI.Full 14729 * @crossplatform 14730 * @atomicservice 14731 * @since 14 14732 */ 14733 fadingEdgeLength?: LengthMetrics; 14734} 14735 14736/** 14737 * Define nested scroll options 14738 * 14739 * @interface NestedScrollOptions 14740 * @syscap SystemCapability.ArkUI.ArkUI.Full 14741 * @since 10 14742 */ 14743/** 14744 * Define nested scroll options 14745 * 14746 * @interface NestedScrollOptions 14747 * @syscap SystemCapability.ArkUI.ArkUI.Full 14748 * @atomicservice 14749 * @since 11 14750 */ 14751declare interface NestedScrollOptions { 14752 /** 14753 * Set NestedScrollMode when the scrollable component scrolls forward 14754 * 14755 * @type { NestedScrollMode } 14756 * @syscap SystemCapability.ArkUI.ArkUI.Full 14757 * @since 10 14758 */ 14759 /** 14760 * Set NestedScrollMode when the scrollable component scrolls forward 14761 * 14762 * @type { NestedScrollMode } 14763 * @syscap SystemCapability.ArkUI.ArkUI.Full 14764 * @crossplatform 14765 * @atomicservice 14766 * @since 11 14767 */ 14768 scrollForward: NestedScrollMode; 14769 14770 /** 14771 * Set NestedScrollMode when the scrollable component scrolls backward 14772 * 14773 * @type { NestedScrollMode } 14774 * @syscap SystemCapability.ArkUI.ArkUI.Full 14775 * @since 10 14776 */ 14777 /** 14778 * Set NestedScrollMode when the scrollable component scrolls backward 14779 * 14780 * @type { NestedScrollMode } 14781 * @syscap SystemCapability.ArkUI.ArkUI.Full 14782 * @crossplatform 14783 * @atomicservice 14784 * @since 11 14785 */ 14786 scrollBackward: NestedScrollMode; 14787} 14788 14789/** 14790 * Defines the menu element. 14791 * 14792 * @interface MenuElement 14793 * @syscap SystemCapability.ArkUI.ArkUI.Full 14794 * @since 7 14795 */ 14796/** 14797 * Defines the menu element. 14798 * 14799 * @interface MenuElement 14800 * @syscap SystemCapability.ArkUI.ArkUI.Full 14801 * @crossplatform 14802 * @since 10 14803 */ 14804/** 14805 * Defines the menu element. 14806 * 14807 * @interface MenuElement 14808 * @syscap SystemCapability.ArkUI.ArkUI.Full 14809 * @crossplatform 14810 * @atomicservice 14811 * @since 11 14812 */ 14813declare interface MenuElement { 14814 /** 14815 * Sets the value of the menu element. 14816 * 14817 * @type { ResourceStr } 14818 * @syscap SystemCapability.ArkUI.ArkUI.Full 14819 * @since 7 14820 */ 14821 /** 14822 * Sets the value of the menu element. 14823 * 14824 * @type { ResourceStr } 14825 * @syscap SystemCapability.ArkUI.ArkUI.Full 14826 * @crossplatform 14827 * @since 10 14828 */ 14829 /** 14830 * Sets the value of the menu element. 14831 * 14832 * @type { ResourceStr } 14833 * @syscap SystemCapability.ArkUI.ArkUI.Full 14834 * @crossplatform 14835 * @atomicservice 14836 * @since 11 14837 */ 14838 value: ResourceStr; 14839 14840 /** 14841 * Sets the icon of the menu element. 14842 * 14843 * @type { ?ResourceStr } 14844 * @syscap SystemCapability.ArkUI.ArkUI.Full 14845 * @crossplatform 14846 * @since 10 14847 */ 14848 /** 14849 * Sets the icon of the menu element. 14850 * 14851 * @type { ?ResourceStr } 14852 * @syscap SystemCapability.ArkUI.ArkUI.Full 14853 * @crossplatform 14854 * @atomicservice 14855 * @since 11 14856 */ 14857 icon?: ResourceStr; 14858 14859 /** 14860 * Sets the symbol of the menu element. 14861 * 14862 * @type { ?SymbolGlyphModifier } 14863 * @syscap SystemCapability.ArkUI.ArkUI.Full 14864 * @atomicservice 14865 * @since 12 14866 */ 14867 symbolIcon?: SymbolGlyphModifier; 14868 14869 /** 14870 * If the value is true, the menu element is available and can respond to operations such as clicking. 14871 * If the value is false, the menu element is not available and click operations are not responded. 14872 * 14873 * @type { ?boolean } 14874 * @default true 14875 * @syscap SystemCapability.ArkUI.ArkUI.Full 14876 * @crossplatform 14877 * @since 11 14878 */ 14879 /** 14880 * If the value is true, the menu element is available and can respond to operations such as clicking. 14881 * If the value is false, the menu element is not available and click operations are not responded. 14882 * 14883 * @type { ?boolean } 14884 * @default true 14885 * @syscap SystemCapability.ArkUI.ArkUI.Full 14886 * @crossplatform 14887 * @atomicservice 14888 * @since 12 14889 */ 14890 enabled?: boolean; 14891 14892 /** 14893 * Method executed by the callback. 14894 * 14895 * @type { function } 14896 * @syscap SystemCapability.ArkUI.ArkUI.Full 14897 * @since 7 14898 */ 14899 /** 14900 * Method executed by the callback. 14901 * 14902 * @type { function } 14903 * @syscap SystemCapability.ArkUI.ArkUI.Full 14904 * @crossplatform 14905 * @since 10 14906 */ 14907 /** 14908 * Method executed by the callback. 14909 * 14910 * @type { function } 14911 * @syscap SystemCapability.ArkUI.ArkUI.Full 14912 * @crossplatform 14913 * @atomicservice 14914 * @since 11 14915 */ 14916 action: () => void; 14917} 14918 14919/** 14920 * Defines the attribute modifier. 14921 * 14922 * @interface AttributeModifier<T> 14923 * @syscap SystemCapability.ArkUI.ArkUI.Full 14924 * @crossplatform 14925 * @since 11 14926 */ 14927/** 14928 * Defines the attribute modifier. 14929 * 14930 * @interface AttributeModifier<T> 14931 * @syscap SystemCapability.ArkUI.ArkUI.Full 14932 * @crossplatform 14933 * @atomicservice 14934 * @since 12 14935 */ 14936declare interface AttributeModifier<T> { 14937 14938 /** 14939 * Defines the normal update attribute function. 14940 * 14941 * @param { T } instance 14942 * @syscap SystemCapability.ArkUI.ArkUI.Full 14943 * @crossplatform 14944 * @since 11 14945 */ 14946 /** 14947 * Defines the normal update attribute function. 14948 * 14949 * @param { T } instance 14950 * @syscap SystemCapability.ArkUI.ArkUI.Full 14951 * @crossplatform 14952 * @atomicservice 14953 * @since 12 14954 */ 14955 applyNormalAttribute?(instance: T) : void; 14956 14957 /** 14958 * Defines the pressed update attribute function. 14959 * 14960 * @param { T } instance 14961 * @syscap SystemCapability.ArkUI.ArkUI.Full 14962 * @crossplatform 14963 * @since 11 14964 */ 14965 /** 14966 * Defines the pressed update attribute function. 14967 * 14968 * @param { T } instance 14969 * @syscap SystemCapability.ArkUI.ArkUI.Full 14970 * @crossplatform 14971 * @atomicservice 14972 * @since 12 14973 */ 14974 applyPressedAttribute?(instance: T) : void; 14975 14976 /** 14977 * Defines the focused update attribute function. 14978 * 14979 * @param { T } instance 14980 * @syscap SystemCapability.ArkUI.ArkUI.Full 14981 * @crossplatform 14982 * @since 11 14983 */ 14984 /** 14985 * Defines the focused update attribute function. 14986 * 14987 * @param { T } instance 14988 * @syscap SystemCapability.ArkUI.ArkUI.Full 14989 * @crossplatform 14990 * @atomicservice 14991 * @since 12 14992 */ 14993 applyFocusedAttribute?(instance: T) : void; 14994 14995 /** 14996 * Defines the disabled update attribute function. 14997 * 14998 * @param { T } instance 14999 * @syscap SystemCapability.ArkUI.ArkUI.Full 15000 * @crossplatform 15001 * @since 11 15002 */ 15003 /** 15004 * Defines the disabled update attribute function. 15005 * 15006 * @param { T } instance 15007 * @syscap SystemCapability.ArkUI.ArkUI.Full 15008 * @crossplatform 15009 * @atomicservice 15010 * @since 12 15011 */ 15012 applyDisabledAttribute?(instance: T) : void; 15013 15014 /** 15015 * Defines the selected update attribute function. 15016 * 15017 * @param { T } instance 15018 * @syscap SystemCapability.ArkUI.ArkUI.Full 15019 * @crossplatform 15020 * @since 11 15021 */ 15022 /** 15023 * Defines the selected update attribute function. 15024 * 15025 * @param { T } instance 15026 * @syscap SystemCapability.ArkUI.ArkUI.Full 15027 * @crossplatform 15028 * @atomicservice 15029 * @since 12 15030 */ 15031 applySelectedAttribute?(instance: T) : void; 15032} 15033 15034/** 15035 * Defines the content modifier. 15036 * 15037 * @interface ContentModifier 15038 * @syscap SystemCapability.ArkUI.ArkUI.Full 15039 * @crossplatform 15040 * @atomicservice 15041 * @since 12 15042 */ 15043declare interface ContentModifier<T> { 15044 15045 /** 15046 * Defining applyContent function. 15047 * 15048 * @returns { WrappedBuilder<[T]> } 15049 * @syscap SystemCapability.ArkUI.ArkUI.Full 15050 * @crossplatform 15051 * @atomicservice 15052 * @since 12 15053 */ 15054 applyContent(): WrappedBuilder<[T]> 15055} 15056 15057/** 15058 * Defines the common configuration. 15059 * 15060 * @interface CommonConfiguration 15061 * @syscap SystemCapability.ArkUI.ArkUI.Full 15062 * @crossplatform 15063 * @atomicservice 15064 * @since 12 15065 */ 15066declare interface CommonConfiguration<T> { 15067 15068 /** 15069 * If the value is true, the contentModifier is available and can respond to operations such as triggerChange. 15070 * If it is set to false, triggerChange operations are not responded. 15071 * 15072 * @type { boolean } 15073 * @syscap SystemCapability.ArkUI.ArkUI.Full 15074 * @crossplatform 15075 * @atomicservice 15076 * @since 12 15077 */ 15078 enabled: boolean, 15079 15080 /** 15081 * Obtains the contentModifier instance object 15082 * 15083 * @type { ContentModifier<T> } 15084 * @syscap SystemCapability.ArkUI.ArkUI.Full 15085 * @crossplatform 15086 * @atomicservice 15087 * @since 12 15088 */ 15089 contentModifier: ContentModifier<T> 15090} 15091 15092/** 15093 * Outline Style 15094 * 15095 * @enum { number } 15096 * @syscap SystemCapability.ArkUI.ArkUI.Full 15097 * @crossplatform 15098 * @form 15099 * @since 11 15100 */ 15101/** 15102 * Outline Style 15103 * 15104 * @enum { number } 15105 * @syscap SystemCapability.ArkUI.ArkUI.Full 15106 * @crossplatform 15107 * @form 15108 * @atomicservice 15109 * @since 12 15110 */ 15111declare enum OutlineStyle { 15112 /** 15113 * Shows as a solid line. 15114 * 15115 * @syscap SystemCapability.ArkUI.ArkUI.Full 15116 * @crossplatform 15117 * @form 15118 * @since 11 15119 */ 15120 /** 15121 * Shows as a solid line. 15122 * 15123 * @syscap SystemCapability.ArkUI.ArkUI.Full 15124 * @crossplatform 15125 * @form 15126 * @atomicservice 15127 * @since 12 15128 */ 15129 SOLID = 0, 15130 15131 /** 15132 * Shows as a series of short square dashed lines. 15133 * 15134 * @syscap SystemCapability.ArkUI.ArkUI.Full 15135 * @crossplatform 15136 * @form 15137 * @since 11 15138 */ 15139 /** 15140 * Shows as a series of short square dashed lines. 15141 * 15142 * @syscap SystemCapability.ArkUI.ArkUI.Full 15143 * @crossplatform 15144 * @form 15145 * @atomicservice 15146 * @since 12 15147 */ 15148 DASHED = 1, 15149 15150 /** 15151 * Displays as a series of dots with a radius of half the borderWidth. 15152 * 15153 * @syscap SystemCapability.ArkUI.ArkUI.Full 15154 * @crossplatform 15155 * @form 15156 * @since 11 15157 */ 15158 /** 15159 * Displays as a series of dots with a radius of half the borderWidth. 15160 * 15161 * @syscap SystemCapability.ArkUI.ArkUI.Full 15162 * @crossplatform 15163 * @form 15164 * @atomicservice 15165 * @since 12 15166 */ 15167 DOTTED = 2, 15168} 15169 15170/** 15171 * Defines the drag preview mode. 15172 * 15173 * @enum { number } 15174 * @syscap SystemCapability.ArkUI.ArkUI.Full 15175 * @since 11 15176 */ 15177/** 15178 * Defines the drag preview mode. 15179 * 15180 * @enum { number } 15181 * @syscap SystemCapability.ArkUI.ArkUI.Full 15182 * @atomicservice 15183 * @since 12 15184 */ 15185declare enum DragPreviewMode { 15186 /** 15187 * Default preview mode, let system process preview scale. 15188 * 15189 * @syscap SystemCapability.ArkUI.ArkUI.Full 15190 * @since 11 15191 */ 15192 /** 15193 * Default preview mode, let system process preview scale. 15194 * 15195 * @syscap SystemCapability.ArkUI.ArkUI.Full 15196 * @atomicservice 15197 * @since 12 15198 */ 15199 AUTO = 1, 15200 /** 15201 * Disable system scale to preview panel 15202 * 15203 * @syscap SystemCapability.ArkUI.ArkUI.Full 15204 * @since 11 15205 */ 15206 /** 15207 * Disable system scale to preview panel 15208 * 15209 * @syscap SystemCapability.ArkUI.ArkUI.Full 15210 * @atomicservice 15211 * @since 12 15212 */ 15213 DISABLE_SCALE = 2, 15214 /** 15215 * Enable the default shadow effect of preview. 15216 * 15217 * @syscap SystemCapability.ArkUI.ArkUI.Full 15218 * @atomicservice 15219 * @since 12 15220 */ 15221 ENABLE_DEFAULT_SHADOW = 3, 15222 /** 15223 * Enable the default radius effect of preview. 15224 * 15225 * @syscap SystemCapability.ArkUI.ArkUI.Full 15226 * @atomicservice 15227 * @since 12 15228 */ 15229 ENABLE_DEFAULT_RADIUS = 4, 15230} 15231 15232/** 15233 * Define the menu pop-up policy 15234 * 15235 * @enum { number } 15236 * @syscap SystemCapability.ArkUI.ArkUI.Full 15237 * @crossplatform 15238 * @atomicservice 15239 * @since 12 15240 */ 15241declare enum MenuPolicy { 15242 /** 15243 * Default value. The default logic of whether to pop up a menu depends on the scene. 15244 * 15245 * @syscap SystemCapability.ArkUI.ArkUI.Full 15246 * @crossplatform 15247 * @atomicservice 15248 * @since 12 15249 */ 15250 DEFAULT = 0, 15251 15252 /** 15253 * Hide pop up menu. 15254 * 15255 * @syscap SystemCapability.ArkUI.ArkUI.Full 15256 * @crossplatform 15257 * @atomicservice 15258 * @since 12 15259 */ 15260 HIDE = 1, 15261 15262 /** 15263 * Show pop up menu. 15264 * 15265 * @syscap SystemCapability.ArkUI.ArkUI.Full 15266 * @crossplatform 15267 * @atomicservice 15268 * @since 12 15269 */ 15270 SHOW = 2, 15271} 15272 15273/** 15274 * ImageModifier 15275 * 15276 * @typedef { import('../api/arkui/ImageModifier').ImageModifier } ImageModifier 15277 * @syscap SystemCapability.ArkUI.ArkUI.Full 15278 * @crossplatform 15279 * @atomicservice 15280 * @since 12 15281 */ 15282declare type ImageModifier = import('../api/arkui/ImageModifier').ImageModifier; 15283 15284/** 15285 * SymbolGlyphModifier 15286 * 15287 * @typedef {import('../api/arkui/SymbolGlyphModifier').SymbolGlyphModifier} SymbolGlyphModifier 15288 * @syscap SystemCapability.ArkUI.ArkUI.Full 15289 * @atomicservice 15290 * @since 12 15291 */ 15292declare type SymbolGlyphModifier = import('../api/arkui/SymbolGlyphModifier').SymbolGlyphModifier; 15293 15294/** 15295 * Defines the preview options. 15296 * 15297 * @interface DragPreviewOptions 15298 * @syscap SystemCapability.ArkUI.ArkUI.Full 15299 * @since 11 15300 */ 15301/** 15302 * Defines the preview options. 15303 * 15304 * @interface DragPreviewOptions 15305 * @syscap SystemCapability.ArkUI.ArkUI.Full 15306 * @atomicservice 15307 * @since 12 15308 */ 15309declare interface DragPreviewOptions { 15310 /** 15311 * Drag preview mode. 15312 * 15313 * @type { ?DragPreviewMode } 15314 * @syscap SystemCapability.ArkUI.ArkUI.Full 15315 * @since 11 15316 */ 15317 /** 15318 * Drag preview mode. 15319 * 15320 * @type { ?(DragPreviewMode | Array<DragPreviewMode>) } 15321 * @syscap SystemCapability.ArkUI.ArkUI.Full 15322 * @atomicservice 15323 * @since 12 15324 */ 15325 mode?: DragPreviewMode | Array<DragPreviewMode>; 15326 15327 /** 15328 * Drag preview modifier. 15329 * 15330 * @type { ?ImageModifier } 15331 * @syscap SystemCapability.ArkUI.ArkUI.Full 15332 * @atomicservice 15333 * @since 12 15334 */ 15335 modifier?: ImageModifier; 15336 15337 /** 15338 * The flag for number showing. 15339 * 15340 * @type { ?(boolean | number) } 15341 * @syscap SystemCapability.ArkUI.ArkUI.Full 15342 * @atomicservice 15343 * @since 12 15344 */ 15345 numberBadge?: boolean | number; 15346} 15347 15348/** 15349 * Defines the drag options. 15350 * 15351 * @interface DragInteractionOptions 15352 * @syscap SystemCapability.ArkUI.ArkUI.Full 15353 * @atomicservice 15354 * @since 12 15355 */ 15356declare interface DragInteractionOptions { 15357 /** 15358 * Define whether to gather selected nodes in grid or list. 15359 * 15360 * @type { ?boolean } 15361 * @syscap SystemCapability.ArkUI.ArkUI.Full 15362 * @atomicservice 15363 * @since 12 15364 */ 15365 isMultiSelectionEnabled?: boolean; 15366 15367 /** 15368 * Define whether to execute animation before preview floating. 15369 * 15370 * @type { ?boolean } 15371 * @syscap SystemCapability.ArkUI.ArkUI.Full 15372 * @atomicservice 15373 * @since 12 15374 */ 15375 defaultAnimationBeforeLifting?: boolean; 15376 15377 /** 15378 * Define whether to lifting trigger drag by finger. 15379 * 15380 * @type { ?boolean } 15381 * @default false 15382 * @syscap SystemCapability.ArkUI.ArkUI.Full 15383 * @atomicservice 15384 * @since 15 15385 */ 15386 isLiftingDisabled?: boolean; 15387} 15388 15389/** 15390 * Defines the drag preview configuration. 15391 * 15392 * @interface PreviewConfiguration 15393 * @syscap SystemCapability.ArkUI.ArkUI.Full 15394 * @atomicservice 15395 * @since 15 15396 */ 15397declare interface PreviewConfiguration { 15398 /** 15399 * Define whether to only use for lifting. 15400 * 15401 * @type { ?boolean } 15402 * @default false 15403 * @syscap SystemCapability.ArkUI.ArkUI.Full 15404 * @atomicservice 15405 * @since 15 15406 */ 15407 onlyForLifting?: boolean; 15408 15409 /** 15410 * Define whether to delay create builder. 15411 * 15412 * @type { ?boolean } 15413 * @default false 15414 * @syscap SystemCapability.ArkUI.ArkUI.Full 15415 * @atomicservice 15416 * @since 15 15417 */ 15418 delayCreating?: boolean; 15419} 15420 15421/** 15422 * Define the options of invert 15423 * 15424 * @interface InvertOptions 15425 * @syscap SystemCapability.ArkUI.ArkUI.Full 15426 * @since 11 15427 */ 15428/** 15429 * Define the options of invert 15430 * 15431 * @interface InvertOptions 15432 * @syscap SystemCapability.ArkUI.ArkUI.Full 15433 * @atomicservice 15434 * @since 12 15435 */ 15436declare interface InvertOptions { 15437 15438 /** 15439 * Defines the low value of threshold 15440 * 15441 * @type { number } 15442 * @syscap SystemCapability.ArkUI.ArkUI.Full 15443 * @crossplatform 15444 * @since 11 15445 */ 15446 /** 15447 * Defines the low value of threshold 15448 * 15449 * @type { number } 15450 * @syscap SystemCapability.ArkUI.ArkUI.Full 15451 * @crossplatform 15452 * @atomicservice 15453 * @since 12 15454 */ 15455 low: number; 15456 15457 /** 15458 * Defines the high value of threshold 15459 * 15460 * @type { number } 15461 * @syscap SystemCapability.ArkUI.ArkUI.Full 15462 * @crossplatform 15463 * @since 11 15464 */ 15465 /** 15466 * Defines the high value of threshold 15467 * 15468 * @type { number } 15469 * @syscap SystemCapability.ArkUI.ArkUI.Full 15470 * @crossplatform 15471 * @atomicservice 15472 * @since 12 15473 */ 15474 high: number; 15475 15476 /** 15477 * Defines the threshold 15478 * 15479 * @type { number } 15480 * @syscap SystemCapability.ArkUI.ArkUI.Full 15481 * @crossplatform 15482 * @since 11 15483 */ 15484 /** 15485 * Defines the threshold 15486 * 15487 * @type { number } 15488 * @syscap SystemCapability.ArkUI.ArkUI.Full 15489 * @crossplatform 15490 * @atomicservice 15491 * @since 12 15492 */ 15493 threshold: number; 15494 15495 /** 15496 *Defines the threshold range 15497 * 15498 * @type { number } 15499 * @syscap SystemCapability.ArkUI.ArkUI.Full 15500 * @crossplatform 15501 * @since 11 15502 */ 15503 /** 15504 *Defines the threshold range 15505 * 15506 * @type { number } 15507 * @syscap SystemCapability.ArkUI.ArkUI.Full 15508 * @crossplatform 15509 * @atomicservice 15510 * @since 12 15511 */ 15512 thresholdRange: number; 15513} 15514 15515/** 15516 * Import the CircleShape type object for common method. 15517 * 15518 * @typedef { import('../api/@ohos.arkui.shape').CircleShape } CircleShape 15519 * @syscap SystemCapability.ArkUI.ArkUI.Full 15520 * @crossplatform 15521 * @form 15522 * @atomicservice 15523 * @since 12 15524 */ 15525declare type CircleShape = import('../api/@ohos.arkui.shape').CircleShape; 15526 15527/** 15528 * Import the EllipseShape type object for common method. 15529 * 15530 * @typedef { import('../api/@ohos.arkui.shape').EllipseShape } EllipseShape 15531 * @syscap SystemCapability.ArkUI.ArkUI.Full 15532 * @crossplatform 15533 * @form 15534 * @atomicservice 15535 * @since 12 15536 */ 15537declare type EllipseShape = import('../api/@ohos.arkui.shape').EllipseShape; 15538 15539/** 15540 * Import the PathShape type object for common method. 15541 * 15542 * @typedef { import('../api/@ohos.arkui.shape').PathShape } PathShape 15543 * @syscap SystemCapability.ArkUI.ArkUI.Full 15544 * @crossplatform 15545 * @form 15546 * @atomicservice 15547 * @since 12 15548 */ 15549declare type PathShape = import('../api/@ohos.arkui.shape').PathShape; 15550 15551/** 15552 * Import the RectShape type object for common method. 15553 * 15554 * @typedef { import('../api/@ohos.arkui.shape').RectShape } RectShape 15555 * @syscap SystemCapability.ArkUI.ArkUI.Full 15556 * @crossplatform 15557 * @form 15558 * @atomicservice 15559 * @since 12 15560 */ 15561declare type RectShape = import('../api/@ohos.arkui.shape').RectShape; 15562 15563/** 15564 * Defines the type that can be undefined. 15565 * 15566 * @typedef { T | undefined } Optional<T> 15567 * @syscap SystemCapability.ArkUI.ArkUI.Full 15568 * @crossplatform 15569 * @form 15570 * @atomicservice 15571 * @since 12 15572 */ 15573declare type Optional<T> = T | undefined; 15574 15575/** 15576 * CommonMethod. 15577 * 15578 * @syscap SystemCapability.ArkUI.ArkUI.Full 15579 * @since 7 15580 */ 15581/** 15582 * CommonMethod. 15583 * 15584 * @syscap SystemCapability.ArkUI.ArkUI.Full 15585 * @form 15586 * @since 9 15587 */ 15588/** 15589 * CommonMethod. 15590 * 15591 * @syscap SystemCapability.ArkUI.ArkUI.Full 15592 * @crossplatform 15593 * @form 15594 * @since 10 15595 */ 15596/** 15597 * CommonMethod. 15598 * 15599 * @syscap SystemCapability.ArkUI.ArkUI.Full 15600 * @crossplatform 15601 * @form 15602 * @atomicservice 15603 * @since 11 15604 */ 15605declare class CommonMethod<T> { 15606 /** 15607 * constructor. 15608 * 15609 * @syscap SystemCapability.ArkUI.ArkUI.Full 15610 * @systemapi 15611 * @since 7 15612 */ 15613 /** 15614 * constructor. 15615 * 15616 * @syscap SystemCapability.ArkUI.ArkUI.Full 15617 * @systemapi 15618 * @form 15619 * @since 9 15620 */ 15621 constructor(); 15622 15623 /** 15624 * Sets the width of the current component. 15625 * 15626 * @param { Length } value 15627 * @returns { T } 15628 * @syscap SystemCapability.ArkUI.ArkUI.Full 15629 * @since 7 15630 */ 15631 /** 15632 * Sets the width of the current component. 15633 * 15634 * @param { Length } value 15635 * @returns { T } 15636 * @syscap SystemCapability.ArkUI.ArkUI.Full 15637 * @form 15638 * @since 9 15639 */ 15640 /** 15641 * Sets the width of the current component. 15642 * 15643 * @param { Length } value 15644 * @returns { T } 15645 * @syscap SystemCapability.ArkUI.ArkUI.Full 15646 * @crossplatform 15647 * @form 15648 * @since 10 15649 */ 15650 /** 15651 * Sets the width of the current component. 15652 * 15653 * @param { Length } value 15654 * @returns { T } 15655 * @syscap SystemCapability.ArkUI.ArkUI.Full 15656 * @crossplatform 15657 * @form 15658 * @atomicservice 15659 * @since 11 15660 */ 15661 width(value: Length): T; 15662 /** 15663 * Sets the width of the current component. 15664 * 15665 * @param { Length | LayoutPolicy } widthValue 15666 * @returns { T } 15667 * @syscap SystemCapability.ArkUI.ArkUI.Full 15668 * @crossplatform 15669 * @form 15670 * @atomicservice 15671 * @since 15 15672 */ 15673 width(widthValue: Length | LayoutPolicy): T; 15674 15675 /** 15676 * Sets the height of the current component. 15677 * 15678 * @param { Length } value 15679 * @returns { T } 15680 * @syscap SystemCapability.ArkUI.ArkUI.Full 15681 * @since 7 15682 */ 15683 /** 15684 * Sets the height of the current component. 15685 * 15686 * @param { Length } value 15687 * @returns { T } 15688 * @syscap SystemCapability.ArkUI.ArkUI.Full 15689 * @form 15690 * @since 9 15691 */ 15692 /** 15693 * Sets the height of the current component. 15694 * 15695 * @param { Length } value 15696 * @returns { T } 15697 * @syscap SystemCapability.ArkUI.ArkUI.Full 15698 * @crossplatform 15699 * @form 15700 * @since 10 15701 */ 15702 /** 15703 * Sets the height of the current component. 15704 * 15705 * @param { Length } value 15706 * @returns { T } 15707 * @syscap SystemCapability.ArkUI.ArkUI.Full 15708 * @crossplatform 15709 * @form 15710 * @atomicservice 15711 * @since 11 15712 */ 15713 height(value: Length): T; 15714 /** 15715 * Sets the height of the current component. 15716 * 15717 * @param { Length | LayoutPolicy } heightValue 15718 * @returns { T } 15719 * @syscap SystemCapability.ArkUI.ArkUI.Full 15720 * @crossplatform 15721 * @form 15722 * @atomicservice 15723 * @since 15 15724 */ 15725 height(heightValue: Length | LayoutPolicy): T; 15726 15727 /** 15728 * Sets the drawModifier of the current component. 15729 * 15730 * @param { DrawModifier | undefined } modifier - drawModifier used to draw, or undefined if it is not available. 15731 * @returns { T } 15732 * @syscap SystemCapability.ArkUI.ArkUI.Full 15733 * @crossplatform 15734 * @atomicservice 15735 * @since 12 15736 */ 15737 drawModifier(modifier: DrawModifier | undefined): T; 15738 15739 /** 15740 * Sets the custom property of the current component. 15741 * 15742 * @param { string } name - the name of the custom property. 15743 * @param { Optional<Object> } value - the value of the custom property. 15744 * @returns { T } 15745 * @syscap SystemCapability.ArkUI.ArkUI.Full 15746 * @crossplatform 15747 * @atomicservice 15748 * @since 12 15749 */ 15750 customProperty(name: string, value: Optional<Object>): T; 15751 15752 /** 15753 * Expands the safe area. 15754 * 15755 * @param { Array<SafeAreaType> } types - Indicates the types of the safe area. 15756 * @param { Array<SafeAreaEdge> } edges - Indicates the edges of the safe area. 15757 * @returns { T } The component instance. 15758 * @syscap SystemCapability.ArkUI.ArkUI.Full 15759 * @crossplatform 15760 * @since 10 15761 */ 15762 /** 15763 * Expands the safe area. 15764 * 15765 * @param { Array<SafeAreaType> } types - Indicates the types of the safe area. 15766 * @param { Array<SafeAreaEdge> } edges - Indicates the edges of the safe area. 15767 * @returns { T } The component instance. 15768 * @syscap SystemCapability.ArkUI.ArkUI.Full 15769 * @crossplatform 15770 * @atomicservice 15771 * @since 11 15772 */ 15773 expandSafeArea(types?: Array<SafeAreaType>, edges?: Array<SafeAreaEdge>): T; 15774 15775 /** 15776 * Sets the response region of the current component. 15777 * 15778 * @param { Array<Rectangle> | Rectangle } value 15779 * @returns { T } 15780 * @syscap SystemCapability.ArkUI.ArkUI.Full 15781 * @since 8 15782 */ 15783 /** 15784 * Sets the response region of the current component. 15785 * 15786 * @param { Array<Rectangle> | Rectangle } value 15787 * @returns { T } 15788 * @syscap SystemCapability.ArkUI.ArkUI.Full 15789 * @form 15790 * @since 9 15791 */ 15792 /** 15793 * Sets the response region of the current component. 15794 * 15795 * @param { Array<Rectangle> | Rectangle } value 15796 * @returns { T } 15797 * @syscap SystemCapability.ArkUI.ArkUI.Full 15798 * @crossplatform 15799 * @form 15800 * @since 10 15801 */ 15802 /** 15803 * Sets the response region of the current component. 15804 * 15805 * @param { Array<Rectangle> | Rectangle } value 15806 * @returns { T } 15807 * @syscap SystemCapability.ArkUI.ArkUI.Full 15808 * @crossplatform 15809 * @form 15810 * @atomicservice 15811 * @since 11 15812 */ 15813 responseRegion(value: Array<Rectangle> | Rectangle): T; 15814 15815 /** 15816 * Sets the mouse response region of current component 15817 * 15818 * @param { Array<Rectangle> | Rectangle } value 15819 * @returns { T } return the component attribute 15820 * @syscap SystemCapability.ArkUI.ArkUI.Full 15821 * @crossplatform 15822 * @since 10 15823 */ 15824 /** 15825 * Sets the mouse response region of current component 15826 * 15827 * @param { Array<Rectangle> | Rectangle } value 15828 * @returns { T } return the component attribute 15829 * @syscap SystemCapability.ArkUI.ArkUI.Full 15830 * @crossplatform 15831 * @atomicservice 15832 * @since 11 15833 */ 15834 mouseResponseRegion(value: Array<Rectangle> | Rectangle): T; 15835 15836 /** 15837 * The size of the current component. 15838 * 15839 * @param { SizeOptions } value 15840 * @returns { T } 15841 * @syscap SystemCapability.ArkUI.ArkUI.Full 15842 * @since 7 15843 */ 15844 /** 15845 * The size of the current component. 15846 * 15847 * @param { SizeOptions } value 15848 * @returns { T } 15849 * @syscap SystemCapability.ArkUI.ArkUI.Full 15850 * @form 15851 * @since 9 15852 */ 15853 /** 15854 * The size of the current component. 15855 * 15856 * @param { SizeOptions } value 15857 * @returns { T } 15858 * @syscap SystemCapability.ArkUI.ArkUI.Full 15859 * @crossplatform 15860 * @form 15861 * @since 10 15862 */ 15863 /** 15864 * The size of the current component. 15865 * 15866 * @param { SizeOptions } value 15867 * @returns { T } 15868 * @syscap SystemCapability.ArkUI.ArkUI.Full 15869 * @crossplatform 15870 * @form 15871 * @atomicservice 15872 * @since 11 15873 */ 15874 size(value: SizeOptions): T; 15875 15876 /** 15877 * constraint Size: 15878 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 15879 * 15880 * @param { ConstraintSizeOptions } value 15881 * @returns { T } 15882 * @syscap SystemCapability.ArkUI.ArkUI.Full 15883 * @since 7 15884 */ 15885 /** 15886 * constraint Size: 15887 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 15888 * 15889 * @param { ConstraintSizeOptions } value 15890 * @returns { T } 15891 * @syscap SystemCapability.ArkUI.ArkUI.Full 15892 * @form 15893 * @since 9 15894 */ 15895 /** 15896 * constraint Size: 15897 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 15898 * 15899 * @param { ConstraintSizeOptions } value 15900 * @returns { T } 15901 * @syscap SystemCapability.ArkUI.ArkUI.Full 15902 * @crossplatform 15903 * @form 15904 * @since 10 15905 */ 15906 /** 15907 * constraint Size: 15908 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 15909 * 15910 * @param { ConstraintSizeOptions } value 15911 * @returns { T } 15912 * @syscap SystemCapability.ArkUI.ArkUI.Full 15913 * @crossplatform 15914 * @form 15915 * @atomicservice 15916 * @since 11 15917 */ 15918 constraintSize(value: ConstraintSizeOptions): T; 15919 15920 /** 15921 * Sets the touchable of the current component 15922 * 15923 * @param { boolean } value 15924 * @returns { T } 15925 * @syscap SystemCapability.ArkUI.ArkUI.Full 15926 * @since 7 15927 * @deprecated since 9 15928 * @useinstead hitTestBehavior 15929 */ 15930 touchable(value: boolean): T; 15931 15932 /** 15933 * Defines the component's hit test behavior in touch events. 15934 * 15935 * @param { HitTestMode } value - the hit test mode. 15936 * @returns { T } 15937 * @syscap SystemCapability.ArkUI.ArkUI.Full 15938 * @since 9 15939 */ 15940 /** 15941 * Defines the component's hit test behavior in touch events. 15942 * 15943 * @param { HitTestMode } value - the hit test mode. 15944 * @returns { T } 15945 * @syscap SystemCapability.ArkUI.ArkUI.Full 15946 * @crossplatform 15947 * @since 10 15948 */ 15949 /** 15950 * Defines the component's hit test behavior in touch events. 15951 * 15952 * @param { HitTestMode } value - the hit test mode. 15953 * @returns { T } 15954 * @syscap SystemCapability.ArkUI.ArkUI.Full 15955 * @crossplatform 15956 * @atomicservice 15957 * @since 11 15958 */ 15959 hitTestBehavior(value: HitTestMode): T; 15960 15961 /** 15962 * Defines the pre-touch test of sub component in touch events. 15963 * 15964 * @param { function } event 15965 * @returns { T } 15966 * @syscap SystemCapability.ArkUI.ArkUI.Full 15967 * @crossplatform 15968 * @since 11 15969 */ 15970 /** 15971 * Defines the pre-touch test of sub component in touch events. 15972 * 15973 * @param { function } event 15974 * @returns { T } 15975 * @syscap SystemCapability.ArkUI.ArkUI.Full 15976 * @crossplatform 15977 * @atomicservice 15978 * @since 12 15979 */ 15980 onChildTouchTest(event: (value: Array<TouchTestInfo>) => TouchResult): T; 15981 15982 /** 15983 * layout Weight 15984 * 15985 * @param { number | string } value 15986 * @returns { T } 15987 * @syscap SystemCapability.ArkUI.ArkUI.Full 15988 * @since 7 15989 */ 15990 /** 15991 * layout Weight 15992 * 15993 * @param { number | string } value 15994 * @returns { T } 15995 * @syscap SystemCapability.ArkUI.ArkUI.Full 15996 * @form 15997 * @since 9 15998 */ 15999 /** 16000 * layout Weight 16001 * 16002 * @param { number | string } value 16003 * @returns { T } 16004 * @syscap SystemCapability.ArkUI.ArkUI.Full 16005 * @crossplatform 16006 * @form 16007 * @since 10 16008 */ 16009 /** 16010 * layout Weight 16011 * 16012 * @param { number | string } value 16013 * @returns { T } 16014 * @syscap SystemCapability.ArkUI.ArkUI.Full 16015 * @crossplatform 16016 * @form 16017 * @atomicservice 16018 * @since 11 16019 */ 16020 layoutWeight(value: number | string): T; 16021 16022 /** 16023 * chain Weight 16024 * 16025 * @param { ChainWeightOptions } chainWeight 16026 * @returns { T } 16027 * @syscap SystemCapability.ArkUI.ArkUI.Full 16028 * @crossplatform 16029 * @atomicservice 16030 * @since 14 16031 */ 16032 chainWeight(chainWeight: ChainWeightOptions): T; 16033 16034 /** 16035 * Inner margin. 16036 * 16037 * @param { Padding | Length } value 16038 * @returns { T } 16039 * @syscap SystemCapability.ArkUI.ArkUI.Full 16040 * @since 7 16041 */ 16042 /** 16043 * Inner margin. 16044 * 16045 * @param { Padding | Length } value 16046 * @returns { T } 16047 * @syscap SystemCapability.ArkUI.ArkUI.Full 16048 * @form 16049 * @since 9 16050 */ 16051 /** 16052 * Inner margin. 16053 * 16054 * @param { Padding | Length } value 16055 * @returns { T } 16056 * @syscap SystemCapability.ArkUI.ArkUI.Full 16057 * @crossplatform 16058 * @form 16059 * @since 10 16060 */ 16061 /** 16062 * Inner margin. 16063 * 16064 * @param { Padding | Length } value 16065 * @returns { T } 16066 * @syscap SystemCapability.ArkUI.ArkUI.Full 16067 * @crossplatform 16068 * @form 16069 * @atomicservice 16070 * @since 11 16071 */ 16072 /** 16073 * Inner margin. 16074 * 16075 * @param { Padding | Length | LocalizedPadding } value 16076 * @returns { T } 16077 * @syscap SystemCapability.ArkUI.ArkUI.Full 16078 * @crossplatform 16079 * @form 16080 * @atomicservice 16081 * @since 12 16082 */ 16083 padding(value: Padding | Length | LocalizedPadding): T; 16084 16085 /** 16086 * Inner safeArea padding. 16087 * 16088 * @param { Padding | LengthMetrics | LocalizedPadding } paddingValue - Indicates safeArea padding values 16089 * @returns { T } 16090 * @syscap SystemCapability.ArkUI.ArkUI.Full 16091 * @crossplatform 16092 * @form 16093 * @atomicservice 16094 * @since 14 16095 */ 16096 safeAreaPadding(paddingValue: Padding | LengthMetrics | LocalizedPadding): T; 16097 16098 /** 16099 * Outer Margin. 16100 * 16101 * @param { Margin | Length } value 16102 * @returns { T } 16103 * @syscap SystemCapability.ArkUI.ArkUI.Full 16104 * @since 7 16105 */ 16106 /** 16107 * Outer Margin. 16108 * 16109 * @param { Margin | Length } value 16110 * @returns { T } 16111 * @syscap SystemCapability.ArkUI.ArkUI.Full 16112 * @form 16113 * @since 9 16114 */ 16115 /** 16116 * Outer Margin. 16117 * 16118 * @param { Margin | Length } value 16119 * @returns { T } 16120 * @syscap SystemCapability.ArkUI.ArkUI.Full 16121 * @crossplatform 16122 * @form 16123 * @since 10 16124 */ 16125 /** 16126 * Outer Margin. 16127 * 16128 * @param { Margin | Length } value 16129 * @returns { T } 16130 * @syscap SystemCapability.ArkUI.ArkUI.Full 16131 * @crossplatform 16132 * @form 16133 * @atomicservice 16134 * @since 11 16135 */ 16136 /** 16137 * Outer Margin. 16138 * 16139 * @param { Margin | Length | LocalizedMargin } value 16140 * @returns { T } 16141 * @syscap SystemCapability.ArkUI.ArkUI.Full 16142 * @crossplatform 16143 * @form 16144 * @atomicservice 16145 * @since 12 16146 */ 16147 margin(value: Margin | Length | LocalizedMargin): T; 16148 16149 /** 16150 * Background. 16151 * 16152 * @param { CustomBuilder } builder 16153 * @param { object } options 16154 * @returns { T } 16155 * @syscap SystemCapability.ArkUI.ArkUI.Full 16156 * @crossplatform 16157 * @since 10 16158 */ 16159 /** 16160 * Background. 16161 * 16162 * @param { CustomBuilder } builder 16163 * @param { object } options 16164 * @returns { T } 16165 * @syscap SystemCapability.ArkUI.ArkUI.Full 16166 * @crossplatform 16167 * @atomicservice 16168 * @since 11 16169 */ 16170 background(builder: CustomBuilder, options?: { align?: Alignment }): T; 16171 16172 /** 16173 * Background color 16174 * 16175 * @param { ResourceColor } value 16176 * @returns { T } 16177 * @syscap SystemCapability.ArkUI.ArkUI.Full 16178 * @since 7 16179 */ 16180 /** 16181 * Background color 16182 * 16183 * @param { ResourceColor } value 16184 * @returns { T } 16185 * @syscap SystemCapability.ArkUI.ArkUI.Full 16186 * @form 16187 * @since 9 16188 */ 16189 /** 16190 * Background color 16191 * 16192 * @param { ResourceColor } value 16193 * @returns { T } 16194 * @syscap SystemCapability.ArkUI.ArkUI.Full 16195 * @crossplatform 16196 * @form 16197 * @since 10 16198 */ 16199 /** 16200 * Background color 16201 * 16202 * @param { ResourceColor } value 16203 * @returns { T } 16204 * @syscap SystemCapability.ArkUI.ArkUI.Full 16205 * @crossplatform 16206 * @form 16207 * @atomicservice 16208 * @since 11 16209 */ 16210 backgroundColor(value: ResourceColor): T; 16211 16212 /** 16213 * PixelRound 16214 * 16215 * @param { PixelRoundPolicy } value - indicates the pixel round policy. 16216 * @returns { T } 16217 * @syscap SystemCapability.ArkUI.ArkUI.Full 16218 * @crossplatform 16219 * @form 16220 * @atomicservice 16221 * @since 11 16222 */ 16223 pixelRound(value: PixelRoundPolicy): T; 16224 16225 /** 16226 * Background image 16227 * src: Image address url 16228 * 16229 * @param { ResourceStr } src 16230 * @param { ImageRepeat } repeat 16231 * @returns { T } 16232 * @syscap SystemCapability.ArkUI.ArkUI.Full 16233 * @since 7 16234 */ 16235 /** 16236 * Background image 16237 * src: Image address url 16238 * 16239 * @param { ResourceStr } src 16240 * @param { ImageRepeat } repeat 16241 * @returns { T } 16242 * @syscap SystemCapability.ArkUI.ArkUI.Full 16243 * @form 16244 * @since 9 16245 */ 16246 /** 16247 * Background image 16248 * src: Image address url 16249 * 16250 * @param { ResourceStr } src 16251 * @param { ImageRepeat } repeat 16252 * @returns { T } 16253 * @syscap SystemCapability.ArkUI.ArkUI.Full 16254 * @crossplatform 16255 * @form 16256 * @since 10 16257 */ 16258 /** 16259 * Background image 16260 * src: Image address url 16261 * 16262 * @param { ResourceStr } src 16263 * @param { ImageRepeat } repeat 16264 * @returns { T } 16265 * @syscap SystemCapability.ArkUI.ArkUI.Full 16266 * @crossplatform 16267 * @form 16268 * @atomicservice 16269 * @since 11 16270 */ 16271 /** 16272 * Background image 16273 * src: Image address url 16274 * 16275 * @param { ResourceStr | PixelMap } src 16276 * @param { ImageRepeat } repeat 16277 * @returns { T } 16278 * @syscap SystemCapability.ArkUI.ArkUI.Full 16279 * @crossplatform 16280 * @form 16281 * @atomicservice 16282 * @since 12 16283 */ 16284 backgroundImage(src: ResourceStr | PixelMap, repeat?: ImageRepeat): T; 16285 16286 /** 16287 * Background image size 16288 * 16289 * @param { SizeOptions | ImageSize } value 16290 * @returns { T } 16291 * @syscap SystemCapability.ArkUI.ArkUI.Full 16292 * @since 7 16293 */ 16294 /** 16295 * Background image size 16296 * 16297 * @param { SizeOptions | ImageSize } value 16298 * @returns { T } 16299 * @syscap SystemCapability.ArkUI.ArkUI.Full 16300 * @form 16301 * @since 9 16302 */ 16303 /** 16304 * Background image size 16305 * 16306 * @param { SizeOptions | ImageSize } value 16307 * @returns { T } 16308 * @syscap SystemCapability.ArkUI.ArkUI.Full 16309 * @crossplatform 16310 * @form 16311 * @since 10 16312 */ 16313 /** 16314 * Background image size 16315 * 16316 * @param { SizeOptions | ImageSize } value 16317 * @returns { T } 16318 * @syscap SystemCapability.ArkUI.ArkUI.Full 16319 * @crossplatform 16320 * @form 16321 * @atomicservice 16322 * @since 11 16323 */ 16324 backgroundImageSize(value: SizeOptions | ImageSize): T; 16325 16326 /** 16327 * Background image position 16328 * x:Horizontal coordinate;y:Vertical axis coordinate. 16329 * 16330 * @param { Position | Alignment } value 16331 * @returns { T } 16332 * @syscap SystemCapability.ArkUI.ArkUI.Full 16333 * @since 7 16334 */ 16335 /** 16336 * Background image position 16337 * x:Horizontal coordinate;y:Vertical axis coordinate. 16338 * 16339 * @param { Position | Alignment } value 16340 * @returns { T } 16341 * @syscap SystemCapability.ArkUI.ArkUI.Full 16342 * @form 16343 * @since 9 16344 */ 16345 /** 16346 * Background image position 16347 * x:Horizontal coordinate;y:Vertical axis coordinate. 16348 * 16349 * @param { Position | Alignment } value 16350 * @returns { T } 16351 * @syscap SystemCapability.ArkUI.ArkUI.Full 16352 * @crossplatform 16353 * @form 16354 * @since 10 16355 */ 16356 /** 16357 * Background image position 16358 * x:Horizontal coordinate;y:Vertical axis coordinate. 16359 * 16360 * @param { Position | Alignment } value 16361 * @returns { T } 16362 * @syscap SystemCapability.ArkUI.ArkUI.Full 16363 * @crossplatform 16364 * @form 16365 * @atomicservice 16366 * @since 11 16367 */ 16368 backgroundImagePosition(value: Position | Alignment): T; 16369 16370 /** 16371 * Background blur style. 16372 * blurStyle:Blur style type. 16373 * 16374 * @param { BlurStyle } value 16375 * @param { BackgroundBlurStyleOptions } options 16376 * @returns { T } 16377 * @syscap SystemCapability.ArkUI.ArkUI.Full 16378 * @form 16379 * @since 9 16380 */ 16381 /** 16382 * Background blur style. 16383 * blurStyle:Blur style type. 16384 * 16385 * @param { BlurStyle } value 16386 * @param { BackgroundBlurStyleOptions } options 16387 * @returns { T } 16388 * @syscap SystemCapability.ArkUI.ArkUI.Full 16389 * @crossplatform 16390 * @form 16391 * @since 10 16392 */ 16393 /** 16394 * Background blur style. 16395 * blurStyle:Blur style type. 16396 * 16397 * @param { BlurStyle } value 16398 * @param { BackgroundBlurStyleOptions } options 16399 * @returns { T } 16400 * @syscap SystemCapability.ArkUI.ArkUI.Full 16401 * @crossplatform 16402 * @form 16403 * @atomicservice 16404 * @since 11 16405 */ 16406 backgroundBlurStyle(value: BlurStyle, options?: BackgroundBlurStyleOptions): T; 16407 16408 /** 16409 * options:background effect options. 16410 * 16411 * @param { BackgroundEffectOptions } options - options indicates the effect options. 16412 * @returns { T } 16413 * @syscap SystemCapability.ArkUI.ArkUI.Full 16414 * @crossplatform 16415 * @since 11 16416 */ 16417 /** 16418 * options:background effect options. 16419 * 16420 * @param { BackgroundEffectOptions } options - options indicates the effect options. 16421 * @returns { T } 16422 * @syscap SystemCapability.ArkUI.ArkUI.Full 16423 * @crossplatform 16424 * @atomicservice 16425 * @since 12 16426 */ 16427 backgroundEffect(options: BackgroundEffectOptions): T; 16428 16429 /** 16430 * Background image resizable. 16431 * value:resizable options 16432 * 16433 * @param { ResizableOptions } value - Indicates the resizable options. 16434 * @returns { T } 16435 * @syscap SystemCapability.ArkUI.ArkUI.Full 16436 * @crossplatform 16437 * @atomicservice 16438 * @since 12 16439 */ 16440 backgroundImageResizable(value: ResizableOptions): T; 16441 16442 /** 16443 * Foreground effect. 16444 * 16445 * @param { ForegroundEffectOptions } options - options indicates the effect options. 16446 * @returns { T } 16447 * @syscap SystemCapability.ArkUI.ArkUI.Full 16448 * @crossplatform 16449 * @atomicservice 16450 * @since 12 16451 */ 16452 foregroundEffect(options: ForegroundEffectOptions): T; 16453 16454 16455 /** 16456 * Unified visual effect interface. 16457 * 16458 * @param { VisualEffect } effect - Visual effect parameters. 16459 * @returns { T } 16460 * @syscap SystemCapability.ArkUI.ArkUI.Full 16461 * @crossplatform 16462 * @atomicservice 16463 * @since 12 16464 */ 16465 visualEffect(effect: VisualEffect): T; 16466 16467 /** 16468 * Filter applied to the background layer of the component. 16469 * 16470 * @param { Filter } filter - Filter effect parameters. 16471 * @returns { T } 16472 * @syscap SystemCapability.ArkUI.ArkUI.Full 16473 * @crossplatform 16474 * @atomicservice 16475 * @since 12 16476 */ 16477 backgroundFilter(filter: Filter): T; 16478 16479 /** 16480 * Filter applied to the foreground layer of the component. 16481 * 16482 * @param { Filter } filter - Filter effect parameters. 16483 * @returns { T } 16484 * @syscap SystemCapability.ArkUI.ArkUI.Full 16485 * @crossplatform 16486 * @atomicservice 16487 * @since 12 16488 */ 16489 foregroundFilter(filter: Filter): T; 16490 16491 /** 16492 * Filter applied to the compositing layer of the component. 16493 * 16494 * @param { Filter } filter - Filter effect parameters. 16495 * @returns { T } 16496 * @syscap SystemCapability.ArkUI.ArkUI.Full 16497 * @crossplatform 16498 * @atomicservice 16499 * @since 12 16500 */ 16501 compositingFilter(filter: Filter): T; 16502 16503 /** 16504 * Foreground blur style. 16505 * blurStyle:Blur style type. 16506 * 16507 * @param { BlurStyle } value 16508 * @param { ForegroundBlurStyleOptions } options 16509 * @returns { T } 16510 * @syscap SystemCapability.ArkUI.ArkUI.Full 16511 * @crossplatform 16512 * @since 10 16513 */ 16514 /** 16515 * Foreground blur style. 16516 * blurStyle:Blur style type. 16517 * 16518 * @param { BlurStyle } value 16519 * @param { ForegroundBlurStyleOptions } options 16520 * @returns { T } 16521 * @syscap SystemCapability.ArkUI.ArkUI.Full 16522 * @crossplatform 16523 * @atomicservice 16524 * @since 11 16525 */ 16526 foregroundBlurStyle(value: BlurStyle, options?: ForegroundBlurStyleOptions): T; 16527 16528 /** 16529 * Opacity 16530 * 16531 * @param { number | Resource } value 16532 * @returns { T } 16533 * @syscap SystemCapability.ArkUI.ArkUI.Full 16534 * @since 7 16535 */ 16536 /** 16537 * Opacity 16538 * 16539 * @param { number | Resource } value 16540 * @returns { T } 16541 * @syscap SystemCapability.ArkUI.ArkUI.Full 16542 * @form 16543 * @since 9 16544 */ 16545 /** 16546 * Opacity 16547 * 16548 * @param { number | Resource } value 16549 * @returns { T } 16550 * @syscap SystemCapability.ArkUI.ArkUI.Full 16551 * @crossplatform 16552 * @form 16553 * @since 10 16554 */ 16555 /** 16556 * Opacity 16557 * 16558 * @param { number | Resource } value 16559 * @returns { T } 16560 * @syscap SystemCapability.ArkUI.ArkUI.Full 16561 * @crossplatform 16562 * @form 16563 * @atomicservice 16564 * @since 11 16565 */ 16566 opacity(value: number | Resource): T; 16567 16568 /** 16569 * Border 16570 * width:Border width;color:Border color;radius:Border radius; 16571 * 16572 * @param { BorderOptions } value 16573 * @returns { T } 16574 * @syscap SystemCapability.ArkUI.ArkUI.Full 16575 * @since 7 16576 */ 16577 /** 16578 * Border 16579 * width:Border width;color:Border color;radius:Border radius; 16580 * 16581 * @param { BorderOptions } value 16582 * @returns { T } 16583 * @syscap SystemCapability.ArkUI.ArkUI.Full 16584 * @form 16585 * @since 9 16586 */ 16587 /** 16588 * Border 16589 * width:Border width;color:Border color;radius:Border radius; 16590 * 16591 * @param { BorderOptions } value 16592 * @returns { T } 16593 * @syscap SystemCapability.ArkUI.ArkUI.Full 16594 * @crossplatform 16595 * @form 16596 * @since 10 16597 */ 16598 /** 16599 * Border 16600 * width:Border width;color:Border color;radius:Border radius; 16601 * 16602 * @param { BorderOptions } value 16603 * @returns { T } 16604 * @syscap SystemCapability.ArkUI.ArkUI.Full 16605 * @crossplatform 16606 * @form 16607 * @atomicservice 16608 * @since 11 16609 */ 16610 border(value: BorderOptions): T; 16611 16612 /** 16613 * Border style 16614 * 16615 * @param { BorderStyle } value 16616 * @returns { T } 16617 * @syscap SystemCapability.ArkUI.ArkUI.Full 16618 * @since 7 16619 */ 16620 /** 16621 * Border style 16622 * 16623 * @param { BorderStyle | EdgeStyles } value 16624 * @returns { T } 16625 * @syscap SystemCapability.ArkUI.ArkUI.Full 16626 * @form 16627 * @since 9 16628 */ 16629 /** 16630 * Border style 16631 * 16632 * @param { BorderStyle | EdgeStyles } value 16633 * @returns { T } 16634 * @syscap SystemCapability.ArkUI.ArkUI.Full 16635 * @crossplatform 16636 * @form 16637 * @since 10 16638 */ 16639 /** 16640 * Border style 16641 * 16642 * @param { BorderStyle | EdgeStyles } value 16643 * @returns { T } 16644 * @syscap SystemCapability.ArkUI.ArkUI.Full 16645 * @crossplatform 16646 * @form 16647 * @atomicservice 16648 * @since 11 16649 */ 16650 borderStyle(value: BorderStyle | EdgeStyles): T; 16651 16652 /** 16653 * Border width 16654 * 16655 * @param { Length } value 16656 * @returns { T } 16657 * @syscap SystemCapability.ArkUI.ArkUI.Full 16658 * @since 7 16659 */ 16660 /** 16661 * Border width 16662 * 16663 * @param { Length | EdgeWidths } value 16664 * @returns { T } 16665 * @syscap SystemCapability.ArkUI.ArkUI.Full 16666 * @form 16667 * @since 9 16668 */ 16669 /** 16670 * Border width 16671 * 16672 * @param { Length | EdgeWidths } value 16673 * @returns { T } 16674 * @syscap SystemCapability.ArkUI.ArkUI.Full 16675 * @crossplatform 16676 * @form 16677 * @since 10 16678 */ 16679 /** 16680 * Border width 16681 * 16682 * @param { Length | EdgeWidths } value 16683 * @returns { T } 16684 * @syscap SystemCapability.ArkUI.ArkUI.Full 16685 * @crossplatform 16686 * @form 16687 * @atomicservice 16688 * @since 11 16689 */ 16690 /** 16691 * Border width 16692 * 16693 * @param { Length | EdgeWidths | LocalizedEdgeWidths } value 16694 * @returns { T } 16695 * @syscap SystemCapability.ArkUI.ArkUI.Full 16696 * @crossplatform 16697 * @form 16698 * @atomicservice 16699 * @since 12 16700 */ 16701 borderWidth(value: Length | EdgeWidths | LocalizedEdgeWidths): T; 16702 16703 /** 16704 * Border color 16705 * 16706 * @param { ResourceColor } value 16707 * @returns { T } 16708 * @syscap SystemCapability.ArkUI.ArkUI.Full 16709 * @since 7 16710 */ 16711 /** 16712 * Border color 16713 * 16714 * @param { ResourceColor | EdgeColors } value 16715 * @returns { T } 16716 * @syscap SystemCapability.ArkUI.ArkUI.Full 16717 * @form 16718 * @since 9 16719 */ 16720 /** 16721 * Border color 16722 * 16723 * @param { ResourceColor | EdgeColors } value 16724 * @returns { T } 16725 * @syscap SystemCapability.ArkUI.ArkUI.Full 16726 * @crossplatform 16727 * @form 16728 * @since 10 16729 */ 16730 /** 16731 * Border color 16732 * 16733 * @param { ResourceColor | EdgeColors } value 16734 * @returns { T } 16735 * @syscap SystemCapability.ArkUI.ArkUI.Full 16736 * @crossplatform 16737 * @form 16738 * @atomicservice 16739 * @since 11 16740 */ 16741 /** 16742 * Border color 16743 * 16744 * @param { ResourceColor | EdgeColors | LocalizedEdgeColors } value 16745 * @returns { T } 16746 * @syscap SystemCapability.ArkUI.ArkUI.Full 16747 * @crossplatform 16748 * @form 16749 * @atomicservice 16750 * @since 12 16751 */ 16752 borderColor(value: ResourceColor | EdgeColors | LocalizedEdgeColors): T; 16753 16754 /** 16755 * Border radius 16756 * 16757 * @param { Length } value 16758 * @returns { T } 16759 * @syscap SystemCapability.ArkUI.ArkUI.Full 16760 * @since 7 16761 */ 16762 /** 16763 * Border radius 16764 * 16765 * @param { Length | BorderRadiuses } value 16766 * @returns { T } 16767 * @syscap SystemCapability.ArkUI.ArkUI.Full 16768 * @form 16769 * @since 9 16770 */ 16771 /** 16772 * Border radius 16773 * 16774 * @param { Length | BorderRadiuses } value 16775 * @returns { T } 16776 * @syscap SystemCapability.ArkUI.ArkUI.Full 16777 * @crossplatform 16778 * @form 16779 * @since 10 16780 */ 16781 /** 16782 * Border radius 16783 * 16784 * @param { Length | BorderRadiuses } value 16785 * @returns { T } 16786 * @syscap SystemCapability.ArkUI.ArkUI.Full 16787 * @crossplatform 16788 * @form 16789 * @atomicservice 16790 * @since 11 16791 */ 16792 /** 16793 * Border radius 16794 * 16795 * @param { Length | BorderRadiuses | LocalizedBorderRadiuses } value 16796 * @returns { T } 16797 * @syscap SystemCapability.ArkUI.ArkUI.Full 16798 * @crossplatform 16799 * @form 16800 * @atomicservice 16801 * @since 12 16802 */ 16803 borderRadius(value: Length | BorderRadiuses | LocalizedBorderRadiuses): T; 16804 16805 /** 16806 * Border image 16807 * 16808 * @param { BorderImageOption } value 16809 * @returns { T } 16810 * @syscap SystemCapability.ArkUI.ArkUI.Full 16811 * @form 16812 * @since 9 16813 */ 16814 /** 16815 * Border image 16816 * 16817 * @param { BorderImageOption } value 16818 * @returns { T } 16819 * @syscap SystemCapability.ArkUI.ArkUI.Full 16820 * @crossplatform 16821 * @form 16822 * @since 10 16823 */ 16824 /** 16825 * Border image 16826 * 16827 * @param { BorderImageOption } value 16828 * @returns { T } 16829 * @syscap SystemCapability.ArkUI.ArkUI.Full 16830 * @crossplatform 16831 * @form 16832 * @atomicservice 16833 * @since 11 16834 */ 16835 borderImage(value: BorderImageOption): T; 16836 16837 /** 16838 * Outline 16839 * width:Outline width;color:Outline color;radius:Outline radius;style:Outline style; 16840 * 16841 * @param { OutlineOptions } value 16842 * @returns { T } 16843 * @syscap SystemCapability.ArkUI.ArkUI.Full 16844 * @crossplatform 16845 * @form 16846 * @since 11 16847 */ 16848 /** 16849 * Outline 16850 * width:Outline width;color:Outline color;radius:Outline radius;style:Outline style; 16851 * 16852 * @param { OutlineOptions } value 16853 * @returns { T } 16854 * @syscap SystemCapability.ArkUI.ArkUI.Full 16855 * @crossplatform 16856 * @form 16857 * @atomicservice 16858 * @since 12 16859 */ 16860 outline(value: OutlineOptions): T; 16861 16862 /** 16863 * Outline style 16864 * The input parameter default value is OutlineStyle.SOLID 16865 * 16866 * @param { OutlineStyle | EdgeOutlineStyles } value 16867 * @returns { T } 16868 * @syscap SystemCapability.ArkUI.ArkUI.Full 16869 * @crossplatform 16870 * @form 16871 * @since 11 16872 */ 16873 /** 16874 * Outline style 16875 * 16876 * @param { OutlineStyle | EdgeOutlineStyles } value 16877 * @returns { T } 16878 * @syscap SystemCapability.ArkUI.ArkUI.Full 16879 * @crossplatform 16880 * @form 16881 * @atomicservice 16882 * @since 12 16883 */ 16884 outlineStyle(value: OutlineStyle | EdgeOutlineStyles): T; 16885 16886 /** 16887 * Outline width 16888 * The input parameter default value is 0 16889 * 16890 * @param { Dimension | EdgeOutlineWidths } value 16891 * @returns { T } 16892 * @syscap SystemCapability.ArkUI.ArkUI.Full 16893 * @crossplatform 16894 * @form 16895 * @since 11 16896 */ 16897 /** 16898 * Outline width 16899 * 16900 * @param { Dimension | EdgeOutlineWidths } value 16901 * @returns { T } 16902 * @syscap SystemCapability.ArkUI.ArkUI.Full 16903 * @crossplatform 16904 * @form 16905 * @atomicservice 16906 * @since 12 16907 */ 16908 outlineWidth(value: Dimension | EdgeOutlineWidths): T; 16909 16910 /** 16911 * Outline color 16912 * The input parameter default value is Color.Black 16913 * 16914 * @param { ResourceColor | EdgeColors } value 16915 * @returns { T } 16916 * @syscap SystemCapability.ArkUI.ArkUI.Full 16917 * @crossplatform 16918 * @form 16919 * @since 11 16920 */ 16921 /** 16922 * Outline color 16923 * 16924 * @param { ResourceColor | EdgeColors | LocalizedEdgeColors } value 16925 * @returns { T } 16926 * @syscap SystemCapability.ArkUI.ArkUI.Full 16927 * @crossplatform 16928 * @form 16929 * @atomicservice 16930 * @since 12 16931 */ 16932 outlineColor(value: ResourceColor | EdgeColors | LocalizedEdgeColors): T; 16933 16934 /** 16935 * Outline radius 16936 * The input parameter default value is 0 16937 * 16938 * @param { Dimension | OutlineRadiuses } value 16939 * @returns { T } 16940 * @syscap SystemCapability.ArkUI.ArkUI.Full 16941 * @crossplatform 16942 * @form 16943 * @since 11 16944 */ 16945 /** 16946 * Outline radius 16947 * 16948 * @param { Dimension | OutlineRadiuses } value 16949 * @returns { T } 16950 * @syscap SystemCapability.ArkUI.ArkUI.Full 16951 * @crossplatform 16952 * @form 16953 * @atomicservice 16954 * @since 12 16955 */ 16956 outlineRadius(value: Dimension | OutlineRadiuses): T; 16957 16958 /** 16959 * Provides the general foreground color capability of UI components, and assigns color values 16960 * according to the characteristics of components. 16961 * 16962 * @param { ResourceColor | ColoringStrategy } value - indicates the color or color selection strategy 16963 * @returns { T } 16964 * @syscap SystemCapability.ArkUI.ArkUI.Full 16965 * @crossplatform 16966 * @since 10 16967 */ 16968 /** 16969 * Provides the general foreground color capability of UI components, and assigns color values 16970 * according to the characteristics of components. 16971 * 16972 * @param { ResourceColor | ColoringStrategy } value - indicates the color or color selection strategy 16973 * @returns { T } 16974 * @syscap SystemCapability.ArkUI.ArkUI.Full 16975 * @crossplatform 16976 * @atomicservice 16977 * @since 11 16978 */ 16979 foregroundColor(value: ResourceColor | ColoringStrategy): T; 16980 16981 /** 16982 * Trigger a click event when a click is clicked. 16983 * 16984 * @param { function } event 16985 * @returns { T } 16986 * @syscap SystemCapability.ArkUI.ArkUI.Full 16987 * @since 7 16988 */ 16989 /** 16990 * Trigger a click event when a click is clicked. 16991 * 16992 * @param { function } event 16993 * @returns { T } 16994 * @syscap SystemCapability.ArkUI.ArkUI.Full 16995 * @form 16996 * @since 9 16997 */ 16998 /** 16999 * Trigger a click event when a click is clicked. 17000 * 17001 * @param { function } event 17002 * @returns { T } 17003 * @syscap SystemCapability.ArkUI.ArkUI.Full 17004 * @crossplatform 17005 * @form 17006 * @since 10 17007 */ 17008 /** 17009 * Trigger a click event when a click is clicked. 17010 * 17011 * @param { function } event 17012 * @returns { T } 17013 * @syscap SystemCapability.ArkUI.ArkUI.Full 17014 * @crossplatform 17015 * @form 17016 * @atomicservice 17017 * @since 11 17018 */ 17019 onClick(event: (event: ClickEvent) => void): T; 17020 17021 /** 17022 * Trigger a click event when a click is clicked, move distance should smaller than distanceThreshold. 17023 * 17024 * @param { function } event - this function callback executed when the click action is recognized 17025 * @param { number } distanceThreshold - the distance threshold of finger's movement when detecting a click action 17026 * @returns { T } 17027 * @syscap SystemCapability.ArkUI.ArkUI.Full 17028 * @crossplatform 17029 * @form 17030 * @atomicservice 17031 * @since 12 17032 */ 17033 onClick(event: Callback<ClickEvent>, distanceThreshold: number): T; 17034 17035 /** 17036 * Trigger a hover event. 17037 * 17038 * @param { function } event 17039 * @returns { T } 17040 * @syscap SystemCapability.ArkUI.ArkUI.Full 17041 * @since 8 17042 */ 17043 /** 17044 * Trigger a hover event. 17045 * 17046 * @param { function } event 17047 * @returns { T } 17048 * @syscap SystemCapability.ArkUI.ArkUI.Full 17049 * @crossplatform 17050 * @atomicservice 17051 * @since 11 17052 */ 17053 onHover(event: (isHover: boolean, event: HoverEvent) => void): T; 17054 17055 /** 17056 * Trigger a hover move event. 17057 * 17058 * @param { Callback<HoverEvent> } event 17059 * @returns { T } 17060 * @syscap SystemCapability.ArkUI.ArkUI.Full 17061 * @crossplatform 17062 * @atomicservice 17063 * @since 15 17064 */ 17065 onHoverMove(event: Callback<HoverEvent>): T; 17066 17067 /** 17068 * Trigger a accessibility hover event. 17069 * 17070 * @param { AccessibilityCallback } callback - A callback instance used when the component is touched after accessibility mode is enabled. 17071 * @returns { T } 17072 * @syscap SystemCapability.ArkUI.ArkUI.Full 17073 * @crossplatform 17074 * @atomicservice 17075 * @since 12 17076 */ 17077 onAccessibilityHover(callback: AccessibilityCallback): T; 17078 17079 /** 17080 * Set hover effect. 17081 * 17082 * @param { HoverEffect } value 17083 * @returns { T } 17084 * @syscap SystemCapability.ArkUI.ArkUI.Full 17085 * @since 8 17086 */ 17087 /** 17088 * Set hover effect. 17089 * 17090 * @param { HoverEffect } value 17091 * @returns { T } 17092 * @syscap SystemCapability.ArkUI.ArkUI.Full 17093 * @crossplatform 17094 * @since 10 17095 */ 17096 /** 17097 * Set hover effect. 17098 * 17099 * @param { HoverEffect } value 17100 * @returns { T } 17101 * @syscap SystemCapability.ArkUI.ArkUI.Full 17102 * @crossplatform 17103 * @atomicservice 17104 * @since 11 17105 */ 17106 hoverEffect(value: HoverEffect): T; 17107 17108 /** 17109 * Trigger a mouse event. 17110 * 17111 * @param { function } event 17112 * @returns { T } 17113 * @syscap SystemCapability.ArkUI.ArkUI.Full 17114 * @since 8 17115 */ 17116 /** 17117 * Trigger a mouse event. 17118 * 17119 * @param { function } event 17120 * @returns { T } 17121 * @syscap SystemCapability.ArkUI.ArkUI.Full 17122 * @atomicservice 17123 * @since 11 17124 */ 17125 onMouse(event: (event: MouseEvent) => void): T; 17126 17127 /** 17128 * Trigger a touch event when touched. 17129 * 17130 * @param { function } event 17131 * @returns { T } 17132 * @syscap SystemCapability.ArkUI.ArkUI.Full 17133 * @since 7 17134 */ 17135 /** 17136 * Trigger a touch event when touched. 17137 * 17138 * @param { function } event 17139 * @returns { T } 17140 * @syscap SystemCapability.ArkUI.ArkUI.Full 17141 * @crossplatform 17142 * @since 10 17143 */ 17144 /** 17145 * Trigger a touch event when touched. 17146 * 17147 * @param { function } event 17148 * @returns { T } 17149 * @syscap SystemCapability.ArkUI.ArkUI.Full 17150 * @crossplatform 17151 * @atomicservice 17152 * @since 11 17153 */ 17154 onTouch(event: (event: TouchEvent) => void): T; 17155 17156 /** 17157 * Keyboard input 17158 * 17159 * @param { function } event 17160 * @returns { T } 17161 * @syscap SystemCapability.ArkUI.ArkUI.Full 17162 * @since 7 17163 */ 17164 /** 17165 * Keyboard input 17166 * 17167 * @param { function } event 17168 * @returns { T } 17169 * @syscap SystemCapability.ArkUI.ArkUI.Full 17170 * @crossplatform 17171 * @since 10 17172 */ 17173 /** 17174 * Keyboard input 17175 * 17176 * @param { function } event 17177 * @returns { T } 17178 * @syscap SystemCapability.ArkUI.ArkUI.Full 17179 * @crossplatform 17180 * @atomicservice 17181 * @since 11 17182 */ 17183 onKeyEvent(event: (event: KeyEvent) => void): T; 17184 17185 /** 17186 * Keyboard input 17187 * 17188 * @param { Callback<KeyEvent, boolean> } event 17189 * @returns { T } 17190 * @syscap SystemCapability.ArkUI.ArkUI.Full 17191 * @crossplatform 17192 * @atomicservice 17193 * @since 15 17194 */ 17195 onKeyEvent(event: Callback<KeyEvent, boolean>): T; 17196 17197 /** 17198 * Handle keyboard events before input method events. 17199 * 17200 * @param { Callback<KeyEvent, boolean> } event 17201 * @returns { T } 17202 * @syscap SystemCapability.ArkUI.ArkUI.Full 17203 * @crossplatform 17204 * @atomicservice 17205 * @since 12 17206 */ 17207 onKeyPreIme(event: Callback<KeyEvent, boolean>): T; 17208 17209 /** 17210 * Trigger a FocusAxisEvent. 17211 * 17212 * @param { Callback<FocusAxisEvent> } event 17213 * @returns { T } 17214 * @syscap SystemCapability.ArkUI.ArkUI.Full 17215 * @atomicservice 17216 * @since 15 17217 */ 17218 onFocusAxisEvent(event: Callback<FocusAxisEvent>): T; 17219 17220 /** 17221 * Customize the handling and distribution of key events. 17222 * 17223 * @param { Callback<KeyEvent, boolean> } event 17224 * @returns { T } 17225 * @syscap SystemCapability.ArkUI.ArkUI.Full 17226 * @crossplatform 17227 * @atomicservice 17228 * @since 15 17229 */ 17230 onKeyEventDispatch(event: Callback<KeyEvent, boolean>): T; 17231 17232 /** 17233 * Set focusable. 17234 * 17235 * @param { boolean } value 17236 * @returns { T } 17237 * @syscap SystemCapability.ArkUI.ArkUI.Full 17238 * @since 8 17239 */ 17240 /** 17241 * Set focusable. 17242 * 17243 * @param { boolean } value 17244 * @returns { T } 17245 * @syscap SystemCapability.ArkUI.ArkUI.Full 17246 * @crossplatform 17247 * @since 10 17248 */ 17249 /** 17250 * Set focusable. 17251 * 17252 * @param { boolean } value 17253 * @returns { T } 17254 * @syscap SystemCapability.ArkUI.ArkUI.Full 17255 * @crossplatform 17256 * @atomicservice 17257 * @since 11 17258 */ 17259 focusable(value: boolean): T; 17260 17261 /** 17262 * Set TabStop on component focus 17263 * 17264 * @param { boolean } isTabStop 17265 * @returns { T } 17266 * @syscap SystemCapability.ArkUI.ArkUI.Full 17267 * @crossplatform 17268 * @atomicservice 17269 * @since 14 17270 */ 17271 tabStop(isTabStop: boolean): T; 17272 17273 /** 17274 * Trigger a event when got focus. 17275 * 17276 * @param { function } event 17277 * @returns { T } 17278 * @syscap SystemCapability.ArkUI.ArkUI.Full 17279 * @since 8 17280 */ 17281 /** 17282 * Trigger a event when got focus. 17283 * 17284 * @param { function } event 17285 * @returns { T } 17286 * @syscap SystemCapability.ArkUI.ArkUI.Full 17287 * @crossplatform 17288 * @since 10 17289 */ 17290 /** 17291 * Trigger a event when got focus. 17292 * 17293 * @param { function } event 17294 * @returns { T } 17295 * @syscap SystemCapability.ArkUI.ArkUI.Full 17296 * @crossplatform 17297 * @atomicservice 17298 * @since 11 17299 */ 17300 onFocus(event: () => void): T; 17301 17302 /** 17303 * Trigger a event when lose focus. 17304 * 17305 * @param { function } event 17306 * @returns { T } 17307 * @syscap SystemCapability.ArkUI.ArkUI.Full 17308 * @since 8 17309 */ 17310 /** 17311 * Trigger a event when lose focus. 17312 * 17313 * @param { function } event 17314 * @returns { T } 17315 * @syscap SystemCapability.ArkUI.ArkUI.Full 17316 * @crossplatform 17317 * @since 10 17318 */ 17319 /** 17320 * Trigger a event when lose focus. 17321 * 17322 * @param { function } event 17323 * @returns { T } 17324 * @syscap SystemCapability.ArkUI.ArkUI.Full 17325 * @crossplatform 17326 * @atomicservice 17327 * @since 11 17328 */ 17329 onBlur(event: () => void): T; 17330 17331 /** 17332 * Set focus index by key tab. 17333 * 17334 * @param { number } index 17335 * @returns { T } 17336 * @syscap SystemCapability.ArkUI.ArkUI.Full 17337 * @since 9 17338 */ 17339 /** 17340 * Set focus index by key tab. 17341 * 17342 * @param { number } index 17343 * @returns { T } 17344 * @syscap SystemCapability.ArkUI.ArkUI.Full 17345 * @crossplatform 17346 * @since 10 17347 */ 17348 /** 17349 * Set focus index by key tab. 17350 * 17351 * @param { number } index 17352 * @returns { T } 17353 * @syscap SystemCapability.ArkUI.ArkUI.Full 17354 * @crossplatform 17355 * @atomicservice 17356 * @since 11 17357 */ 17358 tabIndex(index: number): T; 17359 17360 /** 17361 * Set default focused component when a page create. 17362 * 17363 * @param { boolean } value 17364 * @returns { T } 17365 * @syscap SystemCapability.ArkUI.ArkUI.Full 17366 * @since 9 17367 */ 17368 /** 17369 * Set default focused component when a page create. 17370 * 17371 * @param { boolean } value 17372 * @returns { T } 17373 * @syscap SystemCapability.ArkUI.ArkUI.Full 17374 * @crossplatform 17375 * @since 10 17376 */ 17377 /** 17378 * Set default focused component when a page create. 17379 * 17380 * @param { boolean } value 17381 * @returns { T } 17382 * @syscap SystemCapability.ArkUI.ArkUI.Full 17383 * @crossplatform 17384 * @atomicservice 17385 * @since 11 17386 */ 17387 defaultFocus(value: boolean): T; 17388 17389 /** 17390 * Set default focused component when focus on a focus group. 17391 * 17392 * @param { boolean } value 17393 * @returns { T } 17394 * @syscap SystemCapability.ArkUI.ArkUI.Full 17395 * @since 9 17396 */ 17397 /** 17398 * Set default focused component when focus on a focus group. 17399 * 17400 * @param { boolean } value 17401 * @returns { T } 17402 * @syscap SystemCapability.ArkUI.ArkUI.Full 17403 * @crossplatform 17404 * @since 10 17405 */ 17406 /** 17407 * Set default focused component when focus on a focus group. 17408 * 17409 * @param { boolean } value 17410 * @returns { T } 17411 * @syscap SystemCapability.ArkUI.ArkUI.Full 17412 * @crossplatform 17413 * @atomicservice 17414 * @since 11 17415 */ 17416 groupDefaultFocus(value: boolean): T; 17417 17418 /** 17419 * Set a component focused when the component be touched. 17420 * 17421 * @param { boolean } value 17422 * @returns { T } 17423 * @syscap SystemCapability.ArkUI.ArkUI.Full 17424 * @since 9 17425 */ 17426 /** 17427 * Set a component focused when the component be touched. 17428 * 17429 * @param { boolean } value 17430 * @returns { T } 17431 * @syscap SystemCapability.ArkUI.ArkUI.Full 17432 * @crossplatform 17433 * @since 10 17434 */ 17435 /** 17436 * Set a component focused when the component be touched. 17437 * 17438 * @param { boolean } value 17439 * @returns { T } 17440 * @syscap SystemCapability.ArkUI.ArkUI.Full 17441 * @crossplatform 17442 * @atomicservice 17443 * @since 11 17444 */ 17445 focusOnTouch(value: boolean): T; 17446 17447 /** 17448 * Set the component's focusBox style. 17449 * 17450 * @param { FocusBoxStyle } style 17451 * @returns { T } 17452 * @syscap SystemCapability.ArkUI.ArkUI.Full 17453 * @crossplatform 17454 * @atomicservice 17455 * @since 12 17456 */ 17457 focusBox(style: FocusBoxStyle): T; 17458 17459 /** 17460 * Set container as a focus group with a specific identifier. 17461 * 17462 * @param { string } id - focus scope identifier. 17463 * @param { boolean } [isGroup] - whether this scope is a focus group, the default value is false 17464 * @returns { T } 17465 * @syscap SystemCapability.ArkUI.ArkUI.Full 17466 * @crossplatform 17467 * @atomicservice 17468 * @since 12 17469 */ 17470 focusScopeId(id: string, isGroup?: boolean): T; 17471 /** 17472 * Set container as a focus group with a specific identifier. 17473 * 17474 * @param { string } id - focus scope identifier. 17475 * @param { boolean } [isGroup] - whether this scope is a focus group, the default value is false. 17476 * @param { boolean } [arrowStepOut] - whether the arrow keys can move focus from inside the focus group to outside, 17477 * only effective when isGroup is true, the default value is true. 17478 * @returns { T } 17479 * @syscap SystemCapability.ArkUI.ArkUI.Full 17480 * @crossplatform 17481 * @atomicservice 17482 * @since 14 17483 */ 17484 focusScopeId(id: string, isGroup?: boolean, arrowStepOut?: boolean): T; 17485 17486 /** 17487 * Set the focus priority of component in a specific focus scope. 17488 * 17489 * @param { string } scopeId 17490 * @param { FocusPriority } [priority] - the default value is AUTO 17491 * @returns { T } 17492 * @syscap SystemCapability.ArkUI.ArkUI.Full 17493 * @crossplatform 17494 * @atomicservice 17495 * @since 12 17496 */ 17497 focusScopePriority(scopeId: string, priority?: FocusPriority): T; 17498 17499 /** 17500 * animation 17501 * 17502 * @param { AnimateParam } value 17503 * @returns { T } 17504 * @syscap SystemCapability.ArkUI.ArkUI.Full 17505 * @since 7 17506 */ 17507 /** 17508 * animation 17509 * 17510 * @param { AnimateParam } value 17511 * @returns { T } 17512 * @syscap SystemCapability.ArkUI.ArkUI.Full 17513 * @form 17514 * @since 9 17515 */ 17516 /** 17517 * animation 17518 * 17519 * @param { AnimateParam } value 17520 * @returns { T } 17521 * @syscap SystemCapability.ArkUI.ArkUI.Full 17522 * @crossplatform 17523 * @form 17524 * @since 10 17525 */ 17526 /** 17527 * animation 17528 * 17529 * @param { AnimateParam } value 17530 * @returns { T } 17531 * @syscap SystemCapability.ArkUI.ArkUI.Full 17532 * @crossplatform 17533 * @form 17534 * @atomicservice 17535 * @since 11 17536 */ 17537 animation(value: AnimateParam): T; 17538 17539 /** 17540 * Transition parameter 17541 * 17542 * @param { TransitionOptions | TransitionEffect } value 17543 * @returns { T } 17544 * @syscap SystemCapability.ArkUI.ArkUI.Full 17545 * @since 7 17546 */ 17547 /** 17548 * Transition parameter 17549 * 17550 * @param { TransitionOptions | TransitionEffect } value - transition options 17551 * @returns { T } 17552 * @syscap SystemCapability.ArkUI.ArkUI.Full 17553 * @form 17554 * @since 9 17555 */ 17556 /** 17557 * Transition parameter 17558 * 17559 * @param { TransitionOptions | TransitionEffect } value - transition options or transition effect 17560 * @returns { T } 17561 * @syscap SystemCapability.ArkUI.ArkUI.Full 17562 * @crossplatform 17563 * @form 17564 * @since 10 17565 */ 17566 /** 17567 * Transition parameter 17568 * 17569 * @param { TransitionOptions | TransitionEffect } value - transition options or transition effect 17570 * @returns { T } 17571 * @syscap SystemCapability.ArkUI.ArkUI.Full 17572 * @crossplatform 17573 * @form 17574 * @atomicservice 17575 * @since 11 17576 */ 17577 transition(value: TransitionOptions | TransitionEffect): T; 17578 17579 /** 17580 * Set the transition effect of component when it appears and disappears. 17581 * 17582 * @param { TransitionEffect } effect - transition effect 17583 * @param { Optional<TransitionFinishCallback> } onFinish - transition finish callback. 17584 * @returns { T } 17585 * @syscap SystemCapability.ArkUI.ArkUI.Full 17586 * @crossplatform 17587 * @form 17588 * @atomicservice 17589 * @since 12 17590 */ 17591 transition(effect: TransitionEffect, onFinish: Optional<TransitionFinishCallback>): T; 17592 17593 /** 17594 * Bind gesture recognition. 17595 * gesture:Bound Gesture Type,mask:GestureMask; 17596 * 17597 * @param { GestureType } gesture 17598 * @param { GestureMask } mask 17599 * @returns { T } 17600 * @syscap SystemCapability.ArkUI.ArkUI.Full 17601 * @since 7 17602 */ 17603 /** 17604 * Bind gesture recognition. 17605 * gesture:Bound Gesture Type,mask:GestureMask; 17606 * 17607 * @param { GestureType } gesture 17608 * @param { GestureMask } mask 17609 * @returns { T } 17610 * @syscap SystemCapability.ArkUI.ArkUI.Full 17611 * @crossplatform 17612 * @since 10 17613 */ 17614 /** 17615 * Bind gesture recognition. 17616 * gesture:Bound Gesture Type,mask:GestureMask; 17617 * 17618 * @param { GestureType } gesture 17619 * @param { GestureMask } mask 17620 * @returns { T } 17621 * @syscap SystemCapability.ArkUI.ArkUI.Full 17622 * @crossplatform 17623 * @atomicservice 17624 * @since 11 17625 */ 17626 gesture(gesture: GestureType, mask?: GestureMask): T; 17627 17628 /** 17629 * Binding Preferential Recognition Gestures 17630 * gesture:Bound Gesture Type,mask:GestureMask; 17631 * 17632 * @param { GestureType } gesture 17633 * @param { GestureMask } mask 17634 * @returns { T } 17635 * @syscap SystemCapability.ArkUI.ArkUI.Full 17636 * @since 7 17637 */ 17638 /** 17639 * Binding Preferential Recognition Gestures 17640 * gesture:Bound Gesture Type,mask:GestureMask; 17641 * 17642 * @param { GestureType } gesture 17643 * @param { GestureMask } mask 17644 * @returns { T } 17645 * @syscap SystemCapability.ArkUI.ArkUI.Full 17646 * @crossplatform 17647 * @since 10 17648 */ 17649 /** 17650 * Binding Preferential Recognition Gestures 17651 * gesture:Bound Gesture Type,mask:GestureMask; 17652 * 17653 * @param { GestureType } gesture 17654 * @param { GestureMask } mask 17655 * @returns { T } 17656 * @syscap SystemCapability.ArkUI.ArkUI.Full 17657 * @crossplatform 17658 * @atomicservice 17659 * @since 11 17660 */ 17661 priorityGesture(gesture: GestureType, mask?: GestureMask): T; 17662 17663 /** 17664 * Binding gestures that can be triggered simultaneously with internal component gestures 17665 * gesture:Bound Gesture Type,mask:GestureMask; 17666 * 17667 * @param { GestureType } gesture 17668 * @param { GestureMask } mask 17669 * @returns { T } 17670 * @syscap SystemCapability.ArkUI.ArkUI.Full 17671 * @since 7 17672 */ 17673 /** 17674 * Binding gestures that can be triggered simultaneously with internal component gestures 17675 * gesture:Bound Gesture Type,mask:GestureMask; 17676 * 17677 * @param { GestureType } gesture 17678 * @param { GestureMask } mask 17679 * @returns { T } 17680 * @syscap SystemCapability.ArkUI.ArkUI.Full 17681 * @crossplatform 17682 * @since 10 17683 */ 17684 /** 17685 * Binding gestures that can be triggered simultaneously with internal component gestures 17686 * gesture:Bound Gesture Type,mask:GestureMask; 17687 * 17688 * @param { GestureType } gesture 17689 * @param { GestureMask } mask 17690 * @returns { T } 17691 * @syscap SystemCapability.ArkUI.ArkUI.Full 17692 * @crossplatform 17693 * @atomicservice 17694 * @since 11 17695 */ 17696 parallelGesture(gesture: GestureType, mask?: GestureMask): T; 17697 17698 /** 17699 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 17700 * The larger the blurring radius, the more blurring the content. 17701 * If the value is 0, the content blurring effect is not blurring. 17702 * 17703 * @param { number } value 17704 * @returns { T } 17705 * @syscap SystemCapability.ArkUI.ArkUI.Full 17706 * @since 7 17707 */ 17708 /** 17709 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 17710 * The larger the blurring radius, the more blurring the content. 17711 * If the value is 0, the content blurring effect is not blurring. 17712 * 17713 * @param { number } value 17714 * @returns { T } 17715 * @syscap SystemCapability.ArkUI.ArkUI.Full 17716 * @form 17717 * @since 9 17718 */ 17719 /** 17720 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 17721 * The larger the blurring radius, the more blurring the content. 17722 * If the value is 0, the content blurring effect is not blurring. 17723 * 17724 * @param { number } value 17725 * @returns { T } 17726 * @syscap SystemCapability.ArkUI.ArkUI.Full 17727 * @crossplatform 17728 * @form 17729 * @since 10 17730 */ 17731 /** 17732 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 17733 * The larger the blurring radius, the more blurring the content. 17734 * If the value is 0, the content blurring effect is not blurring. 17735 * 17736 * @param { number } value - value indicates radius of backdrop blur. 17737 * @param { BlurOptions } [options] - options indicates blur options. 17738 * @returns { T } 17739 * @syscap SystemCapability.ArkUI.ArkUI.Full 17740 * @crossplatform 17741 * @form 17742 * @atomicservice 17743 * @since 11 17744 */ 17745 blur(value: number, options?: BlurOptions): T; 17746 17747 /** 17748 * Adds the content linear gradient blurring effect for the current component. The input parameter is the blurring radius. 17749 * 17750 * @param { number } value - the blurring radius. 17751 * The larger the blurring radius, the more blurring the content, and if the value is 0, the content blurring effect is not blurring. 17752 * @param { LinearGradientBlurOptions } options - the linear gradient blur options. 17753 * @returns { T } 17754 * @syscap SystemCapability.ArkUI.ArkUI.Full 17755 * @atomicservice 17756 * @since 12 17757 */ 17758 linearGradientBlur(value: number, options: LinearGradientBlurOptions): T; 17759 17760 /** 17761 * Component motion blur interface. 17762 * 17763 * @param { MotionBlurOptions } value - the attributes of motion blur. 17764 * @returns { T } 17765 * @syscap SystemCapability.ArkUI.ArkUI.Full 17766 * @crossplatform 17767 * @atomicservice 17768 * @since 12 17769 */ 17770 motionBlur(value: MotionBlurOptions):T; 17771 17772 /** 17773 * Adds a highlight effect to the current component. 17774 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 17775 * The component is displayed as all white (percentage). 17776 * 17777 * @param { number } value 17778 * @returns { T } 17779 * @syscap SystemCapability.ArkUI.ArkUI.Full 17780 * @since 7 17781 */ 17782 /** 17783 * Adds a highlight effect to the current component. 17784 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 17785 * The component is displayed as all white (percentage). 17786 * 17787 * @param { number } value 17788 * @returns { T } 17789 * @syscap SystemCapability.ArkUI.ArkUI.Full 17790 * @form 17791 * @since 9 17792 */ 17793 /** 17794 * Adds a highlight effect to the current component. 17795 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 17796 * The component is displayed as all white (percentage). 17797 * 17798 * @param { number } value 17799 * @returns { T } 17800 * @syscap SystemCapability.ArkUI.ArkUI.Full 17801 * @crossplatform 17802 * @form 17803 * @since 10 17804 */ 17805 /** 17806 * Adds a highlight effect to the current component. 17807 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 17808 * The component is displayed as all white (percentage). 17809 * 17810 * @param { number } value 17811 * @returns { T } 17812 * @syscap SystemCapability.ArkUI.ArkUI.Full 17813 * @crossplatform 17814 * @form 17815 * @atomicservice 17816 * @since 11 17817 */ 17818 brightness(value: number): T; 17819 17820 /** 17821 * Adds a contrast effect to the current component. The input parameter is the contrast value. 17822 * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) 17823 * 17824 * @param { number } value 17825 * @returns { T } 17826 * @syscap SystemCapability.ArkUI.ArkUI.Full 17827 * @since 7 17828 */ 17829 /** 17830 * Adds a contrast effect to the current component. The input parameter is the contrast value. 17831 * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) 17832 * 17833 * @param { number } value 17834 * @returns { T } 17835 * @syscap SystemCapability.ArkUI.ArkUI.Full 17836 * @form 17837 * @since 9 17838 */ 17839 /** 17840 * Adds a contrast effect to the current component. The input parameter is the contrast value. 17841 * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) 17842 * 17843 * @param { number } value 17844 * @returns { T } 17845 * @syscap SystemCapability.ArkUI.ArkUI.Full 17846 * @crossplatform 17847 * @form 17848 * @since 10 17849 */ 17850 /** 17851 * Adds a contrast effect to the current component. The input parameter is the contrast value. 17852 * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) 17853 * 17854 * @param { number } value 17855 * @returns { T } 17856 * @syscap SystemCapability.ArkUI.ArkUI.Full 17857 * @crossplatform 17858 * @form 17859 * @atomicservice 17860 * @since 11 17861 */ 17862 contrast(value: number): T; 17863 17864 /** 17865 * Adds a grayscale effect to the current component. 17866 * 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. 17867 * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) 17868 * 17869 * @param { number } value 17870 * @returns { T } 17871 * @syscap SystemCapability.ArkUI.ArkUI.Full 17872 * @since 7 17873 */ 17874 /** 17875 * Adds a grayscale effect to the current component. 17876 * 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. 17877 * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) 17878 * 17879 * @param { number } value 17880 * @returns { T } 17881 * @syscap SystemCapability.ArkUI.ArkUI.Full 17882 * @form 17883 * @since 9 17884 */ 17885 /** 17886 * Adds a grayscale effect to the current component. 17887 * 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. 17888 * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) 17889 * 17890 * @param { number } value 17891 * @returns { T } 17892 * @syscap SystemCapability.ArkUI.ArkUI.Full 17893 * @crossplatform 17894 * @form 17895 * @since 10 17896 */ 17897 /** 17898 * Adds a grayscale effect to the current component. 17899 * 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. 17900 * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) 17901 * 17902 * @param { number } value 17903 * @returns { T } 17904 * @syscap SystemCapability.ArkUI.ArkUI.Full 17905 * @crossplatform 17906 * @form 17907 * @atomicservice 17908 * @since 11 17909 */ 17910 grayscale(value: number): T; 17911 17912 /** 17913 * Adds a color overlay effect for the current component. The input parameter is the superimposed color. 17914 * 17915 * @param { Color | string | Resource } value 17916 * @returns { T } 17917 * @syscap SystemCapability.ArkUI.ArkUI.Full 17918 * @since 7 17919 */ 17920 /** 17921 * Adds a color overlay effect for the current component. The input parameter is the superimposed color. 17922 * 17923 * @param { Color | string | Resource } value 17924 * @returns { T } 17925 * @syscap SystemCapability.ArkUI.ArkUI.Full 17926 * @form 17927 * @since 9 17928 */ 17929 /** 17930 * Adds a color overlay effect for the current component. The input parameter is the superimposed color. 17931 * 17932 * @param { Color | string | Resource } value 17933 * @returns { T } 17934 * @syscap SystemCapability.ArkUI.ArkUI.Full 17935 * @crossplatform 17936 * @form 17937 * @since 10 17938 */ 17939 /** 17940 * Adds a color overlay effect for the current component. The input parameter is the superimposed color. 17941 * 17942 * @param { Color | string | Resource } value 17943 * @returns { T } 17944 * @syscap SystemCapability.ArkUI.ArkUI.Full 17945 * @crossplatform 17946 * @form 17947 * @atomicservice 17948 * @since 11 17949 */ 17950 colorBlend(value: Color | string | Resource): T; 17951 17952 /** 17953 * Adds a saturation effect to the current component. 17954 * The saturation is the ratio of the color-containing component to the achromatic component (gray). 17955 * The larger the color-containing component, the greater the saturation. 17956 * The larger the achromatic component, the smaller the saturation. (Percentage) 17957 * 17958 * @param { number } value 17959 * @returns { T } 17960 * @syscap SystemCapability.ArkUI.ArkUI.Full 17961 * @since 7 17962 */ 17963 /** 17964 * Adds a saturation effect to the current component. 17965 * The saturation is the ratio of the color-containing component to the achromatic component (gray). 17966 * The larger the color-containing component, the greater the saturation. 17967 * The larger the achromatic component, the smaller the saturation. (Percentage) 17968 * 17969 * @param { number } value 17970 * @returns { T } 17971 * @syscap SystemCapability.ArkUI.ArkUI.Full 17972 * @form 17973 * @since 9 17974 */ 17975 /** 17976 * Adds a saturation effect to the current component. 17977 * The saturation is the ratio of the color-containing component to the achromatic component (gray). 17978 * The larger the color-containing component, the greater the saturation. 17979 * The larger the achromatic component, the smaller the saturation. (Percentage) 17980 * 17981 * @param { number } value 17982 * @returns { T } 17983 * @syscap SystemCapability.ArkUI.ArkUI.Full 17984 * @crossplatform 17985 * @form 17986 * @since 10 17987 */ 17988 /** 17989 * Adds a saturation effect to the current component. 17990 * The saturation is the ratio of the color-containing component to the achromatic component (gray). 17991 * The larger the color-containing component, the greater the saturation. 17992 * The larger the achromatic component, the smaller the saturation. (Percentage) 17993 * 17994 * @param { number } value 17995 * @returns { T } 17996 * @syscap SystemCapability.ArkUI.ArkUI.Full 17997 * @crossplatform 17998 * @form 17999 * @atomicservice 18000 * @since 11 18001 */ 18002 saturate(value: number): T; 18003 18004 /** 18005 * Converts the image to sepia. Value defines the scale of the conversion. 18006 * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) 18007 * 18008 * @param { number } value 18009 * @returns { T } 18010 * @syscap SystemCapability.ArkUI.ArkUI.Full 18011 * @since 7 18012 */ 18013 /** 18014 * Converts the image to sepia. Value defines the scale of the conversion. 18015 * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) 18016 * 18017 * @param { number } value 18018 * @returns { T } 18019 * @syscap SystemCapability.ArkUI.ArkUI.Full 18020 * @form 18021 * @since 9 18022 */ 18023 /** 18024 * Converts the image to sepia. Value defines the scale of the conversion. 18025 * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) 18026 * 18027 * @param { number } value 18028 * @returns { T } 18029 * @syscap SystemCapability.ArkUI.ArkUI.Full 18030 * @crossplatform 18031 * @form 18032 * @since 10 18033 */ 18034 /** 18035 * Converts the image to sepia. Value defines the scale of the conversion. 18036 * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) 18037 * 18038 * @param { number } value 18039 * @returns { T } 18040 * @syscap SystemCapability.ArkUI.ArkUI.Full 18041 * @crossplatform 18042 * @form 18043 * @atomicservice 18044 * @since 11 18045 */ 18046 sepia(value: number): T; 18047 18048 /** 18049 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 18050 * A value of 0% does not change the image. (Percentage) 18051 * 18052 * @param { number } value 18053 * @returns { T } 18054 * @syscap SystemCapability.ArkUI.ArkUI.Full 18055 * @since 7 18056 */ 18057 /** 18058 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 18059 * A value of 0% does not change the image. (Percentage) 18060 * 18061 * @param { number } value 18062 * @returns { T } 18063 * @syscap SystemCapability.ArkUI.ArkUI.Full 18064 * @form 18065 * @since 9 18066 */ 18067 /** 18068 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 18069 * A value of 0% does not change the image. (Percentage) 18070 * 18071 * @param { number } value 18072 * @returns { T } 18073 * @syscap SystemCapability.ArkUI.ArkUI.Full 18074 * @crossplatform 18075 * @form 18076 * @since 10 18077 */ 18078 /** 18079 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 18080 * A value of 0% does not change the image. (Percentage) 18081 * 18082 * @param { number | InvertOptions } value - value indicates the scale of the conversion or the options of invert. 18083 * @returns { T } 18084 * @syscap SystemCapability.ArkUI.ArkUI.Full 18085 * @crossplatform 18086 * @form 18087 * @atomicservice 18088 * @since 11 18089 */ 18090 invert(value: number | InvertOptions): T; 18091 18092 /** 18093 * Sets system bar effect to the component. 18094 * 18095 * @returns { T } return the component attribute. 18096 * @syscap SystemCapability.ArkUI.ArkUI.Full 18097 * @atomicservice 18098 * @since 12 18099 */ 18100 systemBarEffect(): T; 18101 18102 /** 18103 * Adds the hue rotation effect to the current component. 18104 * 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. 18105 * If the value exceeds 360deg, the image is circled again. 18106 * 18107 * @param { number | string } value 18108 * @returns { T } 18109 * @syscap SystemCapability.ArkUI.ArkUI.Full 18110 * @since 7 18111 */ 18112 /** 18113 * Adds the hue rotation effect to the current component. 18114 * 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. 18115 * If the value exceeds 360deg, the image is circled again. 18116 * 18117 * @param { number | string } value 18118 * @returns { T } 18119 * @syscap SystemCapability.ArkUI.ArkUI.Full 18120 * @form 18121 * @since 9 18122 */ 18123 /** 18124 * Adds the hue rotation effect to the current component. 18125 * 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. 18126 * If the value exceeds 360deg, the image is circled again. 18127 * 18128 * @param { number | string } value 18129 * @returns { T } 18130 * @syscap SystemCapability.ArkUI.ArkUI.Full 18131 * @crossplatform 18132 * @form 18133 * @since 10 18134 */ 18135 /** 18136 * Adds the hue rotation effect to the current component. 18137 * 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. 18138 * If the value exceeds 360deg, the image is circled again. 18139 * 18140 * @param { number | string } value 18141 * @returns { T } 18142 * @syscap SystemCapability.ArkUI.ArkUI.Full 18143 * @crossplatform 18144 * @form 18145 * @atomicservice 18146 * @since 11 18147 */ 18148 hueRotate(value: number | string): T; 18149 18150 /** 18151 * Add an attribute to control whether the shadows of the child nodes overlap each other. 18152 * 18153 * @param { boolean } value - true means the shadows of the child nodes overlap each other effect and drawn in batches. 18154 * @returns { T } 18155 * @syscap SystemCapability.ArkUI.ArkUI.Full 18156 * @crossplatform 18157 * @form 18158 * @since 11 18159 */ 18160 /** 18161 * Add an attribute to control whether the shadows of the child nodes overlap each other. 18162 * 18163 * @param { boolean } value - true means the shadows of the child nodes overlap each other effect and drawn in batches. 18164 * @returns { T } 18165 * @syscap SystemCapability.ArkUI.ArkUI.Full 18166 * @crossplatform 18167 * @form 18168 * @atomicservice 18169 * @since 12 18170 */ 18171 useShadowBatching(value: boolean): T; 18172 18173 /** 18174 * Sets whether the component should apply the effects template defined by the parent effectComponent or window. 18175 * If multiple parent effectComponents are found, the nearest one will be used. 18176 * If no parent effectComponent is found, this method has no effect. 18177 * 18178 * @param { boolean } useEffect - true means the component should apply the effects template defined by the parent effectComponent or window. 18179 * @param { EffectType } effectType - the effect type of the effects template, defined by the parent effectComponent or window. 18180 * @returns { T } return the component attribute. 18181 * @syscap SystemCapability.ArkUI.ArkUI.Full 18182 * @atomicservice 18183 * @since 14 18184 */ 18185 useEffect(useEffect: boolean, effectType: EffectType): T; 18186 18187 /** 18188 * Sets whether the component should apply the effects template defined by the parent effectComponent. 18189 * If multiple parent effectComponents are found, the nearest one will be used. 18190 * If no parent effectComponent is found, this method has no effect. 18191 * 18192 * @param { boolean } value - true means the component should apply the effects template. 18193 * @returns { T } return the component attribute. 18194 * @syscap SystemCapability.ArkUI.ArkUI.Full 18195 * @atomicservice 18196 * @since 12 18197 */ 18198 useEffect(value: boolean): T; 18199 18200 /** 18201 * Adds the background blur effect for the current component. The input parameter is the blur radius. 18202 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 18203 * 18204 * @param { number } value 18205 * @returns { T } 18206 * @syscap SystemCapability.ArkUI.ArkUI.Full 18207 * @since 7 18208 */ 18209 /** 18210 * Adds the background blur effect for the current component. The input parameter is the blur radius. 18211 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 18212 * 18213 * @param { number } value 18214 * @returns { T } 18215 * @syscap SystemCapability.ArkUI.ArkUI.Full 18216 * @form 18217 * @since 9 18218 */ 18219 /** 18220 * Adds the background blur effect for the current component. The input parameter is the blur radius. 18221 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 18222 * 18223 * @param { number } value 18224 * @returns { T } 18225 * @syscap SystemCapability.ArkUI.ArkUI.Full 18226 * @crossplatform 18227 * @form 18228 * @since 10 18229 */ 18230 /** 18231 * Adds the background blur effect for the current component. The input parameter is the blur radius. 18232 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 18233 * 18234 * @param { number } value - value indicates radius of backdrop blur. 18235 * @param { BlurOptions } [options] - options indicates the backdrop blur options. 18236 * @returns { T } 18237 * @syscap SystemCapability.ArkUI.ArkUI.Full 18238 * @crossplatform 18239 * @form 18240 * @atomicservice 18241 * @since 11 18242 */ 18243 backdropBlur(value: number, options?: BlurOptions): T; 18244 18245 /** 18246 * Composite the contents of this view and its children into an offscreen cache before display in the screen. 18247 * 18248 * @param { boolean } value - if this view and its children need to composite into an offscreen cache. 18249 * @returns { T } 18250 * @syscap SystemCapability.ArkUI.ArkUI.Full 18251 * @crossplatform 18252 * @since 10 18253 */ 18254 /** 18255 * Composite the contents of this view and its children into an offscreen cache before display in the screen. 18256 * 18257 * @param { boolean } value - if this view and its children need to composite into an offscreen cache. 18258 * @returns { T } 18259 * @syscap SystemCapability.ArkUI.ArkUI.Full 18260 * @crossplatform 18261 * @atomicservice 18262 * @since 11 18263 */ 18264 /** 18265 * Composite the contents of this view and its children into an offscreen cache before display in the screen. 18266 * 18267 * @param { boolean } value - if this view and its children need to composite into an offscreen cache. 18268 * @returns { T } 18269 * @syscap SystemCapability.ArkUI.ArkUI.Full 18270 * @crossplatform 18271 * @form 18272 * @atomicservice 18273 * @since 12 18274 */ 18275 renderGroup(value: boolean): T; 18276 18277 /** 18278 * Sets whether the component should remain stationary, reusing the results of the current frame's off-screen rendering. 18279 * If the input parameter is true, the component and subcomponent changes do not affect the display. 18280 * 18281 * @param { boolean } value - true means the component should remain stationary. 18282 * @returns { T } 18283 * @syscap SystemCapability.ArkUI.ArkUI.Full 18284 * @atomicservice 18285 * @since 12 18286 */ 18287 freeze(value: boolean): T; 18288 18289 /** 18290 * Sets the translation effect during page transition. 18291 * The value is the start point of entry and end point of exit. 18292 * When this parameter is set together with slide, slide takes effect by default. 18293 * 18294 * @param { TranslateOptions } value 18295 * @returns { T } 18296 * @syscap SystemCapability.ArkUI.ArkUI.Full 18297 * @since 7 18298 */ 18299 /** 18300 * Sets the translation effect during page transition. 18301 * The value is the start point of entry and end point of exit. 18302 * When this parameter is set together with slide, slide takes effect by default. 18303 * 18304 * @param { TranslateOptions } value 18305 * @returns { T } 18306 * @syscap SystemCapability.ArkUI.ArkUI.Full 18307 * @form 18308 * @since 9 18309 */ 18310 /** 18311 * Sets the translation effect during page transition. 18312 * The value is the start point of entry and end point of exit. 18313 * When this parameter is set together with slide, slide takes effect by default. 18314 * 18315 * @param { TranslateOptions } value 18316 * @returns { T } 18317 * @syscap SystemCapability.ArkUI.ArkUI.Full 18318 * @crossplatform 18319 * @form 18320 * @since 10 18321 */ 18322 /** 18323 * Set component translation. 18324 * 18325 * @param { TranslateOptions } value default:{x:0,y:0,z:0} 18326 * @returns { T } 18327 * @syscap SystemCapability.ArkUI.ArkUI.Full 18328 * @crossplatform 18329 * @form 18330 * @atomicservice 18331 * @since 11 18332 */ 18333 translate(value: TranslateOptions): T; 18334 18335 /** 18336 * Sets the zoom effect during page transition. The value is the start point of entry and end point of exit. 18337 * 18338 * @param { ScaleOptions } value 18339 * @returns { T } 18340 * @syscap SystemCapability.ArkUI.ArkUI.Full 18341 * @since 7 18342 */ 18343 /** 18344 * Sets the zoom effect during page transition. The value is the start point of entry and end point of exit. 18345 * 18346 * @param { ScaleOptions } value 18347 * @returns { T } 18348 * @syscap SystemCapability.ArkUI.ArkUI.Full 18349 * @form 18350 * @since 9 18351 */ 18352 /** 18353 * Sets the zoom effect during page transition. The value is the start point of entry and end point of exit. 18354 * 18355 * @param { ScaleOptions } value 18356 * @returns { T } 18357 * @syscap SystemCapability.ArkUI.ArkUI.Full 18358 * @crossplatform 18359 * @form 18360 * @since 10 18361 */ 18362 /** 18363 * Set component scaling. 18364 * 18365 * @param { ScaleOptions } value default:{x:1,y:1,z:1,centerX:'50%',centerY:'50%'} 18366 * @returns { T } 18367 * @syscap SystemCapability.ArkUI.ArkUI.Full 18368 * @crossplatform 18369 * @form 18370 * @atomicservice 18371 * @since 11 18372 */ 18373 scale(value: ScaleOptions): T; 18374 18375 /** 18376 * 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. 18377 * 18378 * @param { number } value 18379 * @returns { T } 18380 * @syscap SystemCapability.ArkUI.ArkUI.Full 18381 * @since 7 18382 */ 18383 /** 18384 * 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. 18385 * 18386 * @param { number } value 18387 * @returns { T } 18388 * @syscap SystemCapability.ArkUI.ArkUI.Full 18389 * @crossplatform 18390 * @since 10 18391 */ 18392 /** 18393 * 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. 18394 * 18395 * @param { number } value 18396 * @returns { T } 18397 * @syscap SystemCapability.ArkUI.ArkUI.Full 18398 * @crossplatform 18399 * @atomicservice 18400 * @since 11 18401 * @deprecated since 14 18402 * @useinstead grid_col/GridColInterface and grid_row/GridRowInterface 18403 */ 18404 gridSpan(value: number): T; 18405 18406 /** 18407 * 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, 18408 * the current component is located in the nth column. 18409 * 18410 * @param { number } value 18411 * @returns { T } 18412 * @syscap SystemCapability.ArkUI.ArkUI.Full 18413 * @since 7 18414 */ 18415 /** 18416 * 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, 18417 * the current component is located in the nth column. 18418 * 18419 * @param { number } value 18420 * @returns { T } 18421 * @syscap SystemCapability.ArkUI.ArkUI.Full 18422 * @crossplatform 18423 * @since 10 18424 */ 18425 /** 18426 * 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, 18427 * the current component is located in the nth column. 18428 * 18429 * @param { number } value 18430 * @returns { T } 18431 * @syscap SystemCapability.ArkUI.ArkUI.Full 18432 * @crossplatform 18433 * @atomicservice 18434 * @since 11 18435 * @deprecated since 14 18436 * @useinstead grid_col/GridColInterface and grid_row/GridRowInterface 18437 */ 18438 gridOffset(value: number): T; 18439 18440 /** 18441 * Sets the rotation effect during assembly transition. 18442 * The values are the start point during insertion and the end point during deletion. 18443 * 18444 * @param { RotateOptions } value 18445 * @returns { T } 18446 * @syscap SystemCapability.ArkUI.ArkUI.Full 18447 * @since 7 18448 */ 18449 /** 18450 * Sets the rotation effect during assembly transition. 18451 * The values are the start point during insertion and the end point during deletion. 18452 * 18453 * @param { RotateOptions } value 18454 * @returns { T } 18455 * @syscap SystemCapability.ArkUI.ArkUI.Full 18456 * @form 18457 * @since 9 18458 */ 18459 /** 18460 * Sets the rotation effect during assembly transition. 18461 * The values are the start point during insertion and the end point during deletion. 18462 * 18463 * @param { RotateOptions } value 18464 * @returns { T } 18465 * @syscap SystemCapability.ArkUI.ArkUI.Full 18466 * @crossplatform 18467 * @form 18468 * @since 10 18469 */ 18470 /** 18471 * Set component rotation. 18472 * 18473 * @param { RotateOptions } value default:{x:0,y:0,z:0,centerX:'50%',centerY:'50%',centerZ:0,perspective:0} 18474 * @returns { T } 18475 * @syscap SystemCapability.ArkUI.ArkUI.Full 18476 * @crossplatform 18477 * @form 18478 * @atomicservice 18479 * @since 11 18480 */ 18481 rotate(value: RotateOptions): T; 18482 18483 /** 18484 * Sets the transformation matrix for the current component. 18485 * 18486 * @param { object } value 18487 * @returns { T } 18488 * @syscap SystemCapability.ArkUI.ArkUI.Full 18489 * @since 7 18490 */ 18491 /** 18492 * Sets the transformation matrix for the current component. 18493 * 18494 * @param { object } value 18495 * @returns { T } 18496 * @syscap SystemCapability.ArkUI.ArkUI.Full 18497 * @crossplatform 18498 * @since 10 18499 */ 18500 /** 18501 * Sets the transformation matrix for the current component. 18502 * 18503 * @param { object } value 18504 * @returns { T } 18505 * @syscap SystemCapability.ArkUI.ArkUI.Full 18506 * @crossplatform 18507 * @atomicservice 18508 * @since 11 18509 */ 18510 transform(value: object): T; 18511 18512 /** 18513 * This callback is triggered when a component mounts a display. 18514 * 18515 * @param { function } event 18516 * @returns { T } 18517 * @syscap SystemCapability.ArkUI.ArkUI.Full 18518 * @since 7 18519 */ 18520 /** 18521 * This callback is triggered when a component mounts a display. 18522 * 18523 * @param { function } event 18524 * @returns { T } 18525 * @syscap SystemCapability.ArkUI.ArkUI.Full 18526 * @form 18527 * @since 9 18528 */ 18529 /** 18530 * This callback is triggered when a component mounts a display. 18531 * 18532 * @param { function } event 18533 * @returns { T } 18534 * @syscap SystemCapability.ArkUI.ArkUI.Full 18535 * @crossplatform 18536 * @form 18537 * @since 10 18538 */ 18539 /** 18540 * This callback is triggered when a component mounts a display. 18541 * 18542 * @param { function } event 18543 * @returns { T } 18544 * @syscap SystemCapability.ArkUI.ArkUI.Full 18545 * @crossplatform 18546 * @form 18547 * @atomicservice 18548 * @since 11 18549 */ 18550 onAppear(event: () => void): T; 18551 18552 /** 18553 * This callback is triggered when component uninstallation disappears. 18554 * 18555 * @param { function } event 18556 * @returns { T } 18557 * @syscap SystemCapability.ArkUI.ArkUI.Full 18558 * @since 7 18559 */ 18560 /** 18561 * This callback is triggered when component uninstallation disappears. 18562 * 18563 * @param { function } event 18564 * @returns { T } 18565 * @syscap SystemCapability.ArkUI.ArkUI.Full 18566 * @form 18567 * @since 9 18568 */ 18569 /** 18570 * This callback is triggered when component uninstallation disappears. 18571 * 18572 * @param { function } event 18573 * @returns { T } 18574 * @syscap SystemCapability.ArkUI.ArkUI.Full 18575 * @crossplatform 18576 * @form 18577 * @since 10 18578 */ 18579 /** 18580 * This callback is triggered when component uninstallation disappears. 18581 * 18582 * @param { function } event 18583 * @returns { T } 18584 * @syscap SystemCapability.ArkUI.ArkUI.Full 18585 * @crossplatform 18586 * @form 18587 * @atomicservice 18588 * @since 11 18589 */ 18590 onDisAppear(event: () => void): T; 18591 18592 /** 18593 * This callback is triggered when a component mounts to view tree. 18594 * 18595 * @param { Callback<void> } callback 18596 * @returns { T } 18597 * @syscap SystemCapability.ArkUI.ArkUI.Full 18598 * @crossplatform 18599 * @atomicservice 18600 * @since 12 18601 */ 18602 onAttach(callback: Callback<void>): T; 18603 18604 /** 18605 * This callback is triggered when a component is detached from view tree. 18606 * 18607 * @param { Callback<void> } callback 18608 * @returns { T } 18609 * @syscap SystemCapability.ArkUI.ArkUI.Full 18610 * @crossplatform 18611 * @atomicservice 18612 * @since 12 18613 */ 18614 onDetach(callback: Callback<void>): T; 18615 18616 /** 18617 * This callback is triggered when the size or position of this component change finished. 18618 * 18619 * @param { function } event - event callback. 18620 * @returns { T } 18621 * @syscap SystemCapability.ArkUI.ArkUI.Full 18622 * @since 8 18623 */ 18624 /** 18625 * This callback is triggered when the size or position of this component change finished. 18626 * 18627 * @param { function } event - event callback. 18628 * @returns { T } 18629 * @syscap SystemCapability.ArkUI.ArkUI.Full 18630 * @crossplatform 18631 * @since 10 18632 */ 18633 /** 18634 * This callback is triggered when the size or position of this component change finished. 18635 * 18636 * @param { function } event - event callback. 18637 * @returns { T } 18638 * @syscap SystemCapability.ArkUI.ArkUI.Full 18639 * @crossplatform 18640 * @atomicservice 18641 * @since 11 18642 */ 18643 onAreaChange(event: (oldValue: Area, newValue: Area) => void): T; 18644 18645 /** 18646 * Controls the display or hide of the current component. 18647 * 18648 * @param { Visibility } value 18649 * @returns { T } 18650 * @syscap SystemCapability.ArkUI.ArkUI.Full 18651 * @since 7 18652 */ 18653 /** 18654 * Controls the display or hide of the current component. 18655 * 18656 * @param { Visibility } value 18657 * @returns { T } 18658 * @syscap SystemCapability.ArkUI.ArkUI.Full 18659 * @form 18660 * @since 9 18661 */ 18662 /** 18663 * Controls the display or hide of the current component. 18664 * 18665 * @param { Visibility } value 18666 * @returns { T } 18667 * @syscap SystemCapability.ArkUI.ArkUI.Full 18668 * @crossplatform 18669 * @form 18670 * @since 10 18671 */ 18672 /** 18673 * Controls the display or hide of the current component. 18674 * 18675 * @param { Visibility } value 18676 * @returns { T } 18677 * @syscap SystemCapability.ArkUI.ArkUI.Full 18678 * @crossplatform 18679 * @form 18680 * @atomicservice 18681 * @since 11 18682 */ 18683 visibility(value: Visibility): T; 18684 18685 /** 18686 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 18687 * 18688 * @param { number } value 18689 * @returns { T } 18690 * @syscap SystemCapability.ArkUI.ArkUI.Full 18691 * @since 7 18692 */ 18693 /** 18694 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 18695 * 18696 * @param { number } value 18697 * @returns { T } 18698 * @syscap SystemCapability.ArkUI.ArkUI.Full 18699 * @form 18700 * @since 9 18701 */ 18702 /** 18703 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 18704 * 18705 * @param { number } value 18706 * @returns { T } 18707 * @syscap SystemCapability.ArkUI.ArkUI.Full 18708 * @crossplatform 18709 * @form 18710 * @since 10 18711 */ 18712 /** 18713 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 18714 * 18715 * @param { number } value 18716 * @returns { T } 18717 * @syscap SystemCapability.ArkUI.ArkUI.Full 18718 * @crossplatform 18719 * @form 18720 * @atomicservice 18721 * @since 11 18722 */ 18723 flexGrow(value: number): T; 18724 18725 /** 18726 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 18727 * 18728 * @param { number } value 18729 * @returns { T } 18730 * @syscap SystemCapability.ArkUI.ArkUI.Full 18731 * @since 7 18732 */ 18733 /** 18734 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 18735 * 18736 * @param { number } value 18737 * @returns { T } 18738 * @syscap SystemCapability.ArkUI.ArkUI.Full 18739 * @form 18740 * @since 9 18741 */ 18742 /** 18743 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 18744 * 18745 * @param { number } value 18746 * @returns { T } 18747 * @syscap SystemCapability.ArkUI.ArkUI.Full 18748 * @crossplatform 18749 * @form 18750 * @since 10 18751 */ 18752 /** 18753 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 18754 * 18755 * @param { number } value 18756 * @returns { T } 18757 * @syscap SystemCapability.ArkUI.ArkUI.Full 18758 * @crossplatform 18759 * @form 18760 * @atomicservice 18761 * @since 11 18762 */ 18763 flexShrink(value: number): T; 18764 18765 /** 18766 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 18767 * 18768 * @param { number | string } value 18769 * @returns { T } 18770 * @syscap SystemCapability.ArkUI.ArkUI.Full 18771 * @since 7 18772 */ 18773 /** 18774 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 18775 * 18776 * @param { number | string } value 18777 * @returns { T } 18778 * @syscap SystemCapability.ArkUI.ArkUI.Full 18779 * @form 18780 * @since 9 18781 */ 18782 /** 18783 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 18784 * 18785 * @param { number | string } value 18786 * @returns { T } 18787 * @syscap SystemCapability.ArkUI.ArkUI.Full 18788 * @crossplatform 18789 * @form 18790 * @since 10 18791 */ 18792 /** 18793 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 18794 * 18795 * @param { number | string } value 18796 * @returns { T } 18797 * @syscap SystemCapability.ArkUI.ArkUI.Full 18798 * @crossplatform 18799 * @form 18800 * @atomicservice 18801 * @since 11 18802 */ 18803 flexBasis(value: number | string): T; 18804 18805 /** 18806 * Overrides the default configuration of alignItems in the Flex Layout container. 18807 * 18808 * @param { ItemAlign } value 18809 * @returns { T } 18810 * @syscap SystemCapability.ArkUI.ArkUI.Full 18811 * @since 7 18812 */ 18813 /** 18814 * Overrides the default configuration of alignItems in the Flex Layout container. 18815 * 18816 * @param { ItemAlign } value 18817 * @returns { T } 18818 * @syscap SystemCapability.ArkUI.ArkUI.Full 18819 * @form 18820 * @since 9 18821 */ 18822 /** 18823 * Overrides the default configuration of alignItems in the Flex Layout container. 18824 * 18825 * @param { ItemAlign } value 18826 * @returns { T } 18827 * @syscap SystemCapability.ArkUI.ArkUI.Full 18828 * @crossplatform 18829 * @form 18830 * @since 10 18831 */ 18832 /** 18833 * Overrides the default configuration of alignItems in the Flex Layout container. 18834 * 18835 * @param { ItemAlign } value 18836 * @returns { T } 18837 * @syscap SystemCapability.ArkUI.ArkUI.Full 18838 * @crossplatform 18839 * @form 18840 * @atomicservice 18841 * @since 11 18842 */ 18843 alignSelf(value: ItemAlign): T; 18844 18845 /** 18846 * 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. 18847 * 18848 * @param { number } value 18849 * @returns { T } 18850 * @syscap SystemCapability.ArkUI.ArkUI.Full 18851 * @since 7 18852 */ 18853 /** 18854 * 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. 18855 * 18856 * @param { number } value 18857 * @returns { T } 18858 * @syscap SystemCapability.ArkUI.ArkUI.Full 18859 * @form 18860 * @since 9 18861 */ 18862 /** 18863 * 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. 18864 * 18865 * @param { number } value 18866 * @returns { T } 18867 * @syscap SystemCapability.ArkUI.ArkUI.Full 18868 * @crossplatform 18869 * @form 18870 * @since 10 18871 */ 18872 /** 18873 * 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. 18874 * 18875 * @param { number } value 18876 * @returns { T } 18877 * @syscap SystemCapability.ArkUI.ArkUI.Full 18878 * @crossplatform 18879 * @form 18880 * @atomicservice 18881 * @since 11 18882 */ 18883 displayPriority(value: number): T; 18884 18885 /** 18886 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 18887 * 18888 * @param { number } value 18889 * @returns { T } 18890 * @syscap SystemCapability.ArkUI.ArkUI.Full 18891 * @since 7 18892 */ 18893 /** 18894 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 18895 * 18896 * @param { number } value 18897 * @returns { T } 18898 * @syscap SystemCapability.ArkUI.ArkUI.Full 18899 * @form 18900 * @since 9 18901 */ 18902 /** 18903 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 18904 * 18905 * @param { number } value 18906 * @returns { T } 18907 * @syscap SystemCapability.ArkUI.ArkUI.Full 18908 * @crossplatform 18909 * @form 18910 * @since 10 18911 */ 18912 /** 18913 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 18914 * 18915 * @param { number } value 18916 * @returns { T } 18917 * @syscap SystemCapability.ArkUI.ArkUI.Full 18918 * @crossplatform 18919 * @form 18920 * @atomicservice 18921 * @since 11 18922 */ 18923 zIndex(value: number): T; 18924 18925 /** 18926 * 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. 18927 * 18928 * @param { string } id 18929 * @param { sharedTransitionOptions } options 18930 * @returns { T } 18931 * @syscap SystemCapability.ArkUI.ArkUI.Full 18932 * @since 7 18933 */ 18934 /** 18935 * 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. 18936 * 18937 * @param { string } id 18938 * @param { sharedTransitionOptions } options 18939 * @returns { T } 18940 * @syscap SystemCapability.ArkUI.ArkUI.Full 18941 * @crossplatform 18942 * @since 10 18943 */ 18944 /** 18945 * 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. 18946 * 18947 * @param { string } id 18948 * @param { sharedTransitionOptions } options 18949 * @returns { T } 18950 * @syscap SystemCapability.ArkUI.ArkUI.Full 18951 * @crossplatform 18952 * @atomicservice 18953 * @since 11 18954 */ 18955 sharedTransition(id: string, options?: sharedTransitionOptions): T; 18956 18957 /** 18958 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 18959 * 18960 * @param { Direction } value 18961 * @returns { T } 18962 * @syscap SystemCapability.ArkUI.ArkUI.Full 18963 * @since 7 18964 */ 18965 /** 18966 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 18967 * 18968 * @param { Direction } value 18969 * @returns { T } 18970 * @syscap SystemCapability.ArkUI.ArkUI.Full 18971 * @form 18972 * @since 9 18973 */ 18974 /** 18975 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 18976 * 18977 * @param { Direction } value 18978 * @returns { T } 18979 * @syscap SystemCapability.ArkUI.ArkUI.Full 18980 * @crossplatform 18981 * @form 18982 * @since 10 18983 */ 18984 /** 18985 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 18986 * 18987 * @param { Direction } value 18988 * @returns { T } 18989 * @syscap SystemCapability.ArkUI.ArkUI.Full 18990 * @crossplatform 18991 * @form 18992 * @atomicservice 18993 * @since 11 18994 */ 18995 direction(value: Direction): T; 18996 18997 /** 18998 * align 18999 * 19000 * @param { Alignment } value 19001 * @returns { T } 19002 * @syscap SystemCapability.ArkUI.ArkUI.Full 19003 * @since 7 19004 */ 19005 /** 19006 * align 19007 * 19008 * @param { Alignment } value 19009 * @returns { T } 19010 * @syscap SystemCapability.ArkUI.ArkUI.Full 19011 * @form 19012 * @since 9 19013 */ 19014 /** 19015 * align 19016 * 19017 * @param { Alignment } value 19018 * @returns { T } 19019 * @syscap SystemCapability.ArkUI.ArkUI.Full 19020 * @crossplatform 19021 * @form 19022 * @since 10 19023 */ 19024 /** 19025 * align 19026 * 19027 * @param { Alignment } value 19028 * @returns { T } 19029 * @syscap SystemCapability.ArkUI.ArkUI.Full 19030 * @crossplatform 19031 * @form 19032 * @atomicservice 19033 * @since 11 19034 */ 19035 align(value: Alignment): T; 19036 19037 /** 19038 * position 19039 * 19040 * @param { Position } value 19041 * @returns { T } 19042 * @syscap SystemCapability.ArkUI.ArkUI.Full 19043 * @since 7 19044 */ 19045 /** 19046 * position 19047 * 19048 * @param { Position } value 19049 * @returns { T } 19050 * @syscap SystemCapability.ArkUI.ArkUI.Full 19051 * @form 19052 * @since 9 19053 */ 19054 /** 19055 * position 19056 * 19057 * @param { Position } value 19058 * @returns { T } 19059 * @syscap SystemCapability.ArkUI.ArkUI.Full 19060 * @crossplatform 19061 * @form 19062 * @since 10 19063 */ 19064 /** 19065 * position 19066 * 19067 * @param { Position } value 19068 * @returns { T } 19069 * @syscap SystemCapability.ArkUI.ArkUI.Full 19070 * @crossplatform 19071 * @form 19072 * @atomicservice 19073 * @since 11 19074 */ 19075 /** 19076 * position 19077 * 19078 * @param { Position | Edges | LocalizedEdges } value 19079 * @returns { T } 19080 * @syscap SystemCapability.ArkUI.ArkUI.Full 19081 * @crossplatform 19082 * @form 19083 * @atomicservice 19084 * @since 12 19085 */ 19086 position(value: Position | Edges | LocalizedEdges): T; 19087 19088 /** 19089 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 19090 * 19091 * @param { Position } value 19092 * @returns { T } 19093 * @syscap SystemCapability.ArkUI.ArkUI.Full 19094 * @since 7 19095 */ 19096 /** 19097 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 19098 * 19099 * @param { Position } value 19100 * @returns { T } 19101 * @syscap SystemCapability.ArkUI.ArkUI.Full 19102 * @form 19103 * @since 9 19104 */ 19105 /** 19106 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 19107 * 19108 * @param { Position } value 19109 * @returns { T } 19110 * @syscap SystemCapability.ArkUI.ArkUI.Full 19111 * @crossplatform 19112 * @form 19113 * @since 10 19114 */ 19115 /** 19116 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 19117 * 19118 * @param { Position } value 19119 * @returns { T } 19120 * @syscap SystemCapability.ArkUI.ArkUI.Full 19121 * @crossplatform 19122 * @form 19123 * @atomicservice 19124 * @since 11 19125 */ 19126 /** 19127 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 19128 * 19129 * @param { Position | LocalizedPosition} value 19130 * @returns { T } 19131 * @syscap SystemCapability.ArkUI.ArkUI.Full 19132 * @crossplatform 19133 * @form 19134 * @atomicservice 19135 * @since 12 19136 */ 19137 markAnchor(value: Position | LocalizedPosition): T; 19138 19139 /** 19140 * Coordinate offset relative to the layout completion position. 19141 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 19142 * 19143 * @param { Position } value 19144 * @returns { T } 19145 * @syscap SystemCapability.ArkUI.ArkUI.Full 19146 * @since 7 19147 */ 19148 /** 19149 * Coordinate offset relative to the layout completion position. 19150 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 19151 * 19152 * @param { Position } value 19153 * @returns { T } 19154 * @syscap SystemCapability.ArkUI.ArkUI.Full 19155 * @form 19156 * @since 9 19157 */ 19158 /** 19159 * Coordinate offset relative to the layout completion position. 19160 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 19161 * 19162 * @param { Position } value 19163 * @returns { T } 19164 * @syscap SystemCapability.ArkUI.ArkUI.Full 19165 * @crossplatform 19166 * @form 19167 * @since 10 19168 */ 19169 /** 19170 * Coordinate offset relative to the layout completion position. 19171 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 19172 * 19173 * @param { Position } value 19174 * @returns { T } 19175 * @syscap SystemCapability.ArkUI.ArkUI.Full 19176 * @crossplatform 19177 * @form 19178 * @atomicservice 19179 * @since 11 19180 */ 19181 /** 19182 * Coordinate offset relative to the layout completion position. 19183 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 19184 * 19185 * @param { Position | Edges | LocalizedEdges } value 19186 * @returns { T } 19187 * @syscap SystemCapability.ArkUI.ArkUI.Full 19188 * @crossplatform 19189 * @form 19190 * @atomicservice 19191 * @since 12 19192 */ 19193 offset(value: Position | Edges | LocalizedEdges): T; 19194 19195 /** 19196 * If the value is true, the component is available and can respond to operations such as clicking. 19197 * If it is set to false, click operations are not responded. 19198 * 19199 * @param { boolean } value 19200 * @returns { T } 19201 * @syscap SystemCapability.ArkUI.ArkUI.Full 19202 * @since 7 19203 */ 19204 /** 19205 * If the value is true, the component is available and can respond to operations such as clicking. 19206 * If it is set to false, click operations are not responded. 19207 * 19208 * @param { boolean } value 19209 * @returns { T } 19210 * @syscap SystemCapability.ArkUI.ArkUI.Full 19211 * @form 19212 * @since 9 19213 */ 19214 /** 19215 * If the value is true, the component is available and can respond to operations such as clicking. 19216 * If it is set to false, click operations are not responded. 19217 * 19218 * @param { boolean } value 19219 * @returns { T } 19220 * @syscap SystemCapability.ArkUI.ArkUI.Full 19221 * @crossplatform 19222 * @form 19223 * @since 10 19224 */ 19225 /** 19226 * If the value is true, the component is available and can respond to operations such as clicking. 19227 * If it is set to false, click operations are not responded. 19228 * 19229 * @param { boolean } value 19230 * @returns { T } 19231 * @syscap SystemCapability.ArkUI.ArkUI.Full 19232 * @crossplatform 19233 * @form 19234 * @atomicservice 19235 * @since 11 19236 */ 19237 enabled(value: boolean): T; 19238 19239 /** 19240 * Sets the number of occupied columns and offset columns for a specific device width type. 19241 * 19242 * @param { object } value 19243 * @returns { T } 19244 * @syscap SystemCapability.ArkUI.ArkUI.Full 19245 * @since 7 19246 * @deprecated since 9 19247 * @useinstead grid_col/GridColColumnOption and grid_row/GridRowColumnOption 19248 */ 19249 useSizeType(value: { 19250 xs?: number | { span: number; offset: number }; 19251 sm?: number | { span: number; offset: number }; 19252 md?: number | { span: number; offset: number }; 19253 lg?: number | { span: number; offset: number }; 19254 }): T; 19255 19256 /** 19257 * Specifies the alignRules of relative container 19258 * 19259 * @param { AlignRuleOption } value 19260 * @returns { T } 19261 * @syscap SystemCapability.ArkUI.ArkUI.Full 19262 * @form 19263 * @since 9 19264 */ 19265 /** 19266 * Specifies the alignRules of relative container 19267 * 19268 * @param { AlignRuleOption } value 19269 * @returns { T } 19270 * @syscap SystemCapability.ArkUI.ArkUI.Full 19271 * @crossplatform 19272 * @form 19273 * @since 10 19274 */ 19275 /** 19276 * Specifies the alignRules of relative container 19277 * 19278 * @param { AlignRuleOption } value 19279 * @returns { T } 19280 * @syscap SystemCapability.ArkUI.ArkUI.Full 19281 * @crossplatform 19282 * @form 19283 * @atomicservice 19284 * @since 11 19285 */ 19286 alignRules(value: AlignRuleOption): T; 19287 19288 /** 19289 * Specifies the localized alignRules of relative container 19290 * 19291 * @param { LocalizedAlignRuleOptions } alignRule 19292 * @returns { T } 19293 * @syscap SystemCapability.ArkUI.ArkUI.Full 19294 * @crossplatform 19295 * @form 19296 * @atomicservice 19297 * @since 12 19298 */ 19299 alignRules(alignRule: LocalizedAlignRuleOptions): T; 19300 19301 /** 19302 * Specifies the direction and style of chain in relative container 19303 * 19304 * @param { Axis } direction - indicates direction of the chain 19305 * @param { ChainStyle } style - indicates style of the chain 19306 * @returns { T } 19307 * @syscap SystemCapability.ArkUI.ArkUI.Full 19308 * @crossplatform 19309 * @atomicservice 19310 * @since 12 19311 */ 19312 chainMode(direction: Axis, style: ChainStyle): T; 19313 19314 /** 19315 * Specifies the aspect ratio of the current component. 19316 * 19317 * @param { number } value 19318 * @returns { T } 19319 * @syscap SystemCapability.ArkUI.ArkUI.Full 19320 * @since 7 19321 */ 19322 /** 19323 * Specifies the aspect ratio of the current component. 19324 * 19325 * @param { number } value 19326 * @returns { T } 19327 * @syscap SystemCapability.ArkUI.ArkUI.Full 19328 * @form 19329 * @since 9 19330 */ 19331 /** 19332 * Specifies the aspect ratio of the current component. 19333 * 19334 * @param { number } value 19335 * @returns { T } 19336 * @syscap SystemCapability.ArkUI.ArkUI.Full 19337 * @crossplatform 19338 * @form 19339 * @since 10 19340 */ 19341 /** 19342 * Specifies the aspect ratio of the current component. 19343 * 19344 * @param { number } value 19345 * @returns { T } 19346 * @syscap SystemCapability.ArkUI.ArkUI.Full 19347 * @crossplatform 19348 * @form 19349 * @atomicservice 19350 * @since 11 19351 */ 19352 aspectRatio(value: number): T; 19353 19354 /** 19355 * The click effect level and scale number. 19356 * 19357 * @param { ClickEffect | null } value 19358 * @returns { T } return the component attribute. 19359 * @syscap SystemCapability.ArkUI.ArkUI.Full 19360 * @crossplatform 19361 * @since 10 19362 */ 19363 /** 19364 * The click effect level and scale number. 19365 * 19366 * @param { ClickEffect | null } value 19367 * @returns { T } return the component attribute. 19368 * @syscap SystemCapability.ArkUI.ArkUI.Full 19369 * @crossplatform 19370 * @atomicservice 19371 * @since 11 19372 */ 19373 clickEffect(value: ClickEffect | null): T; 19374 19375 /** 19376 * After a listener is bound, the component can be dragged. After the drag occurs, a callback is triggered. 19377 * (To be triggered, press and hold for 170 milliseconds (ms)) 19378 * 19379 * @param { function } event 19380 * @returns { T } 19381 * @syscap SystemCapability.ArkUI.ArkUI.Full 19382 * @since 8 19383 */ 19384 /** 19385 * After a listener is bound, the component can be dragged. After the drag occurs, a callback is triggered. 19386 * (To be triggered, press and hold for 170 milliseconds (ms)) 19387 * 19388 * @param { function } event 19389 * @returns { T } 19390 * @syscap SystemCapability.ArkUI.ArkUI.Full 19391 * @atomicservice 19392 * @since 11 19393 */ 19394 /** 19395 * After a listener is bound, the component can be dragged. After the drag occurs, a callback is triggered. 19396 * (To be triggered, press and hold for 170 milliseconds (ms)) 19397 * 19398 * @param { function } event 19399 * @returns { T } 19400 * @syscap SystemCapability.ArkUI.ArkUI.Full 19401 * @crossplatform 19402 * @atomicservice 19403 * @since 14 19404 */ 19405 onDragStart(event: (event: DragEvent, extraParams?: string) => CustomBuilder | DragItemInfo): T; 19406 19407 /** 19408 * After binding, a callback is triggered when the component is dragged to the range of the component. 19409 * 19410 * @param { function } event 19411 * @returns { T } 19412 * @syscap SystemCapability.ArkUI.ArkUI.Full 19413 * @since 8 19414 */ 19415 /** 19416 * After binding, a callback is triggered when the component is dragged to the range of the component. 19417 * 19418 * @param { function } event 19419 * @returns { T } 19420 * @syscap SystemCapability.ArkUI.ArkUI.Full 19421 * @atomicservice 19422 * @since 11 19423 */ 19424 /** 19425 * After binding, a callback is triggered when the component is dragged to the range of the component. 19426 * 19427 * @param { function } event 19428 * @returns { T } 19429 * @syscap SystemCapability.ArkUI.ArkUI.Full 19430 * @crossplatform 19431 * @atomicservice 19432 * @since 14 19433 */ 19434 onDragEnter(event: (event: DragEvent, extraParams?: string) => void): T; 19435 19436 /** 19437 * After binding, a callback is triggered when the drag moves within the range of a placeable component. 19438 * 19439 * @param { function } event 19440 * @returns { T } 19441 * @syscap SystemCapability.ArkUI.ArkUI.Full 19442 * @since 8 19443 */ 19444 /** 19445 * After binding, a callback is triggered when the drag moves within the range of a placeable component. 19446 * 19447 * @param { function } event 19448 * @returns { T } 19449 * @syscap SystemCapability.ArkUI.ArkUI.Full 19450 * @atomicservice 19451 * @since 11 19452 */ 19453 /** 19454 * After binding, a callback is triggered when the drag moves within the range of a placeable component. 19455 * 19456 * @param { function } event 19457 * @returns { T } 19458 * @syscap SystemCapability.ArkUI.ArkUI.Full 19459 * @crossplatform 19460 * @atomicservice 19461 * @since 14 19462 */ 19463 onDragMove(event: (event: DragEvent, extraParams?: string) => void): T; 19464 19465 /** 19466 * After binding, a callback is triggered when the component is dragged out of the component range. 19467 * 19468 * @param { function } event 19469 * @returns { T } 19470 * @syscap SystemCapability.ArkUI.ArkUI.Full 19471 * @since 8 19472 */ 19473 /** 19474 * After binding, a callback is triggered when the component is dragged out of the component range. 19475 * 19476 * @param { function } event 19477 * @returns { T } 19478 * @syscap SystemCapability.ArkUI.ArkUI.Full 19479 * @atomicservice 19480 * @since 11 19481 */ 19482 /** 19483 * After binding, a callback is triggered when the component is dragged out of the component range. 19484 * 19485 * @param { function } event 19486 * @returns { T } 19487 * @syscap SystemCapability.ArkUI.ArkUI.Full 19488 * @crossplatform 19489 * @atomicservice 19490 * @since 14 19491 */ 19492 onDragLeave(event: (event: DragEvent, extraParams?: string) => void): T; 19493 19494 /** 19495 * The component bound to this event can be used as the drag release target. 19496 * This callback is triggered when the drag behavior is stopped within the scope of the component. 19497 * 19498 * @param { function } event 19499 * @returns { T } 19500 * @syscap SystemCapability.ArkUI.ArkUI.Full 19501 * @since 8 19502 */ 19503 /** 19504 * The component bound to this event can be used as the drag release target. 19505 * This callback is triggered when the drag behavior is stopped within the scope of the component. 19506 * 19507 * @param { function } event 19508 * @returns { T } 19509 * @syscap SystemCapability.ArkUI.ArkUI.Full 19510 * @atomicservice 19511 * @since 11 19512 */ 19513 /** 19514 * The component bound to this event can be used as the drag release target. 19515 * This callback is triggered when the drag behavior is stopped within the scope of the component. 19516 * 19517 * @param { function } event 19518 * @returns { T } 19519 * @syscap SystemCapability.ArkUI.ArkUI.Full 19520 * @crossplatform 19521 * @atomicservice 19522 * @since 14 19523 */ 19524 onDrop(event: (event: DragEvent, extraParams?: string) => void): T; 19525 19526 /** 19527 * The component bound to this event can be used as the drag release target. 19528 * This callback is triggered when the drag behavior is stopped within the scope of the component. 19529 * 19530 * @param { OnDragEventCallback } eventCallback - event callback. 19531 * @param { DropOptions } [dropOptions] - the drop handling options. 19532 * @returns { T } 19533 * @syscap SystemCapability.ArkUI.ArkUI.Full 19534 * @crossplatform 19535 * @atomicservice 19536 * @since 15 19537 */ 19538 onDrop(eventCallback: OnDragEventCallback, dropOptions?: DropOptions): T; 19539 19540 /** 19541 * This function is called when the drag event is end. 19542 * 19543 * @param { function } event - indicates the function to be called. 19544 * @returns { T } property value of type T. 19545 * @syscap SystemCapability.ArkUI.ArkUI.Full 19546 * @since 10 19547 */ 19548 /** 19549 * This function is called when the drag event is end. 19550 * 19551 * @param { function } event - indicates the function to be called. 19552 * @returns { T } property value of type T. 19553 * @syscap SystemCapability.ArkUI.ArkUI.Full 19554 * @atomicservice 19555 * @since 11 19556 */ 19557 /** 19558 * This function is called when the drag event is end. 19559 * 19560 * @param { function } event - indicates the function to be called. 19561 * @returns { T } property value of type T. 19562 * @syscap SystemCapability.ArkUI.ArkUI.Full 19563 * @crossplatform 19564 * @atomicservice 19565 * @since 14 19566 */ 19567 onDragEnd(event: (event: DragEvent, extraParams?: string) => void): T; 19568 19569 /** 19570 * Allowed drop uniformData type for this node. 19571 * 19572 * @param { Array<UniformDataType> } value - the uniformData type for this node. 19573 * @returns { T } property value of type T. 19574 * @syscap SystemCapability.ArkUI.ArkUI.Full 19575 * @crossplatform 19576 * @since 10 19577 */ 19578 /** 19579 * Allowed drop uniformData type for this node. 19580 * 19581 * @param { Array<UniformDataType> } value - the uniformData type for this node. 19582 * @returns { T } property value of type T. 19583 * @syscap SystemCapability.ArkUI.ArkUI.Full 19584 * @crossplatform 19585 * @atomicservice 19586 * @since 11 19587 */ 19588 /** 19589 * Allowed drop uniformData type for this node. 19590 * 19591 * @param { Array<UniformDataType> | null } value - the uniformData type for this node. 19592 * @returns { T } property value of type T. 19593 * @syscap SystemCapability.ArkUI.ArkUI.Full 19594 * @crossplatform 19595 * @atomicservice 19596 * @since 12 19597 */ 19598 allowDrop(value: Array<UniformDataType> | null): T; 19599 19600 /** 19601 * Enable the selectable area can be dragged. 19602 * 19603 * @param { boolean } value - true means the area can be dragged, false means the area can't be dragged. 19604 * @returns { T } property value of type T. 19605 * @syscap SystemCapability.ArkUI.ArkUI.Full 19606 * @since 10 19607 */ 19608 /** 19609 * Enable the selectable area can be dragged. 19610 * 19611 * @param { boolean } value - true means the area can be dragged, false means the area can't be dragged. 19612 * @returns { T } property value of type T. 19613 * @syscap SystemCapability.ArkUI.ArkUI.Full 19614 * @crossplatform 19615 * @atomicservice 19616 * @since 11 19617 */ 19618 draggable(value: boolean): T; 19619 19620 /** 19621 * Set preview of the component for dragging process 19622 * 19623 * @param { CustomBuilder | DragItemInfo } value - preview of the component for dragging process 19624 * @returns { T } property value of type T. 19625 * @syscap SystemCapability.ArkUI.ArkUI.Full 19626 * @since 11 19627 */ 19628 /** 19629 * Set preview of the component for dragging process 19630 * 19631 * @param { CustomBuilder | DragItemInfo | string } value - preview of the component for dragging process 19632 * @returns { T } property value of type T. 19633 * @syscap SystemCapability.ArkUI.ArkUI.Full 19634 * @atomicservice 19635 * @since 12 19636 */ 19637 dragPreview(value: CustomBuilder | DragItemInfo | string): T; 19638 19639 /** 19640 * Set preview of the component for dragging process 19641 * 19642 * @param { CustomBuilder | DragItemInfo | string } preview - preview of the component for dragging process 19643 * @param { PreviewConfiguration } config - drag preview configuration. 19644 * @returns { T } property value of type T. 19645 * @syscap SystemCapability.ArkUI.ArkUI.Full 19646 * @atomicservice 19647 * @since 15 19648 */ 19649 dragPreview(preview: CustomBuilder | DragItemInfo | string, config?: PreviewConfiguration): T; 19650 19651 /** 19652 * Set the selectable area drag preview options. 19653 * 19654 * @param { DragPreviewOptions } value - preview options value. 19655 * @returns { T } property value of type T. 19656 * @syscap SystemCapability.ArkUI.ArkUI.Full 19657 * @since 11 19658 */ 19659 /** 19660 * Set the selectable area drag preview options. 19661 * 19662 * @param { DragPreviewOptions } value - preview options value. 19663 * @param { DragInteractionOptions } options - drag interaction options value. 19664 * @returns { T } property value of type T. 19665 * @syscap SystemCapability.ArkUI.ArkUI.Full 19666 * @atomicservice 19667 * @since 12 19668 */ 19669 dragPreviewOptions(value: DragPreviewOptions, options?: DragInteractionOptions): T; 19670 19671 /** 19672 * After binding, a callback is triggered when the preDrag status change finished. 19673 * 19674 * @param { Callback<PreDragStatus> } callback callback - The callback will be triggered when the preDrag status change. 19675 * @returns { T } property value of type T. 19676 * @syscap SystemCapability.ArkUI.ArkUI.Full 19677 * @atomicservice 19678 * @since 12 19679 */ 19680 onPreDrag(callback: Callback<PreDragStatus>): T; 19681 19682 /** 19683 * Add mask text to the current component. The layout is the same as that of the current component. 19684 * 19685 * @param { string } value 19686 * @param { object } options 19687 * @returns { T } 19688 * @syscap SystemCapability.ArkUI.ArkUI.Full 19689 * @since 7 19690 */ 19691 /** 19692 * Add mask text to the current component. The layout is the same as that of the current component. 19693 * 19694 * @param { string } value 19695 * @param { object } options 19696 * @returns { T } 19697 * @syscap SystemCapability.ArkUI.ArkUI.Full 19698 * @form 19699 * @since 9 19700 */ 19701 /** 19702 * Add mask text to the current component. The layout is the same as that of the current component. 19703 * 19704 * @param { string | CustomBuilder } value 19705 * @param { object } options 19706 * @returns { T } 19707 * @syscap SystemCapability.ArkUI.ArkUI.Full 19708 * @crossplatform 19709 * @form 19710 * @since 10 19711 */ 19712 /** 19713 * Add mask text to the current component. The layout is the same as that of the current component. 19714 * 19715 * @param { string | CustomBuilder } value 19716 * @param { object } options 19717 * @returns { T } 19718 * @syscap SystemCapability.ArkUI.ArkUI.Full 19719 * @crossplatform 19720 * @form 19721 * @atomicservice 19722 * @since 11 19723 */ 19724 /** 19725 * Add mask text to the current component. The layout is the same as that of the current component. 19726 * 19727 * @param { string | CustomBuilder | ComponentContent } value 19728 * @param { OverlayOptions } options 19729 * @returns { T } 19730 * @syscap SystemCapability.ArkUI.ArkUI.Full 19731 * @crossplatform 19732 * @form 19733 * @atomicservice 19734 * @since 12 19735 */ 19736 overlay(value: string | CustomBuilder | ComponentContent, options?: OverlayOptions): T; 19737 19738 /** 19739 * Linear Gradient 19740 * angle: Angle of Linear Gradient. The default value is 180; 19741 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 19742 * colors: Color description for gradients. 19743 * repeating: repeating. The default value is false 19744 * 19745 * @param { object } value 19746 * @returns { T } 19747 * @syscap SystemCapability.ArkUI.ArkUI.Full 19748 * @since 7 19749 */ 19750 /** 19751 * Linear Gradient 19752 * angle: Angle of Linear Gradient. The default value is 180; 19753 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 19754 * colors: Color description for gradients. 19755 * repeating: repeating. The default value is false 19756 * 19757 * @param { object } value 19758 * @returns { T } 19759 * @syscap SystemCapability.ArkUI.ArkUI.Full 19760 * @form 19761 * @since 9 19762 */ 19763 /** 19764 * Linear Gradient 19765 * angle: Angle of Linear Gradient. The default value is 180; 19766 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 19767 * colors: Color description for gradients. 19768 * repeating: repeating. The default value is false 19769 * 19770 * @param { object } value 19771 * @returns { T } 19772 * @syscap SystemCapability.ArkUI.ArkUI.Full 19773 * @crossplatform 19774 * @form 19775 * @since 10 19776 */ 19777 /** 19778 * Linear Gradient 19779 * angle: Angle of Linear Gradient. The default value is 180; 19780 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 19781 * colors: Color description for gradients. 19782 * repeating: repeating. The default value is false 19783 * 19784 * @param { object } value 19785 * @returns { T } 19786 * @syscap SystemCapability.ArkUI.ArkUI.Full 19787 * @crossplatform 19788 * @form 19789 * @atomicservice 19790 * @since 11 19791 */ 19792 /** 19793 * Linear Gradient 19794 * angle: Angle of Linear Gradient; direction:Direction of Linear Gradient; colors:Color description for gradients,repeating:repeating. 19795 * 19796 * @param { object } value 19797 * @returns { T } 19798 * @syscap SystemCapability.ArkUI.ArkUI.Full 19799 * @crossplatform 19800 * @form 19801 * @atomicservice 19802 * @since 12 19803 */ 19804 linearGradient(value: { 19805 angle?: number | string; 19806 direction?: GradientDirection; 19807 colors: Array<[ResourceColor, number]>; 19808 repeating?: boolean; 19809 }): T; 19810 19811 /** 19812 * Angle Gradient 19813 * center:is the center point of the angle gradient 19814 * start:Start point of angle gradient. The default value is 0 19815 * end:End point of angle gradient. The default value is 0 19816 * number:number 19817 * rotating:rotating. The default value is 0 19818 * colors:Color description for gradients 19819 * repeating:repeating. The default value is false 19820 * 19821 * @param { object } value 19822 * @returns { T } 19823 * @syscap SystemCapability.ArkUI.ArkUI.Full 19824 * @since 7 19825 */ 19826 /** 19827 * Angle Gradient 19828 * center:is the center point of the angle gradient 19829 * start:Start point of angle gradient. The default value is 0 19830 * end:End point of angle gradient. The default value is 0 19831 * number:number 19832 * rotating:rotating. The default value is 0 19833 * colors:Color description for gradients 19834 * repeating:repeating. The default value is false 19835 * 19836 * @param { object } value 19837 * @returns { T } 19838 * @syscap SystemCapability.ArkUI.ArkUI.Full 19839 * @form 19840 * @since 9 19841 */ 19842 /** 19843 * Angle Gradient 19844 * center:is the center point of the angle gradient 19845 * start:Start point of angle gradient. The default value is 0 19846 * end:End point of angle gradient. The default value is 0 19847 * number:number 19848 * rotating:rotating. The default value is 0 19849 * colors:Color description for gradients 19850 * repeating:repeating. The default value is false 19851 * 19852 * @param { object } value 19853 * @returns { T } 19854 * @syscap SystemCapability.ArkUI.ArkUI.Full 19855 * @crossplatform 19856 * @form 19857 * @since 10 19858 */ 19859 /** 19860 * Angle Gradient 19861 * center:is the center point of the angle gradient 19862 * start:Start point of angle gradient. The default value is 0 19863 * end:End point of angle gradient. The default value is 0 19864 * number:number 19865 * rotating:rotating. The default value is 0 19866 * colors:Color description for gradients 19867 * repeating:repeating. The default value is false 19868 * 19869 * @param { object } value 19870 * @returns { T } 19871 * @syscap SystemCapability.ArkUI.ArkUI.Full 19872 * @crossplatform 19873 * @form 19874 * @atomicservice 19875 * @since 11 19876 */ 19877 /** 19878 * Angle Gradient 19879 * center:is the center point of the angle gradient 19880 * start:Start point of angle gradient 19881 * end:End point of angle gradient 19882 * number:number 19883 * rotating:rotating 19884 * colors:Color description for gradients 19885 * repeating:repeating 19886 * 19887 * @param { object } value 19888 * @returns { T } 19889 * @syscap SystemCapability.ArkUI.ArkUI.Full 19890 * @crossplatform 19891 * @form 19892 * @atomicservice 19893 * @since 12 19894 */ 19895 sweepGradient(value: { 19896 center: [Length, Length]; 19897 start?: number | string; 19898 end?: number | string; 19899 rotation?: number | string; 19900 colors: Array<[ResourceColor, number]>; 19901 repeating?: boolean; 19902 }): T; 19903 19904 /** 19905 * Radial Gradient 19906 * center:Center point of radial gradient 19907 * radius:Radius of Radial Gradient. value range [0, +∞) 19908 * colors:Color description for gradients 19909 * repeating: Refill. The default value is false 19910 * 19911 * @param { object } value 19912 * @returns { T } 19913 * @syscap SystemCapability.ArkUI.ArkUI.Full 19914 * @since 7 19915 */ 19916 /** 19917 * Radial Gradient 19918 * center:Center point of radial gradient 19919 * radius:Radius of Radial Gradient. value range [0, +∞) 19920 * colors:Color description for gradients 19921 * repeating: Refill. The default value is false 19922 * 19923 * @param { object } value 19924 * @returns { T } 19925 * @syscap SystemCapability.ArkUI.ArkUI.Full 19926 * @form 19927 * @since 9 19928 */ 19929 /** 19930 * Radial Gradient 19931 * center:Center point of radial gradient 19932 * radius:Radius of Radial Gradient. value range [0, +∞) 19933 * colors:Color description for gradients 19934 * repeating: Refill. The default value is false 19935 * 19936 * @param { object } value 19937 * @returns { T } 19938 * @syscap SystemCapability.ArkUI.ArkUI.Full 19939 * @crossplatform 19940 * @form 19941 * @since 10 19942 */ 19943 /** 19944 * Radial Gradient 19945 * center:Center point of radial gradient 19946 * radius:Radius of Radial Gradient. value range [0, +∞) 19947 * colors:Color description for gradients 19948 * repeating: Refill. The default value is false 19949 * 19950 * @param { object } value 19951 * @returns { T } 19952 * @syscap SystemCapability.ArkUI.ArkUI.Full 19953 * @crossplatform 19954 * @form 19955 * @atomicservice 19956 * @since 11 19957 */ 19958 /** 19959 * Radial Gradient 19960 * center:Center point of radial gradient 19961 * radius:Radius of Radial Gradient 19962 * colors:Color description for gradients 19963 * repeating: Refill 19964 * 19965 * @param { object } value 19966 * @returns { T } 19967 * @syscap SystemCapability.ArkUI.ArkUI.Full 19968 * @crossplatform 19969 * @form 19970 * @atomicservice 19971 * @since 12 19972 */ 19973 radialGradient(value: { 19974 center: [Length, Length]; 19975 radius: number | string; 19976 colors: Array<[ResourceColor, number]>; 19977 repeating?: boolean; 19978 }): T; 19979 19980 /** 19981 * Set the motion path of the component 19982 * path:Motion path for displacement animation, using the svg path string. 19983 * from:Start point of the motion path. The default value is 0.0. 19984 * to:End point of the motion path. The default value is 1.0. 19985 * rotatable:Whether to follow the path for rotation. 19986 * 19987 * @param { MotionPathOptions } value 19988 * @returns { T } 19989 * @syscap SystemCapability.ArkUI.ArkUI.Full 19990 * @since 7 19991 */ 19992 /** 19993 * Set the motion path of the component 19994 * path:Motion path for displacement animation, using the svg path string. 19995 * from:Start point of the motion path. The default value is 0.0. 19996 * to:End point of the motion path. The default value is 1.0. 19997 * rotatable:Whether to follow the path for rotation. 19998 * 19999 * @param { MotionPathOptions } value 20000 * @returns { T } 20001 * @syscap SystemCapability.ArkUI.ArkUI.Full 20002 * @crossplatform 20003 * @since 10 20004 */ 20005 /** 20006 * Set the motion path of the component 20007 * path:Motion path for displacement animation, using the svg path string. 20008 * from:Start point of the motion path. The default value is 0.0. 20009 * to:End point of the motion path. The default value is 1.0. 20010 * rotatable:Whether to follow the path for rotation. 20011 * 20012 * @param { MotionPathOptions } value 20013 * @returns { T } 20014 * @syscap SystemCapability.ArkUI.ArkUI.Full 20015 * @crossplatform 20016 * @atomicservice 20017 * @since 11 20018 */ 20019 motionPath(value: MotionPathOptions): T; 20020 20021 /** 20022 * Add a shadow effect to the current component 20023 * 20024 * @param { ShadowOptions } value 20025 * @returns { T } 20026 * @syscap SystemCapability.ArkUI.ArkUI.Full 20027 * @since 7 20028 */ 20029 /** 20030 * Add a shadow effect to the current component 20031 * 20032 * @param { ShadowOptions } value 20033 * @returns { T } 20034 * @syscap SystemCapability.ArkUI.ArkUI.Full 20035 * @form 20036 * @since 9 20037 */ 20038 /** 20039 * Add a shadow effect to the current component 20040 * 20041 * @param { ShadowOptions | ShadowStyle } value 20042 * @returns { T } 20043 * @syscap SystemCapability.ArkUI.ArkUI.Full 20044 * @crossplatform 20045 * @form 20046 * @since 10 20047 */ 20048 /** 20049 * Add a shadow effect to the current component 20050 * 20051 * @param { ShadowOptions | ShadowStyle } value 20052 * @returns { T } 20053 * @syscap SystemCapability.ArkUI.ArkUI.Full 20054 * @crossplatform 20055 * @form 20056 * @atomicservice 20057 * @since 11 20058 */ 20059 shadow(value: ShadowOptions | ShadowStyle): T; 20060 20061 /** 20062 * Add a blendMode effect to the current component 20063 * 20064 * @param { BlendMode } value - Different hybrid modes 20065 * @param { BlendApplyType } [type] - Different blend apply type 20066 * @returns { T } 20067 * @syscap SystemCapability.ArkUI.ArkUI.Full 20068 * @crossplatform 20069 * @form 20070 * @since 11 20071 */ 20072 /** 20073 * Add a blendMode effect to the current component 20074 * 20075 * @param { BlendMode } value - Different hybrid modes 20076 * @param { BlendApplyType } [type] - Different blend apply type 20077 * @returns { T } 20078 * @syscap SystemCapability.ArkUI.ArkUI.Full 20079 * @crossplatform 20080 * @form 20081 * @atomicservice 20082 * @since 12 20083 */ 20084 blendMode(value: BlendMode, type?: BlendApplyType): T; 20085 20086 /** 20087 * Add a blendMode effect to the current component.Cannot be used together with the blendMode interface. 20088 * 20089 * @param { BlendMode | Blender } effect - When the effect type is BlendMode type, define Different hybrid modes. 20090 * When the effect type is Blender type, Define the corresponding blending effect. 20091 * @param { BlendApplyType } [type] - Different blend apply type 20092 * @returns { T } 20093 * @syscap SystemCapability.ArkUI.ArkUI.Full 20094 * @systemapi 20095 * @form 20096 * @since 13 20097 */ 20098 advancedBlendMode(effect: BlendMode | Blender, type?: BlendApplyType): T; 20099 20100 /** 20101 * Whether to crop the sub components beyond the current component range. 20102 * 20103 * @param { boolean } value 20104 * @returns { T } 20105 * @syscap SystemCapability.ArkUI.ArkUI.Full 20106 * @crossplatform 20107 * @form 20108 * @atomicservice 20109 * @since 12 20110 */ 20111 clip(value: boolean): T; 20112 20113 /** 20114 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 20115 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 20116 * 20117 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value 20118 * @returns { T } 20119 * @syscap SystemCapability.ArkUI.ArkUI.Full 20120 * @since 7 20121 */ 20122 /** 20123 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 20124 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 20125 * 20126 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value 20127 * @returns { T } 20128 * @syscap SystemCapability.ArkUI.ArkUI.Full 20129 * @form 20130 * @since 9 20131 */ 20132 /** 20133 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 20134 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 20135 * 20136 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value 20137 * @returns { T } 20138 * @syscap SystemCapability.ArkUI.ArkUI.Full 20139 * @crossplatform 20140 * @form 20141 * @since 10 20142 */ 20143 /** 20144 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 20145 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 20146 * 20147 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value 20148 * @returns { T } 20149 * @syscap SystemCapability.ArkUI.ArkUI.Full 20150 * @crossplatform 20151 * @form 20152 * @atomicservice 20153 * @since 11 20154 * @deprecated since 12 20155 * @useinstead CommonMethod#clipShape 20156 */ 20157 clip(value: boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute): T; 20158 20159 /** 20160 * The current component is cropped according to the specified shape. 20161 * 20162 * @param { CircleShape | EllipseShape | PathShape | RectShape } value - indicates the shape of the clip. 20163 * @returns { T } 20164 * @syscap SystemCapability.ArkUI.ArkUI.Full 20165 * @crossplatform 20166 * @form 20167 * @atomicservice 20168 * @since 12 20169 */ 20170 clipShape(value: CircleShape | EllipseShape | PathShape | RectShape): T; 20171 20172 /** 20173 * Sets the mask of the current component. 20174 * 20175 * @param { ProgressMask } value 20176 * @returns { T } 20177 * @syscap SystemCapability.ArkUI.ArkUI.Full 20178 * @crossplatform 20179 * @atomicservice 20180 * @since 12 20181 */ 20182 mask(value: ProgressMask): T; 20183 20184 /** 20185 * Applies a mask of the specified shape to the current assembly. 20186 * 20187 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value 20188 * @returns { T } 20189 * @syscap SystemCapability.ArkUI.ArkUI.Full 20190 * @since 7 20191 */ 20192 /** 20193 * Applies a mask of the specified shape to the current assembly. 20194 * 20195 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value - indicates the shape of the mask. 20196 * @returns { T } 20197 * @syscap SystemCapability.ArkUI.ArkUI.Full 20198 * @form 20199 * @since 9 20200 */ 20201 /** 20202 * Applies a mask of the specified shape to the current assembly. 20203 * 20204 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value - indicates the shape of the mask. 20205 * @returns { T } 20206 * @syscap SystemCapability.ArkUI.ArkUI.Full 20207 * @crossplatform 20208 * @form 20209 * @since 10 20210 */ 20211 /** 20212 * Applies a mask of the specified shape to the current assembly. 20213 * 20214 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value - indicates the shape of the mask. 20215 * @returns { T } 20216 * @syscap SystemCapability.ArkUI.ArkUI.Full 20217 * @crossplatform 20218 * @form 20219 * @atomicservice 20220 * @since 11 20221 * @deprecated since 12 20222 * @useinstead CommonMethod#maskShape 20223 */ 20224 mask(value: CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask): T; 20225 20226 /** 20227 * Applies a mask of the specified shape to the current assembly. 20228 * 20229 * @param { CircleShape | EllipseShape | PathShape | RectShape } value - indicates the shape of the mask. 20230 * @returns { T } 20231 * @syscap SystemCapability.ArkUI.ArkUI.Full 20232 * @crossplatform 20233 * @form 20234 * @atomicservice 20235 * @since 12 20236 */ 20237 maskShape(value: CircleShape | EllipseShape | PathShape | RectShape): T; 20238 20239 /** 20240 * Key. User can set an key to the component to identify it. 20241 * 20242 * @param { string } value 20243 * @returns { T } 20244 * @syscap SystemCapability.ArkUI.ArkUI.Full 20245 * @atomicservice 20246 * @since 12 20247 * @test 20248 */ 20249 key(value: string): T; 20250 20251 /** 20252 * Id. User can set an id to the component to identify it. 20253 * 20254 * @param { string } value 20255 * @returns { T } 20256 * @syscap SystemCapability.ArkUI.ArkUI.Full 20257 * @since 8 20258 */ 20259 /** 20260 * Id. User can set an id to the component to identify it. 20261 * 20262 * @param { string } value 20263 * @returns { T } 20264 * @syscap SystemCapability.ArkUI.ArkUI.Full 20265 * @form 20266 * @since 9 20267 */ 20268 /** 20269 * Id. User can set an id to the component to identify it. 20270 * 20271 * @param { string } value 20272 * @returns { T } 20273 * @syscap SystemCapability.ArkUI.ArkUI.Full 20274 * @crossplatform 20275 * @form 20276 * @since 10 20277 */ 20278 /** 20279 * Id. User can set an id to the component to identify it. 20280 * 20281 * @param { string } value 20282 * @returns { T } 20283 * @syscap SystemCapability.ArkUI.ArkUI.Full 20284 * @crossplatform 20285 * @form 20286 * @atomicservice 20287 * @since 11 20288 */ 20289 id(value: string): T; 20290 20291 /** 20292 * geometryTransition 20293 * 20294 * @param { string } id 20295 * @returns { T } 20296 * @syscap SystemCapability.ArkUI.ArkUI.Full 20297 * @since 7 20298 */ 20299 /** 20300 * geometryTransition 20301 * 20302 * @param { string } id 20303 * @returns { T } 20304 * @syscap SystemCapability.ArkUI.ArkUI.Full 20305 * @crossplatform 20306 * @since 10 20307 */ 20308 /** 20309 * geometryTransition 20310 * 20311 * @param { string } id 20312 * @returns { T } 20313 * @syscap SystemCapability.ArkUI.ArkUI.Full 20314 * @crossplatform 20315 * @atomicservice 20316 * @since 11 20317 */ 20318 geometryTransition(id: string): T; 20319 /** 20320 * Shared geometry transition 20321 * 20322 * @param { string } id - geometry transition id 20323 * @param { GeometryTransitionOptions } options - Indicates the options of geometry transition. 20324 * @returns { T } 20325 * @syscap SystemCapability.ArkUI.ArkUI.Full 20326 * @crossplatform 20327 * @since 11 20328 */ 20329 /** 20330 * Shared geometry transition 20331 * 20332 * @param { string } id - geometry transition id 20333 * @param { GeometryTransitionOptions } options - Indicates the options of geometry transition. 20334 * @returns { T } 20335 * @syscap SystemCapability.ArkUI.ArkUI.Full 20336 * @crossplatform 20337 * @atomicservice 20338 * @since 12 20339 */ 20340 geometryTransition(id: string, options?: GeometryTransitionOptions): T; 20341 20342 /** 20343 * Popup control 20344 * 20345 * @param { boolean } show 20346 * @param { PopupOptions } popup 20347 * @returns { T } 20348 * @syscap SystemCapability.ArkUI.ArkUI.Full 20349 * @since 7 20350 */ 20351 /** 20352 * Popup control 20353 * 20354 * @param { boolean } show 20355 * @param { PopupOptions | CustomPopupOptions } popup 20356 * @returns { T } 20357 * @syscap SystemCapability.ArkUI.ArkUI.Full 20358 * @since 8 20359 */ 20360 /** 20361 * Popup control 20362 * 20363 * @param { boolean } show 20364 * @param { PopupOptions | CustomPopupOptions } popup 20365 * @returns { T } 20366 * @syscap SystemCapability.ArkUI.ArkUI.Full 20367 * @crossplatform 20368 * @atomicservice 20369 * @since 11 20370 */ 20371 bindPopup(show: boolean, popup: PopupOptions | CustomPopupOptions): T; 20372 20373 /** 20374 * Menu control 20375 * 20376 * @param { { value: ResourceStr; icon?: ResourceStr; action: () => void }[] | CustomBuilder } content 20377 * action: () => void }[] | CustomBuilder } content - Indicates the content of menu. 20378 * @param { MenuOptions } options 20379 * @returns { T } 20380 * @syscap SystemCapability.ArkUI.ArkUI.Full 20381 * @since 7 20382 */ 20383 /** 20384 * Menu control 20385 * 20386 * @param { { value: ResourceStr; icon?: ResourceStr; action: () => void }[] | CustomBuilder } content 20387 * action: () => void }[] | CustomBuilder } content - Indicates the content of menu. 20388 * @param { MenuOptions } options - Indicates the options of menu. 20389 * @returns { T } 20390 * @syscap SystemCapability.ArkUI.ArkUI.Full 20391 * @crossplatform 20392 * @since 10 20393 */ 20394 /** 20395 * Menu control 20396 * 20397 * @param { Array<MenuElement> | CustomBuilder } content - Indicates the content of menu. 20398 * @param { MenuOptions } options - Indicates the options of menu. 20399 * @returns { T } 20400 * @syscap SystemCapability.ArkUI.ArkUI.Full 20401 * @crossplatform 20402 * @atomicservice 20403 * @since 11 20404 */ 20405 bindMenu(content: Array<MenuElement> | CustomBuilder, options?: MenuOptions): T; 20406 20407 /** 20408 * Menu control 20409 * 20410 * @param { boolean } isShow true means display menu, false means hide menu. 20411 * @param { Array<MenuElement> | CustomBuilder } content - Indicates the content of menu. 20412 * @param { MenuOptions } options - Indicates the options of menu. 20413 * @returns { T } 20414 * @syscap SystemCapability.ArkUI.ArkUI.Full 20415 * @crossplatform 20416 * @since 11 20417 */ 20418 /** 20419 * Menu control 20420 * 20421 * @param { boolean } isShow true means display menu, false means hide menu. 20422 * @param { Array<MenuElement> | CustomBuilder } content - Indicates the content of menu. 20423 * @param { MenuOptions } options - Indicates the options of menu. 20424 * @returns { T } 20425 * @syscap SystemCapability.ArkUI.ArkUI.Full 20426 * @crossplatform 20427 * @atomicservice 20428 * @since 12 20429 */ 20430 bindMenu(isShow: boolean, content: Array<MenuElement> | CustomBuilder, options?: MenuOptions): T; 20431 20432 /** 20433 * ContextMenu control 20434 * 20435 * @param { CustomBuilder } content 20436 * @param { ResponseType } responseType 20437 * @param { ContextMenuOptions } options 20438 * @returns { T } 20439 * @syscap SystemCapability.ArkUI.ArkUI.Full 20440 * @since 8 20441 */ 20442 /** 20443 * ContextMenu control 20444 * 20445 * @param { CustomBuilder } content - Indicates the content of context menu. 20446 * @param { ResponseType } responseType - Indicates response type of context menu. 20447 * @param { ContextMenuOptions } options - Indicates the options of context menu. 20448 * @returns { T } 20449 * @syscap SystemCapability.ArkUI.ArkUI.Full 20450 * @crossplatform 20451 * @since 10 20452 */ 20453 /** 20454 * ContextMenu control 20455 * 20456 * @param { CustomBuilder } content - Indicates the content of context menu. 20457 * @param { ResponseType } responseType - Indicates response type of context menu. 20458 * @param { ContextMenuOptions } options - Indicates the options of context menu. 20459 * @returns { T } 20460 * @syscap SystemCapability.ArkUI.ArkUI.Full 20461 * @crossplatform 20462 * @atomicservice 20463 * @since 11 20464 */ 20465 bindContextMenu(content: CustomBuilder, responseType: ResponseType, options?: ContextMenuOptions): T; 20466 20467 /** 20468 * ContextMenu control 20469 * 20470 * @param { boolean } isShown - true means display content, false means hide content. 20471 * @param { CustomBuilder } content - Indicates the content of context menu. 20472 * @param { ContextMenuOptions } [options] - Indicates the options of context menu. 20473 * @returns { T } 20474 * @syscap SystemCapability.ArkUI.ArkUI.Full 20475 * @crossplatform 20476 * @atomicservice 20477 * @since 12 20478 */ 20479 bindContextMenu(isShown: boolean, content: CustomBuilder, options?: ContextMenuOptions): T; 20480 20481 /** 20482 * Bind content cover 20483 * 20484 * @param { boolean } isShow - true means display content, false means hide content. 20485 * @param { CustomBuilder } builder - the content to be displayed. 20486 * @param { ModalTransition } type - transition type. 20487 * @returns { T } 20488 * @syscap SystemCapability.ArkUI.ArkUI.Full 20489 * @crossplatform 20490 * @since 10 20491 */ 20492 /** 20493 * Bind content cover 20494 * 20495 * @param { boolean } isShow - true means display content, false means hide content. 20496 * @param { CustomBuilder } builder - the content to be displayed. 20497 * @param { ModalTransition } type - transition type. 20498 * @returns { T } 20499 * @syscap SystemCapability.ArkUI.ArkUI.Full 20500 * @crossplatform 20501 * @atomicservice 20502 * @since 11 20503 */ 20504 bindContentCover(isShow: boolean, builder: CustomBuilder, type?: ModalTransition): T; 20505 20506 /** 20507 * Bind content cover 20508 * 20509 * @param { boolean } isShow - true means display content, false means hide content. 20510 * @param { CustomBuilder } builder - the content to be displayed. 20511 * @param { ContentCoverOptions } options - options of content cover. 20512 * @returns { T } 20513 * @syscap SystemCapability.ArkUI.ArkUI.Full 20514 * @crossplatform 20515 * @since 10 20516 */ 20517 /** 20518 * Bind content cover 20519 * 20520 * @param { boolean } isShow - true means display content, false means hide content. 20521 * @param { CustomBuilder } builder - the content to be displayed. 20522 * @param { ContentCoverOptions } options - options of content cover. 20523 * @returns { T } 20524 * @syscap SystemCapability.ArkUI.ArkUI.Full 20525 * @crossplatform 20526 * @atomicservice 20527 * @since 11 20528 */ 20529 bindContentCover(isShow: boolean, builder: CustomBuilder, options?: ContentCoverOptions): T; 20530 20531 /** 20532 * Bind sheet 20533 * 20534 * @param { boolean } isShow - true means display sheet, false means hide sheet. 20535 * @param { CustomBuilder } builder - the sheet to be displayed. 20536 * @param { SheetOptions } options - options of sheet. 20537 * @returns { T } - template type 20538 * @syscap SystemCapability.ArkUI.ArkUI.Full 20539 * @crossplatform 20540 * @since 10 20541 */ 20542 /** 20543 * Bind sheet 20544 * 20545 * @param { boolean } isShow - true means display sheet, false means hide sheet. 20546 * @param { CustomBuilder } builder - the sheet to be displayed. 20547 * @param { SheetOptions } options - options of sheet. 20548 * @returns { T } - template type 20549 * @syscap SystemCapability.ArkUI.ArkUI.Full 20550 * @crossplatform 20551 * @atomicservice 20552 * @since 11 20553 */ 20554 bindSheet(isShow: boolean, builder: CustomBuilder, options?: SheetOptions): T; 20555 20556 /** 20557 * Sets styles for component state. 20558 * 20559 * @param { StateStyles } value 20560 * @returns { T } 20561 * @syscap SystemCapability.ArkUI.ArkUI.Full 20562 * @since 8 20563 */ 20564 /** 20565 * Sets styles for component state. 20566 * 20567 * @param { StateStyles } value 20568 * @returns { T } 20569 * @syscap SystemCapability.ArkUI.ArkUI.Full 20570 * @form 20571 * @since 9 20572 */ 20573 /** 20574 * Sets styles for component state. 20575 * 20576 * @param { StateStyles } value 20577 * @returns { T } 20578 * @syscap SystemCapability.ArkUI.ArkUI.Full 20579 * @crossplatform 20580 * @form 20581 * @since 10 20582 */ 20583 /** 20584 * Sets styles for component state. 20585 * 20586 * @param { StateStyles } value 20587 * @returns { T } 20588 * @syscap SystemCapability.ArkUI.ArkUI.Full 20589 * @crossplatform 20590 * @form 20591 * @atomicservice 20592 * @since 11 20593 */ 20594 stateStyles(value: StateStyles): T; 20595 20596 /** 20597 * id for distribute identification. 20598 * 20599 * @param { number } value 20600 * @returns { T } 20601 * @syscap SystemCapability.ArkUI.ArkUI.Full 20602 * @since 8 20603 */ 20604 /** 20605 * id for distribute identification. 20606 * 20607 * @param { number } value 20608 * @returns { T } 20609 * @syscap SystemCapability.ArkUI.ArkUI.Full 20610 * @crossplatform 20611 * @atomicservice 20612 * @since 11 20613 */ 20614 restoreId(value: number): T; 20615 20616 /** 20617 * Trigger a visible area change event. 20618 * 20619 * @param { Array<number> } ratios 20620 * @param { function } event 20621 * @returns { T } 20622 * @syscap SystemCapability.ArkUI.ArkUI.Full 20623 * @since 9 20624 */ 20625 /** 20626 * Trigger a visible area change event. 20627 * 20628 * @param { Array<number> } ratios 20629 * @param { function } event 20630 * @returns { T } 20631 * @syscap SystemCapability.ArkUI.ArkUI.Full 20632 * @crossplatform 20633 * @since 10 20634 */ 20635 /** 20636 * Trigger a visible area change event. 20637 * 20638 * @param { Array<number> } ratios 20639 * @param { function } event 20640 * @returns { T } 20641 * @syscap SystemCapability.ArkUI.ArkUI.Full 20642 * @crossplatform 20643 * @atomicservice 20644 * @since 11 20645 */ 20646 /** 20647 * Trigger a visible area change event. 20648 * 20649 * @param { Array<number> } ratios 20650 * @param { VisibleAreaChangeCallback } event 20651 * @returns { T } 20652 * @syscap SystemCapability.ArkUI.ArkUI.Full 20653 * @crossplatform 20654 * @atomicservice 20655 * @since 13 20656 */ 20657 onVisibleAreaChange(ratios: Array<number>, event: VisibleAreaChangeCallback): T; 20658 20659 /** 20660 * Set the spherical effect of the component. 20661 * 20662 * @param { number } value - set the degree of spherical effect, value range [0, 1]. 20663 * If the value is 0, the component keep same, else the value is 1, component are fully spherical. 20664 * @returns { T } 20665 * @syscap SystemCapability.ArkUI.ArkUI.Full 20666 * @crossplatform 20667 * @atomicservice 20668 * @since 12 20669 */ 20670 sphericalEffect(value: number): T; 20671 20672 /** 20673 * Set the light up effect of the component 20674 * 20675 * @param { number } value - set the degree to which the component lights up, value range [0, 1]. 20676 * The color brightness in the component rendering content area is greater than the value and can be displayed, otherwise it will not be displayed. 20677 * @returns { T } 20678 * @syscap SystemCapability.ArkUI.ArkUI.Full 20679 * @crossplatform 20680 * @atomicservice 20681 * @since 12 20682 */ 20683 lightUpEffect(value: number): T; 20684 20685 /** 20686 * Set the edge pixel stretch effect of the Component. 20687 * 20688 * @param { PixelStretchEffectOptions } options 20689 * @returns { T } 20690 * @syscap SystemCapability.ArkUI.ArkUI.Full 20691 * @crossplatform 20692 * @atomicservice 20693 * @since 12 20694 */ 20695 pixelStretchEffect(options: PixelStretchEffectOptions): T; 20696 20697 /** 20698 * Sets hot keys 20699 * 20700 * @param { string | FunctionKey } value - Character of the combination key. 20701 * @param { Array<ModifierKey> } keys - The modifier keys modify the action of key when the key are pressed at the same time. 20702 * @param { function } [action] - Callback function, triggered when the shortcut keyboard is pressed. 20703 * @returns { T } 20704 * @syscap SystemCapability.ArkUI.ArkUI.Full 20705 * @crossplatform 20706 * @since 10 20707 */ 20708 /** 20709 * Sets hot keys 20710 * 20711 * @param { string | FunctionKey } value - Character of the combination key. 20712 * @param { Array<ModifierKey> } keys - The modifier keys modify the action of key when the key are pressed at the same time. 20713 * @param { function } [action] - Callback function, triggered when the shortcut keyboard is pressed. 20714 * @returns { T } 20715 * @syscap SystemCapability.ArkUI.ArkUI.Full 20716 * @crossplatform 20717 * @atomicservice 20718 * @since 11 20719 */ 20720 keyboardShortcut(value: string | FunctionKey, keys: Array<ModifierKey>, action?: () => void): T; 20721 20722 /** 20723 * Sets accessibilityGroup 20724 * 20725 * @param { boolean } value - set group with accessibility 20726 * @returns { T } 20727 * @syscap SystemCapability.ArkUI.ArkUI.Full 20728 * @crossplatform 20729 * @since 10 20730 */ 20731 /** 20732 * Sets accessibilityGroup 20733 * 20734 * @param { boolean } value - set group with accessibility 20735 * @returns { T } 20736 * @syscap SystemCapability.ArkUI.ArkUI.Full 20737 * @crossplatform 20738 * @atomicservice 20739 * @since 11 20740 */ 20741 /** 20742 * Sets accessibilityGroup 20743 * 20744 * @param { boolean } value - set group with accessibility 20745 * @returns { T } 20746 * @syscap SystemCapability.ArkUI.ArkUI.Full 20747 * @crossplatform 20748 * @form 20749 * @atomicservice 20750 * @since 12 20751 */ 20752 accessibilityGroup(value: boolean): T; 20753 20754 /** 20755 * Sets accessibilityGroup 20756 * 20757 * @param { boolean } isGroup - set group with accessibility 20758 * @param { AccessibilityOptions } accessibilityOptions - accessibilityOptions for accessibility 20759 * @returns { T } 20760 * @syscap SystemCapability.ArkUI.ArkUI.Full 20761 * @crossplatform 20762 * @form 20763 * @atomicservice 20764 * @since 14 20765 */ 20766 accessibilityGroup(isGroup: boolean, accessibilityOptions: AccessibilityOptions): T; 20767 20768 /** 20769 * Sets accessibilityText 20770 * 20771 * @param { string } value - set accessibility text 20772 * @returns { T } 20773 * @syscap SystemCapability.ArkUI.ArkUI.Full 20774 * @crossplatform 20775 * @since 10 20776 */ 20777 /** 20778 * Sets accessibilityText 20779 * 20780 * @param { string } value - set accessibility text 20781 * @returns { T } 20782 * @syscap SystemCapability.ArkUI.ArkUI.Full 20783 * @crossplatform 20784 * @atomicservice 20785 * @since 11 20786 */ 20787 /** 20788 * Sets accessibilityText 20789 * 20790 * @param { string } value - set accessibility text 20791 * @returns { T } 20792 * @syscap SystemCapability.ArkUI.ArkUI.Full 20793 * @crossplatform 20794 * @form 20795 * @atomicservice 20796 * @since 12 20797 */ 20798 accessibilityText(value: string): T; 20799 20800 /** 20801 * Sets accessibilityText 20802 * 20803 * @param { Resource } text - set accessibility text 20804 * @returns { T } 20805 * @syscap SystemCapability.ArkUI.ArkUI.Full 20806 * @crossplatform 20807 * @form 20808 * @atomicservice 20809 * @since 12 20810 */ 20811 accessibilityText(text: Resource): T; 20812 20813 /** 20814 * Sets accessibilityTextHint 20815 * 20816 * @param { string } value - set accessibility text hint 20817 * @returns { T } 20818 * @syscap SystemCapability.ArkUI.ArkUI.Full 20819 * @crossplatform 20820 * @form 20821 * @atomicservice 20822 * @since 12 20823 */ 20824 accessibilityTextHint(value: string): T; 20825 20826 /** 20827 * Sets accessibilityDescription 20828 * 20829 * @param { string } value - set description of accessibility 20830 * @returns { T } 20831 * @syscap SystemCapability.ArkUI.ArkUI.Full 20832 * @crossplatform 20833 * @since 10 20834 */ 20835 /** 20836 * Sets accessibilityDescription 20837 * 20838 * @param { string } value - set description of accessibility 20839 * @returns { T } 20840 * @syscap SystemCapability.ArkUI.ArkUI.Full 20841 * @crossplatform 20842 * @atomicservice 20843 * @since 11 20844 */ 20845 /** 20846 * Sets accessibilityDescription 20847 * 20848 * @param { string } value - set description of accessibility 20849 * @returns { T } 20850 * @syscap SystemCapability.ArkUI.ArkUI.Full 20851 * @crossplatform 20852 * @form 20853 * @atomicservice 20854 * @since 12 20855 */ 20856 accessibilityDescription(value: string): T; 20857 20858 /** 20859 * Sets accessibilityDescription 20860 * 20861 * @param { Resource } description - set description of accessibility 20862 * @returns { T } 20863 * @syscap SystemCapability.ArkUI.ArkUI.Full 20864 * @crossplatform 20865 * @form 20866 * @atomicservice 20867 * @since 12 20868 */ 20869 accessibilityDescription(description: Resource): T; 20870 20871 /** 20872 * Sets accessibilityLevel 20873 * 20874 * @param { string } value - set accessibility level 20875 * @returns { T } 20876 * @syscap SystemCapability.ArkUI.ArkUI.Full 20877 * @crossplatform 20878 * @since 10 20879 */ 20880 /** 20881 * Sets accessibilityLevel 20882 * 20883 * @param { string } value - set accessibility level 20884 * @returns { T } 20885 * @syscap SystemCapability.ArkUI.ArkUI.Full 20886 * @crossplatform 20887 * @atomicservice 20888 * @since 11 20889 */ 20890 /** 20891 * Sets accessibilityLevel 20892 * 20893 * @param { string } value - set accessibility level 20894 * @returns { T } 20895 * @syscap SystemCapability.ArkUI.ArkUI.Full 20896 * @crossplatform 20897 * @form 20898 * @atomicservice 20899 * @since 12 20900 */ 20901 accessibilityLevel(value: string): T; 20902 20903 /** 20904 * Sets accessibilityVirtualNode 20905 * 20906 * @param { CustomBuilder } builder - set virtual node of accessibility 20907 * @returns { T } 20908 * @syscap SystemCapability.ArkUI.ArkUI.Full 20909 * @crossplatform 20910 * @atomicservice 20911 * @since 11 20912 */ 20913 /** 20914 * Sets accessibilityVirtualNode 20915 * 20916 * @param { CustomBuilder } builder - set virtual node of accessibility 20917 * @returns { T } 20918 * @syscap SystemCapability.ArkUI.ArkUI.Full 20919 * @crossplatform 20920 * @form 20921 * @atomicservice 20922 * @since 12 20923 */ 20924 accessibilityVirtualNode(builder: CustomBuilder): T; 20925 20926 /** 20927 * Sets accessibilityChecked 20928 * 20929 * @param { boolean } isCheck - set accessibility checked status 20930 * @returns { T } 20931 * @syscap SystemCapability.ArkUI.ArkUI.Full 20932 * @crossplatform 20933 * @form 20934 * @atomicservice 20935 * @since 13 20936 */ 20937 accessibilityChecked(isCheck: boolean): T; 20938 20939 /** 20940 * Sets accessibilitySelected 20941 * 20942 * @param { boolean } isSelect - set accessibility selected status 20943 * @returns { T } 20944 * @syscap SystemCapability.ArkUI.ArkUI.Full 20945 * @crossplatform 20946 * @form 20947 * @atomicservice 20948 * @since 13 20949 */ 20950 accessibilitySelected(isSelect: boolean): T; 20951 20952 /** 20953 * Sets obscured 20954 * 20955 * @param { Array<ObscuredReasons> } reasons - reasons of obscuration 20956 * @returns { T } 20957 * @syscap SystemCapability.ArkUI.ArkUI.Full 20958 * @crossplatform 20959 * @since 10 20960 */ 20961 /** 20962 * Sets obscured 20963 * 20964 * @param { Array<ObscuredReasons> } reasons - reasons of obscuration 20965 * @returns { T } 20966 * @syscap SystemCapability.ArkUI.ArkUI.Full 20967 * @crossplatform 20968 * @atomicservice 20969 * @since 11 20970 */ 20971 obscured(reasons: Array<ObscuredReasons>): T; 20972 20973 /** 20974 * Reuse id is used for identify the reuse type for each custom node. 20975 * 20976 * @param { string } id - The id for reusable custom node. 20977 * @returns { T } 20978 * @syscap SystemCapability.ArkUI.ArkUI.Full 20979 * @crossplatform 20980 * @since 10 20981 */ 20982 /** 20983 * Reuse id is used for identify the reuse type for each custom node. 20984 * 20985 * @param { string } id - The id for reusable custom node. 20986 * @returns { T } 20987 * @syscap SystemCapability.ArkUI.ArkUI.Full 20988 * @crossplatform 20989 * @atomicservice 20990 * @since 11 20991 */ 20992 reuseId(id: string): T; 20993 20994 /** 20995 * Sets how content is drawn within nodes duration animation 20996 * 20997 * @param { RenderFit } fitMode - The render fit mode of content. 20998 * @returns { T } 20999 * @syscap SystemCapability.ArkUI.ArkUI.Full 21000 * @crossplatform 21001 * @since 10 21002 */ 21003 /** 21004 * Sets how content is drawn within nodes duration animation 21005 * 21006 * @param { RenderFit } fitMode - The render fit mode of content. 21007 * @returns { T } 21008 * @syscap SystemCapability.ArkUI.ArkUI.Full 21009 * @crossplatform 21010 * @atomicservice 21011 * @since 11 21012 */ 21013 renderFit(fitMode: RenderFit): T; 21014 21015 /** 21016 * Sets the attribute modifier. 21017 * 21018 * @param { AttributeModifier<T> } modifier 21019 * @returns { T } 21020 * @syscap SystemCapability.ArkUI.ArkUI.Full 21021 * @crossplatform 21022 * @since 11 21023 */ 21024 /** 21025 * Sets the attribute modifier. 21026 * 21027 * @param { AttributeModifier<T> } modifier 21028 * @returns { T } 21029 * @syscap SystemCapability.ArkUI.ArkUI.Full 21030 * @crossplatform 21031 * @atomicservice 21032 * @since 12 21033 */ 21034 attributeModifier(modifier: AttributeModifier<T>): T; 21035 21036 /** 21037 * Sets the gesture modifier. 21038 * 21039 * @param { GestureModifier } modifier 21040 * @returns { T } 21041 * @syscap SystemCapability.ArkUI.ArkUI.Full 21042 * @crossplatform 21043 * @atomicservice 21044 * @since 12 21045 */ 21046 gestureModifier(modifier: GestureModifier): T; 21047 21048 /** 21049 * Adds a background dynamic light up effect to the current component. 21050 * 21051 * @param { BackgroundBrightnessOptions } params - params indicates BackgroundBrightnessOptions 21052 * @returns { T } 21053 * @syscap SystemCapability.ArkUI.ArkUI.Full 21054 * @atomicservice 21055 * @since 12 21056 */ 21057 backgroundBrightness(params: BackgroundBrightnessOptions): T; 21058 21059 /** 21060 * When a gesture bound to this component will be accepted, a user-defined callback is triggered to get the result 21061 * 21062 * @param { function } callback - A callback instance used when a gesture bound to this component will be accepted. 21063 * @returns { T } 21064 * @syscap SystemCapability.ArkUI.ArkUI.Full 21065 * @crossplatform 21066 * @since 11 21067 */ 21068 /** 21069 * When a gesture bound to this component will be accepted, a user-defined callback is triggered to get the result 21070 * 21071 * @param { function } callback - A callback instance used when a gesture bound to this component will be accepted. 21072 * @returns { T } 21073 * @syscap SystemCapability.ArkUI.ArkUI.Full 21074 * @crossplatform 21075 * @atomicservice 21076 * @since 12 21077 */ 21078 onGestureJudgeBegin(callback: (gestureInfo: GestureInfo, event: BaseGestureEvent) => GestureJudgeResult): T; 21079 21080 /** 21081 * When a gesture bound to this component will be accepted, a user-defined callback is triggered to get the result 21082 * 21083 * @param { GestureRecognizerJudgeBeginCallback } callback - A callback instance used when a gesture bound to this component will be accepted. 21084 * @returns { T } 21085 * @syscap SystemCapability.ArkUI.ArkUI.Full 21086 * @crossplatform 21087 * @atomicservice 21088 * @since 12 21089 */ 21090 onGestureRecognizerJudgeBegin(callback: GestureRecognizerJudgeBeginCallback): T; 21091 21092 /** 21093 * When a gesture bound to this component will be accepted, a user-defined callback is triggered to get the result 21094 * 21095 * @param { GestureRecognizerJudgeBeginCallback } callback - A callback instance used when a gesture bound to this component will be accepted. 21096 * @param { boolean } exposeInnerGesture - This parameter is a flag. This flag determines whether to expose internal gestures. 21097 * @returns { T } 21098 * @syscap SystemCapability.ArkUI.ArkUI.Full 21099 * @crossplatform 21100 * @atomicservice 21101 * 21102 * @since 13 21103 */ 21104 onGestureRecognizerJudgeBegin(callback: GestureRecognizerJudgeBeginCallback, exposeInnerGesture: boolean): T; 21105 21106 /** 21107 * In the touch test phase, the recognizer is selected to form a parallel relationship with other recognizers on the response chain. 21108 * 21109 * @param { ShouldBuiltInRecognizerParallelWithCallback } callback - A callback instance used when a component is doing touch test. 21110 * @returns { T } 21111 * @syscap SystemCapability.ArkUI.ArkUI.Full 21112 * @crossplatform 21113 * @atomicservice 21114 * @since 12 21115 */ 21116 shouldBuiltInRecognizerParallelWith(callback: ShouldBuiltInRecognizerParallelWithCallback): T; 21117 21118 /** 21119 * Events are monopolized by components. 21120 * 21121 * @param { boolean } monopolize - indicate the monopoly of events 21122 * @returns { T } 21123 * @syscap SystemCapability.ArkUI.ArkUI.Full 21124 * @crossplatform 21125 * @since 11 21126 */ 21127 /** 21128 * Events are monopolized by components. 21129 * 21130 * @param { boolean } monopolize - indicate the monopoly of events 21131 * @returns { T } 21132 * @syscap SystemCapability.ArkUI.ArkUI.Full 21133 * @crossplatform 21134 * @atomicservice 21135 * @since 12 21136 */ 21137 monopolizeEvents(monopolize: boolean): T; 21138 21139 /** 21140 * When the component does a touch test, a user-defined callback is triggered. 21141 * 21142 * @param { Callback<TouchEvent, HitTestMode> } callback - A callback instance used when the component does a touch test. 21143 * @returns { T } 21144 * @syscap SystemCapability.ArkUI.ArkUI.Full 21145 * @crossplatform 21146 * @atomicservice 21147 * @since 12 21148 */ 21149 onTouchIntercept(callback: Callback<TouchEvent, HitTestMode>): T; 21150 21151 /** 21152 * This callback is triggered when the size of this component change finished. 21153 * 21154 * @param { SizeChangeCallback } event - event callback. 21155 * @returns { T } 21156 * @syscap SystemCapability.ArkUI.ArkUI.Full 21157 * @crossplatform 21158 * @form 21159 * @atomicservice 21160 * @since 12 21161 */ 21162 onSizeChange(event: SizeChangeCallback): T; 21163} 21164 21165/** 21166 * CommonAttribute for ide. 21167 * 21168 * @extends CommonMethod<CommonAttribute> 21169 * @syscap SystemCapability.ArkUI.ArkUI.Full 21170 * @since 7 21171 */ 21172/** 21173 * CommonAttribute for ide. 21174 * 21175 * @extends CommonMethod<CommonAttribute> 21176 * @syscap SystemCapability.ArkUI.ArkUI.Full 21177 * @form 21178 * @since 9 21179 */ 21180/** 21181 * CommonAttribute for ide. 21182 * 21183 * @extends CommonMethod<CommonAttribute> 21184 * @syscap SystemCapability.ArkUI.ArkUI.Full 21185 * @crossplatform 21186 * @form 21187 * @since 10 21188 */ 21189/** 21190 * CommonAttribute for ide. 21191 * 21192 * @extends CommonMethod<CommonAttribute> 21193 * @syscap SystemCapability.ArkUI.ArkUI.Full 21194 * @crossplatform 21195 * @form 21196 * @atomicservice 21197 * @since 11 21198 */ 21199declare class CommonAttribute extends CommonMethod<CommonAttribute> {} 21200 21201/** 21202 * CommonInterface for ide. 21203 * 21204 * @interface CommonInterface 21205 * @syscap SystemCapability.ArkUI.ArkUI.Full 21206 * @since 7 21207 */ 21208/** 21209 * CommonInterface for ide. 21210 * 21211 * @interface CommonInterface 21212 * @syscap SystemCapability.ArkUI.ArkUI.Full 21213 * @form 21214 * @since 9 21215 */ 21216/** 21217 * CommonInterface for ide. 21218 * 21219 * @interface CommonInterface 21220 * @syscap SystemCapability.ArkUI.ArkUI.Full 21221 * @crossplatform 21222 * @form 21223 * @since 10 21224 */ 21225/** 21226 * CommonInterface for ide. 21227 * 21228 * @interface CommonInterface 21229 * @syscap SystemCapability.ArkUI.ArkUI.Full 21230 * @crossplatform 21231 * @form 21232 * @atomicservice 21233 * @since 11 21234 */ 21235interface CommonInterface { 21236 /** 21237 * Constructor. 21238 * 21239 * @returns { CommonAttribute } 21240 * @syscap SystemCapability.ArkUI.ArkUI.Full 21241 * @since 7 21242 */ 21243 /** 21244 * Constructor 21245 * 21246 * @returns { CommonAttribute } 21247 * @syscap SystemCapability.ArkUI.ArkUI.Full 21248 * @form 21249 * @since 9 21250 */ 21251 /** 21252 * Constructor 21253 * 21254 * @returns { CommonAttribute } 21255 * @syscap SystemCapability.ArkUI.ArkUI.Full 21256 * @crossplatform 21257 * @form 21258 * @since 10 21259 */ 21260 /** 21261 * Constructor 21262 * 21263 * @returns { CommonAttribute } 21264 * @syscap SystemCapability.ArkUI.ArkUI.Full 21265 * @crossplatform 21266 * @form 21267 * @atomicservice 21268 * @since 11 21269 */ 21270 (): CommonAttribute; 21271} 21272 21273/** 21274 * CommonInstance for ide. 21275 * 21276 * @syscap SystemCapability.ArkUI.ArkUI.Full 21277 * @since 7 21278 */ 21279/** 21280 * CommonInstance for ide. 21281 * 21282 * @syscap SystemCapability.ArkUI.ArkUI.Full 21283 * @form 21284 * @since 9 21285 */ 21286/** 21287 * CommonInstance for ide. 21288 * 21289 * @syscap SystemCapability.ArkUI.ArkUI.Full 21290 * @crossplatform 21291 * @form 21292 * @since 10 21293 */ 21294/** 21295 * CommonInstance for ide. 21296 * 21297 * @syscap SystemCapability.ArkUI.ArkUI.Full 21298 * @crossplatform 21299 * @form 21300 * @atomicservice 21301 * @since 11 21302 */ 21303declare const CommonInstance: CommonAttribute; 21304 21305/** 21306 * Common for ide. 21307 * 21308 * @syscap SystemCapability.ArkUI.ArkUI.Full 21309 * @since 7 21310 */ 21311/** 21312 * Common for ide. 21313 * 21314 * @syscap SystemCapability.ArkUI.ArkUI.Full 21315 * @form 21316 * @since 9 21317 */ 21318/** 21319 * Common for ide. 21320 * 21321 * @syscap SystemCapability.ArkUI.ArkUI.Full 21322 * @crossplatform 21323 * @form 21324 * @since 10 21325 */ 21326/** 21327 * Common for ide. 21328 * 21329 * @syscap SystemCapability.ArkUI.ArkUI.Full 21330 * @crossplatform 21331 * @form 21332 * @atomicservice 21333 * @since 11 21334 */ 21335declare const Common: CommonInterface; 21336 21337/** 21338 * Defines the CustomBuilder Type. 21339 * 21340 * @typedef { (() => any) | void } CustomBuilder 21341 * @syscap SystemCapability.ArkUI.ArkUI.Full 21342 * @since 8 21343 */ 21344/** 21345 * Defines the CustomBuilder Type. 21346 * 21347 * @typedef { (() => any) | void } CustomBuilder 21348 * @syscap SystemCapability.ArkUI.ArkUI.Full 21349 * @form 21350 * @since 9 21351 */ 21352/** 21353 * Defines the CustomBuilder Type. 21354 * 21355 * @typedef { (() => any) | void } CustomBuilder 21356 * @syscap SystemCapability.ArkUI.ArkUI.Full 21357 * @crossplatform 21358 * @form 21359 * @since 10 21360 */ 21361/** 21362 * Defines the CustomBuilder Type. 21363 * 21364 * @typedef { (() => any) | void } CustomBuilder 21365 * @syscap SystemCapability.ArkUI.ArkUI.Full 21366 * @crossplatform 21367 * @form 21368 * @atomicservice 21369 * @since 11 21370 */ 21371declare type CustomBuilder = (() => any) | void; 21372 21373/** 21374 * Defines the OverlayOptions interface. 21375 * 21376 * @typedef OverlayOptions 21377 * @syscap SystemCapability.ArkUI.ArkUI.Full 21378 * @crossplatform 21379 * @form 21380 * @atomicservice 21381 * @since 12 21382 */ 21383declare interface OverlayOptions { 21384 /** 21385 * Defines align type. 21386 * 21387 * @type { ?Alignment } 21388 * @syscap SystemCapability.ArkUI.ArkUI.Full 21389 * @since 7 21390 */ 21391 /** 21392 * Defines align type. 21393 * 21394 * @type { ?Alignment } 21395 * @syscap SystemCapability.ArkUI.ArkUI.Full 21396 * @form 21397 * @since 9 21398 */ 21399 /** 21400 * Defines align type. 21401 * 21402 * @type { ?Alignment } 21403 * @syscap SystemCapability.ArkUI.ArkUI.Full 21404 * @crossplatform 21405 * @form 21406 * @since 10 21407 */ 21408 /** 21409 * Defines align type. 21410 * 21411 * @type { ?Alignment } 21412 * @syscap SystemCapability.ArkUI.ArkUI.Full 21413 * @crossplatform 21414 * @form 21415 * @atomicservice 21416 * @since 11 21417 */ 21418 align?: Alignment; 21419 21420 /** 21421 * Defines offset type. 21422 * 21423 * @type { ?OverlayOffset } 21424 * @syscap SystemCapability.ArkUI.ArkUI.Full 21425 * @since 7 21426 */ 21427 /** 21428 * Defines offset type. 21429 * 21430 * @type { ?OverlayOffset } 21431 * @syscap SystemCapability.ArkUI.ArkUI.Full 21432 * @form 21433 * @since 9 21434 */ 21435 /** 21436 * Defines offset type. 21437 * 21438 * @type { ?OverlayOffset } 21439 * @syscap SystemCapability.ArkUI.ArkUI.Full 21440 * @crossplatform 21441 * @form 21442 * @since 10 21443 */ 21444 /** 21445 * Defines offset type. 21446 * 21447 * @type { ?OverlayOffset } 21448 * @syscap SystemCapability.ArkUI.ArkUI.Full 21449 * @crossplatform 21450 * @form 21451 * @atomicservice 21452 * @since 11 21453 */ 21454 offset?: OverlayOffset; 21455} 21456 21457/** 21458 * Defines the OverlayOffset. 21459 * 21460 * @typedef OverlayOffset 21461 * @syscap SystemCapability.ArkUI.ArkUI.Full 21462 * @crossplatform 21463 * @form 21464 * @atomicservice 21465 * @since 12 21466 */ 21467declare interface OverlayOffset { 21468 /** 21469 * Defines x. 21470 * 21471 * @type { ?number } 21472 * @syscap SystemCapability.ArkUI.ArkUI.Full 21473 * @since 7 21474 */ 21475 /** 21476 * Defines x. 21477 * 21478 * @type { ?number } 21479 * @syscap SystemCapability.ArkUI.ArkUI.Full 21480 * @form 21481 * @since 9 21482 */ 21483 /** 21484 * Defines x. 21485 * 21486 * @type { ?number } 21487 * @syscap SystemCapability.ArkUI.ArkUI.Full 21488 * @crossplatform 21489 * @form 21490 * @since 10 21491 */ 21492 /** 21493 * Defines x. 21494 * 21495 * @type { ?number } 21496 * @syscap SystemCapability.ArkUI.ArkUI.Full 21497 * @crossplatform 21498 * @form 21499 * @atomicservice 21500 * @since 11 21501 */ 21502 x?: number; 21503 /** 21504 * Defines y. 21505 * 21506 * @type { ?number } 21507 * @syscap SystemCapability.ArkUI.ArkUI.Full 21508 * @since 7 21509 */ 21510 /** 21511 * Defines y. 21512 * 21513 * @type { ?number } 21514 * @syscap SystemCapability.ArkUI.ArkUI.Full 21515 * @form 21516 * @since 9 21517 */ 21518 /** 21519 * Defines y. 21520 * 21521 * @type { ?number } 21522 * @syscap SystemCapability.ArkUI.ArkUI.Full 21523 * @crossplatform 21524 * @form 21525 * @since 10 21526 */ 21527 /** 21528 * Defines y. 21529 * 21530 * @type { ?number } 21531 * @syscap SystemCapability.ArkUI.ArkUI.Full 21532 * @crossplatform 21533 * @form 21534 * @atomicservice 21535 * @since 11 21536 */ 21537 y?: number; 21538} 21539 21540/** 21541 * Defines the segment of blur. 21542 * The first element in the tuple means fraction. 21543 * The range of this value is [0,1]. A value of 1 means opaque and 0 means completely transparent. 21544 * The second element means the stop position. 21545 * The range of this value is [0,1]. A value of 1 means region ending position and 0 means region starting position. 21546 * 21547 * @typedef { [ number, number ] } FractionStop 21548 * @syscap SystemCapability.ArkUI.ArkUI.Full 21549 * @atomicservice 21550 * @since 12 21551 */ 21552declare type FractionStop = [ number, number ]; 21553 21554/** 21555 * CommonShapeMethod 21556 * 21557 * @extends CommonMethod<T> 21558 * @syscap SystemCapability.ArkUI.ArkUI.Full 21559 * @since 7 21560 */ 21561/** 21562 * CommonShapeMethod 21563 * 21564 * @extends CommonMethod<T> 21565 * @syscap SystemCapability.ArkUI.ArkUI.Full 21566 * @form 21567 * @since 9 21568 */ 21569/** 21570 * CommonShapeMethod 21571 * 21572 * @extends CommonMethod<T> 21573 * @syscap SystemCapability.ArkUI.ArkUI.Full 21574 * @crossplatform 21575 * @form 21576 * @since 10 21577 */ 21578/** 21579 * CommonShapeMethod 21580 * 21581 * @extends CommonMethod<T> 21582 * @syscap SystemCapability.ArkUI.ArkUI.Full 21583 * @crossplatform 21584 * @form 21585 * @atomicservice 21586 * @since 11 21587 */ 21588declare class CommonShapeMethod<T> extends CommonMethod<T> { 21589 /** 21590 * constructor. 21591 * 21592 * @syscap SystemCapability.ArkUI.ArkUI.Full 21593 * @systemapi 21594 * @since 7 21595 */ 21596 /** 21597 * constructor. 21598 * 21599 * @syscap SystemCapability.ArkUI.ArkUI.Full 21600 * @systemapi 21601 * @form 21602 * @since 9 21603 */ 21604 constructor(); 21605 21606 /** 21607 * border Color 21608 * 21609 * @param { ResourceColor } value 21610 * @returns { T } 21611 * @syscap SystemCapability.ArkUI.ArkUI.Full 21612 * @since 7 21613 */ 21614 /** 21615 * border Color 21616 * 21617 * @param { ResourceColor } value 21618 * @returns { T } 21619 * @syscap SystemCapability.ArkUI.ArkUI.Full 21620 * @form 21621 * @since 9 21622 */ 21623 /** 21624 * border Color 21625 * 21626 * @param { ResourceColor } value 21627 * @returns { T } 21628 * @syscap SystemCapability.ArkUI.ArkUI.Full 21629 * @crossplatform 21630 * @form 21631 * @since 10 21632 */ 21633 /** 21634 * border Color 21635 * 21636 * @param { ResourceColor } value 21637 * @returns { T } 21638 * @syscap SystemCapability.ArkUI.ArkUI.Full 21639 * @crossplatform 21640 * @form 21641 * @atomicservice 21642 * @since 11 21643 */ 21644 stroke(value: ResourceColor): T; 21645 21646 /** 21647 * Fill color. 21648 * 21649 * @param { ResourceColor } value 21650 * @returns { T } 21651 * @syscap SystemCapability.ArkUI.ArkUI.Full 21652 * @since 7 21653 */ 21654 /** 21655 * Fill color. 21656 * 21657 * @param { ResourceColor } value 21658 * @returns { T } 21659 * @syscap SystemCapability.ArkUI.ArkUI.Full 21660 * @form 21661 * @since 9 21662 */ 21663 /** 21664 * Fill color. 21665 * 21666 * @param { ResourceColor } value 21667 * @returns { T } 21668 * @syscap SystemCapability.ArkUI.ArkUI.Full 21669 * @crossplatform 21670 * @form 21671 * @since 10 21672 */ 21673 /** 21674 * Fill color. 21675 * 21676 * @param { ResourceColor } value 21677 * @returns { T } 21678 * @syscap SystemCapability.ArkUI.ArkUI.Full 21679 * @crossplatform 21680 * @form 21681 * @atomicservice 21682 * @since 11 21683 */ 21684 fill(value: ResourceColor): T; 21685 21686 /** 21687 * Offset from the start point of the border drawing. 21688 * 21689 * @param { number | string } value 21690 * @returns { T } 21691 * @syscap SystemCapability.ArkUI.ArkUI.Full 21692 * @since 7 21693 */ 21694 /** 21695 * Offset from the start point of the border drawing. 21696 * 21697 * @param { number | string } value 21698 * @returns { T } 21699 * @syscap SystemCapability.ArkUI.ArkUI.Full 21700 * @form 21701 * @since 9 21702 */ 21703 /** 21704 * Offset from the start point of the border drawing. 21705 * 21706 * @param { number | string } value 21707 * @returns { T } 21708 * @syscap SystemCapability.ArkUI.ArkUI.Full 21709 * @crossplatform 21710 * @form 21711 * @since 10 21712 */ 21713 /** 21714 * Offset from the start point of the border drawing. 21715 * 21716 * @param { number | string } value 21717 * @returns { T } 21718 * @syscap SystemCapability.ArkUI.ArkUI.Full 21719 * @crossplatform 21720 * @form 21721 * @atomicservice 21722 * @since 11 21723 */ 21724 strokeDashOffset(value: number | string): T; 21725 21726 /** 21727 * Path endpoint drawing style. 21728 * 21729 * @param { LineCapStyle } value 21730 * @returns { T } 21731 * @syscap SystemCapability.ArkUI.ArkUI.Full 21732 * @since 7 21733 */ 21734 /** 21735 * Path endpoint drawing style. 21736 * 21737 * @param { LineCapStyle } value 21738 * @returns { T } 21739 * @syscap SystemCapability.ArkUI.ArkUI.Full 21740 * @form 21741 * @since 9 21742 */ 21743 /** 21744 * Path endpoint drawing style. 21745 * 21746 * @param { LineCapStyle } value 21747 * @returns { T } 21748 * @syscap SystemCapability.ArkUI.ArkUI.Full 21749 * @crossplatform 21750 * @form 21751 * @since 10 21752 */ 21753 /** 21754 * Path endpoint drawing style. 21755 * 21756 * @param { LineCapStyle } value 21757 * @returns { T } 21758 * @syscap SystemCapability.ArkUI.ArkUI.Full 21759 * @crossplatform 21760 * @form 21761 * @atomicservice 21762 * @since 11 21763 */ 21764 strokeLineCap(value: LineCapStyle): T; 21765 21766 /** 21767 * Border corner drawing style. 21768 * 21769 * @param { LineJoinStyle } value 21770 * @returns { T } 21771 * @syscap SystemCapability.ArkUI.ArkUI.Full 21772 * @since 7 21773 */ 21774 /** 21775 * Border corner drawing style. 21776 * 21777 * @param { LineJoinStyle } value 21778 * @returns { T } 21779 * @syscap SystemCapability.ArkUI.ArkUI.Full 21780 * @form 21781 * @since 9 21782 */ 21783 /** 21784 * Border corner drawing style. 21785 * 21786 * @param { LineJoinStyle } value 21787 * @returns { T } 21788 * @syscap SystemCapability.ArkUI.ArkUI.Full 21789 * @crossplatform 21790 * @form 21791 * @since 10 21792 */ 21793 /** 21794 * Border corner drawing style. 21795 * 21796 * @param { LineJoinStyle } value 21797 * @returns { T } 21798 * @syscap SystemCapability.ArkUI.ArkUI.Full 21799 * @crossplatform 21800 * @form 21801 * @atomicservice 21802 * @since 11 21803 */ 21804 strokeLineJoin(value: LineJoinStyle): T; 21805 21806 /** 21807 * Limits for drawing acute angles as bevels 21808 * 21809 * @param { number | string } value 21810 * @returns { T } 21811 * @syscap SystemCapability.ArkUI.ArkUI.Full 21812 * @since 7 21813 */ 21814 /** 21815 * Limits for drawing acute angles as bevels 21816 * 21817 * @param { number | string } value 21818 * @returns { T } 21819 * @syscap SystemCapability.ArkUI.ArkUI.Full 21820 * @form 21821 * @since 9 21822 */ 21823 /** 21824 * Limits for drawing acute angles as bevels 21825 * 21826 * @param { number | string } value 21827 * @returns { T } 21828 * @syscap SystemCapability.ArkUI.ArkUI.Full 21829 * @crossplatform 21830 * @form 21831 * @since 10 21832 */ 21833 /** 21834 * Limits for drawing acute angles as bevels 21835 * 21836 * @param { number | string } value 21837 * @returns { T } 21838 * @syscap SystemCapability.ArkUI.ArkUI.Full 21839 * @crossplatform 21840 * @form 21841 * @atomicservice 21842 * @since 11 21843 */ 21844 strokeMiterLimit(value: number | string): T; 21845 21846 /** 21847 * Sets the opacity of the border. 21848 * 21849 * @param { number | string | Resource } value 21850 * @returns { T } 21851 * @syscap SystemCapability.ArkUI.ArkUI.Full 21852 * @since 7 21853 */ 21854 /** 21855 * Sets the opacity of the border. 21856 * 21857 * @param { number | string | Resource } value 21858 * @returns { T } 21859 * @syscap SystemCapability.ArkUI.ArkUI.Full 21860 * @form 21861 * @since 9 21862 */ 21863 /** 21864 * Sets the opacity of the border. 21865 * 21866 * @param { number | string | Resource } value 21867 * @returns { T } 21868 * @syscap SystemCapability.ArkUI.ArkUI.Full 21869 * @crossplatform 21870 * @form 21871 * @since 10 21872 */ 21873 /** 21874 * Sets the opacity of the border. 21875 * 21876 * @param { number | string | Resource } value 21877 * @returns { T } 21878 * @syscap SystemCapability.ArkUI.ArkUI.Full 21879 * @crossplatform 21880 * @form 21881 * @atomicservice 21882 * @since 11 21883 */ 21884 strokeOpacity(value: number | string | Resource): T; 21885 21886 /** 21887 * fill Opacity 21888 * 21889 * @param { number | string | Resource } value 21890 * @returns { T } 21891 * @syscap SystemCapability.ArkUI.ArkUI.Full 21892 * @since 7 21893 */ 21894 /** 21895 * fill Opacity 21896 * 21897 * @param { number | string | Resource } value 21898 * @returns { T } 21899 * @syscap SystemCapability.ArkUI.ArkUI.Full 21900 * @form 21901 * @since 9 21902 */ 21903 /** 21904 * fill Opacity 21905 * 21906 * @param { number | string | Resource } value 21907 * @returns { T } 21908 * @syscap SystemCapability.ArkUI.ArkUI.Full 21909 * @crossplatform 21910 * @form 21911 * @since 10 21912 */ 21913 /** 21914 * fill Opacity 21915 * 21916 * @param { number | string | Resource } value 21917 * @returns { T } 21918 * @syscap SystemCapability.ArkUI.ArkUI.Full 21919 * @crossplatform 21920 * @form 21921 * @atomicservice 21922 * @since 11 21923 */ 21924 fillOpacity(value: number | string | Resource): T; 21925 21926 /** 21927 * Sets the width of the dividing line. 21928 * 21929 * @param { Length } value 21930 * @returns { T } 21931 * @syscap SystemCapability.ArkUI.ArkUI.Full 21932 * @since 7 21933 */ 21934 /** 21935 * Sets the width of the dividing line. 21936 * 21937 * @param { Length } value 21938 * @returns { T } 21939 * @syscap SystemCapability.ArkUI.ArkUI.Full 21940 * @form 21941 * @since 9 21942 */ 21943 /** 21944 * Sets the width of the dividing line. 21945 * 21946 * @param { Length } value 21947 * @returns { T } 21948 * @syscap SystemCapability.ArkUI.ArkUI.Full 21949 * @crossplatform 21950 * @form 21951 * @since 10 21952 */ 21953 /** 21954 * Sets the width of the dividing line. 21955 * 21956 * @param { Length } value 21957 * @returns { T } 21958 * @syscap SystemCapability.ArkUI.ArkUI.Full 21959 * @crossplatform 21960 * @form 21961 * @atomicservice 21962 * @since 11 21963 */ 21964 strokeWidth(value: Length): T; 21965 21966 /** 21967 * Indicates whether to enable anti-aliasing 21968 * 21969 * @param { boolean } value 21970 * @returns { T } 21971 * @syscap SystemCapability.ArkUI.ArkUI.Full 21972 * @since 7 21973 */ 21974 /** 21975 * Indicates whether to enable anti-aliasing 21976 * 21977 * @param { boolean } value 21978 * @returns { T } 21979 * @syscap SystemCapability.ArkUI.ArkUI.Full 21980 * @form 21981 * @since 9 21982 */ 21983 /** 21984 * Indicates whether to enable anti-aliasing 21985 * 21986 * @param { boolean } value 21987 * @returns { T } 21988 * @syscap SystemCapability.ArkUI.ArkUI.Full 21989 * @crossplatform 21990 * @form 21991 * @since 10 21992 */ 21993 /** 21994 * Indicates whether to enable anti-aliasing 21995 * 21996 * @param { boolean } value 21997 * @returns { T } 21998 * @syscap SystemCapability.ArkUI.ArkUI.Full 21999 * @crossplatform 22000 * @form 22001 * @atomicservice 22002 * @since 11 22003 */ 22004 antiAlias(value: boolean): T; 22005 22006 /** 22007 * Sets the gap for the border. 22008 * 22009 * @param { Array<any> } value 22010 * @returns { T } 22011 * @syscap SystemCapability.ArkUI.ArkUI.Full 22012 * @since 7 22013 */ 22014 /** 22015 * Sets the gap for the border. 22016 * 22017 * @param { Array<any> } value 22018 * @returns { T } 22019 * @syscap SystemCapability.ArkUI.ArkUI.Full 22020 * @form 22021 * @since 9 22022 */ 22023 /** 22024 * Sets the gap for the border. 22025 * 22026 * @param { Array<any> } value 22027 * @returns { T } 22028 * @syscap SystemCapability.ArkUI.ArkUI.Full 22029 * @crossplatform 22030 * @form 22031 * @since 10 22032 */ 22033 /** 22034 * Sets the gap for the border. 22035 * 22036 * @param { Array<any> } value 22037 * @returns { T } 22038 * @syscap SystemCapability.ArkUI.ArkUI.Full 22039 * @crossplatform 22040 * @form 22041 * @atomicservice 22042 * @since 11 22043 */ 22044 strokeDashArray(value: Array<any>): T; 22045} 22046 22047/** 22048 * Linear Gradient Interface 22049 * 22050 * @interface LinearGradient 22051 * @syscap SystemCapability.ArkUI.ArkUI.Full 22052 * @since 9 22053 */ 22054/** 22055 * Linear Gradient Interface 22056 * 22057 * @interface LinearGradient 22058 * @syscap SystemCapability.ArkUI.ArkUI.Full 22059 * @crossplatform 22060 * @since 10 22061 */ 22062/** 22063 * Linear Gradient Interface 22064 * 22065 * @interface LinearGradient 22066 * @syscap SystemCapability.ArkUI.ArkUI.Full 22067 * @crossplatform 22068 * @atomicservice 22069 * @since 11 22070 */ 22071declare interface LinearGradient { 22072 /** 22073 * Linear Gradient Angle 22074 * 22075 * @type { ?(number | string) } 22076 * @syscap SystemCapability.ArkUI.ArkUI.Full 22077 * @since 9 22078 */ 22079 /** 22080 * Linear Gradient Angle 22081 * 22082 * @type { ?(number | string) } 22083 * @syscap SystemCapability.ArkUI.ArkUI.Full 22084 * @crossplatform 22085 * @since 10 22086 */ 22087 /** 22088 * Linear Gradient Angle 22089 * 22090 * @type { ?(number | string) } 22091 * @syscap SystemCapability.ArkUI.ArkUI.Full 22092 * @crossplatform 22093 * @atomicservice 22094 * @since 11 22095 */ 22096 angle?: number | string; 22097 /** 22098 * Linear Gradient Direction 22099 * 22100 * @type { ?GradientDirection } 22101 * @syscap SystemCapability.ArkUI.ArkUI.Full 22102 * @since 9 22103 */ 22104 /** 22105 * Linear Gradient Direction 22106 * 22107 * @type { ?GradientDirection } 22108 * @syscap SystemCapability.ArkUI.ArkUI.Full 22109 * @crossplatform 22110 * @since 10 22111 */ 22112 /** 22113 * Linear Gradient Direction 22114 * 22115 * @type { ?GradientDirection } 22116 * @syscap SystemCapability.ArkUI.ArkUI.Full 22117 * @crossplatform 22118 * @atomicservice 22119 * @since 11 22120 */ 22121 direction?: GradientDirection; 22122 /** 22123 * Linear Gradient Colors 22124 * 22125 * @type { Array<any> } 22126 * @syscap SystemCapability.ArkUI.ArkUI.Full 22127 * @since 9 22128 */ 22129 /** 22130 * Linear Gradient Colors 22131 * 22132 * @type { Array<any> } 22133 * @syscap SystemCapability.ArkUI.ArkUI.Full 22134 * @crossplatform 22135 * @since 10 22136 */ 22137 /** 22138 * Linear Gradient Colors 22139 * 22140 * @type { Array<any> } 22141 * @syscap SystemCapability.ArkUI.ArkUI.Full 22142 * @crossplatform 22143 * @atomicservice 22144 * @since 11 22145 */ 22146 /** 22147 * Linear Gradient Colors 22148 * 22149 * @type { Array<[ResourceColor, number]> } 22150 * @syscap SystemCapability.ArkUI.ArkUI.Full 22151 * @crossplatform 22152 * @atomicservice 22153 * @since 12 22154 */ 22155 colors: Array<[ResourceColor, number]>; 22156 /** 22157 * Linear Gradient Repeating 22158 * 22159 * @type { ?boolean } 22160 * @syscap SystemCapability.ArkUI.ArkUI.Full 22161 * @since 9 22162 */ 22163 /** 22164 * Linear Gradient Repeating 22165 * 22166 * @type { ?boolean } 22167 * @syscap SystemCapability.ArkUI.ArkUI.Full 22168 * @crossplatform 22169 * @since 10 22170 */ 22171 /** 22172 * Linear Gradient Repeating 22173 * 22174 * @type { ?boolean } 22175 * @syscap SystemCapability.ArkUI.ArkUI.Full 22176 * @crossplatform 22177 * @atomicservice 22178 * @since 11 22179 */ 22180 repeating?: boolean; 22181} 22182 22183/** 22184 * Defines the pixel round property. 22185 * 22186 * @interface PixelRoundPolicy 22187 * @syscap SystemCapability.ArkUI.ArkUI.Full 22188 * @crossplatform 22189 * @form 22190 * @atomicservice 22191 * @since 11 22192 */ 22193declare interface PixelRoundPolicy { 22194 /** 22195 * start property. 22196 * 22197 * @type { ?PixelRoundCalcPolicy } 22198 * @default PixelRoundCalcPolicy.NO_FORCE_ROUND 22199 * @syscap SystemCapability.ArkUI.ArkUI.Full 22200 * @crossplatform 22201 * @form 22202 * @atomicservice 22203 * @since 11 22204 */ 22205 start?: PixelRoundCalcPolicy; 22206 22207 /** 22208 * top property. 22209 * 22210 * @type { ?PixelRoundCalcPolicy } 22211 * @default PixelRoundCalcPolicy.NO_FORCE_ROUND 22212 * @syscap SystemCapability.ArkUI.ArkUI.Full 22213 * @crossplatform 22214 * @form 22215 * @atomicservice 22216 * @since 11 22217 */ 22218 top?: PixelRoundCalcPolicy; 22219 22220 /** 22221 * end property. 22222 * 22223 * @type { ?PixelRoundCalcPolicy } 22224 * @default PixelRoundCalcPolicy.NO_FORCE_ROUND 22225 * @syscap SystemCapability.ArkUI.ArkUI.Full 22226 * @crossplatform 22227 * @form 22228 * @atomicservice 22229 * @since 11 22230 */ 22231 end?: PixelRoundCalcPolicy; 22232 22233 /** 22234 * bottom property. 22235 * 22236 * @type { ?PixelRoundCalcPolicy } 22237 * @default PixelRoundCalcPolicy.NO_FORCE_ROUND 22238 * @syscap SystemCapability.ArkUI.ArkUI.Full 22239 * @crossplatform 22240 * @form 22241 * @atomicservice 22242 * @since 11 22243 */ 22244 bottom?: PixelRoundCalcPolicy; 22245} 22246 22247/** 22248 * Linear Gradient Blur Interface 22249 * 22250 * @interface LinearGradientBlurOptions 22251 * @syscap SystemCapability.ArkUI.ArkUI.Full 22252 * @atomicservice 22253 * @since 12 22254 */ 22255declare interface LinearGradientBlurOptions { 22256 /** 22257 * Percentage of blurring effect. 22258 * 22259 * @type { FractionStop[] } 22260 * @syscap SystemCapability.ArkUI.ArkUI.Full 22261 * @atomicservice 22262 * @since 12 22263 */ 22264 fractionStops: FractionStop[]; 22265 /** 22266 * Direction of linear gradient blur. 22267 * 22268 * @type { GradientDirection } 22269 * @syscap SystemCapability.ArkUI.ArkUI.Full 22270 * @atomicservice 22271 * @since 12 22272 */ 22273 direction: GradientDirection; 22274} 22275 22276/** 22277 * Define motion blur anchor coordinates. 22278 * 22279 * @interface MotionBlurAnchor 22280 * @syscap SystemCapability.ArkUI.ArkUI.Full 22281 * @crossplatform 22282 * @atomicservice 22283 * @since 12 22284 */ 22285declare interface MotionBlurAnchor { 22286 /** 22287 * Define anchor coordinate x-value.Value range [0.0, 1.0]. 22288 * 22289 * @type { number } 22290 * @syscap SystemCapability.ArkUI.ArkUI.Full 22291 * @atomicservice 22292 * @since 12 22293 */ 22294 x: number; 22295 /** 22296 * Define anchor coordinate y-value.Value range [0.0, 1.0]. 22297 * 22298 * @type { number } 22299 * @syscap SystemCapability.ArkUI.ArkUI.Full 22300 * @atomicservice 22301 * @since 12 22302 */ 22303 y: number; 22304} 22305 22306/** 22307 * Define motion blur options. 22308 * 22309 * @interface MotionBlurOptions 22310 * @syscap SystemCapability.ArkUI.ArkUI.Full 22311 * @crossplatform 22312 * @atomicservice 22313 * @since 12 22314 */ 22315declare interface MotionBlurOptions { 22316 /** 22317 * Define the size of motion blur radius.The range of this value is [0.0, ∞). 22318 * 22319 * @type { number } 22320 * @syscap SystemCapability.ArkUI.ArkUI.Full 22321 * @atomicservice 22322 * @since 12 22323 */ 22324 radius: number; 22325 /** 22326 * Define motion blur anchor coordinates. 22327 * 22328 * @type { MotionBlurAnchor } 22329 * @syscap SystemCapability.ArkUI.ArkUI.Full 22330 * @atomicservice 22331 * @since 12 22332 */ 22333 anchor: MotionBlurAnchor; 22334} 22335 22336/** 22337 * Sub component border info. 22338 * 22339 * @interface LayoutBorderInfo 22340 * @syscap SystemCapability.ArkUI.ArkUI.Full 22341 * @form 22342 * @since 9 22343 * @deprecated since 10 22344 */ 22345declare interface LayoutBorderInfo { 22346 /** 22347 * Sub component borderWidth info. 22348 * 22349 * @type { EdgeWidths } 22350 * @syscap SystemCapability.ArkUI.ArkUI.Full 22351 * @form 22352 * @since 9 22353 * @deprecated since 10 22354 */ 22355 borderWidth: EdgeWidths; 22356 22357 /** 22358 * Sub component margin info. 22359 * 22360 * @type { Margin } 22361 * @syscap SystemCapability.ArkUI.ArkUI.Full 22362 * @form 22363 * @since 9 22364 * @deprecated since 10 22365 */ 22366 margin: Margin, 22367 22368 /** 22369 * Sub component padding info. 22370 * 22371 * @type { Padding } 22372 * @syscap SystemCapability.ArkUI.ArkUI.Full 22373 * @form 22374 * @since 9 22375 * @deprecated since 10 22376 */ 22377 padding: Padding, 22378} 22379 22380/** 22381 * Sub component layout info. 22382 * 22383 * @interface LayoutInfo 22384 * @syscap SystemCapability.ArkUI.ArkUI.Full 22385 * @form 22386 * @since 9 22387 * @deprecated since 10 22388 */ 22389declare interface LayoutInfo { 22390 /** 22391 * Sub component position info. 22392 * 22393 * @type { Position } 22394 * @syscap SystemCapability.ArkUI.ArkUI.Full 22395 * @form 22396 * @since 9 22397 * @deprecated since 10 22398 */ 22399 position: Position, 22400 22401 /** 22402 * Sub component constraint info. 22403 * 22404 * @type { ConstraintSizeOptions } 22405 * @syscap SystemCapability.ArkUI.ArkUI.Full 22406 * @form 22407 * @since 9 22408 * @deprecated since 10 22409 */ 22410 constraint: ConstraintSizeOptions, 22411} 22412 22413/** 22414 * Sub component info passed from framework when layout and measure happens. 22415 * 22416 * @interface LayoutChild 22417 * @syscap SystemCapability.ArkUI.ArkUI.Full 22418 * @form 22419 * @since 9 22420 * @deprecated since 10 22421 */ 22422declare interface LayoutChild { 22423 /** 22424 * Sub component name. 22425 * 22426 * @type { string } 22427 * @syscap SystemCapability.ArkUI.ArkUI.Full 22428 * @form 22429 * @since 9 22430 * @deprecated since 10 22431 */ 22432 name: string, 22433 22434 /** 22435 * Sub component id. 22436 * 22437 * @type { string } 22438 * @syscap SystemCapability.ArkUI.ArkUI.Full 22439 * @form 22440 * @since 9 22441 * @deprecated since 10 22442 */ 22443 id: string, 22444 22445 /** 22446 * Sub component constraint. 22447 * 22448 * @type { ConstraintSizeOptions } 22449 * @syscap SystemCapability.ArkUI.ArkUI.Full 22450 * @form 22451 * @since 9 22452 * @deprecated since 10 22453 */ 22454 constraint: ConstraintSizeOptions, 22455 22456 /** 22457 * Sub component border info. 22458 * 22459 * @type { LayoutBorderInfo } 22460 * @syscap SystemCapability.ArkUI.ArkUI.Full 22461 * @form 22462 * @since 9 22463 * @deprecated since 10 22464 */ 22465 borderInfo: LayoutBorderInfo, 22466 22467 /** 22468 * Sub component position. 22469 * 22470 * @type { Position } 22471 * @syscap SystemCapability.ArkUI.ArkUI.Full 22472 * @form 22473 * @since 9 22474 * @deprecated since 10 22475 */ 22476 position: Position, 22477 22478 /** 22479 * Call this measure method in onMeasure callback to supply sub component size. 22480 * 22481 * @param { ConstraintSizeOptions } childConstraint 22482 * @syscap SystemCapability.ArkUI.ArkUI.Full 22483 * @form 22484 * @since 9 22485 * @deprecated since 10 22486 */ 22487 measure(childConstraint: ConstraintSizeOptions), 22488 22489 /** 22490 * Call this layout method in onLayout callback to assign layout info to sub component. 22491 * 22492 * @param { LayoutInfo } childLayoutInfo 22493 * @syscap SystemCapability.ArkUI.ArkUI.Full 22494 * @form 22495 * @since 9 22496 * @deprecated since 10 22497 */ 22498 layout(childLayoutInfo: LayoutInfo), 22499} 22500 22501/** 22502 * Sub component layout info. 22503 * 22504 * @extends SizeResult 22505 * @interface GeometryInfo 22506 * @syscap SystemCapability.ArkUI.ArkUI.Full 22507 * @crossplatform 22508 * @since 10 22509 */ 22510/** 22511 * Sub component layout info. 22512 * 22513 * @extends SizeResult 22514 * @interface GeometryInfo 22515 * @syscap SystemCapability.ArkUI.ArkUI.Full 22516 * @crossplatform 22517 * @atomicservice 22518 * @since 11 22519 */ 22520declare interface GeometryInfo extends SizeResult { 22521 /** 22522 * Sub component borderWidth info. 22523 * 22524 * @type { EdgeWidth } 22525 * @syscap SystemCapability.ArkUI.ArkUI.Full 22526 * @crossplatform 22527 * @since 10 22528 */ 22529 /** 22530 * Sub component borderWidth info. 22531 * 22532 * @type { EdgeWidth } 22533 * @syscap SystemCapability.ArkUI.ArkUI.Full 22534 * @crossplatform 22535 * @atomicservice 22536 * @since 11 22537 */ 22538 borderWidth: EdgeWidth; 22539 22540 /** 22541 * Sub component margin info. 22542 * 22543 * @type { Margin } 22544 * @syscap SystemCapability.ArkUI.ArkUI.Full 22545 * @crossplatform 22546 * @since 10 22547 */ 22548 /** 22549 * Sub component margin info. 22550 * 22551 * @type { Margin } 22552 * @syscap SystemCapability.ArkUI.ArkUI.Full 22553 * @crossplatform 22554 * @atomicservice 22555 * @since 11 22556 */ 22557 margin: Margin, 22558 22559 /** 22560 * Sub component padding info. 22561 * 22562 * @type { Padding } 22563 * @syscap SystemCapability.ArkUI.ArkUI.Full 22564 * @crossplatform 22565 * @since 10 22566 */ 22567 /** 22568 * Sub component padding info. 22569 * 22570 * @type { Padding } 22571 * @syscap SystemCapability.ArkUI.ArkUI.Full 22572 * @crossplatform 22573 * @atomicservice 22574 * @since 11 22575 */ 22576 padding: Padding, 22577} 22578 22579/** 22580 * Sub component info passed from framework when layout happens. 22581 * 22582 * @interface Layoutable 22583 * @syscap SystemCapability.ArkUI.ArkUI.Full 22584 * @crossplatform 22585 * @since 10 22586 */ 22587/** 22588 * Sub component info passed from framework when layout happens. 22589 * 22590 * @interface Layoutable 22591 * @syscap SystemCapability.ArkUI.ArkUI.Full 22592 * @crossplatform 22593 * @atomicservice 22594 * @since 11 22595 */ 22596declare interface Layoutable { 22597 /** 22598 * Measurement result of the child component. 22599 * 22600 * @type { MeasureResult } 22601 * @syscap SystemCapability.ArkUI.ArkUI.Full 22602 * @crossplatform 22603 * @since 10 22604 */ 22605 /** 22606 * Measurement result of the child component. 22607 * 22608 * @type { MeasureResult } 22609 * @syscap SystemCapability.ArkUI.ArkUI.Full 22610 * @crossplatform 22611 * @atomicservice 22612 * @since 11 22613 */ 22614 measureResult: MeasureResult, 22615 22616 /** 22617 * Call this layout method in onLayout callback to assign layout info to sub component. 22618 * 22619 * @param { Position } position 22620 * @syscap SystemCapability.ArkUI.ArkUI.Full 22621 * @crossplatform 22622 * @since 10 22623 */ 22624 /** 22625 * Call this layout method in onLayout callback to assign layout info to sub component. 22626 * 22627 * @param { Position } position 22628 * @syscap SystemCapability.ArkUI.ArkUI.Full 22629 * @crossplatform 22630 * @atomicservice 22631 * @since 11 22632 */ 22633 layout(position: Position): void, 22634 22635 /** 22636 * Call this method to get the margin of sub component. 22637 * 22638 * @returns { DirectionalEdgesT<number> } the margin of sub component, unit is vp 22639 * @syscap SystemCapability.ArkUI.ArkUI.Full 22640 * @crossplatform 22641 * @atomicservice 22642 * @since 12 22643 */ 22644 getMargin() : DirectionalEdgesT<number>, 22645 22646 /** 22647 * Call this method to get the padding of sub component. 22648 * 22649 * @returns { DirectionalEdgesT<number> } the padding of sub component, unit is vp 22650 * @syscap SystemCapability.ArkUI.ArkUI.Full 22651 * @crossplatform 22652 * @atomicservice 22653 * @since 12 22654 */ 22655 getPadding() : DirectionalEdgesT<number>, 22656 22657 /** 22658 * Call this method to get the borderWidth of sub component. 22659 * 22660 * @returns { DirectionalEdgesT<number> } the borderWidth of sub component, unit is vp 22661 * @syscap SystemCapability.ArkUI.ArkUI.Full 22662 * @crossplatform 22663 * @atomicservice 22664 * @since 12 22665 */ 22666 getBorderWidth() : DirectionalEdgesT<number>, 22667} 22668 22669/** 22670 * Sub component info passed from framework when measure happens. 22671 * 22672 * @interface Measurable 22673 * @syscap SystemCapability.ArkUI.ArkUI.Full 22674 * @crossplatform 22675 * @since 10 22676 */ 22677/** 22678 * Sub component info passed from framework when measure happens. 22679 * 22680 * @interface Measurable 22681 * @syscap SystemCapability.ArkUI.ArkUI.Full 22682 * @crossplatform 22683 * @atomicservice 22684 * @since 11 22685 */ 22686declare interface Measurable { 22687 /** 22688 * Call this measure method in onMeasure callback to supply sub component size. 22689 * 22690 * @param { ConstraintSizeOptions } constraint 22691 * @returns { MeasureResult } 22692 * @syscap SystemCapability.ArkUI.ArkUI.Full 22693 * @crossplatform 22694 * @since 10 22695 */ 22696 /** 22697 * Call this measure method in onMeasure callback to supply sub component size. 22698 * 22699 * @param { ConstraintSizeOptions } constraint 22700 * @returns { MeasureResult } 22701 * @syscap SystemCapability.ArkUI.ArkUI.Full 22702 * @crossplatform 22703 * @atomicservice 22704 * @since 11 22705 */ 22706 measure(constraint: ConstraintSizeOptions) : MeasureResult, 22707 22708 /** 22709 * Call this method to get the margin of sub component. 22710 * 22711 * @returns { DirectionalEdgesT<number> } the margin of sub component, unit is vp 22712 * @syscap SystemCapability.ArkUI.ArkUI.Full 22713 * @crossplatform 22714 * @atomicservice 22715 * @since 12 22716 */ 22717 getMargin() : DirectionalEdgesT<number>, 22718 22719 /** 22720 * Call this method to get the padding of sub component. 22721 * 22722 * @returns { DirectionalEdgesT<number> } the padding of sub component, unit is vp 22723 * @syscap SystemCapability.ArkUI.ArkUI.Full 22724 * @crossplatform 22725 * @atomicservice 22726 * @since 12 22727 */ 22728 getPadding() : DirectionalEdgesT<number>, 22729 22730 /** 22731 * Call this method to get the borderWidth of sub component. 22732 * 22733 * @returns { DirectionalEdgesT<number> } the borderWidth of sub component, unit is vp 22734 * @syscap SystemCapability.ArkUI.ArkUI.Full 22735 * @crossplatform 22736 * @atomicservice 22737 * @since 12 22738 */ 22739 getBorderWidth() : DirectionalEdgesT<number>, 22740} 22741 22742/** 22743 * Sub component SizeResult info. 22744 * 22745 * @interface SizeResult 22746 * @syscap SystemCapability.ArkUI.ArkUI.Full 22747 * @crossplatform 22748 * @since 10 22749 */ 22750/** 22751 * Sub component SizeResult info. 22752 * 22753 * @interface SizeResult 22754 * @syscap SystemCapability.ArkUI.ArkUI.Full 22755 * @crossplatform 22756 * @atomicservice 22757 * @since 11 22758 */ 22759declare interface SizeResult { 22760 /** 22761 * Width obtained from the measurement result. 22762 * 22763 * @type { number } 22764 * @syscap SystemCapability.ArkUI.ArkUI.Full 22765 * @crossplatform 22766 * @since 10 22767 */ 22768 /** 22769 * Width obtained from the measurement result. 22770 * 22771 * @type { number } 22772 * @syscap SystemCapability.ArkUI.ArkUI.Full 22773 * @crossplatform 22774 * @atomicservice 22775 * @since 11 22776 */ 22777 width: number, 22778 22779 /** 22780 * Height obtained from the measurement result. 22781 * 22782 * @type { number } 22783 * @syscap SystemCapability.ArkUI.ArkUI.Full 22784 * @crossplatform 22785 * @since 10 22786 */ 22787 /** 22788 * Height obtained from the measurement result. 22789 * 22790 * @type { number } 22791 * @syscap SystemCapability.ArkUI.ArkUI.Full 22792 * @crossplatform 22793 * @atomicservice 22794 * @since 11 22795 */ 22796 height: number, 22797} 22798 22799/** 22800 * Sub component MeasureResult info. 22801 * 22802 * @interface MeasureResult 22803 * @syscap SystemCapability.ArkUI.ArkUI.Full 22804 * @crossplatform 22805 * @since 10 22806 */ 22807/** 22808 * Sub component MeasureResult info. 22809 * 22810 * @interface MeasureResult 22811 * @syscap SystemCapability.ArkUI.ArkUI.Full 22812 * @crossplatform 22813 * @atomicservice 22814 * @since 11 22815 */ 22816declare interface MeasureResult extends SizeResult { 22817 22818} 22819 22820/** 22821 * The navigation destination information. 22822 * 22823 * @syscap SystemCapability.ArkUI.ArkUI.Full 22824 * @crossplatform 22825 * @since 11 22826 */ 22827/** 22828 * The navigation destination information. 22829 * 22830 * @typedef {import('../api/@ohos.arkui.observer').default.NavDestinationInfo} NavDestinationInfo 22831 * @syscap SystemCapability.ArkUI.ArkUI.Full 22832 * @crossplatform 22833 * @atomicservice 22834 * @since 12 22835 */ 22836declare type NavDestinationInfo = import('../api/@ohos.arkui.observer').default.NavDestinationInfo; 22837 22838/** 22839 * The navigation information. 22840 * 22841 * @typedef {import('../api/@ohos.arkui.observer').default.NavigationInfo} NavigationInfo 22842 * @syscap SystemCapability.ArkUI.ArkUI.Full 22843 * @crossplatform 22844 * @atomicservice 22845 * @since 12 22846 */ 22847declare type NavigationInfo = import('../api/@ohos.arkui.observer').default.NavigationInfo; 22848 22849/** 22850 * The router page information. 22851 * 22852 * @typedef {import('../api/@ohos.arkui.observer').default.RouterPageInfo} RouterPageInfo 22853 * @syscap SystemCapability.ArkUI.ArkUI.Full 22854 * @crossplatform 22855 * @atomicservice 22856 * @since 12 22857 */ 22858declare type RouterPageInfo = import('../api/@ohos.arkui.observer').default.RouterPageInfo; 22859 22860/** 22861 * UIContext 22862 * 22863 * @syscap SystemCapability.ArkUI.ArkUI.Full 22864 * @crossplatform 22865 * @since 11 22866 */ 22867/** 22868 * UIContext 22869 * 22870 * @typedef { import('../api/@ohos.arkui.UIContext').UIContext } UIContext 22871 * @syscap SystemCapability.ArkUI.ArkUI.Full 22872 * @crossplatform 22873 * @atomicservice 22874 * @since 12 22875 */ 22876declare type UIContext = import('../api/@ohos.arkui.UIContext').UIContext; 22877 22878/** 22879 * DrawContext 22880 * 22881 * @typedef { import('../api/arkui/Graphics').DrawContext } DrawContext 22882 * @syscap SystemCapability.ArkUI.ArkUI.Full 22883 * @crossplatform 22884 * @atomicservice 22885 * @since 12 22886 */ 22887declare type DrawContext = import('../api/arkui/Graphics').DrawContext; 22888 22889/** 22890 * VisualEffect 22891 * 22892 * @typedef { import('../api/@ohos.graphics.uiEffect').default.VisualEffect } VisualEffect 22893 * @syscap SystemCapability.ArkUI.ArkUI.Full 22894 * @crossplatform 22895 * @atomicservice 22896 * @since 12 22897 */ 22898declare type VisualEffect = import('../api/@ohos.graphics.uiEffect').default.VisualEffect; 22899 22900 22901/** 22902 * Filter 22903 * 22904 * @typedef { import('../api/@ohos.graphics.uiEffect').default.Filter } Filter 22905 * @syscap SystemCapability.ArkUI.ArkUI.Full 22906 * @crossplatform 22907 * @atomicservice 22908 * @since 12 22909 */ 22910declare type Filter = import('../api/@ohos.graphics.uiEffect').default.Filter; 22911 22912/** 22913 * Blender 22914 * 22915 * @typedef { import('../api/@ohos.graphics.uiEffect').default.Blender } Blender 22916 * @syscap SystemCapability.ArkUI.ArkUI.Full 22917 * @systemapi 22918 * @form 22919 * @since 13 22920 */ 22921declare type Blender = import('../api/@ohos.graphics.uiEffect').default.Blender; 22922 22923/** 22924 * ComponentContent. 22925 * 22926 * @typedef {import('../api/arkui/ComponentContent').ComponentContent<T>} ComponentContent<T = Object> 22927 * @syscap SystemCapability.ArkUI.ArkUI.Full 22928 * @crossplatform 22929 * @atomicservice 22930 * @since 12 22931 */ 22932declare type ComponentContent<T = Object> = import('../api/arkui/ComponentContent').ComponentContent<T>; 22933 22934/** 22935 * Theme. 22936 * 22937 * @typedef {import('../api/@ohos.arkui.theme').Theme} Theme 22938 * @syscap SystemCapability.ArkUI.ArkUI.Full 22939 * @crossplatform 22940 * @atomicservice 22941 * @since 12 22942 */ 22943declare type Theme = import('../api/@ohos.arkui.theme').Theme; 22944 22945/** 22946 * Custom Component 22947 * 22948 * @extends CommonAttribute 22949 * @syscap SystemCapability.ArkUI.ArkUI.Full 22950 * @since 7 22951 */ 22952/** 22953 * Custom Component 22954 * 22955 * @extends CommonAttribute 22956 * @syscap SystemCapability.ArkUI.ArkUI.Full 22957 * @form 22958 * @since 9 22959 */ 22960/** 22961 * Custom Component 22962 * 22963 * @extends CommonAttribute 22964 * @syscap SystemCapability.ArkUI.ArkUI.Full 22965 * @crossplatform 22966 * @form 22967 * @since 10 22968 */ 22969/** 22970 * Custom Component 22971 * 22972 * @extends CommonAttribute 22973 * @syscap SystemCapability.ArkUI.ArkUI.Full 22974 * @crossplatform 22975 * @form 22976 * @atomicservice 22977 * @since 11 22978 */ 22979declare class CustomComponent extends CommonAttribute { 22980 /** 22981 * Customize the pop-up content constructor. 22982 * 22983 * @syscap SystemCapability.ArkUI.ArkUI.Full 22984 * @since 7 22985 */ 22986 /** 22987 * Customize the pop-up content constructor. 22988 * 22989 * @syscap SystemCapability.ArkUI.ArkUI.Full 22990 * @form 22991 * @since 9 22992 */ 22993 /** 22994 * Customize the pop-up content constructor. 22995 * 22996 * @syscap SystemCapability.ArkUI.ArkUI.Full 22997 * @crossplatform 22998 * @form 22999 * @since 10 23000 */ 23001 /** 23002 * Customize the pop-up content constructor. 23003 * 23004 * @syscap SystemCapability.ArkUI.ArkUI.Full 23005 * @crossplatform 23006 * @form 23007 * @atomicservice 23008 * @since 11 23009 */ 23010 build(): void; 23011 23012 /** 23013 * aboutToAppear Method 23014 * 23015 * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. 23016 * 23017 * @syscap SystemCapability.ArkUI.ArkUI.Full 23018 * @since 7 23019 */ 23020 /** 23021 * aboutToAppear Method 23022 * 23023 * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. 23024 * 23025 * @syscap SystemCapability.ArkUI.ArkUI.Full 23026 * @form 23027 * @since 9 23028 */ 23029 /** 23030 * aboutToAppear Method 23031 * 23032 * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. 23033 * 23034 * @syscap SystemCapability.ArkUI.ArkUI.Full 23035 * @crossplatform 23036 * @form 23037 * @since 10 23038 */ 23039 /** 23040 * aboutToAppear Method 23041 * 23042 * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. 23043 * 23044 * @syscap SystemCapability.ArkUI.ArkUI.Full 23045 * @crossplatform 23046 * @form 23047 * @atomicservice 23048 * @since 11 23049 */ 23050 aboutToAppear?(): void; 23051 23052 /** 23053 * aboutToDisappear Method 23054 * 23055 * The aboutToDisappear function executes before a custom component is destroyed. 23056 * 23057 * @syscap SystemCapability.ArkUI.ArkUI.Full 23058 * @since 7 23059 */ 23060 /** 23061 * aboutToDisappear Method 23062 * 23063 * The aboutToDisappear function executes before a custom component is destroyed. 23064 * 23065 * @syscap SystemCapability.ArkUI.ArkUI.Full 23066 * @form 23067 * @since 9 23068 */ 23069 /** 23070 * aboutToDisappear Method 23071 * 23072 * The aboutToDisappear function executes before a custom component is destroyed. 23073 * 23074 * @syscap SystemCapability.ArkUI.ArkUI.Full 23075 * @crossplatform 23076 * @form 23077 * @since 10 23078 */ 23079 /** 23080 * aboutToDisappear Method 23081 * 23082 * The aboutToDisappear function executes before a custom component is destroyed. 23083 * 23084 * @syscap SystemCapability.ArkUI.ArkUI.Full 23085 * @crossplatform 23086 * @form 23087 * @atomicservice 23088 * @since 11 23089 */ 23090 aboutToDisappear?(): void; 23091 23092 /** 23093 * aboutToReuse Method 23094 * 23095 * @param { object } params - Custom component init params. 23096 * @syscap SystemCapability.ArkUI.ArkUI.Full 23097 * @crossplatform 23098 * @since 10 23099 */ 23100 /** 23101 * aboutToReuse Method 23102 * 23103 * @param { object } params - Custom component init params. 23104 * @syscap SystemCapability.ArkUI.ArkUI.Full 23105 * @crossplatform 23106 * @atomicservice 23107 * @since 11 23108 */ 23109 aboutToReuse?(params: { [key: string]: unknown }): void; 23110 23111 /** 23112 * aboutToRecycle Method 23113 * 23114 * @syscap SystemCapability.ArkUI.ArkUI.Full 23115 * @crossplatform 23116 * @since 10 23117 */ 23118 /** 23119 * aboutToRecycle Method 23120 * 23121 * @syscap SystemCapability.ArkUI.ArkUI.Full 23122 * @crossplatform 23123 * @atomicservice 23124 * @since 11 23125 */ 23126 aboutToRecycle?(): void; 23127 23128 /** 23129 * The onWillApplyTheme function is a custom hook to get active theme object from the context 23130 * 23131 * @param { Theme } theme - Custom theme init params. 23132 * @syscap SystemCapability.ArkUI.ArkUI.Full 23133 * @crossplatform 23134 * @atomicservice 23135 * @since 12 23136 */ 23137 onWillApplyTheme?(theme: Theme): void; 23138 23139 /** 23140 * Custom component override this method to layout each of its sub components. 23141 * 23142 * @param { Array<LayoutChild> } children 23143 * @param { ConstraintSizeOptions } constraint 23144 * @syscap SystemCapability.ArkUI.ArkUI.Full 23145 * @form 23146 * @since 9 23147 * @deprecated since 10 23148 * @useinstead CustomComponent#onPlaceChildren 23149 */ 23150 onLayout?(children: Array<LayoutChild>, constraint: ConstraintSizeOptions): void; 23151 23152 /** 23153 * Custom component override this method to layout each of its sub components. 23154 * 23155 * @param { GeometryInfo } selfLayoutInfo 23156 * @param { Array<Layoutable> } children 23157 * @param { ConstraintSizeOptions } constraint 23158 * @syscap SystemCapability.ArkUI.ArkUI.Full 23159 * @crossplatform 23160 * @since 10 23161 */ 23162 /** 23163 * Custom component override this method to layout each of its sub components. 23164 * 23165 * @param { GeometryInfo } selfLayoutInfo 23166 * @param { Array<Layoutable> } children 23167 * @param { ConstraintSizeOptions } constraint 23168 * @syscap SystemCapability.ArkUI.ArkUI.Full 23169 * @crossplatform 23170 * @atomicservice 23171 * @since 11 23172 */ 23173 onPlaceChildren?(selfLayoutInfo: GeometryInfo, children: Array<Layoutable>, constraint: ConstraintSizeOptions): void; 23174 23175 /** 23176 * Custom component override this method to measure each of its sub components. 23177 * 23178 * @param { Array<LayoutChild> } children 23179 * @param { ConstraintSizeOptions } constraint 23180 * @syscap SystemCapability.ArkUI.ArkUI.Full 23181 * @form 23182 * @since 9 23183 * @deprecated since 10 23184 * @useinstead CustomComponent#onMeasureSize 23185 */ 23186 onMeasure?(children: Array<LayoutChild>, constraint: ConstraintSizeOptions): void; 23187 23188 /** 23189 * Custom component override this method to measure each of its sub components. 23190 * @param { GeometryInfo } selfLayoutInfo 23191 * @param { Array<Measurable> } children - indicate the measure child 23192 * @param { ConstraintSizeOptions } constraint - indicate child constraint size 23193 * @returns { SizeResult } 23194 * @syscap SystemCapability.ArkUI.ArkUI.Full 23195 * @crossplatform 23196 * @since 10 23197 */ 23198 /** 23199 * Custom component override this method to measure each of its sub components. 23200 * @param { GeometryInfo } selfLayoutInfo 23201 * @param { Array<Measurable> } children - indicate the measure child 23202 * @param { ConstraintSizeOptions } constraint - indicate child constraint size 23203 * @returns { SizeResult } 23204 * @syscap SystemCapability.ArkUI.ArkUI.Full 23205 * @crossplatform 23206 * @atomicservice 23207 * @since 11 23208 */ 23209 onMeasureSize?(selfLayoutInfo: GeometryInfo, children: Array<Measurable>, constraint: ConstraintSizeOptions): SizeResult; 23210 23211 /** 23212 * onPageShow Method 23213 * 23214 * The page is triggered once each time it is displayed, including scenarios such as the routing process and the application entering the foreground 23215 * 23216 * @syscap SystemCapability.ArkUI.ArkUI.Full 23217 * @since 7 23218 */ 23219 /** 23220 * onPageShow Method 23221 * 23222 * The page is triggered once each time it is displayed, including scenarios such as the routing process and the application entering the foreground 23223 * 23224 * @syscap SystemCapability.ArkUI.ArkUI.Full 23225 * @crossplatform 23226 * @since 10 23227 */ 23228 /** 23229 * onPageShow Method 23230 * 23231 * The page is triggered once each time it is displayed, including scenarios such as the routing process and the application entering the foreground 23232 * 23233 * @syscap SystemCapability.ArkUI.ArkUI.Full 23234 * @crossplatform 23235 * @atomicservice 23236 * @since 11 23237 */ 23238 onPageShow?(): void; 23239 23240 /** 23241 * onPageHide Method 23242 * 23243 * It is triggered once each time the page is hidden, including scenarios such as the routing process and the application entering the background 23244 * 23245 * @syscap SystemCapability.ArkUI.ArkUI.Full 23246 * @since 7 23247 */ 23248 /** 23249 * onPageHide Method 23250 * 23251 * It is triggered once each time the page is hidden, including scenarios such as the routing process and the application entering the background 23252 * 23253 * @syscap SystemCapability.ArkUI.ArkUI.Full 23254 * @crossplatform 23255 * @since 10 23256 */ 23257 /** 23258 * onPageHide Method 23259 * 23260 * It is triggered once each time the page is hidden, including scenarios such as the routing process and the application entering the background 23261 * 23262 * @syscap SystemCapability.ArkUI.ArkUI.Full 23263 * @crossplatform 23264 * @atomicservice 23265 * @since 11 23266 */ 23267 onPageHide?(): void; 23268 23269 /** 23270 * onFormRecycle Method, this is only for ArkTS form, if form was marked recyclable by form user, when system memory is low, 23271 * it will be recycled after calling this method, you should return a string of params that you wish to be saved, it will be 23272 * passed back as params in onFormRecover, in which you can recover the form 23273 * 23274 * @returns { string } status data of ArkTS form UI, this data will be passed in when recover form later 23275 * @syscap SystemCapability.ArkUI.ArkUI.Full 23276 * @crossplatform 23277 * @form 23278 * @since 11 23279 */ 23280 /** 23281 * onFormRecycle Method, this is only for ArkTS form, if form was marked recyclable by form user, when system memory is low, 23282 * it will be recycled after calling this method, you should return a string of params that you wish to be saved, it will be 23283 * passed back as params in onFormRecover, in which you can recover the form 23284 * 23285 * @returns { string } status data of ArkTS form UI, this data will be passed in when recover form later 23286 * @syscap SystemCapability.ArkUI.ArkUI.Full 23287 * @crossplatform 23288 * @form 23289 * @atomicservice 23290 * @since 12 23291 */ 23292 onFormRecycle?(): string; 23293 23294 /** 23295 * onFormRecover Method, this is only for ArkTS form 23296 * 23297 * @param { string } statusData - indicate status data of ArkTS form UI, which is acquired by calling onFormRecycle, it is used to recover form 23298 * @syscap SystemCapability.ArkUI.ArkUI.Full 23299 * @crossplatform 23300 * @form 23301 * @since 11 23302 */ 23303 /** 23304 * onFormRecover Method, this is only for ArkTS form 23305 * 23306 * @param { string } statusData - indicate status data of ArkTS form UI, which is acquired by calling onFormRecycle, it is used to recover form 23307 * @syscap SystemCapability.ArkUI.ArkUI.Full 23308 * @crossplatform 23309 * @form 23310 * @atomicservice 23311 * @since 12 23312 */ 23313 onFormRecover?(statusData: string): void; 23314 23315 /** 23316 * onBackPress Method 23317 * 23318 * Triggered when the user clicks the back button 23319 * 23320 * @returns { void | boolean } 23321 * @syscap SystemCapability.ArkUI.ArkUI.Full 23322 * @since 7 23323 */ 23324 /** 23325 * onBackPress Method 23326 * 23327 * Triggered when the user clicks the back button 23328 * 23329 * @returns { void | boolean } true means that the page itself processes the return logic. 23330 * false means that the default return logic is used. 23331 * If no value is returned, the default return logic is used. 23332 * @syscap SystemCapability.ArkUI.ArkUI.Full 23333 * @crossplatform 23334 * @since 10 23335 */ 23336 /** 23337 * onBackPress Method 23338 * 23339 * Triggered when the user clicks the back button 23340 * 23341 * @returns { void | boolean } true means that the page itself processes the return logic. 23342 * false means that the default return logic is used. 23343 * If no value is returned, the default return logic is used. 23344 * @syscap SystemCapability.ArkUI.ArkUI.Full 23345 * @crossplatform 23346 * @atomicservice 23347 * @since 11 23348 */ 23349 onBackPress?(): void | boolean; 23350 23351 /** 23352 * PageTransition Method. 23353 * Implement Animation when enter this page or move to other pages. 23354 * 23355 * @syscap SystemCapability.ArkUI.ArkUI.Full 23356 * @since 9 23357 */ 23358 /** 23359 * PageTransition Method. 23360 * Implement Animation when enter this page or move to other pages. 23361 * 23362 * @syscap SystemCapability.ArkUI.ArkUI.Full 23363 * @crossplatform 23364 * @since 10 23365 */ 23366 /** 23367 * PageTransition Method. 23368 * Implement Animation when enter this page or move to other pages. 23369 * 23370 * @syscap SystemCapability.ArkUI.ArkUI.Full 23371 * @crossplatform 23372 * @atomicservice 23373 * @since 11 23374 */ 23375 pageTransition?(): void; 23376 23377 /** 23378 * Get current UIContext 23379 * 23380 * @returns { UIContext } The UIContext that the custom component belongs to. 23381 * @syscap SystemCapability.ArkUI.ArkUI.Full 23382 * @crossplatform 23383 * @since 11 23384 */ 23385 /** 23386 * Get current UIContext 23387 * 23388 * @returns { UIContext } The UIContext that the custom component belongs to. 23389 * @syscap SystemCapability.ArkUI.ArkUI.Full 23390 * @crossplatform 23391 * @atomicservice 23392 * @since 12 23393 */ 23394 getUIContext(): UIContext; 23395 23396 /** 23397 * Get uniqueId of the custom component. 23398 * 23399 * @returns { number } - The uniqueId of the custom component. 23400 * @syscap SystemCapability.ArkUI.ArkUI.Full 23401 * @crossplatform 23402 * @atomicservice 23403 * @since 12 23404 */ 23405 getUniqueId(): number; 23406 23407 /** 23408 * Queries the navigation destination information. 23409 * 23410 * @returns { NavDestinationInfo | undefined } The navigation destination information, or undefined if it is not available. 23411 * @syscap SystemCapability.ArkUI.ArkUI.Full 23412 * @crossplatform 23413 * @since 11 23414 */ 23415 /** 23416 * Queries the navigation destination information. 23417 * 23418 * @returns { NavDestinationInfo | undefined } The navigation destination information, or undefined if it is not available. 23419 * @syscap SystemCapability.ArkUI.ArkUI.Full 23420 * @crossplatform 23421 * @atomicservice 23422 * @since 12 23423 */ 23424 queryNavDestinationInfo(): NavDestinationInfo | undefined; 23425 23426 /** 23427 * Query the navigation information of the current custom component. 23428 * 23429 * @returns { NavigationInfo | undefined } The navigation information, or undefined if it is not available 23430 * @syscap SystemCapability.ArkUI.ArkUI.Full 23431 * @crossplatform 23432 * @atomicservice 23433 * @since 12 23434 */ 23435 queryNavigationInfo(): NavigationInfo | undefined; 23436 23437 /** 23438 * Query the router page information of the current custom component. 23439 * 23440 * @returns { RouterPageInfo | undefined } The router page information, or undefined if it is not available. 23441 * @syscap SystemCapability.ArkUI.ArkUI.Full 23442 * @crossplatform 23443 * @atomicservice 23444 * @since 12 23445 */ 23446 queryRouterPageInfo(): RouterPageInfo | undefined; 23447 23448 /** 23449 * The callback method after the custom component is built. 23450 * 23451 * Triggered when the custom component has been built. 23452 * 23453 * @syscap SystemCapability.ArkUI.ArkUI.Full 23454 * @crossplatform 23455 * @atomicservice 23456 * @since 12 23457 */ 23458 onDidBuild?(): void; 23459} 23460 23461/** 23462 * View 23463 * 23464 * @syscap SystemCapability.ArkUI.ArkUI.Full 23465 * @systemapi 23466 * @since 7 23467 */ 23468/** 23469 * View 23470 * 23471 * @syscap SystemCapability.ArkUI.ArkUI.Full 23472 * @systemapi 23473 * @form 23474 * @since 9 23475 */ 23476declare class View { 23477 /** 23478 * Just use for generate tsbundle 23479 * 23480 * @param { any } value 23481 * @returns { any } 23482 * @syscap SystemCapability.ArkUI.ArkUI.Full 23483 * @systemapi 23484 * @since 7 23485 */ 23486 /** 23487 * Just use for generate tsbundle 23488 * 23489 * @param { any } value 23490 * @returns { any } 23491 * @syscap SystemCapability.ArkUI.ArkUI.Full 23492 * @systemapi 23493 * @form 23494 * @since 9 23495 */ 23496 create(value: any): any; 23497} 23498 23499/** 23500 * Rect info. 23501 * 23502 * @interface RectResult 23503 * @syscap SystemCapability.ArkUI.ArkUI.Full 23504 * @crossplatform 23505 * @since 10 23506 */ 23507/** 23508 * Rect info. 23509 * 23510 * @interface RectResult 23511 * @syscap SystemCapability.ArkUI.ArkUI.Full 23512 * @crossplatform 23513 * @atomicservice 23514 * @since 11 23515 */ 23516declare interface RectResult { 23517 /** 23518 * x:Horizontal coordinate relative to the component. 23519 * 23520 * @type { number } 23521 * @syscap SystemCapability.ArkUI.ArkUI.Full 23522 * @since 10 23523 */ 23524 /** 23525 * x:Horizontal coordinate relative to the component. 23526 * 23527 * @type { number } 23528 * @syscap SystemCapability.ArkUI.ArkUI.Full 23529 * @crossplatform 23530 * @atomicservice 23531 * @since 11 23532 */ 23533 x: number; 23534 23535 /** 23536 * y:Vertical axis coordinate relative to the component. 23537 * 23538 * @type { number } 23539 * @syscap SystemCapability.ArkUI.ArkUI.Full 23540 * @since 10 23541 */ 23542 /** 23543 * y:Vertical axis coordinate relative to the component. 23544 * 23545 * @type { number } 23546 * @syscap SystemCapability.ArkUI.ArkUI.Full 23547 * @crossplatform 23548 * @atomicservice 23549 * @since 11 23550 */ 23551 y: number; 23552 23553 /** 23554 * Get the width of the current textRect. 23555 * 23556 * @type { number } 23557 * @syscap SystemCapability.ArkUI.ArkUI.Full 23558 * @since 10 23559 */ 23560 /** 23561 * Get the width of the current textRect. 23562 * 23563 * @type { number } 23564 * @syscap SystemCapability.ArkUI.ArkUI.Full 23565 * @crossplatform 23566 * @atomicservice 23567 * @since 11 23568 */ 23569 width: number; 23570 23571 /** 23572 * Get the height of the current textRect. 23573 * 23574 * @type { number } 23575 * @syscap SystemCapability.ArkUI.ArkUI.Full 23576 * @since 10 23577 */ 23578 /** 23579 * Get the height of the current textRect. 23580 * 23581 * @type { number } 23582 * @syscap SystemCapability.ArkUI.ArkUI.Full 23583 * @crossplatform 23584 * @atomicservice 23585 * @since 11 23586 */ 23587 height: number; 23588} 23589 23590/** 23591 * CaretOffset info. 23592 * 23593 * @interface CaretOffset 23594 * @syscap SystemCapability.ArkUI.ArkUI.Full 23595 * @crossplatform 23596 * @since 11 23597 */ 23598/** 23599 * CaretOffset info. 23600 * 23601 * @interface CaretOffset 23602 * @syscap SystemCapability.ArkUI.ArkUI.Full 23603 * @crossplatform 23604 * @atomicservice 23605 * @since 12 23606 */ 23607declare interface CaretOffset { 23608 /** 23609 * Get the index of the CaretOffset 23610 * 23611 * @type { number } 23612 * @syscap SystemCapability.ArkUI.ArkUI.Full 23613 * @since 11 23614 */ 23615 /** 23616 * Get the index of the CaretOffset 23617 * 23618 * @type { number } 23619 * @syscap SystemCapability.ArkUI.ArkUI.Full 23620 * @atomicservice 23621 * @since 12 23622 */ 23623 index: number; 23624 23625 /** 23626 * Get the x of the relative position. 23627 * 23628 * @type { number } 23629 * @syscap SystemCapability.ArkUI.ArkUI.Full 23630 * @since 11 23631 */ 23632 /** 23633 * Get the x of the relative position. 23634 * 23635 * @type { number } 23636 * @syscap SystemCapability.ArkUI.ArkUI.Full 23637 * @atomicservice 23638 * @since 12 23639 */ 23640 x: number; 23641 23642 /** 23643 * Get the y of the relative position. 23644 * 23645 * @type { number } 23646 * @syscap SystemCapability.ArkUI.ArkUI.Full 23647 * @since 11 23648 */ 23649 /** 23650 * Get the y of the relative position. 23651 * 23652 * @type { number } 23653 * @syscap SystemCapability.ArkUI.ArkUI.Full 23654 * @atomicservice 23655 * @since 12 23656 */ 23657 y: number; 23658} 23659 23660/** 23661 * Defines the span options of TextContentController. 23662 * 23663 * @interface TextContentControllerOptions 23664 * @syscap SystemCapability.ArkUI.ArkUI.Full 23665 * @crossplatform 23666 * @atomicservice 23667 * @since 15 23668 */ 23669declare interface TextContentControllerOptions { 23670 /** 23671 * the offset that add a text at. 23672 * 23673 * @type { ?number } 23674 * @syscap SystemCapability.ArkUI.ArkUI.Full 23675 * @crossplatform 23676 * @atomicservice 23677 * @since 15 23678 */ 23679 offset?: number; 23680} 23681 23682/** 23683 * TextContentControllerBase 23684 * 23685 * @syscap SystemCapability.ArkUI.ArkUI.Full 23686 * @crossplatform 23687 * @since 10 23688 */ 23689/** 23690 * TextContentControllerBase 23691 * 23692 * @syscap SystemCapability.ArkUI.ArkUI.Full 23693 * @crossplatform 23694 * @atomicservice 23695 * @since 11 23696 */ 23697declare abstract class TextContentControllerBase { 23698 /** 23699 * Get the index and relative position of the CaretOffset. 23700 * 23701 * @returns { CaretOffset } index and relative position of the CaretOffset. 23702 * @syscap SystemCapability.ArkUI.ArkUI.Full 23703 * @crossplatform 23704 * @since 11 23705 */ 23706 /** 23707 * Get the index and relative position of the CaretOffset. 23708 * 23709 * @returns { CaretOffset } index and relative position of the CaretOffset. 23710 * @syscap SystemCapability.ArkUI.ArkUI.Full 23711 * @crossplatform 23712 * @atomicservice 23713 * @since 12 23714 */ 23715 getCaretOffset() : CaretOffset; 23716 23717 /** 23718 * Get the start and end positions of the text content. 23719 * 23720 * @returns { RectResult } Text content rect. 23721 * @syscap SystemCapability.ArkUI.ArkUI.Full 23722 * @crossplatform 23723 * @since 10 23724 */ 23725 /** 23726 * Get the start and end positions of the text content. 23727 * 23728 * @returns { RectResult } Text content rect. 23729 * @syscap SystemCapability.ArkUI.ArkUI.Full 23730 * @crossplatform 23731 * @atomicservice 23732 * @since 11 23733 */ 23734 getTextContentRect() : RectResult; 23735 23736 /** 23737 * Get the lines number of the text content. 23738 * 23739 * @returns { number } Text content line count 23740 * @syscap SystemCapability.ArkUI.ArkUI.Full 23741 * @crossplatform 23742 * @since 10 23743 */ 23744 /** 23745 * Get the lines number of the text content. 23746 * 23747 * @returns { number } Text content line count 23748 * @syscap SystemCapability.ArkUI.ArkUI.Full 23749 * @crossplatform 23750 * @atomicservice 23751 * @since 11 23752 */ 23753 getTextContentLineCount() : number; 23754 23755 /** 23756 * Add a text. 23757 * 23758 * @param { string } text - text value. 23759 * @param { TextContentControllerOptions } [textOperationOptions] - operation info. 23760 * @returns { number } caret index 23761 * @syscap SystemCapability.ArkUI.ArkUI.Full 23762 * @crossplatform 23763 * @atomicservice 23764 * @since 15 23765 */ 23766 addText(text: string, textOperationOptions?: TextContentControllerOptions): number; 23767 23768 /** 23769 * Delete text in TextRange. 23770 * 23771 * @param { TextRange } [range] - range for deleting. 23772 * @syscap SystemCapability.ArkUI.ArkUI.Full 23773 * @crossplatform 23774 * @atomicservice 23775 * @since 15 23776 */ 23777 deleteText(range?: TextRange): void; 23778 23779 /** 23780 * Gets the selected range of text content. 23781 * 23782 * @returns { TextRange } range for selecting. 23783 * @syscap SystemCapability.ArkUI.ArkUI.Full 23784 * @crossplatform 23785 * @atomicservice 23786 * @since 15 23787 */ 23788 getSelection(): TextRange; 23789} 23790 23791/** 23792 * Enum of scrollable containers' content clip mode. 23793 * 23794 * @enum { number } 23795 * @syscap SystemCapability.ArkUI.ArkUI.Full 23796 * @crossplatform 23797 * @atomicservice 23798 * @since 14 23799 */ 23800declare enum ContentClipMode { 23801 /** 23802 * Clip to content rect inside margin & padding. 23803 * 23804 * @syscap SystemCapability.ArkUI.ArkUI.Full 23805 * @crossplatform 23806 * @atomicservice 23807 * @since 14 23808 */ 23809 CONTENT_ONLY = 0, 23810 23811 /** 23812 * Clip to scrollable's outer rect, including padding but inside margin. 23813 * 23814 * @syscap SystemCapability.ArkUI.ArkUI.Full 23815 * @crossplatform 23816 * @atomicservice 23817 * @since 14 23818 */ 23819 BOUNDARY = 1, 23820 23821 /** 23822 * Clip to the safeArea of scrollable container. 23823 * 23824 * @syscap SystemCapability.ArkUI.ArkUI.Full 23825 * @crossplatform 23826 * @atomicservice 23827 * @since 14 23828 */ 23829 SAFE_AREA = 2, 23830} 23831 23832/** 23833 * CommonScrollableMethod 23834 * 23835 * @extends CommonMethod<T> 23836 * @syscap SystemCapability.ArkUI.ArkUI.Full 23837 * @crossplatform 23838 * @atomicservice 23839 * @since 11 23840 */ 23841/** 23842 * CommonScrollableMethod 23843 * 23844 * @extends CommonMethod<T> 23845 * @syscap SystemCapability.ArkUI.ArkUI.Full 23846 * @crossplatform 23847 * @form 23848 * @atomicservice 23849 * @since 12 23850 */ 23851declare class ScrollableCommonMethod<T> extends CommonMethod<T> { 23852 /** 23853 * Scrollbar status. 23854 * 23855 * @param { BarState } barState - Scrollbar status. 23856 * @returns { T } 23857 * @syscap SystemCapability.ArkUI.ArkUI.Full 23858 * @crossplatform 23859 * @atomicservice 23860 * @since 11 23861 */ 23862 scrollBar(barState: BarState): T; 23863 23864 /** 23865 * Color of the scrollbar. 23866 * 23867 * @param { Color | number | string } color - Color of the scrollbar. 23868 * @returns { T } 23869 * @syscap SystemCapability.ArkUI.ArkUI.Full 23870 * @crossplatform 23871 * @atomicservice 23872 * @since 11 23873 */ 23874 scrollBarColor(color: Color | number | string): T; 23875 23876 /** 23877 * Width of the scrollbar. 23878 * 23879 * @param { number | string } value - Width of the scrollbar. 23880 * @returns { T } 23881 * @syscap SystemCapability.ArkUI.ArkUI.Full 23882 * @crossplatform 23883 * @atomicservice 23884 * @since 11 23885 */ 23886 scrollBarWidth(value: number | string): T; 23887 23888 /** 23889 * Edge scrolling effect. 23890 * 23891 * @param { EdgeEffect } edgeEffect - edge scrolling effect. 23892 * @param { EdgeEffectOptions } options - edge scrolling effect options. 23893 * @returns { T } 23894 * @syscap SystemCapability.ArkUI.ArkUI.Full 23895 * @crossplatform 23896 * @atomicservice 23897 * @since 11 23898 */ 23899 edgeEffect(edgeEffect: EdgeEffect, options?: EdgeEffectOptions): T; 23900 23901 /** 23902 * Called when setting whether to enable fading Edge effect. 23903 * 23904 * @param { Optional<boolean> } enabled - Whether to turn on the edge fade effect 23905 * @param { FadingEdgeOptions } [options] - The options of fadingEdge. 23906 * @returns { T } 23907 * @syscap SystemCapability.ArkUI.ArkUI.Full 23908 * @crossplatform 23909 * @atomicservice 23910 * @since 14 23911 */ 23912 fadingEdge(enabled: Optional<boolean>, options?: FadingEdgeOptions): T; 23913 23914 /** 23915 * Nested scrolling options. 23916 * 23917 * @param { NestedScrollOptions } value - options for nested scrolling. 23918 * @returns { T } 23919 * @syscap SystemCapability.ArkUI.ArkUI.Full 23920 * @crossplatform 23921 * @atomicservice 23922 * @since 11 23923 */ 23924 nestedScroll(value: NestedScrollOptions): T; 23925 23926 /** 23927 * Whether to support scroll gestures by finger or mouse. 23928 * 23929 * @param { boolean } value - Whether to support scroll gestures by finger or mouse. 23930 * @returns { T } 23931 * @syscap SystemCapability.ArkUI.ArkUI.Full 23932 * @crossplatform 23933 * @atomicservice 23934 * @since 11 23935 */ 23936 enableScrollInteraction(value: boolean): T; 23937 23938 /** 23939 * Friction coefficient. 23940 * 23941 * @param { number | Resource } value - friction coefficient. 23942 * @returns { T } 23943 * @syscap SystemCapability.ArkUI.ArkUI.Full 23944 * @crossplatform 23945 * @atomicservice 23946 * @since 11 23947 */ 23948 friction(value: number | Resource): T; 23949 23950 /** 23951 * Called when the scrollable scrolls. 23952 * 23953 * @param { function } event - callback of scrollable, 23954 * scrollOffset is offset per frame scrolling, ScrollState is current scroll state. 23955 * @returns { T } 23956 * @syscap SystemCapability.ArkUI.ArkUI.Full 23957 * @crossplatform 23958 * @atomicservice 23959 * @since 11 23960 * @deprecated since 12 23961 * @useinstead ScrollableCommonMethod#onDidScroll 23962 */ 23963 onScroll(event: (scrollOffset: number, scrollState: ScrollState) => void): T; 23964 23965 /** 23966 * Called when the scrollable will scroll. 23967 * 23968 * @param { Optional<OnWillScrollCallback> } handler - callback of scrollable. 23969 * @returns { T } 23970 * @syscap SystemCapability.ArkUI.ArkUI.Full 23971 * @crossplatform 23972 * @atomicservice 23973 * @since 12 23974 */ 23975 onWillScroll(handler: Optional<OnWillScrollCallback>): T; 23976 23977 /** 23978 * Called when the scrollable did scroll. 23979 * 23980 * @param { OnScrollCallback } handler - callback of scrollable, 23981 * scrollOffset is offset this frame did scroll, scrollState is current scroll state. 23982 * @returns { T } 23983 * @syscap SystemCapability.ArkUI.ArkUI.Full 23984 * @crossplatform 23985 * @form 23986 * @atomicservice 23987 * @since 12 23988 */ 23989 onDidScroll(handler: OnScrollCallback): T; 23990 23991 /** 23992 * Called when the scrollable reaches the start position. 23993 * 23994 * @param { function } event - Callback function, triggered when the scrollable reaches the start position. 23995 * @returns { T } 23996 * @syscap SystemCapability.ArkUI.ArkUI.Full 23997 * @crossplatform 23998 * @atomicservice 23999 * @since 11 24000 */ 24001 onReachStart(event: () => void): T; 24002 24003 /** 24004 * Called when the scrollable reaches the end position. 24005 * 24006 * @param { function } event - Callback function, triggered when the scrollable reaches the end position. 24007 * @returns { T } 24008 * @syscap SystemCapability.ArkUI.ArkUI.Full 24009 * @crossplatform 24010 * @atomicservice 24011 * @since 11 24012 */ 24013 onReachEnd(event: () => void): T; 24014 24015 /** 24016 * Called when the scrollable starts scrolling. 24017 * 24018 * @param { function } event - Callback function, triggered when the scrollable starts scrolling. 24019 * @returns { T } 24020 * @syscap SystemCapability.ArkUI.ArkUI.Full 24021 * @crossplatform 24022 * @atomicservice 24023 * @since 11 24024 */ 24025 onScrollStart(event: () => void): T; 24026 24027 /** 24028 * Called when the scrollable stops scrolling. 24029 * 24030 * @param { function } event - Callback function, triggered when the scrollable stops scrolling. 24031 * @returns { T } 24032 * @syscap SystemCapability.ArkUI.ArkUI.Full 24033 * @crossplatform 24034 * @atomicservice 24035 * @since 11 24036 */ 24037 onScrollStop(event: () => void): T; 24038 24039 /** 24040 * Limit the max speed when fling. 24041 * 24042 * @param { number } speedLimit - Max fling speed, the minimum value is 0, the maximum value is not limited. 24043 * The unit is vp/s. 24044 * @returns { T } 24045 * @syscap SystemCapability.ArkUI.ArkUI.Full 24046 * @crossplatform 24047 * @atomicservice 24048 * @since 11 24049 */ 24050 flingSpeedLimit(speedLimit: number): T; 24051 24052 /** 24053 * Clip the content of the scrollable container, excluding background. 24054 * 24055 * @param { ContentClipMode | RectShape } clip - A value from enum ContentClipMode or a customized clip rect. 24056 * @returns { T } 24057 * @syscap SystemCapability.ArkUI.ArkUI.Full 24058 * @crossplatform 24059 * @atomicservice 24060 * @since 14 24061 */ 24062 clipContent(clip: ContentClipMode | RectShape): T; 24063 24064 /** 24065 * Controls whether the scrollable scrolls back to top when status bar is clicked. 24066 * 24067 * @param { boolean } backToTop - whether the scrollable scrolls back to top when status bar is clicked. 24068 * The default value is false. 24069 * @returns { T } 24070 * @syscap SystemCapability.ArkUI.ArkUI.Full 24071 * @crossplatform 24072 * @atomicservice 24073 * @since 15 24074 */ 24075 backToTop(backToTop: boolean): T; 24076} 24077 24078/** 24079 * The actual offset by which the scrollable scrolls. 24080 * @syscap SystemCapability.ArkUI.ArkUI.Full 24081 * @crossplatform 24082 * @atomicservice 24083 * @since 12 24084 */ 24085declare class ScrollResult { 24086 /** 24087 * Actual offset by which the scrollable scrolls in vp. 24088 * @type { number } 24089 * @syscap SystemCapability.ArkUI.ArkUI.Full 24090 * @crossplatform 24091 * @atomicservice 24092 * @since 12 24093 */ 24094 offsetRemain: number; 24095} 24096 24097/** 24098 * Called before scroll to allow developer to control real offset the Scrollable can scroll. 24099 * 24100 * @typedef { function } OnWillScrollCallback 24101 * @param { number } scrollOffset - offset this frame will scroll, which may or may not be reached. 24102 * @param { ScrollState } scrollState - current scroll state. 24103 * @param { ScrollSource } scrollSource - source of current scroll. 24104 * @returns { void | ScrollResult } the remain offset for the scrollable, 24105 * same as scrollOffset when no ScrollResult is returned. 24106 * @syscap SystemCapability.ArkUI.ArkUI.Full 24107 * @crossplatform 24108 * @atomicservice 24109 * @since 12 24110 */ 24111declare type OnWillScrollCallback = 24112(scrollOffset: number, scrollState: ScrollState, scrollSource: ScrollSource) => void | ScrollResult; 24113 24114/** 24115 * On scroll callback using in scrollable onDidScroll. 24116 * 24117 * @typedef { function } OnScrollCallback 24118 * @param { number } scrollOffset - offset this frame did scroll. 24119 * @param { ScrollState } scrollState - current scroll state. 24120 * @syscap SystemCapability.ArkUI.ArkUI.Full 24121 * @crossplatform 24122 * @form 24123 * @atomicservice 24124 * @since 12 24125 */ 24126declare type OnScrollCallback = (scrollOffset: number, scrollState: ScrollState) => void; 24127 24128/** 24129 * Defines the onMove callback. 24130 * 24131 * @typedef { function } OnMoveHandler 24132 * @param { number } from - Index number for moving elements. 24133 * @param { number } to - Target index number for moving elements. 24134 * @syscap SystemCapability.ArkUI.ArkUI.Full 24135 * @crossplatform 24136 * @atomicservice 24137 * @since 12 24138 */ 24139declare type OnMoveHandler = (from: number, to: number) => void 24140 24141/** 24142 * Define DynamicNode. 24143 * 24144 * @syscap SystemCapability.ArkUI.ArkUI.Full 24145 * @crossplatform 24146 * @atomicservice 24147 * @since 12 24148 */ 24149declare class DynamicNode<T> { 24150 /** 24151 * Set the move action. 24152 * 24153 * @param { Optional<OnMoveHandler> } handler 24154 * @returns { T } 24155 * @syscap SystemCapability.ArkUI.ArkUI.Full 24156 * @crossplatform 24157 * @atomicservice 24158 * @since 12 24159 */ 24160 onMove(handler: Optional<OnMoveHandler>): T 24161} 24162 24163/** 24164 * Define EdgeEffect Options. 24165 * 24166 * @interface EdgeEffectOptions 24167 * @syscap SystemCapability.ArkUI.ArkUI.Full 24168 * @crossplatform 24169 * @since 11 24170 */ 24171/** 24172 * Define EdgeEffect Options. 24173 * 24174 * @interface EdgeEffectOptions 24175 * @syscap SystemCapability.ArkUI.ArkUI.Full 24176 * @crossplatform 24177 * @atomicservice 24178 * @since 12 24179 */ 24180declare interface EdgeEffectOptions { 24181 /** 24182 * Enable Sliding effect when component does not full screen. 24183 * 24184 * @type { boolean } 24185 * @syscap SystemCapability.ArkUI.ArkUI.Full 24186 * @crossplatform 24187 * @since 11 24188 */ 24189 /** 24190 * Enable Sliding effect when component does not full screen. 24191 * 24192 * @type { boolean } 24193 * @syscap SystemCapability.ArkUI.ArkUI.Full 24194 * @crossplatform 24195 * @atomicservice 24196 * @since 12 24197 */ 24198 alwaysEnabled: boolean; 24199} 24200 24201/** 24202 * Indicates children main size. 24203 * 24204 * @syscap SystemCapability.ArkUI.ArkUI.Full 24205 * @crossplatform 24206 * @atomicservice 24207 * @since 12 24208 */ 24209declare class ChildrenMainSize { 24210 /** 24211 * Creates an instance of ChildrenMainSize. 24212 * 24213 * @param { number } childDefaultSize - default main size, in vp. If the main axis is vertical, it indicates height. 24214 * If the main axis is horizontal, it indicates width. 24215 * @throws { BusinessError } 401 - Parameter error. Possible causes: 24216 * <br> 1. Mandatory parameters are left unspecified. 24217 * <br> 2. Incorrect parameters types. 24218 * <br> 3. Parameter verification failed. 24219 * @syscap SystemCapability.ArkUI.ArkUI.Full 24220 * @crossplatform 24221 * @atomicservice 24222 * @since 12 24223 */ 24224 constructor(childDefaultSize: number); 24225 24226 /** 24227 * Set default size. 24228 * 24229 * @param { number } value - default main size, in vp. If the main axis is vertical, it indicates height. 24230 * If the main axis is horizontal, it indicates width. 24231 * @throws { BusinessError } 401 - Parameter error. Possible causes: 24232 * <br> 1. Mandatory parameters are left unspecified. 24233 * <br> 2. Incorrect parameters types. 24234 * <br> 3. Parameter verification failed. 24235 * @syscap SystemCapability.ArkUI.ArkUI.Full 24236 * @crossplatform 24237 * @atomicservice 24238 * @since 12 24239 */ 24240 set childDefaultSize(value: number); 24241 24242 /** 24243 * Get default size 24244 * 24245 * @returns { number } - default main size, in vp. If the main axis is vertical, it indicates height. 24246 * If the main axis is horizontal, it indicates width. 24247 * @syscap SystemCapability.ArkUI.ArkUI.Full 24248 * @crossplatform 24249 * @atomicservice 24250 * @since 12 24251 */ 24252 get childDefaultSize(): number; 24253 24254 /** 24255 * Changes children main size by removing or replacing existing elements and/or adding new elements in place. 24256 * 24257 * @param { number } start - Zero-based index at which to start changing the children main size. 24258 * @param { number } [deleteCount] - Indicating the number of children main size to remove from start. 24259 * @param { Array<number> } [childrenSize] - Add the new children main size, beginning from start. 24260 * @throws { BusinessError } 401 - Parameter error. Possible causes: 24261 * <br> 1. Mandatory parameters are left unspecified. 24262 * <br> 2. Incorrect parameters types. 24263 * <br> 3. Parameter verification failed. 24264 * @syscap SystemCapability.ArkUI.ArkUI.Full 24265 * @crossplatform 24266 * @atomicservice 24267 * @since 12 24268 * @example splice(1, 0, [100]), Insert a child after first child, the child's main size is 100vp. 24269 * splice(1, 1), Delete the second child. 24270 * splice(1, 2, [100, 100]), Change the main size of the second and third children to 100vp. 24271 */ 24272 splice(start: number, deleteCount?: number, childrenSize?: Array<number>): void; 24273 24274 /** 24275 * Updates main size for specified child. 24276 * 24277 * @param { number } index - index of child to be updated. 24278 * @param { number } childSize - new section options. 24279 * @throws { BusinessError } 401 - Parameter error. Possible causes: 24280 * <br> 1. Mandatory parameters are left unspecified. 24281 * <br> 2. Incorrect parameters types. 24282 * <br> 3. Parameter verification failed. 24283 * @syscap SystemCapability.ArkUI.ArkUI.Full 24284 * @crossplatform 24285 * @atomicservice 24286 * @since 12 24287 */ 24288 update(index: number, childSize: number): void; 24289} 24290 24291/** 24292 * Define BackgroundBrightness Options. 24293 * 24294 * @interface BackgroundBrightnessOptions 24295 * @syscap SystemCapability.ArkUI.ArkUI.Full 24296 * @atomicservice 24297 * @since 12 24298 */ 24299declare interface BackgroundBrightnessOptions { 24300 24301 /** 24302 * Rate represents the rate at which lightUpDegree 24303 * decreases with increasing pixel brightness. 24304 * 24305 * @type { number } -The default value is 0.0, value range: (0.0, +∞). 24306 * @syscap SystemCapability.ArkUI.ArkUI.Full 24307 * @atomicservice 24308 * @since 12 24309 */ 24310 rate: number; 24311 24312 /** 24313 * LightUpDegree represents the degree of brightness 24314 * of the rgb value changes when its brightness 24315 * is 0. 24316 * 24317 * @type { number } -The default value is 0.0, value range: [-1.0, 1.0]. 24318 * @syscap SystemCapability.ArkUI.ArkUI.Full 24319 * @atomicservice 24320 * @since 12 24321 */ 24322 lightUpDegree: number; 24323} 24324 24325/** 24326 * PointLightStyle info 24327 * 24328 * @interface PointLightStyle 24329 * @syscap SystemCapability.ArkUI.ArkUI.Full 24330 * @systemapi 24331 * @since 11 24332 */ 24333declare interface PointLightStyle { 24334 /** 24335 * Defines the PointLight light intensity and position. 24336 * 24337 * @type { ?LightSource } 24338 * @default undefined 24339 * @syscap SystemCapability.ArkUI.ArkUI.Full 24340 * @systemapi 24341 * @since 11 24342 */ 24343 lightSource?: LightSource; 24344 /** 24345 * Defines the PointLight illuminated type. 24346 * 24347 * @type { ?IlluminatedType } 24348 * @default IlluminatedType.NONE 24349 * @syscap SystemCapability.ArkUI.ArkUI.Full 24350 * @systemapi 24351 * @since 11 24352 */ 24353 illuminated?: IlluminatedType; 24354 /** 24355 * Defines the PointLight bloom. 24356 * 24357 * @type { ?number } 24358 * @default 0 24359 * @syscap SystemCapability.ArkUI.ArkUI.Full 24360 * @systemapi 24361 * @since 11 24362 */ 24363 bloom?: number; 24364} 24365 24366/** 24367 * LightSource info 24368 * 24369 * @interface LightSource 24370 * @syscap SystemCapability.ArkUI.ArkUI.Full 24371 * @systemapi 24372 * @since 11 24373 */ 24374declare interface LightSource { 24375 /** 24376 * Defines the PointLight light positionX. 24377 * 24378 * @type { Dimension } 24379 * @syscap SystemCapability.ArkUI.ArkUI.Full 24380 * @systemapi 24381 * @since 11 24382 */ 24383 positionX: Dimension; 24384 /** 24385 * Defines the PointLight light positionX. 24386 * 24387 * @type { Dimension } 24388 * @syscap SystemCapability.ArkUI.ArkUI.Full 24389 * @systemapi 24390 * @since 11 24391 */ 24392 positionY: Dimension; 24393 /** 24394 * Defines the PointLight light positionX. 24395 * 24396 * @type { Dimension } 24397 * @syscap SystemCapability.ArkUI.ArkUI.Full 24398 * @systemapi 24399 * @since 11 24400 */ 24401 positionZ: Dimension; 24402 /** 24403 * Defines the PointLight light intensity. 24404 * 24405 * @type { number } 24406 * @syscap SystemCapability.ArkUI.ArkUI.Full 24407 * @systemapi 24408 * @since 11 24409 */ 24410 intensity: number; 24411 /** 24412 * Defines the PointLight light color. 24413 * 24414 * @type { ?ResourceColor } 24415 * @syscap SystemCapability.ArkUI.ArkUI.Full 24416 * @systemapi 24417 * @since 12 24418 */ 24419 color?: ResourceColor; 24420} 24421 24422/** 24423 * Defining wrapBuilder function. 24424 * @param { function } builder 24425 * @returns { WrappedBuilder<Args> } 24426 * @syscap SystemCapability.ArkUI.ArkUI.Full 24427 * @crossplatform 24428 * @since 11 24429 */ 24430/** 24431 * Defining wrapBuilder function. 24432 * @param { function } builder 24433 * @returns { WrappedBuilder<Args> } 24434 * @syscap SystemCapability.ArkUI.ArkUI.Full 24435 * @crossplatform 24436 * @atomicservice 24437 * @since 12 24438 */ 24439declare function wrapBuilder<Args extends Object[]>(builder: (...args: Args) => void): WrappedBuilder<Args>; 24440 24441/** 24442 * Defines the WrappedBuilder class. 24443 * @syscap SystemCapability.ArkUI.ArkUI.Full 24444 * @crossplatform 24445 * @since 11 24446 */ 24447/** 24448 * Defines the WrappedBuilder class. 24449 * @syscap SystemCapability.ArkUI.ArkUI.Full 24450 * @crossplatform 24451 * @atomicservice 24452 * @since 12 24453 */ 24454declare class WrappedBuilder<Args extends Object[]> { 24455 /** 24456 * @type { function } 24457 * @syscap SystemCapability.ArkUI.ArkUI.Full 24458 * @crossplatform 24459 * @since 11 24460 */ 24461 /** 24462 * @type { function } 24463 * @syscap SystemCapability.ArkUI.ArkUI.Full 24464 * @crossplatform 24465 * @atomicservice 24466 * @since 12 24467 */ 24468 builder: (...args: Args) => void; 24469 24470 /** 24471 * @param { function } builder 24472 * @syscap SystemCapability.ArkUI.ArkUI.Full 24473 * @crossplatform 24474 * @since 11 24475 */ 24476 /** 24477 * @param { function } builder 24478 * @syscap SystemCapability.ArkUI.ArkUI.Full 24479 * @crossplatform 24480 * @atomicservice 24481 * @since 12 24482 */ 24483 constructor(builder: (...args: Args) => void); 24484} 24485 24486 24487/** 24488 * Defines the overall animation parameters of the keyframe animation. 24489 * 24490 * @interface KeyframeAnimateParam 24491 * @syscap SystemCapability.ArkUI.ArkUI.Full 24492 * @crossplatform 24493 * @since 11 24494 */ 24495/** 24496 * Defines the overall animation parameters of the keyframe animation. 24497 * 24498 * @interface KeyframeAnimateParam 24499 * @syscap SystemCapability.ArkUI.ArkUI.Full 24500 * @crossplatform 24501 * @atomicservice 24502 * @since 12 24503 */ 24504declare interface KeyframeAnimateParam { 24505 /** 24506 * Animation delay time, in ms. 24507 * 24508 * @type { ?number } 24509 * @default 0 24510 * @syscap SystemCapability.ArkUI.ArkUI.Full 24511 * @crossplatform 24512 * @since 11 24513 */ 24514 /** 24515 * Animation delay time, in ms. 24516 * 24517 * @type { ?number } 24518 * @default 0 24519 * @syscap SystemCapability.ArkUI.ArkUI.Full 24520 * @crossplatform 24521 * @atomicservice 24522 * @since 12 24523 */ 24524 delay?: number; 24525 24526 /** 24527 * Animation iterations. When set to -1, the animation playing it repeatedly. The value range is greater than or equal to -1. 24528 * 24529 * @type { ?number } 24530 * @default 1 24531 * @syscap SystemCapability.ArkUI.ArkUI.Full 24532 * @crossplatform 24533 * @since 11 24534 */ 24535 /** 24536 * Animation iterations. When set to -1, the animation playing it repeatedly. The value range is greater than or equal to -1. 24537 * 24538 * @type { ?number } 24539 * @default 1 24540 * @syscap SystemCapability.ArkUI.ArkUI.Full 24541 * @crossplatform 24542 * @atomicservice 24543 * @since 12 24544 */ 24545 iterations?: number; 24546 24547 /** 24548 * Callback invoked when the whole keyframe animation is complete or the ability is about to enter the background. 24549 * 24550 * @type { ?function } 24551 * @syscap SystemCapability.ArkUI.ArkUI.Full 24552 * @crossplatform 24553 * @since 11 24554 */ 24555 /** 24556 * Callback invoked when the whole keyframe animation is complete or the ability is about to enter the background. 24557 * 24558 * @type { ?function } 24559 * @syscap SystemCapability.ArkUI.ArkUI.Full 24560 * @crossplatform 24561 * @atomicservice 24562 * @since 12 24563 */ 24564 onFinish?: () => void; 24565} 24566 24567/** 24568 * Defines a keyframe state. 24569 * 24570 * @interface KeyframeState 24571 * @syscap SystemCapability.ArkUI.ArkUI.Full 24572 * @crossplatform 24573 * @since 11 24574 */ 24575/** 24576 * Defines a keyframe state. 24577 * 24578 * @interface KeyframeState 24579 * @syscap SystemCapability.ArkUI.ArkUI.Full 24580 * @crossplatform 24581 * @atomicservice 24582 * @since 12 24583 */ 24584declare interface KeyframeState { 24585 /** 24586 * Animation duration of this keyframe, in ms. 24587 * 24588 * @type { number } 24589 * @syscap SystemCapability.ArkUI.ArkUI.Full 24590 * @crossplatform 24591 * @since 11 24592 */ 24593 /** 24594 * Animation duration of this keyframe, in ms. 24595 * 24596 * @type { number } 24597 * @syscap SystemCapability.ArkUI.ArkUI.Full 24598 * @crossplatform 24599 * @atomicservice 24600 * @since 12 24601 */ 24602 duration: number; 24603 24604 /** 24605 * Animation curve of this keyframe. 24606 * 24607 * @type { ?(Curve | string | ICurve) } 24608 * @syscap SystemCapability.ArkUI.ArkUI.Full 24609 * @crossplatform 24610 * @since 11 24611 */ 24612 /** 24613 * Animation curve of this keyframe. 24614 * 24615 * @type { ?(Curve | string | ICurve) } 24616 * @syscap SystemCapability.ArkUI.ArkUI.Full 24617 * @crossplatform 24618 * @atomicservice 24619 * @since 12 24620 */ 24621 curve?: Curve | string | ICurve; 24622 24623 /** 24624 * The closure function to specify the terminating state of this keyframe. 24625 * 24626 * @type { function } 24627 * @syscap SystemCapability.ArkUI.ArkUI.Full 24628 * @crossplatform 24629 * @since 11 24630 */ 24631 /** 24632 * The closure function to specify the terminating state of this keyframe. 24633 * 24634 * @type { function } 24635 * @syscap SystemCapability.ArkUI.ArkUI.Full 24636 * @crossplatform 24637 * @atomicservice 24638 * @since 12 24639 */ 24640 event: () => void; 24641} 24642 24643 24644/** 24645 * Defines the basic callback. 24646 * 24647 * @typedef Callback<T, V = void> 24648 * @syscap SystemCapability.ArkUI.ArkUI.Full 24649 * @crossplatform 24650 * @atomicservice 24651 * @since 12 24652 */ 24653declare interface Callback<T, V = void> { 24654 /** 24655 * Defines the callback info. 24656 * 24657 * @param { T } data - the data will be used in the callback. 24658 * @returns { V } - Returns result of the callback. 24659 * @syscap SystemCapability.ArkUI.ArkUI.Full 24660 * @crossplatform 24661 * @atomicservice 24662 * @since 12 24663 */ 24664 (data: T): V; 24665} 24666 24667/** 24668 * Defines the callback type used in hover events. 24669 * The value of isHover indicates whether the mouse is hovering over the component. 24670 * The value of event contains information about HoverEvent. 24671 * 24672 * @typedef { function } HoverCallback 24673 * @param { boolean } isHover 24674 * @param { HoverEvent} event 24675 * @syscap SystemCapability.ArkUI.ArkUI.Full 24676 * @crossplatform 24677 * @atomicservice 24678 * @since 12 24679 */ 24680declare type HoverCallback = (isHover: boolean, event: HoverEvent) => void 24681 24682/** 24683 * Defines the callback type used in accessibility hover events. 24684 * The value of isHover indicates whether the touch is hovering over the component. 24685 * The value of event contains information about AccessibilityHoverEvent. 24686 * 24687 * @typedef { function } AccessibilityCallback 24688 * @param { boolean } isHover 24689 * @param { AccessibilityHoverEvent } event 24690 * @syscap SystemCapability.ArkUI.ArkUI.Full 24691 * @crossplatform 24692 * @atomicservice 24693 * @since 12 24694 */ 24695declare type AccessibilityCallback = (isHover: boolean, event: AccessibilityHoverEvent) => void; 24696 24697/** 24698 * Defines the options about VisibleAreaEvent. 24699 * 24700 * @interface VisibleAreaEventOptions 24701 * @syscap SystemCapability.ArkUI.ArkUI.Full 24702 * @crossplatform 24703 * @atomicservice 24704 * @since 12 24705 */ 24706declare interface VisibleAreaEventOptions { 24707 /** 24708 * Each number in ratios indicates the value of visibility ratio. Each number in the Array value range in [0, 1]. 24709 * 24710 * @type { Array<number> } 24711 * @syscap SystemCapability.ArkUI.ArkUI.Full 24712 * @crossplatform 24713 * @atomicservice 24714 * @since 12 24715 */ 24716 ratios: Array<number>; 24717 24718 /** 24719 * The value of expectedUpdateInterval indicates desired update period(ms). 24720 * 24721 * @type { ?number } 24722 * @default 1000 24723 * @syscap SystemCapability.ArkUI.ArkUI.Full 24724 * @crossplatform 24725 * @atomicservice 24726 * @since 12 24727 */ 24728 expectedUpdateInterval?: number; 24729} 24730 24731/** 24732 * Defines the callback type used in VisibleAreaChange events. 24733 * 24734 * @typedef { function } VisibleAreaChangeCallback 24735 * @param { boolean } isVisible - Indicates the ratio of the visible area to its own area compared to the last change. 24736 * It is true as the ratio increases and false as the ratio decreases. 24737 * @param { number } currentRatio - The value of currentRatio indicates the visibility ratio of the current component. 24738 * @syscap SystemCapability.ArkUI.ArkUI.Full 24739 * @crossplatform 24740 * @atomicservice 24741 * @since 12 24742 */ 24743/** 24744 * Defines the callback type used in VisibleAreaChange events. 24745 * 24746 * @typedef { function } VisibleAreaChangeCallback 24747 * @param { boolean } isExpanding - Indicates the ratio of the visible area to its own area compared to the last change. 24748 * It is true as the ratio increases and false as the ratio decreases. 24749 * @param { number } currentRatio - The value of currentRatio indicates the visibility ratio of the current component. 24750 * @syscap SystemCapability.ArkUI.ArkUI.Full 24751 * @crossplatform 24752 * @atomicservice 24753 * @since 13 24754 */ 24755declare type VisibleAreaChangeCallback = (isExpanding: boolean, currentRatio: number) => void; 24756 24757/** 24758 * Defines a UICommonEvent which is used to set different common event to target component. 24759 * 24760 * @interface UICommonEvent 24761 * @syscap SystemCapability.ArkUI.ArkUI.Full 24762 * @crossplatform 24763 * @atomicservice 24764 * @since 12 24765 */ 24766declare interface UICommonEvent { 24767 /** 24768 * Set or reset the callback which will be triggered a click event when clicked. 24769 * 24770 * @param { Callback<ClickEvent> | undefined } callback - The callback about the click event. If set undefined will reset the target callback. 24771 * @syscap SystemCapability.ArkUI.ArkUI.Full 24772 * @crossplatform 24773 * @atomicservice 24774 * @since 12 24775 */ 24776 setOnClick(callback: Callback<ClickEvent> | undefined): void; 24777 24778 /** 24779 * Set or reset the callback which will be triggered a touch event when touched. 24780 * 24781 * @param { Callback<TouchEvent> | undefined } callback - The callback about the touch event. If set undefined will reset the target callback. 24782 * @syscap SystemCapability.ArkUI.ArkUI.Full 24783 * @crossplatform 24784 * @atomicservice 24785 * @since 12 24786 */ 24787 setOnTouch(callback: Callback<TouchEvent> | undefined): void; 24788 24789 /** 24790 * Set or reset the callback is triggered when a component mounts a display. 24791 * 24792 * @param { Callback<void> | undefined } callback - The callback will be triggered when a component mounts a display. If set undefined will reset the target callback. 24793 * @syscap SystemCapability.ArkUI.ArkUI.Full 24794 * @crossplatform 24795 * @atomicservice 24796 * @since 12 24797 */ 24798 setOnAppear(callback: Callback<void> | undefined): void; 24799 24800 /** 24801 * Set or reset the callback is triggered when component uninstallation disappears. 24802 * 24803 * @param { Callback<void> | undefined } callback - The callback will be triggered when component uninstallation disappears. If set undefined will reset the target callback. 24804 * @syscap SystemCapability.ArkUI.ArkUI.Full 24805 * @crossplatform 24806 * @atomicservice 24807 * @since 12 24808 */ 24809 setOnDisappear(callback: Callback<void> | undefined): void; 24810 24811 24812 /** 24813 * Set or reset the callback is triggered when component has keyboard input. 24814 * 24815 * @param { Callback<KeyEvent> | undefined } callback - The callback will be triggered when has keyboard input. If set undefined will reset the target callback. 24816 * @syscap SystemCapability.ArkUI.ArkUI.Full 24817 * @crossplatform 24818 * @atomicservice 24819 * @since 12 24820 */ 24821 setOnKeyEvent(callback: Callback<KeyEvent> | undefined): void; 24822 24823 /** 24824 * Set or reset the callback which is triggered when component get focus. 24825 * 24826 * @param { Callback<void> | undefined } callback - The callback will be triggered when a component get focus. If set undefined will reset the target callback. 24827 * @syscap SystemCapability.ArkUI.ArkUI.Full 24828 * @crossplatform 24829 * @atomicservice 24830 * @since 12 24831 */ 24832 setOnFocus(callback: Callback<void> | undefined): void; 24833 24834 /** 24835 * Set or reset the callback which is triggered when lose focus. 24836 * 24837 * @param { Callback<void> | undefined } callback - The callback will be triggered when a component lose focus. If set undefined will reset the target callback. 24838 * @syscap SystemCapability.ArkUI.ArkUI.Full 24839 * @crossplatform 24840 * @atomicservice 24841 * @since 12 24842 */ 24843 setOnBlur(callback: Callback<void> | undefined): void; 24844 24845 /** 24846 * Set or reset the callback which is triggered when has a hover event. 24847 * 24848 * @param { HoverCallback | undefined } callback - The callback will be triggered when has a hover event. If set undefined will reset the target callback. 24849 * @syscap SystemCapability.ArkUI.ArkUI.Full 24850 * @crossplatform 24851 * @atomicservice 24852 * @since 12 24853 */ 24854 setOnHover(callback: HoverCallback | undefined): void; 24855 24856 /** 24857 * Set or reset the callback which is triggered when has a mouse event. 24858 * 24859 * @param { Callback<MouseEvent> | undefined } callback - The callback will be triggered when has mouse input. If set undefined will reset the target callback. 24860 * @syscap SystemCapability.ArkUI.ArkUI.Full 24861 * @crossplatform 24862 * @atomicservice 24863 * @since 12 24864 */ 24865 setOnMouse(callback: Callback<MouseEvent> | undefined): void; 24866 24867 /** 24868 * Set or reset the callback which is triggered when the size of component changed. 24869 * 24870 * @param { SizeChangeCallback | undefined } callback - The callback will be triggered when the size of component changed. If set undefined will reset the target callback. 24871 * @syscap SystemCapability.ArkUI.ArkUI.Full 24872 * @crossplatform 24873 * @atomicservice 24874 * @since 12 24875 */ 24876 setOnSizeChange(callback: SizeChangeCallback | undefined): void; 24877 24878 /** 24879 * Set or reset the callback which is triggered when the visibleArea of component changed. 24880 * 24881 * @param { VisibleAreaEventOptions } options - The options for the visibility event. 24882 * @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. 24883 * If set undefined will reset the target callback. 24884 * @syscap SystemCapability.ArkUI.ArkUI.Full 24885 * @crossplatform 24886 * @atomicservice 24887 * @since 12 24888 */ 24889 setOnVisibleAreaApproximateChange(options: VisibleAreaEventOptions, event: VisibleAreaChangeCallback | undefined): void; 24890} 24891 24892/** 24893 * Defines a UIGestureEvent which is used to set different gestures to target component. 24894 * 24895 * @interface UIGestureEvent 24896 * @syscap SystemCapability.ArkUI.ArkUI.Full 24897 * @crossplatform 24898 * @atomicservice 24899 * @since 12 24900 */ 24901declare interface UIGestureEvent { 24902 /** 24903 * Add a gesture bound to the component. 24904 * 24905 * @param { GestureHandler<T> } gesture - gesture indicates the gesture bound to a component. 24906 * @param { GesturePriority } priority - priority indicates the gesture's priority. 24907 * @param { GestureMask } mask - mask indicates the gesture's GestureMask value. 24908 * @syscap SystemCapability.ArkUI.ArkUI.Full 24909 * @crossplatform 24910 * @atomicservice 24911 * @since 12 24912 */ 24913 addGesture<T>(gesture: GestureHandler<T>, priority?: GesturePriority, mask?: GestureMask): void; 24914 24915 /** 24916 * Add a parallel gesture bound to the component. 24917 * 24918 * @param { GestureHandler<T> } gesture - gesture indicates the gesture bound to a component. 24919 * @param { GestureMask } mask - mask indicates the gesture's GestureMask value. 24920 * @syscap SystemCapability.ArkUI.ArkUI.Full 24921 * @crossplatform 24922 * @atomicservice 24923 * @since 12 24924 */ 24925 addParallelGesture<T>(gesture: GestureHandler<T>, mask?: GestureMask): void; 24926 24927 /** 24928 * Remove the gesture that is bound to the component and marked as tag. 24929 * 24930 * @param { string } tag - tag indicates the gesture's tag. 24931 * @syscap SystemCapability.ArkUI.ArkUI.Full 24932 * @crossplatform 24933 * @atomicservice 24934 * @since 12 24935 */ 24936 removeGestureByTag(tag: string): void; 24937 24938 /** 24939 * Clear gestures bound to the component. 24940 * 24941 * @syscap SystemCapability.ArkUI.ArkUI.Full 24942 * @crossplatform 24943 * @atomicservice 24944 * @since 12 24945 */ 24946 clearGestures(): void; 24947} 24948 24949/** 24950 * Defines the gesture modifier. 24951 * 24952 * @interface GestureModifier 24953 * @syscap SystemCapability.ArkUI.ArkUI.Full 24954 * @crossplatform 24955 * @atomicservice 24956 * @since 12 24957 */ 24958declare interface GestureModifier { 24959 /** 24960 * Defines the gesture update function. 24961 * 24962 * @param { UIGestureEvent } event 24963 * @syscap SystemCapability.ArkUI.ArkUI.Full 24964 * @crossplatform 24965 * @atomicservice 24966 * @since 12 24967 */ 24968 applyGesture(event: UIGestureEvent): void; 24969} 24970 24971/** 24972 * Defines the selection options. 24973 * 24974 * @interface SelectionOptions 24975 * @syscap SystemCapability.ArkUI.ArkUI.Full 24976 * @crossplatform 24977 * @atomicservice 24978 * @since 12 24979 */ 24980declare interface SelectionOptions { 24981 /** 24982 * Menu pop-up policy. 24983 * 24984 * @type { ?MenuPolicy } 24985 * @syscap SystemCapability.ArkUI.ArkUI.Full 24986 * @crossplatform 24987 * @atomicservice 24988 * @since 12 24989 */ 24990 menuPolicy?: MenuPolicy; 24991} 24992 24993/** 24994 * enum keyboard avoid mode 24995 * 24996 * @enum { number } 24997 * @syscap SystemCapability.ArkUI.ArkUI.Full 24998 * @crossplatform 24999 * @atomicservice 25000 * @since 12 25001 */ 25002declare enum KeyboardAvoidMode { 25003 /** 25004 * Defines avoid keyboard when keyboard shows. 25005 * 25006 * @syscap SystemCapability.ArkUI.ArkUI.Full 25007 * @crossplatform 25008 * @atomicservice 25009 * @since 12 25010 */ 25011 DEFAULT = 0, 25012 25013 /** 25014 * Defines not avoid keyboard when keyboard shows. 25015 * 25016 * @syscap SystemCapability.ArkUI.ArkUI.Full 25017 * @crossplatform 25018 * @atomicservice 25019 * @since 12 25020 */ 25021 NONE = 1, 25022} 25023 25024/** 25025 * Enumerates the type of area in hover mode. 25026 * 25027 * @enum { number } 25028 * @syscap SystemCapability.ArkUI.ArkUI.Full 25029 * @crossplatform 25030 * @atomicservice 25031 * @since 14 25032 */ 25033declare enum HoverModeAreaType { 25034 25035 /** 25036 * Layout top half screen when the phone in hover mode. 25037 * 25038 * @syscap SystemCapability.ArkUI.ArkUI.Full 25039 * @crossplatform 25040 * @atomicservice 25041 * @since 14 25042 */ 25043 TOP_SCREEN = 0, 25044 25045 /** 25046 * Layout bottom half screen when the phone in hover mode. 25047 * 25048 * @syscap SystemCapability.ArkUI.ArkUI.Full 25049 * @crossplatform 25050 * @atomicservice 25051 * @since 14 25052 */ 25053 BOTTOM_SCREEN = 1, 25054} 25055