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 data type of the interface restriction. 23 * 24 * @typedef { import('../api/global/resource').Resource } Resource 25 * @interface Resource 26 * @syscap SystemCapability.ArkUI.ArkUI.Full 27 * @since 7 28 */ 29/** 30 * Defines the data type of the interface restriction. 31 * 32 * @typedef { import('../api/global/resource').Resource } Resource 33 * @interface Resource 34 * @syscap SystemCapability.ArkUI.ArkUI.Full 35 * @form 36 * @since 9 37 */ 38/** 39 * Defines the data type of the interface restriction. 40 * 41 * @typedef { import('../api/global/resource').Resource } Resource 42 * @syscap SystemCapability.ArkUI.ArkUI.Full 43 * @crossplatform 44 * @form 45 * @since 10 46 */ 47/** 48 * Defines the data type of the interface restriction. 49 * 50 * @typedef { import('../api/global/resource').Resource } Resource 51 * @syscap SystemCapability.ArkUI.ArkUI.Full 52 * @crossplatform 53 * @form 54 * @atomicservice 55 * @since 11 56 */ 57declare type Resource = import('../api/global/resource').Resource; 58 59/** 60 * Defines the length property with string, number and resource unit. 61 * 62 * @typedef { string | number | Resource } Length 63 * @syscap SystemCapability.ArkUI.ArkUI.Full 64 * @since 7 65 */ 66/** 67 * Defines the length property with string, number and resource unit. 68 * 69 * @typedef { string | number | Resource } Length 70 * @syscap SystemCapability.ArkUI.ArkUI.Full 71 * @form 72 * @since 9 73 */ 74/** 75 * Defines the length property with string, number and resource unit. 76 * 77 * @typedef { string | number | Resource } Length 78 * @syscap SystemCapability.ArkUI.ArkUI.Full 79 * @crossplatform 80 * @form 81 * @since 10 82 */ 83/** 84 * Defines the length property with string, number and resource unit. 85 * 86 * @typedef { string | number | Resource } Length 87 * @syscap SystemCapability.ArkUI.ArkUI.Full 88 * @crossplatform 89 * @form 90 * @atomicservice 91 * @since 11 92 */ 93declare type Length = string | number | Resource; 94 95/** 96 * Defines the length property with number in units of px. 97 * 98 * @typedef { `${number}px` } PX 99 * @syscap SystemCapability.ArkUI.ArkUI.Full 100 * @since 10 101 */ 102/** 103 * Defines the length property with number in units of px. 104 * 105 * @typedef { `${number}px` } PX 106 * @syscap SystemCapability.ArkUI.ArkUI.Full 107 * @atomicservice 108 * @since 11 109 */ 110/** 111 * Defines the length property with number in units of px. 112 * 113 * @typedef { `${number}px` } PX 114 * @syscap SystemCapability.ArkUI.ArkUI.Full 115 * @crossplatform 116 * @atomicservice 117 * @since 18 118 */ 119declare type PX = `${number}px`; 120 121/** 122 * Defines the length property with number or number in units of vp. 123 * 124 * @typedef { `${number}vp` | number } VP 125 * @syscap SystemCapability.ArkUI.ArkUI.Full 126 * @since 10 127 */ 128/** 129 * Defines the length property with number or number in units of vp. 130 * 131 * @typedef { `${number}vp` | number } VP 132 * @syscap SystemCapability.ArkUI.ArkUI.Full 133 * @atomicservice 134 * @since 11 135 */ 136/** 137 * Defines the length property with number or number in units of vp. 138 * 139 * @typedef { `${number}vp` | number } VP 140 * @syscap SystemCapability.ArkUI.ArkUI.Full 141 * @crossplatform 142 * @atomicservice 143 * @since 18 144 */ 145declare type VP = `${number}vp` | number; 146 147/** 148 * Defines the length property with number in units of fp. 149 * 150 * @typedef { `${number}fp` } FP 151 * @syscap SystemCapability.ArkUI.ArkUI.Full 152 * @since 10 153 */ 154/** 155 * Defines the length property with number in units of fp. 156 * 157 * @typedef { `${number}fp` } FP 158 * @syscap SystemCapability.ArkUI.ArkUI.Full 159 * @atomicservice 160 * @since 11 161 */ 162/** 163 * Defines the length property with number in units of fp. 164 * 165 * @typedef { `${number}fp` } FP 166 * @syscap SystemCapability.ArkUI.ArkUI.Full 167 * @crossplatform 168 * @atomicservice 169 * @since 18 170 */ 171declare type FP = `${number}fp`; 172 173/** 174 * Defines the length property with number in units of lpx. 175 * 176 * @typedef { `${number}lpx` } LPX 177 * @syscap SystemCapability.ArkUI.ArkUI.Full 178 * @since 10 179 */ 180/** 181 * Defines the length property with number in units of lpx. 182 * 183 * @typedef { `${number}lpx` } LPX 184 * @syscap SystemCapability.ArkUI.ArkUI.Full 185 * @atomicservice 186 * @since 11 187 */ 188/** 189 * Defines the length property with number in units of lpx. 190 * 191 * @typedef { `${number}lpx` } LPX 192 * @syscap SystemCapability.ArkUI.ArkUI.Full 193 * @crossplatform 194 * @atomicservice 195 * @since 18 196 */ 197declare type LPX = `${number}lpx`; 198 199/** 200 * Defines the length property with number in units of Percentage. 201 * 202 * @typedef { `${number}%` } Percentage 203 * @syscap SystemCapability.ArkUI.ArkUI.Full 204 * @since 10 205 */ 206/** 207 * Defines the length property with number in units of Percentage. 208 * 209 * @typedef { `${number}%` } Percentage 210 * @syscap SystemCapability.ArkUI.ArkUI.Full 211 * @atomicservice 212 * @since 11 213 */ 214/** 215 * Defines the length property with number in units of Percentage. 216 * 217 * @typedef { `${number}%` } Percentage 218 * @syscap SystemCapability.ArkUI.ArkUI.Full 219 * @crossplatform 220 * @atomicservice 221 * @since 18 222 */ 223declare type Percentage = `${number}%`; 224 225/** 226 * Defines the angle property with number in units of deg. 227 * 228 * @typedef { `${number}deg` } Degree 229 * @syscap SystemCapability.ArkUI.ArkUI.Full 230 * @since 10 231 */ 232/** 233 * Defines the angle property with number in units of deg. 234 * 235 * @typedef { `${number}deg` } Degree 236 * @syscap SystemCapability.ArkUI.ArkUI.Full 237 * @atomicservice 238 * @since 11 239 */ 240declare type Degree = `${number}deg`; 241 242/** 243 * Defines the dimension property with number with units(vp|px|fp|lpx|%), and resource. 244 * 245 * @typedef { PX | VP | FP | LPX | Percentage | Resource } Dimension 246 * @syscap SystemCapability.ArkUI.ArkUI.Full 247 * @since 10 248 */ 249/** 250 * Defines the dimension property with number with units(vp|px|fp|lpx|%), and resource. 251 * 252 * @typedef { PX | VP | FP | LPX | Percentage | Resource } Dimension 253 * @syscap SystemCapability.ArkUI.ArkUI.Full 254 * @atomicservice 255 * @since 11 256 */ 257/** 258 * Defines the dimension property with number with units(vp|px|fp|lpx|%), and resource. 259 * 260 * @typedef { PX | VP | FP | LPX | Percentage | Resource } Dimension 261 * @syscap SystemCapability.ArkUI.ArkUI.Full 262 * @crossplatform 263 * @atomicservice 264 * @since 18 265 */ 266declare type Dimension = PX | VP | FP | LPX | Percentage | Resource; 267 268/** 269 * Defines the string which can use resource. 270 * 271 * @typedef { string | Resource } ResourceStr 272 * @syscap SystemCapability.ArkUI.ArkUI.Full 273 * @since 7 274 */ 275/** 276 * Defines the string which can use resource. 277 * 278 * @typedef { string | Resource } ResourceStr 279 * @syscap SystemCapability.ArkUI.ArkUI.Full 280 * @form 281 * @since 9 282 */ 283/** 284 * Defines the string which can use resource. 285 * 286 * @typedef { string | Resource } ResourceStr 287 * @syscap SystemCapability.ArkUI.ArkUI.Full 288 * @crossplatform 289 * @form 290 * @since 10 291 */ 292/** 293 * Defines the string which can use resource. 294 * 295 * @typedef { string | Resource } ResourceStr 296 * @syscap SystemCapability.ArkUI.ArkUI.Full 297 * @crossplatform 298 * @form 299 * @atomicservice 300 * @since 11 301 */ 302declare type ResourceStr = string | Resource; 303 304/** 305 * Defines the padding property. 306 * 307 * @syscap SystemCapability.ArkUI.ArkUI.Full 308 * @since 7 309 */ 310/** 311 * Defines the padding property. 312 * 313 * @syscap SystemCapability.ArkUI.ArkUI.Full 314 * @form 315 * @since 9 316 */ 317/** 318 * Defines the padding property. 319 * 320 * @syscap SystemCapability.ArkUI.ArkUI.Full 321 * @crossplatform 322 * @form 323 * @since 10 324 */ 325/** 326 * Defines the padding property. 327 * 328 * @typedef { object } Padding 329 * @syscap SystemCapability.ArkUI.ArkUI.Full 330 * @crossplatform 331 * @form 332 * @atomicservice 333 * @since 11 334 */ 335declare type Padding = { 336 /** 337 * top property. 338 * 339 * @type { ?Length } 340 * @syscap SystemCapability.ArkUI.ArkUI.Full 341 * @since 7 342 */ 343 /** 344 * top property. 345 * 346 * @type { ?Length } 347 * @syscap SystemCapability.ArkUI.ArkUI.Full 348 * @since 9 349 * @form 350 */ 351 /** 352 * top property. 353 * 354 * @type { ?Length } 355 * @syscap SystemCapability.ArkUI.ArkUI.Full 356 * @crossplatform 357 * @since 10 358 * @form 359 */ 360 /** 361 * top property. 362 * 363 * @type { ?Length } 364 * @syscap SystemCapability.ArkUI.ArkUI.Full 365 * @crossplatform 366 * @atomicservice 367 * @since 11 368 * @form 369 */ 370 top?: Length; 371 372 /** 373 * right property. 374 * 375 * @type { ?Length } 376 * @syscap SystemCapability.ArkUI.ArkUI.Full 377 * @since 7 378 */ 379 /** 380 * right property. 381 * 382 * @type { ?Length } 383 * @syscap SystemCapability.ArkUI.ArkUI.Full 384 * @since 9 385 * @form 386 */ 387 /** 388 * right property. 389 * 390 * @type { ?Length } 391 * @syscap SystemCapability.ArkUI.ArkUI.Full 392 * @crossplatform 393 * @since 10 394 * @form 395 */ 396 /** 397 * right property. 398 * 399 * @type { ?Length } 400 * @syscap SystemCapability.ArkUI.ArkUI.Full 401 * @crossplatform 402 * @atomicservice 403 * @since 11 404 * @form 405 */ 406 right?: Length; 407 408 /** 409 * bottom property. 410 * 411 * @type { ?Length } 412 * @syscap SystemCapability.ArkUI.ArkUI.Full 413 * @since 7 414 */ 415 /** 416 * bottom property. 417 * 418 * @type { ?Length } 419 * @syscap SystemCapability.ArkUI.ArkUI.Full 420 * @since 9 421 * @form 422 */ 423 /** 424 * bottom property. 425 * 426 * @type { ?Length } 427 * @syscap SystemCapability.ArkUI.ArkUI.Full 428 * @crossplatform 429 * @since 10 430 * @form 431 */ 432 /** 433 * bottom property. 434 * 435 * @type { ?Length } 436 * @syscap SystemCapability.ArkUI.ArkUI.Full 437 * @crossplatform 438 * @atomicservice 439 * @since 11 440 * @form 441 */ 442 bottom?: Length; 443 444 /** 445 * left property. 446 * 447 * @type { ?Length } 448 * @syscap SystemCapability.ArkUI.ArkUI.Full 449 * @since 7 450 */ 451 /** 452 * left property. 453 * 454 * @type { ?Length } 455 * @syscap SystemCapability.ArkUI.ArkUI.Full 456 * @since 9 457 * @form 458 */ 459 /** 460 * left property. 461 * 462 * @type { ?Length } 463 * @syscap SystemCapability.ArkUI.ArkUI.Full 464 * @crossplatform 465 * @since 10 466 * @form 467 */ 468 /** 469 * left property. 470 * 471 * @type { ?Length } 472 * @syscap SystemCapability.ArkUI.ArkUI.Full 473 * @crossplatform 474 * @atomicservice 475 * @since 11 476 * @form 477 */ 478 left?: Length; 479}; 480 481/** 482 * Defines the localized padding property. 483 * 484 * @interface LocalizedPadding 485 * @syscap SystemCapability.ArkUI.ArkUI.Full 486 * @crossplatform 487 * @form 488 * @atomicservice 489 * @since 12 490 */ 491declare interface LocalizedPadding { 492 /** 493 * top property. 494 * 495 * @type { ?LengthMetrics } 496 * @syscap SystemCapability.ArkUI.ArkUI.Full 497 * @crossplatform 498 * @form 499 * @atomicservice 500 * @since 12 501 */ 502 top?: LengthMetrics; 503 504 /** 505 * end property. 506 * 507 * @type { ?LengthMetrics } 508 * @syscap SystemCapability.ArkUI.ArkUI.Full 509 * @crossplatform 510 * @form 511 * @atomicservice 512 * @since 12 513 */ 514 end?: LengthMetrics; 515 516 /** 517 * bottom property. 518 * 519 * @type { ?LengthMetrics } 520 * @syscap SystemCapability.ArkUI.ArkUI.Full 521 * @crossplatform 522 * @form 523 * @atomicservice 524 * @since 12 525 */ 526 bottom?: LengthMetrics; 527 528 /** 529 * start property. 530 * 531 * @type { ?LengthMetrics } 532 * @syscap SystemCapability.ArkUI.ArkUI.Full 533 * @crossplatform 534 * @form 535 * @atomicservice 536 * @since 12 537 */ 538 start?: LengthMetrics; 539}; 540 541/** 542 * Defines the margin property. 543 * 544 * @typedef { Padding } Margin 545 * @syscap SystemCapability.ArkUI.ArkUI.Full 546 * @since 7 547 */ 548/** 549 * Defines the margin property. 550 * 551 * @typedef { Padding } Margin 552 * @syscap SystemCapability.ArkUI.ArkUI.Full 553 * @form 554 * @since 9 555 */ 556/** 557 * Defines the margin property. 558 * 559 * @typedef { Padding } Margin 560 * @syscap SystemCapability.ArkUI.ArkUI.Full 561 * @crossplatform 562 * @form 563 * @since 10 564 */ 565/** 566 * Defines the margin property. 567 * 568 * @typedef { Padding } Margin 569 * @syscap SystemCapability.ArkUI.ArkUI.Full 570 * @crossplatform 571 * @form 572 * @atomicservice 573 * @since 11 574 */ 575declare type Margin = Padding; 576 577/** 578 * Defines the border width property. 579 * 580 * @typedef { EdgeWidths } EdgeWidth 581 * @syscap SystemCapability.ArkUI.ArkUI.Full 582 * @crossplatform 583 * @since 10 584 */ 585/** 586 * Defines the border width property. 587 * 588 * @typedef { EdgeWidths } EdgeWidth 589 * @syscap SystemCapability.ArkUI.ArkUI.Full 590 * @crossplatform 591 * @atomicservice 592 * @since 11 593 */ 594declare type EdgeWidth = EdgeWidths; 595 596/** 597 * Defines the border width property. 598 * 599 * @typedef { object } EdgeWidths 600 * @syscap SystemCapability.ArkUI.ArkUI.Full 601 * @form 602 * @since 9 603 */ 604/** 605 * Defines the border width property. 606 * 607 * @typedef { object } EdgeWidths 608 * @syscap SystemCapability.ArkUI.ArkUI.Full 609 * @crossplatform 610 * @form 611 * @since 10 612 */ 613/** 614 * Defines the border width property. 615 * 616 * @typedef { object } EdgeWidths 617 * @syscap SystemCapability.ArkUI.ArkUI.Full 618 * @crossplatform 619 * @form 620 * @atomicservice 621 * @since 11 622 */ 623declare type EdgeWidths = { 624 /** 625 * top property. 626 * 627 * @type { ?Length } 628 * @syscap SystemCapability.ArkUI.ArkUI.Full 629 * @since 9 630 * @form 631 */ 632 /** 633 * top property. 634 * 635 * @type { ?Length } 636 * @syscap SystemCapability.ArkUI.ArkUI.Full 637 * @crossplatform 638 * @since 10 639 * @form 640 */ 641 /** 642 * top property. 643 * 644 * @type { ?Length } 645 * @syscap SystemCapability.ArkUI.ArkUI.Full 646 * @crossplatform 647 * @atomicservice 648 * @since 11 649 * @form 650 */ 651 top?: Length; 652 653 /** 654 * right property. 655 * 656 * @type { ?Length } 657 * @syscap SystemCapability.ArkUI.ArkUI.Full 658 * @since 9 659 * @form 660 */ 661 /** 662 * right property. 663 * 664 * @type { ?Length } 665 * @syscap SystemCapability.ArkUI.ArkUI.Full 666 * @crossplatform 667 * @since 10 668 * @form 669 */ 670 /** 671 * right property. 672 * 673 * @type { ?Length } 674 * @syscap SystemCapability.ArkUI.ArkUI.Full 675 * @crossplatform 676 * @atomicservice 677 * @since 11 678 * @form 679 */ 680 right?: Length; 681 682 /** 683 * bottom property. 684 * 685 * @type { ?Length } 686 * @syscap SystemCapability.ArkUI.ArkUI.Full 687 * @since 9 688 * @form 689 */ 690 /** 691 * bottom property. 692 * 693 * @type { ?Length } 694 * @syscap SystemCapability.ArkUI.ArkUI.Full 695 * @crossplatform 696 * @since 10 697 * @form 698 */ 699 /** 700 * bottom property. 701 * 702 * @type { ?Length } 703 * @syscap SystemCapability.ArkUI.ArkUI.Full 704 * @crossplatform 705 * @atomicservice 706 * @since 11 707 * @form 708 */ 709 bottom?: Length; 710 711 /** 712 * left property. 713 * 714 * @type { ?Length } 715 * @syscap SystemCapability.ArkUI.ArkUI.Full 716 * @since 9 717 * @form 718 */ 719 /** 720 * left property. 721 * 722 * @type { ?Length } 723 * @syscap SystemCapability.ArkUI.ArkUI.Full 724 * @crossplatform 725 * @since 10 726 * @form 727 */ 728 /** 729 * left property. 730 * 731 * @type { ?Length } 732 * @syscap SystemCapability.ArkUI.ArkUI.Full 733 * @crossplatform 734 * @atomicservice 735 * @since 11 736 * @form 737 */ 738 left?: Length; 739}; 740 741/** 742 * Defines the localized border width property. 743 * 744 * @interface LocalizedEdgeWidths 745 * @syscap SystemCapability.ArkUI.ArkUI.Full 746 * @crossplatform 747 * @form 748 * @atomicservice 749 * @since 12 750 */ 751declare interface LocalizedEdgeWidths { 752 /** 753 * top property. 754 * 755 * @type { ?LengthMetrics } 756 * @syscap SystemCapability.ArkUI.ArkUI.Full 757 * @crossplatform 758 * @form 759 * @atomicservice 760 * @since 12 761 */ 762 top?: LengthMetrics; 763 764 /** 765 * end property. 766 * 767 * @type { ?LengthMetrics } 768 * @syscap SystemCapability.ArkUI.ArkUI.Full 769 * @crossplatform 770 * @form 771 * @atomicservice 772 * @since 12 773 */ 774 end?: LengthMetrics; 775 776 /** 777 * bottom property. 778 * 779 * @type { ?LengthMetrics } 780 * @syscap SystemCapability.ArkUI.ArkUI.Full 781 * @crossplatform 782 * @form 783 * @atomicservice 784 * @since 12 785 */ 786 bottom?: LengthMetrics; 787 788 /** 789 * start property. 790 * 791 * @type { ?LengthMetrics } 792 * @syscap SystemCapability.ArkUI.ArkUI.Full 793 * @crossplatform 794 * @form 795 * @atomicservice 796 * @since 12 797 */ 798 start?: LengthMetrics; 799}; 800 801/** 802 * Defines the outline width property. 803 * 804 * @syscap SystemCapability.ArkUI.ArkUI.Full 805 * @crossplatform 806 * @form 807 * @since 11 808 */ 809/** 810 * Defines the outline width property. 811 * 812 * @typedef { object } EdgeOutlineWidths 813 * @syscap SystemCapability.ArkUI.ArkUI.Full 814 * @crossplatform 815 * @form 816 * @atomicservice 817 * @since 12 818 */ 819declare type EdgeOutlineWidths = { 820 /** 821 * top outline width property. 822 * 823 * @type { ?Dimension } 824 * @syscap SystemCapability.ArkUI.ArkUI.Full 825 * @crossplatform 826 * @since 11 827 * @form 828 */ 829 /** 830 * top outline width property. 831 * 832 * @type { ?Dimension } 833 * @syscap SystemCapability.ArkUI.ArkUI.Full 834 * @crossplatform 835 * @form 836 * @atomicservice 837 * @since 12 838 */ 839 top?: Dimension; 840 841 /** 842 * right outline width property. 843 * 844 * @type { ?Dimension } 845 * @syscap SystemCapability.ArkUI.ArkUI.Full 846 * @crossplatform 847 * @since 11 848 * @form 849 */ 850 /** 851 * right outline width property. 852 * 853 * @type { ?Dimension } 854 * @syscap SystemCapability.ArkUI.ArkUI.Full 855 * @crossplatform 856 * @form 857 * @atomicservice 858 * @since 12 859 */ 860 right?: Dimension; 861 862 /** 863 * bottom outline width property. 864 * 865 * @type { ?Dimension } 866 * @syscap SystemCapability.ArkUI.ArkUI.Full 867 * @crossplatform 868 * @since 11 869 * @form 870 */ 871 /** 872 * bottom outline width property. 873 * 874 * @type { ?Dimension } 875 * @syscap SystemCapability.ArkUI.ArkUI.Full 876 * @crossplatform 877 * @form 878 * @atomicservice 879 * @since 12 880 */ 881 bottom?: Dimension; 882 883 /** 884 * left outline width property. 885 * 886 * @type { ?Dimension } 887 * @syscap SystemCapability.ArkUI.ArkUI.Full 888 * @crossplatform 889 * @since 11 890 * @form 891 */ 892 /** 893 * left outline width property. 894 * 895 * @type { ?Dimension } 896 * @syscap SystemCapability.ArkUI.ArkUI.Full 897 * @crossplatform 898 * @form 899 * @atomicservice 900 * @since 12 901 */ 902 left?: Dimension; 903}; 904 905/** 906 * Defines the border radius property. 907 * 908 * @typedef { object } BorderRadiuses 909 * @syscap SystemCapability.ArkUI.ArkUI.Full 910 * @form 911 * @since 9 912 */ 913/** 914 * Defines the border radius property. 915 * 916 * @typedef { object } BorderRadiuses 917 * @syscap SystemCapability.ArkUI.ArkUI.Full 918 * @crossplatform 919 * @form 920 * @since 10 921 */ 922/** 923 * Defines the border radius property. 924 * 925 * @typedef { object } BorderRadiuses 926 * @syscap SystemCapability.ArkUI.ArkUI.Full 927 * @crossplatform 928 * @form 929 * @atomicservice 930 * @since 11 931 */ 932declare type BorderRadiuses = { 933 /** 934 * top-left property. 935 * 936 * @type { ?Length } 937 * @syscap SystemCapability.ArkUI.ArkUI.Full 938 * @since 9 939 * @form 940 */ 941 /** 942 * top-left property. 943 * 944 * @type { ?Length } 945 * @syscap SystemCapability.ArkUI.ArkUI.Full 946 * @crossplatform 947 * @since 10 948 * @form 949 */ 950 /** 951 * top-left property. 952 * 953 * @type { ?Length } 954 * @syscap SystemCapability.ArkUI.ArkUI.Full 955 * @crossplatform 956 * @atomicservice 957 * @since 11 958 * @form 959 */ 960 topLeft?: Length; 961 962 /** 963 * top-right property. 964 * 965 * @type { ?Length } 966 * @syscap SystemCapability.ArkUI.ArkUI.Full 967 * @since 9 968 * @form 969 */ 970 /** 971 * top-right property. 972 * 973 * @type { ?Length } 974 * @syscap SystemCapability.ArkUI.ArkUI.Full 975 * @crossplatform 976 * @since 10 977 * @form 978 */ 979 /** 980 * top-right property. 981 * 982 * @type { ?Length } 983 * @syscap SystemCapability.ArkUI.ArkUI.Full 984 * @crossplatform 985 * @atomicservice 986 * @since 11 987 * @form 988 */ 989 topRight?: Length; 990 991 /** 992 * bottom-left property. 993 * 994 * @type { ?Length } 995 * @syscap SystemCapability.ArkUI.ArkUI.Full 996 * @since 9 997 * @form 998 */ 999 /** 1000 * bottom-left property. 1001 * 1002 * @type { ?Length } 1003 * @syscap SystemCapability.ArkUI.ArkUI.Full 1004 * @crossplatform 1005 * @since 10 1006 * @form 1007 */ 1008 /** 1009 * bottom-left property. 1010 * 1011 * @type { ?Length } 1012 * @syscap SystemCapability.ArkUI.ArkUI.Full 1013 * @crossplatform 1014 * @atomicservice 1015 * @since 11 1016 * @form 1017 */ 1018 bottomLeft?: Length; 1019 1020 /** 1021 * bottom-right property. 1022 * 1023 * @type { ?Length } 1024 * @syscap SystemCapability.ArkUI.ArkUI.Full 1025 * @since 9 1026 * @form 1027 */ 1028 /** 1029 * bottom-right property. 1030 * 1031 * @type { ?Length } 1032 * @syscap SystemCapability.ArkUI.ArkUI.Full 1033 * @crossplatform 1034 * @since 10 1035 * @form 1036 */ 1037 /** 1038 * bottom-right property. 1039 * 1040 * @type { ?Length } 1041 * @syscap SystemCapability.ArkUI.ArkUI.Full 1042 * @crossplatform 1043 * @atomicservice 1044 * @since 11 1045 * @form 1046 */ 1047 bottomRight?: Length; 1048}; 1049 1050/** 1051 * Defines the localized border radius property. 1052 * 1053 * @interface LocalizedBorderRadiuses 1054 * @syscap SystemCapability.ArkUI.ArkUI.Full 1055 * @crossplatform 1056 * @form 1057 * @atomicservice 1058 * @since 12 1059 */ 1060declare interface LocalizedBorderRadiuses { 1061 /** 1062 * top-start property. 1063 * 1064 * @type { ?LengthMetrics } 1065 * @syscap SystemCapability.ArkUI.ArkUI.Full 1066 * @crossplatform 1067 * @form 1068 * @atomicservice 1069 * @since 12 1070 */ 1071 topStart?: LengthMetrics; 1072 1073 /** 1074 * top-end property. 1075 * 1076 * @type { ?LengthMetrics } 1077 * @syscap SystemCapability.ArkUI.ArkUI.Full 1078 * @crossplatform 1079 * @form 1080 * @atomicservice 1081 * @since 12 1082 */ 1083 topEnd?: LengthMetrics; 1084 1085 /** 1086 * bottom-start property. 1087 * 1088 * @type { ?LengthMetrics } 1089 * @syscap SystemCapability.ArkUI.ArkUI.Full 1090 * @crossplatform 1091 * @form 1092 * @atomicservice 1093 * @since 12 1094 */ 1095 bottomStart?: LengthMetrics; 1096 1097 /** 1098 * bottom-end property. 1099 * 1100 * @type { ?LengthMetrics } 1101 * @syscap SystemCapability.ArkUI.ArkUI.Full 1102 * @crossplatform 1103 * @form 1104 * @atomicservice 1105 * @since 12 1106 */ 1107 bottomEnd?: LengthMetrics; 1108}; 1109 1110/** 1111 * Defines the outline radius property. 1112 * 1113 * @typedef { object } OutlineRadiuses 1114 * @syscap SystemCapability.ArkUI.ArkUI.Full 1115 * @crossplatform 1116 * @form 1117 * @since 11 1118 */ 1119/** 1120 * Defines the outline radius property. 1121 * 1122 * @typedef { object } OutlineRadiuses 1123 * @syscap SystemCapability.ArkUI.ArkUI.Full 1124 * @crossplatform 1125 * @form 1126 * @atomicservice 1127 * @since 12 1128 */ 1129declare type OutlineRadiuses = { 1130 /** 1131 * top-left property. 1132 * 1133 * @type { ?Dimension } 1134 * @syscap SystemCapability.ArkUI.ArkUI.Full 1135 * @crossplatform 1136 * @since 11 1137 * @form 1138 */ 1139 /** 1140 * top-left property. 1141 * 1142 * @type { ?Dimension } 1143 * @syscap SystemCapability.ArkUI.ArkUI.Full 1144 * @crossplatform 1145 * @form 1146 * @atomicservice 1147 * @since 12 1148 */ 1149 topLeft?: Dimension; 1150 1151 /** 1152 * top-right property. 1153 * 1154 * @type { ?Dimension } 1155 * @syscap SystemCapability.ArkUI.ArkUI.Full 1156 * @crossplatform 1157 * @since 11 1158 * @form 1159 */ 1160 /** 1161 * top-right property. 1162 * 1163 * @type { ?Dimension } 1164 * @syscap SystemCapability.ArkUI.ArkUI.Full 1165 * @crossplatform 1166 * @form 1167 * @atomicservice 1168 * @since 12 1169 */ 1170 topRight?: Dimension; 1171 1172 /** 1173 * bottom-left property. 1174 * 1175 * @type { ?Dimension } 1176 * @syscap SystemCapability.ArkUI.ArkUI.Full 1177 * @crossplatform 1178 * @since 11 1179 * @form 1180 */ 1181 /** 1182 * bottom-left property. 1183 * 1184 * @type { ?Dimension } 1185 * @syscap SystemCapability.ArkUI.ArkUI.Full 1186 * @crossplatform 1187 * @form 1188 * @atomicservice 1189 * @since 12 1190 */ 1191 bottomLeft?: Dimension; 1192 1193 /** 1194 * bottom-right property. 1195 * 1196 * @type { ?Dimension } 1197 * @syscap SystemCapability.ArkUI.ArkUI.Full 1198 * @crossplatform 1199 * @since 11 1200 * @form 1201 */ 1202 /** 1203 * bottom-right property. 1204 * 1205 * @type { ?Dimension } 1206 * @syscap SystemCapability.ArkUI.ArkUI.Full 1207 * @crossplatform 1208 * @form 1209 * @atomicservice 1210 * @since 12 1211 */ 1212 bottomRight?: Dimension; 1213}; 1214 1215/** 1216 * Defines the border color property. 1217 * 1218 * @typedef { object } EdgeColors 1219 * @syscap SystemCapability.ArkUI.ArkUI.Full 1220 * @form 1221 * @since 9 1222 */ 1223/** 1224 * Defines the border color property. 1225 * 1226 * @typedef { object } EdgeColors 1227 * @syscap SystemCapability.ArkUI.ArkUI.Full 1228 * @crossplatform 1229 * @form 1230 * @since 10 1231 */ 1232/** 1233 * Defines the border color property. 1234 * 1235 * @typedef { object } EdgeColors 1236 * @syscap SystemCapability.ArkUI.ArkUI.Full 1237 * @crossplatform 1238 * @form 1239 * @atomicservice 1240 * @since 11 1241 */ 1242declare type EdgeColors = { 1243 /** 1244 * top property. 1245 * 1246 * @type { ?ResourceColor } 1247 * @syscap SystemCapability.ArkUI.ArkUI.Full 1248 * @since 9 1249 * @form 1250 */ 1251 /** 1252 * top property. 1253 * 1254 * @type { ?ResourceColor } 1255 * @syscap SystemCapability.ArkUI.ArkUI.Full 1256 * @crossplatform 1257 * @since 10 1258 * @form 1259 */ 1260 /** 1261 * top property. 1262 * 1263 * @type { ?ResourceColor } 1264 * @syscap SystemCapability.ArkUI.ArkUI.Full 1265 * @crossplatform 1266 * @atomicservice 1267 * @since 11 1268 * @form 1269 */ 1270 top?: ResourceColor; 1271 1272 /** 1273 * right property. 1274 * 1275 * @type { ?ResourceColor } 1276 * @syscap SystemCapability.ArkUI.ArkUI.Full 1277 * @since 9 1278 * @form 1279 */ 1280 /** 1281 * right property. 1282 * 1283 * @type { ?ResourceColor } 1284 * @syscap SystemCapability.ArkUI.ArkUI.Full 1285 * @crossplatform 1286 * @since 10 1287 * @form 1288 */ 1289 /** 1290 * right property. 1291 * 1292 * @type { ?ResourceColor } 1293 * @syscap SystemCapability.ArkUI.ArkUI.Full 1294 * @crossplatform 1295 * @atomicservice 1296 * @since 11 1297 * @form 1298 */ 1299 right?: ResourceColor; 1300 1301 /** 1302 * bottom property. 1303 * 1304 * @type { ?ResourceColor } 1305 * @syscap SystemCapability.ArkUI.ArkUI.Full 1306 * @since 9 1307 * @form 1308 */ 1309 /** 1310 * bottom property. 1311 * 1312 * @type { ?ResourceColor } 1313 * @syscap SystemCapability.ArkUI.ArkUI.Full 1314 * @crossplatform 1315 * @since 10 1316 * @form 1317 */ 1318 /** 1319 * bottom property. 1320 * 1321 * @type { ?ResourceColor } 1322 * @syscap SystemCapability.ArkUI.ArkUI.Full 1323 * @crossplatform 1324 * @atomicservice 1325 * @since 11 1326 * @form 1327 */ 1328 bottom?: ResourceColor; 1329 1330 /** 1331 * left property. 1332 * 1333 * @type { ?ResourceColor } 1334 * @syscap SystemCapability.ArkUI.ArkUI.Full 1335 * @since 9 1336 * @form 1337 */ 1338 /** 1339 * left property. 1340 * 1341 * @type { ?ResourceColor } 1342 * @syscap SystemCapability.ArkUI.ArkUI.Full 1343 * @crossplatform 1344 * @since 10 1345 * @form 1346 */ 1347 /** 1348 * left property. 1349 * 1350 * @type { ?ResourceColor } 1351 * @syscap SystemCapability.ArkUI.ArkUI.Full 1352 * @crossplatform 1353 * @atomicservice 1354 * @since 11 1355 * @form 1356 */ 1357 left?: ResourceColor; 1358}; 1359 1360/** 1361 * Defines the localized border color property. 1362 * 1363 * @interface LocalizedEdgeColors 1364 * @syscap SystemCapability.ArkUI.ArkUI.Full 1365 * @crossplatform 1366 * @form 1367 * @atomicservice 1368 * @since 12 1369 */ 1370declare interface LocalizedEdgeColors { 1371 /** 1372 * top property. 1373 * 1374 * @type { ?ResourceColor } 1375 * @syscap SystemCapability.ArkUI.ArkUI.Full 1376 * @crossplatform 1377 * @form 1378 * @atomicservice 1379 * @since 12 1380 */ 1381 top?: ResourceColor; 1382 1383 /** 1384 * end property. 1385 * 1386 * @type { ?ResourceColor } 1387 * @syscap SystemCapability.ArkUI.ArkUI.Full 1388 * @crossplatform 1389 * @form 1390 * @atomicservice 1391 * @since 12 1392 */ 1393 end?: ResourceColor; 1394 1395 /** 1396 * bottom property. 1397 * 1398 * @type { ?ResourceColor } 1399 * @syscap SystemCapability.ArkUI.ArkUI.Full 1400 * @crossplatform 1401 * @form 1402 * @atomicservice 1403 * @since 12 1404 */ 1405 bottom?: ResourceColor; 1406 1407 /** 1408 * start property. 1409 * 1410 * @type { ?ResourceColor } 1411 * @syscap SystemCapability.ArkUI.ArkUI.Full 1412 * @crossplatform 1413 * @form 1414 * @atomicservice 1415 * @since 12 1416 */ 1417 start?: ResourceColor; 1418}; 1419 1420/** 1421 * Defines the localized margin property. 1422 * 1423 * @typedef { LocalizedPadding } LocalizedMargin 1424 * @syscap SystemCapability.ArkUI.ArkUI.Full 1425 * @crossplatform 1426 * @form 1427 * @atomicservice 1428 * @since 12 1429*/ 1430declare type LocalizedMargin = LocalizedPadding; 1431 1432/** 1433 * Defines the border style property. 1434 * 1435 * @typedef { object } EdgeStyles 1436 * @syscap SystemCapability.ArkUI.ArkUI.Full 1437 * @form 1438 * @since 9 1439 */ 1440/** 1441 * Defines the border style property. 1442 * 1443 * @typedef { object } EdgeStyles 1444 * @syscap SystemCapability.ArkUI.ArkUI.Full 1445 * @crossplatform 1446 * @form 1447 * @since 10 1448 */ 1449/** 1450 * Defines the border style property. 1451 * 1452 * @typedef { object } EdgeStyles 1453 * @syscap SystemCapability.ArkUI.ArkUI.Full 1454 * @crossplatform 1455 * @form 1456 * @atomicservice 1457 * @since 11 1458 */ 1459declare type EdgeStyles = { 1460 /** 1461 * top property. 1462 * 1463 * @type { ?BorderStyle } 1464 * @syscap SystemCapability.ArkUI.ArkUI.Full 1465 * @since 9 1466 * @form 1467 */ 1468 /** 1469 * top property. 1470 * 1471 * @type { ?BorderStyle } 1472 * @syscap SystemCapability.ArkUI.ArkUI.Full 1473 * @crossplatform 1474 * @since 10 1475 * @form 1476 */ 1477 /** 1478 * top property. 1479 * 1480 * @type { ?BorderStyle } 1481 * @syscap SystemCapability.ArkUI.ArkUI.Full 1482 * @crossplatform 1483 * @atomicservice 1484 * @since 11 1485 * @form 1486 */ 1487 top?: BorderStyle; 1488 1489 /** 1490 * right property. 1491 * 1492 * @type { ?BorderStyle } 1493 * @syscap SystemCapability.ArkUI.ArkUI.Full 1494 * @since 9 1495 * @form 1496 */ 1497 /** 1498 * right property. 1499 * 1500 * @type { ?BorderStyle } 1501 * @syscap SystemCapability.ArkUI.ArkUI.Full 1502 * @crossplatform 1503 * @since 10 1504 * @form 1505 */ 1506 /** 1507 * right property. 1508 * 1509 * @type { ?BorderStyle } 1510 * @syscap SystemCapability.ArkUI.ArkUI.Full 1511 * @crossplatform 1512 * @atomicservice 1513 * @since 11 1514 * @form 1515 */ 1516 right?: BorderStyle; 1517 1518 /** 1519 * bottom property. 1520 * 1521 * @type { ?BorderStyle } 1522 * @syscap SystemCapability.ArkUI.ArkUI.Full 1523 * @since 9 1524 * @form 1525 */ 1526 /** 1527 * bottom property. 1528 * 1529 * @type { ?BorderStyle } 1530 * @syscap SystemCapability.ArkUI.ArkUI.Full 1531 * @crossplatform 1532 * @since 10 1533 * @form 1534 */ 1535 /** 1536 * bottom property. 1537 * 1538 * @type { ?BorderStyle } 1539 * @syscap SystemCapability.ArkUI.ArkUI.Full 1540 * @crossplatform 1541 * @atomicservice 1542 * @since 11 1543 * @form 1544 */ 1545 bottom?: BorderStyle; 1546 1547 /** 1548 * left property. 1549 * 1550 * @type { ?BorderStyle } 1551 * @syscap SystemCapability.ArkUI.ArkUI.Full 1552 * @since 9 1553 * @form 1554 */ 1555 /** 1556 * left property. 1557 * 1558 * @type { ?BorderStyle } 1559 * @syscap SystemCapability.ArkUI.ArkUI.Full 1560 * @crossplatform 1561 * @since 10 1562 * @form 1563 */ 1564 /** 1565 * left property. 1566 * 1567 * @type { ?BorderStyle } 1568 * @syscap SystemCapability.ArkUI.ArkUI.Full 1569 * @crossplatform 1570 * @atomicservice 1571 * @since 11 1572 * @form 1573 */ 1574 left?: BorderStyle; 1575}; 1576 1577/** 1578 * Defines the outline style property. 1579 * 1580 * @typedef { object } EdgeOutlineStyles 1581 * @syscap SystemCapability.ArkUI.ArkUI.Full 1582 * @crossplatform 1583 * @form 1584 * @since 11 1585 */ 1586/** 1587 * Defines the outline style property. 1588 * 1589 * @typedef { object } EdgeOutlineStyles 1590 * @syscap SystemCapability.ArkUI.ArkUI.Full 1591 * @crossplatform 1592 * @form 1593 * @atomicservice 1594 * @since 12 1595 */ 1596declare type EdgeOutlineStyles = { 1597 /** 1598 * top property. 1599 * 1600 * @type { ?OutlineStyle } 1601 * @syscap SystemCapability.ArkUI.ArkUI.Full 1602 * @crossplatform 1603 * @since 11 1604 * @form 1605 */ 1606 /** 1607 * top property. 1608 * 1609 * @type { ?OutlineStyle } 1610 * @syscap SystemCapability.ArkUI.ArkUI.Full 1611 * @crossplatform 1612 * @form 1613 * @atomicservice 1614 * @since 12 1615 */ 1616 top?: OutlineStyle; 1617 1618 /** 1619 * right property. 1620 * 1621 * @type { ?OutlineStyle } 1622 * @syscap SystemCapability.ArkUI.ArkUI.Full 1623 * @crossplatform 1624 * @since 11 1625 * @form 1626 */ 1627 /** 1628 * right property. 1629 * 1630 * @type { ?OutlineStyle } 1631 * @syscap SystemCapability.ArkUI.ArkUI.Full 1632 * @crossplatform 1633 * @form 1634 * @atomicservice 1635 * @since 12 1636 */ 1637 right?: OutlineStyle; 1638 1639 /** 1640 * bottom property. 1641 * 1642 * @type { ?OutlineStyle } 1643 * @syscap SystemCapability.ArkUI.ArkUI.Full 1644 * @crossplatform 1645 * @since 11 1646 * @form 1647 */ 1648 /** 1649 * bottom property. 1650 * 1651 * @type { ?OutlineStyle } 1652 * @syscap SystemCapability.ArkUI.ArkUI.Full 1653 * @crossplatform 1654 * @form 1655 * @atomicservice 1656 * @since 12 1657 */ 1658 bottom?: OutlineStyle; 1659 1660 /** 1661 * left property. 1662 * 1663 * @type { ?OutlineStyle } 1664 * @syscap SystemCapability.ArkUI.ArkUI.Full 1665 * @crossplatform 1666 * @since 11 1667 * @form 1668 */ 1669 /** 1670 * left property. 1671 * 1672 * @type { ?OutlineStyle } 1673 * @syscap SystemCapability.ArkUI.ArkUI.Full 1674 * @crossplatform 1675 * @form 1676 * @atomicservice 1677 * @since 12 1678 */ 1679 left?: OutlineStyle; 1680}; 1681 1682/** 1683 * Defines the offset property. 1684 * 1685 * @typedef { object } Offset 1686 * @syscap SystemCapability.ArkUI.ArkUI.Full 1687 * @since 7 1688 */ 1689/** 1690 * Defines the offset property. 1691 * 1692 * @typedef { object } Offset 1693 * @syscap SystemCapability.ArkUI.ArkUI.Full 1694 * @crossplatform 1695 * @since 10 1696 */ 1697/** 1698 * Defines the offset property. 1699 * 1700 * @typedef { object } Offset 1701 * @syscap SystemCapability.ArkUI.ArkUI.Full 1702 * @crossplatform 1703 * @atomicservice 1704 * @since 11 1705 */ 1706declare type Offset = { 1707 /** 1708 * dx property. 1709 * 1710 * @type { Length } 1711 * @syscap SystemCapability.ArkUI.ArkUI.Full 1712 * @since 7 1713 */ 1714 /** 1715 * dx property. 1716 * 1717 * @type { Length } 1718 * @syscap SystemCapability.ArkUI.ArkUI.Full 1719 * @crossplatform 1720 * @since 10 1721 */ 1722 /** 1723 * dx property. 1724 * 1725 * @type { Length } 1726 * @syscap SystemCapability.ArkUI.ArkUI.Full 1727 * @crossplatform 1728 * @atomicservice 1729 * @since 11 1730 */ 1731 dx: Length; 1732 1733 /** 1734 * dy property. 1735 * 1736 * @type { Length } 1737 * @syscap SystemCapability.ArkUI.ArkUI.Full 1738 * @since 7 1739 */ 1740 /** 1741 * dy property. 1742 * 1743 * @type { Length } 1744 * @syscap SystemCapability.ArkUI.ArkUI.Full 1745 * @crossplatform 1746 * @since 10 1747 */ 1748 /** 1749 * dy property. 1750 * 1751 * @type { Length } 1752 * @syscap SystemCapability.ArkUI.ArkUI.Full 1753 * @crossplatform 1754 * @atomicservice 1755 * @since 11 1756 */ 1757 dy: Length; 1758}; 1759 1760/** 1761 * Defines the color which can use resource. 1762 * 1763 * @typedef { Color | number | string | Resource } ResourceColor 1764 * @syscap SystemCapability.ArkUI.ArkUI.Full 1765 * @since 7 1766 */ 1767/** 1768 * Defines the color which can use resource. 1769 * 1770 * @typedef { Color | number | string | Resource } ResourceColor 1771 * @syscap SystemCapability.ArkUI.ArkUI.Full 1772 * @form 1773 * @since 9 1774 */ 1775/** 1776 * Defines the color which can use resource. 1777 * 1778 * @typedef { Color | number | string | Resource } ResourceColor 1779 * @syscap SystemCapability.ArkUI.ArkUI.Full 1780 * @crossplatform 1781 * @form 1782 * @since 10 1783 */ 1784/** 1785 * Defines the color which can use resource. 1786 * 1787 * @typedef { Color | number | string | Resource } ResourceColor 1788 * @syscap SystemCapability.ArkUI.ArkUI.Full 1789 * @crossplatform 1790 * @form 1791 * @atomicservice 1792 * @since 11 1793 */ 1794declare type ResourceColor = Color | number | string | Resource; 1795 1796/** 1797 * Defines the length constrain property. 1798 * 1799 * @typedef { object } LengthConstrain 1800 * @syscap SystemCapability.ArkUI.ArkUI.Full 1801 * @form 1802 * @since 9 1803 */ 1804/** 1805 * Defines the length constrain property. 1806 * 1807 * @typedef { object } LengthConstrain 1808 * @syscap SystemCapability.ArkUI.ArkUI.Full 1809 * @crossplatform 1810 * @form 1811 * @since 10 1812 */ 1813/** 1814 * Defines the length constrain property. 1815 * 1816 * @typedef { object } LengthConstrain 1817 * @syscap SystemCapability.ArkUI.ArkUI.Full 1818 * @crossplatform 1819 * @form 1820 * @atomicservice 1821 * @since 11 1822 */ 1823declare type LengthConstrain = { 1824 /** 1825 * minimum length. 1826 * 1827 * @type { Length } 1828 * @syscap SystemCapability.ArkUI.ArkUI.Full 1829 * @since 9 1830 * @form 1831 */ 1832 /** 1833 * minimum length. 1834 * 1835 * @type { Length } 1836 * @syscap SystemCapability.ArkUI.ArkUI.Full 1837 * @crossplatform 1838 * @since 10 1839 * @form 1840 */ 1841 /** 1842 * minimum length. 1843 * 1844 * @type { Length } 1845 * @syscap SystemCapability.ArkUI.ArkUI.Full 1846 * @crossplatform 1847 * @atomicservice 1848 * @since 11 1849 * @form 1850 */ 1851 minLength: Length; 1852 1853 /** 1854 * maximum length. 1855 * 1856 * @type { Length } 1857 * @syscap SystemCapability.ArkUI.ArkUI.Full 1858 * @since 9 1859 * @form 1860 */ 1861 /** 1862 * maximum length. 1863 * 1864 * @type { Length } 1865 * @syscap SystemCapability.ArkUI.ArkUI.Full 1866 * @crossplatform 1867 * @since 10 1868 * @form 1869 */ 1870 /** 1871 * maximum length. 1872 * 1873 * @type { Length } 1874 * @syscap SystemCapability.ArkUI.ArkUI.Full 1875 * @crossplatform 1876 * @atomicservice 1877 * @since 11 1878 * @form 1879 */ 1880 maxLength: Length; 1881}; 1882 1883/** 1884 * Defines VoidCallback. 1885 * 1886 * @typedef { function } VoidCallback 1887 * @syscap SystemCapability.ArkUI.ArkUI.Full 1888 * @crossplatform 1889 * @atomicservice 1890 * @since 12 1891 */ 1892declare type VoidCallback = () => void; 1893 1894/** 1895 * Defines length metrics unit. 1896 * 1897 * @typedef { import('../api/arkui/Graphics').LengthMetricsUnit } LengthMetricsUnit 1898 * @syscap SystemCapability.ArkUI.ArkUI.Full 1899 * @crossplatform 1900 * @form 1901 * @atomicservice 1902 * @since 12 1903 */ 1904declare type LengthMetricsUnit = import('../api/arkui/Graphics').LengthMetricsUnit; 1905 1906/** 1907 * Defines LengthMetrics. 1908 * 1909 * @typedef { import('../api/arkui/Graphics').LengthMetrics } LengthMetrics 1910 * @syscap SystemCapability.ArkUI.ArkUI.Full 1911 * @crossplatform 1912 * @atomicservice 1913 * @since 12 1914 */ 1915declare type LengthMetrics = import('../api/arkui/Graphics').LengthMetrics; 1916 1917/** 1918 * Defines ColorMetrics. 1919 * 1920 * @typedef { import('../api/arkui/Graphics').ColorMetrics } ColorMetrics 1921 * @syscap SystemCapability.ArkUI.ArkUI.Full 1922 * @crossplatform 1923 * @atomicservice 1924 * @since 12 1925 */ 1926declare type ColorMetrics = import('../api/arkui/Graphics').ColorMetrics; 1927 1928/** 1929 * Defines the font used for text. 1930 * 1931 * @interface Font 1932 * @syscap SystemCapability.ArkUI.ArkUI.Full 1933 * @since 7 1934 */ 1935/** 1936 * Defines the font used for text. 1937 * 1938 * @interface Font 1939 * @syscap SystemCapability.ArkUI.ArkUI.Full 1940 * @crossplatform 1941 * @since 10 1942 */ 1943/** 1944 * Defines the font used for text. 1945 * 1946 * @interface Font 1947 * @syscap SystemCapability.ArkUI.ArkUI.Full 1948 * @crossplatform 1949 * @atomicservice 1950 * @since 11 1951 */ 1952declare interface Font { 1953 /** 1954 * font size. 1955 * 1956 * @type { ?Length } 1957 * @syscap SystemCapability.ArkUI.ArkUI.Full 1958 * @since 7 1959 */ 1960 /** 1961 * font size. 1962 * 1963 * @type { ?Length } 1964 * @syscap SystemCapability.ArkUI.ArkUI.Full 1965 * @crossplatform 1966 * @since 10 1967 */ 1968 /** 1969 * font size. 1970 * 1971 * @type { ?Length } 1972 * @syscap SystemCapability.ArkUI.ArkUI.Full 1973 * @crossplatform 1974 * @atomicservice 1975 * @since 11 1976 */ 1977 size?: Length; 1978 1979 /** 1980 * font weight. 1981 * 1982 * @type { ?(FontWeight | number | string) } 1983 * @syscap SystemCapability.ArkUI.ArkUI.Full 1984 * @since 7 1985 */ 1986 /** 1987 * font weight. 1988 * 1989 * @type { ?(FontWeight | number | string) } 1990 * @syscap SystemCapability.ArkUI.ArkUI.Full 1991 * @crossplatform 1992 * @since 10 1993 */ 1994 /** 1995 * font weight. 1996 * 1997 * @type { ?(FontWeight | number | string) } 1998 * @syscap SystemCapability.ArkUI.ArkUI.Full 1999 * @crossplatform 2000 * @atomicservice 2001 * @since 11 2002 */ 2003 weight?: FontWeight | number | string; 2004 2005 /** 2006 * font family. 2007 * 2008 * @type { ?(string | Resource) } 2009 * @syscap SystemCapability.ArkUI.ArkUI.Full 2010 * @since 7 2011 */ 2012 /** 2013 * font family. 2014 * 2015 * @type { ?(string | Resource) } 2016 * @syscap SystemCapability.ArkUI.ArkUI.Full 2017 * @crossplatform 2018 * @since 10 2019 */ 2020 /** 2021 * font family. 2022 * 2023 * @type { ?(string | Resource) } 2024 * @syscap SystemCapability.ArkUI.ArkUI.Full 2025 * @crossplatform 2026 * @atomicservice 2027 * @since 11 2028 */ 2029 family?: string | Resource; 2030 2031 /** 2032 * font style. 2033 * 2034 * @type { ?FontStyle } 2035 * @syscap SystemCapability.ArkUI.ArkUI.Full 2036 * @since 7 2037 */ 2038 /** 2039 * font style. 2040 * 2041 * @type { ?FontStyle } 2042 * @syscap SystemCapability.ArkUI.ArkUI.Full 2043 * @crossplatform 2044 * @since 10 2045 */ 2046 /** 2047 * font style. 2048 * 2049 * @type { ?FontStyle } 2050 * @syscap SystemCapability.ArkUI.ArkUI.Full 2051 * @crossplatform 2052 * @atomicservice 2053 * @since 11 2054 */ 2055 style?: FontStyle; 2056} 2057 2058/** 2059 * Defines the area property. 2060 * 2061 * @interface Area 2062 * @syscap SystemCapability.ArkUI.ArkUI.Full 2063 * @since 8 2064 */ 2065/** 2066 * Defines the area property. 2067 * 2068 * @interface Area 2069 * @syscap SystemCapability.ArkUI.ArkUI.Full 2070 * @form 2071 * @since 9 2072 */ 2073/** 2074 * Defines the area property. 2075 * 2076 * @interface Area 2077 * @syscap SystemCapability.ArkUI.ArkUI.Full 2078 * @crossplatform 2079 * @form 2080 * @since 10 2081 */ 2082/** 2083 * Defines the area property. 2084 * 2085 * @interface Area 2086 * @syscap SystemCapability.ArkUI.ArkUI.Full 2087 * @crossplatform 2088 * @form 2089 * @atomicservice 2090 * @since 11 2091 */ 2092declare interface Area { 2093 /** 2094 * Defines the width property. 2095 * 2096 * @type { Length } 2097 * @syscap SystemCapability.ArkUI.ArkUI.Full 2098 * @since 8 2099 */ 2100 /** 2101 * Defines the width property. 2102 * 2103 * @type { Length } 2104 * @syscap SystemCapability.ArkUI.ArkUI.Full 2105 * @form 2106 * @since 9 2107 */ 2108 /** 2109 * Defines the width property. 2110 * 2111 * @type { Length } 2112 * @syscap SystemCapability.ArkUI.ArkUI.Full 2113 * @crossplatform 2114 * @form 2115 * @since 10 2116 */ 2117 /** 2118 * Defines the width property. 2119 * 2120 * @type { Length } 2121 * @syscap SystemCapability.ArkUI.ArkUI.Full 2122 * @crossplatform 2123 * @form 2124 * @atomicservice 2125 * @since 11 2126 */ 2127 width: Length; 2128 2129 /** 2130 * Defines the height property. 2131 * 2132 * @type { Length } 2133 * @syscap SystemCapability.ArkUI.ArkUI.Full 2134 * @since 8 2135 */ 2136 /** 2137 * Defines the height property. 2138 * 2139 * @type { Length } 2140 * @syscap SystemCapability.ArkUI.ArkUI.Full 2141 * @form 2142 * @since 9 2143 */ 2144 /** 2145 * Defines the height property. 2146 * 2147 * @type { Length } 2148 * @syscap SystemCapability.ArkUI.ArkUI.Full 2149 * @crossplatform 2150 * @form 2151 * @since 10 2152 */ 2153 /** 2154 * Defines the height property. 2155 * 2156 * @type { Length } 2157 * @syscap SystemCapability.ArkUI.ArkUI.Full 2158 * @crossplatform 2159 * @form 2160 * @atomicservice 2161 * @since 11 2162 */ 2163 height: Length; 2164 2165 /** 2166 * Defines the local position. 2167 * 2168 * @type { Position } 2169 * @syscap SystemCapability.ArkUI.ArkUI.Full 2170 * @since 8 2171 */ 2172 /** 2173 * Defines the local position. 2174 * 2175 * @type { Position } 2176 * @syscap SystemCapability.ArkUI.ArkUI.Full 2177 * @form 2178 * @since 9 2179 */ 2180 /** 2181 * Defines the local position. 2182 * 2183 * @type { Position } 2184 * @syscap SystemCapability.ArkUI.ArkUI.Full 2185 * @crossplatform 2186 * @form 2187 * @since 10 2188 */ 2189 /** 2190 * Defines the local position. 2191 * 2192 * @type { Position } 2193 * @syscap SystemCapability.ArkUI.ArkUI.Full 2194 * @crossplatform 2195 * @form 2196 * @atomicservice 2197 * @since 11 2198 */ 2199 position: Position; 2200 2201 /** 2202 * Defines the global position. 2203 * 2204 * @type { Position } 2205 * @syscap SystemCapability.ArkUI.ArkUI.Full 2206 * @since 8 2207 */ 2208 /** 2209 * Defines the global position. 2210 * 2211 * @type { Position } 2212 * @syscap SystemCapability.ArkUI.ArkUI.Full 2213 * @form 2214 * @since 9 2215 */ 2216 /** 2217 * Defines the global position. 2218 * 2219 * @type { Position } 2220 * @syscap SystemCapability.ArkUI.ArkUI.Full 2221 * @crossplatform 2222 * @form 2223 * @since 10 2224 */ 2225 /** 2226 * Defines the global position. 2227 * 2228 * @type { Position } 2229 * @syscap SystemCapability.ArkUI.ArkUI.Full 2230 * @crossplatform 2231 * @form 2232 * @atomicservice 2233 * @since 11 2234 */ 2235 globalPosition: Position; 2236} 2237 2238/** 2239 * Defines the position. 2240 * 2241 * @interface Position 2242 * @syscap SystemCapability.ArkUI.ArkUI.Full 2243 * @since 7 2244 */ 2245/** 2246 * Defines the position. 2247 * 2248 * @interface Position 2249 * @syscap SystemCapability.ArkUI.ArkUI.Full 2250 * @form 2251 * @since 9 2252 */ 2253/** 2254 * Defines the position. 2255 * 2256 * @interface Position 2257 * @syscap SystemCapability.ArkUI.ArkUI.Full 2258 * @crossplatform 2259 * @form 2260 * @since 10 2261 */ 2262/** 2263 * Defines the position. 2264 * 2265 * @interface Position 2266 * @syscap SystemCapability.ArkUI.ArkUI.Full 2267 * @crossplatform 2268 * @form 2269 * @atomicservice 2270 * @since 11 2271 */ 2272declare interface Position { 2273 /** 2274 * Coordinate x of the Position. 2275 * 2276 * @type { ?Length } 2277 * @syscap SystemCapability.ArkUI.ArkUI.Full 2278 * @since 7 2279 */ 2280 /** 2281 * Coordinate x of the Position. 2282 * 2283 * @type { ?Length } 2284 * @syscap SystemCapability.ArkUI.ArkUI.Full 2285 * @form 2286 * @since 9 2287 */ 2288 /** 2289 * Coordinate x of the Position. 2290 * 2291 * @type { ?Length } 2292 * @syscap SystemCapability.ArkUI.ArkUI.Full 2293 * @crossplatform 2294 * @form 2295 * @since 10 2296 */ 2297 /** 2298 * Coordinate x of the Position. 2299 * 2300 * @type { ?Length } 2301 * @syscap SystemCapability.ArkUI.ArkUI.Full 2302 * @crossplatform 2303 * @form 2304 * @atomicservice 2305 * @since 11 2306 */ 2307 x?: Length; 2308 2309 /** 2310 * Coordinate y of the Position. 2311 * 2312 * @type { ?Length } 2313 * @syscap SystemCapability.ArkUI.ArkUI.Full 2314 * @since 7 2315 */ 2316 /** 2317 * Coordinate y of the Position. 2318 * 2319 * @type { ?Length } 2320 * @syscap SystemCapability.ArkUI.ArkUI.Full 2321 * @form 2322 * @since 9 2323 */ 2324 /** 2325 * Coordinate y of the Position. 2326 * 2327 * @type { ?Length } 2328 * @syscap SystemCapability.ArkUI.ArkUI.Full 2329 * @crossplatform 2330 * @form 2331 * @since 10 2332 */ 2333 /** 2334 * Coordinate y of the Position. 2335 * 2336 * @type { ?Length } 2337 * @syscap SystemCapability.ArkUI.ArkUI.Full 2338 * @crossplatform 2339 * @form 2340 * @atomicservice 2341 * @since 11 2342 */ 2343 y?: Length; 2344} 2345 2346/** 2347 * Defines the LocalizedPosition. 2348 * 2349 * @interface LocalizedPosition 2350 * @syscap SystemCapability.ArkUI.ArkUI.Full 2351 * @crossplatform 2352 * @atomicservice 2353 * @since 12 2354 */ 2355declare interface LocalizedPosition { 2356 /** 2357 * Coordinate start of the Position. 2358 * 2359 * @type { ?LengthMetrics } 2360 * @syscap SystemCapability.ArkUI.ArkUI.Full 2361 * @crossplatform 2362 * @atomicservice 2363 * @since 12 2364 */ 2365 start?: LengthMetrics; 2366 2367 /** 2368 * Coordinate top of the Position. 2369 * 2370 * @type { ?LengthMetrics } 2371 * @syscap SystemCapability.ArkUI.ArkUI.Full 2372 * @crossplatform 2373 * @atomicservice 2374 * @since 12 2375 */ 2376 top?: LengthMetrics; 2377} 2378 2379/** 2380 * Defines the Edges. 2381 * 2382 * @interface Edges 2383 * @syscap SystemCapability.ArkUI.ArkUI.Full 2384 * @crossplatform 2385 * @form 2386 * @atomicservice 2387 * @since 12 2388 */ 2389declare interface Edges { 2390 /** 2391 * top property. 2392 * 2393 * @type { ?Dimension } 2394 * @syscap SystemCapability.ArkUI.ArkUI.Full 2395 * @crossplatform 2396 * @form 2397 * @atomicservice 2398 * @since 12 2399 */ 2400 top?: Dimension; 2401 2402 /** 2403 * left property. 2404 * 2405 * @type { ?Dimension } 2406 * @syscap SystemCapability.ArkUI.ArkUI.Full 2407 * @crossplatform 2408 * @form 2409 * @atomicservice 2410 * @since 12 2411 */ 2412 left?: Dimension; 2413 2414 /** 2415 * bottom property. 2416 * 2417 * @type { ?Dimension } 2418 * @syscap SystemCapability.ArkUI.ArkUI.Full 2419 * @crossplatform 2420 * @form 2421 * @atomicservice 2422 * @since 12 2423 */ 2424 bottom?: Dimension; 2425 2426 /** 2427 * right property. 2428 * 2429 * @type { ?Dimension } 2430 * @syscap SystemCapability.ArkUI.ArkUI.Full 2431 * @crossplatform 2432 * @form 2433 * @atomicservice 2434 * @since 12 2435 */ 2436 right?: Dimension; 2437} 2438 2439/** 2440 * Defines the LocalizedEdges. 2441 * 2442 * @interface LocalizedEdges 2443 * @syscap SystemCapability.ArkUI.ArkUI.Full 2444 * @crossplatform 2445 * @atomicservice 2446 * @since 12 2447 */ 2448declare interface LocalizedEdges { 2449 /** 2450 * top property. 2451 * 2452 * @type { ?LengthMetrics } 2453 * @syscap SystemCapability.ArkUI.ArkUI.Full 2454 * @crossplatform 2455 * @atomicservice 2456 * @since 12 2457 */ 2458 top?: LengthMetrics; 2459 2460 /** 2461 * start property. 2462 * 2463 * @type { ?LengthMetrics } 2464 * @syscap SystemCapability.ArkUI.ArkUI.Full 2465 * @crossplatform 2466 * @atomicservice 2467 * @since 12 2468 */ 2469 start?: LengthMetrics; 2470 2471 /** 2472 * bottom property. 2473 * 2474 * @type { ?LengthMetrics } 2475 * @syscap SystemCapability.ArkUI.ArkUI.Full 2476 * @crossplatform 2477 * @atomicservice 2478 * @since 12 2479 */ 2480 bottom?: LengthMetrics; 2481 2482 /** 2483 * end property. 2484 * 2485 * @type { ?LengthMetrics } 2486 * @syscap SystemCapability.ArkUI.ArkUI.Full 2487 * @crossplatform 2488 * @atomicservice 2489 * @since 12 2490 */ 2491 end?: LengthMetrics; 2492} 2493 2494/** 2495 * Defines the Bias. 2496 * 2497 * @interface Bias 2498 * @syscap SystemCapability.ArkUI.ArkUI.Full 2499 * @crossplatform 2500 * @form 2501 * @since 11 2502 */ 2503/** 2504 * Defines the Bias. 2505 * 2506 * @interface Bias 2507 * @syscap SystemCapability.ArkUI.ArkUI.Full 2508 * @crossplatform 2509 * @form 2510 * @atomicservice 2511 * @since 12 2512 */ 2513declare interface Bias { 2514 /** 2515 * Horizontal ratio of the Bias, it must be >= 0. 2516 * 2517 * @type { ?number } 2518 * @default 0.5 2519 * @syscap SystemCapability.ArkUI.ArkUI.Full 2520 * @crossplatform 2521 * @form 2522 * @since 11 2523 */ 2524 /** 2525 * Horizontal ratio of the Bias, it must be >= 0. 2526 * 2527 * @type { ?number } 2528 * @default 0.5 2529 * @syscap SystemCapability.ArkUI.ArkUI.Full 2530 * @crossplatform 2531 * @form 2532 * @atomicservice 2533 * @since 12 2534 */ 2535 horizontal?: number; 2536 2537 /** 2538 * Vertical ratio of the Bias, it must be >= 0. 2539 * 2540 * @type { ?number } 2541 * @default 0.5 2542 * @syscap SystemCapability.ArkUI.ArkUI.Full 2543 * @crossplatform 2544 * @form 2545 * @since 11 2546 */ 2547 /** 2548 * Vertical ratio of the Bias, it must be >= 0. 2549 * 2550 * @type { ?number } 2551 * @default 0.5 2552 * @syscap SystemCapability.ArkUI.ArkUI.Full 2553 * @crossplatform 2554 * @form 2555 * @atomicservice 2556 * @since 12 2557 */ 2558 vertical?: number; 2559} 2560 2561/** 2562 * Defines the constrain size options. 2563 * 2564 * @interface ConstraintSizeOptions 2565 * @syscap SystemCapability.ArkUI.ArkUI.Full 2566 * @since 7 2567 */ 2568/** 2569 * Defines the constrain size options. 2570 * 2571 * @interface ConstraintSizeOptions 2572 * @syscap SystemCapability.ArkUI.ArkUI.Full 2573 * @form 2574 * @since 9 2575 */ 2576/** 2577 * Defines the constrain size options. 2578 * 2579 * @interface ConstraintSizeOptions 2580 * @syscap SystemCapability.ArkUI.ArkUI.Full 2581 * @crossplatform 2582 * @form 2583 * @since 10 2584 */ 2585/** 2586 * Defines the constrain size options. 2587 * 2588 * @interface ConstraintSizeOptions 2589 * @syscap SystemCapability.ArkUI.ArkUI.Full 2590 * @crossplatform 2591 * @form 2592 * @atomicservice 2593 * @since 11 2594 */ 2595declare interface ConstraintSizeOptions { 2596 /** 2597 * Defines the min width. 2598 * 2599 * @type { ?Length } 2600 * @syscap SystemCapability.ArkUI.ArkUI.Full 2601 * @since 7 2602 */ 2603 /** 2604 * Defines the min width. 2605 * 2606 * @type { ?Length } 2607 * @syscap SystemCapability.ArkUI.ArkUI.Full 2608 * @form 2609 * @since 9 2610 */ 2611 /** 2612 * Defines the min width. 2613 * 2614 * @type { ?Length } 2615 * @syscap SystemCapability.ArkUI.ArkUI.Full 2616 * @crossplatform 2617 * @form 2618 * @since 10 2619 */ 2620 /** 2621 * Defines the min width. 2622 * 2623 * @type { ?Length } 2624 * @syscap SystemCapability.ArkUI.ArkUI.Full 2625 * @crossplatform 2626 * @form 2627 * @atomicservice 2628 * @since 11 2629 */ 2630 minWidth?: Length; 2631 2632 /** 2633 * Defines the max width. 2634 * 2635 * @type { ?Length } 2636 * @syscap SystemCapability.ArkUI.ArkUI.Full 2637 * @since 7 2638 */ 2639 /** 2640 * Defines the max width. 2641 * 2642 * @type { ?Length } 2643 * @syscap SystemCapability.ArkUI.ArkUI.Full 2644 * @form 2645 * @since 9 2646 */ 2647 /** 2648 * Defines the max width. 2649 * 2650 * @type { ?Length } 2651 * @syscap SystemCapability.ArkUI.ArkUI.Full 2652 * @crossplatform 2653 * @form 2654 * @since 10 2655 */ 2656 /** 2657 * Defines the max width. 2658 * 2659 * @type { ?Length } 2660 * @syscap SystemCapability.ArkUI.ArkUI.Full 2661 * @crossplatform 2662 * @form 2663 * @atomicservice 2664 * @since 11 2665 */ 2666 maxWidth?: Length; 2667 2668 /** 2669 * Defines the min height. 2670 * 2671 * @type { ?Length } 2672 * @syscap SystemCapability.ArkUI.ArkUI.Full 2673 * @since 7 2674 */ 2675 /** 2676 * Defines the min height. 2677 * 2678 * @type { ?Length } 2679 * @syscap SystemCapability.ArkUI.ArkUI.Full 2680 * @form 2681 * @since 9 2682 */ 2683 /** 2684 * Defines the min height. 2685 * 2686 * @type { ?Length } 2687 * @syscap SystemCapability.ArkUI.ArkUI.Full 2688 * @crossplatform 2689 * @form 2690 * @since 10 2691 */ 2692 /** 2693 * Defines the min height. 2694 * 2695 * @type { ?Length } 2696 * @syscap SystemCapability.ArkUI.ArkUI.Full 2697 * @crossplatform 2698 * @form 2699 * @atomicservice 2700 * @since 11 2701 */ 2702 minHeight?: Length; 2703 2704 /** 2705 * Defines the max height. 2706 * 2707 * @type { ?Length } 2708 * @syscap SystemCapability.ArkUI.ArkUI.Full 2709 * @since 7 2710 */ 2711 /** 2712 * Defines the max height. 2713 * 2714 * @type { ?Length } 2715 * @syscap SystemCapability.ArkUI.ArkUI.Full 2716 * @form 2717 * @since 9 2718 */ 2719 /** 2720 * Defines the max height. 2721 * 2722 * @type { ?Length } 2723 * @syscap SystemCapability.ArkUI.ArkUI.Full 2724 * @crossplatform 2725 * @form 2726 * @since 10 2727 */ 2728 /** 2729 * Defines the max height. 2730 * 2731 * @type { ?Length } 2732 * @syscap SystemCapability.ArkUI.ArkUI.Full 2733 * @crossplatform 2734 * @form 2735 * @atomicservice 2736 * @since 11 2737 */ 2738 maxHeight?: Length; 2739} 2740 2741/** 2742 * Defines the size options. 2743 * 2744 * @interface SizeOptions 2745 * @syscap SystemCapability.ArkUI.ArkUI.Full 2746 * @since 7 2747 */ 2748/** 2749 * Defines the size options. 2750 * 2751 * @interface SizeOptions 2752 * @syscap SystemCapability.ArkUI.ArkUI.Full 2753 * @form 2754 * @since 9 2755 */ 2756/** 2757 * Defines the size options. 2758 * 2759 * @interface SizeOptions 2760 * @syscap SystemCapability.ArkUI.ArkUI.Full 2761 * @crossplatform 2762 * @form 2763 * @since 10 2764 */ 2765/** 2766 * Defines the size options. 2767 * 2768 * @interface SizeOptions 2769 * @syscap SystemCapability.ArkUI.ArkUI.Full 2770 * @crossplatform 2771 * @form 2772 * @atomicservice 2773 * @since 11 2774 */ 2775declare interface SizeOptions { 2776 /** 2777 * Defines the width. 2778 * 2779 * @type { ?Length } 2780 * @syscap SystemCapability.ArkUI.ArkUI.Full 2781 * @since 7 2782 */ 2783 /** 2784 * Defines the width. 2785 * 2786 * @type { ?Length } 2787 * @syscap SystemCapability.ArkUI.ArkUI.Full 2788 * @form 2789 * @since 9 2790 */ 2791 /** 2792 * Defines the width. 2793 * 2794 * @type { ?Length } 2795 * @syscap SystemCapability.ArkUI.ArkUI.Full 2796 * @crossplatform 2797 * @form 2798 * @since 10 2799 */ 2800 /** 2801 * Defines the width. 2802 * 2803 * @type { ?Length } 2804 * @syscap SystemCapability.ArkUI.ArkUI.Full 2805 * @crossplatform 2806 * @form 2807 * @atomicservice 2808 * @since 11 2809 */ 2810 width?: Length; 2811 2812 /** 2813 * Defines the height. 2814 * 2815 * @type { ?Length } 2816 * @syscap SystemCapability.ArkUI.ArkUI.Full 2817 * @since 7 2818 */ 2819 /** 2820 * Defines the height. 2821 * 2822 * @type { ?Length } 2823 * @syscap SystemCapability.ArkUI.ArkUI.Full 2824 * @form 2825 * @since 9 2826 */ 2827 /** 2828 * Defines the height. 2829 * 2830 * @type { ?Length } 2831 * @syscap SystemCapability.ArkUI.ArkUI.Full 2832 * @crossplatform 2833 * @form 2834 * @since 10 2835 */ 2836 /** 2837 * Defines the height. 2838 * 2839 * @type { ?Length } 2840 * @syscap SystemCapability.ArkUI.ArkUI.Full 2841 * @crossplatform 2842 * @form 2843 * @atomicservice 2844 * @since 11 2845 */ 2846 height?: Length; 2847} 2848 2849/** 2850 * Defines the options of border. 2851 * 2852 * @interface BorderOptions 2853 * @syscap SystemCapability.ArkUI.ArkUI.Full 2854 * @since 7 2855 */ 2856/** 2857 * Defines the options of border. 2858 * 2859 * @interface BorderOptions 2860 * @syscap SystemCapability.ArkUI.ArkUI.Full 2861 * @form 2862 * @since 9 2863 */ 2864/** 2865 * Defines the options of border. 2866 * 2867 * @interface BorderOptions 2868 * @syscap SystemCapability.ArkUI.ArkUI.Full 2869 * @crossplatform 2870 * @form 2871 * @since 10 2872 */ 2873/** 2874 * Defines the options of border. 2875 * 2876 * @interface BorderOptions 2877 * @syscap SystemCapability.ArkUI.ArkUI.Full 2878 * @crossplatform 2879 * @form 2880 * @atomicservice 2881 * @since 11 2882 */ 2883/** 2884 * Defines the options of border. 2885 * 2886 * @interface BorderOptions 2887 * @syscap SystemCapability.ArkUI.ArkUI.Full 2888 * @crossplatform 2889 * @form 2890 * @atomicservice 2891 * @since 12 2892 */ 2893declare interface BorderOptions { 2894 /** 2895 * Defines the border width. 2896 * 2897 * @type { ?Length } 2898 * @syscap SystemCapability.ArkUI.ArkUI.Full 2899 * @since 7 2900 */ 2901 /** 2902 * Defines the border width. 2903 * 2904 * @type { ?(EdgeWidths | Length) } 2905 * @syscap SystemCapability.ArkUI.ArkUI.Full 2906 * @form 2907 * @since 9 2908 */ 2909 /** 2910 * Defines the border width. 2911 * 2912 * @type { ?(EdgeWidths | Length) } 2913 * @syscap SystemCapability.ArkUI.ArkUI.Full 2914 * @crossplatform 2915 * @form 2916 * @since 10 2917 */ 2918 /** 2919 * Defines the border width. 2920 * 2921 * @type { ?(EdgeWidths | Length) } 2922 * @syscap SystemCapability.ArkUI.ArkUI.Full 2923 * @crossplatform 2924 * @form 2925 * @atomicservice 2926 * @since 11 2927 */ 2928 /** 2929 * Defines the border width. 2930 * 2931 * @type { ?(EdgeWidths | Length | LocalizedEdgeWidths) } 2932 * @syscap SystemCapability.ArkUI.ArkUI.Full 2933 * @crossplatform 2934 * @form 2935 * @atomicservice 2936 * @since 12 2937 */ 2938 width?: EdgeWidths | Length | LocalizedEdgeWidths; 2939 2940 /** 2941 * Defines the border color. 2942 * 2943 * @type { ?ResourceColor } 2944 * @syscap SystemCapability.ArkUI.ArkUI.Full 2945 * @since 7 2946 */ 2947 /** 2948 * Defines the border color. 2949 * 2950 * @type { ?(EdgeColors | ResourceColor) } 2951 * @syscap SystemCapability.ArkUI.ArkUI.Full 2952 * @form 2953 * @since 9 2954 */ 2955 /** 2956 * Defines the border color. 2957 * 2958 * @type { ?(EdgeColors | ResourceColor) } 2959 * @syscap SystemCapability.ArkUI.ArkUI.Full 2960 * @crossplatform 2961 * @form 2962 * @since 10 2963 */ 2964 /** 2965 * Defines the border color. 2966 * 2967 * @type { ?(EdgeColors | ResourceColor) } 2968 * @syscap SystemCapability.ArkUI.ArkUI.Full 2969 * @crossplatform 2970 * @form 2971 * @atomicservice 2972 * @since 11 2973 */ 2974 /** 2975 * Defines the border color. 2976 * 2977 * @type { ?(EdgeColors | ResourceColor | LocalizedEdgeColors) } 2978 * @syscap SystemCapability.ArkUI.ArkUI.Full 2979 * @crossplatform 2980 * @form 2981 * @atomicservice 2982 * @since 12 2983 */ 2984 color?: EdgeColors | ResourceColor | LocalizedEdgeColors; 2985 2986 /** 2987 * Defines the border radius. 2988 * 2989 * @type { ?Length } 2990 * @syscap SystemCapability.ArkUI.ArkUI.Full 2991 * @since 7 2992 */ 2993 /** 2994 * Defines the border radius. 2995 * 2996 * @type { ?(BorderRadiuses | Length) } 2997 * @syscap SystemCapability.ArkUI.ArkUI.Full 2998 * @form 2999 * @since 9 3000 */ 3001 /** 3002 * Defines the border radius. 3003 * 3004 * @type { ?(BorderRadiuses | Length) } 3005 * @syscap SystemCapability.ArkUI.ArkUI.Full 3006 * @crossplatform 3007 * @form 3008 * @since 10 3009 */ 3010 /** 3011 * Defines the border radius. 3012 * 3013 * @type { ?(BorderRadiuses | Length) } 3014 * @syscap SystemCapability.ArkUI.ArkUI.Full 3015 * @crossplatform 3016 * @form 3017 * @atomicservice 3018 * @since 11 3019 */ 3020 /** 3021 * Defines the border radius. 3022 * 3023 * @type { ?(BorderRadiuses | Length | LocalizedBorderRadiuses) } 3024 * @syscap SystemCapability.ArkUI.ArkUI.Full 3025 * @crossplatform 3026 * @form 3027 * @atomicservice 3028 * @since 12 3029 */ 3030 radius?: BorderRadiuses | Length | LocalizedBorderRadiuses; 3031 3032 /** 3033 * Defines the border style. 3034 * 3035 * @type { ?BorderStyle } 3036 * @syscap SystemCapability.ArkUI.ArkUI.Full 3037 * @since 7 3038 */ 3039 /** 3040 * Defines the border style. 3041 * 3042 * @type { ?(EdgeStyles | BorderStyle) } 3043 * @syscap SystemCapability.ArkUI.ArkUI.Full 3044 * @form 3045 * @since 9 3046 */ 3047 /** 3048 * Defines the border style. 3049 * 3050 * @type { ?(EdgeStyles | BorderStyle) } 3051 * @syscap SystemCapability.ArkUI.ArkUI.Full 3052 * @crossplatform 3053 * @form 3054 * @since 10 3055 */ 3056 /** 3057 * Defines the border style. 3058 * 3059 * @type { ?(EdgeStyles | BorderStyle) } 3060 * @syscap SystemCapability.ArkUI.ArkUI.Full 3061 * @crossplatform 3062 * @form 3063 * @atomicservice 3064 * @since 11 3065 */ 3066 style?: EdgeStyles | BorderStyle; 3067 3068 /** 3069 * Defines the gap of dash when BorderStyle is dashed. 3070 * 3071 * @type { ?(EdgeWidths | LengthMetrics | LocalizedEdgeWidths) } 3072 * @syscap SystemCapability.ArkUI.ArkUI.Full 3073 * @crossplatform 3074 * @atomicservice 3075 * @since 12 3076 */ 3077 dashGap?: EdgeWidths | LengthMetrics | LocalizedEdgeWidths; 3078 3079 /** 3080 * Defines the length of dash when BorderStyle is dashed. 3081 * 3082 * @type { ?(EdgeWidths | LengthMetrics | LocalizedEdgeWidths) } 3083 * @syscap SystemCapability.ArkUI.ArkUI.Full 3084 * @crossplatform 3085 * @atomicservice 3086 * @since 12 3087 */ 3088 dashWidth?: EdgeWidths | LengthMetrics | LocalizedEdgeWidths; 3089} 3090 3091/** 3092 * Defines the options of border. 3093 * 3094 * @interface OutlineOptions 3095 * @syscap SystemCapability.ArkUI.ArkUI.Full 3096 * @crossplatform 3097 * @form 3098 * @since 11 3099 */ 3100/** 3101 * Defines the options of border. 3102 * 3103 * @interface OutlineOptions 3104 * @syscap SystemCapability.ArkUI.ArkUI.Full 3105 * @crossplatform 3106 * @form 3107 * @atomicservice 3108 * @since 12 3109 */ 3110declare interface OutlineOptions { 3111 /** 3112 * Defines the outline width. 3113 * 3114 * @type { ?(EdgeOutlineWidths | Dimension) } 3115 * @syscap SystemCapability.ArkUI.ArkUI.Full 3116 * @crossplatform 3117 * @form 3118 * @since 11 3119 */ 3120 /** 3121 * Defines the outline width. 3122 * 3123 * @type { ?(EdgeOutlineWidths | Dimension) } 3124 * @syscap SystemCapability.ArkUI.ArkUI.Full 3125 * @crossplatform 3126 * @form 3127 * @atomicservice 3128 * @since 12 3129 */ 3130 width?: EdgeOutlineWidths | Dimension; 3131 3132 /** 3133 * Defines the outline color. 3134 * 3135 * @type { ?(EdgeColors | ResourceColor) } 3136 * @syscap SystemCapability.ArkUI.ArkUI.Full 3137 * @crossplatform 3138 * @form 3139 * @since 11 3140 */ 3141 /** 3142 * Defines the outline color. 3143 * 3144 * @type { ?(EdgeColors | ResourceColor | LocalizedEdgeColors) } 3145 * @syscap SystemCapability.ArkUI.ArkUI.Full 3146 * @crossplatform 3147 * @form 3148 * @atomicservice 3149 * @since 12 3150 */ 3151 color?: EdgeColors | ResourceColor | LocalizedEdgeColors; 3152 3153 /** 3154 * Defines the outline radius. 3155 * 3156 * @type { ?(OutlineRadiuses | Dimension) } 3157 * @syscap SystemCapability.ArkUI.ArkUI.Full 3158 * @crossplatform 3159 * @form 3160 * @since 11 3161 */ 3162 /** 3163 * Defines the outline radius. 3164 * 3165 * @type { ?(OutlineRadiuses | Dimension) } 3166 * @syscap SystemCapability.ArkUI.ArkUI.Full 3167 * @crossplatform 3168 * @form 3169 * @atomicservice 3170 * @since 12 3171 */ 3172 radius?: OutlineRadiuses | Dimension; 3173 3174 /** 3175 * Defines the outline style. 3176 * 3177 * @type { ?(EdgeOutlineStyles | OutlineStyle) } 3178 * @syscap SystemCapability.ArkUI.ArkUI.Full 3179 * @crossplatform 3180 * @form 3181 * @since 11 3182 */ 3183 /** 3184 * Defines the outline style. 3185 * 3186 * @type { ?(EdgeOutlineStyles | OutlineStyle) } 3187 * @syscap SystemCapability.ArkUI.ArkUI.Full 3188 * @crossplatform 3189 * @form 3190 * @atomicservice 3191 * @since 12 3192 */ 3193 style?: EdgeOutlineStyles | OutlineStyle; 3194} 3195 3196/** 3197 * Define the style of checkbox mark. 3198 * 3199 * @interface MarkStyle 3200 * @syscap SystemCapability.ArkUI.ArkUI.Full 3201 * @crossplatform 3202 * @since 10 3203 */ 3204/** 3205 * Define the style of checkbox mark. 3206 * 3207 * @interface MarkStyle 3208 * @syscap SystemCapability.ArkUI.ArkUI.Full 3209 * @crossplatform 3210 * @atomicservice 3211 * @since 11 3212 */ 3213declare interface MarkStyle { 3214 /** 3215 * Define the stroke color of checkbox mark. 3216 * 3217 * @type { ?ResourceColor } 3218 * @syscap SystemCapability.ArkUI.ArkUI.Full 3219 * @crossplatform 3220 * @since 10 3221 */ 3222 /** 3223 * Define the stroke color of checkbox mark. 3224 * 3225 * @type { ?ResourceColor } 3226 * @syscap SystemCapability.ArkUI.ArkUI.Full 3227 * @crossplatform 3228 * @atomicservice 3229 * @since 11 3230 */ 3231 strokeColor?: ResourceColor; 3232 3233 /** 3234 * Define the size of checkbox mark. 3235 * 3236 * @type { ?Length } 3237 * @syscap SystemCapability.ArkUI.ArkUI.Full 3238 * @crossplatform 3239 * @since 10 3240 */ 3241 /** 3242 * Define the size of checkbox mark. 3243 * 3244 * @type { ?Length } 3245 * @syscap SystemCapability.ArkUI.ArkUI.Full 3246 * @crossplatform 3247 * @atomicservice 3248 * @since 11 3249 */ 3250 size?: Length; 3251 3252 /** 3253 * Define the stroke width of checkbox mark. 3254 * 3255 * @type { ?Length } 3256 * @syscap SystemCapability.ArkUI.ArkUI.Full 3257 * @crossplatform 3258 * @since 10 3259 */ 3260 /** 3261 * Define the stroke width of checkbox mark. 3262 * 3263 * @type { ?Length } 3264 * @syscap SystemCapability.ArkUI.ArkUI.Full 3265 * @crossplatform 3266 * @atomicservice 3267 * @since 11 3268 */ 3269 strokeWidth?: Length; 3270} 3271 3272/** 3273 * Defines the ColorFilter object. 3274 * 3275 * @syscap SystemCapability.ArkUI.ArkUI.Full 3276 * @form 3277 * @since 9 3278 */ 3279/** 3280 * Defines the ColorFilter object. 3281 * 3282 * @syscap SystemCapability.ArkUI.ArkUI.Full 3283 * @crossplatform 3284 * @form 3285 * @since 10 3286 */ 3287/** 3288 * Defines the ColorFilter object. 3289 * 3290 * @syscap SystemCapability.ArkUI.ArkUI.Full 3291 * @crossplatform 3292 * @form 3293 * @atomicservice 3294 * @since 11 3295 */ 3296declare class ColorFilter { 3297 /** 3298 * Creates ColorFilter with 4*5 matrix. 3299 * 3300 * @param { number[] } value 4*5 color matrix values. The value[m*n] is located in the m row and n column. The matrix is row-first. 3301 * @syscap SystemCapability.ArkUI.ArkUI.Full 3302 * @form 3303 * @since 9 3304 */ 3305 /** 3306 * Creates ColorFilter with 4*5 matrix. 3307 * 3308 * @param { number[] } value 4*5 color matrix values. The value[m*n] is located in the m row and n column. The matrix is row-first. 3309 * @syscap SystemCapability.ArkUI.ArkUI.Full 3310 * @crossplatform 3311 * @form 3312 * @since 10 3313 */ 3314 /** 3315 * Creates ColorFilter with 4*5 matrix. 3316 * 3317 * @param { number[] } value 4*5 color matrix values. The value[m*n] is located in the m row and n column. The matrix is row-first. 3318 * @syscap SystemCapability.ArkUI.ArkUI.Full 3319 * @crossplatform 3320 * @form 3321 * @atomicservice 3322 * @since 11 3323 */ 3324 constructor(value: number[]); 3325} 3326 3327/** 3328 * Defines TouchPoint 3329 * 3330 * @interface TouchPoint 3331 * @syscap SystemCapability.ArkUI.ArkUI.Full 3332 * @since 11 3333 */ 3334/** 3335 * Defines TouchPoint 3336 * 3337 * @interface TouchPoint 3338 * @syscap SystemCapability.ArkUI.ArkUI.Full 3339 * @atomicservice 3340 * @since 12 3341 */ 3342/** 3343 * Defines TouchPoint 3344 * 3345 * @interface TouchPoint 3346 * @syscap SystemCapability.ArkUI.ArkUI.Full 3347 * @crossplatform 3348 * @atomicservice 3349 * @since 18 3350 */ 3351declare interface TouchPoint { 3352 /** 3353 * Define the touch point x coordinate. 3354 * 3355 * @type { Dimension } 3356 * @syscap SystemCapability.ArkUI.ArkUI.Full 3357 * @since 11 3358 */ 3359 /** 3360 * Define the touch point x coordinate. 3361 * 3362 * @type { Dimension } 3363 * @syscap SystemCapability.ArkUI.ArkUI.Full 3364 * @atomicservice 3365 * @since 12 3366 */ 3367 /** 3368 * Define the touch point x coordinate. 3369 * 3370 * @type { Dimension } 3371 * @syscap SystemCapability.ArkUI.ArkUI.Full 3372 * @crossplatform 3373 * @atomicservice 3374 * @since 18 3375 */ 3376 x: Dimension; 3377 3378 /** 3379 * Define the touch point y coordinate. 3380 * 3381 * @type { Dimension } 3382 * @syscap SystemCapability.ArkUI.ArkUI.Full 3383 * @since 11 3384 */ 3385 /** 3386 * Define the touch point y coordinate. 3387 * 3388 * @type { Dimension } 3389 * @syscap SystemCapability.ArkUI.ArkUI.Full 3390 * @atomicservice 3391 * @since 12 3392 */ 3393 /** 3394 * Define the touch point y coordinate. 3395 * 3396 * @type { Dimension } 3397 * @syscap SystemCapability.ArkUI.ArkUI.Full 3398 * @crossplatform 3399 * @atomicservice 3400 * @since 18 3401 */ 3402 y: Dimension; 3403} 3404 3405/** 3406 * Defines the DirectionalEdgesT interface. 3407 * 3408 * @interface DirectionalEdgesT 3409 * @syscap SystemCapability.ArkUI.ArkUI.Full 3410 * @crossplatform 3411 * @form 3412 * @atomicservice 3413 * @since 12 3414 */ 3415declare interface DirectionalEdgesT<T> { 3416 /** 3417 * Start property. 3418 * 3419 * @type { T } 3420 * @syscap SystemCapability.ArkUI.ArkUI.Full 3421 * @crossplatform 3422 * @form 3423 * @atomicservice 3424 * @since 12 3425 */ 3426 start: T; 3427 3428 /** 3429 * End property. 3430 * 3431 * @type { T } 3432 * @syscap SystemCapability.ArkUI.ArkUI.Full 3433 * @crossplatform 3434 * @form 3435 * @atomicservice 3436 * @since 12 3437 */ 3438 end: T; 3439 3440 /** 3441 * Top property. 3442 * 3443 * @type { T } 3444 * @syscap SystemCapability.ArkUI.ArkUI.Full 3445 * @crossplatform 3446 * @form 3447 * @atomicservice 3448 * @since 12 3449 */ 3450 top: T; 3451 3452 /** 3453 * Bottom property. 3454 * 3455 * @type { T } 3456 * @syscap SystemCapability.ArkUI.ArkUI.Full 3457 * @crossplatform 3458 * @form 3459 * @atomicservice 3460 * @since 12 3461 */ 3462 bottom: T; 3463} 3464 3465/** 3466 * Defines the struct of DividerStyleOptions. 3467 * 3468 * @interface DividerStyleOptions 3469 * @syscap SystemCapability.ArkUI.ArkUI.Full 3470 * @crossplatform 3471 * @atomicservice 3472 * @since 12 3473 */ 3474declare interface DividerStyleOptions { 3475 /** 3476 * The strokeWidth of Divider. 3477 * 3478 * @type { ?LengthMetrics } 3479 * @syscap SystemCapability.ArkUI.ArkUI.Full 3480 * @crossplatform 3481 * @atomicservice 3482 * @since 12 3483 */ 3484 strokeWidth?: LengthMetrics; 3485 3486 /** 3487 * The color of Divider. 3488 * 3489 * @type { ?ResourceColor } 3490 * @syscap SystemCapability.ArkUI.ArkUI.Full 3491 * @crossplatform 3492 * @atomicservice 3493 * @since 12 3494 */ 3495 color?: ResourceColor; 3496 3497 /** 3498 * The startMargin of Divider. 3499 * 3500 * @type { ?LengthMetrics } 3501 * @syscap SystemCapability.ArkUI.ArkUI.Full 3502 * @crossplatform 3503 * @atomicservice 3504 * @since 12 3505 */ 3506 startMargin?: LengthMetrics; 3507 3508 /** 3509 * The endMargin of Divider. 3510 * 3511 * @type { ?LengthMetrics } 3512 * @syscap SystemCapability.ArkUI.ArkUI.Full 3513 * @crossplatform 3514 * @atomicservice 3515 * @since 12 3516 */ 3517 endMargin?: LengthMetrics; 3518} 3519 3520/** 3521 * Defines the ChainWeightOptions interface. 3522 * 3523 * @interface ChainWeightOptions 3524 * @syscap SystemCapability.ArkUI.ArkUI.Full 3525 * @crossplatform 3526 * @atomicservice 3527 * @since 14 3528 */ 3529declare interface ChainWeightOptions { 3530 /** 3531 * Horizontal ChainWeight. 3532 * 3533 * @type { ?(number) } 3534 * @syscap SystemCapability.ArkUI.ArkUI.Full 3535 * @crossplatform 3536 * @atomicservice 3537 * @since 14 3538 */ 3539 horizontal?: number; 3540 3541 /** 3542 * Vertical ChainWeight. 3543 * 3544 * @type { ?(number) } 3545 * @syscap SystemCapability.ArkUI.ArkUI.Full 3546 * @crossplatform 3547 * @atomicservice 3548 * @since 14 3549 */ 3550 vertical?: number; 3551} 3552 3553/** 3554 * Defines the struct of AccessibilityOptions. 3555 * 3556 * @interface AccessibilityOptions 3557 * @syscap SystemCapability.ArkUI.ArkUI.Full 3558 * @crossplatform 3559 * @atomicservice 3560 * @since 14 3561 */ 3562declare interface AccessibilityOptions { 3563 /** 3564 * accessibilityPreferred - Should accessibilityText be prioritized when contatenating child component strings. 3565 * 3566 * @type { ?(boolean) } 3567 * @syscap SystemCapability.ArkUI.ArkUI.Full 3568 * @crossplatform 3569 * @atomicservice 3570 * @since 14 3571 */ 3572 accessibilityPreferred?: boolean; 3573} 3574