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 * @deprecated since 18 1298 * @useinstead ohos.arkui.UIContext.UIContext#getHostContext 1299 */ 1300declare function getContext(component?: Object): Context; 1301 1302/** 1303 * Defining Reusable ClassDecorator. 1304 * 1305 * @syscap SystemCapability.ArkUI.ArkUI.Full 1306 * @crossplatform 1307 * @since 10 1308 */ 1309/** 1310 * Defining Reusable ClassDecorator. 1311 * 1312 * @syscap SystemCapability.ArkUI.ArkUI.Full 1313 * @crossplatform 1314 * @atomicservice 1315 * @since 11 1316 */ 1317declare const Reusable: ClassDecorator; 1318 1319/** 1320 * Defining ReusableV2 ClassDecorator that is used to decorate @ComponentV2. 1321 * 1322 * @syscap SystemCapability.ArkUI.ArkUI.Full 1323 * @crossplatform 1324 * @atomicservice 1325 * @since 18 1326 */ 1327declare const ReusableV2: ClassDecorator; 1328 1329 /** 1330 * ReuseId callback type. It is used to compute reuseId. 1331 * 1332 * @typedef { function } ReuseIdCallback 1333 * @returns { string } 1334 * @syscap SystemCapability.ArkUI.ArkUI.Full 1335 * @crossplatform 1336 * @atomicservice 1337 * @since 18 1338 */ 1339 declare type ReuseIdCallback = () => string; 1340 1341/** 1342 * Defining the reusable configuration parameters. 1343 * 1344 * @interface ReuseOptions 1345 * @syscap SystemCapability.ArkUI.ArkUI.Full 1346 * @crossplatform 1347 * @atomicservice 1348 * @since 18 1349 */ 1350declare interface ReuseOptions { 1351 /** 1352 * Defining reuseId function. The default reuseId is the custom component name. 1353 * 1354 * @type { ?ReuseIdCallback } 1355 * @syscap SystemCapability.ArkUI.ArkUI.Full 1356 * @crossplatform 1357 * @atomicservice 1358 * @since 18 1359 */ 1360 reuseId? : ReuseIdCallback; 1361} 1362/** 1363 * Get context. 1364 * 1365 * @typedef { import('../api/application/Context').default } Context 1366 * @syscap SystemCapability.ArkUI.ArkUI.Full 1367 * @StageModelOnly 1368 * @since 9 1369 */ 1370/** 1371 * Get context. 1372 * 1373 * @typedef { import('../api/application/Context').default } Context 1374 * @syscap SystemCapability.ArkUI.ArkUI.Full 1375 * @StageModelOnly 1376 * @crossplatform 1377 * @since 10 1378 */ 1379/** 1380 * Get context. 1381 * 1382 * @typedef { import('../api/application/Context').default } Context 1383 * @syscap SystemCapability.ArkUI.ArkUI.Full 1384 * @StageModelOnly 1385 * @crossplatform 1386 * @atomicservice 1387 * @since 11 1388 */ 1389declare type Context = import('../api/application/Context').default; 1390 1391/** 1392 * Post Card Action. 1393 * 1394 * @param { Object } component - indicate the card entry component. 1395 * @param { Object } action - indicate the router, message or call event. 1396 * @syscap SystemCapability.ArkUI.ArkUI.Full 1397 * @StageModelOnly 1398 * @form 1399 * @since 9 1400 */ 1401/** 1402 * Post Card Action. 1403 * 1404 * @param { Object } component - indicate the card entry component. 1405 * @param { Object } action - indicate the router, message or call event. 1406 * @syscap SystemCapability.ArkUI.ArkUI.Full 1407 * @StageModelOnly 1408 * @crossplatform 1409 * @form 1410 * @since 10 1411 */ 1412/** 1413 * Post Card Action. 1414 * 1415 * @param { Object } component - indicate the card entry component. 1416 * @param { Object } action - indicate the router, message or call event. 1417 * @syscap SystemCapability.ArkUI.ArkUI.Full 1418 * @StageModelOnly 1419 * @crossplatform 1420 * @form 1421 * @atomicservice 1422 * @since 11 1423 */ 1424declare function postCardAction(component: Object, action: Object): void; 1425 1426/** 1427 * Defines the data type of the interface restriction. 1428 * 1429 * @interface Configuration 1430 * @syscap SystemCapability.ArkUI.ArkUI.Full 1431 * @since 7 1432 */ 1433/** 1434 * Defines the data type of the interface restriction. 1435 * 1436 * @interface Configuration 1437 * @syscap SystemCapability.ArkUI.ArkUI.Full 1438 * @form 1439 * @since 9 1440 */ 1441/** 1442 * Defines the data type of the interface restriction. 1443 * 1444 * @interface Configuration 1445 * @syscap SystemCapability.ArkUI.ArkUI.Full 1446 * @crossplatform 1447 * @form 1448 * @since 10 1449 */ 1450/** 1451 * Defines the data type of the interface restriction. 1452 * 1453 * @interface Configuration 1454 * @syscap SystemCapability.ArkUI.ArkUI.Full 1455 * @crossplatform 1456 * @form 1457 * @atomicservice 1458 * @since 11 1459 */ 1460declare interface Configuration { 1461 /** 1462 * Set colorMode. 1463 * 1464 * @type { string } 1465 * @readonly 1466 * @syscap SystemCapability.ArkUI.ArkUI.Full 1467 * @since 7 1468 */ 1469 /** 1470 * Set colorMode. 1471 * 1472 * @type { string } 1473 * @readonly 1474 * @syscap SystemCapability.ArkUI.ArkUI.Full 1475 * @form 1476 * @since 9 1477 */ 1478 /** 1479 * Set colorMode. 1480 * 1481 * @type { string } 1482 * @readonly 1483 * @syscap SystemCapability.ArkUI.ArkUI.Full 1484 * @crossplatform 1485 * @form 1486 * @since 10 1487 */ 1488 /** 1489 * Set colorMode. 1490 * 1491 * @type { string } 1492 * @readonly 1493 * @syscap SystemCapability.ArkUI.ArkUI.Full 1494 * @crossplatform 1495 * @form 1496 * @atomicservice 1497 * @since 11 1498 */ 1499 readonly colorMode: string; 1500 1501 /** 1502 * Set fontScale. 1503 * 1504 * @type { number } 1505 * @readonly 1506 * @syscap SystemCapability.ArkUI.ArkUI.Full 1507 * @since 7 1508 */ 1509 /** 1510 * Set fontScale. 1511 * 1512 * @type { number } 1513 * @readonly 1514 * @syscap SystemCapability.ArkUI.ArkUI.Full 1515 * @form 1516 * @since 9 1517 */ 1518 /** 1519 * Set fontScale. 1520 * 1521 * @type { number } 1522 * @readonly 1523 * @syscap SystemCapability.ArkUI.ArkUI.Full 1524 * @crossplatform 1525 * @form 1526 * @since 10 1527 */ 1528 /** 1529 * Set fontScale. 1530 * 1531 * @type { number } 1532 * @readonly 1533 * @syscap SystemCapability.ArkUI.ArkUI.Full 1534 * @crossplatform 1535 * @form 1536 * @atomicservice 1537 * @since 11 1538 */ 1539 readonly fontScale: number; 1540} 1541 1542/** 1543 * Defines the data type of the interface restriction. 1544 * 1545 * @interface Rectangle 1546 * @syscap SystemCapability.ArkUI.ArkUI.Full 1547 * @since 8 1548 */ 1549/** 1550 * Defines the data type of the interface restriction. 1551 * 1552 * @interface Rectangle 1553 * @syscap SystemCapability.ArkUI.ArkUI.Full 1554 * @form 1555 * @since 9 1556 */ 1557/** 1558 * Defines the data type of the interface restriction. 1559 * 1560 * @interface Rectangle 1561 * @syscap SystemCapability.ArkUI.ArkUI.Full 1562 * @crossplatform 1563 * @form 1564 * @since 10 1565 */ 1566/** 1567 * Defines the data type of the interface restriction. 1568 * 1569 * @interface Rectangle 1570 * @syscap SystemCapability.ArkUI.ArkUI.Full 1571 * @crossplatform 1572 * @form 1573 * @atomicservice 1574 * @since 11 1575 */ 1576declare interface Rectangle { 1577 /** 1578 * x:Horizontal coordinate 1579 * 1580 * @type { ?Length } 1581 * @syscap SystemCapability.ArkUI.ArkUI.Full 1582 * @since 8 1583 */ 1584 /** 1585 * x:Horizontal coordinate 1586 * 1587 * @type { ?Length } 1588 * @syscap SystemCapability.ArkUI.ArkUI.Full 1589 * @form 1590 * @since 9 1591 */ 1592 /** 1593 * x:Horizontal coordinate 1594 * 1595 * @type { ?Length } 1596 * @syscap SystemCapability.ArkUI.ArkUI.Full 1597 * @crossplatform 1598 * @form 1599 * @since 10 1600 */ 1601 /** 1602 * x:Horizontal coordinate 1603 * 1604 * @type { ?Length } 1605 * @syscap SystemCapability.ArkUI.ArkUI.Full 1606 * @crossplatform 1607 * @form 1608 * @atomicservice 1609 * @since 11 1610 */ 1611 x?: Length; 1612 1613 /** 1614 * y:Vertical axis coordinate. 1615 * 1616 * @type { ?Length } 1617 * @syscap SystemCapability.ArkUI.ArkUI.Full 1618 * @since 8 1619 */ 1620 /** 1621 * y:Vertical axis coordinate. 1622 * 1623 * @type { ?Length } 1624 * @syscap SystemCapability.ArkUI.ArkUI.Full 1625 * @form 1626 * @since 9 1627 */ 1628 /** 1629 * y:Vertical axis coordinate. 1630 * 1631 * @type { ?Length } 1632 * @syscap SystemCapability.ArkUI.ArkUI.Full 1633 * @crossplatform 1634 * @form 1635 * @since 10 1636 */ 1637 /** 1638 * y:Vertical axis coordinate. 1639 * 1640 * @type { ?Length } 1641 * @syscap SystemCapability.ArkUI.ArkUI.Full 1642 * @crossplatform 1643 * @form 1644 * @atomicservice 1645 * @since 11 1646 */ 1647 y?: Length; 1648 1649 /** 1650 * Sets the width of the current touchRect. 1651 * 1652 * @type { ?Length } 1653 * @syscap SystemCapability.ArkUI.ArkUI.Full 1654 * @since 8 1655 */ 1656 /** 1657 * Sets the width of the current touchRect. 1658 * 1659 * @type { ?Length } 1660 * @syscap SystemCapability.ArkUI.ArkUI.Full 1661 * @form 1662 * @since 9 1663 */ 1664 /** 1665 * Sets the width of the current touchRect. 1666 * 1667 * @type { ?Length } 1668 * @syscap SystemCapability.ArkUI.ArkUI.Full 1669 * @crossplatform 1670 * @form 1671 * @since 10 1672 */ 1673 /** 1674 * Sets the width of the current touchRect. 1675 * 1676 * @type { ?Length } 1677 * @syscap SystemCapability.ArkUI.ArkUI.Full 1678 * @crossplatform 1679 * @form 1680 * @atomicservice 1681 * @since 11 1682 */ 1683 width?: Length; 1684 1685 /** 1686 * Sets the height of the current touchRect. 1687 * 1688 * @type { ?Length } 1689 * @syscap SystemCapability.ArkUI.ArkUI.Full 1690 * @since 8 1691 */ 1692 /** 1693 * Sets the height of the current touchRect. 1694 * 1695 * @type { ?Length } 1696 * @syscap SystemCapability.ArkUI.ArkUI.Full 1697 * @form 1698 * @since 9 1699 */ 1700 /** 1701 * Sets the height of the current touchRect. 1702 * 1703 * @type { ?Length } 1704 * @syscap SystemCapability.ArkUI.ArkUI.Full 1705 * @crossplatform 1706 * @form 1707 * @since 10 1708 */ 1709 /** 1710 * Sets the height of the current touchRect. 1711 * 1712 * @type { ?Length } 1713 * @syscap SystemCapability.ArkUI.ArkUI.Full 1714 * @crossplatform 1715 * @form 1716 * @atomicservice 1717 * @since 11 1718 */ 1719 height?: Length; 1720} 1721 1722/** 1723 * Interface for ExpectedFrameRateRange. 1724 * 1725 * @interface ExpectedFrameRateRange 1726 * @syscap SystemCapability.ArkUI.ArkUI.Full 1727 * @since 11 1728 */ 1729/** 1730 * Interface for ExpectedFrameRateRange. 1731 * 1732 * @interface ExpectedFrameRateRange 1733 * @syscap SystemCapability.ArkUI.ArkUI.Full 1734 * @atomicservice 1735 * @since 12 1736 */ 1737declare interface ExpectedFrameRateRange { 1738 /** 1739 * The minimum animation drawing FPS. 1740 * The minimum value should be less than or equal to the maximum value. 1741 * @type { number } 1742 * @syscap SystemCapability.ArkUI.ArkUI.Full 1743 * @since 11 1744 */ 1745 /** 1746 * The minimum animation drawing FPS. 1747 * The minimum value should be less than or equal to the maximum value. 1748 * @type { number } 1749 * @syscap SystemCapability.ArkUI.ArkUI.Full 1750 * @atomicservice 1751 * @since 12 1752 */ 1753 min: number, 1754 /** 1755 * The maximum animation drawing FPS. 1756 * The maximum value should be greater than or equal to the minimum value. 1757 * @type { number } 1758 * @syscap SystemCapability.ArkUI.ArkUI.Full 1759 * @since 11 1760 */ 1761 /** 1762 * The maximum animation drawing FPS. 1763 * The maximum value should be greater than or equal to the minimum value. 1764 * @type { number } 1765 * @syscap SystemCapability.ArkUI.ArkUI.Full 1766 * @atomicservice 1767 * @since 12 1768 */ 1769 max: number, 1770 /** 1771 * The expected frame rate of dynamical callback rate range. 1772 * The value should be between the minimum and maximum value. 1773 * Otherwise, the actual callback rate will be dynamically 1774 * adjusted to better align with other animation sources. 1775 * @type { number } 1776 * @syscap SystemCapability.ArkUI.ArkUI.Full 1777 * @since 11 1778 */ 1779 /** 1780 * The expected frame rate of dynamical callback rate range. 1781 * The value should be between the minimum and maximum value. 1782 * Otherwise, the actual callback rate will be dynamically 1783 * adjusted to better align with other animation sources. 1784 * @type { number } 1785 * @syscap SystemCapability.ArkUI.ArkUI.Full 1786 * @atomicservice 1787 * @since 12 1788 */ 1789 expected: number, 1790} 1791 1792/** 1793 * global $r function 1794 * 1795 * @param { string } value 1796 * @param { any[] } params 1797 * @returns { Resource } 1798 * @syscap SystemCapability.ArkUI.ArkUI.Full 1799 * @since 7 1800 */ 1801/** 1802 * global $r function 1803 * 1804 * @param { string } value 1805 * @param { any[] } params 1806 * @returns { Resource } 1807 * @syscap SystemCapability.ArkUI.ArkUI.Full 1808 * @form 1809 * @since 9 1810 */ 1811/** 1812 * global $r function 1813 * 1814 * @param { string } value 1815 * @param { any[] } params 1816 * @returns { Resource } 1817 * @syscap SystemCapability.ArkUI.ArkUI.Full 1818 * @crossplatform 1819 * @form 1820 * @since 10 1821 */ 1822/** 1823 * global $r function 1824 * 1825 * @param { string } value 1826 * @param { any[] } params 1827 * @returns { Resource } 1828 * @syscap SystemCapability.ArkUI.ArkUI.Full 1829 * @crossplatform 1830 * @form 1831 * @atomicservice 1832 * @since 11 1833 */ 1834declare function $r(value: string, ...params: any[]): Resource; 1835 1836/** 1837 * global $rawfile function 1838 * 1839 * @param { string } value 1840 * @returns { Resource } 1841 * @syscap SystemCapability.ArkUI.ArkUI.Full 1842 * @since 7 1843 */ 1844/** 1845 * global $rawfile function 1846 * 1847 * @param { string } value 1848 * @returns { Resource } 1849 * @syscap SystemCapability.ArkUI.ArkUI.Full 1850 * @form 1851 * @since 9 1852 */ 1853/** 1854 * global $rawfile function 1855 * 1856 * @param { string } value 1857 * @returns { Resource } 1858 * @syscap SystemCapability.ArkUI.ArkUI.Full 1859 * @crossplatform 1860 * @form 1861 * @since 10 1862 */ 1863/** 1864 * global $rawfile function 1865 * 1866 * @param { string } value 1867 * @returns { Resource } 1868 * @syscap SystemCapability.ArkUI.ArkUI.Full 1869 * @crossplatform 1870 * @form 1871 * @atomicservice 1872 * @since 11 1873 */ 1874declare function $rawfile(value: string): Resource; 1875/** 1876 * Defines the same page mode 1877 * @enum { number } 1878 * @syscap SystemCapability.ArkUI.ArkUI.Full 1879 * @crossplatform 1880 * @form 1881 * @atomicservice 1882 * @since 18 1883 */ 1884declare enum AccessibilitySamePageMode { 1885 /** 1886 * the first page and root page event is not send.but if application load new page whith navigation,the page event will be sent. 1887 * this mode is to solve skipping focus 1888 * @syscap SystemCapability.ArkUI.ArkUI.Full 1889 * @crossplatform 1890 * @form 1891 * @atomicservice 1892 * @since 18 1893 */ 1894 SEMI_SILENT = 0, 1895 /** 1896 * the all page event is not send 1897 * @syscap SystemCapability.ArkUI.ArkUI.Full 1898 * @crossplatform 1899 * @form 1900 * @atomicservice 1901 * @since 18 1902 */ 1903 FULL_SILENT = 1, 1904} 1905/** 1906 * Enum for accessibility component type 1907 * @enum { number } 1908 * @syscap SystemCapability.ArkUI.ArkUI.Full 1909 * @crossplatform 1910 * @form 1911 * @atomicservice 1912 * @since 18 1913 */ 1914declare enum AccessibilityRoleType { 1915 /** 1916 * ActionSheet component type 1917 * @syscap SystemCapability.ArkUI.ArkUI.Full 1918 * @crossplatform 1919 * @form 1920 * @atomicservice 1921 * @since 18 1922 */ 1923 ACTION_SHEET = 0, 1924 /** 1925 * AlertDialog component type 1926 * @syscap SystemCapability.ArkUI.ArkUI.Full 1927 * @crossplatform 1928 * @form 1929 * @atomicservice 1930 * @since 18 1931 */ 1932 ALERT_DIALOG = 1, 1933 /** 1934 * AlphabetIndexer component type 1935 * @syscap SystemCapability.ArkUI.ArkUI.Full 1936 * @crossplatform 1937 * @form 1938 * @atomicservice 1939 * @since 18 1940 */ 1941 INDEXER_COMPONENT = 2, 1942 /** 1943 * badge component type 1944 * @syscap SystemCapability.ArkUI.ArkUI.Full 1945 * @crossplatform 1946 * @form 1947 * @atomicservice 1948 * @since 18 1949 */ 1950 BADGE_COMPONENT = 3, 1951 /** 1952 * blank component type 1953 * @syscap SystemCapability.ArkUI.ArkUI.Full 1954 * @crossplatform 1955 * @form 1956 * @atomicservice 1957 * @since 18 1958 */ 1959 BLANK = 4, 1960 /** 1961 * button component type 1962 * @syscap SystemCapability.ArkUI.ArkUI.Full 1963 * @crossplatform 1964 * @form 1965 * @atomicservice 1966 * @since 18 1967 */ 1968 BUTTON = 5, 1969 /** 1970 * button component type 1971 * @syscap SystemCapability.ArkUI.ArkUI.Full 1972 * @crossplatform 1973 * @form 1974 * @atomicservice 1975 * @since 18 1976 */ 1977 BACK_BUTTON = 6, 1978 /** 1979 * sheet drag bar component type 1980 * @syscap SystemCapability.ArkUI.ArkUI.Full 1981 * @crossplatform 1982 * @form 1983 * @atomicservice 1984 * @since 18 1985 */ 1986 SHEET_DRAG_BAR = 7, 1987 /** 1988 * calendar picker component type 1989 * @syscap SystemCapability.ArkUI.ArkUI.Full 1990 * @crossplatform 1991 * @form 1992 * @atomicservice 1993 * @since 18 1994 */ 1995 CALENDAR_PICKER = 8, 1996 /** 1997 * calendar component type 1998 * @syscap SystemCapability.ArkUI.ArkUI.Full 1999 * @crossplatform 2000 * @form 2001 * @atomicservice 2002 * @since 18 2003 */ 2004 CALENDAR = 9, 2005 /** 2006 * canvas component type 2007 * @syscap SystemCapability.ArkUI.ArkUI.Full 2008 * @crossplatform 2009 * @form 2010 * @atomicservice 2011 * @since 18 2012 */ 2013 CANVAS = 10, 2014 /** 2015 * canvas gradient component type 2016 * @syscap SystemCapability.ArkUI.ArkUI.Full 2017 * @crossplatform 2018 * @form 2019 * @atomicservice 2020 * @since 18 2021 */ 2022 CANVAS_GRADIENT = 11, 2023 /** 2024 * canvas pattern component type 2025 * @syscap SystemCapability.ArkUI.ArkUI.Full 2026 * @crossplatform 2027 * @form 2028 * @atomicservice 2029 * @since 18 2030 */ 2031 CANVAS_PATTERN = 12, 2032 /** 2033 * checkbox component type 2034 * @syscap SystemCapability.ArkUI.ArkUI.Full 2035 * @crossplatform 2036 * @form 2037 * @atomicservice 2038 * @since 18 2039 */ 2040 CHECKBOX = 13, 2041 /** 2042 * checkbox group component type 2043 * @syscap SystemCapability.ArkUI.ArkUI.Full 2044 * @crossplatform 2045 * @form 2046 * @atomicservice 2047 * @since 18 2048 */ 2049 CHECKBOX_GROUP = 14, 2050 /** 2051 * circle component type 2052 * @syscap SystemCapability.ArkUI.ArkUI.Full 2053 * @crossplatform 2054 * @form 2055 * @atomicservice 2056 * @since 18 2057 */ 2058 CIRCLE = 15, 2059 /** 2060 * column split component type 2061 * @syscap SystemCapability.ArkUI.ArkUI.Full 2062 * @crossplatform 2063 * @form 2064 * @atomicservice 2065 * @since 18 2066 */ 2067 COLUMN_SPLIT = 16, 2068 /** 2069 * column component type 2070 * @syscap SystemCapability.ArkUI.ArkUI.Full 2071 * @crossplatform 2072 * @form 2073 * @atomicservice 2074 * @since 18 2075 */ 2076 COLUMN = 17, 2077 /** 2078 * canvas rendering context 2d component type 2079 * @syscap SystemCapability.ArkUI.ArkUI.Full 2080 * @crossplatform 2081 * @form 2082 * @atomicservice 2083 * @since 18 2084 */ 2085 CANVAS_RENDERING_CONTEXT_2D = 18, 2086 /** 2087 * chart component type 2088 * @syscap SystemCapability.ArkUI.ArkUI.Full 2089 * @crossplatform 2090 * @form 2091 * @atomicservice 2092 * @since 18 2093 */ 2094 CHART = 19, 2095 /** 2096 * counter component type 2097 * @syscap SystemCapability.ArkUI.ArkUI.Full 2098 * @crossplatform 2099 * @form 2100 * @atomicservice 2101 * @since 18 2102 */ 2103 COUNTER = 20, 2104 /** 2105 * counter modal component type 2106 * @syscap SystemCapability.ArkUI.ArkUI.Full 2107 * @crossplatform 2108 * @form 2109 * @atomicservice 2110 * @since 18 2111 */ 2112 CONTAINER_MODAL = 21, 2113 /** 2114 * data panel component type 2115 * @syscap SystemCapability.ArkUI.ArkUI.Full 2116 * @crossplatform 2117 * @form 2118 * @atomicservice 2119 * @since 18 2120 */ 2121 DATA_PANEL = 22, 2122 /** 2123 * data picker component type 2124 * @syscap SystemCapability.ArkUI.ArkUI.Full 2125 * @crossplatform 2126 * @form 2127 * @atomicservice 2128 * @since 18 2129 */ 2130 DATE_PICKER = 23, 2131 /** 2132 * dialog component type 2133 * @syscap SystemCapability.ArkUI.ArkUI.Full 2134 * @crossplatform 2135 * @form 2136 * @atomicservice 2137 * @since 18 2138 */ 2139 DIALOG = 24, 2140 /** 2141 * divider component type 2142 * @syscap SystemCapability.ArkUI.ArkUI.Full 2143 * @crossplatform 2144 * @form 2145 * @atomicservice 2146 * @since 18 2147 */ 2148 DIVIDER = 25, 2149 /** 2150 * drag bar component type 2151 * @syscap SystemCapability.ArkUI.ArkUI.Full 2152 * @crossplatform 2153 * @form 2154 * @atomicservice 2155 * @since 18 2156 */ 2157 DRAG_BAR = 26, 2158 /** 2159 * effect component type 2160 * @syscap SystemCapability.ArkUI.ArkUI.Full 2161 * @crossplatform 2162 * @form 2163 * @atomicservice 2164 * @since 18 2165 */ 2166 EFFECT_COMPONENT = 27, 2167 /** 2168 * ellipse component type 2169 * @syscap SystemCapability.ArkUI.ArkUI.Full 2170 * @crossplatform 2171 * @form 2172 * @atomicservice 2173 * @since 18 2174 */ 2175 ELLIPSE = 28, 2176 /** 2177 * flex component type 2178 * @syscap SystemCapability.ArkUI.ArkUI.Full 2179 * @crossplatform 2180 * @form 2181 * @atomicservice 2182 * @since 18 2183 */ 2184 FLEX = 29, 2185 /** 2186 * flow item component type 2187 * @syscap SystemCapability.ArkUI.ArkUI.Full 2188 * @crossplatform 2189 * @form 2190 * @atomicservice 2191 * @since 18 2192 */ 2193 FLOW_ITEM = 30, 2194 /** 2195 * form component type 2196 * @syscap SystemCapability.ArkUI.ArkUI.Full 2197 * @crossplatform 2198 * @form 2199 * @atomicservice 2200 * @since 18 2201 */ 2202 FORM_COMPONENT = 31, 2203 /** 2204 * form link component type 2205 * @syscap SystemCapability.ArkUI.ArkUI.Full 2206 * @crossplatform 2207 * @form 2208 * @atomicservice 2209 * @since 18 2210 */ 2211 FORM_LINK = 32, 2212 /** 2213 * gauge component type 2214 * @syscap SystemCapability.ArkUI.ArkUI.Full 2215 * @crossplatform 2216 * @form 2217 * @atomicservice 2218 * @since 18 2219 */ 2220 GAUGE = 33, 2221 /** 2222 * grid component type 2223 * @syscap SystemCapability.ArkUI.ArkUI.Full 2224 * @crossplatform 2225 * @form 2226 * @atomicservice 2227 * @since 18 2228 */ 2229 GRID = 34, 2230 /** 2231 * grid col component type 2232 * @syscap SystemCapability.ArkUI.ArkUI.Full 2233 * @crossplatform 2234 * @form 2235 * @atomicservice 2236 * @since 18 2237 */ 2238 GRID_COL = 35, 2239 /** 2240 * grid container component type 2241 * @syscap SystemCapability.ArkUI.ArkUI.Full 2242 * @crossplatform 2243 * @form 2244 * @atomicservice 2245 * @since 18 2246 */ 2247 GRID_CONTAINER = 36, 2248 /** 2249 * grid item component type 2250 * @syscap SystemCapability.ArkUI.ArkUI.Full 2251 * @crossplatform 2252 * @form 2253 * @atomicservice 2254 * @since 18 2255 */ 2256 GRID_ITEM = 37, 2257 /** 2258 * grid row component type 2259 * @syscap SystemCapability.ArkUI.ArkUI.Full 2260 * @crossplatform 2261 * @form 2262 * @atomicservice 2263 * @since 18 2264 */ 2265 GRID_ROW = 38, 2266 /** 2267 * hyperlink component type 2268 * @syscap SystemCapability.ArkUI.ArkUI.Full 2269 * @crossplatform 2270 * @form 2271 * @atomicservice 2272 * @since 18 2273 */ 2274 HYPERLINK = 39, 2275 /** 2276 * image component type 2277 * @syscap SystemCapability.ArkUI.ArkUI.Full 2278 * @crossplatform 2279 * @form 2280 * @atomicservice 2281 * @since 18 2282 */ 2283 IMAGE = 40, 2284 /** 2285 * image animator component type 2286 * @syscap SystemCapability.ArkUI.ArkUI.Full 2287 * @crossplatform 2288 * @form 2289 * @atomicservice 2290 * @since 18 2291 */ 2292 IMAGE_ANIMATOR = 41, 2293 /** 2294 * image bitmap component type 2295 * @syscap SystemCapability.ArkUI.ArkUI.Full 2296 * @crossplatform 2297 * @form 2298 * @atomicservice 2299 * @since 18 2300 */ 2301 IMAGE_BITMAP = 42, 2302 /** 2303 * image data component type 2304 * @syscap SystemCapability.ArkUI.ArkUI.Full 2305 * @crossplatform 2306 * @form 2307 * @atomicservice 2308 * @since 18 2309 */ 2310 IMAGE_DATA = 43, 2311 /** 2312 * image span component type 2313 * @syscap SystemCapability.ArkUI.ArkUI.Full 2314 * @crossplatform 2315 * @form 2316 * @atomicservice 2317 * @since 18 2318 */ 2319 IMAGE_SPAN = 44, 2320 /** 2321 * label component type 2322 * @syscap SystemCapability.ArkUI.ArkUI.Full 2323 * @crossplatform 2324 * @form 2325 * @atomicservice 2326 * @since 18 2327 */ 2328 LABEL = 45, 2329 /** 2330 * line component type 2331 * @syscap SystemCapability.ArkUI.ArkUI.Full 2332 * @crossplatform 2333 * @form 2334 * @atomicservice 2335 * @since 18 2336 */ 2337 LINE = 46, 2338 /** 2339 * list component type 2340 * @syscap SystemCapability.ArkUI.ArkUI.Full 2341 * @crossplatform 2342 * @form 2343 * @atomicservice 2344 * @since 18 2345 */ 2346 LIST = 47, 2347 /** 2348 * list item component type 2349 * @syscap SystemCapability.ArkUI.ArkUI.Full 2350 * @crossplatform 2351 * @form 2352 * @atomicservice 2353 * @since 18 2354 */ 2355 LIST_ITEM = 48, 2356 /** 2357 * list item group component type 2358 * @syscap SystemCapability.ArkUI.ArkUI.Full 2359 * @crossplatform 2360 * @form 2361 * @atomicservice 2362 * @since 18 2363 */ 2364 LIST_ITEM_GROUP = 49, 2365 /** 2366 * loading progress component type 2367 * @syscap SystemCapability.ArkUI.ArkUI.Full 2368 * @crossplatform 2369 * @form 2370 * @atomicservice 2371 * @since 18 2372 */ 2373 LOADING_PROGRESS = 50, 2374 /** 2375 * marquee component type 2376 * @syscap SystemCapability.ArkUI.ArkUI.Full 2377 * @crossplatform 2378 * @form 2379 * @atomicservice 2380 * @since 18 2381 */ 2382 MARQUEE = 51, 2383 /** 2384 * matrix2d component type 2385 * @syscap SystemCapability.ArkUI.ArkUI.Full 2386 * @crossplatform 2387 * @form 2388 * @atomicservice 2389 * @since 18 2390 */ 2391 MATRIX2D = 52, 2392 /** 2393 * menu component type 2394 * @syscap SystemCapability.ArkUI.ArkUI.Full 2395 * @crossplatform 2396 * @form 2397 * @atomicservice 2398 * @since 18 2399 */ 2400 MENU = 53, 2401 /** 2402 * menu item component type 2403 * @syscap SystemCapability.ArkUI.ArkUI.Full 2404 * @crossplatform 2405 * @form 2406 * @atomicservice 2407 * @since 18 2408 */ 2409 MENU_ITEM = 54, 2410 /** 2411 * menu item group component type 2412 * @syscap SystemCapability.ArkUI.ArkUI.Full 2413 * @crossplatform 2414 * @form 2415 * @atomicservice 2416 * @since 18 2417 */ 2418 MENU_ITEM_GROUP = 55, 2419 /** 2420 * navdestination component type 2421 * @syscap SystemCapability.ArkUI.ArkUI.Full 2422 * @crossplatform 2423 * @form 2424 * @atomicservice 2425 * @since 18 2426 */ 2427 NAV_DESTINATION = 56, 2428 /** 2429 * navrouter component type 2430 * @syscap SystemCapability.ArkUI.ArkUI.Full 2431 * @crossplatform 2432 * @form 2433 * @atomicservice 2434 * @since 18 2435 */ 2436 NAV_ROUTER = 57, 2437 /** 2438 * navigation component type 2439 * @syscap SystemCapability.ArkUI.ArkUI.Full 2440 * @crossplatform 2441 * @form 2442 * @atomicservice 2443 * @since 18 2444 */ 2445 NAVIGATION = 58, 2446 /** 2447 * navigation bar component type 2448 * @syscap SystemCapability.ArkUI.ArkUI.Full 2449 * @crossplatform 2450 * @form 2451 * @atomicservice 2452 * @since 18 2453 */ 2454 NAVIGATION_BAR = 59, 2455 /** 2456 * navigation menu component type 2457 * @syscap SystemCapability.ArkUI.ArkUI.Full 2458 * @crossplatform 2459 * @form 2460 * @atomicservice 2461 * @since 18 2462 */ 2463 NAVIGATION_MENU = 60, 2464 /** 2465 * navigator component type 2466 * @syscap SystemCapability.ArkUI.ArkUI.Full 2467 * @crossplatform 2468 * @form 2469 * @atomicservice 2470 * @since 18 2471 */ 2472 NAVIGATOR = 61, 2473 /** 2474 * offscreen canvas component type 2475 * @syscap SystemCapability.ArkUI.ArkUI.Full 2476 * @crossplatform 2477 * @form 2478 * @atomicservice 2479 * @since 18 2480 */ 2481 OFFSCREEN_CANVAS = 62, 2482 /** 2483 * offscreen canvas rendering context2d component type 2484 * @syscap SystemCapability.ArkUI.ArkUI.Full 2485 * @crossplatform 2486 * @form 2487 * @atomicservice 2488 * @since 18 2489 */ 2490 OFFSCREEN_CANVAS_RENDERING_CONTEXT2D = 63, 2491 /** 2492 * option component type 2493 * @syscap SystemCapability.ArkUI.ArkUI.Full 2494 * @crossplatform 2495 * @form 2496 * @atomicservice 2497 * @since 18 2498 */ 2499 OPTION = 64, 2500 /** 2501 * panel component type 2502 * @syscap SystemCapability.ArkUI.ArkUI.Full 2503 * @crossplatform 2504 * @form 2505 * @atomicservice 2506 * @since 18 2507 */ 2508 PANEL = 65, 2509 /** 2510 * paper page component type 2511 * @syscap SystemCapability.ArkUI.ArkUI.Full 2512 * @crossplatform 2513 * @form 2514 * @atomicservice 2515 * @since 18 2516 */ 2517 PAPER_PAGE = 66, 2518 /** 2519 * path component type 2520 * @syscap SystemCapability.ArkUI.ArkUI.Full 2521 * @crossplatform 2522 * @form 2523 * @atomicservice 2524 * @since 18 2525 */ 2526 PATH = 67, 2527 /** 2528 * path 2d component type 2529 * @syscap SystemCapability.ArkUI.ArkUI.Full 2530 * @crossplatform 2531 * @form 2532 * @atomicservice 2533 * @since 18 2534 */ 2535 PATH2D = 68, 2536 /** 2537 * pattern lock component type 2538 * @syscap SystemCapability.ArkUI.ArkUI.Full 2539 * @crossplatform 2540 * @form 2541 * @atomicservice 2542 * @since 18 2543 */ 2544 PATTERN_LOCK = 69, 2545 /** 2546 * picker component type 2547 * @syscap SystemCapability.ArkUI.ArkUI.Full 2548 * @crossplatform 2549 * @form 2550 * @atomicservice 2551 * @since 18 2552 */ 2553 PICKER = 70, 2554 /** 2555 * picker view component type 2556 * @syscap SystemCapability.ArkUI.ArkUI.Full 2557 * @crossplatform 2558 * @form 2559 * @atomicservice 2560 * @since 18 2561 */ 2562 PICKER_VIEW = 71, 2563 /** 2564 * plugin component type 2565 * @syscap SystemCapability.ArkUI.ArkUI.Full 2566 * @crossplatform 2567 * @form 2568 * @atomicservice 2569 * @since 18 2570 */ 2571 PLUGIN_COMPONENT = 72, 2572 /** 2573 * polygon component type 2574 * @syscap SystemCapability.ArkUI.ArkUI.Full 2575 * @crossplatform 2576 * @form 2577 * @atomicservice 2578 * @since 18 2579 */ 2580 POLYGON = 73, 2581 /** 2582 * polyline component type 2583 * @syscap SystemCapability.ArkUI.ArkUI.Full 2584 * @crossplatform 2585 * @form 2586 * @atomicservice 2587 * @since 18 2588 */ 2589 POLYLINE = 74, 2590 /** 2591 * pop up component type 2592 * @syscap SystemCapability.ArkUI.ArkUI.Full 2593 * @crossplatform 2594 * @form 2595 * @atomicservice 2596 * @since 18 2597 */ 2598 POPUP = 75, 2599 /** 2600 * progress component type 2601 * @syscap SystemCapability.ArkUI.ArkUI.Full 2602 * @crossplatform 2603 * @form 2604 * @atomicservice 2605 * @since 18 2606 */ 2607 PROGRESS = 76, 2608 /** 2609 * qr code component type 2610 * @syscap SystemCapability.ArkUI.ArkUI.Full 2611 * @crossplatform 2612 * @form 2613 * @atomicservice 2614 * @since 18 2615 */ 2616 QRCODE = 77, 2617 /** 2618 * radio component type 2619 * @syscap SystemCapability.ArkUI.ArkUI.Full 2620 * @crossplatform 2621 * @form 2622 * @atomicservice 2623 * @since 18 2624 */ 2625 RADIO = 78, 2626 /** 2627 * rating component type 2628 * @syscap SystemCapability.ArkUI.ArkUI.Full 2629 * @crossplatform 2630 * @form 2631 * @atomicservice 2632 * @since 18 2633 */ 2634 RATING = 79, 2635 /** 2636 * rect component type 2637 * @syscap SystemCapability.ArkUI.ArkUI.Full 2638 * @crossplatform 2639 * @form 2640 * @atomicservice 2641 * @since 18 2642 */ 2643 RECT = 80, 2644 /** 2645 * refresh component type 2646 * @syscap SystemCapability.ArkUI.ArkUI.Full 2647 * @crossplatform 2648 * @form 2649 * @atomicservice 2650 * @since 18 2651 */ 2652 REFRESH = 81, 2653 /** 2654 * relative container component type 2655 * @syscap SystemCapability.ArkUI.ArkUI.Full 2656 * @crossplatform 2657 * @form 2658 * @atomicservice 2659 * @since 18 2660 */ 2661 RELATIVE_CONTAINER = 82, 2662 /** 2663 * remote window component type 2664 * @syscap SystemCapability.ArkUI.ArkUI.Full 2665 * @crossplatform 2666 * @form 2667 * @atomicservice 2668 * @since 18 2669 */ 2670 REMOTE_WINDOW = 83, 2671 /** 2672 * rich editor component type 2673 * @syscap SystemCapability.ArkUI.ArkUI.Full 2674 * @crossplatform 2675 * @form 2676 * @atomicservice 2677 * @since 18 2678 */ 2679 RICH_EDITOR = 84, 2680 /** 2681 * rich text component type 2682 * @syscap SystemCapability.ArkUI.ArkUI.Full 2683 * @crossplatform 2684 * @form 2685 * @atomicservice 2686 * @since 18 2687 */ 2688 RICH_TEXT = 85, 2689 /** 2690 * rolepager component type 2691 * @syscap SystemCapability.ArkUI.ArkUI.Full 2692 * @crossplatform 2693 * @form 2694 * @atomicservice 2695 * @since 18 2696 */ 2697 ROLE_PAGER = 86, 2698 /** 2699 * row component type 2700 * @syscap SystemCapability.ArkUI.ArkUI.Full 2701 * @crossplatform 2702 * @form 2703 * @atomicservice 2704 * @since 18 2705 */ 2706 ROW = 87, 2707 /** 2708 * row split component type 2709 * @syscap SystemCapability.ArkUI.ArkUI.Full 2710 * @crossplatform 2711 * @form 2712 * @atomicservice 2713 * @since 18 2714 */ 2715 ROW_SPLIT = 88, 2716 /** 2717 * scroll component type 2718 * @syscap SystemCapability.ArkUI.ArkUI.Full 2719 * @crossplatform 2720 * @form 2721 * @atomicservice 2722 * @since 18 2723 */ 2724 SCROLL = 89, 2725 /** 2726 * scroll bar component type 2727 * @syscap SystemCapability.ArkUI.ArkUI.Full 2728 * @crossplatform 2729 * @form 2730 * @atomicservice 2731 * @since 18 2732 */ 2733 SCROLL_BAR = 90, 2734 /** 2735 * search component type 2736 * @syscap SystemCapability.ArkUI.ArkUI.Full 2737 * @crossplatform 2738 * @form 2739 * @atomicservice 2740 * @since 18 2741 */ 2742 SEARCH = 91, 2743 /** 2744 * search field component type 2745 * @syscap SystemCapability.ArkUI.ArkUI.Full 2746 * @crossplatform 2747 * @form 2748 * @atomicservice 2749 * @since 18 2750 */ 2751 SEARCH_FIELD = 92, 2752 /** 2753 * select component type 2754 * @syscap SystemCapability.ArkUI.ArkUI.Full 2755 * @crossplatform 2756 * @form 2757 * @atomicservice 2758 * @since 18 2759 */ 2760 SELECT = 93, 2761 /** 2762 * shape component type 2763 * @syscap SystemCapability.ArkUI.ArkUI.Full 2764 * @crossplatform 2765 * @form 2766 * @atomicservice 2767 * @since 18 2768 */ 2769 SHAPE = 94, 2770 /** 2771 * sidebar container component type 2772 * @syscap SystemCapability.ArkUI.ArkUI.Full 2773 * @crossplatform 2774 * @form 2775 * @atomicservice 2776 * @since 18 2777 */ 2778 SIDEBAR_CONTAINER = 95, 2779 /** 2780 * slider component type 2781 * @syscap SystemCapability.ArkUI.ArkUI.Full 2782 * @crossplatform 2783 * @form 2784 * @atomicservice 2785 * @since 18 2786 */ 2787 SLIDER = 96, 2788 /** 2789 * span component type 2790 * @syscap SystemCapability.ArkUI.ArkUI.Full 2791 * @crossplatform 2792 * @form 2793 * @atomicservice 2794 * @since 18 2795 */ 2796 SPAN = 97, 2797 /** 2798 * stack component type 2799 * @syscap SystemCapability.ArkUI.ArkUI.Full 2800 * @crossplatform 2801 * @form 2802 * @atomicservice 2803 * @since 18 2804 */ 2805 STACK = 98, 2806 /** 2807 * stepper component type 2808 * @syscap SystemCapability.ArkUI.ArkUI.Full 2809 * @crossplatform 2810 * @form 2811 * @atomicservice 2812 * @since 18 2813 */ 2814 STEPPER = 99, 2815 /** 2816 * stepper item component type 2817 * @syscap SystemCapability.ArkUI.ArkUI.Full 2818 * @crossplatform 2819 * @form 2820 * @atomicservice 2821 * @since 18 2822 */ 2823 STEPPER_ITEM = 100, 2824 /** 2825 * swiper component type 2826 * @syscap SystemCapability.ArkUI.ArkUI.Full 2827 * @crossplatform 2828 * @form 2829 * @atomicservice 2830 * @since 18 2831 */ 2832 SWIPER = 101, 2833 /** 2834 * swiper indicator component type 2835 * @syscap SystemCapability.ArkUI.ArkUI.Full 2836 * @crossplatform 2837 * @form 2838 * @atomicservice 2839 * @since 18 2840 */ 2841 SWIPER_INDICATOR = 102, 2842 /** 2843 * switch component type 2844 * @syscap SystemCapability.ArkUI.ArkUI.Full 2845 * @crossplatform 2846 * @form 2847 * @atomicservice 2848 * @since 18 2849 */ 2850 SWITCH = 103, 2851 /** 2852 * symbol glyph component type 2853 * @syscap SystemCapability.ArkUI.ArkUI.Full 2854 * @crossplatform 2855 * @form 2856 * @atomicservice 2857 * @since 18 2858 */ 2859 SYMBOL_GLYPH = 104, 2860 /** 2861 * tab content component type 2862 * @syscap SystemCapability.ArkUI.ArkUI.Full 2863 * @crossplatform 2864 * @form 2865 * @atomicservice 2866 * @since 18 2867 */ 2868 TAB_CONTENT = 105, 2869 /** 2870 * tab bar component type 2871 * @syscap SystemCapability.ArkUI.ArkUI.Full 2872 * @crossplatform 2873 * @form 2874 * @atomicservice 2875 * @since 18 2876 */ 2877 TAB_BAR = 106, 2878 /** 2879 * tabs component type 2880 * @syscap SystemCapability.ArkUI.ArkUI.Full 2881 * @crossplatform 2882 * @form 2883 * @atomicservice 2884 * @since 18 2885 */ 2886 TABS = 107, 2887 /** 2888 * text component type 2889 * @syscap SystemCapability.ArkUI.ArkUI.Full 2890 * @crossplatform 2891 * @form 2892 * @atomicservice 2893 * @since 18 2894 */ 2895 TEXT = 108, 2896 /** 2897 * text clock component type 2898 * @syscap SystemCapability.ArkUI.ArkUI.Full 2899 * @crossplatform 2900 * @form 2901 * @atomicservice 2902 * @since 18 2903 */ 2904 TEXT_CLOCK = 109, 2905 /** 2906 * text entry component type 2907 * @syscap SystemCapability.ArkUI.ArkUI.Full 2908 * @crossplatform 2909 * @form 2910 * @atomicservice 2911 * @since 18 2912 */ 2913 TEXT_ENTRY = 110, 2914 /** 2915 * text input component type 2916 * @syscap SystemCapability.ArkUI.ArkUI.Full 2917 * @crossplatform 2918 * @form 2919 * @atomicservice 2920 * @since 18 2921 */ 2922 TEXT_INPUT = 111, 2923 /** 2924 * text picker component type 2925 * @syscap SystemCapability.ArkUI.ArkUI.Full 2926 * @crossplatform 2927 * @form 2928 * @atomicservice 2929 * @since 18 2930 */ 2931 TEXT_PICKER = 112, 2932 /** 2933 * text timer component type 2934 * @syscap SystemCapability.ArkUI.ArkUI.Full 2935 * @crossplatform 2936 * @form 2937 * @atomicservice 2938 * @since 18 2939 */ 2940 TEXT_TIMER = 113, 2941 /** 2942 * text area component type 2943 * @syscap SystemCapability.ArkUI.ArkUI.Full 2944 * @crossplatform 2945 * @form 2946 * @atomicservice 2947 * @since 18 2948 */ 2949 TEXT_AREA = 114, 2950 /** 2951 * text field component type 2952 * @syscap SystemCapability.ArkUI.ArkUI.Full 2953 * @crossplatform 2954 * @form 2955 * @atomicservice 2956 * @since 18 2957 */ 2958 TEXT_FIELD = 115, 2959 /** 2960 * time picker component type 2961 * @syscap SystemCapability.ArkUI.ArkUI.Full 2962 * @crossplatform 2963 * @form 2964 * @atomicservice 2965 * @since 18 2966 */ 2967 TIME_PICKER = 116, 2968 /** 2969 * title bar component type 2970 * @syscap SystemCapability.ArkUI.ArkUI.Full 2971 * @crossplatform 2972 * @form 2973 * @atomicservice 2974 * @since 18 2975 */ 2976 TITLE_BAR = 117, 2977 /** 2978 * toggler component type 2979 * @syscap SystemCapability.ArkUI.ArkUI.Full 2980 * @crossplatform 2981 * @form 2982 * @atomicservice 2983 * @since 18 2984 */ 2985 TOGGLER = 118, 2986 /** 2987 * uiextensioncomponent component type 2988 * @syscap SystemCapability.ArkUI.ArkUI.Full 2989 * @crossplatform 2990 * @form 2991 * @atomicservice 2992 * @since 18 2993 */ 2994 UI_EXTENSION_COMPONENT = 119, 2995 /** 2996 * video component type 2997 * @syscap SystemCapability.ArkUI.ArkUI.Full 2998 * @crossplatform 2999 * @form 3000 * @atomicservice 3001 * @since 18 3002 */ 3003 VIDEO = 120, 3004 /** 3005 * water flow component type 3006 * @syscap SystemCapability.ArkUI.ArkUI.Full 3007 * @crossplatform 3008 * @form 3009 * @atomicservice 3010 * @since 18 3011 */ 3012 WATER_FLOW = 121, 3013 /** 3014 * web component type 3015 * @syscap SystemCapability.ArkUI.ArkUI.Full 3016 * @crossplatform 3017 * @form 3018 * @atomicservice 3019 * @since 18 3020 */ 3021 WEB = 122, 3022 /** 3023 * xcomponent component type 3024 * @syscap SystemCapability.ArkUI.ArkUI.Full 3025 * @crossplatform 3026 * @form 3027 * @atomicservice 3028 * @since 18 3029 */ 3030 XCOMPONENT = 123, 3031 /** 3032 * none component type: screen reader will not broadcast the component type. 3033 * @syscap SystemCapability.ArkUI.ArkUI.Full 3034 * @crossplatform 3035 * @form 3036 * @atomicservice 3037 * @since 18 3038 */ 3039 ROLE_NONE = 124, 3040} 3041 3042/** 3043 * Defines the callback type used in accessibility focus. The value of isFocus indicates whether the current component is focused 3044 * @typedef {function} AccessibilityFocusCallback 3045 * @param {boolean} isFocus - if component is focused,isFocus will be true. else isFocus is false. 3046 * @syscap SystemCapability.ArkUI.ArkUI.Full 3047 * @crossplatform 3048 * @form 3049 * @atomicservice 3050 * @since 18 3051 */ 3052declare type AccessibilityFocusCallback = (isFocus: boolean) => void; 3053 3054/** 3055 * Enum for FinishCallbackType. 3056 * 3057 * @enum { number } 3058 * @syscap SystemCapability.ArkUI.ArkUI.Full 3059 * @crossplatform 3060 * @form 3061 * @since 11 3062 */ 3063/** 3064 * Enum for FinishCallbackType. 3065 * 3066 * @enum { number } 3067 * @syscap SystemCapability.ArkUI.ArkUI.Full 3068 * @crossplatform 3069 * @form 3070 * @atomicservice 3071 * @since 12 3072 */ 3073declare enum FinishCallbackType { 3074 /** 3075 * When the entire animation ends and will be removed immediately, the callback is triggered. 3076 * 3077 * @syscap SystemCapability.ArkUI.ArkUI.Full 3078 * @crossplatform 3079 * @form 3080 * @since 11 3081 */ 3082 /** 3083 * When the entire animation ends and will be removed immediately, the callback is triggered. 3084 * 3085 * @syscap SystemCapability.ArkUI.ArkUI.Full 3086 * @crossplatform 3087 * @form 3088 * @atomicservice 3089 * @since 12 3090 */ 3091 REMOVED = 0, 3092 /** 3093 * When the animation is logically down but may still be in its long tail, the callback is triggered. 3094 * 3095 * @syscap SystemCapability.ArkUI.ArkUI.Full 3096 * @crossplatform 3097 * @form 3098 * @since 11 3099 */ 3100 /** 3101 * When the animation is logically down but may still be in its long tail, the callback is triggered. 3102 * 3103 * @syscap SystemCapability.ArkUI.ArkUI.Full 3104 * @crossplatform 3105 * @form 3106 * @atomicservice 3107 * @since 12 3108 */ 3109 LOGICALLY = 1, 3110} 3111 3112/** 3113 * Defines the touch test strategy object. 3114 * 3115 * @enum { number } 3116 * @syscap SystemCapability.ArkUI.ArkUI.Full 3117 * @crossplatform 3118 * @form 3119 * @since 11 3120 */ 3121/** 3122 * Defines the touch test strategy object. 3123 * 3124 * @enum { number } 3125 * @syscap SystemCapability.ArkUI.ArkUI.Full 3126 * @crossplatform 3127 * @form 3128 * @atomicservice 3129 * @since 12 3130 */ 3131declare enum TouchTestStrategy { 3132 /** 3133 * Do framework touch test. 3134 * 3135 * @syscap SystemCapability.ArkUI.ArkUI.Full 3136 * @crossplatform 3137 * @form 3138 * @since 11 3139 */ 3140 /** 3141 * Do framework touch test. 3142 * 3143 * @syscap SystemCapability.ArkUI.ArkUI.Full 3144 * @crossplatform 3145 * @form 3146 * @atomicservice 3147 * @since 12 3148 */ 3149 DEFAULT = 0, 3150 3151 /** 3152 * Specify the component to do touch test and follow the framework touch test 3153 * 3154 * @syscap SystemCapability.ArkUI.ArkUI.Full 3155 * @crossplatform 3156 * @form 3157 * @since 11 3158 */ 3159 /** 3160 * Specify the component to do touch test and follow the framework touch test 3161 * 3162 * @syscap SystemCapability.ArkUI.ArkUI.Full 3163 * @crossplatform 3164 * @form 3165 * @atomicservice 3166 * @since 12 3167 */ 3168 FORWARD_COMPETITION = 1, 3169 3170 /** 3171 * Specify the component to do touch test and not follow the framework touch test 3172 * 3173 * @syscap SystemCapability.ArkUI.ArkUI.Full 3174 * @crossplatform 3175 * @form 3176 * @since 11 3177 */ 3178 /** 3179 * Specify the component to do touch test and not follow the framework touch test 3180 * 3181 * @syscap SystemCapability.ArkUI.ArkUI.Full 3182 * @crossplatform 3183 * @form 3184 * @atomicservice 3185 * @since 12 3186 */ 3187 FORWARD = 2 3188} 3189 3190/** 3191 * Defines the animate function params. 3192 * 3193 * @interface AnimateParam 3194 * @syscap SystemCapability.ArkUI.ArkUI.Full 3195 * @since 7 3196 */ 3197/** 3198 * Defines the animate function params. 3199 * 3200 * @interface AnimateParam 3201 * @syscap SystemCapability.ArkUI.ArkUI.Full 3202 * @form 3203 * @since 9 3204 */ 3205/** 3206 * Defines the animate function params. 3207 * 3208 * @interface AnimateParam 3209 * @syscap SystemCapability.ArkUI.ArkUI.Full 3210 * @crossplatform 3211 * @form 3212 * @since 10 3213 */ 3214/** 3215 * Defines the animate function params. 3216 * 3217 * @interface AnimateParam 3218 * @syscap SystemCapability.ArkUI.ArkUI.Full 3219 * @crossplatform 3220 * @form 3221 * @atomicservice 3222 * @since 11 3223 */ 3224declare interface AnimateParam { 3225 /** 3226 * Animation duration, in ms. 3227 * 3228 * @type { ?number } 3229 * @default 1000 3230 * @syscap SystemCapability.ArkUI.ArkUI.Full 3231 * @since 7 3232 */ 3233 /** 3234 * Animation duration, in ms. 3235 * 3236 * @type { ?number } 3237 * @default 1000 3238 * @syscap SystemCapability.ArkUI.ArkUI.Full 3239 * @form 3240 * @since 9 3241 */ 3242 /** 3243 * Animation duration, in ms. 3244 * 3245 * @type { ?number } 3246 * @default 1000 3247 * @syscap SystemCapability.ArkUI.ArkUI.Full 3248 * @crossplatform 3249 * @form 3250 * @since 10 3251 */ 3252 /** 3253 * Animation duration, in ms. 3254 * 3255 * @type { ?number } 3256 * @default 1000 3257 * @syscap SystemCapability.ArkUI.ArkUI.Full 3258 * @crossplatform 3259 * @form 3260 * @atomicservice 3261 * @since 11 3262 */ 3263 duration?: number; 3264 /** 3265 * Animation playback speed. A larger value indicates faster animation playback, and a smaller value indicates slower 3266 * animation playback. The value 0 means that there is no animation. 3267 * 3268 * @type { ?number } 3269 * @default 1.0 3270 * @syscap SystemCapability.ArkUI.ArkUI.Full 3271 * @since 7 3272 */ 3273 /** 3274 * Animation playback speed. A larger value indicates faster animation playback, and a smaller value indicates slower 3275 * animation playback. The value 0 means that there is no animation. 3276 * 3277 * @type { ?number } 3278 * @default 1.0 3279 * @syscap SystemCapability.ArkUI.ArkUI.Full 3280 * @crossplatform 3281 * @since 10 3282 */ 3283 /** 3284 * Animation playback speed. A larger value indicates faster animation playback, and a smaller value indicates slower 3285 * animation playback. The value 0 means that there is no animation. 3286 * 3287 * @type { ?number } 3288 * @default 1.0 3289 * @syscap SystemCapability.ArkUI.ArkUI.Full 3290 * @crossplatform 3291 * @atomicservice 3292 * @since 11 3293 */ 3294 tempo?: number; 3295 /** 3296 * Animation curve. 3297 * 3298 * @type { ?(Curve | string) } 3299 * @default Curve.EaseInOut 3300 * @syscap SystemCapability.ArkUI.ArkUI.Full 3301 * @since 7 3302 */ 3303 /** 3304 * Animation curve. 3305 * 3306 * @type { ?(Curve | string | ICurve) } 3307 * @default Curve.EaseInOut 3308 * @syscap SystemCapability.ArkUI.ArkUI.Full 3309 * @form 3310 * @since 9 3311 */ 3312 /** 3313 * Animation curve. 3314 * 3315 * @type { ?(Curve | string | ICurve) } 3316 * @default Curve.EaseInOut 3317 * @syscap SystemCapability.ArkUI.ArkUI.Full 3318 * @crossplatform 3319 * @form 3320 * @since 10 3321 */ 3322 /** 3323 * Animation curve. 3324 * 3325 * @type { ?(Curve | string | ICurve) } 3326 * @default Curve.EaseInOut 3327 * @syscap SystemCapability.ArkUI.ArkUI.Full 3328 * @crossplatform 3329 * @form 3330 * @atomicservice 3331 * @since 11 3332 */ 3333 curve?: Curve | string | ICurve; 3334 3335 /** 3336 * Animation plays with delay,when set to a negative number, the animation plays in advance. 3337 * 3338 * @type { ?number } 3339 * @default 0 3340 * @syscap SystemCapability.ArkUI.ArkUI.Full 3341 * @since 7 3342 */ 3343 /** 3344 * Animation delay time, in ms. 3345 * 3346 * @type { ?number } 3347 * @default 0 3348 * @syscap SystemCapability.ArkUI.ArkUI.Full 3349 * @crossplatform 3350 * @since 10 3351 */ 3352 /** 3353 * Animation delay time, in ms. 3354 * 3355 * @type { ?number } 3356 * @default 0 3357 * @syscap SystemCapability.ArkUI.ArkUI.Full 3358 * @crossplatform 3359 * @atomicservice 3360 * @since 11 3361 */ 3362 delay?: number; 3363 3364 /** 3365 * Animation iterations. When set to -1, the animation playing it repeatedly. The value range is greater than or equal to -1. 3366 * 3367 * @type { ?number } 3368 * @default 1 3369 * @syscap SystemCapability.ArkUI.ArkUI.Full 3370 * @since 7 3371 */ 3372 /** 3373 * Animation iterations. When set to -1, the animation playing it repeatedly. The value range is greater than or equal to -1. 3374 * 3375 * @type { ?number } 3376 * @default 1 3377 * @syscap SystemCapability.ArkUI.ArkUI.Full 3378 * @crossplatform 3379 * @since 10 3380 */ 3381 /** 3382 * Animation iterations. When set to -1, the animation playing it repeatedly. The value range is greater than or equal to -1. 3383 * 3384 * @type { ?number } 3385 * @default 1 3386 * @syscap SystemCapability.ArkUI.ArkUI.Full 3387 * @crossplatform 3388 * @atomicservice 3389 * @since 11 3390 */ 3391 iterations?: number; 3392 3393 /** 3394 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 3395 * 3396 * @type { ?PlayMode } 3397 * @default PlayMode.Normal 3398 * @syscap SystemCapability.ArkUI.ArkUI.Full 3399 * @since 7 3400 */ 3401 /** 3402 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 3403 * 3404 * @type { ?PlayMode } 3405 * @default PlayMode.Normal 3406 * @syscap SystemCapability.ArkUI.ArkUI.Full 3407 * @form 3408 * @since 9 3409 */ 3410 /** 3411 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 3412 * 3413 * @type { ?PlayMode } 3414 * @default PlayMode.Normal 3415 * @syscap SystemCapability.ArkUI.ArkUI.Full 3416 * @crossplatform 3417 * @form 3418 * @since 10 3419 */ 3420 /** 3421 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 3422 * 3423 * @type { ?PlayMode } 3424 * @default PlayMode.Normal 3425 * @syscap SystemCapability.ArkUI.ArkUI.Full 3426 * @crossplatform 3427 * @form 3428 * @atomicservice 3429 * @since 11 3430 */ 3431 playMode?: PlayMode; 3432 3433 /** 3434 * Callback invoked when the animation playback is complete or the ability is about to enter the background. 3435 * 3436 * @type { ?function } 3437 * @syscap SystemCapability.ArkUI.ArkUI.Full 3438 * @since 7 3439 */ 3440 /** 3441 * Callback invoked when the animation playback is complete or the ability is about to enter the background. 3442 * 3443 * @type { ?function } 3444 * @syscap SystemCapability.ArkUI.ArkUI.Full 3445 * @form 3446 * @since 9 3447 */ 3448 /** 3449 * Callback invoked when the animation playback is complete or the ability is about to enter the background. 3450 * 3451 * @type { ?function } 3452 * @syscap SystemCapability.ArkUI.ArkUI.Full 3453 * @crossplatform 3454 * @form 3455 * @since 10 3456 */ 3457 /** 3458 * Callback invoked when the animation playback is complete or the ability is about to enter the background. 3459 * 3460 * @type { ?function } 3461 * @syscap SystemCapability.ArkUI.ArkUI.Full 3462 * @crossplatform 3463 * @form 3464 * @atomicservice 3465 * @since 11 3466 */ 3467 onFinish?: () => void; 3468 3469 /** 3470 * Define the type of onFinish callback in animation. 3471 * 3472 * @type { ?FinishCallbackType } 3473 * @syscap SystemCapability.ArkUI.ArkUI.Full 3474 * @crossplatform 3475 * @form 3476 * @since 11 3477 */ 3478 /** 3479 * Define the type of onFinish callback in animation. 3480 * 3481 * @type { ?FinishCallbackType } 3482 * @syscap SystemCapability.ArkUI.ArkUI.Full 3483 * @crossplatform 3484 * @form 3485 * @atomicservice 3486 * @since 12 3487 */ 3488 finishCallbackType?: FinishCallbackType; 3489 3490 /** 3491 * Indicates expectedFrameRateRange including minimum、maximum and expected frame rate. 3492 * 3493 * @type { ?ExpectedFrameRateRange } 3494 * @syscap SystemCapability.ArkUI.ArkUI.Full 3495 * @since 11 3496 */ 3497 /** 3498 * Indicates expectedFrameRateRange including minimum、maximum and expected frame rate. 3499 * 3500 * @type { ?ExpectedFrameRateRange } 3501 * @syscap SystemCapability.ArkUI.ArkUI.Full 3502 * @atomicservice 3503 * @since 12 3504 */ 3505 expectedFrameRateRange?: ExpectedFrameRateRange; 3506} 3507 3508/** 3509 * Interface for curve object. 3510 * 3511 * @interface ICurve 3512 * @syscap SystemCapability.ArkUI.ArkUI.Full 3513 * @form 3514 * @since 9 3515 */ 3516/** 3517 * Interface for curve object. 3518 * 3519 * @interface ICurve 3520 * @syscap SystemCapability.ArkUI.ArkUI.Full 3521 * @crossplatform 3522 * @form 3523 * @since 10 3524 */ 3525/** 3526 * Interface for curve object. 3527 * 3528 * @interface ICurve 3529 * @syscap SystemCapability.ArkUI.ArkUI.Full 3530 * @crossplatform 3531 * @form 3532 * @atomicservice 3533 * @since 11 3534 */ 3535interface ICurve { 3536 /** 3537 * Get curve value by fraction. 3538 * 3539 * @param { number } fraction - Indicates the current normalized time parameter. Value range: [0, 1]. 3540 * Note: If the value is less than 0, it will be processed as 0. If the value is greater than 1, 1 is used. 3541 * @returns { number } 3542 * @syscap SystemCapability.ArkUI.ArkUI.Full 3543 * @form 3544 * @since 9 3545 */ 3546 /** 3547 * Get curve value by fraction. 3548 * 3549 * @param { number } fraction - Indicates the current normalized time parameter. Value range: [0, 1]. 3550 * Note: If the value is less than 0, it will be processed as 0. If the value is greater than 1, 1 is used. 3551 * @returns { number } 3552 * @syscap SystemCapability.ArkUI.ArkUI.Full 3553 * @crossplatform 3554 * @form 3555 * @since 10 3556 */ 3557 /** 3558 * Get curve value by fraction. 3559 * 3560 * @param { number } fraction - Indicates the current normalized time parameter. Value range: [0, 1]. 3561 * Note: If the value is less than 0, it will be processed as 0. If the value is greater than 1, 1 is used. 3562 * @returns { number } 3563 * @syscap SystemCapability.ArkUI.ArkUI.Full 3564 * @crossplatform 3565 * @form 3566 * @atomicservice 3567 * @since 11 3568 */ 3569 interpolate(fraction: number): number; 3570} 3571 3572/** 3573 * Defines the motion path options. 3574 * 3575 * @interface MotionPathOptions 3576 * @syscap SystemCapability.ArkUI.ArkUI.Full 3577 * @since 7 3578 */ 3579/** 3580 * Defines the motion path options. 3581 * 3582 * @interface MotionPathOptions 3583 * @syscap SystemCapability.ArkUI.ArkUI.Full 3584 * @crossplatform 3585 * @since 10 3586 */ 3587/** 3588 * Defines the motion path options. 3589 * 3590 * @interface MotionPathOptions 3591 * @syscap SystemCapability.ArkUI.ArkUI.Full 3592 * @crossplatform 3593 * @atomicservice 3594 * @since 11 3595 */ 3596declare interface MotionPathOptions { 3597 /** 3598 * The path info. 3599 * 3600 * @type { string } 3601 * @syscap SystemCapability.ArkUI.ArkUI.Full 3602 * @since 7 3603 */ 3604 /** 3605 * The path info. 3606 * 3607 * @type { string } 3608 * @syscap SystemCapability.ArkUI.ArkUI.Full 3609 * @crossplatform 3610 * @since 10 3611 */ 3612 /** 3613 * The path info. 3614 * 3615 * @type { string } 3616 * @syscap SystemCapability.ArkUI.ArkUI.Full 3617 * @crossplatform 3618 * @atomicservice 3619 * @since 11 3620 */ 3621 path: string; 3622 3623 /** 3624 * The origin point info in range [0,1). 3625 * 3626 * @type { ?number } 3627 * @default 0.0 3628 * @syscap SystemCapability.ArkUI.ArkUI.Full 3629 * @since 7 3630 */ 3631 /** 3632 * The origin point info in range [0,1). 3633 * 3634 * @type { ?number } 3635 * @default 0.0 3636 * @syscap SystemCapability.ArkUI.ArkUI.Full 3637 * @crossplatform 3638 * @since 10 3639 */ 3640 /** 3641 * The origin point info in range [0,1). 3642 * 3643 * @type { ?number } 3644 * @default 0.0 3645 * @syscap SystemCapability.ArkUI.ArkUI.Full 3646 * @crossplatform 3647 * @atomicservice 3648 * @since 11 3649 */ 3650 from?: number; 3651 3652 /** 3653 * he distance point info in range (0,1]. 3654 * 3655 * @type { ?number } 3656 * @default 1.0 3657 * @syscap SystemCapability.ArkUI.ArkUI.Full 3658 * @since 7 3659 */ 3660 /** 3661 * he distance point info in range (0,1]. 3662 * 3663 * @type { ?number } 3664 * @default 1.0 3665 * @syscap SystemCapability.ArkUI.ArkUI.Full 3666 * @crossplatform 3667 * @since 10 3668 */ 3669 /** 3670 * The distance point info in range (0,1]. 3671 * 3672 * @type { ?number } 3673 * @default 1.0 3674 * @syscap SystemCapability.ArkUI.ArkUI.Full 3675 * @crossplatform 3676 * @atomicservice 3677 * @since 11 3678 */ 3679 to?: number; 3680 3681 /** 3682 * The rotate info. 3683 * 3684 * @type { ?boolean } 3685 * @default false 3686 * @syscap SystemCapability.ArkUI.ArkUI.Full 3687 * @since 7 3688 */ 3689 /** 3690 * The rotate info. 3691 * 3692 * @type { ?boolean } 3693 * @default false 3694 * @syscap SystemCapability.ArkUI.ArkUI.Full 3695 * @crossplatform 3696 * @since 10 3697 */ 3698 /** 3699 * The rotate info. 3700 * 3701 * @type { ?boolean } 3702 * @default false 3703 * @syscap SystemCapability.ArkUI.ArkUI.Full 3704 * @crossplatform 3705 * @atomicservice 3706 * @since 11 3707 */ 3708 rotatable?: boolean; 3709} 3710 3711/** 3712 * Defines the shard transition function params. 3713 * 3714 * @interface sharedTransitionOptions 3715 * @syscap SystemCapability.ArkUI.ArkUI.Full 3716 * @since 7 3717 */ 3718/** 3719 * Defines the shard transition function params. 3720 * 3721 * @interface sharedTransitionOptions 3722 * @syscap SystemCapability.ArkUI.ArkUI.Full 3723 * @crossplatform 3724 * @since 10 3725 */ 3726/** 3727 * Defines the shard transition function params. 3728 * 3729 * @interface sharedTransitionOptions 3730 * @syscap SystemCapability.ArkUI.ArkUI.Full 3731 * @crossplatform 3732 * @atomicservice 3733 * @since 11 3734 */ 3735declare interface sharedTransitionOptions { 3736 /** 3737 * Animation duration, in ms. 3738 * 3739 * @type { ?number } 3740 * @default 1000 3741 * @syscap SystemCapability.ArkUI.ArkUI.Full 3742 * @since 7 3743 */ 3744 /** 3745 * Animation duration, in ms. 3746 * 3747 * @type { ?number } 3748 * @default 1000 3749 * @syscap SystemCapability.ArkUI.ArkUI.Full 3750 * @crossplatform 3751 * @since 10 3752 */ 3753 /** 3754 * Animation duration, in ms. 3755 * 3756 * @type { ?number } 3757 * @default 1000 3758 * @syscap SystemCapability.ArkUI.ArkUI.Full 3759 * @crossplatform 3760 * @atomicservice 3761 * @since 11 3762 */ 3763 duration?: number; 3764 3765 /** 3766 * Animation duration, in ms. 3767 * 3768 * @type { ?(Curve | string | ICurve) } 3769 * @default 1000 3770 * @syscap SystemCapability.ArkUI.ArkUI.Full 3771 * @since 7 3772 */ 3773 /** 3774 * Animation curve. 3775 * 3776 * @type { ?(Curve | string | ICurve) } 3777 * @default 1000 3778 * @syscap SystemCapability.ArkUI.ArkUI.Full 3779 * @crossplatform 3780 * @since 10 3781 */ 3782 /** 3783 * Animation curve. 3784 * 3785 * @type { ?(Curve | string | ICurve) } 3786 * @default 1000 3787 * @syscap SystemCapability.ArkUI.ArkUI.Full 3788 * @crossplatform 3789 * @atomicservice 3790 * @since 11 3791 */ 3792 curve?: Curve | string | ICurve; 3793 3794 /** 3795 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 3796 * 3797 * @type { ?number } 3798 * @default 0 3799 * @syscap SystemCapability.ArkUI.ArkUI.Full 3800 * @since 7 3801 */ 3802 /** 3803 * Animation delay time, in ms. 3804 * 3805 * @type { ?number } 3806 * @default 0 3807 * @syscap SystemCapability.ArkUI.ArkUI.Full 3808 * @crossplatform 3809 * @since 10 3810 */ 3811 /** 3812 * Animation delay time, in ms. 3813 * 3814 * @type { ?number } 3815 * @default 0 3816 * @syscap SystemCapability.ArkUI.ArkUI.Full 3817 * @crossplatform 3818 * @atomicservice 3819 * @since 11 3820 */ 3821 delay?: number; 3822 3823 /** 3824 * The motion path info. 3825 * 3826 * @type { ?MotionPathOptions } 3827 * @syscap SystemCapability.ArkUI.ArkUI.Full 3828 * @since 7 3829 */ 3830 /** 3831 * The motion path info. 3832 * 3833 * @type { ?MotionPathOptions } 3834 * @syscap SystemCapability.ArkUI.ArkUI.Full 3835 * @crossplatform 3836 * @since 10 3837 */ 3838 /** 3839 * The motion path info. 3840 * 3841 * @type { ?MotionPathOptions } 3842 * @syscap SystemCapability.ArkUI.ArkUI.Full 3843 * @crossplatform 3844 * @atomicservice 3845 * @since 11 3846 */ 3847 motionPath?: MotionPathOptions; 3848 3849 /** 3850 * Z index info. 3851 * 3852 * @type { ?number } 3853 * @syscap SystemCapability.ArkUI.ArkUI.Full 3854 * @since 7 3855 */ 3856 /** 3857 * Z index info. 3858 * 3859 * @type { ?number } 3860 * @syscap SystemCapability.ArkUI.ArkUI.Full 3861 * @crossplatform 3862 * @since 10 3863 */ 3864 /** 3865 * Z index info. 3866 * 3867 * @type { ?number } 3868 * @syscap SystemCapability.ArkUI.ArkUI.Full 3869 * @crossplatform 3870 * @atomicservice 3871 * @since 11 3872 */ 3873 zIndex?: number; 3874 3875 /** 3876 * the animate type. 3877 * 3878 * @type { ?SharedTransitionEffectType } 3879 * @default SharedTransitionEffectType.Exchange 3880 * @syscap SystemCapability.ArkUI.ArkUI.Full 3881 * @since 7 3882 */ 3883 /** 3884 * the animate type. 3885 * 3886 * @type { ?SharedTransitionEffectType } 3887 * @default SharedTransitionEffectType.Exchange 3888 * @syscap SystemCapability.ArkUI.ArkUI.Full 3889 * @crossplatform 3890 * @since 10 3891 */ 3892 /** 3893 * the animate type. 3894 * 3895 * @type { ?SharedTransitionEffectType } 3896 * @default SharedTransitionEffectType.Exchange 3897 * @syscap SystemCapability.ArkUI.ArkUI.Full 3898 * @crossplatform 3899 * @atomicservice 3900 * @since 11 3901 */ 3902 type?: SharedTransitionEffectType; 3903} 3904 3905/** 3906 * Defines the options of geometry transition. 3907 * 3908 * @interface GeometryTransitionOptions 3909 * @syscap SystemCapability.ArkUI.ArkUI.Full 3910 * @crossplatform 3911 * @since 11 3912 */ 3913/** 3914 * Defines the options of geometry transition. 3915 * 3916 * @interface GeometryTransitionOptions 3917 * @syscap SystemCapability.ArkUI.ArkUI.Full 3918 * @crossplatform 3919 * @atomicservice 3920 * @since 12 3921 */ 3922declare interface GeometryTransitionOptions { 3923 /** 3924 * whether follow target for the component still in the hierarchy, default: false, stay current. 3925 * 3926 * @type { ?boolean } 3927 * @default false 3928 * @syscap SystemCapability.ArkUI.ArkUI.Full 3929 * @crossplatform 3930 * @since 11 3931 */ 3932 /** 3933 * whether follow target for the component still in the hierarchy, default: false, stay current. 3934 * 3935 * @type { ?boolean } 3936 * @default false 3937 * @syscap SystemCapability.ArkUI.ArkUI.Full 3938 * @crossplatform 3939 * @atomicservice 3940 * @since 12 3941 */ 3942 follow?: boolean; 3943 /** 3944 * Defines movement strategy of source and target in the hierarchy during geometry transition. 3945 * 3946 * @type { ?TransitionHierarchyStrategy } 3947 * @default TransitionHierarchyStrategy.ADAPTIVE 3948 * @syscap SystemCapability.ArkUI.ArkUI.Full 3949 * @systemapi 3950 * @atomicservice 3951 * @since 12 3952 */ 3953 /** 3954 * Defines movement strategy of source and target in the hierarchy during geometry transition. 3955 * 3956 * @type { ?TransitionHierarchyStrategy } 3957 * @default TransitionHierarchyStrategy.ADAPTIVE 3958 * @syscap SystemCapability.ArkUI.ArkUI.Full 3959 * @systemapi 3960 * @since 13 3961 */ 3962 hierarchyStrategy?: TransitionHierarchyStrategy 3963} 3964 3965/** 3966 * Defines the options of linear gradient. 3967 * 3968 * @interface LinearGradientOptions 3969 * @syscap SystemCapability.ArkUI.ArkUI.Full 3970 * @crossplatform 3971 * @form 3972 * @atomicservice 3973 * @since 18 3974 */ 3975declare interface LinearGradientOptions { 3976 /** 3977 * angle: Angle of Linear Gradient. The default value is 180; 3978 * 3979 * @type { ?(number | string) } 3980 * @syscap SystemCapability.ArkUI.ArkUI.Full 3981 * @since 7 3982 */ 3983 /** 3984 * angle: Angle of Linear Gradient. The default value is 180; 3985 * 3986 * @type { ?(number | string) } 3987 * @syscap SystemCapability.ArkUI.ArkUI.Full 3988 * @form 3989 * @since 9 3990 */ 3991 /** 3992 * angle: Angle of Linear Gradient. The default value is 180; 3993 * 3994 * @type { ?(number | string) } 3995 * @syscap SystemCapability.ArkUI.ArkUI.Full 3996 * @crossplatform 3997 * @form 3998 * @since 10 3999 */ 4000 /** 4001 * angle: Angle of Linear Gradient. The default value is 180; 4002 * 4003 * @type { ?(number | string) } 4004 * @syscap SystemCapability.ArkUI.ArkUI.Full 4005 * @crossplatform 4006 * @form 4007 * @atomicservice 4008 * @since 11 4009 */ 4010 /** 4011 * angle: Angle of Linear Gradient. The default value is 180; 4012 * 4013 * @type { ?(number | string) } 4014 * @syscap SystemCapability.ArkUI.ArkUI.Full 4015 * @crossplatform 4016 * @form 4017 * @atomicservice 4018 * @since 12 4019 */ 4020 /** 4021 * Defines starting angle of linear gradient. 4022 * 4023 * Anonymous Object Rectification. 4024 * @type { ?(number | string) } 4025 * @default 180 4026 * @syscap SystemCapability.ArkUI.ArkUI.Full 4027 * @crossplatform 4028 * @form 4029 * @atomicservice 4030 * @since 18 4031 */ 4032 angle?: number | string; 4033 4034 /** 4035 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 4036 * 4037 * @type { ?GradientDirection } 4038 * @syscap SystemCapability.ArkUI.ArkUI.Full 4039 * @since 7 4040 */ 4041 /** 4042 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 4043 * 4044 * @type { ?GradientDirection } 4045 * @syscap SystemCapability.ArkUI.ArkUI.Full 4046 * @form 4047 * @since 9 4048 */ 4049 /** 4050 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 4051 * 4052 * @type { ?GradientDirection } 4053 * @syscap SystemCapability.ArkUI.ArkUI.Full 4054 * @crossplatform 4055 * @form 4056 * @since 10 4057 */ 4058 /** 4059 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 4060 * 4061 * @type { ?GradientDirection } 4062 * @syscap SystemCapability.ArkUI.ArkUI.Full 4063 * @crossplatform 4064 * @form 4065 * @atomicservice 4066 * @since 11 4067 */ 4068 /** 4069 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 4070 * 4071 * @type { ?GradientDirection } 4072 * @syscap SystemCapability.ArkUI.ArkUI.Full 4073 * @crossplatform 4074 * @form 4075 * @atomicservice 4076 * @since 12 4077 */ 4078 /** 4079 * Defines the direction of linear gradient. 4080 * 4081 * Anonymous Object Rectification. 4082 * @type { ?GradientDirection } 4083 * @default GradientDirection.Bottom 4084 * @syscap SystemCapability.ArkUI.ArkUI.Full 4085 * @crossplatform 4086 * @form 4087 * @atomicservice 4088 * @since 18 4089 */ 4090 direction?: GradientDirection; 4091 4092 /** 4093 * colors: Color description for gradients. 4094 * 4095 * @type { Array<[ResourceColor, number]> } 4096 * @syscap SystemCapability.ArkUI.ArkUI.Full 4097 * @since 7 4098 */ 4099 /** 4100 * colors: Color description for gradients. 4101 * 4102 * @type { Array<[ResourceColor, number]> } 4103 * @syscap SystemCapability.ArkUI.ArkUI.Full 4104 * @form 4105 * @since 9 4106 */ 4107 /** 4108 * colors: Color description for gradients. 4109 * 4110 * @type { Array<[ResourceColor, number]> } 4111 * @syscap SystemCapability.ArkUI.ArkUI.Full 4112 * @crossplatform 4113 * @form 4114 * @since 10 4115 */ 4116 /** 4117 * colors: Color description for gradients. 4118 * 4119 * @type { Array<[ResourceColor, number]> } 4120 * @syscap SystemCapability.ArkUI.ArkUI.Full 4121 * @crossplatform 4122 * @form 4123 * @atomicservice 4124 * @since 11 4125 */ 4126 /** 4127 * colors: Color description for gradients. 4128 * 4129 * @type { Array<[ResourceColor, number]> } 4130 * @syscap SystemCapability.ArkUI.ArkUI.Full 4131 * @crossplatform 4132 * @form 4133 * @atomicservice 4134 * @since 12 4135 */ 4136 /** 4137 * Defines color description for gradients. 4138 * 4139 * Anonymous Object Rectification. 4140 * @type { Array<[ResourceColor, number]> } 4141 * @syscap SystemCapability.ArkUI.ArkUI.Full 4142 * @crossplatform 4143 * @form 4144 * @atomicservice 4145 * @since 18 4146 */ 4147 colors: Array<[ResourceColor, number]>; 4148 4149 /** 4150 * repeating: repeating. The default value is false 4151 * 4152 * @type { ?boolean } 4153 * @syscap SystemCapability.ArkUI.ArkUI.Full 4154 * @since 7 4155 */ 4156 /** 4157 * repeating: repeating. The default value is false 4158 * 4159 * @type { ?boolean } 4160 * @syscap SystemCapability.ArkUI.ArkUI.Full 4161 * @form 4162 * @since 9 4163 */ 4164 /** 4165 * repeating: repeating. The default value is false 4166 * 4167 * @type { ?boolean } 4168 * @syscap SystemCapability.ArkUI.ArkUI.Full 4169 * @crossplatform 4170 * @form 4171 * @since 10 4172 */ 4173 /** 4174 * repeating: repeating. The default value is false 4175 * 4176 * @type { ?boolean } 4177 * @syscap SystemCapability.ArkUI.ArkUI.Full 4178 * @crossplatform 4179 * @form 4180 * @atomicservice 4181 * @since 11 4182 */ 4183 /** 4184 * repeating: repeating. The default value is false 4185 * 4186 * @type { ?boolean } 4187 * @syscap SystemCapability.ArkUI.ArkUI.Full 4188 * @crossplatform 4189 * @form 4190 * @atomicservice 4191 * @since 12 4192 */ 4193 /** 4194 * Defines gradient colors with repeated coloring. 4195 * 4196 * Anonymous Object Rectification. 4197 * @type { ?boolean } 4198 * @default false 4199 * @syscap SystemCapability.ArkUI.ArkUI.Full 4200 * @crossplatform 4201 * @form 4202 * @atomicservice 4203 * @since 18 4204 */ 4205 repeating?: boolean; 4206} 4207 4208/** 4209 * Defines the options of radial gradient. 4210 * 4211 * @interface SweepGradientOptions 4212 * @syscap SystemCapability.ArkUI.ArkUI.Full 4213 * @crossplatform 4214 * @form 4215 * @atomicservice 4216 * @since 18 4217 */ 4218declare interface SweepGradientOptions { 4219 /** 4220 * center:is the center point of the angle gradient 4221 * 4222 * @type { [Length, Length] } 4223 * @syscap SystemCapability.ArkUI.ArkUI.Full 4224 * @since 7 4225 */ 4226 /** 4227 * center:is the center point of the angle gradient 4228 * 4229 * @type { [Length, Length] } 4230 * @syscap SystemCapability.ArkUI.ArkUI.Full 4231 * @form 4232 * @since 9 4233 */ 4234 /** 4235 * center:is the center point of the angle gradient 4236 * 4237 * @type { [Length, Length] } 4238 * @syscap SystemCapability.ArkUI.ArkUI.Full 4239 * @crossplatform 4240 * @form 4241 * @since 10 4242 */ 4243 /** 4244 * center:is the center point of the angle gradient 4245 * 4246 * @type { [Length, Length] } 4247 * @syscap SystemCapability.ArkUI.ArkUI.Full 4248 * @crossplatform 4249 * @form 4250 * @atomicservice 4251 * @since 11 4252 */ 4253 /** 4254 * center:is the center point of the angle gradient 4255 * 4256 * @type { [Length, Length] } 4257 * @syscap SystemCapability.ArkUI.ArkUI.Full 4258 * @crossplatform 4259 * @form 4260 * @atomicservice 4261 * @since 12 4262 */ 4263 /** 4264 * Defines center point for angle gradient. 4265 * 4266 * Anonymous Object Rectification. 4267 * @type { [Length, Length] } 4268 * @syscap SystemCapability.ArkUI.ArkUI.Full 4269 * @crossplatform 4270 * @form 4271 * @atomicservice 4272 * @since 18 4273 */ 4274 center: [Length, Length]; 4275 4276 /** 4277 * start:Start point of angle gradient. The default value is 0 4278 * 4279 * @param { ?(number | string) } 4280 * @syscap SystemCapability.ArkUI.ArkUI.Full 4281 * @since 7 4282 */ 4283 /** 4284 * start:Start point of angle gradient. The default value is 0 4285 * 4286 * @type { ?(number | string) } 4287 * @syscap SystemCapability.ArkUI.ArkUI.Full 4288 * @form 4289 * @since 9 4290 */ 4291 /** 4292 * Angle Gradient 4293 * start:Start point of angle gradient. The default value is 0 4294 * 4295 * @type { ?(number | string) } 4296 * @syscap SystemCapability.ArkUI.ArkUI.Full 4297 * @crossplatform 4298 * @form 4299 * @since 10 4300 */ 4301 /** 4302 * start:Start point of angle gradient. The default value is 0 4303 * 4304 * @type { ?(number | string) } 4305 * @syscap SystemCapability.ArkUI.ArkUI.Full 4306 * @crossplatform 4307 * @form 4308 * @atomicservice 4309 * @since 11 4310 */ 4311 /** 4312 * start:Start point of angle gradient. The default value is 0 4313 * 4314 * @type { ?(number | string) } 4315 * @syscap SystemCapability.ArkUI.ArkUI.Full 4316 * @crossplatform 4317 * @form 4318 * @atomicservice 4319 * @since 12 4320 */ 4321 /** 4322 * Defines the starting point of angle gradient. 4323 * 4324 * Anonymous Object Rectification. 4325 * @type { ?(number | string) } 4326 * @default 0 4327 * @syscap SystemCapability.ArkUI.ArkUI.Full 4328 * @crossplatform 4329 * @form 4330 * @atomicservice 4331 * @since 18 4332 */ 4333 start?: number | string; 4334 4335 /** 4336 * end:End point of angle gradient. The default value is 0 4337 * @type { ?(number | string) } 4338 * @syscap SystemCapability.ArkUI.ArkUI.Full 4339 * @since 7 4340 */ 4341 /** 4342 * end:End point of angle gradient. The default value is 0 4343 * 4344 * @type { ?(number | string) } 4345 * @syscap SystemCapability.ArkUI.ArkUI.Full 4346 * @form 4347 * @since 9 4348 */ 4349 /** 4350 * end:End point of angle gradient. The default value is 0 4351 * 4352 * @type { ?(number | string) } 4353 * @syscap SystemCapability.ArkUI.ArkUI.Full 4354 * @crossplatform 4355 * @form 4356 * @since 10 4357 */ 4358 /** 4359 * end:End point of angle gradient. The default value is 0 4360 * 4361 * @type { ?(number | string) } 4362 * @syscap SystemCapability.ArkUI.ArkUI.Full 4363 * @crossplatform 4364 * @form 4365 * @atomicservice 4366 * @since 11 4367 */ 4368 /** 4369 * end:End point of angle gradient. The default value is 0 4370 * 4371 * @type { ?(number | string) } 4372 * @syscap SystemCapability.ArkUI.ArkUI.Full 4373 * @crossplatform 4374 * @form 4375 * @atomicservice 4376 * @since 12 4377 */ 4378 /** 4379 * Defines end point of angle gradient. 4380 * 4381 * Anonymous Object Rectification. 4382 * @type { ?(number | string) } 4383 * @default 0 4384 * @syscap SystemCapability.ArkUI.ArkUI.Full 4385 * @crossplatform 4386 * @form 4387 * @atomicservice 4388 * @since 18 4389 */ 4390 end?: number | string; 4391 4392 /** 4393 * rotating:rotating. The default value is 0 4394 * 4395 * @type { ?(number | string) } 4396 * @syscap SystemCapability.ArkUI.ArkUI.Full 4397 * @since 7 4398 */ 4399 /** 4400 * rotating:rotating. The default value is 0 4401 * 4402 * @type { ?(number | string) } 4403 * @syscap SystemCapability.ArkUI.ArkUI.Full 4404 * @form 4405 * @since 9 4406 */ 4407 /** 4408 * rotating:rotating. The default value is 0 4409 * 4410 * @type { ?(number | string) } 4411 * @syscap SystemCapability.ArkUI.ArkUI.Full 4412 * @crossplatform 4413 * @form 4414 * @since 10 4415 */ 4416 /** 4417 * rotating:rotating. The default value is 0 4418 * 4419 * @type { ?(number | string) } 4420 * @syscap SystemCapability.ArkUI.ArkUI.Full 4421 * @crossplatform 4422 * @form 4423 * @atomicservice 4424 * @since 11 4425 */ 4426 /** 4427 * rotating:rotating. The default value is 0 4428 * 4429 * @type { ?(number | string) } 4430 * @syscap SystemCapability.ArkUI.ArkUI.Full 4431 * @crossplatform 4432 * @form 4433 * @atomicservice 4434 * @since 12 4435 */ 4436 /** 4437 * Defines the rotation angle of the gradient. 4438 * 4439 * Anonymous Object Rectification. 4440 * @type { ?(number | string) } 4441 * @default 0 4442 * @syscap SystemCapability.ArkUI.ArkUI.Full 4443 * @crossplatform 4444 * @form 4445 * @atomicservice 4446 * @since 18 4447 */ 4448 rotation?: number | string; 4449 4450 /** 4451 * colors:Color description for gradients 4452 * 4453 * @type { Array<[ResourceColor, number]> } 4454 * @syscap SystemCapability.ArkUI.ArkUI.Full 4455 * @since 7 4456 */ 4457 /** 4458 * colors:Color description for gradients 4459 * 4460 * @type { Array<[ResourceColor, number]> } 4461 * @syscap SystemCapability.ArkUI.ArkUI.Full 4462 * @form 4463 * @since 9 4464 */ 4465 /** 4466 * colors:Color description for gradients 4467 * 4468 * @type { Array<[ResourceColor, number]> } 4469 * @syscap SystemCapability.ArkUI.ArkUI.Full 4470 * @crossplatform 4471 * @form 4472 * @since 10 4473 */ 4474 /** 4475 * colors:Color description for gradients 4476 * 4477 * @type { Array<[ResourceColor, number]> } 4478 * @syscap SystemCapability.ArkUI.ArkUI.Full 4479 * @crossplatform 4480 * @form 4481 * @atomicservice 4482 * @since 11 4483 */ 4484 /** 4485 * colors:Color description for gradients 4486 * 4487 * @type { Array<[ResourceColor, number]> } 4488 * @syscap SystemCapability.ArkUI.ArkUI.Full 4489 * @crossplatform 4490 * @form 4491 * @atomicservice 4492 * @since 12 4493 */ 4494 /** 4495 * Defines color description for gradients. 4496 * 4497 * Anonymous Object Rectification. 4498 * @type { Array<[ResourceColor, number]> } 4499 * @syscap SystemCapability.ArkUI.ArkUI.Full 4500 * @crossplatform 4501 * @form 4502 * @atomicservice 4503 * @since 18 4504 */ 4505 colors: Array<[ResourceColor, number]>; 4506 4507 /** 4508 * repeating:repeating. The default value is false 4509 * 4510 * @type { ?boolean } 4511 * @syscap SystemCapability.ArkUI.ArkUI.Full 4512 * @since 7 4513 */ 4514 /** 4515 * repeating:repeating. The default value is false 4516 * 4517 * @type { ?boolean } 4518 * @syscap SystemCapability.ArkUI.ArkUI.Full 4519 * @form 4520 * @since 9 4521 */ 4522 /** 4523 * repeating:repeating. The default value is false 4524 * 4525 * @type { ?boolean } 4526 * @syscap SystemCapability.ArkUI.ArkUI.Full 4527 * @crossplatform 4528 * @form 4529 * @since 10 4530 */ 4531 /** 4532 * repeating:repeating. The default value is false 4533 * 4534 * @type { ?boolean } 4535 * @syscap SystemCapability.ArkUI.ArkUI.Full 4536 * @crossplatform 4537 * @form 4538 * @atomicservice 4539 * @since 11 4540 */ 4541 /** 4542 * repeating:repeating. The default value is false 4543 * 4544 * @type { ?boolean } 4545 * @syscap SystemCapability.ArkUI.ArkUI.Full 4546 * @crossplatform 4547 * @form 4548 * @atomicservice 4549 * @since 12 4550 */ 4551 /** 4552 * Defines gradient colors with repeated coloring. 4553 * 4554 * Anonymous Object Rectification. 4555 * @type { ?boolean } 4556 * @default false 4557 * @syscap SystemCapability.ArkUI.ArkUI.Full 4558 * @crossplatform 4559 * @form 4560 * @atomicservice 4561 * @since 18 4562 */ 4563 repeating?: boolean; 4564} 4565 4566/** 4567 * Defines the options of radial gradient. 4568 * 4569 * @interface RadialGradientOptions 4570 * @syscap SystemCapability.ArkUI.ArkUI.Full 4571 * @crossplatform 4572 * @form 4573 * @atomicservice 4574 * @since 18 4575 */ 4576declare interface RadialGradientOptions { 4577 /** 4578 * center:Center point of radial gradient 4579 * 4580 * @type { [Length, Length] } 4581 * @syscap SystemCapability.ArkUI.ArkUI.Full 4582 * @since 7 4583 */ 4584 /** 4585 * center:Center point of radial gradient 4586 * 4587 * @type { [Length, Length] } 4588 * @syscap SystemCapability.ArkUI.ArkUI.Full 4589 * @form 4590 * @since 9 4591 */ 4592 /** 4593 * center:Center point of radial gradient 4594 * 4595 * @type { [Length, Length] } 4596 * @syscap SystemCapability.ArkUI.ArkUI.Full 4597 * @crossplatform 4598 * @form 4599 * @since 10 4600 */ 4601 /** 4602 * center:Center point of radial gradient 4603 * 4604 * @type { [Length, Length] } 4605 * @syscap SystemCapability.ArkUI.ArkUI.Full 4606 * @crossplatform 4607 * @form 4608 * @atomicservice 4609 * @since 11 4610 */ 4611 /** 4612 * center:Center point of radial gradient 4613 * 4614 * @type { [Length, Length] } 4615 * @syscap SystemCapability.ArkUI.ArkUI.Full 4616 * @crossplatform 4617 * @form 4618 * @atomicservice 4619 * @since 12 4620 */ 4621 /** 4622 * Defines center point for radial gradient. 4623 * 4624 * Anonymous Object Rectification. 4625 * @type { [Length, Length] } 4626 * @syscap SystemCapability.ArkUI.ArkUI.Full 4627 * @crossplatform 4628 * @form 4629 * @atomicservice 4630 * @since 18 4631 */ 4632 center: [Length, Length]; 4633 4634 /** 4635 * radius:Radius of Radial Gradient. value range [0, +∞) 4636 * 4637 * @type { number | string } 4638 * @syscap SystemCapability.ArkUI.ArkUI.Full 4639 * @since 7 4640 */ 4641 /** 4642 * radius:Radius of Radial Gradient. value range [0, +∞) 4643 * 4644 * @type { number | string } 4645 * @syscap SystemCapability.ArkUI.ArkUI.Full 4646 * @form 4647 * @since 9 4648 */ 4649 /** 4650 * radius:Radius of Radial Gradient. value range [0, +∞) 4651 * 4652 * @type { number | string } 4653 * @syscap SystemCapability.ArkUI.ArkUI.Full 4654 * @crossplatform 4655 * @form 4656 * @since 10 4657 */ 4658 /** 4659 * radius:Radius of Radial Gradient. value range [0, +∞) 4660 * 4661 * @type { number | string } 4662 * @syscap SystemCapability.ArkUI.ArkUI.Full 4663 * @crossplatform 4664 * @form 4665 * @atomicservice 4666 * @since 11 4667 */ 4668 /** 4669 * radius:Radius of Radial Gradient. value range [0, +∞) 4670 * 4671 * @type { number | string } 4672 * @syscap SystemCapability.ArkUI.ArkUI.Full 4673 * @crossplatform 4674 * @form 4675 * @atomicservice 4676 * @since 12 4677 */ 4678 /** 4679 * Defines radius of the radial gradient. 4680 * 4681 * Anonymous Object Rectification. 4682 * @type { Length } 4683 * @syscap SystemCapability.ArkUI.ArkUI.Full 4684 * @crossplatform 4685 * @form 4686 * @atomicservice 4687 * @since 18 4688 */ 4689 radius: Length; 4690 4691 /** 4692 * colors:Color description for gradients 4693 * 4694 * @type { Array<[ResourceColor, number]> } 4695 * @syscap SystemCapability.ArkUI.ArkUI.Full 4696 * @since 7 4697 */ 4698 /** 4699 * colors:Color description for gradients 4700 * 4701 * @type { Array<[ResourceColor, number]> } 4702 * @syscap SystemCapability.ArkUI.ArkUI.Full 4703 * @form 4704 * @since 9 4705 */ 4706 /** 4707 * colors:Color description for gradients 4708 * 4709 * @type { Array<[ResourceColor, number]> } 4710 * @syscap SystemCapability.ArkUI.ArkUI.Full 4711 * @crossplatform 4712 * @form 4713 * @since 10 4714 */ 4715 /** 4716 * colors:Color description for gradients 4717 * 4718 * @type { Array<[ResourceColor, number]> } 4719 * @syscap SystemCapability.ArkUI.ArkUI.Full 4720 * @crossplatform 4721 * @form 4722 * @atomicservice 4723 * @since 11 4724 */ 4725 /** 4726 * colors:Color description for gradients 4727 * 4728 * @type { Array<[ResourceColor, number]> } 4729 * @syscap SystemCapability.ArkUI.ArkUI.Full 4730 * @crossplatform 4731 * @form 4732 * @atomicservice 4733 * @since 12 4734 */ 4735 /** 4736 * Defines color description for gradients. 4737 * 4738 * Anonymous Object Rectification. 4739 * @type { Array<[ResourceColor, number]> } 4740 * @syscap SystemCapability.ArkUI.ArkUI.Full 4741 * @crossplatform 4742 * @form 4743 * @atomicservice 4744 * @since 18 4745 */ 4746 colors: Array<[ResourceColor, number]>; 4747 4748 /** 4749 * repeating: Refill. The default value is false 4750 * 4751 * @type { ?boolean } value 4752 * @syscap SystemCapability.ArkUI.ArkUI.Full 4753 * @since 7 4754 */ 4755 /** 4756 * repeating: Refill. The default value is false 4757 * 4758 * @type { ?boolean } value 4759 * @syscap SystemCapability.ArkUI.ArkUI.Full 4760 * @form 4761 * @since 9 4762 */ 4763 /** 4764 * repeating: Refill. The default value is false 4765 * 4766 * @type { ?boolean } value 4767 * @syscap SystemCapability.ArkUI.ArkUI.Full 4768 * @crossplatform 4769 * @form 4770 * @since 10 4771 */ 4772 /** 4773 * repeating: Refill. The default value is false 4774 * 4775 * @type { ?boolean } value 4776 * @syscap SystemCapability.ArkUI.ArkUI.Full 4777 * @crossplatform 4778 * @form 4779 * @atomicservice 4780 * @since 11 4781 */ 4782 /** 4783 * repeating: Refill. The default value is false 4784 * 4785 * @type { ?boolean } 4786 * @syscap SystemCapability.ArkUI.ArkUI.Full 4787 * @crossplatform 4788 * @form 4789 * @atomicservice 4790 * @since 12 4791 */ 4792 /** 4793 * Defines gradient colors with repeated coloring. 4794 * 4795 * Anonymous Object Rectification. 4796 * @type { ?boolean } 4797 * @default false 4798 * @syscap SystemCapability.ArkUI.ArkUI.Full 4799 * @crossplatform 4800 * @form 4801 * @atomicservice 4802 * @since 18 4803 */ 4804 repeating?: boolean; 4805} 4806 4807/** 4808 * Source and target are two matched elements during the geometry transition. 4809 * The animation starts at the source and ends at the target. 4810 * TransitionHierarchyStrategy enumeration defines how levels of source and target elements 4811 * would be changed in the hierarchy during the geometry transition. 4812 * 4813 * @enum { number } 4814 * @syscap SystemCapability.ArkUI.ArkUI.Full 4815 * @systemapi 4816 * @atomicservice 4817 * @since 12 4818 */ 4819/** 4820 * Source and target are two matched elements during the geometry transition. 4821 * The animation starts at the source and ends at the target. 4822 * TransitionHierarchyStrategy enumeration defines how levels of source and target elements 4823 * would be changed in the hierarchy during the geometry transition. 4824 * 4825 * @enum { number } 4826 * @syscap SystemCapability.ArkUI.ArkUI.Full 4827 * @systemapi 4828 * @since 13 4829 */ 4830declare enum TransitionHierarchyStrategy { 4831 /** 4832 * None mode. 4833 * Source and target staty in the original level in the hierarchy during geometry transition. 4834 * 4835 * @syscap SystemCapability.ArkUI.ArkUI.Full 4836 * @systemapi 4837 * @atomicservice 4838 * @since 12 4839 */ 4840 /** 4841 * None mode. 4842 * Source and target staty in the original level in the hierarchy during geometry transition. 4843 * 4844 * @syscap SystemCapability.ArkUI.ArkUI.Full 4845 * @systemapi 4846 * @since 13 4847 */ 4848 NONE = 0, 4849 4850 /** 4851 * ADAPTIVE mode. 4852 * Lower level one of source and target is elevated to higher level of both, 4853 * indicating that two elements are in same high level. 4854 * 4855 * @syscap SystemCapability.ArkUI.ArkUI.Full 4856 * @systemapi 4857 * @atomicservice 4858 * @since 12 4859 */ 4860 /** 4861 * ADAPTIVE mode. 4862 * Lower level one of source and target is elevated to higher level of both, 4863 * indicating that two elements are in same high level. 4864 * 4865 * @syscap SystemCapability.ArkUI.ArkUI.Full 4866 * @systemapi 4867 * @since 13 4868 */ 4869 ADAPTIVE = 1, 4870} 4871 4872/** 4873 * Defines the options of translate. 4874 * 4875 * @interface TranslateOptions 4876 * @syscap SystemCapability.ArkUI.ArkUI.Full 4877 * @since 7 4878 */ 4879/** 4880 * Defines the options of translate. 4881 * 4882 * @interface TranslateOptions 4883 * @syscap SystemCapability.ArkUI.ArkUI.Full 4884 * @form 4885 * @since 9 4886 */ 4887/** 4888 * Defines the options of translate. 4889 * 4890 * @interface TranslateOptions 4891 * @syscap SystemCapability.ArkUI.ArkUI.Full 4892 * @crossplatform 4893 * @form 4894 * @since 10 4895 */ 4896/** 4897 * Defines the options of translate. 4898 * 4899 * @interface TranslateOptions 4900 * @syscap SystemCapability.ArkUI.ArkUI.Full 4901 * @crossplatform 4902 * @form 4903 * @atomicservice 4904 * @since 11 4905 */ 4906declare interface TranslateOptions { 4907 /** 4908 * The param of x direction. 4909 * 4910 * @type { ?(number | string) } 4911 * @syscap SystemCapability.ArkUI.ArkUI.Full 4912 * @since 7 4913 */ 4914 /** 4915 * The param of x direction. 4916 * 4917 * @type { ?(number | string) } 4918 * @syscap SystemCapability.ArkUI.ArkUI.Full 4919 * @form 4920 * @since 9 4921 */ 4922 /** 4923 * The param of x direction. 4924 * 4925 * @type { ?(number | string) } 4926 * @syscap SystemCapability.ArkUI.ArkUI.Full 4927 * @crossplatform 4928 * @form 4929 * @since 10 4930 */ 4931 /** 4932 * The param of x direction. 4933 * 4934 * @type { ?(number | string) } 4935 * @syscap SystemCapability.ArkUI.ArkUI.Full 4936 * @crossplatform 4937 * @form 4938 * @atomicservice 4939 * @since 11 4940 */ 4941 x?: number | string; 4942 4943 /** 4944 * The param of y direction. 4945 * 4946 * @type { ?(number | string) } 4947 * @syscap SystemCapability.ArkUI.ArkUI.Full 4948 * @since 7 4949 */ 4950 /** 4951 * The param of y direction. 4952 * 4953 * @type { ?(number | string) } 4954 * @syscap SystemCapability.ArkUI.ArkUI.Full 4955 * @form 4956 * @since 9 4957 */ 4958 /** 4959 * The param of y direction. 4960 * 4961 * @type { ?(number | string) } 4962 * @syscap SystemCapability.ArkUI.ArkUI.Full 4963 * @crossplatform 4964 * @form 4965 * @since 10 4966 */ 4967 /** 4968 * The param of y direction. 4969 * 4970 * @type { ?(number | string) } 4971 * @syscap SystemCapability.ArkUI.ArkUI.Full 4972 * @crossplatform 4973 * @form 4974 * @atomicservice 4975 * @since 11 4976 */ 4977 y?: number | string; 4978 4979 /** 4980 * The param of z direction. 4981 * 4982 * @type { ?(number | string) } 4983 * @syscap SystemCapability.ArkUI.ArkUI.Full 4984 * @since 7 4985 */ 4986 /** 4987 * The param of z direction. 4988 * 4989 * @type { ?(number | string) } 4990 * @syscap SystemCapability.ArkUI.ArkUI.Full 4991 * @form 4992 * @since 9 4993 */ 4994 /** 4995 * The param of z direction. 4996 * 4997 * @type { ?(number | string) } 4998 * @syscap SystemCapability.ArkUI.ArkUI.Full 4999 * @crossplatform 5000 * @form 5001 * @since 10 5002 */ 5003 /** 5004 * The param of z direction. 5005 * 5006 * @type { ?(number | string) } 5007 * @syscap SystemCapability.ArkUI.ArkUI.Full 5008 * @crossplatform 5009 * @form 5010 * @atomicservice 5011 * @since 11 5012 */ 5013 z?: number | string; 5014} 5015 5016/** 5017 * Defines the options of scale. 5018 * 5019 * @interface ScaleOptions 5020 * @syscap SystemCapability.ArkUI.ArkUI.Full 5021 * @since 7 5022 */ 5023/** 5024 * Defines the options of scale. 5025 * 5026 * @interface ScaleOptions 5027 * @syscap SystemCapability.ArkUI.ArkUI.Full 5028 * @form 5029 * @since 9 5030 */ 5031/** 5032 * Defines the options of scale. 5033 * 5034 * @interface ScaleOptions 5035 * @syscap SystemCapability.ArkUI.ArkUI.Full 5036 * @crossplatform 5037 * @form 5038 * @since 10 5039 */ 5040/** 5041 * Defines the options of scale. 5042 * 5043 * @interface ScaleOptions 5044 * @syscap SystemCapability.ArkUI.ArkUI.Full 5045 * @crossplatform 5046 * @form 5047 * @atomicservice 5048 * @since 11 5049 */ 5050declare interface ScaleOptions { 5051 /** 5052 * The param of x direction. 5053 * 5054 * @type { ?number } 5055 * @syscap SystemCapability.ArkUI.ArkUI.Full 5056 * @since 7 5057 */ 5058 /** 5059 * The param of x direction. 5060 * 5061 * @type { ?number } 5062 * @syscap SystemCapability.ArkUI.ArkUI.Full 5063 * @form 5064 * @since 9 5065 */ 5066 /** 5067 * The param of x direction. 5068 * 5069 * @type { ?number } 5070 * @syscap SystemCapability.ArkUI.ArkUI.Full 5071 * @crossplatform 5072 * @form 5073 * @since 10 5074 */ 5075 /** 5076 * The param of x direction. 5077 * 5078 * @type { ?number } 5079 * @syscap SystemCapability.ArkUI.ArkUI.Full 5080 * @crossplatform 5081 * @form 5082 * @atomicservice 5083 * @since 11 5084 */ 5085 x?: number; 5086 5087 /** 5088 * The param of y direction. 5089 * 5090 * @type { ?number } 5091 * @syscap SystemCapability.ArkUI.ArkUI.Full 5092 * @since 7 5093 */ 5094 /** 5095 * The param of y direction. 5096 * 5097 * @type { ?number } 5098 * @syscap SystemCapability.ArkUI.ArkUI.Full 5099 * @form 5100 * @since 9 5101 */ 5102 /** 5103 * The param of y direction. 5104 * 5105 * @type { ?number } 5106 * @syscap SystemCapability.ArkUI.ArkUI.Full 5107 * @crossplatform 5108 * @form 5109 * @since 10 5110 */ 5111 /** 5112 * The param of y direction. 5113 * 5114 * @type { ?number } 5115 * @syscap SystemCapability.ArkUI.ArkUI.Full 5116 * @crossplatform 5117 * @form 5118 * @atomicservice 5119 * @since 11 5120 */ 5121 y?: number; 5122 5123 /** 5124 * The param of z direction. 5125 * 5126 * @type { ?number } 5127 * @syscap SystemCapability.ArkUI.ArkUI.Full 5128 * @since 7 5129 */ 5130 /** 5131 * The param of z direction. 5132 * 5133 * @type { ?number } 5134 * @syscap SystemCapability.ArkUI.ArkUI.Full 5135 * @form 5136 * @since 9 5137 */ 5138 /** 5139 * The param of z direction. 5140 * 5141 * @type { ?number } 5142 * @syscap SystemCapability.ArkUI.ArkUI.Full 5143 * @crossplatform 5144 * @form 5145 * @since 10 5146 */ 5147 /** 5148 * The param of z direction. 5149 * 5150 * @type { ?number } 5151 * @syscap SystemCapability.ArkUI.ArkUI.Full 5152 * @crossplatform 5153 * @form 5154 * @atomicservice 5155 * @since 11 5156 */ 5157 z?: number; 5158 5159 /** 5160 * The param of center point of x. 5161 * 5162 * @type { ?(number | string) } 5163 * @syscap SystemCapability.ArkUI.ArkUI.Full 5164 * @since 7 5165 */ 5166 /** 5167 * The param of center point of x. 5168 * 5169 * @type { ?(number | string) } 5170 * @syscap SystemCapability.ArkUI.ArkUI.Full 5171 * @form 5172 * @since 9 5173 */ 5174 /** 5175 * The param of center point of x. 5176 * 5177 * @type { ?(number | string) } 5178 * @syscap SystemCapability.ArkUI.ArkUI.Full 5179 * @crossplatform 5180 * @form 5181 * @since 10 5182 */ 5183 /** 5184 * The param of center point of x. 5185 * 5186 * @type { ?(number | string) } 5187 * @syscap SystemCapability.ArkUI.ArkUI.Full 5188 * @crossplatform 5189 * @form 5190 * @atomicservice 5191 * @since 11 5192 */ 5193 centerX?: number | string; 5194 5195 /** 5196 * The param of center point of y. 5197 * 5198 * @type { ?(number | string) } 5199 * @syscap SystemCapability.ArkUI.ArkUI.Full 5200 * @since 7 5201 */ 5202 /** 5203 * The param of center point of y. 5204 * 5205 * @type { ?(number | string) } 5206 * @syscap SystemCapability.ArkUI.ArkUI.Full 5207 * @form 5208 * @since 9 5209 */ 5210 /** 5211 * The param of center point of y. 5212 * 5213 * @type { ?(number | string) } 5214 * @syscap SystemCapability.ArkUI.ArkUI.Full 5215 * @crossplatform 5216 * @form 5217 * @since 10 5218 */ 5219 /** 5220 * The param of center point of y. 5221 * 5222 * @type { ?(number | string) } 5223 * @syscap SystemCapability.ArkUI.ArkUI.Full 5224 * @crossplatform 5225 * @form 5226 * @atomicservice 5227 * @since 11 5228 */ 5229 centerY?: number | string; 5230} 5231 5232/** 5233 * Defines the align rule options of relative container. 5234 * 5235 * @interface AlignRuleOption 5236 * @syscap SystemCapability.ArkUI.ArkUI.Full 5237 * @form 5238 * @since 9 5239 */ 5240/** 5241 * Defines the align rule options of relative container. 5242 * 5243 * @interface AlignRuleOption 5244 * @syscap SystemCapability.ArkUI.ArkUI.Full 5245 * @crossplatform 5246 * @form 5247 * @since 10 5248 */ 5249/** 5250 * Defines the align rule options of relative container. 5251 * 5252 * @interface AlignRuleOption 5253 * @syscap SystemCapability.ArkUI.ArkUI.Full 5254 * @crossplatform 5255 * @form 5256 * @atomicservice 5257 * @since 11 5258 */ 5259declare interface AlignRuleOption { 5260 /** 5261 * The param of left align. 5262 * 5263 * @type { ?object } 5264 * @syscap SystemCapability.ArkUI.ArkUI.Full 5265 * @form 5266 * @since 9 5267 */ 5268 /** 5269 * The param of left align. 5270 * 5271 * @type { ?object } 5272 * @syscap SystemCapability.ArkUI.ArkUI.Full 5273 * @crossplatform 5274 * @form 5275 * @since 10 5276 */ 5277 /** 5278 * The param of left align. 5279 * 5280 * @type { ?object } 5281 * @syscap SystemCapability.ArkUI.ArkUI.Full 5282 * @crossplatform 5283 * @form 5284 * @atomicservice 5285 * @since 11 5286 */ 5287 left?: { anchor: string, align: HorizontalAlign }; 5288 5289 /** 5290 * The param of right align. 5291 * 5292 * @type { ?object } 5293 * @syscap SystemCapability.ArkUI.ArkUI.Full 5294 * @form 5295 * @since 9 5296 */ 5297 /** 5298 * The param of right align. 5299 * 5300 * @type { ?object } 5301 * @syscap SystemCapability.ArkUI.ArkUI.Full 5302 * @crossplatform 5303 * @form 5304 * @since 10 5305 */ 5306 /** 5307 * The param of right align. 5308 * 5309 * @type { ?object } 5310 * @syscap SystemCapability.ArkUI.ArkUI.Full 5311 * @crossplatform 5312 * @form 5313 * @atomicservice 5314 * @since 11 5315 */ 5316 right?: { anchor: string, align: HorizontalAlign }; 5317 5318 /** 5319 * The param of middle align. 5320 * 5321 * @type { ?object } 5322 * @syscap SystemCapability.ArkUI.ArkUI.Full 5323 * @form 5324 * @since 9 5325 */ 5326 /** 5327 * The param of middle align. 5328 * 5329 * @type { ?object } 5330 * @syscap SystemCapability.ArkUI.ArkUI.Full 5331 * @crossplatform 5332 * @form 5333 * @since 10 5334 */ 5335 /** 5336 * The param of middle align. 5337 * 5338 * @type { ?object } 5339 * @syscap SystemCapability.ArkUI.ArkUI.Full 5340 * @crossplatform 5341 * @form 5342 * @atomicservice 5343 * @since 11 5344 */ 5345 middle?: { anchor: string, align: HorizontalAlign }; 5346 5347 /** 5348 * The param of top align. 5349 * 5350 * @type { ?object } 5351 * @syscap SystemCapability.ArkUI.ArkUI.Full 5352 * @form 5353 * @since 9 5354 */ 5355 /** 5356 * The param of top align. 5357 * 5358 * @type { ?object } 5359 * @syscap SystemCapability.ArkUI.ArkUI.Full 5360 * @crossplatform 5361 * @form 5362 * @since 10 5363 */ 5364 /** 5365 * The param of top align. 5366 * 5367 * @type { ?object } 5368 * @syscap SystemCapability.ArkUI.ArkUI.Full 5369 * @crossplatform 5370 * @form 5371 * @atomicservice 5372 * @since 11 5373 */ 5374 top?: { anchor: string, align: VerticalAlign }; 5375 5376 /** 5377 * The param of bottom align. 5378 * 5379 * @type { ?object } 5380 * @syscap SystemCapability.ArkUI.ArkUI.Full 5381 * @form 5382 * @since 9 5383 */ 5384 /** 5385 * The param of bottom align. 5386 * 5387 * @type { ?object } 5388 * @syscap SystemCapability.ArkUI.ArkUI.Full 5389 * @form 5390 * @since 10 5391 */ 5392 /** 5393 * The param of bottom align. 5394 * 5395 * @type { ?object } 5396 * @syscap SystemCapability.ArkUI.ArkUI.Full 5397 * @form 5398 * @atomicservice 5399 * @since 11 5400 */ 5401 bottom?: { anchor: string, align: VerticalAlign }; 5402 5403 /** 5404 * The param of center align. 5405 * 5406 * @type { ?object } 5407 * @syscap SystemCapability.ArkUI.ArkUI.Full 5408 * @form 5409 * @since 9 5410 */ 5411 /** 5412 * The param of center align. 5413 * 5414 * @type { ?object } 5415 * @syscap SystemCapability.ArkUI.ArkUI.Full 5416 * @crossplatform 5417 * @form 5418 * @since 10 5419 */ 5420 /** 5421 * The param of center align. 5422 * 5423 * @type { ?object } 5424 * @syscap SystemCapability.ArkUI.ArkUI.Full 5425 * @crossplatform 5426 * @form 5427 * @atomicservice 5428 * @since 11 5429 */ 5430 center?: { anchor: string, align: VerticalAlign }; 5431 5432 /** 5433 * Defines the bias ratio in horizontal and vertical direction. 5434 * 5435 * @type { ?Bias } 5436 * @default {horizontal:0.5,vertical:0.5} 5437 * @syscap SystemCapability.ArkUI.ArkUI.Full 5438 * @crossplatform 5439 * @form 5440 * @since 11 5441 */ 5442 /** 5443 * Defines the bias ratio in horizontal and vertical direction. 5444 * 5445 * @type { ?Bias } 5446 * @default {horizontal:0.5,vertical:0.5} 5447 * @syscap SystemCapability.ArkUI.ArkUI.Full 5448 * @crossplatform 5449 * @form 5450 * @atomicservice 5451 * @since 12 5452 */ 5453 bias?: Bias; 5454} 5455 5456/** 5457 * Defines the localized horizontal align param of relative container. 5458 * 5459 * @interface LocalizedHorizontalAlignParam 5460 * @syscap SystemCapability.ArkUI.ArkUI.Full 5461 * @crossplatform 5462 * @atomicservice 5463 * @since 12 5464 */ 5465declare interface LocalizedHorizontalAlignParam { 5466 /** 5467 * The anchor of localized align param. 5468 * 5469 * @type { string } 5470 * @syscap SystemCapability.ArkUI.ArkUI.Full 5471 * @crossplatform 5472 * @atomicservice 5473 * @since 12 5474 */ 5475 anchor: string; 5476 5477 /** 5478 * The align of localized align param. 5479 * 5480 * @type { HorizontalAlign } 5481 * @syscap SystemCapability.ArkUI.ArkUI.Full 5482 * @crossplatform 5483 * @atomicservice 5484 * @since 12 5485 */ 5486 align: HorizontalAlign; 5487} 5488 5489/** 5490 * Defines the localized vertical align param of relative container. 5491 * 5492 * @interface LocalizedVerticalAlignParam 5493 * @syscap SystemCapability.ArkUI.ArkUI.Full 5494 * @crossplatform 5495 * @atomicservice 5496 * @since 12 5497 */ 5498declare interface LocalizedVerticalAlignParam { 5499 /** 5500 * The anchor of localized align param. 5501 * 5502 * @type { string } 5503 * @syscap SystemCapability.ArkUI.ArkUI.Full 5504 * @crossplatform 5505 * @atomicservice 5506 * @since 12 5507 */ 5508 anchor: string; 5509 5510 /** 5511 * The align of localized align param. 5512 * 5513 * @type { VerticalAlign } 5514 * @syscap SystemCapability.ArkUI.ArkUI.Full 5515 * @crossplatform 5516 * @atomicservice 5517 * @since 12 5518 */ 5519 align: VerticalAlign; 5520} 5521 5522/** 5523 * Defines the Localized align rule options of relative container. 5524 * 5525 * @interface LocalizedAlignRuleOptions 5526 * @syscap SystemCapability.ArkUI.ArkUI.Full 5527 * @crossplatform 5528 * @atomicservice 5529 * @since 12 5530 */ 5531declare interface LocalizedAlignRuleOptions { 5532 /** 5533 * The param of start align. 5534 * 5535 * @type { ?LocalizedHorizontalAlignParam } 5536 * @syscap SystemCapability.ArkUI.ArkUI.Full 5537 * @crossplatform 5538 * @atomicservice 5539 * @since 12 5540 */ 5541 start?: LocalizedHorizontalAlignParam; 5542 5543 /** 5544 * The param of end align. 5545 * 5546 * @type { ?LocalizedHorizontalAlignParam } 5547 * @syscap SystemCapability.ArkUI.ArkUI.Full 5548 * @crossplatform 5549 * @atomicservice 5550 * @since 12 5551 */ 5552 end?: LocalizedHorizontalAlignParam; 5553 5554 /** 5555 * The param of middle align. 5556 * 5557 * @type { ?LocalizedHorizontalAlignParam } 5558 * @syscap SystemCapability.ArkUI.ArkUI.Full 5559 * @crossplatform 5560 * @atomicservice 5561 * @since 12 5562 */ 5563 middle?: LocalizedHorizontalAlignParam; 5564 5565 /** 5566 * The param of top align. 5567 * 5568 * @type { ?LocalizedVerticalAlignParam } 5569 * @syscap SystemCapability.ArkUI.ArkUI.Full 5570 * @crossplatform 5571 * @atomicservice 5572 * @since 12 5573 */ 5574 top?: LocalizedVerticalAlignParam; 5575 5576 /** 5577 * The param of bottom align. 5578 * 5579 * @type { ?LocalizedVerticalAlignParam } 5580 * @syscap SystemCapability.ArkUI.ArkUI.Full 5581 * @crossplatform 5582 * @atomicservice 5583 * @since 12 5584 */ 5585 bottom?: LocalizedVerticalAlignParam; 5586 5587 /** 5588 * The param of center align. 5589 * 5590 * @type { ?LocalizedVerticalAlignParam } 5591 * @syscap SystemCapability.ArkUI.ArkUI.Full 5592 * @crossplatform 5593 * @atomicservice 5594 * @since 12 5595 */ 5596 center?: LocalizedVerticalAlignParam; 5597 5598 /** 5599 * Defines the bias ratio in horizontal and vertical direction. 5600 * 5601 * @type { ?Bias } 5602 * @default {horizontal:0.5,vertical:0.5} 5603 * @syscap SystemCapability.ArkUI.ArkUI.Full 5604 * @crossplatform 5605 * @atomicservice 5606 * @since 12 5607 */ 5608 bias?: Bias; 5609} 5610 5611/** 5612 * Defines the style of the chain in relative container. 5613 * 5614 * @enum { number } 5615 * @syscap SystemCapability.ArkUI.ArkUI.Full 5616 * @crossplatform 5617 * @atomicservice 5618 * @since 12 5619 */ 5620declare enum ChainStyle { 5621 /** 5622 * Elements of the chain will be spread out. 5623 * 5624 * @syscap SystemCapability.ArkUI.ArkUI.Full 5625 * @crossplatform 5626 * @atomicservice 5627 * @since 12 5628 */ 5629 SPREAD, 5630 5631 /** 5632 * Elements except chain's head and tail will be spread out. 5633 * 5634 * @syscap SystemCapability.ArkUI.ArkUI.Full 5635 * @crossplatform 5636 * @atomicservice 5637 * @since 12 5638 */ 5639 SPREAD_INSIDE, 5640 5641 /** 5642 * Elements of the chain will be packed together. 5643 * 5644 * @syscap SystemCapability.ArkUI.ArkUI.Full 5645 * @crossplatform 5646 * @atomicservice 5647 * @since 12 5648 */ 5649 PACKED, 5650} 5651 5652/** 5653 * The param of rotate. 5654 * 5655 * @interface RotateOptions 5656 * @syscap SystemCapability.ArkUI.ArkUI.Full 5657 * @since 7 5658 */ 5659/** 5660 * The param of rotate. 5661 * 5662 * @interface RotateOptions 5663 * @syscap SystemCapability.ArkUI.ArkUI.Full 5664 * @form 5665 * @since 9 5666 */ 5667/** 5668 * The param of rotate. 5669 * 5670 * @interface RotateOptions 5671 * @syscap SystemCapability.ArkUI.ArkUI.Full 5672 * @crossplatform 5673 * @form 5674 * @since 10 5675 */ 5676/** 5677 * The param of rotate. 5678 * 5679 * @interface RotateOptions 5680 * @syscap SystemCapability.ArkUI.ArkUI.Full 5681 * @crossplatform 5682 * @form 5683 * @atomicservice 5684 * @since 11 5685 */ 5686declare interface RotateOptions { 5687 /** 5688 * The param of x direction. 5689 * 5690 * @type { ?number } 5691 * @syscap SystemCapability.ArkUI.ArkUI.Full 5692 * @since 7 5693 */ 5694 /** 5695 * The param of x direction. 5696 * 5697 * @type { ?number } 5698 * @syscap SystemCapability.ArkUI.ArkUI.Full 5699 * @form 5700 * @since 9 5701 */ 5702 /** 5703 * The param of x direction. 5704 * 5705 * @type { ?number } 5706 * @syscap SystemCapability.ArkUI.ArkUI.Full 5707 * @crossplatform 5708 * @form 5709 * @since 10 5710 */ 5711 /** 5712 * The param of x direction. 5713 * 5714 * @type { ?number } 5715 * @syscap SystemCapability.ArkUI.ArkUI.Full 5716 * @crossplatform 5717 * @form 5718 * @atomicservice 5719 * @since 11 5720 */ 5721 x?: number; 5722 5723 /** 5724 * The param of y direction. 5725 * 5726 * @type { ?number } 5727 * @syscap SystemCapability.ArkUI.ArkUI.Full 5728 * @since 7 5729 */ 5730 /** 5731 * The param of y direction. 5732 * 5733 * @type { ?number } 5734 * @syscap SystemCapability.ArkUI.ArkUI.Full 5735 * @form 5736 * @since 9 5737 */ 5738 /** 5739 * The param of y direction. 5740 * 5741 * @type { ?number } 5742 * @syscap SystemCapability.ArkUI.ArkUI.Full 5743 * @crossplatform 5744 * @form 5745 * @since 10 5746 */ 5747 /** 5748 * The param of y direction. 5749 * 5750 * @type { ?number } 5751 * @syscap SystemCapability.ArkUI.ArkUI.Full 5752 * @crossplatform 5753 * @form 5754 * @atomicservice 5755 * @since 11 5756 */ 5757 y?: number; 5758 5759 /** 5760 * The param of z direction. 5761 * 5762 * @type { ?number } 5763 * @syscap SystemCapability.ArkUI.ArkUI.Full 5764 * @since 7 5765 */ 5766 /** 5767 * The param of z direction. 5768 * 5769 * @type { ?number } 5770 * @syscap SystemCapability.ArkUI.ArkUI.Full 5771 * @form 5772 * @since 9 5773 */ 5774 /** 5775 * The param of z direction. 5776 * 5777 * @type { ?number } 5778 * @syscap SystemCapability.ArkUI.ArkUI.Full 5779 * @crossplatform 5780 * @form 5781 * @since 10 5782 */ 5783 /** 5784 * The param of z direction. 5785 * 5786 * @type { ?number } 5787 * @syscap SystemCapability.ArkUI.ArkUI.Full 5788 * @crossplatform 5789 * @form 5790 * @atomicservice 5791 * @since 11 5792 */ 5793 z?: number; 5794 5795 /** 5796 * The param of center point of x. 5797 * 5798 * @type { ?(number | string) } 5799 * @syscap SystemCapability.ArkUI.ArkUI.Full 5800 * @since 7 5801 */ 5802 /** 5803 * The param of center point of x. 5804 * 5805 * @type { ?(number | string) } 5806 * @syscap SystemCapability.ArkUI.ArkUI.Full 5807 * @form 5808 * @since 9 5809 */ 5810 /** 5811 * The param of center point of x. 5812 * 5813 * @type { ?(number | string) } 5814 * @syscap SystemCapability.ArkUI.ArkUI.Full 5815 * @crossplatform 5816 * @form 5817 * @since 10 5818 */ 5819 /** 5820 * The param of center point of x. 5821 * 5822 * @type { ?(number | string) } 5823 * @syscap SystemCapability.ArkUI.ArkUI.Full 5824 * @crossplatform 5825 * @form 5826 * @atomicservice 5827 * @since 11 5828 */ 5829 centerX?: number | string; 5830 5831 /** 5832 * The param of center point of y. 5833 * 5834 * @type { ?(number | string) } 5835 * @syscap SystemCapability.ArkUI.ArkUI.Full 5836 * @since 7 5837 */ 5838 /** 5839 * The param of center point of y. 5840 * 5841 * @type { ?(number | string) } 5842 * @syscap SystemCapability.ArkUI.ArkUI.Full 5843 * @since 9 5844 */ 5845 /** 5846 * The param of center point of y. 5847 * 5848 * @type { ?(number | string) } 5849 * @syscap SystemCapability.ArkUI.ArkUI.Full 5850 * @crossplatform 5851 * @form 5852 * @since 10 5853 */ 5854 /** 5855 * The param of center point of y. 5856 * 5857 * @type { ?(number | string) } 5858 * @syscap SystemCapability.ArkUI.ArkUI.Full 5859 * @crossplatform 5860 * @form 5861 * @atomicservice 5862 * @since 11 5863 */ 5864 centerY?: number | string; 5865 5866 /** 5867 * The param of center point of z. 5868 * 5869 * @type { ?number } 5870 * @default 0 5871 * @syscap SystemCapability.ArkUI.ArkUI.Full 5872 * @crossplatform 5873 * @form 5874 * @since 10 5875 */ 5876 /** 5877 * The param of center point of z. 5878 * 5879 * @type { ?number } 5880 * @default 0 5881 * @syscap SystemCapability.ArkUI.ArkUI.Full 5882 * @crossplatform 5883 * @form 5884 * @atomicservice 5885 * @since 11 5886 */ 5887 centerZ?: number; 5888 5889 /** 5890 * The param of camera distance, value range (-∞, ∞). 5891 * @type { ?number } 5892 * @default 0 5893 * @syscap SystemCapability.ArkUI.ArkUI.Full 5894 * @crossplatform 5895 * @form 5896 * @since 10 5897 */ 5898 /** 5899 * The param of camera distance, value range (-∞, ∞). 5900 * @type { ?number } 5901 * @default 0 5902 * @syscap SystemCapability.ArkUI.ArkUI.Full 5903 * @crossplatform 5904 * @form 5905 * @atomicservice 5906 * @since 11 5907 */ 5908 perspective?: number; 5909 5910 /** 5911 * The param of angle. 5912 * 5913 * @type { number | string } 5914 * @syscap SystemCapability.ArkUI.ArkUI.Full 5915 * @since 7 5916 */ 5917 /** 5918 * The param of angle. 5919 * 5920 * @type { number | string } 5921 * @syscap SystemCapability.ArkUI.ArkUI.Full 5922 * @form 5923 * @since 9 5924 */ 5925 /** 5926 * The param of angle. 5927 * 5928 * @type { number | string } 5929 * @syscap SystemCapability.ArkUI.ArkUI.Full 5930 * @crossplatform 5931 * @form 5932 * @since 10 5933 */ 5934 /** 5935 * The param of angle. 5936 * 5937 * @type { number | string } 5938 * @syscap SystemCapability.ArkUI.ArkUI.Full 5939 * @crossplatform 5940 * @form 5941 * @atomicservice 5942 * @since 11 5943 */ 5944 angle: number | string; 5945} 5946 5947/** 5948 * Defines the param of transition. 5949 * 5950 * @interface TransitionOptions 5951 * @syscap SystemCapability.ArkUI.ArkUI.Full 5952 * @since 7 5953 * @deprecated since 10 5954 * @useinstead TransitionEffect 5955 */ 5956declare interface TransitionOptions { 5957 /** 5958 * Defines the param of type. 5959 * 5960 * @type { ?TransitionType } 5961 * @syscap SystemCapability.ArkUI.ArkUI.Full 5962 * @since 7 5963 * @deprecated since 10 5964 */ 5965 type?: TransitionType; 5966 /** 5967 * Defines the param of opacity. 5968 * 5969 * @type { ?number } 5970 * @syscap SystemCapability.ArkUI.ArkUI.Full 5971 * @since 7 5972 * @deprecated since 10 5973 */ 5974 opacity?: number; 5975 /** 5976 * Defines the param of translate. 5977 * 5978 * @type { ?TranslateOptions } 5979 * @syscap SystemCapability.ArkUI.ArkUI.Full 5980 * @since 7 5981 * @deprecated since 10 5982 */ 5983 translate?: TranslateOptions; 5984 /** 5985 * Defines the param of scale. 5986 * 5987 * @type { ?ScaleOptions } 5988 * @syscap SystemCapability.ArkUI.ArkUI.Full 5989 * @since 7 5990 * @deprecated since 10 5991 */ 5992 scale?: ScaleOptions; 5993 /** 5994 * Defines the param of rotate. 5995 * 5996 * @type { ?RotateOptions } 5997 * @syscap SystemCapability.ArkUI.ArkUI.Full 5998 * @since 7 5999 * @deprecated since 10 6000 */ 6001 rotate?: RotateOptions; 6002} 6003 6004/** 6005 * Defines the Edge object. 6006 * 6007 * @enum { number } 6008 * @syscap SystemCapability.ArkUI.ArkUI.Full 6009 * @crossplatform 6010 * @form 6011 * @since 10 6012 */ 6013/** 6014 * Defines the Edge object. 6015 * 6016 * @enum { number } 6017 * @syscap SystemCapability.ArkUI.ArkUI.Full 6018 * @crossplatform 6019 * @form 6020 * @atomicservice 6021 * @since 11 6022 */ 6023declare enum TransitionEdge { 6024 /** 6025 * Top edge 6026 * 6027 * @syscap SystemCapability.ArkUI.ArkUI.Full 6028 * @crossplatform 6029 * @form 6030 * @since 10 6031 */ 6032 /** 6033 * Top edge 6034 * 6035 * @syscap SystemCapability.ArkUI.ArkUI.Full 6036 * @crossplatform 6037 * @form 6038 * @atomicservice 6039 * @since 11 6040 */ 6041 TOP, 6042 6043 /** 6044 * Bottom edge 6045 * 6046 * @syscap SystemCapability.ArkUI.ArkUI.Full 6047 * @crossplatform 6048 * @form 6049 * @since 10 6050 */ 6051 /** 6052 * Bottom edge 6053 * 6054 * @syscap SystemCapability.ArkUI.ArkUI.Full 6055 * @crossplatform 6056 * @form 6057 * @atomicservice 6058 * @since 11 6059 */ 6060 BOTTOM, 6061 6062 /** 6063 * Start edge 6064 * 6065 * @syscap SystemCapability.ArkUI.ArkUI.Full 6066 * @crossplatform 6067 * @form 6068 * @since 10 6069 */ 6070 /** 6071 * Start edge 6072 * 6073 * @syscap SystemCapability.ArkUI.ArkUI.Full 6074 * @crossplatform 6075 * @form 6076 * @atomicservice 6077 * @since 11 6078 */ 6079 START, 6080 6081 /** 6082 * End edge 6083 * 6084 * @syscap SystemCapability.ArkUI.ArkUI.Full 6085 * @crossplatform 6086 * @form 6087 * @since 10 6088 */ 6089 /** 6090 * End edge 6091 * 6092 * @syscap SystemCapability.ArkUI.ArkUI.Full 6093 * @crossplatform 6094 * @form 6095 * @atomicservice 6096 * @since 11 6097 */ 6098 END 6099} 6100 6101/** 6102 * Defines all transition effects. 6103 * 6104 * @typedef { object } TransitionEffects 6105 * @syscap SystemCapability.ArkUI.ArkUI.Full 6106 * @crossplatform 6107 * @form 6108 * @since 10 6109 */ 6110/** 6111 * Defines all transition effects. 6112 * 6113 * @typedef { object } TransitionEffects 6114 * @syscap SystemCapability.ArkUI.ArkUI.Full 6115 * @crossplatform 6116 * @form 6117 * @atomicservice 6118 * @since 11 6119 */ 6120declare type TransitionEffects = { 6121 identity: undefined; 6122 opacity: number; 6123 slideSwitch: undefined; 6124 move: TransitionEdge; 6125 translate: TranslateOptions; 6126 rotate: RotateOptions; 6127 scale: ScaleOptions; 6128 asymmetric: { 6129 appear: TransitionEffect; 6130 disappear: TransitionEffect; 6131 }; 6132}; 6133 6134/** 6135 * Defined the draw modifier of node. Provides draw callbacks for the associated Node. 6136 * 6137 * @syscap SystemCapability.ArkUI.ArkUI.Full 6138 * @crossplatform 6139 * @atomicservice 6140 * @since 12 6141 */ 6142declare class DrawModifier { 6143 /** 6144 * drawBehind Method. Executed before drawing associated Node. 6145 * 6146 * @param { DrawContext } drawContext - The drawContext used to draw. 6147 * @syscap SystemCapability.ArkUI.ArkUI.Full 6148 * @crossplatform 6149 * @atomicservice 6150 * @since 12 6151 */ 6152 drawBehind?(drawContext: DrawContext): void; 6153 6154 /** 6155 * drawContent Method. Executed when associated Node is drawing, the default drawContent method will be replaced 6156 * if this method is set. 6157 * 6158 * @param { DrawContext } drawContext - The drawContext used to draw. 6159 * @syscap SystemCapability.ArkUI.ArkUI.Full 6160 * @crossplatform 6161 * @atomicservice 6162 * @since 12 6163 */ 6164 drawContent?(drawContext: DrawContext): void; 6165 6166 /** 6167 * drawFront Method. Executed after drawing associated Node. 6168 * 6169 * @param { DrawContext } drawContext - The drawContext used to draw. 6170 * @syscap SystemCapability.ArkUI.ArkUI.Full 6171 * @crossplatform 6172 * @atomicservice 6173 * @since 12 6174 */ 6175 drawFront?(drawContext: DrawContext): void; 6176 6177 /** 6178 * Invalidate the component, which will cause a re-render of the component. 6179 * 6180 * @syscap SystemCapability.ArkUI.ArkUI.Full 6181 * @crossplatform 6182 * @atomicservice 6183 * @since 12 6184 */ 6185 invalidate(): void; 6186} 6187 6188/** 6189 * Defines the transition effect 6190 * 6191 * @syscap SystemCapability.ArkUI.ArkUI.Full 6192 * @crossplatform 6193 * @form 6194 * @since 10 6195 */ 6196/** 6197 * Defines the transition effect 6198 * 6199 * @syscap SystemCapability.ArkUI.ArkUI.Full 6200 * @crossplatform 6201 * @form 6202 * @atomicservice 6203 * @since 11 6204 */ 6205declare class TransitionEffect< 6206 Type extends keyof TransitionEffects = keyof TransitionEffects, 6207 Effect extends TransitionEffects[Type] = TransitionEffects[Type] 6208> { 6209 /** 6210 * Disables the transition effect 6211 * 6212 * @type { TransitionEffect<"identity"> } 6213 * @readonly 6214 * @static 6215 * @syscap SystemCapability.ArkUI.ArkUI.Full 6216 * @crossplatform 6217 * @form 6218 * @since 10 6219 */ 6220 /** 6221 * Disables the transition effect 6222 * 6223 * @type { TransitionEffect<"identity"> } 6224 * @readonly 6225 * @static 6226 * @syscap SystemCapability.ArkUI.ArkUI.Full 6227 * @crossplatform 6228 * @form 6229 * @atomicservice 6230 * @since 11 6231 */ 6232 static readonly IDENTITY: TransitionEffect<"identity">; 6233 6234 /** 6235 * Specifies a transition effect with transparency of 0, which is equivalent to TransitionEffect.opacity(0). 6236 * 6237 * @type { TransitionEffect<"opacity"> } 6238 * @readonly 6239 * @static 6240 * @syscap SystemCapability.ArkUI.ArkUI.Full 6241 * @crossplatform 6242 * @form 6243 * @since 10 6244 */ 6245 /** 6246 * Specifies a transition effect with transparency of 0, which is equivalent to TransitionEffect.opacity(0). 6247 * 6248 * @type { TransitionEffect<"opacity"> } 6249 * @readonly 6250 * @static 6251 * @syscap SystemCapability.ArkUI.ArkUI.Full 6252 * @crossplatform 6253 * @form 6254 * @atomicservice 6255 * @since 11 6256 */ 6257 static readonly OPACITY: TransitionEffect<"opacity">; 6258 6259 /** 6260 * Defines a slide transition effect 6261 * 6262 * @type { TransitionEffect< 6263 * "asymmetric", 6264 * {appear: TransitionEffect<"move", TransitionEdge>; 6265 * disappear: TransitionEffect<"move", TransitionEdge>; 6266 * }> } 6267 * @readonly 6268 * @static 6269 * @syscap SystemCapability.ArkUI.ArkUI.Full 6270 * @crossplatform 6271 * @form 6272 * @since 10 6273 */ 6274 /** 6275 * Defines a slide transition effect 6276 * 6277 * @type { TransitionEffect< 6278 * "asymmetric", 6279 * {appear: TransitionEffect<"move", TransitionEdge>; 6280 * disappear: TransitionEffect<"move", TransitionEdge>; 6281 * }> } 6282 * @readonly 6283 * @static 6284 * @syscap SystemCapability.ArkUI.ArkUI.Full 6285 * @crossplatform 6286 * @form 6287 * @atomicservice 6288 * @since 11 6289 */ 6290 static readonly SLIDE: TransitionEffect< 6291 "asymmetric", 6292 { 6293 appear: TransitionEffect<"move", TransitionEdge>; 6294 disappear: TransitionEffect<"move", TransitionEdge>; 6295 } 6296 >; 6297 6298 /** 6299 * Specify a transition effect where the element enters by shrinking first and then expanding as it slides in from the right, 6300 * and exits by shrinking first and then expanding as it slides out to the left, with a minimum scale ratio of 0.8. 6301 * It comes with default animation parameters, which can also be overridden. 6302 * The default animation duration is set to 600ms, and the specified animation curve is cubicBezierCurve(0.24, 0.0, 0.50, 1.0). 6303 * 6304 * @type { TransitionEffect<"slideSwitch"> } 6305 * @readonly 6306 * @static 6307 * @syscap SystemCapability.ArkUI.ArkUI.Full 6308 * @crossplatform 6309 * @form 6310 * @since 10 6311 */ 6312 /** 6313 * Specify a transition effect where the element enters by shrinking first and then expanding as it slides in from the right, 6314 * and exits by shrinking first and then expanding as it slides out to the left, with a minimum scale ratio of 0.8. 6315 * It comes with default animation parameters, which can also be overridden. 6316 * The default animation duration is set to 600ms, and the specified animation curve is cubicBezierCurve(0.24, 0.0, 0.50, 1.0). 6317 * 6318 * @type { TransitionEffect<"slideSwitch"> } 6319 * @readonly 6320 * @static 6321 * @syscap SystemCapability.ArkUI.ArkUI.Full 6322 * @crossplatform 6323 * @form 6324 * @atomicservice 6325 * @since 11 6326 */ 6327 static readonly SLIDE_SWITCH: TransitionEffect<"slideSwitch">; 6328 6329 /** 6330 * Creates a translate transition effect 6331 * 6332 * @param { TranslateOptions } options - translate options 6333 * @returns { TransitionEffect<"translate"> } 6334 * @syscap SystemCapability.ArkUI.ArkUI.Full 6335 * @crossplatform 6336 * @form 6337 * @since 10 6338 */ 6339 /** 6340 * Creates a translate transition effect 6341 * 6342 * @param { TranslateOptions } options - translate options 6343 * @returns { TransitionEffect<"translate"> } 6344 * @syscap SystemCapability.ArkUI.ArkUI.Full 6345 * @crossplatform 6346 * @form 6347 * @atomicservice 6348 * @since 11 6349 */ 6350 static translate(options: TranslateOptions): TransitionEffect<"translate">; 6351 6352 /** 6353 * Creates a rotation transition effect 6354 * 6355 * @param { RotateOptions } options - rotate options 6356 * Set the rotation effect for component transitions when inserting and deleting. 6357 * The value represents the starting rotation point for the inserting animation and the ending rotation point for the deleting animation. 6358 * -x: Horizontal component of the rotational vector. 6359 * -y: Vertical component of the rotational vector. 6360 * -z: Vertical component of the rotational vector. 6361 * -centerX, centerY specify the rotation center point, with default values of "50%", 6362 * meaning that the default rotation center point is the center point of the component. 6363 * -The center point of (0, 0) represents the upper-left corner of the component. 6364 * -centerZ refers to the Z-axis anchor point. The default value of centerZ is 0. 6365 * -perspective indicates the visual distance. The perspective property does not support transition animation. 6366 * @returns { TransitionEffect<"rotate"> } 6367 * @syscap SystemCapability.ArkUI.ArkUI.Full 6368 * @crossplatform 6369 * @form 6370 * @since 10 6371 */ 6372 /** 6373 * Creates a rotation transition effect 6374 * 6375 * @param { RotateOptions } options - rotate options 6376 * Set the rotation effect for component transitions when inserting and deleting. 6377 * The value represents the starting rotation point for the inserting animation and the ending rotation point for the deleting animation. 6378 * -x: Horizontal component of the rotational vector. 6379 * -y: Vertical component of the rotational vector. 6380 * -z: Vertical component of the rotational vector. 6381 * -centerX, centerY specify the rotation center point, with default values of "50%", 6382 * meaning that the default rotation center point is the center point of the component. 6383 * -The center point of (0, 0) represents the upper-left corner of the component. 6384 * -centerZ refers to the Z-axis anchor point. The default value of centerZ is 0. 6385 * -perspective indicates the visual distance. The perspective property does not support transition animation. 6386 * @returns { TransitionEffect<"rotate"> } 6387 * @syscap SystemCapability.ArkUI.ArkUI.Full 6388 * @crossplatform 6389 * @form 6390 * @atomicservice 6391 * @since 11 6392 */ 6393 static rotate(options: RotateOptions): TransitionEffect<"rotate">; 6394 6395 /** 6396 * Creates a scale transition effect 6397 * 6398 * @param { ScaleOptions } options - scale options 6399 * @returns { TransitionEffect<"scale"> } 6400 * @syscap SystemCapability.ArkUI.ArkUI.Full 6401 * @crossplatform 6402 * @form 6403 * @since 10 6404 */ 6405 /** 6406 * Creates a scale transition effect 6407 * 6408 * @param { ScaleOptions } options - scale options 6409 * @returns { TransitionEffect<"scale"> } 6410 * @syscap SystemCapability.ArkUI.ArkUI.Full 6411 * @crossplatform 6412 * @form 6413 * @atomicservice 6414 * @since 11 6415 */ 6416 static scale(options: ScaleOptions): TransitionEffect<"scale">; 6417 6418 /** 6419 * Creates an opacity transition effect with alpha value 6420 * 6421 * @param { number } alpha - opacity alpha value, value range [0, 1]. 6422 * @returns { TransitionEffect<"opacity"> } 6423 * @syscap SystemCapability.ArkUI.ArkUI.Full 6424 * @crossplatform 6425 * @form 6426 * @since 10 6427 */ 6428 /** 6429 * Creates an opacity transition effect with alpha value 6430 * 6431 * @param { number } alpha - opacity alpha value, value range [0, 1]. 6432 * @returns { TransitionEffect<"opacity"> } 6433 * @syscap SystemCapability.ArkUI.ArkUI.Full 6434 * @crossplatform 6435 * @form 6436 * @atomicservice 6437 * @since 11 6438 */ 6439 /** 6440 * Creates an opacity transition effect with alpha value 6441 * 6442 * @param { number } alpha - opacity alpha value, value range [0, 1]. 6443 * Illegal values less than 0 are treated as 0, and illegal values greater than 1 are treated as 1. 6444 * @returns { TransitionEffect<"opacity"> } 6445 * @syscap SystemCapability.ArkUI.ArkUI.Full 6446 * @crossplatform 6447 * @form 6448 * @atomicservice 6449 * @since 12 6450 */ 6451 static opacity(alpha: number): TransitionEffect<"opacity">; 6452 6453 /** 6454 * Creates a move transition effect 6455 * 6456 * @param { TransitionEdge } edge - the edge that component will move to 6457 * @returns { TransitionEffect<"move"> } 6458 * @syscap SystemCapability.ArkUI.ArkUI.Full 6459 * @crossplatform 6460 * @form 6461 * @since 10 6462 */ 6463 /** 6464 * Creates a move transition effect 6465 * 6466 * @param { TransitionEdge } edge - the edge that component will move to 6467 * @returns { TransitionEffect<"move"> } 6468 * @syscap SystemCapability.ArkUI.ArkUI.Full 6469 * @crossplatform 6470 * @form 6471 * @atomicservice 6472 * @since 11 6473 */ 6474 static move(edge: TransitionEdge): TransitionEffect<"move">; 6475 6476 /** 6477 * Creates an asymmetric transition effect 6478 * 6479 * @param { TransitionEffect } appear - the transition which will be attached when the component is appear 6480 * @param { TransitionEffect } disappear - the transition which will be attached when the component is disappear 6481 * @returns { TransitionEffect<"asymmetric"> } 6482 * @syscap SystemCapability.ArkUI.ArkUI.Full 6483 * @crossplatform 6484 * @form 6485 * @since 10 6486 */ 6487 /** 6488 * Creates an asymmetric transition effect 6489 * 6490 * @param { TransitionEffect } appear - the transition which will be attached when the component is appear 6491 * @param { TransitionEffect } disappear - the transition which will be attached when the component is disappear 6492 * @returns { TransitionEffect<"asymmetric"> } 6493 * @syscap SystemCapability.ArkUI.ArkUI.Full 6494 * @crossplatform 6495 * @form 6496 * @atomicservice 6497 * @since 11 6498 */ 6499 static asymmetric( 6500 appear: TransitionEffect, 6501 disappear: TransitionEffect 6502 ): TransitionEffect<"asymmetric">; 6503 6504 /** 6505 * TransitionEffect constructor 6506 * 6507 * @param { Type } type - transition type 6508 * @param { Effect } effect - transition options 6509 * @syscap SystemCapability.ArkUI.ArkUI.Full 6510 * @crossplatform 6511 * @form 6512 * @since 10 6513 */ 6514 /** 6515 * TransitionEffect constructor 6516 * 6517 * @param { Type } type - transition type 6518 * @param { Effect } effect - transition options 6519 * @syscap SystemCapability.ArkUI.ArkUI.Full 6520 * @crossplatform 6521 * @form 6522 * @atomicservice 6523 * @since 11 6524 */ 6525 constructor(type: Type, effect: Effect); 6526 6527 /** 6528 * Set the animation of current transition effect 6529 * 6530 * @param { AnimateParam } value - animation parameters 6531 * @returns { TransitionEffect } 6532 * @syscap SystemCapability.ArkUI.ArkUI.Full 6533 * @crossplatform 6534 * @form 6535 * @since 10 6536 */ 6537 /** 6538 * Set the animation of current transition effect 6539 * 6540 * @param { AnimateParam } value - animation parameters 6541 * @returns { TransitionEffect } 6542 * @syscap SystemCapability.ArkUI.ArkUI.Full 6543 * @crossplatform 6544 * @form 6545 * @atomicservice 6546 * @since 11 6547 */ 6548 animation(value: AnimateParam): TransitionEffect; 6549 6550 /** 6551 * Combines another transition effect 6552 * 6553 * @param { TransitionEffect } transitionEffect - transition effect which is be combined 6554 * @returns { TransitionEffect } combined transition effect 6555 * @syscap SystemCapability.ArkUI.ArkUI.Full 6556 * @crossplatform 6557 * @form 6558 * @since 10 6559 */ 6560 /** 6561 * Combines another transition effect 6562 * 6563 * @param { TransitionEffect } transitionEffect - transition effect which is be combined 6564 * @returns { TransitionEffect } combined transition effect 6565 * @syscap SystemCapability.ArkUI.ArkUI.Full 6566 * @crossplatform 6567 * @form 6568 * @atomicservice 6569 * @since 11 6570 */ 6571 combine(transitionEffect: TransitionEffect): TransitionEffect; 6572} 6573 6574/** 6575 * Define Preview property 6576 * 6577 * @interface PreviewParams 6578 * @syscap SystemCapability.ArkUI.ArkUI.Full 6579 * @form 6580 * @since 9 6581 */ 6582/** 6583 * Define Preview property 6584 * 6585 * @interface PreviewParams 6586 * @syscap SystemCapability.ArkUI.ArkUI.Full 6587 * @crossplatform 6588 * @form 6589 * @atomicservice 6590 * @since 11 6591 */ 6592interface PreviewParams { 6593 /** 6594 * Define Preview title 6595 * 6596 * @type { ?string } 6597 * @syscap SystemCapability.ArkUI.ArkUI.Full 6598 * @form 6599 * @since 9 6600 */ 6601 /** 6602 * Define Preview title 6603 * 6604 * @type { ?string } 6605 * @syscap SystemCapability.ArkUI.ArkUI.Full 6606 * @crossplatform 6607 * @form 6608 * @atomicservice 6609 * @since 11 6610 */ 6611 title?: string; 6612 6613 /** 6614 * Define Preview width 6615 * 6616 * @type { ?number } 6617 * @syscap SystemCapability.ArkUI.ArkUI.Full 6618 * @form 6619 * @since 9 6620 */ 6621 /** 6622 * Define Preview width 6623 * 6624 * @type { ?number } 6625 * @syscap SystemCapability.ArkUI.ArkUI.Full 6626 * @crossplatform 6627 * @form 6628 * @atomicservice 6629 * @since 11 6630 */ 6631 width?: number; 6632 6633 /** 6634 * Define Preview height 6635 * 6636 * @type { ?number } 6637 * @syscap SystemCapability.ArkUI.ArkUI.Full 6638 * @form 6639 * @since 9 6640 */ 6641 /** 6642 * Define Preview height 6643 * 6644 * @type { ?number } 6645 * @syscap SystemCapability.ArkUI.ArkUI.Full 6646 * @crossplatform 6647 * @form 6648 * @atomicservice 6649 * @since 11 6650 */ 6651 height?: number; 6652 6653 /** 6654 * Define Preview locale 6655 * 6656 * @type { ?string } 6657 * @syscap SystemCapability.ArkUI.ArkUI.Full 6658 * @form 6659 * @since 9 6660 */ 6661 /** 6662 * Define Preview locale 6663 * 6664 * @type { ?string } 6665 * @syscap SystemCapability.ArkUI.ArkUI.Full 6666 * @form 6667 * @atomicservice 6668 * @since 11 6669 */ 6670 locale?: string; 6671 6672 /** 6673 * Define Preview colorMode 6674 * 6675 * @type { ?string } 6676 * @syscap SystemCapability.ArkUI.ArkUI.Full 6677 * @form 6678 * @since 9 6679 */ 6680 /** 6681 * Define Preview colorMode 6682 * 6683 * @type { ?string } 6684 * @syscap SystemCapability.ArkUI.ArkUI.Full 6685 * @crossplatform 6686 * @form 6687 * @atomicservice 6688 * @since 11 6689 */ 6690 colorMode?: string; 6691 6692 /** 6693 * Define Preview deviceType 6694 * 6695 * @type { ?string } 6696 * @syscap SystemCapability.ArkUI.ArkUI.Full 6697 * @form 6698 * @since 9 6699 */ 6700 /** 6701 * Define Preview deviceType 6702 * 6703 * @type { ?string } 6704 * @syscap SystemCapability.ArkUI.ArkUI.Full 6705 * @form 6706 * @atomicservice 6707 * @since 11 6708 */ 6709 deviceType?: string; 6710 6711 /** 6712 * Define Preview dpi 6713 * 6714 * @type { ?number } 6715 * @syscap SystemCapability.ArkUI.ArkUI.Full 6716 * @form 6717 * @since 9 6718 */ 6719 /** 6720 * Define Preview dpi 6721 * 6722 * @type { ?number } 6723 * @syscap SystemCapability.ArkUI.ArkUI.Full 6724 * @form 6725 * @atomicservice 6726 * @since 11 6727 */ 6728 dpi?: number; 6729 6730 /** 6731 * Define Preview orientation 6732 * 6733 * @type { ?string } 6734 * @syscap SystemCapability.ArkUI.ArkUI.Full 6735 * @form 6736 * @since 9 6737 */ 6738 /** 6739 * Define Preview orientation 6740 * 6741 * @type { ?string } 6742 * @syscap SystemCapability.ArkUI.ArkUI.Full 6743 * @form 6744 * @atomicservice 6745 * @since 11 6746 */ 6747 orientation?: string; 6748 6749 /** 6750 * Define Preview roundScreen 6751 * 6752 * @type { ?boolean } 6753 * @syscap SystemCapability.ArkUI.ArkUI.Full 6754 * @form 6755 * @since 9 6756 */ 6757 /** 6758 * Define Preview roundScreen 6759 * 6760 * @type { ?boolean } 6761 * @syscap SystemCapability.ArkUI.ArkUI.Full 6762 * @form 6763 * @atomicservice 6764 * @since 11 6765 */ 6766 roundScreen?: boolean; 6767} 6768 6769/** 6770 * ItemDragInfo object description 6771 * 6772 * @interface ItemDragInfo 6773 * @syscap SystemCapability.ArkUI.ArkUI.Full 6774 * @since 8 6775 */ 6776/** 6777 * ItemDragInfo object description 6778 * 6779 * @interface ItemDragInfo 6780 * @syscap SystemCapability.ArkUI.ArkUI.Full 6781 * @crossplatform 6782 * @since 10 6783 */ 6784/** 6785 * ItemDragInfo object description 6786 * 6787 * @interface ItemDragInfo 6788 * @syscap SystemCapability.ArkUI.ArkUI.Full 6789 * @crossplatform 6790 * @atomicservice 6791 * @since 11 6792 */ 6793declare interface ItemDragInfo { 6794 /** 6795 * Obtains the X coordinate of the drag window, in vp. 6796 * 6797 * @type { number } 6798 * @syscap SystemCapability.ArkUI.ArkUI.Full 6799 * @since 8 6800 */ 6801 /** 6802 * Obtains the X coordinate of the drag window, in vp. 6803 * 6804 * @type { number } 6805 * @syscap SystemCapability.ArkUI.ArkUI.Full 6806 * @crossplatform 6807 * @since 10 6808 */ 6809 /** 6810 * Obtains the X coordinate of the drag window, in vp. 6811 * 6812 * @type { number } 6813 * @syscap SystemCapability.ArkUI.ArkUI.Full 6814 * @crossplatform 6815 * @atomicservice 6816 * @since 11 6817 */ 6818 x: number; 6819 6820 /** 6821 * Obtains the Y coordinate of the drag window, in vp. 6822 * 6823 * @type { number } 6824 * @syscap SystemCapability.ArkUI.ArkUI.Full 6825 * @since 8 6826 */ 6827 /** 6828 * Obtains the Y coordinate of the drag window, in vp. 6829 * 6830 * @type { number } 6831 * @syscap SystemCapability.ArkUI.ArkUI.Full 6832 * @crossplatform 6833 * @since 10 6834 */ 6835 /** 6836 * Obtains the Y coordinate of the drag window, in vp. 6837 * 6838 * @type { number } 6839 * @syscap SystemCapability.ArkUI.ArkUI.Full 6840 * @crossplatform 6841 * @atomicservice 6842 * @since 11 6843 */ 6844 y: number; 6845} 6846 6847/** 6848 * Enum of using the effects template mode. 6849 * 6850 * @enum { number } 6851 * @syscap SystemCapability.ArkUI.ArkUI.Full 6852 * @atomicservice 6853 * @since 14 6854 */ 6855declare enum EffectType { 6856 /** 6857 * Define use the effects template defined by the parent effectComponent. 6858 * 6859 * @syscap SystemCapability.ArkUI.ArkUI.Full 6860 * @atomicservice 6861 * @since 14 6862 */ 6863 DEFAULT = 0, 6864 /** 6865 * Define use the effects template defined by the window. 6866 * 6867 * @syscap SystemCapability.ArkUI.ArkUI.Full 6868 * @atomicservice 6869 * @since 14 6870 */ 6871 WINDOW_EFFECT = 1, 6872} 6873 6874/** 6875 * Defines the drag status before drag action. 6876 * 6877 * @enum { number } 6878 * @syscap SystemCapability.ArkUI.ArkUI.Full 6879 * @atomicservice 6880 * @since 12 6881 */ 6882declare enum PreDragStatus { 6883 /** 6884 * Define the status for user prepare to start long press gesture. 6885 * 6886 * @syscap SystemCapability.ArkUI.ArkUI.Full 6887 * @atomicservice 6888 * @since 12 6889 */ 6890 ACTION_DETECTING_STATUS = 0, 6891 6892 /** 6893 * Define the status for user can start drag action. 6894 * 6895 * @syscap SystemCapability.ArkUI.ArkUI.Full 6896 * @atomicservice 6897 * @since 12 6898 */ 6899 READY_TO_TRIGGER_DRAG_ACTION = 1, 6900 6901 /** 6902 * Define the status for dragItem lift animation started. 6903 * 6904 * @syscap SystemCapability.ArkUI.ArkUI.Full 6905 * @atomicservice 6906 * @since 12 6907 */ 6908 PREVIEW_LIFT_STARTED = 2, 6909 6910 /** 6911 * Define the status for dragItem lift animation finished. 6912 * 6913 * @syscap SystemCapability.ArkUI.ArkUI.Full 6914 * @atomicservice 6915 * @since 12 6916 */ 6917 PREVIEW_LIFT_FINISHED = 3, 6918 6919 /** 6920 * Define the status for dragItem landing animation started. 6921 * 6922 * @syscap SystemCapability.ArkUI.ArkUI.Full 6923 * @atomicservice 6924 * @since 12 6925 */ 6926 PREVIEW_LANDING_STARTED = 4, 6927 6928 /** 6929 * Define the status for dragItem landing animation finished. 6930 * 6931 * @syscap SystemCapability.ArkUI.ArkUI.Full 6932 * @atomicservice 6933 * @since 12 6934 */ 6935 PREVIEW_LANDING_FINISHED = 5, 6936 6937 /** 6938 * Define the status for user cancel drag action. 6939 * 6940 * @syscap SystemCapability.ArkUI.ArkUI.Full 6941 * @atomicservice 6942 * @since 12 6943 */ 6944 ACTION_CANCELED_BEFORE_DRAG = 6, 6945 6946 /** 6947 * Define the status for user to sense the availability of drag in advance. 6948 * 6949 * @syscap SystemCapability.ArkUI.ArkUI.Full 6950 * @atomicservice 6951 * @since 18 6952 */ 6953 PREPARING_FOR_DRAG_DETECTION = 7, 6954} 6955 6956/** 6957 * DragItemInfo object description 6958 * 6959 * @interface DragItemInfo 6960 * @syscap SystemCapability.ArkUI.ArkUI.Full 6961 * @since 8 6962 */ 6963/** 6964 * DragItemInfo object description 6965 * 6966 * @interface DragItemInfo 6967 * @syscap SystemCapability.ArkUI.ArkUI.Full 6968 * @atomicservice 6969 * @since 11 6970 */ 6971/** 6972 * DragItemInfo object description 6973 * 6974 * @interface DragItemInfo 6975 * @syscap SystemCapability.ArkUI.ArkUI.Full 6976 * @crossplatform 6977 * @atomicservice 6978 * @since 14 6979 */ 6980declare interface DragItemInfo { 6981 /** 6982 * Uses the pixelMap object for drawing. 6983 * 6984 * @type { ?PixelMap } 6985 * @syscap SystemCapability.ArkUI.ArkUI.Full 6986 * @since 8 6987 */ 6988 /** 6989 * Uses the pixelMap object for drawing. 6990 * 6991 * @type { ?PixelMap } 6992 * @syscap SystemCapability.ArkUI.ArkUI.Full 6993 * @atomicservice 6994 * @since 11 6995 */ 6996 /** 6997 * Uses the pixelMap object for drawing. 6998 * 6999 * @type { ?PixelMap } 7000 * @syscap SystemCapability.ArkUI.ArkUI.Full 7001 * @crossplatform 7002 * @atomicservice 7003 * @since 14 7004 */ 7005 pixelMap?: PixelMap; 7006 7007 /** 7008 * Uses the custom builder for drawing, if pixelMap is set, this value is ignored. 7009 * 7010 * @type { ?CustomBuilder } 7011 * @syscap SystemCapability.ArkUI.ArkUI.Full 7012 * @since 8 7013 */ 7014 /** 7015 * Uses the custom builder for drawing, if pixelMap is set, this value is ignored. 7016 * 7017 * @type { ?CustomBuilder } 7018 * @syscap SystemCapability.ArkUI.ArkUI.Full 7019 * @atomicservice 7020 * @since 11 7021 */ 7022 /** 7023 * Uses the custom builder for drawing, if pixelMap is set, this value is ignored. 7024 * 7025 * @type { ?CustomBuilder } 7026 * @syscap SystemCapability.ArkUI.ArkUI.Full 7027 * @crossplatform 7028 * @atomicservice 7029 * @since 14 7030 */ 7031 builder?: CustomBuilder; 7032 7033 /** 7034 * Sets the extra info for drag event. 7035 * 7036 * @type { ?string } 7037 * @syscap SystemCapability.ArkUI.ArkUI.Full 7038 * @since 8 7039 */ 7040 /** 7041 * Sets the extra info for drag event. 7042 * 7043 * @type { ?string } 7044 * @syscap SystemCapability.ArkUI.ArkUI.Full 7045 * @atomicservice 7046 * @since 11 7047 */ 7048 /** 7049 * Sets the extra info for drag event. 7050 * 7051 * @type { ?string } 7052 * @syscap SystemCapability.ArkUI.ArkUI.Full 7053 * @crossplatform 7054 * @atomicservice 7055 * @since 14 7056 */ 7057 extraInfo?: string; 7058} 7059 7060/** 7061 * Defining animation function. 7062 * 7063 * @param { AnimateParam } value 7064 * @param { function } event 7065 * @syscap SystemCapability.ArkUI.ArkUI.Full 7066 * @since 7 7067 */ 7068/** 7069 * Defining animation function. 7070 * 7071 * @param { AnimateParam } value 7072 * @param { function } event 7073 * @syscap SystemCapability.ArkUI.ArkUI.Full 7074 * @form 7075 * @since 9 7076 */ 7077/** 7078 * Defining animation function. 7079 * 7080 * @param { AnimateParam } value 7081 * @param { function } event 7082 * @syscap SystemCapability.ArkUI.ArkUI.Full 7083 * @crossplatform 7084 * @form 7085 * @since 10 7086 */ 7087/** 7088 * Defining animation function. 7089 * 7090 * @param { AnimateParam } value 7091 * @param { function } event 7092 * @syscap SystemCapability.ArkUI.ArkUI.Full 7093 * @crossplatform 7094 * @form 7095 * @atomicservice 7096 * @since 11 7097 * @deprecated since 18 7098 * @useinstead ohos.arkui.UIContext.UIContext#animateTo 7099 */ 7100declare function animateTo(value: AnimateParam, event: () => void): void; 7101 7102/** 7103 * Define animation functions for immediate distribution. 7104 * 7105 * @param { AnimateParam } value - Set animation effect parameters. 7106 * @param { function } event - Specify the closure function that displays dynamic effects, 7107 * and the system will automatically insert transition animations for state changes caused by the closure function. 7108 * @syscap SystemCapability.ArkUI.ArkUI.Full 7109 * @atomicservice 7110 * @since 12 7111 */ 7112declare function animateToImmediately(value: AnimateParam, event: () => void): void; 7113 7114/** 7115 * Converts a value in vp units to a value in px. 7116 * 7117 * @param { number } value 7118 * @returns { number } 7119 * @syscap SystemCapability.ArkUI.ArkUI.Full 7120 * @since 7 7121 */ 7122/** 7123 * Converts a value in vp units to a value in px. 7124 * 7125 * @param { number } value 7126 * @returns { number } 7127 * @syscap SystemCapability.ArkUI.ArkUI.Full 7128 * @form 7129 * @since 9 7130 */ 7131/** 7132 * Converts a value in vp units to a value in px. 7133 * 7134 * @param { number } value 7135 * @returns { number } 7136 * @syscap SystemCapability.ArkUI.ArkUI.Full 7137 * @crossplatform 7138 * @form 7139 * @since 10 7140 */ 7141/** 7142 * Converts a value in vp units to a value in px. 7143 * 7144 * @param { number } value 7145 * @returns { number } 7146 * @syscap SystemCapability.ArkUI.ArkUI.Full 7147 * @crossplatform 7148 * @form 7149 * @atomicservice 7150 * @since 11 7151 * @deprecated since 18 7152 * @useinstead ohos.arkui.UIContext.UIContext#vp2px 7153 */ 7154declare function vp2px(value: number): number; 7155 7156/** 7157 * Converts a number in units of px to a number in units of vp. 7158 * 7159 * @param { number } value 7160 * @returns { number } 7161 * @syscap SystemCapability.ArkUI.ArkUI.Full 7162 * @since 7 7163 */ 7164/** 7165 * Converts a number in units of px to a number in units of vp. 7166 * 7167 * @param { number } value 7168 * @returns { number } 7169 * @syscap SystemCapability.ArkUI.ArkUI.Full 7170 * @form 7171 * @since 9 7172 */ 7173/** 7174 * Converts a number in units of px to a number in units of vp. 7175 * 7176 * @param { number } value 7177 * @returns { number } 7178 * @syscap SystemCapability.ArkUI.ArkUI.Full 7179 * @crossplatform 7180 * @form 7181 * @since 10 7182 */ 7183/** 7184 * Converts a number in units of px to a number in units of vp. 7185 * 7186 * @param { number } value 7187 * @returns { number } 7188 * @syscap SystemCapability.ArkUI.ArkUI.Full 7189 * @crossplatform 7190 * @form 7191 * @atomicservice 7192 * @since 11 7193 * @deprecated since 18 7194 * @useinstead ohos.arkui.UIContext.UIContext#px2vp 7195 */ 7196declare function px2vp(value: number): number; 7197 7198/** 7199 * Converts a number in fp units to a number in px. 7200 * 7201 * @param { number } value 7202 * @returns { number } 7203 * @syscap SystemCapability.ArkUI.ArkUI.Full 7204 * @since 7 7205 */ 7206/** 7207 * Converts a number in fp units to a number in px. 7208 * 7209 * @param { number } value 7210 * @returns { number } 7211 * @syscap SystemCapability.ArkUI.ArkUI.Full 7212 * @form 7213 * @since 9 7214 */ 7215/** 7216 * Converts a number in fp units to a number in px. 7217 * 7218 * @param { number } value 7219 * @returns { number } 7220 * @syscap SystemCapability.ArkUI.ArkUI.Full 7221 * @crossplatform 7222 * @form 7223 * @since 10 7224 */ 7225/** 7226 * Converts a number in fp units to a number in px. 7227 * 7228 * @param { number } value 7229 * @returns { number } 7230 * @syscap SystemCapability.ArkUI.ArkUI.Full 7231 * @crossplatform 7232 * @form 7233 * @atomicservice 7234 * @since 11 7235 * @deprecated since 18 7236 * @useinstead ohos.arkui.UIContext.UIContext#fp2px 7237 */ 7238declare function fp2px(value: number): number; 7239 7240/** 7241 * Converts a number in units of px to a number in units of fp. 7242 * 7243 * @param { number } value 7244 * @returns { number } 7245 * @syscap SystemCapability.ArkUI.ArkUI.Full 7246 * @since 7 7247 */ 7248/** 7249 * Converts a number in units of px to a number in units of fp. 7250 * 7251 * @param { number } value 7252 * @returns { number } 7253 * @syscap SystemCapability.ArkUI.ArkUI.Full 7254 * @form 7255 * @since 9 7256 */ 7257/** 7258 * Converts a number in units of px to a number in units of fp. 7259 * 7260 * @param { number } value 7261 * @returns { number } 7262 * @syscap SystemCapability.ArkUI.ArkUI.Full 7263 * @crossplatform 7264 * @form 7265 * @since 10 7266 */ 7267/** 7268 * Converts a number in units of px to a number in units of fp. 7269 * 7270 * @param { number } value 7271 * @returns { number } 7272 * @syscap SystemCapability.ArkUI.ArkUI.Full 7273 * @crossplatform 7274 * @form 7275 * @atomicservice 7276 * @since 11 7277 * @deprecated since 18 7278 * @useinstead ohos.arkui.UIContext.UIContext#px2fp 7279 */ 7280declare function px2fp(value: number): number; 7281 7282/** 7283 * Converts a number in units of lpx to a number in units of px. 7284 * 7285 * @param { number } value 7286 * @returns { number } 7287 * @syscap SystemCapability.ArkUI.ArkUI.Full 7288 * @since 7 7289 */ 7290/** 7291 * Converts a number in units of lpx to a number in units of px. 7292 * 7293 * @param { number } value 7294 * @returns { number } 7295 * @syscap SystemCapability.ArkUI.ArkUI.Full 7296 * @form 7297 * @since 9 7298 */ 7299/** 7300 * Converts a number in units of lpx to a number in units of px. 7301 * 7302 * @param { number } value 7303 * @returns { number } 7304 * @syscap SystemCapability.ArkUI.ArkUI.Full 7305 * @crossplatform 7306 * @form 7307 * @since 10 7308 */ 7309/** 7310 * Converts a number in units of lpx to a number in units of px. 7311 * 7312 * @param { number } value 7313 * @returns { number } 7314 * @syscap SystemCapability.ArkUI.ArkUI.Full 7315 * @crossplatform 7316 * @form 7317 * @atomicservice 7318 * @since 11 7319 * @deprecated since 18 7320 * @useinstead ohos.arkui.UIContext.UIContext#lpx2px 7321 */ 7322declare function lpx2px(value: number): number; 7323 7324/** 7325 * Converts a number in units of px to a number in units of lpx. 7326 * 7327 * @param { number } value 7328 * @returns { number } 7329 * @syscap SystemCapability.ArkUI.ArkUI.Full 7330 * @since 7 7331 */ 7332/** 7333 * Converts a number in units of px to a number in units of lpx. 7334 * 7335 * @param { number } value 7336 * @returns { number } 7337 * @syscap SystemCapability.ArkUI.ArkUI.Full 7338 * @form 7339 * @since 9 7340 */ 7341/** 7342 * Converts a number in units of px to a number in units of lpx. 7343 * 7344 * @param { number } value 7345 * @returns { number } 7346 * @syscap SystemCapability.ArkUI.ArkUI.Full 7347 * @crossplatform 7348 * @form 7349 * @since 10 7350 */ 7351/** 7352 * Converts a number in units of px to a number in units of lpx. 7353 * 7354 * @param { number } value 7355 * @returns { number } 7356 * @syscap SystemCapability.ArkUI.ArkUI.Full 7357 * @crossplatform 7358 * @form 7359 * @atomicservice 7360 * @since 11 7361 * @deprecated since 18 7362 * @useinstead ohos.arkui.UIContext.UIContext#px2lpx 7363 */ 7364declare function px2lpx(value: number): number; 7365 7366/** 7367 * Defines the namespace of focus controller. 7368 * 7369 * @namespace focusControl 7370 * @syscap SystemCapability.ArkUI.ArkUI.Full 7371 * @crossplatform 7372 * @form 7373 * @since 9 7374 */ 7375/** 7376 * Defines the namespace of focus controller. 7377 * 7378 * @namespace focusControl 7379 * @syscap SystemCapability.ArkUI.ArkUI.Full 7380 * @crossplatform 7381 * @form 7382 * @atomicservice 7383 * @since 11 7384 */ 7385declare namespace focusControl { 7386 /** 7387 * Request focus to the specific component by param: 'id/key'. 7388 * 7389 * @param { string } value 7390 * @returns { boolean } 7391 * @syscap SystemCapability.ArkUI.ArkUI.Full 7392 * @since 9 7393 */ 7394 /** 7395 * Request focus to the specific component by param: 'id/key'. 7396 * 7397 * @param { string } value 7398 * @returns { boolean } 7399 * @syscap SystemCapability.ArkUI.ArkUI.Full 7400 * @crossplatform 7401 * @since 10 7402 */ 7403 /** 7404 * Request focus to the specific component by param: 'id/key'. 7405 * 7406 * @param { string } value 7407 * @returns { boolean } 7408 * @syscap SystemCapability.ArkUI.ArkUI.Full 7409 * @crossplatform 7410 * @atomicservice 7411 * @since 11 7412 */ 7413 function requestFocus(value: string): boolean; 7414} 7415 7416/** 7417 * Import the PointerStyle type object for setCursor. 7418 * 7419 * @typedef { import('../api/@ohos.multimodalInput.pointer').default.PointerStyle } PointerStyle 7420 * @syscap SystemCapability.ArkUI.ArkUI.Full 7421 * @since 11 7422 */ 7423/** 7424 * Import the PointerStyle type object for setCursor. 7425 * 7426 * @typedef { import('../api/@ohos.multimodalInput.pointer').default.PointerStyle } PointerStyle 7427 * @syscap SystemCapability.ArkUI.ArkUI.Full 7428 * @atomicservice 7429 * @since 12 7430 */ 7431declare type PointerStyle = import('../api/@ohos.multimodalInput.pointer').default.PointerStyle; 7432 7433/** 7434 * CursorControl 7435 * 7436 * @namespace cursorControl 7437 * @syscap SystemCapability.ArkUI.ArkUI.Full 7438 * @since 11 7439 */ 7440/** 7441 * CursorControl 7442 * 7443 * @namespace cursorControl 7444 * @syscap SystemCapability.ArkUI.ArkUI.Full 7445 * @atomicservice 7446 * @since 12 7447 */ 7448declare namespace cursorControl { 7449 7450 /** 7451 * Change the mouse cursor style by param: 'PointerStyle'. 7452 * 7453 * @param { PointerStyle } value 7454 * @syscap SystemCapability.ArkUI.ArkUI.Full 7455 * @crossplatform 7456 * @since 11 7457 */ 7458 /** 7459 * Change the mouse cursor style by param: 'PointerStyle'. 7460 * 7461 * @param { PointerStyle } value 7462 * @syscap SystemCapability.ArkUI.ArkUI.Full 7463 * @crossplatform 7464 * @atomicservice 7465 * @since 12 7466 */ 7467 function setCursor(value: PointerStyle): void; 7468 7469 /** 7470 * Restore the default mouse cursor style. 7471 * 7472 * @syscap SystemCapability.ArkUI.ArkUI.Full 7473 * @crossplatform 7474 * @since 11 7475 */ 7476 /** 7477 * Restore the default mouse cursor style. 7478 * 7479 * @syscap SystemCapability.ArkUI.ArkUI.Full 7480 * @crossplatform 7481 * @atomicservice 7482 * @since 12 7483 */ 7484 function restoreDefault(): void; 7485} 7486 7487/** 7488 * Defines the event target. 7489 * 7490 * @interface EventTarget 7491 * @syscap SystemCapability.ArkUI.ArkUI.Full 7492 * @since 8 7493 */ 7494/** 7495 * Defines the event target. 7496 * 7497 * @interface EventTarget 7498 * @syscap SystemCapability.ArkUI.ArkUI.Full 7499 * @form 7500 * @since 9 7501 */ 7502/** 7503 * Defines the event target. 7504 * 7505 * @interface EventTarget 7506 * @syscap SystemCapability.ArkUI.ArkUI.Full 7507 * @crossplatform 7508 * @form 7509 * @since 10 7510 */ 7511/** 7512 * Defines the event target. 7513 * 7514 * @interface EventTarget 7515 * @syscap SystemCapability.ArkUI.ArkUI.Full 7516 * @crossplatform 7517 * @form 7518 * @atomicservice 7519 * @since 11 7520 */ 7521declare interface EventTarget { 7522 /** 7523 * Area of current target. 7524 * 7525 * @type { Area } 7526 * @syscap SystemCapability.ArkUI.ArkUI.Full 7527 * @since 8 7528 */ 7529 /** 7530 * Area of current target. 7531 * 7532 * @type { Area } 7533 * @syscap SystemCapability.ArkUI.ArkUI.Full 7534 * @form 7535 * @since 9 7536 */ 7537 /** 7538 * Area of current target. 7539 * 7540 * @type { Area } 7541 * @syscap SystemCapability.ArkUI.ArkUI.Full 7542 * @crossplatform 7543 * @form 7544 * @since 10 7545 */ 7546 /** 7547 * Area of current target. 7548 * 7549 * @type { Area } 7550 * @syscap SystemCapability.ArkUI.ArkUI.Full 7551 * @crossplatform 7552 * @form 7553 * @atomicservice 7554 * @since 11 7555 */ 7556 area: Area; 7557 7558 /** 7559 * Node id of current target. 7560 * 7561 * @type { ?string } 7562 * @syscap SystemCapability.ArkUI.ArkUI.Full 7563 * @crossplatform 7564 * @form 7565 * @atomicservice 7566 * @since 15 7567 */ 7568 id?: string; 7569} 7570 7571/** 7572 * Defines the event source type. 7573 * 7574 * @enum { number } 7575 * @syscap SystemCapability.ArkUI.ArkUI.Full 7576 * @since 8 7577 */ 7578/** 7579 * Defines the event source type. 7580 * 7581 * @enum { number } 7582 * @syscap SystemCapability.ArkUI.ArkUI.Full 7583 * @crossplatform 7584 * @since 10 7585 */ 7586/** 7587 * Defines the event source type. 7588 * 7589 * @enum { number } 7590 * @syscap SystemCapability.ArkUI.ArkUI.Full 7591 * @crossplatform 7592 * @atomicservice 7593 * @since 11 7594 */ 7595declare enum SourceType { 7596 /** 7597 * Unknown type. 7598 * 7599 * @syscap SystemCapability.ArkUI.ArkUI.Full 7600 * @since 8 7601 */ 7602 /** 7603 * Unknown type. 7604 * 7605 * @syscap SystemCapability.ArkUI.ArkUI.Full 7606 * @crossplatform 7607 * @since 10 7608 */ 7609 /** 7610 * Unknown type. 7611 * 7612 * @syscap SystemCapability.ArkUI.ArkUI.Full 7613 * @crossplatform 7614 * @atomicservice 7615 * @since 11 7616 */ 7617 Unknown, 7618 7619 /** 7620 * The mouse type. 7621 * 7622 * @syscap SystemCapability.ArkUI.ArkUI.Full 7623 * @since 8 7624 */ 7625 /** 7626 * The mouse type. 7627 * 7628 * @syscap SystemCapability.ArkUI.ArkUI.Full 7629 * @crossplatform 7630 * @since 10 7631 */ 7632 /** 7633 * The mouse type. 7634 * 7635 * @syscap SystemCapability.ArkUI.ArkUI.Full 7636 * @crossplatform 7637 * @atomicservice 7638 * @since 11 7639 */ 7640 Mouse, 7641 7642 /** 7643 * The touch screen type. 7644 * 7645 * @syscap SystemCapability.ArkUI.ArkUI.Full 7646 * @since 8 7647 */ 7648 /** 7649 * The touch screen type. 7650 * 7651 * @syscap SystemCapability.ArkUI.ArkUI.Full 7652 * @crossplatform 7653 * @since 10 7654 */ 7655 /** 7656 * The touch screen type. 7657 * 7658 * @syscap SystemCapability.ArkUI.ArkUI.Full 7659 * @crossplatform 7660 * @atomicservice 7661 * @since 11 7662 */ 7663 TouchScreen, 7664} 7665 7666/** 7667 * Defines the event tool type. 7668 * 7669 * @enum { number } 7670 * @syscap SystemCapability.ArkUI.ArkUI.Full 7671 * @since 9 7672 */ 7673/** 7674 * Defines the event tool type. 7675 * 7676 * @enum { number } 7677 * @syscap SystemCapability.ArkUI.ArkUI.Full 7678 * @crossplatform 7679 * @since 10 7680 */ 7681/** 7682 * Defines the event tool type. 7683 * 7684 * @enum { number } 7685 * @syscap SystemCapability.ArkUI.ArkUI.Full 7686 * @crossplatform 7687 * @atomicservice 7688 * @since 11 7689 */ 7690declare enum SourceTool { 7691 /** 7692 * Unknown type. 7693 * 7694 * @syscap SystemCapability.ArkUI.ArkUI.Full 7695 * @since 9 7696 */ 7697 /** 7698 * Unknown type. 7699 * 7700 * @syscap SystemCapability.ArkUI.ArkUI.Full 7701 * @crossplatform 7702 * @since 10 7703 */ 7704 /** 7705 * Unknown type. 7706 * 7707 * @syscap SystemCapability.ArkUI.ArkUI.Full 7708 * @crossplatform 7709 * @atomicservice 7710 * @since 11 7711 */ 7712 Unknown, 7713 7714 /** 7715 * The finger type. 7716 * 7717 * @syscap SystemCapability.ArkUI.ArkUI.Full 7718 * @since 9 7719 */ 7720 /** 7721 * The finger type. 7722 * 7723 * @syscap SystemCapability.ArkUI.ArkUI.Full 7724 * @crossplatform 7725 * @since 10 7726 */ 7727 /** 7728 * The finger type. 7729 * 7730 * @syscap SystemCapability.ArkUI.ArkUI.Full 7731 * @crossplatform 7732 * @atomicservice 7733 * @since 11 7734 */ 7735 Finger, 7736 7737 /** 7738 * The pen type. 7739 * 7740 * @syscap SystemCapability.ArkUI.ArkUI.Full 7741 * @since 9 7742 */ 7743 /** 7744 * The pen type. 7745 * 7746 * @syscap SystemCapability.ArkUI.ArkUI.Full 7747 * @crossplatform 7748 * @since 10 7749 */ 7750 /** 7751 * The pen type. 7752 * 7753 * @syscap SystemCapability.ArkUI.ArkUI.Full 7754 * @crossplatform 7755 * @atomicservice 7756 * @since 11 7757 */ 7758 Pen, 7759 7760 /** 7761 * The mouse type. 7762 * 7763 * @syscap SystemCapability.ArkUI.ArkUI.Full 7764 * @crossplatform 7765 * @atomicservice 7766 * @since 12 7767 */ 7768 MOUSE, 7769 7770 /** 7771 * The touchpad type. 7772 * 7773 * @syscap SystemCapability.ArkUI.ArkUI.Full 7774 * @crossplatform 7775 * @atomicservice 7776 * @since 12 7777 */ 7778 TOUCHPAD, 7779 7780 /** 7781 * The joystick type. 7782 * 7783 * @syscap SystemCapability.ArkUI.ArkUI.Full 7784 * @crossplatform 7785 * @atomicservice 7786 * @since 12 7787 */ 7788 JOYSTICK, 7789} 7790 7791/** 7792 * Defines the Border Image Repeat Mode. 7793 * 7794 * @enum { number } 7795 * @syscap SystemCapability.ArkUI.ArkUI.Full 7796 * @form 7797 * @since 9 7798 */ 7799/** 7800 * Defines the Border Image Repeat Mode. 7801 * 7802 * @enum { number } 7803 * @syscap SystemCapability.ArkUI.ArkUI.Full 7804 * @crossplatform 7805 * @form 7806 * @since 10 7807 */ 7808/** 7809 * Defines the Border Image Repeat Mode. 7810 * 7811 * @enum { number } 7812 * @syscap SystemCapability.ArkUI.ArkUI.Full 7813 * @crossplatform 7814 * @form 7815 * @atomicservice 7816 * @since 11 7817 */ 7818declare enum RepeatMode { 7819 /** 7820 * Repeat mode. 7821 * 7822 * @syscap SystemCapability.ArkUI.ArkUI.Full 7823 * @form 7824 * @since 9 7825 */ 7826 /** 7827 * Repeat mode. 7828 * 7829 * @syscap SystemCapability.ArkUI.ArkUI.Full 7830 * @crossplatform 7831 * @form 7832 * @since 10 7833 */ 7834 /** 7835 * Repeat mode. 7836 * 7837 * @syscap SystemCapability.ArkUI.ArkUI.Full 7838 * @crossplatform 7839 * @form 7840 * @atomicservice 7841 * @since 11 7842 */ 7843 Repeat, 7844 7845 /** 7846 * Stretch mode. 7847 * 7848 * @syscap SystemCapability.ArkUI.ArkUI.Full 7849 * @form 7850 * @since 9 7851 */ 7852 /** 7853 * Stretch mode. 7854 * 7855 * @syscap SystemCapability.ArkUI.ArkUI.Full 7856 * @crossplatform 7857 * @form 7858 * @since 10 7859 */ 7860 /** 7861 * Stretch mode. 7862 * 7863 * @syscap SystemCapability.ArkUI.ArkUI.Full 7864 * @crossplatform 7865 * @form 7866 * @atomicservice 7867 * @since 11 7868 */ 7869 Stretch, 7870 7871 /** 7872 * Round mode. 7873 * 7874 * @syscap SystemCapability.ArkUI.ArkUI.Full 7875 * @form 7876 * @since 9 7877 */ 7878 /** 7879 * Round mode. 7880 * 7881 * @syscap SystemCapability.ArkUI.ArkUI.Full 7882 * @crossplatform 7883 * @form 7884 * @since 10 7885 */ 7886 /** 7887 * Round mode. 7888 * 7889 * @syscap SystemCapability.ArkUI.ArkUI.Full 7890 * @crossplatform 7891 * @form 7892 * @atomicservice 7893 * @since 11 7894 */ 7895 Round, 7896 7897 /** 7898 * Space mode. 7899 * 7900 * @syscap SystemCapability.ArkUI.ArkUI.Full 7901 * @form 7902 * @since 9 7903 */ 7904 /** 7905 * Space mode. 7906 * 7907 * @syscap SystemCapability.ArkUI.ArkUI.Full 7908 * @crossplatform 7909 * @form 7910 * @since 10 7911 */ 7912 /** 7913 * Space mode. 7914 * 7915 * @syscap SystemCapability.ArkUI.ArkUI.Full 7916 * @crossplatform 7917 * @form 7918 * @atomicservice 7919 * @since 11 7920 */ 7921 Space, 7922} 7923 7924/** 7925 * enum Blur style 7926 * 7927 * @enum { number } 7928 * @syscap SystemCapability.ArkUI.ArkUI.Full 7929 * @form 7930 * @since 9 7931 */ 7932/** 7933 * enum Blur style 7934 * 7935 * @enum { number } 7936 * @syscap SystemCapability.ArkUI.ArkUI.Full 7937 * @crossplatform 7938 * @form 7939 * @since 10 7940 */ 7941/** 7942 * enum Blur style 7943 * 7944 * @enum { number } 7945 * @syscap SystemCapability.ArkUI.ArkUI.Full 7946 * @crossplatform 7947 * @form 7948 * @atomicservice 7949 * @since 11 7950 */ 7951declare enum BlurStyle { 7952 /** 7953 * Defines the thin card material. 7954 * 7955 * @syscap SystemCapability.ArkUI.ArkUI.Full 7956 * @form 7957 * @since 9 7958 */ 7959 /** 7960 * Defines the thin card material. 7961 * 7962 * @syscap SystemCapability.ArkUI.ArkUI.Full 7963 * @crossplatform 7964 * @form 7965 * @since 10 7966 */ 7967 /** 7968 * Defines the thin card material. 7969 * 7970 * @syscap SystemCapability.ArkUI.ArkUI.Full 7971 * @crossplatform 7972 * @form 7973 * @atomicservice 7974 * @since 11 7975 */ 7976 Thin, 7977 7978 /** 7979 * Defines the regular card material. 7980 * 7981 * @syscap SystemCapability.ArkUI.ArkUI.Full 7982 * @form 7983 * @since 9 7984 */ 7985 /** 7986 * Defines the regular card material. 7987 * 7988 * @syscap SystemCapability.ArkUI.ArkUI.Full 7989 * @crossplatform 7990 * @form 7991 * @since 10 7992 */ 7993 /** 7994 * Defines the regular card material. 7995 * 7996 * @syscap SystemCapability.ArkUI.ArkUI.Full 7997 * @crossplatform 7998 * @form 7999 * @atomicservice 8000 * @since 11 8001 */ 8002 Regular, 8003 8004 /** 8005 * Defines the thick card material. 8006 * 8007 * @syscap SystemCapability.ArkUI.ArkUI.Full 8008 * @form 8009 * @since 9 8010 */ 8011 /** 8012 * Defines the thick card material. 8013 * 8014 * @syscap SystemCapability.ArkUI.ArkUI.Full 8015 * @crossplatform 8016 * @form 8017 * @since 10 8018 */ 8019 /** 8020 * Defines the thick card material. 8021 * 8022 * @syscap SystemCapability.ArkUI.ArkUI.Full 8023 * @crossplatform 8024 * @form 8025 * @atomicservice 8026 * @since 11 8027 */ 8028 Thick, 8029 8030 /** 8031 * Defines the thin background material. 8032 * 8033 * @syscap SystemCapability.ArkUI.ArkUI.Full 8034 * @crossplatform 8035 * @since 10 8036 */ 8037 /** 8038 * Defines the thin background material. 8039 * 8040 * @syscap SystemCapability.ArkUI.ArkUI.Full 8041 * @crossplatform 8042 * @form 8043 * @atomicservice 8044 * @since 11 8045 */ 8046 BACKGROUND_THIN, 8047 8048 /** 8049 * Defines the thin regular material. 8050 * 8051 * @syscap SystemCapability.ArkUI.ArkUI.Full 8052 * @crossplatform 8053 * @since 10 8054 */ 8055 /** 8056 * Defines the thin regular material. 8057 * 8058 * @syscap SystemCapability.ArkUI.ArkUI.Full 8059 * @crossplatform 8060 * @form 8061 * @atomicservice 8062 * @since 11 8063 */ 8064 BACKGROUND_REGULAR, 8065 8066 /** 8067 * Defines the thin thick material. 8068 * 8069 * @syscap SystemCapability.ArkUI.ArkUI.Full 8070 * @crossplatform 8071 * @since 10 8072 */ 8073 /** 8074 * Defines the thin thick material. 8075 * 8076 * @syscap SystemCapability.ArkUI.ArkUI.Full 8077 * @crossplatform 8078 * @form 8079 * @atomicservice 8080 * @since 11 8081 */ 8082 BACKGROUND_THICK, 8083 8084 /** 8085 * Defines the thin ultra thick material. 8086 * 8087 * @syscap SystemCapability.ArkUI.ArkUI.Full 8088 * @crossplatform 8089 * @since 10 8090 */ 8091 /** 8092 * Defines the thin ultra thick material. 8093 * 8094 * @syscap SystemCapability.ArkUI.ArkUI.Full 8095 * @crossplatform 8096 * @form 8097 * @atomicservice 8098 * @since 11 8099 */ 8100 BACKGROUND_ULTRA_THICK, 8101 8102 /** 8103 * Defines none material. 8104 * 8105 * @syscap SystemCapability.ArkUI.ArkUI.Full 8106 * @crossplatform 8107 * @form 8108 * @since 10 8109 */ 8110 /** 8111 * Defines none material. 8112 * 8113 * @syscap SystemCapability.ArkUI.ArkUI.Full 8114 * @crossplatform 8115 * @form 8116 * @atomicservice 8117 * @since 11 8118 */ 8119 NONE, 8120 8121 /** 8122 * Defines the ultra thin component material. 8123 * 8124 * @syscap SystemCapability.ArkUI.ArkUI.Full 8125 * @crossplatform 8126 * @form 8127 * @since 11 8128 */ 8129 /** 8130 * Defines the ultra thin component material. 8131 * 8132 * @syscap SystemCapability.ArkUI.ArkUI.Full 8133 * @crossplatform 8134 * @form 8135 * @atomicservice 8136 * @since 12 8137 */ 8138 COMPONENT_ULTRA_THIN = 8, 8139 8140 /** 8141 * Defines the thin component material. 8142 * 8143 * @syscap SystemCapability.ArkUI.ArkUI.Full 8144 * @crossplatform 8145 * @form 8146 * @since 11 8147 */ 8148 /** 8149 * Defines the thin component material. 8150 * 8151 * @syscap SystemCapability.ArkUI.ArkUI.Full 8152 * @crossplatform 8153 * @form 8154 * @atomicservice 8155 * @since 12 8156 */ 8157 COMPONENT_THIN = 9, 8158 8159 /** 8160 * Defines the regular component material. 8161 * 8162 * @syscap SystemCapability.ArkUI.ArkUI.Full 8163 * @crossplatform 8164 * @form 8165 * @since 11 8166 */ 8167 /** 8168 * Defines the regular component material. 8169 * 8170 * @syscap SystemCapability.ArkUI.ArkUI.Full 8171 * @crossplatform 8172 * @form 8173 * @atomicservice 8174 * @since 12 8175 */ 8176 COMPONENT_REGULAR = 10, 8177 8178 /** 8179 * Defines the thick component material. 8180 * 8181 * @syscap SystemCapability.ArkUI.ArkUI.Full 8182 * @crossplatform 8183 * @form 8184 * @since 11 8185 */ 8186 /** 8187 * Defines the thick component material. 8188 * 8189 * @syscap SystemCapability.ArkUI.ArkUI.Full 8190 * @crossplatform 8191 * @form 8192 * @atomicservice 8193 * @since 12 8194 */ 8195 COMPONENT_THICK = 11, 8196 8197 /** 8198 * Defines the ultra thick component material. 8199 * 8200 * @syscap SystemCapability.ArkUI.ArkUI.Full 8201 * @crossplatform 8202 * @form 8203 * @since 11 8204 */ 8205 /** 8206 * Defines the ultra thick component material. 8207 * 8208 * @syscap SystemCapability.ArkUI.ArkUI.Full 8209 * @crossplatform 8210 * @form 8211 * @atomicservice 8212 * @since 12 8213 */ 8214 COMPONENT_ULTRA_THICK = 12, 8215} 8216 8217/** 8218 * Enumerates the policies for activating the blur style. 8219 * 8220 * @enum { number } 8221 * @syscap SystemCapability.ArkUI.ArkUI.Full 8222 * @crossplatform 8223 * @atomicservice 8224 * @since 14 8225 */ 8226declare enum BlurStyleActivePolicy { 8227 /** 8228 * The component has the blur effect only when the window is focused. 8229 * 8230 * @syscap SystemCapability.ArkUI.ArkUI.Full 8231 * @crossplatform 8232 * @atomicservice 8233 * @since 14 8234 */ 8235 FOLLOWS_WINDOW_ACTIVE_STATE = 0, 8236 8237 /** 8238 * The component always has the blur effect, regardless of whether the window is focused. 8239 * 8240 * @syscap SystemCapability.ArkUI.ArkUI.Full 8241 * @crossplatform 8242 * @atomicservice 8243 * @since 14 8244 */ 8245 ALWAYS_ACTIVE = 1, 8246 8247 /** 8248 * The component does not have the blur effect, regardless of whether the window is focused. 8249 * 8250 * @syscap SystemCapability.ArkUI.ArkUI.Full 8251 * @crossplatform 8252 * @atomicservice 8253 * @since 14 8254 */ 8255 ALWAYS_INACTIVE = 2, 8256} 8257 8258/** 8259 * enum color mode 8260 * 8261 * @enum { number } 8262 * @syscap SystemCapability.ArkUI.ArkUI.Full 8263 * @crossplatform 8264 * @since 10 8265 */ 8266/** 8267 * enum color mode 8268 * 8269 * @enum { number } 8270 * @syscap SystemCapability.ArkUI.ArkUI.Full 8271 * @crossplatform 8272 * @atomicservice 8273 * @since 11 8274 */ 8275declare enum ThemeColorMode { 8276 /** 8277 * Defines the mode which is follow up with system. 8278 * 8279 * @syscap SystemCapability.ArkUI.ArkUI.Full 8280 * @crossplatform 8281 * @since 10 8282 */ 8283 /** 8284 * Defines the mode which is follow up with system. 8285 * 8286 * @syscap SystemCapability.ArkUI.ArkUI.Full 8287 * @crossplatform 8288 * @atomicservice 8289 * @since 11 8290 */ 8291 SYSTEM, 8292 8293 /** 8294 * Defines the light mode. 8295 * 8296 * @syscap SystemCapability.ArkUI.ArkUI.Full 8297 * @crossplatform 8298 * @since 10 8299 */ 8300 /** 8301 * Defines the light mode. 8302 * 8303 * @syscap SystemCapability.ArkUI.ArkUI.Full 8304 * @crossplatform 8305 * @atomicservice 8306 * @since 11 8307 */ 8308 LIGHT, 8309 8310 /** 8311 * Defines the dark mode. 8312 * 8313 * @syscap SystemCapability.ArkUI.ArkUI.Full 8314 * @crossplatform 8315 * @since 10 8316 */ 8317 /** 8318 * Defines the dark mode. 8319 * 8320 * @syscap SystemCapability.ArkUI.ArkUI.Full 8321 * @crossplatform 8322 * @atomicservice 8323 * @since 11 8324 */ 8325 DARK, 8326} 8327 8328/** 8329 * Defines adaptive color 8330 * 8331 * @enum { number } 8332 * @syscap SystemCapability.ArkUI.ArkUI.Full 8333 * @crossplatform 8334 * @since 10 8335 */ 8336/** 8337 * Defines adaptive color 8338 * 8339 * @enum { number } 8340 * @syscap SystemCapability.ArkUI.ArkUI.Full 8341 * @crossplatform 8342 * @atomicservice 8343 * @since 11 8344 */ 8345declare enum AdaptiveColor { 8346 /** 8347 * Defines the fixed value color adaptive mode. 8348 * 8349 * @syscap SystemCapability.ArkUI.ArkUI.Full 8350 * @crossplatform 8351 * @since 10 8352 */ 8353 /** 8354 * Defines the fixed value color adaptive mode. 8355 * 8356 * @syscap SystemCapability.ArkUI.ArkUI.Full 8357 * @crossplatform 8358 * @atomicservice 8359 * @since 11 8360 */ 8361 DEFAULT, 8362 8363 /** 8364 * Defines the background average color adaptive mode. 8365 * 8366 * @syscap SystemCapability.ArkUI.ArkUI.Full 8367 * @crossplatform 8368 * @since 10 8369 */ 8370 /** 8371 * Defines the background average color adaptive mode. 8372 * 8373 * @syscap SystemCapability.ArkUI.ArkUI.Full 8374 * @crossplatform 8375 * @atomicservice 8376 * @since 11 8377 */ 8378 AVERAGE, 8379} 8380 8381/** 8382 * Defines modal transition type. 8383 * 8384 * @enum { number } 8385 * @syscap SystemCapability.ArkUI.ArkUI.Full 8386 * @crossplatform 8387 * @since 10 8388 */ 8389/** 8390 * Defines modal transition type. 8391 * 8392 * @enum { number } 8393 * @syscap SystemCapability.ArkUI.ArkUI.Full 8394 * @crossplatform 8395 * @atomicservice 8396 * @since 11 8397 */ 8398declare enum ModalTransition { 8399 /** 8400 * Use default animation. 8401 * 8402 * @syscap SystemCapability.ArkUI.ArkUI.Full 8403 * @crossplatform 8404 * @since 10 8405 */ 8406 /** 8407 * Use default animation. 8408 * 8409 * @syscap SystemCapability.ArkUI.ArkUI.Full 8410 * @crossplatform 8411 * @atomicservice 8412 * @since 11 8413 */ 8414 DEFAULT, 8415 8416 /** 8417 * Use none animation. 8418 * 8419 * @syscap SystemCapability.ArkUI.ArkUI.Full 8420 * @crossplatform 8421 * @since 10 8422 */ 8423 /** 8424 * Use none animation. 8425 * 8426 * @syscap SystemCapability.ArkUI.ArkUI.Full 8427 * @crossplatform 8428 * @atomicservice 8429 * @since 11 8430 */ 8431 NONE, 8432 8433 /** 8434 * Use alpha animation. 8435 * 8436 * @syscap SystemCapability.ArkUI.ArkUI.Full 8437 * @crossplatform 8438 * @since 10 8439 */ 8440 /** 8441 * Use alpha animation. 8442 * 8443 * @syscap SystemCapability.ArkUI.ArkUI.Full 8444 * @crossplatform 8445 * @atomicservice 8446 * @since 11 8447 */ 8448 ALPHA, 8449} 8450 8451/** 8452 * Defines the options of backgroundBlurStyle 8453 * 8454 * @extends BlurStyleOption 8455 * @interface BackgroundBlurStyleOptions 8456 * @syscap SystemCapability.ArkUI.ArkUI.Full 8457 * @crossplatform 8458 * @since 10 8459 */ 8460/** 8461 * Defines the options of backgroundBlurStyle 8462 * 8463 * @extends BlurStyleOption 8464 * @interface BackgroundBlurStyleOptions 8465 * @syscap SystemCapability.ArkUI.ArkUI.Full 8466 * @crossplatform 8467 * @atomicservice 8468 * @since 11 8469 */ 8470declare interface BackgroundBlurStyleOptions extends BlurStyleOptions { 8471 /** 8472 * Defines the policy for activating the blur style. 8473 * 8474 * @type { ?BlurStyleActivePolicy } 8475 * @default BlurStyleActivePolicy.ALWAYS_ACTIVE 8476 * @syscap SystemCapability.ArkUI.ArkUI.Full 8477 * @crossplatform 8478 * @atomicservice 8479 * @since 14 8480 */ 8481 policy?: BlurStyleActivePolicy; 8482 8483 /** 8484 * Color of the background effect when the window is not focused. 8485 * 8486 * @type { ?ResourceColor } 8487 * @default Color.Transparent 8488 * @syscap SystemCapability.ArkUI.ArkUI.Full 8489 * @crossplatform 8490 * @atomicservice 8491 * @since 14 8492 */ 8493 inactiveColor?: ResourceColor; 8494} 8495 8496/** 8497 * Defines the options of ForegroundBlurStyle 8498 * 8499 * @extends BlurStyleOptions 8500 * @interface ForegroundBlurStyleOptions 8501 * @syscap SystemCapability.ArkUI.ArkUI.Full 8502 * @crossplatform 8503 * @since 10 8504 */ 8505/** 8506 * Defines the options of ForegroundBlurStyle 8507 * 8508 * @extends BlurStyleOptions 8509 * @interface ForegroundBlurStyleOptions 8510 * @syscap SystemCapability.ArkUI.ArkUI.Full 8511 * @crossplatform 8512 * @atomicservice 8513 * @since 11 8514 */ 8515declare interface ForegroundBlurStyleOptions extends BlurStyleOptions {} 8516 8517 8518/** 8519 * Defines the options of blur 8520 * 8521 * @interface BlurOptions 8522 * @syscap SystemCapability.ArkUI.ArkUI.Full 8523 * @crossplatform 8524 * @since 11 8525 */ 8526/** 8527 * Defines the options of blur 8528 * 8529 * @interface BlurOptions 8530 * @syscap SystemCapability.ArkUI.ArkUI.Full 8531 * @crossplatform 8532 * @atomicservice 8533 * @since 12 8534 */ 8535declare interface BlurOptions { 8536 /** 8537 * Fuzzy gray scale parameter. 8538 * @type { [number, number] } 8539 * @syscap SystemCapability.ArkUI.ArkUI.Full 8540 * @crossplatform 8541 * @since 11 8542 */ 8543 /** 8544 * Fuzzy gray scale parameter. 8545 * @type { [number, number] } 8546 * @syscap SystemCapability.ArkUI.ArkUI.Full 8547 * @crossplatform 8548 * @atomicservice 8549 * @since 12 8550 */ 8551 grayscale: [number, number]; 8552} 8553 8554/** 8555 * Defines the options of blurStyle 8556 * 8557 * @interface BlurStyleOptions 8558 * @syscap SystemCapability.ArkUI.ArkUI.Full 8559 * @crossplatform 8560 * @since 10 8561 */ 8562/** 8563 * Defines the options of blurStyle 8564 * 8565 * @interface BlurStyleOptions 8566 * @syscap SystemCapability.ArkUI.ArkUI.Full 8567 * @crossplatform 8568 * @atomicservice 8569 * @since 11 8570 */ 8571declare interface BlurStyleOptions { 8572 /** 8573 * color mode 8574 * 8575 * @type { ?ThemeColorMode } 8576 * @default ThemeColorMode.SYSTEM 8577 * @syscap SystemCapability.ArkUI.ArkUI.Full 8578 * @since 10 8579 */ 8580 /** 8581 * color mode 8582 * 8583 * @type { ?ThemeColorMode } 8584 * @default ThemeColorMode.SYSTEM 8585 * @syscap SystemCapability.ArkUI.ArkUI.Full 8586 * @crossplatform 8587 * @atomicservice 8588 * @since 11 8589 */ 8590 colorMode?: ThemeColorMode; 8591 8592 /** 8593 * adaptive color 8594 * 8595 * @type { ?AdaptiveColor } 8596 * @default AdaptiveColor.DEFAULT 8597 * @syscap SystemCapability.ArkUI.ArkUI.Full 8598 * @since 10 8599 */ 8600 /** 8601 * adaptive color 8602 * 8603 * @type { ?AdaptiveColor } 8604 * @default AdaptiveColor.DEFAULT 8605 * @syscap SystemCapability.ArkUI.ArkUI.Full 8606 * @crossplatform 8607 * @atomicservice 8608 * @since 11 8609 */ 8610 adaptiveColor?: AdaptiveColor; 8611 8612 /** 8613 * Define the scale of blur effect. 8614 * The range of value is [0, 1]. The larger the value, the more obvious the blurring effect. 8615 * A value of 0 indicates no blur effect and a value of 1 indicates a complete blur effect. 8616 * 8617 * @type { ?number } 8618 * @default 1.0 8619 * @syscap SystemCapability.ArkUI.ArkUI.Full 8620 * @atomicservice 8621 * @since 12 8622 */ 8623 scale?: number; 8624 8625 /** 8626 * Defines the options of blur 8627 * 8628 * @type { ?BlurOptions } 8629 * @default { grayScale: [0,0] } 8630 * @syscap SystemCapability.ArkUI.ArkUI.Full 8631 * @crossplatform 8632 * @since 11 8633 */ 8634 /** 8635 * Defines the options of blur 8636 * 8637 * @type { ?BlurOptions } 8638 * @default { grayScale: [0,0] } 8639 * @syscap SystemCapability.ArkUI.ArkUI.Full 8640 * @crossplatform 8641 * @atomicservice 8642 * @since 12 8643 */ 8644 blurOptions?: BlurOptions; 8645} 8646 8647/** 8648 * Defines the options of BackgroundEffect 8649 * 8650 * @interface BackgroundEffectOptions 8651 * @syscap SystemCapability.ArkUI.ArkUI.Full 8652 * @crossplatform 8653 * @since 11 8654 */ 8655/** 8656 * Defines the options of BackgroundEffect 8657 * 8658 * @interface BackgroundEffectOptions 8659 * @syscap SystemCapability.ArkUI.ArkUI.Full 8660 * @crossplatform 8661 * @atomicservice 8662 * @since 12 8663 */ 8664declare interface BackgroundEffectOptions { 8665 8666 /** 8667 * Define the radius size of BackgroundEffect.The range of this value is [0, ∞) 8668 * 8669 * @type { number } 8670 * @syscap SystemCapability.ArkUI.ArkUI.Full 8671 * @crossplatform 8672 * @since 11 8673 */ 8674 /** 8675 * Define the radius size of BackgroundEffect.The range of this value is [0, ∞) 8676 * 8677 * @type { number } 8678 * @syscap SystemCapability.ArkUI.ArkUI.Full 8679 * @crossplatform 8680 * @atomicservice 8681 * @since 12 8682 */ 8683 radius: number; 8684 8685 /** 8686 * Define the saturation of BackgroundEffect. Value range [0, ∞) 8687 * 8688 * @type { ?number } 8689 * @default 1 8690 * @syscap SystemCapability.ArkUI.ArkUI.Full 8691 * @crossplatform 8692 * @since 11 8693 */ 8694 /** 8695 * Define the saturation of BackgroundEffect. Value range [0, ∞) 8696 * 8697 * @type { ?number } 8698 * @default 1 8699 * @syscap SystemCapability.ArkUI.ArkUI.Full 8700 * @crossplatform 8701 * @atomicservice 8702 * @since 12 8703 */ 8704 saturation?: number; 8705 8706 /** 8707 * Define the brightness of BackgroundEffect. Value range [0, ∞) 8708 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 8709 * @type { ?number } 8710 * @default 1 8711 * @syscap SystemCapability.ArkUI.ArkUI.Full 8712 * @crossplatform 8713 * @since 11 8714 */ 8715 /** 8716 * Define the brightness of BackgroundEffect. Value range [0, ∞) 8717 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 8718 * @type { ?number } 8719 * @default 1 8720 * @syscap SystemCapability.ArkUI.ArkUI.Full 8721 * @crossplatform 8722 * @atomicservice 8723 * @since 12 8724 */ 8725 brightness?: number; 8726 8727 /** 8728 * color the brightness of BackgroundEffect. 8729 * 8730 * @type { ?ResourceColor } 8731 * @default Color.Transparent 8732 * @syscap SystemCapability.ArkUI.ArkUI.Full 8733 * @crossplatform 8734 * @since 11 8735 */ 8736 /** 8737 * color the brightness of BackgroundEffect. 8738 * 8739 * @type { ?ResourceColor } 8740 * @default Color.Transparent 8741 * @syscap SystemCapability.ArkUI.ArkUI.Full 8742 * @crossplatform 8743 * @atomicservice 8744 * @since 12 8745 */ 8746 color?: ResourceColor; 8747 8748 /** 8749 * Define the adaptiveColor of BackgroundEffect. 8750 * 8751 * @type { ?AdaptiveColor } 8752 * @default AdaptiveColor.DEFAULT 8753 * @syscap SystemCapability.ArkUI.ArkUI.Full 8754 * @crossplatform 8755 * @since 11 8756 */ 8757 /** 8758 * Define the adaptiveColor of BackgroundEffect. 8759 * 8760 * @type { ?AdaptiveColor } 8761 * @default AdaptiveColor.DEFAULT 8762 * @syscap SystemCapability.ArkUI.ArkUI.Full 8763 * @crossplatform 8764 * @atomicservice 8765 * @since 12 8766 */ 8767 adaptiveColor?: AdaptiveColor; 8768 8769 /** 8770 * Define the blurOptions of BackgroundEffect. 8771 * 8772 * @type { ?BlurOptions } 8773 * @default { grayScale: [0,1] } 8774 * @syscap SystemCapability.ArkUI.ArkUI.Full 8775 * @crossplatform 8776 * @since 11 8777 */ 8778 /** 8779 * Define the blurOptions of BackgroundEffect. 8780 * 8781 * @type { ?BlurOptions } 8782 * @default { grayScale: [0,0] } 8783 * @syscap SystemCapability.ArkUI.ArkUI.Full 8784 * @crossplatform 8785 * @atomicservice 8786 * @since 12 8787 */ 8788 blurOptions?: BlurOptions; 8789 8790 /** 8791 * Defines the policy for activating the blur style. 8792 * 8793 * @type { ?BlurStyleActivePolicy } 8794 * @default BlurStyleActivePolicy.ALWAYS_ACTIVE 8795 * @syscap SystemCapability.ArkUI.ArkUI.Full 8796 * @crossplatform 8797 * @atomicservice 8798 * @since 14 8799 */ 8800 policy?: BlurStyleActivePolicy; 8801 8802 /** 8803 * Color of the background effect when the window is not focused. 8804 * 8805 * @type { ?ResourceColor } 8806 * @default Color.Transparent 8807 * @syscap SystemCapability.ArkUI.ArkUI.Full 8808 * @crossplatform 8809 * @atomicservice 8810 * @since 14 8811 */ 8812 inactiveColor?: ResourceColor; 8813} 8814 8815/** 8816 * Defines the options of ForegroundEffect 8817 * 8818 * @interface ForegroundEffectOptions 8819 * @syscap SystemCapability.ArkUI.ArkUI.Full 8820 * @crossplatform 8821 * @atomicservice 8822 * @since 12 8823 */ 8824declare interface ForegroundEffectOptions { 8825 8826 /** 8827 * Define the radius size of ForegroundEffect.The range of this value is [0, ∞) 8828 * 8829 * @type { number } 8830 * @syscap SystemCapability.ArkUI.ArkUI.Full 8831 * @crossplatform 8832 * @atomicservice 8833 * @since 12 8834 */ 8835 radius: number; 8836} 8837 8838/** 8839 * Provide an interface for the text style of picker 8840 * 8841 * @interface PickerTextStyle 8842 * @syscap SystemCapability.ArkUI.ArkUI.Full 8843 * @crossplatform 8844 * @since 10 8845 */ 8846/** 8847 * Provide an interface for the text style of picker 8848 * 8849 * @interface PickerTextStyle 8850 * @syscap SystemCapability.ArkUI.ArkUI.Full 8851 * @crossplatform 8852 * @atomicservice 8853 * @since 11 8854 */ 8855declare interface PickerTextStyle { 8856 /** 8857 * Define the text color of picker. 8858 * 8859 * @type { ?ResourceColor } 8860 * @syscap SystemCapability.ArkUI.ArkUI.Full 8861 * @crossplatform 8862 * @since 10 8863 */ 8864 /** 8865 * Define the text color of picker. 8866 * 8867 * @type { ?ResourceColor } 8868 * @syscap SystemCapability.ArkUI.ArkUI.Full 8869 * @crossplatform 8870 * @atomicservice 8871 * @since 11 8872 */ 8873 color?: ResourceColor; 8874 8875 /** 8876 * Define the text font of picker. 8877 * Only support size and weight. 8878 * 8879 * @type { ?Font } 8880 * @syscap SystemCapability.ArkUI.ArkUI.Full 8881 * @crossplatform 8882 * @since 10 8883 */ 8884 /** 8885 * Define the text font of picker. 8886 * Only support size and weight. 8887 * 8888 * @type { ?Font } 8889 * @syscap SystemCapability.ArkUI.ArkUI.Full 8890 * @crossplatform 8891 * @atomicservice 8892 * @since 11 8893 */ 8894 font?: Font; 8895} 8896 8897/** 8898 * Provide an interface for the button style of picker 8899 * 8900 * @interface PickerDialogButtonStyle 8901 * @syscap SystemCapability.ArkUI.ArkUI.Full 8902 * @crossplatform 8903 * @atomicservice 8904 * @since 12 8905 */ 8906declare interface PickerDialogButtonStyle { 8907 /** 8908 * Describes the button style. 8909 * 8910 * @type { ?ButtonType } 8911 * @syscap SystemCapability.ArkUI.ArkUI.Full 8912 * @crossplatform 8913 * @atomicservice 8914 * @since 12 8915 */ 8916 type?: ButtonType; 8917 8918 /** 8919 * Describes the button style. 8920 * 8921 * @type { ?ButtonStyleMode } 8922 * @syscap SystemCapability.ArkUI.ArkUI.Full 8923 * @crossplatform 8924 * @atomicservice 8925 * @since 12 8926 */ 8927 style?: ButtonStyleMode; 8928 8929 /** 8930 * Describes the button role. 8931 * 8932 * @type { ?ButtonRole } 8933 * @syscap SystemCapability.ArkUI.ArkUI.Full 8934 * @crossplatform 8935 * @atomicservice 8936 * @since 12 8937 */ 8938 role?: ButtonRole; 8939 8940 /** 8941 * Describes the button text size. 8942 * 8943 * @type { ?Length } 8944 * @syscap SystemCapability.ArkUI.ArkUI.Full 8945 * @crossplatform 8946 * @atomicservice 8947 * @since 12 8948 */ 8949 fontSize?: Length; 8950 8951 /** 8952 * Describes the button text color. 8953 * 8954 * @type { ?ResourceColor } 8955 * @syscap SystemCapability.ArkUI.ArkUI.Full 8956 * @crossplatform 8957 * @atomicservice 8958 * @since 12 8959 */ 8960 fontColor?: ResourceColor; 8961 8962 /** 8963 * Describes the button font weight. 8964 * 8965 * @type { ?(FontWeight | number | string) } 8966 * @syscap SystemCapability.ArkUI.ArkUI.Full 8967 * @crossplatform 8968 * @atomicservice 8969 * @since 12 8970 */ 8971 fontWeight?: FontWeight | number | string; 8972 8973 /** 8974 * Describes the button font style. 8975 * 8976 * @type { ?FontStyle } 8977 * @syscap SystemCapability.ArkUI.ArkUI.Full 8978 * @crossplatform 8979 * @atomicservice 8980 * @since 12 8981 */ 8982 fontStyle?: FontStyle; 8983 8984 /** 8985 * Describes the button font family. 8986 * 8987 * @type { ?(Resource | string) } 8988 * @syscap SystemCapability.ArkUI.ArkUI.Full 8989 * @crossplatform 8990 * @atomicservice 8991 * @since 12 8992 */ 8993 fontFamily?: Resource | string; 8994 8995 /** 8996 * Describes the button background color. 8997 * 8998 * @type { ?ResourceColor } 8999 * @syscap SystemCapability.ArkUI.ArkUI.Full 9000 * @crossplatform 9001 * @atomicservice 9002 * @since 12 9003 */ 9004 backgroundColor?: ResourceColor; 9005 9006 /** 9007 * Describes the button border radius. 9008 * 9009 * @type { ?(Length | BorderRadiuses) } 9010 * @syscap SystemCapability.ArkUI.ArkUI.Full 9011 * @crossplatform 9012 * @atomicservice 9013 * @since 12 9014 */ 9015 borderRadius?: Length | BorderRadiuses; 9016 9017 /** 9018 * Define whether the button default to responding to the Enter key 9019 * 9020 * @type { ?boolean } 9021 * @syscap SystemCapability.ArkUI.ArkUI.Full 9022 * @crossplatform 9023 * @atomicservice 9024 * @since 12 9025 */ 9026 primary?: boolean; 9027} 9028 9029/** 9030 * Define the type of shadow 9031 * 9032 * @enum { number } 9033 * @syscap SystemCapability.ArkUI.ArkUI.Full 9034 * @crossplatform 9035 * @since 10 9036 */ 9037/** 9038 * Define the type of shadow 9039 * 9040 * @enum { number } 9041 * @syscap SystemCapability.ArkUI.ArkUI.Full 9042 * @crossplatform 9043 * @atomicservice 9044 * @since 11 9045 */ 9046declare enum ShadowType { 9047 /** 9048 * Define a color type of shadow 9049 * 9050 * @syscap SystemCapability.ArkUI.ArkUI.Full 9051 * @crossplatform 9052 * @since 10 9053 */ 9054 /** 9055 * Define a color type of shadow 9056 * 9057 * @syscap SystemCapability.ArkUI.ArkUI.Full 9058 * @crossplatform 9059 * @atomicservice 9060 * @since 11 9061 */ 9062 COLOR, 9063 9064 /** 9065 * Define a blur type of shadow 9066 * 9067 * @syscap SystemCapability.ArkUI.ArkUI.Full 9068 * @crossplatform 9069 * @since 10 9070 */ 9071 /** 9072 * Define a blur type of shadow 9073 * 9074 * @syscap SystemCapability.ArkUI.ArkUI.Full 9075 * @crossplatform 9076 * @atomicservice 9077 * @since 11 9078 */ 9079 BLUR, 9080} 9081 9082/** 9083 * Define the options of shadow 9084 * 9085 * @interface ShadowOptions 9086 * @syscap SystemCapability.ArkUI.ArkUI.Full 9087 * @since 7 9088 */ 9089/** 9090 * Define the options of shadow 9091 * 9092 * @interface ShadowOptions 9093 * @syscap SystemCapability.ArkUI.ArkUI.Full 9094 * @form 9095 * @since 9 9096 */ 9097/** 9098 * Define the options of shadow 9099 * 9100 * @interface ShadowOptions 9101 * @syscap SystemCapability.ArkUI.ArkUI.Full 9102 * @crossplatform 9103 * @form 9104 * @since 10 9105 */ 9106/** 9107 * Define the options of shadow 9108 * 9109 * @interface ShadowOptions 9110 * @syscap SystemCapability.ArkUI.ArkUI.Full 9111 * @crossplatform 9112 * @form 9113 * @atomicservice 9114 * @since 11 9115 */ 9116declare interface ShadowOptions { 9117 /** 9118 * Define the radius size of shadow 9119 * 9120 * @type { number | Resource } 9121 * @syscap SystemCapability.ArkUI.ArkUI.Full 9122 * @since 7 9123 */ 9124 /** 9125 * Define the radius size of shadow 9126 * 9127 * @type { number | Resource } 9128 * @syscap SystemCapability.ArkUI.ArkUI.Full 9129 * @form 9130 * @since 9 9131 */ 9132 /** 9133 * Define the radius size of shadow 9134 * 9135 * @type { number | Resource } 9136 * @syscap SystemCapability.ArkUI.ArkUI.Full 9137 * @crossplatform 9138 * @form 9139 * @since 10 9140 */ 9141 /** 9142 * Define the radius size of shadow 9143 * 9144 * @type { number | Resource } 9145 * @syscap SystemCapability.ArkUI.ArkUI.Full 9146 * @crossplatform 9147 * @form 9148 * @atomicservice 9149 * @since 11 9150 */ 9151 radius: number | Resource; 9152 9153 /** 9154 * Define the type of shadow 9155 * 9156 * @type { ?ShadowType } 9157 * @default ShadowType.COLOR 9158 * @syscap SystemCapability.ArkUI.ArkUI.Full 9159 * @crossplatform 9160 * @since 10 9161 */ 9162 /** 9163 * Define the type of shadow 9164 * 9165 * @type { ?ShadowType } 9166 * @default ShadowType.COLOR 9167 * @syscap SystemCapability.ArkUI.ArkUI.Full 9168 * @crossplatform 9169 * @atomicservice 9170 * @since 11 9171 */ 9172 type?: ShadowType; 9173 9174 /** 9175 * Define the color of shadow 9176 * 9177 * @type { ?(Color | string | Resource) } 9178 * @syscap SystemCapability.ArkUI.ArkUI.Full 9179 * @since 7 9180 */ 9181 /** 9182 * Define the color of shadow 9183 * 9184 * @type { ?(Color | string | Resource) } 9185 * @syscap SystemCapability.ArkUI.ArkUI.Full 9186 * @form 9187 * @since 9 9188 */ 9189 /** 9190 * Define the color of shadow 9191 * 9192 * @type { ?(Color | string | Resource) } 9193 * @syscap SystemCapability.ArkUI.ArkUI.Full 9194 * @crossplatform 9195 * @form 9196 * @since 10 9197 */ 9198 /** 9199 * Define the color or the color strategy of shadow 9200 * 9201 * @type { ?(Color | string | Resource| ColoringStrategy) } 9202 * @syscap SystemCapability.ArkUI.ArkUI.Full 9203 * @crossplatform 9204 * @form 9205 * @atomicservice 9206 * @since 11 9207 */ 9208 color?: Color | string | Resource | ColoringStrategy; 9209 9210 /** 9211 * Define the horizontal offset size of shadow 9212 * 9213 * @type { ?(number | Resource) } 9214 * @syscap SystemCapability.ArkUI.ArkUI.Full 9215 * @since 7 9216 */ 9217 /** 9218 * Define the horizontal offset size of shadow 9219 * 9220 * @type { ?(number | Resource) } 9221 * @syscap SystemCapability.ArkUI.ArkUI.Full 9222 * @form 9223 * @since 9 9224 */ 9225 /** 9226 * Define the horizontal offset size of shadow 9227 * 9228 * @type { ?(number | Resource) } 9229 * @syscap SystemCapability.ArkUI.ArkUI.Full 9230 * @crossplatform 9231 * @form 9232 * @since 10 9233 */ 9234 /** 9235 * Define the horizontal offset size of shadow 9236 * 9237 * @type { ?(number | Resource) } 9238 * @syscap SystemCapability.ArkUI.ArkUI.Full 9239 * @crossplatform 9240 * @form 9241 * @atomicservice 9242 * @since 11 9243 */ 9244 offsetX?: number | Resource; 9245 9246 /** 9247 * Define the vertical offset size of shadow 9248 * 9249 * @type { ?(number | Resource) } 9250 * @syscap SystemCapability.ArkUI.ArkUI.Full 9251 * @since 7 9252 */ 9253 /** 9254 * Define the vertical offset size of shadow 9255 * 9256 * @type { ?(number | Resource) } 9257 * @syscap SystemCapability.ArkUI.ArkUI.Full 9258 * @form 9259 * @since 9 9260 */ 9261 /** 9262 * Define the vertical offset size of shadow 9263 * 9264 * @type { ?(number | Resource) } 9265 * @syscap SystemCapability.ArkUI.ArkUI.Full 9266 * @crossplatform 9267 * @form 9268 * @since 10 9269 */ 9270 /** 9271 * Define the vertical offset size of shadow 9272 * 9273 * @type { ?(number | Resource) } 9274 * @syscap SystemCapability.ArkUI.ArkUI.Full 9275 * @crossplatform 9276 * @form 9277 * @atomicservice 9278 * @since 11 9279 */ 9280 offsetY?: number | Resource; 9281 9282 /** 9283 * Define whether the shadow should fill the area 9284 * 9285 * @type { ?boolean } 9286 * @default false 9287 * @syscap SystemCapability.ArkUI.ArkUI.Full 9288 * @crossplatform 9289 * @since 11 9290 */ 9291 /** 9292 * Define whether the shadow should fill the area 9293 * 9294 * @type { ?boolean } 9295 * @default false 9296 * @syscap SystemCapability.ArkUI.ArkUI.Full 9297 * @crossplatform 9298 * @atomicservice 9299 * @since 12 9300 */ 9301 fill?: boolean; 9302} 9303 9304/** 9305 * enum Shadow style 9306 * 9307 * @enum { number } 9308 * @syscap SystemCapability.ArkUI.ArkUI.Full 9309 * @crossplatform 9310 * @since 10 9311 */ 9312/** 9313 * enum Shadow style 9314 * 9315 * @enum { number } 9316 * @syscap SystemCapability.ArkUI.ArkUI.Full 9317 * @crossplatform 9318 * @atomicservice 9319 * @since 11 9320 */ 9321declare enum ShadowStyle { 9322 /** 9323 * Defines the super small default shadow style. 9324 * 9325 * @syscap SystemCapability.ArkUI.ArkUI.Full 9326 * @crossplatform 9327 * @since 10 9328 */ 9329 /** 9330 * Defines the super small default shadow style. 9331 * 9332 * @syscap SystemCapability.ArkUI.ArkUI.Full 9333 * @crossplatform 9334 * @atomicservice 9335 * @since 11 9336 */ 9337 OUTER_DEFAULT_XS, 9338 9339 /** 9340 * Defines the small default shadow style. 9341 * 9342 * @syscap SystemCapability.ArkUI.ArkUI.Full 9343 * @crossplatform 9344 * @since 10 9345 */ 9346 /** 9347 * Defines the small default shadow style. 9348 * 9349 * @syscap SystemCapability.ArkUI.ArkUI.Full 9350 * @crossplatform 9351 * @atomicservice 9352 * @since 11 9353 */ 9354 OUTER_DEFAULT_SM, 9355 9356 /** 9357 * Defines the medium default shadow style. 9358 * 9359 * @syscap SystemCapability.ArkUI.ArkUI.Full 9360 * @crossplatform 9361 * @since 10 9362 */ 9363 /** 9364 * Defines the medium default shadow style. 9365 * 9366 * @syscap SystemCapability.ArkUI.ArkUI.Full 9367 * @crossplatform 9368 * @atomicservice 9369 * @since 11 9370 */ 9371 OUTER_DEFAULT_MD, 9372 9373 /** 9374 * Defines the large default shadow style. 9375 * 9376 * @syscap SystemCapability.ArkUI.ArkUI.Full 9377 * @crossplatform 9378 * @since 10 9379 */ 9380 /** 9381 * Defines the large default shadow style. 9382 * 9383 * @syscap SystemCapability.ArkUI.ArkUI.Full 9384 * @crossplatform 9385 * @atomicservice 9386 * @since 11 9387 */ 9388 OUTER_DEFAULT_LG, 9389 9390 /** 9391 * Defines the small floating shadow style. 9392 * 9393 * @syscap SystemCapability.ArkUI.ArkUI.Full 9394 * @crossplatform 9395 * @since 10 9396 */ 9397 /** 9398 * Defines the small floating shadow style. 9399 * 9400 * @syscap SystemCapability.ArkUI.ArkUI.Full 9401 * @crossplatform 9402 * @atomicservice 9403 * @since 11 9404 */ 9405 OUTER_FLOATING_SM, 9406 9407 /** 9408 * Defines the medium floating shadow style. 9409 * 9410 * @syscap SystemCapability.ArkUI.ArkUI.Full 9411 * @crossplatform 9412 * @since 10 9413 */ 9414 /** 9415 * Defines the medium floating shadow style. 9416 * 9417 * @syscap SystemCapability.ArkUI.ArkUI.Full 9418 * @crossplatform 9419 * @atomicservice 9420 * @since 11 9421 */ 9422 OUTER_FLOATING_MD, 9423} 9424 9425/** 9426 * Defines the options of Shadow. 9427 * 9428 * @interface MultiShadowOptions 9429 * @syscap SystemCapability.ArkUI.ArkUI.Full 9430 * @crossplatform 9431 * @since 10 9432 */ 9433/** 9434 * Defines the options of Shadow. 9435 * 9436 * @interface MultiShadowOptions 9437 * @syscap SystemCapability.ArkUI.ArkUI.Full 9438 * @crossplatform 9439 * @atomicservice 9440 * @since 11 9441 */ 9442declare interface MultiShadowOptions { 9443 /** 9444 * Current shadow radius. 9445 * 9446 * @type { ?(number | Resource) } 9447 * @default 5 9448 * @syscap SystemCapability.ArkUI.ArkUI.Full 9449 * @crossplatform 9450 * @since 10 9451 */ 9452 /** 9453 * Current shadow radius. 9454 * 9455 * @type { ?(number | Resource) } 9456 * @default 20 9457 * @syscap SystemCapability.ArkUI.ArkUI.Full 9458 * @crossplatform 9459 * @atomicservice 9460 * @since 11 9461 */ 9462 radius?: number | Resource; 9463 9464 /** 9465 * Current shadow offsetX. 9466 * 9467 * @type { ?(number | Resource) } 9468 * @default 5 9469 * @syscap SystemCapability.ArkUI.ArkUI.Full 9470 * @crossplatform 9471 * @since 10 9472 */ 9473 /** 9474 * Current shadow offsetX. 9475 * 9476 * @type { ?(number | Resource) } 9477 * @default 5 9478 * @syscap SystemCapability.ArkUI.ArkUI.Full 9479 * @crossplatform 9480 * @atomicservice 9481 * @since 11 9482 */ 9483 offsetX?: number | Resource; 9484 9485 /** 9486 * Current shadow offsetY 9487 * 9488 * @type { ?(number | Resource) } 9489 * @default 5 9490 * @syscap SystemCapability.ArkUI.ArkUI.Full 9491 * @crossplatform 9492 * @since 10 9493 */ 9494 /** 9495 * Current shadow offsetY 9496 * 9497 * @type { ?(number | Resource) } 9498 * @default 5 9499 * @syscap SystemCapability.ArkUI.ArkUI.Full 9500 * @crossplatform 9501 * @atomicservice 9502 * @since 11 9503 */ 9504 offsetY?: number | Resource; 9505} 9506 9507/** 9508 * Enumerates the safe area types. 9509 * 9510 * @enum { number } 9511 * @syscap SystemCapability.ArkUI.ArkUI.Full 9512 * @since 10 9513 */ 9514/** 9515 * Enumerates the safe area types. 9516 * 9517 * @enum { number } 9518 * @syscap SystemCapability.ArkUI.ArkUI.Full 9519 * @crossplatform 9520 * @atomicservice 9521 * @since 11 9522 */ 9523declare enum SafeAreaType { 9524 /** 9525 * Default area of the system, including the status bar and navigation bar. 9526 * 9527 * @syscap SystemCapability.ArkUI.ArkUI.Full 9528 * @since 10 9529 */ 9530 /** 9531 * Default area of the system, including the status bar and navigation bar. 9532 * 9533 * @syscap SystemCapability.ArkUI.ArkUI.Full 9534 * @crossplatform 9535 * @atomicservice 9536 * @since 11 9537 */ 9538 SYSTEM, 9539 9540 /** 9541 * Notch or punch hole. 9542 * 9543 * @syscap SystemCapability.ArkUI.ArkUI.Full 9544 * @since 10 9545 */ 9546 /** 9547 * Notch or punch hole. 9548 * 9549 * @syscap SystemCapability.ArkUI.ArkUI.Full 9550 * @crossplatform 9551 * @atomicservice 9552 * @since 11 9553 */ 9554 CUTOUT, 9555 9556 /** 9557 * Soft keyboard area. 9558 * 9559 * @syscap SystemCapability.ArkUI.ArkUI.Full 9560 * @since 10 9561 */ 9562 /** 9563 * Soft keyboard area. 9564 * 9565 * @syscap SystemCapability.ArkUI.ArkUI.Full 9566 * @crossplatform 9567 * @atomicservice 9568 * @since 11 9569 */ 9570 KEYBOARD 9571} 9572 9573/** 9574 * Enumerates the safe area edges. 9575 * 9576 * @enum { number } 9577 * @syscap SystemCapability.ArkUI.ArkUI.Full 9578 * @since 10 9579 */ 9580/** 9581 * Enumerates the safe area edges. 9582 * 9583 * @enum { number } 9584 * @syscap SystemCapability.ArkUI.ArkUI.Full 9585 * @crossplatform 9586 * @atomicservice 9587 * @since 11 9588 */ 9589declare enum SafeAreaEdge { 9590 /** 9591 * Top edge of the safe area. 9592 * 9593 * @syscap SystemCapability.ArkUI.ArkUI.Full 9594 * @since 10 9595 */ 9596 /** 9597 * Top edge of the safe area. 9598 * 9599 * @syscap SystemCapability.ArkUI.ArkUI.Full 9600 * @crossplatform 9601 * @atomicservice 9602 * @since 11 9603 */ 9604 TOP, 9605 9606 /** 9607 * Bottom edge of the safe area. 9608 * 9609 * @syscap SystemCapability.ArkUI.ArkUI.Full 9610 * @since 10 9611 */ 9612 /** 9613 * Bottom edge of the safe area. 9614 * 9615 * @syscap SystemCapability.ArkUI.ArkUI.Full 9616 * @crossplatform 9617 * @atomicservice 9618 * @since 11 9619 */ 9620 BOTTOM, 9621 9622 /** 9623 * Start edge of the safe area. 9624 * 9625 * @syscap SystemCapability.ArkUI.ArkUI.Full 9626 * @since 10 9627 */ 9628 /** 9629 * Start edge of the safe area. 9630 * 9631 * @syscap SystemCapability.ArkUI.ArkUI.Full 9632 * @crossplatform 9633 * @atomicservice 9634 * @since 11 9635 */ 9636 START, 9637 9638 /** 9639 * End edge of the safe area. 9640 * 9641 * @syscap SystemCapability.ArkUI.ArkUI.Full 9642 * @since 10 9643 */ 9644 /** 9645 * End edge of the safe area. 9646 * 9647 * @syscap SystemCapability.ArkUI.ArkUI.Full 9648 * @crossplatform 9649 * @atomicservice 9650 * @since 11 9651 */ 9652 END 9653} 9654 9655/** 9656 * Enumerates the safe area types can be ignored. 9657 * 9658 * @enum { number } 9659 * @syscap SystemCapability.ArkUI.ArkUI.Full 9660 * @crossplatform 9661 * @atomicservice 9662 * @since 12 9663 */ 9664declare enum LayoutSafeAreaType { 9665 /** 9666 * Default area of the system, including the status bar and navigation bar. 9667 * 9668 * @syscap SystemCapability.ArkUI.ArkUI.Full 9669 * @crossplatform 9670 * @atomicservice 9671 * @since 12 9672 */ 9673 SYSTEM = 0, 9674} 9675 9676/** 9677 * Enumerates the safe area edges can be ignored. 9678 * 9679 * @enum { number } 9680 * @syscap SystemCapability.ArkUI.ArkUI.Full 9681 * @crossplatform 9682 * @atomicservice 9683 * @since 12 9684 */ 9685declare enum LayoutSafeAreaEdge { 9686 /** 9687 * Top edge of the safe area. 9688 * 9689 * @syscap SystemCapability.ArkUI.ArkUI.Full 9690 * @crossplatform 9691 * @atomicservice 9692 * @since 12 9693 */ 9694 TOP = 0, 9695 9696 /** 9697 * Bottom edge of the safe area. 9698 * 9699 * @syscap SystemCapability.ArkUI.ArkUI.Full 9700 * @crossplatform 9701 * @atomicservice 9702 * @since 12 9703 */ 9704 BOTTOM = 1, 9705} 9706 9707/** 9708 * Defines sheet size type. 9709 * 9710 * @enum { number } 9711 * @syscap SystemCapability.ArkUI.ArkUI.Full 9712 * @crossplatform 9713 * @since 10 9714 */ 9715/** 9716 * Defines sheet size type. 9717 * 9718 * @enum { number } 9719 * @syscap SystemCapability.ArkUI.ArkUI.Full 9720 * @crossplatform 9721 * @atomicservice 9722 * @since 11 9723 */ 9724declare enum SheetSize { 9725 /** 9726 * Defines the sheet size medium height type. The height is half the screen height 9727 * 9728 * @syscap SystemCapability.ArkUI.ArkUI.Full 9729 * @crossplatform 9730 * @since 10 9731 */ 9732 /** 9733 * Defines the sheet size medium height type. The height is half the screen height 9734 * 9735 * @syscap SystemCapability.ArkUI.ArkUI.Full 9736 * @crossplatform 9737 * @atomicservice 9738 * @since 11 9739 */ 9740 MEDIUM, 9741 9742 /** 9743 * Defines the sheet size large height type. The height is almost screen height. 9744 * 9745 * @syscap SystemCapability.ArkUI.ArkUI.Full 9746 * @crossplatform 9747 * @since 10 9748 */ 9749 /** 9750 * Defines the sheet size large height type. The height is almost screen height. 9751 * 9752 * @syscap SystemCapability.ArkUI.ArkUI.Full 9753 * @crossplatform 9754 * @atomicservice 9755 * @since 11 9756 */ 9757 LARGE, 9758 9759 /** 9760 * Defines the sheet size fit content height type. The height fit content. 9761 * 9762 * @syscap SystemCapability.ArkUI.ArkUI.Full 9763 * @crossplatform 9764 * @since 11 9765 */ 9766 /** 9767 * Defines the sheet size fit content height type. The height fit content. 9768 * 9769 * @syscap SystemCapability.ArkUI.ArkUI.Full 9770 * @crossplatform 9771 * @atomicservice 9772 * @since 12 9773 */ 9774 FIT_CONTENT = 2, 9775} 9776 9777/** 9778 * Defines the base event. 9779 * 9780 * @interface BaseEvent 9781 * @syscap SystemCapability.ArkUI.ArkUI.Full 9782 * @since 8 9783 */ 9784/** 9785 * Defines the base event. 9786 * 9787 * @interface BaseEvent 9788 * @syscap SystemCapability.ArkUI.ArkUI.Full 9789 * @form 9790 * @since 9 9791 */ 9792/** 9793 * Defines the base event. 9794 * 9795 * @interface BaseEvent 9796 * @syscap SystemCapability.ArkUI.ArkUI.Full 9797 * @crossplatform 9798 * @form 9799 * @since 10 9800 */ 9801/** 9802 * Defines the base event. 9803 * 9804 * @interface BaseEvent 9805 * @syscap SystemCapability.ArkUI.ArkUI.Full 9806 * @crossplatform 9807 * @form 9808 * @atomicservice 9809 * @since 11 9810 */ 9811declare interface BaseEvent { 9812 /** 9813 * Defines the current target which fires this event. 9814 * 9815 * @type { EventTarget } 9816 * @syscap SystemCapability.ArkUI.ArkUI.Full 9817 * @since 8 9818 */ 9819 /** 9820 * Defines the current target which fires this event. 9821 * 9822 * @type { EventTarget } 9823 * @syscap SystemCapability.ArkUI.ArkUI.Full 9824 * @form 9825 * @since 9 9826 */ 9827 /** 9828 * Defines the current target which fires this event. 9829 * 9830 * @type { EventTarget } 9831 * @syscap SystemCapability.ArkUI.ArkUI.Full 9832 * @crossplatform 9833 * @form 9834 * @since 10 9835 */ 9836 /** 9837 * Defines the current target which fires this event. 9838 * 9839 * @type { EventTarget } 9840 * @syscap SystemCapability.ArkUI.ArkUI.Full 9841 * @crossplatform 9842 * @form 9843 * @atomicservice 9844 * @since 11 9845 */ 9846 target: EventTarget; 9847 9848 /** 9849 * Event timestamp. 9850 * 9851 * @type { number } 9852 * @syscap SystemCapability.ArkUI.ArkUI.Full 9853 * @since 8 9854 */ 9855 /** 9856 * Event timestamp. 9857 * 9858 * @type { number } 9859 * @syscap SystemCapability.ArkUI.ArkUI.Full 9860 * @form 9861 * @since 9 9862 */ 9863 /** 9864 * Event timestamp. 9865 * 9866 * @type { number } 9867 * @syscap SystemCapability.ArkUI.ArkUI.Full 9868 * @crossplatform 9869 * @form 9870 * @since 10 9871 */ 9872 /** 9873 * Event timestamp. 9874 * 9875 * @type { number } 9876 * @syscap SystemCapability.ArkUI.ArkUI.Full 9877 * @crossplatform 9878 * @form 9879 * @atomicservice 9880 * @since 11 9881 */ 9882 timestamp: number; 9883 9884 /** 9885 * the event source info. 9886 * 9887 * @type { SourceType } 9888 * @syscap SystemCapability.ArkUI.ArkUI.Full 9889 * @since 8 9890 */ 9891 /** 9892 * the event source info. 9893 * 9894 * @type { SourceType } 9895 * @syscap SystemCapability.ArkUI.ArkUI.Full 9896 * @form 9897 * @since 9 9898 */ 9899 /** 9900 * the event source info. 9901 * 9902 * @type { SourceType } 9903 * @syscap SystemCapability.ArkUI.ArkUI.Full 9904 * @crossplatform 9905 * @form 9906 * @since 10 9907 */ 9908 /** 9909 * the event source info. 9910 * 9911 * @type { SourceType } 9912 * @syscap SystemCapability.ArkUI.ArkUI.Full 9913 * @crossplatform 9914 * @form 9915 * @atomicservice 9916 * @since 11 9917 */ 9918 source: SourceType; 9919 9920 /** 9921 * the Horizontal axis coordinate. 9922 * 9923 * @type { ?number } 9924 * @syscap SystemCapability.ArkUI.ArkUI.Full 9925 * @crossplatform 9926 * @form 9927 * @atomicservice 9928 * @since 12 9929 */ 9930 axisHorizontal?: number; 9931 9932 /** 9933 * the Vertical axis coordinate. 9934 * 9935 * @type { ?number } 9936 * @syscap SystemCapability.ArkUI.ArkUI.Full 9937 * @crossplatform 9938 * @form 9939 * @atomicservice 9940 * @since 12 9941 */ 9942 axisVertical?: number; 9943 9944 /** 9945 * Touch pressure. 9946 * 9947 * @type { number } 9948 * @syscap SystemCapability.ArkUI.ArkUI.Full 9949 * @form 9950 * @since 9 9951 */ 9952 /** 9953 * Touch pressure. 9954 * 9955 * @type { number } 9956 * @syscap SystemCapability.ArkUI.ArkUI.Full 9957 * @crossplatform 9958 * @form 9959 * @since 10 9960 */ 9961 /** 9962 * Touch pressure. 9963 * 9964 * @type { number } 9965 * @syscap SystemCapability.ArkUI.ArkUI.Full 9966 * @crossplatform 9967 * @form 9968 * @atomicservice 9969 * @since 11 9970 */ 9971 pressure: number; 9972 9973 /** 9974 * The angle between pencil projection on plane-X-Y and axis-Z. 9975 * 9976 * @type { number } 9977 * @syscap SystemCapability.ArkUI.ArkUI.Full 9978 * @form 9979 * @since 9 9980 */ 9981 /** 9982 * The angle between pencil projection on plane-X-Y and axis-Z. 9983 * 9984 * @type { number } 9985 * @syscap SystemCapability.ArkUI.ArkUI.Full 9986 * @crossplatform 9987 * @form 9988 * @since 10 9989 */ 9990 /** 9991 * The angle between pencil projection on plane-X-Y and axis-Z. 9992 * 9993 * @type { number } 9994 * @syscap SystemCapability.ArkUI.ArkUI.Full 9995 * @crossplatform 9996 * @form 9997 * @atomicservice 9998 * @since 11 9999 */ 10000 tiltX: number; 10001 10002 /** 10003 * The angle between pencil projection on plane-Y-Z and axis-Z. 10004 * 10005 * @type { number } 10006 * @syscap SystemCapability.ArkUI.ArkUI.Full 10007 * @form 10008 * @since 9 10009 */ 10010 /** 10011 * The angle between pencil projection on plane-Y-Z and axis-Z. 10012 * 10013 * @type { number } 10014 * @syscap SystemCapability.ArkUI.ArkUI.Full 10015 * @crossplatform 10016 * @form 10017 * @since 10 10018 */ 10019 /** 10020 * The angle between pencil projection on plane-Y-Z and axis-Z. 10021 * 10022 * @type { number } 10023 * @syscap SystemCapability.ArkUI.ArkUI.Full 10024 * @crossplatform 10025 * @form 10026 * @atomicservice 10027 * @since 11 10028 */ 10029 tiltY: number; 10030 10031 /** 10032 * Indicates the angle at which the stylus rotates around the Z-axis. 10033 * 10034 * @type { number } 10035 * @syscap SystemCapability.ArkUI.ArkUI.Full 10036 * @crossplatform 10037 * @form 10038 * @atomicservice 10039 * @since 17 10040 */ 10041 rollAngle?: number; 10042 10043 /** 10044 * The event tool type info. 10045 * 10046 * @type { SourceTool } 10047 * @syscap SystemCapability.ArkUI.ArkUI.Full 10048 * @form 10049 * @since 9 10050 */ 10051 /** 10052 * The event tool type info. 10053 * 10054 * @type { SourceTool } 10055 * @syscap SystemCapability.ArkUI.ArkUI.Full 10056 * @crossplatform 10057 * @form 10058 * @since 10 10059 */ 10060 /** 10061 * The event tool type info. 10062 * 10063 * @type { SourceTool } 10064 * @syscap SystemCapability.ArkUI.ArkUI.Full 10065 * @crossplatform 10066 * @form 10067 * @atomicservice 10068 * @since 11 10069 */ 10070 sourceTool: SourceTool; 10071 10072 /** 10073 * Query the ModifierKey press state, support 'ctrl'|'alt'|'shift'|'fn' 10074 * 10075 * @param { Array<string> } keys - indicate the keys of the ModifierKey. 10076 * @returns { boolean } 10077 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 10078 * @syscap SystemCapability.ArkUI.ArkUI.Full 10079 * @crossplatform 10080 * @atomicservice 10081 * @since 12 10082 */ 10083 getModifierKeyState?(keys: Array<string>): boolean; 10084 10085 /** 10086 * Indicates the ID of the input device that triggers the current event. 10087 * 10088 * @type { ?number } [deviceId] The ID of the input device that triggers the current event 10089 * @syscap SystemCapability.ArkUI.ArkUI.Full 10090 * @crossplatform 10091 * @atomicservice 10092 * @since 12 10093 */ 10094 deviceId?: number; 10095 10096 /** 10097 * Indicates the screen ID on which the event occurred. 10098 * 10099 * @type { ?number } [targetDisplayId] The screen ID on which the event occurred. 10100 * @syscap SystemCapability.ArkUI.ArkUI.Full 10101 * @crossplatform 10102 * @atomicservice 10103 * @since 15 10104 */ 10105 targetDisplayId?: number; 10106} 10107 10108/** 10109 * Border image option 10110 * 10111 * @interface BorderImageOption 10112 * @syscap SystemCapability.ArkUI.ArkUI.Full 10113 * @form 10114 * @since 9 10115 */ 10116/** 10117 * Border image option 10118 * 10119 * @interface BorderImageOption 10120 * @syscap SystemCapability.ArkUI.ArkUI.Full 10121 * @crossplatform 10122 * @form 10123 * @since 10 10124 */ 10125/** 10126 * Border image option 10127 * 10128 * @interface BorderImageOption 10129 * @syscap SystemCapability.ArkUI.ArkUI.Full 10130 * @crossplatform 10131 * @form 10132 * @atomicservice 10133 * @since 11 10134 */ 10135declare interface BorderImageOption { 10136 /** 10137 * Border image slice 10138 * 10139 * @type { ?(Length | EdgeWidths) } 10140 * @syscap SystemCapability.ArkUI.ArkUI.Full 10141 * @form 10142 * @since 9 10143 */ 10144 /** 10145 * Border image slice 10146 * 10147 * @type { ?(Length | EdgeWidths) } 10148 * @syscap SystemCapability.ArkUI.ArkUI.Full 10149 * @crossplatform 10150 * @form 10151 * @since 10 10152 */ 10153 /** 10154 * Border image slice 10155 * 10156 * @type { ?(Length | EdgeWidths) } 10157 * @syscap SystemCapability.ArkUI.ArkUI.Full 10158 * @crossplatform 10159 * @form 10160 * @atomicservice 10161 * @since 11 10162 */ 10163 /** 10164 * Border image slice 10165 * 10166 * @type { ?(Length | EdgeWidths | LocalizedEdgeWidths) } 10167 * @syscap SystemCapability.ArkUI.ArkUI.Full 10168 * @crossplatform 10169 * @form 10170 * @atomicservice 10171 * @since 12 10172 */ 10173 slice?: Length | EdgeWidths | LocalizedEdgeWidths, 10174 10175 /** 10176 * Border image repeat 10177 * 10178 * @type { ?RepeatMode } 10179 * @syscap SystemCapability.ArkUI.ArkUI.Full 10180 * @form 10181 * @since 9 10182 */ 10183 /** 10184 * Border image repeat 10185 * 10186 * @type { ?RepeatMode } 10187 * @syscap SystemCapability.ArkUI.ArkUI.Full 10188 * @crossplatform 10189 * @form 10190 * @since 10 10191 */ 10192 /** 10193 * Border image repeat 10194 * 10195 * @type { ?RepeatMode } 10196 * @syscap SystemCapability.ArkUI.ArkUI.Full 10197 * @crossplatform 10198 * @form 10199 * @atomicservice 10200 * @since 11 10201 */ 10202 repeat?: RepeatMode, 10203 10204 /** 10205 * Border image source 10206 * 10207 * @type { ?(string | Resource | LinearGradient) } 10208 * @syscap SystemCapability.ArkUI.ArkUI.Full 10209 * @form 10210 * @since 9 10211 */ 10212 /** 10213 * Border image source 10214 * 10215 * @type { ?(string | Resource | LinearGradient) } 10216 * @syscap SystemCapability.ArkUI.ArkUI.Full 10217 * @crossplatform 10218 * @form 10219 * @since 10 10220 */ 10221 /** 10222 * Border image source 10223 * 10224 * @type { ?(string | Resource | LinearGradient) } 10225 * @syscap SystemCapability.ArkUI.ArkUI.Full 10226 * @crossplatform 10227 * @form 10228 * @atomicservice 10229 * @since 11 10230 */ 10231 source?: string | Resource | LinearGradient, 10232 10233 /** 10234 * Border image width 10235 * 10236 * @type { ?(Length | EdgeWidths) } 10237 * @syscap SystemCapability.ArkUI.ArkUI.Full 10238 * @form 10239 * @since 9 10240 */ 10241 /** 10242 * Border image width 10243 * 10244 * @type { ?(Length | EdgeWidths) } 10245 * @syscap SystemCapability.ArkUI.ArkUI.Full 10246 * @crossplatform 10247 * @form 10248 * @since 10 10249 */ 10250 /** 10251 * Border image width 10252 * 10253 * @type { ?(Length | EdgeWidths) } 10254 * @syscap SystemCapability.ArkUI.ArkUI.Full 10255 * @crossplatform 10256 * @form 10257 * @atomicservice 10258 * @since 11 10259 */ 10260 /** 10261 * Border image width 10262 * 10263 * @type { ?(Length | EdgeWidths | LocalizedEdgeWidths) } 10264 * @syscap SystemCapability.ArkUI.ArkUI.Full 10265 * @crossplatform 10266 * @form 10267 * @atomicservice 10268 * @since 12 10269 */ 10270 width?: Length | EdgeWidths | LocalizedEdgeWidths, 10271 10272 /** 10273 * Border image outset 10274 * 10275 * @type { ?(Length | EdgeWidths) } 10276 * @syscap SystemCapability.ArkUI.ArkUI.Full 10277 * @form 10278 * @since 9 10279 */ 10280 /** 10281 * Border image outset 10282 * 10283 * @type { ?(Length | EdgeWidths) } 10284 * @syscap SystemCapability.ArkUI.ArkUI.Full 10285 * @crossplatform 10286 * @form 10287 * @since 10 10288 */ 10289 /** 10290 * Border image outset 10291 * 10292 * @type { ?(Length | EdgeWidths) } 10293 * @syscap SystemCapability.ArkUI.ArkUI.Full 10294 * @crossplatform 10295 * @form 10296 * @atomicservice 10297 * @since 11 10298 */ 10299 /** 10300 * Border image outset 10301 * 10302 * @type { ?(Length | EdgeWidths | LocalizedEdgeWidths) } 10303 * @syscap SystemCapability.ArkUI.ArkUI.Full 10304 * @crossplatform 10305 * @form 10306 * @atomicservice 10307 * @since 12 10308 */ 10309 outset?: Length | EdgeWidths | LocalizedEdgeWidths, 10310 10311 /** 10312 * Border image center fill 10313 * 10314 * @type { ?boolean } 10315 * @syscap SystemCapability.ArkUI.ArkUI.Full 10316 * @form 10317 * @since 9 10318 */ 10319 /** 10320 * Border image center fill 10321 * 10322 * @type { ?boolean } 10323 * @syscap SystemCapability.ArkUI.ArkUI.Full 10324 * @crossplatform 10325 * @form 10326 * @since 10 10327 */ 10328 /** 10329 * Border image center fill 10330 * 10331 * @type { ?boolean } 10332 * @syscap SystemCapability.ArkUI.ArkUI.Full 10333 * @crossplatform 10334 * @form 10335 * @atomicservice 10336 * @since 11 10337 */ 10338 fill?: boolean 10339} 10340 10341/** 10342 * Defines the policy of Layout 10343 * 10344 * @syscap SystemCapability.ArkUI.ArkUI.Full 10345 * @crossplatform 10346 * @form 10347 * @atomicservice 10348 * @since 15 10349 */ 10350declare class LayoutPolicy { 10351 /** 10352 * The component fills its parent which means its size is as large as its parent. 10353 * 10354 * @type { LayoutPolicy } 10355 * @readonly 10356 * @static 10357 * @syscap SystemCapability.ArkUI.ArkUI.Full 10358 * @crossplatform 10359 * @form 10360 * @atomicservice 10361 * @since 15 10362 */ 10363 static readonly matchParent: LayoutPolicy; 10364} 10365 10366/** 10367 * The tap action triggers this method invocation. 10368 * 10369 * @extends BaseEvent 10370 * @interface ClickEvent 10371 * @syscap SystemCapability.ArkUI.ArkUI.Full 10372 * @since 7 10373 */ 10374/** 10375 * The tap action triggers this method invocation. 10376 * 10377 * @extends BaseEvent 10378 * @interface ClickEvent 10379 * @syscap SystemCapability.ArkUI.ArkUI.Full 10380 * @form 10381 * @since 9 10382 */ 10383/** 10384 * The tap action triggers this method invocation. 10385 * 10386 * @extends BaseEvent 10387 * @interface ClickEvent 10388 * @syscap SystemCapability.ArkUI.ArkUI.Full 10389 * @crossplatform 10390 * @form 10391 * @since 10 10392 */ 10393/** 10394 * The tap action triggers this method invocation. 10395 * 10396 * @extends BaseEvent 10397 * @interface ClickEvent 10398 * @syscap SystemCapability.ArkUI.ArkUI.Full 10399 * @crossplatform 10400 * @form 10401 * @atomicservice 10402 * @since 11 10403 */ 10404declare interface ClickEvent extends BaseEvent { 10405 /** 10406 * X coordinate of the click point relative to the left edge of the device screen. 10407 * 10408 * @type { number } 10409 * @syscap SystemCapability.ArkUI.ArkUI.Full 10410 * @crossplatform 10411 * @since 10 10412 */ 10413 /** 10414 * X coordinate of the click point relative to the left edge of the device screen. 10415 * 10416 * @type { number } 10417 * @syscap SystemCapability.ArkUI.ArkUI.Full 10418 * @crossplatform 10419 * @atomicservice 10420 * @since 11 10421 */ 10422 displayX: number; 10423 10424 /** 10425 * Y coordinate of the click point relative to the upper edge of the device screen. 10426 * 10427 * @type { number } 10428 * @syscap SystemCapability.ArkUI.ArkUI.Full 10429 * @crossplatform 10430 * @since 10 10431 */ 10432 /** 10433 * Y coordinate of the click point relative to the upper edge of the device screen. 10434 * 10435 * @type { number } 10436 * @syscap SystemCapability.ArkUI.ArkUI.Full 10437 * @crossplatform 10438 * @atomicservice 10439 * @since 11 10440 */ 10441 displayY: number; 10442 10443 /** 10444 * X coordinate of the click point relative to the left edge of the current window. 10445 * 10446 * @type { number } 10447 * @syscap SystemCapability.ArkUI.ArkUI.Full 10448 * @crossplatform 10449 * @since 10 10450 */ 10451 /** 10452 * X coordinate of the click point relative to the left edge of the current window. 10453 * 10454 * @type { number } 10455 * @syscap SystemCapability.ArkUI.ArkUI.Full 10456 * @crossplatform 10457 * @atomicservice 10458 * @since 11 10459 */ 10460 windowX: number; 10461 10462 /** 10463 * Y coordinate of the click point relative to the upper edge of the current window. 10464 * 10465 * @type { number } 10466 * @syscap SystemCapability.ArkUI.ArkUI.Full 10467 * @crossplatform 10468 * @since 10 10469 */ 10470 /** 10471 * Y coordinate of the click point relative to the upper edge of the current window. 10472 * 10473 * @type { number } 10474 * @syscap SystemCapability.ArkUI.ArkUI.Full 10475 * @crossplatform 10476 * @atomicservice 10477 * @since 11 10478 */ 10479 windowY: number; 10480 10481 /** 10482 * X coordinate of the click point relative to the left edge of the current window. 10483 * 10484 * @type { number } 10485 * @syscap SystemCapability.ArkUI.ArkUI.Full 10486 * @since 7 10487 * @deprecated since 10 10488 * @useinstead ClickEvent#windowX 10489 */ 10490 screenX: number; 10491 10492 /** 10493 * Y coordinate of the click point relative to the upper edge of the current window. 10494 * 10495 * @type { number } 10496 * @syscap SystemCapability.ArkUI.ArkUI.Full 10497 * @since 7 10498 * @deprecated since 10 10499 * @useinstead ClickEvent#windowY 10500 */ 10501 screenY: number; 10502 10503 /** 10504 * X coordinate of the click point relative to the left edge of the clicked element. 10505 * 10506 * @type { number } 10507 * @syscap SystemCapability.ArkUI.ArkUI.Full 10508 * @since 7 10509 */ 10510 /** 10511 * X coordinate of the click point relative to the left edge of the clicked element. 10512 * 10513 * @type { number } 10514 * @syscap SystemCapability.ArkUI.ArkUI.Full 10515 * @form 10516 * @since 9 10517 */ 10518 /** 10519 * X coordinate of the click point relative to the left edge of the clicked element. 10520 * 10521 * @type { number } 10522 * @syscap SystemCapability.ArkUI.ArkUI.Full 10523 * @crossplatform 10524 * @form 10525 * @since 10 10526 */ 10527 /** 10528 * X coordinate of the click point relative to the left edge of the clicked element. 10529 * 10530 * @type { number } 10531 * @syscap SystemCapability.ArkUI.ArkUI.Full 10532 * @crossplatform 10533 * @form 10534 * @atomicservice 10535 * @since 11 10536 */ 10537 x: number; 10538 10539 /** 10540 * Y coordinate of the click point relative to the upper edge of the clicked element. 10541 * 10542 * @type { number } 10543 * @syscap SystemCapability.ArkUI.ArkUI.Full 10544 * @since 7 10545 */ 10546 /** 10547 * Y coordinate of the click point relative to the left edge of the clicked element. 10548 * 10549 * @type { number } 10550 * @syscap SystemCapability.ArkUI.ArkUI.Full 10551 * @form 10552 * @since 9 10553 */ 10554 /** 10555 * Y coordinate of the click point relative to the left edge of the clicked element. 10556 * 10557 * @type { number } 10558 * @syscap SystemCapability.ArkUI.ArkUI.Full 10559 * @crossplatform 10560 * @form 10561 * @since 10 10562 */ 10563 /** 10564 * Y coordinate of the click point relative to the left edge of the clicked element. 10565 * 10566 * @type { number } 10567 * @syscap SystemCapability.ArkUI.ArkUI.Full 10568 * @crossplatform 10569 * @form 10570 * @atomicservice 10571 * @since 11 10572 */ 10573 y: number; 10574 10575 /** 10576 * Type of the touch hand. 10577 * 10578 * @type { InteractionHand } 10579 * @syscap SystemCapability.ArkUI.ArkUI.Full 10580 * @crossplatform 10581 * @atomicservice 10582 * @since 15 10583 */ 10584 hand?: InteractionHand; 10585 10586 /** 10587 * Prevent the default function. 10588 * 10589 * @type { function } 10590 * @syscap SystemCapability.ArkUI.ArkUI.Full 10591 * @crossplatform 10592 * @atomicservice 10593 * @since 12 10594 */ 10595 preventDefault: () => void; 10596} 10597 10598/** 10599 * The hover action triggers this method invocation. 10600 * 10601 * @extends BaseEvent 10602 * @interface HoverEvent 10603 * @syscap SystemCapability.ArkUI.ArkUI.Full 10604 * @since 10 10605 */ 10606/** 10607 * The hover action triggers this method invocation. 10608 * 10609 * @extends BaseEvent 10610 * @interface HoverEvent 10611 * @syscap SystemCapability.ArkUI.ArkUI.Full 10612 * @atomicservice 10613 * @since 11 10614 */ 10615declare interface HoverEvent extends BaseEvent { 10616 /** 10617 * X coordinate of the hover point relative to the left edge of the hover element. 10618 * 10619 * @type { number } 10620 * @syscap SystemCapability.ArkUI.ArkUI.Full 10621 * @atomicservice 10622 * @since 15 10623 */ 10624 x?: number; 10625 10626 /** 10627 * Y coordinate of the hover point relative to the upper edge of the hover element. 10628 * 10629 * @type { number } 10630 * @syscap SystemCapability.ArkUI.ArkUI.Full 10631 * @atomicservice 10632 * @since 15 10633 */ 10634 y?: number; 10635 10636 /** 10637 * X coordinate of the hover point relative to the left edge of the current window. 10638 * 10639 * @type { number } 10640 * @syscap SystemCapability.ArkUI.ArkUI.Full 10641 * @atomicservice 10642 * @since 15 10643 */ 10644 windowX?: number; 10645 10646 /** 10647 * Y coordinate of the hover point relative to the upper edge of the current window. 10648 * 10649 * @type { number } 10650 * @syscap SystemCapability.ArkUI.ArkUI.Full 10651 * @atomicservice 10652 * @since 15 10653 */ 10654 windowY?: number; 10655 10656 /** 10657 * X coordinate of the hover point relative to the left edge of the device screen. 10658 * 10659 * @type { number } 10660 * @syscap SystemCapability.ArkUI.ArkUI.Full 10661 * @atomicservice 10662 * @since 15 10663 */ 10664 displayX?: number; 10665 10666 /** 10667 * Y coordinate of the hover point relative to the upper edge of the device screen. 10668 * 10669 * @type { number } 10670 * @syscap SystemCapability.ArkUI.ArkUI.Full 10671 * @atomicservice 10672 * @since 15 10673 */ 10674 displayY?: number; 10675 10676 /** 10677 * The blocking hover event pops up. 10678 * 10679 * @type { function } 10680 * @syscap SystemCapability.ArkUI.ArkUI.Full 10681 * @since 10 10682 */ 10683 /** 10684 * The blocking hover event pops up. 10685 * 10686 * @type { function } 10687 * @syscap SystemCapability.ArkUI.ArkUI.Full 10688 * @atomicservice 10689 * @since 11 10690 */ 10691 stopPropagation: () => void; 10692} 10693 10694/** 10695 * The mouse click action triggers this method invocation. 10696 * 10697 * @extends BaseEvent 10698 * @interface MouseEvent 10699 * @syscap SystemCapability.ArkUI.ArkUI.Full 10700 * @since 8 10701 */ 10702/** 10703 * The mouse click action triggers this method invocation. 10704 * 10705 * @extends BaseEvent 10706 * @interface MouseEvent 10707 * @syscap SystemCapability.ArkUI.ArkUI.Full 10708 * @atomicservice 10709 * @since 11 10710 */ 10711declare interface MouseEvent extends BaseEvent { 10712 /** 10713 * Mouse button of the click event. 10714 * 10715 * @type { MouseButton } 10716 * @syscap SystemCapability.ArkUI.ArkUI.Full 10717 * @since 8 10718 */ 10719 /** 10720 * Mouse button of the click event. 10721 * 10722 * @type { MouseButton } 10723 * @syscap SystemCapability.ArkUI.ArkUI.Full 10724 * @atomicservice 10725 * @since 11 10726 */ 10727 button: MouseButton; 10728 10729 /** 10730 * Mouse action of the click event. 10731 * 10732 * @type { MouseAction } 10733 * @syscap SystemCapability.ArkUI.ArkUI.Full 10734 * @since 8 10735 */ 10736 /** 10737 * Mouse action of the click event. 10738 * 10739 * @type { MouseAction } 10740 * @syscap SystemCapability.ArkUI.ArkUI.Full 10741 * @atomicservice 10742 * @since 11 10743 */ 10744 action: MouseAction; 10745 10746 /** 10747 * X coordinate of the mouse point relative to the left edge of the device screen. 10748 * 10749 * @type { number } 10750 * @syscap SystemCapability.ArkUI.ArkUI.Full 10751 * @since 10 10752 */ 10753 /** 10754 * X coordinate of the mouse point relative to the left edge of the device screen. 10755 * 10756 * @type { number } 10757 * @syscap SystemCapability.ArkUI.ArkUI.Full 10758 * @atomicservice 10759 * @since 11 10760 */ 10761 displayX: number; 10762 10763 /** 10764 * Y coordinate of the mouse point relative to the upper edge of the device screen. 10765 * 10766 * @type { number } 10767 * @syscap SystemCapability.ArkUI.ArkUI.Full 10768 * @since 10 10769 */ 10770 /** 10771 * Y coordinate of the mouse point relative to the upper edge of the device screen. 10772 * 10773 * @type { number } 10774 * @syscap SystemCapability.ArkUI.ArkUI.Full 10775 * @atomicservice 10776 * @since 11 10777 */ 10778 displayY: number; 10779 10780 /** 10781 * X coordinate of the mouse point relative to the left edge of the current window. 10782 * 10783 * @type { number } 10784 * @syscap SystemCapability.ArkUI.ArkUI.Full 10785 * @since 10 10786 */ 10787 /** 10788 * X coordinate of the mouse point relative to the left edge of the current window. 10789 * 10790 * @type { number } 10791 * @syscap SystemCapability.ArkUI.ArkUI.Full 10792 * @atomicservice 10793 * @since 11 10794 */ 10795 windowX: number; 10796 10797 /** 10798 * Y coordinate of the mouse point relative to the upper edge of the current window. 10799 * 10800 * @type { number } 10801 * @syscap SystemCapability.ArkUI.ArkUI.Full 10802 * @since 10 10803 */ 10804 /** 10805 * Y coordinate of the mouse point relative to the upper edge of the current window. 10806 * 10807 * @type { number } 10808 * @syscap SystemCapability.ArkUI.ArkUI.Full 10809 * @atomicservice 10810 * @since 11 10811 */ 10812 windowY: number; 10813 10814 /** 10815 * X coordinate of the mouse point relative to the left edge of the current window. 10816 * 10817 * @type { number } 10818 * @syscap SystemCapability.ArkUI.ArkUI.Full 10819 * @since 8 10820 * @deprecated since 10 10821 * @useinstead MouseEvent#windowX 10822 */ 10823 screenX: number; 10824 10825 /** 10826 * Y coordinate of the mouse point relative to the upper edge of the current window. 10827 * 10828 * @type { number } 10829 * @syscap SystemCapability.ArkUI.ArkUI.Full 10830 * @since 8 10831 * @deprecated since 10 10832 * @useinstead MouseEvent#windowY 10833 */ 10834 screenY: number; 10835 10836 /** 10837 * X coordinate of the mouse point relative to the left edge of the mouse hit element. 10838 * 10839 * @type { number } 10840 * @syscap SystemCapability.ArkUI.ArkUI.Full 10841 * @since 8 10842 */ 10843 /** 10844 * X coordinate of the mouse point relative to the left edge of the mouse hit element. 10845 * 10846 * @type { number } 10847 * @syscap SystemCapability.ArkUI.ArkUI.Full 10848 * @atomicservice 10849 * @since 11 10850 */ 10851 x: number; 10852 10853 /** 10854 * Y coordinate of the mouse point relative to the upper edge of the mouse hit element. 10855 * 10856 * @type { number } 10857 * @syscap SystemCapability.ArkUI.ArkUI.Full 10858 * @since 8 10859 */ 10860 /** 10861 * Y coordinate of the mouse point relative to the upper edge of the mouse hit element. 10862 * 10863 * @type { number } 10864 * @syscap SystemCapability.ArkUI.ArkUI.Full 10865 * @atomicservice 10866 * @since 11 10867 */ 10868 y: number; 10869 10870 /** 10871 * The blocking event pops up. 10872 * 10873 * @type { function } 10874 * @syscap SystemCapability.ArkUI.ArkUI.Full 10875 * @since 8 10876 */ 10877 /** 10878 * The blocking event pops up. 10879 * 10880 * @type { function } 10881 * @syscap SystemCapability.ArkUI.ArkUI.Full 10882 * @atomicservice 10883 * @since 11 10884 */ 10885 stopPropagation: () => void; 10886 10887 /** 10888 * X axis offset relative to the previous reported mouse pointer position. When the mouse pointer is at 10889 * the edge of the screen, the value may be less than the difference of the X coordinate reported twice. 10890 * 10891 * @type { ?number } 10892 * @syscap SystemCapability.ArkUI.ArkUI.Full 10893 * @atomicservice 10894 * @since 15 10895 */ 10896 rawDeltaX?: number; 10897 10898 /** 10899 * Y axis offset relative to the previous reported mouse pointer position. When the mouse pointer is at 10900 * the edge of the screen, the value may be less than the difference of the Y coordinate reported twice. 10901 * 10902 * @type { ?number } 10903 * @syscap SystemCapability.ArkUI.ArkUI.Full 10904 * @atomicservice 10905 * @since 15 10906 */ 10907 rawDeltaY?: number; 10908 10909 /** 10910 * The pressed buttons of the mouse event. 10911 * 10912 * @type { ?MouseButton[] } 10913 * @syscap SystemCapability.ArkUI.ArkUI.Full 10914 * @atomicservice 10915 * @since 15 10916 */ 10917 pressedButtons?: MouseButton[]; 10918} 10919 10920/** 10921 * The accessibility hover action triggers this method invocation. 10922 * 10923 * @extends BaseEvent 10924 * @typedef AccessibilityHoverEvent 10925 * @syscap SystemCapability.ArkUI.ArkUI.Full 10926 * @atomicservice 10927 * @since 12 10928 */ 10929declare interface AccessibilityHoverEvent extends BaseEvent { 10930 /** 10931 * Type of the accessibility hover event. 10932 * 10933 * @type { AccessibilityHoverType } 10934 * @syscap SystemCapability.ArkUI.ArkUI.Full 10935 * @atomicservice 10936 * @since 12 10937 */ 10938 type: AccessibilityHoverType; 10939 10940 /** 10941 * X coordinate of the accessibility hover point relative to the left edge of the event hit element. 10942 * 10943 * @type { number } 10944 * @syscap SystemCapability.ArkUI.ArkUI.Full 10945 * @atomicservice 10946 * @since 12 10947 */ 10948 x: number; 10949 10950 /** 10951 * Y coordinate of the accessibility hover point relative to the upper edge of the event hit element. 10952 * 10953 * @type { number } 10954 * @syscap SystemCapability.ArkUI.ArkUI.Full 10955 * @atomicservice 10956 * @since 12 10957 */ 10958 y: number; 10959 10960 /** 10961 * X coordinate of the accessibility hover point relative to the left edge of the device screen. 10962 * 10963 * @type { number } 10964 * @syscap SystemCapability.ArkUI.ArkUI.Full 10965 * @atomicservice 10966 * @since 12 10967 */ 10968 displayX: number; 10969 10970 /** 10971 * Y coordinate of the accessibility hover point relative to the upper edge of the device screen. 10972 * 10973 * @type { number } 10974 * @syscap SystemCapability.ArkUI.ArkUI.Full 10975 * @atomicservice 10976 * @since 12 10977 */ 10978 displayY: number; 10979 10980 /** 10981 * X coordinate of the accessibility hover point relative to the left edge of the current window. 10982 * 10983 * @type { number } 10984 * @syscap SystemCapability.ArkUI.ArkUI.Full 10985 * @atomicservice 10986 * @since 12 10987 */ 10988 windowX: number; 10989 10990 /** 10991 * Y coordinate of the accessibility hover point relative to the upper edge of the current window. 10992 * 10993 * @type { number } 10994 * @syscap SystemCapability.ArkUI.ArkUI.Full 10995 * @atomicservice 10996 * @since 12 10997 */ 10998 windowY: number; 10999} 11000 11001/** 11002 * Type of the touch event. 11003 * 11004 * @interface TouchObject 11005 * @syscap SystemCapability.ArkUI.ArkUI.Full 11006 * @since 7 11007 */ 11008/** 11009 * Type of the touch event. 11010 * 11011 * @interface TouchObject 11012 * @syscap SystemCapability.ArkUI.ArkUI.Full 11013 * @crossplatform 11014 * @since 10 11015 */ 11016/** 11017 * Type of the touch event. 11018 * 11019 * @interface TouchObject 11020 * @syscap SystemCapability.ArkUI.ArkUI.Full 11021 * @crossplatform 11022 * @atomicservice 11023 * @since 11 11024 */ 11025declare interface TouchObject { 11026 /** 11027 * Type of the touch event. 11028 * 11029 * @type { TouchType } 11030 * @syscap SystemCapability.ArkUI.ArkUI.Full 11031 * @since 7 11032 */ 11033 /** 11034 * Type of the touch event. 11035 * 11036 * @type { TouchType } 11037 * @syscap SystemCapability.ArkUI.ArkUI.Full 11038 * @crossplatform 11039 * @since 10 11040 */ 11041 /** 11042 * Type of the touch event. 11043 * 11044 * @type { TouchType } 11045 * @syscap SystemCapability.ArkUI.ArkUI.Full 11046 * @crossplatform 11047 * @atomicservice 11048 * @since 11 11049 */ 11050 type: TouchType; 11051 11052 /** 11053 * Finger unique identifier. 11054 * 11055 * @type { number } 11056 * @syscap SystemCapability.ArkUI.ArkUI.Full 11057 * @since 7 11058 */ 11059 /** 11060 * Finger unique identifier. 11061 * 11062 * @type { number } 11063 * @syscap SystemCapability.ArkUI.ArkUI.Full 11064 * @crossplatform 11065 * @since 10 11066 */ 11067 /** 11068 * Finger unique identifier. 11069 * 11070 * @type { number } 11071 * @syscap SystemCapability.ArkUI.ArkUI.Full 11072 * @crossplatform 11073 * @atomicservice 11074 * @since 11 11075 */ 11076 id: number; 11077 11078 /** 11079 * X coordinate of the touch point relative to the left edge of the device screen. 11080 * 11081 * @type { number } 11082 * @syscap SystemCapability.ArkUI.ArkUI.Full 11083 * @crossplatform 11084 * @since 10 11085 */ 11086 /** 11087 * X coordinate of the touch point relative to the left edge of the device screen. 11088 * 11089 * @type { number } 11090 * @syscap SystemCapability.ArkUI.ArkUI.Full 11091 * @crossplatform 11092 * @atomicservice 11093 * @since 11 11094 */ 11095 displayX: number; 11096 11097 /** 11098 * Y coordinate of the touch point relative to the upper edge of the device screen. 11099 * 11100 * @type { number } 11101 * @syscap SystemCapability.ArkUI.ArkUI.Full 11102 * @crossplatform 11103 * @since 10 11104 */ 11105 /** 11106 * Y coordinate of the touch point relative to the upper edge of the device screen. 11107 * 11108 * @type { number } 11109 * @syscap SystemCapability.ArkUI.ArkUI.Full 11110 * @crossplatform 11111 * @atomicservice 11112 * @since 11 11113 */ 11114 displayY: number; 11115 11116 /** 11117 * X coordinate of the touch point relative to the left edge of the current window. 11118 * 11119 * @type { number } 11120 * @syscap SystemCapability.ArkUI.ArkUI.Full 11121 * @crossplatform 11122 * @since 10 11123 */ 11124 /** 11125 * X coordinate of the touch point relative to the left edge of the current window. 11126 * 11127 * @type { number } 11128 * @syscap SystemCapability.ArkUI.ArkUI.Full 11129 * @crossplatform 11130 * @atomicservice 11131 * @since 11 11132 */ 11133 windowX: number; 11134 11135 /** 11136 * Y coordinate of the touch point relative to the upper edge of the current window. 11137 * 11138 * @type { number } 11139 * @syscap SystemCapability.ArkUI.ArkUI.Full 11140 * @crossplatform 11141 * @since 10 11142 */ 11143 /** 11144 * Y coordinate of the touch point relative to the upper edge of the current window. 11145 * 11146 * @type { number } 11147 * @syscap SystemCapability.ArkUI.ArkUI.Full 11148 * @crossplatform 11149 * @atomicservice 11150 * @since 11 11151 */ 11152 windowY: number; 11153 11154 /** 11155 * X coordinate of the touch point relative to the left edge of the current window. 11156 * 11157 * @type { number } 11158 * @syscap SystemCapability.ArkUI.ArkUI.Full 11159 * @since 7 11160 * @deprecated since 10 11161 * @useinstead TouchObject#windowX 11162 */ 11163 screenX: number; 11164 11165 /** 11166 * Y coordinate of the touch point relative to the upper edge of the current window. 11167 * 11168 * @type { number } 11169 * @syscap SystemCapability.ArkUI.ArkUI.Full 11170 * @since 7 11171 * @deprecated since 10 11172 * @useinstead TouchObject#windowY 11173 */ 11174 screenY: number; 11175 11176 /** 11177 * X coordinate of the touch point relative to the left edge of the touched element. 11178 * 11179 * @type { number } 11180 * @syscap SystemCapability.ArkUI.ArkUI.Full 11181 * @since 7 11182 */ 11183 /** 11184 * X coordinate of the touch point relative to the left edge of the touched element. 11185 * 11186 * @type { number } 11187 * @syscap SystemCapability.ArkUI.ArkUI.Full 11188 * @crossplatform 11189 * @since 10 11190 */ 11191 /** 11192 * X coordinate of the touch point relative to the left edge of the touched element. 11193 * 11194 * @type { number } 11195 * @syscap SystemCapability.ArkUI.ArkUI.Full 11196 * @crossplatform 11197 * @atomicservice 11198 * @since 11 11199 */ 11200 x: number; 11201 11202 /** 11203 * Y coordinate of the touch point relative to the upper edge of the touched element. 11204 * 11205 * @type { number } 11206 * @syscap SystemCapability.ArkUI.ArkUI.Full 11207 * @since 7 11208 */ 11209 /** 11210 * Y coordinate of the touch point relative to the upper edge of the touched element. 11211 * 11212 * @type { number } 11213 * @syscap SystemCapability.ArkUI.ArkUI.Full 11214 * @crossplatform 11215 * @since 10 11216 */ 11217 /** 11218 * Y coordinate of the touch point relative to the upper edge of the touched element. 11219 * 11220 * @type { number } 11221 * @syscap SystemCapability.ArkUI.ArkUI.Full 11222 * @crossplatform 11223 * @atomicservice 11224 * @since 11 11225 */ 11226 y: number; 11227 11228 /** 11229 * Type of the touch hand. 11230 * 11231 * @type { InteractionHand } 11232 * @syscap SystemCapability.ArkUI.ArkUI.Full 11233 * @crossplatform 11234 * @atomicservice 11235 * @since 15 11236 */ 11237 hand?: InteractionHand; 11238 11239 /** 11240 * Time stamp when the touch point is pressed. 11241 * 11242 * @type { ?number } 11243 * @syscap SystemCapability.ArkUI.ArkUI.Full 11244 * @crossplatform 11245 * @atomicservice 11246 * @since 15 11247 */ 11248 pressedTime?: number; 11249 /** 11250 * Pressure of a specific touch point. 11251 * 11252 * @type { ?number } 11253 * @syscap SystemCapability.ArkUI.ArkUI.Full 11254 * @crossplatform 11255 * @atomicservice 11256 * @since 15 11257 */ 11258 pressure?: number; 11259 11260 /** 11261 * Width of the contact area when touch is pressed of a specific touch point. 11262 * 11263 * @type { ?number } 11264 * @syscap SystemCapability.ArkUI.ArkUI.Full 11265 * @crossplatform 11266 * @atomicservice 11267 * @since 15 11268 */ 11269 width?: number; 11270 11271 /** 11272 * Height of the contact area when touch is pressed of a specific touch point. 11273 * 11274 * @type { ?number } 11275 * @syscap SystemCapability.ArkUI.ArkUI.Full 11276 * @crossplatform 11277 * @atomicservice 11278 * @since 15 11279 */ 11280 height?: number; 11281} 11282 11283/** 11284 * TouchObject getHistoricalPoints Function Parameters 11285 * 11286 * @interface HistoricalPoint 11287 * @syscap SystemCapability.ArkUI.ArkUI.Full 11288 * @crossplatform 11289 * @since 10 11290 */ 11291/** 11292 * TouchObject getHistoricalPoints Function Parameters 11293 * 11294 * @interface HistoricalPoint 11295 * @syscap SystemCapability.ArkUI.ArkUI.Full 11296 * @crossplatform 11297 * @atomicservice 11298 * @since 11 11299 */ 11300declare interface HistoricalPoint { 11301 /** 11302 * The base touchObject information of historicalPoint 11303 * 11304 * @type { TouchObject } 11305 * @syscap SystemCapability.ArkUI.ArkUI.Full 11306 * @crossplatform 11307 * @since 10 11308 */ 11309 /** 11310 * The base touchObject information of historicalPoint 11311 * 11312 * @type { TouchObject } 11313 * @syscap SystemCapability.ArkUI.ArkUI.Full 11314 * @crossplatform 11315 * @atomicservice 11316 * @since 11 11317 */ 11318 touchObject: TouchObject; 11319 11320 /** 11321 * Contact area between the finger pad and the screen. 11322 * 11323 * @type { number } 11324 * @syscap SystemCapability.ArkUI.ArkUI.Full 11325 * @crossplatform 11326 * @since 10 11327 */ 11328 /** 11329 * Contact area between the finger pad and the screen. 11330 * 11331 * @type { number } 11332 * @syscap SystemCapability.ArkUI.ArkUI.Full 11333 * @crossplatform 11334 * @atomicservice 11335 * @since 11 11336 */ 11337 size: number; 11338 11339 /** 11340 * Pressure of the touch event. 11341 * 11342 * @type { number } 11343 * @syscap SystemCapability.ArkUI.ArkUI.Full 11344 * @crossplatform 11345 * @since 10 11346 */ 11347 /** 11348 * Pressure of the touch event. 11349 * 11350 * @type { number } 11351 * @syscap SystemCapability.ArkUI.ArkUI.Full 11352 * @crossplatform 11353 * @atomicservice 11354 * @since 11 11355 */ 11356 force: number; 11357 11358 /** 11359 * Timestamp of the touch event. 11360 * 11361 * @type { number } 11362 * @syscap SystemCapability.ArkUI.ArkUI.Full 11363 * @crossplatform 11364 * @since 10 11365 */ 11366 /** 11367 * Timestamp of the touch event. 11368 * 11369 * @type { number } 11370 * @syscap SystemCapability.ArkUI.ArkUI.Full 11371 * @crossplatform 11372 * @atomicservice 11373 * @since 11 11374 */ 11375 timestamp: number; 11376} 11377 11378/** 11379 * Touch Action Function Parameters 11380 * 11381 * @extends BaseEvent 11382 * @interface TouchEvent 11383 * @syscap SystemCapability.ArkUI.ArkUI.Full 11384 * @since 7 11385 */ 11386/** 11387 * Touch Action Function Parameters 11388 * 11389 * @extends BaseEvent 11390 * @interface TouchEvent 11391 * @syscap SystemCapability.ArkUI.ArkUI.Full 11392 * @crossplatform 11393 * @since 10 11394 */ 11395/** 11396 * Touch Action Function Parameters 11397 * 11398 * @extends BaseEvent 11399 * @interface TouchEvent 11400 * @syscap SystemCapability.ArkUI.ArkUI.Full 11401 * @crossplatform 11402 * @atomicservice 11403 * @since 11 11404 */ 11405declare interface TouchEvent extends BaseEvent { 11406 /** 11407 * Type of the touch event. 11408 * 11409 * @type { TouchType } 11410 * @syscap SystemCapability.ArkUI.ArkUI.Full 11411 * @since 7 11412 */ 11413 /** 11414 * Type of the touch event. 11415 * 11416 * @type { TouchType } 11417 * @syscap SystemCapability.ArkUI.ArkUI.Full 11418 * @crossplatform 11419 * @since 10 11420 */ 11421 /** 11422 * Type of the touch event. 11423 * 11424 * @type { TouchType } 11425 * @syscap SystemCapability.ArkUI.ArkUI.Full 11426 * @crossplatform 11427 * @atomicservice 11428 * @since 11 11429 */ 11430 type: TouchType; 11431 11432 /** 11433 * All finger information. 11434 * 11435 * @type { TouchObject[] } 11436 * @syscap SystemCapability.ArkUI.ArkUI.Full 11437 * @since 7 11438 */ 11439 /** 11440 * All finger information. 11441 * 11442 * @type { TouchObject[] } 11443 * @syscap SystemCapability.ArkUI.ArkUI.Full 11444 * @crossplatform 11445 * @since 10 11446 */ 11447 /** 11448 * All finger information. 11449 * 11450 * @type { TouchObject[] } 11451 * @syscap SystemCapability.ArkUI.ArkUI.Full 11452 * @crossplatform 11453 * @atomicservice 11454 * @since 11 11455 */ 11456 touches: TouchObject[]; 11457 11458 /** 11459 * Indicates the current changed finger information. 11460 * 11461 * @type { TouchObject[] } 11462 * @syscap SystemCapability.ArkUI.ArkUI.Full 11463 * @since 7 11464 */ 11465 /** 11466 * Indicates the current changed finger information. 11467 * 11468 * @type { TouchObject[] } 11469 * @syscap SystemCapability.ArkUI.ArkUI.Full 11470 * @crossplatform 11471 * @since 10 11472 */ 11473 /** 11474 * Indicates the current changed finger information. 11475 * 11476 * @type { TouchObject[] } 11477 * @syscap SystemCapability.ArkUI.ArkUI.Full 11478 * @crossplatform 11479 * @atomicservice 11480 * @since 11 11481 */ 11482 changedTouches: TouchObject[]; 11483 11484 /** 11485 * The blocking event pops up. 11486 * 11487 * @type { function } 11488 * @syscap SystemCapability.ArkUI.ArkUI.Full 11489 * @since 7 11490 */ 11491 /** 11492 * The blocking event pops up. 11493 * 11494 * @type { function } 11495 * @syscap SystemCapability.ArkUI.ArkUI.Full 11496 * @crossplatform 11497 * @since 10 11498 */ 11499 /** 11500 * The blocking event pops up. 11501 * 11502 * @type { function } 11503 * @syscap SystemCapability.ArkUI.ArkUI.Full 11504 * @crossplatform 11505 * @atomicservice 11506 * @since 11 11507 */ 11508 stopPropagation: () => void; 11509 11510 /** 11511 * Get the historical points. 11512 * 11513 * @returns { Array<HistoricalPoint> } - return all historical points. 11514 * @syscap SystemCapability.ArkUI.ArkUI.Full 11515 * @crossplatform 11516 * @since 10 11517 */ 11518 /** 11519 * Get the historical points. 11520 * 11521 * @returns { Array<HistoricalPoint> } - return all historical points. 11522 * @syscap SystemCapability.ArkUI.ArkUI.Full 11523 * @crossplatform 11524 * @atomicservice 11525 * @since 11 11526 */ 11527 getHistoricalPoints(): Array<HistoricalPoint>; 11528 11529 /** 11530 * Prevent the default function. 11531 * 11532 * @type { function } 11533 * @syscap SystemCapability.ArkUI.ArkUI.Full 11534 * @crossplatform 11535 * @atomicservice 11536 * @since 12 11537 */ 11538 preventDefault: () => void; 11539} 11540 11541/** 11542 * The axis event triggers this method invocation. 11543 * 11544 * @extends BaseEvent 11545 * @interface AxisEvent 11546 * @syscap SystemCapability.ArkUI.ArkUI.Full 11547 * @atomicservice 11548 * @since 17 11549 */ 11550declare interface AxisEvent extends BaseEvent { 11551 /** 11552 * Axis action of the axis event. 11553 * 11554 * @type { AxisAction } 11555 * @syscap SystemCapability.ArkUI.ArkUI.Full 11556 * @atomicservice 11557 * @since 17 11558 */ 11559 action: AxisAction; 11560 11561 /** 11562 * X coordinate of the mouse cursor relative to the left edge of the device screen. 11563 * 11564 * @type { number } 11565 * @syscap SystemCapability.ArkUI.ArkUI.Full 11566 * @atomicservice 11567 * @since 17 11568 */ 11569 displayX: number; 11570 11571 /** 11572 * Y coordinate of the mouse cursor relative to the upper edge of the device screen. 11573 * 11574 * @type { number } 11575 * @syscap SystemCapability.ArkUI.ArkUI.Full 11576 * @atomicservice 11577 * @since 17 11578 */ 11579 displayY: number; 11580 11581 /** 11582 * X coordinate of the mouse cursor relative to the left edge of the current window. 11583 * 11584 * @type { number } 11585 * @syscap SystemCapability.ArkUI.ArkUI.Full 11586 * @atomicservice 11587 * @since 17 11588 */ 11589 windowX: number; 11590 11591 /** 11592 * Y coordinate of the mouse cursor relative to the upper edge of the current window. 11593 * 11594 * @type { number } 11595 * @syscap SystemCapability.ArkUI.ArkUI.Full 11596 * @atomicservice 11597 * @since 17 11598 */ 11599 windowY: number; 11600 11601 /** 11602 * X coordinate of the mouse cursor relative to the left edge of the axis event hit element. 11603 * 11604 * @type { number } 11605 * @syscap SystemCapability.ArkUI.ArkUI.Full 11606 * @atomicservice 11607 * @since 17 11608 */ 11609 x: number; 11610 11611 /** 11612 * Y coordinate of the mouse cursor relative to the upper edge of the axis event hit element. 11613 * 11614 * @type { number } 11615 * @syscap SystemCapability.ArkUI.ArkUI.Full 11616 * @atomicservice 11617 * @since 17 11618 */ 11619 y: number; 11620 11621 /** 11622 * Scroll step configuration which is only mouse wheel has. 11623 * * 11624 * @type { ?number } 11625 * @syscap SystemCapability.ArkUI.ArkUI.Full 11626 * @atomicservice 11627 * @since 17 11628 */ 11629 scrollStep?: number; 11630 11631 /** 11632 * Active event bubbling. 11633 * 11634 * @type { Callback<void> } 11635 * @syscap SystemCapability.ArkUI.ArkUI.Full 11636 * @atomicservice 11637 * @since 17 11638 */ 11639 propagation: Callback<void>; 11640 11641 /** 11642 * Obtains the value of the horizontal scroll axis for this axis event. 11643 * 11644 * @returns { number } 11645 * @syscap SystemCapability.ArkUI.ArkUI.Full 11646 * @atomicservice 11647 * @since 17 11648 */ 11649 getHorizontalAxisValue(): number; 11650 11651 /** 11652 * Obtains the value of the vertical scroll axis for this axis event. 11653 * 11654 * @returns { number } 11655 * @syscap SystemCapability.ArkUI.ArkUI.Full 11656 * @atomicservice 11657 * @since 17 11658 */ 11659 getVerticalAxisValue(): number; 11660} 11661 11662/** 11663 * Defines the callback type used in onSizeChange. 11664 * The value of oldValue is last size of the component. 11665 * The value of newValue is new size of the component. 11666 * 11667 * @typedef { function } SizeChangeCallback 11668 * @syscap SystemCapability.ArkUI.ArkUI.Full 11669 * @crossplatform 11670 * @form 11671 * @atomicservice 11672 * @since 12 11673 */ 11674declare type SizeChangeCallback = (oldValue: SizeOptions, newValue: SizeOptions) => void; 11675 11676/** 11677 * Defines the callback type used in onGestureRecognizerJudgeBegin. 11678 * 11679 * @typedef { function } GestureRecognizerJudgeBeginCallback 11680 * @param { BaseGestureEvent } event - the event information 11681 * @param { GestureRecognizer } current - the current gesture recognizer of the component 11682 * @param { Array<GestureRecognizer> } recognizers - the gesture recognizers of the component on the response chain 11683 * @returns { GestureJudgeResult } the gesture judge result 11684 * @syscap SystemCapability.ArkUI.ArkUI.Full 11685 * @crossplatform 11686 * @atomicservice 11687 * @since 12 11688 */ 11689declare type GestureRecognizerJudgeBeginCallback = (event: BaseGestureEvent, current: GestureRecognizer, recognizers: Array<GestureRecognizer>) => GestureJudgeResult; 11690 11691/** 11692 * Defines the callback type used in shouldBuiltInRecognizerParallelWith. 11693 * 11694 * @typedef { function } ShouldBuiltInRecognizerParallelWithCallback 11695 * @param { GestureRecognizer } current - the current gesture recognizer of the component 11696 * @param { Array<GestureRecognizer> } others - the gesture recognizers of the component on the response chain 11697 * @returns { GestureRecognizer } gesture recognizer of the component 11698 * @syscap SystemCapability.ArkUI.ArkUI.Full 11699 * @crossplatform 11700 * @atomicservice 11701 * @since 12 11702 */ 11703declare type ShouldBuiltInRecognizerParallelWithCallback = (current: GestureRecognizer, others: Array<GestureRecognizer>) => GestureRecognizer; 11704 11705/** 11706 * Defines the finish callback type used in transition. 11707 * 11708 * @typedef { function } TransitionFinishCallback 11709 * @param { boolean } transitionIn - a boolean value indicates whether it is the callback of transitionIn or transitionOut. 11710 * @syscap SystemCapability.ArkUI.ArkUI.Full 11711 * @crossplatform 11712 * @form 11713 * @atomicservice 11714 * @since 12 11715 */ 11716declare type TransitionFinishCallback = (transitionIn: boolean) => void; 11717 11718/** 11719 * Defines the PixelMap type object for ui component. 11720 * 11721 * @syscap SystemCapability.ArkUI.ArkUI.Full 11722 * @since 7 11723 */ 11724/** 11725 * Defines the PixelMap type object for ui component. 11726 * 11727 * @syscap SystemCapability.ArkUI.ArkUI.Full 11728 * @crossplatform 11729 * @since 10 11730 */ 11731/** 11732 * Defines the PixelMap type object for ui component. 11733 * 11734 * @typedef { import('../api/@ohos.multimedia.image').default.PixelMap } PixelMap 11735 * @syscap SystemCapability.ArkUI.ArkUI.Full 11736 * @crossplatform 11737 * @atomicservice 11738 * @since 11 11739 */ 11740declare type PixelMap = import('../api/@ohos.multimedia.image').default.PixelMap; 11741 11742/** 11743 * pixelmap object with release function. 11744 * 11745 * @interface PixelMapMock 11746 * @syscap SystemCapability.ArkUI.ArkUI.Full 11747 * @systemapi 11748 * @since 7 11749 */ 11750declare interface PixelMapMock { 11751 /** 11752 * release function. 11753 * 11754 * @syscap SystemCapability.ArkUI.ArkUI.Full 11755 * @systemapi 11756 * @since 7 11757 */ 11758 release(): void; 11759} 11760 11761/** 11762 * Enum for Drag Behavior. 11763 * 11764 * @enum { number } 11765 * @syscap SystemCapability.ArkUI.ArkUI.Full 11766 * @since 10 11767 */ 11768/** 11769 * Enum for Drag Behavior. 11770 * 11771 * @enum { number } 11772 * @syscap SystemCapability.ArkUI.ArkUI.Full 11773 * @atomicservice 11774 * @since 11 11775 */ 11776/** 11777 * Enum for Drag Behavior. 11778 * 11779 * @enum { number } 11780 * @syscap SystemCapability.ArkUI.ArkUI.Full 11781 * @crossplatform 11782 * @atomicservice 11783 * @since 18 11784 */ 11785declare enum DragBehavior { 11786 /** 11787 * If drag use copy event, then set DragBehavior.COPY. 11788 * 11789 * @syscap SystemCapability.ArkUI.ArkUI.Full 11790 * @since 10 11791 */ 11792 /** 11793 * If drag use copy event, then set DragBehavior.COPY. 11794 * 11795 * @syscap SystemCapability.ArkUI.ArkUI.Full 11796 * @atomicservice 11797 * @since 11 11798 */ 11799 /** 11800 * If drag use copy event, then set DragBehavior.COPY. 11801 * 11802 * @syscap SystemCapability.ArkUI.ArkUI.Full 11803 * @crossplatform 11804 * @atomicservice 11805 * @since 18 11806 */ 11807 COPY, 11808 /** 11809 * If drag use move event, then set DragBehavior.MOVE. 11810 * 11811 * @syscap SystemCapability.ArkUI.ArkUI.Full 11812 * @since 10 11813 */ 11814 /** 11815 * If drag use move event, then set DragBehavior.MOVE. 11816 * 11817 * @syscap SystemCapability.ArkUI.ArkUI.Full 11818 * @atomicservice 11819 * @since 11 11820 */ 11821 /** 11822 * If drag use move event, then set DragBehavior.MOVE. 11823 * 11824 * @syscap SystemCapability.ArkUI.ArkUI.Full 11825 * @crossplatform 11826 * @atomicservice 11827 * @since 18 11828 */ 11829 MOVE 11830} 11831 11832/** 11833 * Import the UnifiedData type object for ui component. 11834 * 11835 * @typedef { import('../api/@ohos.data.unifiedDataChannel').default.UnifiedData } UnifiedData 11836 * @syscap SystemCapability.ArkUI.ArkUI.Full 11837 * @crossplatform 11838 * @since 10 11839 */ 11840/** 11841 * Import the UnifiedData type object for ui component. 11842 * 11843 * @typedef { import('../api/@ohos.data.unifiedDataChannel').default.UnifiedData } UnifiedData 11844 * @syscap SystemCapability.ArkUI.ArkUI.Full 11845 * @crossplatform 11846 * @atomicservice 11847 * @since 11 11848 */ 11849declare type UnifiedData = import('../api/@ohos.data.unifiedDataChannel').default.UnifiedData; 11850 11851/** 11852 * Import the Summary type object for ui component. 11853 * 11854 * @typedef { import('../api/@ohos.data.unifiedDataChannel').default.Summary } Summary 11855 * @syscap SystemCapability.ArkUI.ArkUI.Full 11856 * @since 10 11857 */ 11858/** 11859 * Import the Summary type object for ui component. 11860 * 11861 * @typedef { import('../api/@ohos.data.unifiedDataChannel').default.Summary } Summary 11862 * @syscap SystemCapability.ArkUI.ArkUI.Full 11863 * @atomicservice 11864 * @since 11 11865 */ 11866declare type Summary = import('../api/@ohos.data.unifiedDataChannel').default.Summary; 11867 11868/** 11869 * Import the UniformDataType type object for ui component. 11870 * 11871 * @typedef { import('../api/@ohos.data.uniformTypeDescriptor').default.UniformDataType } UniformDataType 11872 * @syscap SystemCapability.ArkUI.ArkUI.Full 11873 * @since 10 11874 */ 11875/** 11876 * Import the UniformDataType type object for ui component. 11877 * 11878 * @typedef { import('../api/@ohos.data.uniformTypeDescriptor').default.UniformDataType } UniformDataType 11879 * @syscap SystemCapability.ArkUI.ArkUI.Full 11880 * @atomicservice 11881 * @since 11 11882 */ 11883declare type UniformDataType = import('../api/@ohos.data.uniformTypeDescriptor').default.UniformDataType; 11884 11885/** 11886 * Import the GetDataParams type object for ui component. 11887 * 11888 * @typedef { import('../api/@ohos.data.unifiedDataChannel').default.GetDataParams } GetDataParams 11889 * @syscap SystemCapability.ArkUI.ArkUI.Full 11890 * @crossplatform 11891 * @atomicservice 11892 * @since 15 11893 */ 11894declare type DataSyncOptions = import('../api/@ohos.data.unifiedDataChannel').default.GetDataParams; 11895 11896/** 11897 * Enum for Drag Result. 11898 * 11899 * @enum { number } 11900 * @syscap SystemCapability.ArkUI.ArkUI.Full 11901 * @since 10 11902 */ 11903/** 11904 * Enum for Drag Result. 11905 * 11906 * @enum { number } 11907 * @syscap SystemCapability.ArkUI.ArkUI.Full 11908 * @atomicservice 11909 * @since 11 11910 */ 11911/** 11912 * Enum for Drag Result. 11913 * 11914 * @enum { number } 11915 * @syscap SystemCapability.ArkUI.ArkUI.Full 11916 * @crossplatform 11917 * @atomicservice 11918 * @since 14 11919 */ 11920declare enum DragResult { 11921 /** 11922 * If the drag is successful, return DragResult.DRAG_SUCCESSFUL. 11923 * 11924 * @syscap SystemCapability.ArkUI.ArkUI.Full 11925 * @since 10 11926 */ 11927 /** 11928 * If the drag is successful, return DragResult.DRAG_SUCCESSFUL. 11929 * 11930 * @syscap SystemCapability.ArkUI.ArkUI.Full 11931 * @atomicservice 11932 * @since 11 11933 */ 11934 /** 11935 * If the drag is successful, return DragResult.DRAG_SUCCESSFUL. 11936 * 11937 * @syscap SystemCapability.ArkUI.ArkUI.Full 11938 * @crossplatform 11939 * @atomicservice 11940 * @since 14 11941 */ 11942 DRAG_SUCCESSFUL = 0, 11943 /** 11944 * If drag fail, return DragResult.DRAG_FAILED. 11945 * 11946 * @syscap SystemCapability.ArkUI.ArkUI.Full 11947 * @since 10 11948 */ 11949 /** 11950 * If drag fail, return DragResult.DRAG_FAILED. 11951 * 11952 * @syscap SystemCapability.ArkUI.ArkUI.Full 11953 * @atomicservice 11954 * @since 11 11955 */ 11956 /** 11957 * If drag fail, return DragResult.DRAG_FAILED. 11958 * 11959 * @syscap SystemCapability.ArkUI.ArkUI.Full 11960 * @crossplatform 11961 * @atomicservice 11962 * @since 14 11963 */ 11964 DRAG_FAILED = 1, 11965 /** 11966 * If drag action cancel, return DragResult.DRAG_CANCELED. 11967 * 11968 * @syscap SystemCapability.ArkUI.ArkUI.Full 11969 * @since 10 11970 */ 11971 /** 11972 * If drag action cancel, return DragResult.DRAG_CANCELED. 11973 * 11974 * @syscap SystemCapability.ArkUI.ArkUI.Full 11975 * @atomicservice 11976 * @since 11 11977 */ 11978 DRAG_CANCELED = 2, 11979 /** 11980 * If node allow drop in, return DragResult.DROP_ENABLED. 11981 * 11982 * @syscap SystemCapability.ArkUI.ArkUI.Full 11983 * @since 10 11984 */ 11985 /** 11986 * If node allow drop in, return DragResult.DROP_ENABLED. 11987 * 11988 * @syscap SystemCapability.ArkUI.ArkUI.Full 11989 * @atomicservice 11990 * @since 11 11991 */ 11992 DROP_ENABLED = 3, 11993 /** 11994 * If node don't allow drop in, return DragResult.DROP_DISABLED. 11995 * 11996 * @syscap SystemCapability.ArkUI.ArkUI.Full 11997 * @since 10 11998 */ 11999 /** 12000 * If node don't allow drop in, return DragResult.DROP_DISABLED. 12001 * 12002 * @syscap SystemCapability.ArkUI.ArkUI.Full 12003 * @atomicservice 12004 * @since 11 12005 */ 12006 DROP_DISABLED = 4 12007} 12008 12009/** 12010 * Enum for BlendMode. 12011 * Blend modes for compositing current component 12012 * with overlapping content. Use overlapping content 12013 * as dst, current component as src. 12014 * 12015 * @enum { number } 12016 * @syscap SystemCapability.ArkUI.ArkUI.Full 12017 * @crossplatform 12018 * @form 12019 * @since 11 12020 */ 12021/** 12022 * Enum for BlendMode. 12023 * Blend modes for compositing current component 12024 * with overlapping content. Use overlapping content 12025 * as dst, current component as src. 12026 * 12027 * @enum { number } 12028 * @syscap SystemCapability.ArkUI.ArkUI.Full 12029 * @crossplatform 12030 * @form 12031 * @atomicservice 12032 * @since 12 12033 */ 12034declare enum BlendMode { 12035 /** 12036 * Hybrid mode does not take effect 12037 * 12038 * @syscap SystemCapability.ArkUI.ArkUI.Full 12039 * @crossplatform 12040 * @form 12041 * @since 11 12042 */ 12043 /** 12044 * Hybrid mode does not take effect 12045 * 12046 * @syscap SystemCapability.ArkUI.ArkUI.Full 12047 * @crossplatform 12048 * @form 12049 * @atomicservice 12050 * @since 12 12051 */ 12052 NONE = 0, 12053 /** 12054 * Clear destination color covered by the source to 0. 12055 * 12056 * @syscap SystemCapability.ArkUI.ArkUI.Full 12057 * @crossplatform 12058 * @form 12059 * @since 11 12060 */ 12061 /** 12062 * Clear destination color covered by the source to 0. 12063 * 12064 * @syscap SystemCapability.ArkUI.ArkUI.Full 12065 * @crossplatform 12066 * @form 12067 * @atomicservice 12068 * @since 12 12069 */ 12070 CLEAR = 1, 12071 /** 12072 * r = s 12073 * 12074 * @syscap SystemCapability.ArkUI.ArkUI.Full 12075 * @crossplatform 12076 * @form 12077 * @since 11 12078 */ 12079 /** 12080 * r = s 12081 * 12082 * @syscap SystemCapability.ArkUI.ArkUI.Full 12083 * @crossplatform 12084 * @form 12085 * @atomicservice 12086 * @since 12 12087 */ 12088 SRC = 2, 12089 /** 12090 * r = d 12091 * 12092 * @syscap SystemCapability.ArkUI.ArkUI.Full 12093 * @crossplatform 12094 * @form 12095 * @since 11 12096 */ 12097 /** 12098 * r = d 12099 * 12100 * @syscap SystemCapability.ArkUI.ArkUI.Full 12101 * @crossplatform 12102 * @form 12103 * @atomicservice 12104 * @since 12 12105 */ 12106 DST = 3, 12107 /** 12108 * r = s + (1 - sa) * d 12109 * 12110 * @syscap SystemCapability.ArkUI.ArkUI.Full 12111 * @crossplatform 12112 * @form 12113 * @since 11 12114 */ 12115 /** 12116 * r = s + (1 - sa) * d 12117 * 12118 * @syscap SystemCapability.ArkUI.ArkUI.Full 12119 * @crossplatform 12120 * @form 12121 * @atomicservice 12122 * @since 12 12123 */ 12124 SRC_OVER = 4, 12125 /** 12126 * r = d + (1 - da) * s 12127 * 12128 * @syscap SystemCapability.ArkUI.ArkUI.Full 12129 * @crossplatform 12130 * @form 12131 * @since 11 12132 */ 12133 /** 12134 * r = d + (1 - da) * s 12135 * 12136 * @syscap SystemCapability.ArkUI.ArkUI.Full 12137 * @crossplatform 12138 * @form 12139 * @atomicservice 12140 * @since 12 12141 */ 12142 DST_OVER = 5, 12143 /** 12144 * r = s * da 12145 * 12146 * @syscap SystemCapability.ArkUI.ArkUI.Full 12147 * @crossplatform 12148 * @form 12149 * @since 11 12150 */ 12151 /** 12152 * r = s * da 12153 * 12154 * @syscap SystemCapability.ArkUI.ArkUI.Full 12155 * @crossplatform 12156 * @form 12157 * @atomicservice 12158 * @since 12 12159 */ 12160 SRC_IN = 6, 12161 /** 12162 * r = d * sa 12163 * 12164 * @syscap SystemCapability.ArkUI.ArkUI.Full 12165 * @crossplatform 12166 * @form 12167 * @since 11 12168 */ 12169 /** 12170 * r = d * sa 12171 * 12172 * @syscap SystemCapability.ArkUI.ArkUI.Full 12173 * @crossplatform 12174 * @form 12175 * @atomicservice 12176 * @since 12 12177 */ 12178 DST_IN = 7, 12179 /** 12180 * r = s * (1 - da) 12181 * 12182 * @syscap SystemCapability.ArkUI.ArkUI.Full 12183 * @crossplatform 12184 * @form 12185 * @since 11 12186 */ 12187 /** 12188 * r = s * (1 - da) 12189 * 12190 * @syscap SystemCapability.ArkUI.ArkUI.Full 12191 * @crossplatform 12192 * @form 12193 * @atomicservice 12194 * @since 12 12195 */ 12196 SRC_OUT = 8, 12197 /** 12198 * r = d * (1 - sa) 12199 * 12200 * @syscap SystemCapability.ArkUI.ArkUI.Full 12201 * @crossplatform 12202 * @form 12203 * @since 11 12204 */ 12205 /** 12206 * r = d * (1 - sa) 12207 * 12208 * @syscap SystemCapability.ArkUI.ArkUI.Full 12209 * @crossplatform 12210 * @form 12211 * @atomicservice 12212 * @since 12 12213 */ 12214 DST_OUT = 9, 12215 /** 12216 * r = s * da + d * (1 - sa) 12217 * 12218 * @syscap SystemCapability.ArkUI.ArkUI.Full 12219 * @crossplatform 12220 * @form 12221 * @since 11 12222 */ 12223 /** 12224 * r = s * da + d * (1 - sa) 12225 * 12226 * @syscap SystemCapability.ArkUI.ArkUI.Full 12227 * @crossplatform 12228 * @form 12229 * @atomicservice 12230 * @since 12 12231 */ 12232 SRC_ATOP = 10, 12233 /** 12234 * r = d * sa + s * (1 - da) 12235 * 12236 * @syscap SystemCapability.ArkUI.ArkUI.Full 12237 * @crossplatform 12238 * @form 12239 * @since 11 12240 */ 12241 /** 12242 * r = d * sa + s * (1 - da) 12243 * 12244 * @syscap SystemCapability.ArkUI.ArkUI.Full 12245 * @crossplatform 12246 * @form 12247 * @atomicservice 12248 * @since 12 12249 */ 12250 DST_ATOP = 11, 12251 /** 12252 * r = s * (1 - da) + d * (1 - sa) 12253 * 12254 * @syscap SystemCapability.ArkUI.ArkUI.Full 12255 * @crossplatform 12256 * @form 12257 * @since 11 12258 */ 12259 /** 12260 * r = s * (1 - da) + d * (1 - sa) 12261 * 12262 * @syscap SystemCapability.ArkUI.ArkUI.Full 12263 * @crossplatform 12264 * @form 12265 * @atomicservice 12266 * @since 12 12267 */ 12268 XOR = 12, 12269 /** 12270 * r = min(s + d, 1) 12271 * 12272 * @syscap SystemCapability.ArkUI.ArkUI.Full 12273 * @crossplatform 12274 * @form 12275 * @since 11 12276 */ 12277 /** 12278 * r = min(s + d, 1) 12279 * 12280 * @syscap SystemCapability.ArkUI.ArkUI.Full 12281 * @crossplatform 12282 * @form 12283 * @atomicservice 12284 * @since 12 12285 */ 12286 PLUS = 13, 12287 /** 12288 * r = s * d 12289 * 12290 * @syscap SystemCapability.ArkUI.ArkUI.Full 12291 * @crossplatform 12292 * @form 12293 * @since 11 12294 */ 12295 /** 12296 * r = s * d 12297 * 12298 * @syscap SystemCapability.ArkUI.ArkUI.Full 12299 * @crossplatform 12300 * @form 12301 * @atomicservice 12302 * @since 12 12303 */ 12304 MODULATE = 14, 12305 /** 12306 * r = s + d - s * d 12307 * 12308 * @syscap SystemCapability.ArkUI.ArkUI.Full 12309 * @crossplatform 12310 * @form 12311 * @since 11 12312 */ 12313 /** 12314 * r = s + d - s * d 12315 * 12316 * @syscap SystemCapability.ArkUI.ArkUI.Full 12317 * @crossplatform 12318 * @form 12319 * @atomicservice 12320 * @since 12 12321 */ 12322 SCREEN = 15, 12323 /** 12324 * multiply or screen, depending on destination 12325 * 12326 * @syscap SystemCapability.ArkUI.ArkUI.Full 12327 * @crossplatform 12328 * @form 12329 * @since 11 12330 */ 12331 /** 12332 * multiply or screen, depending on destination 12333 * 12334 * @syscap SystemCapability.ArkUI.ArkUI.Full 12335 * @crossplatform 12336 * @form 12337 * @atomicservice 12338 * @since 12 12339 */ 12340 OVERLAY = 16, 12341 /** 12342 * rc = s + d - max(s * da, d * sa), ra = kSrcOver 12343 * 12344 * @syscap SystemCapability.ArkUI.ArkUI.Full 12345 * @crossplatform 12346 * @form 12347 * @since 11 12348 */ 12349 /** 12350 * rc = s + d - max(s * da, d * sa), ra = kSrcOver 12351 * 12352 * @syscap SystemCapability.ArkUI.ArkUI.Full 12353 * @crossplatform 12354 * @form 12355 * @atomicservice 12356 * @since 12 12357 */ 12358 DARKEN = 17, 12359 /** 12360 * rc = s + d - min(s * da, d * sa), ra = kSrcOver 12361 * 12362 * @syscap SystemCapability.ArkUI.ArkUI.Full 12363 * @crossplatform 12364 * @form 12365 * @since 11 12366 */ 12367 /** 12368 * rc = s + d - min(s * da, d * sa), ra = kSrcOver 12369 * 12370 * @syscap SystemCapability.ArkUI.ArkUI.Full 12371 * @crossplatform 12372 * @form 12373 * @atomicservice 12374 * @since 12 12375 */ 12376 LIGHTEN = 18, 12377 /** 12378 * brighten destination to reflect source 12379 * 12380 * @syscap SystemCapability.ArkUI.ArkUI.Full 12381 * @crossplatform 12382 * @form 12383 * @since 11 12384 */ 12385 /** 12386 * brighten destination to reflect source 12387 * 12388 * @syscap SystemCapability.ArkUI.ArkUI.Full 12389 * @crossplatform 12390 * @form 12391 * @atomicservice 12392 * @since 12 12393 */ 12394 COLOR_DODGE = 19, 12395 /** 12396 * darken destination to reflect source 12397 * 12398 * @syscap SystemCapability.ArkUI.ArkUI.Full 12399 * @crossplatform 12400 * @form 12401 * @since 11 12402 */ 12403 /** 12404 * darken destination to reflect source 12405 * 12406 * @syscap SystemCapability.ArkUI.ArkUI.Full 12407 * @crossplatform 12408 * @form 12409 * @atomicservice 12410 * @since 12 12411 */ 12412 COLOR_BURN = 20, 12413 /** 12414 * multiply or screen, depending on source 12415 * 12416 * @syscap SystemCapability.ArkUI.ArkUI.Full 12417 * @crossplatform 12418 * @form 12419 * @since 11 12420 */ 12421 /** 12422 * multiply or screen, depending on source 12423 * 12424 * @syscap SystemCapability.ArkUI.ArkUI.Full 12425 * @crossplatform 12426 * @form 12427 * @atomicservice 12428 * @since 12 12429 */ 12430 HARD_LIGHT = 21, 12431 /** 12432 * lighten or darken, depending on source 12433 * 12434 * @syscap SystemCapability.ArkUI.ArkUI.Full 12435 * @crossplatform 12436 * @form 12437 * @since 11 12438 */ 12439 /** 12440 * lighten or darken, depending on source 12441 * 12442 * @syscap SystemCapability.ArkUI.ArkUI.Full 12443 * @crossplatform 12444 * @form 12445 * @atomicservice 12446 * @since 12 12447 */ 12448 SOFT_LIGHT = 22, 12449 /** 12450 * rc = s + d - 2 * (min(s * da, d * sa)), ra = kSrcOver 12451 * 12452 * @syscap SystemCapability.ArkUI.ArkUI.Full 12453 * @crossplatform 12454 * @form 12455 * @since 11 12456 */ 12457 /** 12458 * rc = s + d - 2 * (min(s * da, d * sa)), ra = kSrcOver 12459 * 12460 * @syscap SystemCapability.ArkUI.ArkUI.Full 12461 * @crossplatform 12462 * @form 12463 * @atomicservice 12464 * @since 12 12465 */ 12466 DIFFERENCE = 23, 12467 /** 12468 * rc = s + d - two(s * d), ra = kSrcOver 12469 * 12470 * @syscap SystemCapability.ArkUI.ArkUI.Full 12471 * @crossplatform 12472 * @form 12473 * @since 11 12474 */ 12475 /** 12476 * rc = s + d - two(s * d), ra = kSrcOver 12477 * 12478 * @syscap SystemCapability.ArkUI.ArkUI.Full 12479 * @crossplatform 12480 * @form 12481 * @atomicservice 12482 * @since 12 12483 */ 12484 EXCLUSION = 24, 12485 /** 12486 * r = s * (1 - da) + d * (1 - sa) + s * d 12487 * 12488 * @syscap SystemCapability.ArkUI.ArkUI.Full 12489 * @crossplatform 12490 * @form 12491 * @since 11 12492 */ 12493 /** 12494 * r = s * (1 - da) + d * (1 - sa) + s * d 12495 * 12496 * @syscap SystemCapability.ArkUI.ArkUI.Full 12497 * @crossplatform 12498 * @form 12499 * @atomicservice 12500 * @since 12 12501 */ 12502 MULTIPLY = 25, 12503 /** 12504 * hue of source with saturation and luminosity of destination 12505 * 12506 * @syscap SystemCapability.ArkUI.ArkUI.Full 12507 * @crossplatform 12508 * @form 12509 * @since 11 12510 */ 12511 /** 12512 * hue of source with saturation and luminosity of destination 12513 * 12514 * @syscap SystemCapability.ArkUI.ArkUI.Full 12515 * @crossplatform 12516 * @form 12517 * @atomicservice 12518 * @since 12 12519 */ 12520 HUE = 26, 12521 /** 12522 * saturation of source with hue and luminosity of destination 12523 * 12524 * @syscap SystemCapability.ArkUI.ArkUI.Full 12525 * @crossplatform 12526 * @form 12527 * @since 11 12528 */ 12529 /** 12530 * saturation of source with hue and luminosity of destination 12531 * 12532 * @syscap SystemCapability.ArkUI.ArkUI.Full 12533 * @crossplatform 12534 * @form 12535 * @atomicservice 12536 * @since 12 12537 */ 12538 SATURATION = 27, 12539 /** 12540 * hue and saturation of source with luminosity of destination 12541 * 12542 * @syscap SystemCapability.ArkUI.ArkUI.Full 12543 * @crossplatform 12544 * @form 12545 * @since 11 12546 */ 12547 /** 12548 * hue and saturation of source with luminosity of destination 12549 * 12550 * @syscap SystemCapability.ArkUI.ArkUI.Full 12551 * @crossplatform 12552 * @form 12553 * @atomicservice 12554 * @since 12 12555 */ 12556 COLOR = 28, 12557 /** 12558 * luminosity of source with hue and saturation of destination 12559 * 12560 * @syscap SystemCapability.ArkUI.ArkUI.Full 12561 * @crossplatform 12562 * @form 12563 * @since 11 12564 */ 12565 /** 12566 * luminosity of source with hue and saturation of destination 12567 * 12568 * @syscap SystemCapability.ArkUI.ArkUI.Full 12569 * @crossplatform 12570 * @form 12571 * @atomicservice 12572 * @since 12 12573 */ 12574 LUMINOSITY = 29 12575} 12576 12577/** 12578 * Enum for BlendApplyType. 12579 * Indicate how to apply specified blend mode to 12580 * the view's content. 12581 * 12582 * @enum { number } 12583 * @syscap SystemCapability.ArkUI.ArkUI.Full 12584 * @crossplatform 12585 * @form 12586 * @since 11 12587 */ 12588/** 12589 * Enum for BlendApplyType. 12590 * Indicate how to apply specified blend mode to 12591 * the view's content. 12592 * 12593 * @enum { number } 12594 * @syscap SystemCapability.ArkUI.ArkUI.Full 12595 * @crossplatform 12596 * @form 12597 * @atomicservice 12598 * @since 12 12599 */ 12600declare enum BlendApplyType { 12601 /** 12602 * Blend view's content in sequence over dst 12603 * 12604 * @syscap SystemCapability.ArkUI.ArkUI.Full 12605 * @crossplatform 12606 * @form 12607 * @since 11 12608 */ 12609 /** 12610 * Blend view's content in sequence over dst 12611 * 12612 * @syscap SystemCapability.ArkUI.ArkUI.Full 12613 * @crossplatform 12614 * @form 12615 * @atomicservice 12616 * @since 12 12617 */ 12618 FAST = 0, 12619 12620 /** 12621 * Composite this views's contents into an 12622 * offscreen image and then blend over dst 12623 * 12624 * @syscap SystemCapability.ArkUI.ArkUI.Full 12625 * @crossplatform 12626 * @form 12627 * @since 11 12628 */ 12629 /** 12630 * Composite this views's contents into an 12631 * offscreen image and then blend over dst 12632 * 12633 * @syscap SystemCapability.ArkUI.ArkUI.Full 12634 * @crossplatform 12635 * @form 12636 * @atomicservice 12637 * @since 12 12638 */ 12639 OFFSCREEN = 1, 12640} 12641 12642/** 12643 * DragEvent object description 12644 * 12645 * @interface DragEvent 12646 * @syscap SystemCapability.ArkUI.ArkUI.Full 12647 * @since 7 12648 */ 12649/** 12650 * DragEvent object description 12651 * 12652 * @interface DragEvent 12653 * @syscap SystemCapability.ArkUI.ArkUI.Full 12654 * @atomicservice 12655 * @since 11 12656 */ 12657/** 12658 * DragEvent object description 12659 * 12660 * @interface DragEvent 12661 * @syscap SystemCapability.ArkUI.ArkUI.Full 12662 * @crossplatform 12663 * @atomicservice 12664 * @since 14 12665 */ 12666declare interface DragEvent { 12667 /** 12668 * X coordinate of the touch point relative to the left edge of the device screen. 12669 * 12670 * @returns { number } 12671 * @syscap SystemCapability.ArkUI.ArkUI.Full 12672 * @since 10 12673 */ 12674 /** 12675 * X coordinate of the touch point relative to the left edge of the device screen. 12676 * 12677 * @returns { number } 12678 * @syscap SystemCapability.ArkUI.ArkUI.Full 12679 * @atomicservice 12680 * @since 11 12681 */ 12682 /** 12683 * X coordinate of the touch point relative to the left edge of the device screen. 12684 * 12685 * @returns { number } 12686 * @syscap SystemCapability.ArkUI.ArkUI.Full 12687 * @crossplatform 12688 * @atomicservice 12689 * @since 14 12690 */ 12691 getDisplayX(): number; 12692 12693 /** 12694 * Y coordinate of the touch point relative to the upper edge of the device screen. 12695 * 12696 * @returns { number } 12697 * @syscap SystemCapability.ArkUI.ArkUI.Full 12698 * @since 10 12699 */ 12700 /** 12701 * Y coordinate of the touch point relative to the upper edge of the device screen. 12702 * 12703 * @returns { number } 12704 * @syscap SystemCapability.ArkUI.ArkUI.Full 12705 * @atomicservice 12706 * @since 11 12707 */ 12708 /** 12709 * Y coordinate of the touch point relative to the upper edge of the device screen. 12710 * 12711 * @returns { number } 12712 * @syscap SystemCapability.ArkUI.ArkUI.Full 12713 * @crossplatform 12714 * @atomicservice 12715 * @since 14 12716 */ 12717 getDisplayY(): number; 12718 12719 /** 12720 * X coordinate of the touch point relative to the left edge of the current window. 12721 * 12722 * @returns { number } 12723 * @syscap SystemCapability.ArkUI.ArkUI.Full 12724 * @since 10 12725 */ 12726 /** 12727 * X coordinate of the touch point relative to the left edge of the current window. 12728 * 12729 * @returns { number } 12730 * @syscap SystemCapability.ArkUI.ArkUI.Full 12731 * @atomicservice 12732 * @since 11 12733 */ 12734 /** 12735 * X coordinate of the touch point relative to the left edge of the current window. 12736 * 12737 * @returns { number } 12738 * @syscap SystemCapability.ArkUI.ArkUI.Full 12739 * @crossplatform 12740 * @atomicservice 12741 * @since 14 12742 */ 12743 getWindowX(): number; 12744 12745 /** 12746 * Y coordinate of the touch point relative to the left edge of the current window. 12747 * 12748 * @returns { number } 12749 * @syscap SystemCapability.ArkUI.ArkUI.Full 12750 * @since 10 12751 */ 12752 /** 12753 * Y coordinate of the touch point relative to the left edge of the current window. 12754 * 12755 * @returns { number } 12756 * @syscap SystemCapability.ArkUI.ArkUI.Full 12757 * @atomicservice 12758 * @since 11 12759 */ 12760 /** 12761 * Y coordinate of the touch point relative to the left edge of the current window. 12762 * 12763 * @returns { number } 12764 * @syscap SystemCapability.ArkUI.ArkUI.Full 12765 * @crossplatform 12766 * @atomicservice 12767 * @since 14 12768 */ 12769 getWindowY(): number; 12770 12771 /** 12772 * X coordinate of the touch point relative to the left edge of the current window. in vp. 12773 * 12774 * @returns { number } 12775 * @syscap SystemCapability.ArkUI.ArkUI.Full 12776 * @since 7 12777 * @deprecated since 10 12778 * @useinstead DragEvent#getWindowX 12779 */ 12780 getX(): number; 12781 12782 /** 12783 * Y coordinate of the touch point relative to the left edge of the current window. in vp. 12784 * 12785 * @returns { number } 12786 * @syscap SystemCapability.ArkUI.ArkUI.Full 12787 * @since 7 12788 * @deprecated since 10 12789 * @useinstead DragEvent#getWindowY 12790 */ 12791 getY(): number; 12792 12793 /** 12794 * If copy is COPY, this DragEvent is a copy event. 12795 * @type { DragBehavior } Operation, if use copy then set COPY, else set MOVE. 12796 * @default COPY 12797 * @syscap SystemCapability.ArkUI.ArkUI.Full 12798 * @since 10 12799 */ 12800 /** 12801 * If copy is COPY, this DragEvent is a copy event. 12802 * @type { DragBehavior } Operation, if use copy then set COPY, else set MOVE. 12803 * @default COPY 12804 * @syscap SystemCapability.ArkUI.ArkUI.Full 12805 * @atomicservice 12806 * @since 11 12807 */ 12808 /** 12809 * If copy is COPY, this DragEvent is a copy event. 12810 * @type { DragBehavior } Operation, if use copy then set COPY, else set MOVE. 12811 * @default COPY 12812 * @syscap SystemCapability.ArkUI.ArkUI.Full 12813 * @crossplatform 12814 * @atomicservice 12815 * @since 18 12816 */ 12817 dragBehavior: DragBehavior; 12818 12819 /** 12820 * If useCustomDropAnimation is true, System will not use drop animation. 12821 * 12822 * @type { boolean } 12823 * @syscap SystemCapability.ArkUI.ArkUI.Full 12824 * @since 10 12825 */ 12826 /** 12827 * If useCustomDropAnimation is true, System will not use drop animation. 12828 * 12829 * @type { boolean } 12830 * @syscap SystemCapability.ArkUI.ArkUI.Full 12831 * @atomicservice 12832 * @since 11 12833 */ 12834 useCustomDropAnimation: boolean; 12835 12836 /** 12837 * Set dragData into DragEvent. 12838 * 12839 * @param { UnifiedData } unifiedData - dragData. 12840 * @syscap SystemCapability.ArkUI.ArkUI.Full 12841 * @crossplatform 12842 * @since 10 12843 */ 12844 /** 12845 * Set dragData into DragEvent. 12846 * 12847 * @param { UnifiedData } unifiedData - dragData. 12848 * @syscap SystemCapability.ArkUI.ArkUI.Full 12849 * @crossplatform 12850 * @atomicservice 12851 * @since 11 12852 */ 12853 setData(unifiedData: UnifiedData): void; 12854 12855 /** 12856 * Get dragData from DragEvent. 12857 * 12858 * @returns { UnifiedData } - get dragData. 12859 * @throws { BusinessError } 190001 - Data not found. 12860 * @throws { BusinessError } 190002 - Data error. 12861 * @syscap SystemCapability.ArkUI.ArkUI.Full 12862 * @crossplatform 12863 * @since 10 12864 */ 12865 /** 12866 * Get dragData from DragEvent. 12867 * 12868 * @returns { UnifiedData } - get dragData. 12869 * @throws { BusinessError } 190001 - Data not found. 12870 * @throws { BusinessError } 190002 - Data error. 12871 * @syscap SystemCapability.ArkUI.ArkUI.Full 12872 * @crossplatform 12873 * @atomicservice 12874 * @since 11 12875 */ 12876 getData(): UnifiedData; 12877 12878 /** 12879 * Get dragData summary from DragEvent. 12880 * 12881 * @returns { Summary } - get Summary Data. 12882 * @syscap SystemCapability.ArkUI.ArkUI.Full 12883 * @crossplatform 12884 * @since 10 12885 */ 12886 /** 12887 * Get dragData summary from DragEvent. 12888 * 12889 * @returns { Summary } - get Summary Data. 12890 * @syscap SystemCapability.ArkUI.ArkUI.Full 12891 * @crossplatform 12892 * @atomicservice 12893 * @since 11 12894 */ 12895 getSummary(): Summary; 12896 12897 /** 12898 * Set dragEvent result to DragEvent. 12899 * 12900 * @param { DragResult } dragResult - the return of dragEvent. 12901 * @syscap SystemCapability.ArkUI.ArkUI.Full 12902 * @since 10 12903 */ 12904 /** 12905 * Set dragEvent result to DragEvent. 12906 * 12907 * @param { DragResult } dragResult - the return of dragEvent. 12908 * @syscap SystemCapability.ArkUI.ArkUI.Full 12909 * @atomicservice 12910 * @since 11 12911 */ 12912 /** 12913 * Set dragEvent result to DragEvent. 12914 * 12915 * @param { DragResult } dragResult - the return of dragEvent. 12916 * @syscap SystemCapability.ArkUI.ArkUI.Full 12917 * @crossplatform 12918 * @atomicservice 12919 * @since 14 12920 */ 12921 setResult(dragResult: DragResult): void; 12922 12923 /** 12924 * Get dragEvent result from DragEvent. 12925 * 12926 * @returns { DragResult } - dragResult Data. 12927 * @syscap SystemCapability.ArkUI.ArkUI.Full 12928 * @since 10 12929 */ 12930 /** 12931 * Get dragEvent result from DragEvent. 12932 * 12933 * @returns { DragResult } - dragResult Data. 12934 * @syscap SystemCapability.ArkUI.ArkUI.Full 12935 * @atomicservice 12936 * @since 11 12937 */ 12938 /** 12939 * Get dragEvent result from DragEvent. 12940 * 12941 * @returns { DragResult } - dragResult Data. 12942 * @syscap SystemCapability.ArkUI.ArkUI.Full 12943 * @crossplatform 12944 * @atomicservice 12945 * @since 14 12946 */ 12947 getResult(): DragResult; 12948 12949 /** 12950 * Get the rectangle of drag window. 12951 * 12952 * @returns { Rectangle } - getPreview rectangle. 12953 * @syscap SystemCapability.ArkUI.ArkUI.Full 12954 * @since 10 12955 */ 12956 /** 12957 * Get the rectangle of drag window. 12958 * 12959 * @returns { Rectangle } - getPreview rectangle. 12960 * @syscap SystemCapability.ArkUI.ArkUI.Full 12961 * @atomicservice 12962 * @since 11 12963 */ 12964 /** 12965 * Get the rectangle of drag window. 12966 * 12967 * @returns { Rectangle } - getPreview rectangle. 12968 * @syscap SystemCapability.ArkUI.ArkUI.Full 12969 * @crossplatform 12970 * @atomicservice 12971 * @since 14 12972 */ 12973 getPreviewRect(): Rectangle; 12974 12975 /** 12976 * Get the x axis velocity of drag gesture. 12977 * 12978 * @returns { number } - get x axis velocity. 12979 * @syscap SystemCapability.ArkUI.ArkUI.Full 12980 * @crossplatform 12981 * @since 10 12982 */ 12983 /** 12984 * Get the x axis velocity of drag gesture. 12985 * 12986 * @returns { number } - get x axis velocity. 12987 * @syscap SystemCapability.ArkUI.ArkUI.Full 12988 * @crossplatform 12989 * @atomicservice 12990 * @since 11 12991 */ 12992 getVelocityX(): number; 12993 12994 /** 12995 * Get the y axis velocity of drag gesture. 12996 * 12997 * @returns { number } - get y axis velocity. 12998 * @syscap SystemCapability.ArkUI.ArkUI.Full 12999 * @crossplatform 13000 * @since 10 13001 */ 13002 /** 13003 * Get the y axis velocity of drag gesture. 13004 * 13005 * @returns { number } - get y axis velocity. 13006 * @syscap SystemCapability.ArkUI.ArkUI.Full 13007 * @crossplatform 13008 * @atomicservice 13009 * @since 11 13010 */ 13011 getVelocityY(): number; 13012 13013 /** 13014 * Get the velocity of drag gesture. 13015 * 13016 * @returns { number } - get velocity. 13017 * @syscap SystemCapability.ArkUI.ArkUI.Full 13018 * @crossplatform 13019 * @since 10 13020 */ 13021 /** 13022 * Get the velocity of drag gesture. 13023 * 13024 * @returns { number } - get velocity. 13025 * @syscap SystemCapability.ArkUI.ArkUI.Full 13026 * @crossplatform 13027 * @atomicservice 13028 * @since 11 13029 */ 13030 getVelocity(): number; 13031 13032 /** 13033 * Query the ModifierKey press state, support 'ctrl'|'alt'|'shift'|'fn' 13034 * 13035 * @param { Array<string> } keys - indicate the keys of the ModifierKey. 13036 * @returns { boolean } 13037 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 13038 * @syscap SystemCapability.ArkUI.ArkUI.Full 13039 * @crossplatform 13040 * @since 12 13041 */ 13042 /** 13043 * Query the ModifierKey press state, support 'ctrl'|'alt'|'shift'|'fn' 13044 * 13045 * @param { Array<string> } keys - indicate the keys of the ModifierKey. 13046 * @returns { boolean } 13047 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 13048 * @syscap SystemCapability.ArkUI.ArkUI.Full 13049 * @crossplatform 13050 * @atomicservice 13051 * @since 13 13052 */ 13053 getModifierKeyState?(keys: Array<string>): boolean; 13054 13055 /** 13056 * Setup one drop animation execution callback, which will be triggered by system when user drops. 13057 * Use this way to implement the custom drop animation instead of doing it in onDrop, as the system 13058 * will decide when to trigger the callback during the drop handling. 13059 * [Note]: 13060 * 1. Please set useCustomDropAnimation to true as well when using this method. 13061 * 2. Do not implement the animation no-related logics in the callback. 13062 * 13063 * @param { Callback<void> } customDropAnimation - the custom drop animation function. 13064 * @syscap SystemCapability.ArkUI.ArkUI.Full 13065 * @crossplatform 13066 * @atomicservice 13067 * @since 18 13068 */ 13069 executeDropAnimation(customDropAnimation: Callback<void>): void; 13070 13071 /** 13072 * Request the drag data to be synchronized to caller, can be notified with the synchronization progress. 13073 * Only can be used in onDrop event processing. 13074 * 13075 * @param { DataSyncOptions } options - the data sync options. 13076 * @returns { string } The data key returned by system, which can be used as the identify of the request. 13077 * @throws { BusinessError } 401 - Parameter error. 13078 * @throws { BusinessError } 190003 - Operation no allowed for current pharse. 13079 * @syscap SystemCapability.ArkUI.ArkUI.Full 13080 * @atomicservice 13081 * @since 15 13082 */ 13083 startDataLoading(options: DataSyncOptions): string; 13084} 13085 13086/** 13087 * The event callback function for drag and drop common interfaces. 13088 * @typedef { function } OnDragEventCallback 13089 * @param { DragEvent } event - the event object indicating current drag status. 13090 * @param { string } [extraParams] - extra information set by user or system. 13091 * @syscap SystemCapability.ArkUI.ArkUI.Full 13092 * @crossplatform 13093 * @atomicservice 13094 * @since 15 13095 */ 13096declare type OnDragEventCallback = (event: DragEvent, extraParams?: string) => void; 13097 13098/** 13099 * Defines the options for the drop handling. 13100 * 13101 * @interface DropOptions 13102 * @syscap SystemCapability.ArkUI.ArkUI.Full 13103 * @crossplatform 13104 * @atomicservice 13105 * @since 15 13106 */ 13107declare interface DropOptions { 13108 13109 /** 13110 * Indicating to disable the UDMF data prefetch action by system or not. 13111 * The system will try to fetch data before calling user's onDrop for some situation, 13112 * it will retry to get data until the max time limit (2.4s for now) reaches, 13113 * this's useful for the cross device draging operation, as the system helps to eliminate 13114 * the communication instability, but it's redundant for startDataLoading method, as this 13115 * method will take care the data fetching with asynchronous mechanism, so must set this 13116 * field to true if using startDataLoading in onDrop to avoid the data is fetched before 13117 * onDrop executing unexpectedly. 13118 * 13119 * @type { boolean } 13120 * @syscap SystemCapability.ArkUI.ArkUI.Full 13121 * @crossplatform 13122 * @atomicservice 13123 * @since 15 13124 */ 13125 disableDataPrefetch?: boolean; 13126} 13127 13128/** 13129 * Import the IntentionCode type object for IntentionCode. 13130 * 13131 * @typedef { import('../api/@ohos.multimodalInput.intentionCode').IntentionCode } IntentionCode 13132 * @syscap SystemCapability.ArkUI.ArkUI.Full 13133 * @since 10 13134 */ 13135/** 13136 * Import the IntentionCode type object for IntentionCode. 13137 * 13138 * @typedef { import('../api/@ohos.multimodalInput.intentionCode').IntentionCode } IntentionCode 13139 * @syscap SystemCapability.ArkUI.ArkUI.Full 13140 * @atomicservice 13141 * @since 11 13142 */ 13143declare type IntentionCode = import('../api/@ohos.multimodalInput.intentionCode').IntentionCode; 13144 13145/** 13146 * KeyEvent object description: 13147 * 13148 * @interface KeyEvent 13149 * @syscap SystemCapability.ArkUI.ArkUI.Full 13150 * @since 7 13151 */ 13152/** 13153 * KeyEvent object description: 13154 * 13155 * @interface KeyEvent 13156 * @syscap SystemCapability.ArkUI.ArkUI.Full 13157 * @crossplatform 13158 * @since 10 13159 */ 13160/** 13161 * KeyEvent object description: 13162 * 13163 * @interface KeyEvent 13164 * @syscap SystemCapability.ArkUI.ArkUI.Full 13165 * @crossplatform 13166 * @atomicservice 13167 * @since 11 13168 */ 13169declare interface KeyEvent { 13170 /** 13171 * Type of a key. 13172 * 13173 * @type { KeyType } 13174 * @syscap SystemCapability.ArkUI.ArkUI.Full 13175 * @since 7 13176 */ 13177 /** 13178 * Type of a key. 13179 * 13180 * @type { KeyType } 13181 * @syscap SystemCapability.ArkUI.ArkUI.Full 13182 * @crossplatform 13183 * @since 10 13184 */ 13185 /** 13186 * Type of a key. 13187 * 13188 * @type { KeyType } 13189 * @syscap SystemCapability.ArkUI.ArkUI.Full 13190 * @crossplatform 13191 * @atomicservice 13192 * @since 11 13193 */ 13194 type: KeyType; 13195 13196 /** 13197 * Key code of a key 13198 * 13199 * @type { number } 13200 * @syscap SystemCapability.ArkUI.ArkUI.Full 13201 * @since 7 13202 */ 13203 /** 13204 * Key code of a key 13205 * 13206 * @type { number } 13207 * @syscap SystemCapability.ArkUI.ArkUI.Full 13208 * @crossplatform 13209 * @since 10 13210 */ 13211 /** 13212 * Key code of a key 13213 * 13214 * @type { number } 13215 * @syscap SystemCapability.ArkUI.ArkUI.Full 13216 * @crossplatform 13217 * @atomicservice 13218 * @since 11 13219 */ 13220 keyCode: number; 13221 13222 /** 13223 * Key value of a key. 13224 * 13225 * @type { string } 13226 * @syscap SystemCapability.ArkUI.ArkUI.Full 13227 * @since 7 13228 */ 13229 /** 13230 * Key value of a key. 13231 * 13232 * @type { string } 13233 * @syscap SystemCapability.ArkUI.ArkUI.Full 13234 * @crossplatform 13235 * @since 10 13236 */ 13237 /** 13238 * Key value of a key. 13239 * 13240 * @type { string } 13241 * @syscap SystemCapability.ArkUI.ArkUI.Full 13242 * @crossplatform 13243 * @atomicservice 13244 * @since 11 13245 */ 13246 keyText: string; 13247 13248 /** 13249 * Type of the input device that triggers the current key, such as the keyboard or handle. 13250 * 13251 * @type { KeySource } 13252 * @syscap SystemCapability.ArkUI.ArkUI.Full 13253 * @since 7 13254 */ 13255 /** 13256 * Type of the input device that triggers the current key, such as the keyboard or handle. 13257 * 13258 * @type { KeySource } 13259 * @syscap SystemCapability.ArkUI.ArkUI.Full 13260 * @crossplatform 13261 * @since 10 13262 */ 13263 /** 13264 * Type of the input device that triggers the current key, such as the keyboard or handle. 13265 * 13266 * @type { KeySource } 13267 * @syscap SystemCapability.ArkUI.ArkUI.Full 13268 * @crossplatform 13269 * @atomicservice 13270 * @since 11 13271 */ 13272 keySource: KeySource; 13273 13274 /** 13275 * Indicates the ID of the input device that triggers the current key. 13276 * 13277 * @type { number } 13278 * @syscap SystemCapability.ArkUI.ArkUI.Full 13279 * @since 7 13280 */ 13281 /** 13282 * Indicates the ID of the input device that triggers the current key. 13283 * 13284 * @type { number } 13285 * @syscap SystemCapability.ArkUI.ArkUI.Full 13286 * @crossplatform 13287 * @since 10 13288 */ 13289 /** 13290 * Indicates the ID of the input device that triggers the current key. 13291 * 13292 * @type { number } 13293 * @syscap SystemCapability.ArkUI.ArkUI.Full 13294 * @crossplatform 13295 * @atomicservice 13296 * @since 11 13297 */ 13298 deviceId: number; 13299 13300 /** 13301 * Indicates the status of the key when the key is pressed. 13302 * The value 1 indicates the pressed state, and the value 0 indicates the unpressed state. 13303 * 13304 * @type { number } 13305 * @syscap SystemCapability.ArkUI.ArkUI.Full 13306 * @since 7 13307 */ 13308 /** 13309 * Indicates the status of the key when the key is pressed. 13310 * The value 1 indicates the pressed state, and the value 0 indicates the unpressed state. 13311 * 13312 * @type { number } 13313 * @syscap SystemCapability.ArkUI.ArkUI.Full 13314 * @crossplatform 13315 * @since 10 13316 */ 13317 /** 13318 * Indicates the status of the key when the key is pressed. 13319 * The value 1 indicates the pressed state, and the value 0 indicates the unpressed state. 13320 * 13321 * @type { number } 13322 * @syscap SystemCapability.ArkUI.ArkUI.Full 13323 * @crossplatform 13324 * @atomicservice 13325 * @since 11 13326 */ 13327 metaKey: number; 13328 13329 /** 13330 * Timestamp when the key was pressed. 13331 * 13332 * @type { number } 13333 * @syscap SystemCapability.ArkUI.ArkUI.Full 13334 * @since 7 13335 */ 13336 /** 13337 * Timestamp when the key was pressed. 13338 * 13339 * @type { number } 13340 * @syscap SystemCapability.ArkUI.ArkUI.Full 13341 * @crossplatform 13342 * @since 10 13343 */ 13344 /** 13345 * Timestamp when the key was pressed. 13346 * 13347 * @type { number } 13348 * @syscap SystemCapability.ArkUI.ArkUI.Full 13349 * @crossplatform 13350 * @atomicservice 13351 * @since 11 13352 */ 13353 timestamp: number; 13354 13355 /** 13356 * Block event bubbling. 13357 * 13358 * @type { function } 13359 * @syscap SystemCapability.ArkUI.ArkUI.Full 13360 * @since 7 13361 */ 13362 /** 13363 * Block event bubbling. 13364 * 13365 * @type { function } 13366 * @syscap SystemCapability.ArkUI.ArkUI.Full 13367 * @crossplatform 13368 * @since 10 13369 */ 13370 /** 13371 * Block event bubbling. 13372 * 13373 * @type { function } 13374 * @syscap SystemCapability.ArkUI.ArkUI.Full 13375 * @crossplatform 13376 * @atomicservice 13377 * @since 11 13378 */ 13379 stopPropagation: () => void; 13380 13381 /** 13382 * Intention code of a key or modifier keys. 13383 * 13384 * @type { IntentionCode } 13385 * @default IntentionCode.INTENTION_UNKNOWN 13386 * @syscap SystemCapability.ArkUI.ArkUI.Full 13387 * @since 10 13388 */ 13389 /** 13390 * Intention code of a key or modifier keys. 13391 * 13392 * @type { IntentionCode } 13393 * @default IntentionCode.INTENTION_UNKNOWN 13394 * @syscap SystemCapability.ArkUI.ArkUI.Full 13395 * @atomicservice 13396 * @since 11 13397 */ 13398 intentionCode: IntentionCode; 13399 13400 /** 13401 * Get the modifier keys press state, support 'ctrl'|'alt'|'shift'|'fn' 13402 * 13403 * @param { Array<string> } keys - indicate the modifier keys. 13404 * @returns { boolean } 13405 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 13406 * @syscap SystemCapability.ArkUI.ArkUI.Full 13407 * @crossplatform 13408 * @since 12 13409 */ 13410 /** 13411 * Get the modifier keys press state, support 'ctrl'|'alt'|'shift'|'fn' 13412 * 13413 * @param { Array<string> } keys - indicate the modifier keys. 13414 * @returns { boolean } 13415 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 13416 * @syscap SystemCapability.ArkUI.ArkUI.Full 13417 * @crossplatform 13418 * @atomicservice 13419 * @since 13 13420 */ 13421 getModifierKeyState?(keys: Array<string>): boolean; 13422 13423 /** 13424 * Unicode of a key 13425 * 13426 * @type { ?number } 13427 * @syscap SystemCapability.ArkUI.ArkUI.Full 13428 * @atomicservice 13429 * @since 14 13430 */ 13431 unicode?: number; 13432} 13433 13434/** 13435 * Focus axis event object description. 13436 * 13437 * @extends BaseEvent 13438 * @interface FocusAxisEvent 13439 * @syscap SystemCapability.ArkUI.ArkUI.Full 13440 * @atomicservice 13441 * @since 15 13442 */ 13443declare interface FocusAxisEvent extends BaseEvent { 13444 /** 13445 * The axis values of axis event. 13446 * 13447 * @type { Map<AxisModel, number> } 13448 * @syscap SystemCapability.ArkUI.ArkUI.Full 13449 * @atomicservice 13450 * @since 15 13451 */ 13452 axisMap: Map<AxisModel, number>; 13453 13454 /** 13455 * The blocking event pops up. 13456 * 13457 * @type { Callback<void> } 13458 * @syscap SystemCapability.ArkUI.ArkUI.Full 13459 * @atomicservice 13460 * @since 15 13461 */ 13462 stopPropagation: Callback<void>; 13463} 13464 13465/** 13466 * CrownEvent object description 13467 * 13468 * @interface CrownEvent 13469 * @syscap SystemCapability.ArkUI.ArkUI.Full 13470 * @atomicservice 13471 * @since 18 13472 */ 13473declare interface CrownEvent { 13474 /** 13475 *The timestamp of the rotating crown event. 13476 * 13477 * @type { number } 13478 * @syscap SystemCapability.ArkUI.ArkUI.Full 13479 * @atomicservice 13480 * @since 18 13481 */ 13482 timestamp: number; 13483 13484 /** 13485 * The angular velocity of a rotating crown. 13486 * 13487 * @type { number } 13488 * @syscap SystemCapability.ArkUI.ArkUI.Full 13489 * @atomicservice 13490 * @since 18 13491 */ 13492 angularVelocity: number; 13493 13494 /** 13495 * The rotation angle of the rotating crown. 13496 * 13497 * @type { number } 13498 * @syscap SystemCapability.ArkUI.ArkUI.Full 13499 * @atomicservice 13500 * @since 18 13501 */ 13502 degree: number; 13503 13504 /** 13505 * The behavior of rotating crown. 13506 * 13507 * @type { CrownAction } 13508 * @syscap SystemCapability.ArkUI.ArkUI.Full 13509 * @atomicservice 13510 * @since 18 13511 */ 13512 action: CrownAction; 13513 13514 /** 13515 * The blocking event pops up. 13516 * 13517 * @type { Callback<void> } 13518 * @syscap SystemCapability.ArkUI.ArkUI.Full 13519 * @atomicservice 13520 * @since 18 13521 */ 13522 stopPropagation: Callback<void>; 13523} 13524 13525/** 13526 * Overlay module options 13527 * 13528 * @interface BindOptions 13529 * @syscap SystemCapability.ArkUI.ArkUI.Full 13530 * @crossplatform 13531 * @since 10 13532 */ 13533/** 13534 * Overlay module options 13535 * 13536 * @interface BindOptions 13537 * @syscap SystemCapability.ArkUI.ArkUI.Full 13538 * @crossplatform 13539 * @atomicservice 13540 * @since 11 13541 */ 13542declare interface BindOptions { 13543 /** 13544 * Defines the background color 13545 * 13546 * @type { ?ResourceColor } 13547 * @syscap SystemCapability.ArkUI.ArkUI.Full 13548 * @crossplatform 13549 * @since 10 13550 */ 13551 /** 13552 * Defines the background color 13553 * 13554 * @type { ?ResourceColor } 13555 * @syscap SystemCapability.ArkUI.ArkUI.Full 13556 * @crossplatform 13557 * @atomicservice 13558 * @since 11 13559 */ 13560 backgroundColor?: ResourceColor; 13561 13562 /** 13563 * Callback function when overlay interface appears 13564 * 13565 * @type { ?function } 13566 * @syscap SystemCapability.ArkUI.ArkUI.Full 13567 * @crossplatform 13568 * @since 10 13569 */ 13570 /** 13571 * Callback function when overlay interface appears 13572 * 13573 * @type { ?function } 13574 * @syscap SystemCapability.ArkUI.ArkUI.Full 13575 * @crossplatform 13576 * @atomicservice 13577 * @since 11 13578 */ 13579 onAppear?: () => void; 13580 13581 /** 13582 * Callback function when overlay interface exits 13583 * 13584 * @type { ?function } 13585 * @syscap SystemCapability.ArkUI.ArkUI.Full 13586 * @crossplatform 13587 * @since 10 13588 */ 13589 /** 13590 * Callback function when overlay interface exits 13591 * 13592 * @type { ?function } 13593 * @syscap SystemCapability.ArkUI.ArkUI.Full 13594 * @crossplatform 13595 * @atomicservice 13596 * @since 11 13597 */ 13598 onDisappear?: () => void; 13599 13600 /** 13601 * Callback function before overlay animation starts. 13602 * 13603 * @type { ?function } 13604 * @syscap SystemCapability.ArkUI.ArkUI.Full 13605 * @crossplatform 13606 * @atomicservice 13607 * @since 12 13608 */ 13609 onWillAppear?: () => void; 13610 13611 /** 13612 * Callback function before overlay popAnimation starts. 13613 * 13614 * @type { ?function } 13615 * @syscap SystemCapability.ArkUI.ArkUI.Full 13616 * @crossplatform 13617 * @atomicservice 13618 * @since 12 13619 */ 13620 onWillDisappear?: () => void; 13621} 13622 13623/** 13624 * Component content cover dismiss 13625 * 13626 * @interface DismissContentCoverAction 13627 * @syscap SystemCapability.ArkUI.ArkUI.Full 13628 * @crossplatform 13629 * @atomicservice 13630 * @since 12 13631 */ 13632declare interface DismissContentCoverAction { 13633 /** 13634 * Defines content cover dismiss function 13635 * 13636 * @type { Callback<void> } 13637 * @syscap SystemCapability.ArkUI.ArkUI.Full 13638 * @crossplatform 13639 * @atomicservice 13640 * @since 12 13641 */ 13642 dismiss: Callback<void>; 13643 13644 /** 13645 * Defines content cover dismiss reason 13646 * 13647 * @type { DismissReason } 13648 * @syscap SystemCapability.ArkUI.ArkUI.Full 13649 * @crossplatform 13650 * @atomicservice 13651 * @since 12 13652 */ 13653 reason: DismissReason; 13654} 13655 13656/** 13657 * Component content cover options 13658 * 13659 * @extends BindOptions 13660 * @interface ContentCoverOptions 13661 * @syscap SystemCapability.ArkUI.ArkUI.Full 13662 * @crossplatform 13663 * @since 10 13664 */ 13665/** 13666 * Component content cover options 13667 * 13668 * @extends BindOptions 13669 * @interface ContentCoverOptions 13670 * @syscap SystemCapability.ArkUI.ArkUI.Full 13671 * @crossplatform 13672 * @atomicservice 13673 * @since 11 13674 */ 13675declare interface ContentCoverOptions extends BindOptions { 13676 /** 13677 * Defines transition type 13678 * 13679 * @type { ?ModalTransition } 13680 * @default ModalTransition.Default 13681 * @syscap SystemCapability.ArkUI.ArkUI.Full 13682 * @crossplatform 13683 * @since 10 13684 */ 13685 /** 13686 * Defines transition type 13687 * 13688 * @type { ?ModalTransition } 13689 * @default ModalTransition.Default 13690 * @syscap SystemCapability.ArkUI.ArkUI.Full 13691 * @crossplatform 13692 * @atomicservice 13693 * @since 11 13694 */ 13695 modalTransition?: ModalTransition, 13696 13697 /** 13698 * Callback function when the content cover interactive dismiss 13699 * 13700 * @type { ?Callback<DismissContentCoverAction> } 13701 * @syscap SystemCapability.ArkUI.ArkUI.Full 13702 * @crossplatform 13703 * @atomicservice 13704 * @since 12 13705 */ 13706 onWillDismiss?: Callback<DismissContentCoverAction>; 13707 13708 /** 13709 * Defines transition effect param 13710 * 13711 * @type { ?TransitionEffect } 13712 * @syscap SystemCapability.ArkUI.ArkUI.Full 13713 * @crossplatform 13714 * @atomicservice 13715 * @since 12 13716 */ 13717 transition?: TransitionEffect; 13718} 13719 13720/** 13721 * Component sheet title options 13722 * 13723 * @interface SheetTitleOptions 13724 * @syscap SystemCapability.ArkUI.ArkUI.Full 13725 * @crossplatform 13726 * @since 11 13727 */ 13728/** 13729 * Component sheet title options 13730 * 13731 * @interface SheetTitleOptions 13732 * @syscap SystemCapability.ArkUI.ArkUI.Full 13733 * @crossplatform 13734 * @atomicservice 13735 * @since 12 13736 */ 13737declare interface SheetTitleOptions { 13738 /** 13739 * Defines title text 13740 * 13741 * @type { ResourceStr } 13742 * @syscap SystemCapability.ArkUI.ArkUI.Full 13743 * @crossplatform 13744 * @since 11 13745 */ 13746 /** 13747 * Defines title text 13748 * 13749 * @type { ResourceStr } 13750 * @syscap SystemCapability.ArkUI.ArkUI.Full 13751 * @crossplatform 13752 * @atomicservice 13753 * @since 12 13754 */ 13755 title: ResourceStr; 13756 13757 /** 13758 * Defines subtitle text 13759 * 13760 * @type { ?ResourceStr } 13761 * @syscap SystemCapability.ArkUI.ArkUI.Full 13762 * @crossplatform 13763 * @since 11 13764 */ 13765 /** 13766 * Defines subtitle text 13767 * 13768 * @type { ?ResourceStr } 13769 * @syscap SystemCapability.ArkUI.ArkUI.Full 13770 * @crossplatform 13771 * @atomicservice 13772 * @since 12 13773 */ 13774 subtitle?: ResourceStr; 13775} 13776 13777/** 13778 * Defines the sheet type. 13779 * 13780 * @enum { number } 13781 * @syscap SystemCapability.ArkUI.ArkUI.Full 13782 * @crossplatform 13783 * @since 11 13784 */ 13785/** 13786 * Defines the sheet type. 13787 * 13788 * @enum { number } 13789 * @syscap SystemCapability.ArkUI.ArkUI.Full 13790 * @crossplatform 13791 * @atomicservice 13792 * @since 12 13793 */ 13794declare enum SheetType { 13795 /** 13796 * Defines bottom sheet type. 13797 * 13798 * @syscap SystemCapability.ArkUI.ArkUI.Full 13799 * @crossplatform 13800 * @since 11 13801 */ 13802 /** 13803 * Defines bottom sheet type. 13804 * 13805 * @syscap SystemCapability.ArkUI.ArkUI.Full 13806 * @crossplatform 13807 * @atomicservice 13808 * @since 12 13809 */ 13810 BOTTOM = 0, 13811 13812 /** 13813 * Defines center sheet type. 13814 * 13815 * @syscap SystemCapability.ArkUI.ArkUI.Full 13816 * @crossplatform 13817 * @since 11 13818 */ 13819 /** 13820 * Defines center sheet type. 13821 * 13822 * @syscap SystemCapability.ArkUI.ArkUI.Full 13823 * @crossplatform 13824 * @atomicservice 13825 * @since 12 13826 */ 13827 CENTER = 1, 13828 13829 /** 13830 * Defines popup sheet type. 13831 * 13832 * @syscap SystemCapability.ArkUI.ArkUI.Full 13833 * @crossplatform 13834 * @since 11 13835 */ 13836 /** 13837 * Defines popup sheet type. 13838 * 13839 * @syscap SystemCapability.ArkUI.ArkUI.Full 13840 * @crossplatform 13841 * @atomicservice 13842 * @since 12 13843 */ 13844 POPUP = 2, 13845} 13846 13847/** 13848 * Define the display mode of the sheet. 13849 * 13850 * @enum { number } 13851 * @syscap SystemCapability.ArkUI.ArkUI.Full 13852 * @crossplatform 13853 * @atomicservice 13854 * @since 12 13855 */ 13856declare enum SheetMode { 13857 /** 13858 * Sheet displays above all page levels. 13859 * 13860 * @syscap SystemCapability.ArkUI.ArkUI.Full 13861 * @crossplatform 13862 * @atomicservice 13863 * @since 12 13864 */ 13865 OVERLAY = 0, 13866 13867 /** 13868 * Sheet displays within the current page. 13869 * 13870 * @syscap SystemCapability.ArkUI.ArkUI.Full 13871 * @crossplatform 13872 * @atomicservice 13873 * @since 12 13874 */ 13875 EMBEDDED = 1, 13876} 13877 13878/** 13879 * Define the scroll size mode of the sheet. 13880 * 13881 * @enum { number } 13882 * @syscap SystemCapability.ArkUI.ArkUI.Full 13883 * @crossplatform 13884 * @atomicservice 13885 * @since 12 13886 */ 13887declare enum ScrollSizeMode { 13888 /** 13889 * Sheet change scroll size after the slide ends. 13890 * 13891 * @syscap SystemCapability.ArkUI.ArkUI.Full 13892 * @crossplatform 13893 * @atomicservice 13894 * @since 12 13895 */ 13896 FOLLOW_DETENT = 0, 13897 13898 /** 13899 * Sheet change scroll size during the sliding process. 13900 * 13901 * @syscap SystemCapability.ArkUI.ArkUI.Full 13902 * @crossplatform 13903 * @atomicservice 13904 * @since 12 13905 */ 13906 CONTINUOUS = 1, 13907} 13908 13909/** 13910 * Define the mode of sheet how to avoid keyboard. 13911 * 13912 * @enum { number } 13913 * @syscap SystemCapability.ArkUI.ArkUI.Full 13914 * @crossplatform 13915 * @atomicservice 13916 * @since 13 13917 */ 13918declare enum SheetKeyboardAvoidMode { 13919 /** 13920 * Sheet will not aovid keyboard. 13921 * 13922 * @syscap SystemCapability.ArkUI.ArkUI.Full 13923 * @crossplatform 13924 * @atomicservice 13925 * @since 13 13926 */ 13927 NONE = 0, 13928 13929 /** 13930 * Firstly sheet will avoid keyboard by changing its height. 13931 * And then sheet will avoid by resizing after reaching its maximum height. 13932 * 13933 * @syscap SystemCapability.ArkUI.ArkUI.Full 13934 * @crossplatform 13935 * @atomicservice 13936 * @since 13 13937 */ 13938 TRANSLATE_AND_RESIZE = 1, 13939 13940 /** 13941 * Sheet will only avoid keyboard by resizing the content. 13942 * 13943 * @syscap SystemCapability.ArkUI.ArkUI.Full 13944 * @crossplatform 13945 * @atomicservice 13946 * @since 13 13947 */ 13948 RESIZE_ONLY = 2, 13949 13950 /** 13951 * Firstly sheet will avoid keyboard by changing its height. 13952 * And then sheet will avoid keyboard by scrolling after reaching its maximum height. 13953 * 13954 * @syscap SystemCapability.ArkUI.ArkUI.Full 13955 * @crossplatform 13956 * @atomicservice 13957 * @since 13 13958 */ 13959 TRANSLATE_AND_SCROLL = 3, 13960} 13961 13962/** 13963 * Component sheet dismiss 13964 * 13965 * @interface SheetDismiss 13966 * @syscap SystemCapability.ArkUI.ArkUI.Full 13967 * @crossplatform 13968 * @since 11 13969 */ 13970/** 13971 * Component sheet dismiss 13972 * 13973 * @interface SheetDismiss 13974 * @syscap SystemCapability.ArkUI.ArkUI.Full 13975 * @crossplatform 13976 * @atomicservice 13977 * @since 12 13978 */ 13979declare interface SheetDismiss { 13980 /** 13981 * Defines sheet dismiss function 13982 * 13983 * @type { function } 13984 * @syscap SystemCapability.ArkUI.ArkUI.Full 13985 * @crossplatform 13986 * @since 11 13987 */ 13988 /** 13989 * Defines sheet dismiss function 13990 * 13991 * @type { function } 13992 * @syscap SystemCapability.ArkUI.ArkUI.Full 13993 * @crossplatform 13994 * @atomicservice 13995 * @since 12 13996 */ 13997 dismiss: () => void; 13998} 13999 14000/** 14001 * Component sheet dismiss 14002 * 14003 * @interface DismissSheetAction 14004 * @syscap SystemCapability.ArkUI.ArkUI.Full 14005 * @crossplatform 14006 * @atomicservice 14007 * @since 12 14008 */ 14009declare interface DismissSheetAction { 14010 14011 /** 14012 * Defines sheet dismiss function 14013 * 14014 * @type { Callback<void> } 14015 * @syscap SystemCapability.ArkUI.ArkUI.Full 14016 * @crossplatform 14017 * @atomicservice 14018 * @since 12 14019 */ 14020 dismiss: Callback<void>; 14021 14022 /** 14023 * Dismiss reason type. 14024 * 14025 * @type { DismissReason } 14026 * @syscap SystemCapability.ArkUI.ArkUI.Full 14027 * @crossplatform 14028 * @atomicservice 14029 * @since 12 14030 */ 14031 reason: DismissReason; 14032} 14033 14034/** 14035 * Defines sheet spring back action 14036 * 14037 * @interface SpringBackAction 14038 * @syscap SystemCapability.ArkUI.ArkUI.Full 14039 * @crossplatform 14040 * @atomicservice 14041 * @since 12 14042 */ 14043declare interface SpringBackAction { 14044 /** 14045 * Defines spring back function 14046 * 14047 * @type { Callback<void> } 14048 * @syscap SystemCapability.ArkUI.ArkUI.Full 14049 * @crossplatform 14050 * @atomicservice 14051 * @since 12 14052 */ 14053 springBack: Callback<void>; 14054} 14055 14056/** 14057 * Component sheet options 14058 * 14059 * @extends BindOptions 14060 * @interface SheetOptions 14061 * @syscap SystemCapability.ArkUI.ArkUI.Full 14062 * @crossplatform 14063 * @since 10 14064 */ 14065/** 14066 * Component sheet options 14067 * 14068 * @extends BindOptions 14069 * @interface SheetOptions 14070 * @syscap SystemCapability.ArkUI.ArkUI.Full 14071 * @crossplatform 14072 * @atomicservice 14073 * @since 11 14074 */ 14075declare interface SheetOptions extends BindOptions { 14076 /** 14077 * Defines sheet height 14078 * 14079 * @type { ?(SheetSize | Length) } 14080 * @default Sheet.LARGE 14081 * @syscap SystemCapability.ArkUI.ArkUI.Full 14082 * @crossplatform 14083 * @since 10 14084 */ 14085 /** 14086 * Defines sheet height 14087 * 14088 * @type { ?(SheetSize | Length) } 14089 * @default Sheet.LARGE 14090 * @syscap SystemCapability.ArkUI.ArkUI.Full 14091 * @crossplatform 14092 * @atomicservice 14093 * @since 11 14094 */ 14095 height?: SheetSize | Length; 14096 14097 /** 14098 * Defines whether the control bar is displayed. 14099 * 14100 * @type { ?boolean } 14101 * @default true 14102 * @syscap SystemCapability.ArkUI.ArkUI.Full 14103 * @crossplatform 14104 * @since 10 14105 */ 14106 /** 14107 * Defines whether the control bar is displayed. 14108 * 14109 * @type { ?boolean } 14110 * @default true 14111 * @syscap SystemCapability.ArkUI.ArkUI.Full 14112 * @crossplatform 14113 * @atomicservice 14114 * @since 11 14115 */ 14116 dragBar?: boolean; 14117 14118 /** 14119 * Defines sheet maskColor 14120 * 14121 * @type { ?ResourceColor } 14122 * @syscap SystemCapability.ArkUI.ArkUI.Full 14123 * @crossplatform 14124 * @since 10 14125 */ 14126 /** 14127 * Defines sheet maskColor 14128 * 14129 * @type { ?ResourceColor } 14130 * @syscap SystemCapability.ArkUI.ArkUI.Full 14131 * @crossplatform 14132 * @atomicservice 14133 * @since 11 14134 */ 14135 maskColor?: ResourceColor; 14136 14137 /** 14138 * Defines sheet detents 14139 * 14140 * @type { ?[(SheetSize | Length), (SheetSize | Length)?, (SheetSize | Length)?] } 14141 * @syscap SystemCapability.ArkUI.ArkUI.Full 14142 * @crossplatform 14143 * @since 11 14144 */ 14145 /** 14146 * Defines sheet detents 14147 * 14148 * @type { ?[(SheetSize | Length), (SheetSize | Length)?, (SheetSize | Length)?] } 14149 * @syscap SystemCapability.ArkUI.ArkUI.Full 14150 * @crossplatform 14151 * @atomicservice 14152 * @since 12 14153 */ 14154 detents?: [(SheetSize | Length), (SheetSize | Length)?, (SheetSize | Length)?]; 14155 14156 /** 14157 * Defines sheet background blur Style 14158 * 14159 * @type { ?BlurStyle } 14160 * @default BlurStyle.NONE 14161 * @syscap SystemCapability.ArkUI.ArkUI.Full 14162 * @crossplatform 14163 * @since 11 14164 */ 14165 /** 14166 * Defines sheet background blur Style 14167 * 14168 * @type { ?BlurStyle } 14169 * @default BlurStyle.NONE 14170 * @syscap SystemCapability.ArkUI.ArkUI.Full 14171 * @crossplatform 14172 * @atomicservice 14173 * @since 12 14174 */ 14175 blurStyle?: BlurStyle; 14176 14177 /** 14178 * Defines whether the close icon is displayed 14179 * 14180 * @type { ?(boolean | Resource) } 14181 * @default true 14182 * @syscap SystemCapability.ArkUI.ArkUI.Full 14183 * @crossplatform 14184 * @since 11 14185 */ 14186 /** 14187 * Defines whether the close icon is displayed 14188 * 14189 * @type { ?(boolean | Resource) } 14190 * @default true 14191 * @syscap SystemCapability.ArkUI.ArkUI.Full 14192 * @crossplatform 14193 * @atomicservice 14194 * @since 12 14195 */ 14196 showClose?: boolean | Resource; 14197 14198 /** 14199 * Defines the sheet prefer type 14200 * 14201 * @type { ?(SheetType.CENTER | SheetType.POPUP) } 14202 * @syscap SystemCapability.ArkUI.ArkUI.Full 14203 * @crossplatform 14204 * @since 11 14205 */ 14206 /** 14207 * Defines the sheet prefer type 14208 * 14209 * @type { ?SheetType } 14210 * @syscap SystemCapability.ArkUI.ArkUI.Full 14211 * @crossplatform 14212 * @atomicservice 14213 * @since 12 14214 */ 14215 preferType?: SheetType; 14216 14217 /** 14218 * Defines the sheet title 14219 * 14220 * @type { ?(SheetTitleOptions | CustomBuilder) } 14221 * @syscap SystemCapability.ArkUI.ArkUI.Full 14222 * @crossplatform 14223 * @since 11 14224 */ 14225 /** 14226 * Defines the sheet title 14227 * 14228 * @type { ?(SheetTitleOptions | CustomBuilder) } 14229 * @syscap SystemCapability.ArkUI.ArkUI.Full 14230 * @crossplatform 14231 * @atomicservice 14232 * @since 12 14233 */ 14234 title?: SheetTitleOptions | CustomBuilder; 14235 14236 /** 14237 * Callback function when the sheet interactive dismiss 14238 * 14239 * @type { ?function } 14240 * @syscap SystemCapability.ArkUI.ArkUI.Full 14241 * @crossplatform 14242 * @since 11 14243 */ 14244 /** 14245 * Callback function when the sheet interactive dismiss 14246 * 14247 * @type { ?function } 14248 * @syscap SystemCapability.ArkUI.ArkUI.Full 14249 * @crossplatform 14250 * @atomicservice 14251 * @since 12 14252 */ 14253 shouldDismiss?: (sheetDismiss: SheetDismiss) => void; 14254 14255 /** 14256 * Callback function when the sheet will dismiss 14257 * 14258 * @type { ?Callback<DismissSheetAction> } 14259 * @syscap SystemCapability.ArkUI.ArkUI.Full 14260 * @crossplatform 14261 * @atomicservice 14262 * @since 12 14263 */ 14264 onWillDismiss?: Callback<DismissSheetAction>; 14265 14266 /** 14267 * Sheet springs back callback when dismiss 14268 * 14269 * @type { ?Callback<SpringBackAction> } 14270 * @syscap SystemCapability.ArkUI.ArkUI.Full 14271 * @crossplatform 14272 * @atomicservice 14273 * @since 12 14274 */ 14275 onWillSpringBackWhenDismiss?: Callback<SpringBackAction>; 14276 14277 /** 14278 * Set whether interaction is allowed outside the sheet 14279 * 14280 * @type { ?boolean } 14281 * @default false 14282 * @syscap SystemCapability.ArkUI.ArkUI.Full 14283 * @crossplatform 14284 * @since 11 14285 */ 14286 /** 14287 * Set whether interaction is allowed outside the sheet 14288 * 14289 * @type { ?boolean } 14290 * @default false 14291 * @syscap SystemCapability.ArkUI.ArkUI.Full 14292 * @crossplatform 14293 * @atomicservice 14294 * @since 12 14295 */ 14296 enableOutsideInteractive?: boolean; 14297 14298 /** 14299 * Defines the sheet's width. 14300 * 14301 * @type { ?Dimension } 14302 * @syscap SystemCapability.ArkUI.ArkUI.Full 14303 * @crossplatform 14304 * @atomicservice 14305 * @since 12 14306 */ 14307 width?: Dimension; 14308 14309 /** 14310 * Defines the sheet's border width. 14311 * 14312 * @type { ?(Dimension | EdgeWidths | LocalizedEdgeWidths) } 14313 * @syscap SystemCapability.ArkUI.ArkUI.Full 14314 * @crossplatform 14315 * @atomicservice 14316 * @since 12 14317 */ 14318 borderWidth?: Dimension | EdgeWidths | LocalizedEdgeWidths; 14319 14320 /** 14321 * Defines the sheet's border color. 14322 * 14323 * @type { ?(ResourceColor | EdgeColors | LocalizedEdgeColors) } 14324 * @syscap SystemCapability.ArkUI.ArkUI.Full 14325 * @crossplatform 14326 * @atomicservice 14327 * @since 12 14328 */ 14329 borderColor?: ResourceColor | EdgeColors | LocalizedEdgeColors; 14330 14331 /** 14332 * Defines the sheet's border style. 14333 * 14334 * @type { ?(BorderStyle | EdgeStyles) } 14335 * @syscap SystemCapability.ArkUI.ArkUI.Full 14336 * @crossplatform 14337 * @atomicservice 14338 * @since 12 14339 */ 14340 borderStyle?: BorderStyle | EdgeStyles; 14341 14342 /** 14343 * Defines the sheet's shadow. 14344 * 14345 * @type { ?(ShadowOptions | ShadowStyle) } 14346 * @syscap SystemCapability.ArkUI.ArkUI.Full 14347 * @crossplatform 14348 * @atomicservice 14349 * @since 12 14350 */ 14351 shadow?: ShadowOptions | ShadowStyle; 14352 14353 /** 14354 * Called when height of the sheet is changed 14355 * 14356 * @type { ?Callback<number> } 14357 * @syscap SystemCapability.ArkUI.ArkUI.Full 14358 * @crossplatform 14359 * @atomicservice 14360 * @since 12 14361 */ 14362 onHeightDidChange?: Callback<number>; 14363 14364 /** 14365 * Determine the level sheet shows, whether sheet should be displayed within the page 14366 * 14367 * @type { ?SheetMode } 14368 * @default SheetMode.OVERLAY 14369 * @syscap SystemCapability.ArkUI.ArkUI.Full 14370 * @crossplatform 14371 * @atomicservice 14372 * @since 12 14373 */ 14374 mode?: SheetMode; 14375 14376 /** 14377 * Determine sheet scroll size mode. 14378 * 14379 * @type { ?ScrollSizeMode } 14380 * @default ScrollSizeMode.FELLOW_DETEND 14381 * @syscap SystemCapability.ArkUI.ArkUI.Full 14382 * @crossplatform 14383 * @atomicservice 14384 * @since 12 14385 */ 14386 scrollSizeMode?: ScrollSizeMode; 14387 14388 /** 14389 * Called when detents of the sheet changed 14390 * 14391 * @type { ?Callback<number> } 14392 * @syscap SystemCapability.ArkUI.ArkUI.Full 14393 * @crossplatform 14394 * @atomicservice 14395 * @since 12 14396 */ 14397 onDetentsDidChange?: Callback<number>; 14398 14399 /** 14400 * Called when width of the sheet changed 14401 * 14402 * @type { ?Callback<number> } 14403 * @syscap SystemCapability.ArkUI.ArkUI.Full 14404 * @crossplatform 14405 * @atomicservice 14406 * @since 12 14407 */ 14408 onWidthDidChange?: Callback<number>; 14409 14410 /** 14411 * Called when the sheet type changed 14412 * 14413 * @type { ?Callback<SheetType> } 14414 * @syscap SystemCapability.ArkUI.ArkUI.Full 14415 * @crossplatform 14416 * @atomicservice 14417 * @since 12 14418 */ 14419 onTypeDidChange?: Callback<SheetType>; 14420 14421 /** 14422 * The UIContext that the sheet belongs to 14423 * 14424 * @type { ?UIContext } 14425 * @syscap SystemCapability.ArkUI.ArkUI.Full 14426 * @crossplatform 14427 * @atomicservice 14428 * @since 12 14429 */ 14430 uiContext?: UIContext; 14431 14432 /** 14433 * Determine the mode of sheet how to avoid keyboard. 14434 * 14435 * @type { ?SheetKeyboardAvoidMode } 14436 * @default SheetKeyboardAvoidMode.TRANSLATE_AND_SCROLL 14437 * @syscap SystemCapability.ArkUI.ArkUI.Full 14438 * @crossplatform 14439 * @atomicservice 14440 * @since 13 14441 */ 14442 keyboardAvoidMode?: SheetKeyboardAvoidMode; 14443 14444 /** 14445 * Defines whether to respond to the hover mode. 14446 * 14447 * @type { ?boolean } 14448 * @default false 14449 * @syscap SystemCapability.ArkUI.ArkUI.Full 14450 * @crossplatform 14451 * @atomicservice 14452 * @since 14 14453 */ 14454 enableHoverMode?: boolean; 14455 14456 /** 14457 * Defines the sheet's display area in hover mode. 14458 * 14459 * @type { ?HoverModeAreaType } 14460 * @default HoverModeAreaType.BOTTOM_SCREEN 14461 * @syscap SystemCapability.ArkUI.ArkUI.Full 14462 * @crossplatform 14463 * @atomicservice 14464 * @since 14 14465 */ 14466 hoverModeArea?: HoverModeAreaType; 14467 14468 /** 14469 * Sets the position offset of the bindSheet. 14470 * 14471 * @type { ?Position } 14472 * @syscap SystemCapability.ArkUI.ArkUI.Full 14473 * @systemapi 14474 * @since 14 14475 */ 14476 offset?: Position 14477 14478 /** 14479 * Sets whether the sheet edge has spring effect. 14480 * 14481 * @type { ?number } 14482 * @default 3 14483 * @syscap SystemCapability.ArkUI.ArkUI.Full 14484 * @crossplatform 14485 * @atomicservice 14486 * @since 18 14487 */ 14488 effectEdge?: number 14489 14490 /** 14491 * Defines sheet radius 14492 * 14493 * @type { ?(LengthMetrics | BorderRadiuses | LocalizedBorderRadiuses) } 14494 * @syscap SystemCapability.ArkUI.ArkUI.Full 14495 * @crossplatform 14496 * @atomicservice 14497 * @since 15 14498 */ 14499 radius?: LengthMetrics | BorderRadiuses | LocalizedBorderRadiuses; 14500 14501 /** 14502 * Select a detent from detents property 14503 * 14504 * @type { ?(SheetSize | Length) } 14505 * @default detents[0] 14506 * @syscap SystemCapability.ArkUI.ArkUI.Full 14507 * @crossplatform 14508 * @atomicservice 14509 * @since 15 14510 */ 14511 detentSelection?: SheetSize | Length; 14512 14513 /** 14514 * The placement of popup sheet type. 14515 * Supports all positions defined in Placement. 14516 * 14517 * @type { ?Placement } 14518 * @default Placement.Bottom 14519 * @syscap SystemCapability.ArkUI.ArkUI.Full 14520 * @crossplatform 14521 * @atomicservice 14522 * @since 18 14523 */ 14524 placement?: Placement; 14525 14526 /** 14527 * placement On target node 14528 * 14529 * @type { ?boolean } 14530 * @default true 14531 * @syscap SystemCapability.ArkUI.ArkUI.Full 14532 * @crossplatform 14533 * @atomicservice 14534 * @since 18 14535 */ 14536 placementOnTarget?: boolean; 14537} 14538 14539/** 14540 * Component State Styles. 14541 * 14542 * @interface StateStyles 14543 * @syscap SystemCapability.ArkUI.ArkUI.Full 14544 * @since 8 14545 */ 14546/** 14547 * Component State Styles. 14548 * 14549 * @interface StateStyles 14550 * @syscap SystemCapability.ArkUI.ArkUI.Full 14551 * @form 14552 * @since 9 14553 */ 14554/** 14555 * Component State Styles. 14556 * 14557 * @interface StateStyles 14558 * @syscap SystemCapability.ArkUI.ArkUI.Full 14559 * @crossplatform 14560 * @form 14561 * @since 10 14562 */ 14563/** 14564 * Component State Styles. 14565 * 14566 * @interface StateStyles 14567 * @syscap SystemCapability.ArkUI.ArkUI.Full 14568 * @crossplatform 14569 * @form 14570 * @atomicservice 14571 * @since 11 14572 */ 14573declare interface StateStyles { 14574 /** 14575 * Defines normal state styles. 14576 * 14577 * @type { ?any } 14578 * @syscap SystemCapability.ArkUI.ArkUI.Full 14579 * @since 8 14580 */ 14581 /** 14582 * Defines normal state styles. 14583 * 14584 * @type { ?any } 14585 * @syscap SystemCapability.ArkUI.ArkUI.Full 14586 * @form 14587 * @since 9 14588 */ 14589 /** 14590 * Defines normal state styles. 14591 * 14592 * @type { ?any } 14593 * @syscap SystemCapability.ArkUI.ArkUI.Full 14594 * @crossplatform 14595 * @form 14596 * @since 10 14597 */ 14598 /** 14599 * Defines normal state styles. 14600 * 14601 * @type { ?any } 14602 * @syscap SystemCapability.ArkUI.ArkUI.Full 14603 * @crossplatform 14604 * @form 14605 * @atomicservice 14606 * @since 11 14607 */ 14608 normal?: any; 14609 14610 /** 14611 * Defines pressed state styles. 14612 * 14613 * @type { ?any } 14614 * @syscap SystemCapability.ArkUI.ArkUI.Full 14615 * @since 8 14616 */ 14617 /** 14618 * Defines pressed state styles. 14619 * 14620 * @type { ?any } 14621 * @syscap SystemCapability.ArkUI.ArkUI.Full 14622 * @form 14623 * @since 9 14624 */ 14625 /** 14626 * Defines pressed state styles. 14627 * 14628 * @type { ?any } 14629 * @syscap SystemCapability.ArkUI.ArkUI.Full 14630 * @crossplatform 14631 * @form 14632 * @since 10 14633 */ 14634 /** 14635 * Defines pressed state styles. 14636 * 14637 * @type { ?any } 14638 * @syscap SystemCapability.ArkUI.ArkUI.Full 14639 * @crossplatform 14640 * @form 14641 * @atomicservice 14642 * @since 11 14643 */ 14644 pressed?: any; 14645 14646 /** 14647 * Defines disabled state styles. 14648 * 14649 * @type { ?any } 14650 * @syscap SystemCapability.ArkUI.ArkUI.Full 14651 * @since 8 14652 */ 14653 /** 14654 * Defines disabled state styles. 14655 * 14656 * @type { ?any } 14657 * @syscap SystemCapability.ArkUI.ArkUI.Full 14658 * @form 14659 * @since 9 14660 */ 14661 /** 14662 * Defines disabled state styles. 14663 * 14664 * @type { ?any } 14665 * @syscap SystemCapability.ArkUI.ArkUI.Full 14666 * @crossplatform 14667 * @form 14668 * @since 10 14669 */ 14670 /** 14671 * Defines disabled state styles. 14672 * 14673 * @type { ?any } 14674 * @syscap SystemCapability.ArkUI.ArkUI.Full 14675 * @crossplatform 14676 * @form 14677 * @atomicservice 14678 * @since 11 14679 */ 14680 disabled?: any; 14681 14682 /** 14683 * Defines focused state styles. 14684 * 14685 * @type { ?any } 14686 * @syscap SystemCapability.ArkUI.ArkUI.Full 14687 * @since 8 14688 */ 14689 /** 14690 * Defines focused state styles. 14691 * 14692 * @type { ?any } 14693 * @syscap SystemCapability.ArkUI.ArkUI.Full 14694 * @form 14695 * @since 9 14696 */ 14697 /** 14698 * Defines focused state styles. 14699 * 14700 * @type { ?any } 14701 * @syscap SystemCapability.ArkUI.ArkUI.Full 14702 * @crossplatform 14703 * @form 14704 * @since 10 14705 */ 14706 /** 14707 * Defines focused state styles. 14708 * 14709 * @type { ?any } 14710 * @syscap SystemCapability.ArkUI.ArkUI.Full 14711 * @crossplatform 14712 * @form 14713 * @atomicservice 14714 * @since 11 14715 */ 14716 focused?: any; 14717 14718 /** 14719 * Defines clicked state styles. 14720 * 14721 * @type { ?any } 14722 * @syscap SystemCapability.ArkUI.ArkUI.Full 14723 * @since 8 14724 */ 14725 /** 14726 * Defines clicked state styles. 14727 * 14728 * @type { ?any } 14729 * @syscap SystemCapability.ArkUI.ArkUI.Full 14730 * @form 14731 * @since 9 14732 */ 14733 /** 14734 * Defines clicked state styles. 14735 * 14736 * @type { ?any } 14737 * @syscap SystemCapability.ArkUI.ArkUI.Full 14738 * @crossplatform 14739 * @form 14740 * @since 10 14741 */ 14742 /** 14743 * Defines clicked state styles. 14744 * 14745 * @type { ?any } 14746 * @syscap SystemCapability.ArkUI.ArkUI.Full 14747 * @crossplatform 14748 * @form 14749 * @atomicservice 14750 * @since 11 14751 */ 14752 clicked?: any; 14753 14754 /** 14755 * Defines selected state styles. 14756 * 14757 * @type { ?object } 14758 * @syscap SystemCapability.ArkUI.ArkUI.Full 14759 * @crossplatform 14760 * @form 14761 * @since 10 14762 */ 14763 /** 14764 * Defines selected state styles. 14765 * 14766 * @type { ?object } 14767 * @syscap SystemCapability.ArkUI.ArkUI.Full 14768 * @crossplatform 14769 * @form 14770 * @atomicservice 14771 * @since 11 14772 */ 14773 selected?: object; 14774} 14775 14776/** 14777 * Defines the options of popup message. 14778 * 14779 * @interface PopupMessageOptions 14780 * @syscap SystemCapability.ArkUI.ArkUI.Full 14781 * @crossplatform 14782 * @since 10 14783 */ 14784/** 14785 * Defines the options of popup message. 14786 * 14787 * @interface PopupMessageOptions 14788 * @syscap SystemCapability.ArkUI.ArkUI.Full 14789 * @crossplatform 14790 * @atomicservice 14791 * @since 11 14792 */ 14793declare interface PopupMessageOptions { 14794 /** 14795 * Sets the color of popup text. 14796 * 14797 * @type { ?ResourceColor } 14798 * @syscap SystemCapability.ArkUI.ArkUI.Full 14799 * @crossplatform 14800 * @since 10 14801 */ 14802 /** 14803 * Sets the color of popup text. 14804 * 14805 * @type { ?ResourceColor } 14806 * @syscap SystemCapability.ArkUI.ArkUI.Full 14807 * @crossplatform 14808 * @atomicservice 14809 * @since 11 14810 */ 14811 textColor?: ResourceColor; 14812 14813 /** 14814 * Sets the font of popup text. 14815 * 14816 * @type { ?Font } 14817 * @syscap SystemCapability.ArkUI.ArkUI.Full 14818 * @crossplatform 14819 * @since 10 14820 */ 14821 /** 14822 * Sets the font of popup text. 14823 * 14824 * @type { ?Font } 14825 * @syscap SystemCapability.ArkUI.ArkUI.Full 14826 * @crossplatform 14827 * @atomicservice 14828 * @since 11 14829 */ 14830 font?: Font; 14831} 14832 14833/** 14834 * Dismiss reason type. 14835 * 14836 * @enum { number } 14837 * @syscap SystemCapability.ArkUI.ArkUI.Full 14838 * @crossplatform 14839 * @atomicservice 14840 * @since 12 14841 */ 14842declare enum DismissReason { 14843 /** 14844 * Press back 14845 * 14846 * @syscap SystemCapability.ArkUI.ArkUI.Full 14847 * @crossplatform 14848 * @atomicservice 14849 * @since 12 14850 */ 14851 PRESS_BACK = 0, 14852 14853 /** 14854 * Touch component outside 14855 * 14856 * @syscap SystemCapability.ArkUI.ArkUI.Full 14857 * @crossplatform 14858 * @atomicservice 14859 * @since 12 14860 */ 14861 TOUCH_OUTSIDE = 1, 14862 14863 /** 14864 * Close button 14865 * 14866 * @syscap SystemCapability.ArkUI.ArkUI.Full 14867 * @crossplatform 14868 * @atomicservice 14869 * @since 12 14870 */ 14871 CLOSE_BUTTON = 2, 14872 14873 /** 14874 * Slide down 14875 * 14876 * @syscap SystemCapability.ArkUI.ArkUI.Full 14877 * @crossplatform 14878 * @atomicservice 14879 * @since 12 14880 */ 14881 SLIDE_DOWN = 3 14882} 14883 14884/** 14885 * Component popup dismiss 14886 * 14887 * @interface DismissPopupAction 14888 * @syscap SystemCapability.ArkUI.ArkUI.Full 14889 * @crossplatform 14890 * @atomicservice 14891 * @since 12 14892 */ 14893declare interface DismissPopupAction { 14894 /** 14895 * Defines popup dismiss function 14896 * 14897 * @type { Callback<void> } 14898 * @syscap SystemCapability.ArkUI.ArkUI.Full 14899 * @crossplatform 14900 * @atomicservice 14901 * @since 12 14902 */ 14903 dismiss: Callback<void>; 14904 14905 /** 14906 * Defines popup dismiss reason 14907 * 14908 * @type { DismissReason } 14909 * @syscap SystemCapability.ArkUI.ArkUI.Full 14910 * @crossplatform 14911 * @atomicservice 14912 * @since 12 14913 */ 14914 reason: DismissReason; 14915} 14916 14917/** 14918 * Popup state change param 14919 * 14920 * @interface PopupStateChangeParam 14921 * @syscap SystemCapability.ArkUI.ArkUI.Full 14922 * @crossplatform 14923 * @atomicservice 14924 * @since 18 14925 */ 14926declare interface PopupStateChangeParam { 14927 /** 14928 * is Visible. 14929 * Anonymous Object Rectification. 14930 * 14931 * @type { boolean } 14932 * @syscap SystemCapability.ArkUI.ArkUI.Full 14933 * @crossplatform 14934 * @atomicservice 14935 * @since 18 14936 */ 14937 isVisible: boolean; 14938} 14939 14940/** 14941 * Popup state change callback 14942 * 14943 * @typedef { function } PopupStateChangeCallback 14944 * @param { PopupStateChangeParam } event - The parameter of state change callback. 14945 * @syscap SystemCapability.ArkUI.ArkUI.Full 14946 * @crossplatform 14947 * @atomicservice 14948 * @since 18 14949 */ 14950declare type PopupStateChangeCallback = (event: PopupStateChangeParam) => void; 14951 14952/** 14953 * Popup mask type 14954 * 14955 * @interface PopupMaskType 14956 * @syscap SystemCapability.ArkUI.ArkUI.Full 14957 * @crossplatform 14958 * @atomicservice 14959 * @since 18 14960 */ 14961declare interface PopupMaskType { 14962 /** 14963 * Color. 14964 * Anonymous Object Rectification. 14965 * 14966 * @type { ResourceColor } 14967 * @syscap SystemCapability.ArkUI.ArkUI.Full 14968 * @crossplatform 14969 * @atomicservice 14970 * @since 18 14971 */ 14972 color: ResourceColor; 14973} 14974 14975/** 14976 * Popup common options 14977 * 14978 * @interface PopupCommonOptions 14979 * @syscap SystemCapability.ArkUI.ArkUI.Full 14980 * @crossplatform 14981 * @atomicservice 14982 * @since 18 14983 */ 14984declare interface PopupCommonOptions { 14985 /** 14986 * placement of popup. 14987 * 14988 * @type { ?Placement } 14989 * @default Placement.Bottom 14990 * @syscap SystemCapability.ArkUI.ArkUI.Full 14991 * @crossplatform 14992 * @atomicservice 14993 * @since 18 14994 */ 14995 placement?: Placement; 14996 14997 /** 14998 * Set the background color of the popup. 14999 * 15000 * @type { ?ResourceColor } 15001 * @syscap SystemCapability.ArkUI.ArkUI.Full 15002 * @crossplatform 15003 * @atomicservice 15004 * @since 18 15005 */ 15006 popupColor?: ResourceColor; 15007 15008 /** 15009 * whether show arrow 15010 * 15011 * @type { ?boolean } 15012 * @default true 15013 * @syscap SystemCapability.ArkUI.ArkUI.Full 15014 * @crossplatform 15015 * @atomicservice 15016 * @since 18 15017 */ 15018 enableArrow?: boolean; 15019 15020 /** 15021 * Whether hide popup when click mask 15022 * 15023 * @type { ?boolean } 15024 * @default true 15025 * @syscap SystemCapability.ArkUI.ArkUI.Full 15026 * @crossplatform 15027 * @atomicservice 15028 * @since 18 15029 */ 15030 autoCancel?: boolean; 15031 15032 /** 15033 * on State Change 15034 * 15035 * @type { ?function } 15036 * @syscap SystemCapability.ArkUI.ArkUI.Full 15037 * @crossplatform 15038 * @atomicservice 15039 * @since 18 15040 */ 15041 onStateChange?: PopupStateChangeCallback; 15042 15043 /** 15044 * The offset of the sharp corner of popup. 15045 * 15046 * @type { ?Length } 15047 * @syscap SystemCapability.ArkUI.ArkUI.Full 15048 * @crossplatform 15049 * @atomicservice 15050 * @since 18 15051 */ 15052 arrowOffset?: Length; 15053 15054 /** 15055 * Whether to display in the sub window. 15056 * 15057 * @type { ?boolean } 15058 * @syscap SystemCapability.ArkUI.ArkUI.Full 15059 * @crossplatform 15060 * @atomicservice 15061 * @since 18 15062 */ 15063 showInSubWindow?: boolean; 15064 15065 /** 15066 * The mask to block gesture events of popup. 15067 * When mask is set false, gesture events are not blocked. 15068 * When mask is set true, gesture events are blocked and mask color is transparent. 15069 * 15070 * @type { ?(boolean | PopupMaskType) } 15071 * @syscap SystemCapability.ArkUI.ArkUI.Full 15072 * @crossplatform 15073 * @atomicservice 15074 * @since 18 15075 */ 15076 mask?: boolean | PopupMaskType; 15077 15078 /** 15079 * Sets the space of between the popup and target. 15080 * 15081 * @type { ?Length } 15082 * @syscap SystemCapability.ArkUI.ArkUI.Full 15083 * @crossplatform 15084 * @atomicservice 15085 * @since 18 15086 */ 15087 targetSpace?: Length; 15088 15089 /** 15090 * Sets the position offset of the popup. 15091 * 15092 * @type { ?Position } 15093 * @syscap SystemCapability.ArkUI.ArkUI.Full 15094 * @crossplatform 15095 * @atomicservice 15096 * @since 18 15097 */ 15098 offset?: Position; 15099 15100 /** 15101 * Set the width of the popup. 15102 * 15103 * @type { ?Dimension } 15104 * @syscap SystemCapability.ArkUI.ArkUI.Full 15105 * @crossplatform 15106 * @atomicservice 15107 * @since 18 15108 */ 15109 width?: Dimension; 15110 15111 /** 15112 * The position of the sharp corner of popup. 15113 * 15114 * @type { ?ArrowPointPosition } 15115 * @syscap SystemCapability.ArkUI.ArkUI.Full 15116 * @crossplatform 15117 * @atomicservice 15118 * @since 18 15119 */ 15120 arrowPointPosition?: ArrowPointPosition; 15121 15122 /** 15123 * The width of the arrow. 15124 * 15125 * @type { ?Dimension } 15126 * @default 16.0_vp. 15127 * @syscap SystemCapability.ArkUI.ArkUI.Full 15128 * @crossplatform 15129 * @atomicservice 15130 * @since 18 15131 */ 15132 arrowWidth?: Dimension; 15133 15134 /** 15135 * The height of the arrow. 15136 * 15137 * @type { ?Dimension } 15138 * @default 8.0_vp. 15139 * @syscap SystemCapability.ArkUI.ArkUI.Full 15140 * @crossplatform 15141 * @atomicservice 15142 * @since 18 15143 */ 15144 arrowHeight?: Dimension; 15145 15146 /** 15147 * The round corners of the popup. 15148 * 15149 * @type { ?Dimension } 15150 * @default 20.0_vp. 15151 * @syscap SystemCapability.ArkUI.ArkUI.Full 15152 * @crossplatform 15153 * @atomicservice 15154 * @since 18 15155 */ 15156 radius?: Dimension; 15157 15158 /** 15159 * The style of popup Shadow. 15160 * 15161 * @type { ?(ShadowOptions | ShadowStyle) } 15162 * @default ShadowStyle.OUTER_DEFAULT_MD. 15163 * @syscap SystemCapability.ArkUI.ArkUI.Full 15164 * @crossplatform 15165 * @atomicservice 15166 * @since 18 15167 */ 15168 shadow?: ShadowOptions | ShadowStyle; 15169 15170 /** 15171 * Defines popup background blur Style 15172 * 15173 * @type { ?BlurStyle } 15174 * @default BlurStyle.COMPONENT_ULTRA_THICK 15175 * @syscap SystemCapability.ArkUI.ArkUI.Full 15176 * @crossplatform 15177 * @atomicservice 15178 * @since 18 15179 */ 15180 backgroundBlurStyle?: BlurStyle; 15181 15182 /** 15183 * Set popup focusable 15184 * 15185 * @type { ?boolean } 15186 * @default true 15187 * @syscap SystemCapability.ArkUI.ArkUI.Full 15188 * @crossplatform 15189 * @atomicservice 15190 * @since 18 15191 */ 15192 focusable?: boolean; 15193 15194 /** 15195 * Defines the transition effect of popup opening and closing 15196 * 15197 * @type { ?TransitionEffect } 15198 * @syscap SystemCapability.ArkUI.ArkUI.Full 15199 * @crossplatform 15200 * @atomicservice 15201 * @since 18 15202 */ 15203 transition?: TransitionEffect; 15204 15205 /** 15206 * Callback function when the popup interactive dismiss. 15207 * Use boolean to respond all interactive dismiss event. Use Callback to customize which event should be responded. 15208 * 15209 * @type { ?(boolean | Callback<DismissPopupAction>) } 15210 * @syscap SystemCapability.ArkUI.ArkUI.Full 15211 * @crossplatform 15212 * @atomicservice 15213 * @since 18 15214 */ 15215 onWillDismiss?: boolean | Callback<DismissPopupAction>; 15216 15217 /** 15218 * Determine if it is compatible popup's half folded. 15219 * 15220 * @type { ?boolean } 15221 * @default false 15222 * @syscap SystemCapability.ArkUI.ArkUI.Full 15223 * @crossplatform 15224 * @atomicservice 15225 * @since 18 15226 */ 15227 enableHoverMode?: boolean; 15228 15229 /** 15230 * Determine if popup can follow the target node when it has rotation or scale. 15231 * 15232 * @type { ?boolean } 15233 * @default false 15234 * @syscap SystemCapability.ArkUI.ArkUI.Full 15235 * @crossplatform 15236 * @atomicservice 15237 * @since 18 15238 */ 15239 followTransformOfTarget?: boolean; 15240} 15241 15242/** 15243 * Defines the popup options. 15244 * 15245 * @interface PopupOptions 15246 * @syscap SystemCapability.ArkUI.ArkUI.Full 15247 * @since 7 15248 */ 15249/** 15250 * Defines the popup options. 15251 * 15252 * @interface PopupOptions 15253 * @syscap SystemCapability.ArkUI.ArkUI.Full 15254 * @crossplatform 15255 * @since 10 15256 */ 15257/** 15258 * Defines the popup options. 15259 * 15260 * @interface PopupOptions 15261 * @syscap SystemCapability.ArkUI.ArkUI.Full 15262 * @crossplatform 15263 * @atomicservice 15264 * @since 11 15265 */ 15266declare interface PopupOptions { 15267 /** 15268 * Information in the pop-up window. 15269 * 15270 * @type { string } 15271 * @syscap SystemCapability.ArkUI.ArkUI.Full 15272 * @since 7 15273 */ 15274 /** 15275 * Information in the pop-up window. 15276 * 15277 * @type { string } 15278 * @syscap SystemCapability.ArkUI.ArkUI.Full 15279 * @crossplatform 15280 * @since 10 15281 */ 15282 /** 15283 * Information in the pop-up window. 15284 * 15285 * @type { string } 15286 * @syscap SystemCapability.ArkUI.ArkUI.Full 15287 * @crossplatform 15288 * @atomicservice 15289 * @since 11 15290 */ 15291 message: string; 15292 15293 /** 15294 * placement On Top 15295 * 15296 * @type { ?boolean } 15297 * @syscap SystemCapability.ArkUI.ArkUI.Full 15298 * @since 7 15299 * @deprecated since 10 15300 * @useinstead PopupOptions#placement 15301 */ 15302 placementOnTop?: boolean; 15303 15304 /** 15305 * The placement of popup. 15306 * Supports all positions defined in Placement. 15307 * 15308 * @type { ?Placement } 15309 * @default Placement.Bottom 15310 * @syscap SystemCapability.ArkUI.ArkUI.Full 15311 * @crossplatform 15312 * @since 10 15313 */ 15314 /** 15315 * The placement of popup. 15316 * Supports all positions defined in Placement. 15317 * 15318 * @type { ?Placement } 15319 * @default Placement.Bottom 15320 * @syscap SystemCapability.ArkUI.ArkUI.Full 15321 * @crossplatform 15322 * @atomicservice 15323 * @since 11 15324 */ 15325 placement?: Placement; 15326 15327 /** 15328 * The first button. 15329 * 15330 * @type { ?object } 15331 * @syscap SystemCapability.ArkUI.ArkUI.Full 15332 * @since 7 15333 */ 15334 /** 15335 * The first button. 15336 * 15337 * @type { ?object } 15338 * @syscap SystemCapability.ArkUI.ArkUI.Full 15339 * @crossplatform 15340 * @since 10 15341 */ 15342 /** 15343 * The first button. 15344 * 15345 * @type { ?object } 15346 * @syscap SystemCapability.ArkUI.ArkUI.Full 15347 * @crossplatform 15348 * @atomicservice 15349 * @since 11 15350 */ 15351 primaryButton?: { 15352 /** 15353 * Button text value 15354 * 15355 * @type { string } 15356 * @syscap SystemCapability.ArkUI.ArkUI.Full 15357 * @since 7 15358 */ 15359 /** 15360 * Button text value 15361 * 15362 * @type { string } 15363 * @syscap SystemCapability.ArkUI.ArkUI.Full 15364 * @crossplatform 15365 * @since 10 15366 */ 15367 /** 15368 * Button text value 15369 * 15370 * @type { string } 15371 * @syscap SystemCapability.ArkUI.ArkUI.Full 15372 * @crossplatform 15373 * @atomicservice 15374 * @since 11 15375 */ 15376 value: string; 15377 15378 /** 15379 * action 15380 * 15381 * @type { function } 15382 * @syscap SystemCapability.ArkUI.ArkUI.Full 15383 * @since 7 15384 */ 15385 /** 15386 * action 15387 * 15388 * @type { function } 15389 * @syscap SystemCapability.ArkUI.ArkUI.Full 15390 * @crossplatform 15391 * @since 10 15392 */ 15393 /** 15394 * action 15395 * 15396 * @type { function } 15397 * @syscap SystemCapability.ArkUI.ArkUI.Full 15398 * @crossplatform 15399 * @atomicservice 15400 * @since 11 15401 */ 15402 action: () => void; 15403 }; 15404 15405 /** 15406 * The second button. 15407 * 15408 * @type { ?object } 15409 * @syscap SystemCapability.ArkUI.ArkUI.Full 15410 * @since 7 15411 */ 15412 /** 15413 * The second button. 15414 * 15415 * @type { ?object } 15416 * @syscap SystemCapability.ArkUI.ArkUI.Full 15417 * @crossplatform 15418 * @since 10 15419 */ 15420 /** 15421 * The second button. 15422 * 15423 * @type { ?object } 15424 * @syscap SystemCapability.ArkUI.ArkUI.Full 15425 * @crossplatform 15426 * @atomicservice 15427 * @since 11 15428 */ 15429 secondaryButton?: { 15430 /** 15431 * Button text value 15432 * 15433 * @type { string } 15434 * @syscap SystemCapability.ArkUI.ArkUI.Full 15435 * @since 7 15436 */ 15437 /** 15438 * Button text value 15439 * 15440 * @type { string } 15441 * @syscap SystemCapability.ArkUI.ArkUI.Full 15442 * @crossplatform 15443 * @since 10 15444 */ 15445 /** 15446 * Button text value 15447 * 15448 * @type { string } 15449 * @syscap SystemCapability.ArkUI.ArkUI.Full 15450 * @crossplatform 15451 * @atomicservice 15452 * @since 11 15453 */ 15454 value: string; 15455 15456 /** 15457 * action 15458 * 15459 * @type { function } 15460 * @syscap SystemCapability.ArkUI.ArkUI.Full 15461 * @since 7 15462 */ 15463 /** 15464 * action 15465 * 15466 * @type { function } 15467 * @syscap SystemCapability.ArkUI.ArkUI.Full 15468 * @crossplatform 15469 * @since 10 15470 */ 15471 /** 15472 * action 15473 * 15474 * @type { function } 15475 * @syscap SystemCapability.ArkUI.ArkUI.Full 15476 * @crossplatform 15477 * @atomicservice 15478 * @since 11 15479 */ 15480 action: () => void; 15481 }; 15482 15483 /** 15484 * on State Change 15485 * 15486 * @type { ?function } 15487 * @syscap SystemCapability.ArkUI.ArkUI.Full 15488 * @since 7 15489 */ 15490 /** 15491 * on State Change 15492 * 15493 * @type { ?function } 15494 * @syscap SystemCapability.ArkUI.ArkUI.Full 15495 * @crossplatform 15496 * @since 10 15497 */ 15498 /** 15499 * on State Change 15500 * 15501 * @type { ?function } 15502 * @syscap SystemCapability.ArkUI.ArkUI.Full 15503 * @crossplatform 15504 * @atomicservice 15505 * @since 11 15506 */ 15507 onStateChange?: (event: { 15508 /** 15509 * is Visible. 15510 * 15511 * @type { boolean } 15512 * @syscap SystemCapability.ArkUI.ArkUI.Full 15513 * @crossplatform 15514 * @since 10 15515 */ 15516 /** 15517 * is Visible. 15518 * 15519 * @type { boolean } 15520 * @syscap SystemCapability.ArkUI.ArkUI.Full 15521 * @crossplatform 15522 * @atomicservice 15523 * @since 11 15524 */ 15525 isVisible: boolean 15526 }) => void; 15527 15528 /** 15529 * The offset of the sharp corner of popup. 15530 * 15531 * @type { ?Length } 15532 * @syscap SystemCapability.ArkUI.ArkUI.Full 15533 * @since 9 15534 */ 15535 /** 15536 * The offset of the sharp corner of popup. 15537 * 15538 * @type { ?Length } 15539 * @syscap SystemCapability.ArkUI.ArkUI.Full 15540 * @crossplatform 15541 * @since 10 15542 */ 15543 /** 15544 * The offset of the sharp corner of popup. 15545 * 15546 * @type { ?Length } 15547 * @syscap SystemCapability.ArkUI.ArkUI.Full 15548 * @crossplatform 15549 * @atomicservice 15550 * @since 11 15551 */ 15552 arrowOffset?: Length; 15553 15554 /** 15555 * Whether to display in the sub window. 15556 * 15557 * @type { ?boolean } 15558 * @syscap SystemCapability.ArkUI.ArkUI.Full 15559 * @since 9 15560 */ 15561 /** 15562 * Whether to display in the sub window. 15563 * 15564 * @type { ?boolean } 15565 * @syscap SystemCapability.ArkUI.ArkUI.Full 15566 * @crossplatform 15567 * @since 10 15568 */ 15569 /** 15570 * Whether to display in the sub window. 15571 * 15572 * @type { ?boolean } 15573 * @syscap SystemCapability.ArkUI.ArkUI.Full 15574 * @crossplatform 15575 * @atomicservice 15576 * @since 11 15577 */ 15578 showInSubWindow?: boolean; 15579 15580 /** 15581 * The mask to block gesture events of popup. 15582 * When mask is set false, gesture events are not blocked. 15583 * When mask is set true, gesture events are blocked and mask color is transparent. 15584 * 15585 * @type { ?(boolean | { color: ResourceColor }) } 15586 * @syscap SystemCapability.ArkUI.ArkUI.Full 15587 * @crossplatform 15588 * @since 10 15589 */ 15590 /** 15591 * The mask to block gesture events of popup. 15592 * When mask is set false, gesture events are not blocked. 15593 * When mask is set true, gesture events are blocked and mask color is transparent. 15594 * 15595 * @type { ?(boolean | { color: ResourceColor }) } 15596 * @syscap SystemCapability.ArkUI.ArkUI.Full 15597 * @crossplatform 15598 * @atomicservice 15599 * @since 11 15600 */ 15601 mask?: boolean | { color: ResourceColor }; 15602 15603 /** 15604 * Sets the options of popup message. 15605 * 15606 * @type { ?PopupMessageOptions } 15607 * @syscap SystemCapability.ArkUI.ArkUI.Full 15608 * @crossplatform 15609 * @since 10 15610 */ 15611 /** 15612 * Sets the options of popup message. 15613 * 15614 * @type { ?PopupMessageOptions } 15615 * @syscap SystemCapability.ArkUI.ArkUI.Full 15616 * @crossplatform 15617 * @atomicservice 15618 * @since 11 15619 */ 15620 messageOptions?: PopupMessageOptions 15621 15622 /** 15623 * Sets the space of between the popup and target. 15624 * 15625 * @type { ?Length } 15626 * @syscap SystemCapability.ArkUI.ArkUI.Full 15627 * @crossplatform 15628 * @since 10 15629 */ 15630 /** 15631 * Sets the space of between the popup and target. 15632 * 15633 * @type { ?Length } 15634 * @syscap SystemCapability.ArkUI.ArkUI.Full 15635 * @crossplatform 15636 * @atomicservice 15637 * @since 11 15638 */ 15639 targetSpace?: Length 15640 15641 /** 15642 * whether show arrow 15643 * 15644 * @type { ?boolean } 15645 * @default true 15646 * @syscap SystemCapability.ArkUI.ArkUI.Full 15647 * @since 10 15648 */ 15649 /** 15650 * whether show arrow 15651 * 15652 * @type { ?boolean } 15653 * @default true 15654 * @syscap SystemCapability.ArkUI.ArkUI.Full 15655 * @crossplatform 15656 * @atomicservice 15657 * @since 11 15658 */ 15659 enableArrow?: boolean; 15660 /** 15661 * Sets the position offset of the popup. 15662 * 15663 * @type { ?Position } 15664 * @syscap SystemCapability.ArkUI.ArkUI.Full 15665 * @crossplatform 15666 * @since 10 15667 */ 15668 /** 15669 * Sets the position offset of the popup. 15670 * 15671 * @type { ?Position } 15672 * @syscap SystemCapability.ArkUI.ArkUI.Full 15673 * @crossplatform 15674 * @atomicservice 15675 * @since 11 15676 */ 15677 offset?: Position 15678 15679 /** 15680 * Set the background color of the popup. 15681 * 15682 * @type { ?(Color | string | Resource | number) } 15683 * @syscap SystemCapability.ArkUI.ArkUI.Full 15684 * @crossplatform 15685 * @since 11 15686 */ 15687 /** 15688 * Set the background color of the popup. 15689 * 15690 * @type { ?(Color | string | Resource | number) } 15691 * @syscap SystemCapability.ArkUI.ArkUI.Full 15692 * @crossplatform 15693 * @atomicservice 15694 * @since 12 15695 */ 15696 popupColor?: Color | string | Resource | number; 15697 15698 /** 15699 * Whether hide popup when click mask 15700 * 15701 * @type { ?boolean } 15702 * @default true 15703 * @syscap SystemCapability.ArkUI.ArkUI.Full 15704 * @crossplatform 15705 * @since 11 15706 */ 15707 /** 15708 * Whether hide popup when click mask 15709 * 15710 * @type { ?boolean } 15711 * @default true 15712 * @syscap SystemCapability.ArkUI.ArkUI.Full 15713 * @crossplatform 15714 * @atomicservice 15715 * @since 12 15716 */ 15717 autoCancel?: boolean; 15718 15719 /** 15720 * Set the width of the popup. 15721 * 15722 * @type { ?Dimension } 15723 * @syscap SystemCapability.ArkUI.ArkUI.Full 15724 * @crossplatform 15725 * @since 11 15726 */ 15727 /** 15728 * Set the width of the popup. 15729 * 15730 * @type { ?Dimension } 15731 * @syscap SystemCapability.ArkUI.ArkUI.Full 15732 * @crossplatform 15733 * @atomicservice 15734 * @since 12 15735 */ 15736 width?: Dimension; 15737 15738 /** 15739 * The position of the sharp corner of popup. 15740 * 15741 * @type { ?ArrowPointPosition } 15742 * @syscap SystemCapability.ArkUI.ArkUI.Full 15743 * @crossplatform 15744 * @since 11 15745 */ 15746 /** 15747 * The position of the sharp corner of popup. 15748 * 15749 * @type { ?ArrowPointPosition } 15750 * @syscap SystemCapability.ArkUI.ArkUI.Full 15751 * @crossplatform 15752 * @atomicservice 15753 * @since 12 15754 */ 15755 arrowPointPosition?: ArrowPointPosition; 15756 15757 /** 15758 * The width of the arrow. 15759 * 15760 * @type { ?Dimension } 15761 * @default 16.0_vp. 15762 * @syscap SystemCapability.ArkUI.ArkUI.Full 15763 * @crossplatform 15764 * @since 11 15765 */ 15766 /** 15767 * The width of the arrow. 15768 * 15769 * @type { ?Dimension } 15770 * @default 16.0_vp. 15771 * @syscap SystemCapability.ArkUI.ArkUI.Full 15772 * @crossplatform 15773 * @atomicservice 15774 * @since 12 15775 */ 15776 arrowWidth?: Dimension; 15777 15778 /** 15779 * The height of the arrow. 15780 * 15781 * @type { ?Dimension } 15782 * @default 8.0_vp. 15783 * @syscap SystemCapability.ArkUI.ArkUI.Full 15784 * @crossplatform 15785 * @since 11 15786 */ 15787 /** 15788 * The height of the arrow. 15789 * 15790 * @type { ?Dimension } 15791 * @default 8.0_vp. 15792 * @syscap SystemCapability.ArkUI.ArkUI.Full 15793 * @crossplatform 15794 * @atomicservice 15795 * @since 12 15796 */ 15797 arrowHeight?: Dimension; 15798 15799 /** 15800 * The round corners of the popup. 15801 * 15802 * @type { ?Dimension } 15803 * @default 20.0_vp. 15804 * @syscap SystemCapability.ArkUI.ArkUI.Full 15805 * @crossplatform 15806 * @since 11 15807 */ 15808 /** 15809 * The round corners of the popup. 15810 * 15811 * @type { ?Dimension } 15812 * @default 20.0_vp. 15813 * @syscap SystemCapability.ArkUI.ArkUI.Full 15814 * @crossplatform 15815 * @atomicservice 15816 * @since 12 15817 */ 15818 radius?: Dimension; 15819 15820 /** 15821 * The style of popup Shadow. 15822 * 15823 * @type { ?(ShadowOptions | ShadowStyle) } 15824 * @default ShadowStyle.OUTER_DEFAULT_MD. 15825 * @syscap SystemCapability.ArkUI.ArkUI.Full 15826 * @crossplatform 15827 * @since 11 15828 */ 15829 /** 15830 * The style of popup Shadow. 15831 * 15832 * @type { ?(ShadowOptions | ShadowStyle) } 15833 * @default ShadowStyle.OUTER_DEFAULT_MD. 15834 * @syscap SystemCapability.ArkUI.ArkUI.Full 15835 * @crossplatform 15836 * @atomicservice 15837 * @since 12 15838 */ 15839 shadow?: ShadowOptions | ShadowStyle; 15840 15841 /** 15842 * Defines popup background blur Style 15843 * 15844 * @type { ?BlurStyle } 15845 * @default BlurStyle.COMPONENT_ULTRA_THICK 15846 * @syscap SystemCapability.ArkUI.ArkUI.Full 15847 * @crossplatform 15848 * @since 11 15849 */ 15850 /** 15851 * Defines popup background blur Style 15852 * 15853 * @type { ?BlurStyle } 15854 * @default BlurStyle.COMPONENT_ULTRA_THICK 15855 * @syscap SystemCapability.ArkUI.ArkUI.Full 15856 * @crossplatform 15857 * @atomicservice 15858 * @since 12 15859 */ 15860 backgroundBlurStyle?: BlurStyle; 15861 15862 /** 15863 * Defines the transition effect of popup opening and closing 15864 * 15865 * @type { ?TransitionEffect } 15866 * @syscap SystemCapability.ArkUI.ArkUI.Full 15867 * @crossplatform 15868 * @atomicservice 15869 * @since 12 15870 */ 15871 transition?: TransitionEffect; 15872 15873 /** 15874 * Callback function when the popup interactive dismiss 15875 * 15876 * @type { ?(boolean | Callback<DismissPopupAction>) } 15877 * @syscap SystemCapability.ArkUI.ArkUI.Full 15878 * @crossplatform 15879 * @atomicservice 15880 * @since 12 15881 */ 15882 onWillDismiss?: boolean | Callback<DismissPopupAction>; 15883 15884 /** 15885 * Determine if it is compatible popup's half folded. 15886 * 15887 * @type { ?boolean } 15888 * @default false 15889 * @syscap SystemCapability.ArkUI.ArkUI.Full 15890 * @crossplatform 15891 * @atomicservice 15892 * @since 18 15893 */ 15894 enableHoverMode?: boolean; 15895 15896 /** 15897 * Determine if popup can follow the target node when it has rotation or scale. 15898 * 15899 * @type { ?boolean } 15900 * @default false 15901 * @syscap SystemCapability.ArkUI.ArkUI.Full 15902 * @crossplatform 15903 * @atomicservice 15904 * @since 13 15905 */ 15906 followTransformOfTarget?: boolean; 15907 15908 /** 15909 * Define the popup avoid keyboard mode. 15910 * 15911 * @type { ?KeyboardAvoidMode } 15912 * @default KeyboardAvoidMode.NONE 15913 * @syscap SystemCapability.ArkUI.ArkUI.Full 15914 * @crossplatform 15915 * @atomicservice 15916 * @since 15 15917 */ 15918 keyboardAvoidMode?: KeyboardAvoidMode; 15919} 15920 15921/** 15922 * Defines the custom popup options. 15923 * 15924 * @interface CustomPopupOptions 15925 * @syscap SystemCapability.ArkUI.ArkUI.Full 15926 * @since 8 15927 */ 15928/** 15929 * Defines the custom popup options. 15930 * 15931 * @interface CustomPopupOptions 15932 * @syscap SystemCapability.ArkUI.ArkUI.Full 15933 * @crossplatform 15934 * @since 10 15935 */ 15936/** 15937 * Defines the custom popup options. 15938 * 15939 * @interface CustomPopupOptions 15940 * @syscap SystemCapability.ArkUI.ArkUI.Full 15941 * @crossplatform 15942 * @atomicservice 15943 * @since 11 15944 */ 15945declare interface CustomPopupOptions { 15946 /** 15947 * builder of popup 15948 * 15949 * @type { CustomBuilder } 15950 * @syscap SystemCapability.ArkUI.ArkUI.Full 15951 * @since 8 15952 */ 15953 /** 15954 * builder of popup 15955 * 15956 * @type { CustomBuilder } 15957 * @syscap SystemCapability.ArkUI.ArkUI.Full 15958 * @crossplatform 15959 * @since 10 15960 */ 15961 /** 15962 * builder of popup 15963 * 15964 * @type { CustomBuilder } 15965 * @syscap SystemCapability.ArkUI.ArkUI.Full 15966 * @crossplatform 15967 * @atomicservice 15968 * @since 11 15969 */ 15970 builder: CustomBuilder; 15971 15972 /** 15973 * placement of popup 15974 * 15975 * @type { ?Placement } 15976 * @syscap SystemCapability.ArkUI.ArkUI.Full 15977 * @since 8 15978 */ 15979 /** 15980 * placement of popup 15981 * 15982 * @type { ?Placement } 15983 * @syscap SystemCapability.ArkUI.ArkUI.Full 15984 * @crossplatform 15985 * @since 10 15986 */ 15987 /** 15988 * placement of popup 15989 * 15990 * @type { ?Placement } 15991 * @syscap SystemCapability.ArkUI.ArkUI.Full 15992 * @crossplatform 15993 * @atomicservice 15994 * @since 11 15995 */ 15996 placement?: Placement; 15997 15998 /** 15999 * mask color of popup 16000 * 16001 * @type { ?(Color | string | Resource | number) } 16002 * @syscap SystemCapability.ArkUI.ArkUI.Full 16003 * @since 8 16004 * @deprecated since 10 16005 * @useinstead CustomPopupOptions#mask 16006 */ 16007 maskColor?: Color | string | Resource | number; 16008 16009 /** 16010 * background color of popup 16011 * 16012 * @type { ?(Color | string | Resource | number) } 16013 * @syscap SystemCapability.ArkUI.ArkUI.Full 16014 * @since 8 16015 */ 16016 /** 16017 * background color of popup 16018 * 16019 * @type { ?(Color | string | Resource | number) } 16020 * @syscap SystemCapability.ArkUI.ArkUI.Full 16021 * @crossplatform 16022 * @since 10 16023 */ 16024 /** 16025 * background color of popup 16026 * 16027 * @type { ?(Color | string | Resource | number) } 16028 * @syscap SystemCapability.ArkUI.ArkUI.Full 16029 * @crossplatform 16030 * @atomicservice 16031 * @since 11 16032 */ 16033 popupColor?: Color | string | Resource | number; 16034 16035 /** 16036 * whether show arrow 16037 * 16038 * @type { ?boolean } 16039 * @syscap SystemCapability.ArkUI.ArkUI.Full 16040 * @since 8 16041 */ 16042 /** 16043 * whether show arrow 16044 * 16045 * @type { ?boolean } 16046 * @syscap SystemCapability.ArkUI.ArkUI.Full 16047 * @crossplatform 16048 * @since 10 16049 */ 16050 /** 16051 * whether show arrow 16052 * 16053 * @type { ?boolean } 16054 * @syscap SystemCapability.ArkUI.ArkUI.Full 16055 * @crossplatform 16056 * @atomicservice 16057 * @since 11 16058 */ 16059 enableArrow?: boolean; 16060 16061 /** 16062 * whether hide popup when click mask 16063 * 16064 * @type { ?boolean } 16065 * @syscap SystemCapability.ArkUI.ArkUI.Full 16066 * @since 8 16067 */ 16068 /** 16069 * whether hide popup when click mask 16070 * 16071 * @type { ?boolean } 16072 * @syscap SystemCapability.ArkUI.ArkUI.Full 16073 * @crossplatform 16074 * @since 10 16075 */ 16076 /** 16077 * whether hide popup when click mask 16078 * 16079 * @type { ?boolean } 16080 * @syscap SystemCapability.ArkUI.ArkUI.Full 16081 * @crossplatform 16082 * @atomicservice 16083 * @since 11 16084 */ 16085 autoCancel?: boolean; 16086 16087 /** 16088 * on State Change 16089 * 16090 * @type { ?function } 16091 * @syscap SystemCapability.ArkUI.ArkUI.Full 16092 * @since 8 16093 */ 16094 /** 16095 * on State Change 16096 * 16097 * @type { ?function } 16098 * @syscap SystemCapability.ArkUI.ArkUI.Full 16099 * @crossplatform 16100 * @since 10 16101 */ 16102 /** 16103 * on State Change 16104 * 16105 * @type { ?function } 16106 * @syscap SystemCapability.ArkUI.ArkUI.Full 16107 * @crossplatform 16108 * @atomicservice 16109 * @since 11 16110 */ 16111 onStateChange?: (event: { 16112 /** 16113 * is Visible. 16114 * 16115 * @type { boolean } 16116 * @syscap SystemCapability.ArkUI.ArkUI.Full 16117 * @crossplatform 16118 * @since 10 16119 */ 16120 /** 16121 * is Visible. 16122 * 16123 * @type { boolean } 16124 * @syscap SystemCapability.ArkUI.ArkUI.Full 16125 * @crossplatform 16126 * @atomicservice 16127 * @since 11 16128 */ 16129 isVisible: boolean 16130 }) => void; 16131 16132 /** 16133 * The offset of the sharp corner of popup. 16134 * 16135 * @type { ?Length } 16136 * @syscap SystemCapability.ArkUI.ArkUI.Full 16137 * @since 9 16138 */ 16139 /** 16140 * The offset of the sharp corner of popup. 16141 * 16142 * @type { ?Length } 16143 * @syscap SystemCapability.ArkUI.ArkUI.Full 16144 * @crossplatform 16145 * @since 10 16146 */ 16147 /** 16148 * The offset of the sharp corner of popup. 16149 * 16150 * @type { ?Length } 16151 * @syscap SystemCapability.ArkUI.ArkUI.Full 16152 * @crossplatform 16153 * @atomicservice 16154 * @since 11 16155 */ 16156 arrowOffset?: Length; 16157 16158 /** 16159 * Whether to display in the sub window. 16160 * 16161 * @type { ?boolean } 16162 * @syscap SystemCapability.ArkUI.ArkUI.Full 16163 * @since 9 16164 */ 16165 /** 16166 * Whether to display in the sub window. 16167 * 16168 * @type { ?boolean } 16169 * @syscap SystemCapability.ArkUI.ArkUI.Full 16170 * @crossplatform 16171 * @since 10 16172 */ 16173 /** 16174 * Whether to display in the sub window. 16175 * 16176 * @type { ?boolean } 16177 * @syscap SystemCapability.ArkUI.ArkUI.Full 16178 * @crossplatform 16179 * @atomicservice 16180 * @since 11 16181 */ 16182 showInSubWindow?: boolean; 16183 16184 /** 16185 * The mask to block gesture events of popup. 16186 * When mask is set false, gesture events are not blocked. 16187 * When mask is set true, gesture events are blocked and mask color is transparent. 16188 * 16189 * @type { ?(boolean | { color: ResourceColor }) } 16190 * @syscap SystemCapability.ArkUI.ArkUI.Full 16191 * @crossplatform 16192 * @since 10 16193 */ 16194 /** 16195 * The mask to block gesture events of popup. 16196 * When mask is set false, gesture events are not blocked. 16197 * When mask is set true, gesture events are blocked and mask color is transparent. 16198 * 16199 * @type { ?(boolean | { color: ResourceColor }) } 16200 * @syscap SystemCapability.ArkUI.ArkUI.Full 16201 * @crossplatform 16202 * @atomicservice 16203 * @since 11 16204 */ 16205 mask?: boolean | { color: ResourceColor }; 16206 16207 /** 16208 * Sets the space of between the popup and target. 16209 * 16210 * @type { ?Length } 16211 * @syscap SystemCapability.ArkUI.ArkUI.Full 16212 * @crossplatform 16213 * @since 10 16214 */ 16215 /** 16216 * Sets the space of between the popup and target. 16217 * 16218 * @type { ?Length } 16219 * @syscap SystemCapability.ArkUI.ArkUI.Full 16220 * @crossplatform 16221 * @atomicservice 16222 * @since 11 16223 */ 16224 targetSpace?: Length 16225 16226 /** 16227 * Sets the position offset of the popup. 16228 * 16229 * @type { ?Position } 16230 * @syscap SystemCapability.ArkUI.ArkUI.Full 16231 * @crossplatform 16232 * @since 10 16233 */ 16234 /** 16235 * Sets the position offset of the popup. 16236 * 16237 * @type { ?Position } 16238 * @syscap SystemCapability.ArkUI.ArkUI.Full 16239 * @crossplatform 16240 * @atomicservice 16241 * @since 11 16242 */ 16243 offset?: Position 16244 16245 /** 16246 * Set the width of the popup. 16247 * 16248 * @type { ?Dimension } 16249 * @syscap SystemCapability.ArkUI.ArkUI.Full 16250 * @crossplatform 16251 * @since 11 16252 */ 16253 /** 16254 * Set the width of the popup. 16255 * 16256 * @type { ?Dimension } 16257 * @syscap SystemCapability.ArkUI.ArkUI.Full 16258 * @crossplatform 16259 * @atomicservice 16260 * @since 12 16261 */ 16262 width?: Dimension; 16263 16264 /** 16265 * The position of the sharp corner of popup. 16266 * 16267 * @type { ?ArrowPointPosition } 16268 * @syscap SystemCapability.ArkUI.ArkUI.Full 16269 * @crossplatform 16270 * @since 11 16271 */ 16272 /** 16273 * The position of the sharp corner of popup. 16274 * 16275 * @type { ?ArrowPointPosition } 16276 * @syscap SystemCapability.ArkUI.ArkUI.Full 16277 * @crossplatform 16278 * @atomicservice 16279 * @since 12 16280 */ 16281 arrowPointPosition?: ArrowPointPosition; 16282 16283 /** 16284 * The width of the arrow. 16285 * 16286 * @type { ?Dimension } 16287 * @default 16.0_vp. 16288 * @syscap SystemCapability.ArkUI.ArkUI.Full 16289 * @crossplatform 16290 * @since 11 16291 */ 16292 /** 16293 * The width of the arrow. 16294 * 16295 * @type { ?Dimension } 16296 * @default 16.0_vp. 16297 * @syscap SystemCapability.ArkUI.ArkUI.Full 16298 * @crossplatform 16299 * @atomicservice 16300 * @since 12 16301 */ 16302 arrowWidth?: Dimension; 16303 16304 /** 16305 * The height of the arrow. 16306 * 16307 * @type { ?Dimension } 16308 * @default 8.0_vp. 16309 * @syscap SystemCapability.ArkUI.ArkUI.Full 16310 * @crossplatform 16311 * @since 11 16312 */ 16313 /** 16314 * The height of the arrow. 16315 * 16316 * @type { ?Dimension } 16317 * @default 8.0_vp. 16318 * @syscap SystemCapability.ArkUI.ArkUI.Full 16319 * @crossplatform 16320 * @atomicservice 16321 * @since 12 16322 */ 16323 arrowHeight?: Dimension; 16324 16325 /** 16326 * The round corners of the popup. 16327 * 16328 * @type { ?Dimension } 16329 * @default 20.0_vp. 16330 * @syscap SystemCapability.ArkUI.ArkUI.Full 16331 * @crossplatform 16332 * @since 11 16333 */ 16334 /** 16335 * The round corners of the popup. 16336 * 16337 * @type { ?Dimension } 16338 * @default 20.0_vp. 16339 * @syscap SystemCapability.ArkUI.ArkUI.Full 16340 * @crossplatform 16341 * @atomicservice 16342 * @since 12 16343 */ 16344 radius?: Dimension; 16345 16346 /** 16347 * The style of popup Shadow. 16348 * 16349 * @type { ?(ShadowOptions | ShadowStyle) } 16350 * @default ShadowStyle.OUTER_DEFAULT_MD. 16351 * @syscap SystemCapability.ArkUI.ArkUI.Full 16352 * @crossplatform 16353 * @since 11 16354 */ 16355 /** 16356 * The style of popup Shadow. 16357 * 16358 * @type { ?(ShadowOptions | ShadowStyle) } 16359 * @default ShadowStyle.OUTER_DEFAULT_MD. 16360 * @syscap SystemCapability.ArkUI.ArkUI.Full 16361 * @crossplatform 16362 * @atomicservice 16363 * @since 12 16364 */ 16365 shadow?: ShadowOptions | ShadowStyle; 16366 16367 /** 16368 * Defines popup background blur Style 16369 * 16370 * @type { ?BlurStyle } 16371 * @default BlurStyle.COMPONENT_ULTRA_THICK 16372 * @syscap SystemCapability.ArkUI.ArkUI.Full 16373 * @crossplatform 16374 * @since 11 16375 */ 16376 /** 16377 * Defines popup background blur Style 16378 * 16379 * @type { ?BlurStyle } 16380 * @default BlurStyle.COMPONENT_ULTRA_THICK 16381 * @syscap SystemCapability.ArkUI.ArkUI.Full 16382 * @crossplatform 16383 * @atomicservice 16384 * @since 12 16385 */ 16386 backgroundBlurStyle?: BlurStyle; 16387 16388 /** 16389 * Set popup focusable 16390 * 16391 * @type { ?boolean } 16392 * @default true 16393 * @syscap SystemCapability.ArkUI.ArkUI.Full 16394 * @crossplatform 16395 * @since 11 16396 */ 16397 /** 16398 * Set popup focusable 16399 * 16400 * @type { ?boolean } 16401 * @default true 16402 * @syscap SystemCapability.ArkUI.ArkUI.Full 16403 * @crossplatform 16404 * @atomicservice 16405 * @since 12 16406 */ 16407 focusable?: boolean; 16408 16409 /** 16410 * Defines the transition effect of popup opening and closing 16411 * 16412 * @type { ?TransitionEffect } 16413 * @syscap SystemCapability.ArkUI.ArkUI.Full 16414 * @crossplatform 16415 * @atomicservice 16416 * @since 12 16417 */ 16418 transition?: TransitionEffect; 16419 16420 /** 16421 * Callback function when the popup interactive dismiss 16422 * 16423 * @type { ?(boolean | Callback<DismissPopupAction>) } 16424 * @syscap SystemCapability.ArkUI.ArkUI.Full 16425 * @crossplatform 16426 * @atomicservice 16427 * @since 12 16428 */ 16429 onWillDismiss?: boolean | Callback<DismissPopupAction>; 16430 16431 /** 16432 * Determine if it is compatible popup's half folded. 16433 * 16434 * @type { ?boolean } 16435 * @default false 16436 * @syscap SystemCapability.ArkUI.ArkUI.Full 16437 * @crossplatform 16438 * @atomicservice 16439 * @since 18 16440 */ 16441 enableHoverMode?: boolean; 16442 16443 /** 16444 * Determine if popup can follow the target node when it has rotation or scale. 16445 * 16446 * @type { ?boolean } 16447 * @default false 16448 * @syscap SystemCapability.ArkUI.ArkUI.Full 16449 * @crossplatform 16450 * @atomicservice 16451 * @since 13 16452 */ 16453 followTransformOfTarget?: boolean; 16454 16455 /** 16456 * Define the popup avoid keyboard mode. 16457 * 16458 * @type { ?KeyboardAvoidMode } 16459 * @default KeyboardAvoidMode.NONE 16460 * @syscap SystemCapability.ArkUI.ArkUI.Full 16461 * @crossplatform 16462 * @atomicservice 16463 * @since 15 16464 */ 16465 keyboardAvoidMode?: KeyboardAvoidMode; 16466} 16467 16468/** 16469 * Defines the menu preview mode. 16470 * 16471 * @enum { number } 16472 * @syscap SystemCapability.ArkUI.ArkUI.Full 16473 * @crossplatform 16474 * @since 11 16475 */ 16476/** 16477 * Defines the menu preview mode. 16478 * 16479 * @enum { number } 16480 * @syscap SystemCapability.ArkUI.ArkUI.Full 16481 * @crossplatform 16482 * @atomicservice 16483 * @since 12 16484 */ 16485declare enum MenuPreviewMode { 16486 /** 16487 * No preview content. 16488 * 16489 * @syscap SystemCapability.ArkUI.ArkUI.Full 16490 * @crossplatform 16491 * @since 11 16492 */ 16493 /** 16494 * No preview content. 16495 * 16496 * @syscap SystemCapability.ArkUI.ArkUI.Full 16497 * @crossplatform 16498 * @atomicservice 16499 * @since 12 16500 */ 16501 NONE = 0, 16502 /** 16503 * Defines image type preview content. 16504 * 16505 * @syscap SystemCapability.ArkUI.ArkUI.Full 16506 * @crossplatform 16507 * @since 11 16508 */ 16509 /** 16510 * Defines image type preview content. 16511 * 16512 * @syscap SystemCapability.ArkUI.ArkUI.Full 16513 * @crossplatform 16514 * @atomicservice 16515 * @since 12 16516 */ 16517 IMAGE = 1 16518} 16519 16520/** 16521 * Defines the animator range of start and end property. 16522 * 16523 * @typedef { [from: T, to: T] } AnimationRange<T> 16524 * @syscap SystemCapability.ArkUI.ArkUI.Full 16525 * @crossplatform 16526 * @since 11 16527 */ 16528/** 16529 * Defines the animator range of start and end property. 16530 * 16531 * @typedef { [from: T, to: T] } AnimationRange<T> 16532 * @syscap SystemCapability.ArkUI.ArkUI.Full 16533 * @crossplatform 16534 * @atomicservice 16535 * @since 12 16536 */ 16537declare type AnimationRange<T> = [from: T, to: T]; 16538 16539/** 16540 * Defines the ContextMenu's preview animator options. 16541 * 16542 * @interface ContextMenuAnimationOptions 16543 * @syscap SystemCapability.ArkUI.ArkUI.Full 16544 * @crossplatform 16545 * @since 11 16546 */ 16547/** 16548 * Defines the ContextMenu's preview animator options. 16549 * 16550 * @interface ContextMenuAnimationOptions 16551 * @syscap SystemCapability.ArkUI.ArkUI.Full 16552 * @crossplatform 16553 * @atomicservice 16554 * @since 12 16555 */ 16556interface ContextMenuAnimationOptions { 16557 /** 16558 * Sets the start animator scale and end animator scale. 16559 * 16560 * @type { ?AnimationRange<number> } 16561 * @default - 16562 * @syscap SystemCapability.ArkUI.ArkUI.Full 16563 * @crossplatform 16564 * @since 11 16565 */ 16566 /** 16567 * Sets the start animator scale and end animator scale. 16568 * 16569 * @type { ?AnimationRange<number> } 16570 * @default - 16571 * @syscap SystemCapability.ArkUI.ArkUI.Full 16572 * @crossplatform 16573 * @atomicservice 16574 * @since 12 16575 */ 16576 scale?: AnimationRange<number>; 16577 /** 16578 * Defines the transition effect of menu preview opening and closing. 16579 * 16580 * @type { ?TransitionEffect } 16581 * @syscap SystemCapability.ArkUI.ArkUI.Full 16582 * @crossplatform 16583 * @atomicservice 16584 * @since 12 16585 */ 16586 transition?: TransitionEffect; 16587 16588 /** 16589 * Sets the scale start and end animator of the image displayed before the custom builder preview is displayed. 16590 * 16591 * @type { ?AnimationRange<number> } 16592 * @syscap SystemCapability.ArkUI.ArkUI.Full 16593 * @crossplatform 16594 * @atomicservice 16595 * @since 12 16596 */ 16597 hoverScale?: AnimationRange<number>; 16598} 16599 16600/** 16601 * Defines the menu haptic feedback mode. 16602 * 16603 * @enum { number } 16604 * @syscap SystemCapability.ArkUI.ArkUI.Full 16605 * @crossplatform 16606 * @atomicservice 16607 * @since 18 16608 */ 16609declare enum HapticFeedbackMode { 16610 /** 16611 * No haptic feedback. 16612 * 16613 * @syscap SystemCapability.ArkUI.ArkUI.Full 16614 * @crossplatform 16615 * @atomicservice 16616 * @since 18 16617 */ 16618 DISABLED = 0, 16619 /** 16620 * Defines menu always haptic feedback. 16621 * 16622 * @syscap SystemCapability.ArkUI.ArkUI.Full 16623 * @crossplatform 16624 * @atomicservice 16625 * @since 18 16626 */ 16627 ENABLED = 1, 16628 /** 16629 * Defines menu automatically haptic feedback. 16630 * 16631 * @syscap SystemCapability.ArkUI.ArkUI.Full 16632 * @crossplatform 16633 * @atomicservice 16634 * @since 18 16635 */ 16636 AUTO = 2 16637} 16638 16639/** 16640 * Defines the context menu options. 16641 * 16642 * @interface ContextMenuOptions 16643 * @syscap SystemCapability.ArkUI.ArkUI.Full 16644 * @crossplatform 16645 * @since 10 16646 */ 16647/** 16648 * Defines the context menu options. 16649 * 16650 * @interface ContextMenuOptions 16651 * @syscap SystemCapability.ArkUI.ArkUI.Full 16652 * @crossplatform 16653 * @atomicservice 16654 * @since 11 16655 */ 16656declare interface ContextMenuOptions { 16657 /** 16658 * Sets the position offset of the context menu window. 16659 * 16660 * @type { ?Position } 16661 * @default - 16662 * @syscap SystemCapability.ArkUI.ArkUI.Full 16663 * @crossplatform 16664 * @since 10 16665 */ 16666 /** 16667 * Sets the position offset of the context menu window. 16668 * 16669 * @type { ?Position } 16670 * @default - 16671 * @syscap SystemCapability.ArkUI.ArkUI.Full 16672 * @crossplatform 16673 * @atomicservice 16674 * @since 11 16675 */ 16676 offset?: Position; 16677 16678 /** 16679 * Sets the placement of the context menu window. 16680 * 16681 * @type { ?Placement } 16682 * @default - 16683 * @syscap SystemCapability.ArkUI.ArkUI.Full 16684 * @crossplatform 16685 * @since 10 16686 */ 16687 /** 16688 * Sets the placement of the context menu window. 16689 * 16690 * @type { ?Placement } 16691 * @default - 16692 * @syscap SystemCapability.ArkUI.ArkUI.Full 16693 * @crossplatform 16694 * @atomicservice 16695 * @since 11 16696 */ 16697 placement?: Placement; 16698 16699 /** 16700 * whether show arrow belong to the menu, default: false, not show arrow 16701 * 16702 * @type { ?boolean } 16703 * @default false 16704 * @syscap SystemCapability.ArkUI.ArkUI.Full 16705 * @since 10 16706 */ 16707 /** 16708 * whether show arrow belong to the menu, default: false, not show arrow 16709 * 16710 * @type { ?boolean } 16711 * @default false 16712 * @syscap SystemCapability.ArkUI.ArkUI.Full 16713 * @crossplatform 16714 * @atomicservice 16715 * @since 11 16716 */ 16717 enableArrow?: boolean; 16718 16719 /** 16720 * The horizontal offset to the left of menu or vertical offset to the top of menu 16721 * 16722 * @type { ?Length } 16723 * @default 0 16724 * @syscap SystemCapability.ArkUI.ArkUI.Full 16725 * @since 10 16726 */ 16727 /** 16728 * The horizontal offset to the left of menu or vertical offset to the top of menu 16729 * 16730 * @type { ?Length } 16731 * @default 0 16732 * @syscap SystemCapability.ArkUI.ArkUI.Full 16733 * @crossplatform 16734 * @atomicservice 16735 * @since 11 16736 */ 16737 arrowOffset?: Length; 16738 16739 /** 16740 * The preview content of context menu. 16741 * 16742 * @type { ?(MenuPreviewMode | CustomBuilder) } 16743 * @default MenuPreviewMode.NONE 16744 * @syscap SystemCapability.ArkUI.ArkUI.Full 16745 * @crossplatform 16746 * @since 11 16747 */ 16748 /** 16749 * The preview content of context menu. 16750 * 16751 * @type { ?(MenuPreviewMode | CustomBuilder) } 16752 * @default MenuPreviewMode.NONE 16753 * @syscap SystemCapability.ArkUI.ArkUI.Full 16754 * @crossplatform 16755 * @atomicservice 16756 * @since 12 16757 */ 16758 preview?: MenuPreviewMode | CustomBuilder; 16759 16760 /** 16761 * Defines the border radius of menu. 16762 * 16763 * @type { ?(Length | BorderRadiuses | LocalizedBorderRadiuses) } 16764 * @syscap SystemCapability.ArkUI.ArkUI.Full 16765 * @crossplatform 16766 * @atomicservice 16767 * @since 12 16768 */ 16769 borderRadius?: Length | BorderRadiuses | LocalizedBorderRadiuses; 16770 16771 /** 16772 * Callback function when the context menu appears. 16773 * 16774 * @type { ?function } 16775 * @syscap SystemCapability.ArkUI.ArkUI.Full 16776 * @crossplatform 16777 * @since 10 16778 */ 16779 /** 16780 * Callback function when the context menu appears. 16781 * 16782 * @type { ?function } 16783 * @syscap SystemCapability.ArkUI.ArkUI.Full 16784 * @crossplatform 16785 * @atomicservice 16786 * @since 11 16787 */ 16788 onAppear?: () => void; 16789 16790 /** 16791 * Callback function when the context menu disappear. 16792 * 16793 * @type { ?function } 16794 * @syscap SystemCapability.ArkUI.ArkUI.Full 16795 * @crossplatform 16796 * @since 10 16797 */ 16798 /** 16799 * Callback function when the context menu disappear. 16800 * 16801 * @type { ?function } 16802 * @syscap SystemCapability.ArkUI.ArkUI.Full 16803 * @crossplatform 16804 * @atomicservice 16805 * @since 11 16806 */ 16807 onDisappear?: () => void; 16808 16809 /** 16810 * Callback function before the context menu animation starts. 16811 * 16812 * @type { ?function } 16813 * @syscap SystemCapability.ArkUI.ArkUI.Full 16814 * @crossplatform 16815 * @since 11 16816 */ 16817 /** 16818 * Callback function before the context menu animation starts. 16819 * 16820 * @type { ?function } 16821 * @syscap SystemCapability.ArkUI.ArkUI.Full 16822 * @crossplatform 16823 * @atomicservice 16824 * @since 12 16825 */ 16826 aboutToAppear?: () => void; 16827 16828 /** 16829 * Callback function before the context menu popAnimation starts. 16830 * 16831 * @type { ?function } 16832 * @syscap SystemCapability.ArkUI.ArkUI.Full 16833 * @crossplatform 16834 * @since 11 16835 */ 16836 /** 16837 * Callback function before the context menu popAnimation starts. 16838 * 16839 * @type { ?function } 16840 * @syscap SystemCapability.ArkUI.ArkUI.Full 16841 * @crossplatform 16842 * @atomicservice 16843 * @since 12 16844 */ 16845 aboutToDisappear?: () => void; 16846 16847 /** 16848 * The margin of menu's layoutRegion. 16849 * 16850 * @type { ?Margin } 16851 * @syscap SystemCapability.ArkUI.ArkUI.Full 16852 * @crossplatform 16853 * @atomicservice 16854 * @since 13 16855 */ 16856 layoutRegionMargin?: Margin; 16857 16858 /** 16859 * The preview animator options. 16860 * 16861 * @type { ?ContextMenuAnimationOptions } 16862 * @syscap SystemCapability.ArkUI.ArkUI.Full 16863 * @crossplatform 16864 * @since 11 16865 */ 16866 /** 16867 * The preview animator options. 16868 * 16869 * @type { ?ContextMenuAnimationOptions } 16870 * @syscap SystemCapability.ArkUI.ArkUI.Full 16871 * @crossplatform 16872 * @atomicservice 16873 * @since 12 16874 */ 16875 previewAnimationOptions?: ContextMenuAnimationOptions; 16876 16877 /** 16878 * Defines the menu's background color 16879 * 16880 * @type { ?ResourceColor } 16881 * @default Color.Transparent 16882 * @syscap SystemCapability.ArkUI.ArkUI.Full 16883 * @crossplatform 16884 * @since 11 16885 */ 16886 /** 16887 * Defines the menu's background color 16888 * 16889 * @type { ?ResourceColor } 16890 * @default Color.Transparent 16891 * @syscap SystemCapability.ArkUI.ArkUI.Full 16892 * @crossplatform 16893 * @atomicservice 16894 * @since 12 16895 */ 16896 backgroundColor?: ResourceColor; 16897 16898 /** 16899 * Defines menu background blur Style 16900 * 16901 * @type { ?BlurStyle } 16902 * @default BlurStyle.COMPONENT_ULTRA_THICK 16903 * @syscap SystemCapability.ArkUI.ArkUI.Full 16904 * @crossplatform 16905 * @since 11 16906 */ 16907 /** 16908 * Defines menu background blur Style 16909 * 16910 * @type { ?BlurStyle } 16911 * @default BlurStyle.COMPONENT_ULTRA_THICK 16912 * @syscap SystemCapability.ArkUI.ArkUI.Full 16913 * @crossplatform 16914 * @atomicservice 16915 * @since 12 16916 */ 16917 backgroundBlurStyle?: BlurStyle; 16918 16919 /** 16920 * Defines the menu's background blur style with options 16921 * 16922 * @type { ?BackgroundBlurStyleOptions } 16923 * @syscap SystemCapability.ArkUI.ArkUI.Full 16924 * @crossplatform 16925 * @atomicservice 16926 * @since 18 16927 */ 16928 backgroundBlurStyleOptions?: BackgroundBlurStyleOptions; 16929 16930 /** 16931 * Defines the menu's background effect with options 16932 * 16933 * @type { ?BackgroundEffectOptions } 16934 * @syscap SystemCapability.ArkUI.ArkUI.Full 16935 * @crossplatform 16936 * @atomicservice 16937 * @since 18 16938 */ 16939 backgroundEffect?: BackgroundEffectOptions; 16940 16941 /** 16942 * Defines the transition effect of menu opening and closing. 16943 * 16944 * @type { ?TransitionEffect } 16945 * @syscap SystemCapability.ArkUI.ArkUI.Full 16946 * @crossplatform 16947 * @atomicservice 16948 * @since 12 16949 */ 16950 transition?: TransitionEffect; 16951 16952 /** 16953 * Determine if it is compatible menu's half folded. 16954 * 16955 * @type { ?boolean } 16956 * @default false 16957 * @syscap SystemCapability.ArkUI.ArkUI.Full 16958 * @crossplatform 16959 * @atomicservice 16960 * @since 18 16961 */ 16962 enableHoverMode?: boolean; 16963 16964 /** 16965 * Defines the haptic feedback mode of menu. 16966 * 16967 * @type { ?HapticFeedbackMode } 16968 * @default HapticFeedbackMode.DISABLED 16969 * @syscap SystemCapability.ArkUI.ArkUI.Full 16970 * @crossplatform 16971 * @atomicservice 16972 * @since 18 16973 */ 16974 hapticFeedbackMode?: HapticFeedbackMode; 16975} 16976 16977/** 16978 * Defines the menu options. 16979 * 16980 * @extends ContextMenuOptions 16981 * @interface MenuOptions 16982 * @syscap SystemCapability.ArkUI.ArkUI.Full 16983 * @crossplatform 16984 * @since 10 16985 */ 16986/** 16987 * Defines the menu options. 16988 * 16989 * @extends ContextMenuOptions 16990 * @interface MenuOptions 16991 * @syscap SystemCapability.ArkUI.ArkUI.Full 16992 * @crossplatform 16993 * @atomicservice 16994 * @since 11 16995 */ 16996declare interface MenuOptions extends ContextMenuOptions { 16997 /** 16998 * Sets the title of the menu window. 16999 * 17000 * @type { ?ResourceStr } 17001 * @syscap SystemCapability.ArkUI.ArkUI.Full 17002 * @crossplatform 17003 * @since 10 17004 */ 17005 /** 17006 * Sets the title of the menu window. 17007 * 17008 * @type { ?ResourceStr } 17009 * @syscap SystemCapability.ArkUI.ArkUI.Full 17010 * @crossplatform 17011 * @atomicservice 17012 * @since 11 17013 */ 17014 title?: ResourceStr; 17015 17016 /** 17017 * Whether to display in the sub window. 17018 * 17019 * @type { ?boolean } 17020 * @syscap SystemCapability.ArkUI.ArkUI.Full 17021 * @crossplatform 17022 * @since 11 17023 */ 17024 /** 17025 * Whether to display in the sub window. 17026 * 17027 * @type { ?boolean } 17028 * @syscap SystemCapability.ArkUI.ArkUI.Full 17029 * @crossplatform 17030 * @atomicservice 17031 * @since 12 17032 */ 17033 showInSubWindow?: boolean; 17034} 17035 17036/** 17037 * Defines the ProgressMask class. 17038 * 17039 * @syscap SystemCapability.ArkUI.ArkUI.Full 17040 * @crossplatform 17041 * @since 10 17042 */ 17043/** 17044 * Defines the ProgressMask class. 17045 * 17046 * @syscap SystemCapability.ArkUI.ArkUI.Full 17047 * @crossplatform 17048 * @atomicservice 17049 * @since 11 17050 */ 17051declare class ProgressMask { 17052 /** 17053 * constructor. 17054 * 17055 * @param { number } value - indicates the current value of the progress. 17056 * @param { number } total - indicates the total value of the progress. 17057 * @param { ResourceColor } color - indicates the color of the mask. 17058 * @syscap SystemCapability.ArkUI.ArkUI.Full 17059 * @crossplatform 17060 * @since 10 17061 */ 17062 /** 17063 * constructor. 17064 * 17065 * @param { number } value - indicates the current value of the progress. 17066 * @param { number } total - indicates the total value of the progress. 17067 * @param { ResourceColor } color - indicates the color of the mask. 17068 * @syscap SystemCapability.ArkUI.ArkUI.Full 17069 * @crossplatform 17070 * @atomicservice 17071 * @since 11 17072 */ 17073 constructor(value: number, total: number, color: ResourceColor); 17074 17075 /** 17076 * Update the current value of the progress. 17077 * 17078 * @param { number } value - indicates the current value of the progress. 17079 * @syscap SystemCapability.ArkUI.ArkUI.Full 17080 * @crossplatform 17081 * @since 10 17082 */ 17083 /** 17084 * Update the current value of the progress. 17085 * 17086 * @param { number } value - indicates the current value of the progress. 17087 * @syscap SystemCapability.ArkUI.ArkUI.Full 17088 * @crossplatform 17089 * @atomicservice 17090 * @since 11 17091 */ 17092 updateProgress(value: number): void; 17093 17094 /** 17095 * Update the color of the mask. 17096 * 17097 * @param { ResourceColor } value - indicates the color of the mask. 17098 * @syscap SystemCapability.ArkUI.ArkUI.Full 17099 * @crossplatform 17100 * @since 10 17101 */ 17102 /** 17103 * Update the color of the mask. 17104 * 17105 * @param { ResourceColor } value - indicates the color of the mask. 17106 * @syscap SystemCapability.ArkUI.ArkUI.Full 17107 * @crossplatform 17108 * @atomicservice 17109 * @since 11 17110 */ 17111 updateColor(value: ResourceColor): void; 17112 17113 /** 17114 * Enable the breathe animation of mask. 17115 * 17116 * @param { boolean } value 17117 * @syscap SystemCapability.ArkUI.ArkUI.Full 17118 * @crossplatform 17119 * @atomicservice 17120 * @since 12 17121 */ 17122 enableBreathingAnimation(value: boolean): void; 17123} 17124 17125/** 17126 * Defines TouchTestInfo class. 17127 * 17128 * @syscap SystemCapability.ArkUI.ArkUI.Full 17129 * @crossplatform 17130 * @since 11 17131 */ 17132/** 17133 * Defines TouchTestInfo class. 17134 * 17135 * @syscap SystemCapability.ArkUI.ArkUI.Full 17136 * @crossplatform 17137 * @atomicservice 17138 * @since 12 17139 */ 17140declare class TouchTestInfo { 17141 /** 17142 * Get the X-coordinate relative to the window. 17143 * 17144 * @type { number } 17145 * @syscap SystemCapability.ArkUI.ArkUI.Full 17146 * @crossplatform 17147 * @since 11 17148 */ 17149 /** 17150 * Get the X-coordinate relative to the window. 17151 * 17152 * @type { number } 17153 * @syscap SystemCapability.ArkUI.ArkUI.Full 17154 * @crossplatform 17155 * @atomicservice 17156 * @since 12 17157 */ 17158 windowX: number; 17159 17160 /** 17161 * Get the Y-coordinate relative to the window. 17162 * 17163 * @type { number } 17164 * @syscap SystemCapability.ArkUI.ArkUI.Full 17165 * @crossplatform 17166 * @since 11 17167 */ 17168 /** 17169 * Get the Y-coordinate relative to the window. 17170 * 17171 * @type { number } 17172 * @syscap SystemCapability.ArkUI.ArkUI.Full 17173 * @crossplatform 17174 * @atomicservice 17175 * @since 12 17176 */ 17177 windowY: number; 17178 17179 /** 17180 * Get the X-coordinate relative to the current component. 17181 * 17182 * @type { number } 17183 * @syscap SystemCapability.ArkUI.ArkUI.Full 17184 * @crossplatform 17185 * @since 11 17186 */ 17187 /** 17188 * Get the X-coordinate relative to the current component. 17189 * 17190 * @type { number } 17191 * @syscap SystemCapability.ArkUI.ArkUI.Full 17192 * @crossplatform 17193 * @atomicservice 17194 * @since 12 17195 */ 17196 parentX: number; 17197 17198 /** 17199 * Get the Y-coordinate relative to the current component. 17200 * 17201 * @type { number } 17202 * @syscap SystemCapability.ArkUI.ArkUI.Full 17203 * @crossplatform 17204 * @since 11 17205 */ 17206 /** 17207 * Get the Y-coordinate relative to the current component. 17208 * 17209 * @type { number } 17210 * @syscap SystemCapability.ArkUI.ArkUI.Full 17211 * @crossplatform 17212 * @atomicservice 17213 * @since 12 17214 */ 17215 parentY: number; 17216 17217 /** 17218 * Get the X-coordinate relative to the sub component. 17219 * 17220 * @type { number } 17221 * @syscap SystemCapability.ArkUI.ArkUI.Full 17222 * @crossplatform 17223 * @since 11 17224 */ 17225 /** 17226 * Get the X-coordinate relative to the sub component. 17227 * 17228 * @type { number } 17229 * @syscap SystemCapability.ArkUI.ArkUI.Full 17230 * @crossplatform 17231 * @atomicservice 17232 * @since 12 17233 */ 17234 x: number; 17235 17236 /** 17237 * Get the Y-coordinate relative to the sub component. 17238 * 17239 * @type { number } 17240 * @syscap SystemCapability.ArkUI.ArkUI.Full 17241 * @crossplatform 17242 * @since 11 17243 */ 17244 /** 17245 * Get the Y-coordinate relative to the sub component. 17246 * 17247 * @type { number } 17248 * @syscap SystemCapability.ArkUI.ArkUI.Full 17249 * @crossplatform 17250 * @atomicservice 17251 * @since 12 17252 */ 17253 y: number; 17254 17255 /** 17256 * Get the rectangle of sub component. 17257 * 17258 * @type { RectResult } 17259 * @syscap SystemCapability.ArkUI.ArkUI.Full 17260 * @crossplatform 17261 * @since 11 17262 */ 17263 /** 17264 * Get the rectangle of sub component. 17265 * 17266 * @type { RectResult } 17267 * @syscap SystemCapability.ArkUI.ArkUI.Full 17268 * @crossplatform 17269 * @atomicservice 17270 * @since 12 17271 */ 17272 rect: RectResult; 17273 17274 /** 17275 * Get the name of sub component. 17276 * 17277 * @type { string } 17278 * @syscap SystemCapability.ArkUI.ArkUI.Full 17279 * @crossplatform 17280 * @since 11 17281 */ 17282 /** 17283 * Get the name of sub component. 17284 * 17285 * @type { string } 17286 * @syscap SystemCapability.ArkUI.ArkUI.Full 17287 * @crossplatform 17288 * @atomicservice 17289 * @since 12 17290 */ 17291 id: string; 17292} 17293 17294/** 17295 * Defines TouchResult class. 17296 * 17297 * @syscap SystemCapability.ArkUI.ArkUI.Full 17298 * @crossplatform 17299 * @since 11 17300 */ 17301/** 17302 * Defines TouchResult class. 17303 * 17304 * @syscap SystemCapability.ArkUI.ArkUI.Full 17305 * @crossplatform 17306 * @atomicservice 17307 * @since 12 17308 */ 17309declare class TouchResult { 17310 /** 17311 * Defines the touch test strategy. 17312 * 17313 * @type { TouchTestStrategy } 17314 * @syscap SystemCapability.ArkUI.ArkUI.Full 17315 * @crossplatform 17316 * @since 11 17317 */ 17318 /** 17319 * Defines the touch test strategy. 17320 * 17321 * @type { TouchTestStrategy } 17322 * @syscap SystemCapability.ArkUI.ArkUI.Full 17323 * @crossplatform 17324 * @atomicservice 17325 * @since 12 17326 */ 17327 strategy: TouchTestStrategy; 17328 17329 /** 17330 * Defines the component's name. 17331 * 17332 * @type { ?string } 17333 * @syscap SystemCapability.ArkUI.ArkUI.Full 17334 * @crossplatform 17335 * @since 11 17336 */ 17337 /** 17338 * Defines the component's name. 17339 * 17340 * @type { ?string } 17341 * @syscap SystemCapability.ArkUI.ArkUI.Full 17342 * @crossplatform 17343 * @atomicservice 17344 * @since 12 17345 */ 17346 id?: string; 17347} 17348 17349/** 17350 * Set the edge blur effect distance of the corresponding defense line of the component 17351 * When the component expand out, no re-layout is triggered 17352 * 17353 * @interface PixelStretchEffectOptions 17354 * @syscap SystemCapability.ArkUI.ArkUI.Full 17355 * @crossplatform 17356 * @since 10 17357 */ 17358/** 17359 * Set the edge blur effect distance of the corresponding defense line of the component 17360 * When the component expand out, no re-layout is triggered 17361 * 17362 * @interface PixelStretchEffectOptions 17363 * @syscap SystemCapability.ArkUI.ArkUI.Full 17364 * @crossplatform 17365 * @atomicservice 17366 * @since 11 17367 */ 17368declare interface PixelStretchEffectOptions { 17369 /** 17370 * top property. value range (-∞, ∞) 17371 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 17372 * 17373 * @type { ?Length } 17374 * @default 0 17375 * @syscap SystemCapability.ArkUI.ArkUI.Full 17376 * @crossplatform 17377 * @since 10 17378 */ 17379 /** 17380 * top property. value range (-∞, ∞) 17381 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 17382 * 17383 * @type { ?Length } 17384 * @default 0 17385 * @syscap SystemCapability.ArkUI.ArkUI.Full 17386 * @crossplatform 17387 * @atomicservice 17388 * @since 11 17389 */ 17390 top?: Length; 17391 17392 /** 17393 * bottom property. value range (-∞, ∞) 17394 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 17395 * 17396 * @type { ?Length } 17397 * @default 0 17398 * @syscap SystemCapability.ArkUI.ArkUI.Full 17399 * @crossplatform 17400 * @since 10 17401 */ 17402 /** 17403 * bottom property. value range (-∞, ∞) 17404 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 17405 * 17406 * @type { ?Length } 17407 * @default 0 17408 * @syscap SystemCapability.ArkUI.ArkUI.Full 17409 * @crossplatform 17410 * @atomicservice 17411 * @since 11 17412 */ 17413 bottom?: Length; 17414 17415 /** 17416 * left property. value range (-∞, ∞) 17417 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 17418 * 17419 * @type { ?Length } 17420 * @default 0 17421 * @syscap SystemCapability.ArkUI.ArkUI.Full 17422 * @crossplatform 17423 * @since 10 17424 */ 17425 /** 17426 * left property. value range (-∞, ∞) 17427 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 17428 * 17429 * @type { ?Length } 17430 * @default 0 17431 * @syscap SystemCapability.ArkUI.ArkUI.Full 17432 * @crossplatform 17433 * @atomicservice 17434 * @since 11 17435 */ 17436 left?: Length; 17437 17438 /** 17439 * right property. value range (-∞, ∞) 17440 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 17441 * 17442 * @type { ?Length } 17443 * @default 0 17444 * @syscap SystemCapability.ArkUI.ArkUI.Full 17445 * @crossplatform 17446 * @since 10 17447 */ 17448 /** 17449 * right property. value range (-∞, ∞) 17450 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 17451 * 17452 * @type { ?Length } 17453 * @default 0 17454 * @syscap SystemCapability.ArkUI.ArkUI.Full 17455 * @crossplatform 17456 * @atomicservice 17457 * @since 11 17458 */ 17459 right?: Length; 17460} 17461 17462/** 17463 * Defines the click effect. 17464 * 17465 * @interface ClickEffect 17466 * @syscap SystemCapability.ArkUI.ArkUI.Full 17467 * @crossplatform 17468 * @since 10 17469 */ 17470/** 17471 * Defines the click effect. 17472 * 17473 * @interface ClickEffect 17474 * @syscap SystemCapability.ArkUI.ArkUI.Full 17475 * @crossplatform 17476 * @atomicservice 17477 * @since 11 17478 */ 17479declare interface ClickEffect { 17480 /** 17481 * Set the click effect level. 17482 * 17483 * @type { ClickEffectLevel } 17484 * @default ClickEffectLevel.Light 17485 * @syscap SystemCapability.ArkUI.ArkUI.Full 17486 * @since 10 17487 */ 17488 /** 17489 * Set the click effect level. 17490 * 17491 * @type { ClickEffectLevel } 17492 * @default ClickEffectLevel.Light 17493 * @syscap SystemCapability.ArkUI.ArkUI.Full 17494 * @atomicservice 17495 * @since 11 17496 */ 17497 level: ClickEffectLevel; 17498 17499 /** 17500 * Set scale number. 17501 * This default scale is same as the scale of click effect level. 17502 * 17503 * @type { ?number } 17504 * @syscap SystemCapability.ArkUI.ArkUI.Full 17505 * @since 10 17506 */ 17507 /** 17508 * Set scale number. 17509 * This default scale is same as the scale of click effect level. 17510 * 17511 * @type { ?number } 17512 * @syscap SystemCapability.ArkUI.ArkUI.Full 17513 * @atomicservice 17514 * @since 11 17515 */ 17516 scale?: number; 17517} 17518 17519/** 17520 * Defines the fadingEdge options. 17521 * 17522 * @typedef FadingEdgeOptions 17523 * @syscap SystemCapability.ArkUI.ArkUI.Full 17524 * @crossplatform 17525 * @atomicservice 17526 * @since 14 17527 */ 17528declare interface FadingEdgeOptions { 17529 /** 17530 * The length of FadingEdge. 17531 * 17532 * @type { LengthMetrics } 17533 * @default 32vp 17534 * @syscap SystemCapability.ArkUI.ArkUI.Full 17535 * @crossplatform 17536 * @atomicservice 17537 * @since 14 17538 */ 17539 fadingEdgeLength?: LengthMetrics; 17540} 17541 17542/** 17543 * Define nested scroll options 17544 * 17545 * @interface NestedScrollOptions 17546 * @syscap SystemCapability.ArkUI.ArkUI.Full 17547 * @since 10 17548 */ 17549/** 17550 * Define nested scroll options 17551 * 17552 * @interface NestedScrollOptions 17553 * @syscap SystemCapability.ArkUI.ArkUI.Full 17554 * @atomicservice 17555 * @since 11 17556 */ 17557declare interface NestedScrollOptions { 17558 /** 17559 * Set NestedScrollMode when the scrollable component scrolls forward 17560 * 17561 * @type { NestedScrollMode } 17562 * @syscap SystemCapability.ArkUI.ArkUI.Full 17563 * @since 10 17564 */ 17565 /** 17566 * Set NestedScrollMode when the scrollable component scrolls forward 17567 * 17568 * @type { NestedScrollMode } 17569 * @syscap SystemCapability.ArkUI.ArkUI.Full 17570 * @crossplatform 17571 * @atomicservice 17572 * @since 11 17573 */ 17574 scrollForward: NestedScrollMode; 17575 17576 /** 17577 * Set NestedScrollMode when the scrollable component scrolls backward 17578 * 17579 * @type { NestedScrollMode } 17580 * @syscap SystemCapability.ArkUI.ArkUI.Full 17581 * @since 10 17582 */ 17583 /** 17584 * Set NestedScrollMode when the scrollable component scrolls backward 17585 * 17586 * @type { NestedScrollMode } 17587 * @syscap SystemCapability.ArkUI.ArkUI.Full 17588 * @crossplatform 17589 * @atomicservice 17590 * @since 11 17591 */ 17592 scrollBackward: NestedScrollMode; 17593} 17594 17595/** 17596 * Defines the menu element. 17597 * 17598 * @interface MenuElement 17599 * @syscap SystemCapability.ArkUI.ArkUI.Full 17600 * @since 7 17601 */ 17602/** 17603 * Defines the menu element. 17604 * 17605 * @interface MenuElement 17606 * @syscap SystemCapability.ArkUI.ArkUI.Full 17607 * @crossplatform 17608 * @since 10 17609 */ 17610/** 17611 * Defines the menu element. 17612 * 17613 * @interface MenuElement 17614 * @syscap SystemCapability.ArkUI.ArkUI.Full 17615 * @crossplatform 17616 * @atomicservice 17617 * @since 11 17618 */ 17619declare interface MenuElement { 17620 /** 17621 * Sets the value of the menu element. 17622 * 17623 * @type { ResourceStr } 17624 * @syscap SystemCapability.ArkUI.ArkUI.Full 17625 * @since 7 17626 */ 17627 /** 17628 * Sets the value of the menu element. 17629 * 17630 * @type { ResourceStr } 17631 * @syscap SystemCapability.ArkUI.ArkUI.Full 17632 * @crossplatform 17633 * @since 10 17634 */ 17635 /** 17636 * Sets the value of the menu element. 17637 * 17638 * @type { ResourceStr } 17639 * @syscap SystemCapability.ArkUI.ArkUI.Full 17640 * @crossplatform 17641 * @atomicservice 17642 * @since 11 17643 */ 17644 value: ResourceStr; 17645 17646 /** 17647 * Sets the icon of the menu element. 17648 * 17649 * @type { ?ResourceStr } 17650 * @syscap SystemCapability.ArkUI.ArkUI.Full 17651 * @crossplatform 17652 * @since 10 17653 */ 17654 /** 17655 * Sets the icon of the menu element. 17656 * 17657 * @type { ?ResourceStr } 17658 * @syscap SystemCapability.ArkUI.ArkUI.Full 17659 * @crossplatform 17660 * @atomicservice 17661 * @since 11 17662 */ 17663 icon?: ResourceStr; 17664 17665 /** 17666 * Sets the symbol of the menu element. 17667 * 17668 * @type { ?SymbolGlyphModifier } 17669 * @syscap SystemCapability.ArkUI.ArkUI.Full 17670 * @atomicservice 17671 * @since 12 17672 */ 17673 symbolIcon?: SymbolGlyphModifier; 17674 17675 /** 17676 * If the value is true, the menu element is available and can respond to operations such as clicking. 17677 * If the value is false, the menu element is not available and click operations are not responded. 17678 * 17679 * @type { ?boolean } 17680 * @default true 17681 * @syscap SystemCapability.ArkUI.ArkUI.Full 17682 * @crossplatform 17683 * @since 11 17684 */ 17685 /** 17686 * If the value is true, the menu element is available and can respond to operations such as clicking. 17687 * If the value is false, the menu element is not available and click operations are not responded. 17688 * 17689 * @type { ?boolean } 17690 * @default true 17691 * @syscap SystemCapability.ArkUI.ArkUI.Full 17692 * @crossplatform 17693 * @atomicservice 17694 * @since 12 17695 */ 17696 enabled?: boolean; 17697 17698 /** 17699 * Method executed by the callback. 17700 * 17701 * @type { function } 17702 * @syscap SystemCapability.ArkUI.ArkUI.Full 17703 * @since 7 17704 */ 17705 /** 17706 * Method executed by the callback. 17707 * 17708 * @type { function } 17709 * @syscap SystemCapability.ArkUI.ArkUI.Full 17710 * @crossplatform 17711 * @since 10 17712 */ 17713 /** 17714 * Method executed by the callback. 17715 * 17716 * @type { function } 17717 * @syscap SystemCapability.ArkUI.ArkUI.Full 17718 * @crossplatform 17719 * @atomicservice 17720 * @since 11 17721 */ 17722 action: () => void; 17723} 17724 17725/** 17726 * Defines the attribute modifier. 17727 * 17728 * @interface AttributeModifier<T> 17729 * @syscap SystemCapability.ArkUI.ArkUI.Full 17730 * @crossplatform 17731 * @since 11 17732 */ 17733/** 17734 * Defines the attribute modifier. 17735 * 17736 * @interface AttributeModifier<T> 17737 * @syscap SystemCapability.ArkUI.ArkUI.Full 17738 * @crossplatform 17739 * @atomicservice 17740 * @since 12 17741 */ 17742declare interface AttributeModifier<T> { 17743 17744 /** 17745 * Defines the normal update attribute function. 17746 * 17747 * @param { T } instance 17748 * @syscap SystemCapability.ArkUI.ArkUI.Full 17749 * @crossplatform 17750 * @since 11 17751 */ 17752 /** 17753 * Defines the normal update attribute function. 17754 * 17755 * @param { T } instance 17756 * @syscap SystemCapability.ArkUI.ArkUI.Full 17757 * @crossplatform 17758 * @atomicservice 17759 * @since 12 17760 */ 17761 applyNormalAttribute?(instance: T) : void; 17762 17763 /** 17764 * Defines the pressed update attribute function. 17765 * 17766 * @param { T } instance 17767 * @syscap SystemCapability.ArkUI.ArkUI.Full 17768 * @crossplatform 17769 * @since 11 17770 */ 17771 /** 17772 * Defines the pressed update attribute function. 17773 * 17774 * @param { T } instance 17775 * @syscap SystemCapability.ArkUI.ArkUI.Full 17776 * @crossplatform 17777 * @atomicservice 17778 * @since 12 17779 */ 17780 applyPressedAttribute?(instance: T) : void; 17781 17782 /** 17783 * Defines the focused update attribute function. 17784 * 17785 * @param { T } instance 17786 * @syscap SystemCapability.ArkUI.ArkUI.Full 17787 * @crossplatform 17788 * @since 11 17789 */ 17790 /** 17791 * Defines the focused update attribute function. 17792 * 17793 * @param { T } instance 17794 * @syscap SystemCapability.ArkUI.ArkUI.Full 17795 * @crossplatform 17796 * @atomicservice 17797 * @since 12 17798 */ 17799 applyFocusedAttribute?(instance: T) : void; 17800 17801 /** 17802 * Defines the disabled update attribute function. 17803 * 17804 * @param { T } instance 17805 * @syscap SystemCapability.ArkUI.ArkUI.Full 17806 * @crossplatform 17807 * @since 11 17808 */ 17809 /** 17810 * Defines the disabled update attribute function. 17811 * 17812 * @param { T } instance 17813 * @syscap SystemCapability.ArkUI.ArkUI.Full 17814 * @crossplatform 17815 * @atomicservice 17816 * @since 12 17817 */ 17818 applyDisabledAttribute?(instance: T) : void; 17819 17820 /** 17821 * Defines the selected update attribute function. 17822 * 17823 * @param { T } instance 17824 * @syscap SystemCapability.ArkUI.ArkUI.Full 17825 * @crossplatform 17826 * @since 11 17827 */ 17828 /** 17829 * Defines the selected update attribute function. 17830 * 17831 * @param { T } instance 17832 * @syscap SystemCapability.ArkUI.ArkUI.Full 17833 * @crossplatform 17834 * @atomicservice 17835 * @since 12 17836 */ 17837 applySelectedAttribute?(instance: T) : void; 17838} 17839 17840/** 17841 * Defines the content modifier. 17842 * 17843 * @interface ContentModifier 17844 * @syscap SystemCapability.ArkUI.ArkUI.Full 17845 * @crossplatform 17846 * @atomicservice 17847 * @since 12 17848 */ 17849declare interface ContentModifier<T> { 17850 17851 /** 17852 * Defining applyContent function. 17853 * 17854 * @returns { WrappedBuilder<[T]> } 17855 * @syscap SystemCapability.ArkUI.ArkUI.Full 17856 * @crossplatform 17857 * @atomicservice 17858 * @since 12 17859 */ 17860 applyContent(): WrappedBuilder<[T]> 17861} 17862 17863/** 17864 * Defines the common configuration. 17865 * 17866 * @interface CommonConfiguration 17867 * @syscap SystemCapability.ArkUI.ArkUI.Full 17868 * @crossplatform 17869 * @atomicservice 17870 * @since 12 17871 */ 17872declare interface CommonConfiguration<T> { 17873 17874 /** 17875 * If the value is true, the contentModifier is available and can respond to operations such as triggerChange. 17876 * If it is set to false, triggerChange operations are not responded. 17877 * 17878 * @type { boolean } 17879 * @syscap SystemCapability.ArkUI.ArkUI.Full 17880 * @crossplatform 17881 * @atomicservice 17882 * @since 12 17883 */ 17884 enabled: boolean, 17885 17886 /** 17887 * Obtains the contentModifier instance object 17888 * 17889 * @type { ContentModifier<T> } 17890 * @syscap SystemCapability.ArkUI.ArkUI.Full 17891 * @crossplatform 17892 * @atomicservice 17893 * @since 12 17894 */ 17895 contentModifier: ContentModifier<T> 17896} 17897 17898/** 17899 * Outline Style 17900 * 17901 * @enum { number } 17902 * @syscap SystemCapability.ArkUI.ArkUI.Full 17903 * @crossplatform 17904 * @form 17905 * @since 11 17906 */ 17907/** 17908 * Outline Style 17909 * 17910 * @enum { number } 17911 * @syscap SystemCapability.ArkUI.ArkUI.Full 17912 * @crossplatform 17913 * @form 17914 * @atomicservice 17915 * @since 12 17916 */ 17917declare enum OutlineStyle { 17918 /** 17919 * Shows as a solid line. 17920 * 17921 * @syscap SystemCapability.ArkUI.ArkUI.Full 17922 * @crossplatform 17923 * @form 17924 * @since 11 17925 */ 17926 /** 17927 * Shows as a solid line. 17928 * 17929 * @syscap SystemCapability.ArkUI.ArkUI.Full 17930 * @crossplatform 17931 * @form 17932 * @atomicservice 17933 * @since 12 17934 */ 17935 SOLID = 0, 17936 17937 /** 17938 * Shows as a series of short square dashed lines. 17939 * 17940 * @syscap SystemCapability.ArkUI.ArkUI.Full 17941 * @crossplatform 17942 * @form 17943 * @since 11 17944 */ 17945 /** 17946 * Shows as a series of short square dashed lines. 17947 * 17948 * @syscap SystemCapability.ArkUI.ArkUI.Full 17949 * @crossplatform 17950 * @form 17951 * @atomicservice 17952 * @since 12 17953 */ 17954 DASHED = 1, 17955 17956 /** 17957 * Displays as a series of dots with a radius of half the borderWidth. 17958 * 17959 * @syscap SystemCapability.ArkUI.ArkUI.Full 17960 * @crossplatform 17961 * @form 17962 * @since 11 17963 */ 17964 /** 17965 * Displays as a series of dots with a radius of half the borderWidth. 17966 * 17967 * @syscap SystemCapability.ArkUI.ArkUI.Full 17968 * @crossplatform 17969 * @form 17970 * @atomicservice 17971 * @since 12 17972 */ 17973 DOTTED = 2, 17974} 17975 17976/** 17977 * Defines the drag preview mode. 17978 * 17979 * @enum { number } 17980 * @syscap SystemCapability.ArkUI.ArkUI.Full 17981 * @since 11 17982 */ 17983/** 17984 * Defines the drag preview mode. 17985 * 17986 * @enum { number } 17987 * @syscap SystemCapability.ArkUI.ArkUI.Full 17988 * @atomicservice 17989 * @since 12 17990 */ 17991/** 17992 * Defines the drag preview mode. 17993 * 17994 * @enum { number } 17995 * @syscap SystemCapability.ArkUI.ArkUI.Full 17996 * @crossplatform 17997 * @atomicservice 17998 * @since 18 17999 */ 18000declare enum DragPreviewMode { 18001 /** 18002 * Default preview mode, let system process preview scale. 18003 * 18004 * @syscap SystemCapability.ArkUI.ArkUI.Full 18005 * @since 11 18006 */ 18007 /** 18008 * Default preview mode, let system process preview scale. 18009 * 18010 * @syscap SystemCapability.ArkUI.ArkUI.Full 18011 * @atomicservice 18012 * @since 12 18013 */ 18014 /** 18015 * Default preview mode, let system process preview scale. 18016 * 18017 * @syscap SystemCapability.ArkUI.ArkUI.Full 18018 * @crossplatform 18019 * @atomicservice 18020 * @since 18 18021 */ 18022 AUTO = 1, 18023 /** 18024 * Disable system scale to preview panel 18025 * 18026 * @syscap SystemCapability.ArkUI.ArkUI.Full 18027 * @since 11 18028 */ 18029 /** 18030 * Disable system scale to preview panel 18031 * 18032 * @syscap SystemCapability.ArkUI.ArkUI.Full 18033 * @atomicservice 18034 * @since 12 18035 */ 18036 /** 18037 * Disable system scale to preview panel 18038 * 18039 * @syscap SystemCapability.ArkUI.ArkUI.Full 18040 * @crossplatform 18041 * @atomicservice 18042 * @since 18 18043 */ 18044 DISABLE_SCALE = 2, 18045 /** 18046 * Enable the default shadow effect of preview. 18047 * 18048 * @syscap SystemCapability.ArkUI.ArkUI.Full 18049 * @atomicservice 18050 * @since 12 18051 */ 18052 /** 18053 * Enable the default shadow effect of preview. 18054 * 18055 * @syscap SystemCapability.ArkUI.ArkUI.Full 18056 * @crossplatform 18057 * @atomicservice 18058 * @since 18 18059 */ 18060 ENABLE_DEFAULT_SHADOW = 3, 18061 /** 18062 * Enable the default radius effect of preview. 18063 * 18064 * @syscap SystemCapability.ArkUI.ArkUI.Full 18065 * @atomicservice 18066 * @since 12 18067 */ 18068 /** 18069 * Enable the default radius effect of preview. 18070 * 18071 * @syscap SystemCapability.ArkUI.ArkUI.Full 18072 * @crossplatform 18073 * @atomicservice 18074 * @since 18 18075 */ 18076 ENABLE_DEFAULT_RADIUS = 4, 18077 /** 18078 * Enable the default gray effect on the dragging item. 18079 * 18080 * @syscap SystemCapability.ArkUI.ArkUI.Full 18081 * @atomicservice 18082 * @since 18 18083 */ 18084 ENABLE_DRAG_ITEM_GRAY_EFFECT = 5, 18085 /** 18086 * Enable the tile effect for multi drag, each dragged graph is display in the original relative position. 18087 * 18088 * @syscap SystemCapability.ArkUI.ArkUI.Full 18089 * @atomicservice 18090 * @since 18 18091 */ 18092 ENABLE_MULTI_TILE_EFFECT = 6, 18093} 18094 18095/** 18096 * Define the menu pop-up policy 18097 * 18098 * @enum { number } 18099 * @syscap SystemCapability.ArkUI.ArkUI.Full 18100 * @crossplatform 18101 * @atomicservice 18102 * @since 12 18103 */ 18104declare enum MenuPolicy { 18105 /** 18106 * Default value. The default logic of whether to pop up a menu depends on the scene. 18107 * 18108 * @syscap SystemCapability.ArkUI.ArkUI.Full 18109 * @crossplatform 18110 * @atomicservice 18111 * @since 12 18112 */ 18113 DEFAULT = 0, 18114 18115 /** 18116 * Hide pop up menu. 18117 * 18118 * @syscap SystemCapability.ArkUI.ArkUI.Full 18119 * @crossplatform 18120 * @atomicservice 18121 * @since 12 18122 */ 18123 HIDE = 1, 18124 18125 /** 18126 * Show pop up menu. 18127 * 18128 * @syscap SystemCapability.ArkUI.ArkUI.Full 18129 * @crossplatform 18130 * @atomicservice 18131 * @since 12 18132 */ 18133 SHOW = 2, 18134} 18135 18136/** 18137 * ImageModifier 18138 * 18139 * @typedef { import('../api/arkui/ImageModifier').ImageModifier } ImageModifier 18140 * @syscap SystemCapability.ArkUI.ArkUI.Full 18141 * @crossplatform 18142 * @atomicservice 18143 * @since 12 18144 */ 18145declare type ImageModifier = import('../api/arkui/ImageModifier').ImageModifier; 18146 18147/** 18148 * SymbolGlyphModifier 18149 * 18150 * @typedef {import('../api/arkui/SymbolGlyphModifier').SymbolGlyphModifier} SymbolGlyphModifier 18151 * @syscap SystemCapability.ArkUI.ArkUI.Full 18152 * @atomicservice 18153 * @since 12 18154 */ 18155declare type SymbolGlyphModifier = import('../api/arkui/SymbolGlyphModifier').SymbolGlyphModifier; 18156 18157/** 18158 * Defines the preview options. 18159 * 18160 * @interface DragPreviewOptions 18161 * @syscap SystemCapability.ArkUI.ArkUI.Full 18162 * @since 11 18163 */ 18164/** 18165 * Defines the preview options. 18166 * 18167 * @interface DragPreviewOptions 18168 * @syscap SystemCapability.ArkUI.ArkUI.Full 18169 * @atomicservice 18170 * @since 12 18171 */ 18172/** 18173 * Defines the preview options. 18174 * 18175 * @interface DragPreviewOptions 18176 * @syscap SystemCapability.ArkUI.ArkUI.Full 18177 * @crossplatform 18178 * @atomicservice 18179 * @since 18 18180 */ 18181declare interface DragPreviewOptions { 18182 /** 18183 * Drag preview mode. 18184 * 18185 * @type { ?DragPreviewMode } 18186 * @syscap SystemCapability.ArkUI.ArkUI.Full 18187 * @since 11 18188 */ 18189 /** 18190 * Drag preview mode. 18191 * 18192 * @type { ?(DragPreviewMode | Array<DragPreviewMode>) } 18193 * @syscap SystemCapability.ArkUI.ArkUI.Full 18194 * @atomicservice 18195 * @since 12 18196 */ 18197 /** 18198 * Drag preview mode. 18199 * 18200 * @type { ?(DragPreviewMode | Array<DragPreviewMode>) } 18201 * @syscap SystemCapability.ArkUI.ArkUI.Full 18202 * @crossplatform 18203 * @atomicservice 18204 * @since 18 18205 */ 18206 mode?: DragPreviewMode | Array<DragPreviewMode>; 18207 18208 /** 18209 * Drag preview modifier. 18210 * 18211 * @type { ?ImageModifier } 18212 * @syscap SystemCapability.ArkUI.ArkUI.Full 18213 * @atomicservice 18214 * @since 12 18215 */ 18216 /** 18217 * Drag preview modifier. 18218 * 18219 * @type { ?ImageModifier } 18220 * @syscap SystemCapability.ArkUI.ArkUI.Full 18221 * @crossplatform 18222 * @atomicservice 18223 * @since 18 18224 */ 18225 modifier?: ImageModifier; 18226 18227 /** 18228 * The flag for number showing. 18229 * 18230 * @type { ?(boolean | number) } 18231 * @syscap SystemCapability.ArkUI.ArkUI.Full 18232 * @atomicservice 18233 * @since 12 18234 */ 18235 /** 18236 * The flag for number showing. 18237 * 18238 * @type { ?(boolean | number) } 18239 * @syscap SystemCapability.ArkUI.ArkUI.Full 18240 * @crossplatform 18241 * @atomicservice 18242 * @since 18 18243 */ 18244 numberBadge?: boolean | number; 18245} 18246 18247/** 18248 * Defines the drag options. 18249 * 18250 * @interface DragInteractionOptions 18251 * @syscap SystemCapability.ArkUI.ArkUI.Full 18252 * @atomicservice 18253 * @since 12 18254 */ 18255declare interface DragInteractionOptions { 18256 /** 18257 * Define whether to gather selected nodes in grid or list. 18258 * 18259 * @type { ?boolean } 18260 * @syscap SystemCapability.ArkUI.ArkUI.Full 18261 * @atomicservice 18262 * @since 12 18263 */ 18264 isMultiSelectionEnabled?: boolean; 18265 18266 /** 18267 * Define whether to execute animation before preview floating. 18268 * 18269 * @type { ?boolean } 18270 * @syscap SystemCapability.ArkUI.ArkUI.Full 18271 * @atomicservice 18272 * @since 12 18273 */ 18274 defaultAnimationBeforeLifting?: boolean; 18275 18276 /** 18277 * Define whether to enable the haptic feedback when dragging, the default value is false. 18278 * 18279 * @type { ?boolean } 18280 * @syscap SystemCapability.ArkUI.ArkUI.Full 18281 * @atomicservice 18282 * @since 18 18283 */ 18284 enableHapticFeedback?: boolean; 18285 18286 /** 18287 * Config if auto scrolling should be triggered when the drag hovered on a scrollable controller's edge. 18288 * 18289 * @type { ?boolean } 18290 * @syscap SystemCapability.ArkUI.ArkUI.Full 18291 * @atomicservice 18292 * @since 18 18293 */ 18294 enableEdgeAutoScroll?: boolean; 18295 18296 /** 18297 * Define whether to lifting trigger drag by finger. 18298 * 18299 * @type { ?boolean } 18300 * @default false 18301 * @syscap SystemCapability.ArkUI.ArkUI.Full 18302 * @atomicservice 18303 * @since 15 18304 */ 18305 isLiftingDisabled?: boolean; 18306} 18307 18308/** 18309 * Defines the drag preview configuration. 18310 * 18311 * @interface PreviewConfiguration 18312 * @syscap SystemCapability.ArkUI.ArkUI.Full 18313 * @atomicservice 18314 * @since 15 18315 */ 18316declare interface PreviewConfiguration { 18317 /** 18318 * Define whether to only use for lifting. 18319 * 18320 * @type { ?boolean } 18321 * @default false 18322 * @syscap SystemCapability.ArkUI.ArkUI.Full 18323 * @atomicservice 18324 * @since 15 18325 */ 18326 onlyForLifting?: boolean; 18327 18328 /** 18329 * Define whether to delay create builder. 18330 * 18331 * @type { ?boolean } 18332 * @default false 18333 * @syscap SystemCapability.ArkUI.ArkUI.Full 18334 * @atomicservice 18335 * @since 15 18336 */ 18337 delayCreating?: boolean; 18338} 18339 18340/** 18341 * Define the options of invert 18342 * 18343 * @interface InvertOptions 18344 * @syscap SystemCapability.ArkUI.ArkUI.Full 18345 * @since 11 18346 */ 18347/** 18348 * Define the options of invert 18349 * 18350 * @interface InvertOptions 18351 * @syscap SystemCapability.ArkUI.ArkUI.Full 18352 * @atomicservice 18353 * @since 12 18354 */ 18355declare interface InvertOptions { 18356 18357 /** 18358 * Defines the low value of threshold 18359 * 18360 * @type { number } 18361 * @syscap SystemCapability.ArkUI.ArkUI.Full 18362 * @crossplatform 18363 * @since 11 18364 */ 18365 /** 18366 * Defines the low value of threshold 18367 * 18368 * @type { number } 18369 * @syscap SystemCapability.ArkUI.ArkUI.Full 18370 * @crossplatform 18371 * @atomicservice 18372 * @since 12 18373 */ 18374 low: number; 18375 18376 /** 18377 * Defines the high value of threshold 18378 * 18379 * @type { number } 18380 * @syscap SystemCapability.ArkUI.ArkUI.Full 18381 * @crossplatform 18382 * @since 11 18383 */ 18384 /** 18385 * Defines the high value of threshold 18386 * 18387 * @type { number } 18388 * @syscap SystemCapability.ArkUI.ArkUI.Full 18389 * @crossplatform 18390 * @atomicservice 18391 * @since 12 18392 */ 18393 high: number; 18394 18395 /** 18396 * Defines the threshold 18397 * 18398 * @type { number } 18399 * @syscap SystemCapability.ArkUI.ArkUI.Full 18400 * @crossplatform 18401 * @since 11 18402 */ 18403 /** 18404 * Defines the threshold 18405 * 18406 * @type { number } 18407 * @syscap SystemCapability.ArkUI.ArkUI.Full 18408 * @crossplatform 18409 * @atomicservice 18410 * @since 12 18411 */ 18412 threshold: number; 18413 18414 /** 18415 *Defines the threshold range 18416 * 18417 * @type { number } 18418 * @syscap SystemCapability.ArkUI.ArkUI.Full 18419 * @crossplatform 18420 * @since 11 18421 */ 18422 /** 18423 *Defines the threshold range 18424 * 18425 * @type { number } 18426 * @syscap SystemCapability.ArkUI.ArkUI.Full 18427 * @crossplatform 18428 * @atomicservice 18429 * @since 12 18430 */ 18431 thresholdRange: number; 18432} 18433 18434/** 18435 * Import the CircleShape type object for common method. 18436 * 18437 * @typedef { import('../api/@ohos.arkui.shape').CircleShape } CircleShape 18438 * @syscap SystemCapability.ArkUI.ArkUI.Full 18439 * @crossplatform 18440 * @form 18441 * @atomicservice 18442 * @since 12 18443 */ 18444declare type CircleShape = import('../api/@ohos.arkui.shape').CircleShape; 18445 18446/** 18447 * Import the EllipseShape type object for common method. 18448 * 18449 * @typedef { import('../api/@ohos.arkui.shape').EllipseShape } EllipseShape 18450 * @syscap SystemCapability.ArkUI.ArkUI.Full 18451 * @crossplatform 18452 * @form 18453 * @atomicservice 18454 * @since 12 18455 */ 18456declare type EllipseShape = import('../api/@ohos.arkui.shape').EllipseShape; 18457 18458/** 18459 * Import the PathShape type object for common method. 18460 * 18461 * @typedef { import('../api/@ohos.arkui.shape').PathShape } PathShape 18462 * @syscap SystemCapability.ArkUI.ArkUI.Full 18463 * @crossplatform 18464 * @form 18465 * @atomicservice 18466 * @since 12 18467 */ 18468declare type PathShape = import('../api/@ohos.arkui.shape').PathShape; 18469 18470/** 18471 * Import the RectShape type object for common method. 18472 * 18473 * @typedef { import('../api/@ohos.arkui.shape').RectShape } RectShape 18474 * @syscap SystemCapability.ArkUI.ArkUI.Full 18475 * @crossplatform 18476 * @form 18477 * @atomicservice 18478 * @since 12 18479 */ 18480declare type RectShape = import('../api/@ohos.arkui.shape').RectShape; 18481 18482/** 18483 * Defines the type that can be undefined. 18484 * 18485 * @typedef { T | undefined } Optional<T> 18486 * @syscap SystemCapability.ArkUI.ArkUI.Full 18487 * @crossplatform 18488 * @form 18489 * @atomicservice 18490 * @since 12 18491 */ 18492declare type Optional<T> = T | undefined; 18493 18494/** 18495 * Define the options for background image. 18496 * 18497 * @interface BackgroundImageOptions 18498 * @syscap SystemCapability.ArkUI.ArkUI.Full 18499 * @crossplatform 18500 * @form 18501 * @atomicservice 18502 * @since 18 18503 */ 18504interface BackgroundImageOptions { 18505 /** 18506 * Sets the synchronous or asynchronous mode for background image loading. 18507 * The default parameter type is bool, and the default value is false. 18508 * 18509 * @type { ?boolean } 18510 * @param { boolean } value 18511 * @syscap SystemCapability.ArkUI.ArkUI.Full 18512 * @crossplatform 18513 * @form 18514 * @atomicservice 18515 * @since 18 18516 */ 18517 syncLoad?: boolean; 18518 /** 18519 * Set the repeat style of the background image. 18520 * 18521 * @type { ?ImageRepeat } 18522 * @param { ImageRepeat } value 18523 * @syscap SystemCapability.ArkUI.ArkUI.Full 18524 * @crossplatform 18525 * @form 18526 * @atomicservice 18527 * @since 18 18528 */ 18529 repeat?: ImageRepeat; 18530} 18531 18532/** 18533 * CommonMethod. 18534 * 18535 * @syscap SystemCapability.ArkUI.ArkUI.Full 18536 * @since 7 18537 */ 18538/** 18539 * CommonMethod. 18540 * 18541 * @syscap SystemCapability.ArkUI.ArkUI.Full 18542 * @form 18543 * @since 9 18544 */ 18545/** 18546 * CommonMethod. 18547 * 18548 * @syscap SystemCapability.ArkUI.ArkUI.Full 18549 * @crossplatform 18550 * @form 18551 * @since 10 18552 */ 18553/** 18554 * CommonMethod. 18555 * 18556 * @syscap SystemCapability.ArkUI.ArkUI.Full 18557 * @crossplatform 18558 * @form 18559 * @atomicservice 18560 * @since 11 18561 */ 18562declare class CommonMethod<T> { 18563 /** 18564 * constructor. 18565 * 18566 * @syscap SystemCapability.ArkUI.ArkUI.Full 18567 * @systemapi 18568 * @since 7 18569 */ 18570 /** 18571 * constructor. 18572 * 18573 * @syscap SystemCapability.ArkUI.ArkUI.Full 18574 * @systemapi 18575 * @form 18576 * @since 9 18577 */ 18578 constructor(); 18579 18580 /** 18581 * Sets the width of the current component. 18582 * 18583 * @param { Length } value 18584 * @returns { T } 18585 * @syscap SystemCapability.ArkUI.ArkUI.Full 18586 * @since 7 18587 */ 18588 /** 18589 * Sets the width of the current component. 18590 * 18591 * @param { Length } value 18592 * @returns { T } 18593 * @syscap SystemCapability.ArkUI.ArkUI.Full 18594 * @form 18595 * @since 9 18596 */ 18597 /** 18598 * Sets the width of the current component. 18599 * 18600 * @param { Length } value 18601 * @returns { T } 18602 * @syscap SystemCapability.ArkUI.ArkUI.Full 18603 * @crossplatform 18604 * @form 18605 * @since 10 18606 */ 18607 /** 18608 * Sets the width of the current component. 18609 * 18610 * @param { Length } value 18611 * @returns { T } 18612 * @syscap SystemCapability.ArkUI.ArkUI.Full 18613 * @crossplatform 18614 * @form 18615 * @atomicservice 18616 * @since 11 18617 */ 18618 width(value: Length): T; 18619 /** 18620 * Sets the width of the current component. 18621 * 18622 * @param { Length | LayoutPolicy } widthValue 18623 * @returns { T } 18624 * @syscap SystemCapability.ArkUI.ArkUI.Full 18625 * @crossplatform 18626 * @form 18627 * @atomicservice 18628 * @since 15 18629 */ 18630 width(widthValue: Length | LayoutPolicy): T; 18631 18632 /** 18633 * Sets the height of the current component. 18634 * 18635 * @param { Length } value 18636 * @returns { T } 18637 * @syscap SystemCapability.ArkUI.ArkUI.Full 18638 * @since 7 18639 */ 18640 /** 18641 * Sets the height of the current component. 18642 * 18643 * @param { Length } value 18644 * @returns { T } 18645 * @syscap SystemCapability.ArkUI.ArkUI.Full 18646 * @form 18647 * @since 9 18648 */ 18649 /** 18650 * Sets the height of the current component. 18651 * 18652 * @param { Length } value 18653 * @returns { T } 18654 * @syscap SystemCapability.ArkUI.ArkUI.Full 18655 * @crossplatform 18656 * @form 18657 * @since 10 18658 */ 18659 /** 18660 * Sets the height of the current component. 18661 * 18662 * @param { Length } value 18663 * @returns { T } 18664 * @syscap SystemCapability.ArkUI.ArkUI.Full 18665 * @crossplatform 18666 * @form 18667 * @atomicservice 18668 * @since 11 18669 */ 18670 height(value: Length): T; 18671 /** 18672 * Sets the height of the current component. 18673 * 18674 * @param { Length | LayoutPolicy } heightValue 18675 * @returns { T } 18676 * @syscap SystemCapability.ArkUI.ArkUI.Full 18677 * @crossplatform 18678 * @form 18679 * @atomicservice 18680 * @since 15 18681 */ 18682 height(heightValue: Length | LayoutPolicy): T; 18683 18684 /** 18685 * Sets the drawModifier of the current component. 18686 * 18687 * @param { DrawModifier | undefined } modifier - drawModifier used to draw, or undefined if it is not available. 18688 * @returns { T } 18689 * @syscap SystemCapability.ArkUI.ArkUI.Full 18690 * @crossplatform 18691 * @atomicservice 18692 * @since 12 18693 */ 18694 drawModifier(modifier: DrawModifier | undefined): T; 18695 18696 /** 18697 * Sets the custom property of the current component. 18698 * 18699 * @param { string } name - the name of the custom property. 18700 * @param { Optional<Object> } value - the value of the custom property. 18701 * @returns { T } 18702 * @syscap SystemCapability.ArkUI.ArkUI.Full 18703 * @crossplatform 18704 * @atomicservice 18705 * @since 12 18706 */ 18707 customProperty(name: string, value: Optional<Object>): T; 18708 18709 /** 18710 * Expands the safe area. 18711 * 18712 * @param { Array<SafeAreaType> } types - Indicates the types of the safe area. 18713 * @param { Array<SafeAreaEdge> } edges - Indicates the edges of the safe area. 18714 * @returns { T } The component instance. 18715 * @syscap SystemCapability.ArkUI.ArkUI.Full 18716 * @crossplatform 18717 * @since 10 18718 */ 18719 /** 18720 * Expands the safe area. 18721 * 18722 * @param { Array<SafeAreaType> } types - Indicates the types of the safe area. 18723 * @param { Array<SafeAreaEdge> } edges - Indicates the edges of the safe area. 18724 * @returns { T } The component instance. 18725 * @syscap SystemCapability.ArkUI.ArkUI.Full 18726 * @crossplatform 18727 * @atomicservice 18728 * @since 11 18729 */ 18730 expandSafeArea(types?: Array<SafeAreaType>, edges?: Array<SafeAreaEdge>): T; 18731 18732 /** 18733 * Sets the response region of the current component. 18734 * 18735 * @param { Array<Rectangle> | Rectangle } value 18736 * @returns { T } 18737 * @syscap SystemCapability.ArkUI.ArkUI.Full 18738 * @since 8 18739 */ 18740 /** 18741 * Sets the response region of the current component. 18742 * 18743 * @param { Array<Rectangle> | Rectangle } value 18744 * @returns { T } 18745 * @syscap SystemCapability.ArkUI.ArkUI.Full 18746 * @form 18747 * @since 9 18748 */ 18749 /** 18750 * Sets the response region of the current component. 18751 * 18752 * @param { Array<Rectangle> | Rectangle } value 18753 * @returns { T } 18754 * @syscap SystemCapability.ArkUI.ArkUI.Full 18755 * @crossplatform 18756 * @form 18757 * @since 10 18758 */ 18759 /** 18760 * Sets the response region of the current component. 18761 * 18762 * @param { Array<Rectangle> | Rectangle } value 18763 * @returns { T } 18764 * @syscap SystemCapability.ArkUI.ArkUI.Full 18765 * @crossplatform 18766 * @form 18767 * @atomicservice 18768 * @since 11 18769 */ 18770 responseRegion(value: Array<Rectangle> | Rectangle): T; 18771 18772 /** 18773 * Sets the mouse response region of current component 18774 * 18775 * @param { Array<Rectangle> | Rectangle } value 18776 * @returns { T } return the component attribute 18777 * @syscap SystemCapability.ArkUI.ArkUI.Full 18778 * @crossplatform 18779 * @since 10 18780 */ 18781 /** 18782 * Sets the mouse response region of current component 18783 * 18784 * @param { Array<Rectangle> | Rectangle } value 18785 * @returns { T } return the component attribute 18786 * @syscap SystemCapability.ArkUI.ArkUI.Full 18787 * @crossplatform 18788 * @atomicservice 18789 * @since 11 18790 */ 18791 mouseResponseRegion(value: Array<Rectangle> | Rectangle): T; 18792 18793 /** 18794 * The size of the current component. 18795 * 18796 * @param { SizeOptions } value 18797 * @returns { T } 18798 * @syscap SystemCapability.ArkUI.ArkUI.Full 18799 * @since 7 18800 */ 18801 /** 18802 * The size of the current component. 18803 * 18804 * @param { SizeOptions } value 18805 * @returns { T } 18806 * @syscap SystemCapability.ArkUI.ArkUI.Full 18807 * @form 18808 * @since 9 18809 */ 18810 /** 18811 * The size of the current component. 18812 * 18813 * @param { SizeOptions } value 18814 * @returns { T } 18815 * @syscap SystemCapability.ArkUI.ArkUI.Full 18816 * @crossplatform 18817 * @form 18818 * @since 10 18819 */ 18820 /** 18821 * The size of the current component. 18822 * 18823 * @param { SizeOptions } value 18824 * @returns { T } 18825 * @syscap SystemCapability.ArkUI.ArkUI.Full 18826 * @crossplatform 18827 * @form 18828 * @atomicservice 18829 * @since 11 18830 */ 18831 size(value: SizeOptions): T; 18832 18833 /** 18834 * constraint Size: 18835 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 18836 * 18837 * @param { ConstraintSizeOptions } value 18838 * @returns { T } 18839 * @syscap SystemCapability.ArkUI.ArkUI.Full 18840 * @since 7 18841 */ 18842 /** 18843 * constraint Size: 18844 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 18845 * 18846 * @param { ConstraintSizeOptions } value 18847 * @returns { T } 18848 * @syscap SystemCapability.ArkUI.ArkUI.Full 18849 * @form 18850 * @since 9 18851 */ 18852 /** 18853 * constraint Size: 18854 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 18855 * 18856 * @param { ConstraintSizeOptions } value 18857 * @returns { T } 18858 * @syscap SystemCapability.ArkUI.ArkUI.Full 18859 * @crossplatform 18860 * @form 18861 * @since 10 18862 */ 18863 /** 18864 * constraint Size: 18865 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 18866 * 18867 * @param { ConstraintSizeOptions } value 18868 * @returns { T } 18869 * @syscap SystemCapability.ArkUI.ArkUI.Full 18870 * @crossplatform 18871 * @form 18872 * @atomicservice 18873 * @since 11 18874 */ 18875 constraintSize(value: ConstraintSizeOptions): T; 18876 18877 /** 18878 * Sets the touchable of the current component 18879 * 18880 * @param { boolean } value 18881 * @returns { T } 18882 * @syscap SystemCapability.ArkUI.ArkUI.Full 18883 * @since 7 18884 * @deprecated since 9 18885 * @useinstead hitTestBehavior 18886 */ 18887 touchable(value: boolean): T; 18888 18889 /** 18890 * Defines the component's hit test behavior in touch events. 18891 * 18892 * @param { HitTestMode } value - the hit test mode. 18893 * @returns { T } 18894 * @syscap SystemCapability.ArkUI.ArkUI.Full 18895 * @since 9 18896 */ 18897 /** 18898 * Defines the component's hit test behavior in touch events. 18899 * 18900 * @param { HitTestMode } value - the hit test mode. 18901 * @returns { T } 18902 * @syscap SystemCapability.ArkUI.ArkUI.Full 18903 * @crossplatform 18904 * @since 10 18905 */ 18906 /** 18907 * Defines the component's hit test behavior in touch events. 18908 * 18909 * @param { HitTestMode } value - the hit test mode. 18910 * @returns { T } 18911 * @syscap SystemCapability.ArkUI.ArkUI.Full 18912 * @crossplatform 18913 * @atomicservice 18914 * @since 11 18915 */ 18916 hitTestBehavior(value: HitTestMode): T; 18917 18918 /** 18919 * Defines the pre-touch test of sub component in touch events. 18920 * 18921 * @param { function } event 18922 * @returns { T } 18923 * @syscap SystemCapability.ArkUI.ArkUI.Full 18924 * @crossplatform 18925 * @since 11 18926 */ 18927 /** 18928 * Defines the pre-touch test of sub component in touch events. 18929 * 18930 * @param { function } event 18931 * @returns { T } 18932 * @syscap SystemCapability.ArkUI.ArkUI.Full 18933 * @crossplatform 18934 * @atomicservice 18935 * @since 12 18936 */ 18937 onChildTouchTest(event: (value: Array<TouchTestInfo>) => TouchResult): T; 18938 18939 /** 18940 * layout Weight 18941 * 18942 * @param { number | string } value 18943 * @returns { T } 18944 * @syscap SystemCapability.ArkUI.ArkUI.Full 18945 * @since 7 18946 */ 18947 /** 18948 * layout Weight 18949 * 18950 * @param { number | string } value 18951 * @returns { T } 18952 * @syscap SystemCapability.ArkUI.ArkUI.Full 18953 * @form 18954 * @since 9 18955 */ 18956 /** 18957 * layout Weight 18958 * 18959 * @param { number | string } value 18960 * @returns { T } 18961 * @syscap SystemCapability.ArkUI.ArkUI.Full 18962 * @crossplatform 18963 * @form 18964 * @since 10 18965 */ 18966 /** 18967 * Defines the weight of the component, according to which the remain part of main-axis is allocated self-adaptively 18968 * 18969 * @param { number | string } value 18970 * @returns { T } 18971 * @syscap SystemCapability.ArkUI.ArkUI.Full 18972 * @crossplatform 18973 * @form 18974 * @atomicservice 18975 * @since 11 18976 */ 18977 layoutWeight(value: number | string): T; 18978 18979 /** 18980 * chain Weight 18981 * 18982 * @param { ChainWeightOptions } chainWeight 18983 * @returns { T } 18984 * @syscap SystemCapability.ArkUI.ArkUI.Full 18985 * @crossplatform 18986 * @atomicservice 18987 * @since 14 18988 */ 18989 chainWeight(chainWeight: ChainWeightOptions): T; 18990 18991 /** 18992 * Inner margin. 18993 * 18994 * @param { Padding | Length } value 18995 * @returns { T } 18996 * @syscap SystemCapability.ArkUI.ArkUI.Full 18997 * @since 7 18998 */ 18999 /** 19000 * Inner margin. 19001 * 19002 * @param { Padding | Length } value 19003 * @returns { T } 19004 * @syscap SystemCapability.ArkUI.ArkUI.Full 19005 * @form 19006 * @since 9 19007 */ 19008 /** 19009 * Inner margin. 19010 * 19011 * @param { Padding | Length } value 19012 * @returns { T } 19013 * @syscap SystemCapability.ArkUI.ArkUI.Full 19014 * @crossplatform 19015 * @form 19016 * @since 10 19017 */ 19018 /** 19019 * Inner margin. 19020 * 19021 * @param { Padding | Length } value 19022 * @returns { T } 19023 * @syscap SystemCapability.ArkUI.ArkUI.Full 19024 * @crossplatform 19025 * @form 19026 * @atomicservice 19027 * @since 11 19028 */ 19029 /** 19030 * Inner margin. 19031 * 19032 * @param { Padding | Length | LocalizedPadding } value 19033 * @returns { T } 19034 * @syscap SystemCapability.ArkUI.ArkUI.Full 19035 * @crossplatform 19036 * @form 19037 * @atomicservice 19038 * @since 12 19039 */ 19040 padding(value: Padding | Length | LocalizedPadding): T; 19041 19042 /** 19043 * Inner safeArea padding. 19044 * 19045 * @param { Padding | LengthMetrics | LocalizedPadding } paddingValue - Indicates safeArea padding values 19046 * @returns { T } 19047 * @syscap SystemCapability.ArkUI.ArkUI.Full 19048 * @crossplatform 19049 * @form 19050 * @atomicservice 19051 * @since 14 19052 */ 19053 safeAreaPadding(paddingValue: Padding | LengthMetrics | LocalizedPadding): T; 19054 19055 /** 19056 * Outer Margin. 19057 * 19058 * @param { Margin | Length } value 19059 * @returns { T } 19060 * @syscap SystemCapability.ArkUI.ArkUI.Full 19061 * @since 7 19062 */ 19063 /** 19064 * Outer Margin. 19065 * 19066 * @param { Margin | Length } value 19067 * @returns { T } 19068 * @syscap SystemCapability.ArkUI.ArkUI.Full 19069 * @form 19070 * @since 9 19071 */ 19072 /** 19073 * Outer Margin. 19074 * 19075 * @param { Margin | Length } value 19076 * @returns { T } 19077 * @syscap SystemCapability.ArkUI.ArkUI.Full 19078 * @crossplatform 19079 * @form 19080 * @since 10 19081 */ 19082 /** 19083 * Outer Margin. 19084 * 19085 * @param { Margin | Length } value 19086 * @returns { T } 19087 * @syscap SystemCapability.ArkUI.ArkUI.Full 19088 * @crossplatform 19089 * @form 19090 * @atomicservice 19091 * @since 11 19092 */ 19093 /** 19094 * Outer Margin. 19095 * 19096 * @param { Margin | Length | LocalizedMargin } value 19097 * @returns { T } 19098 * @syscap SystemCapability.ArkUI.ArkUI.Full 19099 * @crossplatform 19100 * @form 19101 * @atomicservice 19102 * @since 12 19103 */ 19104 margin(value: Margin | Length | LocalizedMargin): T; 19105 19106 /** 19107 * Background. 19108 * 19109 * @param { CustomBuilder } builder 19110 * @param { object } options 19111 * @returns { T } 19112 * @syscap SystemCapability.ArkUI.ArkUI.Full 19113 * @crossplatform 19114 * @since 10 19115 */ 19116 /** 19117 * Background. 19118 * 19119 * @param { CustomBuilder } builder 19120 * @param { object } options 19121 * @returns { T } 19122 * @syscap SystemCapability.ArkUI.ArkUI.Full 19123 * @crossplatform 19124 * @atomicservice 19125 * @since 11 19126 */ 19127 background(builder: CustomBuilder, options?: { align?: Alignment }): T; 19128 19129 /** 19130 * Background color 19131 * 19132 * @param { ResourceColor } value 19133 * @returns { T } 19134 * @syscap SystemCapability.ArkUI.ArkUI.Full 19135 * @since 7 19136 */ 19137 /** 19138 * Background color 19139 * 19140 * @param { ResourceColor } value 19141 * @returns { T } 19142 * @syscap SystemCapability.ArkUI.ArkUI.Full 19143 * @form 19144 * @since 9 19145 */ 19146 /** 19147 * Background color 19148 * 19149 * @param { ResourceColor } value 19150 * @returns { T } 19151 * @syscap SystemCapability.ArkUI.ArkUI.Full 19152 * @crossplatform 19153 * @form 19154 * @since 10 19155 */ 19156 /** 19157 * Background color 19158 * 19159 * @param { ResourceColor } value 19160 * @returns { T } 19161 * @syscap SystemCapability.ArkUI.ArkUI.Full 19162 * @crossplatform 19163 * @form 19164 * @atomicservice 19165 * @since 11 19166 */ 19167 backgroundColor(value: ResourceColor): T; 19168 19169 /** 19170 * Background color 19171 * 19172 * @param { Optional<ResourceColor> } color 19173 * @returns { T } 19174 * @syscap SystemCapability.ArkUI.ArkUI.Full 19175 * @crossplatform 19176 * @form 19177 * @atomicservice 19178 * @since 18 19179 */ 19180 backgroundColor(color: Optional<ResourceColor>): T; 19181 19182 /** 19183 * PixelRound 19184 * 19185 * @param { PixelRoundPolicy } value - indicates the pixel round policy. 19186 * @returns { T } 19187 * @syscap SystemCapability.ArkUI.ArkUI.Full 19188 * @crossplatform 19189 * @form 19190 * @atomicservice 19191 * @since 11 19192 */ 19193 pixelRound(value: PixelRoundPolicy): T; 19194 19195 /** 19196 * Background image 19197 * src: Image address url 19198 * 19199 * @param { ResourceStr } src 19200 * @param { ImageRepeat } repeat 19201 * @returns { T } 19202 * @syscap SystemCapability.ArkUI.ArkUI.Full 19203 * @since 7 19204 */ 19205 /** 19206 * Background image 19207 * src: Image address url 19208 * 19209 * @param { ResourceStr } src 19210 * @param { ImageRepeat } repeat 19211 * @returns { T } 19212 * @syscap SystemCapability.ArkUI.ArkUI.Full 19213 * @form 19214 * @since 9 19215 */ 19216 /** 19217 * Background image 19218 * src: Image address url 19219 * 19220 * @param { ResourceStr } src 19221 * @param { ImageRepeat } repeat 19222 * @returns { T } 19223 * @syscap SystemCapability.ArkUI.ArkUI.Full 19224 * @crossplatform 19225 * @form 19226 * @since 10 19227 */ 19228 /** 19229 * Background image 19230 * src: Image address url 19231 * 19232 * @param { ResourceStr } src 19233 * @param { ImageRepeat } repeat 19234 * @returns { T } 19235 * @syscap SystemCapability.ArkUI.ArkUI.Full 19236 * @crossplatform 19237 * @form 19238 * @atomicservice 19239 * @since 11 19240 */ 19241 /** 19242 * Background image 19243 * src: Image address url 19244 * 19245 * @param { ResourceStr | PixelMap } src 19246 * @param { ImageRepeat } repeat 19247 * @returns { T } 19248 * @syscap SystemCapability.ArkUI.ArkUI.Full 19249 * @crossplatform 19250 * @form 19251 * @atomicservice 19252 * @since 12 19253 */ 19254 backgroundImage(src: ResourceStr | PixelMap, repeat?: ImageRepeat): T; 19255 19256 /** 19257 * Background image 19258 * 19259 * @param { ResourceStr | PixelMap } src - the background image source 19260 * @param { BackgroundImageOptions } options - config the options 19261 * @returns { T } 19262 * @syscap SystemCapability.ArkUI.ArkUI.Full 19263 * @crossplatform 19264 * @form 19265 * @atomicservice 19266 * @since 18 19267 */ 19268 backgroundImage(src: ResourceStr | PixelMap, options?: BackgroundImageOptions): T; 19269 19270 /** 19271 * Background image size 19272 * 19273 * @param { SizeOptions | ImageSize } value 19274 * @returns { T } 19275 * @syscap SystemCapability.ArkUI.ArkUI.Full 19276 * @since 7 19277 */ 19278 /** 19279 * Background image size 19280 * 19281 * @param { SizeOptions | ImageSize } value 19282 * @returns { T } 19283 * @syscap SystemCapability.ArkUI.ArkUI.Full 19284 * @form 19285 * @since 9 19286 */ 19287 /** 19288 * Background image size 19289 * 19290 * @param { SizeOptions | ImageSize } value 19291 * @returns { T } 19292 * @syscap SystemCapability.ArkUI.ArkUI.Full 19293 * @crossplatform 19294 * @form 19295 * @since 10 19296 */ 19297 /** 19298 * Background image size 19299 * 19300 * @param { SizeOptions | ImageSize } value 19301 * @returns { T } 19302 * @syscap SystemCapability.ArkUI.ArkUI.Full 19303 * @crossplatform 19304 * @form 19305 * @atomicservice 19306 * @since 11 19307 */ 19308 backgroundImageSize(value: SizeOptions | ImageSize): T; 19309 19310 /** 19311 * Background image position 19312 * x:Horizontal coordinate;y:Vertical axis coordinate. 19313 * 19314 * @param { Position | Alignment } value 19315 * @returns { T } 19316 * @syscap SystemCapability.ArkUI.ArkUI.Full 19317 * @since 7 19318 */ 19319 /** 19320 * Background image position 19321 * x:Horizontal coordinate;y:Vertical axis coordinate. 19322 * 19323 * @param { Position | Alignment } value 19324 * @returns { T } 19325 * @syscap SystemCapability.ArkUI.ArkUI.Full 19326 * @form 19327 * @since 9 19328 */ 19329 /** 19330 * Background image position 19331 * x:Horizontal coordinate;y:Vertical axis coordinate. 19332 * 19333 * @param { Position | Alignment } value 19334 * @returns { T } 19335 * @syscap SystemCapability.ArkUI.ArkUI.Full 19336 * @crossplatform 19337 * @form 19338 * @since 10 19339 */ 19340 /** 19341 * Background image position 19342 * x:Horizontal coordinate;y:Vertical axis coordinate. 19343 * 19344 * @param { Position | Alignment } value 19345 * @returns { T } 19346 * @syscap SystemCapability.ArkUI.ArkUI.Full 19347 * @crossplatform 19348 * @form 19349 * @atomicservice 19350 * @since 11 19351 */ 19352 backgroundImagePosition(value: Position | Alignment): T; 19353 19354 /** 19355 * Background blur style. 19356 * blurStyle:Blur style type. 19357 * 19358 * @param { BlurStyle } value 19359 * @param { BackgroundBlurStyleOptions } options 19360 * @returns { T } 19361 * @syscap SystemCapability.ArkUI.ArkUI.Full 19362 * @form 19363 * @since 9 19364 */ 19365 /** 19366 * Background blur style. 19367 * blurStyle:Blur style type. 19368 * 19369 * @param { BlurStyle } value 19370 * @param { BackgroundBlurStyleOptions } options 19371 * @returns { T } 19372 * @syscap SystemCapability.ArkUI.ArkUI.Full 19373 * @crossplatform 19374 * @form 19375 * @since 10 19376 */ 19377 /** 19378 * Background blur style. 19379 * blurStyle:Blur style type. 19380 * 19381 * @param { BlurStyle } value 19382 * @param { BackgroundBlurStyleOptions } options 19383 * @returns { T } 19384 * @syscap SystemCapability.ArkUI.ArkUI.Full 19385 * @crossplatform 19386 * @form 19387 * @atomicservice 19388 * @since 11 19389 */ 19390 backgroundBlurStyle(value: BlurStyle, options?: BackgroundBlurStyleOptions): T; 19391 19392 /** 19393 * Background blur style. 19394 * blurStyle:Blur style type. 19395 * 19396 * @param { Optional<BlurStyle> } style 19397 * @param { BackgroundBlurStyleOptions } [options] 19398 * @returns { T } 19399 * @syscap SystemCapability.ArkUI.ArkUI.Full 19400 * @crossplatform 19401 * @form 19402 * @atomicservice 19403 * @since 18 19404 */ 19405 backgroundBlurStyle(style: Optional<BlurStyle>, options?: BackgroundBlurStyleOptions): T; 19406 19407 /** 19408 * options:background effect options. 19409 * 19410 * @param { BackgroundEffectOptions } options - options indicates the effect options. 19411 * @returns { T } 19412 * @syscap SystemCapability.ArkUI.ArkUI.Full 19413 * @crossplatform 19414 * @since 11 19415 */ 19416 /** 19417 * options:background effect options. 19418 * 19419 * @param { BackgroundEffectOptions } options - options indicates the effect options. 19420 * @returns { T } 19421 * @syscap SystemCapability.ArkUI.ArkUI.Full 19422 * @crossplatform 19423 * @atomicservice 19424 * @since 12 19425 */ 19426 backgroundEffect(options: BackgroundEffectOptions): T; 19427 19428 /** 19429 * options:background effect options. 19430 * 19431 * @param { Optional<BackgroundEffectOptions> } options - options indicates the effect options. 19432 * @returns { T } 19433 * @syscap SystemCapability.ArkUI.ArkUI.Full 19434 * @crossplatform 19435 * @atomicservice 19436 * @since 18 19437 */ 19438 backgroundEffect(options: Optional<BackgroundEffectOptions>): T; 19439 19440 /** 19441 * Background image resizable. 19442 * value:resizable options 19443 * 19444 * @param { ResizableOptions } value - Indicates the resizable options. 19445 * @returns { T } 19446 * @syscap SystemCapability.ArkUI.ArkUI.Full 19447 * @crossplatform 19448 * @atomicservice 19449 * @since 12 19450 */ 19451 backgroundImageResizable(value: ResizableOptions): T; 19452 19453 /** 19454 * Foreground effect. 19455 * 19456 * @param { ForegroundEffectOptions } options - options indicates the effect options. 19457 * @returns { T } 19458 * @syscap SystemCapability.ArkUI.ArkUI.Full 19459 * @crossplatform 19460 * @atomicservice 19461 * @since 12 19462 */ 19463 foregroundEffect(options: ForegroundEffectOptions): T; 19464 19465 /** 19466 * Unified visual effect interface. 19467 * 19468 * @param { VisualEffect } effect - Visual effect parameters. 19469 * @returns { T } 19470 * @syscap SystemCapability.ArkUI.ArkUI.Full 19471 * @crossplatform 19472 * @atomicservice 19473 * @since 12 19474 */ 19475 visualEffect(effect: VisualEffect): T; 19476 19477 /** 19478 * Filter applied to the background layer of the component. 19479 * 19480 * @param { Filter } filter - Filter effect parameters. 19481 * @returns { T } 19482 * @syscap SystemCapability.ArkUI.ArkUI.Full 19483 * @crossplatform 19484 * @atomicservice 19485 * @since 12 19486 */ 19487 backgroundFilter(filter: Filter): T; 19488 19489 /** 19490 * Filter applied to the foreground layer of the component. 19491 * 19492 * @param { Filter } filter - Filter effect parameters. 19493 * @returns { T } 19494 * @syscap SystemCapability.ArkUI.ArkUI.Full 19495 * @crossplatform 19496 * @atomicservice 19497 * @since 12 19498 */ 19499 foregroundFilter(filter: Filter): T; 19500 19501 /** 19502 * Filter applied to the compositing layer of the component. 19503 * 19504 * @param { Filter } filter - Filter effect parameters. 19505 * @returns { T } 19506 * @syscap SystemCapability.ArkUI.ArkUI.Full 19507 * @crossplatform 19508 * @atomicservice 19509 * @since 12 19510 */ 19511 compositingFilter(filter: Filter): T; 19512 19513 /** 19514 * Foreground blur style. 19515 * blurStyle:Blur style type. 19516 * 19517 * @param { BlurStyle } value 19518 * @param { ForegroundBlurStyleOptions } options 19519 * @returns { T } 19520 * @syscap SystemCapability.ArkUI.ArkUI.Full 19521 * @crossplatform 19522 * @since 10 19523 */ 19524 /** 19525 * Foreground blur style. 19526 * blurStyle:Blur style type. 19527 * 19528 * @param { BlurStyle } value 19529 * @param { ForegroundBlurStyleOptions } options 19530 * @returns { T } 19531 * @syscap SystemCapability.ArkUI.ArkUI.Full 19532 * @crossplatform 19533 * @atomicservice 19534 * @since 11 19535 */ 19536 foregroundBlurStyle(value: BlurStyle, options?: ForegroundBlurStyleOptions): T; 19537 19538 /** 19539 * Foreground blur style. 19540 * blurStyle:Blur style type. 19541 * 19542 * @param { Optional<BlurStyle> } style 19543 * @param { ForegroundBlurStyleOptions } [options] 19544 * @returns { T } 19545 * @syscap SystemCapability.ArkUI.ArkUI.Full 19546 * @crossplatform 19547 * @atomicservice 19548 * @since 18 19549 */ 19550 foregroundBlurStyle(style: Optional<BlurStyle>, options?: ForegroundBlurStyleOptions): T; 19551 19552 /** 19553 * Opacity 19554 * 19555 * @param { number | Resource } value 19556 * @returns { T } 19557 * @syscap SystemCapability.ArkUI.ArkUI.Full 19558 * @since 7 19559 */ 19560 /** 19561 * Opacity 19562 * 19563 * @param { number | Resource } value 19564 * @returns { T } 19565 * @syscap SystemCapability.ArkUI.ArkUI.Full 19566 * @form 19567 * @since 9 19568 */ 19569 /** 19570 * Opacity 19571 * 19572 * @param { number | Resource } value 19573 * @returns { T } 19574 * @syscap SystemCapability.ArkUI.ArkUI.Full 19575 * @crossplatform 19576 * @form 19577 * @since 10 19578 */ 19579 /** 19580 * Opacity 19581 * 19582 * @param { number | Resource } value 19583 * @returns { T } 19584 * @syscap SystemCapability.ArkUI.ArkUI.Full 19585 * @crossplatform 19586 * @form 19587 * @atomicservice 19588 * @since 11 19589 */ 19590 opacity(value: number | Resource): T; 19591 19592 /** 19593 * Opacity 19594 * 19595 * @param { Optional<number | Resource> } opacity 19596 * @returns { T } 19597 * @syscap SystemCapability.ArkUI.ArkUI.Full 19598 * @crossplatform 19599 * @form 19600 * @atomicservice 19601 * @since 18 19602 */ 19603 opacity(opacity: Optional<number | Resource>): T; 19604 19605 /** 19606 * Border 19607 * width:Border width;color:Border color;radius:Border radius; 19608 * 19609 * @param { BorderOptions } value 19610 * @returns { T } 19611 * @syscap SystemCapability.ArkUI.ArkUI.Full 19612 * @since 7 19613 */ 19614 /** 19615 * Border 19616 * width:Border width;color:Border color;radius:Border radius; 19617 * 19618 * @param { BorderOptions } value 19619 * @returns { T } 19620 * @syscap SystemCapability.ArkUI.ArkUI.Full 19621 * @form 19622 * @since 9 19623 */ 19624 /** 19625 * Border 19626 * width:Border width;color:Border color;radius:Border radius; 19627 * 19628 * @param { BorderOptions } value 19629 * @returns { T } 19630 * @syscap SystemCapability.ArkUI.ArkUI.Full 19631 * @crossplatform 19632 * @form 19633 * @since 10 19634 */ 19635 /** 19636 * Border 19637 * width:Border width;color:Border color;radius:Border radius; 19638 * 19639 * @param { BorderOptions } value 19640 * @returns { T } 19641 * @syscap SystemCapability.ArkUI.ArkUI.Full 19642 * @crossplatform 19643 * @form 19644 * @atomicservice 19645 * @since 11 19646 */ 19647 border(value: BorderOptions): T; 19648 19649 /** 19650 * Border style 19651 * 19652 * @param { BorderStyle } value 19653 * @returns { T } 19654 * @syscap SystemCapability.ArkUI.ArkUI.Full 19655 * @since 7 19656 */ 19657 /** 19658 * Border style 19659 * 19660 * @param { BorderStyle | EdgeStyles } value 19661 * @returns { T } 19662 * @syscap SystemCapability.ArkUI.ArkUI.Full 19663 * @form 19664 * @since 9 19665 */ 19666 /** 19667 * Border style 19668 * 19669 * @param { BorderStyle | EdgeStyles } value 19670 * @returns { T } 19671 * @syscap SystemCapability.ArkUI.ArkUI.Full 19672 * @crossplatform 19673 * @form 19674 * @since 10 19675 */ 19676 /** 19677 * Border style 19678 * 19679 * @param { BorderStyle | EdgeStyles } value 19680 * @returns { T } 19681 * @syscap SystemCapability.ArkUI.ArkUI.Full 19682 * @crossplatform 19683 * @form 19684 * @atomicservice 19685 * @since 11 19686 */ 19687 borderStyle(value: BorderStyle | EdgeStyles): T; 19688 19689 /** 19690 * Border width 19691 * 19692 * @param { Length } value 19693 * @returns { T } 19694 * @syscap SystemCapability.ArkUI.ArkUI.Full 19695 * @since 7 19696 */ 19697 /** 19698 * Border width 19699 * 19700 * @param { Length | EdgeWidths } value 19701 * @returns { T } 19702 * @syscap SystemCapability.ArkUI.ArkUI.Full 19703 * @form 19704 * @since 9 19705 */ 19706 /** 19707 * Border width 19708 * 19709 * @param { Length | EdgeWidths } value 19710 * @returns { T } 19711 * @syscap SystemCapability.ArkUI.ArkUI.Full 19712 * @crossplatform 19713 * @form 19714 * @since 10 19715 */ 19716 /** 19717 * Border width 19718 * 19719 * @param { Length | EdgeWidths } value 19720 * @returns { T } 19721 * @syscap SystemCapability.ArkUI.ArkUI.Full 19722 * @crossplatform 19723 * @form 19724 * @atomicservice 19725 * @since 11 19726 */ 19727 /** 19728 * Border width 19729 * 19730 * @param { Length | EdgeWidths | LocalizedEdgeWidths } value 19731 * @returns { T } 19732 * @syscap SystemCapability.ArkUI.ArkUI.Full 19733 * @crossplatform 19734 * @form 19735 * @atomicservice 19736 * @since 12 19737 */ 19738 borderWidth(value: Length | EdgeWidths | LocalizedEdgeWidths): T; 19739 19740 /** 19741 * Border color 19742 * 19743 * @param { ResourceColor } value 19744 * @returns { T } 19745 * @syscap SystemCapability.ArkUI.ArkUI.Full 19746 * @since 7 19747 */ 19748 /** 19749 * Border color 19750 * 19751 * @param { ResourceColor | EdgeColors } value 19752 * @returns { T } 19753 * @syscap SystemCapability.ArkUI.ArkUI.Full 19754 * @form 19755 * @since 9 19756 */ 19757 /** 19758 * Border color 19759 * 19760 * @param { ResourceColor | EdgeColors } value 19761 * @returns { T } 19762 * @syscap SystemCapability.ArkUI.ArkUI.Full 19763 * @crossplatform 19764 * @form 19765 * @since 10 19766 */ 19767 /** 19768 * Border color 19769 * 19770 * @param { ResourceColor | EdgeColors } value 19771 * @returns { T } 19772 * @syscap SystemCapability.ArkUI.ArkUI.Full 19773 * @crossplatform 19774 * @form 19775 * @atomicservice 19776 * @since 11 19777 */ 19778 /** 19779 * Border color 19780 * 19781 * @param { ResourceColor | EdgeColors | LocalizedEdgeColors } value 19782 * @returns { T } 19783 * @syscap SystemCapability.ArkUI.ArkUI.Full 19784 * @crossplatform 19785 * @form 19786 * @atomicservice 19787 * @since 12 19788 */ 19789 borderColor(value: ResourceColor | EdgeColors | LocalizedEdgeColors): T; 19790 19791 /** 19792 * Border radius 19793 * 19794 * @param { Length } value 19795 * @returns { T } 19796 * @syscap SystemCapability.ArkUI.ArkUI.Full 19797 * @since 7 19798 */ 19799 /** 19800 * Border radius 19801 * 19802 * @param { Length | BorderRadiuses } value 19803 * @returns { T } 19804 * @syscap SystemCapability.ArkUI.ArkUI.Full 19805 * @form 19806 * @since 9 19807 */ 19808 /** 19809 * Border radius 19810 * 19811 * @param { Length | BorderRadiuses } value 19812 * @returns { T } 19813 * @syscap SystemCapability.ArkUI.ArkUI.Full 19814 * @crossplatform 19815 * @form 19816 * @since 10 19817 */ 19818 /** 19819 * Border radius 19820 * 19821 * @param { Length | BorderRadiuses } value 19822 * @returns { T } 19823 * @syscap SystemCapability.ArkUI.ArkUI.Full 19824 * @crossplatform 19825 * @form 19826 * @atomicservice 19827 * @since 11 19828 */ 19829 /** 19830 * Border radius 19831 * 19832 * @param { Length | BorderRadiuses | LocalizedBorderRadiuses } value 19833 * @returns { T } 19834 * @syscap SystemCapability.ArkUI.ArkUI.Full 19835 * @crossplatform 19836 * @form 19837 * @atomicservice 19838 * @since 12 19839 */ 19840 borderRadius(value: Length | BorderRadiuses | LocalizedBorderRadiuses): T; 19841 19842 /** 19843 * Border image 19844 * 19845 * @param { BorderImageOption } value 19846 * @returns { T } 19847 * @syscap SystemCapability.ArkUI.ArkUI.Full 19848 * @form 19849 * @since 9 19850 */ 19851 /** 19852 * Border image 19853 * 19854 * @param { BorderImageOption } value 19855 * @returns { T } 19856 * @syscap SystemCapability.ArkUI.ArkUI.Full 19857 * @crossplatform 19858 * @form 19859 * @since 10 19860 */ 19861 /** 19862 * Border image 19863 * 19864 * @param { BorderImageOption } value 19865 * @returns { T } 19866 * @syscap SystemCapability.ArkUI.ArkUI.Full 19867 * @crossplatform 19868 * @form 19869 * @atomicservice 19870 * @since 11 19871 */ 19872 borderImage(value: BorderImageOption): T; 19873 19874 /** 19875 * Outline 19876 * width:Outline width;color:Outline color;radius:Outline radius;style:Outline style; 19877 * 19878 * @param { OutlineOptions } value 19879 * @returns { T } 19880 * @syscap SystemCapability.ArkUI.ArkUI.Full 19881 * @crossplatform 19882 * @form 19883 * @since 11 19884 */ 19885 /** 19886 * Outline 19887 * width:Outline width;color:Outline color;radius:Outline radius;style:Outline style; 19888 * 19889 * @param { OutlineOptions } value 19890 * @returns { T } 19891 * @syscap SystemCapability.ArkUI.ArkUI.Full 19892 * @crossplatform 19893 * @form 19894 * @atomicservice 19895 * @since 12 19896 */ 19897 outline(value: OutlineOptions): T; 19898 19899 /** 19900 * Outline 19901 * width:Outline width;color:Outline color;radius:Outline radius;style:Outline style; 19902 * 19903 * @param { Optional<OutlineOptions> } options 19904 * @returns { T } 19905 * @syscap SystemCapability.ArkUI.ArkUI.Full 19906 * @crossplatform 19907 * @form 19908 * @atomicservice 19909 * @since 18 19910 */ 19911 outline(options: Optional<OutlineOptions>): T; 19912 19913 /** 19914 * Outline style 19915 * The input parameter default value is OutlineStyle.SOLID 19916 * 19917 * @param { OutlineStyle | EdgeOutlineStyles } value 19918 * @returns { T } 19919 * @syscap SystemCapability.ArkUI.ArkUI.Full 19920 * @crossplatform 19921 * @form 19922 * @since 11 19923 */ 19924 /** 19925 * Outline style 19926 * 19927 * @param { OutlineStyle | EdgeOutlineStyles } value 19928 * @returns { T } 19929 * @syscap SystemCapability.ArkUI.ArkUI.Full 19930 * @crossplatform 19931 * @form 19932 * @atomicservice 19933 * @since 12 19934 */ 19935 outlineStyle(value: OutlineStyle | EdgeOutlineStyles): T; 19936 19937 /** 19938 * Outline style 19939 * 19940 * @param { Optional<OutlineStyle | EdgeOutlineStyles> } style 19941 * @returns { T } 19942 * @syscap SystemCapability.ArkUI.ArkUI.Full 19943 * @crossplatform 19944 * @form 19945 * @atomicservice 19946 * @since 18 19947 */ 19948 outlineStyle(style: Optional<OutlineStyle | EdgeOutlineStyles>): T; 19949 19950 /** 19951 * Outline width 19952 * The input parameter default value is 0 19953 * 19954 * @param { Dimension | EdgeOutlineWidths } value 19955 * @returns { T } 19956 * @syscap SystemCapability.ArkUI.ArkUI.Full 19957 * @crossplatform 19958 * @form 19959 * @since 11 19960 */ 19961 /** 19962 * Outline width 19963 * 19964 * @param { Dimension | EdgeOutlineWidths } value 19965 * @returns { T } 19966 * @syscap SystemCapability.ArkUI.ArkUI.Full 19967 * @crossplatform 19968 * @form 19969 * @atomicservice 19970 * @since 12 19971 */ 19972 outlineWidth(value: Dimension | EdgeOutlineWidths): T; 19973 19974 /** 19975 * Outline width 19976 * 19977 * @param { Optional<Dimension | EdgeOutlineWidths> } width 19978 * @returns { T } 19979 * @syscap SystemCapability.ArkUI.ArkUI.Full 19980 * @crossplatform 19981 * @form 19982 * @atomicservice 19983 * @since 18 19984 */ 19985 outlineWidth(width: Optional<Dimension | EdgeOutlineWidths>): T; 19986 19987 /** 19988 * Outline color 19989 * The input parameter default value is Color.Black 19990 * 19991 * @param { ResourceColor | EdgeColors } value 19992 * @returns { T } 19993 * @syscap SystemCapability.ArkUI.ArkUI.Full 19994 * @crossplatform 19995 * @form 19996 * @since 11 19997 */ 19998 /** 19999 * Outline color 20000 * 20001 * @param { ResourceColor | EdgeColors | LocalizedEdgeColors } value 20002 * @returns { T } 20003 * @syscap SystemCapability.ArkUI.ArkUI.Full 20004 * @crossplatform 20005 * @form 20006 * @atomicservice 20007 * @since 12 20008 */ 20009 outlineColor(value: ResourceColor | EdgeColors | LocalizedEdgeColors): T; 20010 20011 /** 20012 * Outline color 20013 * 20014 * @param { Optional<ResourceColor | EdgeColors | LocalizedEdgeColors> } color 20015 * @returns { T } 20016 * @syscap SystemCapability.ArkUI.ArkUI.Full 20017 * @crossplatform 20018 * @form 20019 * @atomicservice 20020 * @since 18 20021 */ 20022 outlineColor(color: Optional<ResourceColor | EdgeColors | LocalizedEdgeColors>): T; 20023 20024 /** 20025 * Outline radius 20026 * The input parameter default value is 0 20027 * 20028 * @param { Dimension | OutlineRadiuses } value 20029 * @returns { T } 20030 * @syscap SystemCapability.ArkUI.ArkUI.Full 20031 * @crossplatform 20032 * @form 20033 * @since 11 20034 */ 20035 /** 20036 * Outline radius 20037 * 20038 * @param { Dimension | OutlineRadiuses } value 20039 * @returns { T } 20040 * @syscap SystemCapability.ArkUI.ArkUI.Full 20041 * @crossplatform 20042 * @form 20043 * @atomicservice 20044 * @since 12 20045 */ 20046 outlineRadius(value: Dimension | OutlineRadiuses): T; 20047 20048 /** 20049 * Outline radius 20050 * 20051 * @param { Optional<Dimension | OutlineRadiuses> } radius 20052 * @returns { T } 20053 * @syscap SystemCapability.ArkUI.ArkUI.Full 20054 * @crossplatform 20055 * @form 20056 * @atomicservice 20057 * @since 18 20058 */ 20059 outlineRadius(radius: Optional<Dimension | OutlineRadiuses>): T; 20060 20061 /** 20062 * Provides the general foreground color capability of UI components, and assigns color values 20063 * according to the characteristics of components. 20064 * 20065 * @param { ResourceColor | ColoringStrategy } value - indicates the color or color selection strategy 20066 * @returns { T } 20067 * @syscap SystemCapability.ArkUI.ArkUI.Full 20068 * @crossplatform 20069 * @since 10 20070 */ 20071 /** 20072 * Provides the general foreground color capability of UI components, and assigns color values 20073 * according to the characteristics of components. 20074 * 20075 * @param { ResourceColor | ColoringStrategy } value - indicates the color or color selection strategy 20076 * @returns { T } 20077 * @syscap SystemCapability.ArkUI.ArkUI.Full 20078 * @crossplatform 20079 * @atomicservice 20080 * @since 11 20081 */ 20082 foregroundColor(value: ResourceColor | ColoringStrategy): T; 20083 20084 /** 20085 * Provides the general foreground color capability of UI components, and assigns color values 20086 * according to the characteristics of components. 20087 * 20088 * @param { Optional<ResourceColor | ColoringStrategy> } color - indicates the color or color selection strategy 20089 * @returns { T } 20090 * @syscap SystemCapability.ArkUI.ArkUI.Full 20091 * @crossplatform 20092 * @atomicservice 20093 * @since 18 20094 */ 20095 foregroundColor(color: Optional<ResourceColor | ColoringStrategy>): T; 20096 20097 /** 20098 * Trigger a click event when a click is clicked. 20099 * 20100 * @param { function } event 20101 * @returns { T } 20102 * @syscap SystemCapability.ArkUI.ArkUI.Full 20103 * @since 7 20104 */ 20105 /** 20106 * Trigger a click event when a click is clicked. 20107 * 20108 * @param { function } event 20109 * @returns { T } 20110 * @syscap SystemCapability.ArkUI.ArkUI.Full 20111 * @form 20112 * @since 9 20113 */ 20114 /** 20115 * Trigger a click event when a click is clicked. 20116 * 20117 * @param { function } event 20118 * @returns { T } 20119 * @syscap SystemCapability.ArkUI.ArkUI.Full 20120 * @crossplatform 20121 * @form 20122 * @since 10 20123 */ 20124 /** 20125 * Trigger a click event when a click is clicked. 20126 * 20127 * @param { function } event 20128 * @returns { T } 20129 * @syscap SystemCapability.ArkUI.ArkUI.Full 20130 * @crossplatform 20131 * @form 20132 * @atomicservice 20133 * @since 11 20134 */ 20135 onClick(event: (event: ClickEvent) => void): T; 20136 20137 /** 20138 * Trigger a click event when a click is clicked, move distance should smaller than distanceThreshold. 20139 * 20140 * @param { function } event - this function callback executed when the click action is recognized 20141 * @param { number } distanceThreshold - the distance threshold of finger's movement when detecting a click action 20142 * @returns { T } 20143 * @syscap SystemCapability.ArkUI.ArkUI.Full 20144 * @crossplatform 20145 * @form 20146 * @atomicservice 20147 * @since 12 20148 */ 20149 onClick(event: Callback<ClickEvent>, distanceThreshold: number): T; 20150 20151 /** 20152 * Trigger a hover event. 20153 * 20154 * @param { function } event 20155 * @returns { T } 20156 * @syscap SystemCapability.ArkUI.ArkUI.Full 20157 * @since 8 20158 */ 20159 /** 20160 * Trigger a hover event. 20161 * 20162 * @param { function } event 20163 * @returns { T } 20164 * @syscap SystemCapability.ArkUI.ArkUI.Full 20165 * @crossplatform 20166 * @atomicservice 20167 * @since 11 20168 */ 20169 onHover(event: (isHover: boolean, event: HoverEvent) => void): T; 20170 20171 /** 20172 * Trigger a hover move event. 20173 * 20174 * @param { Callback<HoverEvent> } event 20175 * @returns { T } 20176 * @syscap SystemCapability.ArkUI.ArkUI.Full 20177 * @crossplatform 20178 * @atomicservice 20179 * @since 15 20180 */ 20181 onHoverMove(event: Callback<HoverEvent>): T; 20182 20183 /** 20184 * Trigger a accessibility hover event. 20185 * 20186 * @param { AccessibilityCallback } callback - A callback instance used when the component is touched after accessibility mode is enabled. 20187 * @returns { T } 20188 * @syscap SystemCapability.ArkUI.ArkUI.Full 20189 * @crossplatform 20190 * @atomicservice 20191 * @since 12 20192 */ 20193 onAccessibilityHover(callback: AccessibilityCallback): T; 20194 20195 /** 20196 * Set hover effect. 20197 * 20198 * @param { HoverEffect } value 20199 * @returns { T } 20200 * @syscap SystemCapability.ArkUI.ArkUI.Full 20201 * @since 8 20202 */ 20203 /** 20204 * Set hover effect. 20205 * 20206 * @param { HoverEffect } value 20207 * @returns { T } 20208 * @syscap SystemCapability.ArkUI.ArkUI.Full 20209 * @crossplatform 20210 * @since 10 20211 */ 20212 /** 20213 * Set hover effect. 20214 * 20215 * @param { HoverEffect } value 20216 * @returns { T } 20217 * @syscap SystemCapability.ArkUI.ArkUI.Full 20218 * @crossplatform 20219 * @atomicservice 20220 * @since 11 20221 */ 20222 hoverEffect(value: HoverEffect): T; 20223 20224 /** 20225 * Trigger a mouse event. 20226 * 20227 * @param { function } event 20228 * @returns { T } 20229 * @syscap SystemCapability.ArkUI.ArkUI.Full 20230 * @since 8 20231 */ 20232 /** 20233 * Trigger a mouse event. 20234 * 20235 * @param { function } event 20236 * @returns { T } 20237 * @syscap SystemCapability.ArkUI.ArkUI.Full 20238 * @atomicservice 20239 * @since 11 20240 */ 20241 onMouse(event: (event: MouseEvent) => void): T; 20242 20243 /** 20244 * Trigger a touch event when touched. 20245 * 20246 * @param { function } event 20247 * @returns { T } 20248 * @syscap SystemCapability.ArkUI.ArkUI.Full 20249 * @since 7 20250 */ 20251 /** 20252 * Trigger a touch event when touched. 20253 * 20254 * @param { function } event 20255 * @returns { T } 20256 * @syscap SystemCapability.ArkUI.ArkUI.Full 20257 * @crossplatform 20258 * @since 10 20259 */ 20260 /** 20261 * Trigger a touch event when touched. 20262 * 20263 * @param { function } event 20264 * @returns { T } 20265 * @syscap SystemCapability.ArkUI.ArkUI.Full 20266 * @crossplatform 20267 * @atomicservice 20268 * @since 11 20269 */ 20270 onTouch(event: (event: TouchEvent) => void): T; 20271 20272 /** 20273 * Keyboard input 20274 * 20275 * @param { function } event 20276 * @returns { T } 20277 * @syscap SystemCapability.ArkUI.ArkUI.Full 20278 * @since 7 20279 */ 20280 /** 20281 * Keyboard input 20282 * 20283 * @param { function } event 20284 * @returns { T } 20285 * @syscap SystemCapability.ArkUI.ArkUI.Full 20286 * @crossplatform 20287 * @since 10 20288 */ 20289 /** 20290 * Keyboard input 20291 * 20292 * @param { function } event 20293 * @returns { T } 20294 * @syscap SystemCapability.ArkUI.ArkUI.Full 20295 * @crossplatform 20296 * @atomicservice 20297 * @since 11 20298 */ 20299 onKeyEvent(event: (event: KeyEvent) => void): T; 20300 20301 /** 20302 * Keyboard input 20303 * 20304 * @param { Callback<KeyEvent, boolean> } event 20305 * @returns { T } 20306 * @syscap SystemCapability.ArkUI.ArkUI.Full 20307 * @crossplatform 20308 * @atomicservice 20309 * @since 15 20310 */ 20311 onKeyEvent(event: Callback<KeyEvent, boolean>): T; 20312 20313 /** 20314 * Digital crown input. 20315 * 20316 * @param { Callback<CrownEvent> } event 20317 * @returns { T } 20318 * @syscap SystemCapability.ArkUI.ArkUI.Full 20319 * @atomicservice 20320 * @since 18 20321 */ 20322 onDigitalCrown(handler: Optional<Callback<CrownEvent>>): T; 20323 20324 /** 20325 * Handle keyboard events before input method events. 20326 * 20327 * @param { Callback<KeyEvent, boolean> } event 20328 * @returns { T } 20329 * @syscap SystemCapability.ArkUI.ArkUI.Full 20330 * @crossplatform 20331 * @atomicservice 20332 * @since 12 20333 */ 20334 onKeyPreIme(event: Callback<KeyEvent, boolean>): T; 20335 20336 /** 20337 * Customize the handling and distribution of key events. 20338 * 20339 * @param { Callback<KeyEvent, boolean> } event 20340 * @returns { T } 20341 * @syscap SystemCapability.ArkUI.ArkUI.Full 20342 * @crossplatform 20343 * @atomicservice 20344 * @since 15 20345 */ 20346 onKeyEventDispatch(event: Callback<KeyEvent, boolean>): T; 20347 20348 /** 20349 * Trigger a FocusAxisEvent. 20350 * 20351 * @param { Callback<FocusAxisEvent> } event 20352 * @returns { T } 20353 * @syscap SystemCapability.ArkUI.ArkUI.Full 20354 * @atomicservice 20355 * @since 15 20356 */ 20357 onFocusAxisEvent(event: Callback<FocusAxisEvent>): T; 20358 20359 /** 20360 * Handle axis events. 20361 * 20362 * @param { Callback<AxisEvent> } event 20363 * @returns { T } 20364 * @syscap SystemCapability.ArkUI.ArkUI.Full 20365 * @atomicservice 20366 * @since 17 20367 */ 20368 onAxisEvent(event: Callback<AxisEvent>): T; 20369 20370 /** 20371 * Set focusable. 20372 * 20373 * @param { boolean } value 20374 * @returns { T } 20375 * @syscap SystemCapability.ArkUI.ArkUI.Full 20376 * @since 8 20377 */ 20378 /** 20379 * Set focusable. 20380 * 20381 * @param { boolean } value 20382 * @returns { T } 20383 * @syscap SystemCapability.ArkUI.ArkUI.Full 20384 * @crossplatform 20385 * @since 10 20386 */ 20387 /** 20388 * Set focusable. 20389 * 20390 * @param { boolean } value 20391 * @returns { T } 20392 * @syscap SystemCapability.ArkUI.ArkUI.Full 20393 * @crossplatform 20394 * @atomicservice 20395 * @since 11 20396 */ 20397 focusable(value: boolean): T; 20398 20399 /** 20400 * Set nextFocus. 20401 * 20402 * @param { FocusMovement } nextStep 20403 * @returns { T } 20404 * @syscap SystemCapability.ArkUI.ArkUI.Full 20405 * @crossplatform 20406 * @atomicservice 20407 * @since 18 20408 */ 20409 nextFocus(nextStep: Optional<FocusMovement>): T; 20410 20411 /** 20412 * Set TabStop on component focus 20413 * 20414 * @param { boolean } isTabStop 20415 * @returns { T } 20416 * @syscap SystemCapability.ArkUI.ArkUI.Full 20417 * @crossplatform 20418 * @atomicservice 20419 * @since 14 20420 */ 20421 tabStop(isTabStop: boolean): T; 20422 20423 /** 20424 * Trigger a event when got focus. 20425 * 20426 * @param { function } event 20427 * @returns { T } 20428 * @syscap SystemCapability.ArkUI.ArkUI.Full 20429 * @since 8 20430 */ 20431 /** 20432 * Trigger a event when got focus. 20433 * 20434 * @param { function } event 20435 * @returns { T } 20436 * @syscap SystemCapability.ArkUI.ArkUI.Full 20437 * @crossplatform 20438 * @since 10 20439 */ 20440 /** 20441 * Trigger a event when got focus. 20442 * 20443 * @param { function } event 20444 * @returns { T } 20445 * @syscap SystemCapability.ArkUI.ArkUI.Full 20446 * @crossplatform 20447 * @atomicservice 20448 * @since 11 20449 */ 20450 onFocus(event: () => void): T; 20451 20452 /** 20453 * Trigger a event when lose focus. 20454 * 20455 * @param { function } event 20456 * @returns { T } 20457 * @syscap SystemCapability.ArkUI.ArkUI.Full 20458 * @since 8 20459 */ 20460 /** 20461 * Trigger a event when lose focus. 20462 * 20463 * @param { function } event 20464 * @returns { T } 20465 * @syscap SystemCapability.ArkUI.ArkUI.Full 20466 * @crossplatform 20467 * @since 10 20468 */ 20469 /** 20470 * Trigger a event when lose focus. 20471 * 20472 * @param { function } event 20473 * @returns { T } 20474 * @syscap SystemCapability.ArkUI.ArkUI.Full 20475 * @crossplatform 20476 * @atomicservice 20477 * @since 11 20478 */ 20479 onBlur(event: () => void): T; 20480 20481 /** 20482 * Set focus index by key tab. 20483 * 20484 * @param { number } index 20485 * @returns { T } 20486 * @syscap SystemCapability.ArkUI.ArkUI.Full 20487 * @since 9 20488 */ 20489 /** 20490 * Set focus index by key tab. 20491 * 20492 * @param { number } index 20493 * @returns { T } 20494 * @syscap SystemCapability.ArkUI.ArkUI.Full 20495 * @crossplatform 20496 * @since 10 20497 */ 20498 /** 20499 * Set focus index by key tab. 20500 * 20501 * @param { number } index 20502 * @returns { T } 20503 * @syscap SystemCapability.ArkUI.ArkUI.Full 20504 * @crossplatform 20505 * @atomicservice 20506 * @since 11 20507 */ 20508 tabIndex(index: number): T; 20509 20510 /** 20511 * Set default focused component when a page create. 20512 * 20513 * @param { boolean } value 20514 * @returns { T } 20515 * @syscap SystemCapability.ArkUI.ArkUI.Full 20516 * @since 9 20517 */ 20518 /** 20519 * Set default focused component when a page create. 20520 * 20521 * @param { boolean } value 20522 * @returns { T } 20523 * @syscap SystemCapability.ArkUI.ArkUI.Full 20524 * @crossplatform 20525 * @since 10 20526 */ 20527 /** 20528 * Set default focused component when a page create. 20529 * 20530 * @param { boolean } value 20531 * @returns { T } 20532 * @syscap SystemCapability.ArkUI.ArkUI.Full 20533 * @crossplatform 20534 * @atomicservice 20535 * @since 11 20536 */ 20537 defaultFocus(value: boolean): T; 20538 20539 /** 20540 * Set default focused component when focus on a focus group. 20541 * 20542 * @param { boolean } value 20543 * @returns { T } 20544 * @syscap SystemCapability.ArkUI.ArkUI.Full 20545 * @since 9 20546 */ 20547 /** 20548 * Set default focused component when focus on a focus group. 20549 * 20550 * @param { boolean } value 20551 * @returns { T } 20552 * @syscap SystemCapability.ArkUI.ArkUI.Full 20553 * @crossplatform 20554 * @since 10 20555 */ 20556 /** 20557 * Set default focused component when focus on a focus group. 20558 * 20559 * @param { boolean } value 20560 * @returns { T } 20561 * @syscap SystemCapability.ArkUI.ArkUI.Full 20562 * @crossplatform 20563 * @atomicservice 20564 * @since 11 20565 */ 20566 groupDefaultFocus(value: boolean): T; 20567 20568 /** 20569 * Set a component focused when the component be touched. 20570 * 20571 * @param { boolean } value 20572 * @returns { T } 20573 * @syscap SystemCapability.ArkUI.ArkUI.Full 20574 * @since 9 20575 */ 20576 /** 20577 * Set a component focused when the component be touched. 20578 * 20579 * @param { boolean } value 20580 * @returns { T } 20581 * @syscap SystemCapability.ArkUI.ArkUI.Full 20582 * @crossplatform 20583 * @since 10 20584 */ 20585 /** 20586 * Set a component focused when the component be touched. 20587 * 20588 * @param { boolean } value 20589 * @returns { T } 20590 * @syscap SystemCapability.ArkUI.ArkUI.Full 20591 * @crossplatform 20592 * @atomicservice 20593 * @since 11 20594 */ 20595 focusOnTouch(value: boolean): T; 20596 20597 /** 20598 * Set the component's focusBox style. 20599 * 20600 * @param { FocusBoxStyle } style 20601 * @returns { T } 20602 * @syscap SystemCapability.ArkUI.ArkUI.Full 20603 * @crossplatform 20604 * @atomicservice 20605 * @since 12 20606 */ 20607 focusBox(style: FocusBoxStyle): T; 20608 20609 /** 20610 * Set container as a focus group with a specific identifier. 20611 * 20612 * @param { string } id - focus scope identifier. 20613 * @param { boolean } [isGroup] - whether this scope is a focus group, the default value is false 20614 * @returns { T } 20615 * @syscap SystemCapability.ArkUI.ArkUI.Full 20616 * @crossplatform 20617 * @atomicservice 20618 * @since 12 20619 */ 20620 focusScopeId(id: string, isGroup?: boolean): T; 20621 /** 20622 * Set container as a focus group with a specific identifier. 20623 * 20624 * @param { string } id - focus scope identifier. 20625 * @param { boolean } [isGroup] - whether this scope is a focus group, the default value is false. 20626 * @param { boolean } [arrowStepOut] - whether the arrow keys can move focus from inside the focus group to outside, 20627 * only effective when isGroup is true, the default value is true. 20628 * @returns { T } 20629 * @syscap SystemCapability.ArkUI.ArkUI.Full 20630 * @crossplatform 20631 * @atomicservice 20632 * @since 14 20633 */ 20634 focusScopeId(id: string, isGroup?: boolean, arrowStepOut?: boolean): T; 20635 20636 /** 20637 * Set the focus priority of component in a specific focus scope. 20638 * 20639 * @param { string } scopeId 20640 * @param { FocusPriority } [priority] - the default value is AUTO 20641 * @returns { T } 20642 * @syscap SystemCapability.ArkUI.ArkUI.Full 20643 * @crossplatform 20644 * @atomicservice 20645 * @since 12 20646 */ 20647 focusScopePriority(scopeId: string, priority?: FocusPriority): T; 20648 20649 /** 20650 * animation 20651 * 20652 * @param { AnimateParam } value 20653 * @returns { T } 20654 * @syscap SystemCapability.ArkUI.ArkUI.Full 20655 * @since 7 20656 */ 20657 /** 20658 * animation 20659 * 20660 * @param { AnimateParam } value 20661 * @returns { T } 20662 * @syscap SystemCapability.ArkUI.ArkUI.Full 20663 * @form 20664 * @since 9 20665 */ 20666 /** 20667 * animation 20668 * 20669 * @param { AnimateParam } value 20670 * @returns { T } 20671 * @syscap SystemCapability.ArkUI.ArkUI.Full 20672 * @crossplatform 20673 * @form 20674 * @since 10 20675 */ 20676 /** 20677 * animation 20678 * 20679 * @param { AnimateParam } value 20680 * @returns { T } 20681 * @syscap SystemCapability.ArkUI.ArkUI.Full 20682 * @crossplatform 20683 * @form 20684 * @atomicservice 20685 * @since 11 20686 */ 20687 animation(value: AnimateParam): T; 20688 20689 /** 20690 * Transition parameter 20691 * 20692 * @param { TransitionOptions | TransitionEffect } value 20693 * @returns { T } 20694 * @syscap SystemCapability.ArkUI.ArkUI.Full 20695 * @since 7 20696 */ 20697 /** 20698 * Transition parameter 20699 * 20700 * @param { TransitionOptions | TransitionEffect } value - transition options 20701 * @returns { T } 20702 * @syscap SystemCapability.ArkUI.ArkUI.Full 20703 * @form 20704 * @since 9 20705 */ 20706 /** 20707 * Transition parameter 20708 * 20709 * @param { TransitionOptions | TransitionEffect } value - transition options or transition effect 20710 * @returns { T } 20711 * @syscap SystemCapability.ArkUI.ArkUI.Full 20712 * @crossplatform 20713 * @form 20714 * @since 10 20715 */ 20716 /** 20717 * Transition parameter 20718 * 20719 * @param { TransitionOptions | TransitionEffect } value - transition options or transition effect 20720 * @returns { T } 20721 * @syscap SystemCapability.ArkUI.ArkUI.Full 20722 * @crossplatform 20723 * @form 20724 * @atomicservice 20725 * @since 11 20726 */ 20727 transition(value: TransitionOptions | TransitionEffect): T; 20728 20729 /** 20730 * Set the transition effect of component when it appears and disappears. 20731 * 20732 * @param { TransitionEffect } effect - transition effect 20733 * @param { Optional<TransitionFinishCallback> } onFinish - transition finish callback. 20734 * @returns { T } 20735 * @syscap SystemCapability.ArkUI.ArkUI.Full 20736 * @crossplatform 20737 * @form 20738 * @atomicservice 20739 * @since 12 20740 */ 20741 transition(effect: TransitionEffect, onFinish: Optional<TransitionFinishCallback>): T; 20742 20743 /** 20744 * Bind gesture recognition. 20745 * gesture:Bound Gesture Type,mask:GestureMask; 20746 * 20747 * @param { GestureType } gesture 20748 * @param { GestureMask } mask 20749 * @returns { T } 20750 * @syscap SystemCapability.ArkUI.ArkUI.Full 20751 * @since 7 20752 */ 20753 /** 20754 * Bind gesture recognition. 20755 * gesture:Bound Gesture Type,mask:GestureMask; 20756 * 20757 * @param { GestureType } gesture 20758 * @param { GestureMask } mask 20759 * @returns { T } 20760 * @syscap SystemCapability.ArkUI.ArkUI.Full 20761 * @crossplatform 20762 * @since 10 20763 */ 20764 /** 20765 * Bind gesture recognition. 20766 * gesture:Bound Gesture Type,mask:GestureMask; 20767 * 20768 * @param { GestureType } gesture 20769 * @param { GestureMask } mask 20770 * @returns { T } 20771 * @syscap SystemCapability.ArkUI.ArkUI.Full 20772 * @crossplatform 20773 * @atomicservice 20774 * @since 11 20775 */ 20776 gesture(gesture: GestureType, mask?: GestureMask): T; 20777 20778 /** 20779 * Binding Preferential Recognition Gestures 20780 * gesture:Bound Gesture Type,mask:GestureMask; 20781 * 20782 * @param { GestureType } gesture 20783 * @param { GestureMask } mask 20784 * @returns { T } 20785 * @syscap SystemCapability.ArkUI.ArkUI.Full 20786 * @since 7 20787 */ 20788 /** 20789 * Binding Preferential Recognition Gestures 20790 * gesture:Bound Gesture Type,mask:GestureMask; 20791 * 20792 * @param { GestureType } gesture 20793 * @param { GestureMask } mask 20794 * @returns { T } 20795 * @syscap SystemCapability.ArkUI.ArkUI.Full 20796 * @crossplatform 20797 * @since 10 20798 */ 20799 /** 20800 * Binding Preferential Recognition Gestures 20801 * gesture:Bound Gesture Type,mask:GestureMask; 20802 * 20803 * @param { GestureType } gesture 20804 * @param { GestureMask } mask 20805 * @returns { T } 20806 * @syscap SystemCapability.ArkUI.ArkUI.Full 20807 * @crossplatform 20808 * @atomicservice 20809 * @since 11 20810 */ 20811 priorityGesture(gesture: GestureType, mask?: GestureMask): T; 20812 20813 /** 20814 * Binding gestures that can be triggered simultaneously with internal component gestures 20815 * gesture:Bound Gesture Type,mask:GestureMask; 20816 * 20817 * @param { GestureType } gesture 20818 * @param { GestureMask } mask 20819 * @returns { T } 20820 * @syscap SystemCapability.ArkUI.ArkUI.Full 20821 * @since 7 20822 */ 20823 /** 20824 * Binding gestures that can be triggered simultaneously with internal component gestures 20825 * gesture:Bound Gesture Type,mask:GestureMask; 20826 * 20827 * @param { GestureType } gesture 20828 * @param { GestureMask } mask 20829 * @returns { T } 20830 * @syscap SystemCapability.ArkUI.ArkUI.Full 20831 * @crossplatform 20832 * @since 10 20833 */ 20834 /** 20835 * Binding gestures that can be triggered simultaneously with internal component gestures 20836 * gesture:Bound Gesture Type,mask:GestureMask; 20837 * 20838 * @param { GestureType } gesture 20839 * @param { GestureMask } mask 20840 * @returns { T } 20841 * @syscap SystemCapability.ArkUI.ArkUI.Full 20842 * @crossplatform 20843 * @atomicservice 20844 * @since 11 20845 */ 20846 parallelGesture(gesture: GestureType, mask?: GestureMask): T; 20847 20848 /** 20849 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 20850 * The larger the blurring radius, the more blurring the content. 20851 * If the value is 0, the content blurring effect is not blurring. 20852 * 20853 * @param { number } value 20854 * @returns { T } 20855 * @syscap SystemCapability.ArkUI.ArkUI.Full 20856 * @since 7 20857 */ 20858 /** 20859 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 20860 * The larger the blurring radius, the more blurring the content. 20861 * If the value is 0, the content blurring effect is not blurring. 20862 * 20863 * @param { number } value 20864 * @returns { T } 20865 * @syscap SystemCapability.ArkUI.ArkUI.Full 20866 * @form 20867 * @since 9 20868 */ 20869 /** 20870 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 20871 * The larger the blurring radius, the more blurring the content. 20872 * If the value is 0, the content blurring effect is not blurring. 20873 * 20874 * @param { number } value 20875 * @returns { T } 20876 * @syscap SystemCapability.ArkUI.ArkUI.Full 20877 * @crossplatform 20878 * @form 20879 * @since 10 20880 */ 20881 /** 20882 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 20883 * The larger the blurring radius, the more blurring the content. 20884 * If the value is 0, the content blurring effect is not blurring. 20885 * 20886 * @param { number } value - value indicates radius of backdrop blur. 20887 * @param { BlurOptions } [options] - options indicates blur options. 20888 * @returns { T } 20889 * @syscap SystemCapability.ArkUI.ArkUI.Full 20890 * @crossplatform 20891 * @form 20892 * @atomicservice 20893 * @since 11 20894 */ 20895 blur(value: number, options?: BlurOptions): T; 20896 20897 /** 20898 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 20899 * The larger the blurring radius, the more blurring the content. 20900 * If the value is 0, the content blurring effect is not blurring. 20901 * 20902 * @param { Optional<number> } blurRadius - value indicates radius of backdrop blur. 20903 * @param { BlurOptions } [options] - options indicates blur options. 20904 * @returns { T } 20905 * @syscap SystemCapability.ArkUI.ArkUI.Full 20906 * @crossplatform 20907 * @form 20908 * @atomicservice 20909 * @since 18 20910 */ 20911 blur(blurRadius: Optional<number>, options?: BlurOptions): T; 20912 20913 /** 20914 * Adds the content linear gradient blurring effect for the current component. The input parameter is the blurring radius. 20915 * 20916 * @param { number } value - the blurring radius. 20917 * The larger the blurring radius, the more blurring the content, and if the value is 0, the content blurring effect is not blurring. 20918 * @param { LinearGradientBlurOptions } options - the linear gradient blur options. 20919 * @returns { T } 20920 * @syscap SystemCapability.ArkUI.ArkUI.Full 20921 * @atomicservice 20922 * @since 12 20923 */ 20924 linearGradientBlur(value: number, options: LinearGradientBlurOptions): T; 20925 20926 /** 20927 * Adds the content linear gradient blurring effect for the current component. The input parameter is the blurring radius. 20928 * 20929 * @param { Optional<number> } blurRadius - the blurring radius. 20930 * The larger the blurring radius, the more blurring the content, and if the value is 0, the content blurring effect is not blurring. 20931 * @param { Optional<LinearGradientBlurOptions> } options - the linear gradient blur options. 20932 * @returns { T } 20933 * @syscap SystemCapability.ArkUI.ArkUI.Full 20934 * @atomicservice 20935 * @since 18 20936 */ 20937 linearGradientBlur(blurRadius: Optional<number>, options: Optional<LinearGradientBlurOptions>): T; 20938 20939 /** 20940 * Component motion blur interface. 20941 * 20942 * @param { MotionBlurOptions } value - the attributes of motion blur. 20943 * @returns { T } 20944 * @syscap SystemCapability.ArkUI.ArkUI.Full 20945 * @crossplatform 20946 * @atomicservice 20947 * @since 12 20948 */ 20949 motionBlur(value: MotionBlurOptions):T; 20950 20951 /** 20952 * Component motion blur interface. 20953 * 20954 * @param { Optional<MotionBlurOptions> } motionBlur - the attributes of motion blur. 20955 * @returns { T } 20956 * @syscap SystemCapability.ArkUI.ArkUI.Full 20957 * @crossplatform 20958 * @atomicservice 20959 * @since 18 20960 */ 20961 motionBlur(motionBlur: Optional<MotionBlurOptions>):T; 20962 20963 /** 20964 * Adds a highlight effect to the current component. 20965 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 20966 * The component is displayed as all white (percentage). 20967 * 20968 * @param { number } value 20969 * @returns { T } 20970 * @syscap SystemCapability.ArkUI.ArkUI.Full 20971 * @since 7 20972 */ 20973 /** 20974 * Adds a highlight effect to the current component. 20975 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 20976 * The component is displayed as all white (percentage). 20977 * 20978 * @param { number } value 20979 * @returns { T } 20980 * @syscap SystemCapability.ArkUI.ArkUI.Full 20981 * @form 20982 * @since 9 20983 */ 20984 /** 20985 * Adds a highlight effect to the current component. 20986 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 20987 * The component is displayed as all white (percentage). 20988 * 20989 * @param { number } value 20990 * @returns { T } 20991 * @syscap SystemCapability.ArkUI.ArkUI.Full 20992 * @crossplatform 20993 * @form 20994 * @since 10 20995 */ 20996 /** 20997 * Adds a highlight effect to the current component. 20998 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 20999 * The component is displayed as all white (percentage). 21000 * 21001 * @param { number } value 21002 * @returns { T } 21003 * @syscap SystemCapability.ArkUI.ArkUI.Full 21004 * @crossplatform 21005 * @form 21006 * @atomicservice 21007 * @since 11 21008 */ 21009 brightness(value: number): T; 21010 21011 /** 21012 * Adds a highlight effect to the current component. 21013 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 21014 * The component is displayed as all white (percentage). 21015 * 21016 * @param { Optional<number> } brightness 21017 * @returns { T } 21018 * @syscap SystemCapability.ArkUI.ArkUI.Full 21019 * @crossplatform 21020 * @form 21021 * @atomicservice 21022 * @since 18 21023 */ 21024 brightness(brightness: Optional<number>): T; 21025 21026 /** 21027 * Adds a contrast effect to the current component. The input parameter is the contrast value. 21028 * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) 21029 * 21030 * @param { number } value 21031 * @returns { T } 21032 * @syscap SystemCapability.ArkUI.ArkUI.Full 21033 * @since 7 21034 */ 21035 /** 21036 * Adds a contrast effect to the current component. The input parameter is the contrast value. 21037 * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) 21038 * 21039 * @param { number } value 21040 * @returns { T } 21041 * @syscap SystemCapability.ArkUI.ArkUI.Full 21042 * @form 21043 * @since 9 21044 */ 21045 /** 21046 * Adds a contrast effect to the current component. The input parameter is the contrast value. 21047 * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) 21048 * 21049 * @param { number } value 21050 * @returns { T } 21051 * @syscap SystemCapability.ArkUI.ArkUI.Full 21052 * @crossplatform 21053 * @form 21054 * @since 10 21055 */ 21056 /** 21057 * Adds a contrast effect to the current component. The input parameter is the contrast value. 21058 * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) 21059 * 21060 * @param { number } value 21061 * @returns { T } 21062 * @syscap SystemCapability.ArkUI.ArkUI.Full 21063 * @crossplatform 21064 * @form 21065 * @atomicservice 21066 * @since 11 21067 */ 21068 contrast(value: number): T; 21069 21070 /** 21071 * Adds a contrast effect to the current component. The input parameter is the contrast value. 21072 * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) 21073 * 21074 * @param { Optional<number> } contrast 21075 * @returns { T } 21076 * @syscap SystemCapability.ArkUI.ArkUI.Full 21077 * @crossplatform 21078 * @form 21079 * @atomicservice 21080 * @since 18 21081 */ 21082 contrast(contrast: Optional<number>): T; 21083 21084 /** 21085 * Adds a grayscale effect to the current component. 21086 * 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. 21087 * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) 21088 * 21089 * @param { number } value 21090 * @returns { T } 21091 * @syscap SystemCapability.ArkUI.ArkUI.Full 21092 * @since 7 21093 */ 21094 /** 21095 * Adds a grayscale effect to the current component. 21096 * 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. 21097 * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) 21098 * 21099 * @param { number } value 21100 * @returns { T } 21101 * @syscap SystemCapability.ArkUI.ArkUI.Full 21102 * @form 21103 * @since 9 21104 */ 21105 /** 21106 * Adds a grayscale effect to the current component. 21107 * 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. 21108 * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) 21109 * 21110 * @param { number } value 21111 * @returns { T } 21112 * @syscap SystemCapability.ArkUI.ArkUI.Full 21113 * @crossplatform 21114 * @form 21115 * @since 10 21116 */ 21117 /** 21118 * Adds a grayscale effect to the current component. 21119 * 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. 21120 * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) 21121 * 21122 * @param { number } value 21123 * @returns { T } 21124 * @syscap SystemCapability.ArkUI.ArkUI.Full 21125 * @crossplatform 21126 * @form 21127 * @atomicservice 21128 * @since 11 21129 */ 21130 grayscale(value: number): T; 21131 21132 /** 21133 * Adds a grayscale effect to the current component. 21134 * 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. 21135 * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) 21136 * 21137 * @param { Optional<number> } grayscale 21138 * @returns { T } 21139 * @syscap SystemCapability.ArkUI.ArkUI.Full 21140 * @crossplatform 21141 * @form 21142 * @atomicservice 21143 * @since 18 21144 */ 21145 grayscale(grayscale: Optional<number>): T; 21146 21147 /** 21148 * Adds a color overlay effect for the current component. The input parameter is the superimposed color. 21149 * 21150 * @param { Color | string | Resource } value 21151 * @returns { T } 21152 * @syscap SystemCapability.ArkUI.ArkUI.Full 21153 * @since 7 21154 */ 21155 /** 21156 * Adds a color overlay effect for the current component. The input parameter is the superimposed color. 21157 * 21158 * @param { Color | string | Resource } value 21159 * @returns { T } 21160 * @syscap SystemCapability.ArkUI.ArkUI.Full 21161 * @form 21162 * @since 9 21163 */ 21164 /** 21165 * Adds a color overlay effect for the current component. The input parameter is the superimposed color. 21166 * 21167 * @param { Color | string | Resource } value 21168 * @returns { T } 21169 * @syscap SystemCapability.ArkUI.ArkUI.Full 21170 * @crossplatform 21171 * @form 21172 * @since 10 21173 */ 21174 /** 21175 * Adds a color overlay effect for the current component. The input parameter is the superimposed color. 21176 * 21177 * @param { Color | string | Resource } value 21178 * @returns { T } 21179 * @syscap SystemCapability.ArkUI.ArkUI.Full 21180 * @crossplatform 21181 * @form 21182 * @atomicservice 21183 * @since 11 21184 */ 21185 colorBlend(value: Color | string | Resource): T; 21186 21187 /** 21188 * Adds a color overlay effect for the current component. The input parameter is the superimposed color. 21189 * 21190 * @param { Optional<Color | string | Resource> } color 21191 * @returns { T } 21192 * @syscap SystemCapability.ArkUI.ArkUI.Full 21193 * @crossplatform 21194 * @form 21195 * @atomicservice 21196 * @since 18 21197 */ 21198 colorBlend(color: Optional<Color | string | Resource>): T; 21199 21200 /** 21201 * Adds a saturation effect to the current component. 21202 * The saturation is the ratio of the color-containing component to the achromatic component (gray). 21203 * The larger the color-containing component, the greater the saturation. 21204 * The larger the achromatic component, the smaller the saturation. (Percentage) 21205 * 21206 * @param { number } value 21207 * @returns { T } 21208 * @syscap SystemCapability.ArkUI.ArkUI.Full 21209 * @since 7 21210 */ 21211 /** 21212 * Adds a saturation effect to the current component. 21213 * The saturation is the ratio of the color-containing component to the achromatic component (gray). 21214 * The larger the color-containing component, the greater the saturation. 21215 * The larger the achromatic component, the smaller the saturation. (Percentage) 21216 * 21217 * @param { number } value 21218 * @returns { T } 21219 * @syscap SystemCapability.ArkUI.ArkUI.Full 21220 * @form 21221 * @since 9 21222 */ 21223 /** 21224 * Adds a saturation effect to the current component. 21225 * The saturation is the ratio of the color-containing component to the achromatic component (gray). 21226 * The larger the color-containing component, the greater the saturation. 21227 * The larger the achromatic component, the smaller the saturation. (Percentage) 21228 * 21229 * @param { number } value 21230 * @returns { T } 21231 * @syscap SystemCapability.ArkUI.ArkUI.Full 21232 * @crossplatform 21233 * @form 21234 * @since 10 21235 */ 21236 /** 21237 * Adds a saturation effect to the current component. 21238 * The saturation is the ratio of the color-containing component to the achromatic component (gray). 21239 * The larger the color-containing component, the greater the saturation. 21240 * The larger the achromatic component, the smaller the saturation. (Percentage) 21241 * 21242 * @param { number } value 21243 * @returns { T } 21244 * @syscap SystemCapability.ArkUI.ArkUI.Full 21245 * @crossplatform 21246 * @form 21247 * @atomicservice 21248 * @since 11 21249 */ 21250 saturate(value: number): T; 21251 21252 /** 21253 * Adds a saturation effect to the current component. 21254 * The saturation is the ratio of the color-containing component to the achromatic component (gray). 21255 * The larger the color-containing component, the greater the saturation. 21256 * The larger the achromatic component, the smaller the saturation. (Percentage) 21257 * 21258 * @param { Optional<number> } saturate 21259 * @returns { T } 21260 * @syscap SystemCapability.ArkUI.ArkUI.Full 21261 * @crossplatform 21262 * @form 21263 * @atomicservice 21264 * @since 18 21265 */ 21266 saturate(saturate: Optional<number>): T; 21267 21268 /** 21269 * Converts the image to sepia. Value defines the scale of the conversion. 21270 * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) 21271 * 21272 * @param { number } value 21273 * @returns { T } 21274 * @syscap SystemCapability.ArkUI.ArkUI.Full 21275 * @since 7 21276 */ 21277 /** 21278 * Converts the image to sepia. Value defines the scale of the conversion. 21279 * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) 21280 * 21281 * @param { number } value 21282 * @returns { T } 21283 * @syscap SystemCapability.ArkUI.ArkUI.Full 21284 * @form 21285 * @since 9 21286 */ 21287 /** 21288 * Converts the image to sepia. Value defines the scale of the conversion. 21289 * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) 21290 * 21291 * @param { number } value 21292 * @returns { T } 21293 * @syscap SystemCapability.ArkUI.ArkUI.Full 21294 * @crossplatform 21295 * @form 21296 * @since 10 21297 */ 21298 /** 21299 * Converts the image to sepia. Value defines the scale of the conversion. 21300 * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) 21301 * 21302 * @param { number } value 21303 * @returns { T } 21304 * @syscap SystemCapability.ArkUI.ArkUI.Full 21305 * @crossplatform 21306 * @form 21307 * @atomicservice 21308 * @since 11 21309 */ 21310 sepia(value: number): T; 21311 21312 /** 21313 * Converts the image to sepia. Value defines the scale of the conversion. 21314 * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) 21315 * 21316 * @param { Optional<number> } sepia 21317 * @returns { T } 21318 * @syscap SystemCapability.ArkUI.ArkUI.Full 21319 * @crossplatform 21320 * @form 21321 * @atomicservice 21322 * @since 18 21323 */ 21324 sepia(sepia: Optional<number>): T; 21325 21326 /** 21327 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 21328 * A value of 0% does not change the image. (Percentage) 21329 * 21330 * @param { number } value 21331 * @returns { T } 21332 * @syscap SystemCapability.ArkUI.ArkUI.Full 21333 * @since 7 21334 */ 21335 /** 21336 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 21337 * A value of 0% does not change the image. (Percentage) 21338 * 21339 * @param { number } value 21340 * @returns { T } 21341 * @syscap SystemCapability.ArkUI.ArkUI.Full 21342 * @form 21343 * @since 9 21344 */ 21345 /** 21346 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 21347 * A value of 0% does not change the image. (Percentage) 21348 * 21349 * @param { number } value 21350 * @returns { T } 21351 * @syscap SystemCapability.ArkUI.ArkUI.Full 21352 * @crossplatform 21353 * @form 21354 * @since 10 21355 */ 21356 /** 21357 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 21358 * A value of 0% does not change the image. (Percentage) 21359 * 21360 * @param { number | InvertOptions } value - value indicates the scale of the conversion or the options of invert. 21361 * @returns { T } 21362 * @syscap SystemCapability.ArkUI.ArkUI.Full 21363 * @crossplatform 21364 * @form 21365 * @atomicservice 21366 * @since 11 21367 */ 21368 invert(value: number | InvertOptions): T; 21369 21370 /** 21371 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 21372 * A value of 0% does not change the image. (Percentage) 21373 * 21374 * @param { Optional<number | InvertOptions> } options - value indicates the scale of the conversion or the options of invert. 21375 * @returns { T } 21376 * @syscap SystemCapability.ArkUI.ArkUI.Full 21377 * @crossplatform 21378 * @form 21379 * @atomicservice 21380 * @since 18 21381 */ 21382 invert(options: Optional<number | InvertOptions>): T; 21383 21384 /** 21385 * Sets system bar effect to the component. 21386 * 21387 * @returns { T } return the component attribute. 21388 * @syscap SystemCapability.ArkUI.ArkUI.Full 21389 * @atomicservice 21390 * @since 12 21391 */ 21392 systemBarEffect(): T; 21393 21394 /** 21395 * Adds the hue rotation effect to the current component. 21396 * 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. 21397 * If the value exceeds 360deg, the image is circled again. 21398 * 21399 * @param { number | string } value 21400 * @returns { T } 21401 * @syscap SystemCapability.ArkUI.ArkUI.Full 21402 * @since 7 21403 */ 21404 /** 21405 * Adds the hue rotation effect to the current component. 21406 * 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. 21407 * If the value exceeds 360deg, the image is circled again. 21408 * 21409 * @param { number | string } value 21410 * @returns { T } 21411 * @syscap SystemCapability.ArkUI.ArkUI.Full 21412 * @form 21413 * @since 9 21414 */ 21415 /** 21416 * Adds the hue rotation effect to the current component. 21417 * 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. 21418 * If the value exceeds 360deg, the image is circled again. 21419 * 21420 * @param { number | string } value 21421 * @returns { T } 21422 * @syscap SystemCapability.ArkUI.ArkUI.Full 21423 * @crossplatform 21424 * @form 21425 * @since 10 21426 */ 21427 /** 21428 * Adds the hue rotation effect to the current component. 21429 * 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. 21430 * If the value exceeds 360deg, the image is circled again. 21431 * 21432 * @param { number | string } value 21433 * @returns { T } 21434 * @syscap SystemCapability.ArkUI.ArkUI.Full 21435 * @crossplatform 21436 * @form 21437 * @atomicservice 21438 * @since 11 21439 */ 21440 hueRotate(value: number | string): T; 21441 21442 /** 21443 * Adds the hue rotation effect to the current component. 21444 * 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. 21445 * If the value exceeds 360deg, the image is circled again. 21446 * 21447 * @param { Optional<number | string> } rotation 21448 * @returns { T } 21449 * @syscap SystemCapability.ArkUI.ArkUI.Full 21450 * @crossplatform 21451 * @form 21452 * @atomicservice 21453 * @since 18 21454 */ 21455 hueRotate(rotation: Optional<number | string>): T; 21456 21457 /** 21458 * Add an attribute to control whether the shadows of the child nodes overlap each other. 21459 * 21460 * @param { boolean } value - true means the shadows of the child nodes overlap each other effect and drawn in batches. 21461 * @returns { T } 21462 * @syscap SystemCapability.ArkUI.ArkUI.Full 21463 * @crossplatform 21464 * @form 21465 * @since 11 21466 */ 21467 /** 21468 * Add an attribute to control whether the shadows of the child nodes overlap each other. 21469 * 21470 * @param { boolean } value - true means the shadows of the child nodes overlap each other effect and drawn in batches. 21471 * @returns { T } 21472 * @syscap SystemCapability.ArkUI.ArkUI.Full 21473 * @crossplatform 21474 * @form 21475 * @atomicservice 21476 * @since 12 21477 */ 21478 useShadowBatching(value: boolean): T; 21479 21480 /** 21481 * Add an attribute to control whether the shadows of the child nodes overlap each other. 21482 * 21483 * @param { Optional<boolean> } use - true means the shadows of the child nodes overlap each other effect and drawn in batches. 21484 * @returns { T } 21485 * @syscap SystemCapability.ArkUI.ArkUI.Full 21486 * @crossplatform 21487 * @form 21488 * @atomicservice 21489 * @since 18 21490 */ 21491 useShadowBatching(use: Optional<boolean>): T; 21492 21493 /** 21494 * Sets whether the component should apply the effects template defined by the parent effectComponent or window. 21495 * If multiple parent effectComponents are found, the nearest one will be used. 21496 * If no parent effectComponent is found, this method has no effect. 21497 * 21498 * @param { boolean } useEffect - true means the component should apply the effects template defined by the parent effectComponent or window. 21499 * @param { EffectType } effectType - the effect type of the effects template, defined by the parent effectComponent or window. 21500 * @returns { T } return the component attribute. 21501 * @syscap SystemCapability.ArkUI.ArkUI.Full 21502 * @atomicservice 21503 * @since 14 21504 */ 21505 useEffect(useEffect: boolean, effectType: EffectType): T; 21506 21507 /** 21508 * Sets whether the component should apply the effects template defined by the parent effectComponent or window. 21509 * If multiple parent effectComponents are found, the nearest one will be used. 21510 * If no parent effectComponent is found, this method has no effect. 21511 * 21512 * @param { Optional<boolean> } useEffect - true means the component should apply the effects template defined by the parent effectComponent or window. 21513 * @param { EffectType } [effectType] - the effect type of the effects template, defined by the parent effectComponent or window. 21514 * @returns { T } return the component attribute. 21515 * @syscap SystemCapability.ArkUI.ArkUI.Full 21516 * @atomicservice 21517 * @since 18 21518 */ 21519 useEffect(useEffect: Optional<boolean>, effectType?: EffectType): T; 21520 21521 /** 21522 * Sets whether the component should apply the effects template defined by the parent effectComponent. 21523 * If multiple parent effectComponents are found, the nearest one will be used. 21524 * If no parent effectComponent is found, this method has no effect. 21525 * 21526 * @param { boolean } value - true means the component should apply the effects template. 21527 * @returns { T } return the component attribute. 21528 * @syscap SystemCapability.ArkUI.ArkUI.Full 21529 * @atomicservice 21530 * @since 12 21531 */ 21532 useEffect(value: boolean): T; 21533 21534 /** 21535 * Adds the background blur effect for the current component. The input parameter is the blur radius. 21536 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 21537 * 21538 * @param { number } value 21539 * @returns { T } 21540 * @syscap SystemCapability.ArkUI.ArkUI.Full 21541 * @since 7 21542 */ 21543 /** 21544 * Adds the background blur effect for the current component. The input parameter is the blur radius. 21545 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 21546 * 21547 * @param { number } value 21548 * @returns { T } 21549 * @syscap SystemCapability.ArkUI.ArkUI.Full 21550 * @form 21551 * @since 9 21552 */ 21553 /** 21554 * Adds the background blur effect for the current component. The input parameter is the blur radius. 21555 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 21556 * 21557 * @param { number } value 21558 * @returns { T } 21559 * @syscap SystemCapability.ArkUI.ArkUI.Full 21560 * @crossplatform 21561 * @form 21562 * @since 10 21563 */ 21564 /** 21565 * Adds the background blur effect for the current component. The input parameter is the blur radius. 21566 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 21567 * 21568 * @param { number } value - value indicates radius of backdrop blur. 21569 * @param { BlurOptions } [options] - options indicates the backdrop blur options. 21570 * @returns { T } 21571 * @syscap SystemCapability.ArkUI.ArkUI.Full 21572 * @crossplatform 21573 * @form 21574 * @atomicservice 21575 * @since 11 21576 */ 21577 backdropBlur(value: number, options?: BlurOptions): T; 21578 21579 /** 21580 * Adds the background blur effect for the current component. The input parameter is the blur radius. 21581 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 21582 * 21583 * @param { Optional<number> } radius - radius indicates radius of backdrop blur. 21584 * @param { BlurOptions } [options] - options indicates the backdrop blur options. 21585 * @returns { T } 21586 * @syscap SystemCapability.ArkUI.ArkUI.Full 21587 * @crossplatform 21588 * @form 21589 * @atomicservice 21590 * @since 18 21591 */ 21592 backdropBlur(radius: Optional<number>, options?: BlurOptions): T; 21593 21594 /** 21595 * Composite the contents of this view and its children into an offscreen cache before display in the screen. 21596 * 21597 * @param { boolean } value - if this view and its children need to composite into an offscreen cache. 21598 * @returns { T } 21599 * @syscap SystemCapability.ArkUI.ArkUI.Full 21600 * @crossplatform 21601 * @since 10 21602 */ 21603 /** 21604 * Composite the contents of this view and its children into an offscreen cache before display in the screen. 21605 * 21606 * @param { boolean } value - if this view and its children need to composite into an offscreen cache. 21607 * @returns { T } 21608 * @syscap SystemCapability.ArkUI.ArkUI.Full 21609 * @crossplatform 21610 * @atomicservice 21611 * @since 11 21612 */ 21613 /** 21614 * Composite the contents of this view and its children into an offscreen cache before display in the screen. 21615 * 21616 * @param { boolean } value - if this view and its children need to composite into an offscreen cache. 21617 * @returns { T } 21618 * @syscap SystemCapability.ArkUI.ArkUI.Full 21619 * @crossplatform 21620 * @form 21621 * @atomicservice 21622 * @since 12 21623 */ 21624 renderGroup(value: boolean): T; 21625 21626 /** 21627 * Composite the contents of this view and its children into an offscreen cache before display in the screen. 21628 * 21629 * @param { Optional<boolean> } isGroup - if this view and its children need to composite into an offscreen cache. 21630 * @returns { T } 21631 * @syscap SystemCapability.ArkUI.ArkUI.Full 21632 * @crossplatform 21633 * @form 21634 * @atomicservice 21635 * @since 18 21636 */ 21637 renderGroup(isGroup: Optional<boolean>): T; 21638 21639 /** 21640 * Sets whether the component should remain stationary, reusing the results of the current frame's off-screen rendering. 21641 * If the input parameter is true, the component and subcomponent changes do not affect the display. 21642 * 21643 * @param { boolean } value - true means the component should remain stationary. 21644 * @returns { T } 21645 * @syscap SystemCapability.ArkUI.ArkUI.Full 21646 * @atomicservice 21647 * @since 12 21648 */ 21649 freeze(value: boolean): T; 21650 21651 /** 21652 * Sets whether the component should remain stationary, reusing the results of the current frame's off-screen rendering. 21653 * If the input parameter is true, the component and subcomponent changes do not affect the display. 21654 * 21655 * @param { Optional<boolean> } freeze - true means the component should remain stationary. 21656 * @returns { T } 21657 * @syscap SystemCapability.ArkUI.ArkUI.Full 21658 * @atomicservice 21659 * @since 18 21660 */ 21661 freeze(freeze: Optional<boolean>): T; 21662 21663 /** 21664 * Sets the translation effect during page transition. 21665 * The value is the start point of entry and end point of exit. 21666 * When this parameter is set together with slide, slide takes effect by default. 21667 * 21668 * @param { TranslateOptions } value 21669 * @returns { T } 21670 * @syscap SystemCapability.ArkUI.ArkUI.Full 21671 * @since 7 21672 */ 21673 /** 21674 * Sets the translation effect during page transition. 21675 * The value is the start point of entry and end point of exit. 21676 * When this parameter is set together with slide, slide takes effect by default. 21677 * 21678 * @param { TranslateOptions } value 21679 * @returns { T } 21680 * @syscap SystemCapability.ArkUI.ArkUI.Full 21681 * @form 21682 * @since 9 21683 */ 21684 /** 21685 * Sets the translation effect during page transition. 21686 * The value is the start point of entry and end point of exit. 21687 * When this parameter is set together with slide, slide takes effect by default. 21688 * 21689 * @param { TranslateOptions } value 21690 * @returns { T } 21691 * @syscap SystemCapability.ArkUI.ArkUI.Full 21692 * @crossplatform 21693 * @form 21694 * @since 10 21695 */ 21696 /** 21697 * Set component translation. 21698 * 21699 * @param { TranslateOptions } value default:{x:0,y:0,z:0} 21700 * @returns { T } 21701 * @syscap SystemCapability.ArkUI.ArkUI.Full 21702 * @crossplatform 21703 * @form 21704 * @atomicservice 21705 * @since 11 21706 */ 21707 translate(value: TranslateOptions): T; 21708 21709 /** 21710 * Set component translation. 21711 * 21712 * @param { Optional<TranslateOptions> } translate default:{x:0,y:0,z:0} 21713 * @returns { T } 21714 * @syscap SystemCapability.ArkUI.ArkUI.Full 21715 * @crossplatform 21716 * @form 21717 * @atomicservice 21718 * @since 18 21719 */ 21720 translate(translate: Optional<TranslateOptions>): T; 21721 21722 /** 21723 * Sets the zoom effect during page transition. The value is the start point of entry and end point of exit. 21724 * 21725 * @param { ScaleOptions } value 21726 * @returns { T } 21727 * @syscap SystemCapability.ArkUI.ArkUI.Full 21728 * @since 7 21729 */ 21730 /** 21731 * Sets the zoom effect during page transition. The value is the start point of entry and end point of exit. 21732 * 21733 * @param { ScaleOptions } value 21734 * @returns { T } 21735 * @syscap SystemCapability.ArkUI.ArkUI.Full 21736 * @form 21737 * @since 9 21738 */ 21739 /** 21740 * Sets the zoom effect during page transition. The value is the start point of entry and end point of exit. 21741 * 21742 * @param { ScaleOptions } value 21743 * @returns { T } 21744 * @syscap SystemCapability.ArkUI.ArkUI.Full 21745 * @crossplatform 21746 * @form 21747 * @since 10 21748 */ 21749 /** 21750 * Set component scaling. 21751 * 21752 * @param { ScaleOptions } value default:{x:1,y:1,z:1,centerX:'50%',centerY:'50%'} 21753 * @returns { T } 21754 * @syscap SystemCapability.ArkUI.ArkUI.Full 21755 * @crossplatform 21756 * @form 21757 * @atomicservice 21758 * @since 11 21759 */ 21760 scale(value: ScaleOptions): T; 21761 21762 /** 21763 * Set component scaling. 21764 * 21765 * @param { Optional<ScaleOptions> } options default:{x:1,y:1,z:1,centerX:'50%',centerY:'50%'} 21766 * @returns { T } 21767 * @syscap SystemCapability.ArkUI.ArkUI.Full 21768 * @crossplatform 21769 * @form 21770 * @atomicservice 21771 * @since 18 21772 */ 21773 scale(options: Optional<ScaleOptions>): T; 21774 21775 /** 21776 * 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. 21777 * 21778 * @param { number } value 21779 * @returns { T } 21780 * @syscap SystemCapability.ArkUI.ArkUI.Full 21781 * @since 7 21782 */ 21783 /** 21784 * 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. 21785 * 21786 * @param { number } value 21787 * @returns { T } 21788 * @syscap SystemCapability.ArkUI.ArkUI.Full 21789 * @crossplatform 21790 * @since 10 21791 */ 21792 /** 21793 * 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. 21794 * 21795 * @param { number } value 21796 * @returns { T } 21797 * @syscap SystemCapability.ArkUI.ArkUI.Full 21798 * @crossplatform 21799 * @atomicservice 21800 * @since 11 21801 * @deprecated since 14 21802 * @useinstead grid_col/GridColInterface and grid_row/GridRowInterface 21803 */ 21804 gridSpan(value: number): T; 21805 21806 /** 21807 * 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, 21808 * the current component is located in the nth column. 21809 * 21810 * @param { number } value 21811 * @returns { T } 21812 * @syscap SystemCapability.ArkUI.ArkUI.Full 21813 * @since 7 21814 */ 21815 /** 21816 * 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, 21817 * the current component is located in the nth column. 21818 * 21819 * @param { number } value 21820 * @returns { T } 21821 * @syscap SystemCapability.ArkUI.ArkUI.Full 21822 * @crossplatform 21823 * @since 10 21824 */ 21825 /** 21826 * 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, 21827 * the current component is located in the nth column. 21828 * 21829 * @param { number } value 21830 * @returns { T } 21831 * @syscap SystemCapability.ArkUI.ArkUI.Full 21832 * @crossplatform 21833 * @atomicservice 21834 * @since 11 21835 * @deprecated since 14 21836 * @useinstead grid_col/GridColInterface and grid_row/GridRowInterface 21837 */ 21838 gridOffset(value: number): T; 21839 21840 /** 21841 * Sets the rotation effect during assembly transition. 21842 * The values are the start point during insertion and the end point during deletion. 21843 * 21844 * @param { RotateOptions } value 21845 * @returns { T } 21846 * @syscap SystemCapability.ArkUI.ArkUI.Full 21847 * @since 7 21848 */ 21849 /** 21850 * Sets the rotation effect during assembly transition. 21851 * The values are the start point during insertion and the end point during deletion. 21852 * 21853 * @param { RotateOptions } value 21854 * @returns { T } 21855 * @syscap SystemCapability.ArkUI.ArkUI.Full 21856 * @form 21857 * @since 9 21858 */ 21859 /** 21860 * Sets the rotation effect during assembly transition. 21861 * The values are the start point during insertion and the end point during deletion. 21862 * 21863 * @param { RotateOptions } value 21864 * @returns { T } 21865 * @syscap SystemCapability.ArkUI.ArkUI.Full 21866 * @crossplatform 21867 * @form 21868 * @since 10 21869 */ 21870 /** 21871 * Set component rotation. 21872 * 21873 * @param { RotateOptions } value default:{x:0,y:0,z:0,centerX:'50%',centerY:'50%',centerZ:0,perspective:0} 21874 * @returns { T } 21875 * @syscap SystemCapability.ArkUI.ArkUI.Full 21876 * @crossplatform 21877 * @form 21878 * @atomicservice 21879 * @since 11 21880 */ 21881 rotate(value: RotateOptions): T; 21882 21883 /** 21884 * Set component rotation. 21885 * 21886 * @param { Optional<RotateOptions> } options default:{x:0,y:0,z:0,centerX:'50%',centerY:'50%',centerZ:0,perspective:0} 21887 * @returns { T } 21888 * @syscap SystemCapability.ArkUI.ArkUI.Full 21889 * @crossplatform 21890 * @form 21891 * @atomicservice 21892 * @since 18 21893 */ 21894 rotate(options: Optional<RotateOptions>): T; 21895 21896 /** 21897 * Sets the transformation matrix for the current component. 21898 * 21899 * @param { object } value 21900 * @returns { T } 21901 * @syscap SystemCapability.ArkUI.ArkUI.Full 21902 * @since 7 21903 */ 21904 /** 21905 * Sets the transformation matrix for the current component. 21906 * 21907 * @param { object } value 21908 * @returns { T } 21909 * @syscap SystemCapability.ArkUI.ArkUI.Full 21910 * @crossplatform 21911 * @since 10 21912 */ 21913 /** 21914 * Sets the transformation matrix for the current component. 21915 * 21916 * @param { object } value 21917 * @returns { T } 21918 * @syscap SystemCapability.ArkUI.ArkUI.Full 21919 * @crossplatform 21920 * @atomicservice 21921 * @since 11 21922 */ 21923 transform(value: object): T; 21924 21925 /** 21926 * Sets the transformation matrix for the current component. 21927 * 21928 * @param { Optional<object> } transform 21929 * @returns { T } 21930 * @syscap SystemCapability.ArkUI.ArkUI.Full 21931 * @crossplatform 21932 * @atomicservice 21933 * @since 18 21934 */ 21935 transform(transform: Optional<object>): T; 21936 21937 /** 21938 * This callback is triggered when a component mounts a display. 21939 * 21940 * @param { function } event 21941 * @returns { T } 21942 * @syscap SystemCapability.ArkUI.ArkUI.Full 21943 * @since 7 21944 */ 21945 /** 21946 * This callback is triggered when a component mounts a display. 21947 * 21948 * @param { function } event 21949 * @returns { T } 21950 * @syscap SystemCapability.ArkUI.ArkUI.Full 21951 * @form 21952 * @since 9 21953 */ 21954 /** 21955 * This callback is triggered when a component mounts a display. 21956 * 21957 * @param { function } event 21958 * @returns { T } 21959 * @syscap SystemCapability.ArkUI.ArkUI.Full 21960 * @crossplatform 21961 * @form 21962 * @since 10 21963 */ 21964 /** 21965 * This callback is triggered when a component mounts a display. 21966 * 21967 * @param { function } event 21968 * @returns { T } 21969 * @syscap SystemCapability.ArkUI.ArkUI.Full 21970 * @crossplatform 21971 * @form 21972 * @atomicservice 21973 * @since 11 21974 */ 21975 onAppear(event: () => void): T; 21976 21977 /** 21978 * This callback is triggered when component uninstallation disappears. 21979 * 21980 * @param { function } event 21981 * @returns { T } 21982 * @syscap SystemCapability.ArkUI.ArkUI.Full 21983 * @since 7 21984 */ 21985 /** 21986 * This callback is triggered when component uninstallation disappears. 21987 * 21988 * @param { function } event 21989 * @returns { T } 21990 * @syscap SystemCapability.ArkUI.ArkUI.Full 21991 * @form 21992 * @since 9 21993 */ 21994 /** 21995 * This callback is triggered when component uninstallation disappears. 21996 * 21997 * @param { function } event 21998 * @returns { T } 21999 * @syscap SystemCapability.ArkUI.ArkUI.Full 22000 * @crossplatform 22001 * @form 22002 * @since 10 22003 */ 22004 /** 22005 * This callback is triggered when component uninstallation disappears. 22006 * 22007 * @param { function } event 22008 * @returns { T } 22009 * @syscap SystemCapability.ArkUI.ArkUI.Full 22010 * @crossplatform 22011 * @form 22012 * @atomicservice 22013 * @since 11 22014 */ 22015 onDisAppear(event: () => void): T; 22016 22017 /** 22018 * This callback is triggered when a component mounts to view tree. 22019 * 22020 * @param { Callback<void> } callback 22021 * @returns { T } 22022 * @syscap SystemCapability.ArkUI.ArkUI.Full 22023 * @crossplatform 22024 * @atomicservice 22025 * @since 12 22026 */ 22027 onAttach(callback: Callback<void>): T; 22028 22029 /** 22030 * This callback is triggered when a component is detached from view tree. 22031 * 22032 * @param { Callback<void> } callback 22033 * @returns { T } 22034 * @syscap SystemCapability.ArkUI.ArkUI.Full 22035 * @crossplatform 22036 * @atomicservice 22037 * @since 12 22038 */ 22039 onDetach(callback: Callback<void>): T; 22040 22041 /** 22042 * This callback is triggered when the size or position of this component change finished. 22043 * 22044 * @param { function } event - event callback. 22045 * @returns { T } 22046 * @syscap SystemCapability.ArkUI.ArkUI.Full 22047 * @since 8 22048 */ 22049 /** 22050 * This callback is triggered when the size or position of this component change finished. 22051 * 22052 * @param { function } event - event callback. 22053 * @returns { T } 22054 * @syscap SystemCapability.ArkUI.ArkUI.Full 22055 * @crossplatform 22056 * @since 10 22057 */ 22058 /** 22059 * This callback is triggered when the size or position of this component change finished. 22060 * 22061 * @param { function } event - event callback. 22062 * @returns { T } 22063 * @syscap SystemCapability.ArkUI.ArkUI.Full 22064 * @crossplatform 22065 * @atomicservice 22066 * @since 11 22067 */ 22068 onAreaChange(event: (oldValue: Area, newValue: Area) => void): T; 22069 22070 /** 22071 * Controls the display or hide of the current component. 22072 * 22073 * @param { Visibility } value 22074 * @returns { T } 22075 * @syscap SystemCapability.ArkUI.ArkUI.Full 22076 * @since 7 22077 */ 22078 /** 22079 * Controls the display or hide of the current component. 22080 * 22081 * @param { Visibility } value 22082 * @returns { T } 22083 * @syscap SystemCapability.ArkUI.ArkUI.Full 22084 * @form 22085 * @since 9 22086 */ 22087 /** 22088 * Controls the display or hide of the current component. 22089 * 22090 * @param { Visibility } value 22091 * @returns { T } 22092 * @syscap SystemCapability.ArkUI.ArkUI.Full 22093 * @crossplatform 22094 * @form 22095 * @since 10 22096 */ 22097 /** 22098 * Controls the display or hide of the current component. 22099 * 22100 * @param { Visibility } value 22101 * @returns { T } 22102 * @syscap SystemCapability.ArkUI.ArkUI.Full 22103 * @crossplatform 22104 * @form 22105 * @atomicservice 22106 * @since 11 22107 */ 22108 visibility(value: Visibility): T; 22109 22110 /** 22111 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 22112 * 22113 * @param { number } value 22114 * @returns { T } 22115 * @syscap SystemCapability.ArkUI.ArkUI.Full 22116 * @since 7 22117 */ 22118 /** 22119 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 22120 * 22121 * @param { number } value 22122 * @returns { T } 22123 * @syscap SystemCapability.ArkUI.ArkUI.Full 22124 * @form 22125 * @since 9 22126 */ 22127 /** 22128 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 22129 * 22130 * @param { number } value 22131 * @returns { T } 22132 * @syscap SystemCapability.ArkUI.ArkUI.Full 22133 * @crossplatform 22134 * @form 22135 * @since 10 22136 */ 22137 /** 22138 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 22139 * 22140 * @param { number } value 22141 * @returns { T } 22142 * @syscap SystemCapability.ArkUI.ArkUI.Full 22143 * @crossplatform 22144 * @form 22145 * @atomicservice 22146 * @since 11 22147 */ 22148 flexGrow(value: number): T; 22149 22150 /** 22151 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 22152 * 22153 * @param { number } value 22154 * @returns { T } 22155 * @syscap SystemCapability.ArkUI.ArkUI.Full 22156 * @since 7 22157 */ 22158 /** 22159 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 22160 * 22161 * @param { number } value 22162 * @returns { T } 22163 * @syscap SystemCapability.ArkUI.ArkUI.Full 22164 * @form 22165 * @since 9 22166 */ 22167 /** 22168 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 22169 * 22170 * @param { number } value 22171 * @returns { T } 22172 * @syscap SystemCapability.ArkUI.ArkUI.Full 22173 * @crossplatform 22174 * @form 22175 * @since 10 22176 */ 22177 /** 22178 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 22179 * 22180 * @param { number } value 22181 * @returns { T } 22182 * @syscap SystemCapability.ArkUI.ArkUI.Full 22183 * @crossplatform 22184 * @form 22185 * @atomicservice 22186 * @since 11 22187 */ 22188 flexShrink(value: number): T; 22189 22190 /** 22191 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 22192 * 22193 * @param { number | string } value 22194 * @returns { T } 22195 * @syscap SystemCapability.ArkUI.ArkUI.Full 22196 * @since 7 22197 */ 22198 /** 22199 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 22200 * 22201 * @param { number | string } value 22202 * @returns { T } 22203 * @syscap SystemCapability.ArkUI.ArkUI.Full 22204 * @form 22205 * @since 9 22206 */ 22207 /** 22208 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 22209 * 22210 * @param { number | string } value 22211 * @returns { T } 22212 * @syscap SystemCapability.ArkUI.ArkUI.Full 22213 * @crossplatform 22214 * @form 22215 * @since 10 22216 */ 22217 /** 22218 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 22219 * 22220 * @param { number | string } value 22221 * @returns { T } 22222 * @syscap SystemCapability.ArkUI.ArkUI.Full 22223 * @crossplatform 22224 * @form 22225 * @atomicservice 22226 * @since 11 22227 */ 22228 flexBasis(value: number | string): T; 22229 22230 /** 22231 * Overrides the default configuration of alignItems in the Flex Layout container. 22232 * 22233 * @param { ItemAlign } value 22234 * @returns { T } 22235 * @syscap SystemCapability.ArkUI.ArkUI.Full 22236 * @since 7 22237 */ 22238 /** 22239 * Overrides the default configuration of alignItems in the Flex Layout container. 22240 * 22241 * @param { ItemAlign } value 22242 * @returns { T } 22243 * @syscap SystemCapability.ArkUI.ArkUI.Full 22244 * @form 22245 * @since 9 22246 */ 22247 /** 22248 * Overrides the default configuration of alignItems in the Flex Layout container. 22249 * 22250 * @param { ItemAlign } value 22251 * @returns { T } 22252 * @syscap SystemCapability.ArkUI.ArkUI.Full 22253 * @crossplatform 22254 * @form 22255 * @since 10 22256 */ 22257 /** 22258 * Overrides the default configuration of alignItems in the Flex Layout container. 22259 * 22260 * @param { ItemAlign } value 22261 * @returns { T } 22262 * @syscap SystemCapability.ArkUI.ArkUI.Full 22263 * @crossplatform 22264 * @form 22265 * @atomicservice 22266 * @since 11 22267 */ 22268 alignSelf(value: ItemAlign): T; 22269 22270 /** 22271 * 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. 22272 * 22273 * @param { number } value 22274 * @returns { T } 22275 * @syscap SystemCapability.ArkUI.ArkUI.Full 22276 * @since 7 22277 */ 22278 /** 22279 * 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. 22280 * 22281 * @param { number } value 22282 * @returns { T } 22283 * @syscap SystemCapability.ArkUI.ArkUI.Full 22284 * @form 22285 * @since 9 22286 */ 22287 /** 22288 * 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. 22289 * 22290 * @param { number } value 22291 * @returns { T } 22292 * @syscap SystemCapability.ArkUI.ArkUI.Full 22293 * @crossplatform 22294 * @form 22295 * @since 10 22296 */ 22297 /** 22298 * 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. 22299 * 22300 * @param { number } value 22301 * @returns { T } 22302 * @syscap SystemCapability.ArkUI.ArkUI.Full 22303 * @crossplatform 22304 * @form 22305 * @atomicservice 22306 * @since 11 22307 */ 22308 displayPriority(value: number): T; 22309 22310 /** 22311 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 22312 * 22313 * @param { number } value 22314 * @returns { T } 22315 * @syscap SystemCapability.ArkUI.ArkUI.Full 22316 * @since 7 22317 */ 22318 /** 22319 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 22320 * 22321 * @param { number } value 22322 * @returns { T } 22323 * @syscap SystemCapability.ArkUI.ArkUI.Full 22324 * @form 22325 * @since 9 22326 */ 22327 /** 22328 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 22329 * 22330 * @param { number } value 22331 * @returns { T } 22332 * @syscap SystemCapability.ArkUI.ArkUI.Full 22333 * @crossplatform 22334 * @form 22335 * @since 10 22336 */ 22337 /** 22338 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 22339 * 22340 * @param { number } value 22341 * @returns { T } 22342 * @syscap SystemCapability.ArkUI.ArkUI.Full 22343 * @crossplatform 22344 * @form 22345 * @atomicservice 22346 * @since 11 22347 */ 22348 zIndex(value: number): T; 22349 22350 /** 22351 * 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. 22352 * 22353 * @param { string } id 22354 * @param { sharedTransitionOptions } options 22355 * @returns { T } 22356 * @syscap SystemCapability.ArkUI.ArkUI.Full 22357 * @since 7 22358 */ 22359 /** 22360 * 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. 22361 * 22362 * @param { string } id 22363 * @param { sharedTransitionOptions } options 22364 * @returns { T } 22365 * @syscap SystemCapability.ArkUI.ArkUI.Full 22366 * @crossplatform 22367 * @since 10 22368 */ 22369 /** 22370 * 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. 22371 * 22372 * @param { string } id 22373 * @param { sharedTransitionOptions } options 22374 * @returns { T } 22375 * @syscap SystemCapability.ArkUI.ArkUI.Full 22376 * @crossplatform 22377 * @atomicservice 22378 * @since 11 22379 */ 22380 sharedTransition(id: string, options?: sharedTransitionOptions): T; 22381 22382 /** 22383 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 22384 * 22385 * @param { Direction } value 22386 * @returns { T } 22387 * @syscap SystemCapability.ArkUI.ArkUI.Full 22388 * @since 7 22389 */ 22390 /** 22391 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 22392 * 22393 * @param { Direction } value 22394 * @returns { T } 22395 * @syscap SystemCapability.ArkUI.ArkUI.Full 22396 * @form 22397 * @since 9 22398 */ 22399 /** 22400 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 22401 * 22402 * @param { Direction } value 22403 * @returns { T } 22404 * @syscap SystemCapability.ArkUI.ArkUI.Full 22405 * @crossplatform 22406 * @form 22407 * @since 10 22408 */ 22409 /** 22410 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 22411 * 22412 * @param { Direction } value 22413 * @returns { T } 22414 * @syscap SystemCapability.ArkUI.ArkUI.Full 22415 * @crossplatform 22416 * @form 22417 * @atomicservice 22418 * @since 11 22419 */ 22420 direction(value: Direction): T; 22421 22422 /** 22423 * align 22424 * 22425 * @param { Alignment } value 22426 * @returns { T } 22427 * @syscap SystemCapability.ArkUI.ArkUI.Full 22428 * @since 7 22429 */ 22430 /** 22431 * align 22432 * 22433 * @param { Alignment } value 22434 * @returns { T } 22435 * @syscap SystemCapability.ArkUI.ArkUI.Full 22436 * @form 22437 * @since 9 22438 */ 22439 /** 22440 * align 22441 * 22442 * @param { Alignment } value 22443 * @returns { T } 22444 * @syscap SystemCapability.ArkUI.ArkUI.Full 22445 * @crossplatform 22446 * @form 22447 * @since 10 22448 */ 22449 /** 22450 * align 22451 * 22452 * @param { Alignment } value 22453 * @returns { T } 22454 * @syscap SystemCapability.ArkUI.ArkUI.Full 22455 * @crossplatform 22456 * @form 22457 * @atomicservice 22458 * @since 11 22459 */ 22460 align(value: Alignment): T; 22461 22462 /** 22463 * position 22464 * 22465 * @param { Position } value 22466 * @returns { T } 22467 * @syscap SystemCapability.ArkUI.ArkUI.Full 22468 * @since 7 22469 */ 22470 /** 22471 * position 22472 * 22473 * @param { Position } value 22474 * @returns { T } 22475 * @syscap SystemCapability.ArkUI.ArkUI.Full 22476 * @form 22477 * @since 9 22478 */ 22479 /** 22480 * position 22481 * 22482 * @param { Position } value 22483 * @returns { T } 22484 * @syscap SystemCapability.ArkUI.ArkUI.Full 22485 * @crossplatform 22486 * @form 22487 * @since 10 22488 */ 22489 /** 22490 * position 22491 * 22492 * @param { Position } value 22493 * @returns { T } 22494 * @syscap SystemCapability.ArkUI.ArkUI.Full 22495 * @crossplatform 22496 * @form 22497 * @atomicservice 22498 * @since 11 22499 */ 22500 /** 22501 * position 22502 * 22503 * @param { Position | Edges | LocalizedEdges } value 22504 * @returns { T } 22505 * @syscap SystemCapability.ArkUI.ArkUI.Full 22506 * @crossplatform 22507 * @form 22508 * @atomicservice 22509 * @since 12 22510 */ 22511 position(value: Position | Edges | LocalizedEdges): T; 22512 22513 /** 22514 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 22515 * 22516 * @param { Position } value 22517 * @returns { T } 22518 * @syscap SystemCapability.ArkUI.ArkUI.Full 22519 * @since 7 22520 */ 22521 /** 22522 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 22523 * 22524 * @param { Position } value 22525 * @returns { T } 22526 * @syscap SystemCapability.ArkUI.ArkUI.Full 22527 * @form 22528 * @since 9 22529 */ 22530 /** 22531 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 22532 * 22533 * @param { Position } value 22534 * @returns { T } 22535 * @syscap SystemCapability.ArkUI.ArkUI.Full 22536 * @crossplatform 22537 * @form 22538 * @since 10 22539 */ 22540 /** 22541 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 22542 * 22543 * @param { Position } value 22544 * @returns { T } 22545 * @syscap SystemCapability.ArkUI.ArkUI.Full 22546 * @crossplatform 22547 * @form 22548 * @atomicservice 22549 * @since 11 22550 */ 22551 /** 22552 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 22553 * 22554 * @param { Position | LocalizedPosition} value 22555 * @returns { T } 22556 * @syscap SystemCapability.ArkUI.ArkUI.Full 22557 * @crossplatform 22558 * @form 22559 * @atomicservice 22560 * @since 12 22561 */ 22562 markAnchor(value: Position | LocalizedPosition): T; 22563 22564 /** 22565 * Coordinate offset relative to the layout completion position. 22566 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 22567 * 22568 * @param { Position } value 22569 * @returns { T } 22570 * @syscap SystemCapability.ArkUI.ArkUI.Full 22571 * @since 7 22572 */ 22573 /** 22574 * Coordinate offset relative to the layout completion position. 22575 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 22576 * 22577 * @param { Position } value 22578 * @returns { T } 22579 * @syscap SystemCapability.ArkUI.ArkUI.Full 22580 * @form 22581 * @since 9 22582 */ 22583 /** 22584 * Coordinate offset relative to the layout completion position. 22585 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 22586 * 22587 * @param { Position } value 22588 * @returns { T } 22589 * @syscap SystemCapability.ArkUI.ArkUI.Full 22590 * @crossplatform 22591 * @form 22592 * @since 10 22593 */ 22594 /** 22595 * Coordinate offset relative to the layout completion position. 22596 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 22597 * 22598 * @param { Position } value 22599 * @returns { T } 22600 * @syscap SystemCapability.ArkUI.ArkUI.Full 22601 * @crossplatform 22602 * @form 22603 * @atomicservice 22604 * @since 11 22605 */ 22606 /** 22607 * Coordinate offset relative to the layout completion position. 22608 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 22609 * 22610 * @param { Position | Edges | LocalizedEdges } value 22611 * @returns { T } 22612 * @syscap SystemCapability.ArkUI.ArkUI.Full 22613 * @crossplatform 22614 * @form 22615 * @atomicservice 22616 * @since 12 22617 */ 22618 offset(value: Position | Edges | LocalizedEdges): T; 22619 22620 /** 22621 * If the value is true, the component is available and can respond to operations such as clicking. 22622 * If it is set to false, click operations are not responded. 22623 * 22624 * @param { boolean } value 22625 * @returns { T } 22626 * @syscap SystemCapability.ArkUI.ArkUI.Full 22627 * @since 7 22628 */ 22629 /** 22630 * If the value is true, the component is available and can respond to operations such as clicking. 22631 * If it is set to false, click operations are not responded. 22632 * 22633 * @param { boolean } value 22634 * @returns { T } 22635 * @syscap SystemCapability.ArkUI.ArkUI.Full 22636 * @form 22637 * @since 9 22638 */ 22639 /** 22640 * If the value is true, the component is available and can respond to operations such as clicking. 22641 * If it is set to false, click operations are not responded. 22642 * 22643 * @param { boolean } value 22644 * @returns { T } 22645 * @syscap SystemCapability.ArkUI.ArkUI.Full 22646 * @crossplatform 22647 * @form 22648 * @since 10 22649 */ 22650 /** 22651 * If the value is true, the component is available and can respond to operations such as clicking. 22652 * If it is set to false, click operations are not responded. 22653 * 22654 * @param { boolean } value 22655 * @returns { T } 22656 * @syscap SystemCapability.ArkUI.ArkUI.Full 22657 * @crossplatform 22658 * @form 22659 * @atomicservice 22660 * @since 11 22661 */ 22662 enabled(value: boolean): T; 22663 22664 /** 22665 * Sets the number of occupied columns and offset columns for a specific device width type. 22666 * 22667 * @param { object } value 22668 * @returns { T } 22669 * @syscap SystemCapability.ArkUI.ArkUI.Full 22670 * @since 7 22671 * @deprecated since 9 22672 * @useinstead grid_col/GridColColumnOption and grid_row/GridRowColumnOption 22673 */ 22674 useSizeType(value: { 22675 xs?: number | { span: number; offset: number }; 22676 sm?: number | { span: number; offset: number }; 22677 md?: number | { span: number; offset: number }; 22678 lg?: number | { span: number; offset: number }; 22679 }): T; 22680 22681 /** 22682 * Specifies the alignRules of relative container 22683 * 22684 * @param { AlignRuleOption } value 22685 * @returns { T } 22686 * @syscap SystemCapability.ArkUI.ArkUI.Full 22687 * @form 22688 * @since 9 22689 */ 22690 /** 22691 * Specifies the alignRules of relative container 22692 * 22693 * @param { AlignRuleOption } value 22694 * @returns { T } 22695 * @syscap SystemCapability.ArkUI.ArkUI.Full 22696 * @crossplatform 22697 * @form 22698 * @since 10 22699 */ 22700 /** 22701 * Specifies the alignRules of relative container 22702 * 22703 * @param { AlignRuleOption } value 22704 * @returns { T } 22705 * @syscap SystemCapability.ArkUI.ArkUI.Full 22706 * @crossplatform 22707 * @form 22708 * @atomicservice 22709 * @since 11 22710 */ 22711 alignRules(value: AlignRuleOption): T; 22712 22713 /** 22714 * Specifies the localized alignRules of relative container 22715 * 22716 * @param { LocalizedAlignRuleOptions } alignRule 22717 * @returns { T } 22718 * @syscap SystemCapability.ArkUI.ArkUI.Full 22719 * @crossplatform 22720 * @form 22721 * @atomicservice 22722 * @since 12 22723 */ 22724 alignRules(alignRule: LocalizedAlignRuleOptions): T; 22725 22726 /** 22727 * Specifies the direction and style of chain in relative container 22728 * 22729 * @param { Axis } direction - indicates direction of the chain 22730 * @param { ChainStyle } style - indicates style of the chain 22731 * @returns { T } 22732 * @syscap SystemCapability.ArkUI.ArkUI.Full 22733 * @crossplatform 22734 * @atomicservice 22735 * @since 12 22736 */ 22737 chainMode(direction: Axis, style: ChainStyle): T; 22738 22739 /** 22740 * Specifies the aspect ratio of the current component. 22741 * 22742 * @param { number } value 22743 * @returns { T } 22744 * @syscap SystemCapability.ArkUI.ArkUI.Full 22745 * @since 7 22746 */ 22747 /** 22748 * Specifies the aspect ratio of the current component. 22749 * 22750 * @param { number } value 22751 * @returns { T } 22752 * @syscap SystemCapability.ArkUI.ArkUI.Full 22753 * @form 22754 * @since 9 22755 */ 22756 /** 22757 * Specifies the aspect ratio of the current component. 22758 * 22759 * @param { number } value 22760 * @returns { T } 22761 * @syscap SystemCapability.ArkUI.ArkUI.Full 22762 * @crossplatform 22763 * @form 22764 * @since 10 22765 */ 22766 /** 22767 * Specifies the aspect ratio of the current component. 22768 * 22769 * @param { number } value 22770 * @returns { T } 22771 * @syscap SystemCapability.ArkUI.ArkUI.Full 22772 * @crossplatform 22773 * @form 22774 * @atomicservice 22775 * @since 11 22776 */ 22777 aspectRatio(value: number): T; 22778 22779 /** 22780 * The click effect level and scale number. 22781 * 22782 * @param { ClickEffect | null } value 22783 * @returns { T } return the component attribute. 22784 * @syscap SystemCapability.ArkUI.ArkUI.Full 22785 * @crossplatform 22786 * @since 10 22787 */ 22788 /** 22789 * The click effect level and scale number. 22790 * 22791 * @param { ClickEffect | null } value 22792 * @returns { T } return the component attribute. 22793 * @syscap SystemCapability.ArkUI.ArkUI.Full 22794 * @crossplatform 22795 * @atomicservice 22796 * @since 11 22797 */ 22798 clickEffect(value: ClickEffect | null): T; 22799 22800 /** 22801 * The click effect level and scale number. 22802 * 22803 * @param { Optional<ClickEffect | null> } effect 22804 * @returns { T } return the component attribute. 22805 * @syscap SystemCapability.ArkUI.ArkUI.Full 22806 * @crossplatform 22807 * @atomicservice 22808 * @since 18 22809 */ 22810 clickEffect(effect: Optional<ClickEffect | null>): T; 22811 22812 /** 22813 * After a listener is bound, the component can be dragged. After the drag occurs, a callback is triggered. 22814 * (To be triggered, press and hold for 170 milliseconds (ms)) 22815 * 22816 * @param { function } event 22817 * @returns { T } 22818 * @syscap SystemCapability.ArkUI.ArkUI.Full 22819 * @since 8 22820 */ 22821 /** 22822 * After a listener is bound, the component can be dragged. After the drag occurs, a callback is triggered. 22823 * (To be triggered, press and hold for 170 milliseconds (ms)) 22824 * 22825 * @param { function } event 22826 * @returns { T } 22827 * @syscap SystemCapability.ArkUI.ArkUI.Full 22828 * @atomicservice 22829 * @since 11 22830 */ 22831 /** 22832 * After a listener is bound, the component can be dragged. After the drag occurs, a callback is triggered. 22833 * (To be triggered, press and hold for 170 milliseconds (ms)) 22834 * 22835 * @param { function } event 22836 * @returns { T } 22837 * @syscap SystemCapability.ArkUI.ArkUI.Full 22838 * @crossplatform 22839 * @atomicservice 22840 * @since 14 22841 */ 22842 onDragStart(event: (event: DragEvent, extraParams?: string) => CustomBuilder | DragItemInfo): T; 22843 22844 /** 22845 * After binding, a callback is triggered when the component is dragged to the range of the component. 22846 * 22847 * @param { function } event 22848 * @returns { T } 22849 * @syscap SystemCapability.ArkUI.ArkUI.Full 22850 * @since 8 22851 */ 22852 /** 22853 * After binding, a callback is triggered when the component is dragged to the range of the component. 22854 * 22855 * @param { function } event 22856 * @returns { T } 22857 * @syscap SystemCapability.ArkUI.ArkUI.Full 22858 * @atomicservice 22859 * @since 11 22860 */ 22861 /** 22862 * After binding, a callback is triggered when the component is dragged to the range of the component. 22863 * 22864 * @param { function } event 22865 * @returns { T } 22866 * @syscap SystemCapability.ArkUI.ArkUI.Full 22867 * @crossplatform 22868 * @atomicservice 22869 * @since 14 22870 */ 22871 onDragEnter(event: (event: DragEvent, extraParams?: string) => void): T; 22872 22873 /** 22874 * After binding, a callback is triggered when the drag moves within the range of a placeable component. 22875 * 22876 * @param { function } event 22877 * @returns { T } 22878 * @syscap SystemCapability.ArkUI.ArkUI.Full 22879 * @since 8 22880 */ 22881 /** 22882 * After binding, a callback is triggered when the drag moves within the range of a placeable component. 22883 * 22884 * @param { function } event 22885 * @returns { T } 22886 * @syscap SystemCapability.ArkUI.ArkUI.Full 22887 * @atomicservice 22888 * @since 11 22889 */ 22890 /** 22891 * After binding, a callback is triggered when the drag moves within the range of a placeable component. 22892 * 22893 * @param { function } event 22894 * @returns { T } 22895 * @syscap SystemCapability.ArkUI.ArkUI.Full 22896 * @crossplatform 22897 * @atomicservice 22898 * @since 14 22899 */ 22900 onDragMove(event: (event: DragEvent, extraParams?: string) => void): T; 22901 22902 /** 22903 * After binding, a callback is triggered when the component is dragged out of the component range. 22904 * 22905 * @param { function } event 22906 * @returns { T } 22907 * @syscap SystemCapability.ArkUI.ArkUI.Full 22908 * @since 8 22909 */ 22910 /** 22911 * After binding, a callback is triggered when the component is dragged out of the component range. 22912 * 22913 * @param { function } event 22914 * @returns { T } 22915 * @syscap SystemCapability.ArkUI.ArkUI.Full 22916 * @atomicservice 22917 * @since 11 22918 */ 22919 /** 22920 * After binding, a callback is triggered when the component is dragged out of the component range. 22921 * 22922 * @param { function } event 22923 * @returns { T } 22924 * @syscap SystemCapability.ArkUI.ArkUI.Full 22925 * @crossplatform 22926 * @atomicservice 22927 * @since 14 22928 */ 22929 onDragLeave(event: (event: DragEvent, extraParams?: string) => void): T; 22930 22931 /** 22932 * The component bound to this event can be used as the drag release target. 22933 * This callback is triggered when the drag behavior is stopped within the scope of the component. 22934 * 22935 * @param { function } event 22936 * @returns { T } 22937 * @syscap SystemCapability.ArkUI.ArkUI.Full 22938 * @since 8 22939 */ 22940 /** 22941 * The component bound to this event can be used as the drag release target. 22942 * This callback is triggered when the drag behavior is stopped within the scope of the component. 22943 * 22944 * @param { function } event 22945 * @returns { T } 22946 * @syscap SystemCapability.ArkUI.ArkUI.Full 22947 * @atomicservice 22948 * @since 11 22949 */ 22950 /** 22951 * The component bound to this event can be used as the drag release target. 22952 * This callback is triggered when the drag behavior is stopped within the scope of the component. 22953 * 22954 * @param { function } event 22955 * @returns { T } 22956 * @syscap SystemCapability.ArkUI.ArkUI.Full 22957 * @crossplatform 22958 * @atomicservice 22959 * @since 14 22960 */ 22961 onDrop(event: (event: DragEvent, extraParams?: string) => void): T; 22962 22963 /** 22964 * The component bound to this event can be used as the drag release target. 22965 * This callback is triggered when the drag behavior is stopped within the scope of the component. 22966 * 22967 * @param { OnDragEventCallback } eventCallback - event callback. 22968 * @param { DropOptions } [dropOptions] - the drop handling options. 22969 * @returns { T } 22970 * @syscap SystemCapability.ArkUI.ArkUI.Full 22971 * @crossplatform 22972 * @atomicservice 22973 * @since 15 22974 */ 22975 onDrop(eventCallback: OnDragEventCallback, dropOptions?: DropOptions): T; 22976 22977 /** 22978 * This function is called when the drag event is end. 22979 * 22980 * @param { function } event - indicates the function to be called. 22981 * @returns { T } property value of type T. 22982 * @syscap SystemCapability.ArkUI.ArkUI.Full 22983 * @since 10 22984 */ 22985 /** 22986 * This function is called when the drag event is end. 22987 * 22988 * @param { function } event - indicates the function to be called. 22989 * @returns { T } property value of type T. 22990 * @syscap SystemCapability.ArkUI.ArkUI.Full 22991 * @atomicservice 22992 * @since 11 22993 */ 22994 /** 22995 * This function is called when the drag event is end. 22996 * 22997 * @param { function } event - indicates the function to be called. 22998 * @returns { T } property value of type T. 22999 * @syscap SystemCapability.ArkUI.ArkUI.Full 23000 * @crossplatform 23001 * @atomicservice 23002 * @since 14 23003 */ 23004 onDragEnd(event: (event: DragEvent, extraParams?: string) => void): T; 23005 23006 /** 23007 * Allowed drop uniformData type for this node. 23008 * 23009 * @param { Array<UniformDataType> } value - the uniformData type for this node. 23010 * @returns { T } property value of type T. 23011 * @syscap SystemCapability.ArkUI.ArkUI.Full 23012 * @crossplatform 23013 * @since 10 23014 */ 23015 /** 23016 * Allowed drop uniformData type for this node. 23017 * 23018 * @param { Array<UniformDataType> } value - the uniformData type for this node. 23019 * @returns { T } property value of type T. 23020 * @syscap SystemCapability.ArkUI.ArkUI.Full 23021 * @crossplatform 23022 * @atomicservice 23023 * @since 11 23024 */ 23025 /** 23026 * Allowed drop uniformData type for this node. 23027 * 23028 * @param { Array<UniformDataType> | null } value - the uniformData type for this node. 23029 * @returns { T } property value of type T. 23030 * @syscap SystemCapability.ArkUI.ArkUI.Full 23031 * @crossplatform 23032 * @atomicservice 23033 * @since 12 23034 */ 23035 allowDrop(value: Array<UniformDataType> | null): T; 23036 23037 /** 23038 * Enable the selectable area can be dragged. 23039 * 23040 * @param { boolean } value - true means the area can be dragged, false means the area can't be dragged. 23041 * @returns { T } property value of type T. 23042 * @syscap SystemCapability.ArkUI.ArkUI.Full 23043 * @since 10 23044 */ 23045 /** 23046 * Enable the selectable area can be dragged. 23047 * 23048 * @param { boolean } value - true means the area can be dragged, false means the area can't be dragged. 23049 * @returns { T } property value of type T. 23050 * @syscap SystemCapability.ArkUI.ArkUI.Full 23051 * @crossplatform 23052 * @atomicservice 23053 * @since 11 23054 */ 23055 draggable(value: boolean): T; 23056 23057 /** 23058 * Set preview of the component for dragging process 23059 * 23060 * @param { CustomBuilder | DragItemInfo } value - preview of the component for dragging process 23061 * @returns { T } property value of type T. 23062 * @syscap SystemCapability.ArkUI.ArkUI.Full 23063 * @since 11 23064 */ 23065 /** 23066 * Set preview of the component for dragging process 23067 * 23068 * @param { CustomBuilder | DragItemInfo | string } value - preview of the component for dragging process 23069 * @returns { T } property value of type T. 23070 * @syscap SystemCapability.ArkUI.ArkUI.Full 23071 * @atomicservice 23072 * @since 12 23073 */ 23074 dragPreview(value: CustomBuilder | DragItemInfo | string): T; 23075 23076 /** 23077 * Set preview of the component for dragging process 23078 * 23079 * @param { CustomBuilder | DragItemInfo | string } preview - preview of the component for dragging process 23080 * @param { PreviewConfiguration } config - drag preview configuration. 23081 * @returns { T } property value of type T. 23082 * @syscap SystemCapability.ArkUI.ArkUI.Full 23083 * @atomicservice 23084 * @since 15 23085 */ 23086 dragPreview(preview: CustomBuilder | DragItemInfo | string, config?: PreviewConfiguration): T; 23087 23088 /** 23089 * Set the selectable area drag preview options. 23090 * 23091 * @param { DragPreviewOptions } value - preview options value. 23092 * @returns { T } property value of type T. 23093 * @syscap SystemCapability.ArkUI.ArkUI.Full 23094 * @since 11 23095 */ 23096 /** 23097 * Set the selectable area drag preview options. 23098 * 23099 * @param { DragPreviewOptions } value - preview options value. 23100 * @param { DragInteractionOptions } options - drag interaction options value. 23101 * @returns { T } property value of type T. 23102 * @syscap SystemCapability.ArkUI.ArkUI.Full 23103 * @atomicservice 23104 * @since 12 23105 */ 23106 dragPreviewOptions(value: DragPreviewOptions, options?: DragInteractionOptions): T; 23107 23108 /** 23109 * After binding, a callback is triggered when the preDrag status change finished. 23110 * 23111 * @param { Callback<PreDragStatus> } callback callback - The callback will be triggered when the preDrag status change. 23112 * @returns { T } property value of type T. 23113 * @syscap SystemCapability.ArkUI.ArkUI.Full 23114 * @atomicservice 23115 * @since 12 23116 */ 23117 onPreDrag(callback: Callback<PreDragStatus>): T; 23118 23119 /** 23120 * Add mask text to the current component. The layout is the same as that of the current component. 23121 * 23122 * @param { string } value 23123 * @param { object } options 23124 * @returns { T } 23125 * @syscap SystemCapability.ArkUI.ArkUI.Full 23126 * @since 7 23127 */ 23128 /** 23129 * Add mask text to the current component. The layout is the same as that of the current component. 23130 * 23131 * @param { string } value 23132 * @param { object } options 23133 * @returns { T } 23134 * @syscap SystemCapability.ArkUI.ArkUI.Full 23135 * @form 23136 * @since 9 23137 */ 23138 /** 23139 * Add mask text to the current component. The layout is the same as that of the current component. 23140 * 23141 * @param { string | CustomBuilder } value 23142 * @param { object } options 23143 * @returns { T } 23144 * @syscap SystemCapability.ArkUI.ArkUI.Full 23145 * @crossplatform 23146 * @form 23147 * @since 10 23148 */ 23149 /** 23150 * Add mask text to the current component. The layout is the same as that of the current component. 23151 * 23152 * @param { string | CustomBuilder } value 23153 * @param { object } options 23154 * @returns { T } 23155 * @syscap SystemCapability.ArkUI.ArkUI.Full 23156 * @crossplatform 23157 * @form 23158 * @atomicservice 23159 * @since 11 23160 */ 23161 /** 23162 * Add mask text to the current component. The layout is the same as that of the current component. 23163 * 23164 * @param { string | CustomBuilder | ComponentContent } value 23165 * @param { OverlayOptions } options 23166 * @returns { T } 23167 * @syscap SystemCapability.ArkUI.ArkUI.Full 23168 * @crossplatform 23169 * @form 23170 * @atomicservice 23171 * @since 12 23172 */ 23173 overlay(value: string | CustomBuilder | ComponentContent, options?: OverlayOptions): T; 23174 23175 /** 23176 * Linear Gradient 23177 * angle: Angle of Linear Gradient. The default value is 180; 23178 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 23179 * colors: Color description for gradients. 23180 * repeating: repeating. The default value is false 23181 * 23182 * @param { object } value 23183 * @returns { T } 23184 * @syscap SystemCapability.ArkUI.ArkUI.Full 23185 * @since 7 23186 */ 23187 /** 23188 * Linear Gradient 23189 * angle: Angle of Linear Gradient. The default value is 180; 23190 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 23191 * colors: Color description for gradients. 23192 * repeating: repeating. The default value is false 23193 * 23194 * @param { object } value 23195 * @returns { T } 23196 * @syscap SystemCapability.ArkUI.ArkUI.Full 23197 * @form 23198 * @since 9 23199 */ 23200 /** 23201 * Linear Gradient 23202 * angle: Angle of Linear Gradient. The default value is 180; 23203 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 23204 * colors: Color description for gradients. 23205 * repeating: repeating. The default value is false 23206 * 23207 * @param { object } value 23208 * @returns { T } 23209 * @syscap SystemCapability.ArkUI.ArkUI.Full 23210 * @crossplatform 23211 * @form 23212 * @since 10 23213 */ 23214 /** 23215 * Linear Gradient 23216 * angle: Angle of Linear Gradient. The default value is 180; 23217 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 23218 * colors: Color description for gradients. 23219 * repeating: repeating. The default value is false 23220 * 23221 * @param { object } value 23222 * @returns { T } 23223 * @syscap SystemCapability.ArkUI.ArkUI.Full 23224 * @crossplatform 23225 * @form 23226 * @atomicservice 23227 * @since 11 23228 */ 23229 /** 23230 * Linear Gradient 23231 * angle: Angle of Linear Gradient; direction:Direction of Linear Gradient; colors:Color description for gradients,repeating:repeating. 23232 * 23233 * @param { object } value 23234 * @returns { T } 23235 * @syscap SystemCapability.ArkUI.ArkUI.Full 23236 * @crossplatform 23237 * @form 23238 * @atomicservice 23239 * @since 12 23240 */ 23241 /** 23242 * Linear Gradient 23243 * angle: Angle of Linear Gradient. The default value is 180; 23244 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 23245 * colors: Color description for gradients. 23246 * repeating: repeating. The default value is false 23247 * 23248 * Anonymous Object Rectification. 23249 * @param { LinearGradientOptions } value 23250 * @returns { T } 23251 * @syscap SystemCapability.ArkUI.ArkUI.Full 23252 * @crossplatform 23253 * @form 23254 * @atomicservice 23255 * @since 18 23256 */ 23257 linearGradient(value: LinearGradientOptions): T; 23258 23259 /** 23260 * Linear Gradient 23261 * angle: Angle of Linear Gradient. The default value is 180; 23262 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 23263 * colors: Color description for gradients. 23264 * repeating: repeating. The default value is false 23265 * 23266 * @param { Optional<LinearGradientOptions> } options 23267 * @returns { T } 23268 * @syscap SystemCapability.ArkUI.ArkUI.Full 23269 * @crossplatform 23270 * @form 23271 * @atomicservice 23272 * @since 18 23273 */ 23274 linearGradient(options: Optional<LinearGradientOptions>): T; 23275 23276 /** 23277 * Angle Gradient 23278 * center:is the center point of the angle gradient 23279 * start:Start point of angle gradient. The default value is 0 23280 * end:End point of angle gradient. The default value is 0 23281 * number:number 23282 * rotating:rotating. The default value is 0 23283 * colors:Color description for gradients 23284 * repeating:repeating. The default value is false 23285 * 23286 * @param { object } value 23287 * @returns { T } 23288 * @syscap SystemCapability.ArkUI.ArkUI.Full 23289 * @since 7 23290 */ 23291 /** 23292 * Angle Gradient 23293 * center:is the center point of the angle gradient 23294 * start:Start point of angle gradient. The default value is 0 23295 * end:End point of angle gradient. The default value is 0 23296 * number:number 23297 * rotating:rotating. The default value is 0 23298 * colors:Color description for gradients 23299 * repeating:repeating. The default value is false 23300 * 23301 * @param { object } value 23302 * @returns { T } 23303 * @syscap SystemCapability.ArkUI.ArkUI.Full 23304 * @form 23305 * @since 9 23306 */ 23307 /** 23308 * Angle Gradient 23309 * center:is the center point of the angle gradient 23310 * start:Start point of angle gradient. The default value is 0 23311 * end:End point of angle gradient. The default value is 0 23312 * number:number 23313 * rotating:rotating. The default value is 0 23314 * colors:Color description for gradients 23315 * repeating:repeating. The default value is false 23316 * 23317 * @param { object } value 23318 * @returns { T } 23319 * @syscap SystemCapability.ArkUI.ArkUI.Full 23320 * @crossplatform 23321 * @form 23322 * @since 10 23323 */ 23324 /** 23325 * Angle Gradient 23326 * center:is the center point of the angle gradient 23327 * start:Start point of angle gradient. The default value is 0 23328 * end:End point of angle gradient. The default value is 0 23329 * number:number 23330 * rotating:rotating. The default value is 0 23331 * colors:Color description for gradients 23332 * repeating:repeating. The default value is false 23333 * 23334 * @param { object } value 23335 * @returns { T } 23336 * @syscap SystemCapability.ArkUI.ArkUI.Full 23337 * @crossplatform 23338 * @form 23339 * @atomicservice 23340 * @since 11 23341 */ 23342 /** 23343 * Angle Gradient 23344 * center:is the center point of the angle gradient 23345 * start:Start point of angle gradient 23346 * end:End point of angle gradient 23347 * number:number 23348 * rotating:rotating 23349 * colors:Color description for gradients 23350 * repeating:repeating 23351 * 23352 * @param { object } value 23353 * @returns { T } 23354 * @syscap SystemCapability.ArkUI.ArkUI.Full 23355 * @crossplatform 23356 * @form 23357 * @atomicservice 23358 * @since 12 23359 */ 23360 /** 23361 * Angle Gradient 23362 * center:is the center point of the angle gradient 23363 * start:Start point of angle gradient. The default value is 0 23364 * end:End point of angle gradient. The default value is 0 23365 * rotating:rotating. The default value is 0 23366 * colors:Color description for gradients 23367 * repeating:repeating. The default value is false 23368 * 23369 * Anonymous Object Rectification. 23370 * @param { SweepGradientOptions } value 23371 * @returns { T } 23372 * @syscap SystemCapability.ArkUI.ArkUI.Full 23373 * @crossplatform 23374 * @form 23375 * @atomicservice 23376 * @since 18 23377 */ 23378 sweepGradient(value: SweepGradientOptions): T; 23379 23380 /** 23381 * Angle Gradient 23382 * center:is the center point of the angle gradient 23383 * start:Start point of angle gradient. The default value is 0 23384 * end:End point of angle gradient. The default value is 0 23385 * rotating:rotating. The default value is 0 23386 * colors:Color description for gradients 23387 * repeating:repeating. The default value is false 23388 * 23389 * @param { Optional<SweepGradientOptions> } options 23390 * @returns { T } 23391 * @syscap SystemCapability.ArkUI.ArkUI.Full 23392 * @crossplatform 23393 * @form 23394 * @atomicservice 23395 * @since 18 23396 */ 23397 sweepGradient(options: Optional<SweepGradientOptions>): T; 23398 23399 /** 23400 * Radial Gradient 23401 * center:Center point of radial gradient 23402 * radius:Radius of Radial Gradient. value range [0, +∞) 23403 * colors:Color description for gradients 23404 * repeating: Refill. The default value is false 23405 * 23406 * @param { object } value 23407 * @returns { T } 23408 * @syscap SystemCapability.ArkUI.ArkUI.Full 23409 * @since 7 23410 */ 23411 /** 23412 * Radial Gradient 23413 * center:Center point of radial gradient 23414 * radius:Radius of Radial Gradient. value range [0, +∞) 23415 * colors:Color description for gradients 23416 * repeating: Refill. The default value is false 23417 * 23418 * @param { object } value 23419 * @returns { T } 23420 * @syscap SystemCapability.ArkUI.ArkUI.Full 23421 * @form 23422 * @since 9 23423 */ 23424 /** 23425 * Radial Gradient 23426 * center:Center point of radial gradient 23427 * radius:Radius of Radial Gradient. value range [0, +∞) 23428 * colors:Color description for gradients 23429 * repeating: Refill. The default value is false 23430 * 23431 * @param { object } value 23432 * @returns { T } 23433 * @syscap SystemCapability.ArkUI.ArkUI.Full 23434 * @crossplatform 23435 * @form 23436 * @since 10 23437 */ 23438 /** 23439 * Radial Gradient 23440 * center:Center point of radial gradient 23441 * radius:Radius of Radial Gradient. value range [0, +∞) 23442 * colors:Color description for gradients 23443 * repeating: Refill. The default value is false 23444 * 23445 * @param { object } value 23446 * @returns { T } 23447 * @syscap SystemCapability.ArkUI.ArkUI.Full 23448 * @crossplatform 23449 * @form 23450 * @atomicservice 23451 * @since 11 23452 */ 23453 /** 23454 * Radial Gradient 23455 * center:Center point of radial gradient 23456 * radius:Radius of Radial Gradient 23457 * colors:Color description for gradients 23458 * repeating: Refill 23459 * 23460 * @param { object } value 23461 * @returns { T } 23462 * @syscap SystemCapability.ArkUI.ArkUI.Full 23463 * @crossplatform 23464 * @form 23465 * @atomicservice 23466 * @since 12 23467 */ 23468 /** 23469 * Radial Gradient 23470 * center:Center point of radial gradient 23471 * radius:Radius of Radial Gradient. value range [0, +∞) 23472 * colors:Color description for gradients 23473 * repeating: Refill. The default value is false 23474 * 23475 * Anonymous Object Rectification. 23476 * @param { RadialGradientOptions } value 23477 * @returns { T } 23478 * @syscap SystemCapability.ArkUI.ArkUI.Full 23479 * @crossplatform 23480 * @form 23481 * @atomicservice 23482 * @since 18 23483 */ 23484 radialGradient(value: RadialGradientOptions): T; 23485 23486 /** 23487 * Radial Gradient 23488 * center:Center point of radial gradient 23489 * radius:Radius of Radial Gradient. value range [0, +∞) 23490 * colors:Color description for gradients 23491 * repeating: Refill. The default value is false 23492 * 23493 * @param { Optional<RadialGradientOptions> } options 23494 * @returns { T } 23495 * @syscap SystemCapability.ArkUI.ArkUI.Full 23496 * @crossplatform 23497 * @form 23498 * @atomicservice 23499 * @since 18 23500 */ 23501 radialGradient(options: Optional<RadialGradientOptions>): T; 23502 23503 /** 23504 * Set the motion path of the component 23505 * path:Motion path for displacement animation, using the svg path string. 23506 * from:Start point of the motion path. The default value is 0.0. 23507 * to:End point of the motion path. The default value is 1.0. 23508 * rotatable:Whether to follow the path for rotation. 23509 * 23510 * @param { MotionPathOptions } value 23511 * @returns { T } 23512 * @syscap SystemCapability.ArkUI.ArkUI.Full 23513 * @since 7 23514 */ 23515 /** 23516 * Set the motion path of the component 23517 * path:Motion path for displacement animation, using the svg path string. 23518 * from:Start point of the motion path. The default value is 0.0. 23519 * to:End point of the motion path. The default value is 1.0. 23520 * rotatable:Whether to follow the path for rotation. 23521 * 23522 * @param { MotionPathOptions } value 23523 * @returns { T } 23524 * @syscap SystemCapability.ArkUI.ArkUI.Full 23525 * @crossplatform 23526 * @since 10 23527 */ 23528 /** 23529 * Set the motion path of the component 23530 * path:Motion path for displacement animation, using the svg path string. 23531 * from:Start point of the motion path. The default value is 0.0. 23532 * to:End point of the motion path. The default value is 1.0. 23533 * rotatable:Whether to follow the path for rotation. 23534 * 23535 * @param { MotionPathOptions } value 23536 * @returns { T } 23537 * @syscap SystemCapability.ArkUI.ArkUI.Full 23538 * @crossplatform 23539 * @atomicservice 23540 * @since 11 23541 */ 23542 motionPath(value: MotionPathOptions): T; 23543 23544 /** 23545 * Add a shadow effect to the current component 23546 * 23547 * @param { ShadowOptions } value 23548 * @returns { T } 23549 * @syscap SystemCapability.ArkUI.ArkUI.Full 23550 * @since 7 23551 */ 23552 /** 23553 * Add a shadow effect to the current component 23554 * 23555 * @param { ShadowOptions } value 23556 * @returns { T } 23557 * @syscap SystemCapability.ArkUI.ArkUI.Full 23558 * @form 23559 * @since 9 23560 */ 23561 /** 23562 * Add a shadow effect to the current component 23563 * 23564 * @param { ShadowOptions | ShadowStyle } value 23565 * @returns { T } 23566 * @syscap SystemCapability.ArkUI.ArkUI.Full 23567 * @crossplatform 23568 * @form 23569 * @since 10 23570 */ 23571 /** 23572 * Add a shadow effect to the current component 23573 * 23574 * @param { ShadowOptions | ShadowStyle } value 23575 * @returns { T } 23576 * @syscap SystemCapability.ArkUI.ArkUI.Full 23577 * @crossplatform 23578 * @form 23579 * @atomicservice 23580 * @since 11 23581 */ 23582 shadow(value: ShadowOptions | ShadowStyle): T; 23583 23584 /** 23585 * Add a shadow effect to the current component 23586 * 23587 * @param { Optional<ShadowOptions | ShadowStyle> } options 23588 * @returns { T } 23589 * @syscap SystemCapability.ArkUI.ArkUI.Full 23590 * @crossplatform 23591 * @form 23592 * @atomicservice 23593 * @since 18 23594 */ 23595 shadow(options: Optional<ShadowOptions | ShadowStyle>): T; 23596 23597 /** 23598 * Add a blendMode effect to the current component 23599 * 23600 * @param { BlendMode } value - Different hybrid modes 23601 * @param { BlendApplyType } [type] - Different blend apply type 23602 * @returns { T } 23603 * @syscap SystemCapability.ArkUI.ArkUI.Full 23604 * @crossplatform 23605 * @form 23606 * @since 11 23607 */ 23608 /** 23609 * Add a blendMode effect to the current component 23610 * 23611 * @param { BlendMode } value - Different hybrid modes 23612 * @param { BlendApplyType } [type] - Different blend apply type 23613 * @returns { T } 23614 * @syscap SystemCapability.ArkUI.ArkUI.Full 23615 * @crossplatform 23616 * @form 23617 * @atomicservice 23618 * @since 12 23619 */ 23620 blendMode(value: BlendMode, type?: BlendApplyType): T; 23621 23622 /** 23623 * Add a blendMode effect to the current component 23624 * 23625 * @param { Optional<BlendMode> } mode - Different hybrid modes 23626 * @param { BlendApplyType } [type] - Different blend apply type 23627 * @returns { T } 23628 * @syscap SystemCapability.ArkUI.ArkUI.Full 23629 * @crossplatform 23630 * @form 23631 * @atomicservice 23632 * @since 18 23633 */ 23634 blendMode(mode: Optional<BlendMode>, type?: BlendApplyType): T; 23635 23636 /** 23637 * Add a blendMode effect to the current component.Cannot be used together with the blendMode interface. 23638 * 23639 * @param { BlendMode | Blender } effect - When the effect type is BlendMode type, define Different hybrid modes. 23640 * When the effect type is Blender type, Define the corresponding blending effect. 23641 * @param { BlendApplyType } [type] - Different blend apply type 23642 * @returns { T } 23643 * @syscap SystemCapability.ArkUI.ArkUI.Full 23644 * @systemapi 23645 * @form 23646 * @since 13 23647 */ 23648 advancedBlendMode(effect: BlendMode | Blender, type?: BlendApplyType): T; 23649 23650 /** 23651 * Whether to crop the sub components beyond the current component range. 23652 * 23653 * @param { boolean } value 23654 * @returns { T } 23655 * @syscap SystemCapability.ArkUI.ArkUI.Full 23656 * @crossplatform 23657 * @form 23658 * @atomicservice 23659 * @since 12 23660 */ 23661 clip(value: boolean): T; 23662 23663 /** 23664 * Whether to crop the sub components beyond the current component range. 23665 * 23666 * @param { Optional<boolean> } clip 23667 * @returns { T } 23668 * @syscap SystemCapability.ArkUI.ArkUI.Full 23669 * @crossplatform 23670 * @form 23671 * @atomicservice 23672 * @since 18 23673 */ 23674 clip(clip: Optional<boolean>): T; 23675 23676 /** 23677 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 23678 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 23679 * 23680 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value 23681 * @returns { T } 23682 * @syscap SystemCapability.ArkUI.ArkUI.Full 23683 * @since 7 23684 */ 23685 /** 23686 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 23687 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 23688 * 23689 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value 23690 * @returns { T } 23691 * @syscap SystemCapability.ArkUI.ArkUI.Full 23692 * @form 23693 * @since 9 23694 */ 23695 /** 23696 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 23697 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 23698 * 23699 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value 23700 * @returns { T } 23701 * @syscap SystemCapability.ArkUI.ArkUI.Full 23702 * @crossplatform 23703 * @form 23704 * @since 10 23705 */ 23706 /** 23707 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 23708 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 23709 * 23710 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value 23711 * @returns { T } 23712 * @syscap SystemCapability.ArkUI.ArkUI.Full 23713 * @crossplatform 23714 * @form 23715 * @atomicservice 23716 * @since 11 23717 * @deprecated since 12 23718 * @useinstead CommonMethod#clipShape 23719 */ 23720 clip(value: boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute): T; 23721 23722 /** 23723 * The current component is cropped according to the specified shape. 23724 * 23725 * @param { CircleShape | EllipseShape | PathShape | RectShape } value - indicates the shape of the clip. 23726 * @returns { T } 23727 * @syscap SystemCapability.ArkUI.ArkUI.Full 23728 * @crossplatform 23729 * @form 23730 * @atomicservice 23731 * @since 12 23732 */ 23733 clipShape(value: CircleShape | EllipseShape | PathShape | RectShape): T; 23734 23735 /** 23736 * The current component is cropped according to the specified shape. 23737 * 23738 * @param { Optional<CircleShape | EllipseShape | PathShape | RectShape> } shape - indicates the shape of the clip. 23739 * @returns { T } 23740 * @syscap SystemCapability.ArkUI.ArkUI.Full 23741 * @crossplatform 23742 * @form 23743 * @atomicservice 23744 * @since 18 23745 */ 23746 clipShape(shape: Optional<CircleShape | EllipseShape | PathShape | RectShape>): T; 23747 23748 /** 23749 * Sets the mask of the current component. 23750 * 23751 * @param { ProgressMask } value 23752 * @returns { T } 23753 * @syscap SystemCapability.ArkUI.ArkUI.Full 23754 * @crossplatform 23755 * @atomicservice 23756 * @since 12 23757 */ 23758 mask(value: ProgressMask): T; 23759 23760 /** 23761 * Sets the mask of the current component. 23762 * 23763 * @param { Optional<ProgressMask> } mask 23764 * @returns { T } 23765 * @syscap SystemCapability.ArkUI.ArkUI.Full 23766 * @crossplatform 23767 * @atomicservice 23768 * @since 18 23769 */ 23770 mask(mask: Optional<ProgressMask>): T; 23771 23772 /** 23773 * Applies a mask of the specified shape to the current assembly. 23774 * 23775 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value 23776 * @returns { T } 23777 * @syscap SystemCapability.ArkUI.ArkUI.Full 23778 * @since 7 23779 */ 23780 /** 23781 * Applies a mask of the specified shape to the current assembly. 23782 * 23783 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value - indicates the shape of the mask. 23784 * @returns { T } 23785 * @syscap SystemCapability.ArkUI.ArkUI.Full 23786 * @form 23787 * @since 9 23788 */ 23789 /** 23790 * Applies a mask of the specified shape to the current assembly. 23791 * 23792 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value - indicates the shape of the mask. 23793 * @returns { T } 23794 * @syscap SystemCapability.ArkUI.ArkUI.Full 23795 * @crossplatform 23796 * @form 23797 * @since 10 23798 */ 23799 /** 23800 * Applies a mask of the specified shape to the current assembly. 23801 * 23802 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value - indicates the shape of the mask. 23803 * @returns { T } 23804 * @syscap SystemCapability.ArkUI.ArkUI.Full 23805 * @crossplatform 23806 * @form 23807 * @atomicservice 23808 * @since 11 23809 * @deprecated since 12 23810 * @useinstead CommonMethod#maskShape 23811 */ 23812 mask(value: CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask): T; 23813 23814 /** 23815 * Applies a mask of the specified shape to the current assembly. 23816 * 23817 * @param { CircleShape | EllipseShape | PathShape | RectShape } value - indicates the shape of the mask. 23818 * @returns { T } 23819 * @syscap SystemCapability.ArkUI.ArkUI.Full 23820 * @crossplatform 23821 * @form 23822 * @atomicservice 23823 * @since 12 23824 */ 23825 maskShape(value: CircleShape | EllipseShape | PathShape | RectShape): T; 23826 23827 /** 23828 * Applies a mask of the specified shape to the current assembly. 23829 * 23830 * @param { Optional<CircleShape | EllipseShape | PathShape | RectShape> } shape - indicates the shape of the mask. 23831 * @returns { T } 23832 * @syscap SystemCapability.ArkUI.ArkUI.Full 23833 * @crossplatform 23834 * @form 23835 * @atomicservice 23836 * @since 18 23837 */ 23838 maskShape(shape: Optional<CircleShape | EllipseShape | PathShape | RectShape>): T; 23839 23840 /** 23841 * Key. User can set an key to the component to identify it. 23842 * 23843 * @param { string } value 23844 * @returns { T } 23845 * @syscap SystemCapability.ArkUI.ArkUI.Full 23846 * @atomicservice 23847 * @since 12 23848 * @test 23849 */ 23850 key(value: string): T; 23851 23852 /** 23853 * Id. User can set an id to the component to identify it. 23854 * 23855 * @param { string } value 23856 * @returns { T } 23857 * @syscap SystemCapability.ArkUI.ArkUI.Full 23858 * @since 8 23859 */ 23860 /** 23861 * Id. User can set an id to the component to identify it. 23862 * 23863 * @param { string } value 23864 * @returns { T } 23865 * @syscap SystemCapability.ArkUI.ArkUI.Full 23866 * @form 23867 * @since 9 23868 */ 23869 /** 23870 * Id. User can set an id to the component to identify it. 23871 * 23872 * @param { string } value 23873 * @returns { T } 23874 * @syscap SystemCapability.ArkUI.ArkUI.Full 23875 * @crossplatform 23876 * @form 23877 * @since 10 23878 */ 23879 /** 23880 * Id. User can set an id to the component to identify it. 23881 * 23882 * @param { string } value 23883 * @returns { T } 23884 * @syscap SystemCapability.ArkUI.ArkUI.Full 23885 * @crossplatform 23886 * @form 23887 * @atomicservice 23888 * @since 11 23889 */ 23890 id(value: string): T; 23891 23892 /** 23893 * geometryTransition 23894 * 23895 * @param { string } id 23896 * @returns { T } 23897 * @syscap SystemCapability.ArkUI.ArkUI.Full 23898 * @since 7 23899 */ 23900 /** 23901 * geometryTransition 23902 * 23903 * @param { string } id 23904 * @returns { T } 23905 * @syscap SystemCapability.ArkUI.ArkUI.Full 23906 * @crossplatform 23907 * @since 10 23908 */ 23909 /** 23910 * geometryTransition 23911 * 23912 * @param { string } id 23913 * @returns { T } 23914 * @syscap SystemCapability.ArkUI.ArkUI.Full 23915 * @crossplatform 23916 * @atomicservice 23917 * @since 11 23918 */ 23919 geometryTransition(id: string): T; 23920 /** 23921 * Shared geometry transition 23922 * 23923 * @param { string } id - geometry transition id 23924 * @param { GeometryTransitionOptions } options - Indicates the options of geometry transition. 23925 * @returns { T } 23926 * @syscap SystemCapability.ArkUI.ArkUI.Full 23927 * @crossplatform 23928 * @since 11 23929 */ 23930 /** 23931 * Shared geometry transition 23932 * 23933 * @param { string } id - geometry transition id 23934 * @param { GeometryTransitionOptions } options - Indicates the options of geometry transition. 23935 * @returns { T } 23936 * @syscap SystemCapability.ArkUI.ArkUI.Full 23937 * @crossplatform 23938 * @atomicservice 23939 * @since 12 23940 */ 23941 geometryTransition(id: string, options?: GeometryTransitionOptions): T; 23942 23943 /** 23944 * Popup control 23945 * 23946 * @param { boolean } show 23947 * @param { PopupOptions } popup 23948 * @returns { T } 23949 * @syscap SystemCapability.ArkUI.ArkUI.Full 23950 * @since 7 23951 */ 23952 /** 23953 * Popup control 23954 * 23955 * @param { boolean } show 23956 * @param { PopupOptions | CustomPopupOptions } popup 23957 * @returns { T } 23958 * @syscap SystemCapability.ArkUI.ArkUI.Full 23959 * @since 8 23960 */ 23961 /** 23962 * Popup control 23963 * 23964 * @param { boolean } show 23965 * @param { PopupOptions | CustomPopupOptions } popup 23966 * @returns { T } 23967 * @syscap SystemCapability.ArkUI.ArkUI.Full 23968 * @crossplatform 23969 * @atomicservice 23970 * @since 11 23971 */ 23972 bindPopup(show: boolean, popup: PopupOptions | CustomPopupOptions): T; 23973 23974 /** 23975 * Menu control 23976 * 23977 * @param { { value: ResourceStr; icon?: ResourceStr; action: () => void }[] | CustomBuilder } content 23978 * action: () => void }[] | CustomBuilder } content - Indicates the content of menu. 23979 * @param { MenuOptions } options 23980 * @returns { T } 23981 * @syscap SystemCapability.ArkUI.ArkUI.Full 23982 * @since 7 23983 */ 23984 /** 23985 * Menu control 23986 * 23987 * @param { { value: ResourceStr; icon?: ResourceStr; action: () => void }[] | CustomBuilder } content 23988 * action: () => void }[] | CustomBuilder } content - Indicates the content of menu. 23989 * @param { MenuOptions } options - Indicates the options of menu. 23990 * @returns { T } 23991 * @syscap SystemCapability.ArkUI.ArkUI.Full 23992 * @crossplatform 23993 * @since 10 23994 */ 23995 /** 23996 * Menu control 23997 * 23998 * @param { Array<MenuElement> | CustomBuilder } content - Indicates the content of menu. 23999 * @param { MenuOptions } options - Indicates the options of menu. 24000 * @returns { T } 24001 * @syscap SystemCapability.ArkUI.ArkUI.Full 24002 * @crossplatform 24003 * @atomicservice 24004 * @since 11 24005 */ 24006 bindMenu(content: Array<MenuElement> | CustomBuilder, options?: MenuOptions): T; 24007 24008 /** 24009 * Menu control 24010 * 24011 * @param { boolean } isShow true means display menu, false means hide menu. 24012 * @param { Array<MenuElement> | CustomBuilder } content - Indicates the content of menu. 24013 * @param { MenuOptions } options - Indicates the options of menu. 24014 * @returns { T } 24015 * @syscap SystemCapability.ArkUI.ArkUI.Full 24016 * @crossplatform 24017 * @since 11 24018 */ 24019 /** 24020 * Menu control 24021 * 24022 * @param { boolean } isShow true means display menu, false means hide menu. 24023 * @param { Array<MenuElement> | CustomBuilder } content - Indicates the content of menu. 24024 * @param { MenuOptions } options - Indicates the options of menu. 24025 * @returns { T } 24026 * @syscap SystemCapability.ArkUI.ArkUI.Full 24027 * @crossplatform 24028 * @atomicservice 24029 * @since 12 24030 */ 24031 bindMenu(isShow: boolean, content: Array<MenuElement> | CustomBuilder, options?: MenuOptions): T; 24032 24033 /** 24034 * ContextMenu control 24035 * 24036 * @param { CustomBuilder } content 24037 * @param { ResponseType } responseType 24038 * @param { ContextMenuOptions } options 24039 * @returns { T } 24040 * @syscap SystemCapability.ArkUI.ArkUI.Full 24041 * @since 8 24042 */ 24043 /** 24044 * ContextMenu control 24045 * 24046 * @param { CustomBuilder } content - Indicates the content of context menu. 24047 * @param { ResponseType } responseType - Indicates response type of context menu. 24048 * @param { ContextMenuOptions } options - Indicates the options of context menu. 24049 * @returns { T } 24050 * @syscap SystemCapability.ArkUI.ArkUI.Full 24051 * @crossplatform 24052 * @since 10 24053 */ 24054 /** 24055 * ContextMenu control 24056 * 24057 * @param { CustomBuilder } content - Indicates the content of context menu. 24058 * @param { ResponseType } responseType - Indicates response type of context menu. 24059 * @param { ContextMenuOptions } options - Indicates the options of context menu. 24060 * @returns { T } 24061 * @syscap SystemCapability.ArkUI.ArkUI.Full 24062 * @crossplatform 24063 * @atomicservice 24064 * @since 11 24065 */ 24066 bindContextMenu(content: CustomBuilder, responseType: ResponseType, options?: ContextMenuOptions): T; 24067 24068 /** 24069 * ContextMenu control 24070 * 24071 * @param { boolean } isShown - true means display content, false means hide content. 24072 * @param { CustomBuilder } content - Indicates the content of context menu. 24073 * @param { ContextMenuOptions } [options] - Indicates the options of context menu. 24074 * @returns { T } 24075 * @syscap SystemCapability.ArkUI.ArkUI.Full 24076 * @crossplatform 24077 * @atomicservice 24078 * @since 12 24079 */ 24080 bindContextMenu(isShown: boolean, content: CustomBuilder, options?: ContextMenuOptions): T; 24081 24082 /** 24083 * Bind content cover 24084 * 24085 * @param { boolean } isShow - true means display content, false means hide content. 24086 * @param { CustomBuilder } builder - the content to be displayed. 24087 * @param { ModalTransition } type - transition type. 24088 * @returns { T } 24089 * @syscap SystemCapability.ArkUI.ArkUI.Full 24090 * @crossplatform 24091 * @since 10 24092 */ 24093 /** 24094 * Bind content cover 24095 * 24096 * @param { boolean } isShow - true means display content, false means hide content. 24097 * @param { CustomBuilder } builder - the content to be displayed. 24098 * @param { ModalTransition } type - transition type. 24099 * @returns { T } 24100 * @syscap SystemCapability.ArkUI.ArkUI.Full 24101 * @crossplatform 24102 * @atomicservice 24103 * @since 11 24104 */ 24105 bindContentCover(isShow: boolean, builder: CustomBuilder, type?: ModalTransition): T; 24106 24107 /** 24108 * Bind content cover 24109 * 24110 * @param { boolean } isShow - true means display content, false means hide content. 24111 * @param { CustomBuilder } builder - the content to be displayed. 24112 * @param { ContentCoverOptions } options - options of content cover. 24113 * @returns { T } 24114 * @syscap SystemCapability.ArkUI.ArkUI.Full 24115 * @crossplatform 24116 * @since 10 24117 */ 24118 /** 24119 * Bind content cover 24120 * 24121 * @param { boolean } isShow - true means display content, false means hide content. 24122 * @param { CustomBuilder } builder - the content to be displayed. 24123 * @param { ContentCoverOptions } options - options of content cover. 24124 * @returns { T } 24125 * @syscap SystemCapability.ArkUI.ArkUI.Full 24126 * @crossplatform 24127 * @atomicservice 24128 * @since 11 24129 */ 24130 bindContentCover(isShow: boolean, builder: CustomBuilder, options?: ContentCoverOptions): T; 24131 24132 /** 24133 * Bind sheet 24134 * 24135 * @param { boolean } isShow - true means display sheet, false means hide sheet. 24136 * @param { CustomBuilder } builder - the sheet to be displayed. 24137 * @param { SheetOptions } options - options of sheet. 24138 * @returns { T } - template type 24139 * @syscap SystemCapability.ArkUI.ArkUI.Full 24140 * @crossplatform 24141 * @since 10 24142 */ 24143 /** 24144 * Bind sheet 24145 * 24146 * @param { boolean } isShow - true means display sheet, false means hide sheet. 24147 * @param { CustomBuilder } builder - the sheet to be displayed. 24148 * @param { SheetOptions } options - options of sheet. 24149 * @returns { T } - template type 24150 * @syscap SystemCapability.ArkUI.ArkUI.Full 24151 * @crossplatform 24152 * @atomicservice 24153 * @since 11 24154 */ 24155 bindSheet(isShow: boolean, builder: CustomBuilder, options?: SheetOptions): T; 24156 24157 /** 24158 * Sets styles for component state. 24159 * 24160 * @param { StateStyles } value 24161 * @returns { T } 24162 * @syscap SystemCapability.ArkUI.ArkUI.Full 24163 * @since 8 24164 */ 24165 /** 24166 * Sets styles for component state. 24167 * 24168 * @param { StateStyles } value 24169 * @returns { T } 24170 * @syscap SystemCapability.ArkUI.ArkUI.Full 24171 * @form 24172 * @since 9 24173 */ 24174 /** 24175 * Sets styles for component state. 24176 * 24177 * @param { StateStyles } value 24178 * @returns { T } 24179 * @syscap SystemCapability.ArkUI.ArkUI.Full 24180 * @crossplatform 24181 * @form 24182 * @since 10 24183 */ 24184 /** 24185 * Sets styles for component state. 24186 * 24187 * @param { StateStyles } value 24188 * @returns { T } 24189 * @syscap SystemCapability.ArkUI.ArkUI.Full 24190 * @crossplatform 24191 * @form 24192 * @atomicservice 24193 * @since 11 24194 */ 24195 stateStyles(value: StateStyles): T; 24196 24197 /** 24198 * id for distribute identification. 24199 * 24200 * @param { number } value 24201 * @returns { T } 24202 * @syscap SystemCapability.ArkUI.ArkUI.Full 24203 * @since 8 24204 */ 24205 /** 24206 * id for distribute identification. 24207 * 24208 * @param { number } value 24209 * @returns { T } 24210 * @syscap SystemCapability.ArkUI.ArkUI.Full 24211 * @crossplatform 24212 * @atomicservice 24213 * @since 11 24214 */ 24215 restoreId(value: number): T; 24216 24217 /** 24218 * Trigger a visible area change event. 24219 * 24220 * @param { Array<number> } ratios 24221 * @param { function } event 24222 * @returns { T } 24223 * @syscap SystemCapability.ArkUI.ArkUI.Full 24224 * @since 9 24225 */ 24226 /** 24227 * Trigger a visible area change event. 24228 * 24229 * @param { Array<number> } ratios 24230 * @param { function } event 24231 * @returns { T } 24232 * @syscap SystemCapability.ArkUI.ArkUI.Full 24233 * @crossplatform 24234 * @since 10 24235 */ 24236 /** 24237 * Trigger a visible area change event. 24238 * 24239 * @param { Array<number> } ratios 24240 * @param { function } event 24241 * @returns { T } 24242 * @syscap SystemCapability.ArkUI.ArkUI.Full 24243 * @crossplatform 24244 * @atomicservice 24245 * @since 11 24246 */ 24247 /** 24248 * Trigger a visible area change event. 24249 * 24250 * @param { Array<number> } ratios 24251 * @param { VisibleAreaChangeCallback } event 24252 * @returns { T } 24253 * @syscap SystemCapability.ArkUI.ArkUI.Full 24254 * @crossplatform 24255 * @atomicservice 24256 * @since 13 24257 */ 24258 onVisibleAreaChange(ratios: Array<number>, event: VisibleAreaChangeCallback): T; 24259 24260 24261 /** 24262 * Set or reset the callback which is triggered when the visibleArea of component changed. 24263 * The interval between two visible area change callbacks will not be less than the expected update interval. 24264 * 24265 * @param { VisibleAreaEventOptions } options - The options for the visibility event. 24266 * @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. 24267 * If set undefined will reset the target callback. 24268 * @syscap SystemCapability.ArkUI.ArkUI.Full 24269 * @crossplatform 24270 * @atomicservice 24271 * @since 17 24272 */ 24273 onVisibleAreaApproximateChange(options: VisibleAreaEventOptions, event: VisibleAreaChangeCallback | undefined): void; 24274 24275 /** 24276 * Set the spherical effect of the component. 24277 * 24278 * @param { number } value - set the degree of spherical effect, value range [0, 1]. 24279 * If the value is 0, the component keep same, else the value is 1, component are fully spherical. 24280 * @returns { T } 24281 * @syscap SystemCapability.ArkUI.ArkUI.Full 24282 * @crossplatform 24283 * @atomicservice 24284 * @since 12 24285 */ 24286 sphericalEffect(value: number): T; 24287 24288 /** 24289 * Set the spherical effect of the component. 24290 * 24291 * @param { Optional<number> } effect - set the degree of spherical effect, value range [0, 1]. 24292 * If the value is 0, the component keep same, else the value is 1, component are fully spherical. 24293 * @returns { T } 24294 * @syscap SystemCapability.ArkUI.ArkUI.Full 24295 * @crossplatform 24296 * @atomicservice 24297 * @since 18 24298 */ 24299 sphericalEffect(effect: Optional<number>): T; 24300 24301 /** 24302 * Set the light up effect of the component 24303 * 24304 * @param { number } value - set the degree to which the component lights up, value range [0, 1]. 24305 * The color brightness in the component rendering content area is greater than the value and can be displayed, otherwise it will not be displayed. 24306 * @returns { T } 24307 * @syscap SystemCapability.ArkUI.ArkUI.Full 24308 * @crossplatform 24309 * @atomicservice 24310 * @since 12 24311 */ 24312 lightUpEffect(value: number): T; 24313 24314 /** 24315 * Set the light up effect of the component 24316 * 24317 * @param { Optional<number> } degree - set the degree to which the component lights up, value range [0, 1]. 24318 * The color brightness in the component rendering content area is greater than the value and can be displayed, otherwise it will not be displayed. 24319 * @returns { T } 24320 * @syscap SystemCapability.ArkUI.ArkUI.Full 24321 * @crossplatform 24322 * @atomicservice 24323 * @since 18 24324 */ 24325 lightUpEffect(degree: Optional<number>): T; 24326 24327 /** 24328 * Set the edge pixel stretch effect of the Component. 24329 * 24330 * @param { PixelStretchEffectOptions } options 24331 * @returns { T } 24332 * @syscap SystemCapability.ArkUI.ArkUI.Full 24333 * @crossplatform 24334 * @atomicservice 24335 * @since 12 24336 */ 24337 pixelStretchEffect(options: PixelStretchEffectOptions): T; 24338 24339 /** 24340 * Set the edge pixel stretch effect of the Component. 24341 * 24342 * @param { Optional<PixelStretchEffectOptions> } options 24343 * @returns { T } 24344 * @syscap SystemCapability.ArkUI.ArkUI.Full 24345 * @crossplatform 24346 * @atomicservice 24347 * @since 18 24348 */ 24349 pixelStretchEffect(options: Optional<PixelStretchEffectOptions>): T; 24350 24351 /** 24352 * Sets hot keys 24353 * 24354 * @param { string | FunctionKey } value - Character of the combination key. 24355 * @param { Array<ModifierKey> } keys - The modifier keys modify the action of key when the key are pressed at the same time. 24356 * @param { function } [action] - Callback function, triggered when the shortcut keyboard is pressed. 24357 * @returns { T } 24358 * @syscap SystemCapability.ArkUI.ArkUI.Full 24359 * @crossplatform 24360 * @since 10 24361 */ 24362 /** 24363 * Sets hot keys 24364 * 24365 * @param { string | FunctionKey } value - Character of the combination key. 24366 * @param { Array<ModifierKey> } keys - The modifier keys modify the action of key when the key are pressed at the same time. 24367 * @param { function } [action] - Callback function, triggered when the shortcut keyboard is pressed. 24368 * @returns { T } 24369 * @syscap SystemCapability.ArkUI.ArkUI.Full 24370 * @crossplatform 24371 * @atomicservice 24372 * @since 11 24373 */ 24374 keyboardShortcut(value: string | FunctionKey, keys: Array<ModifierKey>, action?: () => void): T; 24375 24376 /** 24377 * Sets accessibilityGroup 24378 * 24379 * @param { boolean } value - set group with accessibility 24380 * @returns { T } 24381 * @syscap SystemCapability.ArkUI.ArkUI.Full 24382 * @crossplatform 24383 * @since 10 24384 */ 24385 /** 24386 * Sets accessibilityGroup 24387 * 24388 * @param { boolean } value - set group with accessibility 24389 * @returns { T } 24390 * @syscap SystemCapability.ArkUI.ArkUI.Full 24391 * @crossplatform 24392 * @atomicservice 24393 * @since 11 24394 */ 24395 /** 24396 * Sets accessibilityGroup 24397 * 24398 * @param { boolean } value - set group with accessibility 24399 * @returns { T } 24400 * @syscap SystemCapability.ArkUI.ArkUI.Full 24401 * @crossplatform 24402 * @form 24403 * @atomicservice 24404 * @since 12 24405 */ 24406 accessibilityGroup(value: boolean): T; 24407 24408 /** 24409 * Sets accessibilityGroup 24410 * 24411 * @param { boolean } isGroup - set group with accessibility 24412 * @param { AccessibilityOptions } accessibilityOptions - accessibilityOptions for accessibility 24413 * @returns { T } 24414 * @syscap SystemCapability.ArkUI.ArkUI.Full 24415 * @crossplatform 24416 * @form 24417 * @atomicservice 24418 * @since 14 24419 */ 24420 accessibilityGroup(isGroup: boolean, accessibilityOptions: AccessibilityOptions): T; 24421 24422 /** 24423 * Sets accessibilityText 24424 * 24425 * @param { string } value - set accessibility text 24426 * @returns { T } 24427 * @syscap SystemCapability.ArkUI.ArkUI.Full 24428 * @crossplatform 24429 * @since 10 24430 */ 24431 /** 24432 * Sets accessibilityText 24433 * 24434 * @param { string } value - set accessibility text 24435 * @returns { T } 24436 * @syscap SystemCapability.ArkUI.ArkUI.Full 24437 * @crossplatform 24438 * @atomicservice 24439 * @since 11 24440 */ 24441 /** 24442 * Sets accessibilityText 24443 * 24444 * @param { string } value - set accessibility text 24445 * @returns { T } 24446 * @syscap SystemCapability.ArkUI.ArkUI.Full 24447 * @crossplatform 24448 * @form 24449 * @atomicservice 24450 * @since 12 24451 */ 24452 accessibilityText(value: string): T; 24453 24454 /** 24455 * Sets accessibility next focus id 24456 * @param { string } nextId - set component next accessibility focus id 24457 * @returns { T } 24458 * @syscap SystemCapability.ArkUI.ArkUI.Full 24459 * @crossplatform 24460 * @form 24461 * @atomicservice 24462 * @since 18 24463 */ 24464 accessibilityNextFocusId(nextId: string): T; 24465 24466 /** 24467 * Sets the accessibility default foucs flag 24468 * @param { boolean } focus - if the component is accessibility default focus,focus set true 24469 * @returns { T } 24470 * @syscap SystemCapability.ArkUI.ArkUI.Full 24471 * @crossplatform 24472 * @form 24473 * @atomicservice 24474 * @since 18 24475 */ 24476 accessibilityDefaultFocus(focus: boolean): T; 24477 24478 /** 24479 * Sets accessibility same page mode 24480 * @param { AccessibilitySamePageMode } pageMode - accessibility same page mode 24481 * @returns { T } 24482 * @syscap SystemCapability.ArkUI.ArkUI.Full 24483 * @crossplatform 24484 * @form 24485 * @atomicservice 24486 * @since 18 24487 */ 24488 accessibilityUseSamePage(pageMode: AccessibilitySamePageMode): T; 24489 24490 /** 24491 * Sets accessibilityScrollTriggerable 24492 * @param { boolean } isTriggerable - set property of supporting scroll in accessibility 24493 * @returns { T } 24494 * @syscap SystemCapability.ArkUI.ArkUI.Full 24495 * @crossplatform 24496 * @form 24497 * @atomicservice 24498 * @since 18 24499 */ 24500 accessibilityScrollTriggerable(isTriggerable: boolean): T; 24501 24502 /** 24503 * Sets accessibilityText 24504 * 24505 * @param { Resource } text - set accessibility text 24506 * @returns { T } 24507 * @syscap SystemCapability.ArkUI.ArkUI.Full 24508 * @crossplatform 24509 * @form 24510 * @atomicservice 24511 * @since 12 24512 */ 24513 accessibilityText(text: Resource): T; 24514 24515 /** 24516 * Sets accessibility role,role indicates the custom type of the component 24517 * @param { AccessibilityRoleType } role - set accessibility component type 24518 * @returns { T } 24519 * @syscap SystemCapability.ArkUI.ArkUI.Full 24520 * @crossplatform 24521 * @form 24522 * @atomicservice 24523 * @since 18 24524 */ 24525 accessibilityRole(role: AccessibilityRoleType): T; 24526 24527 /** 24528 * Register accessibility focus callback,when the component is focused or out of focus,the callback will be executed 24529 * @param { AccessibilityFocusCallback } callback - accessibility focus callback function 24530 * @returns { T } 24531 * @syscap SystemCapability.ArkUI.ArkUI.Full 24532 * @crossplatform 24533 * @form 24534 * @atomicservice 24535 * @since 18 24536 */ 24537 onAccessibilityFocus(callback: AccessibilityFocusCallback): T; 24538 24539 /** 24540 * Sets accessibilityTextHint 24541 * 24542 * @param { string } value - set accessibility text hint 24543 * @returns { T } 24544 * @syscap SystemCapability.ArkUI.ArkUI.Full 24545 * @crossplatform 24546 * @form 24547 * @atomicservice 24548 * @since 12 24549 */ 24550 accessibilityTextHint(value: string): T; 24551 24552 /** 24553 * Sets accessibilityDescription 24554 * 24555 * @param { string } value - set description of accessibility 24556 * @returns { T } 24557 * @syscap SystemCapability.ArkUI.ArkUI.Full 24558 * @crossplatform 24559 * @since 10 24560 */ 24561 /** 24562 * Sets accessibilityDescription 24563 * 24564 * @param { string } value - set description of accessibility 24565 * @returns { T } 24566 * @syscap SystemCapability.ArkUI.ArkUI.Full 24567 * @crossplatform 24568 * @atomicservice 24569 * @since 11 24570 */ 24571 /** 24572 * Sets accessibilityDescription 24573 * 24574 * @param { string } value - set description of accessibility 24575 * @returns { T } 24576 * @syscap SystemCapability.ArkUI.ArkUI.Full 24577 * @crossplatform 24578 * @form 24579 * @atomicservice 24580 * @since 12 24581 */ 24582 accessibilityDescription(value: string): T; 24583 24584 /** 24585 * Sets accessibilityDescription 24586 * 24587 * @param { Resource } description - set description of accessibility 24588 * @returns { T } 24589 * @syscap SystemCapability.ArkUI.ArkUI.Full 24590 * @crossplatform 24591 * @form 24592 * @atomicservice 24593 * @since 12 24594 */ 24595 accessibilityDescription(description: Resource): T; 24596 24597 /** 24598 * Sets accessibilityLevel 24599 * 24600 * @param { string } value - set accessibility level 24601 * @returns { T } 24602 * @syscap SystemCapability.ArkUI.ArkUI.Full 24603 * @crossplatform 24604 * @since 10 24605 */ 24606 /** 24607 * Sets accessibilityLevel 24608 * 24609 * @param { string } value - set accessibility level 24610 * @returns { T } 24611 * @syscap SystemCapability.ArkUI.ArkUI.Full 24612 * @crossplatform 24613 * @atomicservice 24614 * @since 11 24615 */ 24616 /** 24617 * Sets accessibilityLevel 24618 * 24619 * @param { string } value - set accessibility level 24620 * @returns { T } 24621 * @syscap SystemCapability.ArkUI.ArkUI.Full 24622 * @crossplatform 24623 * @form 24624 * @atomicservice 24625 * @since 12 24626 */ 24627 accessibilityLevel(value: string): T; 24628 24629 /** 24630 * Sets accessibilityVirtualNode 24631 * 24632 * @param { CustomBuilder } builder - set virtual node of accessibility 24633 * @returns { T } 24634 * @syscap SystemCapability.ArkUI.ArkUI.Full 24635 * @crossplatform 24636 * @atomicservice 24637 * @since 11 24638 */ 24639 /** 24640 * Sets accessibilityVirtualNode 24641 * 24642 * @param { CustomBuilder } builder - set virtual node of accessibility 24643 * @returns { T } 24644 * @syscap SystemCapability.ArkUI.ArkUI.Full 24645 * @crossplatform 24646 * @form 24647 * @atomicservice 24648 * @since 12 24649 */ 24650 accessibilityVirtualNode(builder: CustomBuilder): T; 24651 24652 /** 24653 * Sets accessibilityChecked 24654 * 24655 * @param { boolean } isCheck - set accessibility checked status 24656 * @returns { T } 24657 * @syscap SystemCapability.ArkUI.ArkUI.Full 24658 * @crossplatform 24659 * @form 24660 * @atomicservice 24661 * @since 13 24662 */ 24663 accessibilityChecked(isCheck: boolean): T; 24664 24665 /** 24666 * Sets accessibilitySelected 24667 * 24668 * @param { boolean } isSelect - set accessibility selected status 24669 * @returns { T } 24670 * @syscap SystemCapability.ArkUI.ArkUI.Full 24671 * @crossplatform 24672 * @form 24673 * @atomicservice 24674 * @since 13 24675 */ 24676 accessibilitySelected(isSelect: boolean): T; 24677 24678 /** 24679 * Sets obscured 24680 * 24681 * @param { Array<ObscuredReasons> } reasons - reasons of obscuration 24682 * @returns { T } 24683 * @syscap SystemCapability.ArkUI.ArkUI.Full 24684 * @crossplatform 24685 * @since 10 24686 */ 24687 /** 24688 * Sets obscured 24689 * 24690 * @param { Array<ObscuredReasons> } reasons - reasons of obscuration 24691 * @returns { T } 24692 * @syscap SystemCapability.ArkUI.ArkUI.Full 24693 * @crossplatform 24694 * @atomicservice 24695 * @since 11 24696 */ 24697 obscured(reasons: Array<ObscuredReasons>): T; 24698 24699 /** 24700 * Reuse id is used for identify the reuse type for each custom node. 24701 * 24702 * @param { string } id - The id for reusable custom node. 24703 * @returns { T } 24704 * @syscap SystemCapability.ArkUI.ArkUI.Full 24705 * @crossplatform 24706 * @since 10 24707 */ 24708 /** 24709 * Reuse id is used for identify the reuse type for each custom node. 24710 * 24711 * @param { string } id - The id for reusable custom node. 24712 * @returns { T } 24713 * @syscap SystemCapability.ArkUI.ArkUI.Full 24714 * @crossplatform 24715 * @atomicservice 24716 * @since 11 24717 */ 24718 reuseId(id: string): T; 24719 24720 /** 24721 * Reuse id is used for identify the reuse type of each @ComponentV2 custom component, which can give user control of sub-component recycle and reuse. 24722 * 24723 * @param { ReuseOptions } options - The configuration parameter for reusable custom component. 24724 * @returns { T } 24725 * @syscap SystemCapability.ArkUI.ArkUI.Full 24726 * @crossplatform 24727 * @atomicservice 24728 * @since 18 24729 */ 24730 reuse(options: ReuseOptions): T; 24731 24732 /** 24733 * Sets how content is drawn within nodes duration animation 24734 * 24735 * @param { RenderFit } fitMode - The render fit mode of content. 24736 * @returns { T } 24737 * @syscap SystemCapability.ArkUI.ArkUI.Full 24738 * @crossplatform 24739 * @since 10 24740 */ 24741 /** 24742 * Sets how content is drawn within nodes duration animation 24743 * 24744 * @param { RenderFit } fitMode - The render fit mode of content. 24745 * @returns { T } 24746 * @syscap SystemCapability.ArkUI.ArkUI.Full 24747 * @crossplatform 24748 * @atomicservice 24749 * @since 11 24750 */ 24751 /** 24752 * Sets how content is drawn within nodes duration animation 24753 * 24754 * @param { RenderFit } fitMode - The render fit mode of content. 24755 * @returns { T } 24756 * @syscap SystemCapability.ArkUI.ArkUI.Full 24757 * @crossplatform 24758 * @form 24759 * @atomicservice 24760 * @since 18 24761 */ 24762 renderFit(fitMode: RenderFit): T; 24763 24764 /** 24765 * Sets how content is drawn within nodes during animation 24766 * 24767 * @param { Optional<RenderFit> } fitMode - The render fit mode of content. 24768 * @returns { T } 24769 * @syscap SystemCapability.ArkUI.ArkUI.Full 24770 * @crossplatform 24771 * @form 24772 * @atomicservice 24773 * @since 18 24774 */ 24775 renderFit(fitMode: Optional<RenderFit>): T; 24776 24777 /** 24778 * Sets the attribute modifier. 24779 * 24780 * @param { AttributeModifier<T> } modifier 24781 * @returns { T } 24782 * @syscap SystemCapability.ArkUI.ArkUI.Full 24783 * @crossplatform 24784 * @since 11 24785 */ 24786 /** 24787 * Sets the attribute modifier. 24788 * 24789 * @param { AttributeModifier<T> } modifier 24790 * @returns { T } 24791 * @syscap SystemCapability.ArkUI.ArkUI.Full 24792 * @crossplatform 24793 * @atomicservice 24794 * @since 12 24795 */ 24796 attributeModifier(modifier: AttributeModifier<T>): T; 24797 24798 /** 24799 * Sets the gesture modifier. 24800 * 24801 * @param { GestureModifier } modifier 24802 * @returns { T } 24803 * @syscap SystemCapability.ArkUI.ArkUI.Full 24804 * @crossplatform 24805 * @atomicservice 24806 * @since 12 24807 */ 24808 gestureModifier(modifier: GestureModifier): T; 24809 24810 /** 24811 * Adds a background dynamic light up effect to the current component. 24812 * 24813 * @param { BackgroundBrightnessOptions } params - params indicates BackgroundBrightnessOptions 24814 * @returns { T } 24815 * @syscap SystemCapability.ArkUI.ArkUI.Full 24816 * @atomicservice 24817 * @since 12 24818 */ 24819 backgroundBrightness(params: BackgroundBrightnessOptions): T; 24820 24821 /** 24822 * Adds a background dynamic light up effect to the current component. 24823 * 24824 * @param { Optional<BackgroundBrightnessOptions> } options - params indicates BackgroundBrightnessOptions 24825 * @returns { T } 24826 * @syscap SystemCapability.ArkUI.ArkUI.Full 24827 * @atomicservice 24828 * @since 18 24829 */ 24830 backgroundBrightness(options: Optional<BackgroundBrightnessOptions>): T; 24831 24832 /** 24833 * When a gesture bound to this component will be accepted, a user-defined callback is triggered to get the result 24834 * 24835 * @param { function } callback - A callback instance used when a gesture bound to this component will be accepted. 24836 * @returns { T } 24837 * @syscap SystemCapability.ArkUI.ArkUI.Full 24838 * @crossplatform 24839 * @since 11 24840 */ 24841 /** 24842 * When a gesture bound to this component will be accepted, a user-defined callback is triggered to get the result 24843 * 24844 * @param { function } callback - A callback instance used when a gesture bound to this component will be accepted. 24845 * @returns { T } 24846 * @syscap SystemCapability.ArkUI.ArkUI.Full 24847 * @crossplatform 24848 * @atomicservice 24849 * @since 12 24850 */ 24851 onGestureJudgeBegin(callback: (gestureInfo: GestureInfo, event: BaseGestureEvent) => GestureJudgeResult): T; 24852 24853 /** 24854 * When a gesture bound to this component will be accepted, a user-defined callback is triggered to get the result 24855 * 24856 * @param { GestureRecognizerJudgeBeginCallback } callback - A callback instance used when a gesture bound to this component will be accepted. 24857 * @returns { T } 24858 * @syscap SystemCapability.ArkUI.ArkUI.Full 24859 * @crossplatform 24860 * @atomicservice 24861 * @since 12 24862 */ 24863 onGestureRecognizerJudgeBegin(callback: GestureRecognizerJudgeBeginCallback): T; 24864 24865 /** 24866 * When a gesture bound to this component will be accepted, a user-defined callback is triggered to get the result 24867 * 24868 * @param { GestureRecognizerJudgeBeginCallback } callback - A callback instance used when a gesture bound to this component will be accepted. 24869 * @param { boolean } exposeInnerGesture - This parameter is a flag. This flag determines whether to expose internal gestures. 24870 * @returns { T } 24871 * @syscap SystemCapability.ArkUI.ArkUI.Full 24872 * @crossplatform 24873 * @atomicservice 24874 * 24875 * @since 13 24876 */ 24877 onGestureRecognizerJudgeBegin(callback: GestureRecognizerJudgeBeginCallback, exposeInnerGesture: boolean): T; 24878 24879 /** 24880 * In the touch test phase, the recognizer is selected to form a parallel relationship with other recognizers on the response chain. 24881 * 24882 * @param { ShouldBuiltInRecognizerParallelWithCallback } callback - A callback instance used when a component is doing touch test. 24883 * @returns { T } 24884 * @syscap SystemCapability.ArkUI.ArkUI.Full 24885 * @crossplatform 24886 * @atomicservice 24887 * @since 12 24888 */ 24889 shouldBuiltInRecognizerParallelWith(callback: ShouldBuiltInRecognizerParallelWithCallback): T; 24890 24891 /** 24892 * Events are monopolized by components. 24893 * 24894 * @param { boolean } monopolize - indicate the monopoly of events 24895 * @returns { T } 24896 * @syscap SystemCapability.ArkUI.ArkUI.Full 24897 * @crossplatform 24898 * @since 11 24899 */ 24900 /** 24901 * Events are monopolized by components. 24902 * 24903 * @param { boolean } monopolize - indicate the monopoly of events 24904 * @returns { T } 24905 * @syscap SystemCapability.ArkUI.ArkUI.Full 24906 * @crossplatform 24907 * @atomicservice 24908 * @since 12 24909 */ 24910 monopolizeEvents(monopolize: boolean): T; 24911 24912 /** 24913 * When the component does a touch test, a user-defined callback is triggered. 24914 * 24915 * @param { Callback<TouchEvent, HitTestMode> } callback - A callback instance used when the component does a touch test. 24916 * @returns { T } 24917 * @syscap SystemCapability.ArkUI.ArkUI.Full 24918 * @crossplatform 24919 * @atomicservice 24920 * @since 12 24921 */ 24922 onTouchIntercept(callback: Callback<TouchEvent, HitTestMode>): T; 24923 24924 /** 24925 * This callback is triggered when the size of this component change finished. 24926 * 24927 * @param { SizeChangeCallback } event - event callback. 24928 * @returns { T } 24929 * @syscap SystemCapability.ArkUI.ArkUI.Full 24930 * @crossplatform 24931 * @form 24932 * @atomicservice 24933 * @since 12 24934 */ 24935 onSizeChange(event: SizeChangeCallback): T; 24936} 24937 24938/** 24939 * CommonAttribute for ide. 24940 * 24941 * @extends CommonMethod<CommonAttribute> 24942 * @syscap SystemCapability.ArkUI.ArkUI.Full 24943 * @since 7 24944 */ 24945/** 24946 * CommonAttribute for ide. 24947 * 24948 * @extends CommonMethod<CommonAttribute> 24949 * @syscap SystemCapability.ArkUI.ArkUI.Full 24950 * @form 24951 * @since 9 24952 */ 24953/** 24954 * CommonAttribute for ide. 24955 * 24956 * @extends CommonMethod<CommonAttribute> 24957 * @syscap SystemCapability.ArkUI.ArkUI.Full 24958 * @crossplatform 24959 * @form 24960 * @since 10 24961 */ 24962/** 24963 * CommonAttribute for ide. 24964 * 24965 * @extends CommonMethod<CommonAttribute> 24966 * @syscap SystemCapability.ArkUI.ArkUI.Full 24967 * @crossplatform 24968 * @form 24969 * @atomicservice 24970 * @since 11 24971 */ 24972declare class CommonAttribute extends CommonMethod<CommonAttribute> {} 24973 24974/** 24975 * CommonInterface for ide. 24976 * 24977 * @interface CommonInterface 24978 * @syscap SystemCapability.ArkUI.ArkUI.Full 24979 * @since 7 24980 */ 24981/** 24982 * CommonInterface for ide. 24983 * 24984 * @interface CommonInterface 24985 * @syscap SystemCapability.ArkUI.ArkUI.Full 24986 * @form 24987 * @since 9 24988 */ 24989/** 24990 * CommonInterface for ide. 24991 * 24992 * @interface CommonInterface 24993 * @syscap SystemCapability.ArkUI.ArkUI.Full 24994 * @crossplatform 24995 * @form 24996 * @since 10 24997 */ 24998/** 24999 * CommonInterface for ide. 25000 * 25001 * @interface CommonInterface 25002 * @syscap SystemCapability.ArkUI.ArkUI.Full 25003 * @crossplatform 25004 * @form 25005 * @atomicservice 25006 * @since 11 25007 */ 25008interface CommonInterface { 25009 /** 25010 * Constructor. 25011 * 25012 * @returns { CommonAttribute } 25013 * @syscap SystemCapability.ArkUI.ArkUI.Full 25014 * @since 7 25015 */ 25016 /** 25017 * Constructor 25018 * 25019 * @returns { CommonAttribute } 25020 * @syscap SystemCapability.ArkUI.ArkUI.Full 25021 * @form 25022 * @since 9 25023 */ 25024 /** 25025 * Constructor 25026 * 25027 * @returns { CommonAttribute } 25028 * @syscap SystemCapability.ArkUI.ArkUI.Full 25029 * @crossplatform 25030 * @form 25031 * @since 10 25032 */ 25033 /** 25034 * Constructor 25035 * 25036 * @returns { CommonAttribute } 25037 * @syscap SystemCapability.ArkUI.ArkUI.Full 25038 * @crossplatform 25039 * @form 25040 * @atomicservice 25041 * @since 11 25042 */ 25043 (): CommonAttribute; 25044} 25045 25046/** 25047 * CommonInstance for ide. 25048 * 25049 * @syscap SystemCapability.ArkUI.ArkUI.Full 25050 * @since 7 25051 */ 25052/** 25053 * CommonInstance for ide. 25054 * 25055 * @syscap SystemCapability.ArkUI.ArkUI.Full 25056 * @form 25057 * @since 9 25058 */ 25059/** 25060 * CommonInstance for ide. 25061 * 25062 * @syscap SystemCapability.ArkUI.ArkUI.Full 25063 * @crossplatform 25064 * @form 25065 * @since 10 25066 */ 25067/** 25068 * CommonInstance for ide. 25069 * 25070 * @syscap SystemCapability.ArkUI.ArkUI.Full 25071 * @crossplatform 25072 * @form 25073 * @atomicservice 25074 * @since 11 25075 */ 25076declare const CommonInstance: CommonAttribute; 25077 25078/** 25079 * Common for ide. 25080 * 25081 * @syscap SystemCapability.ArkUI.ArkUI.Full 25082 * @since 7 25083 */ 25084/** 25085 * Common for ide. 25086 * 25087 * @syscap SystemCapability.ArkUI.ArkUI.Full 25088 * @form 25089 * @since 9 25090 */ 25091/** 25092 * Common for ide. 25093 * 25094 * @syscap SystemCapability.ArkUI.ArkUI.Full 25095 * @crossplatform 25096 * @form 25097 * @since 10 25098 */ 25099/** 25100 * Common for ide. 25101 * 25102 * @syscap SystemCapability.ArkUI.ArkUI.Full 25103 * @crossplatform 25104 * @form 25105 * @atomicservice 25106 * @since 11 25107 */ 25108declare const Common: CommonInterface; 25109 25110/** 25111 * Defines the CustomBuilder Type. 25112 * 25113 * @typedef { (() => any) | void } CustomBuilder 25114 * @syscap SystemCapability.ArkUI.ArkUI.Full 25115 * @since 8 25116 */ 25117/** 25118 * Defines the CustomBuilder Type. 25119 * 25120 * @typedef { (() => any) | void } CustomBuilder 25121 * @syscap SystemCapability.ArkUI.ArkUI.Full 25122 * @form 25123 * @since 9 25124 */ 25125/** 25126 * Defines the CustomBuilder Type. 25127 * 25128 * @typedef { (() => any) | void } CustomBuilder 25129 * @syscap SystemCapability.ArkUI.ArkUI.Full 25130 * @crossplatform 25131 * @form 25132 * @since 10 25133 */ 25134/** 25135 * Defines the CustomBuilder Type. 25136 * 25137 * @typedef { (() => any) | void } CustomBuilder 25138 * @syscap SystemCapability.ArkUI.ArkUI.Full 25139 * @crossplatform 25140 * @form 25141 * @atomicservice 25142 * @since 11 25143 */ 25144declare type CustomBuilder = (() => any) | void; 25145 25146/** 25147 * Defines the OverlayOptions interface. 25148 * 25149 * @typedef OverlayOptions 25150 * @syscap SystemCapability.ArkUI.ArkUI.Full 25151 * @crossplatform 25152 * @form 25153 * @atomicservice 25154 * @since 12 25155 */ 25156declare interface OverlayOptions { 25157 /** 25158 * Defines align type. 25159 * 25160 * @type { ?Alignment } 25161 * @syscap SystemCapability.ArkUI.ArkUI.Full 25162 * @since 7 25163 */ 25164 /** 25165 * Defines align type. 25166 * 25167 * @type { ?Alignment } 25168 * @syscap SystemCapability.ArkUI.ArkUI.Full 25169 * @form 25170 * @since 9 25171 */ 25172 /** 25173 * Defines align type. 25174 * 25175 * @type { ?Alignment } 25176 * @syscap SystemCapability.ArkUI.ArkUI.Full 25177 * @crossplatform 25178 * @form 25179 * @since 10 25180 */ 25181 /** 25182 * Defines align type. 25183 * 25184 * @type { ?Alignment } 25185 * @syscap SystemCapability.ArkUI.ArkUI.Full 25186 * @crossplatform 25187 * @form 25188 * @atomicservice 25189 * @since 11 25190 */ 25191 align?: Alignment; 25192 25193 /** 25194 * Defines offset type. 25195 * 25196 * @type { ?OverlayOffset } 25197 * @syscap SystemCapability.ArkUI.ArkUI.Full 25198 * @since 7 25199 */ 25200 /** 25201 * Defines offset type. 25202 * 25203 * @type { ?OverlayOffset } 25204 * @syscap SystemCapability.ArkUI.ArkUI.Full 25205 * @form 25206 * @since 9 25207 */ 25208 /** 25209 * Defines offset type. 25210 * 25211 * @type { ?OverlayOffset } 25212 * @syscap SystemCapability.ArkUI.ArkUI.Full 25213 * @crossplatform 25214 * @form 25215 * @since 10 25216 */ 25217 /** 25218 * Defines offset type. 25219 * 25220 * @type { ?OverlayOffset } 25221 * @syscap SystemCapability.ArkUI.ArkUI.Full 25222 * @crossplatform 25223 * @form 25224 * @atomicservice 25225 * @since 11 25226 */ 25227 offset?: OverlayOffset; 25228} 25229 25230/** 25231 * Defines the OverlayOffset. 25232 * 25233 * @typedef OverlayOffset 25234 * @syscap SystemCapability.ArkUI.ArkUI.Full 25235 * @crossplatform 25236 * @form 25237 * @atomicservice 25238 * @since 12 25239 */ 25240declare interface OverlayOffset { 25241 /** 25242 * Defines x. 25243 * 25244 * @type { ?number } 25245 * @syscap SystemCapability.ArkUI.ArkUI.Full 25246 * @since 7 25247 */ 25248 /** 25249 * Defines x. 25250 * 25251 * @type { ?number } 25252 * @syscap SystemCapability.ArkUI.ArkUI.Full 25253 * @form 25254 * @since 9 25255 */ 25256 /** 25257 * Defines x. 25258 * 25259 * @type { ?number } 25260 * @syscap SystemCapability.ArkUI.ArkUI.Full 25261 * @crossplatform 25262 * @form 25263 * @since 10 25264 */ 25265 /** 25266 * Defines x. 25267 * 25268 * @type { ?number } 25269 * @syscap SystemCapability.ArkUI.ArkUI.Full 25270 * @crossplatform 25271 * @form 25272 * @atomicservice 25273 * @since 11 25274 */ 25275 x?: number; 25276 /** 25277 * Defines y. 25278 * 25279 * @type { ?number } 25280 * @syscap SystemCapability.ArkUI.ArkUI.Full 25281 * @since 7 25282 */ 25283 /** 25284 * Defines y. 25285 * 25286 * @type { ?number } 25287 * @syscap SystemCapability.ArkUI.ArkUI.Full 25288 * @form 25289 * @since 9 25290 */ 25291 /** 25292 * Defines y. 25293 * 25294 * @type { ?number } 25295 * @syscap SystemCapability.ArkUI.ArkUI.Full 25296 * @crossplatform 25297 * @form 25298 * @since 10 25299 */ 25300 /** 25301 * Defines y. 25302 * 25303 * @type { ?number } 25304 * @syscap SystemCapability.ArkUI.ArkUI.Full 25305 * @crossplatform 25306 * @form 25307 * @atomicservice 25308 * @since 11 25309 */ 25310 y?: number; 25311} 25312 25313/** 25314 * Defines the segment of blur. 25315 * The first element in the tuple means fraction. 25316 * The range of this value is [0,1]. A value of 1 means opaque and 0 means completely transparent. 25317 * The second element means the stop position. 25318 * The range of this value is [0,1]. A value of 1 means region ending position and 0 means region starting position. 25319 * 25320 * @typedef { [ number, number ] } FractionStop 25321 * @syscap SystemCapability.ArkUI.ArkUI.Full 25322 * @atomicservice 25323 * @since 12 25324 */ 25325declare type FractionStop = [ number, number ]; 25326 25327/** 25328 * CommonShapeMethod 25329 * 25330 * @extends CommonMethod<T> 25331 * @syscap SystemCapability.ArkUI.ArkUI.Full 25332 * @since 7 25333 */ 25334/** 25335 * CommonShapeMethod 25336 * 25337 * @extends CommonMethod<T> 25338 * @syscap SystemCapability.ArkUI.ArkUI.Full 25339 * @form 25340 * @since 9 25341 */ 25342/** 25343 * CommonShapeMethod 25344 * 25345 * @extends CommonMethod<T> 25346 * @syscap SystemCapability.ArkUI.ArkUI.Full 25347 * @crossplatform 25348 * @form 25349 * @since 10 25350 */ 25351/** 25352 * CommonShapeMethod 25353 * 25354 * @extends CommonMethod<T> 25355 * @syscap SystemCapability.ArkUI.ArkUI.Full 25356 * @crossplatform 25357 * @form 25358 * @atomicservice 25359 * @since 11 25360 */ 25361declare class CommonShapeMethod<T> extends CommonMethod<T> { 25362 /** 25363 * constructor. 25364 * 25365 * @syscap SystemCapability.ArkUI.ArkUI.Full 25366 * @systemapi 25367 * @since 7 25368 */ 25369 /** 25370 * constructor. 25371 * 25372 * @syscap SystemCapability.ArkUI.ArkUI.Full 25373 * @systemapi 25374 * @form 25375 * @since 9 25376 */ 25377 constructor(); 25378 25379 /** 25380 * border Color 25381 * 25382 * @param { ResourceColor } value 25383 * @returns { T } 25384 * @syscap SystemCapability.ArkUI.ArkUI.Full 25385 * @since 7 25386 */ 25387 /** 25388 * border Color 25389 * 25390 * @param { ResourceColor } value 25391 * @returns { T } 25392 * @syscap SystemCapability.ArkUI.ArkUI.Full 25393 * @form 25394 * @since 9 25395 */ 25396 /** 25397 * border Color 25398 * 25399 * @param { ResourceColor } value 25400 * @returns { T } 25401 * @syscap SystemCapability.ArkUI.ArkUI.Full 25402 * @crossplatform 25403 * @form 25404 * @since 10 25405 */ 25406 /** 25407 * border Color 25408 * 25409 * @param { ResourceColor } value 25410 * @returns { T } 25411 * @syscap SystemCapability.ArkUI.ArkUI.Full 25412 * @crossplatform 25413 * @form 25414 * @atomicservice 25415 * @since 11 25416 */ 25417 stroke(value: ResourceColor): T; 25418 25419 /** 25420 * Fill color. 25421 * 25422 * @param { ResourceColor } value 25423 * @returns { T } 25424 * @syscap SystemCapability.ArkUI.ArkUI.Full 25425 * @since 7 25426 */ 25427 /** 25428 * Fill color. 25429 * 25430 * @param { ResourceColor } value 25431 * @returns { T } 25432 * @syscap SystemCapability.ArkUI.ArkUI.Full 25433 * @form 25434 * @since 9 25435 */ 25436 /** 25437 * Fill color. 25438 * 25439 * @param { ResourceColor } value 25440 * @returns { T } 25441 * @syscap SystemCapability.ArkUI.ArkUI.Full 25442 * @crossplatform 25443 * @form 25444 * @since 10 25445 */ 25446 /** 25447 * Fill color. 25448 * 25449 * @param { ResourceColor } value 25450 * @returns { T } 25451 * @syscap SystemCapability.ArkUI.ArkUI.Full 25452 * @crossplatform 25453 * @form 25454 * @atomicservice 25455 * @since 11 25456 */ 25457 fill(value: ResourceColor): T; 25458 25459 /** 25460 * Offset from the start point of the border drawing. 25461 * 25462 * @param { number | string } value 25463 * @returns { T } 25464 * @syscap SystemCapability.ArkUI.ArkUI.Full 25465 * @since 7 25466 */ 25467 /** 25468 * Offset from the start point of the border drawing. 25469 * 25470 * @param { number | string } value 25471 * @returns { T } 25472 * @syscap SystemCapability.ArkUI.ArkUI.Full 25473 * @form 25474 * @since 9 25475 */ 25476 /** 25477 * Offset from the start point of the border drawing. 25478 * 25479 * @param { number | string } value 25480 * @returns { T } 25481 * @syscap SystemCapability.ArkUI.ArkUI.Full 25482 * @crossplatform 25483 * @form 25484 * @since 10 25485 */ 25486 /** 25487 * Offset from the start point of the border drawing. 25488 * 25489 * @param { number | string } value 25490 * @returns { T } 25491 * @syscap SystemCapability.ArkUI.ArkUI.Full 25492 * @crossplatform 25493 * @form 25494 * @atomicservice 25495 * @since 11 25496 */ 25497 strokeDashOffset(value: number | string): T; 25498 25499 /** 25500 * Path endpoint drawing style. 25501 * 25502 * @param { LineCapStyle } value 25503 * @returns { T } 25504 * @syscap SystemCapability.ArkUI.ArkUI.Full 25505 * @since 7 25506 */ 25507 /** 25508 * Path endpoint drawing style. 25509 * 25510 * @param { LineCapStyle } value 25511 * @returns { T } 25512 * @syscap SystemCapability.ArkUI.ArkUI.Full 25513 * @form 25514 * @since 9 25515 */ 25516 /** 25517 * Path endpoint drawing style. 25518 * 25519 * @param { LineCapStyle } value 25520 * @returns { T } 25521 * @syscap SystemCapability.ArkUI.ArkUI.Full 25522 * @crossplatform 25523 * @form 25524 * @since 10 25525 */ 25526 /** 25527 * Path endpoint drawing style. 25528 * 25529 * @param { LineCapStyle } value 25530 * @returns { T } 25531 * @syscap SystemCapability.ArkUI.ArkUI.Full 25532 * @crossplatform 25533 * @form 25534 * @atomicservice 25535 * @since 11 25536 */ 25537 strokeLineCap(value: LineCapStyle): T; 25538 25539 /** 25540 * Border corner drawing style. 25541 * 25542 * @param { LineJoinStyle } value 25543 * @returns { T } 25544 * @syscap SystemCapability.ArkUI.ArkUI.Full 25545 * @since 7 25546 */ 25547 /** 25548 * Border corner drawing style. 25549 * 25550 * @param { LineJoinStyle } value 25551 * @returns { T } 25552 * @syscap SystemCapability.ArkUI.ArkUI.Full 25553 * @form 25554 * @since 9 25555 */ 25556 /** 25557 * Border corner drawing style. 25558 * 25559 * @param { LineJoinStyle } value 25560 * @returns { T } 25561 * @syscap SystemCapability.ArkUI.ArkUI.Full 25562 * @crossplatform 25563 * @form 25564 * @since 10 25565 */ 25566 /** 25567 * Border corner drawing style. 25568 * 25569 * @param { LineJoinStyle } value 25570 * @returns { T } 25571 * @syscap SystemCapability.ArkUI.ArkUI.Full 25572 * @crossplatform 25573 * @form 25574 * @atomicservice 25575 * @since 11 25576 */ 25577 strokeLineJoin(value: LineJoinStyle): T; 25578 25579 /** 25580 * Limits for drawing acute angles as bevels 25581 * 25582 * @param { number | string } value 25583 * @returns { T } 25584 * @syscap SystemCapability.ArkUI.ArkUI.Full 25585 * @since 7 25586 */ 25587 /** 25588 * Limits for drawing acute angles as bevels 25589 * 25590 * @param { number | string } value 25591 * @returns { T } 25592 * @syscap SystemCapability.ArkUI.ArkUI.Full 25593 * @form 25594 * @since 9 25595 */ 25596 /** 25597 * Limits for drawing acute angles as bevels 25598 * 25599 * @param { number | string } value 25600 * @returns { T } 25601 * @syscap SystemCapability.ArkUI.ArkUI.Full 25602 * @crossplatform 25603 * @form 25604 * @since 10 25605 */ 25606 /** 25607 * Limits for drawing acute angles as bevels 25608 * 25609 * @param { number | string } value 25610 * @returns { T } 25611 * @syscap SystemCapability.ArkUI.ArkUI.Full 25612 * @crossplatform 25613 * @form 25614 * @atomicservice 25615 * @since 11 25616 */ 25617 strokeMiterLimit(value: number | string): T; 25618 25619 /** 25620 * Sets the opacity of the border. 25621 * 25622 * @param { number | string | Resource } value 25623 * @returns { T } 25624 * @syscap SystemCapability.ArkUI.ArkUI.Full 25625 * @since 7 25626 */ 25627 /** 25628 * Sets the opacity of the border. 25629 * 25630 * @param { number | string | Resource } value 25631 * @returns { T } 25632 * @syscap SystemCapability.ArkUI.ArkUI.Full 25633 * @form 25634 * @since 9 25635 */ 25636 /** 25637 * Sets the opacity of the border. 25638 * 25639 * @param { number | string | Resource } value 25640 * @returns { T } 25641 * @syscap SystemCapability.ArkUI.ArkUI.Full 25642 * @crossplatform 25643 * @form 25644 * @since 10 25645 */ 25646 /** 25647 * Sets the opacity of the border. 25648 * 25649 * @param { number | string | Resource } value 25650 * @returns { T } 25651 * @syscap SystemCapability.ArkUI.ArkUI.Full 25652 * @crossplatform 25653 * @form 25654 * @atomicservice 25655 * @since 11 25656 */ 25657 strokeOpacity(value: number | string | Resource): T; 25658 25659 /** 25660 * fill Opacity 25661 * 25662 * @param { number | string | Resource } value 25663 * @returns { T } 25664 * @syscap SystemCapability.ArkUI.ArkUI.Full 25665 * @since 7 25666 */ 25667 /** 25668 * fill Opacity 25669 * 25670 * @param { number | string | Resource } value 25671 * @returns { T } 25672 * @syscap SystemCapability.ArkUI.ArkUI.Full 25673 * @form 25674 * @since 9 25675 */ 25676 /** 25677 * fill Opacity 25678 * 25679 * @param { number | string | Resource } value 25680 * @returns { T } 25681 * @syscap SystemCapability.ArkUI.ArkUI.Full 25682 * @crossplatform 25683 * @form 25684 * @since 10 25685 */ 25686 /** 25687 * fill Opacity 25688 * 25689 * @param { number | string | Resource } value 25690 * @returns { T } 25691 * @syscap SystemCapability.ArkUI.ArkUI.Full 25692 * @crossplatform 25693 * @form 25694 * @atomicservice 25695 * @since 11 25696 */ 25697 fillOpacity(value: number | string | Resource): T; 25698 25699 /** 25700 * Sets the width of the dividing line. 25701 * 25702 * @param { Length } value 25703 * @returns { T } 25704 * @syscap SystemCapability.ArkUI.ArkUI.Full 25705 * @since 7 25706 */ 25707 /** 25708 * Sets the width of the dividing line. 25709 * 25710 * @param { Length } value 25711 * @returns { T } 25712 * @syscap SystemCapability.ArkUI.ArkUI.Full 25713 * @form 25714 * @since 9 25715 */ 25716 /** 25717 * Sets the width of the dividing line. 25718 * 25719 * @param { Length } value 25720 * @returns { T } 25721 * @syscap SystemCapability.ArkUI.ArkUI.Full 25722 * @crossplatform 25723 * @form 25724 * @since 10 25725 */ 25726 /** 25727 * Sets the width of the dividing line. 25728 * 25729 * @param { Length } value 25730 * @returns { T } 25731 * @syscap SystemCapability.ArkUI.ArkUI.Full 25732 * @crossplatform 25733 * @form 25734 * @atomicservice 25735 * @since 11 25736 */ 25737 strokeWidth(value: Length): T; 25738 25739 /** 25740 * Indicates whether to enable anti-aliasing 25741 * 25742 * @param { boolean } value 25743 * @returns { T } 25744 * @syscap SystemCapability.ArkUI.ArkUI.Full 25745 * @since 7 25746 */ 25747 /** 25748 * Indicates whether to enable anti-aliasing 25749 * 25750 * @param { boolean } value 25751 * @returns { T } 25752 * @syscap SystemCapability.ArkUI.ArkUI.Full 25753 * @form 25754 * @since 9 25755 */ 25756 /** 25757 * Indicates whether to enable anti-aliasing 25758 * 25759 * @param { boolean } value 25760 * @returns { T } 25761 * @syscap SystemCapability.ArkUI.ArkUI.Full 25762 * @crossplatform 25763 * @form 25764 * @since 10 25765 */ 25766 /** 25767 * Indicates whether to enable anti-aliasing 25768 * 25769 * @param { boolean } value 25770 * @returns { T } 25771 * @syscap SystemCapability.ArkUI.ArkUI.Full 25772 * @crossplatform 25773 * @form 25774 * @atomicservice 25775 * @since 11 25776 */ 25777 antiAlias(value: boolean): T; 25778 25779 /** 25780 * Sets the gap for the border. 25781 * 25782 * @param { Array<any> } value 25783 * @returns { T } 25784 * @syscap SystemCapability.ArkUI.ArkUI.Full 25785 * @since 7 25786 */ 25787 /** 25788 * Sets the gap for the border. 25789 * 25790 * @param { Array<any> } value 25791 * @returns { T } 25792 * @syscap SystemCapability.ArkUI.ArkUI.Full 25793 * @form 25794 * @since 9 25795 */ 25796 /** 25797 * Sets the gap for the border. 25798 * 25799 * @param { Array<any> } value 25800 * @returns { T } 25801 * @syscap SystemCapability.ArkUI.ArkUI.Full 25802 * @crossplatform 25803 * @form 25804 * @since 10 25805 */ 25806 /** 25807 * Sets the gap for the border. 25808 * 25809 * @param { Array<any> } value 25810 * @returns { T } 25811 * @syscap SystemCapability.ArkUI.ArkUI.Full 25812 * @crossplatform 25813 * @form 25814 * @atomicservice 25815 * @since 11 25816 */ 25817 strokeDashArray(value: Array<any>): T; 25818} 25819 25820/** 25821 * Linear Gradient Interface 25822 * 25823 * @interface LinearGradient 25824 * @syscap SystemCapability.ArkUI.ArkUI.Full 25825 * @since 9 25826 */ 25827/** 25828 * Linear Gradient Interface 25829 * 25830 * @interface LinearGradient 25831 * @syscap SystemCapability.ArkUI.ArkUI.Full 25832 * @crossplatform 25833 * @since 10 25834 */ 25835/** 25836 * Linear Gradient Interface 25837 * 25838 * @interface LinearGradient 25839 * @syscap SystemCapability.ArkUI.ArkUI.Full 25840 * @crossplatform 25841 * @atomicservice 25842 * @since 11 25843 */ 25844declare interface LinearGradient { 25845 /** 25846 * Linear Gradient Angle 25847 * 25848 * @type { ?(number | string) } 25849 * @syscap SystemCapability.ArkUI.ArkUI.Full 25850 * @since 9 25851 */ 25852 /** 25853 * Linear Gradient Angle 25854 * 25855 * @type { ?(number | string) } 25856 * @syscap SystemCapability.ArkUI.ArkUI.Full 25857 * @crossplatform 25858 * @since 10 25859 */ 25860 /** 25861 * Linear Gradient Angle 25862 * 25863 * @type { ?(number | string) } 25864 * @syscap SystemCapability.ArkUI.ArkUI.Full 25865 * @crossplatform 25866 * @atomicservice 25867 * @since 11 25868 */ 25869 angle?: number | string; 25870 /** 25871 * Linear Gradient Direction 25872 * 25873 * @type { ?GradientDirection } 25874 * @syscap SystemCapability.ArkUI.ArkUI.Full 25875 * @since 9 25876 */ 25877 /** 25878 * Linear Gradient Direction 25879 * 25880 * @type { ?GradientDirection } 25881 * @syscap SystemCapability.ArkUI.ArkUI.Full 25882 * @crossplatform 25883 * @since 10 25884 */ 25885 /** 25886 * Linear Gradient Direction 25887 * 25888 * @type { ?GradientDirection } 25889 * @syscap SystemCapability.ArkUI.ArkUI.Full 25890 * @crossplatform 25891 * @atomicservice 25892 * @since 11 25893 */ 25894 direction?: GradientDirection; 25895 /** 25896 * Linear Gradient Colors 25897 * 25898 * @type { Array<any> } 25899 * @syscap SystemCapability.ArkUI.ArkUI.Full 25900 * @since 9 25901 */ 25902 /** 25903 * Linear Gradient Colors 25904 * 25905 * @type { Array<any> } 25906 * @syscap SystemCapability.ArkUI.ArkUI.Full 25907 * @crossplatform 25908 * @since 10 25909 */ 25910 /** 25911 * Linear Gradient Colors 25912 * 25913 * @type { Array<any> } 25914 * @syscap SystemCapability.ArkUI.ArkUI.Full 25915 * @crossplatform 25916 * @atomicservice 25917 * @since 11 25918 */ 25919 /** 25920 * Linear Gradient Colors 25921 * 25922 * @type { Array<[ResourceColor, number]> } 25923 * @syscap SystemCapability.ArkUI.ArkUI.Full 25924 * @crossplatform 25925 * @atomicservice 25926 * @since 12 25927 */ 25928 colors: Array<[ResourceColor, number]>; 25929 /** 25930 * Linear Gradient Repeating 25931 * 25932 * @type { ?boolean } 25933 * @syscap SystemCapability.ArkUI.ArkUI.Full 25934 * @since 9 25935 */ 25936 /** 25937 * Linear Gradient Repeating 25938 * 25939 * @type { ?boolean } 25940 * @syscap SystemCapability.ArkUI.ArkUI.Full 25941 * @crossplatform 25942 * @since 10 25943 */ 25944 /** 25945 * Linear Gradient Repeating 25946 * 25947 * @type { ?boolean } 25948 * @syscap SystemCapability.ArkUI.ArkUI.Full 25949 * @crossplatform 25950 * @atomicservice 25951 * @since 11 25952 */ 25953 repeating?: boolean; 25954} 25955 25956/** 25957 * Defines the pixel round property. 25958 * 25959 * @interface PixelRoundPolicy 25960 * @syscap SystemCapability.ArkUI.ArkUI.Full 25961 * @crossplatform 25962 * @form 25963 * @atomicservice 25964 * @since 11 25965 */ 25966declare interface PixelRoundPolicy { 25967 /** 25968 * start property. 25969 * 25970 * @type { ?PixelRoundCalcPolicy } 25971 * @default PixelRoundCalcPolicy.NO_FORCE_ROUND 25972 * @syscap SystemCapability.ArkUI.ArkUI.Full 25973 * @crossplatform 25974 * @form 25975 * @atomicservice 25976 * @since 11 25977 */ 25978 start?: PixelRoundCalcPolicy; 25979 25980 /** 25981 * top property. 25982 * 25983 * @type { ?PixelRoundCalcPolicy } 25984 * @default PixelRoundCalcPolicy.NO_FORCE_ROUND 25985 * @syscap SystemCapability.ArkUI.ArkUI.Full 25986 * @crossplatform 25987 * @form 25988 * @atomicservice 25989 * @since 11 25990 */ 25991 top?: PixelRoundCalcPolicy; 25992 25993 /** 25994 * end property. 25995 * 25996 * @type { ?PixelRoundCalcPolicy } 25997 * @default PixelRoundCalcPolicy.NO_FORCE_ROUND 25998 * @syscap SystemCapability.ArkUI.ArkUI.Full 25999 * @crossplatform 26000 * @form 26001 * @atomicservice 26002 * @since 11 26003 */ 26004 end?: PixelRoundCalcPolicy; 26005 26006 /** 26007 * bottom property. 26008 * 26009 * @type { ?PixelRoundCalcPolicy } 26010 * @default PixelRoundCalcPolicy.NO_FORCE_ROUND 26011 * @syscap SystemCapability.ArkUI.ArkUI.Full 26012 * @crossplatform 26013 * @form 26014 * @atomicservice 26015 * @since 11 26016 */ 26017 bottom?: PixelRoundCalcPolicy; 26018} 26019 26020/** 26021 * Linear Gradient Blur Interface 26022 * 26023 * @interface LinearGradientBlurOptions 26024 * @syscap SystemCapability.ArkUI.ArkUI.Full 26025 * @atomicservice 26026 * @since 12 26027 */ 26028declare interface LinearGradientBlurOptions { 26029 /** 26030 * Percentage of blurring effect. 26031 * 26032 * @type { FractionStop[] } 26033 * @syscap SystemCapability.ArkUI.ArkUI.Full 26034 * @atomicservice 26035 * @since 12 26036 */ 26037 fractionStops: FractionStop[]; 26038 /** 26039 * Direction of linear gradient blur. 26040 * 26041 * @type { GradientDirection } 26042 * @syscap SystemCapability.ArkUI.ArkUI.Full 26043 * @atomicservice 26044 * @since 12 26045 */ 26046 direction: GradientDirection; 26047} 26048 26049/** 26050 * Define motion blur anchor coordinates. 26051 * 26052 * @interface MotionBlurAnchor 26053 * @syscap SystemCapability.ArkUI.ArkUI.Full 26054 * @crossplatform 26055 * @atomicservice 26056 * @since 12 26057 */ 26058declare interface MotionBlurAnchor { 26059 /** 26060 * Define anchor coordinate x-value.Value range [0.0, 1.0]. 26061 * 26062 * @type { number } 26063 * @syscap SystemCapability.ArkUI.ArkUI.Full 26064 * @atomicservice 26065 * @since 12 26066 */ 26067 x: number; 26068 /** 26069 * Define anchor coordinate y-value.Value range [0.0, 1.0]. 26070 * 26071 * @type { number } 26072 * @syscap SystemCapability.ArkUI.ArkUI.Full 26073 * @atomicservice 26074 * @since 12 26075 */ 26076 y: number; 26077} 26078 26079/** 26080 * Define motion blur options. 26081 * 26082 * @interface MotionBlurOptions 26083 * @syscap SystemCapability.ArkUI.ArkUI.Full 26084 * @crossplatform 26085 * @atomicservice 26086 * @since 12 26087 */ 26088declare interface MotionBlurOptions { 26089 /** 26090 * Define the size of motion blur radius.The range of this value is [0.0, ∞). 26091 * 26092 * @type { number } 26093 * @syscap SystemCapability.ArkUI.ArkUI.Full 26094 * @atomicservice 26095 * @since 12 26096 */ 26097 radius: number; 26098 /** 26099 * Define motion blur anchor coordinates. 26100 * 26101 * @type { MotionBlurAnchor } 26102 * @syscap SystemCapability.ArkUI.ArkUI.Full 26103 * @atomicservice 26104 * @since 12 26105 */ 26106 anchor: MotionBlurAnchor; 26107} 26108 26109/** 26110 * Sub component border info. 26111 * 26112 * @interface LayoutBorderInfo 26113 * @syscap SystemCapability.ArkUI.ArkUI.Full 26114 * @form 26115 * @since 9 26116 * @deprecated since 10 26117 */ 26118declare interface LayoutBorderInfo { 26119 /** 26120 * Sub component borderWidth info. 26121 * 26122 * @type { EdgeWidths } 26123 * @syscap SystemCapability.ArkUI.ArkUI.Full 26124 * @form 26125 * @since 9 26126 * @deprecated since 10 26127 */ 26128 borderWidth: EdgeWidths; 26129 26130 /** 26131 * Sub component margin info. 26132 * 26133 * @type { Margin } 26134 * @syscap SystemCapability.ArkUI.ArkUI.Full 26135 * @form 26136 * @since 9 26137 * @deprecated since 10 26138 */ 26139 margin: Margin, 26140 26141 /** 26142 * Sub component padding info. 26143 * 26144 * @type { Padding } 26145 * @syscap SystemCapability.ArkUI.ArkUI.Full 26146 * @form 26147 * @since 9 26148 * @deprecated since 10 26149 */ 26150 padding: Padding, 26151} 26152 26153/** 26154 * Sub component layout info. 26155 * 26156 * @interface LayoutInfo 26157 * @syscap SystemCapability.ArkUI.ArkUI.Full 26158 * @form 26159 * @since 9 26160 * @deprecated since 10 26161 */ 26162declare interface LayoutInfo { 26163 /** 26164 * Sub component position info. 26165 * 26166 * @type { Position } 26167 * @syscap SystemCapability.ArkUI.ArkUI.Full 26168 * @form 26169 * @since 9 26170 * @deprecated since 10 26171 */ 26172 position: Position, 26173 26174 /** 26175 * Sub component constraint info. 26176 * 26177 * @type { ConstraintSizeOptions } 26178 * @syscap SystemCapability.ArkUI.ArkUI.Full 26179 * @form 26180 * @since 9 26181 * @deprecated since 10 26182 */ 26183 constraint: ConstraintSizeOptions, 26184} 26185 26186/** 26187 * Sub component info passed from framework when layout and measure happens. 26188 * 26189 * @interface LayoutChild 26190 * @syscap SystemCapability.ArkUI.ArkUI.Full 26191 * @form 26192 * @since 9 26193 * @deprecated since 10 26194 */ 26195declare interface LayoutChild { 26196 /** 26197 * Sub component name. 26198 * 26199 * @type { string } 26200 * @syscap SystemCapability.ArkUI.ArkUI.Full 26201 * @form 26202 * @since 9 26203 * @deprecated since 10 26204 */ 26205 name: string, 26206 26207 /** 26208 * Sub component id. 26209 * 26210 * @type { string } 26211 * @syscap SystemCapability.ArkUI.ArkUI.Full 26212 * @form 26213 * @since 9 26214 * @deprecated since 10 26215 */ 26216 id: string, 26217 26218 /** 26219 * Sub component constraint. 26220 * 26221 * @type { ConstraintSizeOptions } 26222 * @syscap SystemCapability.ArkUI.ArkUI.Full 26223 * @form 26224 * @since 9 26225 * @deprecated since 10 26226 */ 26227 constraint: ConstraintSizeOptions, 26228 26229 /** 26230 * Sub component border info. 26231 * 26232 * @type { LayoutBorderInfo } 26233 * @syscap SystemCapability.ArkUI.ArkUI.Full 26234 * @form 26235 * @since 9 26236 * @deprecated since 10 26237 */ 26238 borderInfo: LayoutBorderInfo, 26239 26240 /** 26241 * Sub component position. 26242 * 26243 * @type { Position } 26244 * @syscap SystemCapability.ArkUI.ArkUI.Full 26245 * @form 26246 * @since 9 26247 * @deprecated since 10 26248 */ 26249 position: Position, 26250 26251 /** 26252 * Call this measure method in onMeasure callback to supply sub component size. 26253 * 26254 * @param { ConstraintSizeOptions } childConstraint 26255 * @syscap SystemCapability.ArkUI.ArkUI.Full 26256 * @form 26257 * @since 9 26258 * @deprecated since 10 26259 */ 26260 measure(childConstraint: ConstraintSizeOptions), 26261 26262 /** 26263 * Call this layout method in onLayout callback to assign layout info to sub component. 26264 * 26265 * @param { LayoutInfo } childLayoutInfo 26266 * @syscap SystemCapability.ArkUI.ArkUI.Full 26267 * @form 26268 * @since 9 26269 * @deprecated since 10 26270 */ 26271 layout(childLayoutInfo: LayoutInfo), 26272} 26273 26274/** 26275 * Sub component layout info. 26276 * 26277 * @extends SizeResult 26278 * @interface GeometryInfo 26279 * @syscap SystemCapability.ArkUI.ArkUI.Full 26280 * @crossplatform 26281 * @since 10 26282 */ 26283/** 26284 * Sub component layout info. 26285 * 26286 * @extends SizeResult 26287 * @interface GeometryInfo 26288 * @syscap SystemCapability.ArkUI.ArkUI.Full 26289 * @crossplatform 26290 * @atomicservice 26291 * @since 11 26292 */ 26293declare interface GeometryInfo extends SizeResult { 26294 /** 26295 * Sub component borderWidth info. 26296 * 26297 * @type { EdgeWidth } 26298 * @syscap SystemCapability.ArkUI.ArkUI.Full 26299 * @crossplatform 26300 * @since 10 26301 */ 26302 /** 26303 * Sub component borderWidth info. 26304 * 26305 * @type { EdgeWidth } 26306 * @syscap SystemCapability.ArkUI.ArkUI.Full 26307 * @crossplatform 26308 * @atomicservice 26309 * @since 11 26310 */ 26311 borderWidth: EdgeWidth; 26312 26313 /** 26314 * Sub component margin info. 26315 * 26316 * @type { Margin } 26317 * @syscap SystemCapability.ArkUI.ArkUI.Full 26318 * @crossplatform 26319 * @since 10 26320 */ 26321 /** 26322 * Sub component margin info. 26323 * 26324 * @type { Margin } 26325 * @syscap SystemCapability.ArkUI.ArkUI.Full 26326 * @crossplatform 26327 * @atomicservice 26328 * @since 11 26329 */ 26330 margin: Margin, 26331 26332 /** 26333 * Sub component padding info. 26334 * 26335 * @type { Padding } 26336 * @syscap SystemCapability.ArkUI.ArkUI.Full 26337 * @crossplatform 26338 * @since 10 26339 */ 26340 /** 26341 * Sub component padding info. 26342 * 26343 * @type { Padding } 26344 * @syscap SystemCapability.ArkUI.ArkUI.Full 26345 * @crossplatform 26346 * @atomicservice 26347 * @since 11 26348 */ 26349 padding: Padding, 26350} 26351 26352/** 26353 * Sub component info passed from framework when layout happens. 26354 * 26355 * @interface Layoutable 26356 * @syscap SystemCapability.ArkUI.ArkUI.Full 26357 * @crossplatform 26358 * @since 10 26359 */ 26360/** 26361 * Sub component info passed from framework when layout happens. 26362 * 26363 * @interface Layoutable 26364 * @syscap SystemCapability.ArkUI.ArkUI.Full 26365 * @crossplatform 26366 * @atomicservice 26367 * @since 11 26368 */ 26369declare interface Layoutable { 26370 /** 26371 * Measurement result of the child component. 26372 * 26373 * @type { MeasureResult } 26374 * @syscap SystemCapability.ArkUI.ArkUI.Full 26375 * @crossplatform 26376 * @since 10 26377 */ 26378 /** 26379 * Measurement result of the child component. 26380 * 26381 * @type { MeasureResult } 26382 * @syscap SystemCapability.ArkUI.ArkUI.Full 26383 * @crossplatform 26384 * @atomicservice 26385 * @since 11 26386 */ 26387 measureResult: MeasureResult, 26388 26389 /** 26390 * Unique ID of the child component. 26391 * 26392 * @type { ?number } 26393 * @syscap SystemCapability.ArkUI.ArkUI.Full 26394 * @crossplatform 26395 * @atomicservice 26396 * @since 18 26397 */ 26398 uniqueId?: number; 26399 26400 /** 26401 * Call this layout method in onLayout callback to assign layout info to sub component. 26402 * 26403 * @param { Position } position 26404 * @syscap SystemCapability.ArkUI.ArkUI.Full 26405 * @crossplatform 26406 * @since 10 26407 */ 26408 /** 26409 * Call this layout method in onLayout callback to assign layout info to sub component. 26410 * 26411 * @param { Position } position 26412 * @syscap SystemCapability.ArkUI.ArkUI.Full 26413 * @crossplatform 26414 * @atomicservice 26415 * @since 11 26416 */ 26417 layout(position: Position): void, 26418 26419 /** 26420 * Call this method to get the margin of sub component. 26421 * 26422 * @returns { DirectionalEdgesT<number> } the margin of sub component, unit is vp 26423 * @syscap SystemCapability.ArkUI.ArkUI.Full 26424 * @crossplatform 26425 * @atomicservice 26426 * @since 12 26427 */ 26428 getMargin() : DirectionalEdgesT<number>, 26429 26430 /** 26431 * Call this method to get the padding of sub component. 26432 * 26433 * @returns { DirectionalEdgesT<number> } the padding of sub component, unit is vp 26434 * @syscap SystemCapability.ArkUI.ArkUI.Full 26435 * @crossplatform 26436 * @atomicservice 26437 * @since 12 26438 */ 26439 getPadding() : DirectionalEdgesT<number>, 26440 26441 /** 26442 * Call this method to get the borderWidth of sub component. 26443 * 26444 * @returns { DirectionalEdgesT<number> } the borderWidth of sub component, unit is vp 26445 * @syscap SystemCapability.ArkUI.ArkUI.Full 26446 * @crossplatform 26447 * @atomicservice 26448 * @since 12 26449 */ 26450 getBorderWidth() : DirectionalEdgesT<number>, 26451} 26452 26453/** 26454 * Sub component info passed from framework when measure happens. 26455 * 26456 * @interface Measurable 26457 * @syscap SystemCapability.ArkUI.ArkUI.Full 26458 * @crossplatform 26459 * @since 10 26460 */ 26461/** 26462 * Sub component info passed from framework when measure happens. 26463 * 26464 * @interface Measurable 26465 * @syscap SystemCapability.ArkUI.ArkUI.Full 26466 * @crossplatform 26467 * @atomicservice 26468 * @since 11 26469 */ 26470declare interface Measurable { 26471 /** 26472 * Unique ID of the child component. 26473 * 26474 * @type { ?number } 26475 * @syscap SystemCapability.ArkUI.ArkUI.Full 26476 * @crossplatform 26477 * @atomicservice 26478 * @since 18 26479 */ 26480 uniqueId?: number; 26481 26482 /** 26483 * Call this measure method in onMeasure callback to supply sub component size. 26484 * 26485 * @param { ConstraintSizeOptions } constraint 26486 * @returns { MeasureResult } 26487 * @syscap SystemCapability.ArkUI.ArkUI.Full 26488 * @crossplatform 26489 * @since 10 26490 */ 26491 /** 26492 * Call this measure method in onMeasure callback to supply sub component size. 26493 * 26494 * @param { ConstraintSizeOptions } constraint 26495 * @returns { MeasureResult } 26496 * @syscap SystemCapability.ArkUI.ArkUI.Full 26497 * @crossplatform 26498 * @atomicservice 26499 * @since 11 26500 */ 26501 measure(constraint: ConstraintSizeOptions) : MeasureResult, 26502 26503 /** 26504 * Call this method to get the margin of sub component. 26505 * 26506 * @returns { DirectionalEdgesT<number> } the margin of sub component, unit is vp 26507 * @syscap SystemCapability.ArkUI.ArkUI.Full 26508 * @crossplatform 26509 * @atomicservice 26510 * @since 12 26511 */ 26512 getMargin() : DirectionalEdgesT<number>, 26513 26514 /** 26515 * Call this method to get the padding of sub component. 26516 * 26517 * @returns { DirectionalEdgesT<number> } the padding of sub component, unit is vp 26518 * @syscap SystemCapability.ArkUI.ArkUI.Full 26519 * @crossplatform 26520 * @atomicservice 26521 * @since 12 26522 */ 26523 getPadding() : DirectionalEdgesT<number>, 26524 26525 /** 26526 * Call this method to get the borderWidth of sub component. 26527 * 26528 * @returns { DirectionalEdgesT<number> } the borderWidth of sub component, unit is vp 26529 * @syscap SystemCapability.ArkUI.ArkUI.Full 26530 * @crossplatform 26531 * @atomicservice 26532 * @since 12 26533 */ 26534 getBorderWidth() : DirectionalEdgesT<number>, 26535} 26536 26537/** 26538 * Sub component SizeResult info. 26539 * 26540 * @interface SizeResult 26541 * @syscap SystemCapability.ArkUI.ArkUI.Full 26542 * @crossplatform 26543 * @since 10 26544 */ 26545/** 26546 * Sub component SizeResult info. 26547 * 26548 * @interface SizeResult 26549 * @syscap SystemCapability.ArkUI.ArkUI.Full 26550 * @crossplatform 26551 * @atomicservice 26552 * @since 11 26553 */ 26554declare interface SizeResult { 26555 /** 26556 * Width obtained from the measurement result. 26557 * 26558 * @type { number } 26559 * @syscap SystemCapability.ArkUI.ArkUI.Full 26560 * @crossplatform 26561 * @since 10 26562 */ 26563 /** 26564 * Width obtained from the measurement result. 26565 * 26566 * @type { number } 26567 * @syscap SystemCapability.ArkUI.ArkUI.Full 26568 * @crossplatform 26569 * @atomicservice 26570 * @since 11 26571 */ 26572 width: number, 26573 26574 /** 26575 * Height obtained from the measurement result. 26576 * 26577 * @type { number } 26578 * @syscap SystemCapability.ArkUI.ArkUI.Full 26579 * @crossplatform 26580 * @since 10 26581 */ 26582 /** 26583 * Height obtained from the measurement result. 26584 * 26585 * @type { number } 26586 * @syscap SystemCapability.ArkUI.ArkUI.Full 26587 * @crossplatform 26588 * @atomicservice 26589 * @since 11 26590 */ 26591 height: number, 26592} 26593 26594/** 26595 * Sub component MeasureResult info. 26596 * 26597 * @extends SizeResult 26598 * @interface MeasureResult 26599 * @syscap SystemCapability.ArkUI.ArkUI.Full 26600 * @crossplatform 26601 * @since 10 26602 */ 26603/** 26604 * Sub component MeasureResult info. 26605 * 26606 * @extends SizeResult 26607 * @interface MeasureResult 26608 * @syscap SystemCapability.ArkUI.ArkUI.Full 26609 * @crossplatform 26610 * @atomicservice 26611 * @since 11 26612 */ 26613declare interface MeasureResult extends SizeResult { 26614 26615} 26616 26617/** 26618 * The navigation destination information. 26619 * 26620 * @syscap SystemCapability.ArkUI.ArkUI.Full 26621 * @crossplatform 26622 * @since 11 26623 */ 26624/** 26625 * The navigation destination information. 26626 * 26627 * @typedef {import('../api/@ohos.arkui.observer').default.NavDestinationInfo} NavDestinationInfo 26628 * @syscap SystemCapability.ArkUI.ArkUI.Full 26629 * @crossplatform 26630 * @atomicservice 26631 * @since 12 26632 */ 26633declare type NavDestinationInfo = import('../api/@ohos.arkui.observer').default.NavDestinationInfo; 26634 26635/** 26636 * The navigation information. 26637 * 26638 * @typedef {import('../api/@ohos.arkui.observer').default.NavigationInfo} NavigationInfo 26639 * @syscap SystemCapability.ArkUI.ArkUI.Full 26640 * @crossplatform 26641 * @atomicservice 26642 * @since 12 26643 */ 26644declare type NavigationInfo = import('../api/@ohos.arkui.observer').default.NavigationInfo; 26645 26646/** 26647 * The router page information. 26648 * 26649 * @typedef {import('../api/@ohos.arkui.observer').default.RouterPageInfo} RouterPageInfo 26650 * @syscap SystemCapability.ArkUI.ArkUI.Full 26651 * @crossplatform 26652 * @atomicservice 26653 * @since 12 26654 */ 26655declare type RouterPageInfo = import('../api/@ohos.arkui.observer').default.RouterPageInfo; 26656 26657/** 26658 * UIContext 26659 * 26660 * @syscap SystemCapability.ArkUI.ArkUI.Full 26661 * @crossplatform 26662 * @since 11 26663 */ 26664/** 26665 * UIContext 26666 * 26667 * @typedef { import('../api/@ohos.arkui.UIContext').UIContext } UIContext 26668 * @syscap SystemCapability.ArkUI.ArkUI.Full 26669 * @crossplatform 26670 * @atomicservice 26671 * @since 12 26672 */ 26673declare type UIContext = import('../api/@ohos.arkui.UIContext').UIContext; 26674 26675/** 26676 * DrawContext 26677 * 26678 * @typedef { import('../api/arkui/Graphics').DrawContext } DrawContext 26679 * @syscap SystemCapability.ArkUI.ArkUI.Full 26680 * @crossplatform 26681 * @atomicservice 26682 * @since 12 26683 */ 26684declare type DrawContext = import('../api/arkui/Graphics').DrawContext; 26685 26686/** 26687 * VisualEffect 26688 * 26689 * @typedef { import('../api/@ohos.graphics.uiEffect').default.VisualEffect } VisualEffect 26690 * @syscap SystemCapability.ArkUI.ArkUI.Full 26691 * @crossplatform 26692 * @atomicservice 26693 * @since 12 26694 */ 26695declare type VisualEffect = import('../api/@ohos.graphics.uiEffect').default.VisualEffect; 26696 26697 26698/** 26699 * Filter 26700 * 26701 * @typedef { import('../api/@ohos.graphics.uiEffect').default.Filter } Filter 26702 * @syscap SystemCapability.ArkUI.ArkUI.Full 26703 * @crossplatform 26704 * @atomicservice 26705 * @since 12 26706 */ 26707declare type Filter = import('../api/@ohos.graphics.uiEffect').default.Filter; 26708 26709/** 26710 * Blender 26711 * 26712 * @typedef { import('../api/@ohos.graphics.uiEffect').default.Blender } Blender 26713 * @syscap SystemCapability.ArkUI.ArkUI.Full 26714 * @systemapi 26715 * @form 26716 * @since 13 26717 */ 26718declare type Blender = import('../api/@ohos.graphics.uiEffect').default.Blender; 26719 26720/** 26721 * ComponentContent. 26722 * 26723 * @typedef {import('../api/arkui/ComponentContent').ComponentContent<T>} ComponentContent<T = Object> 26724 * @syscap SystemCapability.ArkUI.ArkUI.Full 26725 * @crossplatform 26726 * @atomicservice 26727 * @since 12 26728 */ 26729declare type ComponentContent<T = Object> = import('../api/arkui/ComponentContent').ComponentContent<T>; 26730 26731/** 26732 * Theme. 26733 * 26734 * @typedef {import('../api/@ohos.arkui.theme').Theme} Theme 26735 * @syscap SystemCapability.ArkUI.ArkUI.Full 26736 * @crossplatform 26737 * @atomicservice 26738 * @since 12 26739 */ 26740declare type Theme = import('../api/@ohos.arkui.theme').Theme; 26741 26742/** 26743 * Import the DialogController type from promptAction. 26744 * 26745 * @typedef { import('../api/@ohos.promptAction').promptAction.DialogController } PromptActionDialogController 26746 * @syscap SystemCapability.ArkUI.ArkUI.Full 26747 * @atomicservice 26748 * @since 18 26749 */ 26750declare type PromptActionDialogController = import('../api/@ohos.promptAction').promptAction.DialogController; 26751 26752/** 26753 * Custom Component 26754 * 26755 * @extends CommonAttribute 26756 * @syscap SystemCapability.ArkUI.ArkUI.Full 26757 * @since 7 26758 */ 26759/** 26760 * Custom Component 26761 * 26762 * @extends CommonAttribute 26763 * @syscap SystemCapability.ArkUI.ArkUI.Full 26764 * @form 26765 * @since 9 26766 */ 26767/** 26768 * Custom Component 26769 * 26770 * @extends CommonAttribute 26771 * @syscap SystemCapability.ArkUI.ArkUI.Full 26772 * @crossplatform 26773 * @form 26774 * @since 10 26775 */ 26776/** 26777 * Custom Component 26778 * 26779 * @extends CommonAttribute 26780 * @syscap SystemCapability.ArkUI.ArkUI.Full 26781 * @crossplatform 26782 * @form 26783 * @atomicservice 26784 * @since 11 26785 */ 26786/** 26787 * Custom Component 26788 * 26789 * @extends BaseCustomComponent 26790 * @syscap SystemCapability.ArkUI.ArkUI.Full 26791 * @crossplatform 26792 * @form 26793 * @atomicservice 26794 * @since 18 26795 */ 26796declare class CustomComponent extends BaseCustomComponent { 26797 /** 26798 * aboutToReuse Method 26799 * 26800 * @param { object } params - Custom component init params. 26801 * @syscap SystemCapability.ArkUI.ArkUI.Full 26802 * @crossplatform 26803 * @since 10 26804 */ 26805 /** 26806 * aboutToReuse Method 26807 * 26808 * @param { object } params - Custom component init params. 26809 * @syscap SystemCapability.ArkUI.ArkUI.Full 26810 * @crossplatform 26811 * @atomicservice 26812 * @since 11 26813 */ 26814 aboutToReuse?(params: { [key: string]: unknown }): void; 26815 26816 /** 26817 * Custom component override this method to layout each of its sub components. 26818 * 26819 * @param { Array<LayoutChild> } children 26820 * @param { ConstraintSizeOptions } constraint 26821 * @syscap SystemCapability.ArkUI.ArkUI.Full 26822 * @form 26823 * @since 9 26824 * @deprecated since 10 26825 * @useinstead CustomComponent#onPlaceChildren 26826 */ 26827 onLayout?(children: Array<LayoutChild>, constraint: ConstraintSizeOptions): void; 26828 26829 /** 26830 * Custom component override this method to measure each of its sub components. 26831 * 26832 * @param { Array<LayoutChild> } children 26833 * @param { ConstraintSizeOptions } constraint 26834 * @syscap SystemCapability.ArkUI.ArkUI.Full 26835 * @form 26836 * @since 9 26837 * @deprecated since 10 26838 * @useinstead CustomComponent#onMeasureSize 26839 */ 26840 onMeasure?(children: Array<LayoutChild>, constraint: ConstraintSizeOptions): void; 26841} 26842 26843/** 26844 * Custom ComponentV2 26845 * 26846 * @extends BaseCustomComponent 26847 * @syscap SystemCapability.ArkUI.ArkUI.Full 26848 * @crossplatform 26849 * @form 26850 * @atomicservice 26851 * @since 18 26852 */ 26853declare class CustomComponentV2 extends BaseCustomComponent { 26854 /** 26855 * aboutToReuse Method for @ComponentV2, it is executed when fetching instance of custom component from RecyclePool. 26856 * It is different from the @Reusable in CustomComponent, there is no param parameter in this callback. 26857 * 26858 * @syscap SystemCapability.ArkUI.ArkUI.Full 26859 * @crossplatform 26860 * @atomicservice 26861 * @since 18 26862 */ 26863 aboutToReuse?(): void; 26864} 26865 26866/** 26867 * Custom Component base class and it is migrated from class CustomComponent. 26868 * 26869 * @extends BaseCustomComponent 26870 * @syscap SystemCapability.ArkUI.ArkUI.Full 26871 * @crossplatform 26872 * @form 26873 * @atomicservice 26874 * @since 18 26875 */ 26876declare class BaseCustomComponent extends CommonAttribute { 26877 /** 26878 * Customize the pop-up content constructor . 26879 * 26880 * @syscap SystemCapability.ArkUI.ArkUI.Full 26881 * @since 7 26882 */ 26883 /** 26884 * Customize the pop-up content constructor. 26885 * 26886 * @syscap SystemCapability.ArkUI.ArkUI.Full 26887 * @form 26888 * @since 9 26889 */ 26890 /** 26891 * Customize the pop-up content constructor. 26892 * 26893 * @syscap SystemCapability.ArkUI.ArkUI.Full 26894 * @crossplatform 26895 * @form 26896 * @since 10 26897 */ 26898 /** 26899 * Customize the pop-up content constructor. 26900 * 26901 * @syscap SystemCapability.ArkUI.ArkUI.Full 26902 * @crossplatform 26903 * @form 26904 * @atomicservice 26905 * @since 11 26906 */ 26907 /** 26908 * Customize the pop-up content constructor and it is migrated from class CustomComponent. 26909 * 26910 * @syscap SystemCapability.ArkUI.ArkUI.Full 26911 * @crossplatform 26912 * @form 26913 * @atomicservice 26914 * @since 18 26915 */ 26916 build(): void; 26917 26918 /** 26919 * aboutToAppear Method 26920 * 26921 * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. 26922 * 26923 * @syscap SystemCapability.ArkUI.ArkUI.Full 26924 * @since 7 26925 */ 26926 /** 26927 * aboutToAppear Method 26928 * 26929 * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. 26930 * 26931 * @syscap SystemCapability.ArkUI.ArkUI.Full 26932 * @form 26933 * @since 9 26934 */ 26935 /** 26936 * aboutToAppear Method 26937 * 26938 * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. 26939 * 26940 * @syscap SystemCapability.ArkUI.ArkUI.Full 26941 * @crossplatform 26942 * @form 26943 * @since 10 26944 */ 26945 /** 26946 * aboutToAppear Method 26947 * 26948 * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. 26949 * 26950 * @syscap SystemCapability.ArkUI.ArkUI.Full 26951 * @crossplatform 26952 * @form 26953 * @atomicservice 26954 * @since 11 26955 */ 26956 /** 26957 * aboutToAppear Method and it is migrated from class CustomComponent. 26958 * 26959 * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. 26960 * 26961 * @syscap SystemCapability.ArkUI.ArkUI.Full 26962 * @crossplatform 26963 * @form 26964 * @atomicservice 26965 * @since 18 26966 */ 26967 aboutToAppear?(): void; 26968 26969 /** 26970 * aboutToDisappear Method 26971 * 26972 * The aboutToDisappear function executes before a custom component is destroyed. 26973 * 26974 * @syscap SystemCapability.ArkUI.ArkUI.Full 26975 * @since 7 26976 */ 26977 /** 26978 * aboutToDisappear Method 26979 * 26980 * The aboutToDisappear function executes before a custom component is destroyed. 26981 * 26982 * @syscap SystemCapability.ArkUI.ArkUI.Full 26983 * @form 26984 * @since 9 26985 */ 26986 /** 26987 * aboutToDisappear Method 26988 * 26989 * The aboutToDisappear function executes before a custom component is destroyed. 26990 * 26991 * @syscap SystemCapability.ArkUI.ArkUI.Full 26992 * @crossplatform 26993 * @form 26994 * @since 10 26995 */ 26996 /** 26997 * aboutToDisappear Method 26998 * 26999 * The aboutToDisappear function executes before a custom component is destroyed. 27000 * 27001 * @syscap SystemCapability.ArkUI.ArkUI.Full 27002 * @crossplatform 27003 * @form 27004 * @atomicservice 27005 * @since 11 27006 */ 27007 /** 27008 * aboutToDisappear Method and it is migrated from class CustomComponent. 27009 * 27010 * The aboutToDisappear function executes before a custom component is destroyed. 27011 * 27012 * @syscap SystemCapability.ArkUI.ArkUI.Full 27013 * @crossplatform 27014 * @form 27015 * @atomicservice 27016 * @since 18 27017 */ 27018 aboutToDisappear?(): void; 27019 27020 /** 27021 * aboutToRecycle Method 27022 * 27023 * @syscap SystemCapability.ArkUI.ArkUI.Full 27024 * @crossplatform 27025 * @since 10 27026 */ 27027 /** 27028 * aboutToRecycle Method 27029 * 27030 * @syscap SystemCapability.ArkUI.ArkUI.Full 27031 * @crossplatform 27032 * @atomicservice 27033 * @since 11 27034 */ 27035 /** 27036 * aboutToRecycle Method and it is migrated from class CustomComponent. 27037 * 27038 * @syscap SystemCapability.ArkUI.ArkUI.Full 27039 * @crossplatform 27040 * @atomicservice 27041 * @since 18 27042 */ 27043 aboutToRecycle?(): void; 27044 27045 /** 27046 * The onWillApplyTheme function is a custom hook to get active theme object from the context 27047 * 27048 * @param { Theme } theme - Custom theme init params. 27049 * @syscap SystemCapability.ArkUI.ArkUI.Full 27050 * @crossplatform 27051 * @atomicservice 27052 * @since 12 27053 */ 27054 /** 27055 * The onWillApplyTheme function is a custom hook to get active theme object from the context, it is migrated from class CustomComponent. 27056 * 27057 * @param { Theme } theme - Custom theme init params. 27058 * @syscap SystemCapability.ArkUI.ArkUI.Full 27059 * @crossplatform 27060 * @atomicservice 27061 * @since 18 27062 */ 27063 onWillApplyTheme?(theme: Theme): void; 27064 27065 /** 27066 * Custom component override this method to layout each of its sub components. 27067 * 27068 * @param { GeometryInfo } selfLayoutInfo 27069 * @param { Array<Layoutable> } children 27070 * @param { ConstraintSizeOptions } constraint 27071 * @syscap SystemCapability.ArkUI.ArkUI.Full 27072 * @crossplatform 27073 * @since 10 27074 */ 27075 /** 27076 * Custom component override this method to layout each of its sub components. 27077 * 27078 * @param { GeometryInfo } selfLayoutInfo 27079 * @param { Array<Layoutable> } children 27080 * @param { ConstraintSizeOptions } constraint 27081 * @syscap SystemCapability.ArkUI.ArkUI.Full 27082 * @crossplatform 27083 * @atomicservice 27084 * @since 11 27085 */ 27086 /** 27087 * Custom component override this method to layout each of its sub components, it is migrated from class CustomComponent. 27088 * 27089 * @param { GeometryInfo } selfLayoutInfo 27090 * @param { Array<Layoutable> } children 27091 * @param { ConstraintSizeOptions } constraint 27092 * @syscap SystemCapability.ArkUI.ArkUI.Full 27093 * @crossplatform 27094 * @atomicservice 27095 * @since 18 27096 */ 27097 onPlaceChildren?(selfLayoutInfo: GeometryInfo, children: Array<Layoutable>, constraint: ConstraintSizeOptions): void; 27098 27099 /** 27100 * Custom component override this method to measure each of its sub components. 27101 * @param { GeometryInfo } selfLayoutInfo 27102 * @param { Array<Measurable> } children - indicate the measure child 27103 * @param { ConstraintSizeOptions } constraint - indicate child constraint size 27104 * @returns { SizeResult } 27105 * @syscap SystemCapability.ArkUI.ArkUI.Full 27106 * @crossplatform 27107 * @since 10 27108 */ 27109 /** 27110 * Custom component override this method to measure each of its sub components. 27111 * @param { GeometryInfo } selfLayoutInfo 27112 * @param { Array<Measurable> } children - indicate the measure child 27113 * @param { ConstraintSizeOptions } constraint - indicate child constraint size 27114 * @returns { SizeResult } 27115 * @syscap SystemCapability.ArkUI.ArkUI.Full 27116 * @crossplatform 27117 * @atomicservice 27118 * @since 11 27119 */ 27120 /** 27121 * Custom component override this method to measure each of its sub components, it is migrated from class CustomComponent. 27122 * @param { GeometryInfo } selfLayoutInfo 27123 * @param { Array<Measurable> } children - indicate the measure child 27124 * @param { ConstraintSizeOptions } constraint - indicate child constraint size 27125 * @returns { SizeResult } 27126 * @syscap SystemCapability.ArkUI.ArkUI.Full 27127 * @crossplatform 27128 * @atomicservice 27129 * @since 18 27130 */ 27131 onMeasureSize?(selfLayoutInfo: GeometryInfo, children: Array<Measurable>, constraint: ConstraintSizeOptions): SizeResult; 27132 27133 /** 27134 * onPageShow Method 27135 * 27136 * The page is triggered once each time it is displayed, including scenarios such as the routing process and the application entering the foreground 27137 * 27138 * @syscap SystemCapability.ArkUI.ArkUI.Full 27139 * @since 7 27140 */ 27141 /** 27142 * onPageShow Method 27143 * 27144 * The page is triggered once each time it is displayed, including scenarios such as the routing process and the application entering the foreground 27145 * 27146 * @syscap SystemCapability.ArkUI.ArkUI.Full 27147 * @crossplatform 27148 * @since 10 27149 */ 27150 /** 27151 * onPageShow Method 27152 * 27153 * The page is triggered once each time it is displayed, including scenarios such as the routing process and the application entering the foreground 27154 * 27155 * @syscap SystemCapability.ArkUI.ArkUI.Full 27156 * @crossplatform 27157 * @atomicservice 27158 * @since 11 27159 */ 27160 /** 27161 * onPageShow Method and it is migrated from class CustomComponent. 27162 * 27163 * The page is triggered once each time it is displayed, including scenarios such as the routing process and the application entering the foreground 27164 * 27165 * @syscap SystemCapability.ArkUI.ArkUI.Full 27166 * @crossplatform 27167 * @atomicservice 27168 * @since 18 27169 */ 27170 onPageShow?(): void; 27171 27172 /** 27173 * onPageHide Method 27174 * 27175 * It is triggered once each time the page is hidden, including scenarios such as the routing process and the application entering the background 27176 * 27177 * @syscap SystemCapability.ArkUI.ArkUI.Full 27178 * @since 7 27179 */ 27180 /** 27181 * onPageHide Method 27182 * 27183 * It is triggered once each time the page is hidden, including scenarios such as the routing process and the application entering the background 27184 * 27185 * @syscap SystemCapability.ArkUI.ArkUI.Full 27186 * @crossplatform 27187 * @since 10 27188 */ 27189 /** 27190 * onPageHide Method 27191 * 27192 * It is triggered once each time the page is hidden, including scenarios such as the routing process and the application entering the background 27193 * 27194 * @syscap SystemCapability.ArkUI.ArkUI.Full 27195 * @crossplatform 27196 * @atomicservice 27197 * @since 11 27198 */ 27199 /** 27200 * onPageHide Method and it is migrated from class CustomComponent. 27201 * 27202 * It is triggered once each time the page is hidden, including scenarios such as the routing process and the application entering the background 27203 * 27204 * @syscap SystemCapability.ArkUI.ArkUI.Full 27205 * @crossplatform 27206 * @atomicservice 27207 * @since 18 27208 */ 27209 onPageHide?(): void; 27210 27211 /** 27212 * onFormRecycle Method, this is only for ArkTS form, if form was marked recyclable by form user, when system memory is low, 27213 * it will be recycled after calling this method, you should return a string of params that you wish to be saved, it will be 27214 * passed back as params in onFormRecover, in which you can recover the form 27215 * 27216 * @returns { string } status data of ArkTS form UI, this data will be passed in when recover form later 27217 * @syscap SystemCapability.ArkUI.ArkUI.Full 27218 * @crossplatform 27219 * @form 27220 * @since 11 27221 */ 27222 /** 27223 * onFormRecycle Method, this is only for ArkTS form, if form was marked recyclable by form user, when system memory is low, 27224 * it will be recycled after calling this method, you should return a string of params that you wish to be saved, it will be 27225 * passed back as params in onFormRecover, in which you can recover the form 27226 * 27227 * @returns { string } status data of ArkTS form UI, this data will be passed in when recover form later 27228 * @syscap SystemCapability.ArkUI.ArkUI.Full 27229 * @crossplatform 27230 * @form 27231 * @atomicservice 27232 * @since 12 27233 */ 27234 /** 27235 * onFormRecycle Method, this is only for ArkTS form, if form was marked recyclable by form user, when system memory is low, 27236 * it will be recycled after calling this method, you should return a string of params that you wish to be saved, it will be 27237 * passed back as params in onFormRecover, in which you can recover the form, it is migrated from class CustomComponent. 27238 * 27239 * @returns { string } status data of ArkTS form UI, this data will be passed in when recover form later 27240 * @syscap SystemCapability.ArkUI.ArkUI.Full 27241 * @crossplatform 27242 * @form 27243 * @atomicservice 27244 * @since 18 27245 */ 27246 onFormRecycle?(): string; 27247 27248 /** 27249 * onFormRecover Method, this is only for ArkTS form 27250 * 27251 * @param { string } statusData - indicate status data of ArkTS form UI, which is acquired by calling onFormRecycle, it is used to recover form 27252 * @syscap SystemCapability.ArkUI.ArkUI.Full 27253 * @crossplatform 27254 * @form 27255 * @since 11 27256 */ 27257 /** 27258 * onFormRecover Method, this is only for ArkTS form 27259 * 27260 * @param { string } statusData - indicate status data of ArkTS form UI, which is acquired by calling onFormRecycle, it is used to recover form 27261 * @syscap SystemCapability.ArkUI.ArkUI.Full 27262 * @crossplatform 27263 * @form 27264 * @atomicservice 27265 * @since 12 27266 */ 27267 /** 27268 * onFormRecover Method, this is only for ArkTS form, it is migrated from class CustomComponent. 27269 * 27270 * @param { string } statusData - indicate status data of ArkTS form UI, which is acquired by calling onFormRecycle, it is used to recover form 27271 * @syscap SystemCapability.ArkUI.ArkUI.Full 27272 * @crossplatform 27273 * @form 27274 * @atomicservice 27275 * @since 18 27276 */ 27277 onFormRecover?(statusData: string): void; 27278 27279 /** 27280 * onBackPress Method 27281 * 27282 * Triggered when the user clicks the back button 27283 * 27284 * @returns { void | boolean } 27285 * @syscap SystemCapability.ArkUI.ArkUI.Full 27286 * @since 7 27287 */ 27288 /** 27289 * onBackPress Method 27290 * 27291 * Triggered when the user clicks the back button 27292 * 27293 * @returns { void | boolean } true means that the page itself processes the return logic. 27294 * false means that the default return logic is used. 27295 * If no value is returned, the default return logic is used. 27296 * @syscap SystemCapability.ArkUI.ArkUI.Full 27297 * @crossplatform 27298 * @since 10 27299 */ 27300 /** 27301 * onBackPress Method 27302 * 27303 * Triggered when the user clicks the back button 27304 * 27305 * @returns { void | boolean } true means that the page itself processes the return logic. 27306 * false means that the default return logic is used. 27307 * If no value is returned, the default return logic is used. 27308 * @syscap SystemCapability.ArkUI.ArkUI.Full 27309 * @crossplatform 27310 * @atomicservice 27311 * @since 11 27312 */ 27313 /** 27314 * onBackPress Method and it is migrated from class CustomComponent. 27315 * 27316 * Triggered when the user clicks the back button 27317 * 27318 * @returns { void | boolean } true means that the page itself processes the return logic. 27319 * false means that the default return logic is used. 27320 * If no value is returned, the default return logic is used. 27321 * @syscap SystemCapability.ArkUI.ArkUI.Full 27322 * @crossplatform 27323 * @atomicservice 27324 * @since 18 27325 */ 27326 onBackPress?(): void | boolean; 27327 27328 /** 27329 * PageTransition Method. 27330 * Implement Animation when enter this page or move to other pages. 27331 * 27332 * @syscap SystemCapability.ArkUI.ArkUI.Full 27333 * @since 9 27334 */ 27335 /** 27336 * PageTransition Method. 27337 * Implement Animation when enter this page or move to other pages. 27338 * 27339 * @syscap SystemCapability.ArkUI.ArkUI.Full 27340 * @crossplatform 27341 * @since 10 27342 */ 27343 /** 27344 * PageTransition Method. 27345 * Implement Animation when enter this page or move to other pages. 27346 * 27347 * @syscap SystemCapability.ArkUI.ArkUI.Full 27348 * @crossplatform 27349 * @atomicservice 27350 * @since 11 27351 */ 27352 /** 27353 * PageTransition Method and it is migrated from class CustomComponent. 27354 * Implement Animation when enter this page or move to other pages. 27355 * 27356 * @syscap SystemCapability.ArkUI.ArkUI.Full 27357 * @crossplatform 27358 * @atomicservice 27359 * @since 18 27360 */ 27361 pageTransition?(): void; 27362 27363 /** 27364 * Get current UIContext 27365 * 27366 * @returns { UIContext } The UIContext that the custom component belongs to. 27367 * @syscap SystemCapability.ArkUI.ArkUI.Full 27368 * @crossplatform 27369 * @since 11 27370 */ 27371 /** 27372 * Get current UIContext 27373 * 27374 * @returns { UIContext } The UIContext that the custom component belongs to. 27375 * @syscap SystemCapability.ArkUI.ArkUI.Full 27376 * @crossplatform 27377 * @atomicservice 27378 * @since 12 27379 */ 27380 /** 27381 * Get current UIContext and it is migrated from class CustomComponent. 27382 * 27383 * @returns { UIContext } The UIContext that the custom component belongs to. 27384 * @syscap SystemCapability.ArkUI.ArkUI.Full 27385 * @crossplatform 27386 * @atomicservice 27387 * @since 18 27388 */ 27389 getUIContext(): UIContext; 27390 27391 /** 27392 * Get uniqueId of the custom component. 27393 * 27394 * @returns { number } - The uniqueId of the custom component. 27395 * @syscap SystemCapability.ArkUI.ArkUI.Full 27396 * @crossplatform 27397 * @atomicservice 27398 * @since 12 27399 */ 27400 /** 27401 * Get uniqueId of the custom component and it is migrated from class CustomComponent. 27402 * 27403 * @returns { number } - The uniqueId of the custom component. 27404 * @syscap SystemCapability.ArkUI.ArkUI.Full 27405 * @crossplatform 27406 * @atomicservice 27407 * @since 18 27408 */ 27409 getUniqueId(): number; 27410 27411 /** 27412 * Queries the navigation destination information. 27413 * 27414 * @returns { NavDestinationInfo | undefined } The navigation destination information, or undefined if it is not available. 27415 * @syscap SystemCapability.ArkUI.ArkUI.Full 27416 * @crossplatform 27417 * @since 11 27418 */ 27419 /** 27420 * Queries the navigation destination information. 27421 * 27422 * @returns { NavDestinationInfo | undefined } The navigation destination information, or undefined if it is not available. 27423 * @syscap SystemCapability.ArkUI.ArkUI.Full 27424 * @crossplatform 27425 * @atomicservice 27426 * @since 12 27427 */ 27428 /** 27429 * Queries the navigation destination information and it is migrated from class CustomComponent. 27430 * 27431 * @returns { NavDestinationInfo | undefined } The navigation destination information, or undefined if it is not available. 27432 * @syscap SystemCapability.ArkUI.ArkUI.Full 27433 * @crossplatform 27434 * @atomicservice 27435 * @since 18 27436 */ 27437 queryNavDestinationInfo(): NavDestinationInfo | undefined; 27438 27439 /** 27440 * Queries the navigation destination information. 27441 * 27442 * @param { Optional<boolean> } [isInner] 27443 * @returns { NavDestinationInfo | undefined } The navigation destination information, or undefined if it is not available. 27444 * @syscap SystemCapability.ArkUI.ArkUI.Full 27445 * @crossplatform 27446 * @atomicservice 27447 * @since 18 27448 */ 27449 queryNavDestinationInfo(isInner: Optional<boolean>): NavDestinationInfo | undefined; 27450 27451 /** 27452 * Query the navigation information of the current custom component. 27453 * 27454 * @returns { NavigationInfo | undefined } The navigation information, or undefined if it is not available 27455 * @syscap SystemCapability.ArkUI.ArkUI.Full 27456 * @crossplatform 27457 * @atomicservice 27458 * @since 12 27459 */ 27460 /** 27461 * Query the navigation information of the current custom component and it is migrated from class CustomComponent. 27462 * 27463 * @returns { NavigationInfo | undefined } The navigation information, or undefined if it is not available 27464 * @syscap SystemCapability.ArkUI.ArkUI.Full 27465 * @crossplatform 27466 * @atomicservice 27467 * @since 18 27468 */ 27469 queryNavigationInfo(): NavigationInfo | undefined; 27470 27471 /** 27472 * Query the router page information of the current custom component. 27473 * 27474 * @returns { RouterPageInfo | undefined } The router page information, or undefined if it is not available. 27475 * @syscap SystemCapability.ArkUI.ArkUI.Full 27476 * @crossplatform 27477 * @atomicservice 27478 * @since 12 27479 */ 27480 /** 27481 * Query the router page information of the current custom component and it is migrated from class CustomComponent. 27482 * 27483 * @returns { RouterPageInfo | undefined } The router page information, or undefined if it is not available. 27484 * @syscap SystemCapability.ArkUI.ArkUI.Full 27485 * @crossplatform 27486 * @atomicservice 27487 * @since 18 27488 */ 27489 queryRouterPageInfo(): RouterPageInfo | undefined; 27490 27491 /** 27492 * The callback method after the custom component is built. 27493 * 27494 * Triggered when the custom component has been built. 27495 * 27496 * @syscap SystemCapability.ArkUI.ArkUI.Full 27497 * @crossplatform 27498 * @atomicservice 27499 * @since 12 27500 */ 27501 /** 27502 * The callback method after the custom component is built and it is migrated from class CustomComponent. 27503 * 27504 * Triggered when the custom component has been built. 27505 * 27506 * @syscap SystemCapability.ArkUI.ArkUI.Full 27507 * @crossplatform 27508 * @atomicservice 27509 * @since 18 27510 */ 27511 onDidBuild?(): void; 27512 27513 /** 27514 * The dialog controller of the custom component. 27515 * 27516 * @returns { PromptActionDialogController | undefined } The controller of dialog, or undefined if it is not available 27517 * @syscap SystemCapability.ArkUI.ArkUI.Full 27518 * @crossplatform 27519 * @atomicservice 27520 * @since 18 27521 */ 27522 getDialogController(): PromptActionDialogController | undefined; 27523} 27524/** 27525 * View 27526 * 27527 * @syscap SystemCapability.ArkUI.ArkUI.Full 27528 * @systemapi 27529 * @since 7 27530 */ 27531/** 27532 * View 27533 * 27534 * @syscap SystemCapability.ArkUI.ArkUI.Full 27535 * @systemapi 27536 * @form 27537 * @since 9 27538 */ 27539declare class View { 27540 /** 27541 * Just use for generate tsbundle 27542 * 27543 * @param { any } value 27544 * @returns { any } 27545 * @syscap SystemCapability.ArkUI.ArkUI.Full 27546 * @systemapi 27547 * @since 7 27548 */ 27549 /** 27550 * Just use for generate tsbundle 27551 * 27552 * @param { any } value 27553 * @returns { any } 27554 * @syscap SystemCapability.ArkUI.ArkUI.Full 27555 * @systemapi 27556 * @form 27557 * @since 9 27558 */ 27559 create(value: any): any; 27560} 27561 27562/** 27563 * Rect info. 27564 * 27565 * @interface RectResult 27566 * @syscap SystemCapability.ArkUI.ArkUI.Full 27567 * @crossplatform 27568 * @since 10 27569 */ 27570/** 27571 * Rect info. 27572 * 27573 * @interface RectResult 27574 * @syscap SystemCapability.ArkUI.ArkUI.Full 27575 * @crossplatform 27576 * @atomicservice 27577 * @since 11 27578 */ 27579declare interface RectResult { 27580 /** 27581 * x:Horizontal coordinate relative to the component. 27582 * 27583 * @type { number } 27584 * @syscap SystemCapability.ArkUI.ArkUI.Full 27585 * @since 10 27586 */ 27587 /** 27588 * x:Horizontal coordinate relative to the component. 27589 * 27590 * @type { number } 27591 * @syscap SystemCapability.ArkUI.ArkUI.Full 27592 * @crossplatform 27593 * @atomicservice 27594 * @since 11 27595 */ 27596 x: number; 27597 27598 /** 27599 * y:Vertical axis coordinate relative to the component. 27600 * 27601 * @type { number } 27602 * @syscap SystemCapability.ArkUI.ArkUI.Full 27603 * @since 10 27604 */ 27605 /** 27606 * y:Vertical axis coordinate relative to the component. 27607 * 27608 * @type { number } 27609 * @syscap SystemCapability.ArkUI.ArkUI.Full 27610 * @crossplatform 27611 * @atomicservice 27612 * @since 11 27613 */ 27614 y: number; 27615 27616 /** 27617 * Get the width of the current textRect. 27618 * 27619 * @type { number } 27620 * @syscap SystemCapability.ArkUI.ArkUI.Full 27621 * @since 10 27622 */ 27623 /** 27624 * Get the width of the current textRect. 27625 * 27626 * @type { number } 27627 * @syscap SystemCapability.ArkUI.ArkUI.Full 27628 * @crossplatform 27629 * @atomicservice 27630 * @since 11 27631 */ 27632 width: number; 27633 27634 /** 27635 * Get the height of the current textRect. 27636 * 27637 * @type { number } 27638 * @syscap SystemCapability.ArkUI.ArkUI.Full 27639 * @since 10 27640 */ 27641 /** 27642 * Get the height of the current textRect. 27643 * 27644 * @type { number } 27645 * @syscap SystemCapability.ArkUI.ArkUI.Full 27646 * @crossplatform 27647 * @atomicservice 27648 * @since 11 27649 */ 27650 height: number; 27651} 27652 27653/** 27654 * CaretOffset info. 27655 * 27656 * @interface CaretOffset 27657 * @syscap SystemCapability.ArkUI.ArkUI.Full 27658 * @crossplatform 27659 * @since 11 27660 */ 27661/** 27662 * CaretOffset info. 27663 * 27664 * @interface CaretOffset 27665 * @syscap SystemCapability.ArkUI.ArkUI.Full 27666 * @crossplatform 27667 * @atomicservice 27668 * @since 12 27669 */ 27670declare interface CaretOffset { 27671 /** 27672 * Get the index of the CaretOffset 27673 * 27674 * @type { number } 27675 * @syscap SystemCapability.ArkUI.ArkUI.Full 27676 * @since 11 27677 */ 27678 /** 27679 * Get the index of the CaretOffset 27680 * 27681 * @type { number } 27682 * @syscap SystemCapability.ArkUI.ArkUI.Full 27683 * @atomicservice 27684 * @since 12 27685 */ 27686 index: number; 27687 27688 /** 27689 * Get the x of the relative position. 27690 * 27691 * @type { number } 27692 * @syscap SystemCapability.ArkUI.ArkUI.Full 27693 * @since 11 27694 */ 27695 /** 27696 * Get the x of the relative position. 27697 * 27698 * @type { number } 27699 * @syscap SystemCapability.ArkUI.ArkUI.Full 27700 * @atomicservice 27701 * @since 12 27702 */ 27703 x: number; 27704 27705 /** 27706 * Get the y of the relative position. 27707 * 27708 * @type { number } 27709 * @syscap SystemCapability.ArkUI.ArkUI.Full 27710 * @since 11 27711 */ 27712 /** 27713 * Get the y of the relative position. 27714 * 27715 * @type { number } 27716 * @syscap SystemCapability.ArkUI.ArkUI.Full 27717 * @atomicservice 27718 * @since 12 27719 */ 27720 y: number; 27721} 27722 27723/** 27724 * Defines the span options of TextContentController. 27725 * 27726 * @interface TextContentControllerOptions 27727 * @syscap SystemCapability.ArkUI.ArkUI.Full 27728 * @crossplatform 27729 * @atomicservice 27730 * @since 15 27731 */ 27732declare interface TextContentControllerOptions { 27733 /** 27734 * the offset that add a text at. 27735 * 27736 * @type { ?number } 27737 * @syscap SystemCapability.ArkUI.ArkUI.Full 27738 * @crossplatform 27739 * @atomicservice 27740 * @since 15 27741 */ 27742 offset?: number; 27743} 27744 27745/** 27746 * TextContentControllerBase 27747 * 27748 * @syscap SystemCapability.ArkUI.ArkUI.Full 27749 * @crossplatform 27750 * @since 10 27751 */ 27752/** 27753 * TextContentControllerBase 27754 * 27755 * @syscap SystemCapability.ArkUI.ArkUI.Full 27756 * @crossplatform 27757 * @atomicservice 27758 * @since 11 27759 */ 27760declare abstract class TextContentControllerBase { 27761 /** 27762 * Get the index and relative position of the CaretOffset. 27763 * 27764 * @returns { CaretOffset } index and relative position of the CaretOffset. 27765 * @syscap SystemCapability.ArkUI.ArkUI.Full 27766 * @crossplatform 27767 * @since 11 27768 */ 27769 /** 27770 * Get the index and relative position of the CaretOffset. 27771 * 27772 * @returns { CaretOffset } index and relative position of the CaretOffset. 27773 * @syscap SystemCapability.ArkUI.ArkUI.Full 27774 * @crossplatform 27775 * @atomicservice 27776 * @since 12 27777 */ 27778 getCaretOffset() : CaretOffset; 27779 27780 /** 27781 * Get the start and end positions of the text content. 27782 * 27783 * @returns { RectResult } Text content rect. 27784 * @syscap SystemCapability.ArkUI.ArkUI.Full 27785 * @crossplatform 27786 * @since 10 27787 */ 27788 /** 27789 * Get the start and end positions of the text content. 27790 * 27791 * @returns { RectResult } Text content rect. 27792 * @syscap SystemCapability.ArkUI.ArkUI.Full 27793 * @crossplatform 27794 * @atomicservice 27795 * @since 11 27796 */ 27797 getTextContentRect() : RectResult; 27798 27799 /** 27800 * Get the lines number of the text content. 27801 * 27802 * @returns { number } Text content line count 27803 * @syscap SystemCapability.ArkUI.ArkUI.Full 27804 * @crossplatform 27805 * @since 10 27806 */ 27807 /** 27808 * Get the lines number of the text content. 27809 * 27810 * @returns { number } Text content line count 27811 * @syscap SystemCapability.ArkUI.ArkUI.Full 27812 * @crossplatform 27813 * @atomicservice 27814 * @since 11 27815 */ 27816 getTextContentLineCount() : number; 27817 27818 /** 27819 * Add a text. 27820 * 27821 * @param { string } text - text value. 27822 * @param { TextContentControllerOptions } [textOperationOptions] - operation info. 27823 * @returns { number } caret index 27824 * @syscap SystemCapability.ArkUI.ArkUI.Full 27825 * @crossplatform 27826 * @atomicservice 27827 * @since 15 27828 */ 27829 addText(text: string, textOperationOptions?: TextContentControllerOptions): number; 27830 27831 /** 27832 * Delete text in TextRange. 27833 * 27834 * @param { TextRange } [range] - range for deleting. 27835 * @syscap SystemCapability.ArkUI.ArkUI.Full 27836 * @crossplatform 27837 * @atomicservice 27838 * @since 15 27839 */ 27840 deleteText(range?: TextRange): void; 27841 27842 /** 27843 * Gets the selected range of text content. 27844 * 27845 * @returns { TextRange } range for selecting. 27846 * @syscap SystemCapability.ArkUI.ArkUI.Full 27847 * @crossplatform 27848 * @atomicservice 27849 * @since 15 27850 */ 27851 getSelection(): TextRange; 27852 27853 /** 27854 * Clear the content of preview. 27855 * 27856 * @syscap SystemCapability.ArkUI.ArkUI.Full 27857 * @atomicservice 27858 * @since 17 27859 */ 27860 clearPreviewText(): void; 27861} 27862 27863/** 27864 * Enum of scrollable containers' content clip mode. 27865 * 27866 * @enum { number } 27867 * @syscap SystemCapability.ArkUI.ArkUI.Full 27868 * @crossplatform 27869 * @atomicservice 27870 * @since 14 27871 */ 27872declare enum ContentClipMode { 27873 /** 27874 * Clip to content rect inside margin & padding. 27875 * 27876 * @syscap SystemCapability.ArkUI.ArkUI.Full 27877 * @crossplatform 27878 * @atomicservice 27879 * @since 14 27880 */ 27881 CONTENT_ONLY = 0, 27882 27883 /** 27884 * Clip to scrollable's outer rect, including padding but inside margin. 27885 * 27886 * @syscap SystemCapability.ArkUI.ArkUI.Full 27887 * @crossplatform 27888 * @atomicservice 27889 * @since 14 27890 */ 27891 BOUNDARY = 1, 27892 27893 /** 27894 * Clip to the safeArea of scrollable container. 27895 * 27896 * @syscap SystemCapability.ArkUI.ArkUI.Full 27897 * @crossplatform 27898 * @atomicservice 27899 * @since 14 27900 */ 27901 SAFE_AREA = 2, 27902} 27903 27904/** 27905 * CommonScrollableMethod 27906 * 27907 * @extends CommonMethod<T> 27908 * @syscap SystemCapability.ArkUI.ArkUI.Full 27909 * @crossplatform 27910 * @atomicservice 27911 * @since 11 27912 */ 27913/** 27914 * CommonScrollableMethod 27915 * 27916 * @extends CommonMethod<T> 27917 * @syscap SystemCapability.ArkUI.ArkUI.Full 27918 * @crossplatform 27919 * @form 27920 * @atomicservice 27921 * @since 12 27922 */ 27923declare class ScrollableCommonMethod<T> extends CommonMethod<T> { 27924 /** 27925 * Scrollbar status. 27926 * 27927 * @param { BarState } barState - Scrollbar status. 27928 * @returns { T } 27929 * @syscap SystemCapability.ArkUI.ArkUI.Full 27930 * @crossplatform 27931 * @atomicservice 27932 * @since 11 27933 */ 27934 scrollBar(barState: BarState): T; 27935 27936 /** 27937 * Color of the scrollbar. 27938 * 27939 * @param { Color | number | string } color - Color of the scrollbar. 27940 * @returns { T } 27941 * @syscap SystemCapability.ArkUI.ArkUI.Full 27942 * @crossplatform 27943 * @atomicservice 27944 * @since 11 27945 */ 27946 scrollBarColor(color: Color | number | string): T; 27947 27948 /** 27949 * Width of the scrollbar. 27950 * 27951 * @param { number | string } value - Width of the scrollbar. 27952 * @returns { T } 27953 * @syscap SystemCapability.ArkUI.ArkUI.Full 27954 * @crossplatform 27955 * @atomicservice 27956 * @since 11 27957 */ 27958 scrollBarWidth(value: number | string): T; 27959 27960 /** 27961 * Edge scrolling effect. 27962 * 27963 * @param { EdgeEffect } edgeEffect - edge scrolling effect. 27964 * @param { EdgeEffectOptions } options - edge scrolling effect options. 27965 * @returns { T } 27966 * @syscap SystemCapability.ArkUI.ArkUI.Full 27967 * @crossplatform 27968 * @atomicservice 27969 * @since 11 27970 */ 27971 edgeEffect(edgeEffect: EdgeEffect, options?: EdgeEffectOptions): T; 27972 27973 /** 27974 * Called when setting whether to enable fading Edge effect. 27975 * 27976 * @param { Optional<boolean> } enabled - Whether to turn on the edge fade effect 27977 * @param { FadingEdgeOptions } [options] - The options of fadingEdge. 27978 * @returns { T } 27979 * @syscap SystemCapability.ArkUI.ArkUI.Full 27980 * @crossplatform 27981 * @atomicservice 27982 * @since 14 27983 */ 27984 fadingEdge(enabled: Optional<boolean>, options?: FadingEdgeOptions): T; 27985 27986 /** 27987 * Nested scrolling options. 27988 * 27989 * @param { NestedScrollOptions } value - options for nested scrolling. 27990 * @returns { T } 27991 * @syscap SystemCapability.ArkUI.ArkUI.Full 27992 * @crossplatform 27993 * @atomicservice 27994 * @since 11 27995 */ 27996 nestedScroll(value: NestedScrollOptions): T; 27997 27998 /** 27999 * Whether to support scroll gestures by finger or mouse. 28000 * 28001 * @param { boolean } value - Whether to support scroll gestures by finger or mouse. 28002 * @returns { T } 28003 * @syscap SystemCapability.ArkUI.ArkUI.Full 28004 * @crossplatform 28005 * @atomicservice 28006 * @since 11 28007 */ 28008 enableScrollInteraction(value: boolean): T; 28009 28010 /** 28011 * Friction coefficient. 28012 * 28013 * @param { number | Resource } value - friction coefficient. 28014 * @returns { T } 28015 * @syscap SystemCapability.ArkUI.ArkUI.Full 28016 * @crossplatform 28017 * @atomicservice 28018 * @since 11 28019 */ 28020 friction(value: number | Resource): T; 28021 28022 /** 28023 * Called when the scrollable scrolls. 28024 * 28025 * @param { function } event - callback of scrollable, 28026 * scrollOffset is offset per frame scrolling, ScrollState is current scroll state. 28027 * @returns { T } 28028 * @syscap SystemCapability.ArkUI.ArkUI.Full 28029 * @crossplatform 28030 * @atomicservice 28031 * @since 11 28032 * @deprecated since 12 28033 * @useinstead ScrollableCommonMethod#onDidScroll 28034 */ 28035 onScroll(event: (scrollOffset: number, scrollState: ScrollState) => void): T; 28036 28037 /** 28038 * Called when the scrollable will scroll. 28039 * 28040 * @param { Optional<OnWillScrollCallback> } handler - callback of scrollable. 28041 * @returns { T } 28042 * @syscap SystemCapability.ArkUI.ArkUI.Full 28043 * @crossplatform 28044 * @atomicservice 28045 * @since 12 28046 */ 28047 onWillScroll(handler: Optional<OnWillScrollCallback>): T; 28048 28049 /** 28050 * Called when the scrollable did scroll. 28051 * 28052 * @param { OnScrollCallback } handler - callback of scrollable, 28053 * scrollOffset is offset this frame did scroll, scrollState is current scroll state. 28054 * @returns { T } 28055 * @syscap SystemCapability.ArkUI.ArkUI.Full 28056 * @crossplatform 28057 * @form 28058 * @atomicservice 28059 * @since 12 28060 */ 28061 onDidScroll(handler: OnScrollCallback): T; 28062 28063 /** 28064 * Called when the scrollable reaches the start position. 28065 * 28066 * @param { function } event - Callback function, triggered when the scrollable reaches the start position. 28067 * @returns { T } 28068 * @syscap SystemCapability.ArkUI.ArkUI.Full 28069 * @crossplatform 28070 * @atomicservice 28071 * @since 11 28072 */ 28073 onReachStart(event: () => void): T; 28074 28075 /** 28076 * Called when the scrollable reaches the end position. 28077 * 28078 * @param { function } event - Callback function, triggered when the scrollable reaches the end position. 28079 * @returns { T } 28080 * @syscap SystemCapability.ArkUI.ArkUI.Full 28081 * @crossplatform 28082 * @atomicservice 28083 * @since 11 28084 */ 28085 onReachEnd(event: () => void): T; 28086 28087 /** 28088 * Called when the scrollable starts scrolling. 28089 * 28090 * @param { function } event - Callback function, triggered when the scrollable starts scrolling. 28091 * @returns { T } 28092 * @syscap SystemCapability.ArkUI.ArkUI.Full 28093 * @crossplatform 28094 * @atomicservice 28095 * @since 11 28096 */ 28097 onScrollStart(event: () => void): T; 28098 28099 /** 28100 * Called when the scrollable stops scrolling. 28101 * 28102 * @param { function } event - Callback function, triggered when the scrollable stops scrolling. 28103 * @returns { T } 28104 * @syscap SystemCapability.ArkUI.ArkUI.Full 28105 * @crossplatform 28106 * @atomicservice 28107 * @since 11 28108 */ 28109 onScrollStop(event: () => void): T; 28110 28111 /** 28112 * Limit the max speed when fling. 28113 * 28114 * @param { number } speedLimit - Max fling speed, the minimum value is 0, the maximum value is not limited. 28115 * The unit is vp/s. 28116 * @returns { T } 28117 * @syscap SystemCapability.ArkUI.ArkUI.Full 28118 * @crossplatform 28119 * @atomicservice 28120 * @since 11 28121 */ 28122 flingSpeedLimit(speedLimit: number): T; 28123 28124 /** 28125 * Clip the content of the scrollable container, excluding background. 28126 * 28127 * @param { ContentClipMode | RectShape } clip - A value from enum ContentClipMode or a customized clip rect. 28128 * @returns { T } 28129 * @syscap SystemCapability.ArkUI.ArkUI.Full 28130 * @crossplatform 28131 * @atomicservice 28132 * @since 14 28133 */ 28134 clipContent(clip: ContentClipMode | RectShape): T; 28135 28136 /** 28137 * Set the sensitivity of rotating crown. 28138 * 28139 * @param { Optional<CrownSensitivity> } sensitivity - The sensitivity of rotating crown, default value is { MEDIUM }. 28140 * @returns { T } The component instance. 28141 * @syscap SystemCapability.ArkUI.ArkUI.Full 28142 * @crossplatform 28143 * @atomicservice 28144 * @since 18 28145 */ 28146 digitalCrownSensitivity(sensitivity: Optional<CrownSensitivity>): T; 28147 28148 /** 28149 * Controls whether the scrollable scrolls back to top when status bar is clicked. 28150 * 28151 * @param { boolean } backToTop - whether the scrollable scrolls back to top when status bar is clicked. 28152 * The default value is false. 28153 * @returns { T } 28154 * @syscap SystemCapability.ArkUI.ArkUI.Full 28155 * @crossplatform 28156 * @atomicservice 28157 * @since 15 28158 */ 28159 backToTop(backToTop: boolean): T; 28160} 28161 28162/** 28163 * The actual offset by which the scrollable scrolls. 28164 * @syscap SystemCapability.ArkUI.ArkUI.Full 28165 * @crossplatform 28166 * @atomicservice 28167 * @since 12 28168 */ 28169declare class ScrollResult { 28170 /** 28171 * Actual offset by which the scrollable scrolls in vp. 28172 * @type { number } 28173 * @syscap SystemCapability.ArkUI.ArkUI.Full 28174 * @crossplatform 28175 * @atomicservice 28176 * @since 12 28177 */ 28178 offsetRemain: number; 28179} 28180 28181/** 28182 * Called before scroll to allow developer to control real offset the Scrollable can scroll. 28183 * 28184 * @typedef { function } OnWillScrollCallback 28185 * @param { number } scrollOffset - offset this frame will scroll, which may or may not be reached. 28186 * @param { ScrollState } scrollState - current scroll state. 28187 * @param { ScrollSource } scrollSource - source of current scroll. 28188 * @returns { void | ScrollResult } the remain offset for the scrollable, 28189 * same as scrollOffset when no ScrollResult is returned. 28190 * @syscap SystemCapability.ArkUI.ArkUI.Full 28191 * @crossplatform 28192 * @atomicservice 28193 * @since 12 28194 */ 28195declare type OnWillScrollCallback = 28196(scrollOffset: number, scrollState: ScrollState, scrollSource: ScrollSource) => void | ScrollResult; 28197 28198/** 28199 * On scroll callback using in scrollable onDidScroll. 28200 * 28201 * @typedef { function } OnScrollCallback 28202 * @param { number } scrollOffset - offset this frame did scroll. 28203 * @param { ScrollState } scrollState - current scroll state. 28204 * @syscap SystemCapability.ArkUI.ArkUI.Full 28205 * @crossplatform 28206 * @form 28207 * @atomicservice 28208 * @since 12 28209 */ 28210declare type OnScrollCallback = (scrollOffset: number, scrollState: ScrollState) => void; 28211 28212/** 28213 * Defines the onMove callback. 28214 * 28215 * @typedef { function } OnMoveHandler 28216 * @param { number } from - Index number for moving elements. 28217 * @param { number } to - Target index number for moving elements. 28218 * @syscap SystemCapability.ArkUI.ArkUI.Full 28219 * @crossplatform 28220 * @atomicservice 28221 * @since 12 28222 */ 28223declare type OnMoveHandler = (from: number, to: number) => void; 28224 28225/** 28226 * Define DynamicNode. 28227 * 28228 * @syscap SystemCapability.ArkUI.ArkUI.Full 28229 * @crossplatform 28230 * @atomicservice 28231 * @since 12 28232 */ 28233declare class DynamicNode<T> { 28234 /** 28235 * Set the move action. 28236 * 28237 * @param { Optional<OnMoveHandler> } handler 28238 * @returns { T } 28239 * @syscap SystemCapability.ArkUI.ArkUI.Full 28240 * @crossplatform 28241 * @atomicservice 28242 * @since 12 28243 */ 28244 onMove(handler: Optional<OnMoveHandler>): T; 28245} 28246 28247/** 28248 * Define EdgeEffect Options. 28249 * 28250 * @interface EdgeEffectOptions 28251 * @syscap SystemCapability.ArkUI.ArkUI.Full 28252 * @crossplatform 28253 * @since 11 28254 */ 28255/** 28256 * Define EdgeEffect Options. 28257 * 28258 * @interface EdgeEffectOptions 28259 * @syscap SystemCapability.ArkUI.ArkUI.Full 28260 * @crossplatform 28261 * @atomicservice 28262 * @since 12 28263 */ 28264declare interface EdgeEffectOptions { 28265 /** 28266 * Enable Sliding effect when component does not full screen. 28267 * 28268 * @type { boolean } 28269 * @syscap SystemCapability.ArkUI.ArkUI.Full 28270 * @crossplatform 28271 * @since 11 28272 */ 28273 /** 28274 * Enable Sliding effect when component does not full screen. 28275 * 28276 * @type { boolean } 28277 * @syscap SystemCapability.ArkUI.ArkUI.Full 28278 * @crossplatform 28279 * @atomicservice 28280 * @since 12 28281 */ 28282 alwaysEnabled: boolean; 28283 28284 /** 28285 * Set the effective edge of the edge effect. 28286 * 28287 * @type { ?number } 28288 * @syscap SystemCapability.ArkUI.ArkUI.Full 28289 * @crossplatform 28290 * @atomicservice 28291 * @since 18 28292 */ 28293 effectEdge?: number; 28294} 28295 28296/** 28297 * Enumerates the effective edge of the edge effect. 28298 * 28299 * @enum { number } 28300 * @syscap SystemCapability.ArkUI.ArkUI.Full 28301 * @crossplatform 28302 * @atomicservice 28303 * @since 18 28304 */ 28305declare enum EffectEdge { 28306 28307 /** 28308 * Effective only for the starting edge. 28309 * 28310 * @syscap SystemCapability.ArkUI.ArkUI.Full 28311 * @crossplatform 28312 * @atomicservice 28313 * @since 18 28314 */ 28315 START = 1, 28316 28317 /** 28318 * Effective only for the end edge. 28319 * 28320 * @syscap SystemCapability.ArkUI.ArkUI.Full 28321 * @crossplatform 28322 * @atomicservice 28323 * @since 18 28324 */ 28325 END = 2, 28326} 28327 28328/** 28329 * Indicates children main size. 28330 * 28331 * @syscap SystemCapability.ArkUI.ArkUI.Full 28332 * @crossplatform 28333 * @atomicservice 28334 * @since 12 28335 */ 28336declare class ChildrenMainSize { 28337 /** 28338 * Creates an instance of ChildrenMainSize. 28339 * 28340 * @param { number } childDefaultSize - default main size, in vp. If the main axis is vertical, it indicates height. 28341 * If the main axis is horizontal, it indicates width. 28342 * @throws { BusinessError } 401 - Parameter error. Possible causes: 28343 * <br> 1. Mandatory parameters are left unspecified. 28344 * <br> 2. Incorrect parameters types. 28345 * <br> 3. Parameter verification failed. 28346 * @syscap SystemCapability.ArkUI.ArkUI.Full 28347 * @crossplatform 28348 * @atomicservice 28349 * @since 12 28350 */ 28351 constructor(childDefaultSize: number); 28352 28353 /** 28354 * Set default size. 28355 * 28356 * @param { number } value - default main size, in vp. If the main axis is vertical, it indicates height. 28357 * If the main axis is horizontal, it indicates width. 28358 * @throws { BusinessError } 401 - Parameter error. Possible causes: 28359 * <br> 1. Mandatory parameters are left unspecified. 28360 * <br> 2. Incorrect parameters types. 28361 * <br> 3. Parameter verification failed. 28362 * @syscap SystemCapability.ArkUI.ArkUI.Full 28363 * @crossplatform 28364 * @atomicservice 28365 * @since 12 28366 */ 28367 set childDefaultSize(value: number); 28368 28369 /** 28370 * Get default size 28371 * 28372 * @returns { number } - default main size, in vp. If the main axis is vertical, it indicates height. 28373 * If the main axis is horizontal, it indicates width. 28374 * @syscap SystemCapability.ArkUI.ArkUI.Full 28375 * @crossplatform 28376 * @atomicservice 28377 * @since 12 28378 */ 28379 get childDefaultSize(): number; 28380 28381 /** 28382 * Changes children main size by removing or replacing existing elements and/or adding new elements in place. 28383 * 28384 * @param { number } start - Zero-based index at which to start changing the children main size. 28385 * @param { number } [deleteCount] - Indicating the number of children main size to remove from start. 28386 * @param { Array<number> } [childrenSize] - Add the new children main size, beginning from start. 28387 * @throws { BusinessError } 401 - Parameter error. Possible causes: 28388 * <br> 1. Mandatory parameters are left unspecified. 28389 * <br> 2. Incorrect parameters types. 28390 * <br> 3. Parameter verification failed. 28391 * @syscap SystemCapability.ArkUI.ArkUI.Full 28392 * @crossplatform 28393 * @atomicservice 28394 * @since 12 28395 * @example splice(1, 0, [100]), Insert a child after first child, the child's main size is 100vp. 28396 * splice(1, 1), Delete the second child. 28397 * splice(1, 2, [100, 100]), Change the main size of the second and third children to 100vp. 28398 */ 28399 splice(start: number, deleteCount?: number, childrenSize?: Array<number>): void; 28400 28401 /** 28402 * Updates main size for specified child. 28403 * 28404 * @param { number } index - index of child to be updated. 28405 * @param { number } childSize - new section options. 28406 * @throws { BusinessError } 401 - Parameter error. Possible causes: 28407 * <br> 1. Mandatory parameters are left unspecified. 28408 * <br> 2. Incorrect parameters types. 28409 * <br> 3. Parameter verification failed. 28410 * @syscap SystemCapability.ArkUI.ArkUI.Full 28411 * @crossplatform 28412 * @atomicservice 28413 * @since 12 28414 */ 28415 update(index: number, childSize: number): void; 28416} 28417 28418/** 28419 * Define BackgroundBrightness Options. 28420 * 28421 * @interface BackgroundBrightnessOptions 28422 * @syscap SystemCapability.ArkUI.ArkUI.Full 28423 * @atomicservice 28424 * @since 12 28425 */ 28426declare interface BackgroundBrightnessOptions { 28427 28428 /** 28429 * Rate represents the rate at which lightUpDegree 28430 * decreases with increasing pixel brightness. 28431 * 28432 * @type { number } -The default value is 0.0, value range: (0.0, +∞). 28433 * @syscap SystemCapability.ArkUI.ArkUI.Full 28434 * @atomicservice 28435 * @since 12 28436 */ 28437 rate: number; 28438 28439 /** 28440 * LightUpDegree represents the degree of brightness 28441 * of the rgb value changes when its brightness 28442 * is 0. 28443 * 28444 * @type { number } -The default value is 0.0, value range: [-1.0, 1.0]. 28445 * @syscap SystemCapability.ArkUI.ArkUI.Full 28446 * @atomicservice 28447 * @since 12 28448 */ 28449 lightUpDegree: number; 28450} 28451 28452/** 28453 * PointLightStyle info 28454 * 28455 * @interface PointLightStyle 28456 * @syscap SystemCapability.ArkUI.ArkUI.Full 28457 * @systemapi 28458 * @since 11 28459 */ 28460declare interface PointLightStyle { 28461 /** 28462 * Defines the PointLight light intensity and position. 28463 * 28464 * @type { ?LightSource } 28465 * @default undefined 28466 * @syscap SystemCapability.ArkUI.ArkUI.Full 28467 * @systemapi 28468 * @since 11 28469 */ 28470 lightSource?: LightSource; 28471 /** 28472 * Defines the PointLight illuminated type. 28473 * 28474 * @type { ?IlluminatedType } 28475 * @default IlluminatedType.NONE 28476 * @syscap SystemCapability.ArkUI.ArkUI.Full 28477 * @systemapi 28478 * @since 11 28479 */ 28480 illuminated?: IlluminatedType; 28481 /** 28482 * Defines the PointLight bloom. 28483 * 28484 * @type { ?number } 28485 * @default 0 28486 * @syscap SystemCapability.ArkUI.ArkUI.Full 28487 * @systemapi 28488 * @since 11 28489 */ 28490 bloom?: number; 28491} 28492 28493/** 28494 * LightSource info 28495 * 28496 * @interface LightSource 28497 * @syscap SystemCapability.ArkUI.ArkUI.Full 28498 * @systemapi 28499 * @since 11 28500 */ 28501declare interface LightSource { 28502 /** 28503 * Defines the PointLight light positionX. 28504 * 28505 * @type { Dimension } 28506 * @syscap SystemCapability.ArkUI.ArkUI.Full 28507 * @systemapi 28508 * @since 11 28509 */ 28510 positionX: Dimension; 28511 /** 28512 * Defines the PointLight light positionX. 28513 * 28514 * @type { Dimension } 28515 * @syscap SystemCapability.ArkUI.ArkUI.Full 28516 * @systemapi 28517 * @since 11 28518 */ 28519 positionY: Dimension; 28520 /** 28521 * Defines the PointLight light positionX. 28522 * 28523 * @type { Dimension } 28524 * @syscap SystemCapability.ArkUI.ArkUI.Full 28525 * @systemapi 28526 * @since 11 28527 */ 28528 positionZ: Dimension; 28529 /** 28530 * Defines the PointLight light intensity. 28531 * 28532 * @type { number } 28533 * @syscap SystemCapability.ArkUI.ArkUI.Full 28534 * @systemapi 28535 * @since 11 28536 */ 28537 intensity: number; 28538 /** 28539 * Defines the PointLight light color. 28540 * 28541 * @type { ?ResourceColor } 28542 * @syscap SystemCapability.ArkUI.ArkUI.Full 28543 * @systemapi 28544 * @since 12 28545 */ 28546 color?: ResourceColor; 28547} 28548 28549/** 28550 * Defining wrapBuilder function. 28551 * @param { function } builder 28552 * @returns { WrappedBuilder<Args> } 28553 * @syscap SystemCapability.ArkUI.ArkUI.Full 28554 * @crossplatform 28555 * @since 11 28556 */ 28557/** 28558 * Defining wrapBuilder function. 28559 * @param { function } builder 28560 * @returns { WrappedBuilder<Args> } 28561 * @syscap SystemCapability.ArkUI.ArkUI.Full 28562 * @crossplatform 28563 * @atomicservice 28564 * @since 12 28565 */ 28566declare function wrapBuilder<Args extends Object[]>(builder: (...args: Args) => void): WrappedBuilder<Args>; 28567 28568/** 28569 * Defines the WrappedBuilder class. 28570 * @syscap SystemCapability.ArkUI.ArkUI.Full 28571 * @crossplatform 28572 * @since 11 28573 */ 28574/** 28575 * Defines the WrappedBuilder class. 28576 * @syscap SystemCapability.ArkUI.ArkUI.Full 28577 * @crossplatform 28578 * @atomicservice 28579 * @since 12 28580 */ 28581declare class WrappedBuilder<Args extends Object[]> { 28582 /** 28583 * @type { function } 28584 * @syscap SystemCapability.ArkUI.ArkUI.Full 28585 * @crossplatform 28586 * @since 11 28587 */ 28588 /** 28589 * @type { function } 28590 * @syscap SystemCapability.ArkUI.ArkUI.Full 28591 * @crossplatform 28592 * @atomicservice 28593 * @since 12 28594 */ 28595 builder: (...args: Args) => void; 28596 28597 /** 28598 * @param { function } builder 28599 * @syscap SystemCapability.ArkUI.ArkUI.Full 28600 * @crossplatform 28601 * @since 11 28602 */ 28603 /** 28604 * @param { function } builder 28605 * @syscap SystemCapability.ArkUI.ArkUI.Full 28606 * @crossplatform 28607 * @atomicservice 28608 * @since 12 28609 */ 28610 constructor(builder: (...args: Args) => void); 28611} 28612 28613 28614/** 28615 * Defines the overall animation parameters of the keyframe animation. 28616 * 28617 * @interface KeyframeAnimateParam 28618 * @syscap SystemCapability.ArkUI.ArkUI.Full 28619 * @crossplatform 28620 * @since 11 28621 */ 28622/** 28623 * Defines the overall animation parameters of the keyframe animation. 28624 * 28625 * @interface KeyframeAnimateParam 28626 * @syscap SystemCapability.ArkUI.ArkUI.Full 28627 * @crossplatform 28628 * @atomicservice 28629 * @since 12 28630 */ 28631declare interface KeyframeAnimateParam { 28632 /** 28633 * Animation delay time, in ms. 28634 * 28635 * @type { ?number } 28636 * @default 0 28637 * @syscap SystemCapability.ArkUI.ArkUI.Full 28638 * @crossplatform 28639 * @since 11 28640 */ 28641 /** 28642 * Animation delay time, in ms. 28643 * 28644 * @type { ?number } 28645 * @default 0 28646 * @syscap SystemCapability.ArkUI.ArkUI.Full 28647 * @crossplatform 28648 * @atomicservice 28649 * @since 12 28650 */ 28651 delay?: number; 28652 28653 /** 28654 * Animation iterations. When set to -1, the animation playing it repeatedly. The value range is greater than or equal to -1. 28655 * 28656 * @type { ?number } 28657 * @default 1 28658 * @syscap SystemCapability.ArkUI.ArkUI.Full 28659 * @crossplatform 28660 * @since 11 28661 */ 28662 /** 28663 * Animation iterations. When set to -1, the animation playing it repeatedly. The value range is greater than or equal to -1. 28664 * 28665 * @type { ?number } 28666 * @default 1 28667 * @syscap SystemCapability.ArkUI.ArkUI.Full 28668 * @crossplatform 28669 * @atomicservice 28670 * @since 12 28671 */ 28672 iterations?: number; 28673 28674 /** 28675 * Callback invoked when the whole keyframe animation is complete or the ability is about to enter the background. 28676 * 28677 * @type { ?function } 28678 * @syscap SystemCapability.ArkUI.ArkUI.Full 28679 * @crossplatform 28680 * @since 11 28681 */ 28682 /** 28683 * Callback invoked when the whole keyframe animation is complete or the ability is about to enter the background. 28684 * 28685 * @type { ?function } 28686 * @syscap SystemCapability.ArkUI.ArkUI.Full 28687 * @crossplatform 28688 * @atomicservice 28689 * @since 12 28690 */ 28691 onFinish?: () => void; 28692} 28693 28694/** 28695 * Defines a keyframe state. 28696 * 28697 * @interface KeyframeState 28698 * @syscap SystemCapability.ArkUI.ArkUI.Full 28699 * @crossplatform 28700 * @since 11 28701 */ 28702/** 28703 * Defines a keyframe state. 28704 * 28705 * @interface KeyframeState 28706 * @syscap SystemCapability.ArkUI.ArkUI.Full 28707 * @crossplatform 28708 * @atomicservice 28709 * @since 12 28710 */ 28711declare interface KeyframeState { 28712 /** 28713 * Animation duration of this keyframe, in ms. 28714 * 28715 * @type { number } 28716 * @syscap SystemCapability.ArkUI.ArkUI.Full 28717 * @crossplatform 28718 * @since 11 28719 */ 28720 /** 28721 * Animation duration of this keyframe, in ms. 28722 * 28723 * @type { number } 28724 * @syscap SystemCapability.ArkUI.ArkUI.Full 28725 * @crossplatform 28726 * @atomicservice 28727 * @since 12 28728 */ 28729 duration: number; 28730 28731 /** 28732 * Animation curve of this keyframe. 28733 * 28734 * @type { ?(Curve | string | ICurve) } 28735 * @syscap SystemCapability.ArkUI.ArkUI.Full 28736 * @crossplatform 28737 * @since 11 28738 */ 28739 /** 28740 * Animation curve of this keyframe. 28741 * 28742 * @type { ?(Curve | string | ICurve) } 28743 * @syscap SystemCapability.ArkUI.ArkUI.Full 28744 * @crossplatform 28745 * @atomicservice 28746 * @since 12 28747 */ 28748 curve?: Curve | string | ICurve; 28749 28750 /** 28751 * The closure function to specify the terminating state of this keyframe. 28752 * 28753 * @type { function } 28754 * @syscap SystemCapability.ArkUI.ArkUI.Full 28755 * @crossplatform 28756 * @since 11 28757 */ 28758 /** 28759 * The closure function to specify the terminating state of this keyframe. 28760 * 28761 * @type { function } 28762 * @syscap SystemCapability.ArkUI.ArkUI.Full 28763 * @crossplatform 28764 * @atomicservice 28765 * @since 12 28766 */ 28767 event: () => void; 28768} 28769 28770 28771/** 28772 * Defines the basic callback. 28773 * 28774 * @typedef Callback<T, V = void> 28775 * @syscap SystemCapability.ArkUI.ArkUI.Full 28776 * @crossplatform 28777 * @atomicservice 28778 * @since 12 28779 */ 28780declare interface Callback<T, V = void> { 28781 /** 28782 * Defines the callback info. 28783 * 28784 * @param { T } data - the data will be used in the callback. 28785 * @returns { V } - Returns result of the callback. 28786 * @syscap SystemCapability.ArkUI.ArkUI.Full 28787 * @crossplatform 28788 * @atomicservice 28789 * @since 12 28790 */ 28791 (data: T): V; 28792} 28793 28794/** 28795 * Defines the callback type used in hover events. 28796 * The value of isHover indicates whether the mouse is hovering over the component. 28797 * The value of event contains information about HoverEvent. 28798 * 28799 * @typedef { function } HoverCallback 28800 * @param { boolean } isHover 28801 * @param { HoverEvent} event 28802 * @syscap SystemCapability.ArkUI.ArkUI.Full 28803 * @crossplatform 28804 * @atomicservice 28805 * @since 12 28806 */ 28807declare type HoverCallback = (isHover: boolean, event: HoverEvent) => void 28808 28809/** 28810 * Defines the callback type used in accessibility hover events. 28811 * The value of isHover indicates whether the touch is hovering over the component. 28812 * The value of event contains information about AccessibilityHoverEvent. 28813 * 28814 * @typedef { function } AccessibilityCallback 28815 * @param { boolean } isHover 28816 * @param { AccessibilityHoverEvent } event 28817 * @syscap SystemCapability.ArkUI.ArkUI.Full 28818 * @crossplatform 28819 * @atomicservice 28820 * @since 12 28821 */ 28822declare type AccessibilityCallback = (isHover: boolean, event: AccessibilityHoverEvent) => void; 28823 28824/** 28825 * Defines the options about VisibleAreaEvent. 28826 * 28827 * @interface VisibleAreaEventOptions 28828 * @syscap SystemCapability.ArkUI.ArkUI.Full 28829 * @crossplatform 28830 * @atomicservice 28831 * @since 12 28832 */ 28833declare interface VisibleAreaEventOptions { 28834 /** 28835 * Each number in ratios indicates the value of visibility ratio. Each number in the Array value range in [0, 1]. 28836 * 28837 * @type { Array<number> } 28838 * @syscap SystemCapability.ArkUI.ArkUI.Full 28839 * @crossplatform 28840 * @atomicservice 28841 * @since 12 28842 */ 28843 ratios: Array<number>; 28844 28845 /** 28846 * The value of expectedUpdateInterval indicates desired update period(ms). 28847 * 28848 * @type { ?number } 28849 * @default 1000 28850 * @syscap SystemCapability.ArkUI.ArkUI.Full 28851 * @crossplatform 28852 * @atomicservice 28853 * @since 12 28854 */ 28855 expectedUpdateInterval?: number; 28856} 28857 28858/** 28859 * Defines the callback type used in VisibleAreaChange events. 28860 * 28861 * @typedef { function } VisibleAreaChangeCallback 28862 * @param { boolean } isVisible - Indicates the ratio of the visible area to its own area compared to the last change. 28863 * It is true as the ratio increases and false as the ratio decreases. 28864 * @param { number } currentRatio - The value of currentRatio indicates the visibility ratio of the current component. 28865 * @syscap SystemCapability.ArkUI.ArkUI.Full 28866 * @crossplatform 28867 * @atomicservice 28868 * @since 12 28869 */ 28870/** 28871 * Defines the callback type used in VisibleAreaChange events. 28872 * 28873 * @typedef { function } VisibleAreaChangeCallback 28874 * @param { boolean } isExpanding - Indicates the ratio of the visible area to its own area compared to the last change. 28875 * It is true as the ratio increases and false as the ratio decreases. 28876 * @param { number } currentRatio - The value of currentRatio indicates the visibility ratio of the current component. 28877 * @syscap SystemCapability.ArkUI.ArkUI.Full 28878 * @crossplatform 28879 * @atomicservice 28880 * @since 13 28881 */ 28882declare type VisibleAreaChangeCallback = (isExpanding: boolean, currentRatio: number) => void; 28883 28884/** 28885 * Defines a UICommonEvent which is used to set different common event to target component. 28886 * 28887 * @interface UICommonEvent 28888 * @syscap SystemCapability.ArkUI.ArkUI.Full 28889 * @crossplatform 28890 * @atomicservice 28891 * @since 12 28892 */ 28893declare interface UICommonEvent { 28894 /** 28895 * Set or reset the callback which will be triggered a click event when clicked. 28896 * 28897 * @param { Callback<ClickEvent> | undefined } callback - The callback about the click event. If set undefined will reset the target callback. 28898 * @syscap SystemCapability.ArkUI.ArkUI.Full 28899 * @crossplatform 28900 * @atomicservice 28901 * @since 12 28902 */ 28903 setOnClick(callback: Callback<ClickEvent> | undefined): void; 28904 28905 /** 28906 * Set or reset the callback which will be triggered a touch event when touched. 28907 * 28908 * @param { Callback<TouchEvent> | undefined } callback - The callback about the touch event. If set undefined will reset the target callback. 28909 * @syscap SystemCapability.ArkUI.ArkUI.Full 28910 * @crossplatform 28911 * @atomicservice 28912 * @since 12 28913 */ 28914 setOnTouch(callback: Callback<TouchEvent> | undefined): void; 28915 28916 /** 28917 * Set or reset the callback is triggered when a component mounts a display. 28918 * 28919 * @param { Callback<void> | undefined } callback - The callback will be triggered when a component mounts a display. If set undefined will reset the target callback. 28920 * @syscap SystemCapability.ArkUI.ArkUI.Full 28921 * @crossplatform 28922 * @atomicservice 28923 * @since 12 28924 */ 28925 setOnAppear(callback: Callback<void> | undefined): void; 28926 28927 /** 28928 * Set or reset the callback is triggered when component uninstallation disappears. 28929 * 28930 * @param { Callback<void> | undefined } callback - The callback will be triggered when component uninstallation disappears. If set undefined will reset the target callback. 28931 * @syscap SystemCapability.ArkUI.ArkUI.Full 28932 * @crossplatform 28933 * @atomicservice 28934 * @since 12 28935 */ 28936 setOnDisappear(callback: Callback<void> | undefined): void; 28937 28938 28939 /** 28940 * Set or reset the callback is triggered when component has keyboard input. 28941 * 28942 * @param { Callback<KeyEvent> | undefined } callback - The callback will be triggered when has keyboard input. If set undefined will reset the target callback. 28943 * @syscap SystemCapability.ArkUI.ArkUI.Full 28944 * @crossplatform 28945 * @atomicservice 28946 * @since 12 28947 */ 28948 setOnKeyEvent(callback: Callback<KeyEvent> | undefined): void; 28949 28950 /** 28951 * Set or reset the callback which is triggered when component get focus. 28952 * 28953 * @param { Callback<void> | undefined } callback - The callback will be triggered when a component get focus. If set undefined will reset the target callback. 28954 * @syscap SystemCapability.ArkUI.ArkUI.Full 28955 * @crossplatform 28956 * @atomicservice 28957 * @since 12 28958 */ 28959 setOnFocus(callback: Callback<void> | undefined): void; 28960 28961 /** 28962 * Set or reset the callback which is triggered when lose focus. 28963 * 28964 * @param { Callback<void> | undefined } callback - The callback will be triggered when a component lose focus. If set undefined will reset the target callback. 28965 * @syscap SystemCapability.ArkUI.ArkUI.Full 28966 * @crossplatform 28967 * @atomicservice 28968 * @since 12 28969 */ 28970 setOnBlur(callback: Callback<void> | undefined): void; 28971 28972 /** 28973 * Set or reset the callback which is triggered when has a hover event. 28974 * 28975 * @param { HoverCallback | undefined } callback - The callback will be triggered when has a hover event. If set undefined will reset the target callback. 28976 * @syscap SystemCapability.ArkUI.ArkUI.Full 28977 * @crossplatform 28978 * @atomicservice 28979 * @since 12 28980 */ 28981 setOnHover(callback: HoverCallback | undefined): void; 28982 28983 /** 28984 * Set or reset the callback which is triggered when has a mouse event. 28985 * 28986 * @param { Callback<MouseEvent> | undefined } callback - The callback will be triggered when has mouse input. If set undefined will reset the target callback. 28987 * @syscap SystemCapability.ArkUI.ArkUI.Full 28988 * @crossplatform 28989 * @atomicservice 28990 * @since 12 28991 */ 28992 setOnMouse(callback: Callback<MouseEvent> | undefined): void; 28993 28994 /** 28995 * Set or reset the callback which is triggered when the size of component changed. 28996 * 28997 * @param { SizeChangeCallback | undefined } callback - The callback will be triggered when the size of component changed. If set undefined will reset the target callback. 28998 * @syscap SystemCapability.ArkUI.ArkUI.Full 28999 * @crossplatform 29000 * @atomicservice 29001 * @since 12 29002 */ 29003 setOnSizeChange(callback: SizeChangeCallback | undefined): void; 29004 29005 /** 29006 * Set or reset the callback which is triggered when the visibleArea of component changed. 29007 * 29008 * @param { VisibleAreaEventOptions } options - The options for the visibility event. 29009 * @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. 29010 * If set undefined will reset the target callback. 29011 * @syscap SystemCapability.ArkUI.ArkUI.Full 29012 * @crossplatform 29013 * @atomicservice 29014 * @since 12 29015 */ 29016 setOnVisibleAreaApproximateChange(options: VisibleAreaEventOptions, event: VisibleAreaChangeCallback | undefined): void; 29017} 29018 29019/** 29020 * Defines a UIGestureEvent which is used to set different gestures to target component. 29021 * 29022 * @interface UIGestureEvent 29023 * @syscap SystemCapability.ArkUI.ArkUI.Full 29024 * @crossplatform 29025 * @atomicservice 29026 * @since 12 29027 */ 29028declare interface UIGestureEvent { 29029 /** 29030 * Add a gesture bound to the component. 29031 * 29032 * @param { GestureHandler<T> } gesture - gesture indicates the gesture bound to a component. 29033 * @param { GesturePriority } priority - priority indicates the gesture's priority. 29034 * @param { GestureMask } mask - mask indicates the gesture's GestureMask value. 29035 * @syscap SystemCapability.ArkUI.ArkUI.Full 29036 * @crossplatform 29037 * @atomicservice 29038 * @since 12 29039 */ 29040 addGesture<T>(gesture: GestureHandler<T>, priority?: GesturePriority, mask?: GestureMask): void; 29041 29042 /** 29043 * Add a parallel gesture bound to the component. 29044 * 29045 * @param { GestureHandler<T> } gesture - gesture indicates the gesture bound to a component. 29046 * @param { GestureMask } mask - mask indicates the gesture's GestureMask value. 29047 * @syscap SystemCapability.ArkUI.ArkUI.Full 29048 * @crossplatform 29049 * @atomicservice 29050 * @since 12 29051 */ 29052 addParallelGesture<T>(gesture: GestureHandler<T>, mask?: GestureMask): void; 29053 29054 /** 29055 * Remove the gesture that is bound to the component and marked as tag. 29056 * 29057 * @param { string } tag - tag indicates the gesture's tag. 29058 * @syscap SystemCapability.ArkUI.ArkUI.Full 29059 * @crossplatform 29060 * @atomicservice 29061 * @since 12 29062 */ 29063 removeGestureByTag(tag: string): void; 29064 29065 /** 29066 * Clear gestures bound to the component. 29067 * 29068 * @syscap SystemCapability.ArkUI.ArkUI.Full 29069 * @crossplatform 29070 * @atomicservice 29071 * @since 12 29072 */ 29073 clearGestures(): void; 29074} 29075 29076/** 29077 * Defines the gesture modifier. 29078 * 29079 * @interface GestureModifier 29080 * @syscap SystemCapability.ArkUI.ArkUI.Full 29081 * @crossplatform 29082 * @atomicservice 29083 * @since 12 29084 */ 29085declare interface GestureModifier { 29086 /** 29087 * Defines the gesture update function. 29088 * 29089 * @param { UIGestureEvent } event 29090 * @syscap SystemCapability.ArkUI.ArkUI.Full 29091 * @crossplatform 29092 * @atomicservice 29093 * @since 12 29094 */ 29095 applyGesture(event: UIGestureEvent): void; 29096} 29097 29098/** 29099 * Defines the selection options. 29100 * 29101 * @interface SelectionOptions 29102 * @syscap SystemCapability.ArkUI.ArkUI.Full 29103 * @crossplatform 29104 * @atomicservice 29105 * @since 12 29106 */ 29107declare interface SelectionOptions { 29108 /** 29109 * Menu pop-up policy. 29110 * 29111 * @type { ?MenuPolicy } 29112 * @syscap SystemCapability.ArkUI.ArkUI.Full 29113 * @crossplatform 29114 * @atomicservice 29115 * @since 12 29116 */ 29117 menuPolicy?: MenuPolicy; 29118} 29119 29120/** 29121 * Defines the next focus item. 29122 * 29123 * @interface FocusMovement 29124 * @syscap SystemCapability.ArkUI.ArkUI.Full 29125 * @crossplatform 29126 * @atomicservice 29127 * @since 18 29128 */ 29129declare interface FocusMovement { 29130 /** 29131 * Next focus item's component identifier of forward. 29132 * 29133 * @type { ?string } 29134 * @syscap SystemCapability.ArkUI.ArkUI.Full 29135 * @crossplatform 29136 * @atomicservice 29137 * @since 18 29138 */ 29139 forward?: string; 29140 /** 29141 * Next focus item's component identifier of backward. 29142 * 29143 * @type { ?string } 29144 * @syscap SystemCapability.ArkUI.ArkUI.Full 29145 * @crossplatform 29146 * @atomicservice 29147 * @since 18 29148 */ 29149 backward?: string; 29150 /** 29151 * Next focus item's component identifier of up. 29152 * 29153 * @type { ?string } 29154 * @syscap SystemCapability.ArkUI.ArkUI.Full 29155 * @crossplatform 29156 * @atomicservice 29157 * @since 18 29158 */ 29159 up?: string; 29160 /** 29161 * Next focus item's component identifier of down. 29162 * 29163 * @type { ?string } 29164 * @syscap SystemCapability.ArkUI.ArkUI.Full 29165 * @crossplatform 29166 * @atomicservice 29167 * @since 18 29168 */ 29169 down?: string; 29170 /** 29171 * Next focus item's component identifier of left. 29172 * 29173 * @type { ?string } 29174 * @syscap SystemCapability.ArkUI.ArkUI.Full 29175 * @crossplatform 29176 * @atomicservice 29177 * @since 18 29178 */ 29179 left?: string; 29180 /** 29181 * Next focus item's component identifier of right. 29182 * 29183 * @type { ?string } 29184 * @syscap SystemCapability.ArkUI.ArkUI.Full 29185 * @crossplatform 29186 * @atomicservice 29187 * @since 18 29188 */ 29189 right?: string; 29190} 29191 29192/** 29193 * enum keyboard avoid mode 29194 * 29195 * @enum { number } 29196 * @syscap SystemCapability.ArkUI.ArkUI.Full 29197 * @crossplatform 29198 * @atomicservice 29199 * @since 12 29200 */ 29201declare enum KeyboardAvoidMode { 29202 /** 29203 * Defines avoid keyboard when keyboard shows. 29204 * 29205 * @syscap SystemCapability.ArkUI.ArkUI.Full 29206 * @crossplatform 29207 * @atomicservice 29208 * @since 12 29209 */ 29210 DEFAULT = 0, 29211 29212 /** 29213 * Defines not avoid keyboard when keyboard shows. 29214 * 29215 * @syscap SystemCapability.ArkUI.ArkUI.Full 29216 * @crossplatform 29217 * @atomicservice 29218 * @since 12 29219 */ 29220 NONE = 1, 29221} 29222 29223/** 29224 * Enumerates the type of area in hover mode. 29225 * 29226 * @enum { number } 29227 * @syscap SystemCapability.ArkUI.ArkUI.Full 29228 * @crossplatform 29229 * @atomicservice 29230 * @since 14 29231 */ 29232declare enum HoverModeAreaType { 29233 29234 /** 29235 * Layout top half screen when the phone in hover mode. 29236 * 29237 * @syscap SystemCapability.ArkUI.ArkUI.Full 29238 * @crossplatform 29239 * @atomicservice 29240 * @since 14 29241 */ 29242 TOP_SCREEN = 0, 29243 29244 /** 29245 * Layout bottom half screen when the phone in hover mode. 29246 * 29247 * @syscap SystemCapability.ArkUI.ArkUI.Full 29248 * @crossplatform 29249 * @atomicservice 29250 * @since 14 29251 */ 29252 BOTTOM_SCREEN = 1, 29253} 29254