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