1/* 2 * Copyright (c) 2021-2023 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16/** 17 * @file 18 * @kit ArkUI 19 */ 20 21/** 22 * Defines the options of Component ClassDecorator. 23 * 24 * @interface ComponentOptions 25 * @syscap SystemCapability.ArkUI.ArkUI.Full 26 * @crossplatform 27 * @form 28 * @since 11 29 */ 30/** 31 * Defines the options of Component ClassDecorator. 32 * 33 * @interface ComponentOptions 34 * @syscap SystemCapability.ArkUI.ArkUI.Full 35 * @crossplatform 36 * @form 37 * @atomicservice 38 * @since 12 39 */ 40declare interface ComponentOptions { 41 /** 42 * freeze UI state. 43 * 44 * @type { boolean } 45 * @default false 46 * @syscap SystemCapability.ArkUI.ArkUI.Full 47 * @crossplatform 48 * @form 49 * @since 11 50 */ 51 /** 52 * freeze UI state. 53 * 54 * @type { boolean } 55 * @default false 56 * @syscap SystemCapability.ArkUI.ArkUI.Full 57 * @crossplatform 58 * @form 59 * @atomicservice 60 * @since 12 61 */ 62 freezeWhenInactive : boolean, 63} 64 65/** 66 * Define the ratio of characters entered by the the percentage of InputCounterOptions. 67 * 68 * @interface InputCounterOptions 69 * @syscap SystemCapability.ArkUI.ArkUI.Full 70 * @crossplatform 71 * @since 11 72 */ 73/** 74 * Define the ratio of characters entered by the the percentage of InputCounterOptions. 75 * 76 * @interface InputCounterOptions 77 * @syscap SystemCapability.ArkUI.ArkUI.Full 78 * @crossplatform 79 * @atomicservice 80 * @since 12 81 */ 82declare interface InputCounterOptions { 83 /** 84 * It is the numerator bit of the percentage and used as a threshold. If the number of characters input 85 * reaches the maximum number of characters multiplied by this threshold, the counter is displayed. 86 * @type { ?number } 87 * @syscap SystemCapability.ArkUI.ArkUI.Full 88 * @crossplatform 89 * @since 11 90 */ 91 /** 92 * It is the numerator bit of the percentage and used as a threshold. If the number of characters input 93 * reaches the maximum number of characters multiplied by this threshold, the counter is displayed. 94 * @type { ?number } 95 * @syscap SystemCapability.ArkUI.ArkUI.Full 96 * @crossplatform 97 * @atomicservice 98 * @since 12 99 */ 100 thresholdPercentage?: number; 101 102 /** 103 * If the current input character count reaches the maximum character count and users want to exceed the 104 * normal input, the border will turn red. If this parameter is true, the red border displayed. 105 * @type { ?boolean } 106 * @default true 107 * @syscap SystemCapability.ArkUI.ArkUI.Full 108 * @crossplatform 109 * @since 11 110 */ 111 /** 112 * If the current input character count reaches the maximum character count and users want to exceed the 113 * normal input, the border will turn red. If this parameter is true, the red border displayed. 114 * @type { ?boolean } 115 * @default true 116 * @syscap SystemCapability.ArkUI.ArkUI.Full 117 * @crossplatform 118 * @atomicservice 119 * @since 12 120 */ 121 highlightBorder?: boolean; 122} 123 124/** 125 * Defines the options of decoration. 126 * 127 * @interface TextDecorationOptions 128 * @syscap SystemCapability.ArkUI.ArkUI.Full 129 * @crossplatform 130 * @atomicservice 131 * @since 12 132 */ 133declare interface TextDecorationOptions { 134 /** 135 * The decoration type. 136 * 137 * @type { TextDecorationType } 138 * @syscap SystemCapability.ArkUI.ArkUI.Full 139 * @crossplatform 140 * @atomicservice 141 * @since 12 142 */ 143 type: TextDecorationType; 144 145 /** 146 * Sets the color of decoration. 147 * 148 * @type { ?ResourceColor } 149 * @syscap SystemCapability.ArkUI.ArkUI.Full 150 * @crossplatform 151 * @atomicservice 152 * @since 12 153 */ 154 color?: ResourceColor; 155 156 /** 157 * The style value of decoration. 158 * 159 * @type { ?TextDecorationStyle } 160 * @syscap SystemCapability.ArkUI.ArkUI.Full 161 * @crossplatform 162 * @atomicservice 163 * @since 12 164 */ 165 style?: TextDecorationStyle; 166} 167 168/** 169 * Defining Component ClassDecorator 170 * 171 * @syscap SystemCapability.ArkUI.ArkUI.Full 172 * @since 7 173 */ 174/** 175 * Defining Component ClassDecorator 176 * 177 * @syscap SystemCapability.ArkUI.ArkUI.Full 178 * @form 179 * @since 9 180 */ 181/** 182 * Defining Component ClassDecorator 183 * 184 * @syscap SystemCapability.ArkUI.ArkUI.Full 185 * @crossplatform 186 * @form 187 * @since 10 188 */ 189/** 190 * Defining Component ClassDecorator 191 * 192 * Component is a ClassDecorator and it supports ComponentOptions as parameters. 193 * @syscap SystemCapability.ArkUI.ArkUI.Full 194 * @crossplatform 195 * @form 196 * @atomicservice 197 * @since 11 198 */ 199declare const Component: ClassDecorator & ((options: ComponentOptions) => ClassDecorator); 200 201/** 202 * Defining ComponentV2 ClassDecorator 203 * 204 * ComponentV2 is a ClassDecorator and it supports ComponentOptions as parameters. 205 * @syscap SystemCapability.ArkUI.ArkUI.Full 206 * @crossplatform 207 * @atomicservice 208 * @since 12 209 */ 210declare const ComponentV2: ClassDecorator & ((options: ComponentOptions) => ClassDecorator); 211 212/** 213 * Defines the options of Entry ClassDecorator. 214 * 215 * @interface EntryOptions 216 * @syscap SystemCapability.ArkUI.ArkUI.Full 217 * @form 218 * @since 10 219 */ 220/** 221 * Defines the options of Entry ClassDecorator. 222 * 223 * @interface EntryOptions 224 * @syscap SystemCapability.ArkUI.ArkUI.Full 225 * @form 226 * @atomicservice 227 * @since 11 228 */ 229declare interface EntryOptions { 230 /** 231 * Named route name. 232 * 233 * @type { ?string } 234 * @syscap SystemCapability.ArkUI.ArkUI.Full 235 * @form 236 * @since 10 237 */ 238 /** 239 * Named route name. 240 * 241 * @type { ?string } 242 * @syscap SystemCapability.ArkUI.ArkUI.Full 243 * @form 244 * @atomicservice 245 * @since 11 246 */ 247 routeName? : string, 248 249 /** 250 * LocalStorage to be passed. 251 * 252 * @type { ?LocalStorage } 253 * @syscap SystemCapability.ArkUI.ArkUI.Full 254 * @form 255 * @since 10 256 */ 257 /** 258 * LocalStorage to be passed. 259 * 260 * @type { ?LocalStorage } 261 * @syscap SystemCapability.ArkUI.ArkUI.Full 262 * @form 263 * @atomicservice 264 * @since 11 265 */ 266 storage? : LocalStorage, 267 268 /** 269 * Determines whether to use the LocalStorage instance object returned by the LocalStorage.getShared() interface. 270 * 271 * @type { ?boolean } 272 * @syscap SystemCapability.ArkUI.ArkUI.Full 273 * @crossplatform 274 * @form 275 * @atomicservice 276 * @since 12 277 */ 278 useSharedStorage? : boolean, 279} 280 281/** 282 * Defines Entry ClassDecorator. 283 * 284 * @syscap SystemCapability.ArkUI.ArkUI.Full 285 * @since 7 286 */ 287/** 288 * Defines Entry ClassDecorator. 289 * 290 * Entry is a ClassDecorator and it supports LocalStorage as parameters. 291 * @syscap SystemCapability.ArkUI.ArkUI.Full 292 * @form 293 * @since 9 294 */ 295/** 296 * Defines Entry ClassDecorator. 297 * 298 * Entry is a ClassDecorator and it supports LocalStorage or EntryOptions as parameters. 299 * @syscap SystemCapability.ArkUI.ArkUI.Full 300 * @crossplatform 301 * @form 302 * @since 10 303 */ 304/** 305 * Defines Entry ClassDecorator. 306 * 307 * Entry is a ClassDecorator and it supports LocalStorage or EntryOptions as parameters. 308 * @syscap SystemCapability.ArkUI.ArkUI.Full 309 * @crossplatform 310 * @form 311 * @atomicservice 312 * @since 11 313 */ 314declare const Entry: ClassDecorator & ((options?: LocalStorage | EntryOptions) => ClassDecorator); 315 316/** 317 * Defining Observed ClassDecorator. 318 * 319 * @syscap SystemCapability.ArkUI.ArkUI.Full 320 * @since 7 321 */ 322/** 323 * Defining Observed ClassDecorator. 324 * 325 * @syscap SystemCapability.ArkUI.ArkUI.Full 326 * @form 327 * @since 9 328 */ 329/** 330 * Defining Observed ClassDecorator. 331 * 332 * @syscap SystemCapability.ArkUI.ArkUI.Full 333 * @crossplatform 334 * @form 335 * @since 10 336 */ 337/** 338 * Defining Observed ClassDecorator. 339 * 340 * @syscap SystemCapability.ArkUI.ArkUI.Full 341 * @crossplatform 342 * @form 343 * @atomicservice 344 * @since 11 345 */ 346declare const Observed: ClassDecorator; 347 348/** 349 * Defining ObservedV2 ClassDecorator. 350 * 351 * @syscap SystemCapability.ArkUI.ArkUI.Full 352 * @crossplatform 353 * @form 354 * @atomicservice 355 * @since 12 356 */ 357declare const ObservedV2: ClassDecorator; 358 359/** 360 * Defining Preview ClassDecorator. 361 * 362 * @syscap SystemCapability.ArkUI.ArkUI.Full 363 * @since 7 364 */ 365/** 366 * Defining Preview ClassDecorator. 367 * 368 * @syscap SystemCapability.ArkUI.ArkUI.Full 369 * @form 370 * @since 9 371 */ 372/** 373 * Defining Preview ClassDecorator. 374 * 375 * @syscap SystemCapability.ArkUI.ArkUI.Full 376 * @crossplatform 377 * @form 378 * @since 10 379 */ 380/** 381 * Defining Preview ClassDecorator. 382 * 383 * @syscap SystemCapability.ArkUI.ArkUI.Full 384 * @crossplatform 385 * @form 386 * @atomicservice 387 * @since 11 388 */ 389declare const Preview: ClassDecorator & ((value: PreviewParams) => ClassDecorator); 390 391/** 392 * Defining Require PropertyDecorator. 393 * 394 * @syscap SystemCapability.ArkUI.ArkUI.Full 395 * @crossplatform 396 * @form 397 * @atomicservice 398 * @since 11 399 */ 400declare const Require: PropertyDecorator; 401 402/** 403 * Defining BuilderParam PropertyDecorator 404 * 405 * @syscap SystemCapability.ArkUI.ArkUI.Full 406 * @since 7 407 */ 408/** 409 * Defining BuilderParam PropertyDecorator 410 * 411 * @syscap SystemCapability.ArkUI.ArkUI.Full 412 * @form 413 * @since 9 414 */ 415/** 416 * Defining BuilderParam PropertyDecorator 417 * 418 * @syscap SystemCapability.ArkUI.ArkUI.Full 419 * @crossplatform 420 * @form 421 * @since 10 422 */ 423/** 424 * Defining BuilderParam PropertyDecorator 425 * 426 * @syscap SystemCapability.ArkUI.ArkUI.Full 427 * @crossplatform 428 * @form 429 * @atomicservice 430 * @since 11 431 */ 432declare const BuilderParam: PropertyDecorator; 433 434/** 435 * Defining Local PropertyDecorator. 436 * 437 * @syscap SystemCapability.ArkUI.ArkUI.Full 438 * @crossplatform 439 * @atomicservice 440 * @since 12 441 */ 442declare const Local: PropertyDecorator; 443 444/** 445 * Defining Param PropertyDecorator. 446 * 447 * @syscap SystemCapability.ArkUI.ArkUI.Full 448 * @crossplatform 449 * @atomicservice 450 * @since 12 451 */ 452declare const Param: PropertyDecorator; 453 454/** 455 * Defining Once PropertyDecorator. 456 * 457 * @syscap SystemCapability.ArkUI.ArkUI.Full 458 * @crossplatform 459 * @atomicservice 460 * @since 12 461 */ 462declare const Once: PropertyDecorator; 463 464/** 465 * Defining Event PropertyDecorator. 466 * 467 * @syscap SystemCapability.ArkUI.ArkUI.Full 468 * @crossplatform 469 * @atomicservice 470 * @since 12 471 */ 472declare const Event: PropertyDecorator; 473 474/** 475 * Defining State PropertyDecorator. 476 * 477 * @syscap SystemCapability.ArkUI.ArkUI.Full 478 * @since 7 479 */ 480/** 481 * Defining State PropertyDecorator. 482 * 483 * @syscap SystemCapability.ArkUI.ArkUI.Full 484 * @form 485 * @since 9 486 */ 487/** 488 * Defining State PropertyDecorator. 489 * 490 * @syscap SystemCapability.ArkUI.ArkUI.Full 491 * @crossplatform 492 * @form 493 * @since 10 494 */ 495/** 496 * Defining State PropertyDecorator. 497 * 498 * @syscap SystemCapability.ArkUI.ArkUI.Full 499 * @crossplatform 500 * @form 501 * @atomicservice 502 * @since 11 503 */ 504declare const State: PropertyDecorator; 505 506/** 507 * Defining Track PropertyDecorator. 508 * 509 * @syscap SystemCapability.ArkUI.ArkUI.Full 510 * @crossplatform 511 * @form 512 * @since 11 513 */ 514/** 515 * Defining Track PropertyDecorator. 516 * 517 * @syscap SystemCapability.ArkUI.ArkUI.Full 518 * @crossplatform 519 * @form 520 * @atomicservice 521 * @since 12 522 */ 523declare const Track: PropertyDecorator; 524 525/** 526 * Defining Trace PropertyDecorator. 527 * 528 * @syscap SystemCapability.ArkUI.ArkUI.Full 529 * @crossplatform 530 * @form 531 * @atomicservice 532 * @since 12 533 */ 534declare const Trace: PropertyDecorator; 535 536/** 537 * Defining Prop PropertyDecorator. 538 * 539 * @syscap SystemCapability.ArkUI.ArkUI.Full 540 * @since 7 541 */ 542/** 543 * Defining Prop PropertyDecorator. 544 * 545 * @syscap SystemCapability.ArkUI.ArkUI.Full 546 * @form 547 * @since 9 548 */ 549/** 550 * Defining Prop PropertyDecorator. 551 * 552 * @syscap SystemCapability.ArkUI.ArkUI.Full 553 * @crossplatform 554 * @form 555 * @since 10 556 */ 557/** 558 * Defining Prop PropertyDecorator. 559 * 560 * @syscap SystemCapability.ArkUI.ArkUI.Full 561 * @crossplatform 562 * @form 563 * @atomicservice 564 * @since 11 565 */ 566declare const Prop: PropertyDecorator; 567 568/** 569 * Defining Link PropertyDecorator. 570 * 571 * @syscap SystemCapability.ArkUI.ArkUI.Full 572 * @since 7 573 */ 574/** 575 * Defining Link PropertyDecorator. 576 * 577 * @syscap SystemCapability.ArkUI.ArkUI.Full 578 * @form 579 * @since 9 580 */ 581/** 582 * Defining Link PropertyDecorator. 583 * 584 * @syscap SystemCapability.ArkUI.ArkUI.Full 585 * @crossplatform 586 * @form 587 * @since 10 588 */ 589/** 590 * Defining Link PropertyDecorator. 591 * 592 * @syscap SystemCapability.ArkUI.ArkUI.Full 593 * @crossplatform 594 * @form 595 * @atomicservice 596 * @since 11 597 */ 598declare const Link: PropertyDecorator; 599 600/** 601 * Defining ObjectLink PropertyDecorator. 602 * 603 * @syscap SystemCapability.ArkUI.ArkUI.Full 604 * @since 7 605 */ 606/** 607 * Defining ObjectLink PropertyDecorator. 608 * 609 * @syscap SystemCapability.ArkUI.ArkUI.Full 610 * @form 611 * @since 9 612 */ 613/** 614 * Defining ObjectLink PropertyDecorator. 615 * 616 * @syscap SystemCapability.ArkUI.ArkUI.Full 617 * @crossplatform 618 * @form 619 * @since 10 620 */ 621/** 622 * Defining ObjectLink PropertyDecorator. 623 * 624 * @syscap SystemCapability.ArkUI.ArkUI.Full 625 * @crossplatform 626 * @form 627 * @atomicservice 628 * @since 11 629 */ 630declare const ObjectLink: PropertyDecorator; 631 632/** 633 * Defines the options of Provide PropertyDecorator. 634 * 635 * @interface ProvideOptions 636 * @syscap SystemCapability.ArkUI.ArkUI.Full 637 * @crossplatform 638 * @form 639 * @atomicservice 640 * @since 11 641 */ 642declare interface ProvideOptions { 643 /** 644 * Override the @Provide of any parent or parent of parent @Component.@Provide({allowOverride: "name"}) is 645 * also allowed to be used even when there is no ancestor @Component whose @Provide would be overridden. 646 * 647 * @type { ?string } 648 * @syscap SystemCapability.ArkUI.ArkUI.Full 649 * @crossplatform 650 * @form 651 * @atomicservice 652 * @since 11 653 */ 654 allowOverride?: string, 655} 656 657/** 658 * Defining Provide PropertyDecorator. 659 * 660 * @syscap SystemCapability.ArkUI.ArkUI.Full 661 * @since 7 662 */ 663/** 664 * Defining Provide PropertyDecorator. 665 * 666 * @syscap SystemCapability.ArkUI.ArkUI.Full 667 * @form 668 * @since 9 669 */ 670/** 671 * Defining Provide PropertyDecorator. 672 * 673 * @syscap SystemCapability.ArkUI.ArkUI.Full 674 * @crossplatform 675 * @form 676 * @since 10 677 */ 678/** 679 * Defining Provide PropertyDecorator. 680 * 681 * @syscap SystemCapability.ArkUI.ArkUI.Full 682 * @crossplatform 683 * @form 684 * @atomicservice 685 * @since 11 686 */ 687declare const Provide: PropertyDecorator & ((value: string | ProvideOptions) => PropertyDecorator); 688 689/** 690 * Defining Provider PropertyDecorator, aliasName is the only matching key and if aliasName is the default, the default attribute name is regarded as aliasName. 691 * @syscap SystemCapability.ArkUI.ArkUI.Full 692 * @crossplatform 693 * @atomicservice 694 * @since 12 695 */ 696declare const Provider: (aliasName?: string) => PropertyDecorator; 697 698/** 699 * Defining Consume PropertyDecorator. 700 * 701 * @syscap SystemCapability.ArkUI.ArkUI.Full 702 * @since 7 703 */ 704/** 705 * Defining Consume PropertyDecorator. 706 * 707 * @syscap SystemCapability.ArkUI.ArkUI.Full 708 * @form 709 * @since 9 710 */ 711/** 712 * Defining Consume PropertyDecorator. 713 * 714 * @syscap SystemCapability.ArkUI.ArkUI.Full 715 * @crossplatform 716 * @form 717 * @since 10 718 */ 719/** 720 * Defining Consume PropertyDecorator. 721 * 722 * @syscap SystemCapability.ArkUI.ArkUI.Full 723 * @crossplatform 724 * @form 725 * @atomicservice 726 * @since 11 727 */ 728declare const Consume: PropertyDecorator & ((value: string) => PropertyDecorator); 729 730/** 731* Defining Consumer PropertyDecorator, aliasName is the only matching key and if aliasName is the default, the default attribute name is regarded as aliasName. 732* And @Consumer will find the nearest @Provider. 733* @syscap SystemCapability.ArkUI.ArkUI.Full 734* @crossplatform 735* @atomicservice 736* @since 12 737*/ 738declare const Consumer: (aliasName?: string) => PropertyDecorator; 739 740/** 741* Defining Computed MethodDecorator. 742* 743* @syscap SystemCapability.ArkUI.ArkUI.Full 744* @crossplatform 745* @atomicservice 746* @since 12 747*/ 748declare const Computed: MethodDecorator; 749 750/** 751 * Defining StorageProp PropertyDecorator. 752 * 753 * @syscap SystemCapability.ArkUI.ArkUI.Full 754 * @since 7 755 */ 756/** 757 * Defining StorageProp PropertyDecorator. 758 * 759 * @syscap SystemCapability.ArkUI.ArkUI.Full 760 * @crossplatform 761 * @since 10 762 */ 763/** 764 * Defining StorageProp PropertyDecorator. 765 * 766 * @syscap SystemCapability.ArkUI.ArkUI.Full 767 * @crossplatform 768 * @atomicservice 769 * @since 11 770 */ 771declare const StorageProp: (value: string) => PropertyDecorator; 772 773/** 774 * Defining StorageLink PropertyDecorator. 775 * 776 * @syscap SystemCapability.ArkUI.ArkUI.Full 777 * @since 7 778 */ 779/** 780 * Defining StorageLink PropertyDecorator. 781 * 782 * @syscap SystemCapability.ArkUI.ArkUI.Full 783 * @crossplatform 784 * @since 10 785 */ 786/** 787 * Defining StorageLink PropertyDecorator. 788 * 789 * @syscap SystemCapability.ArkUI.ArkUI.Full 790 * @crossplatform 791 * @atomicservice 792 * @since 11 793 */ 794declare const StorageLink: (value: string) => PropertyDecorator; 795 796/** 797 * Defining Watch PropertyDecorator. 798 * 799 * @syscap SystemCapability.ArkUI.ArkUI.Full 800 * @since 7 801 */ 802/** 803 * Defining Watch PropertyDecorator. 804 * 805 * @syscap SystemCapability.ArkUI.ArkUI.Full 806 * @form 807 * @since 9 808 */ 809/** 810 * Defining Watch PropertyDecorator. 811 * 812 * @syscap SystemCapability.ArkUI.ArkUI.Full 813 * @crossplatform 814 * @form 815 * @since 10 816 */ 817/** 818 * Defining Watch PropertyDecorator. 819 * 820 * @syscap SystemCapability.ArkUI.ArkUI.Full 821 * @crossplatform 822 * @form 823 * @atomicservice 824 * @since 11 825 */ 826declare const Watch: (value: string) => PropertyDecorator; 827 828/** 829 * Defining Builder MethodDecorator 830 * 831 * @syscap SystemCapability.ArkUI.ArkUI.Full 832 * @since 7 833 */ 834/** 835 * Defining Builder MethodDecorator 836 * 837 * @syscap SystemCapability.ArkUI.ArkUI.Full 838 * @form 839 * @since 9 840 */ 841/** 842 * Defining Builder MethodDecorator 843 * 844 * @syscap SystemCapability.ArkUI.ArkUI.Full 845 * @crossplatform 846 * @form 847 * @since 10 848 */ 849/** 850 * Defining Builder MethodDecorator 851 * 852 * @syscap SystemCapability.ArkUI.ArkUI.Full 853 * @crossplatform 854 * @form 855 * @atomicservice 856 * @since 11 857 */ 858declare const Builder: MethodDecorator; 859 860/** 861 * Defining LocalBuilder MethodDecorator 862 * 863 * @syscap SystemCapability.ArkUI.ArkUI.Full 864 * @crossplatform 865 * @form 866 * @atomicservice 867 * @since 12 868 */ 869declare const LocalBuilder: MethodDecorator; 870 871/** 872 * Defining Styles MethodDecorator 873 * 874 * @syscap SystemCapability.ArkUI.ArkUI.Full 875 * @since 8 876 */ 877/** 878 * Defining Styles MethodDecorator 879 * 880 * @syscap SystemCapability.ArkUI.ArkUI.Full 881 * @form 882 * @since 9 883 */ 884/** 885 * Defining Styles MethodDecorator 886 * 887 * @syscap SystemCapability.ArkUI.ArkUI.Full 888 * @crossplatform 889 * @form 890 * @since 10 891 */ 892/** 893 * Defining Styles MethodDecorator 894 * 895 * @syscap SystemCapability.ArkUI.ArkUI.Full 896 * @crossplatform 897 * @form 898 * @atomicservice 899 * @since 11 900 */ 901declare const Styles: MethodDecorator; 902 903/** 904 * Defining Extend MethodDecorator 905 * 906 * @syscap SystemCapability.ArkUI.ArkUI.Full 907 * @since 7 908 */ 909/** 910 * Defining Extend MethodDecorator 911 * 912 * @syscap SystemCapability.ArkUI.ArkUI.Full 913 * @form 914 * @since 9 915 */ 916/** 917 * Defining Extend MethodDecorator 918 * 919 * @syscap SystemCapability.ArkUI.ArkUI.Full 920 * @crossplatform 921 * @form 922 * @since 10 923 */ 924/** 925 * Defining Extend MethodDecorator 926 * 927 * @syscap SystemCapability.ArkUI.ArkUI.Full 928 * @crossplatform 929 * @form 930 * @atomicservice 931 * @since 11 932 */ 933declare const Extend: MethodDecorator & ((value: any) => MethodDecorator); 934 935/** 936 * Define AnimatableExtend MethodDecorator 937 * 938 * @syscap SystemCapability.ArkUI.ArkUI.Full 939 * @crossplatform 940 * @since 10 941 */ 942/** 943 * Define AnimatableExtend MethodDecorator 944 * 945 * @syscap SystemCapability.ArkUI.ArkUI.Full 946 * @crossplatform 947 * @atomicservice 948 * @since 11 949 */ 950 declare const AnimatableExtend: MethodDecorator & ((value: Object) => MethodDecorator); 951 952/** 953 * Define Monitor MethodDecorator 954 * 955 * @syscap SystemCapability.ArkUI.ArkUI.Full 956 * @crossplatform 957 * @atomicservice 958 * @since 12 959 */ 960declare const Monitor: MonitorDecorator; 961 962/** 963 * Define Monitor Decorator type 964 * 965 * @typedef { function } MonitorDecorator 966 * @param { string } value - Monitored path input by the user 967 * @param { string[] } args - Monitored path(s) input by the user 968 * @returns { MethodDecorator } Monitor decorator 969 * @syscap SystemCapability.ArkUI.ArkUI.Full 970 * @crossplatform 971 * @atomicservice 972 * @since 12 973 */ 974declare type MonitorDecorator = (value: string, ...args: string[]) => MethodDecorator; 975 976/** 977 * Define IMonitor interface 978 * 979 * @interface IMonitor 980 * @syscap SystemCapability.ArkUI.ArkUI.Full 981 * @crossplatform 982 * @atomicservice 983 * @since 12 984 */ 985declare interface IMonitor { 986 /** 987 * Array of changed paths(keys) 988 * 989 * @type { Array<string> } 990 * @syscap SystemCapability.ArkUI.ArkUI.Full 991 * @crossplatform 992 * @atomicservice 993 * @since 12 994 */ 995 dirty: Array<string>; 996 997 /** 998 * Return the pair of the value before the most recent change and current value for given path. 999 * If path does not exist, return undefined; If path is not specified, return the value pair corresponding to the first path in dirty. 1000 * 1001 * @param { string } [path] 1002 * @returns { IMonitorValue<T> | undefined } 1003 * @syscap SystemCapability.ArkUI.ArkUI.Full 1004 * @crossplatform 1005 * @atomicservice 1006 * @since 12 1007 */ 1008 value<T>(path?: string): IMonitorValue<T> | undefined; 1009} 1010 1011/** 1012 * Define IMonitorValue interface 1013 * 1014 * @interface IMonitorValue<T> 1015 * @syscap SystemCapability.ArkUI.ArkUI.Full 1016 * @crossplatform 1017 * @atomicservice 1018 * @since 12 1019 */ 1020declare interface IMonitorValue<T> { 1021 /** 1022 * Get the previous value. 1023 * 1024 * @type { T } 1025 * @syscap SystemCapability.ArkUI.ArkUI.Full 1026 * @crossplatform 1027 * @atomicservice 1028 * @since 12 1029 */ 1030 before: T; 1031 1032 /** 1033 * Get current value. 1034 * 1035 * @type { T } 1036 * @syscap SystemCapability.ArkUI.ArkUI.Full 1037 * @crossplatform 1038 * @atomicservice 1039 * @since 12 1040 */ 1041 now: T; 1042 1043 /** 1044 * Monitored path input by the user. 1045 * 1046 * @type { string } 1047 * @syscap SystemCapability.ArkUI.ArkUI.Full 1048 * @crossplatform 1049 * @atomicservice 1050 * @since 12 1051 */ 1052 path: string; 1053} 1054 1055/** 1056 * Define AnimatableArithmetic interface 1057 * 1058 * @interface AnimatableArithmetic 1059 * @syscap SystemCapability.ArkUI.ArkUI.Full 1060 * @crossplatform 1061 * @since 10 1062 */ 1063/** 1064 * Define AnimatableArithmetic interface 1065 * 1066 * @interface AnimatableArithmetic 1067 * @syscap SystemCapability.ArkUI.ArkUI.Full 1068 * @crossplatform 1069 * @atomicservice 1070 * @since 11 1071 */ 1072 declare interface AnimatableArithmetic<T> { 1073 /** 1074 * Define plus method 1075 * 1076 * @param { AnimatableArithmetic<T> } rhs - another value 1077 * @returns { AnimatableArithmetic<T> } new value which implements AnimatableArithmetic<T> interface 1078 * @syscap SystemCapability.ArkUI.ArkUI.Full 1079 * @crossplatform 1080 * @since 10 1081 */ 1082 /** 1083 * Define plus method 1084 * 1085 * @param { AnimatableArithmetic<T> } rhs - another value 1086 * @returns { AnimatableArithmetic<T> } new value which implements AnimatableArithmetic<T> interface 1087 * @syscap SystemCapability.ArkUI.ArkUI.Full 1088 * @crossplatform 1089 * @atomicservice 1090 * @since 11 1091 */ 1092 plus(rhs: AnimatableArithmetic<T>): AnimatableArithmetic<T>; 1093 1094 /** 1095 * Define subtract method 1096 * 1097 * @param { AnimatableArithmetic<T> } rhs - another value 1098 * @returns { AnimatableArithmetic<T> } new value which implements AnimatableArithmetic<T> interface 1099 * @syscap SystemCapability.ArkUI.ArkUI.Full 1100 * @crossplatform 1101 * @since 10 1102 */ 1103 /** 1104 * Define subtract method 1105 * 1106 * @param { AnimatableArithmetic<T> } rhs - another value 1107 * @returns { AnimatableArithmetic<T> } new value which implements AnimatableArithmetic<T> interface 1108 * @syscap SystemCapability.ArkUI.ArkUI.Full 1109 * @crossplatform 1110 * @atomicservice 1111 * @since 11 1112 */ 1113 subtract(rhs: AnimatableArithmetic<T>): AnimatableArithmetic<T>; 1114 1115 /** 1116 * Define multiply method 1117 * 1118 * @param { number } scale - scale value 1119 * @returns { AnimatableArithmetic<T> } new value which implements AnimatableArithmetic<T> interface 1120 * @syscap SystemCapability.ArkUI.ArkUI.Full 1121 * @crossplatform 1122 * @since 10 1123 */ 1124 /** 1125 * Define multiply method 1126 * 1127 * @param { number } scale - scale value 1128 * @returns { AnimatableArithmetic<T> } new value which implements AnimatableArithmetic<T> interface 1129 * @syscap SystemCapability.ArkUI.ArkUI.Full 1130 * @crossplatform 1131 * @atomicservice 1132 * @since 11 1133 */ 1134 multiply(scale: number): AnimatableArithmetic<T>; 1135 1136 /** 1137 * Define equals method 1138 * 1139 * @param { AnimatableArithmetic<T> } rhs - another value 1140 * @returns { boolean } is equals 1141 * @syscap SystemCapability.ArkUI.ArkUI.Full 1142 * @crossplatform 1143 * @since 10 1144 */ 1145 /** 1146 * Define equals method 1147 * 1148 * @param { AnimatableArithmetic<T> } rhs - another value 1149 * @returns { boolean } is equals 1150 * @syscap SystemCapability.ArkUI.ArkUI.Full 1151 * @crossplatform 1152 * @atomicservice 1153 * @since 11 1154 */ 1155 equals(rhs: AnimatableArithmetic<T>): boolean; 1156} 1157 1158/** 1159 * Defining Concurrent MethodDecorator 1160 * 1161 * @syscap SystemCapability.ArkUI.ArkUI.Full 1162 * @since 9 1163 */ 1164/** 1165 * Defining Concurrent MethodDecorator 1166 * 1167 * @syscap SystemCapability.ArkUI.ArkUI.Full 1168 * @crossplatform 1169 * @since 10 1170 */ 1171/** 1172 * Defining Concurrent MethodDecorator 1173 * 1174 * @syscap SystemCapability.ArkUI.ArkUI.Full 1175 * @crossplatform 1176 * @atomicservice 1177 * @since 11 1178 */ 1179declare const Concurrent: MethodDecorator; 1180 1181/** 1182 * Defining Sendable ClassDecorator 1183 * The Sendable decorator can be used only for classes. A class with this decorator is marked as sendable, and the class object can be shared globally. 1184 * Since 12, the Sendable decorator can be used for function and typeAlias also. 1185 * A function with this decorator is marked as sendable, and the function can be an shareable property of sendable-class object. 1186 * A typeAlias with this decorator is marked as sendable, and the typeAlias can be used to declare properties, variables, 1187 * and arguments that need to be assigned with sendable-function. 1188 * 1189 * @syscap SystemCapability.ArkUI.ArkUI.Full 1190 * @crossplatform 1191 * @atomicservice 1192 * @since 11 1193 */ 1194declare const Sendable: ClassDecorator; 1195 1196/** 1197 * Defining CustomDialog ClassDecorator 1198 * 1199 * @syscap SystemCapability.ArkUI.ArkUI.Full 1200 * @since 7 1201 */ 1202/** 1203 * Defining CustomDialog ClassDecorator 1204 * 1205 * @syscap SystemCapability.ArkUI.ArkUI.Full 1206 * @crossplatform 1207 * @since 10 1208 */ 1209/** 1210 * Defining CustomDialog ClassDecorator 1211 * 1212 * @syscap SystemCapability.ArkUI.ArkUI.Full 1213 * @crossplatform 1214 * @atomicservice 1215 * @since 11 1216 */ 1217declare const CustomDialog: ClassDecorator; 1218 1219/** 1220 * Defining LocalStorageLink PropertyDecorator. 1221 * 1222 * @syscap SystemCapability.ArkUI.ArkUI.Full 1223 * @since 9 1224 */ 1225/** 1226 * Defining LocalStorageLink PropertyDecorator. 1227 * 1228 * @syscap SystemCapability.ArkUI.ArkUI.Full 1229 * @crossplatform 1230 * @since 10 1231 */ 1232/** 1233 * Defining LocalStorageLink PropertyDecorator. 1234 * 1235 * @syscap SystemCapability.ArkUI.ArkUI.Full 1236 * @crossplatform 1237 * @atomicservice 1238 * @since 11 1239 */ 1240declare const LocalStorageLink: (value: string) => PropertyDecorator; 1241 1242/** 1243 * Defining LocalStorageProp PropertyDecorator 1244 * 1245 * @syscap SystemCapability.ArkUI.ArkUI.Full 1246 * @form 1247 * @since 9 1248 */ 1249/** 1250 * Defining LocalStorageProp PropertyDecorator 1251 * 1252 * @syscap SystemCapability.ArkUI.ArkUI.Full 1253 * @crossplatform 1254 * @form 1255 * @since 10 1256 */ 1257/** 1258 * Defining LocalStorageProp PropertyDecorator 1259 * 1260 * @syscap SystemCapability.ArkUI.ArkUI.Full 1261 * @crossplatform 1262 * @form 1263 * @atomicservice 1264 * @since 11 1265 */ 1266declare const LocalStorageProp: (value: string) => PropertyDecorator; 1267 1268/** 1269 * Obtains the Context object associated with a component on the page. 1270 * 1271 * @param { Object } component - indicate the component on the page. 1272 * @returns { Context } 1273 * @syscap SystemCapability.ArkUI.ArkUI.Full 1274 * @StageModelOnly 1275 * @since 9 1276 */ 1277/** 1278 * Obtains the Context object associated with a component on the page. 1279 * 1280 * @param { Object } component - indicate the component on the page. 1281 * @returns { Context } 1282 * @syscap SystemCapability.ArkUI.ArkUI.Full 1283 * @StageModelOnly 1284 * @crossplatform 1285 * @since 10 1286 */ 1287/** 1288 * Obtains the Context object associated with a component on the page. 1289 * 1290 * @param { Object } component - indicate the component on the page. 1291 * @returns { Context } 1292 * @syscap SystemCapability.ArkUI.ArkUI.Full 1293 * @StageModelOnly 1294 * @crossplatform 1295 * @atomicservice 1296 * @since 11 1297 */ 1298declare function getContext(component?: Object): Context; 1299 1300/** 1301 * Defining Reusable ClassDecorator. 1302 * 1303 * @syscap SystemCapability.ArkUI.ArkUI.Full 1304 * @crossplatform 1305 * @since 10 1306 */ 1307/** 1308 * Defining Reusable ClassDecorator. 1309 * 1310 * @syscap SystemCapability.ArkUI.ArkUI.Full 1311 * @crossplatform 1312 * @atomicservice 1313 * @since 11 1314 */ 1315declare const Reusable: ClassDecorator; 1316 1317/** 1318 * Get context. 1319 * 1320 * @typedef { import('../api/application/Context').default } Context 1321 * @syscap SystemCapability.ArkUI.ArkUI.Full 1322 * @StageModelOnly 1323 * @since 9 1324 */ 1325/** 1326 * Get context. 1327 * 1328 * @typedef { import('../api/application/Context').default } Context 1329 * @syscap SystemCapability.ArkUI.ArkUI.Full 1330 * @StageModelOnly 1331 * @crossplatform 1332 * @since 10 1333 */ 1334/** 1335 * Get context. 1336 * 1337 * @typedef { import('../api/application/Context').default } Context 1338 * @syscap SystemCapability.ArkUI.ArkUI.Full 1339 * @StageModelOnly 1340 * @crossplatform 1341 * @atomicservice 1342 * @since 11 1343 */ 1344declare type Context = import('../api/application/Context').default; 1345 1346/** 1347 * Post Card Action. 1348 * 1349 * @param { Object } component - indicate the card entry component. 1350 * @param { Object } action - indicate the router, message or call event. 1351 * @syscap SystemCapability.ArkUI.ArkUI.Full 1352 * @StageModelOnly 1353 * @form 1354 * @since 9 1355 */ 1356/** 1357 * Post Card Action. 1358 * 1359 * @param { Object } component - indicate the card entry component. 1360 * @param { Object } action - indicate the router, message or call event. 1361 * @syscap SystemCapability.ArkUI.ArkUI.Full 1362 * @StageModelOnly 1363 * @crossplatform 1364 * @form 1365 * @since 10 1366 */ 1367/** 1368 * Post Card Action. 1369 * 1370 * @param { Object } component - indicate the card entry component. 1371 * @param { Object } action - indicate the router, message or call event. 1372 * @syscap SystemCapability.ArkUI.ArkUI.Full 1373 * @StageModelOnly 1374 * @crossplatform 1375 * @form 1376 * @atomicservice 1377 * @since 11 1378 */ 1379declare function postCardAction(component: Object, action: Object): void; 1380 1381/** 1382 * Defines the data type of the interface restriction. 1383 * 1384 * @interface Configuration 1385 * @syscap SystemCapability.ArkUI.ArkUI.Full 1386 * @since 7 1387 */ 1388/** 1389 * Defines the data type of the interface restriction. 1390 * 1391 * @interface Configuration 1392 * @syscap SystemCapability.ArkUI.ArkUI.Full 1393 * @form 1394 * @since 9 1395 */ 1396/** 1397 * Defines the data type of the interface restriction. 1398 * 1399 * @interface Configuration 1400 * @syscap SystemCapability.ArkUI.ArkUI.Full 1401 * @crossplatform 1402 * @form 1403 * @since 10 1404 */ 1405/** 1406 * Defines the data type of the interface restriction. 1407 * 1408 * @interface Configuration 1409 * @syscap SystemCapability.ArkUI.ArkUI.Full 1410 * @crossplatform 1411 * @form 1412 * @atomicservice 1413 * @since 11 1414 */ 1415declare interface Configuration { 1416 /** 1417 * Set colorMode. 1418 * 1419 * @type { string } 1420 * @readonly 1421 * @syscap SystemCapability.ArkUI.ArkUI.Full 1422 * @since 7 1423 */ 1424 /** 1425 * Set colorMode. 1426 * 1427 * @type { string } 1428 * @readonly 1429 * @syscap SystemCapability.ArkUI.ArkUI.Full 1430 * @form 1431 * @since 9 1432 */ 1433 /** 1434 * Set colorMode. 1435 * 1436 * @type { string } 1437 * @readonly 1438 * @syscap SystemCapability.ArkUI.ArkUI.Full 1439 * @crossplatform 1440 * @form 1441 * @since 10 1442 */ 1443 /** 1444 * Set colorMode. 1445 * 1446 * @type { string } 1447 * @readonly 1448 * @syscap SystemCapability.ArkUI.ArkUI.Full 1449 * @crossplatform 1450 * @form 1451 * @atomicservice 1452 * @since 11 1453 */ 1454 readonly colorMode: string; 1455 1456 /** 1457 * Set fontScale. 1458 * 1459 * @type { number } 1460 * @readonly 1461 * @syscap SystemCapability.ArkUI.ArkUI.Full 1462 * @since 7 1463 */ 1464 /** 1465 * Set fontScale. 1466 * 1467 * @type { number } 1468 * @readonly 1469 * @syscap SystemCapability.ArkUI.ArkUI.Full 1470 * @form 1471 * @since 9 1472 */ 1473 /** 1474 * Set fontScale. 1475 * 1476 * @type { number } 1477 * @readonly 1478 * @syscap SystemCapability.ArkUI.ArkUI.Full 1479 * @crossplatform 1480 * @form 1481 * @since 10 1482 */ 1483 /** 1484 * Set fontScale. 1485 * 1486 * @type { number } 1487 * @readonly 1488 * @syscap SystemCapability.ArkUI.ArkUI.Full 1489 * @crossplatform 1490 * @form 1491 * @atomicservice 1492 * @since 11 1493 */ 1494 readonly fontScale: number; 1495} 1496 1497/** 1498 * Defines the data type of the interface restriction. 1499 * 1500 * @interface Rectangle 1501 * @syscap SystemCapability.ArkUI.ArkUI.Full 1502 * @since 8 1503 */ 1504/** 1505 * Defines the data type of the interface restriction. 1506 * 1507 * @interface Rectangle 1508 * @syscap SystemCapability.ArkUI.ArkUI.Full 1509 * @form 1510 * @since 9 1511 */ 1512/** 1513 * Defines the data type of the interface restriction. 1514 * 1515 * @interface Rectangle 1516 * @syscap SystemCapability.ArkUI.ArkUI.Full 1517 * @crossplatform 1518 * @form 1519 * @since 10 1520 */ 1521/** 1522 * Defines the data type of the interface restriction. 1523 * 1524 * @interface Rectangle 1525 * @syscap SystemCapability.ArkUI.ArkUI.Full 1526 * @crossplatform 1527 * @form 1528 * @atomicservice 1529 * @since 11 1530 */ 1531declare interface Rectangle { 1532 /** 1533 * x:Horizontal coordinate 1534 * 1535 * @type { ?Length } 1536 * @syscap SystemCapability.ArkUI.ArkUI.Full 1537 * @since 8 1538 */ 1539 /** 1540 * x:Horizontal coordinate 1541 * 1542 * @type { ?Length } 1543 * @syscap SystemCapability.ArkUI.ArkUI.Full 1544 * @form 1545 * @since 9 1546 */ 1547 /** 1548 * x:Horizontal coordinate 1549 * 1550 * @type { ?Length } 1551 * @syscap SystemCapability.ArkUI.ArkUI.Full 1552 * @crossplatform 1553 * @form 1554 * @since 10 1555 */ 1556 /** 1557 * x:Horizontal coordinate 1558 * 1559 * @type { ?Length } 1560 * @syscap SystemCapability.ArkUI.ArkUI.Full 1561 * @crossplatform 1562 * @form 1563 * @atomicservice 1564 * @since 11 1565 */ 1566 x?: Length; 1567 1568 /** 1569 * y:Vertical axis coordinate. 1570 * 1571 * @type { ?Length } 1572 * @syscap SystemCapability.ArkUI.ArkUI.Full 1573 * @since 8 1574 */ 1575 /** 1576 * y:Vertical axis coordinate. 1577 * 1578 * @type { ?Length } 1579 * @syscap SystemCapability.ArkUI.ArkUI.Full 1580 * @form 1581 * @since 9 1582 */ 1583 /** 1584 * y:Vertical axis coordinate. 1585 * 1586 * @type { ?Length } 1587 * @syscap SystemCapability.ArkUI.ArkUI.Full 1588 * @crossplatform 1589 * @form 1590 * @since 10 1591 */ 1592 /** 1593 * y:Vertical axis coordinate. 1594 * 1595 * @type { ?Length } 1596 * @syscap SystemCapability.ArkUI.ArkUI.Full 1597 * @crossplatform 1598 * @form 1599 * @atomicservice 1600 * @since 11 1601 */ 1602 y?: Length; 1603 1604 /** 1605 * Sets the width of the current touchRect. 1606 * 1607 * @type { ?Length } 1608 * @syscap SystemCapability.ArkUI.ArkUI.Full 1609 * @since 8 1610 */ 1611 /** 1612 * Sets the width of the current touchRect. 1613 * 1614 * @type { ?Length } 1615 * @syscap SystemCapability.ArkUI.ArkUI.Full 1616 * @form 1617 * @since 9 1618 */ 1619 /** 1620 * Sets the width of the current touchRect. 1621 * 1622 * @type { ?Length } 1623 * @syscap SystemCapability.ArkUI.ArkUI.Full 1624 * @crossplatform 1625 * @form 1626 * @since 10 1627 */ 1628 /** 1629 * Sets the width of the current touchRect. 1630 * 1631 * @type { ?Length } 1632 * @syscap SystemCapability.ArkUI.ArkUI.Full 1633 * @crossplatform 1634 * @form 1635 * @atomicservice 1636 * @since 11 1637 */ 1638 width?: Length; 1639 1640 /** 1641 * Sets the height of the current touchRect. 1642 * 1643 * @type { ?Length } 1644 * @syscap SystemCapability.ArkUI.ArkUI.Full 1645 * @since 8 1646 */ 1647 /** 1648 * Sets the height of the current touchRect. 1649 * 1650 * @type { ?Length } 1651 * @syscap SystemCapability.ArkUI.ArkUI.Full 1652 * @form 1653 * @since 9 1654 */ 1655 /** 1656 * Sets the height of the current touchRect. 1657 * 1658 * @type { ?Length } 1659 * @syscap SystemCapability.ArkUI.ArkUI.Full 1660 * @crossplatform 1661 * @form 1662 * @since 10 1663 */ 1664 /** 1665 * Sets the height of the current touchRect. 1666 * 1667 * @type { ?Length } 1668 * @syscap SystemCapability.ArkUI.ArkUI.Full 1669 * @crossplatform 1670 * @form 1671 * @atomicservice 1672 * @since 11 1673 */ 1674 height?: Length; 1675} 1676 1677/** 1678 * Interface for ExpectedFrameRateRange. 1679 * 1680 * @interface ExpectedFrameRateRange 1681 * @syscap SystemCapability.ArkUI.ArkUI.Full 1682 * @since 11 1683 */ 1684/** 1685 * Interface for ExpectedFrameRateRange. 1686 * 1687 * @interface ExpectedFrameRateRange 1688 * @syscap SystemCapability.ArkUI.ArkUI.Full 1689 * @atomicservice 1690 * @since 12 1691 */ 1692declare interface ExpectedFrameRateRange { 1693 /** 1694 * The minimum animation drawing FPS. 1695 * The minimum value should be less than or equal to the maximum value. 1696 * @type { number } 1697 * @syscap SystemCapability.ArkUI.ArkUI.Full 1698 * @since 11 1699 */ 1700 /** 1701 * The minimum animation drawing FPS. 1702 * The minimum value should be less than or equal to the maximum value. 1703 * @type { number } 1704 * @syscap SystemCapability.ArkUI.ArkUI.Full 1705 * @atomicservice 1706 * @since 12 1707 */ 1708 min: number, 1709 /** 1710 * The maximum animation drawing FPS. 1711 * The maximum value should be greater than or equal to the minimum value. 1712 * @type { number } 1713 * @syscap SystemCapability.ArkUI.ArkUI.Full 1714 * @since 11 1715 */ 1716 /** 1717 * The maximum animation drawing FPS. 1718 * The maximum value should be greater than or equal to the minimum value. 1719 * @type { number } 1720 * @syscap SystemCapability.ArkUI.ArkUI.Full 1721 * @atomicservice 1722 * @since 12 1723 */ 1724 max: number, 1725 /** 1726 * The expected frame rate of dynamical callback rate range. 1727 * The value should be between the minimum and maximum value. 1728 * Otherwise, the actual callback rate will be dynamically 1729 * adjusted to better align with other animation sources. 1730 * @type { number } 1731 * @syscap SystemCapability.ArkUI.ArkUI.Full 1732 * @since 11 1733 */ 1734 /** 1735 * The expected frame rate of dynamical callback rate range. 1736 * The value should be between the minimum and maximum value. 1737 * Otherwise, the actual callback rate will be dynamically 1738 * adjusted to better align with other animation sources. 1739 * @type { number } 1740 * @syscap SystemCapability.ArkUI.ArkUI.Full 1741 * @atomicservice 1742 * @since 12 1743 */ 1744 expected: number, 1745} 1746 1747/** 1748 * global $r function 1749 * 1750 * @param { string } value 1751 * @param { any[] } params 1752 * @returns { Resource } 1753 * @syscap SystemCapability.ArkUI.ArkUI.Full 1754 * @since 7 1755 */ 1756/** 1757 * global $r function 1758 * 1759 * @param { string } value 1760 * @param { any[] } params 1761 * @returns { Resource } 1762 * @syscap SystemCapability.ArkUI.ArkUI.Full 1763 * @form 1764 * @since 9 1765 */ 1766/** 1767 * global $r function 1768 * 1769 * @param { string } value 1770 * @param { any[] } params 1771 * @returns { Resource } 1772 * @syscap SystemCapability.ArkUI.ArkUI.Full 1773 * @crossplatform 1774 * @form 1775 * @since 10 1776 */ 1777/** 1778 * global $r function 1779 * 1780 * @param { string } value 1781 * @param { any[] } params 1782 * @returns { Resource } 1783 * @syscap SystemCapability.ArkUI.ArkUI.Full 1784 * @crossplatform 1785 * @form 1786 * @atomicservice 1787 * @since 11 1788 */ 1789declare function $r(value: string, ...params: any[]): Resource; 1790 1791/** 1792 * global $rawfile function 1793 * 1794 * @param { string } value 1795 * @returns { Resource } 1796 * @syscap SystemCapability.ArkUI.ArkUI.Full 1797 * @since 7 1798 */ 1799/** 1800 * global $rawfile function 1801 * 1802 * @param { string } value 1803 * @returns { Resource } 1804 * @syscap SystemCapability.ArkUI.ArkUI.Full 1805 * @form 1806 * @since 9 1807 */ 1808/** 1809 * global $rawfile function 1810 * 1811 * @param { string } value 1812 * @returns { Resource } 1813 * @syscap SystemCapability.ArkUI.ArkUI.Full 1814 * @crossplatform 1815 * @form 1816 * @since 10 1817 */ 1818/** 1819 * global $rawfile function 1820 * 1821 * @param { string } value 1822 * @returns { Resource } 1823 * @syscap SystemCapability.ArkUI.ArkUI.Full 1824 * @crossplatform 1825 * @form 1826 * @atomicservice 1827 * @since 11 1828 */ 1829declare function $rawfile(value: string): Resource; 1830 1831/** 1832 * Enum for FinishCallbackType. 1833 * 1834 * @enum { number } 1835 * @syscap SystemCapability.ArkUI.ArkUI.Full 1836 * @crossplatform 1837 * @form 1838 * @since 11 1839 */ 1840/** 1841 * Enum for FinishCallbackType. 1842 * 1843 * @enum { number } 1844 * @syscap SystemCapability.ArkUI.ArkUI.Full 1845 * @crossplatform 1846 * @form 1847 * @atomicservice 1848 * @since 12 1849 */ 1850declare enum FinishCallbackType { 1851 /** 1852 * When the entire animation ends and will be removed immediately, the callback is triggered. 1853 * 1854 * @syscap SystemCapability.ArkUI.ArkUI.Full 1855 * @crossplatform 1856 * @form 1857 * @since 11 1858 */ 1859 /** 1860 * When the entire animation ends and will be removed immediately, the callback is triggered. 1861 * 1862 * @syscap SystemCapability.ArkUI.ArkUI.Full 1863 * @crossplatform 1864 * @form 1865 * @atomicservice 1866 * @since 12 1867 */ 1868 REMOVED = 0, 1869 /** 1870 * When the animation is logically down but may still be in its long tail, the callback is triggered. 1871 * 1872 * @syscap SystemCapability.ArkUI.ArkUI.Full 1873 * @crossplatform 1874 * @form 1875 * @since 11 1876 */ 1877 /** 1878 * When the animation is logically down but may still be in its long tail, the callback is triggered. 1879 * 1880 * @syscap SystemCapability.ArkUI.ArkUI.Full 1881 * @crossplatform 1882 * @form 1883 * @atomicservice 1884 * @since 12 1885 */ 1886 LOGICALLY = 1, 1887} 1888 1889/** 1890 * Defines the touch test strategy object. 1891 * 1892 * @enum { number } 1893 * @syscap SystemCapability.ArkUI.ArkUI.Full 1894 * @crossplatform 1895 * @form 1896 * @since 11 1897 */ 1898/** 1899 * Defines the touch test strategy object. 1900 * 1901 * @enum { number } 1902 * @syscap SystemCapability.ArkUI.ArkUI.Full 1903 * @crossplatform 1904 * @form 1905 * @atomicservice 1906 * @since 12 1907 */ 1908declare enum TouchTestStrategy { 1909 /** 1910 * Do framework touch test. 1911 * 1912 * @syscap SystemCapability.ArkUI.ArkUI.Full 1913 * @crossplatform 1914 * @form 1915 * @since 11 1916 */ 1917 /** 1918 * Do framework touch test. 1919 * 1920 * @syscap SystemCapability.ArkUI.ArkUI.Full 1921 * @crossplatform 1922 * @form 1923 * @atomicservice 1924 * @since 12 1925 */ 1926 DEFAULT = 0, 1927 1928 /** 1929 * Specify the component to do touch test and follow the framework touch test 1930 * 1931 * @syscap SystemCapability.ArkUI.ArkUI.Full 1932 * @crossplatform 1933 * @form 1934 * @since 11 1935 */ 1936 /** 1937 * Specify the component to do touch test and follow the framework touch test 1938 * 1939 * @syscap SystemCapability.ArkUI.ArkUI.Full 1940 * @crossplatform 1941 * @form 1942 * @atomicservice 1943 * @since 12 1944 */ 1945 FORWARD_COMPETITION = 1, 1946 1947 /** 1948 * Specify the component to do touch test and not follow the framework touch test 1949 * 1950 * @syscap SystemCapability.ArkUI.ArkUI.Full 1951 * @crossplatform 1952 * @form 1953 * @since 11 1954 */ 1955 /** 1956 * Specify the component to do touch test and not follow the framework touch test 1957 * 1958 * @syscap SystemCapability.ArkUI.ArkUI.Full 1959 * @crossplatform 1960 * @form 1961 * @atomicservice 1962 * @since 12 1963 */ 1964 FORWARD = 2 1965} 1966 1967/** 1968 * Defines the animate function params. 1969 * 1970 * @interface AnimateParam 1971 * @syscap SystemCapability.ArkUI.ArkUI.Full 1972 * @since 7 1973 */ 1974/** 1975 * Defines the animate function params. 1976 * 1977 * @interface AnimateParam 1978 * @syscap SystemCapability.ArkUI.ArkUI.Full 1979 * @form 1980 * @since 9 1981 */ 1982/** 1983 * Defines the animate function params. 1984 * 1985 * @interface AnimateParam 1986 * @syscap SystemCapability.ArkUI.ArkUI.Full 1987 * @crossplatform 1988 * @form 1989 * @since 10 1990 */ 1991/** 1992 * Defines the animate function params. 1993 * 1994 * @interface AnimateParam 1995 * @syscap SystemCapability.ArkUI.ArkUI.Full 1996 * @crossplatform 1997 * @form 1998 * @atomicservice 1999 * @since 11 2000 */ 2001declare interface AnimateParam { 2002 /** 2003 * Animation duration, in ms. 2004 * 2005 * @type { ?number } 2006 * @default 1000 2007 * @syscap SystemCapability.ArkUI.ArkUI.Full 2008 * @since 7 2009 */ 2010 /** 2011 * Animation duration, in ms. 2012 * 2013 * @type { ?number } 2014 * @default 1000 2015 * @syscap SystemCapability.ArkUI.ArkUI.Full 2016 * @form 2017 * @since 9 2018 */ 2019 /** 2020 * Animation duration, in ms. 2021 * 2022 * @type { ?number } 2023 * @default 1000 2024 * @syscap SystemCapability.ArkUI.ArkUI.Full 2025 * @crossplatform 2026 * @form 2027 * @since 10 2028 */ 2029 /** 2030 * Animation duration, in ms. 2031 * 2032 * @type { ?number } 2033 * @default 1000 2034 * @syscap SystemCapability.ArkUI.ArkUI.Full 2035 * @crossplatform 2036 * @form 2037 * @atomicservice 2038 * @since 11 2039 */ 2040 duration?: number; 2041 /** 2042 * Animation playback speed. A larger value indicates faster animation playback, and a smaller value indicates slower 2043 * animation playback. The value 0 means that there is no animation. 2044 * 2045 * @type { ?number } 2046 * @default 1.0 2047 * @syscap SystemCapability.ArkUI.ArkUI.Full 2048 * @since 7 2049 */ 2050 /** 2051 * Animation playback speed. A larger value indicates faster animation playback, and a smaller value indicates slower 2052 * animation playback. The value 0 means that there is no animation. 2053 * 2054 * @type { ?number } 2055 * @default 1.0 2056 * @syscap SystemCapability.ArkUI.ArkUI.Full 2057 * @crossplatform 2058 * @since 10 2059 */ 2060 /** 2061 * Animation playback speed. A larger value indicates faster animation playback, and a smaller value indicates slower 2062 * animation playback. The value 0 means that there is no animation. 2063 * 2064 * @type { ?number } 2065 * @default 1.0 2066 * @syscap SystemCapability.ArkUI.ArkUI.Full 2067 * @crossplatform 2068 * @atomicservice 2069 * @since 11 2070 */ 2071 tempo?: number; 2072 /** 2073 * Animation curve. 2074 * 2075 * @type { ?(Curve | string) } 2076 * @default Curve.EaseInOut 2077 * @syscap SystemCapability.ArkUI.ArkUI.Full 2078 * @since 7 2079 */ 2080 /** 2081 * Animation curve. 2082 * 2083 * @type { ?(Curve | string | ICurve) } 2084 * @default Curve.EaseInOut 2085 * @syscap SystemCapability.ArkUI.ArkUI.Full 2086 * @form 2087 * @since 9 2088 */ 2089 /** 2090 * Animation curve. 2091 * 2092 * @type { ?(Curve | string | ICurve) } 2093 * @default Curve.EaseInOut 2094 * @syscap SystemCapability.ArkUI.ArkUI.Full 2095 * @crossplatform 2096 * @form 2097 * @since 10 2098 */ 2099 /** 2100 * Animation curve. 2101 * 2102 * @type { ?(Curve | string | ICurve) } 2103 * @default Curve.EaseInOut 2104 * @syscap SystemCapability.ArkUI.ArkUI.Full 2105 * @crossplatform 2106 * @form 2107 * @atomicservice 2108 * @since 11 2109 */ 2110 curve?: Curve | string | ICurve; 2111 2112 /** 2113 * Animation plays with delay,when set to a negative number, the animation plays in advance. 2114 * 2115 * @type { ?number } 2116 * @default 0 2117 * @syscap SystemCapability.ArkUI.ArkUI.Full 2118 * @since 7 2119 */ 2120 /** 2121 * Animation delay time, in ms. 2122 * 2123 * @type { ?number } 2124 * @default 0 2125 * @syscap SystemCapability.ArkUI.ArkUI.Full 2126 * @crossplatform 2127 * @since 10 2128 */ 2129 /** 2130 * Animation delay time, in ms. 2131 * 2132 * @type { ?number } 2133 * @default 0 2134 * @syscap SystemCapability.ArkUI.ArkUI.Full 2135 * @crossplatform 2136 * @atomicservice 2137 * @since 11 2138 */ 2139 delay?: number; 2140 2141 /** 2142 * Animation iterations. When set to -1, the animation playing it repeatedly. The value range is greater than or equal to -1. 2143 * 2144 * @type { ?number } 2145 * @default 1 2146 * @syscap SystemCapability.ArkUI.ArkUI.Full 2147 * @since 7 2148 */ 2149 /** 2150 * Animation iterations. When set to -1, the animation playing it repeatedly. The value range is greater than or equal to -1. 2151 * 2152 * @type { ?number } 2153 * @default 1 2154 * @syscap SystemCapability.ArkUI.ArkUI.Full 2155 * @crossplatform 2156 * @since 10 2157 */ 2158 /** 2159 * Animation iterations. When set to -1, the animation playing it repeatedly. The value range is greater than or equal to -1. 2160 * 2161 * @type { ?number } 2162 * @default 1 2163 * @syscap SystemCapability.ArkUI.ArkUI.Full 2164 * @crossplatform 2165 * @atomicservice 2166 * @since 11 2167 */ 2168 iterations?: number; 2169 2170 /** 2171 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 2172 * 2173 * @type { ?PlayMode } 2174 * @default PlayMode.Normal 2175 * @syscap SystemCapability.ArkUI.ArkUI.Full 2176 * @since 7 2177 */ 2178 /** 2179 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 2180 * 2181 * @type { ?PlayMode } 2182 * @default PlayMode.Normal 2183 * @syscap SystemCapability.ArkUI.ArkUI.Full 2184 * @form 2185 * @since 9 2186 */ 2187 /** 2188 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 2189 * 2190 * @type { ?PlayMode } 2191 * @default PlayMode.Normal 2192 * @syscap SystemCapability.ArkUI.ArkUI.Full 2193 * @crossplatform 2194 * @form 2195 * @since 10 2196 */ 2197 /** 2198 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 2199 * 2200 * @type { ?PlayMode } 2201 * @default PlayMode.Normal 2202 * @syscap SystemCapability.ArkUI.ArkUI.Full 2203 * @crossplatform 2204 * @form 2205 * @atomicservice 2206 * @since 11 2207 */ 2208 playMode?: PlayMode; 2209 2210 /** 2211 * Callback invoked when the animation playback is complete or the ability is about to enter the background. 2212 * 2213 * @type { ?function } 2214 * @syscap SystemCapability.ArkUI.ArkUI.Full 2215 * @since 7 2216 */ 2217 /** 2218 * Callback invoked when the animation playback is complete or the ability is about to enter the background. 2219 * 2220 * @type { ?function } 2221 * @syscap SystemCapability.ArkUI.ArkUI.Full 2222 * @form 2223 * @since 9 2224 */ 2225 /** 2226 * Callback invoked when the animation playback is complete or the ability is about to enter the background. 2227 * 2228 * @type { ?function } 2229 * @syscap SystemCapability.ArkUI.ArkUI.Full 2230 * @crossplatform 2231 * @form 2232 * @since 10 2233 */ 2234 /** 2235 * Callback invoked when the animation playback is complete or the ability is about to enter the background. 2236 * 2237 * @type { ?function } 2238 * @syscap SystemCapability.ArkUI.ArkUI.Full 2239 * @crossplatform 2240 * @form 2241 * @atomicservice 2242 * @since 11 2243 */ 2244 onFinish?: () => void; 2245 2246 /** 2247 * Define the type of onFinish callback in animation. 2248 * 2249 * @type { ?FinishCallbackType } 2250 * @syscap SystemCapability.ArkUI.ArkUI.Full 2251 * @crossplatform 2252 * @form 2253 * @since 11 2254 */ 2255 /** 2256 * Define the type of onFinish callback in animation. 2257 * 2258 * @type { ?FinishCallbackType } 2259 * @syscap SystemCapability.ArkUI.ArkUI.Full 2260 * @crossplatform 2261 * @form 2262 * @atomicservice 2263 * @since 12 2264 */ 2265 finishCallbackType?: FinishCallbackType; 2266 2267 /** 2268 * Indicates expectedFrameRateRange including minimum、maximum and expected frame rate. 2269 * 2270 * @type { ?ExpectedFrameRateRange } 2271 * @syscap SystemCapability.ArkUI.ArkUI.Full 2272 * @since 11 2273 */ 2274 /** 2275 * Indicates expectedFrameRateRange including minimum、maximum and expected frame rate. 2276 * 2277 * @type { ?ExpectedFrameRateRange } 2278 * @syscap SystemCapability.ArkUI.ArkUI.Full 2279 * @atomicservice 2280 * @since 12 2281 */ 2282 expectedFrameRateRange?: ExpectedFrameRateRange; 2283} 2284 2285/** 2286 * Interface for curve object. 2287 * 2288 * @interface ICurve 2289 * @syscap SystemCapability.ArkUI.ArkUI.Full 2290 * @form 2291 * @since 9 2292 */ 2293/** 2294 * Interface for curve object. 2295 * 2296 * @interface ICurve 2297 * @syscap SystemCapability.ArkUI.ArkUI.Full 2298 * @crossplatform 2299 * @form 2300 * @since 10 2301 */ 2302/** 2303 * Interface for curve object. 2304 * 2305 * @interface ICurve 2306 * @syscap SystemCapability.ArkUI.ArkUI.Full 2307 * @crossplatform 2308 * @form 2309 * @atomicservice 2310 * @since 11 2311 */ 2312interface ICurve { 2313 /** 2314 * Get curve value by fraction. 2315 * 2316 * @param { number } fraction - Indicates the current normalized time parameter. Value range: [0, 1]. 2317 * Note: If the value is less than 0, it will be processed as 0. If the value is greater than 1, 1 is used. 2318 * @returns { number } 2319 * @syscap SystemCapability.ArkUI.ArkUI.Full 2320 * @form 2321 * @since 9 2322 */ 2323 /** 2324 * Get curve value by fraction. 2325 * 2326 * @param { number } fraction - Indicates the current normalized time parameter. Value range: [0, 1]. 2327 * Note: If the value is less than 0, it will be processed as 0. If the value is greater than 1, 1 is used. 2328 * @returns { number } 2329 * @syscap SystemCapability.ArkUI.ArkUI.Full 2330 * @crossplatform 2331 * @form 2332 * @since 10 2333 */ 2334 /** 2335 * Get curve value by fraction. 2336 * 2337 * @param { number } fraction - Indicates the current normalized time parameter. Value range: [0, 1]. 2338 * Note: If the value is less than 0, it will be processed as 0. If the value is greater than 1, 1 is used. 2339 * @returns { number } 2340 * @syscap SystemCapability.ArkUI.ArkUI.Full 2341 * @crossplatform 2342 * @form 2343 * @atomicservice 2344 * @since 11 2345 */ 2346 interpolate(fraction: number): number; 2347} 2348 2349/** 2350 * Defines the motion path options. 2351 * 2352 * @interface MotionPathOptions 2353 * @syscap SystemCapability.ArkUI.ArkUI.Full 2354 * @since 7 2355 */ 2356/** 2357 * Defines the motion path options. 2358 * 2359 * @interface MotionPathOptions 2360 * @syscap SystemCapability.ArkUI.ArkUI.Full 2361 * @crossplatform 2362 * @since 10 2363 */ 2364/** 2365 * Defines the motion path options. 2366 * 2367 * @interface MotionPathOptions 2368 * @syscap SystemCapability.ArkUI.ArkUI.Full 2369 * @crossplatform 2370 * @atomicservice 2371 * @since 11 2372 */ 2373declare interface MotionPathOptions { 2374 /** 2375 * The path info. 2376 * 2377 * @type { string } 2378 * @syscap SystemCapability.ArkUI.ArkUI.Full 2379 * @since 7 2380 */ 2381 /** 2382 * The path info. 2383 * 2384 * @type { string } 2385 * @syscap SystemCapability.ArkUI.ArkUI.Full 2386 * @crossplatform 2387 * @since 10 2388 */ 2389 /** 2390 * The path info. 2391 * 2392 * @type { string } 2393 * @syscap SystemCapability.ArkUI.ArkUI.Full 2394 * @crossplatform 2395 * @atomicservice 2396 * @since 11 2397 */ 2398 path: string; 2399 2400 /** 2401 * The origin point info in range [0,1). 2402 * 2403 * @type { ?number } 2404 * @default 0.0 2405 * @syscap SystemCapability.ArkUI.ArkUI.Full 2406 * @since 7 2407 */ 2408 /** 2409 * The origin point info in range [0,1). 2410 * 2411 * @type { ?number } 2412 * @default 0.0 2413 * @syscap SystemCapability.ArkUI.ArkUI.Full 2414 * @crossplatform 2415 * @since 10 2416 */ 2417 /** 2418 * The origin point info in range [0,1). 2419 * 2420 * @type { ?number } 2421 * @default 0.0 2422 * @syscap SystemCapability.ArkUI.ArkUI.Full 2423 * @crossplatform 2424 * @atomicservice 2425 * @since 11 2426 */ 2427 from?: number; 2428 2429 /** 2430 * he distance point info in range (0,1]. 2431 * 2432 * @type { ?number } 2433 * @default 1.0 2434 * @syscap SystemCapability.ArkUI.ArkUI.Full 2435 * @since 7 2436 */ 2437 /** 2438 * he distance point info in range (0,1]. 2439 * 2440 * @type { ?number } 2441 * @default 1.0 2442 * @syscap SystemCapability.ArkUI.ArkUI.Full 2443 * @crossplatform 2444 * @since 10 2445 */ 2446 /** 2447 * The distance point info in range (0,1]. 2448 * 2449 * @type { ?number } 2450 * @default 1.0 2451 * @syscap SystemCapability.ArkUI.ArkUI.Full 2452 * @crossplatform 2453 * @atomicservice 2454 * @since 11 2455 */ 2456 to?: number; 2457 2458 /** 2459 * The rotate info. 2460 * 2461 * @type { ?boolean } 2462 * @default false 2463 * @syscap SystemCapability.ArkUI.ArkUI.Full 2464 * @since 7 2465 */ 2466 /** 2467 * The rotate info. 2468 * 2469 * @type { ?boolean } 2470 * @default false 2471 * @syscap SystemCapability.ArkUI.ArkUI.Full 2472 * @crossplatform 2473 * @since 10 2474 */ 2475 /** 2476 * The rotate info. 2477 * 2478 * @type { ?boolean } 2479 * @default false 2480 * @syscap SystemCapability.ArkUI.ArkUI.Full 2481 * @crossplatform 2482 * @atomicservice 2483 * @since 11 2484 */ 2485 rotatable?: boolean; 2486} 2487 2488/** 2489 * Defines the shard transition function params. 2490 * 2491 * @interface sharedTransitionOptions 2492 * @syscap SystemCapability.ArkUI.ArkUI.Full 2493 * @since 7 2494 */ 2495/** 2496 * Defines the shard transition function params. 2497 * 2498 * @interface sharedTransitionOptions 2499 * @syscap SystemCapability.ArkUI.ArkUI.Full 2500 * @crossplatform 2501 * @since 10 2502 */ 2503/** 2504 * Defines the shard transition function params. 2505 * 2506 * @interface sharedTransitionOptions 2507 * @syscap SystemCapability.ArkUI.ArkUI.Full 2508 * @crossplatform 2509 * @atomicservice 2510 * @since 11 2511 */ 2512declare interface sharedTransitionOptions { 2513 /** 2514 * Animation duration, in ms. 2515 * 2516 * @type { ?number } 2517 * @default 1000 2518 * @syscap SystemCapability.ArkUI.ArkUI.Full 2519 * @since 7 2520 */ 2521 /** 2522 * Animation duration, in ms. 2523 * 2524 * @type { ?number } 2525 * @default 1000 2526 * @syscap SystemCapability.ArkUI.ArkUI.Full 2527 * @crossplatform 2528 * @since 10 2529 */ 2530 /** 2531 * Animation duration, in ms. 2532 * 2533 * @type { ?number } 2534 * @default 1000 2535 * @syscap SystemCapability.ArkUI.ArkUI.Full 2536 * @crossplatform 2537 * @atomicservice 2538 * @since 11 2539 */ 2540 duration?: number; 2541 2542 /** 2543 * Animation duration, in ms. 2544 * 2545 * @type { ?(Curve | string | ICurve) } 2546 * @default 1000 2547 * @syscap SystemCapability.ArkUI.ArkUI.Full 2548 * @since 7 2549 */ 2550 /** 2551 * Animation curve. 2552 * 2553 * @type { ?(Curve | string | ICurve) } 2554 * @default 1000 2555 * @syscap SystemCapability.ArkUI.ArkUI.Full 2556 * @crossplatform 2557 * @since 10 2558 */ 2559 /** 2560 * Animation curve. 2561 * 2562 * @type { ?(Curve | string | ICurve) } 2563 * @default 1000 2564 * @syscap SystemCapability.ArkUI.ArkUI.Full 2565 * @crossplatform 2566 * @atomicservice 2567 * @since 11 2568 */ 2569 curve?: Curve | string | ICurve; 2570 2571 /** 2572 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 2573 * 2574 * @type { ?number } 2575 * @default 0 2576 * @syscap SystemCapability.ArkUI.ArkUI.Full 2577 * @since 7 2578 */ 2579 /** 2580 * Animation delay time, in ms. 2581 * 2582 * @type { ?number } 2583 * @default 0 2584 * @syscap SystemCapability.ArkUI.ArkUI.Full 2585 * @crossplatform 2586 * @since 10 2587 */ 2588 /** 2589 * Animation delay time, in ms. 2590 * 2591 * @type { ?number } 2592 * @default 0 2593 * @syscap SystemCapability.ArkUI.ArkUI.Full 2594 * @crossplatform 2595 * @atomicservice 2596 * @since 11 2597 */ 2598 delay?: number; 2599 2600 /** 2601 * The motion path info. 2602 * 2603 * @type { ?MotionPathOptions } 2604 * @syscap SystemCapability.ArkUI.ArkUI.Full 2605 * @since 7 2606 */ 2607 /** 2608 * The motion path info. 2609 * 2610 * @type { ?MotionPathOptions } 2611 * @syscap SystemCapability.ArkUI.ArkUI.Full 2612 * @crossplatform 2613 * @since 10 2614 */ 2615 /** 2616 * The motion path info. 2617 * 2618 * @type { ?MotionPathOptions } 2619 * @syscap SystemCapability.ArkUI.ArkUI.Full 2620 * @crossplatform 2621 * @atomicservice 2622 * @since 11 2623 */ 2624 motionPath?: MotionPathOptions; 2625 2626 /** 2627 * Z index info. 2628 * 2629 * @type { ?number } 2630 * @syscap SystemCapability.ArkUI.ArkUI.Full 2631 * @since 7 2632 */ 2633 /** 2634 * Z index info. 2635 * 2636 * @type { ?number } 2637 * @syscap SystemCapability.ArkUI.ArkUI.Full 2638 * @crossplatform 2639 * @since 10 2640 */ 2641 /** 2642 * Z index info. 2643 * 2644 * @type { ?number } 2645 * @syscap SystemCapability.ArkUI.ArkUI.Full 2646 * @crossplatform 2647 * @atomicservice 2648 * @since 11 2649 */ 2650 zIndex?: number; 2651 2652 /** 2653 * the animate type. 2654 * 2655 * @type { ?SharedTransitionEffectType } 2656 * @default SharedTransitionEffectType.Exchange 2657 * @syscap SystemCapability.ArkUI.ArkUI.Full 2658 * @since 7 2659 */ 2660 /** 2661 * the animate type. 2662 * 2663 * @type { ?SharedTransitionEffectType } 2664 * @default SharedTransitionEffectType.Exchange 2665 * @syscap SystemCapability.ArkUI.ArkUI.Full 2666 * @crossplatform 2667 * @since 10 2668 */ 2669 /** 2670 * the animate type. 2671 * 2672 * @type { ?SharedTransitionEffectType } 2673 * @default SharedTransitionEffectType.Exchange 2674 * @syscap SystemCapability.ArkUI.ArkUI.Full 2675 * @crossplatform 2676 * @atomicservice 2677 * @since 11 2678 */ 2679 type?: SharedTransitionEffectType; 2680} 2681 2682/** 2683 * Defines the options of geometry transition. 2684 * 2685 * @interface GeometryTransitionOptions 2686 * @syscap SystemCapability.ArkUI.ArkUI.Full 2687 * @crossplatform 2688 * @since 11 2689 */ 2690/** 2691 * Defines the options of geometry transition. 2692 * 2693 * @interface GeometryTransitionOptions 2694 * @syscap SystemCapability.ArkUI.ArkUI.Full 2695 * @crossplatform 2696 * @atomicservice 2697 * @since 12 2698 */ 2699declare interface GeometryTransitionOptions { 2700 /** 2701 * whether follow target for the component still in the hierarchy, default: false, stay current. 2702 * 2703 * @type { ?boolean } 2704 * @default false 2705 * @syscap SystemCapability.ArkUI.ArkUI.Full 2706 * @crossplatform 2707 * @since 11 2708 */ 2709 /** 2710 * whether follow target for the component still in the hierarchy, default: false, stay current. 2711 * 2712 * @type { ?boolean } 2713 * @default false 2714 * @syscap SystemCapability.ArkUI.ArkUI.Full 2715 * @crossplatform 2716 * @atomicservice 2717 * @since 12 2718 */ 2719 follow?: boolean; 2720 /** 2721 * Defines movement strategy of source and target in the hierarchy during geometry transition. 2722 * 2723 * @type { ?TransitionHierarchyStrategy } 2724 * @default TransitionHierarchyStrategy.ADAPTIVE 2725 * @syscap SystemCapability.ArkUI.ArkUI.Full 2726 * @systemapi 2727 * @atomicservice 2728 * @since 12 2729 */ 2730 /** 2731 * Defines movement strategy of source and target in the hierarchy during geometry transition. 2732 * 2733 * @type { ?TransitionHierarchyStrategy } 2734 * @default TransitionHierarchyStrategy.ADAPTIVE 2735 * @syscap SystemCapability.ArkUI.ArkUI.Full 2736 * @systemapi 2737 * @since 13 2738 */ 2739 hierarchyStrategy?: TransitionHierarchyStrategy 2740} 2741 2742/** 2743 * Source and target are two matched elements during the geometry transition. 2744 * The animation starts at the source and ends at the target. 2745 * TransitionHierarchyStrategy enumeration defines how levels of source and target elements 2746 * would be changed in the hierarchy during the geometry transition. 2747 * 2748 * @enum { number } 2749 * @syscap SystemCapability.ArkUI.ArkUI.Full 2750 * @systemapi 2751 * @atomicservice 2752 * @since 12 2753 */ 2754/** 2755 * Source and target are two matched elements during the geometry transition. 2756 * The animation starts at the source and ends at the target. 2757 * TransitionHierarchyStrategy enumeration defines how levels of source and target elements 2758 * would be changed in the hierarchy during the geometry transition. 2759 * 2760 * @enum { number } 2761 * @syscap SystemCapability.ArkUI.ArkUI.Full 2762 * @systemapi 2763 * @since 13 2764 */ 2765declare enum TransitionHierarchyStrategy { 2766 /** 2767 * None mode. 2768 * Source and target staty in the original level in the hierarchy during geometry transition. 2769 * 2770 * @syscap SystemCapability.ArkUI.ArkUI.Full 2771 * @systemapi 2772 * @atomicservice 2773 * @since 12 2774 */ 2775 /** 2776 * None mode. 2777 * Source and target staty in the original level in the hierarchy during geometry transition. 2778 * 2779 * @syscap SystemCapability.ArkUI.ArkUI.Full 2780 * @systemapi 2781 * @since 13 2782 */ 2783 NONE = 0, 2784 2785 /** 2786 * ADAPTIVE mode. 2787 * Lower level one of source and target is elevated to higher level of both, 2788 * indicating that two elements are in same high level. 2789 * 2790 * @syscap SystemCapability.ArkUI.ArkUI.Full 2791 * @systemapi 2792 * @atomicservice 2793 * @since 12 2794 */ 2795 /** 2796 * ADAPTIVE mode. 2797 * Lower level one of source and target is elevated to higher level of both, 2798 * indicating that two elements are in same high level. 2799 * 2800 * @syscap SystemCapability.ArkUI.ArkUI.Full 2801 * @systemapi 2802 * @since 13 2803 */ 2804 ADAPTIVE = 1, 2805} 2806 2807/** 2808 * Defines the options of translate. 2809 * 2810 * @interface TranslateOptions 2811 * @syscap SystemCapability.ArkUI.ArkUI.Full 2812 * @since 7 2813 */ 2814/** 2815 * Defines the options of translate. 2816 * 2817 * @interface TranslateOptions 2818 * @syscap SystemCapability.ArkUI.ArkUI.Full 2819 * @form 2820 * @since 9 2821 */ 2822/** 2823 * Defines the options of translate. 2824 * 2825 * @interface TranslateOptions 2826 * @syscap SystemCapability.ArkUI.ArkUI.Full 2827 * @crossplatform 2828 * @form 2829 * @since 10 2830 */ 2831/** 2832 * Defines the options of translate. 2833 * 2834 * @interface TranslateOptions 2835 * @syscap SystemCapability.ArkUI.ArkUI.Full 2836 * @crossplatform 2837 * @form 2838 * @atomicservice 2839 * @since 11 2840 */ 2841declare interface TranslateOptions { 2842 /** 2843 * The param of x direction. 2844 * 2845 * @type { ?(number | string) } 2846 * @syscap SystemCapability.ArkUI.ArkUI.Full 2847 * @since 7 2848 */ 2849 /** 2850 * The param of x direction. 2851 * 2852 * @type { ?(number | string) } 2853 * @syscap SystemCapability.ArkUI.ArkUI.Full 2854 * @form 2855 * @since 9 2856 */ 2857 /** 2858 * The param of x direction. 2859 * 2860 * @type { ?(number | string) } 2861 * @syscap SystemCapability.ArkUI.ArkUI.Full 2862 * @crossplatform 2863 * @form 2864 * @since 10 2865 */ 2866 /** 2867 * The param of x direction. 2868 * 2869 * @type { ?(number | string) } 2870 * @syscap SystemCapability.ArkUI.ArkUI.Full 2871 * @crossplatform 2872 * @form 2873 * @atomicservice 2874 * @since 11 2875 */ 2876 x?: number | string; 2877 2878 /** 2879 * The param of y direction. 2880 * 2881 * @type { ?(number | string) } 2882 * @syscap SystemCapability.ArkUI.ArkUI.Full 2883 * @since 7 2884 */ 2885 /** 2886 * The param of y direction. 2887 * 2888 * @type { ?(number | string) } 2889 * @syscap SystemCapability.ArkUI.ArkUI.Full 2890 * @form 2891 * @since 9 2892 */ 2893 /** 2894 * The param of y direction. 2895 * 2896 * @type { ?(number | string) } 2897 * @syscap SystemCapability.ArkUI.ArkUI.Full 2898 * @crossplatform 2899 * @form 2900 * @since 10 2901 */ 2902 /** 2903 * The param of y direction. 2904 * 2905 * @type { ?(number | string) } 2906 * @syscap SystemCapability.ArkUI.ArkUI.Full 2907 * @crossplatform 2908 * @form 2909 * @atomicservice 2910 * @since 11 2911 */ 2912 y?: number | string; 2913 2914 /** 2915 * The param of z direction. 2916 * 2917 * @type { ?(number | string) } 2918 * @syscap SystemCapability.ArkUI.ArkUI.Full 2919 * @since 7 2920 */ 2921 /** 2922 * The param of z direction. 2923 * 2924 * @type { ?(number | string) } 2925 * @syscap SystemCapability.ArkUI.ArkUI.Full 2926 * @form 2927 * @since 9 2928 */ 2929 /** 2930 * The param of z direction. 2931 * 2932 * @type { ?(number | string) } 2933 * @syscap SystemCapability.ArkUI.ArkUI.Full 2934 * @crossplatform 2935 * @form 2936 * @since 10 2937 */ 2938 /** 2939 * The param of z direction. 2940 * 2941 * @type { ?(number | string) } 2942 * @syscap SystemCapability.ArkUI.ArkUI.Full 2943 * @crossplatform 2944 * @form 2945 * @atomicservice 2946 * @since 11 2947 */ 2948 z?: number | string; 2949} 2950 2951/** 2952 * Defines the options of scale. 2953 * 2954 * @interface ScaleOptions 2955 * @syscap SystemCapability.ArkUI.ArkUI.Full 2956 * @since 7 2957 */ 2958/** 2959 * Defines the options of scale. 2960 * 2961 * @interface ScaleOptions 2962 * @syscap SystemCapability.ArkUI.ArkUI.Full 2963 * @form 2964 * @since 9 2965 */ 2966/** 2967 * Defines the options of scale. 2968 * 2969 * @interface ScaleOptions 2970 * @syscap SystemCapability.ArkUI.ArkUI.Full 2971 * @crossplatform 2972 * @form 2973 * @since 10 2974 */ 2975/** 2976 * Defines the options of scale. 2977 * 2978 * @interface ScaleOptions 2979 * @syscap SystemCapability.ArkUI.ArkUI.Full 2980 * @crossplatform 2981 * @form 2982 * @atomicservice 2983 * @since 11 2984 */ 2985declare interface ScaleOptions { 2986 /** 2987 * The param of x direction. 2988 * 2989 * @type { ?number } 2990 * @syscap SystemCapability.ArkUI.ArkUI.Full 2991 * @since 7 2992 */ 2993 /** 2994 * The param of x direction. 2995 * 2996 * @type { ?number } 2997 * @syscap SystemCapability.ArkUI.ArkUI.Full 2998 * @form 2999 * @since 9 3000 */ 3001 /** 3002 * The param of x direction. 3003 * 3004 * @type { ?number } 3005 * @syscap SystemCapability.ArkUI.ArkUI.Full 3006 * @crossplatform 3007 * @form 3008 * @since 10 3009 */ 3010 /** 3011 * The param of x direction. 3012 * 3013 * @type { ?number } 3014 * @syscap SystemCapability.ArkUI.ArkUI.Full 3015 * @crossplatform 3016 * @form 3017 * @atomicservice 3018 * @since 11 3019 */ 3020 x?: number; 3021 3022 /** 3023 * The param of y direction. 3024 * 3025 * @type { ?number } 3026 * @syscap SystemCapability.ArkUI.ArkUI.Full 3027 * @since 7 3028 */ 3029 /** 3030 * The param of y direction. 3031 * 3032 * @type { ?number } 3033 * @syscap SystemCapability.ArkUI.ArkUI.Full 3034 * @form 3035 * @since 9 3036 */ 3037 /** 3038 * The param of y direction. 3039 * 3040 * @type { ?number } 3041 * @syscap SystemCapability.ArkUI.ArkUI.Full 3042 * @crossplatform 3043 * @form 3044 * @since 10 3045 */ 3046 /** 3047 * The param of y direction. 3048 * 3049 * @type { ?number } 3050 * @syscap SystemCapability.ArkUI.ArkUI.Full 3051 * @crossplatform 3052 * @form 3053 * @atomicservice 3054 * @since 11 3055 */ 3056 y?: number; 3057 3058 /** 3059 * The param of z direction. 3060 * 3061 * @type { ?number } 3062 * @syscap SystemCapability.ArkUI.ArkUI.Full 3063 * @since 7 3064 */ 3065 /** 3066 * The param of z direction. 3067 * 3068 * @type { ?number } 3069 * @syscap SystemCapability.ArkUI.ArkUI.Full 3070 * @form 3071 * @since 9 3072 */ 3073 /** 3074 * The param of z direction. 3075 * 3076 * @type { ?number } 3077 * @syscap SystemCapability.ArkUI.ArkUI.Full 3078 * @crossplatform 3079 * @form 3080 * @since 10 3081 */ 3082 /** 3083 * The param of z direction. 3084 * 3085 * @type { ?number } 3086 * @syscap SystemCapability.ArkUI.ArkUI.Full 3087 * @crossplatform 3088 * @form 3089 * @atomicservice 3090 * @since 11 3091 */ 3092 z?: number; 3093 3094 /** 3095 * The param of center point of x. 3096 * 3097 * @type { ?(number | string) } 3098 * @syscap SystemCapability.ArkUI.ArkUI.Full 3099 * @since 7 3100 */ 3101 /** 3102 * The param of center point of x. 3103 * 3104 * @type { ?(number | string) } 3105 * @syscap SystemCapability.ArkUI.ArkUI.Full 3106 * @form 3107 * @since 9 3108 */ 3109 /** 3110 * The param of center point of x. 3111 * 3112 * @type { ?(number | string) } 3113 * @syscap SystemCapability.ArkUI.ArkUI.Full 3114 * @crossplatform 3115 * @form 3116 * @since 10 3117 */ 3118 /** 3119 * The param of center point of x. 3120 * 3121 * @type { ?(number | string) } 3122 * @syscap SystemCapability.ArkUI.ArkUI.Full 3123 * @crossplatform 3124 * @form 3125 * @atomicservice 3126 * @since 11 3127 */ 3128 centerX?: number | string; 3129 3130 /** 3131 * The param of center point of y. 3132 * 3133 * @type { ?(number | string) } 3134 * @syscap SystemCapability.ArkUI.ArkUI.Full 3135 * @since 7 3136 */ 3137 /** 3138 * The param of center point of y. 3139 * 3140 * @type { ?(number | string) } 3141 * @syscap SystemCapability.ArkUI.ArkUI.Full 3142 * @form 3143 * @since 9 3144 */ 3145 /** 3146 * The param of center point of y. 3147 * 3148 * @type { ?(number | string) } 3149 * @syscap SystemCapability.ArkUI.ArkUI.Full 3150 * @crossplatform 3151 * @form 3152 * @since 10 3153 */ 3154 /** 3155 * The param of center point of y. 3156 * 3157 * @type { ?(number | string) } 3158 * @syscap SystemCapability.ArkUI.ArkUI.Full 3159 * @crossplatform 3160 * @form 3161 * @atomicservice 3162 * @since 11 3163 */ 3164 centerY?: number | string; 3165} 3166 3167/** 3168 * Defines the align rule options of relative container. 3169 * 3170 * @interface AlignRuleOption 3171 * @syscap SystemCapability.ArkUI.ArkUI.Full 3172 * @form 3173 * @since 9 3174 */ 3175/** 3176 * Defines the align rule options of relative container. 3177 * 3178 * @interface AlignRuleOption 3179 * @syscap SystemCapability.ArkUI.ArkUI.Full 3180 * @crossplatform 3181 * @form 3182 * @since 10 3183 */ 3184/** 3185 * Defines the align rule options of relative container. 3186 * 3187 * @interface AlignRuleOption 3188 * @syscap SystemCapability.ArkUI.ArkUI.Full 3189 * @crossplatform 3190 * @form 3191 * @atomicservice 3192 * @since 11 3193 */ 3194declare interface AlignRuleOption { 3195 /** 3196 * The param of left align. 3197 * 3198 * @type { ?object } 3199 * @syscap SystemCapability.ArkUI.ArkUI.Full 3200 * @form 3201 * @since 9 3202 */ 3203 /** 3204 * The param of left align. 3205 * 3206 * @type { ?object } 3207 * @syscap SystemCapability.ArkUI.ArkUI.Full 3208 * @crossplatform 3209 * @form 3210 * @since 10 3211 */ 3212 /** 3213 * The param of left align. 3214 * 3215 * @type { ?object } 3216 * @syscap SystemCapability.ArkUI.ArkUI.Full 3217 * @crossplatform 3218 * @form 3219 * @atomicservice 3220 * @since 11 3221 */ 3222 left?: { anchor: string, align: HorizontalAlign }; 3223 3224 /** 3225 * The param of right align. 3226 * 3227 * @type { ?object } 3228 * @syscap SystemCapability.ArkUI.ArkUI.Full 3229 * @form 3230 * @since 9 3231 */ 3232 /** 3233 * The param of right align. 3234 * 3235 * @type { ?object } 3236 * @syscap SystemCapability.ArkUI.ArkUI.Full 3237 * @crossplatform 3238 * @form 3239 * @since 10 3240 */ 3241 /** 3242 * The param of right align. 3243 * 3244 * @type { ?object } 3245 * @syscap SystemCapability.ArkUI.ArkUI.Full 3246 * @crossplatform 3247 * @form 3248 * @atomicservice 3249 * @since 11 3250 */ 3251 right?: { anchor: string, align: HorizontalAlign }; 3252 3253 /** 3254 * The param of middle align. 3255 * 3256 * @type { ?object } 3257 * @syscap SystemCapability.ArkUI.ArkUI.Full 3258 * @form 3259 * @since 9 3260 */ 3261 /** 3262 * The param of middle align. 3263 * 3264 * @type { ?object } 3265 * @syscap SystemCapability.ArkUI.ArkUI.Full 3266 * @crossplatform 3267 * @form 3268 * @since 10 3269 */ 3270 /** 3271 * The param of middle align. 3272 * 3273 * @type { ?object } 3274 * @syscap SystemCapability.ArkUI.ArkUI.Full 3275 * @crossplatform 3276 * @form 3277 * @atomicservice 3278 * @since 11 3279 */ 3280 middle?: { anchor: string, align: HorizontalAlign }; 3281 3282 /** 3283 * The param of top align. 3284 * 3285 * @type { ?object } 3286 * @syscap SystemCapability.ArkUI.ArkUI.Full 3287 * @form 3288 * @since 9 3289 */ 3290 /** 3291 * The param of top align. 3292 * 3293 * @type { ?object } 3294 * @syscap SystemCapability.ArkUI.ArkUI.Full 3295 * @crossplatform 3296 * @form 3297 * @since 10 3298 */ 3299 /** 3300 * The param of top align. 3301 * 3302 * @type { ?object } 3303 * @syscap SystemCapability.ArkUI.ArkUI.Full 3304 * @crossplatform 3305 * @form 3306 * @atomicservice 3307 * @since 11 3308 */ 3309 top?: { anchor: string, align: VerticalAlign }; 3310 3311 /** 3312 * The param of bottom align. 3313 * 3314 * @type { ?object } 3315 * @syscap SystemCapability.ArkUI.ArkUI.Full 3316 * @form 3317 * @since 9 3318 */ 3319 /** 3320 * The param of bottom align. 3321 * 3322 * @type { ?object } 3323 * @syscap SystemCapability.ArkUI.ArkUI.Full 3324 * @form 3325 * @since 10 3326 */ 3327 /** 3328 * The param of bottom align. 3329 * 3330 * @type { ?object } 3331 * @syscap SystemCapability.ArkUI.ArkUI.Full 3332 * @form 3333 * @atomicservice 3334 * @since 11 3335 */ 3336 bottom?: { anchor: string, align: VerticalAlign }; 3337 3338 /** 3339 * The param of center align. 3340 * 3341 * @type { ?object } 3342 * @syscap SystemCapability.ArkUI.ArkUI.Full 3343 * @form 3344 * @since 9 3345 */ 3346 /** 3347 * The param of center align. 3348 * 3349 * @type { ?object } 3350 * @syscap SystemCapability.ArkUI.ArkUI.Full 3351 * @crossplatform 3352 * @form 3353 * @since 10 3354 */ 3355 /** 3356 * The param of center align. 3357 * 3358 * @type { ?object } 3359 * @syscap SystemCapability.ArkUI.ArkUI.Full 3360 * @crossplatform 3361 * @form 3362 * @atomicservice 3363 * @since 11 3364 */ 3365 center?: { anchor: string, align: VerticalAlign }; 3366 3367 /** 3368 * Defines the bias ratio in horizontal and vertical direction. 3369 * 3370 * @type { ?Bias } 3371 * @default {horizontal:0.5,vertical:0.5} 3372 * @syscap SystemCapability.ArkUI.ArkUI.Full 3373 * @crossplatform 3374 * @form 3375 * @since 11 3376 */ 3377 /** 3378 * Defines the bias ratio in horizontal and vertical direction. 3379 * 3380 * @type { ?Bias } 3381 * @default {horizontal:0.5,vertical:0.5} 3382 * @syscap SystemCapability.ArkUI.ArkUI.Full 3383 * @crossplatform 3384 * @form 3385 * @atomicservice 3386 * @since 12 3387 */ 3388 bias?: Bias; 3389} 3390 3391/** 3392 * Defines the localized horizontal align param of relative container. 3393 * 3394 * @interface LocalizedHorizontalAlignParam 3395 * @syscap SystemCapability.ArkUI.ArkUI.Full 3396 * @crossplatform 3397 * @atomicservice 3398 * @since 12 3399 */ 3400declare interface LocalizedHorizontalAlignParam { 3401 /** 3402 * The anchor of localized align param. 3403 * 3404 * @type { string } 3405 * @syscap SystemCapability.ArkUI.ArkUI.Full 3406 * @crossplatform 3407 * @atomicservice 3408 * @since 12 3409 */ 3410 anchor: string; 3411 3412 /** 3413 * The align of localized align param. 3414 * 3415 * @type { HorizontalAlign } 3416 * @syscap SystemCapability.ArkUI.ArkUI.Full 3417 * @crossplatform 3418 * @atomicservice 3419 * @since 12 3420 */ 3421 align: HorizontalAlign; 3422} 3423 3424/** 3425 * Defines the localized vertical align param of relative container. 3426 * 3427 * @interface LocalizedVerticalAlignParam 3428 * @syscap SystemCapability.ArkUI.ArkUI.Full 3429 * @crossplatform 3430 * @atomicservice 3431 * @since 12 3432 */ 3433declare interface LocalizedVerticalAlignParam { 3434 /** 3435 * The anchor of localized align param. 3436 * 3437 * @type { string } 3438 * @syscap SystemCapability.ArkUI.ArkUI.Full 3439 * @crossplatform 3440 * @atomicservice 3441 * @since 12 3442 */ 3443 anchor: string; 3444 3445 /** 3446 * The align of localized align param. 3447 * 3448 * @type { VerticalAlign } 3449 * @syscap SystemCapability.ArkUI.ArkUI.Full 3450 * @crossplatform 3451 * @atomicservice 3452 * @since 12 3453 */ 3454 align: VerticalAlign; 3455} 3456 3457/** 3458 * Defines the Localized align rule options of relative container. 3459 * 3460 * @interface LocalizedAlignRuleOptions 3461 * @syscap SystemCapability.ArkUI.ArkUI.Full 3462 * @crossplatform 3463 * @atomicservice 3464 * @since 12 3465 */ 3466declare interface LocalizedAlignRuleOptions { 3467 /** 3468 * The param of start align. 3469 * 3470 * @type { ?LocalizedHorizontalAlignParam } 3471 * @syscap SystemCapability.ArkUI.ArkUI.Full 3472 * @crossplatform 3473 * @atomicservice 3474 * @since 12 3475 */ 3476 start?: LocalizedHorizontalAlignParam; 3477 3478 /** 3479 * The param of end align. 3480 * 3481 * @type { ?LocalizedHorizontalAlignParam } 3482 * @syscap SystemCapability.ArkUI.ArkUI.Full 3483 * @crossplatform 3484 * @atomicservice 3485 * @since 12 3486 */ 3487 end?: LocalizedHorizontalAlignParam; 3488 3489 /** 3490 * The param of middle align. 3491 * 3492 * @type { ?LocalizedHorizontalAlignParam } 3493 * @syscap SystemCapability.ArkUI.ArkUI.Full 3494 * @crossplatform 3495 * @atomicservice 3496 * @since 12 3497 */ 3498 middle?: LocalizedHorizontalAlignParam; 3499 3500 /** 3501 * The param of top align. 3502 * 3503 * @type { ?LocalizedVerticalAlignParam } 3504 * @syscap SystemCapability.ArkUI.ArkUI.Full 3505 * @crossplatform 3506 * @atomicservice 3507 * @since 12 3508 */ 3509 top?: LocalizedVerticalAlignParam; 3510 3511 /** 3512 * The param of bottom align. 3513 * 3514 * @type { ?LocalizedVerticalAlignParam } 3515 * @syscap SystemCapability.ArkUI.ArkUI.Full 3516 * @crossplatform 3517 * @atomicservice 3518 * @since 12 3519 */ 3520 bottom?: LocalizedVerticalAlignParam; 3521 3522 /** 3523 * The param of center align. 3524 * 3525 * @type { ?LocalizedVerticalAlignParam } 3526 * @syscap SystemCapability.ArkUI.ArkUI.Full 3527 * @crossplatform 3528 * @atomicservice 3529 * @since 12 3530 */ 3531 center?: LocalizedVerticalAlignParam; 3532 3533 /** 3534 * Defines the bias ratio in horizontal and vertical direction. 3535 * 3536 * @type { ?Bias } 3537 * @default {horizontal:0.5,vertical:0.5} 3538 * @syscap SystemCapability.ArkUI.ArkUI.Full 3539 * @crossplatform 3540 * @atomicservice 3541 * @since 12 3542 */ 3543 bias?: Bias; 3544} 3545 3546/** 3547 * Defines the style of the chain in relative container. 3548 * 3549 * @enum { number } 3550 * @syscap SystemCapability.ArkUI.ArkUI.Full 3551 * @crossplatform 3552 * @atomicservice 3553 * @since 12 3554 */ 3555declare enum ChainStyle { 3556 /** 3557 * Elements of the chain will be spread out. 3558 * 3559 * @syscap SystemCapability.ArkUI.ArkUI.Full 3560 * @crossplatform 3561 * @atomicservice 3562 * @since 12 3563 */ 3564 SPREAD, 3565 3566 /** 3567 * Elements except chain's head and tail will be spread out. 3568 * 3569 * @syscap SystemCapability.ArkUI.ArkUI.Full 3570 * @crossplatform 3571 * @atomicservice 3572 * @since 12 3573 */ 3574 SPREAD_INSIDE, 3575 3576 /** 3577 * Elements of the chain will be packed together. 3578 * 3579 * @syscap SystemCapability.ArkUI.ArkUI.Full 3580 * @crossplatform 3581 * @atomicservice 3582 * @since 12 3583 */ 3584 PACKED, 3585} 3586 3587/** 3588 * The param of rotate. 3589 * 3590 * @interface RotateOptions 3591 * @syscap SystemCapability.ArkUI.ArkUI.Full 3592 * @since 7 3593 */ 3594/** 3595 * The param of rotate. 3596 * 3597 * @interface RotateOptions 3598 * @syscap SystemCapability.ArkUI.ArkUI.Full 3599 * @form 3600 * @since 9 3601 */ 3602/** 3603 * The param of rotate. 3604 * 3605 * @interface RotateOptions 3606 * @syscap SystemCapability.ArkUI.ArkUI.Full 3607 * @crossplatform 3608 * @form 3609 * @since 10 3610 */ 3611/** 3612 * The param of rotate. 3613 * 3614 * @interface RotateOptions 3615 * @syscap SystemCapability.ArkUI.ArkUI.Full 3616 * @crossplatform 3617 * @form 3618 * @atomicservice 3619 * @since 11 3620 */ 3621declare interface RotateOptions { 3622 /** 3623 * The param of x direction. 3624 * 3625 * @type { ?number } 3626 * @syscap SystemCapability.ArkUI.ArkUI.Full 3627 * @since 7 3628 */ 3629 /** 3630 * The param of x direction. 3631 * 3632 * @type { ?number } 3633 * @syscap SystemCapability.ArkUI.ArkUI.Full 3634 * @form 3635 * @since 9 3636 */ 3637 /** 3638 * The param of x direction. 3639 * 3640 * @type { ?number } 3641 * @syscap SystemCapability.ArkUI.ArkUI.Full 3642 * @crossplatform 3643 * @form 3644 * @since 10 3645 */ 3646 /** 3647 * The param of x direction. 3648 * 3649 * @type { ?number } 3650 * @syscap SystemCapability.ArkUI.ArkUI.Full 3651 * @crossplatform 3652 * @form 3653 * @atomicservice 3654 * @since 11 3655 */ 3656 x?: number; 3657 3658 /** 3659 * The param of y direction. 3660 * 3661 * @type { ?number } 3662 * @syscap SystemCapability.ArkUI.ArkUI.Full 3663 * @since 7 3664 */ 3665 /** 3666 * The param of y direction. 3667 * 3668 * @type { ?number } 3669 * @syscap SystemCapability.ArkUI.ArkUI.Full 3670 * @form 3671 * @since 9 3672 */ 3673 /** 3674 * The param of y direction. 3675 * 3676 * @type { ?number } 3677 * @syscap SystemCapability.ArkUI.ArkUI.Full 3678 * @crossplatform 3679 * @form 3680 * @since 10 3681 */ 3682 /** 3683 * The param of y direction. 3684 * 3685 * @type { ?number } 3686 * @syscap SystemCapability.ArkUI.ArkUI.Full 3687 * @crossplatform 3688 * @form 3689 * @atomicservice 3690 * @since 11 3691 */ 3692 y?: number; 3693 3694 /** 3695 * The param of z direction. 3696 * 3697 * @type { ?number } 3698 * @syscap SystemCapability.ArkUI.ArkUI.Full 3699 * @since 7 3700 */ 3701 /** 3702 * The param of z direction. 3703 * 3704 * @type { ?number } 3705 * @syscap SystemCapability.ArkUI.ArkUI.Full 3706 * @form 3707 * @since 9 3708 */ 3709 /** 3710 * The param of z direction. 3711 * 3712 * @type { ?number } 3713 * @syscap SystemCapability.ArkUI.ArkUI.Full 3714 * @crossplatform 3715 * @form 3716 * @since 10 3717 */ 3718 /** 3719 * The param of z direction. 3720 * 3721 * @type { ?number } 3722 * @syscap SystemCapability.ArkUI.ArkUI.Full 3723 * @crossplatform 3724 * @form 3725 * @atomicservice 3726 * @since 11 3727 */ 3728 z?: number; 3729 3730 /** 3731 * The param of center point of x. 3732 * 3733 * @type { ?(number | string) } 3734 * @syscap SystemCapability.ArkUI.ArkUI.Full 3735 * @since 7 3736 */ 3737 /** 3738 * The param of center point of x. 3739 * 3740 * @type { ?(number | string) } 3741 * @syscap SystemCapability.ArkUI.ArkUI.Full 3742 * @form 3743 * @since 9 3744 */ 3745 /** 3746 * The param of center point of x. 3747 * 3748 * @type { ?(number | string) } 3749 * @syscap SystemCapability.ArkUI.ArkUI.Full 3750 * @crossplatform 3751 * @form 3752 * @since 10 3753 */ 3754 /** 3755 * The param of center point of x. 3756 * 3757 * @type { ?(number | string) } 3758 * @syscap SystemCapability.ArkUI.ArkUI.Full 3759 * @crossplatform 3760 * @form 3761 * @atomicservice 3762 * @since 11 3763 */ 3764 centerX?: number | string; 3765 3766 /** 3767 * The param of center point of y. 3768 * 3769 * @type { ?(number | string) } 3770 * @syscap SystemCapability.ArkUI.ArkUI.Full 3771 * @since 7 3772 */ 3773 /** 3774 * The param of center point of y. 3775 * 3776 * @type { ?(number | string) } 3777 * @syscap SystemCapability.ArkUI.ArkUI.Full 3778 * @since 9 3779 */ 3780 /** 3781 * The param of center point of y. 3782 * 3783 * @type { ?(number | string) } 3784 * @syscap SystemCapability.ArkUI.ArkUI.Full 3785 * @crossplatform 3786 * @form 3787 * @since 10 3788 */ 3789 /** 3790 * The param of center point of y. 3791 * 3792 * @type { ?(number | string) } 3793 * @syscap SystemCapability.ArkUI.ArkUI.Full 3794 * @crossplatform 3795 * @form 3796 * @atomicservice 3797 * @since 11 3798 */ 3799 centerY?: number | string; 3800 3801 /** 3802 * The param of center point of z. 3803 * 3804 * @type { ?number } 3805 * @default 0 3806 * @syscap SystemCapability.ArkUI.ArkUI.Full 3807 * @crossplatform 3808 * @form 3809 * @since 10 3810 */ 3811 /** 3812 * The param of center point of z. 3813 * 3814 * @type { ?number } 3815 * @default 0 3816 * @syscap SystemCapability.ArkUI.ArkUI.Full 3817 * @crossplatform 3818 * @form 3819 * @atomicservice 3820 * @since 11 3821 */ 3822 centerZ?: number; 3823 3824 /** 3825 * The param of camera distance, value range (-∞, ∞). 3826 * @type { ?number } 3827 * @default 0 3828 * @syscap SystemCapability.ArkUI.ArkUI.Full 3829 * @crossplatform 3830 * @form 3831 * @since 10 3832 */ 3833 /** 3834 * The param of camera distance, value range (-∞, ∞). 3835 * @type { ?number } 3836 * @default 0 3837 * @syscap SystemCapability.ArkUI.ArkUI.Full 3838 * @crossplatform 3839 * @form 3840 * @atomicservice 3841 * @since 11 3842 */ 3843 perspective?: number; 3844 3845 /** 3846 * The param of angle. 3847 * 3848 * @type { number | string } 3849 * @syscap SystemCapability.ArkUI.ArkUI.Full 3850 * @since 7 3851 */ 3852 /** 3853 * The param of angle. 3854 * 3855 * @type { number | string } 3856 * @syscap SystemCapability.ArkUI.ArkUI.Full 3857 * @form 3858 * @since 9 3859 */ 3860 /** 3861 * The param of angle. 3862 * 3863 * @type { number | string } 3864 * @syscap SystemCapability.ArkUI.ArkUI.Full 3865 * @crossplatform 3866 * @form 3867 * @since 10 3868 */ 3869 /** 3870 * The param of angle. 3871 * 3872 * @type { number | string } 3873 * @syscap SystemCapability.ArkUI.ArkUI.Full 3874 * @crossplatform 3875 * @form 3876 * @atomicservice 3877 * @since 11 3878 */ 3879 angle: number | string; 3880} 3881 3882/** 3883 * Defines the param of transition. 3884 * 3885 * @interface TransitionOptions 3886 * @syscap SystemCapability.ArkUI.ArkUI.Full 3887 * @since 7 3888 * @deprecated since 10 3889 * @useinstead TransitionEffect 3890 */ 3891declare interface TransitionOptions { 3892 /** 3893 * Defines the param of type. 3894 * 3895 * @type { ?TransitionType } 3896 * @syscap SystemCapability.ArkUI.ArkUI.Full 3897 * @since 7 3898 * @deprecated since 10 3899 */ 3900 type?: TransitionType; 3901 /** 3902 * Defines the param of opacity. 3903 * 3904 * @type { ?number } 3905 * @syscap SystemCapability.ArkUI.ArkUI.Full 3906 * @since 7 3907 * @deprecated since 10 3908 */ 3909 opacity?: number; 3910 /** 3911 * Defines the param of translate. 3912 * 3913 * @type { ?TranslateOptions } 3914 * @syscap SystemCapability.ArkUI.ArkUI.Full 3915 * @since 7 3916 * @deprecated since 10 3917 */ 3918 translate?: TranslateOptions; 3919 /** 3920 * Defines the param of scale. 3921 * 3922 * @type { ?ScaleOptions } 3923 * @syscap SystemCapability.ArkUI.ArkUI.Full 3924 * @since 7 3925 * @deprecated since 10 3926 */ 3927 scale?: ScaleOptions; 3928 /** 3929 * Defines the param of rotate. 3930 * 3931 * @type { ?RotateOptions } 3932 * @syscap SystemCapability.ArkUI.ArkUI.Full 3933 * @since 7 3934 * @deprecated since 10 3935 */ 3936 rotate?: RotateOptions; 3937} 3938 3939/** 3940 * Defines the Edge object. 3941 * 3942 * @enum { number } 3943 * @syscap SystemCapability.ArkUI.ArkUI.Full 3944 * @crossplatform 3945 * @form 3946 * @since 10 3947 */ 3948/** 3949 * Defines the Edge object. 3950 * 3951 * @enum { number } 3952 * @syscap SystemCapability.ArkUI.ArkUI.Full 3953 * @crossplatform 3954 * @form 3955 * @atomicservice 3956 * @since 11 3957 */ 3958declare enum TransitionEdge { 3959 /** 3960 * Top edge 3961 * 3962 * @syscap SystemCapability.ArkUI.ArkUI.Full 3963 * @crossplatform 3964 * @form 3965 * @since 10 3966 */ 3967 /** 3968 * Top edge 3969 * 3970 * @syscap SystemCapability.ArkUI.ArkUI.Full 3971 * @crossplatform 3972 * @form 3973 * @atomicservice 3974 * @since 11 3975 */ 3976 TOP, 3977 3978 /** 3979 * Bottom edge 3980 * 3981 * @syscap SystemCapability.ArkUI.ArkUI.Full 3982 * @crossplatform 3983 * @form 3984 * @since 10 3985 */ 3986 /** 3987 * Bottom edge 3988 * 3989 * @syscap SystemCapability.ArkUI.ArkUI.Full 3990 * @crossplatform 3991 * @form 3992 * @atomicservice 3993 * @since 11 3994 */ 3995 BOTTOM, 3996 3997 /** 3998 * Start edge 3999 * 4000 * @syscap SystemCapability.ArkUI.ArkUI.Full 4001 * @crossplatform 4002 * @form 4003 * @since 10 4004 */ 4005 /** 4006 * Start edge 4007 * 4008 * @syscap SystemCapability.ArkUI.ArkUI.Full 4009 * @crossplatform 4010 * @form 4011 * @atomicservice 4012 * @since 11 4013 */ 4014 START, 4015 4016 /** 4017 * End edge 4018 * 4019 * @syscap SystemCapability.ArkUI.ArkUI.Full 4020 * @crossplatform 4021 * @form 4022 * @since 10 4023 */ 4024 /** 4025 * End edge 4026 * 4027 * @syscap SystemCapability.ArkUI.ArkUI.Full 4028 * @crossplatform 4029 * @form 4030 * @atomicservice 4031 * @since 11 4032 */ 4033 END 4034} 4035 4036/** 4037 * Defines all transition effects. 4038 * 4039 * @typedef { object } TransitionEffects 4040 * @syscap SystemCapability.ArkUI.ArkUI.Full 4041 * @crossplatform 4042 * @form 4043 * @since 10 4044 */ 4045/** 4046 * Defines all transition effects. 4047 * 4048 * @typedef { object } TransitionEffects 4049 * @syscap SystemCapability.ArkUI.ArkUI.Full 4050 * @crossplatform 4051 * @form 4052 * @atomicservice 4053 * @since 11 4054 */ 4055declare type TransitionEffects = { 4056 identity: undefined; 4057 opacity: number; 4058 slideSwitch: undefined; 4059 move: TransitionEdge; 4060 translate: TranslateOptions; 4061 rotate: RotateOptions; 4062 scale: ScaleOptions; 4063 asymmetric: { 4064 appear: TransitionEffect; 4065 disappear: TransitionEffect; 4066 }; 4067}; 4068 4069/** 4070 * Defined the draw modifier of node. Provides draw callbacks for the associated Node. 4071 * 4072 * @syscap SystemCapability.ArkUI.ArkUI.Full 4073 * @crossplatform 4074 * @atomicservice 4075 * @since 12 4076 */ 4077declare class DrawModifier { 4078 /** 4079 * drawBehind Method. Executed before drawing associated Node. 4080 * 4081 * @param { DrawContext } drawContext - The drawContext used to draw. 4082 * @syscap SystemCapability.ArkUI.ArkUI.Full 4083 * @crossplatform 4084 * @atomicservice 4085 * @since 12 4086 */ 4087 drawBehind?(drawContext: DrawContext): void; 4088 4089 /** 4090 * drawContent Method. Executed when associated Node is drawing, the default drawContent method will be replaced 4091 * if this method is set. 4092 * 4093 * @param { DrawContext } drawContext - The drawContext used to draw. 4094 * @syscap SystemCapability.ArkUI.ArkUI.Full 4095 * @crossplatform 4096 * @atomicservice 4097 * @since 12 4098 */ 4099 drawContent?(drawContext: DrawContext): void; 4100 4101 /** 4102 * drawFront Method. Executed after drawing associated Node. 4103 * 4104 * @param { DrawContext } drawContext - The drawContext used to draw. 4105 * @syscap SystemCapability.ArkUI.ArkUI.Full 4106 * @crossplatform 4107 * @atomicservice 4108 * @since 12 4109 */ 4110 drawFront?(drawContext: DrawContext): void; 4111 4112 /** 4113 * Invalidate the component, which will cause a re-render of the component. 4114 * 4115 * @syscap SystemCapability.ArkUI.ArkUI.Full 4116 * @crossplatform 4117 * @atomicservice 4118 * @since 12 4119 */ 4120 invalidate(): void; 4121} 4122 4123/** 4124 * Defines the transition effect 4125 * 4126 * @syscap SystemCapability.ArkUI.ArkUI.Full 4127 * @crossplatform 4128 * @form 4129 * @since 10 4130 */ 4131/** 4132 * Defines the transition effect 4133 * 4134 * @syscap SystemCapability.ArkUI.ArkUI.Full 4135 * @crossplatform 4136 * @form 4137 * @atomicservice 4138 * @since 11 4139 */ 4140declare class TransitionEffect< 4141 Type extends keyof TransitionEffects = keyof TransitionEffects, 4142 Effect extends TransitionEffects[Type] = TransitionEffects[Type] 4143> { 4144 /** 4145 * Disables the transition effect 4146 * 4147 * @type { TransitionEffect<"identity"> } 4148 * @readonly 4149 * @static 4150 * @syscap SystemCapability.ArkUI.ArkUI.Full 4151 * @crossplatform 4152 * @form 4153 * @since 10 4154 */ 4155 /** 4156 * Disables the transition effect 4157 * 4158 * @type { TransitionEffect<"identity"> } 4159 * @readonly 4160 * @static 4161 * @syscap SystemCapability.ArkUI.ArkUI.Full 4162 * @crossplatform 4163 * @form 4164 * @atomicservice 4165 * @since 11 4166 */ 4167 static readonly IDENTITY: TransitionEffect<"identity">; 4168 4169 /** 4170 * Specifies a transition effect with transparency of 0, which is equivalent to TransitionEffect.opacity(0). 4171 * 4172 * @type { TransitionEffect<"opacity"> } 4173 * @readonly 4174 * @static 4175 * @syscap SystemCapability.ArkUI.ArkUI.Full 4176 * @crossplatform 4177 * @form 4178 * @since 10 4179 */ 4180 /** 4181 * Specifies a transition effect with transparency of 0, which is equivalent to TransitionEffect.opacity(0). 4182 * 4183 * @type { TransitionEffect<"opacity"> } 4184 * @readonly 4185 * @static 4186 * @syscap SystemCapability.ArkUI.ArkUI.Full 4187 * @crossplatform 4188 * @form 4189 * @atomicservice 4190 * @since 11 4191 */ 4192 static readonly OPACITY: TransitionEffect<"opacity">; 4193 4194 /** 4195 * Defines a slide transition effect 4196 * 4197 * @type { TransitionEffect< 4198 * "asymmetric", 4199 * {appear: TransitionEffect<"move", TransitionEdge>; 4200 * disappear: TransitionEffect<"move", TransitionEdge>; 4201 * }> } 4202 * @readonly 4203 * @static 4204 * @syscap SystemCapability.ArkUI.ArkUI.Full 4205 * @crossplatform 4206 * @form 4207 * @since 10 4208 */ 4209 /** 4210 * Defines a slide transition effect 4211 * 4212 * @type { TransitionEffect< 4213 * "asymmetric", 4214 * {appear: TransitionEffect<"move", TransitionEdge>; 4215 * disappear: TransitionEffect<"move", TransitionEdge>; 4216 * }> } 4217 * @readonly 4218 * @static 4219 * @syscap SystemCapability.ArkUI.ArkUI.Full 4220 * @crossplatform 4221 * @form 4222 * @atomicservice 4223 * @since 11 4224 */ 4225 static readonly SLIDE: TransitionEffect< 4226 "asymmetric", 4227 { 4228 appear: TransitionEffect<"move", TransitionEdge>; 4229 disappear: TransitionEffect<"move", TransitionEdge>; 4230 } 4231 >; 4232 4233 /** 4234 * Specify a transition effect where the element enters by shrinking first and then expanding as it slides in from the right, 4235 * and exits by shrinking first and then expanding as it slides out to the left, with a minimum scale ratio of 0.8. 4236 * It comes with default animation parameters, which can also be overridden. 4237 * The default animation duration is set to 600ms, and the specified animation curve is cubicBezierCurve(0.24, 0.0, 0.50, 1.0). 4238 * 4239 * @type { TransitionEffect<"slideSwitch"> } 4240 * @readonly 4241 * @static 4242 * @syscap SystemCapability.ArkUI.ArkUI.Full 4243 * @crossplatform 4244 * @form 4245 * @since 10 4246 */ 4247 /** 4248 * Specify a transition effect where the element enters by shrinking first and then expanding as it slides in from the right, 4249 * and exits by shrinking first and then expanding as it slides out to the left, with a minimum scale ratio of 0.8. 4250 * It comes with default animation parameters, which can also be overridden. 4251 * The default animation duration is set to 600ms, and the specified animation curve is cubicBezierCurve(0.24, 0.0, 0.50, 1.0). 4252 * 4253 * @type { TransitionEffect<"slideSwitch"> } 4254 * @readonly 4255 * @static 4256 * @syscap SystemCapability.ArkUI.ArkUI.Full 4257 * @crossplatform 4258 * @form 4259 * @atomicservice 4260 * @since 11 4261 */ 4262 static readonly SLIDE_SWITCH: TransitionEffect<"slideSwitch">; 4263 4264 /** 4265 * Creates a translate transition effect 4266 * 4267 * @param { TranslateOptions } options - translate options 4268 * @returns { TransitionEffect<"translate"> } 4269 * @syscap SystemCapability.ArkUI.ArkUI.Full 4270 * @crossplatform 4271 * @form 4272 * @since 10 4273 */ 4274 /** 4275 * Creates a translate transition effect 4276 * 4277 * @param { TranslateOptions } options - translate options 4278 * @returns { TransitionEffect<"translate"> } 4279 * @syscap SystemCapability.ArkUI.ArkUI.Full 4280 * @crossplatform 4281 * @form 4282 * @atomicservice 4283 * @since 11 4284 */ 4285 static translate(options: TranslateOptions): TransitionEffect<"translate">; 4286 4287 /** 4288 * Creates a rotation transition effect 4289 * 4290 * @param { RotateOptions } options - rotate options 4291 * Set the rotation effect for component transitions when inserting and deleting. 4292 * The value represents the starting rotation point for the inserting animation and the ending rotation point for the deleting animation. 4293 * -x: Horizontal component of the rotational vector. 4294 * -y: Vertical component of the rotational vector. 4295 * -z: Vertical component of the rotational vector. 4296 * -centerX, centerY specify the rotation center point, with default values of "50%", 4297 * meaning that the default rotation center point is the center point of the component. 4298 * -The center point of (0, 0) represents the upper-left corner of the component. 4299 * -centerZ refers to the Z-axis anchor point. The default value of centerZ is 0. 4300 * -perspective indicates the visual distance. The perspective property does not support transition animation. 4301 * @returns { TransitionEffect<"rotate"> } 4302 * @syscap SystemCapability.ArkUI.ArkUI.Full 4303 * @crossplatform 4304 * @form 4305 * @since 10 4306 */ 4307 /** 4308 * Creates a rotation transition effect 4309 * 4310 * @param { RotateOptions } options - rotate options 4311 * Set the rotation effect for component transitions when inserting and deleting. 4312 * The value represents the starting rotation point for the inserting animation and the ending rotation point for the deleting animation. 4313 * -x: Horizontal component of the rotational vector. 4314 * -y: Vertical component of the rotational vector. 4315 * -z: Vertical component of the rotational vector. 4316 * -centerX, centerY specify the rotation center point, with default values of "50%", 4317 * meaning that the default rotation center point is the center point of the component. 4318 * -The center point of (0, 0) represents the upper-left corner of the component. 4319 * -centerZ refers to the Z-axis anchor point. The default value of centerZ is 0. 4320 * -perspective indicates the visual distance. The perspective property does not support transition animation. 4321 * @returns { TransitionEffect<"rotate"> } 4322 * @syscap SystemCapability.ArkUI.ArkUI.Full 4323 * @crossplatform 4324 * @form 4325 * @atomicservice 4326 * @since 11 4327 */ 4328 static rotate(options: RotateOptions): TransitionEffect<"rotate">; 4329 4330 /** 4331 * Creates a scale transition effect 4332 * 4333 * @param { ScaleOptions } options - scale options 4334 * @returns { TransitionEffect<"scale"> } 4335 * @syscap SystemCapability.ArkUI.ArkUI.Full 4336 * @crossplatform 4337 * @form 4338 * @since 10 4339 */ 4340 /** 4341 * Creates a scale transition effect 4342 * 4343 * @param { ScaleOptions } options - scale options 4344 * @returns { TransitionEffect<"scale"> } 4345 * @syscap SystemCapability.ArkUI.ArkUI.Full 4346 * @crossplatform 4347 * @form 4348 * @atomicservice 4349 * @since 11 4350 */ 4351 static scale(options: ScaleOptions): TransitionEffect<"scale">; 4352 4353 /** 4354 * Creates an opacity transition effect with alpha value 4355 * 4356 * @param { number } alpha - opacity alpha value, value range [0, 1]. 4357 * @returns { TransitionEffect<"opacity"> } 4358 * @syscap SystemCapability.ArkUI.ArkUI.Full 4359 * @crossplatform 4360 * @form 4361 * @since 10 4362 */ 4363 /** 4364 * Creates an opacity transition effect with alpha value 4365 * 4366 * @param { number } alpha - opacity alpha value, value range [0, 1]. 4367 * @returns { TransitionEffect<"opacity"> } 4368 * @syscap SystemCapability.ArkUI.ArkUI.Full 4369 * @crossplatform 4370 * @form 4371 * @atomicservice 4372 * @since 11 4373 */ 4374 /** 4375 * Creates an opacity transition effect with alpha value 4376 * 4377 * @param { number } alpha - opacity alpha value, value range [0, 1]. 4378 * Illegal values less than 0 are treated as 0, and illegal values greater than 1 are treated as 1. 4379 * @returns { TransitionEffect<"opacity"> } 4380 * @syscap SystemCapability.ArkUI.ArkUI.Full 4381 * @crossplatform 4382 * @form 4383 * @atomicservice 4384 * @since 12 4385 */ 4386 static opacity(alpha: number): TransitionEffect<"opacity">; 4387 4388 /** 4389 * Creates a move transition effect 4390 * 4391 * @param { TransitionEdge } edge - the edge that component will move to 4392 * @returns { TransitionEffect<"move"> } 4393 * @syscap SystemCapability.ArkUI.ArkUI.Full 4394 * @crossplatform 4395 * @form 4396 * @since 10 4397 */ 4398 /** 4399 * Creates a move transition effect 4400 * 4401 * @param { TransitionEdge } edge - the edge that component will move to 4402 * @returns { TransitionEffect<"move"> } 4403 * @syscap SystemCapability.ArkUI.ArkUI.Full 4404 * @crossplatform 4405 * @form 4406 * @atomicservice 4407 * @since 11 4408 */ 4409 static move(edge: TransitionEdge): TransitionEffect<"move">; 4410 4411 /** 4412 * Creates an asymmetric transition effect 4413 * 4414 * @param { TransitionEffect } appear - the transition which will be attached when the component is appear 4415 * @param { TransitionEffect } disappear - the transition which will be attached when the component is disappear 4416 * @returns { TransitionEffect<"asymmetric"> } 4417 * @syscap SystemCapability.ArkUI.ArkUI.Full 4418 * @crossplatform 4419 * @form 4420 * @since 10 4421 */ 4422 /** 4423 * Creates an asymmetric transition effect 4424 * 4425 * @param { TransitionEffect } appear - the transition which will be attached when the component is appear 4426 * @param { TransitionEffect } disappear - the transition which will be attached when the component is disappear 4427 * @returns { TransitionEffect<"asymmetric"> } 4428 * @syscap SystemCapability.ArkUI.ArkUI.Full 4429 * @crossplatform 4430 * @form 4431 * @atomicservice 4432 * @since 11 4433 */ 4434 static asymmetric( 4435 appear: TransitionEffect, 4436 disappear: TransitionEffect 4437 ): TransitionEffect<"asymmetric">; 4438 4439 /** 4440 * TransitionEffect constructor 4441 * 4442 * @param { Type } type - transition type 4443 * @param { Effect } effect - transition options 4444 * @syscap SystemCapability.ArkUI.ArkUI.Full 4445 * @crossplatform 4446 * @form 4447 * @since 10 4448 */ 4449 /** 4450 * TransitionEffect constructor 4451 * 4452 * @param { Type } type - transition type 4453 * @param { Effect } effect - transition options 4454 * @syscap SystemCapability.ArkUI.ArkUI.Full 4455 * @crossplatform 4456 * @form 4457 * @atomicservice 4458 * @since 11 4459 */ 4460 constructor(type: Type, effect: Effect); 4461 4462 /** 4463 * Set the animation of current transition effect 4464 * 4465 * @param { AnimateParam } value - animation parameters 4466 * @returns { TransitionEffect } 4467 * @syscap SystemCapability.ArkUI.ArkUI.Full 4468 * @crossplatform 4469 * @form 4470 * @since 10 4471 */ 4472 /** 4473 * Set the animation of current transition effect 4474 * 4475 * @param { AnimateParam } value - animation parameters 4476 * @returns { TransitionEffect } 4477 * @syscap SystemCapability.ArkUI.ArkUI.Full 4478 * @crossplatform 4479 * @form 4480 * @atomicservice 4481 * @since 11 4482 */ 4483 animation(value: AnimateParam): TransitionEffect; 4484 4485 /** 4486 * Combines another transition effect 4487 * 4488 * @param { TransitionEffect } transitionEffect - transition effect which is be combined 4489 * @returns { TransitionEffect } combined transition effect 4490 * @syscap SystemCapability.ArkUI.ArkUI.Full 4491 * @crossplatform 4492 * @form 4493 * @since 10 4494 */ 4495 /** 4496 * Combines another transition effect 4497 * 4498 * @param { TransitionEffect } transitionEffect - transition effect which is be combined 4499 * @returns { TransitionEffect } combined transition effect 4500 * @syscap SystemCapability.ArkUI.ArkUI.Full 4501 * @crossplatform 4502 * @form 4503 * @atomicservice 4504 * @since 11 4505 */ 4506 combine(transitionEffect: TransitionEffect): TransitionEffect; 4507} 4508 4509/** 4510 * Define Preview property 4511 * 4512 * @interface PreviewParams 4513 * @syscap SystemCapability.ArkUI.ArkUI.Full 4514 * @form 4515 * @since 9 4516 */ 4517/** 4518 * Define Preview property 4519 * 4520 * @interface PreviewParams 4521 * @syscap SystemCapability.ArkUI.ArkUI.Full 4522 * @crossplatform 4523 * @form 4524 * @atomicservice 4525 * @since 11 4526 */ 4527interface PreviewParams { 4528 /** 4529 * Define Preview title 4530 * 4531 * @type { ?string } 4532 * @syscap SystemCapability.ArkUI.ArkUI.Full 4533 * @form 4534 * @since 9 4535 */ 4536 /** 4537 * Define Preview title 4538 * 4539 * @type { ?string } 4540 * @syscap SystemCapability.ArkUI.ArkUI.Full 4541 * @crossplatform 4542 * @form 4543 * @atomicservice 4544 * @since 11 4545 */ 4546 title?: string; 4547 4548 /** 4549 * Define Preview width 4550 * 4551 * @type { ?number } 4552 * @syscap SystemCapability.ArkUI.ArkUI.Full 4553 * @form 4554 * @since 9 4555 */ 4556 /** 4557 * Define Preview width 4558 * 4559 * @type { ?number } 4560 * @syscap SystemCapability.ArkUI.ArkUI.Full 4561 * @crossplatform 4562 * @form 4563 * @atomicservice 4564 * @since 11 4565 */ 4566 width?: number; 4567 4568 /** 4569 * Define Preview height 4570 * 4571 * @type { ?number } 4572 * @syscap SystemCapability.ArkUI.ArkUI.Full 4573 * @form 4574 * @since 9 4575 */ 4576 /** 4577 * Define Preview height 4578 * 4579 * @type { ?number } 4580 * @syscap SystemCapability.ArkUI.ArkUI.Full 4581 * @crossplatform 4582 * @form 4583 * @atomicservice 4584 * @since 11 4585 */ 4586 height?: number; 4587 4588 /** 4589 * Define Preview locale 4590 * 4591 * @type { ?string } 4592 * @syscap SystemCapability.ArkUI.ArkUI.Full 4593 * @form 4594 * @since 9 4595 */ 4596 /** 4597 * Define Preview locale 4598 * 4599 * @type { ?string } 4600 * @syscap SystemCapability.ArkUI.ArkUI.Full 4601 * @form 4602 * @atomicservice 4603 * @since 11 4604 */ 4605 locale?: string; 4606 4607 /** 4608 * Define Preview colorMode 4609 * 4610 * @type { ?string } 4611 * @syscap SystemCapability.ArkUI.ArkUI.Full 4612 * @form 4613 * @since 9 4614 */ 4615 /** 4616 * Define Preview colorMode 4617 * 4618 * @type { ?string } 4619 * @syscap SystemCapability.ArkUI.ArkUI.Full 4620 * @crossplatform 4621 * @form 4622 * @atomicservice 4623 * @since 11 4624 */ 4625 colorMode?: string; 4626 4627 /** 4628 * Define Preview deviceType 4629 * 4630 * @type { ?string } 4631 * @syscap SystemCapability.ArkUI.ArkUI.Full 4632 * @form 4633 * @since 9 4634 */ 4635 /** 4636 * Define Preview deviceType 4637 * 4638 * @type { ?string } 4639 * @syscap SystemCapability.ArkUI.ArkUI.Full 4640 * @form 4641 * @atomicservice 4642 * @since 11 4643 */ 4644 deviceType?: string; 4645 4646 /** 4647 * Define Preview dpi 4648 * 4649 * @type { ?number } 4650 * @syscap SystemCapability.ArkUI.ArkUI.Full 4651 * @form 4652 * @since 9 4653 */ 4654 /** 4655 * Define Preview dpi 4656 * 4657 * @type { ?number } 4658 * @syscap SystemCapability.ArkUI.ArkUI.Full 4659 * @form 4660 * @atomicservice 4661 * @since 11 4662 */ 4663 dpi?: number; 4664 4665 /** 4666 * Define Preview orientation 4667 * 4668 * @type { ?string } 4669 * @syscap SystemCapability.ArkUI.ArkUI.Full 4670 * @form 4671 * @since 9 4672 */ 4673 /** 4674 * Define Preview orientation 4675 * 4676 * @type { ?string } 4677 * @syscap SystemCapability.ArkUI.ArkUI.Full 4678 * @form 4679 * @atomicservice 4680 * @since 11 4681 */ 4682 orientation?: string; 4683 4684 /** 4685 * Define Preview roundScreen 4686 * 4687 * @type { ?boolean } 4688 * @syscap SystemCapability.ArkUI.ArkUI.Full 4689 * @form 4690 * @since 9 4691 */ 4692 /** 4693 * Define Preview roundScreen 4694 * 4695 * @type { ?boolean } 4696 * @syscap SystemCapability.ArkUI.ArkUI.Full 4697 * @form 4698 * @atomicservice 4699 * @since 11 4700 */ 4701 roundScreen?: boolean; 4702} 4703 4704/** 4705 * ItemDragInfo object description 4706 * 4707 * @interface ItemDragInfo 4708 * @syscap SystemCapability.ArkUI.ArkUI.Full 4709 * @since 8 4710 */ 4711/** 4712 * ItemDragInfo object description 4713 * 4714 * @interface ItemDragInfo 4715 * @syscap SystemCapability.ArkUI.ArkUI.Full 4716 * @crossplatform 4717 * @since 10 4718 */ 4719/** 4720 * ItemDragInfo object description 4721 * 4722 * @interface ItemDragInfo 4723 * @syscap SystemCapability.ArkUI.ArkUI.Full 4724 * @crossplatform 4725 * @atomicservice 4726 * @since 11 4727 */ 4728declare interface ItemDragInfo { 4729 /** 4730 * Obtains the X coordinate of the drag window, in vp. 4731 * 4732 * @type { number } 4733 * @syscap SystemCapability.ArkUI.ArkUI.Full 4734 * @since 8 4735 */ 4736 /** 4737 * Obtains the X coordinate of the drag window, in vp. 4738 * 4739 * @type { number } 4740 * @syscap SystemCapability.ArkUI.ArkUI.Full 4741 * @crossplatform 4742 * @since 10 4743 */ 4744 /** 4745 * Obtains the X coordinate of the drag window, in vp. 4746 * 4747 * @type { number } 4748 * @syscap SystemCapability.ArkUI.ArkUI.Full 4749 * @crossplatform 4750 * @atomicservice 4751 * @since 11 4752 */ 4753 x: number; 4754 4755 /** 4756 * Obtains the Y coordinate of the drag window, in vp. 4757 * 4758 * @type { number } 4759 * @syscap SystemCapability.ArkUI.ArkUI.Full 4760 * @since 8 4761 */ 4762 /** 4763 * Obtains the Y coordinate of the drag window, in vp. 4764 * 4765 * @type { number } 4766 * @syscap SystemCapability.ArkUI.ArkUI.Full 4767 * @crossplatform 4768 * @since 10 4769 */ 4770 /** 4771 * Obtains the Y coordinate of the drag window, in vp. 4772 * 4773 * @type { number } 4774 * @syscap SystemCapability.ArkUI.ArkUI.Full 4775 * @crossplatform 4776 * @atomicservice 4777 * @since 11 4778 */ 4779 y: number; 4780} 4781 4782/** 4783 * Enum of using the effects template mode. 4784 * 4785 * @enum { number } 4786 * @syscap SystemCapability.ArkUI.ArkUI.Full 4787 * @atomicservice 4788 * @since 14 4789 */ 4790declare enum EffectType { 4791 /** 4792 * Define use the effects template defined by the parent effectComponent. 4793 * 4794 * @syscap SystemCapability.ArkUI.ArkUI.Full 4795 * @atomicservice 4796 * @since 14 4797 */ 4798 DEFAULT = 0, 4799 /** 4800 * Define use the effects template defined by the window. 4801 * 4802 * @syscap SystemCapability.ArkUI.ArkUI.Full 4803 * @atomicservice 4804 * @since 14 4805 */ 4806 WINDOW_EFFECT = 1, 4807} 4808 4809/** 4810 * Defines the drag status before drag action. 4811 * 4812 * @enum { number } 4813 * @syscap SystemCapability.ArkUI.ArkUI.Full 4814 * @atomicservice 4815 * @since 12 4816 */ 4817declare enum PreDragStatus { 4818 /** 4819 * Define the status for user prepare to start long press gesture. 4820 * 4821 * @syscap SystemCapability.ArkUI.ArkUI.Full 4822 * @atomicservice 4823 * @since 12 4824 */ 4825 ACTION_DETECTING_STATUS = 0, 4826 4827 /** 4828 * Define the status for user can start drag action. 4829 * 4830 * @syscap SystemCapability.ArkUI.ArkUI.Full 4831 * @atomicservice 4832 * @since 12 4833 */ 4834 READY_TO_TRIGGER_DRAG_ACTION = 1, 4835 4836 /** 4837 * Define the status for dragItem lift animation started. 4838 * 4839 * @syscap SystemCapability.ArkUI.ArkUI.Full 4840 * @atomicservice 4841 * @since 12 4842 */ 4843 PREVIEW_LIFT_STARTED = 2, 4844 4845 /** 4846 * Define the status for dragItem lift animation finished. 4847 * 4848 * @syscap SystemCapability.ArkUI.ArkUI.Full 4849 * @atomicservice 4850 * @since 12 4851 */ 4852 PREVIEW_LIFT_FINISHED = 3, 4853 4854 /** 4855 * Define the status for dragItem landing animation started. 4856 * 4857 * @syscap SystemCapability.ArkUI.ArkUI.Full 4858 * @atomicservice 4859 * @since 12 4860 */ 4861 PREVIEW_LANDING_STARTED = 4, 4862 4863 /** 4864 * Define the status for dragItem landing animation finished. 4865 * 4866 * @syscap SystemCapability.ArkUI.ArkUI.Full 4867 * @atomicservice 4868 * @since 12 4869 */ 4870 PREVIEW_LANDING_FINISHED = 5, 4871 4872 /** 4873 * Define the status for user cancel drag action. 4874 * 4875 * @syscap SystemCapability.ArkUI.ArkUI.Full 4876 * @atomicservice 4877 * @since 12 4878 */ 4879 ACTION_CANCELED_BEFORE_DRAG = 6, 4880} 4881 4882/** 4883 * DragItemInfo object description 4884 * 4885 * @interface DragItemInfo 4886 * @syscap SystemCapability.ArkUI.ArkUI.Full 4887 * @since 8 4888 */ 4889/** 4890 * DragItemInfo object description 4891 * 4892 * @interface DragItemInfo 4893 * @syscap SystemCapability.ArkUI.ArkUI.Full 4894 * @atomicservice 4895 * @since 11 4896 */ 4897/** 4898 * DragItemInfo object description 4899 * 4900 * @interface DragItemInfo 4901 * @syscap SystemCapability.ArkUI.ArkUI.Full 4902 * @crossplatform 4903 * @atomicservice 4904 * @since 14 4905 */ 4906declare interface DragItemInfo { 4907 /** 4908 * Uses the pixelMap object for drawing. 4909 * 4910 * @type { ?PixelMap } 4911 * @syscap SystemCapability.ArkUI.ArkUI.Full 4912 * @since 8 4913 */ 4914 /** 4915 * Uses the pixelMap object for drawing. 4916 * 4917 * @type { ?PixelMap } 4918 * @syscap SystemCapability.ArkUI.ArkUI.Full 4919 * @atomicservice 4920 * @since 11 4921 */ 4922 /** 4923 * Uses the pixelMap object for drawing. 4924 * 4925 * @type { ?PixelMap } 4926 * @syscap SystemCapability.ArkUI.ArkUI.Full 4927 * @crossplatform 4928 * @atomicservice 4929 * @since 14 4930 */ 4931 pixelMap?: PixelMap; 4932 4933 /** 4934 * Uses the custom builder for drawing, if pixelMap is set, this value is ignored. 4935 * 4936 * @type { ?CustomBuilder } 4937 * @syscap SystemCapability.ArkUI.ArkUI.Full 4938 * @since 8 4939 */ 4940 /** 4941 * Uses the custom builder for drawing, if pixelMap is set, this value is ignored. 4942 * 4943 * @type { ?CustomBuilder } 4944 * @syscap SystemCapability.ArkUI.ArkUI.Full 4945 * @atomicservice 4946 * @since 11 4947 */ 4948 /** 4949 * Uses the custom builder for drawing, if pixelMap is set, this value is ignored. 4950 * 4951 * @type { ?CustomBuilder } 4952 * @syscap SystemCapability.ArkUI.ArkUI.Full 4953 * @crossplatform 4954 * @atomicservice 4955 * @since 14 4956 */ 4957 builder?: CustomBuilder; 4958 4959 /** 4960 * Sets the extra info for drag event. 4961 * 4962 * @type { ?string } 4963 * @syscap SystemCapability.ArkUI.ArkUI.Full 4964 * @since 8 4965 */ 4966 /** 4967 * Sets the extra info for drag event. 4968 * 4969 * @type { ?string } 4970 * @syscap SystemCapability.ArkUI.ArkUI.Full 4971 * @atomicservice 4972 * @since 11 4973 */ 4974 /** 4975 * Sets the extra info for drag event. 4976 * 4977 * @type { ?string } 4978 * @syscap SystemCapability.ArkUI.ArkUI.Full 4979 * @crossplatform 4980 * @atomicservice 4981 * @since 14 4982 */ 4983 extraInfo?: string; 4984} 4985 4986/** 4987 * Defining animation function. 4988 * 4989 * @param { AnimateParam } value 4990 * @param { function } event 4991 * @syscap SystemCapability.ArkUI.ArkUI.Full 4992 * @since 7 4993 */ 4994/** 4995 * Defining animation function. 4996 * 4997 * @param { AnimateParam } value 4998 * @param { function } event 4999 * @syscap SystemCapability.ArkUI.ArkUI.Full 5000 * @form 5001 * @since 9 5002 */ 5003/** 5004 * Defining animation function. 5005 * 5006 * @param { AnimateParam } value 5007 * @param { function } event 5008 * @syscap SystemCapability.ArkUI.ArkUI.Full 5009 * @crossplatform 5010 * @form 5011 * @since 10 5012 */ 5013/** 5014 * Defining animation function. 5015 * 5016 * @param { AnimateParam } value 5017 * @param { function } event 5018 * @syscap SystemCapability.ArkUI.ArkUI.Full 5019 * @crossplatform 5020 * @form 5021 * @atomicservice 5022 * @since 11 5023 */ 5024declare function animateTo(value: AnimateParam, event: () => void): void; 5025 5026/** 5027 * Define animation functions for immediate distribution. 5028 * 5029 * @param { AnimateParam } value - Set animation effect parameters. 5030 * @param { function } event - Specify the closure function that displays dynamic effects, 5031 * and the system will automatically insert transition animations for state changes caused by the closure function. 5032 * @syscap SystemCapability.ArkUI.ArkUI.Full 5033 * @atomicservice 5034 * @since 12 5035 */ 5036declare function animateToImmediately(value: AnimateParam, event: () => void): void; 5037 5038/** 5039 * Converts a value in vp units to a value in px. 5040 * 5041 * @param { number } value 5042 * @returns { number } 5043 * @syscap SystemCapability.ArkUI.ArkUI.Full 5044 * @since 7 5045 */ 5046/** 5047 * Converts a value in vp units to a value in px. 5048 * 5049 * @param { number } value 5050 * @returns { number } 5051 * @syscap SystemCapability.ArkUI.ArkUI.Full 5052 * @form 5053 * @since 9 5054 */ 5055/** 5056 * Converts a value in vp units to a value in px. 5057 * 5058 * @param { number } value 5059 * @returns { number } 5060 * @syscap SystemCapability.ArkUI.ArkUI.Full 5061 * @crossplatform 5062 * @form 5063 * @since 10 5064 */ 5065/** 5066 * Converts a value in vp units to a value in px. 5067 * 5068 * @param { number } value 5069 * @returns { number } 5070 * @syscap SystemCapability.ArkUI.ArkUI.Full 5071 * @crossplatform 5072 * @form 5073 * @atomicservice 5074 * @since 11 5075 */ 5076declare function vp2px(value: number): number; 5077 5078/** 5079 * Converts a number in units of px to a number in units of vp. 5080 * 5081 * @param { number } value 5082 * @returns { number } 5083 * @syscap SystemCapability.ArkUI.ArkUI.Full 5084 * @since 7 5085 */ 5086/** 5087 * Converts a number in units of px to a number in units of vp. 5088 * 5089 * @param { number } value 5090 * @returns { number } 5091 * @syscap SystemCapability.ArkUI.ArkUI.Full 5092 * @form 5093 * @since 9 5094 */ 5095/** 5096 * Converts a number in units of px to a number in units of vp. 5097 * 5098 * @param { number } value 5099 * @returns { number } 5100 * @syscap SystemCapability.ArkUI.ArkUI.Full 5101 * @crossplatform 5102 * @form 5103 * @since 10 5104 */ 5105/** 5106 * Converts a number in units of px to a number in units of vp. 5107 * 5108 * @param { number } value 5109 * @returns { number } 5110 * @syscap SystemCapability.ArkUI.ArkUI.Full 5111 * @crossplatform 5112 * @form 5113 * @atomicservice 5114 * @since 11 5115 */ 5116declare function px2vp(value: number): number; 5117 5118/** 5119 * Converts a number in fp units to a number in px. 5120 * 5121 * @param { number } value 5122 * @returns { number } 5123 * @syscap SystemCapability.ArkUI.ArkUI.Full 5124 * @since 7 5125 */ 5126/** 5127 * Converts a number in fp units to a number in px. 5128 * 5129 * @param { number } value 5130 * @returns { number } 5131 * @syscap SystemCapability.ArkUI.ArkUI.Full 5132 * @form 5133 * @since 9 5134 */ 5135/** 5136 * Converts a number in fp units to a number in px. 5137 * 5138 * @param { number } value 5139 * @returns { number } 5140 * @syscap SystemCapability.ArkUI.ArkUI.Full 5141 * @crossplatform 5142 * @form 5143 * @since 10 5144 */ 5145/** 5146 * Converts a number in fp units to a number in px. 5147 * 5148 * @param { number } value 5149 * @returns { number } 5150 * @syscap SystemCapability.ArkUI.ArkUI.Full 5151 * @crossplatform 5152 * @form 5153 * @atomicservice 5154 * @since 11 5155 */ 5156declare function fp2px(value: number): number; 5157 5158/** 5159 * Converts a number in units of px to a number in units of fp. 5160 * 5161 * @param { number } value 5162 * @returns { number } 5163 * @syscap SystemCapability.ArkUI.ArkUI.Full 5164 * @since 7 5165 */ 5166/** 5167 * Converts a number in units of px to a number in units of fp. 5168 * 5169 * @param { number } value 5170 * @returns { number } 5171 * @syscap SystemCapability.ArkUI.ArkUI.Full 5172 * @form 5173 * @since 9 5174 */ 5175/** 5176 * Converts a number in units of px to a number in units of fp. 5177 * 5178 * @param { number } value 5179 * @returns { number } 5180 * @syscap SystemCapability.ArkUI.ArkUI.Full 5181 * @crossplatform 5182 * @form 5183 * @since 10 5184 */ 5185/** 5186 * Converts a number in units of px to a number in units of fp. 5187 * 5188 * @param { number } value 5189 * @returns { number } 5190 * @syscap SystemCapability.ArkUI.ArkUI.Full 5191 * @crossplatform 5192 * @form 5193 * @atomicservice 5194 * @since 11 5195 */ 5196declare function px2fp(value: number): number; 5197 5198/** 5199 * Converts a number in units of lpx to a number in units of px. 5200 * 5201 * @param { number } value 5202 * @returns { number } 5203 * @syscap SystemCapability.ArkUI.ArkUI.Full 5204 * @since 7 5205 */ 5206/** 5207 * Converts a number in units of lpx to a number in units of px. 5208 * 5209 * @param { number } value 5210 * @returns { number } 5211 * @syscap SystemCapability.ArkUI.ArkUI.Full 5212 * @form 5213 * @since 9 5214 */ 5215/** 5216 * Converts a number in units of lpx to a number in units of px. 5217 * 5218 * @param { number } value 5219 * @returns { number } 5220 * @syscap SystemCapability.ArkUI.ArkUI.Full 5221 * @crossplatform 5222 * @form 5223 * @since 10 5224 */ 5225/** 5226 * Converts a number in units of lpx to a number in units of px. 5227 * 5228 * @param { number } value 5229 * @returns { number } 5230 * @syscap SystemCapability.ArkUI.ArkUI.Full 5231 * @crossplatform 5232 * @form 5233 * @atomicservice 5234 * @since 11 5235 */ 5236declare function lpx2px(value: number): number; 5237 5238/** 5239 * Converts a number in units of px to a number in units of lpx. 5240 * 5241 * @param { number } value 5242 * @returns { number } 5243 * @syscap SystemCapability.ArkUI.ArkUI.Full 5244 * @since 7 5245 */ 5246/** 5247 * Converts a number in units of px to a number in units of lpx. 5248 * 5249 * @param { number } value 5250 * @returns { number } 5251 * @syscap SystemCapability.ArkUI.ArkUI.Full 5252 * @form 5253 * @since 9 5254 */ 5255/** 5256 * Converts a number in units of px to a number in units of lpx. 5257 * 5258 * @param { number } value 5259 * @returns { number } 5260 * @syscap SystemCapability.ArkUI.ArkUI.Full 5261 * @crossplatform 5262 * @form 5263 * @since 10 5264 */ 5265/** 5266 * Converts a number in units of px to a number in units of lpx. 5267 * 5268 * @param { number } value 5269 * @returns { number } 5270 * @syscap SystemCapability.ArkUI.ArkUI.Full 5271 * @crossplatform 5272 * @form 5273 * @atomicservice 5274 * @since 11 5275 */ 5276declare function px2lpx(value: number): number; 5277 5278/** 5279 * Defines the namespace of focus controller. 5280 * 5281 * @namespace focusControl 5282 * @syscap SystemCapability.ArkUI.ArkUI.Full 5283 * @crossplatform 5284 * @form 5285 * @since 9 5286 */ 5287/** 5288 * Defines the namespace of focus controller. 5289 * 5290 * @namespace focusControl 5291 * @syscap SystemCapability.ArkUI.ArkUI.Full 5292 * @crossplatform 5293 * @form 5294 * @atomicservice 5295 * @since 11 5296 */ 5297declare namespace focusControl { 5298 /** 5299 * Request focus to the specific component by param: 'id/key'. 5300 * 5301 * @param { string } value 5302 * @returns { boolean } 5303 * @syscap SystemCapability.ArkUI.ArkUI.Full 5304 * @since 9 5305 */ 5306 /** 5307 * Request focus to the specific component by param: 'id/key'. 5308 * 5309 * @param { string } value 5310 * @returns { boolean } 5311 * @syscap SystemCapability.ArkUI.ArkUI.Full 5312 * @crossplatform 5313 * @since 10 5314 */ 5315 /** 5316 * Request focus to the specific component by param: 'id/key'. 5317 * 5318 * @param { string } value 5319 * @returns { boolean } 5320 * @syscap SystemCapability.ArkUI.ArkUI.Full 5321 * @crossplatform 5322 * @atomicservice 5323 * @since 11 5324 */ 5325 function requestFocus(value: string): boolean; 5326} 5327 5328/** 5329 * Import the PointerStyle type object for setCursor. 5330 * 5331 * @typedef { import('../api/@ohos.multimodalInput.pointer').default.PointerStyle } PointerStyle 5332 * @syscap SystemCapability.ArkUI.ArkUI.Full 5333 * @since 11 5334 */ 5335/** 5336 * Import the PointerStyle type object for setCursor. 5337 * 5338 * @typedef { import('../api/@ohos.multimodalInput.pointer').default.PointerStyle } PointerStyle 5339 * @syscap SystemCapability.ArkUI.ArkUI.Full 5340 * @atomicservice 5341 * @since 12 5342 */ 5343declare type PointerStyle = import('../api/@ohos.multimodalInput.pointer').default.PointerStyle; 5344 5345/** 5346 * CursorControl 5347 * 5348 * @namespace cursorControl 5349 * @syscap SystemCapability.ArkUI.ArkUI.Full 5350 * @since 11 5351 */ 5352/** 5353 * CursorControl 5354 * 5355 * @namespace cursorControl 5356 * @syscap SystemCapability.ArkUI.ArkUI.Full 5357 * @atomicservice 5358 * @since 12 5359 */ 5360declare namespace cursorControl { 5361 5362 /** 5363 * Change the mouse cursor style by param: 'PointerStyle'. 5364 * 5365 * @param { PointerStyle } value 5366 * @syscap SystemCapability.ArkUI.ArkUI.Full 5367 * @crossplatform 5368 * @since 11 5369 */ 5370 /** 5371 * Change the mouse cursor style by param: 'PointerStyle'. 5372 * 5373 * @param { PointerStyle } value 5374 * @syscap SystemCapability.ArkUI.ArkUI.Full 5375 * @crossplatform 5376 * @atomicservice 5377 * @since 12 5378 */ 5379 function setCursor(value: PointerStyle): void; 5380 5381 /** 5382 * Restore the default mouse cursor style. 5383 * 5384 * @syscap SystemCapability.ArkUI.ArkUI.Full 5385 * @crossplatform 5386 * @since 11 5387 */ 5388 /** 5389 * Restore the default mouse cursor style. 5390 * 5391 * @syscap SystemCapability.ArkUI.ArkUI.Full 5392 * @crossplatform 5393 * @atomicservice 5394 * @since 12 5395 */ 5396 function restoreDefault(): void; 5397} 5398 5399/** 5400 * Defines the event target. 5401 * 5402 * @interface EventTarget 5403 * @syscap SystemCapability.ArkUI.ArkUI.Full 5404 * @since 8 5405 */ 5406/** 5407 * Defines the event target. 5408 * 5409 * @interface EventTarget 5410 * @syscap SystemCapability.ArkUI.ArkUI.Full 5411 * @form 5412 * @since 9 5413 */ 5414/** 5415 * Defines the event target. 5416 * 5417 * @interface EventTarget 5418 * @syscap SystemCapability.ArkUI.ArkUI.Full 5419 * @crossplatform 5420 * @form 5421 * @since 10 5422 */ 5423/** 5424 * Defines the event target. 5425 * 5426 * @interface EventTarget 5427 * @syscap SystemCapability.ArkUI.ArkUI.Full 5428 * @crossplatform 5429 * @form 5430 * @atomicservice 5431 * @since 11 5432 */ 5433declare interface EventTarget { 5434 /** 5435 * Area of current target. 5436 * 5437 * @type { Area } 5438 * @syscap SystemCapability.ArkUI.ArkUI.Full 5439 * @since 8 5440 */ 5441 /** 5442 * Area of current target. 5443 * 5444 * @type { Area } 5445 * @syscap SystemCapability.ArkUI.ArkUI.Full 5446 * @form 5447 * @since 9 5448 */ 5449 /** 5450 * Area of current target. 5451 * 5452 * @type { Area } 5453 * @syscap SystemCapability.ArkUI.ArkUI.Full 5454 * @crossplatform 5455 * @form 5456 * @since 10 5457 */ 5458 /** 5459 * Area of current target. 5460 * 5461 * @type { Area } 5462 * @syscap SystemCapability.ArkUI.ArkUI.Full 5463 * @crossplatform 5464 * @form 5465 * @atomicservice 5466 * @since 11 5467 */ 5468 area: Area; 5469} 5470 5471/** 5472 * Defines the event source type. 5473 * 5474 * @enum { number } 5475 * @syscap SystemCapability.ArkUI.ArkUI.Full 5476 * @since 8 5477 */ 5478/** 5479 * Defines the event source type. 5480 * 5481 * @enum { number } 5482 * @syscap SystemCapability.ArkUI.ArkUI.Full 5483 * @crossplatform 5484 * @since 10 5485 */ 5486/** 5487 * Defines the event source type. 5488 * 5489 * @enum { number } 5490 * @syscap SystemCapability.ArkUI.ArkUI.Full 5491 * @crossplatform 5492 * @atomicservice 5493 * @since 11 5494 */ 5495declare enum SourceType { 5496 /** 5497 * Unknown type. 5498 * 5499 * @syscap SystemCapability.ArkUI.ArkUI.Full 5500 * @since 8 5501 */ 5502 /** 5503 * Unknown type. 5504 * 5505 * @syscap SystemCapability.ArkUI.ArkUI.Full 5506 * @crossplatform 5507 * @since 10 5508 */ 5509 /** 5510 * Unknown type. 5511 * 5512 * @syscap SystemCapability.ArkUI.ArkUI.Full 5513 * @crossplatform 5514 * @atomicservice 5515 * @since 11 5516 */ 5517 Unknown, 5518 5519 /** 5520 * The mouse type. 5521 * 5522 * @syscap SystemCapability.ArkUI.ArkUI.Full 5523 * @since 8 5524 */ 5525 /** 5526 * The mouse type. 5527 * 5528 * @syscap SystemCapability.ArkUI.ArkUI.Full 5529 * @crossplatform 5530 * @since 10 5531 */ 5532 /** 5533 * The mouse type. 5534 * 5535 * @syscap SystemCapability.ArkUI.ArkUI.Full 5536 * @crossplatform 5537 * @atomicservice 5538 * @since 11 5539 */ 5540 Mouse, 5541 5542 /** 5543 * The touch screen type. 5544 * 5545 * @syscap SystemCapability.ArkUI.ArkUI.Full 5546 * @since 8 5547 */ 5548 /** 5549 * The touch screen type. 5550 * 5551 * @syscap SystemCapability.ArkUI.ArkUI.Full 5552 * @crossplatform 5553 * @since 10 5554 */ 5555 /** 5556 * The touch screen type. 5557 * 5558 * @syscap SystemCapability.ArkUI.ArkUI.Full 5559 * @crossplatform 5560 * @atomicservice 5561 * @since 11 5562 */ 5563 TouchScreen, 5564} 5565 5566/** 5567 * Defines the event tool type. 5568 * 5569 * @enum { number } 5570 * @syscap SystemCapability.ArkUI.ArkUI.Full 5571 * @since 9 5572 */ 5573/** 5574 * Defines the event tool type. 5575 * 5576 * @enum { number } 5577 * @syscap SystemCapability.ArkUI.ArkUI.Full 5578 * @crossplatform 5579 * @since 10 5580 */ 5581/** 5582 * Defines the event tool type. 5583 * 5584 * @enum { number } 5585 * @syscap SystemCapability.ArkUI.ArkUI.Full 5586 * @crossplatform 5587 * @atomicservice 5588 * @since 11 5589 */ 5590declare enum SourceTool { 5591 /** 5592 * Unknown type. 5593 * 5594 * @syscap SystemCapability.ArkUI.ArkUI.Full 5595 * @since 9 5596 */ 5597 /** 5598 * Unknown type. 5599 * 5600 * @syscap SystemCapability.ArkUI.ArkUI.Full 5601 * @crossplatform 5602 * @since 10 5603 */ 5604 /** 5605 * Unknown type. 5606 * 5607 * @syscap SystemCapability.ArkUI.ArkUI.Full 5608 * @crossplatform 5609 * @atomicservice 5610 * @since 11 5611 */ 5612 Unknown, 5613 5614 /** 5615 * The finger type. 5616 * 5617 * @syscap SystemCapability.ArkUI.ArkUI.Full 5618 * @since 9 5619 */ 5620 /** 5621 * The finger type. 5622 * 5623 * @syscap SystemCapability.ArkUI.ArkUI.Full 5624 * @crossplatform 5625 * @since 10 5626 */ 5627 /** 5628 * The finger type. 5629 * 5630 * @syscap SystemCapability.ArkUI.ArkUI.Full 5631 * @crossplatform 5632 * @atomicservice 5633 * @since 11 5634 */ 5635 Finger, 5636 5637 /** 5638 * The pen type. 5639 * 5640 * @syscap SystemCapability.ArkUI.ArkUI.Full 5641 * @since 9 5642 */ 5643 /** 5644 * The pen type. 5645 * 5646 * @syscap SystemCapability.ArkUI.ArkUI.Full 5647 * @crossplatform 5648 * @since 10 5649 */ 5650 /** 5651 * The pen type. 5652 * 5653 * @syscap SystemCapability.ArkUI.ArkUI.Full 5654 * @crossplatform 5655 * @atomicservice 5656 * @since 11 5657 */ 5658 Pen, 5659 5660 /** 5661 * The mouse type. 5662 * 5663 * @syscap SystemCapability.ArkUI.ArkUI.Full 5664 * @crossplatform 5665 * @atomicservice 5666 * @since 12 5667 */ 5668 MOUSE, 5669 5670 /** 5671 * The touchpad type. 5672 * 5673 * @syscap SystemCapability.ArkUI.ArkUI.Full 5674 * @crossplatform 5675 * @atomicservice 5676 * @since 12 5677 */ 5678 TOUCHPAD, 5679 5680 /** 5681 * The joystick type. 5682 * 5683 * @syscap SystemCapability.ArkUI.ArkUI.Full 5684 * @crossplatform 5685 * @atomicservice 5686 * @since 12 5687 */ 5688 JOYSTICK, 5689} 5690 5691/** 5692 * Defines the Border Image Repeat Mode. 5693 * 5694 * @enum { number } 5695 * @syscap SystemCapability.ArkUI.ArkUI.Full 5696 * @form 5697 * @since 9 5698 */ 5699/** 5700 * Defines the Border Image Repeat Mode. 5701 * 5702 * @enum { number } 5703 * @syscap SystemCapability.ArkUI.ArkUI.Full 5704 * @crossplatform 5705 * @form 5706 * @since 10 5707 */ 5708/** 5709 * Defines the Border Image Repeat Mode. 5710 * 5711 * @enum { number } 5712 * @syscap SystemCapability.ArkUI.ArkUI.Full 5713 * @crossplatform 5714 * @form 5715 * @atomicservice 5716 * @since 11 5717 */ 5718declare enum RepeatMode { 5719 /** 5720 * Repeat mode. 5721 * 5722 * @syscap SystemCapability.ArkUI.ArkUI.Full 5723 * @form 5724 * @since 9 5725 */ 5726 /** 5727 * Repeat mode. 5728 * 5729 * @syscap SystemCapability.ArkUI.ArkUI.Full 5730 * @crossplatform 5731 * @form 5732 * @since 10 5733 */ 5734 /** 5735 * Repeat mode. 5736 * 5737 * @syscap SystemCapability.ArkUI.ArkUI.Full 5738 * @crossplatform 5739 * @form 5740 * @atomicservice 5741 * @since 11 5742 */ 5743 Repeat, 5744 5745 /** 5746 * Stretch mode. 5747 * 5748 * @syscap SystemCapability.ArkUI.ArkUI.Full 5749 * @form 5750 * @since 9 5751 */ 5752 /** 5753 * Stretch mode. 5754 * 5755 * @syscap SystemCapability.ArkUI.ArkUI.Full 5756 * @crossplatform 5757 * @form 5758 * @since 10 5759 */ 5760 /** 5761 * Stretch mode. 5762 * 5763 * @syscap SystemCapability.ArkUI.ArkUI.Full 5764 * @crossplatform 5765 * @form 5766 * @atomicservice 5767 * @since 11 5768 */ 5769 Stretch, 5770 5771 /** 5772 * Round mode. 5773 * 5774 * @syscap SystemCapability.ArkUI.ArkUI.Full 5775 * @form 5776 * @since 9 5777 */ 5778 /** 5779 * Round mode. 5780 * 5781 * @syscap SystemCapability.ArkUI.ArkUI.Full 5782 * @crossplatform 5783 * @form 5784 * @since 10 5785 */ 5786 /** 5787 * Round mode. 5788 * 5789 * @syscap SystemCapability.ArkUI.ArkUI.Full 5790 * @crossplatform 5791 * @form 5792 * @atomicservice 5793 * @since 11 5794 */ 5795 Round, 5796 5797 /** 5798 * Space mode. 5799 * 5800 * @syscap SystemCapability.ArkUI.ArkUI.Full 5801 * @form 5802 * @since 9 5803 */ 5804 /** 5805 * Space mode. 5806 * 5807 * @syscap SystemCapability.ArkUI.ArkUI.Full 5808 * @crossplatform 5809 * @form 5810 * @since 10 5811 */ 5812 /** 5813 * Space mode. 5814 * 5815 * @syscap SystemCapability.ArkUI.ArkUI.Full 5816 * @crossplatform 5817 * @form 5818 * @atomicservice 5819 * @since 11 5820 */ 5821 Space, 5822} 5823 5824/** 5825 * enum Blur style 5826 * 5827 * @enum { number } 5828 * @syscap SystemCapability.ArkUI.ArkUI.Full 5829 * @form 5830 * @since 9 5831 */ 5832/** 5833 * enum Blur style 5834 * 5835 * @enum { number } 5836 * @syscap SystemCapability.ArkUI.ArkUI.Full 5837 * @crossplatform 5838 * @form 5839 * @since 10 5840 */ 5841/** 5842 * enum Blur style 5843 * 5844 * @enum { number } 5845 * @syscap SystemCapability.ArkUI.ArkUI.Full 5846 * @crossplatform 5847 * @form 5848 * @atomicservice 5849 * @since 11 5850 */ 5851declare enum BlurStyle { 5852 /** 5853 * Defines the thin card material. 5854 * 5855 * @syscap SystemCapability.ArkUI.ArkUI.Full 5856 * @form 5857 * @since 9 5858 */ 5859 /** 5860 * Defines the thin card material. 5861 * 5862 * @syscap SystemCapability.ArkUI.ArkUI.Full 5863 * @crossplatform 5864 * @form 5865 * @since 10 5866 */ 5867 /** 5868 * Defines the thin card material. 5869 * 5870 * @syscap SystemCapability.ArkUI.ArkUI.Full 5871 * @crossplatform 5872 * @form 5873 * @atomicservice 5874 * @since 11 5875 */ 5876 Thin, 5877 5878 /** 5879 * Defines the regular card material. 5880 * 5881 * @syscap SystemCapability.ArkUI.ArkUI.Full 5882 * @form 5883 * @since 9 5884 */ 5885 /** 5886 * Defines the regular card material. 5887 * 5888 * @syscap SystemCapability.ArkUI.ArkUI.Full 5889 * @crossplatform 5890 * @form 5891 * @since 10 5892 */ 5893 /** 5894 * Defines the regular card material. 5895 * 5896 * @syscap SystemCapability.ArkUI.ArkUI.Full 5897 * @crossplatform 5898 * @form 5899 * @atomicservice 5900 * @since 11 5901 */ 5902 Regular, 5903 5904 /** 5905 * Defines the thick card material. 5906 * 5907 * @syscap SystemCapability.ArkUI.ArkUI.Full 5908 * @form 5909 * @since 9 5910 */ 5911 /** 5912 * Defines the thick card material. 5913 * 5914 * @syscap SystemCapability.ArkUI.ArkUI.Full 5915 * @crossplatform 5916 * @form 5917 * @since 10 5918 */ 5919 /** 5920 * Defines the thick card material. 5921 * 5922 * @syscap SystemCapability.ArkUI.ArkUI.Full 5923 * @crossplatform 5924 * @form 5925 * @atomicservice 5926 * @since 11 5927 */ 5928 Thick, 5929 5930 /** 5931 * Defines the thin background material. 5932 * 5933 * @syscap SystemCapability.ArkUI.ArkUI.Full 5934 * @crossplatform 5935 * @since 10 5936 */ 5937 /** 5938 * Defines the thin background material. 5939 * 5940 * @syscap SystemCapability.ArkUI.ArkUI.Full 5941 * @crossplatform 5942 * @form 5943 * @atomicservice 5944 * @since 11 5945 */ 5946 BACKGROUND_THIN, 5947 5948 /** 5949 * Defines the thin regular material. 5950 * 5951 * @syscap SystemCapability.ArkUI.ArkUI.Full 5952 * @crossplatform 5953 * @since 10 5954 */ 5955 /** 5956 * Defines the thin regular material. 5957 * 5958 * @syscap SystemCapability.ArkUI.ArkUI.Full 5959 * @crossplatform 5960 * @form 5961 * @atomicservice 5962 * @since 11 5963 */ 5964 BACKGROUND_REGULAR, 5965 5966 /** 5967 * Defines the thin thick material. 5968 * 5969 * @syscap SystemCapability.ArkUI.ArkUI.Full 5970 * @crossplatform 5971 * @since 10 5972 */ 5973 /** 5974 * Defines the thin thick material. 5975 * 5976 * @syscap SystemCapability.ArkUI.ArkUI.Full 5977 * @crossplatform 5978 * @form 5979 * @atomicservice 5980 * @since 11 5981 */ 5982 BACKGROUND_THICK, 5983 5984 /** 5985 * Defines the thin ultra thick material. 5986 * 5987 * @syscap SystemCapability.ArkUI.ArkUI.Full 5988 * @crossplatform 5989 * @since 10 5990 */ 5991 /** 5992 * Defines the thin ultra thick material. 5993 * 5994 * @syscap SystemCapability.ArkUI.ArkUI.Full 5995 * @crossplatform 5996 * @form 5997 * @atomicservice 5998 * @since 11 5999 */ 6000 BACKGROUND_ULTRA_THICK, 6001 6002 /** 6003 * Defines none material. 6004 * 6005 * @syscap SystemCapability.ArkUI.ArkUI.Full 6006 * @crossplatform 6007 * @form 6008 * @since 10 6009 */ 6010 /** 6011 * Defines none material. 6012 * 6013 * @syscap SystemCapability.ArkUI.ArkUI.Full 6014 * @crossplatform 6015 * @form 6016 * @atomicservice 6017 * @since 11 6018 */ 6019 NONE, 6020 6021 /** 6022 * Defines the ultra thin component material. 6023 * 6024 * @syscap SystemCapability.ArkUI.ArkUI.Full 6025 * @crossplatform 6026 * @form 6027 * @since 11 6028 */ 6029 /** 6030 * Defines the ultra thin component material. 6031 * 6032 * @syscap SystemCapability.ArkUI.ArkUI.Full 6033 * @crossplatform 6034 * @form 6035 * @atomicservice 6036 * @since 12 6037 */ 6038 COMPONENT_ULTRA_THIN = 8, 6039 6040 /** 6041 * Defines the thin component material. 6042 * 6043 * @syscap SystemCapability.ArkUI.ArkUI.Full 6044 * @crossplatform 6045 * @form 6046 * @since 11 6047 */ 6048 /** 6049 * Defines the thin component material. 6050 * 6051 * @syscap SystemCapability.ArkUI.ArkUI.Full 6052 * @crossplatform 6053 * @form 6054 * @atomicservice 6055 * @since 12 6056 */ 6057 COMPONENT_THIN = 9, 6058 6059 /** 6060 * Defines the regular component material. 6061 * 6062 * @syscap SystemCapability.ArkUI.ArkUI.Full 6063 * @crossplatform 6064 * @form 6065 * @since 11 6066 */ 6067 /** 6068 * Defines the regular component material. 6069 * 6070 * @syscap SystemCapability.ArkUI.ArkUI.Full 6071 * @crossplatform 6072 * @form 6073 * @atomicservice 6074 * @since 12 6075 */ 6076 COMPONENT_REGULAR = 10, 6077 6078 /** 6079 * Defines the thick component material. 6080 * 6081 * @syscap SystemCapability.ArkUI.ArkUI.Full 6082 * @crossplatform 6083 * @form 6084 * @since 11 6085 */ 6086 /** 6087 * Defines the thick component material. 6088 * 6089 * @syscap SystemCapability.ArkUI.ArkUI.Full 6090 * @crossplatform 6091 * @form 6092 * @atomicservice 6093 * @since 12 6094 */ 6095 COMPONENT_THICK = 11, 6096 6097 /** 6098 * Defines the ultra thick component material. 6099 * 6100 * @syscap SystemCapability.ArkUI.ArkUI.Full 6101 * @crossplatform 6102 * @form 6103 * @since 11 6104 */ 6105 /** 6106 * Defines the ultra thick component material. 6107 * 6108 * @syscap SystemCapability.ArkUI.ArkUI.Full 6109 * @crossplatform 6110 * @form 6111 * @atomicservice 6112 * @since 12 6113 */ 6114 COMPONENT_ULTRA_THICK = 12, 6115} 6116 6117/** 6118 * Enumerates the policies for activating the blur style. 6119 * 6120 * @enum { number } 6121 * @syscap SystemCapability.ArkUI.ArkUI.Full 6122 * @crossplatform 6123 * @atomicservice 6124 * @since 14 6125 */ 6126declare enum BlurStyleActivePolicy { 6127 /** 6128 * The component has the blur effect only when the window is focused. 6129 * 6130 * @syscap SystemCapability.ArkUI.ArkUI.Full 6131 * @crossplatform 6132 * @atomicservice 6133 * @since 14 6134 */ 6135 FOLLOWS_WINDOW_ACTIVE_STATE = 0, 6136 6137 /** 6138 * The component always has the blur effect, regardless of whether the window is focused. 6139 * 6140 * @syscap SystemCapability.ArkUI.ArkUI.Full 6141 * @crossplatform 6142 * @atomicservice 6143 * @since 14 6144 */ 6145 ALWAYS_ACTIVE = 1, 6146 6147 /** 6148 * The component does not have the blur effect, regardless of whether the window is focused. 6149 * 6150 * @syscap SystemCapability.ArkUI.ArkUI.Full 6151 * @crossplatform 6152 * @atomicservice 6153 * @since 14 6154 */ 6155 ALWAYS_INACTIVE = 2, 6156} 6157 6158/** 6159 * enum color mode 6160 * 6161 * @enum { number } 6162 * @syscap SystemCapability.ArkUI.ArkUI.Full 6163 * @crossplatform 6164 * @since 10 6165 */ 6166/** 6167 * enum color mode 6168 * 6169 * @enum { number } 6170 * @syscap SystemCapability.ArkUI.ArkUI.Full 6171 * @crossplatform 6172 * @atomicservice 6173 * @since 11 6174 */ 6175declare enum ThemeColorMode { 6176 /** 6177 * Defines the mode which is follow up with system. 6178 * 6179 * @syscap SystemCapability.ArkUI.ArkUI.Full 6180 * @crossplatform 6181 * @since 10 6182 */ 6183 /** 6184 * Defines the mode which is follow up with system. 6185 * 6186 * @syscap SystemCapability.ArkUI.ArkUI.Full 6187 * @crossplatform 6188 * @atomicservice 6189 * @since 11 6190 */ 6191 SYSTEM, 6192 6193 /** 6194 * Defines the light mode. 6195 * 6196 * @syscap SystemCapability.ArkUI.ArkUI.Full 6197 * @crossplatform 6198 * @since 10 6199 */ 6200 /** 6201 * Defines the light mode. 6202 * 6203 * @syscap SystemCapability.ArkUI.ArkUI.Full 6204 * @crossplatform 6205 * @atomicservice 6206 * @since 11 6207 */ 6208 LIGHT, 6209 6210 /** 6211 * Defines the dark mode. 6212 * 6213 * @syscap SystemCapability.ArkUI.ArkUI.Full 6214 * @crossplatform 6215 * @since 10 6216 */ 6217 /** 6218 * Defines the dark mode. 6219 * 6220 * @syscap SystemCapability.ArkUI.ArkUI.Full 6221 * @crossplatform 6222 * @atomicservice 6223 * @since 11 6224 */ 6225 DARK, 6226} 6227 6228/** 6229 * Defines adaptive color 6230 * 6231 * @enum { number } 6232 * @syscap SystemCapability.ArkUI.ArkUI.Full 6233 * @crossplatform 6234 * @since 10 6235 */ 6236/** 6237 * Defines adaptive color 6238 * 6239 * @enum { number } 6240 * @syscap SystemCapability.ArkUI.ArkUI.Full 6241 * @crossplatform 6242 * @atomicservice 6243 * @since 11 6244 */ 6245declare enum AdaptiveColor { 6246 /** 6247 * Defines the fixed value color adaptive mode. 6248 * 6249 * @syscap SystemCapability.ArkUI.ArkUI.Full 6250 * @crossplatform 6251 * @since 10 6252 */ 6253 /** 6254 * Defines the fixed value color adaptive mode. 6255 * 6256 * @syscap SystemCapability.ArkUI.ArkUI.Full 6257 * @crossplatform 6258 * @atomicservice 6259 * @since 11 6260 */ 6261 DEFAULT, 6262 6263 /** 6264 * Defines the background average color adaptive mode. 6265 * 6266 * @syscap SystemCapability.ArkUI.ArkUI.Full 6267 * @crossplatform 6268 * @since 10 6269 */ 6270 /** 6271 * Defines the background average color adaptive mode. 6272 * 6273 * @syscap SystemCapability.ArkUI.ArkUI.Full 6274 * @crossplatform 6275 * @atomicservice 6276 * @since 11 6277 */ 6278 AVERAGE, 6279} 6280 6281/** 6282 * Defines modal transition type. 6283 * 6284 * @enum { number } 6285 * @syscap SystemCapability.ArkUI.ArkUI.Full 6286 * @crossplatform 6287 * @since 10 6288 */ 6289/** 6290 * Defines modal transition type. 6291 * 6292 * @enum { number } 6293 * @syscap SystemCapability.ArkUI.ArkUI.Full 6294 * @crossplatform 6295 * @atomicservice 6296 * @since 11 6297 */ 6298declare enum ModalTransition { 6299 /** 6300 * Use default animation. 6301 * 6302 * @syscap SystemCapability.ArkUI.ArkUI.Full 6303 * @crossplatform 6304 * @since 10 6305 */ 6306 /** 6307 * Use default animation. 6308 * 6309 * @syscap SystemCapability.ArkUI.ArkUI.Full 6310 * @crossplatform 6311 * @atomicservice 6312 * @since 11 6313 */ 6314 DEFAULT, 6315 6316 /** 6317 * Use none animation. 6318 * 6319 * @syscap SystemCapability.ArkUI.ArkUI.Full 6320 * @crossplatform 6321 * @since 10 6322 */ 6323 /** 6324 * Use none animation. 6325 * 6326 * @syscap SystemCapability.ArkUI.ArkUI.Full 6327 * @crossplatform 6328 * @atomicservice 6329 * @since 11 6330 */ 6331 NONE, 6332 6333 /** 6334 * Use alpha animation. 6335 * 6336 * @syscap SystemCapability.ArkUI.ArkUI.Full 6337 * @crossplatform 6338 * @since 10 6339 */ 6340 /** 6341 * Use alpha animation. 6342 * 6343 * @syscap SystemCapability.ArkUI.ArkUI.Full 6344 * @crossplatform 6345 * @atomicservice 6346 * @since 11 6347 */ 6348 ALPHA, 6349} 6350 6351/** 6352 * Defines the options of backgroundBlurStyle 6353 * 6354 * @extends BlurStyleOption 6355 * @interface BackgroundBlurStyleOptions 6356 * @syscap SystemCapability.ArkUI.ArkUI.Full 6357 * @crossplatform 6358 * @since 10 6359 */ 6360/** 6361 * Defines the options of backgroundBlurStyle 6362 * 6363 * @extends BlurStyleOption 6364 * @interface BackgroundBlurStyleOptions 6365 * @syscap SystemCapability.ArkUI.ArkUI.Full 6366 * @crossplatform 6367 * @atomicservice 6368 * @since 11 6369 */ 6370declare interface BackgroundBlurStyleOptions extends BlurStyleOptions { 6371 /** 6372 * Defines the policy for activating the blur style. 6373 * 6374 * @type { ?BlurStyleActivePolicy } 6375 * @default BlurStyleActivePolicy.ALWAYS_ACTIVE 6376 * @syscap SystemCapability.ArkUI.ArkUI.Full 6377 * @crossplatform 6378 * @atomicservice 6379 * @since 14 6380 */ 6381 policy?: BlurStyleActivePolicy; 6382 6383 /** 6384 * Color of the background effect when the window is not focused. 6385 * 6386 * @type { ?ResourceColor } 6387 * @default Color.Transparent 6388 * @syscap SystemCapability.ArkUI.ArkUI.Full 6389 * @crossplatform 6390 * @atomicservice 6391 * @since 14 6392 */ 6393 inactiveColor?: ResourceColor; 6394} 6395 6396/** 6397 * Defines the options of ForegroundBlurStyle 6398 * 6399 * @extends BlurStyleOptions 6400 * @interface ForegroundBlurStyleOptions 6401 * @syscap SystemCapability.ArkUI.ArkUI.Full 6402 * @crossplatform 6403 * @since 10 6404 */ 6405/** 6406 * Defines the options of ForegroundBlurStyle 6407 * 6408 * @extends BlurStyleOptions 6409 * @interface ForegroundBlurStyleOptions 6410 * @syscap SystemCapability.ArkUI.ArkUI.Full 6411 * @crossplatform 6412 * @atomicservice 6413 * @since 11 6414 */ 6415declare interface ForegroundBlurStyleOptions extends BlurStyleOptions {} 6416 6417 6418/** 6419 * Defines the options of blur 6420 * 6421 * @interface BlurOptions 6422 * @syscap SystemCapability.ArkUI.ArkUI.Full 6423 * @crossplatform 6424 * @since 11 6425 */ 6426/** 6427 * Defines the options of blur 6428 * 6429 * @interface BlurOptions 6430 * @syscap SystemCapability.ArkUI.ArkUI.Full 6431 * @crossplatform 6432 * @atomicservice 6433 * @since 12 6434 */ 6435declare interface BlurOptions { 6436 /** 6437 * Fuzzy gray scale parameter. 6438 * @type { [number, number] } 6439 * @syscap SystemCapability.ArkUI.ArkUI.Full 6440 * @crossplatform 6441 * @since 11 6442 */ 6443 /** 6444 * Fuzzy gray scale parameter. 6445 * @type { [number, number] } 6446 * @syscap SystemCapability.ArkUI.ArkUI.Full 6447 * @crossplatform 6448 * @atomicservice 6449 * @since 12 6450 */ 6451 grayscale: [number, number]; 6452} 6453 6454/** 6455 * Defines the options of blurStyle 6456 * 6457 * @interface BlurStyleOptions 6458 * @syscap SystemCapability.ArkUI.ArkUI.Full 6459 * @crossplatform 6460 * @since 10 6461 */ 6462/** 6463 * Defines the options of blurStyle 6464 * 6465 * @interface BlurStyleOptions 6466 * @syscap SystemCapability.ArkUI.ArkUI.Full 6467 * @crossplatform 6468 * @atomicservice 6469 * @since 11 6470 */ 6471declare interface BlurStyleOptions { 6472 /** 6473 * color mode 6474 * 6475 * @type { ?ThemeColorMode } 6476 * @default ThemeColorMode.SYSTEM 6477 * @syscap SystemCapability.ArkUI.ArkUI.Full 6478 * @since 10 6479 */ 6480 /** 6481 * color mode 6482 * 6483 * @type { ?ThemeColorMode } 6484 * @default ThemeColorMode.SYSTEM 6485 * @syscap SystemCapability.ArkUI.ArkUI.Full 6486 * @crossplatform 6487 * @atomicservice 6488 * @since 11 6489 */ 6490 colorMode?: ThemeColorMode; 6491 6492 /** 6493 * adaptive color 6494 * 6495 * @type { ?AdaptiveColor } 6496 * @default AdaptiveColor.DEFAULT 6497 * @syscap SystemCapability.ArkUI.ArkUI.Full 6498 * @since 10 6499 */ 6500 /** 6501 * adaptive color 6502 * 6503 * @type { ?AdaptiveColor } 6504 * @default AdaptiveColor.DEFAULT 6505 * @syscap SystemCapability.ArkUI.ArkUI.Full 6506 * @crossplatform 6507 * @atomicservice 6508 * @since 11 6509 */ 6510 adaptiveColor?: AdaptiveColor; 6511 6512 /** 6513 * Define the scale of blur effect. 6514 * The range of value is [0, 1]. The larger the value, the more obvious the blurring effect. 6515 * A value of 0 indicates no blur effect and a value of 1 indicates a complete blur effect. 6516 * 6517 * @type { ?number } 6518 * @default 1.0 6519 * @syscap SystemCapability.ArkUI.ArkUI.Full 6520 * @atomicservice 6521 * @since 12 6522 */ 6523 scale?: number; 6524 6525 /** 6526 * Defines the options of blur 6527 * 6528 * @type { ?BlurOptions } 6529 * @default { grayScale: [0,0] } 6530 * @syscap SystemCapability.ArkUI.ArkUI.Full 6531 * @crossplatform 6532 * @since 11 6533 */ 6534 /** 6535 * Defines the options of blur 6536 * 6537 * @type { ?BlurOptions } 6538 * @default { grayScale: [0,0] } 6539 * @syscap SystemCapability.ArkUI.ArkUI.Full 6540 * @crossplatform 6541 * @atomicservice 6542 * @since 12 6543 */ 6544 blurOptions?: BlurOptions; 6545} 6546 6547/** 6548 * Defines the options of BackgroundEffect 6549 * 6550 * @interface BackgroundEffectOptions 6551 * @syscap SystemCapability.ArkUI.ArkUI.Full 6552 * @crossplatform 6553 * @since 11 6554 */ 6555/** 6556 * Defines the options of BackgroundEffect 6557 * 6558 * @interface BackgroundEffectOptions 6559 * @syscap SystemCapability.ArkUI.ArkUI.Full 6560 * @crossplatform 6561 * @atomicservice 6562 * @since 12 6563 */ 6564declare interface BackgroundEffectOptions { 6565 6566 /** 6567 * Define the radius size of BackgroundEffect.The range of this value is [0, ∞) 6568 * 6569 * @type { number } 6570 * @syscap SystemCapability.ArkUI.ArkUI.Full 6571 * @crossplatform 6572 * @since 11 6573 */ 6574 /** 6575 * Define the radius size of BackgroundEffect.The range of this value is [0, ∞) 6576 * 6577 * @type { number } 6578 * @syscap SystemCapability.ArkUI.ArkUI.Full 6579 * @crossplatform 6580 * @atomicservice 6581 * @since 12 6582 */ 6583 radius: number; 6584 6585 /** 6586 * Define the saturation of BackgroundEffect. Value range [0, ∞) 6587 * 6588 * @type { ?number } 6589 * @default 1 6590 * @syscap SystemCapability.ArkUI.ArkUI.Full 6591 * @crossplatform 6592 * @since 11 6593 */ 6594 /** 6595 * Define the saturation of BackgroundEffect. Value range [0, ∞) 6596 * 6597 * @type { ?number } 6598 * @default 1 6599 * @syscap SystemCapability.ArkUI.ArkUI.Full 6600 * @crossplatform 6601 * @atomicservice 6602 * @since 12 6603 */ 6604 saturation?: number; 6605 6606 /** 6607 * Define the brightness of BackgroundEffect. Value range [0, ∞) 6608 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 6609 * @type { ?number } 6610 * @default 1 6611 * @syscap SystemCapability.ArkUI.ArkUI.Full 6612 * @crossplatform 6613 * @since 11 6614 */ 6615 /** 6616 * Define the brightness of BackgroundEffect. Value range [0, ∞) 6617 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 6618 * @type { ?number } 6619 * @default 1 6620 * @syscap SystemCapability.ArkUI.ArkUI.Full 6621 * @crossplatform 6622 * @atomicservice 6623 * @since 12 6624 */ 6625 brightness?: number; 6626 6627 /** 6628 * color the brightness of BackgroundEffect. 6629 * 6630 * @type { ?ResourceColor } 6631 * @default Color.Transparent 6632 * @syscap SystemCapability.ArkUI.ArkUI.Full 6633 * @crossplatform 6634 * @since 11 6635 */ 6636 /** 6637 * color the brightness of BackgroundEffect. 6638 * 6639 * @type { ?ResourceColor } 6640 * @default Color.Transparent 6641 * @syscap SystemCapability.ArkUI.ArkUI.Full 6642 * @crossplatform 6643 * @atomicservice 6644 * @since 12 6645 */ 6646 color?: ResourceColor; 6647 6648 /** 6649 * Define the adaptiveColor of BackgroundEffect. 6650 * 6651 * @type { ?AdaptiveColor } 6652 * @default AdaptiveColor.DEFAULT 6653 * @syscap SystemCapability.ArkUI.ArkUI.Full 6654 * @crossplatform 6655 * @since 11 6656 */ 6657 /** 6658 * Define the adaptiveColor of BackgroundEffect. 6659 * 6660 * @type { ?AdaptiveColor } 6661 * @default AdaptiveColor.DEFAULT 6662 * @syscap SystemCapability.ArkUI.ArkUI.Full 6663 * @crossplatform 6664 * @atomicservice 6665 * @since 12 6666 */ 6667 adaptiveColor?: AdaptiveColor; 6668 6669 /** 6670 * Define the blurOptions of BackgroundEffect. 6671 * 6672 * @type { ?BlurOptions } 6673 * @default { grayScale: [0,1] } 6674 * @syscap SystemCapability.ArkUI.ArkUI.Full 6675 * @crossplatform 6676 * @since 11 6677 */ 6678 /** 6679 * Define the blurOptions of BackgroundEffect. 6680 * 6681 * @type { ?BlurOptions } 6682 * @default { grayScale: [0,0] } 6683 * @syscap SystemCapability.ArkUI.ArkUI.Full 6684 * @crossplatform 6685 * @atomicservice 6686 * @since 12 6687 */ 6688 blurOptions?: BlurOptions; 6689 6690 /** 6691 * Defines the policy for activating the blur style. 6692 * 6693 * @type { ?BlurStyleActivePolicy } 6694 * @default BlurStyleActivePolicy.ALWAYS_ACTIVE 6695 * @syscap SystemCapability.ArkUI.ArkUI.Full 6696 * @crossplatform 6697 * @atomicservice 6698 * @since 14 6699 */ 6700 policy?: BlurStyleActivePolicy; 6701 6702 /** 6703 * Color of the background effect when the window is not focused. 6704 * 6705 * @type { ?ResourceColor } 6706 * @default Color.Transparent 6707 * @syscap SystemCapability.ArkUI.ArkUI.Full 6708 * @crossplatform 6709 * @atomicservice 6710 * @since 14 6711 */ 6712 inactiveColor?: ResourceColor; 6713} 6714 6715/** 6716 * Defines the options of ForegroundEffect 6717 * 6718 * @interface ForegroundEffectOptions 6719 * @syscap SystemCapability.ArkUI.ArkUI.Full 6720 * @crossplatform 6721 * @atomicservice 6722 * @since 12 6723 */ 6724declare interface ForegroundEffectOptions { 6725 6726 /** 6727 * Define the radius size of ForegroundEffect.The range of this value is [0, ∞) 6728 * 6729 * @type { number } 6730 * @syscap SystemCapability.ArkUI.ArkUI.Full 6731 * @crossplatform 6732 * @atomicservice 6733 * @since 12 6734 */ 6735 radius: number; 6736} 6737 6738/** 6739 * Provide an interface for the text style of picker 6740 * 6741 * @interface PickerTextStyle 6742 * @syscap SystemCapability.ArkUI.ArkUI.Full 6743 * @crossplatform 6744 * @since 10 6745 */ 6746/** 6747 * Provide an interface for the text style of picker 6748 * 6749 * @interface PickerTextStyle 6750 * @syscap SystemCapability.ArkUI.ArkUI.Full 6751 * @crossplatform 6752 * @atomicservice 6753 * @since 11 6754 */ 6755declare interface PickerTextStyle { 6756 /** 6757 * Define the text color of picker. 6758 * 6759 * @type { ?ResourceColor } 6760 * @syscap SystemCapability.ArkUI.ArkUI.Full 6761 * @crossplatform 6762 * @since 10 6763 */ 6764 /** 6765 * Define the text color of picker. 6766 * 6767 * @type { ?ResourceColor } 6768 * @syscap SystemCapability.ArkUI.ArkUI.Full 6769 * @crossplatform 6770 * @atomicservice 6771 * @since 11 6772 */ 6773 color?: ResourceColor; 6774 6775 /** 6776 * Define the text font of picker. 6777 * Only support size and weight. 6778 * 6779 * @type { ?Font } 6780 * @syscap SystemCapability.ArkUI.ArkUI.Full 6781 * @crossplatform 6782 * @since 10 6783 */ 6784 /** 6785 * Define the text font of picker. 6786 * Only support size and weight. 6787 * 6788 * @type { ?Font } 6789 * @syscap SystemCapability.ArkUI.ArkUI.Full 6790 * @crossplatform 6791 * @atomicservice 6792 * @since 11 6793 */ 6794 font?: Font; 6795} 6796 6797/** 6798 * Provide an interface for the button style of picker 6799 * 6800 * @interface PickerDialogButtonStyle 6801 * @syscap SystemCapability.ArkUI.ArkUI.Full 6802 * @crossplatform 6803 * @atomicservice 6804 * @since 12 6805 */ 6806declare interface PickerDialogButtonStyle { 6807 /** 6808 * Describes the button style. 6809 * 6810 * @type { ?ButtonType } 6811 * @syscap SystemCapability.ArkUI.ArkUI.Full 6812 * @crossplatform 6813 * @atomicservice 6814 * @since 12 6815 */ 6816 type?: ButtonType; 6817 6818 /** 6819 * Describes the button style. 6820 * 6821 * @type { ?ButtonStyleMode } 6822 * @syscap SystemCapability.ArkUI.ArkUI.Full 6823 * @crossplatform 6824 * @atomicservice 6825 * @since 12 6826 */ 6827 style?: ButtonStyleMode; 6828 6829 /** 6830 * Describes the button role. 6831 * 6832 * @type { ?ButtonRole } 6833 * @syscap SystemCapability.ArkUI.ArkUI.Full 6834 * @crossplatform 6835 * @atomicservice 6836 * @since 12 6837 */ 6838 role?: ButtonRole; 6839 6840 /** 6841 * Describes the button text size. 6842 * 6843 * @type { ?Length } 6844 * @syscap SystemCapability.ArkUI.ArkUI.Full 6845 * @crossplatform 6846 * @atomicservice 6847 * @since 12 6848 */ 6849 fontSize?: Length; 6850 6851 /** 6852 * Describes the button text color. 6853 * 6854 * @type { ?ResourceColor } 6855 * @syscap SystemCapability.ArkUI.ArkUI.Full 6856 * @crossplatform 6857 * @atomicservice 6858 * @since 12 6859 */ 6860 fontColor?: ResourceColor; 6861 6862 /** 6863 * Describes the button font weight. 6864 * 6865 * @type { ?(FontWeight | number | string) } 6866 * @syscap SystemCapability.ArkUI.ArkUI.Full 6867 * @crossplatform 6868 * @atomicservice 6869 * @since 12 6870 */ 6871 fontWeight?: FontWeight | number | string; 6872 6873 /** 6874 * Describes the button font style. 6875 * 6876 * @type { ?FontStyle } 6877 * @syscap SystemCapability.ArkUI.ArkUI.Full 6878 * @crossplatform 6879 * @atomicservice 6880 * @since 12 6881 */ 6882 fontStyle?: FontStyle; 6883 6884 /** 6885 * Describes the button font family. 6886 * 6887 * @type { ?(Resource | string) } 6888 * @syscap SystemCapability.ArkUI.ArkUI.Full 6889 * @crossplatform 6890 * @atomicservice 6891 * @since 12 6892 */ 6893 fontFamily?: Resource | string; 6894 6895 /** 6896 * Describes the button background color. 6897 * 6898 * @type { ?ResourceColor } 6899 * @syscap SystemCapability.ArkUI.ArkUI.Full 6900 * @crossplatform 6901 * @atomicservice 6902 * @since 12 6903 */ 6904 backgroundColor?: ResourceColor; 6905 6906 /** 6907 * Describes the button border radius. 6908 * 6909 * @type { ?(Length | BorderRadiuses) } 6910 * @syscap SystemCapability.ArkUI.ArkUI.Full 6911 * @crossplatform 6912 * @atomicservice 6913 * @since 12 6914 */ 6915 borderRadius?: Length | BorderRadiuses; 6916 6917 /** 6918 * Define whether the button default to responding to the Enter key 6919 * 6920 * @type { ?boolean } 6921 * @syscap SystemCapability.ArkUI.ArkUI.Full 6922 * @crossplatform 6923 * @atomicservice 6924 * @since 12 6925 */ 6926 primary?: boolean; 6927} 6928 6929/** 6930 * Define the type of shadow 6931 * 6932 * @enum { number } 6933 * @syscap SystemCapability.ArkUI.ArkUI.Full 6934 * @crossplatform 6935 * @since 10 6936 */ 6937/** 6938 * Define the type of shadow 6939 * 6940 * @enum { number } 6941 * @syscap SystemCapability.ArkUI.ArkUI.Full 6942 * @crossplatform 6943 * @atomicservice 6944 * @since 11 6945 */ 6946declare enum ShadowType { 6947 /** 6948 * Define a color type of shadow 6949 * 6950 * @syscap SystemCapability.ArkUI.ArkUI.Full 6951 * @crossplatform 6952 * @since 10 6953 */ 6954 /** 6955 * Define a color type of shadow 6956 * 6957 * @syscap SystemCapability.ArkUI.ArkUI.Full 6958 * @crossplatform 6959 * @atomicservice 6960 * @since 11 6961 */ 6962 COLOR, 6963 6964 /** 6965 * Define a blur type of shadow 6966 * 6967 * @syscap SystemCapability.ArkUI.ArkUI.Full 6968 * @crossplatform 6969 * @since 10 6970 */ 6971 /** 6972 * Define a blur type of shadow 6973 * 6974 * @syscap SystemCapability.ArkUI.ArkUI.Full 6975 * @crossplatform 6976 * @atomicservice 6977 * @since 11 6978 */ 6979 BLUR, 6980} 6981 6982/** 6983 * Define the options of shadow 6984 * 6985 * @interface ShadowOptions 6986 * @syscap SystemCapability.ArkUI.ArkUI.Full 6987 * @since 7 6988 */ 6989/** 6990 * Define the options of shadow 6991 * 6992 * @interface ShadowOptions 6993 * @syscap SystemCapability.ArkUI.ArkUI.Full 6994 * @form 6995 * @since 9 6996 */ 6997/** 6998 * Define the options of shadow 6999 * 7000 * @interface ShadowOptions 7001 * @syscap SystemCapability.ArkUI.ArkUI.Full 7002 * @crossplatform 7003 * @form 7004 * @since 10 7005 */ 7006/** 7007 * Define the options of shadow 7008 * 7009 * @interface ShadowOptions 7010 * @syscap SystemCapability.ArkUI.ArkUI.Full 7011 * @crossplatform 7012 * @form 7013 * @atomicservice 7014 * @since 11 7015 */ 7016declare interface ShadowOptions { 7017 /** 7018 * Define the radius size of shadow 7019 * 7020 * @type { number | Resource } 7021 * @syscap SystemCapability.ArkUI.ArkUI.Full 7022 * @since 7 7023 */ 7024 /** 7025 * Define the radius size of shadow 7026 * 7027 * @type { number | Resource } 7028 * @syscap SystemCapability.ArkUI.ArkUI.Full 7029 * @form 7030 * @since 9 7031 */ 7032 /** 7033 * Define the radius size of shadow 7034 * 7035 * @type { number | Resource } 7036 * @syscap SystemCapability.ArkUI.ArkUI.Full 7037 * @crossplatform 7038 * @form 7039 * @since 10 7040 */ 7041 /** 7042 * Define the radius size of shadow 7043 * 7044 * @type { number | Resource } 7045 * @syscap SystemCapability.ArkUI.ArkUI.Full 7046 * @crossplatform 7047 * @form 7048 * @atomicservice 7049 * @since 11 7050 */ 7051 radius: number | Resource; 7052 7053 /** 7054 * Define the type of shadow 7055 * 7056 * @type { ?ShadowType } 7057 * @default ShadowType.COLOR 7058 * @syscap SystemCapability.ArkUI.ArkUI.Full 7059 * @crossplatform 7060 * @since 10 7061 */ 7062 /** 7063 * Define the type of shadow 7064 * 7065 * @type { ?ShadowType } 7066 * @default ShadowType.COLOR 7067 * @syscap SystemCapability.ArkUI.ArkUI.Full 7068 * @crossplatform 7069 * @atomicservice 7070 * @since 11 7071 */ 7072 type?: ShadowType; 7073 7074 /** 7075 * Define the color of shadow 7076 * 7077 * @type { ?(Color | string | Resource) } 7078 * @syscap SystemCapability.ArkUI.ArkUI.Full 7079 * @since 7 7080 */ 7081 /** 7082 * Define the color of shadow 7083 * 7084 * @type { ?(Color | string | Resource) } 7085 * @syscap SystemCapability.ArkUI.ArkUI.Full 7086 * @form 7087 * @since 9 7088 */ 7089 /** 7090 * Define the color of shadow 7091 * 7092 * @type { ?(Color | string | Resource) } 7093 * @syscap SystemCapability.ArkUI.ArkUI.Full 7094 * @crossplatform 7095 * @form 7096 * @since 10 7097 */ 7098 /** 7099 * Define the color or the color strategy of shadow 7100 * 7101 * @type { ?(Color | string | Resource| ColoringStrategy) } 7102 * @syscap SystemCapability.ArkUI.ArkUI.Full 7103 * @crossplatform 7104 * @form 7105 * @atomicservice 7106 * @since 11 7107 */ 7108 color?: Color | string | Resource | ColoringStrategy; 7109 7110 /** 7111 * Define the horizontal offset size of shadow 7112 * 7113 * @type { ?(number | Resource) } 7114 * @syscap SystemCapability.ArkUI.ArkUI.Full 7115 * @since 7 7116 */ 7117 /** 7118 * Define the horizontal offset size of shadow 7119 * 7120 * @type { ?(number | Resource) } 7121 * @syscap SystemCapability.ArkUI.ArkUI.Full 7122 * @form 7123 * @since 9 7124 */ 7125 /** 7126 * Define the horizontal offset size of shadow 7127 * 7128 * @type { ?(number | Resource) } 7129 * @syscap SystemCapability.ArkUI.ArkUI.Full 7130 * @crossplatform 7131 * @form 7132 * @since 10 7133 */ 7134 /** 7135 * Define the horizontal offset size of shadow 7136 * 7137 * @type { ?(number | Resource) } 7138 * @syscap SystemCapability.ArkUI.ArkUI.Full 7139 * @crossplatform 7140 * @form 7141 * @atomicservice 7142 * @since 11 7143 */ 7144 offsetX?: number | Resource; 7145 7146 /** 7147 * Define the vertical offset size of shadow 7148 * 7149 * @type { ?(number | Resource) } 7150 * @syscap SystemCapability.ArkUI.ArkUI.Full 7151 * @since 7 7152 */ 7153 /** 7154 * Define the vertical offset size of shadow 7155 * 7156 * @type { ?(number | Resource) } 7157 * @syscap SystemCapability.ArkUI.ArkUI.Full 7158 * @form 7159 * @since 9 7160 */ 7161 /** 7162 * Define the vertical offset size of shadow 7163 * 7164 * @type { ?(number | Resource) } 7165 * @syscap SystemCapability.ArkUI.ArkUI.Full 7166 * @crossplatform 7167 * @form 7168 * @since 10 7169 */ 7170 /** 7171 * Define the vertical offset size of shadow 7172 * 7173 * @type { ?(number | Resource) } 7174 * @syscap SystemCapability.ArkUI.ArkUI.Full 7175 * @crossplatform 7176 * @form 7177 * @atomicservice 7178 * @since 11 7179 */ 7180 offsetY?: number | Resource; 7181 7182 /** 7183 * Define whether the shadow should fill the area 7184 * 7185 * @type { ?boolean } 7186 * @default false 7187 * @syscap SystemCapability.ArkUI.ArkUI.Full 7188 * @crossplatform 7189 * @since 11 7190 */ 7191 /** 7192 * Define whether the shadow should fill the area 7193 * 7194 * @type { ?boolean } 7195 * @default false 7196 * @syscap SystemCapability.ArkUI.ArkUI.Full 7197 * @crossplatform 7198 * @atomicservice 7199 * @since 12 7200 */ 7201 fill?: boolean; 7202} 7203 7204/** 7205 * enum Shadow style 7206 * 7207 * @enum { number } 7208 * @syscap SystemCapability.ArkUI.ArkUI.Full 7209 * @crossplatform 7210 * @since 10 7211 */ 7212/** 7213 * enum Shadow style 7214 * 7215 * @enum { number } 7216 * @syscap SystemCapability.ArkUI.ArkUI.Full 7217 * @crossplatform 7218 * @atomicservice 7219 * @since 11 7220 */ 7221declare enum ShadowStyle { 7222 /** 7223 * Defines the super small default shadow style. 7224 * 7225 * @syscap SystemCapability.ArkUI.ArkUI.Full 7226 * @crossplatform 7227 * @since 10 7228 */ 7229 /** 7230 * Defines the super small default shadow style. 7231 * 7232 * @syscap SystemCapability.ArkUI.ArkUI.Full 7233 * @crossplatform 7234 * @atomicservice 7235 * @since 11 7236 */ 7237 OUTER_DEFAULT_XS, 7238 7239 /** 7240 * Defines the small default shadow style. 7241 * 7242 * @syscap SystemCapability.ArkUI.ArkUI.Full 7243 * @crossplatform 7244 * @since 10 7245 */ 7246 /** 7247 * Defines the small default shadow style. 7248 * 7249 * @syscap SystemCapability.ArkUI.ArkUI.Full 7250 * @crossplatform 7251 * @atomicservice 7252 * @since 11 7253 */ 7254 OUTER_DEFAULT_SM, 7255 7256 /** 7257 * Defines the medium default shadow style. 7258 * 7259 * @syscap SystemCapability.ArkUI.ArkUI.Full 7260 * @crossplatform 7261 * @since 10 7262 */ 7263 /** 7264 * Defines the medium default shadow style. 7265 * 7266 * @syscap SystemCapability.ArkUI.ArkUI.Full 7267 * @crossplatform 7268 * @atomicservice 7269 * @since 11 7270 */ 7271 OUTER_DEFAULT_MD, 7272 7273 /** 7274 * Defines the large default shadow style. 7275 * 7276 * @syscap SystemCapability.ArkUI.ArkUI.Full 7277 * @crossplatform 7278 * @since 10 7279 */ 7280 /** 7281 * Defines the large default shadow style. 7282 * 7283 * @syscap SystemCapability.ArkUI.ArkUI.Full 7284 * @crossplatform 7285 * @atomicservice 7286 * @since 11 7287 */ 7288 OUTER_DEFAULT_LG, 7289 7290 /** 7291 * Defines the small floating shadow style. 7292 * 7293 * @syscap SystemCapability.ArkUI.ArkUI.Full 7294 * @crossplatform 7295 * @since 10 7296 */ 7297 /** 7298 * Defines the small floating shadow style. 7299 * 7300 * @syscap SystemCapability.ArkUI.ArkUI.Full 7301 * @crossplatform 7302 * @atomicservice 7303 * @since 11 7304 */ 7305 OUTER_FLOATING_SM, 7306 7307 /** 7308 * Defines the medium floating shadow style. 7309 * 7310 * @syscap SystemCapability.ArkUI.ArkUI.Full 7311 * @crossplatform 7312 * @since 10 7313 */ 7314 /** 7315 * Defines the medium floating shadow style. 7316 * 7317 * @syscap SystemCapability.ArkUI.ArkUI.Full 7318 * @crossplatform 7319 * @atomicservice 7320 * @since 11 7321 */ 7322 OUTER_FLOATING_MD, 7323} 7324 7325/** 7326 * Defines the options of Shadow. 7327 * 7328 * @interface MultiShadowOptions 7329 * @syscap SystemCapability.ArkUI.ArkUI.Full 7330 * @crossplatform 7331 * @since 10 7332 */ 7333/** 7334 * Defines the options of Shadow. 7335 * 7336 * @interface MultiShadowOptions 7337 * @syscap SystemCapability.ArkUI.ArkUI.Full 7338 * @crossplatform 7339 * @atomicservice 7340 * @since 11 7341 */ 7342declare interface MultiShadowOptions { 7343 /** 7344 * Current shadow radius. 7345 * 7346 * @type { ?(number | Resource) } 7347 * @default 5 7348 * @syscap SystemCapability.ArkUI.ArkUI.Full 7349 * @crossplatform 7350 * @since 10 7351 */ 7352 /** 7353 * Current shadow radius. 7354 * 7355 * @type { ?(number | Resource) } 7356 * @default 20 7357 * @syscap SystemCapability.ArkUI.ArkUI.Full 7358 * @crossplatform 7359 * @atomicservice 7360 * @since 11 7361 */ 7362 radius?: number | Resource; 7363 7364 /** 7365 * Current shadow offsetX. 7366 * 7367 * @type { ?(number | Resource) } 7368 * @default 5 7369 * @syscap SystemCapability.ArkUI.ArkUI.Full 7370 * @crossplatform 7371 * @since 10 7372 */ 7373 /** 7374 * Current shadow offsetX. 7375 * 7376 * @type { ?(number | Resource) } 7377 * @default 5 7378 * @syscap SystemCapability.ArkUI.ArkUI.Full 7379 * @crossplatform 7380 * @atomicservice 7381 * @since 11 7382 */ 7383 offsetX?: number | Resource; 7384 7385 /** 7386 * Current shadow offsetY 7387 * 7388 * @type { ?(number | Resource) } 7389 * @default 5 7390 * @syscap SystemCapability.ArkUI.ArkUI.Full 7391 * @crossplatform 7392 * @since 10 7393 */ 7394 /** 7395 * Current shadow offsetY 7396 * 7397 * @type { ?(number | Resource) } 7398 * @default 5 7399 * @syscap SystemCapability.ArkUI.ArkUI.Full 7400 * @crossplatform 7401 * @atomicservice 7402 * @since 11 7403 */ 7404 offsetY?: number | Resource; 7405} 7406 7407/** 7408 * Enumerates the safe area types. 7409 * 7410 * @enum { number } 7411 * @syscap SystemCapability.ArkUI.ArkUI.Full 7412 * @since 10 7413 */ 7414/** 7415 * Enumerates the safe area types. 7416 * 7417 * @enum { number } 7418 * @syscap SystemCapability.ArkUI.ArkUI.Full 7419 * @crossplatform 7420 * @atomicservice 7421 * @since 11 7422 */ 7423declare enum SafeAreaType { 7424 /** 7425 * Default area of the system, including the status bar and navigation bar. 7426 * 7427 * @syscap SystemCapability.ArkUI.ArkUI.Full 7428 * @since 10 7429 */ 7430 /** 7431 * Default area of the system, including the status bar and navigation bar. 7432 * 7433 * @syscap SystemCapability.ArkUI.ArkUI.Full 7434 * @crossplatform 7435 * @atomicservice 7436 * @since 11 7437 */ 7438 SYSTEM, 7439 7440 /** 7441 * Notch or punch hole. 7442 * 7443 * @syscap SystemCapability.ArkUI.ArkUI.Full 7444 * @since 10 7445 */ 7446 /** 7447 * Notch or punch hole. 7448 * 7449 * @syscap SystemCapability.ArkUI.ArkUI.Full 7450 * @crossplatform 7451 * @atomicservice 7452 * @since 11 7453 */ 7454 CUTOUT, 7455 7456 /** 7457 * Soft keyboard area. 7458 * 7459 * @syscap SystemCapability.ArkUI.ArkUI.Full 7460 * @since 10 7461 */ 7462 /** 7463 * Soft keyboard area. 7464 * 7465 * @syscap SystemCapability.ArkUI.ArkUI.Full 7466 * @crossplatform 7467 * @atomicservice 7468 * @since 11 7469 */ 7470 KEYBOARD 7471} 7472 7473/** 7474 * Enumerates the safe area edges. 7475 * 7476 * @enum { number } 7477 * @syscap SystemCapability.ArkUI.ArkUI.Full 7478 * @since 10 7479 */ 7480/** 7481 * Enumerates the safe area edges. 7482 * 7483 * @enum { number } 7484 * @syscap SystemCapability.ArkUI.ArkUI.Full 7485 * @crossplatform 7486 * @atomicservice 7487 * @since 11 7488 */ 7489declare enum SafeAreaEdge { 7490 /** 7491 * Top edge of the safe area. 7492 * 7493 * @syscap SystemCapability.ArkUI.ArkUI.Full 7494 * @since 10 7495 */ 7496 /** 7497 * Top edge of the safe area. 7498 * 7499 * @syscap SystemCapability.ArkUI.ArkUI.Full 7500 * @crossplatform 7501 * @atomicservice 7502 * @since 11 7503 */ 7504 TOP, 7505 7506 /** 7507 * Bottom edge of the safe area. 7508 * 7509 * @syscap SystemCapability.ArkUI.ArkUI.Full 7510 * @since 10 7511 */ 7512 /** 7513 * Bottom edge of the safe area. 7514 * 7515 * @syscap SystemCapability.ArkUI.ArkUI.Full 7516 * @crossplatform 7517 * @atomicservice 7518 * @since 11 7519 */ 7520 BOTTOM, 7521 7522 /** 7523 * Start edge of the safe area. 7524 * 7525 * @syscap SystemCapability.ArkUI.ArkUI.Full 7526 * @since 10 7527 */ 7528 /** 7529 * Start edge of the safe area. 7530 * 7531 * @syscap SystemCapability.ArkUI.ArkUI.Full 7532 * @crossplatform 7533 * @atomicservice 7534 * @since 11 7535 */ 7536 START, 7537 7538 /** 7539 * End edge of the safe area. 7540 * 7541 * @syscap SystemCapability.ArkUI.ArkUI.Full 7542 * @since 10 7543 */ 7544 /** 7545 * End edge of the safe area. 7546 * 7547 * @syscap SystemCapability.ArkUI.ArkUI.Full 7548 * @crossplatform 7549 * @atomicservice 7550 * @since 11 7551 */ 7552 END 7553} 7554 7555/** 7556 * Enumerates the safe area types can be ignored. 7557 * 7558 * @enum { number } 7559 * @syscap SystemCapability.ArkUI.ArkUI.Full 7560 * @crossplatform 7561 * @atomicservice 7562 * @since 12 7563 */ 7564declare enum LayoutSafeAreaType { 7565 /** 7566 * Default area of the system, including the status bar and navigation bar. 7567 * 7568 * @syscap SystemCapability.ArkUI.ArkUI.Full 7569 * @crossplatform 7570 * @atomicservice 7571 * @since 12 7572 */ 7573 SYSTEM = 0, 7574} 7575 7576/** 7577 * Enumerates the safe area edges can be ignored. 7578 * 7579 * @enum { number } 7580 * @syscap SystemCapability.ArkUI.ArkUI.Full 7581 * @crossplatform 7582 * @atomicservice 7583 * @since 12 7584 */ 7585declare enum LayoutSafeAreaEdge { 7586 /** 7587 * Top edge of the safe area. 7588 * 7589 * @syscap SystemCapability.ArkUI.ArkUI.Full 7590 * @crossplatform 7591 * @atomicservice 7592 * @since 12 7593 */ 7594 TOP = 0, 7595 7596 /** 7597 * Bottom edge of the safe area. 7598 * 7599 * @syscap SystemCapability.ArkUI.ArkUI.Full 7600 * @crossplatform 7601 * @atomicservice 7602 * @since 12 7603 */ 7604 BOTTOM = 1, 7605} 7606 7607/** 7608 * Defines sheet size type. 7609 * 7610 * @enum { number } 7611 * @syscap SystemCapability.ArkUI.ArkUI.Full 7612 * @crossplatform 7613 * @since 10 7614 */ 7615/** 7616 * Defines sheet size type. 7617 * 7618 * @enum { number } 7619 * @syscap SystemCapability.ArkUI.ArkUI.Full 7620 * @crossplatform 7621 * @atomicservice 7622 * @since 11 7623 */ 7624declare enum SheetSize { 7625 /** 7626 * Defines the sheet size medium height type. The height is half the screen height 7627 * 7628 * @syscap SystemCapability.ArkUI.ArkUI.Full 7629 * @crossplatform 7630 * @since 10 7631 */ 7632 /** 7633 * Defines the sheet size medium height type. The height is half the screen height 7634 * 7635 * @syscap SystemCapability.ArkUI.ArkUI.Full 7636 * @crossplatform 7637 * @atomicservice 7638 * @since 11 7639 */ 7640 MEDIUM, 7641 7642 /** 7643 * Defines the sheet size large height type. The height is almost screen height. 7644 * 7645 * @syscap SystemCapability.ArkUI.ArkUI.Full 7646 * @crossplatform 7647 * @since 10 7648 */ 7649 /** 7650 * Defines the sheet size large height type. The height is almost screen height. 7651 * 7652 * @syscap SystemCapability.ArkUI.ArkUI.Full 7653 * @crossplatform 7654 * @atomicservice 7655 * @since 11 7656 */ 7657 LARGE, 7658 7659 /** 7660 * Defines the sheet size fit content height type. The height fit content. 7661 * 7662 * @syscap SystemCapability.ArkUI.ArkUI.Full 7663 * @crossplatform 7664 * @since 11 7665 */ 7666 /** 7667 * Defines the sheet size fit content height type. The height fit content. 7668 * 7669 * @syscap SystemCapability.ArkUI.ArkUI.Full 7670 * @crossplatform 7671 * @atomicservice 7672 * @since 12 7673 */ 7674 FIT_CONTENT = 2, 7675} 7676 7677/** 7678 * Defines the base event. 7679 * 7680 * @interface BaseEvent 7681 * @syscap SystemCapability.ArkUI.ArkUI.Full 7682 * @since 8 7683 */ 7684/** 7685 * Defines the base event. 7686 * 7687 * @interface BaseEvent 7688 * @syscap SystemCapability.ArkUI.ArkUI.Full 7689 * @form 7690 * @since 9 7691 */ 7692/** 7693 * Defines the base event. 7694 * 7695 * @interface BaseEvent 7696 * @syscap SystemCapability.ArkUI.ArkUI.Full 7697 * @crossplatform 7698 * @form 7699 * @since 10 7700 */ 7701/** 7702 * Defines the base event. 7703 * 7704 * @interface BaseEvent 7705 * @syscap SystemCapability.ArkUI.ArkUI.Full 7706 * @crossplatform 7707 * @form 7708 * @atomicservice 7709 * @since 11 7710 */ 7711declare interface BaseEvent { 7712 /** 7713 * Defines the current target which fires this event. 7714 * 7715 * @type { EventTarget } 7716 * @syscap SystemCapability.ArkUI.ArkUI.Full 7717 * @since 8 7718 */ 7719 /** 7720 * Defines the current target which fires this event. 7721 * 7722 * @type { EventTarget } 7723 * @syscap SystemCapability.ArkUI.ArkUI.Full 7724 * @form 7725 * @since 9 7726 */ 7727 /** 7728 * Defines the current target which fires this event. 7729 * 7730 * @type { EventTarget } 7731 * @syscap SystemCapability.ArkUI.ArkUI.Full 7732 * @crossplatform 7733 * @form 7734 * @since 10 7735 */ 7736 /** 7737 * Defines the current target which fires this event. 7738 * 7739 * @type { EventTarget } 7740 * @syscap SystemCapability.ArkUI.ArkUI.Full 7741 * @crossplatform 7742 * @form 7743 * @atomicservice 7744 * @since 11 7745 */ 7746 target: EventTarget; 7747 7748 /** 7749 * Event timestamp. 7750 * 7751 * @type { number } 7752 * @syscap SystemCapability.ArkUI.ArkUI.Full 7753 * @since 8 7754 */ 7755 /** 7756 * Event timestamp. 7757 * 7758 * @type { number } 7759 * @syscap SystemCapability.ArkUI.ArkUI.Full 7760 * @form 7761 * @since 9 7762 */ 7763 /** 7764 * Event timestamp. 7765 * 7766 * @type { number } 7767 * @syscap SystemCapability.ArkUI.ArkUI.Full 7768 * @crossplatform 7769 * @form 7770 * @since 10 7771 */ 7772 /** 7773 * Event timestamp. 7774 * 7775 * @type { number } 7776 * @syscap SystemCapability.ArkUI.ArkUI.Full 7777 * @crossplatform 7778 * @form 7779 * @atomicservice 7780 * @since 11 7781 */ 7782 timestamp: number; 7783 7784 /** 7785 * the event source info. 7786 * 7787 * @type { SourceType } 7788 * @syscap SystemCapability.ArkUI.ArkUI.Full 7789 * @since 8 7790 */ 7791 /** 7792 * the event source info. 7793 * 7794 * @type { SourceType } 7795 * @syscap SystemCapability.ArkUI.ArkUI.Full 7796 * @form 7797 * @since 9 7798 */ 7799 /** 7800 * the event source info. 7801 * 7802 * @type { SourceType } 7803 * @syscap SystemCapability.ArkUI.ArkUI.Full 7804 * @crossplatform 7805 * @form 7806 * @since 10 7807 */ 7808 /** 7809 * the event source info. 7810 * 7811 * @type { SourceType } 7812 * @syscap SystemCapability.ArkUI.ArkUI.Full 7813 * @crossplatform 7814 * @form 7815 * @atomicservice 7816 * @since 11 7817 */ 7818 source: SourceType; 7819 7820 /** 7821 * the Horizontal axis coordinate. 7822 * 7823 * @type { number } 7824 * @syscap SystemCapability.ArkUI.ArkUI.Full 7825 * @crossplatform 7826 * @form 7827 * @atomicservice 7828 * @since 12 7829 */ 7830 axisHorizontal?: number; 7831 7832 /** 7833 * the Vertical axis coordinate. 7834 * 7835 * @type { number } 7836 * @syscap SystemCapability.ArkUI.ArkUI.Full 7837 * @crossplatform 7838 * @form 7839 * @atomicservice 7840 * @since 12 7841 */ 7842 axisVertical?: number; 7843 7844 /** 7845 * Touch pressure. 7846 * 7847 * @type { number } 7848 * @syscap SystemCapability.ArkUI.ArkUI.Full 7849 * @form 7850 * @since 9 7851 */ 7852 /** 7853 * Touch pressure. 7854 * 7855 * @type { number } 7856 * @syscap SystemCapability.ArkUI.ArkUI.Full 7857 * @crossplatform 7858 * @form 7859 * @since 10 7860 */ 7861 /** 7862 * Touch pressure. 7863 * 7864 * @type { number } 7865 * @syscap SystemCapability.ArkUI.ArkUI.Full 7866 * @crossplatform 7867 * @form 7868 * @atomicservice 7869 * @since 11 7870 */ 7871 pressure: number; 7872 7873 /** 7874 * The angle between pencil projection on plane-X-Y and axis-Z. 7875 * 7876 * @type { number } 7877 * @syscap SystemCapability.ArkUI.ArkUI.Full 7878 * @form 7879 * @since 9 7880 */ 7881 /** 7882 * The angle between pencil projection on plane-X-Y and axis-Z. 7883 * 7884 * @type { number } 7885 * @syscap SystemCapability.ArkUI.ArkUI.Full 7886 * @crossplatform 7887 * @form 7888 * @since 10 7889 */ 7890 /** 7891 * The angle between pencil projection on plane-X-Y and axis-Z. 7892 * 7893 * @type { number } 7894 * @syscap SystemCapability.ArkUI.ArkUI.Full 7895 * @crossplatform 7896 * @form 7897 * @atomicservice 7898 * @since 11 7899 */ 7900 tiltX: number; 7901 7902 /** 7903 * The angle between pencil projection on plane-Y-Z and axis-Z. 7904 * 7905 * @type { number } 7906 * @syscap SystemCapability.ArkUI.ArkUI.Full 7907 * @form 7908 * @since 9 7909 */ 7910 /** 7911 * The angle between pencil projection on plane-Y-Z and axis-Z. 7912 * 7913 * @type { number } 7914 * @syscap SystemCapability.ArkUI.ArkUI.Full 7915 * @crossplatform 7916 * @form 7917 * @since 10 7918 */ 7919 /** 7920 * The angle between pencil projection on plane-Y-Z and axis-Z. 7921 * 7922 * @type { number } 7923 * @syscap SystemCapability.ArkUI.ArkUI.Full 7924 * @crossplatform 7925 * @form 7926 * @atomicservice 7927 * @since 11 7928 */ 7929 tiltY: number; 7930 7931 /** 7932 * The event tool type info. 7933 * 7934 * @type { SourceTool } 7935 * @syscap SystemCapability.ArkUI.ArkUI.Full 7936 * @form 7937 * @since 9 7938 */ 7939 /** 7940 * The event tool type info. 7941 * 7942 * @type { SourceTool } 7943 * @syscap SystemCapability.ArkUI.ArkUI.Full 7944 * @crossplatform 7945 * @form 7946 * @since 10 7947 */ 7948 /** 7949 * The event tool type info. 7950 * 7951 * @type { SourceTool } 7952 * @syscap SystemCapability.ArkUI.ArkUI.Full 7953 * @crossplatform 7954 * @form 7955 * @atomicservice 7956 * @since 11 7957 */ 7958 sourceTool: SourceTool; 7959 7960 /** 7961 * Query the ModifierKey press state, support 'ctrl'|'alt'|'shift'|'fn' 7962 * 7963 * @param { Array<string> } keys - indicate the keys of the ModifierKey. 7964 * @returns { boolean } 7965 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 7966 * @syscap SystemCapability.ArkUI.ArkUI.Full 7967 * @crossplatform 7968 * @atomicservice 7969 * @since 12 7970 */ 7971 getModifierKeyState?(keys: Array<string>): boolean; 7972 7973 /** 7974 * Indicates the ID of the input device that triggers the current event. 7975 * 7976 * @type { ?number } [deviceId] The ID of the input device that triggers the current event 7977 * @syscap SystemCapability.ArkUI.ArkUI.Full 7978 * @crossplatform 7979 * @atomicservice 7980 * @since 12 7981 */ 7982 deviceId?: number; 7983} 7984 7985/** 7986 * Border image option 7987 * 7988 * @interface BorderImageOption 7989 * @syscap SystemCapability.ArkUI.ArkUI.Full 7990 * @form 7991 * @since 9 7992 */ 7993/** 7994 * Border image option 7995 * 7996 * @interface BorderImageOption 7997 * @syscap SystemCapability.ArkUI.ArkUI.Full 7998 * @crossplatform 7999 * @form 8000 * @since 10 8001 */ 8002/** 8003 * Border image option 8004 * 8005 * @interface BorderImageOption 8006 * @syscap SystemCapability.ArkUI.ArkUI.Full 8007 * @crossplatform 8008 * @form 8009 * @atomicservice 8010 * @since 11 8011 */ 8012declare interface BorderImageOption { 8013 /** 8014 * Border image slice 8015 * 8016 * @type { ?(Length | EdgeWidths) } 8017 * @syscap SystemCapability.ArkUI.ArkUI.Full 8018 * @form 8019 * @since 9 8020 */ 8021 /** 8022 * Border image slice 8023 * 8024 * @type { ?(Length | EdgeWidths) } 8025 * @syscap SystemCapability.ArkUI.ArkUI.Full 8026 * @crossplatform 8027 * @form 8028 * @since 10 8029 */ 8030 /** 8031 * Border image slice 8032 * 8033 * @type { ?(Length | EdgeWidths) } 8034 * @syscap SystemCapability.ArkUI.ArkUI.Full 8035 * @crossplatform 8036 * @form 8037 * @atomicservice 8038 * @since 11 8039 */ 8040 /** 8041 * Border image slice 8042 * 8043 * @type { ?(Length | EdgeWidths | LocalizedEdgeWidths) } 8044 * @syscap SystemCapability.ArkUI.ArkUI.Full 8045 * @crossplatform 8046 * @form 8047 * @atomicservice 8048 * @since 12 8049 */ 8050 slice?: Length | EdgeWidths | LocalizedEdgeWidths, 8051 8052 /** 8053 * Border image repeat 8054 * 8055 * @type { ?RepeatMode } 8056 * @syscap SystemCapability.ArkUI.ArkUI.Full 8057 * @form 8058 * @since 9 8059 */ 8060 /** 8061 * Border image repeat 8062 * 8063 * @type { ?RepeatMode } 8064 * @syscap SystemCapability.ArkUI.ArkUI.Full 8065 * @crossplatform 8066 * @form 8067 * @since 10 8068 */ 8069 /** 8070 * Border image repeat 8071 * 8072 * @type { ?RepeatMode } 8073 * @syscap SystemCapability.ArkUI.ArkUI.Full 8074 * @crossplatform 8075 * @form 8076 * @atomicservice 8077 * @since 11 8078 */ 8079 repeat?: RepeatMode, 8080 8081 /** 8082 * Border image source 8083 * 8084 * @type { ?(string | Resource | LinearGradient) } 8085 * @syscap SystemCapability.ArkUI.ArkUI.Full 8086 * @form 8087 * @since 9 8088 */ 8089 /** 8090 * Border image source 8091 * 8092 * @type { ?(string | Resource | LinearGradient) } 8093 * @syscap SystemCapability.ArkUI.ArkUI.Full 8094 * @crossplatform 8095 * @form 8096 * @since 10 8097 */ 8098 /** 8099 * Border image source 8100 * 8101 * @type { ?(string | Resource | LinearGradient) } 8102 * @syscap SystemCapability.ArkUI.ArkUI.Full 8103 * @crossplatform 8104 * @form 8105 * @atomicservice 8106 * @since 11 8107 */ 8108 source?: string | Resource | LinearGradient, 8109 8110 /** 8111 * Border image width 8112 * 8113 * @type { ?(Length | EdgeWidths) } 8114 * @syscap SystemCapability.ArkUI.ArkUI.Full 8115 * @form 8116 * @since 9 8117 */ 8118 /** 8119 * Border image width 8120 * 8121 * @type { ?(Length | EdgeWidths) } 8122 * @syscap SystemCapability.ArkUI.ArkUI.Full 8123 * @crossplatform 8124 * @form 8125 * @since 10 8126 */ 8127 /** 8128 * Border image width 8129 * 8130 * @type { ?(Length | EdgeWidths) } 8131 * @syscap SystemCapability.ArkUI.ArkUI.Full 8132 * @crossplatform 8133 * @form 8134 * @atomicservice 8135 * @since 11 8136 */ 8137 /** 8138 * Border image width 8139 * 8140 * @type { ?(Length | EdgeWidths | LocalizedEdgeWidths) } 8141 * @syscap SystemCapability.ArkUI.ArkUI.Full 8142 * @crossplatform 8143 * @form 8144 * @atomicservice 8145 * @since 12 8146 */ 8147 width?: Length | EdgeWidths | LocalizedEdgeWidths, 8148 8149 /** 8150 * Border image outset 8151 * 8152 * @type { ?(Length | EdgeWidths) } 8153 * @syscap SystemCapability.ArkUI.ArkUI.Full 8154 * @form 8155 * @since 9 8156 */ 8157 /** 8158 * Border image outset 8159 * 8160 * @type { ?(Length | EdgeWidths) } 8161 * @syscap SystemCapability.ArkUI.ArkUI.Full 8162 * @crossplatform 8163 * @form 8164 * @since 10 8165 */ 8166 /** 8167 * Border image outset 8168 * 8169 * @type { ?(Length | EdgeWidths) } 8170 * @syscap SystemCapability.ArkUI.ArkUI.Full 8171 * @crossplatform 8172 * @form 8173 * @atomicservice 8174 * @since 11 8175 */ 8176 /** 8177 * Border image outset 8178 * 8179 * @type { ?(Length | EdgeWidths | LocalizedEdgeWidths) } 8180 * @syscap SystemCapability.ArkUI.ArkUI.Full 8181 * @crossplatform 8182 * @form 8183 * @atomicservice 8184 * @since 12 8185 */ 8186 outset?: Length | EdgeWidths | LocalizedEdgeWidths, 8187 8188 /** 8189 * Border image center fill 8190 * 8191 * @type { ?boolean } 8192 * @syscap SystemCapability.ArkUI.ArkUI.Full 8193 * @form 8194 * @since 9 8195 */ 8196 /** 8197 * Border image center fill 8198 * 8199 * @type { ?boolean } 8200 * @syscap SystemCapability.ArkUI.ArkUI.Full 8201 * @crossplatform 8202 * @form 8203 * @since 10 8204 */ 8205 /** 8206 * Border image center fill 8207 * 8208 * @type { ?boolean } 8209 * @syscap SystemCapability.ArkUI.ArkUI.Full 8210 * @crossplatform 8211 * @form 8212 * @atomicservice 8213 * @since 11 8214 */ 8215 fill?: boolean 8216} 8217 8218/** 8219 * The tap action triggers this method invocation. 8220 * 8221 * @extends BaseEvent 8222 * @interface ClickEvent 8223 * @syscap SystemCapability.ArkUI.ArkUI.Full 8224 * @since 7 8225 */ 8226/** 8227 * The tap action triggers this method invocation. 8228 * 8229 * @extends BaseEvent 8230 * @interface ClickEvent 8231 * @syscap SystemCapability.ArkUI.ArkUI.Full 8232 * @form 8233 * @since 9 8234 */ 8235/** 8236 * The tap action triggers this method invocation. 8237 * 8238 * @extends BaseEvent 8239 * @interface ClickEvent 8240 * @syscap SystemCapability.ArkUI.ArkUI.Full 8241 * @crossplatform 8242 * @form 8243 * @since 10 8244 */ 8245/** 8246 * The tap action triggers this method invocation. 8247 * 8248 * @extends BaseEvent 8249 * @interface ClickEvent 8250 * @syscap SystemCapability.ArkUI.ArkUI.Full 8251 * @crossplatform 8252 * @form 8253 * @atomicservice 8254 * @since 11 8255 */ 8256declare interface ClickEvent extends BaseEvent { 8257 /** 8258 * X coordinate of the click point relative to the left edge of the device screen. 8259 * 8260 * @type { number } 8261 * @syscap SystemCapability.ArkUI.ArkUI.Full 8262 * @crossplatform 8263 * @since 10 8264 */ 8265 /** 8266 * X coordinate of the click point relative to the left edge of the device screen. 8267 * 8268 * @type { number } 8269 * @syscap SystemCapability.ArkUI.ArkUI.Full 8270 * @crossplatform 8271 * @atomicservice 8272 * @since 11 8273 */ 8274 displayX: number; 8275 8276 /** 8277 * Y coordinate of the click point relative to the upper edge of the device screen. 8278 * 8279 * @type { number } 8280 * @syscap SystemCapability.ArkUI.ArkUI.Full 8281 * @crossplatform 8282 * @since 10 8283 */ 8284 /** 8285 * Y coordinate of the click point relative to the upper edge of the device screen. 8286 * 8287 * @type { number } 8288 * @syscap SystemCapability.ArkUI.ArkUI.Full 8289 * @crossplatform 8290 * @atomicservice 8291 * @since 11 8292 */ 8293 displayY: number; 8294 8295 /** 8296 * X coordinate of the click point relative to the left edge of the current window. 8297 * 8298 * @type { number } 8299 * @syscap SystemCapability.ArkUI.ArkUI.Full 8300 * @crossplatform 8301 * @since 10 8302 */ 8303 /** 8304 * X coordinate of the click point relative to the left edge of the current window. 8305 * 8306 * @type { number } 8307 * @syscap SystemCapability.ArkUI.ArkUI.Full 8308 * @crossplatform 8309 * @atomicservice 8310 * @since 11 8311 */ 8312 windowX: number; 8313 8314 /** 8315 * Y coordinate of the click point relative to the upper edge of the current window. 8316 * 8317 * @type { number } 8318 * @syscap SystemCapability.ArkUI.ArkUI.Full 8319 * @crossplatform 8320 * @since 10 8321 */ 8322 /** 8323 * Y coordinate of the click point relative to the upper edge of the current window. 8324 * 8325 * @type { number } 8326 * @syscap SystemCapability.ArkUI.ArkUI.Full 8327 * @crossplatform 8328 * @atomicservice 8329 * @since 11 8330 */ 8331 windowY: number; 8332 8333 /** 8334 * X coordinate of the click point relative to the left edge of the current window. 8335 * 8336 * @type { number } 8337 * @syscap SystemCapability.ArkUI.ArkUI.Full 8338 * @since 7 8339 * @deprecated since 10 8340 * @useinstead ClickEvent#windowX 8341 */ 8342 screenX: number; 8343 8344 /** 8345 * Y coordinate of the click point relative to the upper edge of the current window. 8346 * 8347 * @type { number } 8348 * @syscap SystemCapability.ArkUI.ArkUI.Full 8349 * @since 7 8350 * @deprecated since 10 8351 * @useinstead ClickEvent#windowY 8352 */ 8353 screenY: number; 8354 8355 /** 8356 * X coordinate of the click point relative to the left edge of the clicked element. 8357 * 8358 * @type { number } 8359 * @syscap SystemCapability.ArkUI.ArkUI.Full 8360 * @since 7 8361 */ 8362 /** 8363 * X coordinate of the click point relative to the left edge of the clicked element. 8364 * 8365 * @type { number } 8366 * @syscap SystemCapability.ArkUI.ArkUI.Full 8367 * @form 8368 * @since 9 8369 */ 8370 /** 8371 * X coordinate of the click point relative to the left edge of the clicked element. 8372 * 8373 * @type { number } 8374 * @syscap SystemCapability.ArkUI.ArkUI.Full 8375 * @crossplatform 8376 * @form 8377 * @since 10 8378 */ 8379 /** 8380 * X coordinate of the click point relative to the left edge of the clicked element. 8381 * 8382 * @type { number } 8383 * @syscap SystemCapability.ArkUI.ArkUI.Full 8384 * @crossplatform 8385 * @form 8386 * @atomicservice 8387 * @since 11 8388 */ 8389 x: number; 8390 8391 /** 8392 * Y coordinate of the click point relative to the upper edge of the clicked element. 8393 * 8394 * @type { number } 8395 * @syscap SystemCapability.ArkUI.ArkUI.Full 8396 * @since 7 8397 */ 8398 /** 8399 * Y coordinate of the click point relative to the left edge of the clicked element. 8400 * 8401 * @type { number } 8402 * @syscap SystemCapability.ArkUI.ArkUI.Full 8403 * @form 8404 * @since 9 8405 */ 8406 /** 8407 * Y coordinate of the click point relative to the left edge of the clicked element. 8408 * 8409 * @type { number } 8410 * @syscap SystemCapability.ArkUI.ArkUI.Full 8411 * @crossplatform 8412 * @form 8413 * @since 10 8414 */ 8415 /** 8416 * Y coordinate of the click point relative to the left edge of the clicked element. 8417 * 8418 * @type { number } 8419 * @syscap SystemCapability.ArkUI.ArkUI.Full 8420 * @crossplatform 8421 * @form 8422 * @atomicservice 8423 * @since 11 8424 */ 8425 y: number; 8426 8427 /** 8428 * Prevent the default function. 8429 * 8430 * @type { function } 8431 * @syscap SystemCapability.ArkUI.ArkUI.Full 8432 * @crossplatform 8433 * @atomicservice 8434 * @since 12 8435 */ 8436 preventDefault: () => void; 8437} 8438 8439/** 8440 * The hover action triggers this method invocation. 8441 * 8442 * @extends BaseEvent 8443 * @interface HoverEvent 8444 * @syscap SystemCapability.ArkUI.ArkUI.Full 8445 * @since 10 8446 */ 8447/** 8448 * The hover action triggers this method invocation. 8449 * 8450 * @extends BaseEvent 8451 * @interface HoverEvent 8452 * @syscap SystemCapability.ArkUI.ArkUI.Full 8453 * @atomicservice 8454 * @since 11 8455 */ 8456declare interface HoverEvent extends BaseEvent { 8457 /** 8458 * The blocking hover event pops up. 8459 * 8460 * @type { function } 8461 * @syscap SystemCapability.ArkUI.ArkUI.Full 8462 * @since 10 8463 */ 8464 /** 8465 * The blocking hover event pops up. 8466 * 8467 * @type { function } 8468 * @syscap SystemCapability.ArkUI.ArkUI.Full 8469 * @atomicservice 8470 * @since 11 8471 */ 8472 stopPropagation: () => void; 8473} 8474 8475/** 8476 * The mouse click action triggers this method invocation. 8477 * 8478 * @extends BaseEvent 8479 * @interface MouseEvent 8480 * @syscap SystemCapability.ArkUI.ArkUI.Full 8481 * @since 8 8482 */ 8483/** 8484 * The mouse click action triggers this method invocation. 8485 * 8486 * @extends BaseEvent 8487 * @interface MouseEvent 8488 * @syscap SystemCapability.ArkUI.ArkUI.Full 8489 * @atomicservice 8490 * @since 11 8491 */ 8492declare interface MouseEvent extends BaseEvent { 8493 /** 8494 * Mouse button of the click event. 8495 * 8496 * @type { MouseButton } 8497 * @syscap SystemCapability.ArkUI.ArkUI.Full 8498 * @since 8 8499 */ 8500 /** 8501 * Mouse button of the click event. 8502 * 8503 * @type { MouseButton } 8504 * @syscap SystemCapability.ArkUI.ArkUI.Full 8505 * @atomicservice 8506 * @since 11 8507 */ 8508 button: MouseButton; 8509 8510 /** 8511 * Mouse action of the click event. 8512 * 8513 * @type { MouseAction } 8514 * @syscap SystemCapability.ArkUI.ArkUI.Full 8515 * @since 8 8516 */ 8517 /** 8518 * Mouse action of the click event. 8519 * 8520 * @type { MouseAction } 8521 * @syscap SystemCapability.ArkUI.ArkUI.Full 8522 * @atomicservice 8523 * @since 11 8524 */ 8525 action: MouseAction; 8526 8527 /** 8528 * X coordinate of the mouse point relative to the left edge of the device screen. 8529 * 8530 * @type { number } 8531 * @syscap SystemCapability.ArkUI.ArkUI.Full 8532 * @since 10 8533 */ 8534 /** 8535 * X coordinate of the mouse point relative to the left edge of the device screen. 8536 * 8537 * @type { number } 8538 * @syscap SystemCapability.ArkUI.ArkUI.Full 8539 * @atomicservice 8540 * @since 11 8541 */ 8542 displayX: number; 8543 8544 /** 8545 * Y coordinate of the mouse point relative to the upper edge of the device screen. 8546 * 8547 * @type { number } 8548 * @syscap SystemCapability.ArkUI.ArkUI.Full 8549 * @since 10 8550 */ 8551 /** 8552 * Y coordinate of the mouse point relative to the upper edge of the device screen. 8553 * 8554 * @type { number } 8555 * @syscap SystemCapability.ArkUI.ArkUI.Full 8556 * @atomicservice 8557 * @since 11 8558 */ 8559 displayY: number; 8560 8561 /** 8562 * X coordinate of the mouse point relative to the left edge of the current window. 8563 * 8564 * @type { number } 8565 * @syscap SystemCapability.ArkUI.ArkUI.Full 8566 * @since 10 8567 */ 8568 /** 8569 * X coordinate of the mouse point relative to the left edge of the current window. 8570 * 8571 * @type { number } 8572 * @syscap SystemCapability.ArkUI.ArkUI.Full 8573 * @atomicservice 8574 * @since 11 8575 */ 8576 windowX: number; 8577 8578 /** 8579 * Y coordinate of the mouse point relative to the upper edge of the current window. 8580 * 8581 * @type { number } 8582 * @syscap SystemCapability.ArkUI.ArkUI.Full 8583 * @since 10 8584 */ 8585 /** 8586 * Y coordinate of the mouse point relative to the upper edge of the current window. 8587 * 8588 * @type { number } 8589 * @syscap SystemCapability.ArkUI.ArkUI.Full 8590 * @atomicservice 8591 * @since 11 8592 */ 8593 windowY: number; 8594 8595 /** 8596 * X coordinate of the mouse point relative to the left edge of the current window. 8597 * 8598 * @type { number } 8599 * @syscap SystemCapability.ArkUI.ArkUI.Full 8600 * @since 8 8601 * @deprecated since 10 8602 * @useinstead MouseEvent#windowX 8603 */ 8604 screenX: number; 8605 8606 /** 8607 * Y coordinate of the mouse point relative to the upper edge of the current window. 8608 * 8609 * @type { number } 8610 * @syscap SystemCapability.ArkUI.ArkUI.Full 8611 * @since 8 8612 * @deprecated since 10 8613 * @useinstead MouseEvent#windowY 8614 */ 8615 screenY: number; 8616 8617 /** 8618 * X coordinate of the mouse point relative to the left edge of the mouse hit element. 8619 * 8620 * @type { number } 8621 * @syscap SystemCapability.ArkUI.ArkUI.Full 8622 * @since 8 8623 */ 8624 /** 8625 * X coordinate of the mouse point relative to the left edge of the mouse hit element. 8626 * 8627 * @type { number } 8628 * @syscap SystemCapability.ArkUI.ArkUI.Full 8629 * @atomicservice 8630 * @since 11 8631 */ 8632 x: number; 8633 8634 /** 8635 * Y coordinate of the mouse point relative to the upper edge of the mouse hit element. 8636 * 8637 * @type { number } 8638 * @syscap SystemCapability.ArkUI.ArkUI.Full 8639 * @since 8 8640 */ 8641 /** 8642 * Y coordinate of the mouse point relative to the upper edge of the mouse hit element. 8643 * 8644 * @type { number } 8645 * @syscap SystemCapability.ArkUI.ArkUI.Full 8646 * @atomicservice 8647 * @since 11 8648 */ 8649 y: number; 8650 8651 /** 8652 * The blocking event pops up. 8653 * 8654 * @type { function } 8655 * @syscap SystemCapability.ArkUI.ArkUI.Full 8656 * @since 8 8657 */ 8658 /** 8659 * The blocking event pops up. 8660 * 8661 * @type { function } 8662 * @syscap SystemCapability.ArkUI.ArkUI.Full 8663 * @atomicservice 8664 * @since 11 8665 */ 8666 stopPropagation: () => void; 8667} 8668 8669/** 8670 * The accessibility hover action triggers this method invocation. 8671 * 8672 * @extends BaseEvent 8673 * @typedef AccessibilityHoverEvent 8674 * @syscap SystemCapability.ArkUI.ArkUI.Full 8675 * @atomicservice 8676 * @since 12 8677 */ 8678declare interface AccessibilityHoverEvent extends BaseEvent { 8679 /** 8680 * Type of the accessibility hover event. 8681 * 8682 * @type { AccessibilityHoverType } 8683 * @syscap SystemCapability.ArkUI.ArkUI.Full 8684 * @atomicservice 8685 * @since 12 8686 */ 8687 type: AccessibilityHoverType; 8688 8689 /** 8690 * X coordinate of the accessibility hover point relative to the left edge of the event hit element. 8691 * 8692 * @type { number } 8693 * @syscap SystemCapability.ArkUI.ArkUI.Full 8694 * @atomicservice 8695 * @since 12 8696 */ 8697 x: number; 8698 8699 /** 8700 * Y coordinate of the accessibility hover point relative to the upper edge of the event hit element. 8701 * 8702 * @type { number } 8703 * @syscap SystemCapability.ArkUI.ArkUI.Full 8704 * @atomicservice 8705 * @since 12 8706 */ 8707 y: number; 8708 8709 /** 8710 * X coordinate of the accessibility hover point relative to the left edge of the device screen. 8711 * 8712 * @type { number } 8713 * @syscap SystemCapability.ArkUI.ArkUI.Full 8714 * @atomicservice 8715 * @since 12 8716 */ 8717 displayX: number; 8718 8719 /** 8720 * Y coordinate of the accessibility hover point relative to the upper edge of the device screen. 8721 * 8722 * @type { number } 8723 * @syscap SystemCapability.ArkUI.ArkUI.Full 8724 * @atomicservice 8725 * @since 12 8726 */ 8727 displayY: number; 8728 8729 /** 8730 * X coordinate of the accessibility hover point relative to the left edge of the current window. 8731 * 8732 * @type { number } 8733 * @syscap SystemCapability.ArkUI.ArkUI.Full 8734 * @atomicservice 8735 * @since 12 8736 */ 8737 windowX: number; 8738 8739 /** 8740 * Y coordinate of the accessibility hover point relative to the upper edge of the current window. 8741 * 8742 * @type { number } 8743 * @syscap SystemCapability.ArkUI.ArkUI.Full 8744 * @atomicservice 8745 * @since 12 8746 */ 8747 windowY: number; 8748} 8749 8750/** 8751 * Type of the touch event. 8752 * 8753 * @interface TouchObject 8754 * @syscap SystemCapability.ArkUI.ArkUI.Full 8755 * @since 7 8756 */ 8757/** 8758 * Type of the touch event. 8759 * 8760 * @interface TouchObject 8761 * @syscap SystemCapability.ArkUI.ArkUI.Full 8762 * @crossplatform 8763 * @since 10 8764 */ 8765/** 8766 * Type of the touch event. 8767 * 8768 * @interface TouchObject 8769 * @syscap SystemCapability.ArkUI.ArkUI.Full 8770 * @crossplatform 8771 * @atomicservice 8772 * @since 11 8773 */ 8774declare interface TouchObject { 8775 /** 8776 * Type of the touch event. 8777 * 8778 * @type { TouchType } 8779 * @syscap SystemCapability.ArkUI.ArkUI.Full 8780 * @since 7 8781 */ 8782 /** 8783 * Type of the touch event. 8784 * 8785 * @type { TouchType } 8786 * @syscap SystemCapability.ArkUI.ArkUI.Full 8787 * @crossplatform 8788 * @since 10 8789 */ 8790 /** 8791 * Type of the touch event. 8792 * 8793 * @type { TouchType } 8794 * @syscap SystemCapability.ArkUI.ArkUI.Full 8795 * @crossplatform 8796 * @atomicservice 8797 * @since 11 8798 */ 8799 type: TouchType; 8800 8801 /** 8802 * Finger unique identifier. 8803 * 8804 * @type { number } 8805 * @syscap SystemCapability.ArkUI.ArkUI.Full 8806 * @since 7 8807 */ 8808 /** 8809 * Finger unique identifier. 8810 * 8811 * @type { number } 8812 * @syscap SystemCapability.ArkUI.ArkUI.Full 8813 * @crossplatform 8814 * @since 10 8815 */ 8816 /** 8817 * Finger unique identifier. 8818 * 8819 * @type { number } 8820 * @syscap SystemCapability.ArkUI.ArkUI.Full 8821 * @crossplatform 8822 * @atomicservice 8823 * @since 11 8824 */ 8825 id: number; 8826 8827 /** 8828 * X coordinate of the touch point relative to the left edge of the device screen. 8829 * 8830 * @type { number } 8831 * @syscap SystemCapability.ArkUI.ArkUI.Full 8832 * @crossplatform 8833 * @since 10 8834 */ 8835 /** 8836 * X coordinate of the touch point relative to the left edge of the device screen. 8837 * 8838 * @type { number } 8839 * @syscap SystemCapability.ArkUI.ArkUI.Full 8840 * @crossplatform 8841 * @atomicservice 8842 * @since 11 8843 */ 8844 displayX: number; 8845 8846 /** 8847 * Y coordinate of the touch point relative to the upper edge of the device screen. 8848 * 8849 * @type { number } 8850 * @syscap SystemCapability.ArkUI.ArkUI.Full 8851 * @crossplatform 8852 * @since 10 8853 */ 8854 /** 8855 * Y coordinate of the touch point relative to the upper edge of the device screen. 8856 * 8857 * @type { number } 8858 * @syscap SystemCapability.ArkUI.ArkUI.Full 8859 * @crossplatform 8860 * @atomicservice 8861 * @since 11 8862 */ 8863 displayY: number; 8864 8865 /** 8866 * X coordinate of the touch point relative to the left edge of the current window. 8867 * 8868 * @type { number } 8869 * @syscap SystemCapability.ArkUI.ArkUI.Full 8870 * @crossplatform 8871 * @since 10 8872 */ 8873 /** 8874 * X coordinate of the touch point relative to the left edge of the current window. 8875 * 8876 * @type { number } 8877 * @syscap SystemCapability.ArkUI.ArkUI.Full 8878 * @crossplatform 8879 * @atomicservice 8880 * @since 11 8881 */ 8882 windowX: number; 8883 8884 /** 8885 * Y coordinate of the touch point relative to the upper edge of the current window. 8886 * 8887 * @type { number } 8888 * @syscap SystemCapability.ArkUI.ArkUI.Full 8889 * @crossplatform 8890 * @since 10 8891 */ 8892 /** 8893 * Y coordinate of the touch point relative to the upper edge of the current window. 8894 * 8895 * @type { number } 8896 * @syscap SystemCapability.ArkUI.ArkUI.Full 8897 * @crossplatform 8898 * @atomicservice 8899 * @since 11 8900 */ 8901 windowY: number; 8902 8903 /** 8904 * X coordinate of the touch point relative to the left edge of the current window. 8905 * 8906 * @type { number } 8907 * @syscap SystemCapability.ArkUI.ArkUI.Full 8908 * @since 7 8909 * @deprecated since 10 8910 * @useinstead TouchObject#windowX 8911 */ 8912 screenX: number; 8913 8914 /** 8915 * Y coordinate of the touch point relative to the upper edge of the current window. 8916 * 8917 * @type { number } 8918 * @syscap SystemCapability.ArkUI.ArkUI.Full 8919 * @since 7 8920 * @deprecated since 10 8921 * @useinstead TouchObject#windowY 8922 */ 8923 screenY: number; 8924 8925 /** 8926 * X coordinate of the touch point relative to the left edge of the touched element. 8927 * 8928 * @type { number } 8929 * @syscap SystemCapability.ArkUI.ArkUI.Full 8930 * @since 7 8931 */ 8932 /** 8933 * X coordinate of the touch point relative to the left edge of the touched element. 8934 * 8935 * @type { number } 8936 * @syscap SystemCapability.ArkUI.ArkUI.Full 8937 * @crossplatform 8938 * @since 10 8939 */ 8940 /** 8941 * X coordinate of the touch point relative to the left edge of the touched element. 8942 * 8943 * @type { number } 8944 * @syscap SystemCapability.ArkUI.ArkUI.Full 8945 * @crossplatform 8946 * @atomicservice 8947 * @since 11 8948 */ 8949 x: number; 8950 8951 /** 8952 * Y coordinate of the touch point relative to the upper edge of the touched element. 8953 * 8954 * @type { number } 8955 * @syscap SystemCapability.ArkUI.ArkUI.Full 8956 * @since 7 8957 */ 8958 /** 8959 * Y coordinate of the touch point relative to the upper edge of the touched element. 8960 * 8961 * @type { number } 8962 * @syscap SystemCapability.ArkUI.ArkUI.Full 8963 * @crossplatform 8964 * @since 10 8965 */ 8966 /** 8967 * Y coordinate of the touch point relative to the upper edge of the touched element. 8968 * 8969 * @type { number } 8970 * @syscap SystemCapability.ArkUI.ArkUI.Full 8971 * @crossplatform 8972 * @atomicservice 8973 * @since 11 8974 */ 8975 y: number; 8976} 8977 8978/** 8979 * TouchObject getHistoricalPoints Function Parameters 8980 * 8981 * @interface HistoricalPoint 8982 * @syscap SystemCapability.ArkUI.ArkUI.Full 8983 * @crossplatform 8984 * @since 10 8985 */ 8986/** 8987 * TouchObject getHistoricalPoints Function Parameters 8988 * 8989 * @interface HistoricalPoint 8990 * @syscap SystemCapability.ArkUI.ArkUI.Full 8991 * @crossplatform 8992 * @atomicservice 8993 * @since 11 8994 */ 8995declare interface HistoricalPoint { 8996 /** 8997 * The base touchObject information of historicalPoint 8998 * 8999 * @type { TouchObject } 9000 * @syscap SystemCapability.ArkUI.ArkUI.Full 9001 * @crossplatform 9002 * @since 10 9003 */ 9004 /** 9005 * The base touchObject information of historicalPoint 9006 * 9007 * @type { TouchObject } 9008 * @syscap SystemCapability.ArkUI.ArkUI.Full 9009 * @crossplatform 9010 * @atomicservice 9011 * @since 11 9012 */ 9013 touchObject: TouchObject; 9014 9015 /** 9016 * Contact area between the finger pad and the screen. 9017 * 9018 * @type { number } 9019 * @syscap SystemCapability.ArkUI.ArkUI.Full 9020 * @crossplatform 9021 * @since 10 9022 */ 9023 /** 9024 * Contact area between the finger pad and the screen. 9025 * 9026 * @type { number } 9027 * @syscap SystemCapability.ArkUI.ArkUI.Full 9028 * @crossplatform 9029 * @atomicservice 9030 * @since 11 9031 */ 9032 size: number; 9033 9034 /** 9035 * Pressure of the touch event. 9036 * 9037 * @type { number } 9038 * @syscap SystemCapability.ArkUI.ArkUI.Full 9039 * @crossplatform 9040 * @since 10 9041 */ 9042 /** 9043 * Pressure of the touch event. 9044 * 9045 * @type { number } 9046 * @syscap SystemCapability.ArkUI.ArkUI.Full 9047 * @crossplatform 9048 * @atomicservice 9049 * @since 11 9050 */ 9051 force: number; 9052 9053 /** 9054 * Timestamp of the touch event. 9055 * 9056 * @type { number } 9057 * @syscap SystemCapability.ArkUI.ArkUI.Full 9058 * @crossplatform 9059 * @since 10 9060 */ 9061 /** 9062 * Timestamp of the touch event. 9063 * 9064 * @type { number } 9065 * @syscap SystemCapability.ArkUI.ArkUI.Full 9066 * @crossplatform 9067 * @atomicservice 9068 * @since 11 9069 */ 9070 timestamp: number; 9071} 9072 9073/** 9074 * Touch Action Function Parameters 9075 * 9076 * @extends BaseEvent 9077 * @interface TouchEvent 9078 * @syscap SystemCapability.ArkUI.ArkUI.Full 9079 * @since 7 9080 */ 9081/** 9082 * Touch Action Function Parameters 9083 * 9084 * @extends BaseEvent 9085 * @interface TouchEvent 9086 * @syscap SystemCapability.ArkUI.ArkUI.Full 9087 * @crossplatform 9088 * @since 10 9089 */ 9090/** 9091 * Touch Action Function Parameters 9092 * 9093 * @extends BaseEvent 9094 * @interface TouchEvent 9095 * @syscap SystemCapability.ArkUI.ArkUI.Full 9096 * @crossplatform 9097 * @atomicservice 9098 * @since 11 9099 */ 9100declare interface TouchEvent extends BaseEvent { 9101 /** 9102 * Type of the touch event. 9103 * 9104 * @type { TouchType } 9105 * @syscap SystemCapability.ArkUI.ArkUI.Full 9106 * @since 7 9107 */ 9108 /** 9109 * Type of the touch event. 9110 * 9111 * @type { TouchType } 9112 * @syscap SystemCapability.ArkUI.ArkUI.Full 9113 * @crossplatform 9114 * @since 10 9115 */ 9116 /** 9117 * Type of the touch event. 9118 * 9119 * @type { TouchType } 9120 * @syscap SystemCapability.ArkUI.ArkUI.Full 9121 * @crossplatform 9122 * @atomicservice 9123 * @since 11 9124 */ 9125 type: TouchType; 9126 9127 /** 9128 * All finger information. 9129 * 9130 * @type { TouchObject[] } 9131 * @syscap SystemCapability.ArkUI.ArkUI.Full 9132 * @since 7 9133 */ 9134 /** 9135 * All finger information. 9136 * 9137 * @type { TouchObject[] } 9138 * @syscap SystemCapability.ArkUI.ArkUI.Full 9139 * @crossplatform 9140 * @since 10 9141 */ 9142 /** 9143 * All finger information. 9144 * 9145 * @type { TouchObject[] } 9146 * @syscap SystemCapability.ArkUI.ArkUI.Full 9147 * @crossplatform 9148 * @atomicservice 9149 * @since 11 9150 */ 9151 touches: TouchObject[]; 9152 9153 /** 9154 * Indicates the current changed finger information. 9155 * 9156 * @type { TouchObject[] } 9157 * @syscap SystemCapability.ArkUI.ArkUI.Full 9158 * @since 7 9159 */ 9160 /** 9161 * Indicates the current changed finger information. 9162 * 9163 * @type { TouchObject[] } 9164 * @syscap SystemCapability.ArkUI.ArkUI.Full 9165 * @crossplatform 9166 * @since 10 9167 */ 9168 /** 9169 * Indicates the current changed finger information. 9170 * 9171 * @type { TouchObject[] } 9172 * @syscap SystemCapability.ArkUI.ArkUI.Full 9173 * @crossplatform 9174 * @atomicservice 9175 * @since 11 9176 */ 9177 changedTouches: TouchObject[]; 9178 9179 /** 9180 * The blocking event pops up. 9181 * 9182 * @type { function } 9183 * @syscap SystemCapability.ArkUI.ArkUI.Full 9184 * @since 7 9185 */ 9186 /** 9187 * The blocking event pops up. 9188 * 9189 * @type { function } 9190 * @syscap SystemCapability.ArkUI.ArkUI.Full 9191 * @crossplatform 9192 * @since 10 9193 */ 9194 /** 9195 * The blocking event pops up. 9196 * 9197 * @type { function } 9198 * @syscap SystemCapability.ArkUI.ArkUI.Full 9199 * @crossplatform 9200 * @atomicservice 9201 * @since 11 9202 */ 9203 stopPropagation: () => void; 9204 9205 /** 9206 * Get the historical points. 9207 * 9208 * @returns { Array<HistoricalPoint> } - return all historical points. 9209 * @syscap SystemCapability.ArkUI.ArkUI.Full 9210 * @crossplatform 9211 * @since 10 9212 */ 9213 /** 9214 * Get the historical points. 9215 * 9216 * @returns { Array<HistoricalPoint> } - return all historical points. 9217 * @syscap SystemCapability.ArkUI.ArkUI.Full 9218 * @crossplatform 9219 * @atomicservice 9220 * @since 11 9221 */ 9222 getHistoricalPoints(): Array<HistoricalPoint>; 9223 9224 /** 9225 * Prevent the default function. 9226 * 9227 * @type { function } 9228 * @syscap SystemCapability.ArkUI.ArkUI.Full 9229 * @crossplatform 9230 * @atomicservice 9231 * @since 12 9232 */ 9233 preventDefault: () => void; 9234} 9235 9236/** 9237 * Defines the callback type used in onSizeChange. 9238 * The value of oldValue is last size of the component. 9239 * The value of newValue is new size of the component. 9240 * 9241 * @typedef { function } SizeChangeCallback 9242 * @syscap SystemCapability.ArkUI.ArkUI.Full 9243 * @crossplatform 9244 * @form 9245 * @atomicservice 9246 * @since 12 9247 */ 9248declare type SizeChangeCallback = (oldValue: SizeOptions, newValue: SizeOptions) => void; 9249 9250/** 9251 * Defines the callback type used in onGestureRecognizerJudgeBegin. 9252 * 9253 * @typedef { function } GestureRecognizerJudgeBeginCallback 9254 * @param { BaseGestureEvent } event - the event information 9255 * @param { GestureRecognizer } current - the current gesture recognizer of the component 9256 * @param { Array<GestureRecognizer> } recognizers - the gesture recognizers of the component on the response chain 9257 * @returns { GestureJudgeResult } the gesture judge result 9258 * @syscap SystemCapability.ArkUI.ArkUI.Full 9259 * @crossplatform 9260 * @atomicservice 9261 * @since 12 9262 */ 9263declare type GestureRecognizerJudgeBeginCallback = (event: BaseGestureEvent, current: GestureRecognizer, recognizers: Array<GestureRecognizer>) => GestureJudgeResult; 9264 9265/** 9266 * Defines the callback type used in shouldBuiltInRecognizerParallelWith. 9267 * 9268 * @typedef { function } ShouldBuiltInRecognizerParallelWithCallback 9269 * @param { GestureRecognizer } current - the current gesture recognizer of the component 9270 * @param { Array<GestureRecognizer> } others - the gesture recognizers of the component on the response chain 9271 * @returns { GestureRecognizer } gesture recognizer of the component 9272 * @syscap SystemCapability.ArkUI.ArkUI.Full 9273 * @crossplatform 9274 * @atomicservice 9275 * @since 12 9276 */ 9277declare type ShouldBuiltInRecognizerParallelWithCallback = (current: GestureRecognizer, others: Array<GestureRecognizer>) => GestureRecognizer; 9278 9279/** 9280 * Defines the finish callback type used in transition. 9281 * 9282 * @typedef { function } TransitionFinishCallback 9283 * @param { boolean } transitionIn - a boolean value indicates whether it is the callback of transitionIn or transitionOut. 9284 * @syscap SystemCapability.ArkUI.ArkUI.Full 9285 * @crossplatform 9286 * @form 9287 * @atomicservice 9288 * @since 12 9289 */ 9290declare type TransitionFinishCallback = (transitionIn: boolean) => void; 9291 9292/** 9293 * Defines the PixelMap type object for ui component. 9294 * 9295 * @syscap SystemCapability.ArkUI.ArkUI.Full 9296 * @since 7 9297 */ 9298/** 9299 * Defines the PixelMap type object for ui component. 9300 * 9301 * @syscap SystemCapability.ArkUI.ArkUI.Full 9302 * @crossplatform 9303 * @since 10 9304 */ 9305/** 9306 * Defines the PixelMap type object for ui component. 9307 * 9308 * @typedef { import('../api/@ohos.multimedia.image').default.PixelMap } PixelMap 9309 * @syscap SystemCapability.ArkUI.ArkUI.Full 9310 * @crossplatform 9311 * @atomicservice 9312 * @since 11 9313 */ 9314declare type PixelMap = import('../api/@ohos.multimedia.image').default.PixelMap; 9315 9316/** 9317 * pixelmap object with release function. 9318 * 9319 * @interface PixelMapMock 9320 * @syscap SystemCapability.ArkUI.ArkUI.Full 9321 * @systemapi 9322 * @since 7 9323 */ 9324declare interface PixelMapMock { 9325 /** 9326 * release function. 9327 * 9328 * @syscap SystemCapability.ArkUI.ArkUI.Full 9329 * @systemapi 9330 * @since 7 9331 */ 9332 release(): void; 9333} 9334 9335/** 9336 * Enum for Drag Behavior. 9337 * 9338 * @enum { number } 9339 * @syscap SystemCapability.ArkUI.ArkUI.Full 9340 * @since 10 9341 */ 9342/** 9343 * Enum for Drag Behavior. 9344 * 9345 * @enum { number } 9346 * @syscap SystemCapability.ArkUI.ArkUI.Full 9347 * @atomicservice 9348 * @since 11 9349 */ 9350declare enum DragBehavior { 9351 /** 9352 * If drag use copy event, then set DragBehavior.COPY. 9353 * 9354 * @syscap SystemCapability.ArkUI.ArkUI.Full 9355 * @since 10 9356 */ 9357 /** 9358 * If drag use copy event, then set DragBehavior.COPY. 9359 * 9360 * @syscap SystemCapability.ArkUI.ArkUI.Full 9361 * @atomicservice 9362 * @since 11 9363 */ 9364 COPY, 9365 /** 9366 * If drag use move event, then set DragBehavior.MOVE. 9367 * 9368 * @syscap SystemCapability.ArkUI.ArkUI.Full 9369 * @since 10 9370 */ 9371 /** 9372 * If drag use move event, then set DragBehavior.MOVE. 9373 * 9374 * @syscap SystemCapability.ArkUI.ArkUI.Full 9375 * @atomicservice 9376 * @since 11 9377 */ 9378 MOVE 9379} 9380 9381/** 9382 * Import the UnifiedData type object for ui component. 9383 * 9384 * @typedef { import('../api/@ohos.data.unifiedDataChannel').default.UnifiedData } UnifiedData 9385 * @syscap SystemCapability.ArkUI.ArkUI.Full 9386 * @crossplatform 9387 * @since 10 9388 */ 9389/** 9390 * Import the UnifiedData type object for ui component. 9391 * 9392 * @typedef { import('../api/@ohos.data.unifiedDataChannel').default.UnifiedData } UnifiedData 9393 * @syscap SystemCapability.ArkUI.ArkUI.Full 9394 * @crossplatform 9395 * @atomicservice 9396 * @since 11 9397 */ 9398declare type UnifiedData = import('../api/@ohos.data.unifiedDataChannel').default.UnifiedData; 9399 9400/** 9401 * Import the Summary type object for ui component. 9402 * 9403 * @typedef { import('../api/@ohos.data.unifiedDataChannel').default.Summary } Summary 9404 * @syscap SystemCapability.ArkUI.ArkUI.Full 9405 * @since 10 9406 */ 9407/** 9408 * Import the Summary type object for ui component. 9409 * 9410 * @typedef { import('../api/@ohos.data.unifiedDataChannel').default.Summary } Summary 9411 * @syscap SystemCapability.ArkUI.ArkUI.Full 9412 * @atomicservice 9413 * @since 11 9414 */ 9415declare type Summary = import('../api/@ohos.data.unifiedDataChannel').default.Summary; 9416 9417/** 9418 * Import the UniformDataType type object for ui component. 9419 * 9420 * @typedef { import('../api/@ohos.data.uniformTypeDescriptor').default.UniformDataType } UniformDataType 9421 * @syscap SystemCapability.ArkUI.ArkUI.Full 9422 * @since 10 9423 */ 9424/** 9425 * Import the UniformDataType type object for ui component. 9426 * 9427 * @typedef { import('../api/@ohos.data.uniformTypeDescriptor').default.UniformDataType } UniformDataType 9428 * @syscap SystemCapability.ArkUI.ArkUI.Full 9429 * @atomicservice 9430 * @since 11 9431 */ 9432declare type UniformDataType = import('../api/@ohos.data.uniformTypeDescriptor').default.UniformDataType; 9433 9434/** 9435 * Enum for Drag Result. 9436 * 9437 * @enum { number } 9438 * @syscap SystemCapability.ArkUI.ArkUI.Full 9439 * @since 10 9440 */ 9441/** 9442 * Enum for Drag Result. 9443 * 9444 * @enum { number } 9445 * @syscap SystemCapability.ArkUI.ArkUI.Full 9446 * @atomicservice 9447 * @since 11 9448 */ 9449/** 9450 * Enum for Drag Result. 9451 * 9452 * @enum { number } 9453 * @syscap SystemCapability.ArkUI.ArkUI.Full 9454 * @crossplatform 9455 * @atomicservice 9456 * @since 14 9457 */ 9458declare enum DragResult { 9459 /** 9460 * If the drag is successful, return DragResult.DRAG_SUCCESSFUL. 9461 * 9462 * @syscap SystemCapability.ArkUI.ArkUI.Full 9463 * @since 10 9464 */ 9465 /** 9466 * If the drag is successful, return DragResult.DRAG_SUCCESSFUL. 9467 * 9468 * @syscap SystemCapability.ArkUI.ArkUI.Full 9469 * @atomicservice 9470 * @since 11 9471 */ 9472 /** 9473 * If the drag is successful, return DragResult.DRAG_SUCCESSFUL. 9474 * 9475 * @syscap SystemCapability.ArkUI.ArkUI.Full 9476 * @crossplatform 9477 * @atomicservice 9478 * @since 14 9479 */ 9480 DRAG_SUCCESSFUL = 0, 9481 /** 9482 * If drag fail, return DragResult.DRAG_FAILED. 9483 * 9484 * @syscap SystemCapability.ArkUI.ArkUI.Full 9485 * @since 10 9486 */ 9487 /** 9488 * If drag fail, return DragResult.DRAG_FAILED. 9489 * 9490 * @syscap SystemCapability.ArkUI.ArkUI.Full 9491 * @atomicservice 9492 * @since 11 9493 */ 9494 /** 9495 * If drag fail, return DragResult.DRAG_FAILED. 9496 * 9497 * @syscap SystemCapability.ArkUI.ArkUI.Full 9498 * @crossplatform 9499 * @atomicservice 9500 * @since 14 9501 */ 9502 DRAG_FAILED = 1, 9503 /** 9504 * If drag action cancel, return DragResult.DRAG_CANCELED. 9505 * 9506 * @syscap SystemCapability.ArkUI.ArkUI.Full 9507 * @since 10 9508 */ 9509 /** 9510 * If drag action cancel, return DragResult.DRAG_CANCELED. 9511 * 9512 * @syscap SystemCapability.ArkUI.ArkUI.Full 9513 * @atomicservice 9514 * @since 11 9515 */ 9516 DRAG_CANCELED = 2, 9517 /** 9518 * If node allow drop in, return DragResult.DROP_ENABLED. 9519 * 9520 * @syscap SystemCapability.ArkUI.ArkUI.Full 9521 * @since 10 9522 */ 9523 /** 9524 * If node allow drop in, return DragResult.DROP_ENABLED. 9525 * 9526 * @syscap SystemCapability.ArkUI.ArkUI.Full 9527 * @atomicservice 9528 * @since 11 9529 */ 9530 DROP_ENABLED = 3, 9531 /** 9532 * If node don't allow drop in, return DragResult.DROP_DISABLED. 9533 * 9534 * @syscap SystemCapability.ArkUI.ArkUI.Full 9535 * @since 10 9536 */ 9537 /** 9538 * If node don't allow drop in, return DragResult.DROP_DISABLED. 9539 * 9540 * @syscap SystemCapability.ArkUI.ArkUI.Full 9541 * @atomicservice 9542 * @since 11 9543 */ 9544 DROP_DISABLED = 4 9545} 9546 9547/** 9548 * Enum for BlendMode. 9549 * Blend modes for compositing current component 9550 * with overlapping content. Use overlapping content 9551 * as dst, current component as src. 9552 * 9553 * @enum { number } 9554 * @syscap SystemCapability.ArkUI.ArkUI.Full 9555 * @crossplatform 9556 * @form 9557 * @since 11 9558 */ 9559/** 9560 * Enum for BlendMode. 9561 * Blend modes for compositing current component 9562 * with overlapping content. Use overlapping content 9563 * as dst, current component as src. 9564 * 9565 * @enum { number } 9566 * @syscap SystemCapability.ArkUI.ArkUI.Full 9567 * @crossplatform 9568 * @form 9569 * @atomicservice 9570 * @since 12 9571 */ 9572declare enum BlendMode { 9573 /** 9574 * Hybrid mode does not take effect 9575 * 9576 * @syscap SystemCapability.ArkUI.ArkUI.Full 9577 * @crossplatform 9578 * @form 9579 * @since 11 9580 */ 9581 /** 9582 * Hybrid mode does not take effect 9583 * 9584 * @syscap SystemCapability.ArkUI.ArkUI.Full 9585 * @crossplatform 9586 * @form 9587 * @atomicservice 9588 * @since 12 9589 */ 9590 NONE = 0, 9591 /** 9592 * Clear destination color covered by the source to 0. 9593 * 9594 * @syscap SystemCapability.ArkUI.ArkUI.Full 9595 * @crossplatform 9596 * @form 9597 * @since 11 9598 */ 9599 /** 9600 * Clear destination color covered by the source to 0. 9601 * 9602 * @syscap SystemCapability.ArkUI.ArkUI.Full 9603 * @crossplatform 9604 * @form 9605 * @atomicservice 9606 * @since 12 9607 */ 9608 CLEAR = 1, 9609 /** 9610 * r = s 9611 * 9612 * @syscap SystemCapability.ArkUI.ArkUI.Full 9613 * @crossplatform 9614 * @form 9615 * @since 11 9616 */ 9617 /** 9618 * r = s 9619 * 9620 * @syscap SystemCapability.ArkUI.ArkUI.Full 9621 * @crossplatform 9622 * @form 9623 * @atomicservice 9624 * @since 12 9625 */ 9626 SRC = 2, 9627 /** 9628 * r = d 9629 * 9630 * @syscap SystemCapability.ArkUI.ArkUI.Full 9631 * @crossplatform 9632 * @form 9633 * @since 11 9634 */ 9635 /** 9636 * r = d 9637 * 9638 * @syscap SystemCapability.ArkUI.ArkUI.Full 9639 * @crossplatform 9640 * @form 9641 * @atomicservice 9642 * @since 12 9643 */ 9644 DST = 3, 9645 /** 9646 * r = s + (1 - sa) * d 9647 * 9648 * @syscap SystemCapability.ArkUI.ArkUI.Full 9649 * @crossplatform 9650 * @form 9651 * @since 11 9652 */ 9653 /** 9654 * r = s + (1 - sa) * d 9655 * 9656 * @syscap SystemCapability.ArkUI.ArkUI.Full 9657 * @crossplatform 9658 * @form 9659 * @atomicservice 9660 * @since 12 9661 */ 9662 SRC_OVER = 4, 9663 /** 9664 * r = d + (1 - da) * s 9665 * 9666 * @syscap SystemCapability.ArkUI.ArkUI.Full 9667 * @crossplatform 9668 * @form 9669 * @since 11 9670 */ 9671 /** 9672 * r = d + (1 - da) * s 9673 * 9674 * @syscap SystemCapability.ArkUI.ArkUI.Full 9675 * @crossplatform 9676 * @form 9677 * @atomicservice 9678 * @since 12 9679 */ 9680 DST_OVER = 5, 9681 /** 9682 * r = s * da 9683 * 9684 * @syscap SystemCapability.ArkUI.ArkUI.Full 9685 * @crossplatform 9686 * @form 9687 * @since 11 9688 */ 9689 /** 9690 * r = s * da 9691 * 9692 * @syscap SystemCapability.ArkUI.ArkUI.Full 9693 * @crossplatform 9694 * @form 9695 * @atomicservice 9696 * @since 12 9697 */ 9698 SRC_IN = 6, 9699 /** 9700 * r = d * sa 9701 * 9702 * @syscap SystemCapability.ArkUI.ArkUI.Full 9703 * @crossplatform 9704 * @form 9705 * @since 11 9706 */ 9707 /** 9708 * r = d * sa 9709 * 9710 * @syscap SystemCapability.ArkUI.ArkUI.Full 9711 * @crossplatform 9712 * @form 9713 * @atomicservice 9714 * @since 12 9715 */ 9716 DST_IN = 7, 9717 /** 9718 * r = s * (1 - da) 9719 * 9720 * @syscap SystemCapability.ArkUI.ArkUI.Full 9721 * @crossplatform 9722 * @form 9723 * @since 11 9724 */ 9725 /** 9726 * r = s * (1 - da) 9727 * 9728 * @syscap SystemCapability.ArkUI.ArkUI.Full 9729 * @crossplatform 9730 * @form 9731 * @atomicservice 9732 * @since 12 9733 */ 9734 SRC_OUT = 8, 9735 /** 9736 * r = d * (1 - sa) 9737 * 9738 * @syscap SystemCapability.ArkUI.ArkUI.Full 9739 * @crossplatform 9740 * @form 9741 * @since 11 9742 */ 9743 /** 9744 * r = d * (1 - sa) 9745 * 9746 * @syscap SystemCapability.ArkUI.ArkUI.Full 9747 * @crossplatform 9748 * @form 9749 * @atomicservice 9750 * @since 12 9751 */ 9752 DST_OUT = 9, 9753 /** 9754 * r = s * da + d * (1 - sa) 9755 * 9756 * @syscap SystemCapability.ArkUI.ArkUI.Full 9757 * @crossplatform 9758 * @form 9759 * @since 11 9760 */ 9761 /** 9762 * r = s * da + d * (1 - sa) 9763 * 9764 * @syscap SystemCapability.ArkUI.ArkUI.Full 9765 * @crossplatform 9766 * @form 9767 * @atomicservice 9768 * @since 12 9769 */ 9770 SRC_ATOP = 10, 9771 /** 9772 * r = d * sa + s * (1 - da) 9773 * 9774 * @syscap SystemCapability.ArkUI.ArkUI.Full 9775 * @crossplatform 9776 * @form 9777 * @since 11 9778 */ 9779 /** 9780 * r = d * sa + s * (1 - da) 9781 * 9782 * @syscap SystemCapability.ArkUI.ArkUI.Full 9783 * @crossplatform 9784 * @form 9785 * @atomicservice 9786 * @since 12 9787 */ 9788 DST_ATOP = 11, 9789 /** 9790 * r = s * (1 - da) + d * (1 - sa) 9791 * 9792 * @syscap SystemCapability.ArkUI.ArkUI.Full 9793 * @crossplatform 9794 * @form 9795 * @since 11 9796 */ 9797 /** 9798 * r = s * (1 - da) + d * (1 - sa) 9799 * 9800 * @syscap SystemCapability.ArkUI.ArkUI.Full 9801 * @crossplatform 9802 * @form 9803 * @atomicservice 9804 * @since 12 9805 */ 9806 XOR = 12, 9807 /** 9808 * r = min(s + d, 1) 9809 * 9810 * @syscap SystemCapability.ArkUI.ArkUI.Full 9811 * @crossplatform 9812 * @form 9813 * @since 11 9814 */ 9815 /** 9816 * r = min(s + d, 1) 9817 * 9818 * @syscap SystemCapability.ArkUI.ArkUI.Full 9819 * @crossplatform 9820 * @form 9821 * @atomicservice 9822 * @since 12 9823 */ 9824 PLUS = 13, 9825 /** 9826 * r = s * d 9827 * 9828 * @syscap SystemCapability.ArkUI.ArkUI.Full 9829 * @crossplatform 9830 * @form 9831 * @since 11 9832 */ 9833 /** 9834 * r = s * d 9835 * 9836 * @syscap SystemCapability.ArkUI.ArkUI.Full 9837 * @crossplatform 9838 * @form 9839 * @atomicservice 9840 * @since 12 9841 */ 9842 MODULATE = 14, 9843 /** 9844 * r = s + d - s * d 9845 * 9846 * @syscap SystemCapability.ArkUI.ArkUI.Full 9847 * @crossplatform 9848 * @form 9849 * @since 11 9850 */ 9851 /** 9852 * r = s + d - s * d 9853 * 9854 * @syscap SystemCapability.ArkUI.ArkUI.Full 9855 * @crossplatform 9856 * @form 9857 * @atomicservice 9858 * @since 12 9859 */ 9860 SCREEN = 15, 9861 /** 9862 * multiply or screen, depending on destination 9863 * 9864 * @syscap SystemCapability.ArkUI.ArkUI.Full 9865 * @crossplatform 9866 * @form 9867 * @since 11 9868 */ 9869 /** 9870 * multiply or screen, depending on destination 9871 * 9872 * @syscap SystemCapability.ArkUI.ArkUI.Full 9873 * @crossplatform 9874 * @form 9875 * @atomicservice 9876 * @since 12 9877 */ 9878 OVERLAY = 16, 9879 /** 9880 * rc = s + d - max(s * da, d * sa), ra = kSrcOver 9881 * 9882 * @syscap SystemCapability.ArkUI.ArkUI.Full 9883 * @crossplatform 9884 * @form 9885 * @since 11 9886 */ 9887 /** 9888 * rc = s + d - max(s * da, d * sa), ra = kSrcOver 9889 * 9890 * @syscap SystemCapability.ArkUI.ArkUI.Full 9891 * @crossplatform 9892 * @form 9893 * @atomicservice 9894 * @since 12 9895 */ 9896 DARKEN = 17, 9897 /** 9898 * rc = s + d - min(s * da, d * sa), ra = kSrcOver 9899 * 9900 * @syscap SystemCapability.ArkUI.ArkUI.Full 9901 * @crossplatform 9902 * @form 9903 * @since 11 9904 */ 9905 /** 9906 * rc = s + d - min(s * da, d * sa), ra = kSrcOver 9907 * 9908 * @syscap SystemCapability.ArkUI.ArkUI.Full 9909 * @crossplatform 9910 * @form 9911 * @atomicservice 9912 * @since 12 9913 */ 9914 LIGHTEN = 18, 9915 /** 9916 * brighten destination to reflect source 9917 * 9918 * @syscap SystemCapability.ArkUI.ArkUI.Full 9919 * @crossplatform 9920 * @form 9921 * @since 11 9922 */ 9923 /** 9924 * brighten destination to reflect source 9925 * 9926 * @syscap SystemCapability.ArkUI.ArkUI.Full 9927 * @crossplatform 9928 * @form 9929 * @atomicservice 9930 * @since 12 9931 */ 9932 COLOR_DODGE = 19, 9933 /** 9934 * darken destination to reflect source 9935 * 9936 * @syscap SystemCapability.ArkUI.ArkUI.Full 9937 * @crossplatform 9938 * @form 9939 * @since 11 9940 */ 9941 /** 9942 * darken destination to reflect source 9943 * 9944 * @syscap SystemCapability.ArkUI.ArkUI.Full 9945 * @crossplatform 9946 * @form 9947 * @atomicservice 9948 * @since 12 9949 */ 9950 COLOR_BURN = 20, 9951 /** 9952 * multiply or screen, depending on source 9953 * 9954 * @syscap SystemCapability.ArkUI.ArkUI.Full 9955 * @crossplatform 9956 * @form 9957 * @since 11 9958 */ 9959 /** 9960 * multiply or screen, depending on source 9961 * 9962 * @syscap SystemCapability.ArkUI.ArkUI.Full 9963 * @crossplatform 9964 * @form 9965 * @atomicservice 9966 * @since 12 9967 */ 9968 HARD_LIGHT = 21, 9969 /** 9970 * lighten or darken, depending on source 9971 * 9972 * @syscap SystemCapability.ArkUI.ArkUI.Full 9973 * @crossplatform 9974 * @form 9975 * @since 11 9976 */ 9977 /** 9978 * lighten or darken, depending on source 9979 * 9980 * @syscap SystemCapability.ArkUI.ArkUI.Full 9981 * @crossplatform 9982 * @form 9983 * @atomicservice 9984 * @since 12 9985 */ 9986 SOFT_LIGHT = 22, 9987 /** 9988 * rc = s + d - 2 * (min(s * da, d * sa)), ra = kSrcOver 9989 * 9990 * @syscap SystemCapability.ArkUI.ArkUI.Full 9991 * @crossplatform 9992 * @form 9993 * @since 11 9994 */ 9995 /** 9996 * rc = s + d - 2 * (min(s * da, d * sa)), ra = kSrcOver 9997 * 9998 * @syscap SystemCapability.ArkUI.ArkUI.Full 9999 * @crossplatform 10000 * @form 10001 * @atomicservice 10002 * @since 12 10003 */ 10004 DIFFERENCE = 23, 10005 /** 10006 * rc = s + d - two(s * d), ra = kSrcOver 10007 * 10008 * @syscap SystemCapability.ArkUI.ArkUI.Full 10009 * @crossplatform 10010 * @form 10011 * @since 11 10012 */ 10013 /** 10014 * rc = s + d - two(s * d), ra = kSrcOver 10015 * 10016 * @syscap SystemCapability.ArkUI.ArkUI.Full 10017 * @crossplatform 10018 * @form 10019 * @atomicservice 10020 * @since 12 10021 */ 10022 EXCLUSION = 24, 10023 /** 10024 * r = s * (1 - da) + d * (1 - sa) + s * d 10025 * 10026 * @syscap SystemCapability.ArkUI.ArkUI.Full 10027 * @crossplatform 10028 * @form 10029 * @since 11 10030 */ 10031 /** 10032 * r = s * (1 - da) + d * (1 - sa) + s * d 10033 * 10034 * @syscap SystemCapability.ArkUI.ArkUI.Full 10035 * @crossplatform 10036 * @form 10037 * @atomicservice 10038 * @since 12 10039 */ 10040 MULTIPLY = 25, 10041 /** 10042 * hue of source with saturation and luminosity of destination 10043 * 10044 * @syscap SystemCapability.ArkUI.ArkUI.Full 10045 * @crossplatform 10046 * @form 10047 * @since 11 10048 */ 10049 /** 10050 * hue of source with saturation and luminosity of destination 10051 * 10052 * @syscap SystemCapability.ArkUI.ArkUI.Full 10053 * @crossplatform 10054 * @form 10055 * @atomicservice 10056 * @since 12 10057 */ 10058 HUE = 26, 10059 /** 10060 * saturation of source with hue and luminosity of destination 10061 * 10062 * @syscap SystemCapability.ArkUI.ArkUI.Full 10063 * @crossplatform 10064 * @form 10065 * @since 11 10066 */ 10067 /** 10068 * saturation of source with hue and luminosity of destination 10069 * 10070 * @syscap SystemCapability.ArkUI.ArkUI.Full 10071 * @crossplatform 10072 * @form 10073 * @atomicservice 10074 * @since 12 10075 */ 10076 SATURATION = 27, 10077 /** 10078 * hue and saturation of source with luminosity of destination 10079 * 10080 * @syscap SystemCapability.ArkUI.ArkUI.Full 10081 * @crossplatform 10082 * @form 10083 * @since 11 10084 */ 10085 /** 10086 * hue and saturation of source with luminosity of destination 10087 * 10088 * @syscap SystemCapability.ArkUI.ArkUI.Full 10089 * @crossplatform 10090 * @form 10091 * @atomicservice 10092 * @since 12 10093 */ 10094 COLOR = 28, 10095 /** 10096 * luminosity of source with hue and saturation of destination 10097 * 10098 * @syscap SystemCapability.ArkUI.ArkUI.Full 10099 * @crossplatform 10100 * @form 10101 * @since 11 10102 */ 10103 /** 10104 * luminosity of source with hue and saturation of destination 10105 * 10106 * @syscap SystemCapability.ArkUI.ArkUI.Full 10107 * @crossplatform 10108 * @form 10109 * @atomicservice 10110 * @since 12 10111 */ 10112 LUMINOSITY = 29 10113} 10114 10115/** 10116 * Enum for BlendApplyType. 10117 * Indicate how to apply specified blend mode to 10118 * the view's content. 10119 * 10120 * @enum { number } 10121 * @syscap SystemCapability.ArkUI.ArkUI.Full 10122 * @crossplatform 10123 * @form 10124 * @since 11 10125 */ 10126/** 10127 * Enum for BlendApplyType. 10128 * Indicate how to apply specified blend mode to 10129 * the view's content. 10130 * 10131 * @enum { number } 10132 * @syscap SystemCapability.ArkUI.ArkUI.Full 10133 * @crossplatform 10134 * @form 10135 * @atomicservice 10136 * @since 12 10137 */ 10138declare enum BlendApplyType { 10139 /** 10140 * Blend view's content in sequence over dst 10141 * 10142 * @syscap SystemCapability.ArkUI.ArkUI.Full 10143 * @crossplatform 10144 * @form 10145 * @since 11 10146 */ 10147 /** 10148 * Blend view's content in sequence over dst 10149 * 10150 * @syscap SystemCapability.ArkUI.ArkUI.Full 10151 * @crossplatform 10152 * @form 10153 * @atomicservice 10154 * @since 12 10155 */ 10156 FAST = 0, 10157 10158 /** 10159 * Composite this views's contents into an 10160 * offscreen image and then blend over dst 10161 * 10162 * @syscap SystemCapability.ArkUI.ArkUI.Full 10163 * @crossplatform 10164 * @form 10165 * @since 11 10166 */ 10167 /** 10168 * Composite this views's contents into an 10169 * offscreen image and then blend over dst 10170 * 10171 * @syscap SystemCapability.ArkUI.ArkUI.Full 10172 * @crossplatform 10173 * @form 10174 * @atomicservice 10175 * @since 12 10176 */ 10177 OFFSCREEN = 1, 10178} 10179 10180/** 10181 * DragEvent object description 10182 * 10183 * @interface DragEvent 10184 * @syscap SystemCapability.ArkUI.ArkUI.Full 10185 * @since 7 10186 */ 10187/** 10188 * DragEvent object description 10189 * 10190 * @interface DragEvent 10191 * @syscap SystemCapability.ArkUI.ArkUI.Full 10192 * @atomicservice 10193 * @since 11 10194 */ 10195/** 10196 * DragEvent object description 10197 * 10198 * @interface DragEvent 10199 * @syscap SystemCapability.ArkUI.ArkUI.Full 10200 * @crossplatform 10201 * @atomicservice 10202 * @since 14 10203 */ 10204declare interface DragEvent { 10205 /** 10206 * X coordinate of the touch point relative to the left edge of the device screen. 10207 * 10208 * @returns { number } 10209 * @syscap SystemCapability.ArkUI.ArkUI.Full 10210 * @since 10 10211 */ 10212 /** 10213 * X coordinate of the touch point relative to the left edge of the device screen. 10214 * 10215 * @returns { number } 10216 * @syscap SystemCapability.ArkUI.ArkUI.Full 10217 * @atomicservice 10218 * @since 11 10219 */ 10220 /** 10221 * X coordinate of the touch point relative to the left edge of the device screen. 10222 * 10223 * @returns { number } 10224 * @syscap SystemCapability.ArkUI.ArkUI.Full 10225 * @crossplatform 10226 * @atomicservice 10227 * @since 14 10228 */ 10229 getDisplayX(): number; 10230 10231 /** 10232 * Y coordinate of the touch point relative to the upper edge of the device screen. 10233 * 10234 * @returns { number } 10235 * @syscap SystemCapability.ArkUI.ArkUI.Full 10236 * @since 10 10237 */ 10238 /** 10239 * Y coordinate of the touch point relative to the upper edge of the device screen. 10240 * 10241 * @returns { number } 10242 * @syscap SystemCapability.ArkUI.ArkUI.Full 10243 * @atomicservice 10244 * @since 11 10245 */ 10246 /** 10247 * Y coordinate of the touch point relative to the upper edge of the device screen. 10248 * 10249 * @returns { number } 10250 * @syscap SystemCapability.ArkUI.ArkUI.Full 10251 * @crossplatform 10252 * @atomicservice 10253 * @since 14 10254 */ 10255 getDisplayY(): number; 10256 10257 /** 10258 * X coordinate of the touch point relative to the left edge of the current window. 10259 * 10260 * @returns { number } 10261 * @syscap SystemCapability.ArkUI.ArkUI.Full 10262 * @since 10 10263 */ 10264 /** 10265 * X coordinate of the touch point relative to the left edge of the current window. 10266 * 10267 * @returns { number } 10268 * @syscap SystemCapability.ArkUI.ArkUI.Full 10269 * @atomicservice 10270 * @since 11 10271 */ 10272 /** 10273 * X coordinate of the touch point relative to the left edge of the current window. 10274 * 10275 * @returns { number } 10276 * @syscap SystemCapability.ArkUI.ArkUI.Full 10277 * @crossplatform 10278 * @atomicservice 10279 * @since 14 10280 */ 10281 getWindowX(): number; 10282 10283 /** 10284 * Y coordinate of the touch point relative to the left edge of the current window. 10285 * 10286 * @returns { number } 10287 * @syscap SystemCapability.ArkUI.ArkUI.Full 10288 * @since 10 10289 */ 10290 /** 10291 * Y coordinate of the touch point relative to the left edge of the current window. 10292 * 10293 * @returns { number } 10294 * @syscap SystemCapability.ArkUI.ArkUI.Full 10295 * @atomicservice 10296 * @since 11 10297 */ 10298 /** 10299 * Y coordinate of the touch point relative to the left edge of the current window. 10300 * 10301 * @returns { number } 10302 * @syscap SystemCapability.ArkUI.ArkUI.Full 10303 * @crossplatform 10304 * @atomicservice 10305 * @since 14 10306 */ 10307 getWindowY(): number; 10308 10309 /** 10310 * X coordinate of the touch point relative to the left edge of the current window. in vp. 10311 * 10312 * @returns { number } 10313 * @syscap SystemCapability.ArkUI.ArkUI.Full 10314 * @since 7 10315 * @deprecated since 10 10316 * @useinstead DragEvent#getWindowX 10317 */ 10318 getX(): number; 10319 10320 /** 10321 * Y coordinate of the touch point relative to the left edge of the current window. in vp. 10322 * 10323 * @returns { number } 10324 * @syscap SystemCapability.ArkUI.ArkUI.Full 10325 * @since 7 10326 * @deprecated since 10 10327 * @useinstead DragEvent#getWindowY 10328 */ 10329 getY(): number; 10330 10331 /** 10332 * If copy is COPY, this DragEvent is a copy event. 10333 * @type { DragBehavior } Operation, if use copy then set COPY, else set MOVE. 10334 * @default COPY 10335 * @syscap SystemCapability.ArkUI.ArkUI.Full 10336 * @since 10 10337 */ 10338 /** 10339 * If copy is COPY, this DragEvent is a copy event. 10340 * @type { DragBehavior } Operation, if use copy then set COPY, else set MOVE. 10341 * @default COPY 10342 * @syscap SystemCapability.ArkUI.ArkUI.Full 10343 * @atomicservice 10344 * @since 11 10345 */ 10346 dragBehavior: DragBehavior; 10347 10348 /** 10349 * If useCustomDropAnimation is true, System will not use drop animation. 10350 * 10351 * @type { boolean } 10352 * @syscap SystemCapability.ArkUI.ArkUI.Full 10353 * @since 10 10354 */ 10355 /** 10356 * If useCustomDropAnimation is true, System will not use drop animation. 10357 * 10358 * @type { boolean } 10359 * @syscap SystemCapability.ArkUI.ArkUI.Full 10360 * @atomicservice 10361 * @since 11 10362 */ 10363 useCustomDropAnimation: boolean; 10364 10365 /** 10366 * Set dragData into DragEvent. 10367 * 10368 * @param { UnifiedData } unifiedData - dragData. 10369 * @syscap SystemCapability.ArkUI.ArkUI.Full 10370 * @crossplatform 10371 * @since 10 10372 */ 10373 /** 10374 * Set dragData into DragEvent. 10375 * 10376 * @param { UnifiedData } unifiedData - dragData. 10377 * @syscap SystemCapability.ArkUI.ArkUI.Full 10378 * @crossplatform 10379 * @atomicservice 10380 * @since 11 10381 */ 10382 setData(unifiedData: UnifiedData): void; 10383 10384 /** 10385 * Get dragData from DragEvent. 10386 * 10387 * @returns { UnifiedData } - get dragData. 10388 * @throws { BusinessError } 190001 - Data not found. 10389 * @throws { BusinessError } 190002 - Data error. 10390 * @syscap SystemCapability.ArkUI.ArkUI.Full 10391 * @crossplatform 10392 * @since 10 10393 */ 10394 /** 10395 * Get dragData from DragEvent. 10396 * 10397 * @returns { UnifiedData } - get dragData. 10398 * @throws { BusinessError } 190001 - Data not found. 10399 * @throws { BusinessError } 190002 - Data error. 10400 * @syscap SystemCapability.ArkUI.ArkUI.Full 10401 * @crossplatform 10402 * @atomicservice 10403 * @since 11 10404 */ 10405 getData(): UnifiedData; 10406 10407 /** 10408 * Get dragData summary from DragEvent. 10409 * 10410 * @returns { Summary } - get Summary Data. 10411 * @syscap SystemCapability.ArkUI.ArkUI.Full 10412 * @crossplatform 10413 * @since 10 10414 */ 10415 /** 10416 * Get dragData summary from DragEvent. 10417 * 10418 * @returns { Summary } - get Summary Data. 10419 * @syscap SystemCapability.ArkUI.ArkUI.Full 10420 * @crossplatform 10421 * @atomicservice 10422 * @since 11 10423 */ 10424 getSummary(): Summary; 10425 10426 /** 10427 * Set dragEvent result to DragEvent. 10428 * 10429 * @param { DragResult } dragResult - the return of dragEvent. 10430 * @syscap SystemCapability.ArkUI.ArkUI.Full 10431 * @since 10 10432 */ 10433 /** 10434 * Set dragEvent result to DragEvent. 10435 * 10436 * @param { DragResult } dragResult - the return of dragEvent. 10437 * @syscap SystemCapability.ArkUI.ArkUI.Full 10438 * @atomicservice 10439 * @since 11 10440 */ 10441 /** 10442 * Set dragEvent result to DragEvent. 10443 * 10444 * @param { DragResult } dragResult - the return of dragEvent. 10445 * @syscap SystemCapability.ArkUI.ArkUI.Full 10446 * @crossplatform 10447 * @atomicservice 10448 * @since 14 10449 */ 10450 setResult(dragResult: DragResult): void; 10451 10452 /** 10453 * Get dragEvent result from DragEvent. 10454 * 10455 * @returns { DragResult } - dragResult Data. 10456 * @syscap SystemCapability.ArkUI.ArkUI.Full 10457 * @since 10 10458 */ 10459 /** 10460 * Get dragEvent result from DragEvent. 10461 * 10462 * @returns { DragResult } - dragResult Data. 10463 * @syscap SystemCapability.ArkUI.ArkUI.Full 10464 * @atomicservice 10465 * @since 11 10466 */ 10467 /** 10468 * Get dragEvent result from DragEvent. 10469 * 10470 * @returns { DragResult } - dragResult Data. 10471 * @syscap SystemCapability.ArkUI.ArkUI.Full 10472 * @crossplatform 10473 * @atomicservice 10474 * @since 14 10475 */ 10476 getResult(): DragResult; 10477 10478 /** 10479 * Get the rectangle of drag window. 10480 * 10481 * @returns { Rectangle } - getPreview rectangle. 10482 * @syscap SystemCapability.ArkUI.ArkUI.Full 10483 * @since 10 10484 */ 10485 /** 10486 * Get the rectangle of drag window. 10487 * 10488 * @returns { Rectangle } - getPreview rectangle. 10489 * @syscap SystemCapability.ArkUI.ArkUI.Full 10490 * @atomicservice 10491 * @since 11 10492 */ 10493 /** 10494 * Get the rectangle of drag window. 10495 * 10496 * @returns { Rectangle } - getPreview rectangle. 10497 * @syscap SystemCapability.ArkUI.ArkUI.Full 10498 * @crossplatform 10499 * @atomicservice 10500 * @since 14 10501 */ 10502 getPreviewRect(): Rectangle; 10503 10504 /** 10505 * Get the x axis velocity of drag gesture. 10506 * 10507 * @returns { number } - get x axis velocity. 10508 * @syscap SystemCapability.ArkUI.ArkUI.Full 10509 * @crossplatform 10510 * @since 10 10511 */ 10512 /** 10513 * Get the x axis velocity of drag gesture. 10514 * 10515 * @returns { number } - get x axis velocity. 10516 * @syscap SystemCapability.ArkUI.ArkUI.Full 10517 * @crossplatform 10518 * @atomicservice 10519 * @since 11 10520 */ 10521 getVelocityX(): number; 10522 10523 /** 10524 * Get the y axis velocity of drag gesture. 10525 * 10526 * @returns { number } - get y axis velocity. 10527 * @syscap SystemCapability.ArkUI.ArkUI.Full 10528 * @crossplatform 10529 * @since 10 10530 */ 10531 /** 10532 * Get the y axis velocity of drag gesture. 10533 * 10534 * @returns { number } - get y axis velocity. 10535 * @syscap SystemCapability.ArkUI.ArkUI.Full 10536 * @crossplatform 10537 * @atomicservice 10538 * @since 11 10539 */ 10540 getVelocityY(): number; 10541 10542 /** 10543 * Get the velocity of drag gesture. 10544 * 10545 * @returns { number } - get velocity. 10546 * @syscap SystemCapability.ArkUI.ArkUI.Full 10547 * @crossplatform 10548 * @since 10 10549 */ 10550 /** 10551 * Get the velocity of drag gesture. 10552 * 10553 * @returns { number } - get velocity. 10554 * @syscap SystemCapability.ArkUI.ArkUI.Full 10555 * @crossplatform 10556 * @atomicservice 10557 * @since 11 10558 */ 10559 getVelocity(): number; 10560 10561 /** 10562 * Query the ModifierKey press state, support 'ctrl'|'alt'|'shift'|'fn' 10563 * 10564 * @param { Array<string> } keys - indicate the keys of the ModifierKey. 10565 * @returns { boolean } 10566 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 10567 * @syscap SystemCapability.ArkUI.ArkUI.Full 10568 * @crossplatform 10569 * @since 12 10570 */ 10571 /** 10572 * Query the ModifierKey press state, support 'ctrl'|'alt'|'shift'|'fn' 10573 * 10574 * @param { Array<string> } keys - indicate the keys of the ModifierKey. 10575 * @returns { boolean } 10576 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 10577 * @syscap SystemCapability.ArkUI.ArkUI.Full 10578 * @crossplatform 10579 * @atomicservice 10580 * @since 13 10581 */ 10582 getModifierKeyState?(keys: Array<string>): boolean; 10583} 10584 10585/** 10586 * Import the IntentionCode type object for IntentionCode. 10587 * 10588 * @typedef { import('../api/@ohos.multimodalInput.intentionCode').IntentionCode } IntentionCode 10589 * @syscap SystemCapability.ArkUI.ArkUI.Full 10590 * @since 10 10591 */ 10592/** 10593 * Import the IntentionCode type object for IntentionCode. 10594 * 10595 * @typedef { import('../api/@ohos.multimodalInput.intentionCode').IntentionCode } IntentionCode 10596 * @syscap SystemCapability.ArkUI.ArkUI.Full 10597 * @atomicservice 10598 * @since 11 10599 */ 10600declare type IntentionCode = import('../api/@ohos.multimodalInput.intentionCode').IntentionCode; 10601 10602/** 10603 * KeyEvent object description: 10604 * 10605 * @interface KeyEvent 10606 * @syscap SystemCapability.ArkUI.ArkUI.Full 10607 * @since 7 10608 */ 10609/** 10610 * KeyEvent object description: 10611 * 10612 * @interface KeyEvent 10613 * @syscap SystemCapability.ArkUI.ArkUI.Full 10614 * @crossplatform 10615 * @since 10 10616 */ 10617/** 10618 * KeyEvent object description: 10619 * 10620 * @interface KeyEvent 10621 * @syscap SystemCapability.ArkUI.ArkUI.Full 10622 * @crossplatform 10623 * @atomicservice 10624 * @since 11 10625 */ 10626declare interface KeyEvent { 10627 /** 10628 * Type of a key. 10629 * 10630 * @type { KeyType } 10631 * @syscap SystemCapability.ArkUI.ArkUI.Full 10632 * @since 7 10633 */ 10634 /** 10635 * Type of a key. 10636 * 10637 * @type { KeyType } 10638 * @syscap SystemCapability.ArkUI.ArkUI.Full 10639 * @crossplatform 10640 * @since 10 10641 */ 10642 /** 10643 * Type of a key. 10644 * 10645 * @type { KeyType } 10646 * @syscap SystemCapability.ArkUI.ArkUI.Full 10647 * @crossplatform 10648 * @atomicservice 10649 * @since 11 10650 */ 10651 type: KeyType; 10652 10653 /** 10654 * Key code of a key 10655 * 10656 * @type { number } 10657 * @syscap SystemCapability.ArkUI.ArkUI.Full 10658 * @since 7 10659 */ 10660 /** 10661 * Key code of a key 10662 * 10663 * @type { number } 10664 * @syscap SystemCapability.ArkUI.ArkUI.Full 10665 * @crossplatform 10666 * @since 10 10667 */ 10668 /** 10669 * Key code of a key 10670 * 10671 * @type { number } 10672 * @syscap SystemCapability.ArkUI.ArkUI.Full 10673 * @crossplatform 10674 * @atomicservice 10675 * @since 11 10676 */ 10677 keyCode: number; 10678 10679 /** 10680 * Key value of a key. 10681 * 10682 * @type { string } 10683 * @syscap SystemCapability.ArkUI.ArkUI.Full 10684 * @since 7 10685 */ 10686 /** 10687 * Key value of a key. 10688 * 10689 * @type { string } 10690 * @syscap SystemCapability.ArkUI.ArkUI.Full 10691 * @crossplatform 10692 * @since 10 10693 */ 10694 /** 10695 * Key value of a key. 10696 * 10697 * @type { string } 10698 * @syscap SystemCapability.ArkUI.ArkUI.Full 10699 * @crossplatform 10700 * @atomicservice 10701 * @since 11 10702 */ 10703 keyText: string; 10704 10705 /** 10706 * Type of the input device that triggers the current key, such as the keyboard or handle. 10707 * 10708 * @type { KeySource } 10709 * @syscap SystemCapability.ArkUI.ArkUI.Full 10710 * @since 7 10711 */ 10712 /** 10713 * Type of the input device that triggers the current key, such as the keyboard or handle. 10714 * 10715 * @type { KeySource } 10716 * @syscap SystemCapability.ArkUI.ArkUI.Full 10717 * @crossplatform 10718 * @since 10 10719 */ 10720 /** 10721 * Type of the input device that triggers the current key, such as the keyboard or handle. 10722 * 10723 * @type { KeySource } 10724 * @syscap SystemCapability.ArkUI.ArkUI.Full 10725 * @crossplatform 10726 * @atomicservice 10727 * @since 11 10728 */ 10729 keySource: KeySource; 10730 10731 /** 10732 * Indicates the ID of the input device that triggers the current key. 10733 * 10734 * @type { number } 10735 * @syscap SystemCapability.ArkUI.ArkUI.Full 10736 * @since 7 10737 */ 10738 /** 10739 * Indicates the ID of the input device that triggers the current key. 10740 * 10741 * @type { number } 10742 * @syscap SystemCapability.ArkUI.ArkUI.Full 10743 * @crossplatform 10744 * @since 10 10745 */ 10746 /** 10747 * Indicates the ID of the input device that triggers the current key. 10748 * 10749 * @type { number } 10750 * @syscap SystemCapability.ArkUI.ArkUI.Full 10751 * @crossplatform 10752 * @atomicservice 10753 * @since 11 10754 */ 10755 deviceId: number; 10756 10757 /** 10758 * Indicates the status of the key when the key is pressed. 10759 * The value 1 indicates the pressed state, and the value 0 indicates the unpressed state. 10760 * 10761 * @type { number } 10762 * @syscap SystemCapability.ArkUI.ArkUI.Full 10763 * @since 7 10764 */ 10765 /** 10766 * Indicates the status of the key when the key is pressed. 10767 * The value 1 indicates the pressed state, and the value 0 indicates the unpressed state. 10768 * 10769 * @type { number } 10770 * @syscap SystemCapability.ArkUI.ArkUI.Full 10771 * @crossplatform 10772 * @since 10 10773 */ 10774 /** 10775 * Indicates the status of the key when the key is pressed. 10776 * The value 1 indicates the pressed state, and the value 0 indicates the unpressed state. 10777 * 10778 * @type { number } 10779 * @syscap SystemCapability.ArkUI.ArkUI.Full 10780 * @crossplatform 10781 * @atomicservice 10782 * @since 11 10783 */ 10784 metaKey: number; 10785 10786 /** 10787 * Timestamp when the key was pressed. 10788 * 10789 * @type { number } 10790 * @syscap SystemCapability.ArkUI.ArkUI.Full 10791 * @since 7 10792 */ 10793 /** 10794 * Timestamp when the key was pressed. 10795 * 10796 * @type { number } 10797 * @syscap SystemCapability.ArkUI.ArkUI.Full 10798 * @crossplatform 10799 * @since 10 10800 */ 10801 /** 10802 * Timestamp when the key was pressed. 10803 * 10804 * @type { number } 10805 * @syscap SystemCapability.ArkUI.ArkUI.Full 10806 * @crossplatform 10807 * @atomicservice 10808 * @since 11 10809 */ 10810 timestamp: number; 10811 10812 /** 10813 * Block event bubbling. 10814 * 10815 * @type { function } 10816 * @syscap SystemCapability.ArkUI.ArkUI.Full 10817 * @since 7 10818 */ 10819 /** 10820 * Block event bubbling. 10821 * 10822 * @type { function } 10823 * @syscap SystemCapability.ArkUI.ArkUI.Full 10824 * @crossplatform 10825 * @since 10 10826 */ 10827 /** 10828 * Block event bubbling. 10829 * 10830 * @type { function } 10831 * @syscap SystemCapability.ArkUI.ArkUI.Full 10832 * @crossplatform 10833 * @atomicservice 10834 * @since 11 10835 */ 10836 stopPropagation: () => void; 10837 10838 /** 10839 * Intention code of a key or modifier keys. 10840 * 10841 * @type { IntentionCode } 10842 * @default IntentionCode.INTENTION_UNKNOWN 10843 * @syscap SystemCapability.ArkUI.ArkUI.Full 10844 * @since 10 10845 */ 10846 /** 10847 * Intention code of a key or modifier keys. 10848 * 10849 * @type { IntentionCode } 10850 * @default IntentionCode.INTENTION_UNKNOWN 10851 * @syscap SystemCapability.ArkUI.ArkUI.Full 10852 * @atomicservice 10853 * @since 11 10854 */ 10855 intentionCode: IntentionCode; 10856 10857 /** 10858 * Get the modifier keys press state, support 'ctrl'|'alt'|'shift'|'fn' 10859 * 10860 * @param { Array<string> } keys - indicate the modifier keys. 10861 * @returns { boolean } 10862 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 10863 * @syscap SystemCapability.ArkUI.ArkUI.Full 10864 * @crossplatform 10865 * @since 12 10866 */ 10867 /** 10868 * Get the modifier keys press state, support 'ctrl'|'alt'|'shift'|'fn' 10869 * 10870 * @param { Array<string> } keys - indicate the modifier keys. 10871 * @returns { boolean } 10872 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 10873 * @syscap SystemCapability.ArkUI.ArkUI.Full 10874 * @crossplatform 10875 * @atomicservice 10876 * @since 13 10877 */ 10878 getModifierKeyState?(keys: Array<string>): boolean; 10879 10880 /** 10881 * Unicode of a key 10882 * 10883 * @type { ?number } 10884 * @syscap SystemCapability.ArkUI.ArkUI.Full 10885 * @atomicservice 10886 * @since 14 10887 */ 10888 unicode?: number; 10889} 10890 10891/** 10892 * Overlay module options 10893 * 10894 * @interface BindOptions 10895 * @syscap SystemCapability.ArkUI.ArkUI.Full 10896 * @crossplatform 10897 * @since 10 10898 */ 10899/** 10900 * Overlay module options 10901 * 10902 * @interface BindOptions 10903 * @syscap SystemCapability.ArkUI.ArkUI.Full 10904 * @crossplatform 10905 * @atomicservice 10906 * @since 11 10907 */ 10908declare interface BindOptions { 10909 /** 10910 * Defines the background color 10911 * 10912 * @type { ?ResourceColor } 10913 * @syscap SystemCapability.ArkUI.ArkUI.Full 10914 * @crossplatform 10915 * @since 10 10916 */ 10917 /** 10918 * Defines the background color 10919 * 10920 * @type { ?ResourceColor } 10921 * @syscap SystemCapability.ArkUI.ArkUI.Full 10922 * @crossplatform 10923 * @atomicservice 10924 * @since 11 10925 */ 10926 backgroundColor?: ResourceColor; 10927 10928 /** 10929 * Callback function when overlay interface appears 10930 * 10931 * @type { ?function } 10932 * @syscap SystemCapability.ArkUI.ArkUI.Full 10933 * @crossplatform 10934 * @since 10 10935 */ 10936 /** 10937 * Callback function when overlay interface appears 10938 * 10939 * @type { ?function } 10940 * @syscap SystemCapability.ArkUI.ArkUI.Full 10941 * @crossplatform 10942 * @atomicservice 10943 * @since 11 10944 */ 10945 onAppear?: () => void; 10946 10947 /** 10948 * Callback function when overlay interface exits 10949 * 10950 * @type { ?function } 10951 * @syscap SystemCapability.ArkUI.ArkUI.Full 10952 * @crossplatform 10953 * @since 10 10954 */ 10955 /** 10956 * Callback function when overlay interface exits 10957 * 10958 * @type { ?function } 10959 * @syscap SystemCapability.ArkUI.ArkUI.Full 10960 * @crossplatform 10961 * @atomicservice 10962 * @since 11 10963 */ 10964 onDisappear?: () => void; 10965 10966 /** 10967 * Callback function before overlay animation starts. 10968 * 10969 * @type { ?function } 10970 * @syscap SystemCapability.ArkUI.ArkUI.Full 10971 * @crossplatform 10972 * @atomicservice 10973 * @since 12 10974 */ 10975 onWillAppear?: () => void; 10976 10977 /** 10978 * Callback function before overlay popAnimation starts. 10979 * 10980 * @type { ?function } 10981 * @syscap SystemCapability.ArkUI.ArkUI.Full 10982 * @crossplatform 10983 * @atomicservice 10984 * @since 12 10985 */ 10986 onWillDisappear?: () => void; 10987} 10988 10989/** 10990 * Component content cover dismiss 10991 * 10992 * @interface DismissContentCoverAction 10993 * @syscap SystemCapability.ArkUI.ArkUI.Full 10994 * @crossplatform 10995 * @atomicservice 10996 * @since 12 10997 */ 10998declare interface DismissContentCoverAction { 10999 /** 11000 * Defines content cover dismiss function 11001 * 11002 * @type { Callback<void> } 11003 * @syscap SystemCapability.ArkUI.ArkUI.Full 11004 * @crossplatform 11005 * @atomicservice 11006 * @since 12 11007 */ 11008 dismiss: Callback<void>; 11009 11010 /** 11011 * Defines content cover dismiss reason 11012 * 11013 * @type { DismissReason } 11014 * @syscap SystemCapability.ArkUI.ArkUI.Full 11015 * @crossplatform 11016 * @atomicservice 11017 * @since 12 11018 */ 11019 reason: DismissReason; 11020} 11021 11022/** 11023 * Component content cover options 11024 * 11025 * @interface ContentCoverOptions 11026 * @syscap SystemCapability.ArkUI.ArkUI.Full 11027 * @crossplatform 11028 * @since 10 11029 */ 11030/** 11031 * Component content cover options 11032 * 11033 * @interface ContentCoverOptions 11034 * @syscap SystemCapability.ArkUI.ArkUI.Full 11035 * @crossplatform 11036 * @atomicservice 11037 * @since 11 11038 */ 11039declare interface ContentCoverOptions extends BindOptions { 11040 /** 11041 * Defines transition type 11042 * 11043 * @type { ?ModalTransition } 11044 * @default ModalTransition.Default 11045 * @syscap SystemCapability.ArkUI.ArkUI.Full 11046 * @crossplatform 11047 * @since 10 11048 */ 11049 /** 11050 * Defines transition type 11051 * 11052 * @type { ?ModalTransition } 11053 * @default ModalTransition.Default 11054 * @syscap SystemCapability.ArkUI.ArkUI.Full 11055 * @crossplatform 11056 * @atomicservice 11057 * @since 11 11058 */ 11059 modalTransition?: ModalTransition, 11060 11061 /** 11062 * Callback function when the content cover interactive dismiss 11063 * 11064 * @type { ?Callback<DismissContentCoverAction> } 11065 * @syscap SystemCapability.ArkUI.ArkUI.Full 11066 * @crossplatform 11067 * @atomicservice 11068 * @since 12 11069 */ 11070 onWillDismiss?: Callback<DismissContentCoverAction>; 11071 11072 /** 11073 * Defines transition effect param 11074 * 11075 * @type { ?TransitionEffect } 11076 * @syscap SystemCapability.ArkUI.ArkUI.Full 11077 * @crossplatform 11078 * @atomicservice 11079 * @since 12 11080 */ 11081 transition?: TransitionEffect; 11082} 11083 11084/** 11085 * Component sheet title options 11086 * 11087 * @interface SheetTitleOptions 11088 * @syscap SystemCapability.ArkUI.ArkUI.Full 11089 * @crossplatform 11090 * @since 11 11091 */ 11092/** 11093 * Component sheet title options 11094 * 11095 * @interface SheetTitleOptions 11096 * @syscap SystemCapability.ArkUI.ArkUI.Full 11097 * @crossplatform 11098 * @atomicservice 11099 * @since 12 11100 */ 11101declare interface SheetTitleOptions { 11102 /** 11103 * Defines title text 11104 * 11105 * @type { ResourceStr } 11106 * @syscap SystemCapability.ArkUI.ArkUI.Full 11107 * @crossplatform 11108 * @since 11 11109 */ 11110 /** 11111 * Defines title text 11112 * 11113 * @type { ResourceStr } 11114 * @syscap SystemCapability.ArkUI.ArkUI.Full 11115 * @crossplatform 11116 * @atomicservice 11117 * @since 12 11118 */ 11119 title: ResourceStr; 11120 11121 /** 11122 * Defines subtitle text 11123 * 11124 * @type { ?ResourceStr } 11125 * @syscap SystemCapability.ArkUI.ArkUI.Full 11126 * @crossplatform 11127 * @since 11 11128 */ 11129 /** 11130 * Defines subtitle text 11131 * 11132 * @type { ?ResourceStr } 11133 * @syscap SystemCapability.ArkUI.ArkUI.Full 11134 * @crossplatform 11135 * @atomicservice 11136 * @since 12 11137 */ 11138 subtitle?: ResourceStr; 11139} 11140 11141/** 11142 * Defines the sheet type. 11143 * 11144 * @enum { number } 11145 * @syscap SystemCapability.ArkUI.ArkUI.Full 11146 * @crossplatform 11147 * @since 11 11148 */ 11149/** 11150 * Defines the sheet type. 11151 * 11152 * @enum { number } 11153 * @syscap SystemCapability.ArkUI.ArkUI.Full 11154 * @crossplatform 11155 * @atomicservice 11156 * @since 12 11157 */ 11158declare enum SheetType { 11159 /** 11160 * Defines bottom sheet type. 11161 * 11162 * @syscap SystemCapability.ArkUI.ArkUI.Full 11163 * @crossplatform 11164 * @since 11 11165 */ 11166 /** 11167 * Defines bottom sheet type. 11168 * 11169 * @syscap SystemCapability.ArkUI.ArkUI.Full 11170 * @crossplatform 11171 * @atomicservice 11172 * @since 12 11173 */ 11174 BOTTOM = 0, 11175 11176 /** 11177 * Defines center sheet type. 11178 * 11179 * @syscap SystemCapability.ArkUI.ArkUI.Full 11180 * @crossplatform 11181 * @since 11 11182 */ 11183 /** 11184 * Defines center sheet type. 11185 * 11186 * @syscap SystemCapability.ArkUI.ArkUI.Full 11187 * @crossplatform 11188 * @atomicservice 11189 * @since 12 11190 */ 11191 CENTER = 1, 11192 11193 /** 11194 * Defines popup sheet type. 11195 * 11196 * @syscap SystemCapability.ArkUI.ArkUI.Full 11197 * @crossplatform 11198 * @since 11 11199 */ 11200 /** 11201 * Defines popup sheet type. 11202 * 11203 * @syscap SystemCapability.ArkUI.ArkUI.Full 11204 * @crossplatform 11205 * @atomicservice 11206 * @since 12 11207 */ 11208 POPUP = 2, 11209} 11210 11211/** 11212 * Define the display mode of the sheet. 11213 * 11214 * @enum { number } 11215 * @syscap SystemCapability.ArkUI.ArkUI.Full 11216 * @crossplatform 11217 * @atomicservice 11218 * @since 12 11219 */ 11220declare enum SheetMode { 11221 /** 11222 * Sheet displays above all page levels. 11223 * 11224 * @syscap SystemCapability.ArkUI.ArkUI.Full 11225 * @crossplatform 11226 * @atomicservice 11227 * @since 12 11228 */ 11229 OVERLAY = 0, 11230 11231 /** 11232 * Sheet displays within the current page. 11233 * 11234 * @syscap SystemCapability.ArkUI.ArkUI.Full 11235 * @crossplatform 11236 * @atomicservice 11237 * @since 12 11238 */ 11239 EMBEDDED = 1, 11240} 11241 11242/** 11243 * Define the scroll size mode of the sheet. 11244 * 11245 * @enum { number } 11246 * @syscap SystemCapability.ArkUI.ArkUI.Full 11247 * @crossplatform 11248 * @atomicservice 11249 * @since 12 11250 */ 11251declare enum ScrollSizeMode { 11252 /** 11253 * Sheet change scroll size after the slide ends. 11254 * 11255 * @syscap SystemCapability.ArkUI.ArkUI.Full 11256 * @crossplatform 11257 * @atomicservice 11258 * @since 12 11259 */ 11260 FOLLOW_DETENT = 0, 11261 11262 /** 11263 * Sheet change scroll size during the sliding process. 11264 * 11265 * @syscap SystemCapability.ArkUI.ArkUI.Full 11266 * @crossplatform 11267 * @atomicservice 11268 * @since 12 11269 */ 11270 CONTINUOUS = 1, 11271} 11272 11273/** 11274 * Define the mode of sheet how to avoid keyboard. 11275 * 11276 * @enum { number } 11277 * @syscap SystemCapability.ArkUI.ArkUI.Full 11278 * @crossplatform 11279 * @atomicservice 11280 * @since 13 11281 */ 11282declare enum SheetKeyboardAvoidMode { 11283 /** 11284 * Sheet will not aovid keyboard. 11285 * 11286 * @syscap SystemCapability.ArkUI.ArkUI.Full 11287 * @crossplatform 11288 * @atomicservice 11289 * @since 13 11290 */ 11291 NONE = 0, 11292 11293 /** 11294 * Firstly sheet will avoid keyboard by changing its height. 11295 * And then sheet will avoid by resizing after reaching its maximum height. 11296 * 11297 * @syscap SystemCapability.ArkUI.ArkUI.Full 11298 * @crossplatform 11299 * @atomicservice 11300 * @since 13 11301 */ 11302 TRANSLATE_AND_RESIZE = 1, 11303 11304 /** 11305 * Sheet will only avoid keyboard by resizing the content. 11306 * 11307 * @syscap SystemCapability.ArkUI.ArkUI.Full 11308 * @crossplatform 11309 * @atomicservice 11310 * @since 13 11311 */ 11312 RESIZE_ONLY = 2, 11313 11314 /** 11315 * Firstly sheet will avoid keyboard by changing its height. 11316 * And then sheet will avoid keyboard by scrolling after reaching its maximum height. 11317 * 11318 * @syscap SystemCapability.ArkUI.ArkUI.Full 11319 * @crossplatform 11320 * @atomicservice 11321 * @since 13 11322 */ 11323 TRANSLATE_AND_SCROLL = 3, 11324} 11325 11326/** 11327 * Component sheet dismiss 11328 * 11329 * @interface SheetDismiss 11330 * @syscap SystemCapability.ArkUI.ArkUI.Full 11331 * @crossplatform 11332 * @since 11 11333 */ 11334/** 11335 * Component sheet dismiss 11336 * 11337 * @interface SheetDismiss 11338 * @syscap SystemCapability.ArkUI.ArkUI.Full 11339 * @crossplatform 11340 * @atomicservice 11341 * @since 12 11342 */ 11343declare interface SheetDismiss { 11344 /** 11345 * Defines sheet dismiss function 11346 * 11347 * @type { function } 11348 * @syscap SystemCapability.ArkUI.ArkUI.Full 11349 * @crossplatform 11350 * @since 11 11351 */ 11352 /** 11353 * Defines sheet dismiss function 11354 * 11355 * @type { function } 11356 * @syscap SystemCapability.ArkUI.ArkUI.Full 11357 * @crossplatform 11358 * @atomicservice 11359 * @since 12 11360 */ 11361 dismiss: () => void; 11362} 11363 11364/** 11365 * Component sheet dismiss 11366 * 11367 * @interface DismissSheetAction 11368 * @syscap SystemCapability.ArkUI.ArkUI.Full 11369 * @crossplatform 11370 * @atomicservice 11371 * @since 12 11372 */ 11373declare interface DismissSheetAction { 11374 11375 /** 11376 * Defines sheet dismiss function 11377 * 11378 * @type { Callback<void> } 11379 * @syscap SystemCapability.ArkUI.ArkUI.Full 11380 * @crossplatform 11381 * @atomicservice 11382 * @since 12 11383 */ 11384 dismiss: Callback<void>; 11385 11386 /** 11387 * Dismiss reason type. 11388 * 11389 * @type { DismissReason } 11390 * @syscap SystemCapability.ArkUI.ArkUI.Full 11391 * @crossplatform 11392 * @atomicservice 11393 * @since 12 11394 */ 11395 reason: DismissReason; 11396} 11397 11398/** 11399 * Defines sheet spring back action 11400 * 11401 * @interface SpringBackAction 11402 * @syscap SystemCapability.ArkUI.ArkUI.Full 11403 * @crossplatform 11404 * @atomicservice 11405 * @since 12 11406 */ 11407declare interface SpringBackAction { 11408 /** 11409 * Defines spring back function 11410 * 11411 * @type { Callback<void> } 11412 * @syscap SystemCapability.ArkUI.ArkUI.Full 11413 * @crossplatform 11414 * @atomicservice 11415 * @since 12 11416 */ 11417 springBack: Callback<void>; 11418} 11419 11420/** 11421 * Component sheet options 11422 * 11423 * @interface SheetOptions 11424 * @syscap SystemCapability.ArkUI.ArkUI.Full 11425 * @crossplatform 11426 * @since 10 11427 */ 11428/** 11429 * Component sheet options 11430 * 11431 * @interface SheetOptions 11432 * @syscap SystemCapability.ArkUI.ArkUI.Full 11433 * @crossplatform 11434 * @atomicservice 11435 * @since 11 11436 */ 11437declare interface SheetOptions extends BindOptions { 11438 /** 11439 * Defines sheet height 11440 * 11441 * @type { ?(SheetSize | Length) } 11442 * @default Sheet.LARGE 11443 * @syscap SystemCapability.ArkUI.ArkUI.Full 11444 * @crossplatform 11445 * @since 10 11446 */ 11447 /** 11448 * Defines sheet height 11449 * 11450 * @type { ?(SheetSize | Length) } 11451 * @default Sheet.LARGE 11452 * @syscap SystemCapability.ArkUI.ArkUI.Full 11453 * @crossplatform 11454 * @atomicservice 11455 * @since 11 11456 */ 11457 height?: SheetSize | Length; 11458 11459 /** 11460 * Defines whether the control bar is displayed. 11461 * 11462 * @type { ?boolean } 11463 * @default true 11464 * @syscap SystemCapability.ArkUI.ArkUI.Full 11465 * @crossplatform 11466 * @since 10 11467 */ 11468 /** 11469 * Defines whether the control bar is displayed. 11470 * 11471 * @type { ?boolean } 11472 * @default true 11473 * @syscap SystemCapability.ArkUI.ArkUI.Full 11474 * @crossplatform 11475 * @atomicservice 11476 * @since 11 11477 */ 11478 dragBar?: boolean; 11479 11480 /** 11481 * Defines sheet maskColor 11482 * 11483 * @type { ?ResourceColor } 11484 * @syscap SystemCapability.ArkUI.ArkUI.Full 11485 * @crossplatform 11486 * @since 10 11487 */ 11488 /** 11489 * Defines sheet maskColor 11490 * 11491 * @type { ?ResourceColor } 11492 * @syscap SystemCapability.ArkUI.ArkUI.Full 11493 * @crossplatform 11494 * @atomicservice 11495 * @since 11 11496 */ 11497 maskColor?: ResourceColor; 11498 11499 /** 11500 * Defines sheet detents 11501 * 11502 * @type { ?[(SheetSize | Length), (SheetSize | Length)?, (SheetSize | Length)?] } 11503 * @syscap SystemCapability.ArkUI.ArkUI.Full 11504 * @crossplatform 11505 * @since 11 11506 */ 11507 /** 11508 * Defines sheet detents 11509 * 11510 * @type { ?[(SheetSize | Length), (SheetSize | Length)?, (SheetSize | Length)?] } 11511 * @syscap SystemCapability.ArkUI.ArkUI.Full 11512 * @crossplatform 11513 * @atomicservice 11514 * @since 12 11515 */ 11516 detents?: [(SheetSize | Length), (SheetSize | Length)?, (SheetSize | Length)?]; 11517 11518 /** 11519 * Defines sheet background blur Style 11520 * 11521 * @type { ?BlurStyle } 11522 * @default BlurStyle.NONE 11523 * @syscap SystemCapability.ArkUI.ArkUI.Full 11524 * @crossplatform 11525 * @since 11 11526 */ 11527 /** 11528 * Defines sheet background blur Style 11529 * 11530 * @type { ?BlurStyle } 11531 * @default BlurStyle.NONE 11532 * @syscap SystemCapability.ArkUI.ArkUI.Full 11533 * @crossplatform 11534 * @atomicservice 11535 * @since 12 11536 */ 11537 blurStyle?: BlurStyle; 11538 11539 /** 11540 * Defines whether the close icon is displayed 11541 * 11542 * @type { ?(boolean | Resource) } 11543 * @default true 11544 * @syscap SystemCapability.ArkUI.ArkUI.Full 11545 * @crossplatform 11546 * @since 11 11547 */ 11548 /** 11549 * Defines whether the close icon is displayed 11550 * 11551 * @type { ?(boolean | Resource) } 11552 * @default true 11553 * @syscap SystemCapability.ArkUI.ArkUI.Full 11554 * @crossplatform 11555 * @atomicservice 11556 * @since 12 11557 */ 11558 showClose?: boolean | Resource; 11559 11560 /** 11561 * Defines the sheet prefer type 11562 * 11563 * @type { ?(SheetType.CENTER | SheetType.POPUP) } 11564 * @syscap SystemCapability.ArkUI.ArkUI.Full 11565 * @crossplatform 11566 * @since 11 11567 */ 11568 /** 11569 * Defines the sheet prefer type 11570 * 11571 * @type { ?SheetType } 11572 * @syscap SystemCapability.ArkUI.ArkUI.Full 11573 * @crossplatform 11574 * @atomicservice 11575 * @since 12 11576 */ 11577 preferType?: SheetType; 11578 11579 /** 11580 * Defines the sheet title 11581 * 11582 * @type { ?(SheetTitleOptions | CustomBuilder) } 11583 * @syscap SystemCapability.ArkUI.ArkUI.Full 11584 * @crossplatform 11585 * @since 11 11586 */ 11587 /** 11588 * Defines the sheet title 11589 * 11590 * @type { ?(SheetTitleOptions | CustomBuilder) } 11591 * @syscap SystemCapability.ArkUI.ArkUI.Full 11592 * @crossplatform 11593 * @atomicservice 11594 * @since 12 11595 */ 11596 title?: SheetTitleOptions | CustomBuilder; 11597 11598 /** 11599 * Callback function when the sheet interactive dismiss 11600 * 11601 * @type { ?function } 11602 * @syscap SystemCapability.ArkUI.ArkUI.Full 11603 * @crossplatform 11604 * @since 11 11605 */ 11606 /** 11607 * Callback function when the sheet interactive dismiss 11608 * 11609 * @type { ?function } 11610 * @syscap SystemCapability.ArkUI.ArkUI.Full 11611 * @crossplatform 11612 * @atomicservice 11613 * @since 12 11614 */ 11615 shouldDismiss?: (sheetDismiss: SheetDismiss) => void; 11616 11617 /** 11618 * Callback function when the sheet will dismiss 11619 * 11620 * @type { ?Callback<DismissSheetAction> } 11621 * @syscap SystemCapability.ArkUI.ArkUI.Full 11622 * @crossplatform 11623 * @atomicservice 11624 * @since 12 11625 */ 11626 onWillDismiss?: Callback<DismissSheetAction>; 11627 11628 /** 11629 * Sheet springs back callback when dismiss 11630 * 11631 * @type { ?Callback<SpringBackAction> } 11632 * @syscap SystemCapability.ArkUI.ArkUI.Full 11633 * @crossplatform 11634 * @atomicservice 11635 * @since 12 11636 */ 11637 onWillSpringBackWhenDismiss?: Callback<SpringBackAction>; 11638 11639 /** 11640 * Set whether interaction is allowed outside the sheet 11641 * 11642 * @type { ?boolean } 11643 * @default false 11644 * @syscap SystemCapability.ArkUI.ArkUI.Full 11645 * @crossplatform 11646 * @since 11 11647 */ 11648 /** 11649 * Set whether interaction is allowed outside the sheet 11650 * 11651 * @type { ?boolean } 11652 * @default false 11653 * @syscap SystemCapability.ArkUI.ArkUI.Full 11654 * @crossplatform 11655 * @atomicservice 11656 * @since 12 11657 */ 11658 enableOutsideInteractive?: boolean; 11659 11660 /** 11661 * Defines the sheet's width. 11662 * 11663 * @type { ?Dimension } 11664 * @syscap SystemCapability.ArkUI.ArkUI.Full 11665 * @crossplatform 11666 * @atomicservice 11667 * @since 12 11668 */ 11669 width?: Dimension; 11670 11671 /** 11672 * Defines the sheet's border width. 11673 * 11674 * @type { ?(Dimension | EdgeWidths | LocalizedEdgeWidths) } 11675 * @syscap SystemCapability.ArkUI.ArkUI.Full 11676 * @crossplatform 11677 * @atomicservice 11678 * @since 12 11679 */ 11680 borderWidth?: Dimension | EdgeWidths | LocalizedEdgeWidths; 11681 11682 /** 11683 * Defines the sheet's border color. 11684 * 11685 * @type { ?(ResourceColor | EdgeColors | LocalizedEdgeColors) } 11686 * @syscap SystemCapability.ArkUI.ArkUI.Full 11687 * @crossplatform 11688 * @atomicservice 11689 * @since 12 11690 */ 11691 borderColor?: ResourceColor | EdgeColors | LocalizedEdgeColors; 11692 11693 /** 11694 * Defines the sheet's border style. 11695 * 11696 * @type { ?(BorderStyle | EdgeStyles) } 11697 * @syscap SystemCapability.ArkUI.ArkUI.Full 11698 * @crossplatform 11699 * @atomicservice 11700 * @since 12 11701 */ 11702 borderStyle?: BorderStyle | EdgeStyles; 11703 11704 /** 11705 * Defines the sheet's shadow. 11706 * 11707 * @type { ?(ShadowOptions | ShadowStyle) } 11708 * @syscap SystemCapability.ArkUI.ArkUI.Full 11709 * @crossplatform 11710 * @atomicservice 11711 * @since 12 11712 */ 11713 shadow?: ShadowOptions | ShadowStyle; 11714 11715 /** 11716 * Called when height of the sheet is changed 11717 * 11718 * @type { ?Callback<number> } 11719 * @syscap SystemCapability.ArkUI.ArkUI.Full 11720 * @crossplatform 11721 * @atomicservice 11722 * @since 12 11723 */ 11724 onHeightDidChange?: Callback<number>; 11725 11726 /** 11727 * Determine the level sheet shows, whether sheet should be displayed within the page 11728 * 11729 * @type { ?SheetMode } 11730 * @default SheetMode.OVERLAY 11731 * @syscap SystemCapability.ArkUI.ArkUI.Full 11732 * @crossplatform 11733 * @atomicservice 11734 * @since 12 11735 */ 11736 mode?: SheetMode; 11737 11738 /** 11739 * Determine sheet scroll size mode. 11740 * 11741 * @type { ?ScrollSizeMode } 11742 * @default ScrollSizeMode.FELLOW_DETEND 11743 * @syscap SystemCapability.ArkUI.ArkUI.Full 11744 * @crossplatform 11745 * @atomicservice 11746 * @since 12 11747 */ 11748 scrollSizeMode?: ScrollSizeMode; 11749 11750 /** 11751 * Called when detents of the sheet changed 11752 * 11753 * @type { ?Callback<number> } 11754 * @syscap SystemCapability.ArkUI.ArkUI.Full 11755 * @crossplatform 11756 * @atomicservice 11757 * @since 12 11758 */ 11759 onDetentsDidChange?: Callback<number>; 11760 11761 /** 11762 * Called when width of the sheet changed 11763 * 11764 * @type { ?Callback<number> } 11765 * @syscap SystemCapability.ArkUI.ArkUI.Full 11766 * @crossplatform 11767 * @atomicservice 11768 * @since 12 11769 */ 11770 onWidthDidChange?: Callback<number>; 11771 11772 /** 11773 * Called when the sheet type changed 11774 * 11775 * @type { ?Callback<SheetType> } 11776 * @syscap SystemCapability.ArkUI.ArkUI.Full 11777 * @crossplatform 11778 * @atomicservice 11779 * @since 12 11780 */ 11781 onTypeDidChange?: Callback<SheetType>; 11782 11783 /** 11784 * The UIContext that the sheet belongs to 11785 * 11786 * @type { ?UIContext } 11787 * @syscap SystemCapability.ArkUI.ArkUI.Full 11788 * @crossplatform 11789 * @atomicservice 11790 * @since 12 11791 */ 11792 uiContext?: UIContext; 11793 11794 /** 11795 * Determine the mode of sheet how to avoid keyboard. 11796 * 11797 * @type { ?SheetKeyboardAvoidMode } 11798 * @default SheetKeyboardAvoidMode.TRANSLATE_AND_SCROLL 11799 * @syscap SystemCapability.ArkUI.ArkUI.Full 11800 * @crossplatform 11801 * @atomicservice 11802 * @since 13 11803 */ 11804 keyboardAvoidMode?: SheetKeyboardAvoidMode; 11805 11806 /** 11807 * Defines whether to respond to the hover mode. 11808 * 11809 * @type { ?boolean } 11810 * @default false 11811 * @syscap SystemCapability.ArkUI.ArkUI.Full 11812 * @crossplatform 11813 * @atomicservice 11814 * @since 14 11815 */ 11816 enableHoverMode?: boolean; 11817 11818 /** 11819 * Defines the sheet's display area in hover mode. 11820 * 11821 * @type { ?HoverModeAreaType } 11822 * @default HoverModeAreaType.BOTTOM_SCREEN 11823 * @syscap SystemCapability.ArkUI.ArkUI.Full 11824 * @crossplatform 11825 * @atomicservice 11826 * @since 14 11827 */ 11828 hoverModeArea?: HoverModeAreaType; 11829 11830 /** 11831 * Sets the position offset of the bindSheet. 11832 * 11833 * @type { ?Position } 11834 * @syscap SystemCapability.ArkUI.ArkUI.Full 11835 * @systemapi 11836 * @since 14 11837 */ 11838 offset?: Position 11839} 11840 11841/** 11842 * Component State Styles. 11843 * 11844 * @interface StateStyles 11845 * @syscap SystemCapability.ArkUI.ArkUI.Full 11846 * @since 8 11847 */ 11848/** 11849 * Component State Styles. 11850 * 11851 * @interface StateStyles 11852 * @syscap SystemCapability.ArkUI.ArkUI.Full 11853 * @form 11854 * @since 9 11855 */ 11856/** 11857 * Component State Styles. 11858 * 11859 * @interface StateStyles 11860 * @syscap SystemCapability.ArkUI.ArkUI.Full 11861 * @crossplatform 11862 * @form 11863 * @since 10 11864 */ 11865/** 11866 * Component State Styles. 11867 * 11868 * @interface StateStyles 11869 * @syscap SystemCapability.ArkUI.ArkUI.Full 11870 * @crossplatform 11871 * @form 11872 * @atomicservice 11873 * @since 11 11874 */ 11875declare interface StateStyles { 11876 /** 11877 * Defines normal state styles. 11878 * 11879 * @type { ?any } 11880 * @syscap SystemCapability.ArkUI.ArkUI.Full 11881 * @since 8 11882 */ 11883 /** 11884 * Defines normal state styles. 11885 * 11886 * @type { ?any } 11887 * @syscap SystemCapability.ArkUI.ArkUI.Full 11888 * @form 11889 * @since 9 11890 */ 11891 /** 11892 * Defines normal state styles. 11893 * 11894 * @type { ?any } 11895 * @syscap SystemCapability.ArkUI.ArkUI.Full 11896 * @crossplatform 11897 * @form 11898 * @since 10 11899 */ 11900 /** 11901 * Defines normal state styles. 11902 * 11903 * @type { ?any } 11904 * @syscap SystemCapability.ArkUI.ArkUI.Full 11905 * @crossplatform 11906 * @form 11907 * @atomicservice 11908 * @since 11 11909 */ 11910 normal?: any; 11911 11912 /** 11913 * Defines pressed state styles. 11914 * 11915 * @type { ?any } 11916 * @syscap SystemCapability.ArkUI.ArkUI.Full 11917 * @since 8 11918 */ 11919 /** 11920 * Defines pressed state styles. 11921 * 11922 * @type { ?any } 11923 * @syscap SystemCapability.ArkUI.ArkUI.Full 11924 * @form 11925 * @since 9 11926 */ 11927 /** 11928 * Defines pressed state styles. 11929 * 11930 * @type { ?any } 11931 * @syscap SystemCapability.ArkUI.ArkUI.Full 11932 * @crossplatform 11933 * @form 11934 * @since 10 11935 */ 11936 /** 11937 * Defines pressed state styles. 11938 * 11939 * @type { ?any } 11940 * @syscap SystemCapability.ArkUI.ArkUI.Full 11941 * @crossplatform 11942 * @form 11943 * @atomicservice 11944 * @since 11 11945 */ 11946 pressed?: any; 11947 11948 /** 11949 * Defines disabled state styles. 11950 * 11951 * @type { ?any } 11952 * @syscap SystemCapability.ArkUI.ArkUI.Full 11953 * @since 8 11954 */ 11955 /** 11956 * Defines disabled state styles. 11957 * 11958 * @type { ?any } 11959 * @syscap SystemCapability.ArkUI.ArkUI.Full 11960 * @form 11961 * @since 9 11962 */ 11963 /** 11964 * Defines disabled state styles. 11965 * 11966 * @type { ?any } 11967 * @syscap SystemCapability.ArkUI.ArkUI.Full 11968 * @crossplatform 11969 * @form 11970 * @since 10 11971 */ 11972 /** 11973 * Defines disabled state styles. 11974 * 11975 * @type { ?any } 11976 * @syscap SystemCapability.ArkUI.ArkUI.Full 11977 * @crossplatform 11978 * @form 11979 * @atomicservice 11980 * @since 11 11981 */ 11982 disabled?: any; 11983 11984 /** 11985 * Defines focused state styles. 11986 * 11987 * @type { ?any } 11988 * @syscap SystemCapability.ArkUI.ArkUI.Full 11989 * @since 8 11990 */ 11991 /** 11992 * Defines focused state styles. 11993 * 11994 * @type { ?any } 11995 * @syscap SystemCapability.ArkUI.ArkUI.Full 11996 * @form 11997 * @since 9 11998 */ 11999 /** 12000 * Defines focused state styles. 12001 * 12002 * @type { ?any } 12003 * @syscap SystemCapability.ArkUI.ArkUI.Full 12004 * @crossplatform 12005 * @form 12006 * @since 10 12007 */ 12008 /** 12009 * Defines focused state styles. 12010 * 12011 * @type { ?any } 12012 * @syscap SystemCapability.ArkUI.ArkUI.Full 12013 * @crossplatform 12014 * @form 12015 * @atomicservice 12016 * @since 11 12017 */ 12018 focused?: any; 12019 12020 /** 12021 * Defines clicked state styles. 12022 * 12023 * @type { ?any } 12024 * @syscap SystemCapability.ArkUI.ArkUI.Full 12025 * @since 8 12026 */ 12027 /** 12028 * Defines clicked state styles. 12029 * 12030 * @type { ?any } 12031 * @syscap SystemCapability.ArkUI.ArkUI.Full 12032 * @form 12033 * @since 9 12034 */ 12035 /** 12036 * Defines clicked state styles. 12037 * 12038 * @type { ?any } 12039 * @syscap SystemCapability.ArkUI.ArkUI.Full 12040 * @crossplatform 12041 * @form 12042 * @since 10 12043 */ 12044 /** 12045 * Defines clicked state styles. 12046 * 12047 * @type { ?any } 12048 * @syscap SystemCapability.ArkUI.ArkUI.Full 12049 * @crossplatform 12050 * @form 12051 * @atomicservice 12052 * @since 11 12053 */ 12054 clicked?: any; 12055 12056 /** 12057 * Defines selected state styles. 12058 * 12059 * @type { ?object } 12060 * @syscap SystemCapability.ArkUI.ArkUI.Full 12061 * @crossplatform 12062 * @form 12063 * @since 10 12064 */ 12065 /** 12066 * Defines selected state styles. 12067 * 12068 * @type { ?object } 12069 * @syscap SystemCapability.ArkUI.ArkUI.Full 12070 * @crossplatform 12071 * @form 12072 * @atomicservice 12073 * @since 11 12074 */ 12075 selected?: object; 12076} 12077 12078/** 12079 * Defines the options of popup message. 12080 * 12081 * @interface PopupMessageOptions 12082 * @syscap SystemCapability.ArkUI.ArkUI.Full 12083 * @crossplatform 12084 * @since 10 12085 */ 12086/** 12087 * Defines the options of popup message. 12088 * 12089 * @interface PopupMessageOptions 12090 * @syscap SystemCapability.ArkUI.ArkUI.Full 12091 * @crossplatform 12092 * @atomicservice 12093 * @since 11 12094 */ 12095declare interface PopupMessageOptions { 12096 /** 12097 * Sets the color of popup text. 12098 * 12099 * @type { ?ResourceColor } 12100 * @syscap SystemCapability.ArkUI.ArkUI.Full 12101 * @crossplatform 12102 * @since 10 12103 */ 12104 /** 12105 * Sets the color of popup text. 12106 * 12107 * @type { ?ResourceColor } 12108 * @syscap SystemCapability.ArkUI.ArkUI.Full 12109 * @crossplatform 12110 * @atomicservice 12111 * @since 11 12112 */ 12113 textColor?: ResourceColor; 12114 12115 /** 12116 * Sets the font of popup text. 12117 * 12118 * @type { ?Font } 12119 * @syscap SystemCapability.ArkUI.ArkUI.Full 12120 * @crossplatform 12121 * @since 10 12122 */ 12123 /** 12124 * Sets the font of popup text. 12125 * 12126 * @type { ?Font } 12127 * @syscap SystemCapability.ArkUI.ArkUI.Full 12128 * @crossplatform 12129 * @atomicservice 12130 * @since 11 12131 */ 12132 font?: Font; 12133} 12134 12135/** 12136 * Dismiss reason type. 12137 * 12138 * @enum { number } 12139 * @syscap SystemCapability.ArkUI.ArkUI.Full 12140 * @crossplatform 12141 * @atomicservice 12142 * @since 12 12143 */ 12144declare enum DismissReason { 12145 /** 12146 * Press back 12147 * 12148 * @syscap SystemCapability.ArkUI.ArkUI.Full 12149 * @crossplatform 12150 * @atomicservice 12151 * @since 12 12152 */ 12153 PRESS_BACK = 0, 12154 12155 /** 12156 * Touch component outside 12157 * 12158 * @syscap SystemCapability.ArkUI.ArkUI.Full 12159 * @crossplatform 12160 * @atomicservice 12161 * @since 12 12162 */ 12163 TOUCH_OUTSIDE = 1, 12164 12165 /** 12166 * Close button 12167 * 12168 * @syscap SystemCapability.ArkUI.ArkUI.Full 12169 * @crossplatform 12170 * @atomicservice 12171 * @since 12 12172 */ 12173 CLOSE_BUTTON = 2, 12174 12175 /** 12176 * Slide down 12177 * 12178 * @syscap SystemCapability.ArkUI.ArkUI.Full 12179 * @crossplatform 12180 * @atomicservice 12181 * @since 12 12182 */ 12183 SLIDE_DOWN = 3 12184} 12185 12186/** 12187 * Component popup dismiss 12188 * 12189 * @interface DismissPopupAction 12190 * @syscap SystemCapability.ArkUI.ArkUI.Full 12191 * @crossplatform 12192 * @atomicservice 12193 * @since 12 12194 */ 12195declare interface DismissPopupAction { 12196 /** 12197 * Defines popup dismiss function 12198 * 12199 * @type { Callback<void> } 12200 * @syscap SystemCapability.ArkUI.ArkUI.Full 12201 * @crossplatform 12202 * @atomicservice 12203 * @since 12 12204 */ 12205 dismiss: Callback<void>; 12206 12207 /** 12208 * Defines popup dismiss reason 12209 * 12210 * @type { DismissReason } 12211 * @syscap SystemCapability.ArkUI.ArkUI.Full 12212 * @crossplatform 12213 * @atomicservice 12214 * @since 12 12215 */ 12216 reason: DismissReason; 12217} 12218 12219/** 12220 * Defines the popup options. 12221 * 12222 * @interface PopupOptions 12223 * @syscap SystemCapability.ArkUI.ArkUI.Full 12224 * @since 7 12225 */ 12226/** 12227 * Defines the popup options. 12228 * 12229 * @interface PopupOptions 12230 * @syscap SystemCapability.ArkUI.ArkUI.Full 12231 * @crossplatform 12232 * @since 10 12233 */ 12234/** 12235 * Defines the popup options. 12236 * 12237 * @interface PopupOptions 12238 * @syscap SystemCapability.ArkUI.ArkUI.Full 12239 * @crossplatform 12240 * @atomicservice 12241 * @since 11 12242 */ 12243declare interface PopupOptions { 12244 /** 12245 * Information in the pop-up window. 12246 * 12247 * @type { string } 12248 * @syscap SystemCapability.ArkUI.ArkUI.Full 12249 * @since 7 12250 */ 12251 /** 12252 * Information in the pop-up window. 12253 * 12254 * @type { string } 12255 * @syscap SystemCapability.ArkUI.ArkUI.Full 12256 * @crossplatform 12257 * @since 10 12258 */ 12259 /** 12260 * Information in the pop-up window. 12261 * 12262 * @type { string } 12263 * @syscap SystemCapability.ArkUI.ArkUI.Full 12264 * @crossplatform 12265 * @atomicservice 12266 * @since 11 12267 */ 12268 message: string; 12269 12270 /** 12271 * placement On Top 12272 * 12273 * @type { ?boolean } 12274 * @syscap SystemCapability.ArkUI.ArkUI.Full 12275 * @since 7 12276 * @deprecated since 10 12277 * @useinstead PopupOptions#placement 12278 */ 12279 placementOnTop?: boolean; 12280 12281 /** 12282 * The placement of popup. 12283 * Supports all positions defined in Placement. 12284 * 12285 * @type { ?Placement } 12286 * @default Placement.Bottom 12287 * @syscap SystemCapability.ArkUI.ArkUI.Full 12288 * @crossplatform 12289 * @since 10 12290 */ 12291 /** 12292 * The placement of popup. 12293 * Supports all positions defined in Placement. 12294 * 12295 * @type { ?Placement } 12296 * @default Placement.Bottom 12297 * @syscap SystemCapability.ArkUI.ArkUI.Full 12298 * @crossplatform 12299 * @atomicservice 12300 * @since 11 12301 */ 12302 placement?: Placement; 12303 12304 /** 12305 * The first button. 12306 * 12307 * @type { ?object } 12308 * @syscap SystemCapability.ArkUI.ArkUI.Full 12309 * @since 7 12310 */ 12311 /** 12312 * The first button. 12313 * 12314 * @type { ?object } 12315 * @syscap SystemCapability.ArkUI.ArkUI.Full 12316 * @crossplatform 12317 * @since 10 12318 */ 12319 /** 12320 * The first button. 12321 * 12322 * @type { ?object } 12323 * @syscap SystemCapability.ArkUI.ArkUI.Full 12324 * @crossplatform 12325 * @atomicservice 12326 * @since 11 12327 */ 12328 primaryButton?: { 12329 /** 12330 * Button text value 12331 * 12332 * @type { string } 12333 * @syscap SystemCapability.ArkUI.ArkUI.Full 12334 * @since 7 12335 */ 12336 /** 12337 * Button text value 12338 * 12339 * @type { string } 12340 * @syscap SystemCapability.ArkUI.ArkUI.Full 12341 * @crossplatform 12342 * @since 10 12343 */ 12344 /** 12345 * Button text value 12346 * 12347 * @type { string } 12348 * @syscap SystemCapability.ArkUI.ArkUI.Full 12349 * @crossplatform 12350 * @atomicservice 12351 * @since 11 12352 */ 12353 value: string; 12354 12355 /** 12356 * action 12357 * 12358 * @type { function } 12359 * @syscap SystemCapability.ArkUI.ArkUI.Full 12360 * @since 7 12361 */ 12362 /** 12363 * action 12364 * 12365 * @type { function } 12366 * @syscap SystemCapability.ArkUI.ArkUI.Full 12367 * @crossplatform 12368 * @since 10 12369 */ 12370 /** 12371 * action 12372 * 12373 * @type { function } 12374 * @syscap SystemCapability.ArkUI.ArkUI.Full 12375 * @crossplatform 12376 * @atomicservice 12377 * @since 11 12378 */ 12379 action: () => void; 12380 }; 12381 12382 /** 12383 * The second button. 12384 * 12385 * @type { ?object } 12386 * @syscap SystemCapability.ArkUI.ArkUI.Full 12387 * @since 7 12388 */ 12389 /** 12390 * The second button. 12391 * 12392 * @type { ?object } 12393 * @syscap SystemCapability.ArkUI.ArkUI.Full 12394 * @crossplatform 12395 * @since 10 12396 */ 12397 /** 12398 * The second button. 12399 * 12400 * @type { ?object } 12401 * @syscap SystemCapability.ArkUI.ArkUI.Full 12402 * @crossplatform 12403 * @atomicservice 12404 * @since 11 12405 */ 12406 secondaryButton?: { 12407 /** 12408 * Button text value 12409 * 12410 * @type { string } 12411 * @syscap SystemCapability.ArkUI.ArkUI.Full 12412 * @since 7 12413 */ 12414 /** 12415 * Button text value 12416 * 12417 * @type { string } 12418 * @syscap SystemCapability.ArkUI.ArkUI.Full 12419 * @crossplatform 12420 * @since 10 12421 */ 12422 /** 12423 * Button text value 12424 * 12425 * @type { string } 12426 * @syscap SystemCapability.ArkUI.ArkUI.Full 12427 * @crossplatform 12428 * @atomicservice 12429 * @since 11 12430 */ 12431 value: string; 12432 12433 /** 12434 * action 12435 * 12436 * @type { function } 12437 * @syscap SystemCapability.ArkUI.ArkUI.Full 12438 * @since 7 12439 */ 12440 /** 12441 * action 12442 * 12443 * @type { function } 12444 * @syscap SystemCapability.ArkUI.ArkUI.Full 12445 * @crossplatform 12446 * @since 10 12447 */ 12448 /** 12449 * action 12450 * 12451 * @type { function } 12452 * @syscap SystemCapability.ArkUI.ArkUI.Full 12453 * @crossplatform 12454 * @atomicservice 12455 * @since 11 12456 */ 12457 action: () => void; 12458 }; 12459 12460 /** 12461 * on State Change 12462 * 12463 * @type { ?function } 12464 * @syscap SystemCapability.ArkUI.ArkUI.Full 12465 * @since 7 12466 */ 12467 /** 12468 * on State Change 12469 * 12470 * @type { ?function } 12471 * @syscap SystemCapability.ArkUI.ArkUI.Full 12472 * @crossplatform 12473 * @since 10 12474 */ 12475 /** 12476 * on State Change 12477 * 12478 * @type { ?function } 12479 * @syscap SystemCapability.ArkUI.ArkUI.Full 12480 * @crossplatform 12481 * @atomicservice 12482 * @since 11 12483 */ 12484 onStateChange?: (event: { 12485 /** 12486 * is Visible. 12487 * 12488 * @type { boolean } 12489 * @syscap SystemCapability.ArkUI.ArkUI.Full 12490 * @crossplatform 12491 * @since 10 12492 */ 12493 /** 12494 * is Visible. 12495 * 12496 * @type { boolean } 12497 * @syscap SystemCapability.ArkUI.ArkUI.Full 12498 * @crossplatform 12499 * @atomicservice 12500 * @since 11 12501 */ 12502 isVisible: boolean 12503 }) => void; 12504 12505 /** 12506 * The offset of the sharp corner of popup. 12507 * 12508 * @type { ?Length } 12509 * @syscap SystemCapability.ArkUI.ArkUI.Full 12510 * @since 9 12511 */ 12512 /** 12513 * The offset of the sharp corner of popup. 12514 * 12515 * @type { ?Length } 12516 * @syscap SystemCapability.ArkUI.ArkUI.Full 12517 * @crossplatform 12518 * @since 10 12519 */ 12520 /** 12521 * The offset of the sharp corner of popup. 12522 * 12523 * @type { ?Length } 12524 * @syscap SystemCapability.ArkUI.ArkUI.Full 12525 * @crossplatform 12526 * @atomicservice 12527 * @since 11 12528 */ 12529 arrowOffset?: Length; 12530 12531 /** 12532 * Whether to display in the sub window. 12533 * 12534 * @type { ?boolean } 12535 * @syscap SystemCapability.ArkUI.ArkUI.Full 12536 * @since 9 12537 */ 12538 /** 12539 * Whether to display in the sub window. 12540 * 12541 * @type { ?boolean } 12542 * @syscap SystemCapability.ArkUI.ArkUI.Full 12543 * @crossplatform 12544 * @since 10 12545 */ 12546 /** 12547 * Whether to display in the sub window. 12548 * 12549 * @type { ?boolean } 12550 * @syscap SystemCapability.ArkUI.ArkUI.Full 12551 * @crossplatform 12552 * @atomicservice 12553 * @since 11 12554 */ 12555 showInSubWindow?: boolean; 12556 12557 /** 12558 * The mask to block gesture events of popup. 12559 * When mask is set false, gesture events are not blocked. 12560 * When mask is set true, gesture events are blocked and mask color is transparent. 12561 * 12562 * @type { ?(boolean | { color: ResourceColor }) } 12563 * @syscap SystemCapability.ArkUI.ArkUI.Full 12564 * @crossplatform 12565 * @since 10 12566 */ 12567 /** 12568 * The mask to block gesture events of popup. 12569 * When mask is set false, gesture events are not blocked. 12570 * When mask is set true, gesture events are blocked and mask color is transparent. 12571 * 12572 * @type { ?(boolean | { color: ResourceColor }) } 12573 * @syscap SystemCapability.ArkUI.ArkUI.Full 12574 * @crossplatform 12575 * @atomicservice 12576 * @since 11 12577 */ 12578 mask?: boolean | { color: ResourceColor }; 12579 12580 /** 12581 * Sets the options of popup message. 12582 * 12583 * @type { ?PopupMessageOptions } 12584 * @syscap SystemCapability.ArkUI.ArkUI.Full 12585 * @crossplatform 12586 * @since 10 12587 */ 12588 /** 12589 * Sets the options of popup message. 12590 * 12591 * @type { ?PopupMessageOptions } 12592 * @syscap SystemCapability.ArkUI.ArkUI.Full 12593 * @crossplatform 12594 * @atomicservice 12595 * @since 11 12596 */ 12597 messageOptions?: PopupMessageOptions 12598 12599 /** 12600 * Sets the space of between the popup and target. 12601 * 12602 * @type { ?Length } 12603 * @syscap SystemCapability.ArkUI.ArkUI.Full 12604 * @crossplatform 12605 * @since 10 12606 */ 12607 /** 12608 * Sets the space of between the popup and target. 12609 * 12610 * @type { ?Length } 12611 * @syscap SystemCapability.ArkUI.ArkUI.Full 12612 * @crossplatform 12613 * @atomicservice 12614 * @since 11 12615 */ 12616 targetSpace?: Length 12617 12618 /** 12619 * whether show arrow 12620 * 12621 * @type { ?boolean } 12622 * @default true 12623 * @syscap SystemCapability.ArkUI.ArkUI.Full 12624 * @since 10 12625 */ 12626 /** 12627 * whether show arrow 12628 * 12629 * @type { ?boolean } 12630 * @default true 12631 * @syscap SystemCapability.ArkUI.ArkUI.Full 12632 * @crossplatform 12633 * @atomicservice 12634 * @since 11 12635 */ 12636 enableArrow?: boolean; 12637 /** 12638 * Sets the position offset of the popup. 12639 * 12640 * @type { ?Position } 12641 * @syscap SystemCapability.ArkUI.ArkUI.Full 12642 * @crossplatform 12643 * @since 10 12644 */ 12645 /** 12646 * Sets the position offset of the popup. 12647 * 12648 * @type { ?Position } 12649 * @syscap SystemCapability.ArkUI.ArkUI.Full 12650 * @crossplatform 12651 * @atomicservice 12652 * @since 11 12653 */ 12654 offset?: Position 12655 12656 /** 12657 * Set the background color of the popup. 12658 * 12659 * @type { ?(Color | string | Resource | number) } 12660 * @syscap SystemCapability.ArkUI.ArkUI.Full 12661 * @crossplatform 12662 * @since 11 12663 */ 12664 /** 12665 * Set the background color of the popup. 12666 * 12667 * @type { ?(Color | string | Resource | number) } 12668 * @syscap SystemCapability.ArkUI.ArkUI.Full 12669 * @crossplatform 12670 * @atomicservice 12671 * @since 12 12672 */ 12673 popupColor?: Color | string | Resource | number; 12674 12675 /** 12676 * Whether hide popup when click mask 12677 * 12678 * @type { ?boolean } 12679 * @default true 12680 * @syscap SystemCapability.ArkUI.ArkUI.Full 12681 * @crossplatform 12682 * @since 11 12683 */ 12684 /** 12685 * Whether hide popup when click mask 12686 * 12687 * @type { ?boolean } 12688 * @default true 12689 * @syscap SystemCapability.ArkUI.ArkUI.Full 12690 * @crossplatform 12691 * @atomicservice 12692 * @since 12 12693 */ 12694 autoCancel?: boolean; 12695 12696 /** 12697 * Set the width of the popup. 12698 * 12699 * @type { ?Dimension } 12700 * @syscap SystemCapability.ArkUI.ArkUI.Full 12701 * @crossplatform 12702 * @since 11 12703 */ 12704 /** 12705 * Set the width of the popup. 12706 * 12707 * @type { ?Dimension } 12708 * @syscap SystemCapability.ArkUI.ArkUI.Full 12709 * @crossplatform 12710 * @atomicservice 12711 * @since 12 12712 */ 12713 width?: Dimension; 12714 12715 /** 12716 * The position of the sharp corner of popup. 12717 * 12718 * @type { ?ArrowPointPosition } 12719 * @syscap SystemCapability.ArkUI.ArkUI.Full 12720 * @crossplatform 12721 * @since 11 12722 */ 12723 /** 12724 * The position of the sharp corner of popup. 12725 * 12726 * @type { ?ArrowPointPosition } 12727 * @syscap SystemCapability.ArkUI.ArkUI.Full 12728 * @crossplatform 12729 * @atomicservice 12730 * @since 12 12731 */ 12732 arrowPointPosition?: ArrowPointPosition; 12733 12734 /** 12735 * The width of the arrow. 12736 * 12737 * @type { ?Dimension } 12738 * @default 16.0_vp. 12739 * @syscap SystemCapability.ArkUI.ArkUI.Full 12740 * @crossplatform 12741 * @since 11 12742 */ 12743 /** 12744 * The width of the arrow. 12745 * 12746 * @type { ?Dimension } 12747 * @default 16.0_vp. 12748 * @syscap SystemCapability.ArkUI.ArkUI.Full 12749 * @crossplatform 12750 * @atomicservice 12751 * @since 12 12752 */ 12753 arrowWidth?: Dimension; 12754 12755 /** 12756 * The height of the arrow. 12757 * 12758 * @type { ?Dimension } 12759 * @default 8.0_vp. 12760 * @syscap SystemCapability.ArkUI.ArkUI.Full 12761 * @crossplatform 12762 * @since 11 12763 */ 12764 /** 12765 * The height of the arrow. 12766 * 12767 * @type { ?Dimension } 12768 * @default 8.0_vp. 12769 * @syscap SystemCapability.ArkUI.ArkUI.Full 12770 * @crossplatform 12771 * @atomicservice 12772 * @since 12 12773 */ 12774 arrowHeight?: Dimension; 12775 12776 /** 12777 * The round corners of the popup. 12778 * 12779 * @type { ?Dimension } 12780 * @default 20.0_vp. 12781 * @syscap SystemCapability.ArkUI.ArkUI.Full 12782 * @crossplatform 12783 * @since 11 12784 */ 12785 /** 12786 * The round corners of the popup. 12787 * 12788 * @type { ?Dimension } 12789 * @default 20.0_vp. 12790 * @syscap SystemCapability.ArkUI.ArkUI.Full 12791 * @crossplatform 12792 * @atomicservice 12793 * @since 12 12794 */ 12795 radius?: Dimension; 12796 12797 /** 12798 * The style of popup Shadow. 12799 * 12800 * @type { ?(ShadowOptions | ShadowStyle) } 12801 * @default ShadowStyle.OUTER_DEFAULT_MD. 12802 * @syscap SystemCapability.ArkUI.ArkUI.Full 12803 * @crossplatform 12804 * @since 11 12805 */ 12806 /** 12807 * The style of popup Shadow. 12808 * 12809 * @type { ?(ShadowOptions | ShadowStyle) } 12810 * @default ShadowStyle.OUTER_DEFAULT_MD. 12811 * @syscap SystemCapability.ArkUI.ArkUI.Full 12812 * @crossplatform 12813 * @atomicservice 12814 * @since 12 12815 */ 12816 shadow?: ShadowOptions | ShadowStyle; 12817 12818 /** 12819 * Defines popup background blur Style 12820 * 12821 * @type { ?BlurStyle } 12822 * @default BlurStyle.COMPONENT_ULTRA_THICK 12823 * @syscap SystemCapability.ArkUI.ArkUI.Full 12824 * @crossplatform 12825 * @since 11 12826 */ 12827 /** 12828 * Defines popup background blur Style 12829 * 12830 * @type { ?BlurStyle } 12831 * @default BlurStyle.COMPONENT_ULTRA_THICK 12832 * @syscap SystemCapability.ArkUI.ArkUI.Full 12833 * @crossplatform 12834 * @atomicservice 12835 * @since 12 12836 */ 12837 backgroundBlurStyle?: BlurStyle; 12838 12839 /** 12840 * Defines the transition effect of popup opening and closing 12841 * 12842 * @type { ?TransitionEffect } 12843 * @syscap SystemCapability.ArkUI.ArkUI.Full 12844 * @crossplatform 12845 * @atomicservice 12846 * @since 12 12847 */ 12848 transition?: TransitionEffect; 12849 12850 /** 12851 * Callback function when the popup interactive dismiss 12852 * 12853 * @type { ?(boolean | Callback<DismissPopupAction>) } 12854 * @syscap SystemCapability.ArkUI.ArkUI.Full 12855 * @crossplatform 12856 * @atomicservice 12857 * @since 12 12858 */ 12859 onWillDismiss?: boolean | Callback<DismissPopupAction>; 12860 12861 /** 12862 * Determine if popup can follow the target node when it has rotation or scale. 12863 * 12864 * @type { ?boolean } 12865 * @default false 12866 * @syscap SystemCapability.ArkUI.ArkUI.Full 12867 * @crossplatform 12868 * @atomicservice 12869 * @since 13 12870 */ 12871 followTransformOfTarget?: boolean; 12872} 12873 12874/** 12875 * Defines the custom popup options. 12876 * 12877 * @interface CustomPopupOptions 12878 * @syscap SystemCapability.ArkUI.ArkUI.Full 12879 * @since 8 12880 */ 12881/** 12882 * Defines the custom popup options. 12883 * 12884 * @interface CustomPopupOptions 12885 * @syscap SystemCapability.ArkUI.ArkUI.Full 12886 * @crossplatform 12887 * @since 10 12888 */ 12889/** 12890 * Defines the custom popup options. 12891 * 12892 * @interface CustomPopupOptions 12893 * @syscap SystemCapability.ArkUI.ArkUI.Full 12894 * @crossplatform 12895 * @atomicservice 12896 * @since 11 12897 */ 12898declare interface CustomPopupOptions { 12899 /** 12900 * builder of popup 12901 * 12902 * @type { CustomBuilder } 12903 * @syscap SystemCapability.ArkUI.ArkUI.Full 12904 * @since 8 12905 */ 12906 /** 12907 * builder of popup 12908 * 12909 * @type { CustomBuilder } 12910 * @syscap SystemCapability.ArkUI.ArkUI.Full 12911 * @crossplatform 12912 * @since 10 12913 */ 12914 /** 12915 * builder of popup 12916 * 12917 * @type { CustomBuilder } 12918 * @syscap SystemCapability.ArkUI.ArkUI.Full 12919 * @crossplatform 12920 * @atomicservice 12921 * @since 11 12922 */ 12923 builder: CustomBuilder; 12924 12925 /** 12926 * placement of popup 12927 * 12928 * @type { ?Placement } 12929 * @syscap SystemCapability.ArkUI.ArkUI.Full 12930 * @since 8 12931 */ 12932 /** 12933 * placement of popup 12934 * 12935 * @type { ?Placement } 12936 * @syscap SystemCapability.ArkUI.ArkUI.Full 12937 * @crossplatform 12938 * @since 10 12939 */ 12940 /** 12941 * placement of popup 12942 * 12943 * @type { ?Placement } 12944 * @syscap SystemCapability.ArkUI.ArkUI.Full 12945 * @crossplatform 12946 * @atomicservice 12947 * @since 11 12948 */ 12949 placement?: Placement; 12950 12951 /** 12952 * mask color of popup 12953 * 12954 * @type { ?(Color | string | Resource | number) } 12955 * @syscap SystemCapability.ArkUI.ArkUI.Full 12956 * @since 8 12957 * @deprecated since 10 12958 * @useinstead CustomPopupOptions#mask 12959 */ 12960 maskColor?: Color | string | Resource | number; 12961 12962 /** 12963 * background color of popup 12964 * 12965 * @type { ?(Color | string | Resource | number) } 12966 * @syscap SystemCapability.ArkUI.ArkUI.Full 12967 * @since 8 12968 */ 12969 /** 12970 * background color of popup 12971 * 12972 * @type { ?(Color | string | Resource | number) } 12973 * @syscap SystemCapability.ArkUI.ArkUI.Full 12974 * @crossplatform 12975 * @since 10 12976 */ 12977 /** 12978 * background color of popup 12979 * 12980 * @type { ?(Color | string | Resource | number) } 12981 * @syscap SystemCapability.ArkUI.ArkUI.Full 12982 * @crossplatform 12983 * @atomicservice 12984 * @since 11 12985 */ 12986 popupColor?: Color | string | Resource | number; 12987 12988 /** 12989 * whether show arrow 12990 * 12991 * @type { ?boolean } 12992 * @syscap SystemCapability.ArkUI.ArkUI.Full 12993 * @since 8 12994 */ 12995 /** 12996 * whether show arrow 12997 * 12998 * @type { ?boolean } 12999 * @syscap SystemCapability.ArkUI.ArkUI.Full 13000 * @crossplatform 13001 * @since 10 13002 */ 13003 /** 13004 * whether show arrow 13005 * 13006 * @type { ?boolean } 13007 * @syscap SystemCapability.ArkUI.ArkUI.Full 13008 * @crossplatform 13009 * @atomicservice 13010 * @since 11 13011 */ 13012 enableArrow?: boolean; 13013 13014 /** 13015 * whether hide popup when click mask 13016 * 13017 * @type { ?boolean } 13018 * @syscap SystemCapability.ArkUI.ArkUI.Full 13019 * @since 8 13020 */ 13021 /** 13022 * whether hide popup when click mask 13023 * 13024 * @type { ?boolean } 13025 * @syscap SystemCapability.ArkUI.ArkUI.Full 13026 * @crossplatform 13027 * @since 10 13028 */ 13029 /** 13030 * whether hide popup when click mask 13031 * 13032 * @type { ?boolean } 13033 * @syscap SystemCapability.ArkUI.ArkUI.Full 13034 * @crossplatform 13035 * @atomicservice 13036 * @since 11 13037 */ 13038 autoCancel?: boolean; 13039 13040 /** 13041 * on State Change 13042 * 13043 * @type { ?function } 13044 * @syscap SystemCapability.ArkUI.ArkUI.Full 13045 * @since 8 13046 */ 13047 /** 13048 * on State Change 13049 * 13050 * @type { ?function } 13051 * @syscap SystemCapability.ArkUI.ArkUI.Full 13052 * @crossplatform 13053 * @since 10 13054 */ 13055 /** 13056 * on State Change 13057 * 13058 * @type { ?function } 13059 * @syscap SystemCapability.ArkUI.ArkUI.Full 13060 * @crossplatform 13061 * @atomicservice 13062 * @since 11 13063 */ 13064 onStateChange?: (event: { 13065 /** 13066 * is Visible. 13067 * 13068 * @type { boolean } 13069 * @syscap SystemCapability.ArkUI.ArkUI.Full 13070 * @crossplatform 13071 * @since 10 13072 */ 13073 /** 13074 * is Visible. 13075 * 13076 * @type { boolean } 13077 * @syscap SystemCapability.ArkUI.ArkUI.Full 13078 * @crossplatform 13079 * @atomicservice 13080 * @since 11 13081 */ 13082 isVisible: boolean 13083 }) => void; 13084 13085 /** 13086 * The offset of the sharp corner of popup. 13087 * 13088 * @type { ?Length } 13089 * @syscap SystemCapability.ArkUI.ArkUI.Full 13090 * @since 9 13091 */ 13092 /** 13093 * The offset of the sharp corner of popup. 13094 * 13095 * @type { ?Length } 13096 * @syscap SystemCapability.ArkUI.ArkUI.Full 13097 * @crossplatform 13098 * @since 10 13099 */ 13100 /** 13101 * The offset of the sharp corner of popup. 13102 * 13103 * @type { ?Length } 13104 * @syscap SystemCapability.ArkUI.ArkUI.Full 13105 * @crossplatform 13106 * @atomicservice 13107 * @since 11 13108 */ 13109 arrowOffset?: Length; 13110 13111 /** 13112 * Whether to display in the sub window. 13113 * 13114 * @type { ?boolean } 13115 * @syscap SystemCapability.ArkUI.ArkUI.Full 13116 * @since 9 13117 */ 13118 /** 13119 * Whether to display in the sub window. 13120 * 13121 * @type { ?boolean } 13122 * @syscap SystemCapability.ArkUI.ArkUI.Full 13123 * @crossplatform 13124 * @since 10 13125 */ 13126 /** 13127 * Whether to display in the sub window. 13128 * 13129 * @type { ?boolean } 13130 * @syscap SystemCapability.ArkUI.ArkUI.Full 13131 * @crossplatform 13132 * @atomicservice 13133 * @since 11 13134 */ 13135 showInSubWindow?: boolean; 13136 13137 /** 13138 * The mask to block gesture events of popup. 13139 * When mask is set false, gesture events are not blocked. 13140 * When mask is set true, gesture events are blocked and mask color is transparent. 13141 * 13142 * @type { ?(boolean | { color: ResourceColor }) } 13143 * @syscap SystemCapability.ArkUI.ArkUI.Full 13144 * @crossplatform 13145 * @since 10 13146 */ 13147 /** 13148 * The mask to block gesture events of popup. 13149 * When mask is set false, gesture events are not blocked. 13150 * When mask is set true, gesture events are blocked and mask color is transparent. 13151 * 13152 * @type { ?(boolean | { color: ResourceColor }) } 13153 * @syscap SystemCapability.ArkUI.ArkUI.Full 13154 * @crossplatform 13155 * @atomicservice 13156 * @since 11 13157 */ 13158 mask?: boolean | { color: ResourceColor }; 13159 13160 /** 13161 * Sets the space of between the popup and target. 13162 * 13163 * @type { ?Length } 13164 * @syscap SystemCapability.ArkUI.ArkUI.Full 13165 * @crossplatform 13166 * @since 10 13167 */ 13168 /** 13169 * Sets the space of between the popup and target. 13170 * 13171 * @type { ?Length } 13172 * @syscap SystemCapability.ArkUI.ArkUI.Full 13173 * @crossplatform 13174 * @atomicservice 13175 * @since 11 13176 */ 13177 targetSpace?: Length 13178 13179 /** 13180 * Sets the position offset of the popup. 13181 * 13182 * @type { ?Position } 13183 * @syscap SystemCapability.ArkUI.ArkUI.Full 13184 * @crossplatform 13185 * @since 10 13186 */ 13187 /** 13188 * Sets the position offset of the popup. 13189 * 13190 * @type { ?Position } 13191 * @syscap SystemCapability.ArkUI.ArkUI.Full 13192 * @crossplatform 13193 * @atomicservice 13194 * @since 11 13195 */ 13196 offset?: Position 13197 13198 /** 13199 * Set the width of the popup. 13200 * 13201 * @type { ?Dimension } 13202 * @syscap SystemCapability.ArkUI.ArkUI.Full 13203 * @crossplatform 13204 * @since 11 13205 */ 13206 /** 13207 * Set the width of the popup. 13208 * 13209 * @type { ?Dimension } 13210 * @syscap SystemCapability.ArkUI.ArkUI.Full 13211 * @crossplatform 13212 * @atomicservice 13213 * @since 12 13214 */ 13215 width?: Dimension; 13216 13217 /** 13218 * The position of the sharp corner of popup. 13219 * 13220 * @type { ?ArrowPointPosition } 13221 * @syscap SystemCapability.ArkUI.ArkUI.Full 13222 * @crossplatform 13223 * @since 11 13224 */ 13225 /** 13226 * The position of the sharp corner of popup. 13227 * 13228 * @type { ?ArrowPointPosition } 13229 * @syscap SystemCapability.ArkUI.ArkUI.Full 13230 * @crossplatform 13231 * @atomicservice 13232 * @since 12 13233 */ 13234 arrowPointPosition?: ArrowPointPosition; 13235 13236 /** 13237 * The width of the arrow. 13238 * 13239 * @type { ?Dimension } 13240 * @default 16.0_vp. 13241 * @syscap SystemCapability.ArkUI.ArkUI.Full 13242 * @crossplatform 13243 * @since 11 13244 */ 13245 /** 13246 * The width of the arrow. 13247 * 13248 * @type { ?Dimension } 13249 * @default 16.0_vp. 13250 * @syscap SystemCapability.ArkUI.ArkUI.Full 13251 * @crossplatform 13252 * @atomicservice 13253 * @since 12 13254 */ 13255 arrowWidth?: Dimension; 13256 13257 /** 13258 * The height of the arrow. 13259 * 13260 * @type { ?Dimension } 13261 * @default 8.0_vp. 13262 * @syscap SystemCapability.ArkUI.ArkUI.Full 13263 * @crossplatform 13264 * @since 11 13265 */ 13266 /** 13267 * The height of the arrow. 13268 * 13269 * @type { ?Dimension } 13270 * @default 8.0_vp. 13271 * @syscap SystemCapability.ArkUI.ArkUI.Full 13272 * @crossplatform 13273 * @atomicservice 13274 * @since 12 13275 */ 13276 arrowHeight?: Dimension; 13277 13278 /** 13279 * The round corners of the popup. 13280 * 13281 * @type { ?Dimension } 13282 * @default 20.0_vp. 13283 * @syscap SystemCapability.ArkUI.ArkUI.Full 13284 * @crossplatform 13285 * @since 11 13286 */ 13287 /** 13288 * The round corners of the popup. 13289 * 13290 * @type { ?Dimension } 13291 * @default 20.0_vp. 13292 * @syscap SystemCapability.ArkUI.ArkUI.Full 13293 * @crossplatform 13294 * @atomicservice 13295 * @since 12 13296 */ 13297 radius?: Dimension; 13298 13299 /** 13300 * The style of popup Shadow. 13301 * 13302 * @type { ?(ShadowOptions | ShadowStyle) } 13303 * @default ShadowStyle.OUTER_DEFAULT_MD. 13304 * @syscap SystemCapability.ArkUI.ArkUI.Full 13305 * @crossplatform 13306 * @since 11 13307 */ 13308 /** 13309 * The style of popup Shadow. 13310 * 13311 * @type { ?(ShadowOptions | ShadowStyle) } 13312 * @default ShadowStyle.OUTER_DEFAULT_MD. 13313 * @syscap SystemCapability.ArkUI.ArkUI.Full 13314 * @crossplatform 13315 * @atomicservice 13316 * @since 12 13317 */ 13318 shadow?: ShadowOptions | ShadowStyle; 13319 13320 /** 13321 * Defines popup background blur Style 13322 * 13323 * @type { ?BlurStyle } 13324 * @default BlurStyle.COMPONENT_ULTRA_THICK 13325 * @syscap SystemCapability.ArkUI.ArkUI.Full 13326 * @crossplatform 13327 * @since 11 13328 */ 13329 /** 13330 * Defines popup background blur Style 13331 * 13332 * @type { ?BlurStyle } 13333 * @default BlurStyle.COMPONENT_ULTRA_THICK 13334 * @syscap SystemCapability.ArkUI.ArkUI.Full 13335 * @crossplatform 13336 * @atomicservice 13337 * @since 12 13338 */ 13339 backgroundBlurStyle?: BlurStyle; 13340 13341 /** 13342 * Set popup focusable 13343 * 13344 * @type { ?boolean } 13345 * @default true 13346 * @syscap SystemCapability.ArkUI.ArkUI.Full 13347 * @crossplatform 13348 * @since 11 13349 */ 13350 /** 13351 * Set popup focusable 13352 * 13353 * @type { ?boolean } 13354 * @default true 13355 * @syscap SystemCapability.ArkUI.ArkUI.Full 13356 * @crossplatform 13357 * @atomicservice 13358 * @since 12 13359 */ 13360 focusable?: boolean; 13361 13362 /** 13363 * Defines the transition effect of popup opening and closing 13364 * 13365 * @type { ?TransitionEffect } 13366 * @syscap SystemCapability.ArkUI.ArkUI.Full 13367 * @crossplatform 13368 * @atomicservice 13369 * @since 12 13370 */ 13371 transition?: TransitionEffect; 13372 13373 /** 13374 * Callback function when the popup interactive dismiss 13375 * 13376 * @type { ?(boolean | Callback<DismissPopupAction>) } 13377 * @syscap SystemCapability.ArkUI.ArkUI.Full 13378 * @crossplatform 13379 * @atomicservice 13380 * @since 12 13381 */ 13382 onWillDismiss?: boolean | Callback<DismissPopupAction>; 13383 13384 /** 13385 * Determine if popup can follow the target node when it has rotation or scale. 13386 * 13387 * @type { ?boolean } 13388 * @default false 13389 * @syscap SystemCapability.ArkUI.ArkUI.Full 13390 * @crossplatform 13391 * @atomicservice 13392 * @since 13 13393 */ 13394 followTransformOfTarget?: boolean; 13395} 13396 13397/** 13398 * Defines the menu preview mode. 13399 * 13400 * @enum { number } 13401 * @syscap SystemCapability.ArkUI.ArkUI.Full 13402 * @crossplatform 13403 * @since 11 13404 */ 13405/** 13406 * Defines the menu preview mode. 13407 * 13408 * @enum { number } 13409 * @syscap SystemCapability.ArkUI.ArkUI.Full 13410 * @crossplatform 13411 * @atomicservice 13412 * @since 12 13413 */ 13414declare enum MenuPreviewMode { 13415 /** 13416 * No preview content. 13417 * 13418 * @syscap SystemCapability.ArkUI.ArkUI.Full 13419 * @crossplatform 13420 * @since 11 13421 */ 13422 /** 13423 * No preview content. 13424 * 13425 * @syscap SystemCapability.ArkUI.ArkUI.Full 13426 * @crossplatform 13427 * @atomicservice 13428 * @since 12 13429 */ 13430 NONE = 0, 13431 /** 13432 * Defines image type preview content. 13433 * 13434 * @syscap SystemCapability.ArkUI.ArkUI.Full 13435 * @crossplatform 13436 * @since 11 13437 */ 13438 /** 13439 * Defines image type preview content. 13440 * 13441 * @syscap SystemCapability.ArkUI.ArkUI.Full 13442 * @crossplatform 13443 * @atomicservice 13444 * @since 12 13445 */ 13446 IMAGE = 1 13447} 13448 13449/** 13450 * Defines the animator range of start and end property. 13451 * 13452 * @typedef { [from: T, to: T] } AnimationRange<T> 13453 * @syscap SystemCapability.ArkUI.ArkUI.Full 13454 * @crossplatform 13455 * @since 11 13456 */ 13457/** 13458 * Defines the animator range of start and end property. 13459 * 13460 * @typedef { [from: T, to: T] } AnimationRange<T> 13461 * @syscap SystemCapability.ArkUI.ArkUI.Full 13462 * @crossplatform 13463 * @atomicservice 13464 * @since 12 13465 */ 13466declare type AnimationRange<T> = [from: T, to: T]; 13467 13468/** 13469 * Defines the ContextMenu's preview animator options. 13470 * 13471 * @interface ContextMenuAnimationOptions 13472 * @syscap SystemCapability.ArkUI.ArkUI.Full 13473 * @crossplatform 13474 * @since 11 13475 */ 13476/** 13477 * Defines the ContextMenu's preview animator options. 13478 * 13479 * @interface ContextMenuAnimationOptions 13480 * @syscap SystemCapability.ArkUI.ArkUI.Full 13481 * @crossplatform 13482 * @atomicservice 13483 * @since 12 13484 */ 13485interface ContextMenuAnimationOptions { 13486 /** 13487 * Sets the start animator scale and end animator scale. 13488 * 13489 * @type { ?AnimationRange<number> } 13490 * @default - 13491 * @syscap SystemCapability.ArkUI.ArkUI.Full 13492 * @crossplatform 13493 * @since 11 13494 */ 13495 /** 13496 * Sets the start animator scale and end animator scale. 13497 * 13498 * @type { ?AnimationRange<number> } 13499 * @default - 13500 * @syscap SystemCapability.ArkUI.ArkUI.Full 13501 * @crossplatform 13502 * @atomicservice 13503 * @since 12 13504 */ 13505 scale?: AnimationRange<number>; 13506 /** 13507 * Defines the transition effect of menu preview opening and closing. 13508 * 13509 * @type { ?TransitionEffect } 13510 * @syscap SystemCapability.ArkUI.ArkUI.Full 13511 * @crossplatform 13512 * @atomicservice 13513 * @since 12 13514 */ 13515 transition?: TransitionEffect; 13516 13517 /** 13518 * Sets the scale start and end animator of the image displayed before the custom builder preview is displayed. 13519 * 13520 * @type { ?AnimationRange<number> } 13521 * @syscap SystemCapability.ArkUI.ArkUI.Full 13522 * @crossplatform 13523 * @atomicservice 13524 * @since 12 13525 */ 13526 hoverScale?: AnimationRange<number>; 13527} 13528 13529/** 13530 * Defines the context menu options. 13531 * 13532 * @interface ContextMenuOptions 13533 * @syscap SystemCapability.ArkUI.ArkUI.Full 13534 * @crossplatform 13535 * @since 10 13536 */ 13537/** 13538 * Defines the context menu options. 13539 * 13540 * @interface ContextMenuOptions 13541 * @syscap SystemCapability.ArkUI.ArkUI.Full 13542 * @crossplatform 13543 * @atomicservice 13544 * @since 11 13545 */ 13546declare interface ContextMenuOptions { 13547 /** 13548 * Sets the position offset of the context menu window. 13549 * 13550 * @type { ?Position } 13551 * @default - 13552 * @syscap SystemCapability.ArkUI.ArkUI.Full 13553 * @crossplatform 13554 * @since 10 13555 */ 13556 /** 13557 * Sets the position offset of the context menu window. 13558 * 13559 * @type { ?Position } 13560 * @default - 13561 * @syscap SystemCapability.ArkUI.ArkUI.Full 13562 * @crossplatform 13563 * @atomicservice 13564 * @since 11 13565 */ 13566 offset?: Position; 13567 13568 /** 13569 * Sets the placement of the context menu window. 13570 * 13571 * @type { ?Placement } 13572 * @default - 13573 * @syscap SystemCapability.ArkUI.ArkUI.Full 13574 * @crossplatform 13575 * @since 10 13576 */ 13577 /** 13578 * Sets the placement of the context menu window. 13579 * 13580 * @type { ?Placement } 13581 * @default - 13582 * @syscap SystemCapability.ArkUI.ArkUI.Full 13583 * @crossplatform 13584 * @atomicservice 13585 * @since 11 13586 */ 13587 placement?: Placement; 13588 13589 /** 13590 * whether show arrow belong to the menu, default: false, not show arrow 13591 * 13592 * @type { ?boolean } 13593 * @default false 13594 * @syscap SystemCapability.ArkUI.ArkUI.Full 13595 * @since 10 13596 */ 13597 /** 13598 * whether show arrow belong to the menu, default: false, not show arrow 13599 * 13600 * @type { ?boolean } 13601 * @default false 13602 * @syscap SystemCapability.ArkUI.ArkUI.Full 13603 * @crossplatform 13604 * @atomicservice 13605 * @since 11 13606 */ 13607 enableArrow?: boolean; 13608 13609 /** 13610 * The horizontal offset to the left of menu or vertical offset to the top of menu 13611 * 13612 * @type { ?Length } 13613 * @default 0 13614 * @syscap SystemCapability.ArkUI.ArkUI.Full 13615 * @since 10 13616 */ 13617 /** 13618 * The horizontal offset to the left of menu or vertical offset to the top of menu 13619 * 13620 * @type { ?Length } 13621 * @default 0 13622 * @syscap SystemCapability.ArkUI.ArkUI.Full 13623 * @crossplatform 13624 * @atomicservice 13625 * @since 11 13626 */ 13627 arrowOffset?: Length; 13628 13629 /** 13630 * The preview content of context menu. 13631 * 13632 * @type { ?(MenuPreviewMode | CustomBuilder) } 13633 * @default MenuPreviewMode.NONE 13634 * @syscap SystemCapability.ArkUI.ArkUI.Full 13635 * @crossplatform 13636 * @since 11 13637 */ 13638 /** 13639 * The preview content of context menu. 13640 * 13641 * @type { ?(MenuPreviewMode | CustomBuilder) } 13642 * @default MenuPreviewMode.NONE 13643 * @syscap SystemCapability.ArkUI.ArkUI.Full 13644 * @crossplatform 13645 * @atomicservice 13646 * @since 12 13647 */ 13648 preview?: MenuPreviewMode | CustomBuilder; 13649 13650 /** 13651 * Defines the border radius of menu. 13652 * 13653 * @type { ?(Length | BorderRadiuses | LocalizedBorderRadiuses) } 13654 * @syscap SystemCapability.ArkUI.ArkUI.Full 13655 * @crossplatform 13656 * @atomicservice 13657 * @since 12 13658 */ 13659 borderRadius?: Length | BorderRadiuses | LocalizedBorderRadiuses; 13660 13661 /** 13662 * Callback function when the context menu appears. 13663 * 13664 * @type { ?function } 13665 * @syscap SystemCapability.ArkUI.ArkUI.Full 13666 * @crossplatform 13667 * @since 10 13668 */ 13669 /** 13670 * Callback function when the context menu appears. 13671 * 13672 * @type { ?function } 13673 * @syscap SystemCapability.ArkUI.ArkUI.Full 13674 * @crossplatform 13675 * @atomicservice 13676 * @since 11 13677 */ 13678 onAppear?: () => void; 13679 13680 /** 13681 * Callback function when the context menu disappear. 13682 * 13683 * @type { ?function } 13684 * @syscap SystemCapability.ArkUI.ArkUI.Full 13685 * @crossplatform 13686 * @since 10 13687 */ 13688 /** 13689 * Callback function when the context menu disappear. 13690 * 13691 * @type { ?function } 13692 * @syscap SystemCapability.ArkUI.ArkUI.Full 13693 * @crossplatform 13694 * @atomicservice 13695 * @since 11 13696 */ 13697 onDisappear?: () => void; 13698 13699 /** 13700 * Callback function before the context menu animation starts. 13701 * 13702 * @type { ?function } 13703 * @syscap SystemCapability.ArkUI.ArkUI.Full 13704 * @crossplatform 13705 * @since 11 13706 */ 13707 /** 13708 * Callback function before the context menu animation starts. 13709 * 13710 * @type { ?function } 13711 * @syscap SystemCapability.ArkUI.ArkUI.Full 13712 * @crossplatform 13713 * @atomicservice 13714 * @since 12 13715 */ 13716 aboutToAppear?: () => void; 13717 13718 /** 13719 * Callback function before the context menu popAnimation starts. 13720 * 13721 * @type { ?function } 13722 * @syscap SystemCapability.ArkUI.ArkUI.Full 13723 * @crossplatform 13724 * @since 11 13725 */ 13726 /** 13727 * Callback function before the context menu popAnimation starts. 13728 * 13729 * @type { ?function } 13730 * @syscap SystemCapability.ArkUI.ArkUI.Full 13731 * @crossplatform 13732 * @atomicservice 13733 * @since 12 13734 */ 13735 aboutToDisappear?: () => void; 13736 13737 /** 13738 * The margin of menu's layoutRegion. 13739 * 13740 * @type { ?Margin } 13741 * @syscap SystemCapability.ArkUI.ArkUI.Full 13742 * @crossplatform 13743 * @atomicservice 13744 * @since 13 13745 */ 13746 layoutRegionMargin?: Margin; 13747 13748 /** 13749 * The preview animator options. 13750 * 13751 * @type { ?ContextMenuAnimationOptions } 13752 * @syscap SystemCapability.ArkUI.ArkUI.Full 13753 * @crossplatform 13754 * @since 11 13755 */ 13756 /** 13757 * The preview animator options. 13758 * 13759 * @type { ?ContextMenuAnimationOptions } 13760 * @syscap SystemCapability.ArkUI.ArkUI.Full 13761 * @crossplatform 13762 * @atomicservice 13763 * @since 12 13764 */ 13765 previewAnimationOptions?: ContextMenuAnimationOptions; 13766 13767 /** 13768 * Defines the menu's background color 13769 * 13770 * @type { ?ResourceColor } 13771 * @default Color.Transparent 13772 * @syscap SystemCapability.ArkUI.ArkUI.Full 13773 * @crossplatform 13774 * @since 11 13775 */ 13776 /** 13777 * Defines the menu's background color 13778 * 13779 * @type { ?ResourceColor } 13780 * @default Color.Transparent 13781 * @syscap SystemCapability.ArkUI.ArkUI.Full 13782 * @crossplatform 13783 * @atomicservice 13784 * @since 12 13785 */ 13786 backgroundColor?: ResourceColor; 13787 13788 /** 13789 * Defines menu background blur Style 13790 * 13791 * @type { ?BlurStyle } 13792 * @default BlurStyle.COMPONENT_ULTRA_THICK 13793 * @syscap SystemCapability.ArkUI.ArkUI.Full 13794 * @crossplatform 13795 * @since 11 13796 */ 13797 /** 13798 * Defines menu background blur Style 13799 * 13800 * @type { ?BlurStyle } 13801 * @default BlurStyle.COMPONENT_ULTRA_THICK 13802 * @syscap SystemCapability.ArkUI.ArkUI.Full 13803 * @crossplatform 13804 * @atomicservice 13805 * @since 12 13806 */ 13807 backgroundBlurStyle?: BlurStyle; 13808 13809 /** 13810 * Defines the transition effect of menu opening and closing. 13811 * 13812 * @type { ?TransitionEffect } 13813 * @syscap SystemCapability.ArkUI.ArkUI.Full 13814 * @crossplatform 13815 * @atomicservice 13816 * @since 12 13817 */ 13818 transition?: TransitionEffect; 13819} 13820 13821/** 13822 * Defines the menu options. 13823 * 13824 * @extends ContextMenuOptions 13825 * @interface MenuOptions 13826 * @syscap SystemCapability.ArkUI.ArkUI.Full 13827 * @crossplatform 13828 * @since 10 13829 */ 13830/** 13831 * Defines the menu options. 13832 * 13833 * @extends ContextMenuOptions 13834 * @interface MenuOptions 13835 * @syscap SystemCapability.ArkUI.ArkUI.Full 13836 * @crossplatform 13837 * @atomicservice 13838 * @since 11 13839 */ 13840declare interface MenuOptions extends ContextMenuOptions { 13841 /** 13842 * Sets the title of the menu window. 13843 * 13844 * @type { ?ResourceStr } 13845 * @syscap SystemCapability.ArkUI.ArkUI.Full 13846 * @crossplatform 13847 * @since 10 13848 */ 13849 /** 13850 * Sets the title of the menu window. 13851 * 13852 * @type { ?ResourceStr } 13853 * @syscap SystemCapability.ArkUI.ArkUI.Full 13854 * @crossplatform 13855 * @atomicservice 13856 * @since 11 13857 */ 13858 title?: ResourceStr; 13859 13860 /** 13861 * Whether to display in the sub window. 13862 * 13863 * @type { ?boolean } 13864 * @syscap SystemCapability.ArkUI.ArkUI.Full 13865 * @crossplatform 13866 * @since 11 13867 */ 13868 /** 13869 * Whether to display in the sub window. 13870 * 13871 * @type { ?boolean } 13872 * @syscap SystemCapability.ArkUI.ArkUI.Full 13873 * @crossplatform 13874 * @atomicservice 13875 * @since 12 13876 */ 13877 showInSubWindow?: boolean; 13878} 13879 13880/** 13881 * Defines the ProgressMask class. 13882 * 13883 * @syscap SystemCapability.ArkUI.ArkUI.Full 13884 * @crossplatform 13885 * @since 10 13886 */ 13887/** 13888 * Defines the ProgressMask class. 13889 * 13890 * @syscap SystemCapability.ArkUI.ArkUI.Full 13891 * @crossplatform 13892 * @atomicservice 13893 * @since 11 13894 */ 13895declare class ProgressMask { 13896 /** 13897 * constructor. 13898 * 13899 * @param { number } value - indicates the current value of the progress. 13900 * @param { number } total - indicates the total value of the progress. 13901 * @param { ResourceColor } color - indicates the color of the mask. 13902 * @syscap SystemCapability.ArkUI.ArkUI.Full 13903 * @crossplatform 13904 * @since 10 13905 */ 13906 /** 13907 * constructor. 13908 * 13909 * @param { number } value - indicates the current value of the progress. 13910 * @param { number } total - indicates the total value of the progress. 13911 * @param { ResourceColor } color - indicates the color of the mask. 13912 * @syscap SystemCapability.ArkUI.ArkUI.Full 13913 * @crossplatform 13914 * @atomicservice 13915 * @since 11 13916 */ 13917 constructor(value: number, total: number, color: ResourceColor); 13918 13919 /** 13920 * Update the current value of the progress. 13921 * 13922 * @param { number } value - indicates the current value of the progress. 13923 * @syscap SystemCapability.ArkUI.ArkUI.Full 13924 * @crossplatform 13925 * @since 10 13926 */ 13927 /** 13928 * Update the current value of the progress. 13929 * 13930 * @param { number } value - indicates the current value of the progress. 13931 * @syscap SystemCapability.ArkUI.ArkUI.Full 13932 * @crossplatform 13933 * @atomicservice 13934 * @since 11 13935 */ 13936 updateProgress(value: number): void; 13937 13938 /** 13939 * Update the color of the mask. 13940 * 13941 * @param { ResourceColor } value - indicates the color of the mask. 13942 * @syscap SystemCapability.ArkUI.ArkUI.Full 13943 * @crossplatform 13944 * @since 10 13945 */ 13946 /** 13947 * Update the color of the mask. 13948 * 13949 * @param { ResourceColor } value - indicates the color of the mask. 13950 * @syscap SystemCapability.ArkUI.ArkUI.Full 13951 * @crossplatform 13952 * @atomicservice 13953 * @since 11 13954 */ 13955 updateColor(value: ResourceColor): void; 13956 13957 /** 13958 * Enable the breathe animation of mask. 13959 * 13960 * @param { boolean } value 13961 * @syscap SystemCapability.ArkUI.ArkUI.Full 13962 * @crossplatform 13963 * @atomicservice 13964 * @since 12 13965 */ 13966 enableBreathingAnimation(value: boolean): void; 13967} 13968 13969/** 13970 * Defines TouchTestInfo class. 13971 * 13972 * @syscap SystemCapability.ArkUI.ArkUI.Full 13973 * @crossplatform 13974 * @since 11 13975 */ 13976/** 13977 * Defines TouchTestInfo class. 13978 * 13979 * @syscap SystemCapability.ArkUI.ArkUI.Full 13980 * @crossplatform 13981 * @atomicservice 13982 * @since 12 13983 */ 13984declare class TouchTestInfo { 13985 /** 13986 * Get the X-coordinate relative to the window. 13987 * 13988 * @type { number } 13989 * @syscap SystemCapability.ArkUI.ArkUI.Full 13990 * @crossplatform 13991 * @since 11 13992 */ 13993 /** 13994 * Get the X-coordinate relative to the window. 13995 * 13996 * @type { number } 13997 * @syscap SystemCapability.ArkUI.ArkUI.Full 13998 * @crossplatform 13999 * @atomicservice 14000 * @since 12 14001 */ 14002 windowX: number; 14003 14004 /** 14005 * Get the Y-coordinate relative to the window. 14006 * 14007 * @type { number } 14008 * @syscap SystemCapability.ArkUI.ArkUI.Full 14009 * @crossplatform 14010 * @since 11 14011 */ 14012 /** 14013 * Get the Y-coordinate relative to the window. 14014 * 14015 * @type { number } 14016 * @syscap SystemCapability.ArkUI.ArkUI.Full 14017 * @crossplatform 14018 * @atomicservice 14019 * @since 12 14020 */ 14021 windowY: number; 14022 14023 /** 14024 * Get the X-coordinate relative to the current component. 14025 * 14026 * @type { number } 14027 * @syscap SystemCapability.ArkUI.ArkUI.Full 14028 * @crossplatform 14029 * @since 11 14030 */ 14031 /** 14032 * Get the X-coordinate relative to the current component. 14033 * 14034 * @type { number } 14035 * @syscap SystemCapability.ArkUI.ArkUI.Full 14036 * @crossplatform 14037 * @atomicservice 14038 * @since 12 14039 */ 14040 parentX: number; 14041 14042 /** 14043 * Get the Y-coordinate relative to the current component. 14044 * 14045 * @type { number } 14046 * @syscap SystemCapability.ArkUI.ArkUI.Full 14047 * @crossplatform 14048 * @since 11 14049 */ 14050 /** 14051 * Get the Y-coordinate relative to the current component. 14052 * 14053 * @type { number } 14054 * @syscap SystemCapability.ArkUI.ArkUI.Full 14055 * @crossplatform 14056 * @atomicservice 14057 * @since 12 14058 */ 14059 parentY: number; 14060 14061 /** 14062 * Get the X-coordinate relative to the sub component. 14063 * 14064 * @type { number } 14065 * @syscap SystemCapability.ArkUI.ArkUI.Full 14066 * @crossplatform 14067 * @since 11 14068 */ 14069 /** 14070 * Get the X-coordinate relative to the sub component. 14071 * 14072 * @type { number } 14073 * @syscap SystemCapability.ArkUI.ArkUI.Full 14074 * @crossplatform 14075 * @atomicservice 14076 * @since 12 14077 */ 14078 x: number; 14079 14080 /** 14081 * Get the Y-coordinate relative to the sub component. 14082 * 14083 * @type { number } 14084 * @syscap SystemCapability.ArkUI.ArkUI.Full 14085 * @crossplatform 14086 * @since 11 14087 */ 14088 /** 14089 * Get the Y-coordinate relative to the sub component. 14090 * 14091 * @type { number } 14092 * @syscap SystemCapability.ArkUI.ArkUI.Full 14093 * @crossplatform 14094 * @atomicservice 14095 * @since 12 14096 */ 14097 y: number; 14098 14099 /** 14100 * Get the rectangle of sub component. 14101 * 14102 * @type { RectResult } 14103 * @syscap SystemCapability.ArkUI.ArkUI.Full 14104 * @crossplatform 14105 * @since 11 14106 */ 14107 /** 14108 * Get the rectangle of sub component. 14109 * 14110 * @type { RectResult } 14111 * @syscap SystemCapability.ArkUI.ArkUI.Full 14112 * @crossplatform 14113 * @atomicservice 14114 * @since 12 14115 */ 14116 rect: RectResult; 14117 14118 /** 14119 * Get the name of sub component. 14120 * 14121 * @type { string } 14122 * @syscap SystemCapability.ArkUI.ArkUI.Full 14123 * @crossplatform 14124 * @since 11 14125 */ 14126 /** 14127 * Get the name of sub component. 14128 * 14129 * @type { string } 14130 * @syscap SystemCapability.ArkUI.ArkUI.Full 14131 * @crossplatform 14132 * @atomicservice 14133 * @since 12 14134 */ 14135 id: string; 14136} 14137 14138/** 14139 * Defines TouchResult class. 14140 * 14141 * @syscap SystemCapability.ArkUI.ArkUI.Full 14142 * @crossplatform 14143 * @since 11 14144 */ 14145/** 14146 * Defines TouchResult class. 14147 * 14148 * @syscap SystemCapability.ArkUI.ArkUI.Full 14149 * @crossplatform 14150 * @atomicservice 14151 * @since 12 14152 */ 14153declare class TouchResult { 14154 /** 14155 * Defines the touch test strategy. 14156 * 14157 * @type { TouchTestStrategy } 14158 * @syscap SystemCapability.ArkUI.ArkUI.Full 14159 * @crossplatform 14160 * @since 11 14161 */ 14162 /** 14163 * Defines the touch test strategy. 14164 * 14165 * @type { TouchTestStrategy } 14166 * @syscap SystemCapability.ArkUI.ArkUI.Full 14167 * @crossplatform 14168 * @atomicservice 14169 * @since 12 14170 */ 14171 strategy: TouchTestStrategy; 14172 14173 /** 14174 * Defines the component's name. 14175 * 14176 * @type { ?string } 14177 * @syscap SystemCapability.ArkUI.ArkUI.Full 14178 * @crossplatform 14179 * @since 11 14180 */ 14181 /** 14182 * Defines the component's name. 14183 * 14184 * @type { ?string } 14185 * @syscap SystemCapability.ArkUI.ArkUI.Full 14186 * @crossplatform 14187 * @atomicservice 14188 * @since 12 14189 */ 14190 id?: string; 14191} 14192 14193/** 14194 * Set the edge blur effect distance of the corresponding defense line of the component 14195 * When the component expand out, no re-layout is triggered 14196 * 14197 * @interface PixelStretchEffectOptions 14198 * @syscap SystemCapability.ArkUI.ArkUI.Full 14199 * @crossplatform 14200 * @since 10 14201 */ 14202/** 14203 * Set the edge blur effect distance of the corresponding defense line of the component 14204 * When the component expand out, no re-layout is triggered 14205 * 14206 * @interface PixelStretchEffectOptions 14207 * @syscap SystemCapability.ArkUI.ArkUI.Full 14208 * @crossplatform 14209 * @atomicservice 14210 * @since 11 14211 */ 14212declare interface PixelStretchEffectOptions { 14213 /** 14214 * top property. value range (-∞, ∞) 14215 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 14216 * 14217 * @type { ?Length } 14218 * @default 0 14219 * @syscap SystemCapability.ArkUI.ArkUI.Full 14220 * @crossplatform 14221 * @since 10 14222 */ 14223 /** 14224 * top property. value range (-∞, ∞) 14225 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 14226 * 14227 * @type { ?Length } 14228 * @default 0 14229 * @syscap SystemCapability.ArkUI.ArkUI.Full 14230 * @crossplatform 14231 * @atomicservice 14232 * @since 11 14233 */ 14234 top?: Length; 14235 14236 /** 14237 * bottom property. value range (-∞, ∞) 14238 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 14239 * 14240 * @type { ?Length } 14241 * @default 0 14242 * @syscap SystemCapability.ArkUI.ArkUI.Full 14243 * @crossplatform 14244 * @since 10 14245 */ 14246 /** 14247 * bottom property. value range (-∞, ∞) 14248 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 14249 * 14250 * @type { ?Length } 14251 * @default 0 14252 * @syscap SystemCapability.ArkUI.ArkUI.Full 14253 * @crossplatform 14254 * @atomicservice 14255 * @since 11 14256 */ 14257 bottom?: Length; 14258 14259 /** 14260 * left property. value range (-∞, ∞) 14261 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 14262 * 14263 * @type { ?Length } 14264 * @default 0 14265 * @syscap SystemCapability.ArkUI.ArkUI.Full 14266 * @crossplatform 14267 * @since 10 14268 */ 14269 /** 14270 * left property. value range (-∞, ∞) 14271 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 14272 * 14273 * @type { ?Length } 14274 * @default 0 14275 * @syscap SystemCapability.ArkUI.ArkUI.Full 14276 * @crossplatform 14277 * @atomicservice 14278 * @since 11 14279 */ 14280 left?: Length; 14281 14282 /** 14283 * right property. value range (-∞, ∞) 14284 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 14285 * 14286 * @type { ?Length } 14287 * @default 0 14288 * @syscap SystemCapability.ArkUI.ArkUI.Full 14289 * @crossplatform 14290 * @since 10 14291 */ 14292 /** 14293 * right property. value range (-∞, ∞) 14294 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 14295 * 14296 * @type { ?Length } 14297 * @default 0 14298 * @syscap SystemCapability.ArkUI.ArkUI.Full 14299 * @crossplatform 14300 * @atomicservice 14301 * @since 11 14302 */ 14303 right?: Length; 14304} 14305 14306/** 14307 * Defines the click effect. 14308 * 14309 * @interface ClickEffect 14310 * @syscap SystemCapability.ArkUI.ArkUI.Full 14311 * @crossplatform 14312 * @since 10 14313 */ 14314/** 14315 * Defines the click effect. 14316 * 14317 * @interface ClickEffect 14318 * @syscap SystemCapability.ArkUI.ArkUI.Full 14319 * @crossplatform 14320 * @atomicservice 14321 * @since 11 14322 */ 14323declare interface ClickEffect { 14324 /** 14325 * Set the click effect level. 14326 * 14327 * @type { ClickEffectLevel } 14328 * @default ClickEffectLevel.Light 14329 * @syscap SystemCapability.ArkUI.ArkUI.Full 14330 * @since 10 14331 */ 14332 /** 14333 * Set the click effect level. 14334 * 14335 * @type { ClickEffectLevel } 14336 * @default ClickEffectLevel.Light 14337 * @syscap SystemCapability.ArkUI.ArkUI.Full 14338 * @atomicservice 14339 * @since 11 14340 */ 14341 level: ClickEffectLevel; 14342 14343 /** 14344 * Set scale number. 14345 * This default scale is same as the scale of click effect level. 14346 * 14347 * @type { ?number } 14348 * @syscap SystemCapability.ArkUI.ArkUI.Full 14349 * @since 10 14350 */ 14351 /** 14352 * Set scale number. 14353 * This default scale is same as the scale of click effect level. 14354 * 14355 * @type { ?number } 14356 * @syscap SystemCapability.ArkUI.ArkUI.Full 14357 * @atomicservice 14358 * @since 11 14359 */ 14360 scale?: number; 14361} 14362 14363/** 14364 * Defines the fadingEdge options. 14365 * 14366 * @typedef FadingEdgeOptions 14367 * @syscap SystemCapability.ArkUI.ArkUI.Full 14368 * @crossplatform 14369 * @atomicservice 14370 * @since 14 14371 */ 14372declare interface FadingEdgeOptions { 14373 /** 14374 * The length of FadingEdge. 14375 * 14376 * @type { LengthMetrics } 14377 * @default 32vp 14378 * @syscap SystemCapability.ArkUI.ArkUI.Full 14379 * @crossplatform 14380 * @atomicservice 14381 * @since 14 14382 */ 14383 fadingEdgeLength?: LengthMetrics; 14384} 14385 14386/** 14387 * Define nested scroll options 14388 * 14389 * @interface NestedScrollOptions 14390 * @syscap SystemCapability.ArkUI.ArkUI.Full 14391 * @since 10 14392 */ 14393/** 14394 * Define nested scroll options 14395 * 14396 * @interface NestedScrollOptions 14397 * @syscap SystemCapability.ArkUI.ArkUI.Full 14398 * @atomicservice 14399 * @since 11 14400 */ 14401declare interface NestedScrollOptions { 14402 /** 14403 * Set NestedScrollMode when the scrollable component scrolls forward 14404 * 14405 * @type { NestedScrollMode } 14406 * @syscap SystemCapability.ArkUI.ArkUI.Full 14407 * @since 10 14408 */ 14409 /** 14410 * Set NestedScrollMode when the scrollable component scrolls forward 14411 * 14412 * @type { NestedScrollMode } 14413 * @syscap SystemCapability.ArkUI.ArkUI.Full 14414 * @crossplatform 14415 * @atomicservice 14416 * @since 11 14417 */ 14418 scrollForward: NestedScrollMode; 14419 14420 /** 14421 * Set NestedScrollMode when the scrollable component scrolls backward 14422 * 14423 * @type { NestedScrollMode } 14424 * @syscap SystemCapability.ArkUI.ArkUI.Full 14425 * @since 10 14426 */ 14427 /** 14428 * Set NestedScrollMode when the scrollable component scrolls backward 14429 * 14430 * @type { NestedScrollMode } 14431 * @syscap SystemCapability.ArkUI.ArkUI.Full 14432 * @crossplatform 14433 * @atomicservice 14434 * @since 11 14435 */ 14436 scrollBackward: NestedScrollMode; 14437} 14438 14439/** 14440 * Defines the menu element. 14441 * 14442 * @interface MenuElement 14443 * @syscap SystemCapability.ArkUI.ArkUI.Full 14444 * @since 7 14445 */ 14446/** 14447 * Defines the menu element. 14448 * 14449 * @interface MenuElement 14450 * @syscap SystemCapability.ArkUI.ArkUI.Full 14451 * @crossplatform 14452 * @since 10 14453 */ 14454/** 14455 * Defines the menu element. 14456 * 14457 * @interface MenuElement 14458 * @syscap SystemCapability.ArkUI.ArkUI.Full 14459 * @crossplatform 14460 * @atomicservice 14461 * @since 11 14462 */ 14463declare interface MenuElement { 14464 /** 14465 * Sets the value of the menu element. 14466 * 14467 * @type { ResourceStr } 14468 * @syscap SystemCapability.ArkUI.ArkUI.Full 14469 * @since 7 14470 */ 14471 /** 14472 * Sets the value of the menu element. 14473 * 14474 * @type { ResourceStr } 14475 * @syscap SystemCapability.ArkUI.ArkUI.Full 14476 * @crossplatform 14477 * @since 10 14478 */ 14479 /** 14480 * Sets the value of the menu element. 14481 * 14482 * @type { ResourceStr } 14483 * @syscap SystemCapability.ArkUI.ArkUI.Full 14484 * @crossplatform 14485 * @atomicservice 14486 * @since 11 14487 */ 14488 value: ResourceStr; 14489 14490 /** 14491 * Sets the icon of the menu element. 14492 * 14493 * @type { ?ResourceStr } 14494 * @syscap SystemCapability.ArkUI.ArkUI.Full 14495 * @crossplatform 14496 * @since 10 14497 */ 14498 /** 14499 * Sets the icon of the menu element. 14500 * 14501 * @type { ?ResourceStr } 14502 * @syscap SystemCapability.ArkUI.ArkUI.Full 14503 * @crossplatform 14504 * @atomicservice 14505 * @since 11 14506 */ 14507 icon?: ResourceStr; 14508 14509 /** 14510 * Sets the symbol of the menu element. 14511 * 14512 * @type { ?SymbolGlyphModifier } 14513 * @syscap SystemCapability.ArkUI.ArkUI.Full 14514 * @atomicservice 14515 * @since 12 14516 */ 14517 symbolIcon?: SymbolGlyphModifier; 14518 14519 /** 14520 * If the value is true, the menu element is available and can respond to operations such as clicking. 14521 * If the value is false, the menu element is not available and click operations are not responded. 14522 * 14523 * @type { ?boolean } 14524 * @default true 14525 * @syscap SystemCapability.ArkUI.ArkUI.Full 14526 * @crossplatform 14527 * @since 11 14528 */ 14529 /** 14530 * If the value is true, the menu element is available and can respond to operations such as clicking. 14531 * If the value is false, the menu element is not available and click operations are not responded. 14532 * 14533 * @type { ?boolean } 14534 * @default true 14535 * @syscap SystemCapability.ArkUI.ArkUI.Full 14536 * @crossplatform 14537 * @atomicservice 14538 * @since 12 14539 */ 14540 enabled?: boolean; 14541 14542 /** 14543 * Method executed by the callback. 14544 * 14545 * @type { function } 14546 * @syscap SystemCapability.ArkUI.ArkUI.Full 14547 * @since 7 14548 */ 14549 /** 14550 * Method executed by the callback. 14551 * 14552 * @type { function } 14553 * @syscap SystemCapability.ArkUI.ArkUI.Full 14554 * @crossplatform 14555 * @since 10 14556 */ 14557 /** 14558 * Method executed by the callback. 14559 * 14560 * @type { function } 14561 * @syscap SystemCapability.ArkUI.ArkUI.Full 14562 * @crossplatform 14563 * @atomicservice 14564 * @since 11 14565 */ 14566 action: () => void; 14567} 14568 14569/** 14570 * Defines the attribute modifier. 14571 * 14572 * @interface AttributeModifier<T> 14573 * @syscap SystemCapability.ArkUI.ArkUI.Full 14574 * @crossplatform 14575 * @since 11 14576 */ 14577/** 14578 * Defines the attribute modifier. 14579 * 14580 * @interface AttributeModifier<T> 14581 * @syscap SystemCapability.ArkUI.ArkUI.Full 14582 * @crossplatform 14583 * @atomicservice 14584 * @since 12 14585 */ 14586declare interface AttributeModifier<T> { 14587 14588 /** 14589 * Defines the normal update attribute function. 14590 * 14591 * @param { T } instance 14592 * @syscap SystemCapability.ArkUI.ArkUI.Full 14593 * @crossplatform 14594 * @since 11 14595 */ 14596 /** 14597 * Defines the normal update attribute function. 14598 * 14599 * @param { T } instance 14600 * @syscap SystemCapability.ArkUI.ArkUI.Full 14601 * @crossplatform 14602 * @atomicservice 14603 * @since 12 14604 */ 14605 applyNormalAttribute?(instance: T) : void; 14606 14607 /** 14608 * Defines the pressed update attribute function. 14609 * 14610 * @param { T } instance 14611 * @syscap SystemCapability.ArkUI.ArkUI.Full 14612 * @crossplatform 14613 * @since 11 14614 */ 14615 /** 14616 * Defines the pressed update attribute function. 14617 * 14618 * @param { T } instance 14619 * @syscap SystemCapability.ArkUI.ArkUI.Full 14620 * @crossplatform 14621 * @atomicservice 14622 * @since 12 14623 */ 14624 applyPressedAttribute?(instance: T) : void; 14625 14626 /** 14627 * Defines the focused update attribute function. 14628 * 14629 * @param { T } instance 14630 * @syscap SystemCapability.ArkUI.ArkUI.Full 14631 * @crossplatform 14632 * @since 11 14633 */ 14634 /** 14635 * Defines the focused update attribute function. 14636 * 14637 * @param { T } instance 14638 * @syscap SystemCapability.ArkUI.ArkUI.Full 14639 * @crossplatform 14640 * @atomicservice 14641 * @since 12 14642 */ 14643 applyFocusedAttribute?(instance: T) : void; 14644 14645 /** 14646 * Defines the disabled update attribute function. 14647 * 14648 * @param { T } instance 14649 * @syscap SystemCapability.ArkUI.ArkUI.Full 14650 * @crossplatform 14651 * @since 11 14652 */ 14653 /** 14654 * Defines the disabled update attribute function. 14655 * 14656 * @param { T } instance 14657 * @syscap SystemCapability.ArkUI.ArkUI.Full 14658 * @crossplatform 14659 * @atomicservice 14660 * @since 12 14661 */ 14662 applyDisabledAttribute?(instance: T) : void; 14663 14664 /** 14665 * Defines the selected update attribute function. 14666 * 14667 * @param { T } instance 14668 * @syscap SystemCapability.ArkUI.ArkUI.Full 14669 * @crossplatform 14670 * @since 11 14671 */ 14672 /** 14673 * Defines the selected update attribute function. 14674 * 14675 * @param { T } instance 14676 * @syscap SystemCapability.ArkUI.ArkUI.Full 14677 * @crossplatform 14678 * @atomicservice 14679 * @since 12 14680 */ 14681 applySelectedAttribute?(instance: T) : void; 14682} 14683 14684/** 14685 * Defines the content modifier. 14686 * 14687 * @interface ContentModifier 14688 * @syscap SystemCapability.ArkUI.ArkUI.Full 14689 * @crossplatform 14690 * @atomicservice 14691 * @since 12 14692 */ 14693declare interface ContentModifier<T> { 14694 14695 /** 14696 * Defining applyContent function. 14697 * 14698 * @returns { WrappedBuilder<[T]> } 14699 * @syscap SystemCapability.ArkUI.ArkUI.Full 14700 * @crossplatform 14701 * @atomicservice 14702 * @since 12 14703 */ 14704 applyContent(): WrappedBuilder<[T]> 14705} 14706 14707/** 14708 * Defines the common configuration. 14709 * 14710 * @interface CommonConfiguration 14711 * @syscap SystemCapability.ArkUI.ArkUI.Full 14712 * @crossplatform 14713 * @atomicservice 14714 * @since 12 14715 */ 14716declare interface CommonConfiguration<T> { 14717 14718 /** 14719 * If the value is true, the contentModifier is available and can respond to operations such as triggerChange. 14720 * If it is set to false, triggerChange operations are not responded. 14721 * 14722 * @type { boolean } 14723 * @syscap SystemCapability.ArkUI.ArkUI.Full 14724 * @crossplatform 14725 * @atomicservice 14726 * @since 12 14727 */ 14728 enabled: boolean, 14729 14730 /** 14731 * Obtains the contentModifier instance object 14732 * 14733 * @type { ContentModifier<T> } 14734 * @syscap SystemCapability.ArkUI.ArkUI.Full 14735 * @crossplatform 14736 * @atomicservice 14737 * @since 12 14738 */ 14739 contentModifier: ContentModifier<T> 14740} 14741 14742/** 14743 * Outline Style 14744 * 14745 * @enum { number } 14746 * @syscap SystemCapability.ArkUI.ArkUI.Full 14747 * @crossplatform 14748 * @form 14749 * @since 11 14750 */ 14751/** 14752 * Outline Style 14753 * 14754 * @enum { number } 14755 * @syscap SystemCapability.ArkUI.ArkUI.Full 14756 * @crossplatform 14757 * @form 14758 * @atomicservice 14759 * @since 12 14760 */ 14761declare enum OutlineStyle { 14762 /** 14763 * Shows as a solid line. 14764 * 14765 * @syscap SystemCapability.ArkUI.ArkUI.Full 14766 * @crossplatform 14767 * @form 14768 * @since 11 14769 */ 14770 /** 14771 * Shows as a solid line. 14772 * 14773 * @syscap SystemCapability.ArkUI.ArkUI.Full 14774 * @crossplatform 14775 * @form 14776 * @atomicservice 14777 * @since 12 14778 */ 14779 SOLID = 0, 14780 14781 /** 14782 * Shows as a series of short square dashed lines. 14783 * 14784 * @syscap SystemCapability.ArkUI.ArkUI.Full 14785 * @crossplatform 14786 * @form 14787 * @since 11 14788 */ 14789 /** 14790 * Shows as a series of short square dashed lines. 14791 * 14792 * @syscap SystemCapability.ArkUI.ArkUI.Full 14793 * @crossplatform 14794 * @form 14795 * @atomicservice 14796 * @since 12 14797 */ 14798 DASHED = 1, 14799 14800 /** 14801 * Displays as a series of dots with a radius of half the borderWidth. 14802 * 14803 * @syscap SystemCapability.ArkUI.ArkUI.Full 14804 * @crossplatform 14805 * @form 14806 * @since 11 14807 */ 14808 /** 14809 * Displays as a series of dots with a radius of half the borderWidth. 14810 * 14811 * @syscap SystemCapability.ArkUI.ArkUI.Full 14812 * @crossplatform 14813 * @form 14814 * @atomicservice 14815 * @since 12 14816 */ 14817 DOTTED = 2, 14818} 14819 14820/** 14821 * Defines the drag preview mode. 14822 * 14823 * @enum { number } 14824 * @syscap SystemCapability.ArkUI.ArkUI.Full 14825 * @since 11 14826 */ 14827/** 14828 * Defines the drag preview mode. 14829 * 14830 * @enum { number } 14831 * @syscap SystemCapability.ArkUI.ArkUI.Full 14832 * @atomicservice 14833 * @since 12 14834 */ 14835declare enum DragPreviewMode { 14836 /** 14837 * Default preview mode, let system process preview scale. 14838 * 14839 * @syscap SystemCapability.ArkUI.ArkUI.Full 14840 * @since 11 14841 */ 14842 /** 14843 * Default preview mode, let system process preview scale. 14844 * 14845 * @syscap SystemCapability.ArkUI.ArkUI.Full 14846 * @atomicservice 14847 * @since 12 14848 */ 14849 AUTO = 1, 14850 /** 14851 * Disable system scale to preview panel 14852 * 14853 * @syscap SystemCapability.ArkUI.ArkUI.Full 14854 * @since 11 14855 */ 14856 /** 14857 * Disable system scale to preview panel 14858 * 14859 * @syscap SystemCapability.ArkUI.ArkUI.Full 14860 * @atomicservice 14861 * @since 12 14862 */ 14863 DISABLE_SCALE = 2, 14864 /** 14865 * Enable the default shadow effect of preview. 14866 * 14867 * @syscap SystemCapability.ArkUI.ArkUI.Full 14868 * @atomicservice 14869 * @since 12 14870 */ 14871 ENABLE_DEFAULT_SHADOW = 3, 14872 /** 14873 * Enable the default radius effect of preview. 14874 * 14875 * @syscap SystemCapability.ArkUI.ArkUI.Full 14876 * @atomicservice 14877 * @since 12 14878 */ 14879 ENABLE_DEFAULT_RADIUS = 4, 14880} 14881 14882/** 14883 * Define the menu pop-up policy 14884 * 14885 * @enum { number } 14886 * @syscap SystemCapability.ArkUI.ArkUI.Full 14887 * @crossplatform 14888 * @atomicservice 14889 * @since 12 14890 */ 14891declare enum MenuPolicy { 14892 /** 14893 * Default value. The default logic of whether to pop up a menu depends on the scene. 14894 * 14895 * @syscap SystemCapability.ArkUI.ArkUI.Full 14896 * @crossplatform 14897 * @atomicservice 14898 * @since 12 14899 */ 14900 DEFAULT = 0, 14901 14902 /** 14903 * Hide pop up menu. 14904 * 14905 * @syscap SystemCapability.ArkUI.ArkUI.Full 14906 * @crossplatform 14907 * @atomicservice 14908 * @since 12 14909 */ 14910 HIDE = 1, 14911 14912 /** 14913 * Show pop up menu. 14914 * 14915 * @syscap SystemCapability.ArkUI.ArkUI.Full 14916 * @crossplatform 14917 * @atomicservice 14918 * @since 12 14919 */ 14920 SHOW = 2, 14921} 14922 14923/** 14924 * ImageModifier 14925 * 14926 * @typedef { import('../api/arkui/ImageModifier').ImageModifier } ImageModifier 14927 * @syscap SystemCapability.ArkUI.ArkUI.Full 14928 * @crossplatform 14929 * @atomicservice 14930 * @since 12 14931 */ 14932declare type ImageModifier = import('../api/arkui/ImageModifier').ImageModifier; 14933 14934/** 14935 * SymbolGlyphModifier 14936 * 14937 * @typedef {import('../api/arkui/SymbolGlyphModifier').SymbolGlyphModifier} SymbolGlyphModifier 14938 * @syscap SystemCapability.ArkUI.ArkUI.Full 14939 * @atomicservice 14940 * @since 12 14941 */ 14942declare type SymbolGlyphModifier = import('../api/arkui/SymbolGlyphModifier').SymbolGlyphModifier; 14943 14944/** 14945 * Defines the preview options. 14946 * 14947 * @interface DragPreviewOptions 14948 * @syscap SystemCapability.ArkUI.ArkUI.Full 14949 * @since 11 14950 */ 14951/** 14952 * Defines the preview options. 14953 * 14954 * @interface DragPreviewOptions 14955 * @syscap SystemCapability.ArkUI.ArkUI.Full 14956 * @atomicservice 14957 * @since 12 14958 */ 14959declare interface DragPreviewOptions { 14960 /** 14961 * Drag preview mode. 14962 * 14963 * @type { ?DragPreviewMode } 14964 * @syscap SystemCapability.ArkUI.ArkUI.Full 14965 * @since 11 14966 */ 14967 /** 14968 * Drag preview mode. 14969 * 14970 * @type { ?(DragPreviewMode | Array<DragPreviewMode>) } 14971 * @syscap SystemCapability.ArkUI.ArkUI.Full 14972 * @atomicservice 14973 * @since 12 14974 */ 14975 mode?: DragPreviewMode | Array<DragPreviewMode>; 14976 14977 /** 14978 * Drag preview modifier. 14979 * 14980 * @type { ?ImageModifier } 14981 * @syscap SystemCapability.ArkUI.ArkUI.Full 14982 * @atomicservice 14983 * @since 12 14984 */ 14985 modifier?: ImageModifier; 14986 14987 /** 14988 * The flag for number showing. 14989 * 14990 * @type { ?(boolean | number) } 14991 * @syscap SystemCapability.ArkUI.ArkUI.Full 14992 * @atomicservice 14993 * @since 12 14994 */ 14995 numberBadge?: boolean | number; 14996} 14997 14998/** 14999 * Defines the drag options. 15000 * 15001 * @interface DragInteractionOptions 15002 * @syscap SystemCapability.ArkUI.ArkUI.Full 15003 * @atomicservice 15004 * @since 12 15005 */ 15006declare interface DragInteractionOptions { 15007 /** 15008 * Define whether to gather selected nodes in grid or list. 15009 * 15010 * @type { ?boolean } 15011 * @syscap SystemCapability.ArkUI.ArkUI.Full 15012 * @atomicservice 15013 * @since 12 15014 */ 15015 isMultiSelectionEnabled?: boolean; 15016 15017 /** 15018 * Define whether to execute animation before preview floating. 15019 * 15020 * @type { ?boolean } 15021 * @syscap SystemCapability.ArkUI.ArkUI.Full 15022 * @atomicservice 15023 * @since 12 15024 */ 15025 defaultAnimationBeforeLifting?: boolean; 15026} 15027 15028/** 15029 * Define the options of invert 15030 * 15031 * @interface InvertOptions 15032 * @syscap SystemCapability.ArkUI.ArkUI.Full 15033 * @since 11 15034 */ 15035/** 15036 * Define the options of invert 15037 * 15038 * @interface InvertOptions 15039 * @syscap SystemCapability.ArkUI.ArkUI.Full 15040 * @atomicservice 15041 * @since 12 15042 */ 15043declare interface InvertOptions { 15044 15045 /** 15046 * Defines the low value of threshold 15047 * 15048 * @type { number } 15049 * @syscap SystemCapability.ArkUI.ArkUI.Full 15050 * @crossplatform 15051 * @since 11 15052 */ 15053 /** 15054 * Defines the low value of threshold 15055 * 15056 * @type { number } 15057 * @syscap SystemCapability.ArkUI.ArkUI.Full 15058 * @crossplatform 15059 * @atomicservice 15060 * @since 12 15061 */ 15062 low: number; 15063 15064 /** 15065 * Defines the high value of threshold 15066 * 15067 * @type { number } 15068 * @syscap SystemCapability.ArkUI.ArkUI.Full 15069 * @crossplatform 15070 * @since 11 15071 */ 15072 /** 15073 * Defines the high value of threshold 15074 * 15075 * @type { number } 15076 * @syscap SystemCapability.ArkUI.ArkUI.Full 15077 * @crossplatform 15078 * @atomicservice 15079 * @since 12 15080 */ 15081 high: number; 15082 15083 /** 15084 * Defines the threshold 15085 * 15086 * @type { number } 15087 * @syscap SystemCapability.ArkUI.ArkUI.Full 15088 * @crossplatform 15089 * @since 11 15090 */ 15091 /** 15092 * Defines the threshold 15093 * 15094 * @type { number } 15095 * @syscap SystemCapability.ArkUI.ArkUI.Full 15096 * @crossplatform 15097 * @atomicservice 15098 * @since 12 15099 */ 15100 threshold: number; 15101 15102 /** 15103 *Defines the threshold range 15104 * 15105 * @type { number } 15106 * @syscap SystemCapability.ArkUI.ArkUI.Full 15107 * @crossplatform 15108 * @since 11 15109 */ 15110 /** 15111 *Defines the threshold range 15112 * 15113 * @type { number } 15114 * @syscap SystemCapability.ArkUI.ArkUI.Full 15115 * @crossplatform 15116 * @atomicservice 15117 * @since 12 15118 */ 15119 thresholdRange: number; 15120} 15121 15122/** 15123 * Import the CircleShape type object for common method. 15124 * 15125 * @typedef { import('../api/@ohos.arkui.shape').CircleShape } CircleShape 15126 * @syscap SystemCapability.ArkUI.ArkUI.Full 15127 * @crossplatform 15128 * @form 15129 * @atomicservice 15130 * @since 12 15131 */ 15132declare type CircleShape = import('../api/@ohos.arkui.shape').CircleShape; 15133 15134/** 15135 * Import the EllipseShape type object for common method. 15136 * 15137 * @typedef { import('../api/@ohos.arkui.shape').EllipseShape } EllipseShape 15138 * @syscap SystemCapability.ArkUI.ArkUI.Full 15139 * @crossplatform 15140 * @form 15141 * @atomicservice 15142 * @since 12 15143 */ 15144declare type EllipseShape = import('../api/@ohos.arkui.shape').EllipseShape; 15145 15146/** 15147 * Import the PathShape type object for common method. 15148 * 15149 * @typedef { import('../api/@ohos.arkui.shape').PathShape } PathShape 15150 * @syscap SystemCapability.ArkUI.ArkUI.Full 15151 * @crossplatform 15152 * @form 15153 * @atomicservice 15154 * @since 12 15155 */ 15156declare type PathShape = import('../api/@ohos.arkui.shape').PathShape; 15157 15158/** 15159 * Import the RectShape type object for common method. 15160 * 15161 * @typedef { import('../api/@ohos.arkui.shape').RectShape } RectShape 15162 * @syscap SystemCapability.ArkUI.ArkUI.Full 15163 * @crossplatform 15164 * @form 15165 * @atomicservice 15166 * @since 12 15167 */ 15168declare type RectShape = import('../api/@ohos.arkui.shape').RectShape; 15169 15170/** 15171 * Defines the type that can be undefined. 15172 * 15173 * @typedef { T | undefined } Optional<T> 15174 * @syscap SystemCapability.ArkUI.ArkUI.Full 15175 * @crossplatform 15176 * @form 15177 * @atomicservice 15178 * @since 12 15179 */ 15180declare type Optional<T> = T | undefined; 15181 15182/** 15183 * CommonMethod. 15184 * 15185 * @syscap SystemCapability.ArkUI.ArkUI.Full 15186 * @since 7 15187 */ 15188/** 15189 * CommonMethod. 15190 * 15191 * @syscap SystemCapability.ArkUI.ArkUI.Full 15192 * @form 15193 * @since 9 15194 */ 15195/** 15196 * CommonMethod. 15197 * 15198 * @syscap SystemCapability.ArkUI.ArkUI.Full 15199 * @crossplatform 15200 * @form 15201 * @since 10 15202 */ 15203/** 15204 * CommonMethod. 15205 * 15206 * @syscap SystemCapability.ArkUI.ArkUI.Full 15207 * @crossplatform 15208 * @form 15209 * @atomicservice 15210 * @since 11 15211 */ 15212declare class CommonMethod<T> { 15213 /** 15214 * constructor. 15215 * 15216 * @syscap SystemCapability.ArkUI.ArkUI.Full 15217 * @systemapi 15218 * @since 7 15219 */ 15220 /** 15221 * constructor. 15222 * 15223 * @syscap SystemCapability.ArkUI.ArkUI.Full 15224 * @systemapi 15225 * @form 15226 * @since 9 15227 */ 15228 constructor(); 15229 15230 /** 15231 * Sets the width of the current component. 15232 * 15233 * @param { Length } value 15234 * @returns { T } 15235 * @syscap SystemCapability.ArkUI.ArkUI.Full 15236 * @since 7 15237 */ 15238 /** 15239 * Sets the width of the current component. 15240 * 15241 * @param { Length } value 15242 * @returns { T } 15243 * @syscap SystemCapability.ArkUI.ArkUI.Full 15244 * @form 15245 * @since 9 15246 */ 15247 /** 15248 * Sets the width of the current component. 15249 * 15250 * @param { Length } value 15251 * @returns { T } 15252 * @syscap SystemCapability.ArkUI.ArkUI.Full 15253 * @crossplatform 15254 * @form 15255 * @since 10 15256 */ 15257 /** 15258 * Sets the width of the current component. 15259 * 15260 * @param { Length } value 15261 * @returns { T } 15262 * @syscap SystemCapability.ArkUI.ArkUI.Full 15263 * @crossplatform 15264 * @form 15265 * @atomicservice 15266 * @since 11 15267 */ 15268 width(value: Length): T; 15269 15270 /** 15271 * Sets the height of the current component. 15272 * 15273 * @param { Length } value 15274 * @returns { T } 15275 * @syscap SystemCapability.ArkUI.ArkUI.Full 15276 * @since 7 15277 */ 15278 /** 15279 * Sets the height of the current component. 15280 * 15281 * @param { Length } value 15282 * @returns { T } 15283 * @syscap SystemCapability.ArkUI.ArkUI.Full 15284 * @form 15285 * @since 9 15286 */ 15287 /** 15288 * Sets the height of the current component. 15289 * 15290 * @param { Length } value 15291 * @returns { T } 15292 * @syscap SystemCapability.ArkUI.ArkUI.Full 15293 * @crossplatform 15294 * @form 15295 * @since 10 15296 */ 15297 /** 15298 * Sets the height of the current component. 15299 * 15300 * @param { Length } value 15301 * @returns { T } 15302 * @syscap SystemCapability.ArkUI.ArkUI.Full 15303 * @crossplatform 15304 * @form 15305 * @atomicservice 15306 * @since 11 15307 */ 15308 height(value: Length): T; 15309 15310 /** 15311 * Sets the drawModifier of the current component. 15312 * 15313 * @param { DrawModifier | undefined } modifier - drawModifier used to draw, or undefined if it is not available. 15314 * @returns { T } 15315 * @syscap SystemCapability.ArkUI.ArkUI.Full 15316 * @crossplatform 15317 * @atomicservice 15318 * @since 12 15319 */ 15320 drawModifier(modifier: DrawModifier | undefined): T; 15321 15322 /** 15323 * Sets the custom property of the current component. 15324 * 15325 * @param { string } name - the name of the custom property. 15326 * @param { Optional<Object> } value - the value of the custom property. 15327 * @returns { T } 15328 * @syscap SystemCapability.ArkUI.ArkUI.Full 15329 * @crossplatform 15330 * @atomicservice 15331 * @since 12 15332 */ 15333 customProperty(name: string, value: Optional<Object>): T; 15334 15335 /** 15336 * Expands the safe area. 15337 * 15338 * @param { Array<SafeAreaType> } types - Indicates the types of the safe area. 15339 * @param { Array<SafeAreaEdge> } edges - Indicates the edges of the safe area. 15340 * @returns { T } The component instance. 15341 * @syscap SystemCapability.ArkUI.ArkUI.Full 15342 * @crossplatform 15343 * @since 10 15344 */ 15345 /** 15346 * Expands the safe area. 15347 * 15348 * @param { Array<SafeAreaType> } types - Indicates the types of the safe area. 15349 * @param { Array<SafeAreaEdge> } edges - Indicates the edges of the safe area. 15350 * @returns { T } The component instance. 15351 * @syscap SystemCapability.ArkUI.ArkUI.Full 15352 * @crossplatform 15353 * @atomicservice 15354 * @since 11 15355 */ 15356 expandSafeArea(types?: Array<SafeAreaType>, edges?: Array<SafeAreaEdge>): T; 15357 15358 /** 15359 * Sets the response region of the current component. 15360 * 15361 * @param { Array<Rectangle> | Rectangle } value 15362 * @returns { T } 15363 * @syscap SystemCapability.ArkUI.ArkUI.Full 15364 * @since 8 15365 */ 15366 /** 15367 * Sets the response region of the current component. 15368 * 15369 * @param { Array<Rectangle> | Rectangle } value 15370 * @returns { T } 15371 * @syscap SystemCapability.ArkUI.ArkUI.Full 15372 * @form 15373 * @since 9 15374 */ 15375 /** 15376 * Sets the response region of the current component. 15377 * 15378 * @param { Array<Rectangle> | Rectangle } value 15379 * @returns { T } 15380 * @syscap SystemCapability.ArkUI.ArkUI.Full 15381 * @crossplatform 15382 * @form 15383 * @since 10 15384 */ 15385 /** 15386 * Sets the response region of the current component. 15387 * 15388 * @param { Array<Rectangle> | Rectangle } value 15389 * @returns { T } 15390 * @syscap SystemCapability.ArkUI.ArkUI.Full 15391 * @crossplatform 15392 * @form 15393 * @atomicservice 15394 * @since 11 15395 */ 15396 responseRegion(value: Array<Rectangle> | Rectangle): T; 15397 15398 /** 15399 * Sets the mouse response region of current component 15400 * 15401 * @param { Array<Rectangle> | Rectangle } value 15402 * @returns { T } return the component attribute 15403 * @syscap SystemCapability.ArkUI.ArkUI.Full 15404 * @crossplatform 15405 * @since 10 15406 */ 15407 /** 15408 * Sets the mouse response region of current component 15409 * 15410 * @param { Array<Rectangle> | Rectangle } value 15411 * @returns { T } return the component attribute 15412 * @syscap SystemCapability.ArkUI.ArkUI.Full 15413 * @crossplatform 15414 * @atomicservice 15415 * @since 11 15416 */ 15417 mouseResponseRegion(value: Array<Rectangle> | Rectangle): T; 15418 15419 /** 15420 * The size of the current component. 15421 * 15422 * @param { SizeOptions } value 15423 * @returns { T } 15424 * @syscap SystemCapability.ArkUI.ArkUI.Full 15425 * @since 7 15426 */ 15427 /** 15428 * The size of the current component. 15429 * 15430 * @param { SizeOptions } value 15431 * @returns { T } 15432 * @syscap SystemCapability.ArkUI.ArkUI.Full 15433 * @form 15434 * @since 9 15435 */ 15436 /** 15437 * The size of the current component. 15438 * 15439 * @param { SizeOptions } value 15440 * @returns { T } 15441 * @syscap SystemCapability.ArkUI.ArkUI.Full 15442 * @crossplatform 15443 * @form 15444 * @since 10 15445 */ 15446 /** 15447 * The size of the current component. 15448 * 15449 * @param { SizeOptions } value 15450 * @returns { T } 15451 * @syscap SystemCapability.ArkUI.ArkUI.Full 15452 * @crossplatform 15453 * @form 15454 * @atomicservice 15455 * @since 11 15456 */ 15457 size(value: SizeOptions): T; 15458 15459 /** 15460 * constraint Size: 15461 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 15462 * 15463 * @param { ConstraintSizeOptions } value 15464 * @returns { T } 15465 * @syscap SystemCapability.ArkUI.ArkUI.Full 15466 * @since 7 15467 */ 15468 /** 15469 * constraint Size: 15470 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 15471 * 15472 * @param { ConstraintSizeOptions } value 15473 * @returns { T } 15474 * @syscap SystemCapability.ArkUI.ArkUI.Full 15475 * @form 15476 * @since 9 15477 */ 15478 /** 15479 * constraint Size: 15480 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 15481 * 15482 * @param { ConstraintSizeOptions } value 15483 * @returns { T } 15484 * @syscap SystemCapability.ArkUI.ArkUI.Full 15485 * @crossplatform 15486 * @form 15487 * @since 10 15488 */ 15489 /** 15490 * constraint Size: 15491 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 15492 * 15493 * @param { ConstraintSizeOptions } value 15494 * @returns { T } 15495 * @syscap SystemCapability.ArkUI.ArkUI.Full 15496 * @crossplatform 15497 * @form 15498 * @atomicservice 15499 * @since 11 15500 */ 15501 constraintSize(value: ConstraintSizeOptions): T; 15502 15503 /** 15504 * Sets the touchable of the current component 15505 * 15506 * @param { boolean } value 15507 * @returns { T } 15508 * @syscap SystemCapability.ArkUI.ArkUI.Full 15509 * @since 7 15510 * @deprecated since 9 15511 * @useinstead hitTestBehavior 15512 */ 15513 touchable(value: boolean): T; 15514 15515 /** 15516 * Defines the component's hit test behavior in touch events. 15517 * 15518 * @param { HitTestMode } value - the hit test mode. 15519 * @returns { T } 15520 * @syscap SystemCapability.ArkUI.ArkUI.Full 15521 * @since 9 15522 */ 15523 /** 15524 * Defines the component's hit test behavior in touch events. 15525 * 15526 * @param { HitTestMode } value - the hit test mode. 15527 * @returns { T } 15528 * @syscap SystemCapability.ArkUI.ArkUI.Full 15529 * @crossplatform 15530 * @since 10 15531 */ 15532 /** 15533 * Defines the component's hit test behavior in touch events. 15534 * 15535 * @param { HitTestMode } value - the hit test mode. 15536 * @returns { T } 15537 * @syscap SystemCapability.ArkUI.ArkUI.Full 15538 * @crossplatform 15539 * @atomicservice 15540 * @since 11 15541 */ 15542 hitTestBehavior(value: HitTestMode): T; 15543 15544 /** 15545 * Defines the pre-touch test of sub component in touch events. 15546 * 15547 * @param { function } event 15548 * @returns { T } 15549 * @syscap SystemCapability.ArkUI.ArkUI.Full 15550 * @crossplatform 15551 * @since 11 15552 */ 15553 /** 15554 * Defines the pre-touch test of sub component in touch events. 15555 * 15556 * @param { function } event 15557 * @returns { T } 15558 * @syscap SystemCapability.ArkUI.ArkUI.Full 15559 * @crossplatform 15560 * @atomicservice 15561 * @since 12 15562 */ 15563 onChildTouchTest(event: (value: Array<TouchTestInfo>) => TouchResult): T; 15564 15565 /** 15566 * layout Weight 15567 * 15568 * @param { number | string } value 15569 * @returns { T } 15570 * @syscap SystemCapability.ArkUI.ArkUI.Full 15571 * @since 7 15572 */ 15573 /** 15574 * layout Weight 15575 * 15576 * @param { number | string } value 15577 * @returns { T } 15578 * @syscap SystemCapability.ArkUI.ArkUI.Full 15579 * @form 15580 * @since 9 15581 */ 15582 /** 15583 * layout Weight 15584 * 15585 * @param { number | string } value 15586 * @returns { T } 15587 * @syscap SystemCapability.ArkUI.ArkUI.Full 15588 * @crossplatform 15589 * @form 15590 * @since 10 15591 */ 15592 /** 15593 * layout Weight 15594 * 15595 * @param { number | string } value 15596 * @returns { T } 15597 * @syscap SystemCapability.ArkUI.ArkUI.Full 15598 * @crossplatform 15599 * @form 15600 * @atomicservice 15601 * @since 11 15602 */ 15603 layoutWeight(value: number | string): T; 15604 15605 /** 15606 * chain Weight 15607 * 15608 * @param { ChainWeightOptions } chainWeight 15609 * @returns { T } 15610 * @syscap SystemCapability.ArkUI.ArkUI.Full 15611 * @crossplatform 15612 * @atomicservice 15613 * @since 14 15614 */ 15615 chainWeight(chainWeight: ChainWeightOptions): T; 15616 15617 /** 15618 * Inner margin. 15619 * 15620 * @param { Padding | Length } value 15621 * @returns { T } 15622 * @syscap SystemCapability.ArkUI.ArkUI.Full 15623 * @since 7 15624 */ 15625 /** 15626 * Inner margin. 15627 * 15628 * @param { Padding | Length } value 15629 * @returns { T } 15630 * @syscap SystemCapability.ArkUI.ArkUI.Full 15631 * @form 15632 * @since 9 15633 */ 15634 /** 15635 * Inner margin. 15636 * 15637 * @param { Padding | Length } value 15638 * @returns { T } 15639 * @syscap SystemCapability.ArkUI.ArkUI.Full 15640 * @crossplatform 15641 * @form 15642 * @since 10 15643 */ 15644 /** 15645 * Inner margin. 15646 * 15647 * @param { Padding | Length } value 15648 * @returns { T } 15649 * @syscap SystemCapability.ArkUI.ArkUI.Full 15650 * @crossplatform 15651 * @form 15652 * @atomicservice 15653 * @since 11 15654 */ 15655 /** 15656 * Inner margin. 15657 * 15658 * @param { Padding | Length | LocalizedPadding } value 15659 * @returns { T } 15660 * @syscap SystemCapability.ArkUI.ArkUI.Full 15661 * @crossplatform 15662 * @form 15663 * @atomicservice 15664 * @since 12 15665 */ 15666 padding(value: Padding | Length | LocalizedPadding): T; 15667 15668 /** 15669 * Inner safeArea padding. 15670 * 15671 * @param { Padding | LengthMetrics | LocalizedPadding } paddingValue - Indicates safeArea padding values 15672 * @returns { T } 15673 * @syscap SystemCapability.ArkUI.ArkUI.Full 15674 * @crossplatform 15675 * @form 15676 * @atomicservice 15677 * @since 14 15678 */ 15679 safeAreaPadding(paddingValue: Padding | LengthMetrics | LocalizedPadding): T; 15680 15681 /** 15682 * Outer Margin. 15683 * 15684 * @param { Margin | Length } value 15685 * @returns { T } 15686 * @syscap SystemCapability.ArkUI.ArkUI.Full 15687 * @since 7 15688 */ 15689 /** 15690 * Outer Margin. 15691 * 15692 * @param { Margin | Length } value 15693 * @returns { T } 15694 * @syscap SystemCapability.ArkUI.ArkUI.Full 15695 * @form 15696 * @since 9 15697 */ 15698 /** 15699 * Outer Margin. 15700 * 15701 * @param { Margin | Length } value 15702 * @returns { T } 15703 * @syscap SystemCapability.ArkUI.ArkUI.Full 15704 * @crossplatform 15705 * @form 15706 * @since 10 15707 */ 15708 /** 15709 * Outer Margin. 15710 * 15711 * @param { Margin | Length } value 15712 * @returns { T } 15713 * @syscap SystemCapability.ArkUI.ArkUI.Full 15714 * @crossplatform 15715 * @form 15716 * @atomicservice 15717 * @since 11 15718 */ 15719 /** 15720 * Outer Margin. 15721 * 15722 * @param { Margin | Length | LocalizedMargin } value 15723 * @returns { T } 15724 * @syscap SystemCapability.ArkUI.ArkUI.Full 15725 * @crossplatform 15726 * @form 15727 * @atomicservice 15728 * @since 12 15729 */ 15730 margin(value: Margin | Length | LocalizedMargin): T; 15731 15732 /** 15733 * Background. 15734 * 15735 * @param { CustomBuilder } builder 15736 * @param { object } options 15737 * @returns { T } 15738 * @syscap SystemCapability.ArkUI.ArkUI.Full 15739 * @crossplatform 15740 * @since 10 15741 */ 15742 /** 15743 * Background. 15744 * 15745 * @param { CustomBuilder } builder 15746 * @param { object } options 15747 * @returns { T } 15748 * @syscap SystemCapability.ArkUI.ArkUI.Full 15749 * @crossplatform 15750 * @atomicservice 15751 * @since 11 15752 */ 15753 background(builder: CustomBuilder, options?: { align?: Alignment }): T; 15754 15755 /** 15756 * Background color 15757 * 15758 * @param { ResourceColor } value 15759 * @returns { T } 15760 * @syscap SystemCapability.ArkUI.ArkUI.Full 15761 * @since 7 15762 */ 15763 /** 15764 * Background color 15765 * 15766 * @param { ResourceColor } value 15767 * @returns { T } 15768 * @syscap SystemCapability.ArkUI.ArkUI.Full 15769 * @form 15770 * @since 9 15771 */ 15772 /** 15773 * Background color 15774 * 15775 * @param { ResourceColor } value 15776 * @returns { T } 15777 * @syscap SystemCapability.ArkUI.ArkUI.Full 15778 * @crossplatform 15779 * @form 15780 * @since 10 15781 */ 15782 /** 15783 * Background color 15784 * 15785 * @param { ResourceColor } value 15786 * @returns { T } 15787 * @syscap SystemCapability.ArkUI.ArkUI.Full 15788 * @crossplatform 15789 * @form 15790 * @atomicservice 15791 * @since 11 15792 */ 15793 backgroundColor(value: ResourceColor): T; 15794 15795 /** 15796 * PixelRound 15797 * 15798 * @param { PixelRoundPolicy } value - indicates the pixel round policy. 15799 * @returns { T } 15800 * @syscap SystemCapability.ArkUI.ArkUI.Full 15801 * @crossplatform 15802 * @form 15803 * @atomicservice 15804 * @since 11 15805 */ 15806 pixelRound(value: PixelRoundPolicy): T; 15807 15808 /** 15809 * Background image 15810 * src: Image address url 15811 * 15812 * @param { ResourceStr } src 15813 * @param { ImageRepeat } repeat 15814 * @returns { T } 15815 * @syscap SystemCapability.ArkUI.ArkUI.Full 15816 * @since 7 15817 */ 15818 /** 15819 * Background image 15820 * src: Image address url 15821 * 15822 * @param { ResourceStr } src 15823 * @param { ImageRepeat } repeat 15824 * @returns { T } 15825 * @syscap SystemCapability.ArkUI.ArkUI.Full 15826 * @form 15827 * @since 9 15828 */ 15829 /** 15830 * Background image 15831 * src: Image address url 15832 * 15833 * @param { ResourceStr } src 15834 * @param { ImageRepeat } repeat 15835 * @returns { T } 15836 * @syscap SystemCapability.ArkUI.ArkUI.Full 15837 * @crossplatform 15838 * @form 15839 * @since 10 15840 */ 15841 /** 15842 * Background image 15843 * src: Image address url 15844 * 15845 * @param { ResourceStr } src 15846 * @param { ImageRepeat } repeat 15847 * @returns { T } 15848 * @syscap SystemCapability.ArkUI.ArkUI.Full 15849 * @crossplatform 15850 * @form 15851 * @atomicservice 15852 * @since 11 15853 */ 15854 /** 15855 * Background image 15856 * src: Image address url 15857 * 15858 * @param { ResourceStr | PixelMap } src 15859 * @param { ImageRepeat } repeat 15860 * @returns { T } 15861 * @syscap SystemCapability.ArkUI.ArkUI.Full 15862 * @crossplatform 15863 * @form 15864 * @atomicservice 15865 * @since 12 15866 */ 15867 backgroundImage(src: ResourceStr | PixelMap, repeat?: ImageRepeat): T; 15868 15869 /** 15870 * Background image size 15871 * 15872 * @param { SizeOptions | ImageSize } value 15873 * @returns { T } 15874 * @syscap SystemCapability.ArkUI.ArkUI.Full 15875 * @since 7 15876 */ 15877 /** 15878 * Background image size 15879 * 15880 * @param { SizeOptions | ImageSize } value 15881 * @returns { T } 15882 * @syscap SystemCapability.ArkUI.ArkUI.Full 15883 * @form 15884 * @since 9 15885 */ 15886 /** 15887 * Background image size 15888 * 15889 * @param { SizeOptions | ImageSize } value 15890 * @returns { T } 15891 * @syscap SystemCapability.ArkUI.ArkUI.Full 15892 * @crossplatform 15893 * @form 15894 * @since 10 15895 */ 15896 /** 15897 * Background image size 15898 * 15899 * @param { SizeOptions | ImageSize } value 15900 * @returns { T } 15901 * @syscap SystemCapability.ArkUI.ArkUI.Full 15902 * @crossplatform 15903 * @form 15904 * @atomicservice 15905 * @since 11 15906 */ 15907 backgroundImageSize(value: SizeOptions | ImageSize): T; 15908 15909 /** 15910 * Background image position 15911 * x:Horizontal coordinate;y:Vertical axis coordinate. 15912 * 15913 * @param { Position | Alignment } value 15914 * @returns { T } 15915 * @syscap SystemCapability.ArkUI.ArkUI.Full 15916 * @since 7 15917 */ 15918 /** 15919 * Background image position 15920 * x:Horizontal coordinate;y:Vertical axis coordinate. 15921 * 15922 * @param { Position | Alignment } value 15923 * @returns { T } 15924 * @syscap SystemCapability.ArkUI.ArkUI.Full 15925 * @form 15926 * @since 9 15927 */ 15928 /** 15929 * Background image position 15930 * x:Horizontal coordinate;y:Vertical axis coordinate. 15931 * 15932 * @param { Position | Alignment } value 15933 * @returns { T } 15934 * @syscap SystemCapability.ArkUI.ArkUI.Full 15935 * @crossplatform 15936 * @form 15937 * @since 10 15938 */ 15939 /** 15940 * Background image position 15941 * x:Horizontal coordinate;y:Vertical axis coordinate. 15942 * 15943 * @param { Position | Alignment } value 15944 * @returns { T } 15945 * @syscap SystemCapability.ArkUI.ArkUI.Full 15946 * @crossplatform 15947 * @form 15948 * @atomicservice 15949 * @since 11 15950 */ 15951 backgroundImagePosition(value: Position | Alignment): T; 15952 15953 /** 15954 * Background blur style. 15955 * blurStyle:Blur style type. 15956 * 15957 * @param { BlurStyle } value 15958 * @param { BackgroundBlurStyleOptions } options 15959 * @returns { T } 15960 * @syscap SystemCapability.ArkUI.ArkUI.Full 15961 * @form 15962 * @since 9 15963 */ 15964 /** 15965 * Background blur style. 15966 * blurStyle:Blur style type. 15967 * 15968 * @param { BlurStyle } value 15969 * @param { BackgroundBlurStyleOptions } options 15970 * @returns { T } 15971 * @syscap SystemCapability.ArkUI.ArkUI.Full 15972 * @crossplatform 15973 * @form 15974 * @since 10 15975 */ 15976 /** 15977 * Background blur style. 15978 * blurStyle:Blur style type. 15979 * 15980 * @param { BlurStyle } value 15981 * @param { BackgroundBlurStyleOptions } options 15982 * @returns { T } 15983 * @syscap SystemCapability.ArkUI.ArkUI.Full 15984 * @crossplatform 15985 * @form 15986 * @atomicservice 15987 * @since 11 15988 */ 15989 backgroundBlurStyle(value: BlurStyle, options?: BackgroundBlurStyleOptions): T; 15990 15991 /** 15992 * options:background effect options. 15993 * 15994 * @param { BackgroundEffectOptions } options - options indicates the effect options. 15995 * @returns { T } 15996 * @syscap SystemCapability.ArkUI.ArkUI.Full 15997 * @crossplatform 15998 * @since 11 15999 */ 16000 /** 16001 * options:background effect options. 16002 * 16003 * @param { BackgroundEffectOptions } options - options indicates the effect options. 16004 * @returns { T } 16005 * @syscap SystemCapability.ArkUI.ArkUI.Full 16006 * @crossplatform 16007 * @atomicservice 16008 * @since 12 16009 */ 16010 backgroundEffect(options: BackgroundEffectOptions): T; 16011 16012 /** 16013 * Background image resizable. 16014 * value:resizable options 16015 * 16016 * @param { ResizableOptions } value - Indicates the resizable options. 16017 * @returns { T } 16018 * @syscap SystemCapability.ArkUI.ArkUI.Full 16019 * @crossplatform 16020 * @atomicservice 16021 * @since 12 16022 */ 16023 backgroundImageResizable(value: ResizableOptions): T; 16024 16025 /** 16026 * Foreground effect. 16027 * 16028 * @param { ForegroundEffectOptions } options - options indicates the effect options. 16029 * @returns { T } 16030 * @syscap SystemCapability.ArkUI.ArkUI.Full 16031 * @crossplatform 16032 * @atomicservice 16033 * @since 12 16034 */ 16035 foregroundEffect(options: ForegroundEffectOptions): T; 16036 16037 16038 /** 16039 * Unified visual effect interface. 16040 * 16041 * @param { VisualEffect } effect - Visual effect parameters. 16042 * @returns { T } 16043 * @syscap SystemCapability.ArkUI.ArkUI.Full 16044 * @crossplatform 16045 * @atomicservice 16046 * @since 12 16047 */ 16048 visualEffect(effect: VisualEffect): T; 16049 16050 /** 16051 * Filter applied to the background layer of the component. 16052 * 16053 * @param { Filter } filter - Filter effect parameters. 16054 * @returns { T } 16055 * @syscap SystemCapability.ArkUI.ArkUI.Full 16056 * @crossplatform 16057 * @atomicservice 16058 * @since 12 16059 */ 16060 backgroundFilter(filter: Filter): T; 16061 16062 /** 16063 * Filter applied to the foreground layer of the component. 16064 * 16065 * @param { Filter } filter - Filter effect parameters. 16066 * @returns { T } 16067 * @syscap SystemCapability.ArkUI.ArkUI.Full 16068 * @crossplatform 16069 * @atomicservice 16070 * @since 12 16071 */ 16072 foregroundFilter(filter: Filter): T; 16073 16074 /** 16075 * Filter applied to the compositing layer of the component. 16076 * 16077 * @param { Filter } filter - Filter effect parameters. 16078 * @returns { T } 16079 * @syscap SystemCapability.ArkUI.ArkUI.Full 16080 * @crossplatform 16081 * @atomicservice 16082 * @since 12 16083 */ 16084 compositingFilter(filter: Filter): T; 16085 16086 /** 16087 * Foreground blur style. 16088 * blurStyle:Blur style type. 16089 * 16090 * @param { BlurStyle } value 16091 * @param { ForegroundBlurStyleOptions } options 16092 * @returns { T } 16093 * @syscap SystemCapability.ArkUI.ArkUI.Full 16094 * @crossplatform 16095 * @since 10 16096 */ 16097 /** 16098 * Foreground blur style. 16099 * blurStyle:Blur style type. 16100 * 16101 * @param { BlurStyle } value 16102 * @param { ForegroundBlurStyleOptions } options 16103 * @returns { T } 16104 * @syscap SystemCapability.ArkUI.ArkUI.Full 16105 * @crossplatform 16106 * @atomicservice 16107 * @since 11 16108 */ 16109 foregroundBlurStyle(value: BlurStyle, options?: ForegroundBlurStyleOptions): T; 16110 16111 /** 16112 * Opacity 16113 * 16114 * @param { number | Resource } value 16115 * @returns { T } 16116 * @syscap SystemCapability.ArkUI.ArkUI.Full 16117 * @since 7 16118 */ 16119 /** 16120 * Opacity 16121 * 16122 * @param { number | Resource } value 16123 * @returns { T } 16124 * @syscap SystemCapability.ArkUI.ArkUI.Full 16125 * @form 16126 * @since 9 16127 */ 16128 /** 16129 * Opacity 16130 * 16131 * @param { number | Resource } value 16132 * @returns { T } 16133 * @syscap SystemCapability.ArkUI.ArkUI.Full 16134 * @crossplatform 16135 * @form 16136 * @since 10 16137 */ 16138 /** 16139 * Opacity 16140 * 16141 * @param { number | Resource } value 16142 * @returns { T } 16143 * @syscap SystemCapability.ArkUI.ArkUI.Full 16144 * @crossplatform 16145 * @form 16146 * @atomicservice 16147 * @since 11 16148 */ 16149 opacity(value: number | Resource): T; 16150 16151 /** 16152 * Border 16153 * width:Border width;color:Border color;radius:Border radius; 16154 * 16155 * @param { BorderOptions } value 16156 * @returns { T } 16157 * @syscap SystemCapability.ArkUI.ArkUI.Full 16158 * @since 7 16159 */ 16160 /** 16161 * Border 16162 * width:Border width;color:Border color;radius:Border radius; 16163 * 16164 * @param { BorderOptions } value 16165 * @returns { T } 16166 * @syscap SystemCapability.ArkUI.ArkUI.Full 16167 * @form 16168 * @since 9 16169 */ 16170 /** 16171 * Border 16172 * width:Border width;color:Border color;radius:Border radius; 16173 * 16174 * @param { BorderOptions } value 16175 * @returns { T } 16176 * @syscap SystemCapability.ArkUI.ArkUI.Full 16177 * @crossplatform 16178 * @form 16179 * @since 10 16180 */ 16181 /** 16182 * Border 16183 * width:Border width;color:Border color;radius:Border radius; 16184 * 16185 * @param { BorderOptions } value 16186 * @returns { T } 16187 * @syscap SystemCapability.ArkUI.ArkUI.Full 16188 * @crossplatform 16189 * @form 16190 * @atomicservice 16191 * @since 11 16192 */ 16193 border(value: BorderOptions): T; 16194 16195 /** 16196 * Border style 16197 * 16198 * @param { BorderStyle } value 16199 * @returns { T } 16200 * @syscap SystemCapability.ArkUI.ArkUI.Full 16201 * @since 7 16202 */ 16203 /** 16204 * Border style 16205 * 16206 * @param { BorderStyle | EdgeStyles } value 16207 * @returns { T } 16208 * @syscap SystemCapability.ArkUI.ArkUI.Full 16209 * @form 16210 * @since 9 16211 */ 16212 /** 16213 * Border style 16214 * 16215 * @param { BorderStyle | EdgeStyles } value 16216 * @returns { T } 16217 * @syscap SystemCapability.ArkUI.ArkUI.Full 16218 * @crossplatform 16219 * @form 16220 * @since 10 16221 */ 16222 /** 16223 * Border style 16224 * 16225 * @param { BorderStyle | EdgeStyles } value 16226 * @returns { T } 16227 * @syscap SystemCapability.ArkUI.ArkUI.Full 16228 * @crossplatform 16229 * @form 16230 * @atomicservice 16231 * @since 11 16232 */ 16233 borderStyle(value: BorderStyle | EdgeStyles): T; 16234 16235 /** 16236 * Border width 16237 * 16238 * @param { Length } value 16239 * @returns { T } 16240 * @syscap SystemCapability.ArkUI.ArkUI.Full 16241 * @since 7 16242 */ 16243 /** 16244 * Border width 16245 * 16246 * @param { Length | EdgeWidths } value 16247 * @returns { T } 16248 * @syscap SystemCapability.ArkUI.ArkUI.Full 16249 * @form 16250 * @since 9 16251 */ 16252 /** 16253 * Border width 16254 * 16255 * @param { Length | EdgeWidths } value 16256 * @returns { T } 16257 * @syscap SystemCapability.ArkUI.ArkUI.Full 16258 * @crossplatform 16259 * @form 16260 * @since 10 16261 */ 16262 /** 16263 * Border width 16264 * 16265 * @param { Length | EdgeWidths } value 16266 * @returns { T } 16267 * @syscap SystemCapability.ArkUI.ArkUI.Full 16268 * @crossplatform 16269 * @form 16270 * @atomicservice 16271 * @since 11 16272 */ 16273 /** 16274 * Border width 16275 * 16276 * @param { Length | EdgeWidths | LocalizedEdgeWidths } value 16277 * @returns { T } 16278 * @syscap SystemCapability.ArkUI.ArkUI.Full 16279 * @crossplatform 16280 * @form 16281 * @atomicservice 16282 * @since 12 16283 */ 16284 borderWidth(value: Length | EdgeWidths | LocalizedEdgeWidths): T; 16285 16286 /** 16287 * Border color 16288 * 16289 * @param { ResourceColor } value 16290 * @returns { T } 16291 * @syscap SystemCapability.ArkUI.ArkUI.Full 16292 * @since 7 16293 */ 16294 /** 16295 * Border color 16296 * 16297 * @param { ResourceColor | EdgeColors } value 16298 * @returns { T } 16299 * @syscap SystemCapability.ArkUI.ArkUI.Full 16300 * @form 16301 * @since 9 16302 */ 16303 /** 16304 * Border color 16305 * 16306 * @param { ResourceColor | EdgeColors } value 16307 * @returns { T } 16308 * @syscap SystemCapability.ArkUI.ArkUI.Full 16309 * @crossplatform 16310 * @form 16311 * @since 10 16312 */ 16313 /** 16314 * Border color 16315 * 16316 * @param { ResourceColor | EdgeColors } value 16317 * @returns { T } 16318 * @syscap SystemCapability.ArkUI.ArkUI.Full 16319 * @crossplatform 16320 * @form 16321 * @atomicservice 16322 * @since 11 16323 */ 16324 /** 16325 * Border color 16326 * 16327 * @param { ResourceColor | EdgeColors | LocalizedEdgeColors } value 16328 * @returns { T } 16329 * @syscap SystemCapability.ArkUI.ArkUI.Full 16330 * @crossplatform 16331 * @form 16332 * @atomicservice 16333 * @since 12 16334 */ 16335 borderColor(value: ResourceColor | EdgeColors | LocalizedEdgeColors): T; 16336 16337 /** 16338 * Border radius 16339 * 16340 * @param { Length } value 16341 * @returns { T } 16342 * @syscap SystemCapability.ArkUI.ArkUI.Full 16343 * @since 7 16344 */ 16345 /** 16346 * Border radius 16347 * 16348 * @param { Length | BorderRadiuses } value 16349 * @returns { T } 16350 * @syscap SystemCapability.ArkUI.ArkUI.Full 16351 * @form 16352 * @since 9 16353 */ 16354 /** 16355 * Border radius 16356 * 16357 * @param { Length | BorderRadiuses } value 16358 * @returns { T } 16359 * @syscap SystemCapability.ArkUI.ArkUI.Full 16360 * @crossplatform 16361 * @form 16362 * @since 10 16363 */ 16364 /** 16365 * Border radius 16366 * 16367 * @param { Length | BorderRadiuses } value 16368 * @returns { T } 16369 * @syscap SystemCapability.ArkUI.ArkUI.Full 16370 * @crossplatform 16371 * @form 16372 * @atomicservice 16373 * @since 11 16374 */ 16375 /** 16376 * Border radius 16377 * 16378 * @param { Length | BorderRadiuses | LocalizedBorderRadiuses } value 16379 * @returns { T } 16380 * @syscap SystemCapability.ArkUI.ArkUI.Full 16381 * @crossplatform 16382 * @form 16383 * @atomicservice 16384 * @since 12 16385 */ 16386 borderRadius(value: Length | BorderRadiuses | LocalizedBorderRadiuses): T; 16387 16388 /** 16389 * Border image 16390 * 16391 * @param { BorderImageOption } value 16392 * @returns { T } 16393 * @syscap SystemCapability.ArkUI.ArkUI.Full 16394 * @form 16395 * @since 9 16396 */ 16397 /** 16398 * Border image 16399 * 16400 * @param { BorderImageOption } value 16401 * @returns { T } 16402 * @syscap SystemCapability.ArkUI.ArkUI.Full 16403 * @crossplatform 16404 * @form 16405 * @since 10 16406 */ 16407 /** 16408 * Border image 16409 * 16410 * @param { BorderImageOption } value 16411 * @returns { T } 16412 * @syscap SystemCapability.ArkUI.ArkUI.Full 16413 * @crossplatform 16414 * @form 16415 * @atomicservice 16416 * @since 11 16417 */ 16418 borderImage(value: BorderImageOption): T; 16419 16420 /** 16421 * Outline 16422 * width:Outline width;color:Outline color;radius:Outline radius;style:Outline style; 16423 * 16424 * @param { OutlineOptions } value 16425 * @returns { T } 16426 * @syscap SystemCapability.ArkUI.ArkUI.Full 16427 * @crossplatform 16428 * @form 16429 * @since 11 16430 */ 16431 /** 16432 * Outline 16433 * width:Outline width;color:Outline color;radius:Outline radius;style:Outline style; 16434 * 16435 * @param { OutlineOptions } value 16436 * @returns { T } 16437 * @syscap SystemCapability.ArkUI.ArkUI.Full 16438 * @crossplatform 16439 * @form 16440 * @atomicservice 16441 * @since 12 16442 */ 16443 outline(value: OutlineOptions): T; 16444 16445 /** 16446 * Outline style 16447 * The input parameter default value is OutlineStyle.SOLID 16448 * 16449 * @param { OutlineStyle | EdgeOutlineStyles } value 16450 * @returns { T } 16451 * @syscap SystemCapability.ArkUI.ArkUI.Full 16452 * @crossplatform 16453 * @form 16454 * @since 11 16455 */ 16456 /** 16457 * Outline style 16458 * 16459 * @param { OutlineStyle | EdgeOutlineStyles } value 16460 * @returns { T } 16461 * @syscap SystemCapability.ArkUI.ArkUI.Full 16462 * @crossplatform 16463 * @form 16464 * @atomicservice 16465 * @since 12 16466 */ 16467 outlineStyle(value: OutlineStyle | EdgeOutlineStyles): T; 16468 16469 /** 16470 * Outline width 16471 * The input parameter default value is 0 16472 * 16473 * @param { Dimension | EdgeOutlineWidths } value 16474 * @returns { T } 16475 * @syscap SystemCapability.ArkUI.ArkUI.Full 16476 * @crossplatform 16477 * @form 16478 * @since 11 16479 */ 16480 /** 16481 * Outline width 16482 * 16483 * @param { Dimension | EdgeOutlineWidths } value 16484 * @returns { T } 16485 * @syscap SystemCapability.ArkUI.ArkUI.Full 16486 * @crossplatform 16487 * @form 16488 * @atomicservice 16489 * @since 12 16490 */ 16491 outlineWidth(value: Dimension | EdgeOutlineWidths): T; 16492 16493 /** 16494 * Outline color 16495 * The input parameter default value is Color.Black 16496 * 16497 * @param { ResourceColor | EdgeColors } value 16498 * @returns { T } 16499 * @syscap SystemCapability.ArkUI.ArkUI.Full 16500 * @crossplatform 16501 * @form 16502 * @since 11 16503 */ 16504 /** 16505 * Outline color 16506 * 16507 * @param { ResourceColor | EdgeColors | LocalizedEdgeColors } value 16508 * @returns { T } 16509 * @syscap SystemCapability.ArkUI.ArkUI.Full 16510 * @crossplatform 16511 * @form 16512 * @atomicservice 16513 * @since 12 16514 */ 16515 outlineColor(value: ResourceColor | EdgeColors | LocalizedEdgeColors): T; 16516 16517 /** 16518 * Outline radius 16519 * The input parameter default value is 0 16520 * 16521 * @param { Dimension | OutlineRadiuses } value 16522 * @returns { T } 16523 * @syscap SystemCapability.ArkUI.ArkUI.Full 16524 * @crossplatform 16525 * @form 16526 * @since 11 16527 */ 16528 /** 16529 * Outline radius 16530 * 16531 * @param { Dimension | OutlineRadiuses } value 16532 * @returns { T } 16533 * @syscap SystemCapability.ArkUI.ArkUI.Full 16534 * @crossplatform 16535 * @form 16536 * @atomicservice 16537 * @since 12 16538 */ 16539 outlineRadius(value: Dimension | OutlineRadiuses): T; 16540 16541 /** 16542 * Provides the general foreground color capability of UI components, and assigns color values 16543 * according to the characteristics of components. 16544 * 16545 * @param { ResourceColor | ColoringStrategy } value - indicates the color or color selection strategy 16546 * @returns { T } 16547 * @syscap SystemCapability.ArkUI.ArkUI.Full 16548 * @crossplatform 16549 * @since 10 16550 */ 16551 /** 16552 * Provides the general foreground color capability of UI components, and assigns color values 16553 * according to the characteristics of components. 16554 * 16555 * @param { ResourceColor | ColoringStrategy } value - indicates the color or color selection strategy 16556 * @returns { T } 16557 * @syscap SystemCapability.ArkUI.ArkUI.Full 16558 * @crossplatform 16559 * @atomicservice 16560 * @since 11 16561 */ 16562 foregroundColor(value: ResourceColor | ColoringStrategy): T; 16563 16564 /** 16565 * Trigger a click event when a click is clicked. 16566 * 16567 * @param { function } event 16568 * @returns { T } 16569 * @syscap SystemCapability.ArkUI.ArkUI.Full 16570 * @since 7 16571 */ 16572 /** 16573 * Trigger a click event when a click is clicked. 16574 * 16575 * @param { function } event 16576 * @returns { T } 16577 * @syscap SystemCapability.ArkUI.ArkUI.Full 16578 * @form 16579 * @since 9 16580 */ 16581 /** 16582 * Trigger a click event when a click is clicked. 16583 * 16584 * @param { function } event 16585 * @returns { T } 16586 * @syscap SystemCapability.ArkUI.ArkUI.Full 16587 * @crossplatform 16588 * @form 16589 * @since 10 16590 */ 16591 /** 16592 * Trigger a click event when a click is clicked. 16593 * 16594 * @param { function } event 16595 * @returns { T } 16596 * @syscap SystemCapability.ArkUI.ArkUI.Full 16597 * @crossplatform 16598 * @form 16599 * @atomicservice 16600 * @since 11 16601 */ 16602 onClick(event: (event: ClickEvent) => void): T; 16603 16604 /** 16605 * Trigger a click event when a click is clicked, move distance should smaller than distanceThreshold. 16606 * 16607 * @param { function } event - this function callback executed when the click action is recognized 16608 * @param { number } distanceThreshold - the distance threshold of finger's movement when detecting a click action 16609 * @returns { T } 16610 * @syscap SystemCapability.ArkUI.ArkUI.Full 16611 * @crossplatform 16612 * @form 16613 * @atomicservice 16614 * @since 12 16615 */ 16616 onClick(event: Callback<ClickEvent>, distanceThreshold: number): T; 16617 16618 /** 16619 * Trigger a hover event. 16620 * 16621 * @param { function } event 16622 * @returns { T } 16623 * @syscap SystemCapability.ArkUI.ArkUI.Full 16624 * @since 8 16625 */ 16626 /** 16627 * Trigger a hover event. 16628 * 16629 * @param { function } event 16630 * @returns { T } 16631 * @syscap SystemCapability.ArkUI.ArkUI.Full 16632 * @crossplatform 16633 * @atomicservice 16634 * @since 11 16635 */ 16636 onHover(event: (isHover: boolean, event: HoverEvent) => void): T; 16637 16638 /** 16639 * Trigger a accessibility hover event. 16640 * 16641 * @param { AccessibilityCallback } callback - A callback instance used when the component is touched after accessibility mode is enabled. 16642 * @returns { T } 16643 * @syscap SystemCapability.ArkUI.ArkUI.Full 16644 * @crossplatform 16645 * @atomicservice 16646 * @since 12 16647 */ 16648 onAccessibilityHover(callback: AccessibilityCallback): T; 16649 16650 /** 16651 * Set hover effect. 16652 * 16653 * @param { HoverEffect } value 16654 * @returns { T } 16655 * @syscap SystemCapability.ArkUI.ArkUI.Full 16656 * @since 8 16657 */ 16658 /** 16659 * Set hover effect. 16660 * 16661 * @param { HoverEffect } value 16662 * @returns { T } 16663 * @syscap SystemCapability.ArkUI.ArkUI.Full 16664 * @crossplatform 16665 * @since 10 16666 */ 16667 /** 16668 * Set hover effect. 16669 * 16670 * @param { HoverEffect } value 16671 * @returns { T } 16672 * @syscap SystemCapability.ArkUI.ArkUI.Full 16673 * @crossplatform 16674 * @atomicservice 16675 * @since 11 16676 */ 16677 hoverEffect(value: HoverEffect): T; 16678 16679 /** 16680 * Trigger a mouse event. 16681 * 16682 * @param { function } event 16683 * @returns { T } 16684 * @syscap SystemCapability.ArkUI.ArkUI.Full 16685 * @since 8 16686 */ 16687 /** 16688 * Trigger a mouse event. 16689 * 16690 * @param { function } event 16691 * @returns { T } 16692 * @syscap SystemCapability.ArkUI.ArkUI.Full 16693 * @atomicservice 16694 * @since 11 16695 */ 16696 onMouse(event: (event: MouseEvent) => void): T; 16697 16698 /** 16699 * Trigger a touch event when touched. 16700 * 16701 * @param { function } event 16702 * @returns { T } 16703 * @syscap SystemCapability.ArkUI.ArkUI.Full 16704 * @since 7 16705 */ 16706 /** 16707 * Trigger a touch event when touched. 16708 * 16709 * @param { function } event 16710 * @returns { T } 16711 * @syscap SystemCapability.ArkUI.ArkUI.Full 16712 * @crossplatform 16713 * @since 10 16714 */ 16715 /** 16716 * Trigger a touch event when touched. 16717 * 16718 * @param { function } event 16719 * @returns { T } 16720 * @syscap SystemCapability.ArkUI.ArkUI.Full 16721 * @crossplatform 16722 * @atomicservice 16723 * @since 11 16724 */ 16725 onTouch(event: (event: TouchEvent) => void): T; 16726 16727 /** 16728 * Keyboard input 16729 * 16730 * @param { function } event 16731 * @returns { T } 16732 * @syscap SystemCapability.ArkUI.ArkUI.Full 16733 * @since 7 16734 */ 16735 /** 16736 * Keyboard input 16737 * 16738 * @param { function } event 16739 * @returns { T } 16740 * @syscap SystemCapability.ArkUI.ArkUI.Full 16741 * @crossplatform 16742 * @since 10 16743 */ 16744 /** 16745 * Keyboard input 16746 * 16747 * @param { function } event 16748 * @returns { T } 16749 * @syscap SystemCapability.ArkUI.ArkUI.Full 16750 * @crossplatform 16751 * @atomicservice 16752 * @since 11 16753 */ 16754 onKeyEvent(event: (event: KeyEvent) => void): T; 16755 16756 /** 16757 * Handle keyboard events before input method events. 16758 * 16759 * @param { Callback<KeyEvent, boolean> } event 16760 * @returns { T } 16761 * @syscap SystemCapability.ArkUI.ArkUI.Full 16762 * @crossplatform 16763 * @atomicservice 16764 * @since 12 16765 */ 16766 onKeyPreIme(event: Callback<KeyEvent, boolean>): T; 16767 16768 /** 16769 * Set focusable. 16770 * 16771 * @param { boolean } value 16772 * @returns { T } 16773 * @syscap SystemCapability.ArkUI.ArkUI.Full 16774 * @since 8 16775 */ 16776 /** 16777 * Set focusable. 16778 * 16779 * @param { boolean } value 16780 * @returns { T } 16781 * @syscap SystemCapability.ArkUI.ArkUI.Full 16782 * @crossplatform 16783 * @since 10 16784 */ 16785 /** 16786 * Set focusable. 16787 * 16788 * @param { boolean } value 16789 * @returns { T } 16790 * @syscap SystemCapability.ArkUI.ArkUI.Full 16791 * @crossplatform 16792 * @atomicservice 16793 * @since 11 16794 */ 16795 focusable(value: boolean): T; 16796 16797 /** 16798 * Set TabStop on component focus 16799 * 16800 * @param { boolean } isTabStop 16801 * @returns { T } 16802 * @syscap SystemCapability.ArkUI.ArkUI.Full 16803 * @crossplatform 16804 * @atomicservice 16805 * @since 14 16806 */ 16807 tabStop(isTabStop: boolean): T; 16808 16809 /** 16810 * Trigger a event when got focus. 16811 * 16812 * @param { function } event 16813 * @returns { T } 16814 * @syscap SystemCapability.ArkUI.ArkUI.Full 16815 * @since 8 16816 */ 16817 /** 16818 * Trigger a event when got focus. 16819 * 16820 * @param { function } event 16821 * @returns { T } 16822 * @syscap SystemCapability.ArkUI.ArkUI.Full 16823 * @crossplatform 16824 * @since 10 16825 */ 16826 /** 16827 * Trigger a event when got focus. 16828 * 16829 * @param { function } event 16830 * @returns { T } 16831 * @syscap SystemCapability.ArkUI.ArkUI.Full 16832 * @crossplatform 16833 * @atomicservice 16834 * @since 11 16835 */ 16836 onFocus(event: () => void): T; 16837 16838 /** 16839 * Trigger a event when lose focus. 16840 * 16841 * @param { function } event 16842 * @returns { T } 16843 * @syscap SystemCapability.ArkUI.ArkUI.Full 16844 * @since 8 16845 */ 16846 /** 16847 * Trigger a event when lose focus. 16848 * 16849 * @param { function } event 16850 * @returns { T } 16851 * @syscap SystemCapability.ArkUI.ArkUI.Full 16852 * @crossplatform 16853 * @since 10 16854 */ 16855 /** 16856 * Trigger a event when lose focus. 16857 * 16858 * @param { function } event 16859 * @returns { T } 16860 * @syscap SystemCapability.ArkUI.ArkUI.Full 16861 * @crossplatform 16862 * @atomicservice 16863 * @since 11 16864 */ 16865 onBlur(event: () => void): T; 16866 16867 /** 16868 * Set focus index by key tab. 16869 * 16870 * @param { number } index 16871 * @returns { T } 16872 * @syscap SystemCapability.ArkUI.ArkUI.Full 16873 * @since 9 16874 */ 16875 /** 16876 * Set focus index by key tab. 16877 * 16878 * @param { number } index 16879 * @returns { T } 16880 * @syscap SystemCapability.ArkUI.ArkUI.Full 16881 * @crossplatform 16882 * @since 10 16883 */ 16884 /** 16885 * Set focus index by key tab. 16886 * 16887 * @param { number } index 16888 * @returns { T } 16889 * @syscap SystemCapability.ArkUI.ArkUI.Full 16890 * @crossplatform 16891 * @atomicservice 16892 * @since 11 16893 */ 16894 tabIndex(index: number): T; 16895 16896 /** 16897 * Set default focused component when a page create. 16898 * 16899 * @param { boolean } value 16900 * @returns { T } 16901 * @syscap SystemCapability.ArkUI.ArkUI.Full 16902 * @since 9 16903 */ 16904 /** 16905 * Set default focused component when a page create. 16906 * 16907 * @param { boolean } value 16908 * @returns { T } 16909 * @syscap SystemCapability.ArkUI.ArkUI.Full 16910 * @crossplatform 16911 * @since 10 16912 */ 16913 /** 16914 * Set default focused component when a page create. 16915 * 16916 * @param { boolean } value 16917 * @returns { T } 16918 * @syscap SystemCapability.ArkUI.ArkUI.Full 16919 * @crossplatform 16920 * @atomicservice 16921 * @since 11 16922 */ 16923 defaultFocus(value: boolean): T; 16924 16925 /** 16926 * Set default focused component when focus on a focus group. 16927 * 16928 * @param { boolean } value 16929 * @returns { T } 16930 * @syscap SystemCapability.ArkUI.ArkUI.Full 16931 * @since 9 16932 */ 16933 /** 16934 * Set default focused component when focus on a focus group. 16935 * 16936 * @param { boolean } value 16937 * @returns { T } 16938 * @syscap SystemCapability.ArkUI.ArkUI.Full 16939 * @crossplatform 16940 * @since 10 16941 */ 16942 /** 16943 * Set default focused component when focus on a focus group. 16944 * 16945 * @param { boolean } value 16946 * @returns { T } 16947 * @syscap SystemCapability.ArkUI.ArkUI.Full 16948 * @crossplatform 16949 * @atomicservice 16950 * @since 11 16951 */ 16952 groupDefaultFocus(value: boolean): T; 16953 16954 /** 16955 * Set a component focused when the component be touched. 16956 * 16957 * @param { boolean } value 16958 * @returns { T } 16959 * @syscap SystemCapability.ArkUI.ArkUI.Full 16960 * @since 9 16961 */ 16962 /** 16963 * Set a component focused when the component be touched. 16964 * 16965 * @param { boolean } value 16966 * @returns { T } 16967 * @syscap SystemCapability.ArkUI.ArkUI.Full 16968 * @crossplatform 16969 * @since 10 16970 */ 16971 /** 16972 * Set a component focused when the component be touched. 16973 * 16974 * @param { boolean } value 16975 * @returns { T } 16976 * @syscap SystemCapability.ArkUI.ArkUI.Full 16977 * @crossplatform 16978 * @atomicservice 16979 * @since 11 16980 */ 16981 focusOnTouch(value: boolean): T; 16982 16983 /** 16984 * Set the component's focusBox style. 16985 * 16986 * @param { FocusBoxStyle } style 16987 * @returns { T } 16988 * @syscap SystemCapability.ArkUI.ArkUI.Full 16989 * @crossplatform 16990 * @atomicservice 16991 * @since 12 16992 */ 16993 focusBox(style: FocusBoxStyle): T; 16994 16995 /** 16996 * Set container as a focus group with a specific identifier. 16997 * 16998 * @param { string } id - focus scope identifier. 16999 * @param { boolean } [isGroup] - whether this scope is a focus group, the default value is false 17000 * @returns { T } 17001 * @syscap SystemCapability.ArkUI.ArkUI.Full 17002 * @crossplatform 17003 * @atomicservice 17004 * @since 12 17005 */ 17006 focusScopeId(id: string, isGroup?: boolean): T; 17007 /** 17008 * Set container as a focus group with a specific identifier. 17009 * 17010 * @param { string } id - focus scope identifier. 17011 * @param { boolean } [isGroup] - whether this scope is a focus group, the default value is false. 17012 * @param { boolean } [arrowStepOut] - whether the arrow keys can move focus from inside the focus group to outside, 17013 * only effective when isGroup is true, the default value is true. 17014 * @returns { T } 17015 * @syscap SystemCapability.ArkUI.ArkUI.Full 17016 * @crossplatform 17017 * @atomicservice 17018 * @since 14 17019 */ 17020 focusScopeId(id: string, isGroup?: boolean, arrowStepOut?: boolean): T; 17021 17022 /** 17023 * Set the focus priority of component in a specific focus scope. 17024 * 17025 * @param { string } scopeId 17026 * @param { FocusPriority } [priority] - the default value is AUTO 17027 * @returns { T } 17028 * @syscap SystemCapability.ArkUI.ArkUI.Full 17029 * @crossplatform 17030 * @atomicservice 17031 * @since 12 17032 */ 17033 focusScopePriority(scopeId: string, priority?: FocusPriority): T; 17034 17035 /** 17036 * animation 17037 * 17038 * @param { AnimateParam } value 17039 * @returns { T } 17040 * @syscap SystemCapability.ArkUI.ArkUI.Full 17041 * @since 7 17042 */ 17043 /** 17044 * animation 17045 * 17046 * @param { AnimateParam } value 17047 * @returns { T } 17048 * @syscap SystemCapability.ArkUI.ArkUI.Full 17049 * @form 17050 * @since 9 17051 */ 17052 /** 17053 * animation 17054 * 17055 * @param { AnimateParam } value 17056 * @returns { T } 17057 * @syscap SystemCapability.ArkUI.ArkUI.Full 17058 * @crossplatform 17059 * @form 17060 * @since 10 17061 */ 17062 /** 17063 * animation 17064 * 17065 * @param { AnimateParam } value 17066 * @returns { T } 17067 * @syscap SystemCapability.ArkUI.ArkUI.Full 17068 * @crossplatform 17069 * @form 17070 * @atomicservice 17071 * @since 11 17072 */ 17073 animation(value: AnimateParam): T; 17074 17075 /** 17076 * Transition parameter 17077 * 17078 * @param { TransitionOptions | TransitionEffect } value 17079 * @returns { T } 17080 * @syscap SystemCapability.ArkUI.ArkUI.Full 17081 * @since 7 17082 */ 17083 /** 17084 * Transition parameter 17085 * 17086 * @param { TransitionOptions | TransitionEffect } value - transition options 17087 * @returns { T } 17088 * @syscap SystemCapability.ArkUI.ArkUI.Full 17089 * @form 17090 * @since 9 17091 */ 17092 /** 17093 * Transition parameter 17094 * 17095 * @param { TransitionOptions | TransitionEffect } value - transition options or transition effect 17096 * @returns { T } 17097 * @syscap SystemCapability.ArkUI.ArkUI.Full 17098 * @crossplatform 17099 * @form 17100 * @since 10 17101 */ 17102 /** 17103 * Transition parameter 17104 * 17105 * @param { TransitionOptions | TransitionEffect } value - transition options or transition effect 17106 * @returns { T } 17107 * @syscap SystemCapability.ArkUI.ArkUI.Full 17108 * @crossplatform 17109 * @form 17110 * @atomicservice 17111 * @since 11 17112 */ 17113 transition(value: TransitionOptions | TransitionEffect): T; 17114 17115 /** 17116 * Set the transition effect of component when it appears and disappears. 17117 * 17118 * @param { TransitionEffect } effect - transition effect 17119 * @param { Optional<TransitionFinishCallback> } onFinish - transition finish callback. 17120 * @returns { T } 17121 * @syscap SystemCapability.ArkUI.ArkUI.Full 17122 * @crossplatform 17123 * @form 17124 * @atomicservice 17125 * @since 12 17126 */ 17127 transition(effect: TransitionEffect, onFinish: Optional<TransitionFinishCallback>): T; 17128 17129 /** 17130 * Bind gesture recognition. 17131 * gesture:Bound Gesture Type,mask:GestureMask; 17132 * 17133 * @param { GestureType } gesture 17134 * @param { GestureMask } mask 17135 * @returns { T } 17136 * @syscap SystemCapability.ArkUI.ArkUI.Full 17137 * @since 7 17138 */ 17139 /** 17140 * Bind gesture recognition. 17141 * gesture:Bound Gesture Type,mask:GestureMask; 17142 * 17143 * @param { GestureType } gesture 17144 * @param { GestureMask } mask 17145 * @returns { T } 17146 * @syscap SystemCapability.ArkUI.ArkUI.Full 17147 * @crossplatform 17148 * @since 10 17149 */ 17150 /** 17151 * Bind gesture recognition. 17152 * gesture:Bound Gesture Type,mask:GestureMask; 17153 * 17154 * @param { GestureType } gesture 17155 * @param { GestureMask } mask 17156 * @returns { T } 17157 * @syscap SystemCapability.ArkUI.ArkUI.Full 17158 * @crossplatform 17159 * @atomicservice 17160 * @since 11 17161 */ 17162 gesture(gesture: GestureType, mask?: GestureMask): T; 17163 17164 /** 17165 * Binding Preferential Recognition Gestures 17166 * gesture:Bound Gesture Type,mask:GestureMask; 17167 * 17168 * @param { GestureType } gesture 17169 * @param { GestureMask } mask 17170 * @returns { T } 17171 * @syscap SystemCapability.ArkUI.ArkUI.Full 17172 * @since 7 17173 */ 17174 /** 17175 * Binding Preferential Recognition Gestures 17176 * gesture:Bound Gesture Type,mask:GestureMask; 17177 * 17178 * @param { GestureType } gesture 17179 * @param { GestureMask } mask 17180 * @returns { T } 17181 * @syscap SystemCapability.ArkUI.ArkUI.Full 17182 * @crossplatform 17183 * @since 10 17184 */ 17185 /** 17186 * Binding Preferential Recognition Gestures 17187 * gesture:Bound Gesture Type,mask:GestureMask; 17188 * 17189 * @param { GestureType } gesture 17190 * @param { GestureMask } mask 17191 * @returns { T } 17192 * @syscap SystemCapability.ArkUI.ArkUI.Full 17193 * @crossplatform 17194 * @atomicservice 17195 * @since 11 17196 */ 17197 priorityGesture(gesture: GestureType, mask?: GestureMask): T; 17198 17199 /** 17200 * Binding gestures that can be triggered simultaneously with internal component gestures 17201 * gesture:Bound Gesture Type,mask:GestureMask; 17202 * 17203 * @param { GestureType } gesture 17204 * @param { GestureMask } mask 17205 * @returns { T } 17206 * @syscap SystemCapability.ArkUI.ArkUI.Full 17207 * @since 7 17208 */ 17209 /** 17210 * Binding gestures that can be triggered simultaneously with internal component gestures 17211 * gesture:Bound Gesture Type,mask:GestureMask; 17212 * 17213 * @param { GestureType } gesture 17214 * @param { GestureMask } mask 17215 * @returns { T } 17216 * @syscap SystemCapability.ArkUI.ArkUI.Full 17217 * @crossplatform 17218 * @since 10 17219 */ 17220 /** 17221 * Binding gestures that can be triggered simultaneously with internal component gestures 17222 * gesture:Bound Gesture Type,mask:GestureMask; 17223 * 17224 * @param { GestureType } gesture 17225 * @param { GestureMask } mask 17226 * @returns { T } 17227 * @syscap SystemCapability.ArkUI.ArkUI.Full 17228 * @crossplatform 17229 * @atomicservice 17230 * @since 11 17231 */ 17232 parallelGesture(gesture: GestureType, mask?: GestureMask): T; 17233 17234 /** 17235 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 17236 * The larger the blurring radius, the more blurring the content. 17237 * If the value is 0, the content blurring effect is not blurring. 17238 * 17239 * @param { number } value 17240 * @returns { T } 17241 * @syscap SystemCapability.ArkUI.ArkUI.Full 17242 * @since 7 17243 */ 17244 /** 17245 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 17246 * The larger the blurring radius, the more blurring the content. 17247 * If the value is 0, the content blurring effect is not blurring. 17248 * 17249 * @param { number } value 17250 * @returns { T } 17251 * @syscap SystemCapability.ArkUI.ArkUI.Full 17252 * @form 17253 * @since 9 17254 */ 17255 /** 17256 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 17257 * The larger the blurring radius, the more blurring the content. 17258 * If the value is 0, the content blurring effect is not blurring. 17259 * 17260 * @param { number } value 17261 * @returns { T } 17262 * @syscap SystemCapability.ArkUI.ArkUI.Full 17263 * @crossplatform 17264 * @form 17265 * @since 10 17266 */ 17267 /** 17268 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 17269 * The larger the blurring radius, the more blurring the content. 17270 * If the value is 0, the content blurring effect is not blurring. 17271 * 17272 * @param { number } value - value indicates radius of backdrop blur. 17273 * @param { BlurOptions } [options] - options indicates blur options. 17274 * @returns { T } 17275 * @syscap SystemCapability.ArkUI.ArkUI.Full 17276 * @crossplatform 17277 * @form 17278 * @atomicservice 17279 * @since 11 17280 */ 17281 blur(value: number, options?: BlurOptions): T; 17282 17283 /** 17284 * Adds the content linear gradient blurring effect for the current component. The input parameter is the blurring radius. 17285 * 17286 * @param { number } value - the blurring radius. 17287 * The larger the blurring radius, the more blurring the content, and if the value is 0, the content blurring effect is not blurring. 17288 * @param { LinearGradientBlurOptions } options - the linear gradient blur options. 17289 * @returns { T } 17290 * @syscap SystemCapability.ArkUI.ArkUI.Full 17291 * @atomicservice 17292 * @since 12 17293 */ 17294 linearGradientBlur(value: number, options: LinearGradientBlurOptions): T; 17295 17296 /** 17297 * Component motion blur interface. 17298 * 17299 * @param { MotionBlurOptions } value - the attributes of motion blur. 17300 * @returns { T } 17301 * @syscap SystemCapability.ArkUI.ArkUI.Full 17302 * @crossplatform 17303 * @atomicservice 17304 * @since 12 17305 */ 17306 motionBlur(value: MotionBlurOptions):T; 17307 17308 /** 17309 * Adds a highlight effect to the current component. 17310 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 17311 * The component is displayed as all white (percentage). 17312 * 17313 * @param { number } value 17314 * @returns { T } 17315 * @syscap SystemCapability.ArkUI.ArkUI.Full 17316 * @since 7 17317 */ 17318 /** 17319 * Adds a highlight effect to the current component. 17320 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 17321 * The component is displayed as all white (percentage). 17322 * 17323 * @param { number } value 17324 * @returns { T } 17325 * @syscap SystemCapability.ArkUI.ArkUI.Full 17326 * @form 17327 * @since 9 17328 */ 17329 /** 17330 * Adds a highlight effect to the current component. 17331 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 17332 * The component is displayed as all white (percentage). 17333 * 17334 * @param { number } value 17335 * @returns { T } 17336 * @syscap SystemCapability.ArkUI.ArkUI.Full 17337 * @crossplatform 17338 * @form 17339 * @since 10 17340 */ 17341 /** 17342 * Adds a highlight effect to the current component. 17343 * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. 17344 * The component is displayed as all white (percentage). 17345 * 17346 * @param { number } value 17347 * @returns { T } 17348 * @syscap SystemCapability.ArkUI.ArkUI.Full 17349 * @crossplatform 17350 * @form 17351 * @atomicservice 17352 * @since 11 17353 */ 17354 brightness(value: number): T; 17355 17356 /** 17357 * Adds a contrast effect to the current component. The input parameter is the contrast value. 17358 * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) 17359 * 17360 * @param { number } value 17361 * @returns { T } 17362 * @syscap SystemCapability.ArkUI.ArkUI.Full 17363 * @since 7 17364 */ 17365 /** 17366 * Adds a contrast effect to the current component. The input parameter is the contrast value. 17367 * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) 17368 * 17369 * @param { number } value 17370 * @returns { T } 17371 * @syscap SystemCapability.ArkUI.ArkUI.Full 17372 * @form 17373 * @since 9 17374 */ 17375 /** 17376 * Adds a contrast effect to the current component. The input parameter is the contrast value. 17377 * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) 17378 * 17379 * @param { number } value 17380 * @returns { T } 17381 * @syscap SystemCapability.ArkUI.ArkUI.Full 17382 * @crossplatform 17383 * @form 17384 * @since 10 17385 */ 17386 /** 17387 * Adds a contrast effect to the current component. The input parameter is the contrast value. 17388 * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) 17389 * 17390 * @param { number } value 17391 * @returns { T } 17392 * @syscap SystemCapability.ArkUI.ArkUI.Full 17393 * @crossplatform 17394 * @form 17395 * @atomicservice 17396 * @since 11 17397 */ 17398 contrast(value: number): T; 17399 17400 /** 17401 * Adds a grayscale effect to the current component. 17402 * 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. 17403 * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) 17404 * 17405 * @param { number } value 17406 * @returns { T } 17407 * @syscap SystemCapability.ArkUI.ArkUI.Full 17408 * @since 7 17409 */ 17410 /** 17411 * Adds a grayscale effect to the current component. 17412 * 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. 17413 * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) 17414 * 17415 * @param { number } value 17416 * @returns { T } 17417 * @syscap SystemCapability.ArkUI.ArkUI.Full 17418 * @form 17419 * @since 9 17420 */ 17421 /** 17422 * Adds a grayscale effect to the current component. 17423 * 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. 17424 * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) 17425 * 17426 * @param { number } value 17427 * @returns { T } 17428 * @syscap SystemCapability.ArkUI.ArkUI.Full 17429 * @crossplatform 17430 * @form 17431 * @since 10 17432 */ 17433 /** 17434 * Adds a grayscale effect to the current component. 17435 * 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. 17436 * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) 17437 * 17438 * @param { number } value 17439 * @returns { T } 17440 * @syscap SystemCapability.ArkUI.ArkUI.Full 17441 * @crossplatform 17442 * @form 17443 * @atomicservice 17444 * @since 11 17445 */ 17446 grayscale(value: number): T; 17447 17448 /** 17449 * Adds a color overlay effect for the current component. The input parameter is the superimposed color. 17450 * 17451 * @param { Color | string | Resource } value 17452 * @returns { T } 17453 * @syscap SystemCapability.ArkUI.ArkUI.Full 17454 * @since 7 17455 */ 17456 /** 17457 * Adds a color overlay effect for the current component. The input parameter is the superimposed color. 17458 * 17459 * @param { Color | string | Resource } value 17460 * @returns { T } 17461 * @syscap SystemCapability.ArkUI.ArkUI.Full 17462 * @form 17463 * @since 9 17464 */ 17465 /** 17466 * Adds a color overlay effect for the current component. The input parameter is the superimposed color. 17467 * 17468 * @param { Color | string | Resource } value 17469 * @returns { T } 17470 * @syscap SystemCapability.ArkUI.ArkUI.Full 17471 * @crossplatform 17472 * @form 17473 * @since 10 17474 */ 17475 /** 17476 * Adds a color overlay effect for the current component. The input parameter is the superimposed color. 17477 * 17478 * @param { Color | string | Resource } value 17479 * @returns { T } 17480 * @syscap SystemCapability.ArkUI.ArkUI.Full 17481 * @crossplatform 17482 * @form 17483 * @atomicservice 17484 * @since 11 17485 */ 17486 colorBlend(value: Color | string | Resource): T; 17487 17488 /** 17489 * Adds a saturation effect to the current component. 17490 * The saturation is the ratio of the color-containing component to the achromatic component (gray). 17491 * The larger the color-containing component, the greater the saturation. 17492 * The larger the achromatic component, the smaller the saturation. (Percentage) 17493 * 17494 * @param { number } value 17495 * @returns { T } 17496 * @syscap SystemCapability.ArkUI.ArkUI.Full 17497 * @since 7 17498 */ 17499 /** 17500 * Adds a saturation effect to the current component. 17501 * The saturation is the ratio of the color-containing component to the achromatic component (gray). 17502 * The larger the color-containing component, the greater the saturation. 17503 * The larger the achromatic component, the smaller the saturation. (Percentage) 17504 * 17505 * @param { number } value 17506 * @returns { T } 17507 * @syscap SystemCapability.ArkUI.ArkUI.Full 17508 * @form 17509 * @since 9 17510 */ 17511 /** 17512 * Adds a saturation effect to the current component. 17513 * The saturation is the ratio of the color-containing component to the achromatic component (gray). 17514 * The larger the color-containing component, the greater the saturation. 17515 * The larger the achromatic component, the smaller the saturation. (Percentage) 17516 * 17517 * @param { number } value 17518 * @returns { T } 17519 * @syscap SystemCapability.ArkUI.ArkUI.Full 17520 * @crossplatform 17521 * @form 17522 * @since 10 17523 */ 17524 /** 17525 * Adds a saturation effect to the current component. 17526 * The saturation is the ratio of the color-containing component to the achromatic component (gray). 17527 * The larger the color-containing component, the greater the saturation. 17528 * The larger the achromatic component, the smaller the saturation. (Percentage) 17529 * 17530 * @param { number } value 17531 * @returns { T } 17532 * @syscap SystemCapability.ArkUI.ArkUI.Full 17533 * @crossplatform 17534 * @form 17535 * @atomicservice 17536 * @since 11 17537 */ 17538 saturate(value: number): T; 17539 17540 /** 17541 * Converts the image to sepia. Value defines the scale of the conversion. 17542 * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) 17543 * 17544 * @param { number } value 17545 * @returns { T } 17546 * @syscap SystemCapability.ArkUI.ArkUI.Full 17547 * @since 7 17548 */ 17549 /** 17550 * Converts the image to sepia. Value defines the scale of the conversion. 17551 * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) 17552 * 17553 * @param { number } value 17554 * @returns { T } 17555 * @syscap SystemCapability.ArkUI.ArkUI.Full 17556 * @form 17557 * @since 9 17558 */ 17559 /** 17560 * Converts the image to sepia. Value defines the scale of the conversion. 17561 * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) 17562 * 17563 * @param { number } value 17564 * @returns { T } 17565 * @syscap SystemCapability.ArkUI.ArkUI.Full 17566 * @crossplatform 17567 * @form 17568 * @since 10 17569 */ 17570 /** 17571 * Converts the image to sepia. Value defines the scale of the conversion. 17572 * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) 17573 * 17574 * @param { number } value 17575 * @returns { T } 17576 * @syscap SystemCapability.ArkUI.ArkUI.Full 17577 * @crossplatform 17578 * @form 17579 * @atomicservice 17580 * @since 11 17581 */ 17582 sepia(value: number): T; 17583 17584 /** 17585 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 17586 * A value of 0% does not change the image. (Percentage) 17587 * 17588 * @param { number } value 17589 * @returns { T } 17590 * @syscap SystemCapability.ArkUI.ArkUI.Full 17591 * @since 7 17592 */ 17593 /** 17594 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 17595 * A value of 0% does not change the image. (Percentage) 17596 * 17597 * @param { number } value 17598 * @returns { T } 17599 * @syscap SystemCapability.ArkUI.ArkUI.Full 17600 * @form 17601 * @since 9 17602 */ 17603 /** 17604 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 17605 * A value of 0% does not change the image. (Percentage) 17606 * 17607 * @param { number } value 17608 * @returns { T } 17609 * @syscap SystemCapability.ArkUI.ArkUI.Full 17610 * @crossplatform 17611 * @form 17612 * @since 10 17613 */ 17614 /** 17615 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 17616 * A value of 0% does not change the image. (Percentage) 17617 * 17618 * @param { number | InvertOptions } value - value indicates the scale of the conversion or the options of invert. 17619 * @returns { T } 17620 * @syscap SystemCapability.ArkUI.ArkUI.Full 17621 * @crossplatform 17622 * @form 17623 * @atomicservice 17624 * @since 11 17625 */ 17626 invert(value: number | InvertOptions): T; 17627 17628 /** 17629 * Sets system bar effect to the component. 17630 * 17631 * @returns { T } return the component attribute. 17632 * @syscap SystemCapability.ArkUI.ArkUI.Full 17633 * @atomicservice 17634 * @since 12 17635 */ 17636 systemBarEffect(): T; 17637 17638 /** 17639 * Adds the hue rotation effect to the current component. 17640 * 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. 17641 * If the value exceeds 360deg, the image is circled again. 17642 * 17643 * @param { number | string } value 17644 * @returns { T } 17645 * @syscap SystemCapability.ArkUI.ArkUI.Full 17646 * @since 7 17647 */ 17648 /** 17649 * Adds the hue rotation effect to the current component. 17650 * 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. 17651 * If the value exceeds 360deg, the image is circled again. 17652 * 17653 * @param { number | string } value 17654 * @returns { T } 17655 * @syscap SystemCapability.ArkUI.ArkUI.Full 17656 * @form 17657 * @since 9 17658 */ 17659 /** 17660 * Adds the hue rotation effect to the current component. 17661 * 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. 17662 * If the value exceeds 360deg, the image is circled again. 17663 * 17664 * @param { number | string } value 17665 * @returns { T } 17666 * @syscap SystemCapability.ArkUI.ArkUI.Full 17667 * @crossplatform 17668 * @form 17669 * @since 10 17670 */ 17671 /** 17672 * Adds the hue rotation effect to the current component. 17673 * 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. 17674 * If the value exceeds 360deg, the image is circled again. 17675 * 17676 * @param { number | string } value 17677 * @returns { T } 17678 * @syscap SystemCapability.ArkUI.ArkUI.Full 17679 * @crossplatform 17680 * @form 17681 * @atomicservice 17682 * @since 11 17683 */ 17684 hueRotate(value: number | string): T; 17685 17686 /** 17687 * Add an attribute to control whether the shadows of the child nodes overlap each other. 17688 * 17689 * @param { boolean } value - true means the shadows of the child nodes overlap each other effect and drawn in batches. 17690 * @returns { T } 17691 * @syscap SystemCapability.ArkUI.ArkUI.Full 17692 * @crossplatform 17693 * @form 17694 * @since 11 17695 */ 17696 /** 17697 * Add an attribute to control whether the shadows of the child nodes overlap each other. 17698 * 17699 * @param { boolean } value - true means the shadows of the child nodes overlap each other effect and drawn in batches. 17700 * @returns { T } 17701 * @syscap SystemCapability.ArkUI.ArkUI.Full 17702 * @crossplatform 17703 * @form 17704 * @atomicservice 17705 * @since 12 17706 */ 17707 useShadowBatching(value: boolean): T; 17708 17709 /** 17710 * Sets whether the component should apply the effects template defined by the parent effectComponent or window. 17711 * If multiple parent effectComponents are found, the nearest one will be used. 17712 * If no parent effectComponent is found, this method has no effect. 17713 * 17714 * @param { boolean } useEffect - true means the component should apply the effects template defined by the parent effectComponent or window. 17715 * @param { EffectType } effectType - the effect type of the effects template, defined by the parent effectComponent or window. 17716 * @returns { T } return the component attribute. 17717 * @syscap SystemCapability.ArkUI.ArkUI.Full 17718 * @atomicservice 17719 * @since 14 17720 */ 17721 useEffect(useEffect: boolean, effectType: EffectType): T; 17722 17723 /** 17724 * Sets whether the component should apply the effects template defined by the parent effectComponent. 17725 * If multiple parent effectComponents are found, the nearest one will be used. 17726 * If no parent effectComponent is found, this method has no effect. 17727 * 17728 * @param { boolean } value - true means the component should apply the effects template. 17729 * @returns { T } return the component attribute. 17730 * @syscap SystemCapability.ArkUI.ArkUI.Full 17731 * @atomicservice 17732 * @since 12 17733 */ 17734 useEffect(value: boolean): T; 17735 17736 /** 17737 * Adds the background blur effect for the current component. The input parameter is the blur radius. 17738 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 17739 * 17740 * @param { number } value 17741 * @returns { T } 17742 * @syscap SystemCapability.ArkUI.ArkUI.Full 17743 * @since 7 17744 */ 17745 /** 17746 * Adds the background blur effect for the current component. The input parameter is the blur radius. 17747 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 17748 * 17749 * @param { number } value 17750 * @returns { T } 17751 * @syscap SystemCapability.ArkUI.ArkUI.Full 17752 * @form 17753 * @since 9 17754 */ 17755 /** 17756 * Adds the background blur effect for the current component. The input parameter is the blur radius. 17757 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 17758 * 17759 * @param { number } value 17760 * @returns { T } 17761 * @syscap SystemCapability.ArkUI.ArkUI.Full 17762 * @crossplatform 17763 * @form 17764 * @since 10 17765 */ 17766 /** 17767 * Adds the background blur effect for the current component. The input parameter is the blur radius. 17768 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 17769 * 17770 * @param { number } value - value indicates radius of backdrop blur. 17771 * @param { BlurOptions } [options] - options indicates the backdrop blur options. 17772 * @returns { T } 17773 * @syscap SystemCapability.ArkUI.ArkUI.Full 17774 * @crossplatform 17775 * @form 17776 * @atomicservice 17777 * @since 11 17778 */ 17779 backdropBlur(value: number, options?: BlurOptions): T; 17780 17781 /** 17782 * Composite the contents of this view and its children into an offscreen cache before display in the screen. 17783 * 17784 * @param { boolean } value - if this view and its children need to composite into an offscreen cache. 17785 * @returns { T } 17786 * @syscap SystemCapability.ArkUI.ArkUI.Full 17787 * @crossplatform 17788 * @since 10 17789 */ 17790 /** 17791 * Composite the contents of this view and its children into an offscreen cache before display in the screen. 17792 * 17793 * @param { boolean } value - if this view and its children need to composite into an offscreen cache. 17794 * @returns { T } 17795 * @syscap SystemCapability.ArkUI.ArkUI.Full 17796 * @crossplatform 17797 * @atomicservice 17798 * @since 11 17799 */ 17800 /** 17801 * Composite the contents of this view and its children into an offscreen cache before display in the screen. 17802 * 17803 * @param { boolean } value - if this view and its children need to composite into an offscreen cache. 17804 * @returns { T } 17805 * @syscap SystemCapability.ArkUI.ArkUI.Full 17806 * @crossplatform 17807 * @form 17808 * @atomicservice 17809 * @since 12 17810 */ 17811 renderGroup(value: boolean): T; 17812 17813 /** 17814 * Sets whether the component should remain stationary, reusing the results of the current frame's off-screen rendering. 17815 * If the input parameter is true, the component and subcomponent changes do not affect the display. 17816 * 17817 * @param { boolean } value - true means the component should remain stationary. 17818 * @returns { T } 17819 * @syscap SystemCapability.ArkUI.ArkUI.Full 17820 * @atomicservice 17821 * @since 12 17822 */ 17823 freeze(value: boolean): T; 17824 17825 /** 17826 * Sets the translation effect during page transition. 17827 * The value is the start point of entry and end point of exit. 17828 * When this parameter is set together with slide, slide takes effect by default. 17829 * 17830 * @param { TranslateOptions } value 17831 * @returns { T } 17832 * @syscap SystemCapability.ArkUI.ArkUI.Full 17833 * @since 7 17834 */ 17835 /** 17836 * Sets the translation effect during page transition. 17837 * The value is the start point of entry and end point of exit. 17838 * When this parameter is set together with slide, slide takes effect by default. 17839 * 17840 * @param { TranslateOptions } value 17841 * @returns { T } 17842 * @syscap SystemCapability.ArkUI.ArkUI.Full 17843 * @form 17844 * @since 9 17845 */ 17846 /** 17847 * Sets the translation effect during page transition. 17848 * The value is the start point of entry and end point of exit. 17849 * When this parameter is set together with slide, slide takes effect by default. 17850 * 17851 * @param { TranslateOptions } value 17852 * @returns { T } 17853 * @syscap SystemCapability.ArkUI.ArkUI.Full 17854 * @crossplatform 17855 * @form 17856 * @since 10 17857 */ 17858 /** 17859 * Set component translation. 17860 * 17861 * @param { TranslateOptions } value default:{x:0,y:0,z:0} 17862 * @returns { T } 17863 * @syscap SystemCapability.ArkUI.ArkUI.Full 17864 * @crossplatform 17865 * @form 17866 * @atomicservice 17867 * @since 11 17868 */ 17869 translate(value: TranslateOptions): T; 17870 17871 /** 17872 * Sets the zoom effect during page transition. The value is the start point of entry and end point of exit. 17873 * 17874 * @param { ScaleOptions } value 17875 * @returns { T } 17876 * @syscap SystemCapability.ArkUI.ArkUI.Full 17877 * @since 7 17878 */ 17879 /** 17880 * Sets the zoom effect during page transition. The value is the start point of entry and end point of exit. 17881 * 17882 * @param { ScaleOptions } value 17883 * @returns { T } 17884 * @syscap SystemCapability.ArkUI.ArkUI.Full 17885 * @form 17886 * @since 9 17887 */ 17888 /** 17889 * Sets the zoom effect during page transition. The value is the start point of entry and end point of exit. 17890 * 17891 * @param { ScaleOptions } value 17892 * @returns { T } 17893 * @syscap SystemCapability.ArkUI.ArkUI.Full 17894 * @crossplatform 17895 * @form 17896 * @since 10 17897 */ 17898 /** 17899 * Set component scaling. 17900 * 17901 * @param { ScaleOptions } value default:{x:1,y:1,z:1,centerX:'50%',centerY:'50%'} 17902 * @returns { T } 17903 * @syscap SystemCapability.ArkUI.ArkUI.Full 17904 * @crossplatform 17905 * @form 17906 * @atomicservice 17907 * @since 11 17908 */ 17909 scale(value: ScaleOptions): T; 17910 17911 /** 17912 * 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. 17913 * 17914 * @param { number } value 17915 * @returns { T } 17916 * @syscap SystemCapability.ArkUI.ArkUI.Full 17917 * @since 7 17918 */ 17919 /** 17920 * 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. 17921 * 17922 * @param { number } value 17923 * @returns { T } 17924 * @syscap SystemCapability.ArkUI.ArkUI.Full 17925 * @crossplatform 17926 * @since 10 17927 */ 17928 /** 17929 * 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. 17930 * 17931 * @param { number } value 17932 * @returns { T } 17933 * @syscap SystemCapability.ArkUI.ArkUI.Full 17934 * @crossplatform 17935 * @atomicservice 17936 * @since 11 17937 * @deprecated since 14 17938 * @useinstead grid_col/GridColInterface and grid_row/GridRowInterface 17939 */ 17940 gridSpan(value: number): T; 17941 17942 /** 17943 * 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, 17944 * the current component is located in the nth column. 17945 * 17946 * @param { number } value 17947 * @returns { T } 17948 * @syscap SystemCapability.ArkUI.ArkUI.Full 17949 * @since 7 17950 */ 17951 /** 17952 * 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, 17953 * the current component is located in the nth column. 17954 * 17955 * @param { number } value 17956 * @returns { T } 17957 * @syscap SystemCapability.ArkUI.ArkUI.Full 17958 * @crossplatform 17959 * @since 10 17960 */ 17961 /** 17962 * 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, 17963 * the current component is located in the nth column. 17964 * 17965 * @param { number } value 17966 * @returns { T } 17967 * @syscap SystemCapability.ArkUI.ArkUI.Full 17968 * @crossplatform 17969 * @atomicservice 17970 * @since 11 17971 * @deprecated since 14 17972 * @useinstead grid_col/GridColInterface and grid_row/GridRowInterface 17973 */ 17974 gridOffset(value: number): T; 17975 17976 /** 17977 * Sets the rotation effect during assembly transition. 17978 * The values are the start point during insertion and the end point during deletion. 17979 * 17980 * @param { RotateOptions } value 17981 * @returns { T } 17982 * @syscap SystemCapability.ArkUI.ArkUI.Full 17983 * @since 7 17984 */ 17985 /** 17986 * Sets the rotation effect during assembly transition. 17987 * The values are the start point during insertion and the end point during deletion. 17988 * 17989 * @param { RotateOptions } value 17990 * @returns { T } 17991 * @syscap SystemCapability.ArkUI.ArkUI.Full 17992 * @form 17993 * @since 9 17994 */ 17995 /** 17996 * Sets the rotation effect during assembly transition. 17997 * The values are the start point during insertion and the end point during deletion. 17998 * 17999 * @param { RotateOptions } value 18000 * @returns { T } 18001 * @syscap SystemCapability.ArkUI.ArkUI.Full 18002 * @crossplatform 18003 * @form 18004 * @since 10 18005 */ 18006 /** 18007 * Set component rotation. 18008 * 18009 * @param { RotateOptions } value default:{x:0,y:0,z:0,centerX:'50%',centerY:'50%',centerZ:0,perspective:0} 18010 * @returns { T } 18011 * @syscap SystemCapability.ArkUI.ArkUI.Full 18012 * @crossplatform 18013 * @form 18014 * @atomicservice 18015 * @since 11 18016 */ 18017 rotate(value: RotateOptions): T; 18018 18019 /** 18020 * Sets the transformation matrix for the current component. 18021 * 18022 * @param { object } value 18023 * @returns { T } 18024 * @syscap SystemCapability.ArkUI.ArkUI.Full 18025 * @since 7 18026 */ 18027 /** 18028 * Sets the transformation matrix for the current component. 18029 * 18030 * @param { object } value 18031 * @returns { T } 18032 * @syscap SystemCapability.ArkUI.ArkUI.Full 18033 * @crossplatform 18034 * @since 10 18035 */ 18036 /** 18037 * Sets the transformation matrix for the current component. 18038 * 18039 * @param { object } value 18040 * @returns { T } 18041 * @syscap SystemCapability.ArkUI.ArkUI.Full 18042 * @crossplatform 18043 * @atomicservice 18044 * @since 11 18045 */ 18046 transform(value: object): T; 18047 18048 /** 18049 * This callback is triggered when a component mounts a display. 18050 * 18051 * @param { function } event 18052 * @returns { T } 18053 * @syscap SystemCapability.ArkUI.ArkUI.Full 18054 * @since 7 18055 */ 18056 /** 18057 * This callback is triggered when a component mounts a display. 18058 * 18059 * @param { function } event 18060 * @returns { T } 18061 * @syscap SystemCapability.ArkUI.ArkUI.Full 18062 * @form 18063 * @since 9 18064 */ 18065 /** 18066 * This callback is triggered when a component mounts a display. 18067 * 18068 * @param { function } event 18069 * @returns { T } 18070 * @syscap SystemCapability.ArkUI.ArkUI.Full 18071 * @crossplatform 18072 * @form 18073 * @since 10 18074 */ 18075 /** 18076 * This callback is triggered when a component mounts a display. 18077 * 18078 * @param { function } event 18079 * @returns { T } 18080 * @syscap SystemCapability.ArkUI.ArkUI.Full 18081 * @crossplatform 18082 * @form 18083 * @atomicservice 18084 * @since 11 18085 */ 18086 onAppear(event: () => void): T; 18087 18088 /** 18089 * This callback is triggered when component uninstallation disappears. 18090 * 18091 * @param { function } event 18092 * @returns { T } 18093 * @syscap SystemCapability.ArkUI.ArkUI.Full 18094 * @since 7 18095 */ 18096 /** 18097 * This callback is triggered when component uninstallation disappears. 18098 * 18099 * @param { function } event 18100 * @returns { T } 18101 * @syscap SystemCapability.ArkUI.ArkUI.Full 18102 * @form 18103 * @since 9 18104 */ 18105 /** 18106 * This callback is triggered when component uninstallation disappears. 18107 * 18108 * @param { function } event 18109 * @returns { T } 18110 * @syscap SystemCapability.ArkUI.ArkUI.Full 18111 * @crossplatform 18112 * @form 18113 * @since 10 18114 */ 18115 /** 18116 * This callback is triggered when component uninstallation disappears. 18117 * 18118 * @param { function } event 18119 * @returns { T } 18120 * @syscap SystemCapability.ArkUI.ArkUI.Full 18121 * @crossplatform 18122 * @form 18123 * @atomicservice 18124 * @since 11 18125 */ 18126 onDisAppear(event: () => void): T; 18127 18128 /** 18129 * This callback is triggered when a component mounts to view tree. 18130 * 18131 * @param { Callback<void> } callback 18132 * @returns { T } 18133 * @syscap SystemCapability.ArkUI.ArkUI.Full 18134 * @crossplatform 18135 * @atomicservice 18136 * @since 12 18137 */ 18138 onAttach(callback: Callback<void>): T; 18139 18140 /** 18141 * This callback is triggered when a component is detached from view tree. 18142 * 18143 * @param { Callback<void> } callback 18144 * @returns { T } 18145 * @syscap SystemCapability.ArkUI.ArkUI.Full 18146 * @crossplatform 18147 * @atomicservice 18148 * @since 12 18149 */ 18150 onDetach(callback: Callback<void>): T; 18151 18152 /** 18153 * This callback is triggered when the size or position of this component change finished. 18154 * 18155 * @param { function } event - event callback. 18156 * @returns { T } 18157 * @syscap SystemCapability.ArkUI.ArkUI.Full 18158 * @since 8 18159 */ 18160 /** 18161 * This callback is triggered when the size or position of this component change finished. 18162 * 18163 * @param { function } event - event callback. 18164 * @returns { T } 18165 * @syscap SystemCapability.ArkUI.ArkUI.Full 18166 * @crossplatform 18167 * @since 10 18168 */ 18169 /** 18170 * This callback is triggered when the size or position of this component change finished. 18171 * 18172 * @param { function } event - event callback. 18173 * @returns { T } 18174 * @syscap SystemCapability.ArkUI.ArkUI.Full 18175 * @crossplatform 18176 * @atomicservice 18177 * @since 11 18178 */ 18179 onAreaChange(event: (oldValue: Area, newValue: Area) => void): T; 18180 18181 /** 18182 * Controls the display or hide of the current component. 18183 * 18184 * @param { Visibility } value 18185 * @returns { T } 18186 * @syscap SystemCapability.ArkUI.ArkUI.Full 18187 * @since 7 18188 */ 18189 /** 18190 * Controls the display or hide of the current component. 18191 * 18192 * @param { Visibility } value 18193 * @returns { T } 18194 * @syscap SystemCapability.ArkUI.ArkUI.Full 18195 * @form 18196 * @since 9 18197 */ 18198 /** 18199 * Controls the display or hide of the current component. 18200 * 18201 * @param { Visibility } value 18202 * @returns { T } 18203 * @syscap SystemCapability.ArkUI.ArkUI.Full 18204 * @crossplatform 18205 * @form 18206 * @since 10 18207 */ 18208 /** 18209 * Controls the display or hide of the current component. 18210 * 18211 * @param { Visibility } value 18212 * @returns { T } 18213 * @syscap SystemCapability.ArkUI.ArkUI.Full 18214 * @crossplatform 18215 * @form 18216 * @atomicservice 18217 * @since 11 18218 */ 18219 visibility(value: Visibility): T; 18220 18221 /** 18222 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 18223 * 18224 * @param { number } value 18225 * @returns { T } 18226 * @syscap SystemCapability.ArkUI.ArkUI.Full 18227 * @since 7 18228 */ 18229 /** 18230 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 18231 * 18232 * @param { number } value 18233 * @returns { T } 18234 * @syscap SystemCapability.ArkUI.ArkUI.Full 18235 * @form 18236 * @since 9 18237 */ 18238 /** 18239 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 18240 * 18241 * @param { number } value 18242 * @returns { T } 18243 * @syscap SystemCapability.ArkUI.ArkUI.Full 18244 * @crossplatform 18245 * @form 18246 * @since 10 18247 */ 18248 /** 18249 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 18250 * 18251 * @param { number } value 18252 * @returns { T } 18253 * @syscap SystemCapability.ArkUI.ArkUI.Full 18254 * @crossplatform 18255 * @form 18256 * @atomicservice 18257 * @since 11 18258 */ 18259 flexGrow(value: number): T; 18260 18261 /** 18262 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 18263 * 18264 * @param { number } value 18265 * @returns { T } 18266 * @syscap SystemCapability.ArkUI.ArkUI.Full 18267 * @since 7 18268 */ 18269 /** 18270 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 18271 * 18272 * @param { number } value 18273 * @returns { T } 18274 * @syscap SystemCapability.ArkUI.ArkUI.Full 18275 * @form 18276 * @since 9 18277 */ 18278 /** 18279 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 18280 * 18281 * @param { number } value 18282 * @returns { T } 18283 * @syscap SystemCapability.ArkUI.ArkUI.Full 18284 * @crossplatform 18285 * @form 18286 * @since 10 18287 */ 18288 /** 18289 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 18290 * 18291 * @param { number } value 18292 * @returns { T } 18293 * @syscap SystemCapability.ArkUI.ArkUI.Full 18294 * @crossplatform 18295 * @form 18296 * @atomicservice 18297 * @since 11 18298 */ 18299 flexShrink(value: number): T; 18300 18301 /** 18302 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 18303 * 18304 * @param { number | string } value 18305 * @returns { T } 18306 * @syscap SystemCapability.ArkUI.ArkUI.Full 18307 * @since 7 18308 */ 18309 /** 18310 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 18311 * 18312 * @param { number | string } value 18313 * @returns { T } 18314 * @syscap SystemCapability.ArkUI.ArkUI.Full 18315 * @form 18316 * @since 9 18317 */ 18318 /** 18319 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 18320 * 18321 * @param { number | string } value 18322 * @returns { T } 18323 * @syscap SystemCapability.ArkUI.ArkUI.Full 18324 * @crossplatform 18325 * @form 18326 * @since 10 18327 */ 18328 /** 18329 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 18330 * 18331 * @param { number | string } value 18332 * @returns { T } 18333 * @syscap SystemCapability.ArkUI.ArkUI.Full 18334 * @crossplatform 18335 * @form 18336 * @atomicservice 18337 * @since 11 18338 */ 18339 flexBasis(value: number | string): T; 18340 18341 /** 18342 * Overrides the default configuration of alignItems in the Flex Layout container. 18343 * 18344 * @param { ItemAlign } value 18345 * @returns { T } 18346 * @syscap SystemCapability.ArkUI.ArkUI.Full 18347 * @since 7 18348 */ 18349 /** 18350 * Overrides the default configuration of alignItems in the Flex Layout container. 18351 * 18352 * @param { ItemAlign } value 18353 * @returns { T } 18354 * @syscap SystemCapability.ArkUI.ArkUI.Full 18355 * @form 18356 * @since 9 18357 */ 18358 /** 18359 * Overrides the default configuration of alignItems in the Flex Layout container. 18360 * 18361 * @param { ItemAlign } value 18362 * @returns { T } 18363 * @syscap SystemCapability.ArkUI.ArkUI.Full 18364 * @crossplatform 18365 * @form 18366 * @since 10 18367 */ 18368 /** 18369 * Overrides the default configuration of alignItems in the Flex Layout container. 18370 * 18371 * @param { ItemAlign } value 18372 * @returns { T } 18373 * @syscap SystemCapability.ArkUI.ArkUI.Full 18374 * @crossplatform 18375 * @form 18376 * @atomicservice 18377 * @since 11 18378 */ 18379 alignSelf(value: ItemAlign): T; 18380 18381 /** 18382 * 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. 18383 * 18384 * @param { number } value 18385 * @returns { T } 18386 * @syscap SystemCapability.ArkUI.ArkUI.Full 18387 * @since 7 18388 */ 18389 /** 18390 * 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. 18391 * 18392 * @param { number } value 18393 * @returns { T } 18394 * @syscap SystemCapability.ArkUI.ArkUI.Full 18395 * @form 18396 * @since 9 18397 */ 18398 /** 18399 * 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. 18400 * 18401 * @param { number } value 18402 * @returns { T } 18403 * @syscap SystemCapability.ArkUI.ArkUI.Full 18404 * @crossplatform 18405 * @form 18406 * @since 10 18407 */ 18408 /** 18409 * 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. 18410 * 18411 * @param { number } value 18412 * @returns { T } 18413 * @syscap SystemCapability.ArkUI.ArkUI.Full 18414 * @crossplatform 18415 * @form 18416 * @atomicservice 18417 * @since 11 18418 */ 18419 displayPriority(value: number): T; 18420 18421 /** 18422 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 18423 * 18424 * @param { number } value 18425 * @returns { T } 18426 * @syscap SystemCapability.ArkUI.ArkUI.Full 18427 * @since 7 18428 */ 18429 /** 18430 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 18431 * 18432 * @param { number } value 18433 * @returns { T } 18434 * @syscap SystemCapability.ArkUI.ArkUI.Full 18435 * @form 18436 * @since 9 18437 */ 18438 /** 18439 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 18440 * 18441 * @param { number } value 18442 * @returns { T } 18443 * @syscap SystemCapability.ArkUI.ArkUI.Full 18444 * @crossplatform 18445 * @form 18446 * @since 10 18447 */ 18448 /** 18449 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 18450 * 18451 * @param { number } value 18452 * @returns { T } 18453 * @syscap SystemCapability.ArkUI.ArkUI.Full 18454 * @crossplatform 18455 * @form 18456 * @atomicservice 18457 * @since 11 18458 */ 18459 zIndex(value: number): T; 18460 18461 /** 18462 * 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. 18463 * 18464 * @param { string } id 18465 * @param { sharedTransitionOptions } options 18466 * @returns { T } 18467 * @syscap SystemCapability.ArkUI.ArkUI.Full 18468 * @since 7 18469 */ 18470 /** 18471 * 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. 18472 * 18473 * @param { string } id 18474 * @param { sharedTransitionOptions } options 18475 * @returns { T } 18476 * @syscap SystemCapability.ArkUI.ArkUI.Full 18477 * @crossplatform 18478 * @since 10 18479 */ 18480 /** 18481 * 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. 18482 * 18483 * @param { string } id 18484 * @param { sharedTransitionOptions } options 18485 * @returns { T } 18486 * @syscap SystemCapability.ArkUI.ArkUI.Full 18487 * @crossplatform 18488 * @atomicservice 18489 * @since 11 18490 */ 18491 sharedTransition(id: string, options?: sharedTransitionOptions): T; 18492 18493 /** 18494 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 18495 * 18496 * @param { Direction } value 18497 * @returns { T } 18498 * @syscap SystemCapability.ArkUI.ArkUI.Full 18499 * @since 7 18500 */ 18501 /** 18502 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 18503 * 18504 * @param { Direction } value 18505 * @returns { T } 18506 * @syscap SystemCapability.ArkUI.ArkUI.Full 18507 * @form 18508 * @since 9 18509 */ 18510 /** 18511 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 18512 * 18513 * @param { Direction } value 18514 * @returns { T } 18515 * @syscap SystemCapability.ArkUI.ArkUI.Full 18516 * @crossplatform 18517 * @form 18518 * @since 10 18519 */ 18520 /** 18521 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 18522 * 18523 * @param { Direction } value 18524 * @returns { T } 18525 * @syscap SystemCapability.ArkUI.ArkUI.Full 18526 * @crossplatform 18527 * @form 18528 * @atomicservice 18529 * @since 11 18530 */ 18531 direction(value: Direction): T; 18532 18533 /** 18534 * align 18535 * 18536 * @param { Alignment } value 18537 * @returns { T } 18538 * @syscap SystemCapability.ArkUI.ArkUI.Full 18539 * @since 7 18540 */ 18541 /** 18542 * align 18543 * 18544 * @param { Alignment } value 18545 * @returns { T } 18546 * @syscap SystemCapability.ArkUI.ArkUI.Full 18547 * @form 18548 * @since 9 18549 */ 18550 /** 18551 * align 18552 * 18553 * @param { Alignment } value 18554 * @returns { T } 18555 * @syscap SystemCapability.ArkUI.ArkUI.Full 18556 * @crossplatform 18557 * @form 18558 * @since 10 18559 */ 18560 /** 18561 * align 18562 * 18563 * @param { Alignment } value 18564 * @returns { T } 18565 * @syscap SystemCapability.ArkUI.ArkUI.Full 18566 * @crossplatform 18567 * @form 18568 * @atomicservice 18569 * @since 11 18570 */ 18571 align(value: Alignment): T; 18572 18573 /** 18574 * position 18575 * 18576 * @param { Position } value 18577 * @returns { T } 18578 * @syscap SystemCapability.ArkUI.ArkUI.Full 18579 * @since 7 18580 */ 18581 /** 18582 * position 18583 * 18584 * @param { Position } value 18585 * @returns { T } 18586 * @syscap SystemCapability.ArkUI.ArkUI.Full 18587 * @form 18588 * @since 9 18589 */ 18590 /** 18591 * position 18592 * 18593 * @param { Position } value 18594 * @returns { T } 18595 * @syscap SystemCapability.ArkUI.ArkUI.Full 18596 * @crossplatform 18597 * @form 18598 * @since 10 18599 */ 18600 /** 18601 * position 18602 * 18603 * @param { Position } value 18604 * @returns { T } 18605 * @syscap SystemCapability.ArkUI.ArkUI.Full 18606 * @crossplatform 18607 * @form 18608 * @atomicservice 18609 * @since 11 18610 */ 18611 /** 18612 * position 18613 * 18614 * @param { Position | Edges | LocalizedEdges } value 18615 * @returns { T } 18616 * @syscap SystemCapability.ArkUI.ArkUI.Full 18617 * @crossplatform 18618 * @form 18619 * @atomicservice 18620 * @since 12 18621 */ 18622 position(value: Position | Edges | LocalizedEdges): T; 18623 18624 /** 18625 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 18626 * 18627 * @param { Position } value 18628 * @returns { T } 18629 * @syscap SystemCapability.ArkUI.ArkUI.Full 18630 * @since 7 18631 */ 18632 /** 18633 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 18634 * 18635 * @param { Position } value 18636 * @returns { T } 18637 * @syscap SystemCapability.ArkUI.ArkUI.Full 18638 * @form 18639 * @since 9 18640 */ 18641 /** 18642 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 18643 * 18644 * @param { Position } value 18645 * @returns { T } 18646 * @syscap SystemCapability.ArkUI.ArkUI.Full 18647 * @crossplatform 18648 * @form 18649 * @since 10 18650 */ 18651 /** 18652 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 18653 * 18654 * @param { Position } value 18655 * @returns { T } 18656 * @syscap SystemCapability.ArkUI.ArkUI.Full 18657 * @crossplatform 18658 * @form 18659 * @atomicservice 18660 * @since 11 18661 */ 18662 /** 18663 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 18664 * 18665 * @param { Position | LocalizedPosition} value 18666 * @returns { T } 18667 * @syscap SystemCapability.ArkUI.ArkUI.Full 18668 * @crossplatform 18669 * @form 18670 * @atomicservice 18671 * @since 12 18672 */ 18673 markAnchor(value: Position | LocalizedPosition): T; 18674 18675 /** 18676 * Coordinate offset relative to the layout completion position. 18677 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 18678 * 18679 * @param { Position } value 18680 * @returns { T } 18681 * @syscap SystemCapability.ArkUI.ArkUI.Full 18682 * @since 7 18683 */ 18684 /** 18685 * Coordinate offset relative to the layout completion position. 18686 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 18687 * 18688 * @param { Position } value 18689 * @returns { T } 18690 * @syscap SystemCapability.ArkUI.ArkUI.Full 18691 * @form 18692 * @since 9 18693 */ 18694 /** 18695 * Coordinate offset relative to the layout completion position. 18696 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 18697 * 18698 * @param { Position } value 18699 * @returns { T } 18700 * @syscap SystemCapability.ArkUI.ArkUI.Full 18701 * @crossplatform 18702 * @form 18703 * @since 10 18704 */ 18705 /** 18706 * Coordinate offset relative to the layout completion position. 18707 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 18708 * 18709 * @param { Position } value 18710 * @returns { T } 18711 * @syscap SystemCapability.ArkUI.ArkUI.Full 18712 * @crossplatform 18713 * @form 18714 * @atomicservice 18715 * @since 11 18716 */ 18717 /** 18718 * Coordinate offset relative to the layout completion position. 18719 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 18720 * 18721 * @param { Position | Edges | LocalizedEdges } value 18722 * @returns { T } 18723 * @syscap SystemCapability.ArkUI.ArkUI.Full 18724 * @crossplatform 18725 * @form 18726 * @atomicservice 18727 * @since 12 18728 */ 18729 offset(value: Position | Edges | LocalizedEdges): T; 18730 18731 /** 18732 * If the value is true, the component is available and can respond to operations such as clicking. 18733 * If it is set to false, click operations are not responded. 18734 * 18735 * @param { boolean } value 18736 * @returns { T } 18737 * @syscap SystemCapability.ArkUI.ArkUI.Full 18738 * @since 7 18739 */ 18740 /** 18741 * If the value is true, the component is available and can respond to operations such as clicking. 18742 * If it is set to false, click operations are not responded. 18743 * 18744 * @param { boolean } value 18745 * @returns { T } 18746 * @syscap SystemCapability.ArkUI.ArkUI.Full 18747 * @form 18748 * @since 9 18749 */ 18750 /** 18751 * If the value is true, the component is available and can respond to operations such as clicking. 18752 * If it is set to false, click operations are not responded. 18753 * 18754 * @param { boolean } value 18755 * @returns { T } 18756 * @syscap SystemCapability.ArkUI.ArkUI.Full 18757 * @crossplatform 18758 * @form 18759 * @since 10 18760 */ 18761 /** 18762 * If the value is true, the component is available and can respond to operations such as clicking. 18763 * If it is set to false, click operations are not responded. 18764 * 18765 * @param { boolean } value 18766 * @returns { T } 18767 * @syscap SystemCapability.ArkUI.ArkUI.Full 18768 * @crossplatform 18769 * @form 18770 * @atomicservice 18771 * @since 11 18772 */ 18773 enabled(value: boolean): T; 18774 18775 /** 18776 * Sets the number of occupied columns and offset columns for a specific device width type. 18777 * 18778 * @param { object } value 18779 * @returns { T } 18780 * @syscap SystemCapability.ArkUI.ArkUI.Full 18781 * @since 7 18782 * @deprecated since 9 18783 * @useinstead grid_col/GridColColumnOption and grid_row/GridRowColumnOption 18784 */ 18785 useSizeType(value: { 18786 xs?: number | { span: number; offset: number }; 18787 sm?: number | { span: number; offset: number }; 18788 md?: number | { span: number; offset: number }; 18789 lg?: number | { span: number; offset: number }; 18790 }): T; 18791 18792 /** 18793 * Specifies the alignRules of relative container 18794 * 18795 * @param { AlignRuleOption } value 18796 * @returns { T } 18797 * @syscap SystemCapability.ArkUI.ArkUI.Full 18798 * @form 18799 * @since 9 18800 */ 18801 /** 18802 * Specifies the alignRules of relative container 18803 * 18804 * @param { AlignRuleOption } value 18805 * @returns { T } 18806 * @syscap SystemCapability.ArkUI.ArkUI.Full 18807 * @crossplatform 18808 * @form 18809 * @since 10 18810 */ 18811 /** 18812 * Specifies the alignRules of relative container 18813 * 18814 * @param { AlignRuleOption } value 18815 * @returns { T } 18816 * @syscap SystemCapability.ArkUI.ArkUI.Full 18817 * @crossplatform 18818 * @form 18819 * @atomicservice 18820 * @since 11 18821 */ 18822 alignRules(value: AlignRuleOption): T; 18823 18824 /** 18825 * Specifies the localized alignRules of relative container 18826 * 18827 * @param { LocalizedAlignRuleOptions } alignRule 18828 * @returns { T } 18829 * @syscap SystemCapability.ArkUI.ArkUI.Full 18830 * @crossplatform 18831 * @form 18832 * @atomicservice 18833 * @since 12 18834 */ 18835 alignRules(alignRule: LocalizedAlignRuleOptions): T; 18836 18837 /** 18838 * Specifies the direction and style of chain in relative container 18839 * 18840 * @param { Axis } direction - indicates direction of the chain 18841 * @param { ChainStyle } style - indicates style of the chain 18842 * @returns { T } 18843 * @syscap SystemCapability.ArkUI.ArkUI.Full 18844 * @crossplatform 18845 * @atomicservice 18846 * @since 12 18847 */ 18848 chainMode(direction: Axis, style: ChainStyle): T; 18849 18850 /** 18851 * Specifies the aspect ratio of the current component. 18852 * 18853 * @param { number } value 18854 * @returns { T } 18855 * @syscap SystemCapability.ArkUI.ArkUI.Full 18856 * @since 7 18857 */ 18858 /** 18859 * Specifies the aspect ratio of the current component. 18860 * 18861 * @param { number } value 18862 * @returns { T } 18863 * @syscap SystemCapability.ArkUI.ArkUI.Full 18864 * @form 18865 * @since 9 18866 */ 18867 /** 18868 * Specifies the aspect ratio of the current component. 18869 * 18870 * @param { number } value 18871 * @returns { T } 18872 * @syscap SystemCapability.ArkUI.ArkUI.Full 18873 * @crossplatform 18874 * @form 18875 * @since 10 18876 */ 18877 /** 18878 * Specifies the aspect ratio of the current component. 18879 * 18880 * @param { number } value 18881 * @returns { T } 18882 * @syscap SystemCapability.ArkUI.ArkUI.Full 18883 * @crossplatform 18884 * @form 18885 * @atomicservice 18886 * @since 11 18887 */ 18888 aspectRatio(value: number): T; 18889 18890 /** 18891 * The click effect level and scale number. 18892 * 18893 * @param { ClickEffect | null } value 18894 * @returns { T } return the component attribute. 18895 * @syscap SystemCapability.ArkUI.ArkUI.Full 18896 * @crossplatform 18897 * @since 10 18898 */ 18899 /** 18900 * The click effect level and scale number. 18901 * 18902 * @param { ClickEffect | null } value 18903 * @returns { T } return the component attribute. 18904 * @syscap SystemCapability.ArkUI.ArkUI.Full 18905 * @crossplatform 18906 * @atomicservice 18907 * @since 11 18908 */ 18909 clickEffect(value: ClickEffect | null): T; 18910 18911 /** 18912 * After a listener is bound, the component can be dragged. After the drag occurs, a callback is triggered. 18913 * (To be triggered, press and hold for 170 milliseconds (ms)) 18914 * 18915 * @param { function } event 18916 * @returns { T } 18917 * @syscap SystemCapability.ArkUI.ArkUI.Full 18918 * @since 8 18919 */ 18920 /** 18921 * After a listener is bound, the component can be dragged. After the drag occurs, a callback is triggered. 18922 * (To be triggered, press and hold for 170 milliseconds (ms)) 18923 * 18924 * @param { function } event 18925 * @returns { T } 18926 * @syscap SystemCapability.ArkUI.ArkUI.Full 18927 * @atomicservice 18928 * @since 11 18929 */ 18930 /** 18931 * After a listener is bound, the component can be dragged. After the drag occurs, a callback is triggered. 18932 * (To be triggered, press and hold for 170 milliseconds (ms)) 18933 * 18934 * @param { function } event 18935 * @returns { T } 18936 * @syscap SystemCapability.ArkUI.ArkUI.Full 18937 * @crossplatform 18938 * @atomicservice 18939 * @since 14 18940 */ 18941 onDragStart(event: (event: DragEvent, extraParams?: string) => CustomBuilder | DragItemInfo): T; 18942 18943 /** 18944 * After binding, a callback is triggered when the component is dragged to the range of the component. 18945 * 18946 * @param { function } event 18947 * @returns { T } 18948 * @syscap SystemCapability.ArkUI.ArkUI.Full 18949 * @since 8 18950 */ 18951 /** 18952 * After binding, a callback is triggered when the component is dragged to the range of the component. 18953 * 18954 * @param { function } event 18955 * @returns { T } 18956 * @syscap SystemCapability.ArkUI.ArkUI.Full 18957 * @atomicservice 18958 * @since 11 18959 */ 18960 /** 18961 * After binding, a callback is triggered when the component is dragged to the range of the component. 18962 * 18963 * @param { function } event 18964 * @returns { T } 18965 * @syscap SystemCapability.ArkUI.ArkUI.Full 18966 * @crossplatform 18967 * @atomicservice 18968 * @since 14 18969 */ 18970 onDragEnter(event: (event: DragEvent, extraParams?: string) => void): T; 18971 18972 /** 18973 * After binding, a callback is triggered when the drag moves within the range of a placeable component. 18974 * 18975 * @param { function } event 18976 * @returns { T } 18977 * @syscap SystemCapability.ArkUI.ArkUI.Full 18978 * @since 8 18979 */ 18980 /** 18981 * After binding, a callback is triggered when the drag moves within the range of a placeable component. 18982 * 18983 * @param { function } event 18984 * @returns { T } 18985 * @syscap SystemCapability.ArkUI.ArkUI.Full 18986 * @atomicservice 18987 * @since 11 18988 */ 18989 /** 18990 * After binding, a callback is triggered when the drag moves within the range of a placeable component. 18991 * 18992 * @param { function } event 18993 * @returns { T } 18994 * @syscap SystemCapability.ArkUI.ArkUI.Full 18995 * @crossplatform 18996 * @atomicservice 18997 * @since 14 18998 */ 18999 onDragMove(event: (event: DragEvent, extraParams?: string) => void): T; 19000 19001 /** 19002 * After binding, a callback is triggered when the component is dragged out of the component range. 19003 * 19004 * @param { function } event 19005 * @returns { T } 19006 * @syscap SystemCapability.ArkUI.ArkUI.Full 19007 * @since 8 19008 */ 19009 /** 19010 * After binding, a callback is triggered when the component is dragged out of the component range. 19011 * 19012 * @param { function } event 19013 * @returns { T } 19014 * @syscap SystemCapability.ArkUI.ArkUI.Full 19015 * @atomicservice 19016 * @since 11 19017 */ 19018 /** 19019 * After binding, a callback is triggered when the component is dragged out of the component range. 19020 * 19021 * @param { function } event 19022 * @returns { T } 19023 * @syscap SystemCapability.ArkUI.ArkUI.Full 19024 * @crossplatform 19025 * @atomicservice 19026 * @since 14 19027 */ 19028 onDragLeave(event: (event: DragEvent, extraParams?: string) => void): T; 19029 19030 /** 19031 * The component bound to this event can be used as the drag release target. 19032 * This callback is triggered when the drag behavior is stopped within the scope of the component. 19033 * 19034 * @param { function } event 19035 * @returns { T } 19036 * @syscap SystemCapability.ArkUI.ArkUI.Full 19037 * @since 8 19038 */ 19039 /** 19040 * The component bound to this event can be used as the drag release target. 19041 * This callback is triggered when the drag behavior is stopped within the scope of the component. 19042 * 19043 * @param { function } event 19044 * @returns { T } 19045 * @syscap SystemCapability.ArkUI.ArkUI.Full 19046 * @atomicservice 19047 * @since 11 19048 */ 19049 /** 19050 * The component bound to this event can be used as the drag release target. 19051 * This callback is triggered when the drag behavior is stopped within the scope of the component. 19052 * 19053 * @param { function } event 19054 * @returns { T } 19055 * @syscap SystemCapability.ArkUI.ArkUI.Full 19056 * @crossplatform 19057 * @atomicservice 19058 * @since 14 19059 */ 19060 onDrop(event: (event: DragEvent, extraParams?: string) => void): T; 19061 19062 /** 19063 * This function is called when the drag event is end. 19064 * 19065 * @param { function } event - indicates the function to be called. 19066 * @returns { T } property value of type T. 19067 * @syscap SystemCapability.ArkUI.ArkUI.Full 19068 * @since 10 19069 */ 19070 /** 19071 * This function is called when the drag event is end. 19072 * 19073 * @param { function } event - indicates the function to be called. 19074 * @returns { T } property value of type T. 19075 * @syscap SystemCapability.ArkUI.ArkUI.Full 19076 * @atomicservice 19077 * @since 11 19078 */ 19079 /** 19080 * This function is called when the drag event is end. 19081 * 19082 * @param { function } event - indicates the function to be called. 19083 * @returns { T } property value of type T. 19084 * @syscap SystemCapability.ArkUI.ArkUI.Full 19085 * @crossplatform 19086 * @atomicservice 19087 * @since 14 19088 */ 19089 onDragEnd(event: (event: DragEvent, extraParams?: string) => void): T; 19090 19091 /** 19092 * Allowed drop uniformData type for this node. 19093 * 19094 * @param { Array<UniformDataType> } value - the uniformData type for this node. 19095 * @returns { T } property value of type T. 19096 * @syscap SystemCapability.ArkUI.ArkUI.Full 19097 * @crossplatform 19098 * @since 10 19099 */ 19100 /** 19101 * Allowed drop uniformData type for this node. 19102 * 19103 * @param { Array<UniformDataType> } value - the uniformData type for this node. 19104 * @returns { T } property value of type T. 19105 * @syscap SystemCapability.ArkUI.ArkUI.Full 19106 * @crossplatform 19107 * @atomicservice 19108 * @since 11 19109 */ 19110 /** 19111 * Allowed drop uniformData type for this node. 19112 * 19113 * @param { Array<UniformDataType> | null } value - the uniformData type for this node. 19114 * @returns { T } property value of type T. 19115 * @syscap SystemCapability.ArkUI.ArkUI.Full 19116 * @crossplatform 19117 * @atomicservice 19118 * @since 12 19119 */ 19120 allowDrop(value: Array<UniformDataType> | null): T; 19121 19122 /** 19123 * Enable the selectable area can be dragged. 19124 * 19125 * @param { boolean } value - true means the area can be dragged, false means the area can't be dragged. 19126 * @returns { T } property value of type T. 19127 * @syscap SystemCapability.ArkUI.ArkUI.Full 19128 * @since 10 19129 */ 19130 /** 19131 * Enable the selectable area can be dragged. 19132 * 19133 * @param { boolean } value - true means the area can be dragged, false means the area can't be dragged. 19134 * @returns { T } property value of type T. 19135 * @syscap SystemCapability.ArkUI.ArkUI.Full 19136 * @crossplatform 19137 * @atomicservice 19138 * @since 11 19139 */ 19140 draggable(value: boolean): T; 19141 19142 /** 19143 * Set preview of the component for dragging process 19144 * 19145 * @param { CustomBuilder | DragItemInfo } value - preview of the component for dragging process 19146 * @returns { T } property value of type T. 19147 * @syscap SystemCapability.ArkUI.ArkUI.Full 19148 * @since 11 19149 */ 19150 /** 19151 * Set preview of the component for dragging process 19152 * 19153 * @param { CustomBuilder | DragItemInfo | string } value - preview of the component for dragging process 19154 * @returns { T } property value of type T. 19155 * @syscap SystemCapability.ArkUI.ArkUI.Full 19156 * @atomicservice 19157 * @since 12 19158 */ 19159 dragPreview(value: CustomBuilder | DragItemInfo | string): T; 19160 19161 /** 19162 * Set the selectable area drag preview options. 19163 * 19164 * @param { DragPreviewOptions } value - preview options value. 19165 * @returns { T } property value of type T. 19166 * @syscap SystemCapability.ArkUI.ArkUI.Full 19167 * @since 11 19168 */ 19169 /** 19170 * Set the selectable area drag preview options. 19171 * 19172 * @param { DragPreviewOptions } value - preview options value. 19173 * @param { DragInteractionOptions } options - drag interaction options value. 19174 * @returns { T } property value of type T. 19175 * @syscap SystemCapability.ArkUI.ArkUI.Full 19176 * @atomicservice 19177 * @since 12 19178 */ 19179 dragPreviewOptions(value: DragPreviewOptions, options?: DragInteractionOptions): T; 19180 19181 /** 19182 * After binding, a callback is triggered when the preDrag status change finished. 19183 * 19184 * @param { Callback<PreDragStatus> } callback callback - The callback will be triggered when the preDrag status change. 19185 * @returns { T } property value of type T. 19186 * @syscap SystemCapability.ArkUI.ArkUI.Full 19187 * @atomicservice 19188 * @since 12 19189 */ 19190 onPreDrag(callback: Callback<PreDragStatus>): T; 19191 19192 /** 19193 * Add mask text to the current component. The layout is the same as that of the current component. 19194 * 19195 * @param { string } value 19196 * @param { object } options 19197 * @returns { T } 19198 * @syscap SystemCapability.ArkUI.ArkUI.Full 19199 * @since 7 19200 */ 19201 /** 19202 * Add mask text to the current component. The layout is the same as that of the current component. 19203 * 19204 * @param { string } value 19205 * @param { object } options 19206 * @returns { T } 19207 * @syscap SystemCapability.ArkUI.ArkUI.Full 19208 * @form 19209 * @since 9 19210 */ 19211 /** 19212 * Add mask text to the current component. The layout is the same as that of the current component. 19213 * 19214 * @param { string | CustomBuilder } value 19215 * @param { object } options 19216 * @returns { T } 19217 * @syscap SystemCapability.ArkUI.ArkUI.Full 19218 * @crossplatform 19219 * @form 19220 * @since 10 19221 */ 19222 /** 19223 * Add mask text to the current component. The layout is the same as that of the current component. 19224 * 19225 * @param { string | CustomBuilder } value 19226 * @param { object } options 19227 * @returns { T } 19228 * @syscap SystemCapability.ArkUI.ArkUI.Full 19229 * @crossplatform 19230 * @form 19231 * @atomicservice 19232 * @since 11 19233 */ 19234 /** 19235 * Add mask text to the current component. The layout is the same as that of the current component. 19236 * 19237 * @param { string | CustomBuilder | ComponentContent } value 19238 * @param { OverlayOptions } options 19239 * @returns { T } 19240 * @syscap SystemCapability.ArkUI.ArkUI.Full 19241 * @crossplatform 19242 * @form 19243 * @atomicservice 19244 * @since 12 19245 */ 19246 overlay(value: string | CustomBuilder | ComponentContent, options?: OverlayOptions): T; 19247 19248 /** 19249 * Linear Gradient 19250 * angle: Angle of Linear Gradient. The default value is 180; 19251 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 19252 * colors: Color description for gradients. 19253 * repeating: repeating. The default value is false 19254 * 19255 * @param { object } value 19256 * @returns { T } 19257 * @syscap SystemCapability.ArkUI.ArkUI.Full 19258 * @since 7 19259 */ 19260 /** 19261 * Linear Gradient 19262 * angle: Angle of Linear Gradient. The default value is 180; 19263 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 19264 * colors: Color description for gradients. 19265 * repeating: repeating. The default value is false 19266 * 19267 * @param { object } value 19268 * @returns { T } 19269 * @syscap SystemCapability.ArkUI.ArkUI.Full 19270 * @form 19271 * @since 9 19272 */ 19273 /** 19274 * Linear Gradient 19275 * angle: Angle of Linear Gradient. The default value is 180; 19276 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 19277 * colors: Color description for gradients. 19278 * repeating: repeating. The default value is false 19279 * 19280 * @param { object } value 19281 * @returns { T } 19282 * @syscap SystemCapability.ArkUI.ArkUI.Full 19283 * @crossplatform 19284 * @form 19285 * @since 10 19286 */ 19287 /** 19288 * Linear Gradient 19289 * angle: Angle of Linear Gradient. The default value is 180; 19290 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 19291 * colors: Color description for gradients. 19292 * repeating: repeating. The default value is false 19293 * 19294 * @param { object } value 19295 * @returns { T } 19296 * @syscap SystemCapability.ArkUI.ArkUI.Full 19297 * @crossplatform 19298 * @form 19299 * @atomicservice 19300 * @since 11 19301 */ 19302 /** 19303 * Linear Gradient 19304 * angle: Angle of Linear Gradient; direction:Direction of Linear Gradient; colors:Color description for gradients,repeating:repeating. 19305 * 19306 * @param { object } value 19307 * @returns { T } 19308 * @syscap SystemCapability.ArkUI.ArkUI.Full 19309 * @crossplatform 19310 * @form 19311 * @atomicservice 19312 * @since 12 19313 */ 19314 linearGradient(value: { 19315 angle?: number | string; 19316 direction?: GradientDirection; 19317 colors: Array<[ResourceColor, number]>; 19318 repeating?: boolean; 19319 }): T; 19320 19321 /** 19322 * Angle Gradient 19323 * center:is the center point of the angle gradient 19324 * start:Start point of angle gradient. The default value is 0 19325 * end:End point of angle gradient. The default value is 0 19326 * number:number 19327 * rotating:rotating. The default value is 0 19328 * colors:Color description for gradients 19329 * repeating:repeating. The default value is false 19330 * 19331 * @param { object } value 19332 * @returns { T } 19333 * @syscap SystemCapability.ArkUI.ArkUI.Full 19334 * @since 7 19335 */ 19336 /** 19337 * Angle Gradient 19338 * center:is the center point of the angle gradient 19339 * start:Start point of angle gradient. The default value is 0 19340 * end:End point of angle gradient. The default value is 0 19341 * number:number 19342 * rotating:rotating. The default value is 0 19343 * colors:Color description for gradients 19344 * repeating:repeating. The default value is false 19345 * 19346 * @param { object } value 19347 * @returns { T } 19348 * @syscap SystemCapability.ArkUI.ArkUI.Full 19349 * @form 19350 * @since 9 19351 */ 19352 /** 19353 * Angle Gradient 19354 * center:is the center point of the angle gradient 19355 * start:Start point of angle gradient. The default value is 0 19356 * end:End point of angle gradient. The default value is 0 19357 * number:number 19358 * rotating:rotating. The default value is 0 19359 * colors:Color description for gradients 19360 * repeating:repeating. The default value is false 19361 * 19362 * @param { object } value 19363 * @returns { T } 19364 * @syscap SystemCapability.ArkUI.ArkUI.Full 19365 * @crossplatform 19366 * @form 19367 * @since 10 19368 */ 19369 /** 19370 * Angle Gradient 19371 * center:is the center point of the angle gradient 19372 * start:Start point of angle gradient. The default value is 0 19373 * end:End point of angle gradient. The default value is 0 19374 * number:number 19375 * rotating:rotating. The default value is 0 19376 * colors:Color description for gradients 19377 * repeating:repeating. The default value is false 19378 * 19379 * @param { object } value 19380 * @returns { T } 19381 * @syscap SystemCapability.ArkUI.ArkUI.Full 19382 * @crossplatform 19383 * @form 19384 * @atomicservice 19385 * @since 11 19386 */ 19387 /** 19388 * Angle Gradient 19389 * center:is the center point of the angle gradient 19390 * start:Start point of angle gradient 19391 * end:End point of angle gradient 19392 * number:number 19393 * rotating:rotating 19394 * colors:Color description for gradients 19395 * repeating:repeating 19396 * 19397 * @param { object } value 19398 * @returns { T } 19399 * @syscap SystemCapability.ArkUI.ArkUI.Full 19400 * @crossplatform 19401 * @form 19402 * @atomicservice 19403 * @since 12 19404 */ 19405 sweepGradient(value: { 19406 center: [Length, Length]; 19407 start?: number | string; 19408 end?: number | string; 19409 rotation?: number | string; 19410 colors: Array<[ResourceColor, number]>; 19411 repeating?: boolean; 19412 }): T; 19413 19414 /** 19415 * Radial Gradient 19416 * center:Center point of radial gradient 19417 * radius:Radius of Radial Gradient. value range [0, +∞) 19418 * colors:Color description for gradients 19419 * repeating: Refill. The default value is false 19420 * 19421 * @param { object } value 19422 * @returns { T } 19423 * @syscap SystemCapability.ArkUI.ArkUI.Full 19424 * @since 7 19425 */ 19426 /** 19427 * Radial Gradient 19428 * center:Center point of radial gradient 19429 * radius:Radius of Radial Gradient. value range [0, +∞) 19430 * colors:Color description for gradients 19431 * repeating: Refill. The default value is false 19432 * 19433 * @param { object } value 19434 * @returns { T } 19435 * @syscap SystemCapability.ArkUI.ArkUI.Full 19436 * @form 19437 * @since 9 19438 */ 19439 /** 19440 * Radial Gradient 19441 * center:Center point of radial gradient 19442 * radius:Radius of Radial Gradient. value range [0, +∞) 19443 * colors:Color description for gradients 19444 * repeating: Refill. The default value is false 19445 * 19446 * @param { object } value 19447 * @returns { T } 19448 * @syscap SystemCapability.ArkUI.ArkUI.Full 19449 * @crossplatform 19450 * @form 19451 * @since 10 19452 */ 19453 /** 19454 * Radial Gradient 19455 * center:Center point of radial gradient 19456 * radius:Radius of Radial Gradient. value range [0, +∞) 19457 * colors:Color description for gradients 19458 * repeating: Refill. The default value is false 19459 * 19460 * @param { object } value 19461 * @returns { T } 19462 * @syscap SystemCapability.ArkUI.ArkUI.Full 19463 * @crossplatform 19464 * @form 19465 * @atomicservice 19466 * @since 11 19467 */ 19468 /** 19469 * Radial Gradient 19470 * center:Center point of radial gradient 19471 * radius:Radius of Radial Gradient 19472 * colors:Color description for gradients 19473 * repeating: Refill 19474 * 19475 * @param { object } value 19476 * @returns { T } 19477 * @syscap SystemCapability.ArkUI.ArkUI.Full 19478 * @crossplatform 19479 * @form 19480 * @atomicservice 19481 * @since 12 19482 */ 19483 radialGradient(value: { 19484 center: [Length, Length]; 19485 radius: number | string; 19486 colors: Array<[ResourceColor, number]>; 19487 repeating?: boolean; 19488 }): T; 19489 19490 /** 19491 * Set the motion path of the component 19492 * path:Motion path for displacement animation, using the svg path string. 19493 * from:Start point of the motion path. The default value is 0.0. 19494 * to:End point of the motion path. The default value is 1.0. 19495 * rotatable:Whether to follow the path for rotation. 19496 * 19497 * @param { MotionPathOptions } value 19498 * @returns { T } 19499 * @syscap SystemCapability.ArkUI.ArkUI.Full 19500 * @since 7 19501 */ 19502 /** 19503 * Set the motion path of the component 19504 * path:Motion path for displacement animation, using the svg path string. 19505 * from:Start point of the motion path. The default value is 0.0. 19506 * to:End point of the motion path. The default value is 1.0. 19507 * rotatable:Whether to follow the path for rotation. 19508 * 19509 * @param { MotionPathOptions } value 19510 * @returns { T } 19511 * @syscap SystemCapability.ArkUI.ArkUI.Full 19512 * @crossplatform 19513 * @since 10 19514 */ 19515 /** 19516 * Set the motion path of the component 19517 * path:Motion path for displacement animation, using the svg path string. 19518 * from:Start point of the motion path. The default value is 0.0. 19519 * to:End point of the motion path. The default value is 1.0. 19520 * rotatable:Whether to follow the path for rotation. 19521 * 19522 * @param { MotionPathOptions } value 19523 * @returns { T } 19524 * @syscap SystemCapability.ArkUI.ArkUI.Full 19525 * @crossplatform 19526 * @atomicservice 19527 * @since 11 19528 */ 19529 motionPath(value: MotionPathOptions): T; 19530 19531 /** 19532 * Add a shadow effect to the current component 19533 * 19534 * @param { ShadowOptions } value 19535 * @returns { T } 19536 * @syscap SystemCapability.ArkUI.ArkUI.Full 19537 * @since 7 19538 */ 19539 /** 19540 * Add a shadow effect to the current component 19541 * 19542 * @param { ShadowOptions } value 19543 * @returns { T } 19544 * @syscap SystemCapability.ArkUI.ArkUI.Full 19545 * @form 19546 * @since 9 19547 */ 19548 /** 19549 * Add a shadow effect to the current component 19550 * 19551 * @param { ShadowOptions | ShadowStyle } value 19552 * @returns { T } 19553 * @syscap SystemCapability.ArkUI.ArkUI.Full 19554 * @crossplatform 19555 * @form 19556 * @since 10 19557 */ 19558 /** 19559 * Add a shadow effect to the current component 19560 * 19561 * @param { ShadowOptions | ShadowStyle } value 19562 * @returns { T } 19563 * @syscap SystemCapability.ArkUI.ArkUI.Full 19564 * @crossplatform 19565 * @form 19566 * @atomicservice 19567 * @since 11 19568 */ 19569 shadow(value: ShadowOptions | ShadowStyle): T; 19570 19571 /** 19572 * Add a blendMode effect to the current component 19573 * 19574 * @param { BlendMode } value - Different hybrid modes 19575 * @param { BlendApplyType } [type] - Different blend apply type 19576 * @returns { T } 19577 * @syscap SystemCapability.ArkUI.ArkUI.Full 19578 * @crossplatform 19579 * @form 19580 * @since 11 19581 */ 19582 /** 19583 * Add a blendMode effect to the current component 19584 * 19585 * @param { BlendMode } value - Different hybrid modes 19586 * @param { BlendApplyType } [type] - Different blend apply type 19587 * @returns { T } 19588 * @syscap SystemCapability.ArkUI.ArkUI.Full 19589 * @crossplatform 19590 * @form 19591 * @atomicservice 19592 * @since 12 19593 */ 19594 blendMode(value: BlendMode, type?: BlendApplyType): T; 19595 19596 /** 19597 * Add a blendMode effect to the current component.Cannot be used together with the blendMode interface. 19598 * 19599 * @param { BlendMode | Blender } effect - When the effect type is BlendMode type, define Different hybrid modes. 19600 * When the effect type is Blender type, Define the corresponding blending effect. 19601 * @param { BlendApplyType } [type] - Different blend apply type 19602 * @returns { T } 19603 * @syscap SystemCapability.ArkUI.ArkUI.Full 19604 * @systemapi 19605 * @form 19606 * @since 13 19607 */ 19608 advancedBlendMode(effect: BlendMode | Blender, type?: BlendApplyType): T; 19609 19610 /** 19611 * Whether to crop the sub components beyond the current component range. 19612 * 19613 * @param { boolean } value 19614 * @returns { T } 19615 * @syscap SystemCapability.ArkUI.ArkUI.Full 19616 * @crossplatform 19617 * @form 19618 * @atomicservice 19619 * @since 12 19620 */ 19621 clip(value: boolean): T; 19622 19623 /** 19624 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 19625 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 19626 * 19627 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value 19628 * @returns { T } 19629 * @syscap SystemCapability.ArkUI.ArkUI.Full 19630 * @since 7 19631 */ 19632 /** 19633 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 19634 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 19635 * 19636 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value 19637 * @returns { T } 19638 * @syscap SystemCapability.ArkUI.ArkUI.Full 19639 * @form 19640 * @since 9 19641 */ 19642 /** 19643 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 19644 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 19645 * 19646 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value 19647 * @returns { T } 19648 * @syscap SystemCapability.ArkUI.ArkUI.Full 19649 * @crossplatform 19650 * @form 19651 * @since 10 19652 */ 19653 /** 19654 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 19655 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 19656 * 19657 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value 19658 * @returns { T } 19659 * @syscap SystemCapability.ArkUI.ArkUI.Full 19660 * @crossplatform 19661 * @form 19662 * @atomicservice 19663 * @since 11 19664 * @deprecated since 12 19665 * @useinstead CommonMethod#clipShape 19666 */ 19667 clip(value: boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute): T; 19668 19669 /** 19670 * The current component is cropped according to the specified shape. 19671 * 19672 * @param { CircleShape | EllipseShape | PathShape | RectShape } value - indicates the shape of the clip. 19673 * @returns { T } 19674 * @syscap SystemCapability.ArkUI.ArkUI.Full 19675 * @crossplatform 19676 * @form 19677 * @atomicservice 19678 * @since 12 19679 */ 19680 clipShape(value: CircleShape | EllipseShape | PathShape | RectShape): T; 19681 19682 /** 19683 * Sets the mask of the current component. 19684 * 19685 * @param { ProgressMask } value 19686 * @returns { T } 19687 * @syscap SystemCapability.ArkUI.ArkUI.Full 19688 * @crossplatform 19689 * @atomicservice 19690 * @since 12 19691 */ 19692 mask(value: ProgressMask): T; 19693 19694 /** 19695 * Applies a mask of the specified shape to the current assembly. 19696 * 19697 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value 19698 * @returns { T } 19699 * @syscap SystemCapability.ArkUI.ArkUI.Full 19700 * @since 7 19701 */ 19702 /** 19703 * Applies a mask of the specified shape to the current assembly. 19704 * 19705 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value - indicates the shape of the mask. 19706 * @returns { T } 19707 * @syscap SystemCapability.ArkUI.ArkUI.Full 19708 * @form 19709 * @since 9 19710 */ 19711 /** 19712 * Applies a mask of the specified shape to the current assembly. 19713 * 19714 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value - indicates the shape of the mask. 19715 * @returns { T } 19716 * @syscap SystemCapability.ArkUI.ArkUI.Full 19717 * @crossplatform 19718 * @form 19719 * @since 10 19720 */ 19721 /** 19722 * Applies a mask of the specified shape to the current assembly. 19723 * 19724 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value - indicates the shape of the mask. 19725 * @returns { T } 19726 * @syscap SystemCapability.ArkUI.ArkUI.Full 19727 * @crossplatform 19728 * @form 19729 * @atomicservice 19730 * @since 11 19731 * @deprecated since 12 19732 * @useinstead CommonMethod#maskShape 19733 */ 19734 mask(value: CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask): T; 19735 19736 /** 19737 * Applies a mask of the specified shape to the current assembly. 19738 * 19739 * @param { CircleShape | EllipseShape | PathShape | RectShape } value - indicates the shape of the mask. 19740 * @returns { T } 19741 * @syscap SystemCapability.ArkUI.ArkUI.Full 19742 * @crossplatform 19743 * @form 19744 * @atomicservice 19745 * @since 12 19746 */ 19747 maskShape(value: CircleShape | EllipseShape | PathShape | RectShape): T; 19748 19749 /** 19750 * Key. User can set an key to the component to identify it. 19751 * 19752 * @param { string } value 19753 * @returns { T } 19754 * @syscap SystemCapability.ArkUI.ArkUI.Full 19755 * @atomicservice 19756 * @since 12 19757 * @test 19758 */ 19759 key(value: string): T; 19760 19761 /** 19762 * Id. User can set an id to the component to identify it. 19763 * 19764 * @param { string } value 19765 * @returns { T } 19766 * @syscap SystemCapability.ArkUI.ArkUI.Full 19767 * @since 8 19768 */ 19769 /** 19770 * Id. User can set an id to the component to identify it. 19771 * 19772 * @param { string } value 19773 * @returns { T } 19774 * @syscap SystemCapability.ArkUI.ArkUI.Full 19775 * @form 19776 * @since 9 19777 */ 19778 /** 19779 * Id. User can set an id to the component to identify it. 19780 * 19781 * @param { string } value 19782 * @returns { T } 19783 * @syscap SystemCapability.ArkUI.ArkUI.Full 19784 * @crossplatform 19785 * @form 19786 * @since 10 19787 */ 19788 /** 19789 * Id. User can set an id to the component to identify it. 19790 * 19791 * @param { string } value 19792 * @returns { T } 19793 * @syscap SystemCapability.ArkUI.ArkUI.Full 19794 * @crossplatform 19795 * @form 19796 * @atomicservice 19797 * @since 11 19798 */ 19799 id(value: string): T; 19800 19801 /** 19802 * geometryTransition 19803 * 19804 * @param { string } id 19805 * @returns { T } 19806 * @syscap SystemCapability.ArkUI.ArkUI.Full 19807 * @since 7 19808 */ 19809 /** 19810 * geometryTransition 19811 * 19812 * @param { string } id 19813 * @returns { T } 19814 * @syscap SystemCapability.ArkUI.ArkUI.Full 19815 * @crossplatform 19816 * @since 10 19817 */ 19818 /** 19819 * geometryTransition 19820 * 19821 * @param { string } id 19822 * @returns { T } 19823 * @syscap SystemCapability.ArkUI.ArkUI.Full 19824 * @crossplatform 19825 * @atomicservice 19826 * @since 11 19827 */ 19828 geometryTransition(id: string): T; 19829 /** 19830 * Shared geometry transition 19831 * 19832 * @param { string } id - geometry transition id 19833 * @param { GeometryTransitionOptions } options - Indicates the options of geometry transition. 19834 * @returns { T } 19835 * @syscap SystemCapability.ArkUI.ArkUI.Full 19836 * @crossplatform 19837 * @since 11 19838 */ 19839 /** 19840 * Shared geometry transition 19841 * 19842 * @param { string } id - geometry transition id 19843 * @param { GeometryTransitionOptions } options - Indicates the options of geometry transition. 19844 * @returns { T } 19845 * @syscap SystemCapability.ArkUI.ArkUI.Full 19846 * @crossplatform 19847 * @atomicservice 19848 * @since 12 19849 */ 19850 geometryTransition(id: string, options?: GeometryTransitionOptions): T; 19851 19852 /** 19853 * Popup control 19854 * 19855 * @param { boolean } show 19856 * @param { PopupOptions } popup 19857 * @returns { T } 19858 * @syscap SystemCapability.ArkUI.ArkUI.Full 19859 * @since 7 19860 */ 19861 /** 19862 * Popup control 19863 * 19864 * @param { boolean } show 19865 * @param { PopupOptions | CustomPopupOptions } popup 19866 * @returns { T } 19867 * @syscap SystemCapability.ArkUI.ArkUI.Full 19868 * @since 8 19869 */ 19870 /** 19871 * Popup control 19872 * 19873 * @param { boolean } show 19874 * @param { PopupOptions | CustomPopupOptions } popup 19875 * @returns { T } 19876 * @syscap SystemCapability.ArkUI.ArkUI.Full 19877 * @crossplatform 19878 * @atomicservice 19879 * @since 11 19880 */ 19881 bindPopup(show: boolean, popup: PopupOptions | CustomPopupOptions): T; 19882 19883 /** 19884 * Menu control 19885 * 19886 * @param { { value: ResourceStr; icon?: ResourceStr; action: () => void }[] | CustomBuilder } content 19887 * action: () => void }[] | CustomBuilder } content - Indicates the content of menu. 19888 * @param { MenuOptions } options 19889 * @returns { T } 19890 * @syscap SystemCapability.ArkUI.ArkUI.Full 19891 * @since 7 19892 */ 19893 /** 19894 * Menu control 19895 * 19896 * @param { { value: ResourceStr; icon?: ResourceStr; action: () => void }[] | CustomBuilder } content 19897 * action: () => void }[] | CustomBuilder } content - Indicates the content of menu. 19898 * @param { MenuOptions } options - Indicates the options of menu. 19899 * @returns { T } 19900 * @syscap SystemCapability.ArkUI.ArkUI.Full 19901 * @crossplatform 19902 * @since 10 19903 */ 19904 /** 19905 * Menu control 19906 * 19907 * @param { Array<MenuElement> | CustomBuilder } content - Indicates the content of menu. 19908 * @param { MenuOptions } options - Indicates the options of menu. 19909 * @returns { T } 19910 * @syscap SystemCapability.ArkUI.ArkUI.Full 19911 * @crossplatform 19912 * @atomicservice 19913 * @since 11 19914 */ 19915 bindMenu(content: Array<MenuElement> | CustomBuilder, options?: MenuOptions): T; 19916 19917 /** 19918 * Menu control 19919 * 19920 * @param { boolean } isShow true means display menu, false means hide menu. 19921 * @param { Array<MenuElement> | CustomBuilder } content - Indicates the content of menu. 19922 * @param { MenuOptions } options - Indicates the options of menu. 19923 * @returns { T } 19924 * @syscap SystemCapability.ArkUI.ArkUI.Full 19925 * @crossplatform 19926 * @since 11 19927 */ 19928 /** 19929 * Menu control 19930 * 19931 * @param { boolean } isShow true means display menu, false means hide menu. 19932 * @param { Array<MenuElement> | CustomBuilder } content - Indicates the content of menu. 19933 * @param { MenuOptions } options - Indicates the options of menu. 19934 * @returns { T } 19935 * @syscap SystemCapability.ArkUI.ArkUI.Full 19936 * @crossplatform 19937 * @atomicservice 19938 * @since 12 19939 */ 19940 bindMenu(isShow: boolean, content: Array<MenuElement> | CustomBuilder, options?: MenuOptions): T; 19941 19942 /** 19943 * ContextMenu control 19944 * 19945 * @param { CustomBuilder } content 19946 * @param { ResponseType } responseType 19947 * @param { ContextMenuOptions } options 19948 * @returns { T } 19949 * @syscap SystemCapability.ArkUI.ArkUI.Full 19950 * @since 8 19951 */ 19952 /** 19953 * ContextMenu control 19954 * 19955 * @param { CustomBuilder } content - Indicates the content of context menu. 19956 * @param { ResponseType } responseType - Indicates response type of context menu. 19957 * @param { ContextMenuOptions } options - Indicates the options of context menu. 19958 * @returns { T } 19959 * @syscap SystemCapability.ArkUI.ArkUI.Full 19960 * @crossplatform 19961 * @since 10 19962 */ 19963 /** 19964 * ContextMenu control 19965 * 19966 * @param { CustomBuilder } content - Indicates the content of context menu. 19967 * @param { ResponseType } responseType - Indicates response type of context menu. 19968 * @param { ContextMenuOptions } options - Indicates the options of context menu. 19969 * @returns { T } 19970 * @syscap SystemCapability.ArkUI.ArkUI.Full 19971 * @crossplatform 19972 * @atomicservice 19973 * @since 11 19974 */ 19975 bindContextMenu(content: CustomBuilder, responseType: ResponseType, options?: ContextMenuOptions): T; 19976 19977 /** 19978 * ContextMenu control 19979 * 19980 * @param { boolean } isShown - true means display content, false means hide content. 19981 * @param { CustomBuilder } content - Indicates the content of context menu. 19982 * @param { ContextMenuOptions } [options] - Indicates the options of context menu. 19983 * @returns { T } 19984 * @syscap SystemCapability.ArkUI.ArkUI.Full 19985 * @crossplatform 19986 * @atomicservice 19987 * @since 12 19988 */ 19989 bindContextMenu(isShown: boolean, content: CustomBuilder, options?: ContextMenuOptions): T; 19990 19991 /** 19992 * Bind content cover 19993 * 19994 * @param { boolean } isShow - true means display content, false means hide content. 19995 * @param { CustomBuilder } builder - the content to be displayed. 19996 * @param { ModalTransition } type - transition type. 19997 * @returns { T } 19998 * @syscap SystemCapability.ArkUI.ArkUI.Full 19999 * @crossplatform 20000 * @since 10 20001 */ 20002 /** 20003 * Bind content cover 20004 * 20005 * @param { boolean } isShow - true means display content, false means hide content. 20006 * @param { CustomBuilder } builder - the content to be displayed. 20007 * @param { ModalTransition } type - transition type. 20008 * @returns { T } 20009 * @syscap SystemCapability.ArkUI.ArkUI.Full 20010 * @crossplatform 20011 * @atomicservice 20012 * @since 11 20013 */ 20014 bindContentCover(isShow: boolean, builder: CustomBuilder, type?: ModalTransition): T; 20015 20016 /** 20017 * Bind content cover 20018 * 20019 * @param { boolean } isShow - true means display content, false means hide content. 20020 * @param { CustomBuilder } builder - the content to be displayed. 20021 * @param { ContentCoverOptions } options - options of content cover. 20022 * @returns { T } 20023 * @syscap SystemCapability.ArkUI.ArkUI.Full 20024 * @crossplatform 20025 * @since 10 20026 */ 20027 /** 20028 * Bind content cover 20029 * 20030 * @param { boolean } isShow - true means display content, false means hide content. 20031 * @param { CustomBuilder } builder - the content to be displayed. 20032 * @param { ContentCoverOptions } options - options of content cover. 20033 * @returns { T } 20034 * @syscap SystemCapability.ArkUI.ArkUI.Full 20035 * @crossplatform 20036 * @atomicservice 20037 * @since 11 20038 */ 20039 bindContentCover(isShow: boolean, builder: CustomBuilder, options?: ContentCoverOptions): T; 20040 20041 /** 20042 * Bind sheet 20043 * 20044 * @param { boolean } isShow - true means display sheet, false means hide sheet. 20045 * @param { CustomBuilder } builder - the sheet to be displayed. 20046 * @param { SheetOptions } options - options of sheet. 20047 * @returns { T } - template type 20048 * @syscap SystemCapability.ArkUI.ArkUI.Full 20049 * @crossplatform 20050 * @since 10 20051 */ 20052 /** 20053 * Bind sheet 20054 * 20055 * @param { boolean } isShow - true means display sheet, false means hide sheet. 20056 * @param { CustomBuilder } builder - the sheet to be displayed. 20057 * @param { SheetOptions } options - options of sheet. 20058 * @returns { T } - template type 20059 * @syscap SystemCapability.ArkUI.ArkUI.Full 20060 * @crossplatform 20061 * @atomicservice 20062 * @since 11 20063 */ 20064 bindSheet(isShow: boolean, builder: CustomBuilder, options?: SheetOptions): T; 20065 20066 /** 20067 * Sets styles for component state. 20068 * 20069 * @param { StateStyles } value 20070 * @returns { T } 20071 * @syscap SystemCapability.ArkUI.ArkUI.Full 20072 * @since 8 20073 */ 20074 /** 20075 * Sets styles for component state. 20076 * 20077 * @param { StateStyles } value 20078 * @returns { T } 20079 * @syscap SystemCapability.ArkUI.ArkUI.Full 20080 * @form 20081 * @since 9 20082 */ 20083 /** 20084 * Sets styles for component state. 20085 * 20086 * @param { StateStyles } value 20087 * @returns { T } 20088 * @syscap SystemCapability.ArkUI.ArkUI.Full 20089 * @crossplatform 20090 * @form 20091 * @since 10 20092 */ 20093 /** 20094 * Sets styles for component state. 20095 * 20096 * @param { StateStyles } value 20097 * @returns { T } 20098 * @syscap SystemCapability.ArkUI.ArkUI.Full 20099 * @crossplatform 20100 * @form 20101 * @atomicservice 20102 * @since 11 20103 */ 20104 stateStyles(value: StateStyles): T; 20105 20106 /** 20107 * id for distribute identification. 20108 * 20109 * @param { number } value 20110 * @returns { T } 20111 * @syscap SystemCapability.ArkUI.ArkUI.Full 20112 * @since 8 20113 */ 20114 /** 20115 * id for distribute identification. 20116 * 20117 * @param { number } value 20118 * @returns { T } 20119 * @syscap SystemCapability.ArkUI.ArkUI.Full 20120 * @crossplatform 20121 * @atomicservice 20122 * @since 11 20123 */ 20124 restoreId(value: number): T; 20125 20126 /** 20127 * Trigger a visible area change event. 20128 * 20129 * @param { Array<number> } ratios 20130 * @param { function } event 20131 * @returns { T } 20132 * @syscap SystemCapability.ArkUI.ArkUI.Full 20133 * @since 9 20134 */ 20135 /** 20136 * Trigger a visible area change event. 20137 * 20138 * @param { Array<number> } ratios 20139 * @param { function } event 20140 * @returns { T } 20141 * @syscap SystemCapability.ArkUI.ArkUI.Full 20142 * @crossplatform 20143 * @since 10 20144 */ 20145 /** 20146 * Trigger a visible area change event. 20147 * 20148 * @param { Array<number> } ratios 20149 * @param { function } event 20150 * @returns { T } 20151 * @syscap SystemCapability.ArkUI.ArkUI.Full 20152 * @crossplatform 20153 * @atomicservice 20154 * @since 11 20155 */ 20156 /** 20157 * Trigger a visible area change event. 20158 * 20159 * @param { Array<number> } ratios 20160 * @param { VisibleAreaChangeCallback } event 20161 * @returns { T } 20162 * @syscap SystemCapability.ArkUI.ArkUI.Full 20163 * @crossplatform 20164 * @atomicservice 20165 * @since 13 20166 */ 20167 onVisibleAreaChange(ratios: Array<number>, event: VisibleAreaChangeCallback): T; 20168 20169 /** 20170 * Set the spherical effect of the component. 20171 * 20172 * @param { number } value - set the degree of spherical effect, value range [0, 1]. 20173 * If the value is 0, the component keep same, else the value is 1, component are fully spherical. 20174 * @returns { T } 20175 * @syscap SystemCapability.ArkUI.ArkUI.Full 20176 * @crossplatform 20177 * @atomicservice 20178 * @since 12 20179 */ 20180 sphericalEffect(value: number): T; 20181 20182 /** 20183 * Set the light up effect of the component 20184 * 20185 * @param { number } value - set the degree to which the component lights up, value range [0, 1]. 20186 * The color brightness in the component rendering content area is greater than the value and can be displayed, otherwise it will not be displayed. 20187 * @returns { T } 20188 * @syscap SystemCapability.ArkUI.ArkUI.Full 20189 * @crossplatform 20190 * @atomicservice 20191 * @since 12 20192 */ 20193 lightUpEffect(value: number): T; 20194 20195 /** 20196 * Set the edge pixel stretch effect of the Component. 20197 * 20198 * @param { PixelStretchEffectOptions } options 20199 * @returns { T } 20200 * @syscap SystemCapability.ArkUI.ArkUI.Full 20201 * @crossplatform 20202 * @atomicservice 20203 * @since 12 20204 */ 20205 pixelStretchEffect(options: PixelStretchEffectOptions): T; 20206 20207 /** 20208 * Sets hot keys 20209 * 20210 * @param { string | FunctionKey } value - Character of the combination key. 20211 * @param { Array<ModifierKey> } keys - The modifier keys modify the action of key when the key are pressed at the same time. 20212 * @param { function } [action] - Callback function, triggered when the shortcut keyboard is pressed. 20213 * @returns { T } 20214 * @syscap SystemCapability.ArkUI.ArkUI.Full 20215 * @crossplatform 20216 * @since 10 20217 */ 20218 /** 20219 * Sets hot keys 20220 * 20221 * @param { string | FunctionKey } value - Character of the combination key. 20222 * @param { Array<ModifierKey> } keys - The modifier keys modify the action of key when the key are pressed at the same time. 20223 * @param { function } [action] - Callback function, triggered when the shortcut keyboard is pressed. 20224 * @returns { T } 20225 * @syscap SystemCapability.ArkUI.ArkUI.Full 20226 * @crossplatform 20227 * @atomicservice 20228 * @since 11 20229 */ 20230 keyboardShortcut(value: string | FunctionKey, keys: Array<ModifierKey>, action?: () => void): T; 20231 20232 /** 20233 * Sets accessibilityGroup 20234 * 20235 * @param { boolean } value - set group with accessibility 20236 * @returns { T } 20237 * @syscap SystemCapability.ArkUI.ArkUI.Full 20238 * @crossplatform 20239 * @since 10 20240 */ 20241 /** 20242 * Sets accessibilityGroup 20243 * 20244 * @param { boolean } value - set group with accessibility 20245 * @returns { T } 20246 * @syscap SystemCapability.ArkUI.ArkUI.Full 20247 * @crossplatform 20248 * @atomicservice 20249 * @since 11 20250 */ 20251 /** 20252 * Sets accessibilityGroup 20253 * 20254 * @param { boolean } value - set group with accessibility 20255 * @returns { T } 20256 * @syscap SystemCapability.ArkUI.ArkUI.Full 20257 * @crossplatform 20258 * @form 20259 * @atomicservice 20260 * @since 12 20261 */ 20262 accessibilityGroup(value: boolean): T; 20263 20264 /** 20265 * Sets accessibilityGroup 20266 * 20267 * @param { boolean } isGroup - set group with accessibility 20268 * @param { AccessibilityOptions } accessibilityOptions - accessibilityOptions for accessibility 20269 * @returns { T } 20270 * @syscap SystemCapability.ArkUI.ArkUI.Full 20271 * @crossplatform 20272 * @form 20273 * @atomicservice 20274 * @since 14 20275 */ 20276 accessibilityGroup(isGroup: boolean, accessibilityOptions: AccessibilityOptions): T; 20277 20278 /** 20279 * Sets accessibilityText 20280 * 20281 * @param { string } value - set accessibility text 20282 * @returns { T } 20283 * @syscap SystemCapability.ArkUI.ArkUI.Full 20284 * @crossplatform 20285 * @since 10 20286 */ 20287 /** 20288 * Sets accessibilityText 20289 * 20290 * @param { string } value - set accessibility text 20291 * @returns { T } 20292 * @syscap SystemCapability.ArkUI.ArkUI.Full 20293 * @crossplatform 20294 * @atomicservice 20295 * @since 11 20296 */ 20297 /** 20298 * Sets accessibilityText 20299 * 20300 * @param { string } value - set accessibility text 20301 * @returns { T } 20302 * @syscap SystemCapability.ArkUI.ArkUI.Full 20303 * @crossplatform 20304 * @form 20305 * @atomicservice 20306 * @since 12 20307 */ 20308 accessibilityText(value: string): T; 20309 20310 /** 20311 * Sets accessibilityText 20312 * 20313 * @param { Resource } text - set accessibility text 20314 * @returns { T } 20315 * @syscap SystemCapability.ArkUI.ArkUI.Full 20316 * @crossplatform 20317 * @form 20318 * @atomicservice 20319 * @since 12 20320 */ 20321 accessibilityText(text: Resource): T; 20322 20323 /** 20324 * Sets accessibilityTextHint 20325 * 20326 * @param { string } value - set accessibility text hint 20327 * @returns { T } 20328 * @syscap SystemCapability.ArkUI.ArkUI.Full 20329 * @crossplatform 20330 * @form 20331 * @atomicservice 20332 * @since 12 20333 */ 20334 accessibilityTextHint(value: string): T; 20335 20336 /** 20337 * Sets accessibilityDescription 20338 * 20339 * @param { string } value - set description of accessibility 20340 * @returns { T } 20341 * @syscap SystemCapability.ArkUI.ArkUI.Full 20342 * @crossplatform 20343 * @since 10 20344 */ 20345 /** 20346 * Sets accessibilityDescription 20347 * 20348 * @param { string } value - set description of accessibility 20349 * @returns { T } 20350 * @syscap SystemCapability.ArkUI.ArkUI.Full 20351 * @crossplatform 20352 * @atomicservice 20353 * @since 11 20354 */ 20355 /** 20356 * Sets accessibilityDescription 20357 * 20358 * @param { string } value - set description of accessibility 20359 * @returns { T } 20360 * @syscap SystemCapability.ArkUI.ArkUI.Full 20361 * @crossplatform 20362 * @form 20363 * @atomicservice 20364 * @since 12 20365 */ 20366 accessibilityDescription(value: string): T; 20367 20368 /** 20369 * Sets accessibilityDescription 20370 * 20371 * @param { Resource } description - set description of accessibility 20372 * @returns { T } 20373 * @syscap SystemCapability.ArkUI.ArkUI.Full 20374 * @crossplatform 20375 * @form 20376 * @atomicservice 20377 * @since 12 20378 */ 20379 accessibilityDescription(description: Resource): T; 20380 20381 /** 20382 * Sets accessibilityLevel 20383 * 20384 * @param { string } value - set accessibility level 20385 * @returns { T } 20386 * @syscap SystemCapability.ArkUI.ArkUI.Full 20387 * @crossplatform 20388 * @since 10 20389 */ 20390 /** 20391 * Sets accessibilityLevel 20392 * 20393 * @param { string } value - set accessibility level 20394 * @returns { T } 20395 * @syscap SystemCapability.ArkUI.ArkUI.Full 20396 * @crossplatform 20397 * @atomicservice 20398 * @since 11 20399 */ 20400 /** 20401 * Sets accessibilityLevel 20402 * 20403 * @param { string } value - set accessibility level 20404 * @returns { T } 20405 * @syscap SystemCapability.ArkUI.ArkUI.Full 20406 * @crossplatform 20407 * @form 20408 * @atomicservice 20409 * @since 12 20410 */ 20411 accessibilityLevel(value: string): T; 20412 20413 /** 20414 * Sets accessibilityVirtualNode 20415 * 20416 * @param { CustomBuilder } builder - set virtual node of accessibility 20417 * @returns { T } 20418 * @syscap SystemCapability.ArkUI.ArkUI.Full 20419 * @crossplatform 20420 * @atomicservice 20421 * @since 11 20422 */ 20423 /** 20424 * Sets accessibilityVirtualNode 20425 * 20426 * @param { CustomBuilder } builder - set virtual node of accessibility 20427 * @returns { T } 20428 * @syscap SystemCapability.ArkUI.ArkUI.Full 20429 * @crossplatform 20430 * @form 20431 * @atomicservice 20432 * @since 12 20433 */ 20434 accessibilityVirtualNode(builder: CustomBuilder): T; 20435 20436 /** 20437 * Sets accessibilityChecked 20438 * 20439 * @param { boolean } isCheck - set accessibility checked status 20440 * @returns { T } 20441 * @syscap SystemCapability.ArkUI.ArkUI.Full 20442 * @crossplatform 20443 * @form 20444 * @atomicservice 20445 * @since 13 20446 */ 20447 accessibilityChecked(isCheck: boolean): T; 20448 20449 /** 20450 * Sets accessibilitySelected 20451 * 20452 * @param { boolean } isSelect - set accessibility selected status 20453 * @returns { T } 20454 * @syscap SystemCapability.ArkUI.ArkUI.Full 20455 * @crossplatform 20456 * @form 20457 * @atomicservice 20458 * @since 13 20459 */ 20460 accessibilitySelected(isSelect: boolean): T; 20461 20462 /** 20463 * Sets obscured 20464 * 20465 * @param { Array<ObscuredReasons> } reasons - reasons of obscuration 20466 * @returns { T } 20467 * @syscap SystemCapability.ArkUI.ArkUI.Full 20468 * @crossplatform 20469 * @since 10 20470 */ 20471 /** 20472 * Sets obscured 20473 * 20474 * @param { Array<ObscuredReasons> } reasons - reasons of obscuration 20475 * @returns { T } 20476 * @syscap SystemCapability.ArkUI.ArkUI.Full 20477 * @crossplatform 20478 * @atomicservice 20479 * @since 11 20480 */ 20481 obscured(reasons: Array<ObscuredReasons>): T; 20482 20483 /** 20484 * Reuse id is used for identify the reuse type for each custom node. 20485 * 20486 * @param { string } id - The id for reusable custom node. 20487 * @returns { T } 20488 * @syscap SystemCapability.ArkUI.ArkUI.Full 20489 * @crossplatform 20490 * @since 10 20491 */ 20492 /** 20493 * Reuse id is used for identify the reuse type for each custom node. 20494 * 20495 * @param { string } id - The id for reusable custom node. 20496 * @returns { T } 20497 * @syscap SystemCapability.ArkUI.ArkUI.Full 20498 * @crossplatform 20499 * @atomicservice 20500 * @since 11 20501 */ 20502 reuseId(id: string): T; 20503 20504 /** 20505 * Sets how content is drawn within nodes duration animation 20506 * 20507 * @param { RenderFit } fitMode - The render fit mode of content. 20508 * @returns { T } 20509 * @syscap SystemCapability.ArkUI.ArkUI.Full 20510 * @crossplatform 20511 * @since 10 20512 */ 20513 /** 20514 * Sets how content is drawn within nodes duration animation 20515 * 20516 * @param { RenderFit } fitMode - The render fit mode of content. 20517 * @returns { T } 20518 * @syscap SystemCapability.ArkUI.ArkUI.Full 20519 * @crossplatform 20520 * @atomicservice 20521 * @since 11 20522 */ 20523 renderFit(fitMode: RenderFit): T; 20524 20525 /** 20526 * Sets the attribute modifier. 20527 * 20528 * @param { AttributeModifier<T> } modifier 20529 * @returns { T } 20530 * @syscap SystemCapability.ArkUI.ArkUI.Full 20531 * @crossplatform 20532 * @since 11 20533 */ 20534 /** 20535 * Sets the attribute modifier. 20536 * 20537 * @param { AttributeModifier<T> } modifier 20538 * @returns { T } 20539 * @syscap SystemCapability.ArkUI.ArkUI.Full 20540 * @crossplatform 20541 * @atomicservice 20542 * @since 12 20543 */ 20544 attributeModifier(modifier: AttributeModifier<T>): T; 20545 20546 /** 20547 * Sets the gesture modifier. 20548 * 20549 * @param { GestureModifier } modifier 20550 * @returns { T } 20551 * @syscap SystemCapability.ArkUI.ArkUI.Full 20552 * @crossplatform 20553 * @atomicservice 20554 * @since 12 20555 */ 20556 gestureModifier(modifier: GestureModifier): T; 20557 20558 /** 20559 * Adds a background dynamic light up effect to the current component. 20560 * 20561 * @param { BackgroundBrightnessOptions } params - params indicates BackgroundBrightnessOptions 20562 * @returns { T } 20563 * @syscap SystemCapability.ArkUI.ArkUI.Full 20564 * @atomicservice 20565 * @since 12 20566 */ 20567 backgroundBrightness(params: BackgroundBrightnessOptions): T; 20568 20569 /** 20570 * When a gesture bound to this component will be accepted, a user-defined callback is triggered to get the result 20571 * 20572 * @param { function } callback - A callback instance used when a gesture bound to this component will be accepted. 20573 * @returns { T } 20574 * @syscap SystemCapability.ArkUI.ArkUI.Full 20575 * @crossplatform 20576 * @since 11 20577 */ 20578 /** 20579 * When a gesture bound to this component will be accepted, a user-defined callback is triggered to get the result 20580 * 20581 * @param { function } callback - A callback instance used when a gesture bound to this component will be accepted. 20582 * @returns { T } 20583 * @syscap SystemCapability.ArkUI.ArkUI.Full 20584 * @crossplatform 20585 * @atomicservice 20586 * @since 12 20587 */ 20588 onGestureJudgeBegin(callback: (gestureInfo: GestureInfo, event: BaseGestureEvent) => GestureJudgeResult): T; 20589 20590 /** 20591 * When a gesture bound to this component will be accepted, a user-defined callback is triggered to get the result 20592 * 20593 * @param { GestureRecognizerJudgeBeginCallback } callback - A callback instance used when a gesture bound to this component will be accepted. 20594 * @returns { T } 20595 * @syscap SystemCapability.ArkUI.ArkUI.Full 20596 * @crossplatform 20597 * @atomicservice 20598 * @since 12 20599 */ 20600 onGestureRecognizerJudgeBegin(callback: GestureRecognizerJudgeBeginCallback): T; 20601 20602 /** 20603 * When a gesture bound to this component will be accepted, a user-defined callback is triggered to get the result 20604 * 20605 * @param { GestureRecognizerJudgeBeginCallback } callback - A callback instance used when a gesture bound to this component will be accepted. 20606 * @param { boolean } exposeInnerGesture - This parameter is a flag. This flag determines whether to expose internal gestures. 20607 * @returns { T } 20608 * @syscap SystemCapability.ArkUI.ArkUI.Full 20609 * @crossplatform 20610 * @atomicservice 20611 * 20612 * @since 13 20613 */ 20614 onGestureRecognizerJudgeBegin(callback: GestureRecognizerJudgeBeginCallback, exposeInnerGesture: boolean): T; 20615 20616 /** 20617 * In the touch test phase, the recognizer is selected to form a parallel relationship with other recognizers on the response chain. 20618 * 20619 * @param { ShouldBuiltInRecognizerParallelWithCallback } callback - A callback instance used when a component is doing touch test. 20620 * @returns { T } 20621 * @syscap SystemCapability.ArkUI.ArkUI.Full 20622 * @crossplatform 20623 * @atomicservice 20624 * @since 12 20625 */ 20626 shouldBuiltInRecognizerParallelWith(callback: ShouldBuiltInRecognizerParallelWithCallback): T; 20627 20628 /** 20629 * Events are monopolized by components. 20630 * 20631 * @param { boolean } monopolize - indicate the monopoly of events 20632 * @returns { T } 20633 * @syscap SystemCapability.ArkUI.ArkUI.Full 20634 * @crossplatform 20635 * @since 11 20636 */ 20637 /** 20638 * Events are monopolized by components. 20639 * 20640 * @param { boolean } monopolize - indicate the monopoly of events 20641 * @returns { T } 20642 * @syscap SystemCapability.ArkUI.ArkUI.Full 20643 * @crossplatform 20644 * @atomicservice 20645 * @since 12 20646 */ 20647 monopolizeEvents(monopolize: boolean): T; 20648 20649 /** 20650 * When the component does a touch test, a user-defined callback is triggered. 20651 * 20652 * @param { Callback<TouchEvent, HitTestMode> } callback - A callback instance used when the component does a touch test. 20653 * @returns { T } 20654 * @syscap SystemCapability.ArkUI.ArkUI.Full 20655 * @crossplatform 20656 * @atomicservice 20657 * @since 12 20658 */ 20659 onTouchIntercept(callback: Callback<TouchEvent, HitTestMode>): T; 20660 20661 /** 20662 * This callback is triggered when the size of this component change finished. 20663 * 20664 * @param { SizeChangeCallback } event - event callback. 20665 * @returns { T } 20666 * @syscap SystemCapability.ArkUI.ArkUI.Full 20667 * @crossplatform 20668 * @form 20669 * @atomicservice 20670 * @since 12 20671 */ 20672 onSizeChange(event: SizeChangeCallback): T; 20673} 20674 20675/** 20676 * CommonAttribute for ide. 20677 * 20678 * @extends CommonMethod<CommonAttribute> 20679 * @syscap SystemCapability.ArkUI.ArkUI.Full 20680 * @since 7 20681 */ 20682/** 20683 * CommonAttribute for ide. 20684 * 20685 * @extends CommonMethod<CommonAttribute> 20686 * @syscap SystemCapability.ArkUI.ArkUI.Full 20687 * @form 20688 * @since 9 20689 */ 20690/** 20691 * CommonAttribute for ide. 20692 * 20693 * @extends CommonMethod<CommonAttribute> 20694 * @syscap SystemCapability.ArkUI.ArkUI.Full 20695 * @crossplatform 20696 * @form 20697 * @since 10 20698 */ 20699/** 20700 * CommonAttribute for ide. 20701 * 20702 * @extends CommonMethod<CommonAttribute> 20703 * @syscap SystemCapability.ArkUI.ArkUI.Full 20704 * @crossplatform 20705 * @form 20706 * @atomicservice 20707 * @since 11 20708 */ 20709declare class CommonAttribute extends CommonMethod<CommonAttribute> {} 20710 20711/** 20712 * CommonInterface for ide. 20713 * 20714 * @interface CommonInterface 20715 * @syscap SystemCapability.ArkUI.ArkUI.Full 20716 * @since 7 20717 */ 20718/** 20719 * CommonInterface for ide. 20720 * 20721 * @interface CommonInterface 20722 * @syscap SystemCapability.ArkUI.ArkUI.Full 20723 * @form 20724 * @since 9 20725 */ 20726/** 20727 * CommonInterface for ide. 20728 * 20729 * @interface CommonInterface 20730 * @syscap SystemCapability.ArkUI.ArkUI.Full 20731 * @crossplatform 20732 * @form 20733 * @since 10 20734 */ 20735/** 20736 * CommonInterface for ide. 20737 * 20738 * @interface CommonInterface 20739 * @syscap SystemCapability.ArkUI.ArkUI.Full 20740 * @crossplatform 20741 * @form 20742 * @atomicservice 20743 * @since 11 20744 */ 20745interface CommonInterface { 20746 /** 20747 * Constructor. 20748 * 20749 * @returns { CommonAttribute } 20750 * @syscap SystemCapability.ArkUI.ArkUI.Full 20751 * @since 7 20752 */ 20753 /** 20754 * Constructor 20755 * 20756 * @returns { CommonAttribute } 20757 * @syscap SystemCapability.ArkUI.ArkUI.Full 20758 * @form 20759 * @since 9 20760 */ 20761 /** 20762 * Constructor 20763 * 20764 * @returns { CommonAttribute } 20765 * @syscap SystemCapability.ArkUI.ArkUI.Full 20766 * @crossplatform 20767 * @form 20768 * @since 10 20769 */ 20770 /** 20771 * Constructor 20772 * 20773 * @returns { CommonAttribute } 20774 * @syscap SystemCapability.ArkUI.ArkUI.Full 20775 * @crossplatform 20776 * @form 20777 * @atomicservice 20778 * @since 11 20779 */ 20780 (): CommonAttribute; 20781} 20782 20783/** 20784 * CommonInstance for ide. 20785 * 20786 * @syscap SystemCapability.ArkUI.ArkUI.Full 20787 * @since 7 20788 */ 20789/** 20790 * CommonInstance for ide. 20791 * 20792 * @syscap SystemCapability.ArkUI.ArkUI.Full 20793 * @form 20794 * @since 9 20795 */ 20796/** 20797 * CommonInstance for ide. 20798 * 20799 * @syscap SystemCapability.ArkUI.ArkUI.Full 20800 * @crossplatform 20801 * @form 20802 * @since 10 20803 */ 20804/** 20805 * CommonInstance for ide. 20806 * 20807 * @syscap SystemCapability.ArkUI.ArkUI.Full 20808 * @crossplatform 20809 * @form 20810 * @atomicservice 20811 * @since 11 20812 */ 20813declare const CommonInstance: CommonAttribute; 20814 20815/** 20816 * Common for ide. 20817 * 20818 * @syscap SystemCapability.ArkUI.ArkUI.Full 20819 * @since 7 20820 */ 20821/** 20822 * Common for ide. 20823 * 20824 * @syscap SystemCapability.ArkUI.ArkUI.Full 20825 * @form 20826 * @since 9 20827 */ 20828/** 20829 * Common for ide. 20830 * 20831 * @syscap SystemCapability.ArkUI.ArkUI.Full 20832 * @crossplatform 20833 * @form 20834 * @since 10 20835 */ 20836/** 20837 * Common for ide. 20838 * 20839 * @syscap SystemCapability.ArkUI.ArkUI.Full 20840 * @crossplatform 20841 * @form 20842 * @atomicservice 20843 * @since 11 20844 */ 20845declare const Common: CommonInterface; 20846 20847/** 20848 * Defines the CustomBuilder Type. 20849 * 20850 * @typedef { (() => any) | void } CustomBuilder 20851 * @syscap SystemCapability.ArkUI.ArkUI.Full 20852 * @since 8 20853 */ 20854/** 20855 * Defines the CustomBuilder Type. 20856 * 20857 * @typedef { (() => any) | void } CustomBuilder 20858 * @syscap SystemCapability.ArkUI.ArkUI.Full 20859 * @form 20860 * @since 9 20861 */ 20862/** 20863 * Defines the CustomBuilder Type. 20864 * 20865 * @typedef { (() => any) | void } CustomBuilder 20866 * @syscap SystemCapability.ArkUI.ArkUI.Full 20867 * @crossplatform 20868 * @form 20869 * @since 10 20870 */ 20871/** 20872 * Defines the CustomBuilder Type. 20873 * 20874 * @typedef { (() => any) | void } CustomBuilder 20875 * @syscap SystemCapability.ArkUI.ArkUI.Full 20876 * @crossplatform 20877 * @form 20878 * @atomicservice 20879 * @since 11 20880 */ 20881declare type CustomBuilder = (() => any) | void; 20882 20883/** 20884 * Defines the OverlayOptions interface. 20885 * 20886 * @typedef OverlayOptions 20887 * @syscap SystemCapability.ArkUI.ArkUI.Full 20888 * @crossplatform 20889 * @form 20890 * @atomicservice 20891 * @since 12 20892 */ 20893declare interface OverlayOptions { 20894 /** 20895 * Defines align type. 20896 * 20897 * @type { ?Alignment } 20898 * @syscap SystemCapability.ArkUI.ArkUI.Full 20899 * @since 7 20900 */ 20901 /** 20902 * Defines align type. 20903 * 20904 * @type { ?Alignment } 20905 * @syscap SystemCapability.ArkUI.ArkUI.Full 20906 * @form 20907 * @since 9 20908 */ 20909 /** 20910 * Defines align type. 20911 * 20912 * @type { ?Alignment } 20913 * @syscap SystemCapability.ArkUI.ArkUI.Full 20914 * @crossplatform 20915 * @form 20916 * @since 10 20917 */ 20918 /** 20919 * Defines align type. 20920 * 20921 * @type { ?Alignment } 20922 * @syscap SystemCapability.ArkUI.ArkUI.Full 20923 * @crossplatform 20924 * @form 20925 * @atomicservice 20926 * @since 11 20927 */ 20928 align?: Alignment; 20929 20930 /** 20931 * Defines offset type. 20932 * 20933 * @type { ?OverlayOffset } 20934 * @syscap SystemCapability.ArkUI.ArkUI.Full 20935 * @since 7 20936 */ 20937 /** 20938 * Defines offset type. 20939 * 20940 * @type { ?OverlayOffset } 20941 * @syscap SystemCapability.ArkUI.ArkUI.Full 20942 * @form 20943 * @since 9 20944 */ 20945 /** 20946 * Defines offset type. 20947 * 20948 * @type { ?OverlayOffset } 20949 * @syscap SystemCapability.ArkUI.ArkUI.Full 20950 * @crossplatform 20951 * @form 20952 * @since 10 20953 */ 20954 /** 20955 * Defines offset type. 20956 * 20957 * @type { ?OverlayOffset } 20958 * @syscap SystemCapability.ArkUI.ArkUI.Full 20959 * @crossplatform 20960 * @form 20961 * @atomicservice 20962 * @since 11 20963 */ 20964 offset?: OverlayOffset; 20965} 20966 20967/** 20968 * Defines the OverlayOffset. 20969 * 20970 * @typedef OverlayOffset 20971 * @syscap SystemCapability.ArkUI.ArkUI.Full 20972 * @crossplatform 20973 * @form 20974 * @atomicservice 20975 * @since 12 20976 */ 20977declare interface OverlayOffset { 20978 /** 20979 * Defines x. 20980 * 20981 * @type { ?number } 20982 * @syscap SystemCapability.ArkUI.ArkUI.Full 20983 * @since 7 20984 */ 20985 /** 20986 * Defines x. 20987 * 20988 * @type { ?number } 20989 * @syscap SystemCapability.ArkUI.ArkUI.Full 20990 * @form 20991 * @since 9 20992 */ 20993 /** 20994 * Defines x. 20995 * 20996 * @type { ?number } 20997 * @syscap SystemCapability.ArkUI.ArkUI.Full 20998 * @crossplatform 20999 * @form 21000 * @since 10 21001 */ 21002 /** 21003 * Defines x. 21004 * 21005 * @type { ?number } 21006 * @syscap SystemCapability.ArkUI.ArkUI.Full 21007 * @crossplatform 21008 * @form 21009 * @atomicservice 21010 * @since 11 21011 */ 21012 x?: number; 21013 /** 21014 * Defines y. 21015 * 21016 * @type { ?number } 21017 * @syscap SystemCapability.ArkUI.ArkUI.Full 21018 * @since 7 21019 */ 21020 /** 21021 * Defines y. 21022 * 21023 * @type { ?number } 21024 * @syscap SystemCapability.ArkUI.ArkUI.Full 21025 * @form 21026 * @since 9 21027 */ 21028 /** 21029 * Defines y. 21030 * 21031 * @type { ?number } 21032 * @syscap SystemCapability.ArkUI.ArkUI.Full 21033 * @crossplatform 21034 * @form 21035 * @since 10 21036 */ 21037 /** 21038 * Defines y. 21039 * 21040 * @type { ?number } 21041 * @syscap SystemCapability.ArkUI.ArkUI.Full 21042 * @crossplatform 21043 * @form 21044 * @atomicservice 21045 * @since 11 21046 */ 21047 y?: number; 21048} 21049 21050/** 21051 * Defines the segment of blur. 21052 * The first element in the tuple means fraction. 21053 * The range of this value is [0,1]. A value of 1 means opaque and 0 means completely transparent. 21054 * The second element means the stop position. 21055 * The range of this value is [0,1]. A value of 1 means region ending position and 0 means region starting position. 21056 * 21057 * @typedef { [ number, number ] } FractionStop 21058 * @syscap SystemCapability.ArkUI.ArkUI.Full 21059 * @atomicservice 21060 * @since 12 21061 */ 21062declare type FractionStop = [ number, number ]; 21063 21064/** 21065 * CommonShapeMethod 21066 * 21067 * @extends CommonMethod<T> 21068 * @syscap SystemCapability.ArkUI.ArkUI.Full 21069 * @since 7 21070 */ 21071/** 21072 * CommonShapeMethod 21073 * 21074 * @extends CommonMethod<T> 21075 * @syscap SystemCapability.ArkUI.ArkUI.Full 21076 * @form 21077 * @since 9 21078 */ 21079/** 21080 * CommonShapeMethod 21081 * 21082 * @extends CommonMethod<T> 21083 * @syscap SystemCapability.ArkUI.ArkUI.Full 21084 * @crossplatform 21085 * @form 21086 * @since 10 21087 */ 21088/** 21089 * CommonShapeMethod 21090 * 21091 * @extends CommonMethod<T> 21092 * @syscap SystemCapability.ArkUI.ArkUI.Full 21093 * @crossplatform 21094 * @form 21095 * @atomicservice 21096 * @since 11 21097 */ 21098declare class CommonShapeMethod<T> extends CommonMethod<T> { 21099 /** 21100 * constructor. 21101 * 21102 * @syscap SystemCapability.ArkUI.ArkUI.Full 21103 * @systemapi 21104 * @since 7 21105 */ 21106 /** 21107 * constructor. 21108 * 21109 * @syscap SystemCapability.ArkUI.ArkUI.Full 21110 * @systemapi 21111 * @form 21112 * @since 9 21113 */ 21114 constructor(); 21115 21116 /** 21117 * border Color 21118 * 21119 * @param { ResourceColor } value 21120 * @returns { T } 21121 * @syscap SystemCapability.ArkUI.ArkUI.Full 21122 * @since 7 21123 */ 21124 /** 21125 * border Color 21126 * 21127 * @param { ResourceColor } value 21128 * @returns { T } 21129 * @syscap SystemCapability.ArkUI.ArkUI.Full 21130 * @form 21131 * @since 9 21132 */ 21133 /** 21134 * border Color 21135 * 21136 * @param { ResourceColor } value 21137 * @returns { T } 21138 * @syscap SystemCapability.ArkUI.ArkUI.Full 21139 * @crossplatform 21140 * @form 21141 * @since 10 21142 */ 21143 /** 21144 * border Color 21145 * 21146 * @param { ResourceColor } value 21147 * @returns { T } 21148 * @syscap SystemCapability.ArkUI.ArkUI.Full 21149 * @crossplatform 21150 * @form 21151 * @atomicservice 21152 * @since 11 21153 */ 21154 stroke(value: ResourceColor): T; 21155 21156 /** 21157 * Fill color. 21158 * 21159 * @param { ResourceColor } value 21160 * @returns { T } 21161 * @syscap SystemCapability.ArkUI.ArkUI.Full 21162 * @since 7 21163 */ 21164 /** 21165 * Fill color. 21166 * 21167 * @param { ResourceColor } value 21168 * @returns { T } 21169 * @syscap SystemCapability.ArkUI.ArkUI.Full 21170 * @form 21171 * @since 9 21172 */ 21173 /** 21174 * Fill color. 21175 * 21176 * @param { ResourceColor } value 21177 * @returns { T } 21178 * @syscap SystemCapability.ArkUI.ArkUI.Full 21179 * @crossplatform 21180 * @form 21181 * @since 10 21182 */ 21183 /** 21184 * Fill color. 21185 * 21186 * @param { ResourceColor } value 21187 * @returns { T } 21188 * @syscap SystemCapability.ArkUI.ArkUI.Full 21189 * @crossplatform 21190 * @form 21191 * @atomicservice 21192 * @since 11 21193 */ 21194 fill(value: ResourceColor): T; 21195 21196 /** 21197 * Offset from the start point of the border drawing. 21198 * 21199 * @param { number | string } value 21200 * @returns { T } 21201 * @syscap SystemCapability.ArkUI.ArkUI.Full 21202 * @since 7 21203 */ 21204 /** 21205 * Offset from the start point of the border drawing. 21206 * 21207 * @param { number | string } value 21208 * @returns { T } 21209 * @syscap SystemCapability.ArkUI.ArkUI.Full 21210 * @form 21211 * @since 9 21212 */ 21213 /** 21214 * Offset from the start point of the border drawing. 21215 * 21216 * @param { number | string } value 21217 * @returns { T } 21218 * @syscap SystemCapability.ArkUI.ArkUI.Full 21219 * @crossplatform 21220 * @form 21221 * @since 10 21222 */ 21223 /** 21224 * Offset from the start point of the border drawing. 21225 * 21226 * @param { number | string } value 21227 * @returns { T } 21228 * @syscap SystemCapability.ArkUI.ArkUI.Full 21229 * @crossplatform 21230 * @form 21231 * @atomicservice 21232 * @since 11 21233 */ 21234 strokeDashOffset(value: number | string): T; 21235 21236 /** 21237 * Path endpoint drawing style. 21238 * 21239 * @param { LineCapStyle } value 21240 * @returns { T } 21241 * @syscap SystemCapability.ArkUI.ArkUI.Full 21242 * @since 7 21243 */ 21244 /** 21245 * Path endpoint drawing style. 21246 * 21247 * @param { LineCapStyle } value 21248 * @returns { T } 21249 * @syscap SystemCapability.ArkUI.ArkUI.Full 21250 * @form 21251 * @since 9 21252 */ 21253 /** 21254 * Path endpoint drawing style. 21255 * 21256 * @param { LineCapStyle } value 21257 * @returns { T } 21258 * @syscap SystemCapability.ArkUI.ArkUI.Full 21259 * @crossplatform 21260 * @form 21261 * @since 10 21262 */ 21263 /** 21264 * Path endpoint drawing style. 21265 * 21266 * @param { LineCapStyle } value 21267 * @returns { T } 21268 * @syscap SystemCapability.ArkUI.ArkUI.Full 21269 * @crossplatform 21270 * @form 21271 * @atomicservice 21272 * @since 11 21273 */ 21274 strokeLineCap(value: LineCapStyle): T; 21275 21276 /** 21277 * Border corner drawing style. 21278 * 21279 * @param { LineJoinStyle } value 21280 * @returns { T } 21281 * @syscap SystemCapability.ArkUI.ArkUI.Full 21282 * @since 7 21283 */ 21284 /** 21285 * Border corner drawing style. 21286 * 21287 * @param { LineJoinStyle } value 21288 * @returns { T } 21289 * @syscap SystemCapability.ArkUI.ArkUI.Full 21290 * @form 21291 * @since 9 21292 */ 21293 /** 21294 * Border corner drawing style. 21295 * 21296 * @param { LineJoinStyle } value 21297 * @returns { T } 21298 * @syscap SystemCapability.ArkUI.ArkUI.Full 21299 * @crossplatform 21300 * @form 21301 * @since 10 21302 */ 21303 /** 21304 * Border corner drawing style. 21305 * 21306 * @param { LineJoinStyle } value 21307 * @returns { T } 21308 * @syscap SystemCapability.ArkUI.ArkUI.Full 21309 * @crossplatform 21310 * @form 21311 * @atomicservice 21312 * @since 11 21313 */ 21314 strokeLineJoin(value: LineJoinStyle): T; 21315 21316 /** 21317 * Limits for drawing acute angles as bevels 21318 * 21319 * @param { number | string } value 21320 * @returns { T } 21321 * @syscap SystemCapability.ArkUI.ArkUI.Full 21322 * @since 7 21323 */ 21324 /** 21325 * Limits for drawing acute angles as bevels 21326 * 21327 * @param { number | string } value 21328 * @returns { T } 21329 * @syscap SystemCapability.ArkUI.ArkUI.Full 21330 * @form 21331 * @since 9 21332 */ 21333 /** 21334 * Limits for drawing acute angles as bevels 21335 * 21336 * @param { number | string } value 21337 * @returns { T } 21338 * @syscap SystemCapability.ArkUI.ArkUI.Full 21339 * @crossplatform 21340 * @form 21341 * @since 10 21342 */ 21343 /** 21344 * Limits for drawing acute angles as bevels 21345 * 21346 * @param { number | string } value 21347 * @returns { T } 21348 * @syscap SystemCapability.ArkUI.ArkUI.Full 21349 * @crossplatform 21350 * @form 21351 * @atomicservice 21352 * @since 11 21353 */ 21354 strokeMiterLimit(value: number | string): T; 21355 21356 /** 21357 * Sets the opacity of the border. 21358 * 21359 * @param { number | string | Resource } value 21360 * @returns { T } 21361 * @syscap SystemCapability.ArkUI.ArkUI.Full 21362 * @since 7 21363 */ 21364 /** 21365 * Sets the opacity of the border. 21366 * 21367 * @param { number | string | Resource } value 21368 * @returns { T } 21369 * @syscap SystemCapability.ArkUI.ArkUI.Full 21370 * @form 21371 * @since 9 21372 */ 21373 /** 21374 * Sets the opacity of the border. 21375 * 21376 * @param { number | string | Resource } value 21377 * @returns { T } 21378 * @syscap SystemCapability.ArkUI.ArkUI.Full 21379 * @crossplatform 21380 * @form 21381 * @since 10 21382 */ 21383 /** 21384 * Sets the opacity of the border. 21385 * 21386 * @param { number | string | Resource } value 21387 * @returns { T } 21388 * @syscap SystemCapability.ArkUI.ArkUI.Full 21389 * @crossplatform 21390 * @form 21391 * @atomicservice 21392 * @since 11 21393 */ 21394 strokeOpacity(value: number | string | Resource): T; 21395 21396 /** 21397 * fill Opacity 21398 * 21399 * @param { number | string | Resource } value 21400 * @returns { T } 21401 * @syscap SystemCapability.ArkUI.ArkUI.Full 21402 * @since 7 21403 */ 21404 /** 21405 * fill Opacity 21406 * 21407 * @param { number | string | Resource } value 21408 * @returns { T } 21409 * @syscap SystemCapability.ArkUI.ArkUI.Full 21410 * @form 21411 * @since 9 21412 */ 21413 /** 21414 * fill Opacity 21415 * 21416 * @param { number | string | Resource } value 21417 * @returns { T } 21418 * @syscap SystemCapability.ArkUI.ArkUI.Full 21419 * @crossplatform 21420 * @form 21421 * @since 10 21422 */ 21423 /** 21424 * fill Opacity 21425 * 21426 * @param { number | string | Resource } value 21427 * @returns { T } 21428 * @syscap SystemCapability.ArkUI.ArkUI.Full 21429 * @crossplatform 21430 * @form 21431 * @atomicservice 21432 * @since 11 21433 */ 21434 fillOpacity(value: number | string | Resource): T; 21435 21436 /** 21437 * Sets the width of the dividing line. 21438 * 21439 * @param { Length } value 21440 * @returns { T } 21441 * @syscap SystemCapability.ArkUI.ArkUI.Full 21442 * @since 7 21443 */ 21444 /** 21445 * Sets the width of the dividing line. 21446 * 21447 * @param { Length } value 21448 * @returns { T } 21449 * @syscap SystemCapability.ArkUI.ArkUI.Full 21450 * @form 21451 * @since 9 21452 */ 21453 /** 21454 * Sets the width of the dividing line. 21455 * 21456 * @param { Length } value 21457 * @returns { T } 21458 * @syscap SystemCapability.ArkUI.ArkUI.Full 21459 * @crossplatform 21460 * @form 21461 * @since 10 21462 */ 21463 /** 21464 * Sets the width of the dividing line. 21465 * 21466 * @param { Length } value 21467 * @returns { T } 21468 * @syscap SystemCapability.ArkUI.ArkUI.Full 21469 * @crossplatform 21470 * @form 21471 * @atomicservice 21472 * @since 11 21473 */ 21474 strokeWidth(value: Length): T; 21475 21476 /** 21477 * Indicates whether to enable anti-aliasing 21478 * 21479 * @param { boolean } value 21480 * @returns { T } 21481 * @syscap SystemCapability.ArkUI.ArkUI.Full 21482 * @since 7 21483 */ 21484 /** 21485 * Indicates whether to enable anti-aliasing 21486 * 21487 * @param { boolean } value 21488 * @returns { T } 21489 * @syscap SystemCapability.ArkUI.ArkUI.Full 21490 * @form 21491 * @since 9 21492 */ 21493 /** 21494 * Indicates whether to enable anti-aliasing 21495 * 21496 * @param { boolean } value 21497 * @returns { T } 21498 * @syscap SystemCapability.ArkUI.ArkUI.Full 21499 * @crossplatform 21500 * @form 21501 * @since 10 21502 */ 21503 /** 21504 * Indicates whether to enable anti-aliasing 21505 * 21506 * @param { boolean } value 21507 * @returns { T } 21508 * @syscap SystemCapability.ArkUI.ArkUI.Full 21509 * @crossplatform 21510 * @form 21511 * @atomicservice 21512 * @since 11 21513 */ 21514 antiAlias(value: boolean): T; 21515 21516 /** 21517 * Sets the gap for the border. 21518 * 21519 * @param { Array<any> } value 21520 * @returns { T } 21521 * @syscap SystemCapability.ArkUI.ArkUI.Full 21522 * @since 7 21523 */ 21524 /** 21525 * Sets the gap for the border. 21526 * 21527 * @param { Array<any> } value 21528 * @returns { T } 21529 * @syscap SystemCapability.ArkUI.ArkUI.Full 21530 * @form 21531 * @since 9 21532 */ 21533 /** 21534 * Sets the gap for the border. 21535 * 21536 * @param { Array<any> } value 21537 * @returns { T } 21538 * @syscap SystemCapability.ArkUI.ArkUI.Full 21539 * @crossplatform 21540 * @form 21541 * @since 10 21542 */ 21543 /** 21544 * Sets the gap for the border. 21545 * 21546 * @param { Array<any> } value 21547 * @returns { T } 21548 * @syscap SystemCapability.ArkUI.ArkUI.Full 21549 * @crossplatform 21550 * @form 21551 * @atomicservice 21552 * @since 11 21553 */ 21554 strokeDashArray(value: Array<any>): T; 21555} 21556 21557/** 21558 * Linear Gradient Interface 21559 * 21560 * @interface LinearGradient 21561 * @syscap SystemCapability.ArkUI.ArkUI.Full 21562 * @since 9 21563 */ 21564/** 21565 * Linear Gradient Interface 21566 * 21567 * @interface LinearGradient 21568 * @syscap SystemCapability.ArkUI.ArkUI.Full 21569 * @crossplatform 21570 * @since 10 21571 */ 21572/** 21573 * Linear Gradient Interface 21574 * 21575 * @interface LinearGradient 21576 * @syscap SystemCapability.ArkUI.ArkUI.Full 21577 * @crossplatform 21578 * @atomicservice 21579 * @since 11 21580 */ 21581declare interface LinearGradient { 21582 /** 21583 * Linear Gradient Angle 21584 * 21585 * @type { ?(number | string) } 21586 * @syscap SystemCapability.ArkUI.ArkUI.Full 21587 * @since 9 21588 */ 21589 /** 21590 * Linear Gradient Angle 21591 * 21592 * @type { ?(number | string) } 21593 * @syscap SystemCapability.ArkUI.ArkUI.Full 21594 * @crossplatform 21595 * @since 10 21596 */ 21597 /** 21598 * Linear Gradient Angle 21599 * 21600 * @type { ?(number | string) } 21601 * @syscap SystemCapability.ArkUI.ArkUI.Full 21602 * @crossplatform 21603 * @atomicservice 21604 * @since 11 21605 */ 21606 angle?: number | string; 21607 /** 21608 * Linear Gradient Direction 21609 * 21610 * @type { ?GradientDirection } 21611 * @syscap SystemCapability.ArkUI.ArkUI.Full 21612 * @since 9 21613 */ 21614 /** 21615 * Linear Gradient Direction 21616 * 21617 * @type { ?GradientDirection } 21618 * @syscap SystemCapability.ArkUI.ArkUI.Full 21619 * @crossplatform 21620 * @since 10 21621 */ 21622 /** 21623 * Linear Gradient Direction 21624 * 21625 * @type { ?GradientDirection } 21626 * @syscap SystemCapability.ArkUI.ArkUI.Full 21627 * @crossplatform 21628 * @atomicservice 21629 * @since 11 21630 */ 21631 direction?: GradientDirection; 21632 /** 21633 * Linear Gradient Colors 21634 * 21635 * @type { Array<any> } 21636 * @syscap SystemCapability.ArkUI.ArkUI.Full 21637 * @since 9 21638 */ 21639 /** 21640 * Linear Gradient Colors 21641 * 21642 * @type { Array<any> } 21643 * @syscap SystemCapability.ArkUI.ArkUI.Full 21644 * @crossplatform 21645 * @since 10 21646 */ 21647 /** 21648 * Linear Gradient Colors 21649 * 21650 * @type { Array<any> } 21651 * @syscap SystemCapability.ArkUI.ArkUI.Full 21652 * @crossplatform 21653 * @atomicservice 21654 * @since 11 21655 */ 21656 /** 21657 * Linear Gradient Colors 21658 * 21659 * @type { Array<[ResourceColor, number]> } 21660 * @syscap SystemCapability.ArkUI.ArkUI.Full 21661 * @crossplatform 21662 * @atomicservice 21663 * @since 12 21664 */ 21665 colors: Array<[ResourceColor, number]>; 21666 /** 21667 * Linear Gradient Repeating 21668 * 21669 * @type { ?boolean } 21670 * @syscap SystemCapability.ArkUI.ArkUI.Full 21671 * @since 9 21672 */ 21673 /** 21674 * Linear Gradient Repeating 21675 * 21676 * @type { ?boolean } 21677 * @syscap SystemCapability.ArkUI.ArkUI.Full 21678 * @crossplatform 21679 * @since 10 21680 */ 21681 /** 21682 * Linear Gradient Repeating 21683 * 21684 * @type { ?boolean } 21685 * @syscap SystemCapability.ArkUI.ArkUI.Full 21686 * @crossplatform 21687 * @atomicservice 21688 * @since 11 21689 */ 21690 repeating?: boolean; 21691} 21692 21693/** 21694 * Defines the pixel round property. 21695 * 21696 * @interface PixelRoundPolicy 21697 * @syscap SystemCapability.ArkUI.ArkUI.Full 21698 * @crossplatform 21699 * @form 21700 * @atomicservice 21701 * @since 11 21702 */ 21703declare interface PixelRoundPolicy { 21704 /** 21705 * start property. 21706 * 21707 * @type { ?PixelRoundCalcPolicy } 21708 * @default PixelRoundCalcPolicy.NO_FORCE_ROUND 21709 * @syscap SystemCapability.ArkUI.ArkUI.Full 21710 * @crossplatform 21711 * @form 21712 * @atomicservice 21713 * @since 11 21714 */ 21715 start?: PixelRoundCalcPolicy; 21716 21717 /** 21718 * top property. 21719 * 21720 * @type { ?PixelRoundCalcPolicy } 21721 * @default PixelRoundCalcPolicy.NO_FORCE_ROUND 21722 * @syscap SystemCapability.ArkUI.ArkUI.Full 21723 * @crossplatform 21724 * @form 21725 * @atomicservice 21726 * @since 11 21727 */ 21728 top?: PixelRoundCalcPolicy; 21729 21730 /** 21731 * end property. 21732 * 21733 * @type { ?PixelRoundCalcPolicy } 21734 * @default PixelRoundCalcPolicy.NO_FORCE_ROUND 21735 * @syscap SystemCapability.ArkUI.ArkUI.Full 21736 * @crossplatform 21737 * @form 21738 * @atomicservice 21739 * @since 11 21740 */ 21741 end?: PixelRoundCalcPolicy; 21742 21743 /** 21744 * bottom property. 21745 * 21746 * @type { ?PixelRoundCalcPolicy } 21747 * @default PixelRoundCalcPolicy.NO_FORCE_ROUND 21748 * @syscap SystemCapability.ArkUI.ArkUI.Full 21749 * @crossplatform 21750 * @form 21751 * @atomicservice 21752 * @since 11 21753 */ 21754 bottom?: PixelRoundCalcPolicy; 21755} 21756 21757/** 21758 * Linear Gradient Blur Interface 21759 * 21760 * @interface LinearGradientBlurOptions 21761 * @syscap SystemCapability.ArkUI.ArkUI.Full 21762 * @atomicservice 21763 * @since 12 21764 */ 21765declare interface LinearGradientBlurOptions { 21766 /** 21767 * Percentage of blurring effect. 21768 * 21769 * @type { FractionStop[] } 21770 * @syscap SystemCapability.ArkUI.ArkUI.Full 21771 * @atomicservice 21772 * @since 12 21773 */ 21774 fractionStops: FractionStop[]; 21775 /** 21776 * Direction of linear gradient blur. 21777 * 21778 * @type { GradientDirection } 21779 * @syscap SystemCapability.ArkUI.ArkUI.Full 21780 * @atomicservice 21781 * @since 12 21782 */ 21783 direction: GradientDirection; 21784} 21785 21786/** 21787 * Define motion blur anchor coordinates. 21788 * 21789 * @interface MotionBlurAnchor 21790 * @syscap SystemCapability.ArkUI.ArkUI.Full 21791 * @crossplatform 21792 * @atomicservice 21793 * @since 12 21794 */ 21795declare interface MotionBlurAnchor { 21796 /** 21797 * Define anchor coordinate x-value.Value range [0.0, 1.0]. 21798 * 21799 * @type { number } 21800 * @syscap SystemCapability.ArkUI.ArkUI.Full 21801 * @atomicservice 21802 * @since 12 21803 */ 21804 x: number; 21805 /** 21806 * Define anchor coordinate y-value.Value range [0.0, 1.0]. 21807 * 21808 * @type { number } 21809 * @syscap SystemCapability.ArkUI.ArkUI.Full 21810 * @atomicservice 21811 * @since 12 21812 */ 21813 y: number; 21814} 21815 21816/** 21817 * Define motion blur options. 21818 * 21819 * @interface MotionBlurOptions 21820 * @syscap SystemCapability.ArkUI.ArkUI.Full 21821 * @crossplatform 21822 * @atomicservice 21823 * @since 12 21824 */ 21825declare interface MotionBlurOptions { 21826 /** 21827 * Define the size of motion blur radius.The range of this value is [0.0, ∞). 21828 * 21829 * @type { number } 21830 * @syscap SystemCapability.ArkUI.ArkUI.Full 21831 * @atomicservice 21832 * @since 12 21833 */ 21834 radius: number; 21835 /** 21836 * Define motion blur anchor coordinates. 21837 * 21838 * @type { MotionBlurAnchor } 21839 * @syscap SystemCapability.ArkUI.ArkUI.Full 21840 * @atomicservice 21841 * @since 12 21842 */ 21843 anchor: MotionBlurAnchor; 21844} 21845 21846/** 21847 * Sub component border info. 21848 * 21849 * @interface LayoutBorderInfo 21850 * @syscap SystemCapability.ArkUI.ArkUI.Full 21851 * @form 21852 * @since 9 21853 * @deprecated since 10 21854 */ 21855declare interface LayoutBorderInfo { 21856 /** 21857 * Sub component borderWidth info. 21858 * 21859 * @type { EdgeWidths } 21860 * @syscap SystemCapability.ArkUI.ArkUI.Full 21861 * @form 21862 * @since 9 21863 * @deprecated since 10 21864 */ 21865 borderWidth: EdgeWidths; 21866 21867 /** 21868 * Sub component margin info. 21869 * 21870 * @type { Margin } 21871 * @syscap SystemCapability.ArkUI.ArkUI.Full 21872 * @form 21873 * @since 9 21874 * @deprecated since 10 21875 */ 21876 margin: Margin, 21877 21878 /** 21879 * Sub component padding info. 21880 * 21881 * @type { Padding } 21882 * @syscap SystemCapability.ArkUI.ArkUI.Full 21883 * @form 21884 * @since 9 21885 * @deprecated since 10 21886 */ 21887 padding: Padding, 21888} 21889 21890/** 21891 * Sub component layout info. 21892 * 21893 * @interface LayoutInfo 21894 * @syscap SystemCapability.ArkUI.ArkUI.Full 21895 * @form 21896 * @since 9 21897 * @deprecated since 10 21898 */ 21899declare interface LayoutInfo { 21900 /** 21901 * Sub component position info. 21902 * 21903 * @type { Position } 21904 * @syscap SystemCapability.ArkUI.ArkUI.Full 21905 * @form 21906 * @since 9 21907 * @deprecated since 10 21908 */ 21909 position: Position, 21910 21911 /** 21912 * Sub component constraint info. 21913 * 21914 * @type { ConstraintSizeOptions } 21915 * @syscap SystemCapability.ArkUI.ArkUI.Full 21916 * @form 21917 * @since 9 21918 * @deprecated since 10 21919 */ 21920 constraint: ConstraintSizeOptions, 21921} 21922 21923/** 21924 * Sub component info passed from framework when layout and measure happens. 21925 * 21926 * @interface LayoutChild 21927 * @syscap SystemCapability.ArkUI.ArkUI.Full 21928 * @form 21929 * @since 9 21930 * @deprecated since 10 21931 */ 21932declare interface LayoutChild { 21933 /** 21934 * Sub component name. 21935 * 21936 * @type { string } 21937 * @syscap SystemCapability.ArkUI.ArkUI.Full 21938 * @form 21939 * @since 9 21940 * @deprecated since 10 21941 */ 21942 name: string, 21943 21944 /** 21945 * Sub component id. 21946 * 21947 * @type { string } 21948 * @syscap SystemCapability.ArkUI.ArkUI.Full 21949 * @form 21950 * @since 9 21951 * @deprecated since 10 21952 */ 21953 id: string, 21954 21955 /** 21956 * Sub component constraint. 21957 * 21958 * @type { ConstraintSizeOptions } 21959 * @syscap SystemCapability.ArkUI.ArkUI.Full 21960 * @form 21961 * @since 9 21962 * @deprecated since 10 21963 */ 21964 constraint: ConstraintSizeOptions, 21965 21966 /** 21967 * Sub component border info. 21968 * 21969 * @type { LayoutBorderInfo } 21970 * @syscap SystemCapability.ArkUI.ArkUI.Full 21971 * @form 21972 * @since 9 21973 * @deprecated since 10 21974 */ 21975 borderInfo: LayoutBorderInfo, 21976 21977 /** 21978 * Sub component position. 21979 * 21980 * @type { Position } 21981 * @syscap SystemCapability.ArkUI.ArkUI.Full 21982 * @form 21983 * @since 9 21984 * @deprecated since 10 21985 */ 21986 position: Position, 21987 21988 /** 21989 * Call this measure method in onMeasure callback to supply sub component size. 21990 * 21991 * @param { ConstraintSizeOptions } childConstraint 21992 * @syscap SystemCapability.ArkUI.ArkUI.Full 21993 * @form 21994 * @since 9 21995 * @deprecated since 10 21996 */ 21997 measure(childConstraint: ConstraintSizeOptions), 21998 21999 /** 22000 * Call this layout method in onLayout callback to assign layout info to sub component. 22001 * 22002 * @param { LayoutInfo } childLayoutInfo 22003 * @syscap SystemCapability.ArkUI.ArkUI.Full 22004 * @form 22005 * @since 9 22006 * @deprecated since 10 22007 */ 22008 layout(childLayoutInfo: LayoutInfo), 22009} 22010 22011/** 22012 * Sub component layout info. 22013 * 22014 * @extends SizeResult 22015 * @interface GeometryInfo 22016 * @syscap SystemCapability.ArkUI.ArkUI.Full 22017 * @crossplatform 22018 * @since 10 22019 */ 22020/** 22021 * Sub component layout info. 22022 * 22023 * @extends SizeResult 22024 * @interface GeometryInfo 22025 * @syscap SystemCapability.ArkUI.ArkUI.Full 22026 * @crossplatform 22027 * @atomicservice 22028 * @since 11 22029 */ 22030declare interface GeometryInfo extends SizeResult { 22031 /** 22032 * Sub component borderWidth info. 22033 * 22034 * @type { EdgeWidth } 22035 * @syscap SystemCapability.ArkUI.ArkUI.Full 22036 * @crossplatform 22037 * @since 10 22038 */ 22039 /** 22040 * Sub component borderWidth info. 22041 * 22042 * @type { EdgeWidth } 22043 * @syscap SystemCapability.ArkUI.ArkUI.Full 22044 * @crossplatform 22045 * @atomicservice 22046 * @since 11 22047 */ 22048 borderWidth: EdgeWidth; 22049 22050 /** 22051 * Sub component margin info. 22052 * 22053 * @type { Margin } 22054 * @syscap SystemCapability.ArkUI.ArkUI.Full 22055 * @crossplatform 22056 * @since 10 22057 */ 22058 /** 22059 * Sub component margin info. 22060 * 22061 * @type { Margin } 22062 * @syscap SystemCapability.ArkUI.ArkUI.Full 22063 * @crossplatform 22064 * @atomicservice 22065 * @since 11 22066 */ 22067 margin: Margin, 22068 22069 /** 22070 * Sub component padding info. 22071 * 22072 * @type { Padding } 22073 * @syscap SystemCapability.ArkUI.ArkUI.Full 22074 * @crossplatform 22075 * @since 10 22076 */ 22077 /** 22078 * Sub component padding info. 22079 * 22080 * @type { Padding } 22081 * @syscap SystemCapability.ArkUI.ArkUI.Full 22082 * @crossplatform 22083 * @atomicservice 22084 * @since 11 22085 */ 22086 padding: Padding, 22087} 22088 22089/** 22090 * Sub component info passed from framework when layout happens. 22091 * 22092 * @interface Layoutable 22093 * @syscap SystemCapability.ArkUI.ArkUI.Full 22094 * @crossplatform 22095 * @since 10 22096 */ 22097/** 22098 * Sub component info passed from framework when layout happens. 22099 * 22100 * @interface Layoutable 22101 * @syscap SystemCapability.ArkUI.ArkUI.Full 22102 * @crossplatform 22103 * @atomicservice 22104 * @since 11 22105 */ 22106declare interface Layoutable { 22107 /** 22108 * Measurement result of the child component. 22109 * 22110 * @type { MeasureResult } 22111 * @syscap SystemCapability.ArkUI.ArkUI.Full 22112 * @crossplatform 22113 * @since 10 22114 */ 22115 /** 22116 * Measurement result of the child component. 22117 * 22118 * @type { MeasureResult } 22119 * @syscap SystemCapability.ArkUI.ArkUI.Full 22120 * @crossplatform 22121 * @atomicservice 22122 * @since 11 22123 */ 22124 measureResult: MeasureResult, 22125 22126 /** 22127 * Call this layout method in onLayout callback to assign layout info to sub component. 22128 * 22129 * @param { Position } position 22130 * @syscap SystemCapability.ArkUI.ArkUI.Full 22131 * @crossplatform 22132 * @since 10 22133 */ 22134 /** 22135 * Call this layout method in onLayout callback to assign layout info to sub component. 22136 * 22137 * @param { Position } position 22138 * @syscap SystemCapability.ArkUI.ArkUI.Full 22139 * @crossplatform 22140 * @atomicservice 22141 * @since 11 22142 */ 22143 layout(position: Position): void, 22144 22145 /** 22146 * Call this method to get the margin of sub component. 22147 * 22148 * @returns { DirectionalEdgesT<number> } the margin of sub component, unit is vp 22149 * @syscap SystemCapability.ArkUI.ArkUI.Full 22150 * @crossplatform 22151 * @atomicservice 22152 * @since 12 22153 */ 22154 getMargin() : DirectionalEdgesT<number>, 22155 22156 /** 22157 * Call this method to get the padding of sub component. 22158 * 22159 * @returns { DirectionalEdgesT<number> } the padding of sub component, unit is vp 22160 * @syscap SystemCapability.ArkUI.ArkUI.Full 22161 * @crossplatform 22162 * @atomicservice 22163 * @since 12 22164 */ 22165 getPadding() : DirectionalEdgesT<number>, 22166 22167 /** 22168 * Call this method to get the borderWidth of sub component. 22169 * 22170 * @returns { DirectionalEdgesT<number> } the borderWidth of sub component, unit is vp 22171 * @syscap SystemCapability.ArkUI.ArkUI.Full 22172 * @crossplatform 22173 * @atomicservice 22174 * @since 12 22175 */ 22176 getBorderWidth() : DirectionalEdgesT<number>, 22177} 22178 22179/** 22180 * Sub component info passed from framework when measure happens. 22181 * 22182 * @interface Measurable 22183 * @syscap SystemCapability.ArkUI.ArkUI.Full 22184 * @crossplatform 22185 * @since 10 22186 */ 22187/** 22188 * Sub component info passed from framework when measure happens. 22189 * 22190 * @interface Measurable 22191 * @syscap SystemCapability.ArkUI.ArkUI.Full 22192 * @crossplatform 22193 * @atomicservice 22194 * @since 11 22195 */ 22196declare interface Measurable { 22197 /** 22198 * Call this measure method in onMeasure callback to supply sub component size. 22199 * 22200 * @param { ConstraintSizeOptions } constraint 22201 * @returns { MeasureResult } 22202 * @syscap SystemCapability.ArkUI.ArkUI.Full 22203 * @crossplatform 22204 * @since 10 22205 */ 22206 /** 22207 * Call this measure method in onMeasure callback to supply sub component size. 22208 * 22209 * @param { ConstraintSizeOptions } constraint 22210 * @returns { MeasureResult } 22211 * @syscap SystemCapability.ArkUI.ArkUI.Full 22212 * @crossplatform 22213 * @atomicservice 22214 * @since 11 22215 */ 22216 measure(constraint: ConstraintSizeOptions) : MeasureResult, 22217 22218 /** 22219 * Call this method to get the margin of sub component. 22220 * 22221 * @returns { DirectionalEdgesT<number> } the margin of sub component, unit is vp 22222 * @syscap SystemCapability.ArkUI.ArkUI.Full 22223 * @crossplatform 22224 * @atomicservice 22225 * @since 12 22226 */ 22227 getMargin() : DirectionalEdgesT<number>, 22228 22229 /** 22230 * Call this method to get the padding of sub component. 22231 * 22232 * @returns { DirectionalEdgesT<number> } the padding of sub component, unit is vp 22233 * @syscap SystemCapability.ArkUI.ArkUI.Full 22234 * @crossplatform 22235 * @atomicservice 22236 * @since 12 22237 */ 22238 getPadding() : DirectionalEdgesT<number>, 22239 22240 /** 22241 * Call this method to get the borderWidth of sub component. 22242 * 22243 * @returns { DirectionalEdgesT<number> } the borderWidth of sub component, unit is vp 22244 * @syscap SystemCapability.ArkUI.ArkUI.Full 22245 * @crossplatform 22246 * @atomicservice 22247 * @since 12 22248 */ 22249 getBorderWidth() : DirectionalEdgesT<number>, 22250} 22251 22252/** 22253 * Sub component SizeResult info. 22254 * 22255 * @interface SizeResult 22256 * @syscap SystemCapability.ArkUI.ArkUI.Full 22257 * @crossplatform 22258 * @since 10 22259 */ 22260/** 22261 * Sub component SizeResult info. 22262 * 22263 * @interface SizeResult 22264 * @syscap SystemCapability.ArkUI.ArkUI.Full 22265 * @crossplatform 22266 * @atomicservice 22267 * @since 11 22268 */ 22269declare interface SizeResult { 22270 /** 22271 * Width obtained from the measurement result. 22272 * 22273 * @type { number } 22274 * @syscap SystemCapability.ArkUI.ArkUI.Full 22275 * @crossplatform 22276 * @since 10 22277 */ 22278 /** 22279 * Width obtained from the measurement result. 22280 * 22281 * @type { number } 22282 * @syscap SystemCapability.ArkUI.ArkUI.Full 22283 * @crossplatform 22284 * @atomicservice 22285 * @since 11 22286 */ 22287 width: number, 22288 22289 /** 22290 * Height obtained from the measurement result. 22291 * 22292 * @type { number } 22293 * @syscap SystemCapability.ArkUI.ArkUI.Full 22294 * @crossplatform 22295 * @since 10 22296 */ 22297 /** 22298 * Height obtained from the measurement result. 22299 * 22300 * @type { number } 22301 * @syscap SystemCapability.ArkUI.ArkUI.Full 22302 * @crossplatform 22303 * @atomicservice 22304 * @since 11 22305 */ 22306 height: number, 22307} 22308 22309/** 22310 * Sub component MeasureResult info. 22311 * 22312 * @interface MeasureResult 22313 * @syscap SystemCapability.ArkUI.ArkUI.Full 22314 * @crossplatform 22315 * @since 10 22316 */ 22317/** 22318 * Sub component MeasureResult info. 22319 * 22320 * @interface MeasureResult 22321 * @syscap SystemCapability.ArkUI.ArkUI.Full 22322 * @crossplatform 22323 * @atomicservice 22324 * @since 11 22325 */ 22326declare interface MeasureResult extends SizeResult { 22327 22328} 22329 22330/** 22331 * The navigation destination information. 22332 * 22333 * @syscap SystemCapability.ArkUI.ArkUI.Full 22334 * @crossplatform 22335 * @since 11 22336 */ 22337/** 22338 * The navigation destination information. 22339 * 22340 * @typedef {import('../api/@ohos.arkui.observer').default.NavDestinationInfo} NavDestinationInfo 22341 * @syscap SystemCapability.ArkUI.ArkUI.Full 22342 * @crossplatform 22343 * @atomicservice 22344 * @since 12 22345 */ 22346declare type NavDestinationInfo = import('../api/@ohos.arkui.observer').default.NavDestinationInfo; 22347 22348/** 22349 * The navigation information. 22350 * 22351 * @typedef {import('../api/@ohos.arkui.observer').default.NavigationInfo} NavigationInfo 22352 * @syscap SystemCapability.ArkUI.ArkUI.Full 22353 * @crossplatform 22354 * @atomicservice 22355 * @since 12 22356 */ 22357declare type NavigationInfo = import('../api/@ohos.arkui.observer').default.NavigationInfo; 22358 22359/** 22360 * The router page information. 22361 * 22362 * @typedef {import('../api/@ohos.arkui.observer').default.RouterPageInfo} RouterPageInfo 22363 * @syscap SystemCapability.ArkUI.ArkUI.Full 22364 * @crossplatform 22365 * @atomicservice 22366 * @since 12 22367 */ 22368declare type RouterPageInfo = import('../api/@ohos.arkui.observer').default.RouterPageInfo; 22369 22370/** 22371 * UIContext 22372 * 22373 * @syscap SystemCapability.ArkUI.ArkUI.Full 22374 * @crossplatform 22375 * @since 11 22376 */ 22377/** 22378 * UIContext 22379 * 22380 * @typedef { import('../api/@ohos.arkui.UIContext').UIContext } UIContext 22381 * @syscap SystemCapability.ArkUI.ArkUI.Full 22382 * @crossplatform 22383 * @atomicservice 22384 * @since 12 22385 */ 22386declare type UIContext = import('../api/@ohos.arkui.UIContext').UIContext; 22387 22388/** 22389 * DrawContext 22390 * 22391 * @typedef { import('../api/arkui/Graphics').DrawContext } DrawContext 22392 * @syscap SystemCapability.ArkUI.ArkUI.Full 22393 * @crossplatform 22394 * @atomicservice 22395 * @since 12 22396 */ 22397declare type DrawContext = import('../api/arkui/Graphics').DrawContext; 22398 22399/** 22400 * VisualEffect 22401 * 22402 * @typedef { import('../api/@ohos.graphics.uiEffect').default.VisualEffect } VisualEffect 22403 * @syscap SystemCapability.ArkUI.ArkUI.Full 22404 * @crossplatform 22405 * @atomicservice 22406 * @since 12 22407 */ 22408declare type VisualEffect = import('../api/@ohos.graphics.uiEffect').default.VisualEffect; 22409 22410 22411/** 22412 * Filter 22413 * 22414 * @typedef { import('../api/@ohos.graphics.uiEffect').default.Filter } Filter 22415 * @syscap SystemCapability.ArkUI.ArkUI.Full 22416 * @crossplatform 22417 * @atomicservice 22418 * @since 12 22419 */ 22420declare type Filter = import('../api/@ohos.graphics.uiEffect').default.Filter; 22421 22422/** 22423 * Blender 22424 * 22425 * @typedef { import('../api/@ohos.graphics.uiEffect').default.Blender } Blender 22426 * @syscap SystemCapability.ArkUI.ArkUI.Full 22427 * @systemapi 22428 * @form 22429 * @since 13 22430 */ 22431declare type Blender = import('../api/@ohos.graphics.uiEffect').default.Blender; 22432 22433/** 22434 * ComponentContent. 22435 * 22436 * @typedef {import('../api/arkui/ComponentContent').ComponentContent<T>} ComponentContent<T = Object> 22437 * @syscap SystemCapability.ArkUI.ArkUI.Full 22438 * @crossplatform 22439 * @atomicservice 22440 * @since 12 22441 */ 22442declare type ComponentContent<T = Object> = import('../api/arkui/ComponentContent').ComponentContent<T>; 22443 22444/** 22445 * Theme. 22446 * 22447 * @typedef {import('../api/@ohos.arkui.theme').Theme} Theme 22448 * @syscap SystemCapability.ArkUI.ArkUI.Full 22449 * @crossplatform 22450 * @atomicservice 22451 * @since 12 22452 */ 22453declare type Theme = import('../api/@ohos.arkui.theme').Theme; 22454 22455/** 22456 * Custom Component 22457 * 22458 * @extends CommonAttribute 22459 * @syscap SystemCapability.ArkUI.ArkUI.Full 22460 * @since 7 22461 */ 22462/** 22463 * Custom Component 22464 * 22465 * @extends CommonAttribute 22466 * @syscap SystemCapability.ArkUI.ArkUI.Full 22467 * @form 22468 * @since 9 22469 */ 22470/** 22471 * Custom Component 22472 * 22473 * @extends CommonAttribute 22474 * @syscap SystemCapability.ArkUI.ArkUI.Full 22475 * @crossplatform 22476 * @form 22477 * @since 10 22478 */ 22479/** 22480 * Custom Component 22481 * 22482 * @extends CommonAttribute 22483 * @syscap SystemCapability.ArkUI.ArkUI.Full 22484 * @crossplatform 22485 * @form 22486 * @atomicservice 22487 * @since 11 22488 */ 22489declare class CustomComponent extends CommonAttribute { 22490 /** 22491 * Customize the pop-up content constructor. 22492 * 22493 * @syscap SystemCapability.ArkUI.ArkUI.Full 22494 * @since 7 22495 */ 22496 /** 22497 * Customize the pop-up content constructor. 22498 * 22499 * @syscap SystemCapability.ArkUI.ArkUI.Full 22500 * @form 22501 * @since 9 22502 */ 22503 /** 22504 * Customize the pop-up content constructor. 22505 * 22506 * @syscap SystemCapability.ArkUI.ArkUI.Full 22507 * @crossplatform 22508 * @form 22509 * @since 10 22510 */ 22511 /** 22512 * Customize the pop-up content constructor. 22513 * 22514 * @syscap SystemCapability.ArkUI.ArkUI.Full 22515 * @crossplatform 22516 * @form 22517 * @atomicservice 22518 * @since 11 22519 */ 22520 build(): void; 22521 22522 /** 22523 * aboutToAppear Method 22524 * 22525 * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. 22526 * 22527 * @syscap SystemCapability.ArkUI.ArkUI.Full 22528 * @since 7 22529 */ 22530 /** 22531 * aboutToAppear Method 22532 * 22533 * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. 22534 * 22535 * @syscap SystemCapability.ArkUI.ArkUI.Full 22536 * @form 22537 * @since 9 22538 */ 22539 /** 22540 * aboutToAppear Method 22541 * 22542 * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. 22543 * 22544 * @syscap SystemCapability.ArkUI.ArkUI.Full 22545 * @crossplatform 22546 * @form 22547 * @since 10 22548 */ 22549 /** 22550 * aboutToAppear Method 22551 * 22552 * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. 22553 * 22554 * @syscap SystemCapability.ArkUI.ArkUI.Full 22555 * @crossplatform 22556 * @form 22557 * @atomicservice 22558 * @since 11 22559 */ 22560 aboutToAppear?(): void; 22561 22562 /** 22563 * aboutToDisappear Method 22564 * 22565 * The aboutToDisappear function executes before a custom component is destroyed. 22566 * 22567 * @syscap SystemCapability.ArkUI.ArkUI.Full 22568 * @since 7 22569 */ 22570 /** 22571 * aboutToDisappear Method 22572 * 22573 * The aboutToDisappear function executes before a custom component is destroyed. 22574 * 22575 * @syscap SystemCapability.ArkUI.ArkUI.Full 22576 * @form 22577 * @since 9 22578 */ 22579 /** 22580 * aboutToDisappear Method 22581 * 22582 * The aboutToDisappear function executes before a custom component is destroyed. 22583 * 22584 * @syscap SystemCapability.ArkUI.ArkUI.Full 22585 * @crossplatform 22586 * @form 22587 * @since 10 22588 */ 22589 /** 22590 * aboutToDisappear Method 22591 * 22592 * The aboutToDisappear function executes before a custom component is destroyed. 22593 * 22594 * @syscap SystemCapability.ArkUI.ArkUI.Full 22595 * @crossplatform 22596 * @form 22597 * @atomicservice 22598 * @since 11 22599 */ 22600 aboutToDisappear?(): void; 22601 22602 /** 22603 * aboutToReuse Method 22604 * 22605 * @param { object } params - Custom component init params. 22606 * @syscap SystemCapability.ArkUI.ArkUI.Full 22607 * @crossplatform 22608 * @since 10 22609 */ 22610 /** 22611 * aboutToReuse Method 22612 * 22613 * @param { object } params - Custom component init params. 22614 * @syscap SystemCapability.ArkUI.ArkUI.Full 22615 * @crossplatform 22616 * @atomicservice 22617 * @since 11 22618 */ 22619 aboutToReuse?(params: { [key: string]: unknown }): void; 22620 22621 /** 22622 * aboutToRecycle Method 22623 * 22624 * @syscap SystemCapability.ArkUI.ArkUI.Full 22625 * @crossplatform 22626 * @since 10 22627 */ 22628 /** 22629 * aboutToRecycle Method 22630 * 22631 * @syscap SystemCapability.ArkUI.ArkUI.Full 22632 * @crossplatform 22633 * @atomicservice 22634 * @since 11 22635 */ 22636 aboutToRecycle?(): void; 22637 22638 /** 22639 * The onWillApplyTheme function is a custom hook to get active theme object from the context 22640 * 22641 * @param { Theme } theme - Custom theme init params. 22642 * @syscap SystemCapability.ArkUI.ArkUI.Full 22643 * @crossplatform 22644 * @atomicservice 22645 * @since 12 22646 */ 22647 onWillApplyTheme?(theme: Theme): void; 22648 22649 /** 22650 * Custom component override this method to layout each of its sub components. 22651 * 22652 * @param { Array<LayoutChild> } children 22653 * @param { ConstraintSizeOptions } constraint 22654 * @syscap SystemCapability.ArkUI.ArkUI.Full 22655 * @form 22656 * @since 9 22657 * @deprecated since 10 22658 * @useinstead CustomComponent#onPlaceChildren 22659 */ 22660 onLayout?(children: Array<LayoutChild>, constraint: ConstraintSizeOptions): void; 22661 22662 /** 22663 * Custom component override this method to layout each of its sub components. 22664 * 22665 * @param { GeometryInfo } selfLayoutInfo 22666 * @param { Array<Layoutable> } children 22667 * @param { ConstraintSizeOptions } constraint 22668 * @syscap SystemCapability.ArkUI.ArkUI.Full 22669 * @crossplatform 22670 * @since 10 22671 */ 22672 /** 22673 * Custom component override this method to layout each of its sub components. 22674 * 22675 * @param { GeometryInfo } selfLayoutInfo 22676 * @param { Array<Layoutable> } children 22677 * @param { ConstraintSizeOptions } constraint 22678 * @syscap SystemCapability.ArkUI.ArkUI.Full 22679 * @crossplatform 22680 * @atomicservice 22681 * @since 11 22682 */ 22683 onPlaceChildren?(selfLayoutInfo: GeometryInfo, children: Array<Layoutable>, constraint: ConstraintSizeOptions): void; 22684 22685 /** 22686 * Custom component override this method to measure each of its sub components. 22687 * 22688 * @param { Array<LayoutChild> } children 22689 * @param { ConstraintSizeOptions } constraint 22690 * @syscap SystemCapability.ArkUI.ArkUI.Full 22691 * @form 22692 * @since 9 22693 * @deprecated since 10 22694 * @useinstead CustomComponent#onMeasureSize 22695 */ 22696 onMeasure?(children: Array<LayoutChild>, constraint: ConstraintSizeOptions): void; 22697 22698 /** 22699 * Custom component override this method to measure each of its sub components. 22700 * @param { GeometryInfo } selfLayoutInfo 22701 * @param { Array<Measurable> } children - indicate the measure child 22702 * @param { ConstraintSizeOptions } constraint - indicate child constraint size 22703 * @returns { SizeResult } 22704 * @syscap SystemCapability.ArkUI.ArkUI.Full 22705 * @crossplatform 22706 * @since 10 22707 */ 22708 /** 22709 * Custom component override this method to measure each of its sub components. 22710 * @param { GeometryInfo } selfLayoutInfo 22711 * @param { Array<Measurable> } children - indicate the measure child 22712 * @param { ConstraintSizeOptions } constraint - indicate child constraint size 22713 * @returns { SizeResult } 22714 * @syscap SystemCapability.ArkUI.ArkUI.Full 22715 * @crossplatform 22716 * @atomicservice 22717 * @since 11 22718 */ 22719 onMeasureSize?(selfLayoutInfo: GeometryInfo, children: Array<Measurable>, constraint: ConstraintSizeOptions): SizeResult; 22720 22721 /** 22722 * onPageShow Method 22723 * 22724 * The page is triggered once each time it is displayed, including scenarios such as the routing process and the application entering the foreground 22725 * 22726 * @syscap SystemCapability.ArkUI.ArkUI.Full 22727 * @since 7 22728 */ 22729 /** 22730 * onPageShow Method 22731 * 22732 * The page is triggered once each time it is displayed, including scenarios such as the routing process and the application entering the foreground 22733 * 22734 * @syscap SystemCapability.ArkUI.ArkUI.Full 22735 * @crossplatform 22736 * @since 10 22737 */ 22738 /** 22739 * onPageShow Method 22740 * 22741 * The page is triggered once each time it is displayed, including scenarios such as the routing process and the application entering the foreground 22742 * 22743 * @syscap SystemCapability.ArkUI.ArkUI.Full 22744 * @crossplatform 22745 * @atomicservice 22746 * @since 11 22747 */ 22748 onPageShow?(): void; 22749 22750 /** 22751 * onPageHide Method 22752 * 22753 * It is triggered once each time the page is hidden, including scenarios such as the routing process and the application entering the background 22754 * 22755 * @syscap SystemCapability.ArkUI.ArkUI.Full 22756 * @since 7 22757 */ 22758 /** 22759 * onPageHide Method 22760 * 22761 * It is triggered once each time the page is hidden, including scenarios such as the routing process and the application entering the background 22762 * 22763 * @syscap SystemCapability.ArkUI.ArkUI.Full 22764 * @crossplatform 22765 * @since 10 22766 */ 22767 /** 22768 * onPageHide Method 22769 * 22770 * It is triggered once each time the page is hidden, including scenarios such as the routing process and the application entering the background 22771 * 22772 * @syscap SystemCapability.ArkUI.ArkUI.Full 22773 * @crossplatform 22774 * @atomicservice 22775 * @since 11 22776 */ 22777 onPageHide?(): void; 22778 22779 /** 22780 * onFormRecycle Method, this is only for ArkTS form, if form was marked recyclable by form user, when system memory is low, 22781 * it will be recycled after calling this method, you should return a string of params that you wish to be saved, it will be 22782 * passed back as params in onFormRecover, in which you can recover the form 22783 * 22784 * @returns { string } status data of ArkTS form UI, this data will be passed in when recover form later 22785 * @syscap SystemCapability.ArkUI.ArkUI.Full 22786 * @crossplatform 22787 * @form 22788 * @since 11 22789 */ 22790 /** 22791 * onFormRecycle Method, this is only for ArkTS form, if form was marked recyclable by form user, when system memory is low, 22792 * it will be recycled after calling this method, you should return a string of params that you wish to be saved, it will be 22793 * passed back as params in onFormRecover, in which you can recover the form 22794 * 22795 * @returns { string } status data of ArkTS form UI, this data will be passed in when recover form later 22796 * @syscap SystemCapability.ArkUI.ArkUI.Full 22797 * @crossplatform 22798 * @form 22799 * @atomicservice 22800 * @since 12 22801 */ 22802 onFormRecycle?(): string; 22803 22804 /** 22805 * onFormRecover Method, this is only for ArkTS form 22806 * 22807 * @param { string } statusData - indicate status data of ArkTS form UI, which is acquired by calling onFormRecycle, it is used to recover form 22808 * @syscap SystemCapability.ArkUI.ArkUI.Full 22809 * @crossplatform 22810 * @form 22811 * @since 11 22812 */ 22813 /** 22814 * onFormRecover Method, this is only for ArkTS form 22815 * 22816 * @param { string } statusData - indicate status data of ArkTS form UI, which is acquired by calling onFormRecycle, it is used to recover form 22817 * @syscap SystemCapability.ArkUI.ArkUI.Full 22818 * @crossplatform 22819 * @form 22820 * @atomicservice 22821 * @since 12 22822 */ 22823 onFormRecover?(statusData: string): void; 22824 22825 /** 22826 * onBackPress Method 22827 * 22828 * Triggered when the user clicks the back button 22829 * 22830 * @returns { void | boolean } 22831 * @syscap SystemCapability.ArkUI.ArkUI.Full 22832 * @since 7 22833 */ 22834 /** 22835 * onBackPress Method 22836 * 22837 * Triggered when the user clicks the back button 22838 * 22839 * @returns { void | boolean } true means that the page itself processes the return logic. 22840 * false means that the default return logic is used. 22841 * If no value is returned, the default return logic is used. 22842 * @syscap SystemCapability.ArkUI.ArkUI.Full 22843 * @crossplatform 22844 * @since 10 22845 */ 22846 /** 22847 * onBackPress Method 22848 * 22849 * Triggered when the user clicks the back button 22850 * 22851 * @returns { void | boolean } true means that the page itself processes the return logic. 22852 * false means that the default return logic is used. 22853 * If no value is returned, the default return logic is used. 22854 * @syscap SystemCapability.ArkUI.ArkUI.Full 22855 * @crossplatform 22856 * @atomicservice 22857 * @since 11 22858 */ 22859 onBackPress?(): void | boolean; 22860 22861 /** 22862 * PageTransition Method. 22863 * Implement Animation when enter this page or move to other pages. 22864 * 22865 * @syscap SystemCapability.ArkUI.ArkUI.Full 22866 * @since 9 22867 */ 22868 /** 22869 * PageTransition Method. 22870 * Implement Animation when enter this page or move to other pages. 22871 * 22872 * @syscap SystemCapability.ArkUI.ArkUI.Full 22873 * @crossplatform 22874 * @since 10 22875 */ 22876 /** 22877 * PageTransition Method. 22878 * Implement Animation when enter this page or move to other pages. 22879 * 22880 * @syscap SystemCapability.ArkUI.ArkUI.Full 22881 * @crossplatform 22882 * @atomicservice 22883 * @since 11 22884 */ 22885 pageTransition?(): void; 22886 22887 /** 22888 * Get current UIContext 22889 * 22890 * @returns { UIContext } The UIContext that the custom component belongs to. 22891 * @syscap SystemCapability.ArkUI.ArkUI.Full 22892 * @crossplatform 22893 * @since 11 22894 */ 22895 /** 22896 * Get current UIContext 22897 * 22898 * @returns { UIContext } The UIContext that the custom component belongs to. 22899 * @syscap SystemCapability.ArkUI.ArkUI.Full 22900 * @crossplatform 22901 * @atomicservice 22902 * @since 12 22903 */ 22904 getUIContext(): UIContext; 22905 22906 /** 22907 * Get uniqueId of the custom component. 22908 * 22909 * @returns { number } - The uniqueId of the custom component. 22910 * @syscap SystemCapability.ArkUI.ArkUI.Full 22911 * @crossplatform 22912 * @atomicservice 22913 * @since 12 22914 */ 22915 getUniqueId(): number; 22916 22917 /** 22918 * Queries the navigation destination information. 22919 * 22920 * @returns { NavDestinationInfo | undefined } The navigation destination information, or undefined if it is not available. 22921 * @syscap SystemCapability.ArkUI.ArkUI.Full 22922 * @crossplatform 22923 * @since 11 22924 */ 22925 /** 22926 * Queries the navigation destination information. 22927 * 22928 * @returns { NavDestinationInfo | undefined } The navigation destination information, or undefined if it is not available. 22929 * @syscap SystemCapability.ArkUI.ArkUI.Full 22930 * @crossplatform 22931 * @atomicservice 22932 * @since 12 22933 */ 22934 queryNavDestinationInfo(): NavDestinationInfo | undefined; 22935 22936 /** 22937 * Query the navigation information of the current custom component. 22938 * 22939 * @returns { NavigationInfo | undefined } The navigation information, or undefined if it is not available 22940 * @syscap SystemCapability.ArkUI.ArkUI.Full 22941 * @crossplatform 22942 * @atomicservice 22943 * @since 12 22944 */ 22945 queryNavigationInfo(): NavigationInfo | undefined; 22946 22947 /** 22948 * Query the router page information of the current custom component. 22949 * 22950 * @returns { RouterPageInfo | undefined } The router page information, or undefined if it is not available. 22951 * @syscap SystemCapability.ArkUI.ArkUI.Full 22952 * @crossplatform 22953 * @atomicservice 22954 * @since 12 22955 */ 22956 queryRouterPageInfo(): RouterPageInfo | undefined; 22957 22958 /** 22959 * The callback method after the custom component is built. 22960 * 22961 * Triggered when the custom component has been built. 22962 * 22963 * @syscap SystemCapability.ArkUI.ArkUI.Full 22964 * @crossplatform 22965 * @atomicservice 22966 * @since 12 22967 */ 22968 onDidBuild?(): void; 22969} 22970 22971/** 22972 * View 22973 * 22974 * @syscap SystemCapability.ArkUI.ArkUI.Full 22975 * @systemapi 22976 * @since 7 22977 */ 22978/** 22979 * View 22980 * 22981 * @syscap SystemCapability.ArkUI.ArkUI.Full 22982 * @systemapi 22983 * @form 22984 * @since 9 22985 */ 22986declare class View { 22987 /** 22988 * Just use for generate tsbundle 22989 * 22990 * @param { any } value 22991 * @returns { any } 22992 * @syscap SystemCapability.ArkUI.ArkUI.Full 22993 * @systemapi 22994 * @since 7 22995 */ 22996 /** 22997 * Just use for generate tsbundle 22998 * 22999 * @param { any } value 23000 * @returns { any } 23001 * @syscap SystemCapability.ArkUI.ArkUI.Full 23002 * @systemapi 23003 * @form 23004 * @since 9 23005 */ 23006 create(value: any): any; 23007} 23008 23009/** 23010 * Rect info. 23011 * 23012 * @interface RectResult 23013 * @syscap SystemCapability.ArkUI.ArkUI.Full 23014 * @crossplatform 23015 * @since 10 23016 */ 23017/** 23018 * Rect info. 23019 * 23020 * @interface RectResult 23021 * @syscap SystemCapability.ArkUI.ArkUI.Full 23022 * @crossplatform 23023 * @atomicservice 23024 * @since 11 23025 */ 23026declare interface RectResult { 23027 /** 23028 * x:Horizontal coordinate relative to the component. 23029 * 23030 * @type { number } 23031 * @syscap SystemCapability.ArkUI.ArkUI.Full 23032 * @since 10 23033 */ 23034 /** 23035 * x:Horizontal coordinate relative to the component. 23036 * 23037 * @type { number } 23038 * @syscap SystemCapability.ArkUI.ArkUI.Full 23039 * @crossplatform 23040 * @atomicservice 23041 * @since 11 23042 */ 23043 x: number; 23044 23045 /** 23046 * y:Vertical axis coordinate relative to the component. 23047 * 23048 * @type { number } 23049 * @syscap SystemCapability.ArkUI.ArkUI.Full 23050 * @since 10 23051 */ 23052 /** 23053 * y:Vertical axis coordinate relative to the component. 23054 * 23055 * @type { number } 23056 * @syscap SystemCapability.ArkUI.ArkUI.Full 23057 * @crossplatform 23058 * @atomicservice 23059 * @since 11 23060 */ 23061 y: number; 23062 23063 /** 23064 * Get the width of the current textRect. 23065 * 23066 * @type { number } 23067 * @syscap SystemCapability.ArkUI.ArkUI.Full 23068 * @since 10 23069 */ 23070 /** 23071 * Get the width of the current textRect. 23072 * 23073 * @type { number } 23074 * @syscap SystemCapability.ArkUI.ArkUI.Full 23075 * @crossplatform 23076 * @atomicservice 23077 * @since 11 23078 */ 23079 width: number; 23080 23081 /** 23082 * Get the height of the current textRect. 23083 * 23084 * @type { number } 23085 * @syscap SystemCapability.ArkUI.ArkUI.Full 23086 * @since 10 23087 */ 23088 /** 23089 * Get the height of the current textRect. 23090 * 23091 * @type { number } 23092 * @syscap SystemCapability.ArkUI.ArkUI.Full 23093 * @crossplatform 23094 * @atomicservice 23095 * @since 11 23096 */ 23097 height: number; 23098} 23099 23100/** 23101 * CaretOffset info. 23102 * 23103 * @interface CaretOffset 23104 * @syscap SystemCapability.ArkUI.ArkUI.Full 23105 * @crossplatform 23106 * @since 11 23107 */ 23108/** 23109 * CaretOffset info. 23110 * 23111 * @interface CaretOffset 23112 * @syscap SystemCapability.ArkUI.ArkUI.Full 23113 * @crossplatform 23114 * @atomicservice 23115 * @since 12 23116 */ 23117declare interface CaretOffset { 23118 /** 23119 * Get the index of the CaretOffset 23120 * 23121 * @type { number } 23122 * @syscap SystemCapability.ArkUI.ArkUI.Full 23123 * @since 11 23124 */ 23125 /** 23126 * Get the index of the CaretOffset 23127 * 23128 * @type { number } 23129 * @syscap SystemCapability.ArkUI.ArkUI.Full 23130 * @atomicservice 23131 * @since 12 23132 */ 23133 index: number; 23134 23135 /** 23136 * Get the x of the relative position. 23137 * 23138 * @type { number } 23139 * @syscap SystemCapability.ArkUI.ArkUI.Full 23140 * @since 11 23141 */ 23142 /** 23143 * Get the x of the relative position. 23144 * 23145 * @type { number } 23146 * @syscap SystemCapability.ArkUI.ArkUI.Full 23147 * @atomicservice 23148 * @since 12 23149 */ 23150 x: number; 23151 23152 /** 23153 * Get the y of the relative position. 23154 * 23155 * @type { number } 23156 * @syscap SystemCapability.ArkUI.ArkUI.Full 23157 * @since 11 23158 */ 23159 /** 23160 * Get the y of the relative position. 23161 * 23162 * @type { number } 23163 * @syscap SystemCapability.ArkUI.ArkUI.Full 23164 * @atomicservice 23165 * @since 12 23166 */ 23167 y: number; 23168} 23169 23170/** 23171 * TextContentControllerBase 23172 * 23173 * @syscap SystemCapability.ArkUI.ArkUI.Full 23174 * @crossplatform 23175 * @since 10 23176 */ 23177/** 23178 * TextContentControllerBase 23179 * 23180 * @syscap SystemCapability.ArkUI.ArkUI.Full 23181 * @crossplatform 23182 * @atomicservice 23183 * @since 11 23184 */ 23185declare abstract class TextContentControllerBase { 23186 /** 23187 * Get the index and relative position of the CaretOffset. 23188 * 23189 * @returns { CaretOffset } index and relative position of the CaretOffset. 23190 * @syscap SystemCapability.ArkUI.ArkUI.Full 23191 * @crossplatform 23192 * @since 11 23193 */ 23194 /** 23195 * Get the index and relative position of the CaretOffset. 23196 * 23197 * @returns { CaretOffset } index and relative position of the CaretOffset. 23198 * @syscap SystemCapability.ArkUI.ArkUI.Full 23199 * @crossplatform 23200 * @atomicservice 23201 * @since 12 23202 */ 23203 getCaretOffset() : CaretOffset; 23204 23205 /** 23206 * Get the start and end positions of the text content. 23207 * 23208 * @returns { RectResult } Text content rect. 23209 * @syscap SystemCapability.ArkUI.ArkUI.Full 23210 * @crossplatform 23211 * @since 10 23212 */ 23213 /** 23214 * Get the start and end positions of the text content. 23215 * 23216 * @returns { RectResult } Text content rect. 23217 * @syscap SystemCapability.ArkUI.ArkUI.Full 23218 * @crossplatform 23219 * @atomicservice 23220 * @since 11 23221 */ 23222 getTextContentRect() : RectResult; 23223 23224 /** 23225 * Get the lines number of the text content. 23226 * 23227 * @returns { number } Text content line count 23228 * @syscap SystemCapability.ArkUI.ArkUI.Full 23229 * @crossplatform 23230 * @since 10 23231 */ 23232 /** 23233 * Get the lines number of the text content. 23234 * 23235 * @returns { number } Text content line count 23236 * @syscap SystemCapability.ArkUI.ArkUI.Full 23237 * @crossplatform 23238 * @atomicservice 23239 * @since 11 23240 */ 23241 getTextContentLineCount() : number; 23242} 23243 23244/** 23245 * Enum of scrollable containers' content clip mode. 23246 * 23247 * @enum { number } 23248 * @syscap SystemCapability.ArkUI.ArkUI.Full 23249 * @crossplatform 23250 * @atomicservice 23251 * @since 14 23252 */ 23253declare enum ContentClipMode { 23254 /** 23255 * Clip to content rect inside margin & padding. 23256 * 23257 * @syscap SystemCapability.ArkUI.ArkUI.Full 23258 * @crossplatform 23259 * @atomicservice 23260 * @since 14 23261 */ 23262 CONTENT_ONLY = 0, 23263 23264 /** 23265 * Clip to scrollable's outer rect, including padding but inside margin. 23266 * 23267 * @syscap SystemCapability.ArkUI.ArkUI.Full 23268 * @crossplatform 23269 * @atomicservice 23270 * @since 14 23271 */ 23272 BOUNDARY = 1, 23273 23274 /** 23275 * Clip to the safeArea of scrollable container. 23276 * 23277 * @syscap SystemCapability.ArkUI.ArkUI.Full 23278 * @crossplatform 23279 * @atomicservice 23280 * @since 14 23281 */ 23282 SAFE_AREA = 2, 23283} 23284 23285/** 23286 * CommonScrollableMethod 23287 * 23288 * @extends CommonMethod<T> 23289 * @syscap SystemCapability.ArkUI.ArkUI.Full 23290 * @crossplatform 23291 * @atomicservice 23292 * @since 11 23293 */ 23294/** 23295 * CommonScrollableMethod 23296 * 23297 * @extends CommonMethod<T> 23298 * @syscap SystemCapability.ArkUI.ArkUI.Full 23299 * @crossplatform 23300 * @form 23301 * @atomicservice 23302 * @since 12 23303 */ 23304declare class ScrollableCommonMethod<T> extends CommonMethod<T> { 23305 /** 23306 * Scrollbar status. 23307 * 23308 * @param { BarState } barState - Scrollbar status. 23309 * @returns { T } 23310 * @syscap SystemCapability.ArkUI.ArkUI.Full 23311 * @crossplatform 23312 * @atomicservice 23313 * @since 11 23314 */ 23315 scrollBar(barState: BarState): T; 23316 23317 /** 23318 * Color of the scrollbar. 23319 * 23320 * @param { Color | number | string } color - Color of the scrollbar. 23321 * @returns { T } 23322 * @syscap SystemCapability.ArkUI.ArkUI.Full 23323 * @crossplatform 23324 * @atomicservice 23325 * @since 11 23326 */ 23327 scrollBarColor(color: Color | number | string): T; 23328 23329 /** 23330 * Width of the scrollbar. 23331 * 23332 * @param { number | string } value - Width of the scrollbar. 23333 * @returns { T } 23334 * @syscap SystemCapability.ArkUI.ArkUI.Full 23335 * @crossplatform 23336 * @atomicservice 23337 * @since 11 23338 */ 23339 scrollBarWidth(value: number | string): T; 23340 23341 /** 23342 * Edge scrolling effect. 23343 * 23344 * @param { EdgeEffect } edgeEffect - edge scrolling effect. 23345 * @param { EdgeEffectOptions } options - edge scrolling effect options. 23346 * @returns { T } 23347 * @syscap SystemCapability.ArkUI.ArkUI.Full 23348 * @crossplatform 23349 * @atomicservice 23350 * @since 11 23351 */ 23352 edgeEffect(edgeEffect: EdgeEffect, options?: EdgeEffectOptions): T; 23353 23354 /** 23355 * Called when setting whether to enable fading Edge effect. 23356 * 23357 * @param { Optional<boolean> } enabled - Whether to turn on the edge fade effect 23358 * @param { FadingEdgeOptions } [options] - The options of fadingEdge. 23359 * @returns { T } 23360 * @syscap SystemCapability.ArkUI.ArkUI.Full 23361 * @crossplatform 23362 * @atomicservice 23363 * @since 14 23364 */ 23365 fadingEdge(enabled: Optional<boolean>, options?: FadingEdgeOptions): T; 23366 23367 /** 23368 * Nested scrolling options. 23369 * 23370 * @param { NestedScrollOptions } value - options for nested scrolling. 23371 * @returns { T } 23372 * @syscap SystemCapability.ArkUI.ArkUI.Full 23373 * @crossplatform 23374 * @atomicservice 23375 * @since 11 23376 */ 23377 nestedScroll(value: NestedScrollOptions): T; 23378 23379 /** 23380 * Whether to support scroll gestures by finger or mouse. 23381 * 23382 * @param { boolean } value - Whether to support scroll gestures by finger or mouse. 23383 * @returns { T } 23384 * @syscap SystemCapability.ArkUI.ArkUI.Full 23385 * @crossplatform 23386 * @atomicservice 23387 * @since 11 23388 */ 23389 enableScrollInteraction(value: boolean): T; 23390 23391 /** 23392 * Friction coefficient. 23393 * 23394 * @param { number | Resource } value - friction coefficient. 23395 * @returns { T } 23396 * @syscap SystemCapability.ArkUI.ArkUI.Full 23397 * @crossplatform 23398 * @atomicservice 23399 * @since 11 23400 */ 23401 friction(value: number | Resource): T; 23402 23403 /** 23404 * Called when the scrollable scrolls. 23405 * 23406 * @param { function } event - callback of scrollable, 23407 * scrollOffset is offset per frame scrolling, ScrollState is current scroll state. 23408 * @returns { T } 23409 * @syscap SystemCapability.ArkUI.ArkUI.Full 23410 * @crossplatform 23411 * @atomicservice 23412 * @since 11 23413 * @deprecated since 12 23414 * @useinstead ScrollableCommonMethod#onDidScroll 23415 */ 23416 onScroll(event: (scrollOffset: number, scrollState: ScrollState) => void): T; 23417 23418 /** 23419 * Called when the scrollable will scroll. 23420 * 23421 * @param { Optional<OnWillScrollCallback> } handler - callback of scrollable. 23422 * @returns { T } 23423 * @syscap SystemCapability.ArkUI.ArkUI.Full 23424 * @crossplatform 23425 * @atomicservice 23426 * @since 12 23427 */ 23428 onWillScroll(handler: Optional<OnWillScrollCallback>): T; 23429 23430 /** 23431 * Called when the scrollable did scroll. 23432 * 23433 * @param { OnScrollCallback } handler - callback of scrollable, 23434 * scrollOffset is offset this frame did scroll, scrollState is current scroll state. 23435 * @returns { T } 23436 * @syscap SystemCapability.ArkUI.ArkUI.Full 23437 * @crossplatform 23438 * @form 23439 * @atomicservice 23440 * @since 12 23441 */ 23442 onDidScroll(handler: OnScrollCallback): T; 23443 23444 /** 23445 * Called when the scrollable reaches the start position. 23446 * 23447 * @param { function } event - Callback function, triggered when the scrollable reaches the start position. 23448 * @returns { T } 23449 * @syscap SystemCapability.ArkUI.ArkUI.Full 23450 * @crossplatform 23451 * @atomicservice 23452 * @since 11 23453 */ 23454 onReachStart(event: () => void): T; 23455 23456 /** 23457 * Called when the scrollable reaches the end position. 23458 * 23459 * @param { function } event - Callback function, triggered when the scrollable reaches the end position. 23460 * @returns { T } 23461 * @syscap SystemCapability.ArkUI.ArkUI.Full 23462 * @crossplatform 23463 * @atomicservice 23464 * @since 11 23465 */ 23466 onReachEnd(event: () => void): T; 23467 23468 /** 23469 * Called when the scrollable starts scrolling. 23470 * 23471 * @param { function } event - Callback function, triggered when the scrollable starts scrolling. 23472 * @returns { T } 23473 * @syscap SystemCapability.ArkUI.ArkUI.Full 23474 * @crossplatform 23475 * @atomicservice 23476 * @since 11 23477 */ 23478 onScrollStart(event: () => void): T; 23479 23480 /** 23481 * Called when the scrollable stops scrolling. 23482 * 23483 * @param { function } event - Callback function, triggered when the scrollable stops scrolling. 23484 * @returns { T } 23485 * @syscap SystemCapability.ArkUI.ArkUI.Full 23486 * @crossplatform 23487 * @atomicservice 23488 * @since 11 23489 */ 23490 onScrollStop(event: () => void): T; 23491 23492 /** 23493 * Limit the max speed when fling. 23494 * 23495 * @param { number } speedLimit - Max fling speed, the minimum value is 0, the maximum value is not limited. 23496 * The unit is vp/s. 23497 * @returns { T } 23498 * @syscap SystemCapability.ArkUI.ArkUI.Full 23499 * @crossplatform 23500 * @atomicservice 23501 * @since 11 23502 */ 23503 flingSpeedLimit(speedLimit: number): T; 23504 23505 /** 23506 * Clip the content of the scrollable container, excluding background. 23507 * 23508 * @param { ContentClipMode | RectShape } clip - A value from enum ContentClipMode or a customized clip rect. 23509 * @returns { T } 23510 * @syscap SystemCapability.ArkUI.ArkUI.Full 23511 * @crossplatform 23512 * @atomicservice 23513 * @since 14 23514 */ 23515 clipContent(clip: ContentClipMode | RectShape): T; 23516} 23517 23518/** 23519 * The actual offset by which the scrollable scrolls. 23520 * @syscap SystemCapability.ArkUI.ArkUI.Full 23521 * @crossplatform 23522 * @atomicservice 23523 * @since 12 23524 */ 23525declare class ScrollResult { 23526 /** 23527 * Actual offset by which the scrollable scrolls in vp. 23528 * @type { number } 23529 * @syscap SystemCapability.ArkUI.ArkUI.Full 23530 * @crossplatform 23531 * @atomicservice 23532 * @since 12 23533 */ 23534 offsetRemain: number; 23535} 23536 23537/** 23538 * Called before scroll to allow developer to control real offset the Scrollable can scroll. 23539 * 23540 * @typedef { function } OnWillScrollCallback 23541 * @param { number } scrollOffset - offset this frame will scroll, which may or may not be reached. 23542 * @param { ScrollState } scrollState - current scroll state. 23543 * @param { ScrollSource } scrollSource - source of current scroll. 23544 * @returns { void | ScrollResult } the remain offset for the scrollable, 23545 * same as scrollOffset when no ScrollResult is returned. 23546 * @syscap SystemCapability.ArkUI.ArkUI.Full 23547 * @crossplatform 23548 * @atomicservice 23549 * @since 12 23550 */ 23551declare type OnWillScrollCallback = 23552(scrollOffset: number, scrollState: ScrollState, scrollSource: ScrollSource) => void | ScrollResult; 23553 23554/** 23555 * On scroll callback using in scrollable onDidScroll. 23556 * 23557 * @typedef { function } OnScrollCallback 23558 * @param { number } scrollOffset - offset this frame did scroll. 23559 * @param { ScrollState } scrollState - current scroll state. 23560 * @syscap SystemCapability.ArkUI.ArkUI.Full 23561 * @crossplatform 23562 * @form 23563 * @atomicservice 23564 * @since 12 23565 */ 23566declare type OnScrollCallback = (scrollOffset: number, scrollState: ScrollState) => void; 23567 23568/** 23569 * Defines the onMove callback. 23570 * 23571 * @typedef { function } OnMoveHandler 23572 * @param { number } from - Index number for moving elements. 23573 * @param { number } to - Target index number for moving elements. 23574 * @syscap SystemCapability.ArkUI.ArkUI.Full 23575 * @crossplatform 23576 * @atomicservice 23577 * @since 12 23578 */ 23579declare type OnMoveHandler = (from: number, to: number) => void 23580 23581/** 23582 * Define DynamicNode. 23583 * 23584 * @syscap SystemCapability.ArkUI.ArkUI.Full 23585 * @crossplatform 23586 * @atomicservice 23587 * @since 12 23588 */ 23589declare class DynamicNode<T> { 23590 /** 23591 * Set the move action. 23592 * 23593 * @param { Optional<OnMoveHandler> } handler 23594 * @returns { T } 23595 * @syscap SystemCapability.ArkUI.ArkUI.Full 23596 * @crossplatform 23597 * @atomicservice 23598 * @since 12 23599 */ 23600 onMove(handler: Optional<OnMoveHandler>): T 23601} 23602 23603/** 23604 * Define EdgeEffect Options. 23605 * 23606 * @interface EdgeEffectOptions 23607 * @syscap SystemCapability.ArkUI.ArkUI.Full 23608 * @crossplatform 23609 * @since 11 23610 */ 23611/** 23612 * Define EdgeEffect Options. 23613 * 23614 * @interface EdgeEffectOptions 23615 * @syscap SystemCapability.ArkUI.ArkUI.Full 23616 * @crossplatform 23617 * @atomicservice 23618 * @since 12 23619 */ 23620declare interface EdgeEffectOptions { 23621 /** 23622 * Enable Sliding effect when component does not full screen. 23623 * 23624 * @type { boolean } 23625 * @syscap SystemCapability.ArkUI.ArkUI.Full 23626 * @crossplatform 23627 * @since 11 23628 */ 23629 /** 23630 * Enable Sliding effect when component does not full screen. 23631 * 23632 * @type { boolean } 23633 * @syscap SystemCapability.ArkUI.ArkUI.Full 23634 * @crossplatform 23635 * @atomicservice 23636 * @since 12 23637 */ 23638 alwaysEnabled: boolean; 23639} 23640 23641/** 23642 * Indicates children main size. 23643 * 23644 * @syscap SystemCapability.ArkUI.ArkUI.Full 23645 * @crossplatform 23646 * @atomicservice 23647 * @since 12 23648 */ 23649declare class ChildrenMainSize { 23650 /** 23651 * Creates an instance of ChildrenMainSize. 23652 * 23653 * @param { number } childDefaultSize - default main size, in vp. If the main axis is vertical, it indicates height. 23654 * If the main axis is horizontal, it indicates width. 23655 * @throws { BusinessError } 401 - Parameter error. Possible causes: 23656 * <br> 1. Mandatory parameters are left unspecified. 23657 * <br> 2. Incorrect parameters types. 23658 * <br> 3. Parameter verification failed. 23659 * @syscap SystemCapability.ArkUI.ArkUI.Full 23660 * @crossplatform 23661 * @atomicservice 23662 * @since 12 23663 */ 23664 constructor(childDefaultSize: number); 23665 23666 /** 23667 * Set default size. 23668 * 23669 * @param { number } value - default main size, in vp. If the main axis is vertical, it indicates height. 23670 * If the main axis is horizontal, it indicates width. 23671 * @throws { BusinessError } 401 - Parameter error. Possible causes: 23672 * <br> 1. Mandatory parameters are left unspecified. 23673 * <br> 2. Incorrect parameters types. 23674 * <br> 3. Parameter verification failed. 23675 * @syscap SystemCapability.ArkUI.ArkUI.Full 23676 * @crossplatform 23677 * @atomicservice 23678 * @since 12 23679 */ 23680 set childDefaultSize(value: number); 23681 23682 /** 23683 * Get default size 23684 * 23685 * @returns { number } - default main size, in vp. If the main axis is vertical, it indicates height. 23686 * If the main axis is horizontal, it indicates width. 23687 * @syscap SystemCapability.ArkUI.ArkUI.Full 23688 * @crossplatform 23689 * @atomicservice 23690 * @since 12 23691 */ 23692 get childDefaultSize(): number; 23693 23694 /** 23695 * Changes children main size by removing or replacing existing elements and/or adding new elements in place. 23696 * 23697 * @param { number } start - Zero-based index at which to start changing the children main size. 23698 * @param { number } [deleteCount] - Indicating the number of children main size to remove from start. 23699 * @param { Array<number> } [childrenSize] - Add the new children main size, beginning from start. 23700 * @throws { BusinessError } 401 - Parameter error. Possible causes: 23701 * <br> 1. Mandatory parameters are left unspecified. 23702 * <br> 2. Incorrect parameters types. 23703 * <br> 3. Parameter verification failed. 23704 * @syscap SystemCapability.ArkUI.ArkUI.Full 23705 * @crossplatform 23706 * @atomicservice 23707 * @since 12 23708 * @example splice(1, 0, [100]), Insert a child after first child, the child's main size is 100vp. 23709 * splice(1, 1), Delete the second child. 23710 * splice(1, 2, [100, 100]), Change the main size of the second and third children to 100vp. 23711 */ 23712 splice(start: number, deleteCount?: number, childrenSize?: Array<number>): void; 23713 23714 /** 23715 * Updates main size for specified child. 23716 * 23717 * @param { number } index - index of child to be updated. 23718 * @param { number } childSize - new section options. 23719 * @throws { BusinessError } 401 - Parameter error. Possible causes: 23720 * <br> 1. Mandatory parameters are left unspecified. 23721 * <br> 2. Incorrect parameters types. 23722 * <br> 3. Parameter verification failed. 23723 * @syscap SystemCapability.ArkUI.ArkUI.Full 23724 * @crossplatform 23725 * @atomicservice 23726 * @since 12 23727 */ 23728 update(index: number, childSize: number): void; 23729} 23730 23731/** 23732 * Define BackgroundBrightness Options. 23733 * 23734 * @interface BackgroundBrightnessOptions 23735 * @syscap SystemCapability.ArkUI.ArkUI.Full 23736 * @atomicservice 23737 * @since 12 23738 */ 23739declare interface BackgroundBrightnessOptions { 23740 23741 /** 23742 * Rate represents the rate at which lightUpDegree 23743 * decreases with increasing pixel brightness. 23744 * 23745 * @type { number } -The default value is 0.0, value range: (0.0, +∞). 23746 * @syscap SystemCapability.ArkUI.ArkUI.Full 23747 * @atomicservice 23748 * @since 12 23749 */ 23750 rate: number; 23751 23752 /** 23753 * LightUpDegree represents the degree of brightness 23754 * of the rgb value changes when its brightness 23755 * is 0. 23756 * 23757 * @type { number } -The default value is 0.0, value range: [-1.0, 1.0]. 23758 * @syscap SystemCapability.ArkUI.ArkUI.Full 23759 * @atomicservice 23760 * @since 12 23761 */ 23762 lightUpDegree: number; 23763} 23764 23765/** 23766 * PointLightStyle info 23767 * 23768 * @interface PointLightStyle 23769 * @syscap SystemCapability.ArkUI.ArkUI.Full 23770 * @systemapi 23771 * @since 11 23772 */ 23773declare interface PointLightStyle { 23774 /** 23775 * Defines the PointLight light intensity and position. 23776 * 23777 * @type { ?LightSource } 23778 * @default undefined 23779 * @syscap SystemCapability.ArkUI.ArkUI.Full 23780 * @systemapi 23781 * @since 11 23782 */ 23783 lightSource?: LightSource; 23784 /** 23785 * Defines the PointLight illuminated type. 23786 * 23787 * @type { ?IlluminatedType } 23788 * @default IlluminatedType.NONE 23789 * @syscap SystemCapability.ArkUI.ArkUI.Full 23790 * @systemapi 23791 * @since 11 23792 */ 23793 illuminated?: IlluminatedType; 23794 /** 23795 * Defines the PointLight bloom. 23796 * 23797 * @type { ?number } 23798 * @default 0 23799 * @syscap SystemCapability.ArkUI.ArkUI.Full 23800 * @systemapi 23801 * @since 11 23802 */ 23803 bloom?: number; 23804} 23805 23806/** 23807 * LightSource info 23808 * 23809 * @interface LightSource 23810 * @syscap SystemCapability.ArkUI.ArkUI.Full 23811 * @systemapi 23812 * @since 11 23813 */ 23814declare interface LightSource { 23815 /** 23816 * Defines the PointLight light positionX. 23817 * 23818 * @type { Dimension } 23819 * @syscap SystemCapability.ArkUI.ArkUI.Full 23820 * @systemapi 23821 * @since 11 23822 */ 23823 positionX: Dimension; 23824 /** 23825 * Defines the PointLight light positionX. 23826 * 23827 * @type { Dimension } 23828 * @syscap SystemCapability.ArkUI.ArkUI.Full 23829 * @systemapi 23830 * @since 11 23831 */ 23832 positionY: Dimension; 23833 /** 23834 * Defines the PointLight light positionX. 23835 * 23836 * @type { Dimension } 23837 * @syscap SystemCapability.ArkUI.ArkUI.Full 23838 * @systemapi 23839 * @since 11 23840 */ 23841 positionZ: Dimension; 23842 /** 23843 * Defines the PointLight light intensity. 23844 * 23845 * @type { number } 23846 * @syscap SystemCapability.ArkUI.ArkUI.Full 23847 * @systemapi 23848 * @since 11 23849 */ 23850 intensity: number; 23851 /** 23852 * Defines the PointLight light color. 23853 * 23854 * @type { ?ResourceColor } 23855 * @syscap SystemCapability.ArkUI.ArkUI.Full 23856 * @systemapi 23857 * @since 12 23858 */ 23859 color?: ResourceColor; 23860} 23861 23862/** 23863 * Defining wrapBuilder function. 23864 * @param { function } builder 23865 * @returns { WrappedBuilder<Args> } 23866 * @syscap SystemCapability.ArkUI.ArkUI.Full 23867 * @crossplatform 23868 * @since 11 23869 */ 23870/** 23871 * Defining wrapBuilder function. 23872 * @param { function } builder 23873 * @returns { WrappedBuilder<Args> } 23874 * @syscap SystemCapability.ArkUI.ArkUI.Full 23875 * @crossplatform 23876 * @atomicservice 23877 * @since 12 23878 */ 23879declare function wrapBuilder<Args extends Object[]>(builder: (...args: Args) => void): WrappedBuilder<Args>; 23880 23881/** 23882 * Defines the WrappedBuilder class. 23883 * @syscap SystemCapability.ArkUI.ArkUI.Full 23884 * @crossplatform 23885 * @since 11 23886 */ 23887/** 23888 * Defines the WrappedBuilder class. 23889 * @syscap SystemCapability.ArkUI.ArkUI.Full 23890 * @crossplatform 23891 * @atomicservice 23892 * @since 12 23893 */ 23894declare class WrappedBuilder<Args extends Object[]> { 23895 /** 23896 * @type { function } 23897 * @syscap SystemCapability.ArkUI.ArkUI.Full 23898 * @crossplatform 23899 * @since 11 23900 */ 23901 /** 23902 * @type { function } 23903 * @syscap SystemCapability.ArkUI.ArkUI.Full 23904 * @crossplatform 23905 * @atomicservice 23906 * @since 12 23907 */ 23908 builder: (...args: Args) => void; 23909 23910 /** 23911 * @param { function } builder 23912 * @syscap SystemCapability.ArkUI.ArkUI.Full 23913 * @crossplatform 23914 * @since 11 23915 */ 23916 /** 23917 * @param { function } builder 23918 * @syscap SystemCapability.ArkUI.ArkUI.Full 23919 * @crossplatform 23920 * @atomicservice 23921 * @since 12 23922 */ 23923 constructor(builder: (...args: Args) => void); 23924} 23925 23926 23927/** 23928 * Defines the overall animation parameters of the keyframe animation. 23929 * 23930 * @interface KeyframeAnimateParam 23931 * @syscap SystemCapability.ArkUI.ArkUI.Full 23932 * @crossplatform 23933 * @since 11 23934 */ 23935/** 23936 * Defines the overall animation parameters of the keyframe animation. 23937 * 23938 * @interface KeyframeAnimateParam 23939 * @syscap SystemCapability.ArkUI.ArkUI.Full 23940 * @crossplatform 23941 * @atomicservice 23942 * @since 12 23943 */ 23944declare interface KeyframeAnimateParam { 23945 /** 23946 * Animation delay time, in ms. 23947 * 23948 * @type { ?number } 23949 * @default 0 23950 * @syscap SystemCapability.ArkUI.ArkUI.Full 23951 * @crossplatform 23952 * @since 11 23953 */ 23954 /** 23955 * Animation delay time, in ms. 23956 * 23957 * @type { ?number } 23958 * @default 0 23959 * @syscap SystemCapability.ArkUI.ArkUI.Full 23960 * @crossplatform 23961 * @atomicservice 23962 * @since 12 23963 */ 23964 delay?: number; 23965 23966 /** 23967 * Animation iterations. When set to -1, the animation playing it repeatedly. The value range is greater than or equal to -1. 23968 * 23969 * @type { ?number } 23970 * @default 1 23971 * @syscap SystemCapability.ArkUI.ArkUI.Full 23972 * @crossplatform 23973 * @since 11 23974 */ 23975 /** 23976 * Animation iterations. When set to -1, the animation playing it repeatedly. The value range is greater than or equal to -1. 23977 * 23978 * @type { ?number } 23979 * @default 1 23980 * @syscap SystemCapability.ArkUI.ArkUI.Full 23981 * @crossplatform 23982 * @atomicservice 23983 * @since 12 23984 */ 23985 iterations?: number; 23986 23987 /** 23988 * Callback invoked when the whole keyframe animation is complete or the ability is about to enter the background. 23989 * 23990 * @type { ?function } 23991 * @syscap SystemCapability.ArkUI.ArkUI.Full 23992 * @crossplatform 23993 * @since 11 23994 */ 23995 /** 23996 * Callback invoked when the whole keyframe animation is complete or the ability is about to enter the background. 23997 * 23998 * @type { ?function } 23999 * @syscap SystemCapability.ArkUI.ArkUI.Full 24000 * @crossplatform 24001 * @atomicservice 24002 * @since 12 24003 */ 24004 onFinish?: () => void; 24005} 24006 24007/** 24008 * Defines a keyframe state. 24009 * 24010 * @interface KeyframeState 24011 * @syscap SystemCapability.ArkUI.ArkUI.Full 24012 * @crossplatform 24013 * @since 11 24014 */ 24015/** 24016 * Defines a keyframe state. 24017 * 24018 * @interface KeyframeState 24019 * @syscap SystemCapability.ArkUI.ArkUI.Full 24020 * @crossplatform 24021 * @atomicservice 24022 * @since 12 24023 */ 24024declare interface KeyframeState { 24025 /** 24026 * Animation duration of this keyframe, in ms. 24027 * 24028 * @type { number } 24029 * @syscap SystemCapability.ArkUI.ArkUI.Full 24030 * @crossplatform 24031 * @since 11 24032 */ 24033 /** 24034 * Animation duration of this keyframe, in ms. 24035 * 24036 * @type { number } 24037 * @syscap SystemCapability.ArkUI.ArkUI.Full 24038 * @crossplatform 24039 * @atomicservice 24040 * @since 12 24041 */ 24042 duration: number; 24043 24044 /** 24045 * Animation curve of this keyframe. 24046 * 24047 * @type { ?(Curve | string | ICurve) } 24048 * @syscap SystemCapability.ArkUI.ArkUI.Full 24049 * @crossplatform 24050 * @since 11 24051 */ 24052 /** 24053 * Animation curve of this keyframe. 24054 * 24055 * @type { ?(Curve | string | ICurve) } 24056 * @syscap SystemCapability.ArkUI.ArkUI.Full 24057 * @crossplatform 24058 * @atomicservice 24059 * @since 12 24060 */ 24061 curve?: Curve | string | ICurve; 24062 24063 /** 24064 * The closure function to specify the terminating state of this keyframe. 24065 * 24066 * @type { function } 24067 * @syscap SystemCapability.ArkUI.ArkUI.Full 24068 * @crossplatform 24069 * @since 11 24070 */ 24071 /** 24072 * The closure function to specify the terminating state of this keyframe. 24073 * 24074 * @type { function } 24075 * @syscap SystemCapability.ArkUI.ArkUI.Full 24076 * @crossplatform 24077 * @atomicservice 24078 * @since 12 24079 */ 24080 event: () => void; 24081} 24082 24083 24084/** 24085 * Defines the basic callback. 24086 * 24087 * @typedef Callback<T, V = void> 24088 * @syscap SystemCapability.ArkUI.ArkUI.Full 24089 * @crossplatform 24090 * @atomicservice 24091 * @since 12 24092 */ 24093declare interface Callback<T, V = void> { 24094 /** 24095 * Defines the callback info. 24096 * 24097 * @param { T } data - the data will be used in the callback. 24098 * @returns { V } - Returns result of the callback. 24099 * @syscap SystemCapability.ArkUI.ArkUI.Full 24100 * @crossplatform 24101 * @atomicservice 24102 * @since 12 24103 */ 24104 (data: T): V; 24105} 24106 24107/** 24108 * Defines the callback type used in hover events. 24109 * The value of isHover indicates whether the mouse is hovering over the component. 24110 * The value of event contains information about HoverEvent. 24111 * 24112 * @typedef { function } HoverCallback 24113 * @param { boolean } isHover 24114 * @param { HoverEvent} event 24115 * @syscap SystemCapability.ArkUI.ArkUI.Full 24116 * @crossplatform 24117 * @atomicservice 24118 * @since 12 24119 */ 24120declare type HoverCallback = (isHover: boolean, event: HoverEvent) => void 24121 24122/** 24123 * Defines the callback type used in accessibility hover events. 24124 * The value of isHover indicates whether the touch is hovering over the component. 24125 * The value of event contains information about AccessibilityHoverEvent. 24126 * 24127 * @typedef { function } AccessibilityCallback 24128 * @param { boolean } isHover 24129 * @param { AccessibilityHoverEvent } event 24130 * @syscap SystemCapability.ArkUI.ArkUI.Full 24131 * @crossplatform 24132 * @atomicservice 24133 * @since 12 24134 */ 24135declare type AccessibilityCallback = (isHover: boolean, event: AccessibilityHoverEvent) => void; 24136 24137/** 24138 * Defines the options about VisibleAreaEvent. 24139 * 24140 * @interface VisibleAreaEventOptions 24141 * @syscap SystemCapability.ArkUI.ArkUI.Full 24142 * @crossplatform 24143 * @atomicservice 24144 * @since 12 24145 */ 24146declare interface VisibleAreaEventOptions { 24147 /** 24148 * Each number in ratios indicates the value of visibility ratio. Each number in the Array value range in [0, 1]. 24149 * 24150 * @type { Array<number> } 24151 * @syscap SystemCapability.ArkUI.ArkUI.Full 24152 * @crossplatform 24153 * @atomicservice 24154 * @since 12 24155 */ 24156 ratios: Array<number>; 24157 24158 /** 24159 * The value of expectedUpdateInterval indicates desired update period(ms). 24160 * 24161 * @type { ?number } 24162 * @default 1000 24163 * @syscap SystemCapability.ArkUI.ArkUI.Full 24164 * @crossplatform 24165 * @atomicservice 24166 * @since 12 24167 */ 24168 expectedUpdateInterval?: number; 24169} 24170 24171/** 24172 * Defines the callback type used in VisibleAreaChange events. 24173 * 24174 * @typedef { function } VisibleAreaChangeCallback 24175 * @param { boolean } isVisible - Indicates the ratio of the visible area to its own area compared to the last change. 24176 * It is true as the ratio increases and false as the ratio decreases. 24177 * @param { number } currentRatio - The value of currentRatio indicates the visibility ratio of the current component. 24178 * @syscap SystemCapability.ArkUI.ArkUI.Full 24179 * @crossplatform 24180 * @atomicservice 24181 * @since 12 24182 */ 24183/** 24184 * Defines the callback type used in VisibleAreaChange events. 24185 * 24186 * @typedef { function } VisibleAreaChangeCallback 24187 * @param { boolean } isExpanding - Indicates the ratio of the visible area to its own area compared to the last change. 24188 * It is true as the ratio increases and false as the ratio decreases. 24189 * @param { number } currentRatio - The value of currentRatio indicates the visibility ratio of the current component. 24190 * @syscap SystemCapability.ArkUI.ArkUI.Full 24191 * @crossplatform 24192 * @atomicservice 24193 * @since 13 24194 */ 24195declare type VisibleAreaChangeCallback = (isExpanding: boolean, currentRatio: number) => void; 24196 24197/** 24198 * Defines a UICommonEvent which is used to set different common event to target component. 24199 * 24200 * @interface UICommonEvent 24201 * @syscap SystemCapability.ArkUI.ArkUI.Full 24202 * @crossplatform 24203 * @atomicservice 24204 * @since 12 24205 */ 24206declare interface UICommonEvent { 24207 /** 24208 * Set or reset the callback which will be triggered a click event when clicked. 24209 * 24210 * @param { Callback<ClickEvent> | undefined } callback - The callback about the click event. If set undefined will reset the target callback. 24211 * @syscap SystemCapability.ArkUI.ArkUI.Full 24212 * @crossplatform 24213 * @atomicservice 24214 * @since 12 24215 */ 24216 setOnClick(callback: Callback<ClickEvent> | undefined): void; 24217 24218 /** 24219 * Set or reset the callback which will be triggered a touch event when touched. 24220 * 24221 * @param { Callback<TouchEvent> | undefined } callback - The callback about the touch event. If set undefined will reset the target callback. 24222 * @syscap SystemCapability.ArkUI.ArkUI.Full 24223 * @crossplatform 24224 * @atomicservice 24225 * @since 12 24226 */ 24227 setOnTouch(callback: Callback<TouchEvent> | undefined): void; 24228 24229 /** 24230 * Set or reset the callback is triggered when a component mounts a display. 24231 * 24232 * @param { Callback<void> | undefined } callback - The callback will be triggered when a component mounts a display. If set undefined will reset the target callback. 24233 * @syscap SystemCapability.ArkUI.ArkUI.Full 24234 * @crossplatform 24235 * @atomicservice 24236 * @since 12 24237 */ 24238 setOnAppear(callback: Callback<void> | undefined): void; 24239 24240 /** 24241 * Set or reset the callback is triggered when component uninstallation disappears. 24242 * 24243 * @param { Callback<void> | undefined } callback - The callback will be triggered when component uninstallation disappears. If set undefined will reset the target callback. 24244 * @syscap SystemCapability.ArkUI.ArkUI.Full 24245 * @crossplatform 24246 * @atomicservice 24247 * @since 12 24248 */ 24249 setOnDisappear(callback: Callback<void> | undefined): void; 24250 24251 24252 /** 24253 * Set or reset the callback is triggered when component has keyboard input. 24254 * 24255 * @param { Callback<KeyEvent> | undefined } callback - The callback will be triggered when has keyboard input. If set undefined will reset the target callback. 24256 * @syscap SystemCapability.ArkUI.ArkUI.Full 24257 * @crossplatform 24258 * @atomicservice 24259 * @since 12 24260 */ 24261 setOnKeyEvent(callback: Callback<KeyEvent> | undefined): void; 24262 24263 /** 24264 * Set or reset the callback which is triggered when component get focus. 24265 * 24266 * @param { Callback<void> | undefined } callback - The callback will be triggered when a component get focus. If set undefined will reset the target callback. 24267 * @syscap SystemCapability.ArkUI.ArkUI.Full 24268 * @crossplatform 24269 * @atomicservice 24270 * @since 12 24271 */ 24272 setOnFocus(callback: Callback<void> | undefined): void; 24273 24274 /** 24275 * Set or reset the callback which is triggered when lose focus. 24276 * 24277 * @param { Callback<void> | undefined } callback - The callback will be triggered when a component lose focus. If set undefined will reset the target callback. 24278 * @syscap SystemCapability.ArkUI.ArkUI.Full 24279 * @crossplatform 24280 * @atomicservice 24281 * @since 12 24282 */ 24283 setOnBlur(callback: Callback<void> | undefined): void; 24284 24285 /** 24286 * Set or reset the callback which is triggered when has a hover event. 24287 * 24288 * @param { HoverCallback | undefined } callback - The callback will be triggered when has a hover event. If set undefined will reset the target callback. 24289 * @syscap SystemCapability.ArkUI.ArkUI.Full 24290 * @crossplatform 24291 * @atomicservice 24292 * @since 12 24293 */ 24294 setOnHover(callback: HoverCallback | undefined): void; 24295 24296 /** 24297 * Set or reset the callback which is triggered when has a mouse event. 24298 * 24299 * @param { Callback<MouseEvent> | undefined } callback - The callback will be triggered when has mouse input. If set undefined will reset the target callback. 24300 * @syscap SystemCapability.ArkUI.ArkUI.Full 24301 * @crossplatform 24302 * @atomicservice 24303 * @since 12 24304 */ 24305 setOnMouse(callback: Callback<MouseEvent> | undefined): void; 24306 24307 /** 24308 * Set or reset the callback which is triggered when the size of component changed. 24309 * 24310 * @param { SizeChangeCallback | undefined } callback - The callback will be triggered when the size of component changed. If set undefined will reset the target callback. 24311 * @syscap SystemCapability.ArkUI.ArkUI.Full 24312 * @crossplatform 24313 * @atomicservice 24314 * @since 12 24315 */ 24316 setOnSizeChange(callback: SizeChangeCallback | undefined): void; 24317 24318 /** 24319 * Set or reset the callback which is triggered when the visibleArea of component changed. 24320 * 24321 * @param { VisibleAreaEventOptions } options - The options for the visibility event. 24322 * @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. 24323 * If set undefined will reset the target callback. 24324 * @syscap SystemCapability.ArkUI.ArkUI.Full 24325 * @crossplatform 24326 * @atomicservice 24327 * @since 12 24328 */ 24329 setOnVisibleAreaApproximateChange(options: VisibleAreaEventOptions, event: VisibleAreaChangeCallback | undefined): void; 24330} 24331 24332/** 24333 * Defines a UIGestureEvent which is used to set different gestures to target component. 24334 * 24335 * @interface UIGestureEvent 24336 * @syscap SystemCapability.ArkUI.ArkUI.Full 24337 * @crossplatform 24338 * @atomicservice 24339 * @since 12 24340 */ 24341declare interface UIGestureEvent { 24342 /** 24343 * Add a gesture bound to the component. 24344 * 24345 * @param { GestureHandler<T> } gesture - gesture indicates the gesture bound to a component. 24346 * @param { GesturePriority } priority - priority indicates the gesture's priority. 24347 * @param { GestureMask } mask - mask indicates the gesture's GestureMask value. 24348 * @syscap SystemCapability.ArkUI.ArkUI.Full 24349 * @crossplatform 24350 * @atomicservice 24351 * @since 12 24352 */ 24353 addGesture<T>(gesture: GestureHandler<T>, priority?: GesturePriority, mask?: GestureMask): void; 24354 24355 /** 24356 * Add a parallel gesture bound to the component. 24357 * 24358 * @param { GestureHandler<T> } gesture - gesture indicates the gesture bound to a component. 24359 * @param { GestureMask } mask - mask indicates the gesture's GestureMask value. 24360 * @syscap SystemCapability.ArkUI.ArkUI.Full 24361 * @crossplatform 24362 * @atomicservice 24363 * @since 12 24364 */ 24365 addParallelGesture<T>(gesture: GestureHandler<T>, mask?: GestureMask): void; 24366 24367 /** 24368 * Remove the gesture that is bound to the component and marked as tag. 24369 * 24370 * @param { string } tag - tag indicates the gesture's tag. 24371 * @syscap SystemCapability.ArkUI.ArkUI.Full 24372 * @crossplatform 24373 * @atomicservice 24374 * @since 12 24375 */ 24376 removeGestureByTag(tag: string): void; 24377 24378 /** 24379 * Clear gestures bound to the component. 24380 * 24381 * @syscap SystemCapability.ArkUI.ArkUI.Full 24382 * @crossplatform 24383 * @atomicservice 24384 * @since 12 24385 */ 24386 clearGestures(): void; 24387} 24388 24389/** 24390 * Defines the gesture modifier. 24391 * 24392 * @interface GestureModifier 24393 * @syscap SystemCapability.ArkUI.ArkUI.Full 24394 * @crossplatform 24395 * @atomicservice 24396 * @since 12 24397 */ 24398declare interface GestureModifier { 24399 /** 24400 * Defines the gesture update function. 24401 * 24402 * @param { UIGestureEvent } event 24403 * @syscap SystemCapability.ArkUI.ArkUI.Full 24404 * @crossplatform 24405 * @atomicservice 24406 * @since 12 24407 */ 24408 applyGesture(event: UIGestureEvent): void; 24409} 24410 24411/** 24412 * Defines the selection options. 24413 * 24414 * @interface SelectionOptions 24415 * @syscap SystemCapability.ArkUI.ArkUI.Full 24416 * @crossplatform 24417 * @atomicservice 24418 * @since 12 24419 */ 24420declare interface SelectionOptions { 24421 /** 24422 * Menu pop-up policy. 24423 * 24424 * @type { ?MenuPolicy } 24425 * @syscap SystemCapability.ArkUI.ArkUI.Full 24426 * @crossplatform 24427 * @atomicservice 24428 * @since 12 24429 */ 24430 menuPolicy?: MenuPolicy; 24431} 24432 24433/** 24434 * enum keyboard avoid mode 24435 * 24436 * @enum { number } 24437 * @syscap SystemCapability.ArkUI.ArkUI.Full 24438 * @crossplatform 24439 * @atomicservice 24440 * @since 12 24441 */ 24442declare enum KeyboardAvoidMode { 24443 /** 24444 * Defines avoid keyboard when keyboard shows. 24445 * 24446 * @syscap SystemCapability.ArkUI.ArkUI.Full 24447 * @crossplatform 24448 * @atomicservice 24449 * @since 12 24450 */ 24451 DEFAULT = 0, 24452 24453 /** 24454 * Defines not avoid keyboard when keyboard shows. 24455 * 24456 * @syscap SystemCapability.ArkUI.ArkUI.Full 24457 * @crossplatform 24458 * @atomicservice 24459 * @since 12 24460 */ 24461 NONE = 1, 24462} 24463 24464/** 24465 * Enumerates the type of area in hover mode. 24466 * 24467 * @enum { number } 24468 * @syscap SystemCapability.ArkUI.ArkUI.Full 24469 * @crossplatform 24470 * @atomicservice 24471 * @since 14 24472 */ 24473declare enum HoverModeAreaType { 24474 24475 /** 24476 * Layout top half screen when the phone in hover mode. 24477 * 24478 * @syscap SystemCapability.ArkUI.ArkUI.Full 24479 * @crossplatform 24480 * @atomicservice 24481 * @since 14 24482 */ 24483 TOP_SCREEN = 0, 24484 24485 /** 24486 * Layout bottom half screen when the phone in hover mode. 24487 * 24488 * @syscap SystemCapability.ArkUI.ArkUI.Full 24489 * @crossplatform 24490 * @atomicservice 24491 * @since 14 24492 */ 24493 BOTTOM_SCREEN = 1, 24494} 24495