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 * Defines the option of Progress. 18 * 19 * @interface ProgressOptions 20 * @syscap SystemCapability.ArkUI.ArkUI.Full 21 * @since 7 22 */ 23/** 24 * Defines the option of Progress. 25 * 26 * @interface ProgressOptions 27 * @syscap SystemCapability.ArkUI.ArkUI.Full 28 * @since 9 29 * @form 30 */ 31/** 32 * Defines the option of Progress. 33 * 34 * @interface ProgressOptions 35 * @syscap SystemCapability.ArkUI.ArkUI.Full 36 * @crossplatform 37 * @since 10 38 * @form 39 */ 40/** 41 * Defines the option of Progress. 42 * 43 * @interface ProgressOptions 44 * @syscap SystemCapability.ArkUI.ArkUI.Full 45 * @crossplatform 46 * @atomicservice 47 * @since 11 48 * @form 49 */ 50declare interface ProgressOptions<Type extends keyof ProgressStyleMap> { 51 /** 52 * Sets the value of Progress. 53 * 54 * @type { number } 55 * @syscap SystemCapability.ArkUI.ArkUI.Full 56 * @since 7 57 */ 58 /** 59 * Sets the value of Progress. 60 * 61 * @type { number } 62 * @syscap SystemCapability.ArkUI.ArkUI.Full 63 * @since 9 64 * @form 65 */ 66 /** 67 * Sets the value of Progress. 68 * 69 * @type { number } 70 * @syscap SystemCapability.ArkUI.ArkUI.Full 71 * @crossplatform 72 * @since 10 73 * @form 74 */ 75 /** 76 * Sets the value of Progress. 77 * 78 * @type { number } 79 * @syscap SystemCapability.ArkUI.ArkUI.Full 80 * @crossplatform 81 * @atomicservice 82 * @since 11 83 * @form 84 */ 85 value: number; 86 87 /** 88 * Sets the total of Progress. 89 * 90 * @type { ?number } 91 * @syscap SystemCapability.ArkUI.ArkUI.Full 92 * @since 7 93 */ 94 /** 95 * Sets the total of Progress. 96 * 97 * @type { ?number } 98 * @syscap SystemCapability.ArkUI.ArkUI.Full 99 * @since 9 100 * @form 101 */ 102 /** 103 * Sets the total of Progress. 104 * 105 * @type { ?number } 106 * @syscap SystemCapability.ArkUI.ArkUI.Full 107 * @crossplatform 108 * @since 10 109 * @form 110 */ 111 /** 112 * Sets the total of Progress. 113 * 114 * @type { ?number } 115 * @syscap SystemCapability.ArkUI.ArkUI.Full 116 * @crossplatform 117 * @atomicservice 118 * @since 11 119 * @form 120 */ 121 total?: number; 122 123 /** 124 * Sets the style of Progress. 125 * 126 * @type { ?ProgressStyle } 127 * @syscap SystemCapability.ArkUI.ArkUI.Full 128 * @since 7 129 * @deprecated since 8 130 * @useinstead type 131 */ 132 style?: ProgressStyle 133 134 /** 135 * Sets the type of Progress. 136 * 137 * @type { ?Type } 138 * @syscap SystemCapability.ArkUI.ArkUI.Full 139 * @since 8 140 */ 141 /** 142 * Sets the type of Progress. 143 * 144 * @type { ?Type } 145 * @syscap SystemCapability.ArkUI.ArkUI.Full 146 * @since 9 147 * @form 148 */ 149 /** 150 * Sets the type of Progress. 151 * 152 * @type { ?Type } 153 * @syscap SystemCapability.ArkUI.ArkUI.Full 154 * @crossplatform 155 * @since 10 156 * @form 157 */ 158 /** 159 * Sets the type of Progress. 160 * 161 * @type { ?Type } 162 * @syscap SystemCapability.ArkUI.ArkUI.Full 163 * @crossplatform 164 * @atomicservice 165 * @since 11 166 * @form 167 */ 168 type?: Type 169} 170 171/** 172 * Type of progress bar 173 * 174 * @enum { number } 175 * @syscap SystemCapability.ArkUI.ArkUI.Full 176 * @since 8 177 */ 178/** 179 * Type of progress bar 180 * 181 * @enum { number } 182 * @syscap SystemCapability.ArkUI.ArkUI.Full 183 * @since 9 184 * @form 185 */ 186/** 187 * Type of progress bar 188 * 189 * @enum { number } 190 * @syscap SystemCapability.ArkUI.ArkUI.Full 191 * @crossplatform 192 * @since 10 193 * @form 194 */ 195/** 196 * Type of progress bar 197 * 198 * @enum { number } 199 * @syscap SystemCapability.ArkUI.ArkUI.Full 200 * @crossplatform 201 * @atomicservice 202 * @since 11 203 * @form 204 */ 205declare enum ProgressType { 206 /** 207 * Linear progress bar style. 208 * 209 * @syscap SystemCapability.ArkUI.ArkUI.Full 210 * @since 8 211 */ 212 /** 213 * Linear progress bar style. 214 * 215 * @syscap SystemCapability.ArkUI.ArkUI.Full 216 * @since 9 217 * @form 218 */ 219 /** 220 * Linear progress bar style. 221 * 222 * @syscap SystemCapability.ArkUI.ArkUI.Full 223 * @crossplatform 224 * @since 10 225 * @form 226 */ 227 /** 228 * Linear progress bar style. 229 * 230 * @syscap SystemCapability.ArkUI.ArkUI.Full 231 * @crossplatform 232 * @atomicservice 233 * @since 11 234 * @form 235 */ 236 Linear = 0, 237 238 /** 239 * Ring progress bar. 240 * 241 * @syscap SystemCapability.ArkUI.ArkUI.Full 242 * @since 8 243 */ 244 /** 245 * Ring progress bar. 246 * 247 * @syscap SystemCapability.ArkUI.ArkUI.Full 248 * @since 9 249 * @form 250 */ 251 /** 252 * Ring progress bar. 253 * 254 * @syscap SystemCapability.ArkUI.ArkUI.Full 255 * @crossplatform 256 * @since 10 257 * @form 258 */ 259 /** 260 * Ring progress bar. 261 * 262 * @syscap SystemCapability.ArkUI.ArkUI.Full 263 * @crossplatform 264 * @atomicservice 265 * @since 11 266 * @form 267 */ 268 Ring = 1, 269 270 /** 271 * Eclipse progress bar. 272 * 273 * @syscap SystemCapability.ArkUI.ArkUI.Full 274 * @since 8 275 */ 276 /** 277 * Eclipse progress bar. 278 * 279 * @syscap SystemCapability.ArkUI.ArkUI.Full 280 * @since 9 281 * @form 282 */ 283 /** 284 * Eclipse progress bar. 285 * 286 * @syscap SystemCapability.ArkUI.ArkUI.Full 287 * @crossplatform 288 * @since 10 289 * @form 290 */ 291 /** 292 * Eclipse progress bar. 293 * 294 * @syscap SystemCapability.ArkUI.ArkUI.Full 295 * @crossplatform 296 * @atomicservice 297 * @since 11 298 * @form 299 */ 300 Eclipse = 2, 301 302 /** 303 * ScaleRing progress bar. 304 * 305 * @syscap SystemCapability.ArkUI.ArkUI.Full 306 * @since 8 307 */ 308 /** 309 * ScaleRing progress bar. 310 * 311 * @syscap SystemCapability.ArkUI.ArkUI.Full 312 * @since 9 313 * @form 314 */ 315 /** 316 * ScaleRing progress bar. 317 * 318 * @syscap SystemCapability.ArkUI.ArkUI.Full 319 * @crossplatform 320 * @since 10 321 * @form 322 */ 323 /** 324 * ScaleRing progress bar. 325 * 326 * @syscap SystemCapability.ArkUI.ArkUI.Full 327 * @crossplatform 328 * @atomicservice 329 * @since 11 330 * @form 331 */ 332 ScaleRing = 3, 333 334 /** 335 * Capsule progress bar. 336 * 337 * @syscap SystemCapability.ArkUI.ArkUI.Full 338 * @since 8 339 */ 340 /** 341 * Capsule progress bar. 342 * 343 * @syscap SystemCapability.ArkUI.ArkUI.Full 344 * @since 9 345 * @form 346 */ 347 /** 348 * Capsule progress bar. 349 * 350 * @syscap SystemCapability.ArkUI.ArkUI.Full 351 * @crossplatform 352 * @since 10 353 * @form 354 */ 355 /** 356 * Capsule progress bar. 357 * 358 * @syscap SystemCapability.ArkUI.ArkUI.Full 359 * @crossplatform 360 * @atomicservice 361 * @since 11 362 * @form 363 */ 364 Capsule = 4 365} 366 367/** 368 * Current status of progress bar. 369 * 370 * @enum { number } 371 * @syscap SystemCapability.ArkUI.ArkUI.Full 372 * @since 10 373 */ 374/** 375 * Current status of progress bar. 376 * 377 * @enum { number } 378 * @syscap SystemCapability.ArkUI.ArkUI.Full 379 * @crossplatform 380 * @atomicservice 381 * @since 11 382 */ 383declare enum ProgressStatus { 384 /** 385 * Loading status. 386 * 387 * @syscap SystemCapability.ArkUI.ArkUI.Full 388 * @since 10 389 */ 390 /** 391 * Loading status. 392 * 393 * @syscap SystemCapability.ArkUI.ArkUI.Full 394 * @crossplatform 395 * @atomicservice 396 * @since 11 397 */ 398 LOADING, 399 400 /** 401 * Processing status. 402 * 403 * @syscap SystemCapability.ArkUI.ArkUI.Full 404 * @since 10 405 */ 406 /** 407 * Processing status. 408 * 409 * @syscap SystemCapability.ArkUI.ArkUI.Full 410 * @crossplatform 411 * @atomicservice 412 * @since 11 413 */ 414 PROGRESSING 415} 416 417/** 418 * Defines style options for progress component. 419 * 420 * @interface ProgressStyleOptions 421 * @syscap SystemCapability.ArkUI.ArkUI.Full 422 * @since 8 423 */ 424/** 425 * Defines style options for progress component. 426 * 427 * @interface ProgressStyleOptions 428 * @syscap SystemCapability.ArkUI.ArkUI.Full 429 * @since 9 430 * @form 431 */ 432/** 433 * Defines style options for progress component. 434 * 435 * @interface ProgressStyleOptions 436 * @syscap SystemCapability.ArkUI.ArkUI.Full 437 * @crossplatform 438 * @since 10 439 * @form 440 */ 441/** 442 * Defines style options for progress component. 443 * 444 * @interface ProgressStyleOptions 445 * @syscap SystemCapability.ArkUI.ArkUI.Full 446 * @crossplatform 447 * @atomicservice 448 * @since 11 449 * @form 450 */ 451declare interface ProgressStyleOptions extends CommonProgressStyleOptions { 452 /** 453 * Defines the strokeWidth property. 454 * 455 * @type { ?Length } 456 * @syscap SystemCapability.ArkUI.ArkUI.Full 457 * @since 8 458 */ 459 /** 460 * Defines the strokeWidth property. 461 * 462 * @type { ?Length } 463 * @syscap SystemCapability.ArkUI.ArkUI.Full 464 * @since 9 465 * @form 466 */ 467 /** 468 * Defines the strokeWidth property. 469 * 470 * @type { ?Length } 471 * @syscap SystemCapability.ArkUI.ArkUI.Full 472 * @crossplatform 473 * @since 10 474 * @form 475 */ 476 /** 477 * Defines the strokeWidth property. 478 * 479 * @type { ?Length } 480 * @syscap SystemCapability.ArkUI.ArkUI.Full 481 * @crossplatform 482 * @atomicservice 483 * @since 11 484 * @form 485 */ 486 strokeWidth?: Length; 487 488 /** 489 * Defines the scaleCount property. 490 * 491 * @type { ?number } 492 * @syscap SystemCapability.ArkUI.ArkUI.Full 493 * @since 8 494 */ 495 /** 496 * Defines the scaleCount property. 497 * 498 * @type { ?number } 499 * @syscap SystemCapability.ArkUI.ArkUI.Full 500 * @since 9 501 * @form 502 */ 503 /** 504 * Defines the scaleCount property. 505 * 506 * @type { ?number } 507 * @syscap SystemCapability.ArkUI.ArkUI.Full 508 * @crossplatform 509 * @since 10 510 * @form 511 */ 512 /** 513 * Defines the scaleCount property. 514 * 515 * @type { ?number } 516 * @syscap SystemCapability.ArkUI.ArkUI.Full 517 * @crossplatform 518 * @atomicservice 519 * @since 11 520 * @form 521 */ 522 scaleCount?: number; 523 524 /** 525 * Defines the scaleWidth property. 526 * 527 * @type { ?Length } 528 * @syscap SystemCapability.ArkUI.ArkUI.Full 529 * @since 8 530 */ 531 /** 532 * Defines the scaleWidth property. 533 * 534 * @type { ?Length } 535 * @syscap SystemCapability.ArkUI.ArkUI.Full 536 * @since 9 537 * @form 538 */ 539 /** 540 * Defines the scaleWidth property. 541 * 542 * @type { ?Length } 543 * @syscap SystemCapability.ArkUI.ArkUI.Full 544 * @crossplatform 545 * @since 10 546 * @form 547 */ 548 /** 549 * Defines the scaleWidth property. 550 * 551 * @type { ?Length } 552 * @syscap SystemCapability.ArkUI.ArkUI.Full 553 * @crossplatform 554 * @atomicservice 555 * @since 11 556 * @form 557 */ 558 scaleWidth?: Length; 559} 560 561/** 562 * Progress common style options. 563 * 564 * @interface CommonProgressStyleOptions 565 * @syscap SystemCapability.ArkUI.ArkUI.Full 566 * @since 10 567 */ 568/** 569 * Progress common style options. 570 * 571 * @interface CommonProgressStyleOptions 572 * @syscap SystemCapability.ArkUI.ArkUI.Full 573 * @crossplatform 574 * @atomicservice 575 * @since 11 576 */ 577declare interface CommonProgressStyleOptions { 578 /** 579 * Enable smooth effect. 580 * 581 * @type { ?boolean } 582 * @default true 583 * @syscap SystemCapability.ArkUI.ArkUI.Full 584 * @since 10 585 */ 586 /** 587 * Enable smooth effect. 588 * 589 * @type { ?boolean } 590 * @default true 591 * @syscap SystemCapability.ArkUI.ArkUI.Full 592 * @crossplatform 593 * @atomicservice 594 * @since 11 595 */ 596 enableSmoothEffect?: boolean; 597} 598 599/** 600 * Defines the enable scan effect. 601 * 602 * @interface ScanEffectOptions 603 * @syscap SystemCapability.ArkUI.ArkUI.Full 604 * @since 10 605 */ 606/** 607 * Defines the enable scan effect. 608 * 609 * @interface ScanEffectOptions 610 * @syscap SystemCapability.ArkUI.ArkUI.Full 611 * @crossplatform 612 * @atomicservice 613 * @since 11 614 */ 615declare interface ScanEffectOptions { 616 /** 617 * Enable scan effect. 618 * 619 * @type { ?boolean } 620 * @default false 621 * @syscap SystemCapability.ArkUI.ArkUI.Full 622 * @since 10 623 */ 624 /** 625 * Enable scan effect. 626 * 627 * @type { ?boolean } 628 * @default false 629 * @syscap SystemCapability.ArkUI.ArkUI.Full 630 * @crossplatform 631 * @atomicservice 632 * @since 11 633 */ 634 enableScanEffect?: boolean; 635} 636 637/** 638 * Defines the Eclipse style Options. 639 * 640 * @interface EclipseStyleOptions 641 * @syscap SystemCapability.ArkUI.ArkUI.Full 642 * @since 10 643 */ 644/** 645 * Defines the Eclipse style Options. 646 * 647 * @interface EclipseStyleOptions 648 * @syscap SystemCapability.ArkUI.ArkUI.Full 649 * @atomicservice 650 * @since 11 651 */ 652declare interface EclipseStyleOptions extends CommonProgressStyleOptions { 653 654} 655 656/** 657 * Defines the ScaleRing style Options. 658 * 659 * @interface ScaleRingStyleOptions 660 * @syscap SystemCapability.ArkUI.ArkUI.Full 661 * @since 10 662 */ 663/** 664 * Defines the ScaleRing style Options. 665 * 666 * @interface ScaleRingStyleOptions 667 * @syscap SystemCapability.ArkUI.ArkUI.Full 668 * @crossplatform 669 * @atomicservice 670 * @since 11 671 */ 672declare interface ScaleRingStyleOptions extends CommonProgressStyleOptions { 673 /** 674 * Defines the strokeWidth property. 675 * 676 * @type { ?Length } 677 * @syscap SystemCapability.ArkUI.ArkUI.Full 678 * @since 10 679 */ 680 /** 681 * Defines the strokeWidth property. 682 * 683 * @type { ?Length } 684 * @syscap SystemCapability.ArkUI.ArkUI.Full 685 * @crossplatform 686 * @atomicservice 687 * @since 11 688 */ 689 strokeWidth?: Length; 690 691 /** 692 * Defines the scaleWidth property. 693 * 694 * @type { ?Length } 695 * @syscap SystemCapability.ArkUI.ArkUI.Full 696 * @since 10 697 */ 698 /** 699 * Defines the scaleWidth property. 700 * 701 * @type { ?Length } 702 * @syscap SystemCapability.ArkUI.ArkUI.Full 703 * @crossplatform 704 * @atomicservice 705 * @since 11 706 */ 707 scaleWidth?: Length; 708 709 /** 710 * Defines the scaleCount property. 711 * 712 * @type { ?number } 713 * @syscap SystemCapability.ArkUI.ArkUI.Full 714 * @since 10 715 */ 716 /** 717 * Defines the scaleCount property. 718 * 719 * @type { ?number } 720 * @syscap SystemCapability.ArkUI.ArkUI.Full 721 * @crossplatform 722 * @atomicservice 723 * @since 11 724 */ 725 scaleCount?: number; 726} 727 728/** 729 * Defines the ring style Options. 730 * 731 * @interface RingStyleOptions 732 * @syscap SystemCapability.ArkUI.ArkUI.Full 733 * @since 10 734 */ 735/** 736 * Defines the ring style Options. 737 * 738 * @interface RingStyleOptions 739 * @syscap SystemCapability.ArkUI.ArkUI.Full 740 * @crossplatform 741 * @atomicservice 742 * @since 11 743 */ 744declare interface RingStyleOptions extends ScanEffectOptions, CommonProgressStyleOptions { 745 /** 746 * Defines the strokeWidth property. 747 * 748 * @type { ?Length } 749 * @syscap SystemCapability.ArkUI.ArkUI.Full 750 * @since 10 751 */ 752 /** 753 * Defines the strokeWidth property. 754 * 755 * @type { ?Length } 756 * @syscap SystemCapability.ArkUI.ArkUI.Full 757 * @crossplatform 758 * @atomicservice 759 * @since 11 760 */ 761 strokeWidth?: Length; 762 763 /** 764 * Enables progress shadow. 765 * 766 * @type { ?boolean } 767 * @syscap SystemCapability.ArkUI.ArkUI.Full 768 * @since 10 769 */ 770 /** 771 * Enables progress shadow. 772 * 773 * @type { ?boolean } 774 * @syscap SystemCapability.ArkUI.ArkUI.Full 775 * @crossplatform 776 * @atomicservice 777 * @since 11 778 */ 779 shadow?: boolean; 780 781 /** 782 * The status of progress, default is PROGRESSING. Set to LOADING status will trigger the loading animation. 783 * 784 * @type { ?ProgressStatus } 785 * @syscap SystemCapability.ArkUI.ArkUI.Full 786 * @since 10 787 */ 788 /** 789 * The status of progress, default is PROGRESSING. Set to LOADING status will trigger the loading animation. 790 * 791 * @type { ?ProgressStatus } 792 * @syscap SystemCapability.ArkUI.ArkUI.Full 793 * @crossplatform 794 * @atomicservice 795 * @since 11 796 */ 797 status?: ProgressStatus; 798} 799 800/** 801 * Defines the linear style Options. 802 * 803 * @interface LinearStyleOptions 804 * @syscap SystemCapability.ArkUI.ArkUI.Full 805 * @since 10 806 */ 807/** 808 * Defines the linear style Options. 809 * 810 * @interface LinearStyleOptions 811 * @syscap SystemCapability.ArkUI.ArkUI.Full 812 * @crossplatform 813 * @atomicservice 814 * @since 11 815 */ 816declare interface LinearStyleOptions extends ScanEffectOptions, CommonProgressStyleOptions { 817 /** 818 * Defines the strokeWidth property. 819 * 820 * @type { ?Length } 821 * @syscap SystemCapability.ArkUI.ArkUI.Full 822 * @since 10 823 */ 824 /** 825 * Defines the strokeWidth property. 826 * 827 * @type { ?Length } 828 * @syscap SystemCapability.ArkUI.ArkUI.Full 829 * @crossplatform 830 * @atomicservice 831 * @since 11 832 */ 833 strokeWidth?: Length; 834 /** 835 * Defines the stroke radius property. 836 * 837 * @type { ?(PX | VP | LPX | Resource) } 838 * @default strokeWidth / 2 839 * @syscap SystemCapability.ArkUI.ArkUI.Full 840 * @since 10 841 */ 842 /** 843 * Defines the stroke radius property. 844 * 845 * @type { ?(PX | VP | LPX | Resource) } 846 * @default strokeWidth / 2 847 * @syscap SystemCapability.ArkUI.ArkUI.Full 848 * @crossplatform 849 * @atomicservice 850 * @since 11 851 */ 852 strokeRadius?: PX | VP | LPX | Resource; 853} 854 855/** 856 * Defines the capsule style Options. 857 * 858 * @interface CapsuleStyleOptions 859 * @syscap SystemCapability.ArkUI.ArkUI.Full 860 * @since 10 861 */ 862/** 863 * Defines the capsule style Options. 864 * 865 * @interface CapsuleStyleOptions 866 * @syscap SystemCapability.ArkUI.ArkUI.Full 867 * @crossplatform 868 * @atomicservice 869 * @since 11 870 */ 871declare interface CapsuleStyleOptions extends ScanEffectOptions, CommonProgressStyleOptions { 872 /** 873 * Set the inner border color. 874 * 875 * @type { ?ResourceColor } 876 * @syscap SystemCapability.ArkUI.ArkUI.Full 877 * @since 10 878 */ 879 /** 880 * Set the inner border color. 881 * 882 * @type { ?ResourceColor } 883 * @syscap SystemCapability.ArkUI.ArkUI.Full 884 * @crossplatform 885 * @atomicservice 886 * @since 11 887 */ 888 borderColor?: ResourceColor; 889 890 /** 891 * Set the border width. 892 * 893 * @type { ?Length } 894 * @syscap SystemCapability.ArkUI.ArkUI.Full 895 * @since 10 896 */ 897 /** 898 * Set the border width. 899 * 900 * @type { ?Length } 901 * @syscap SystemCapability.ArkUI.ArkUI.Full 902 * @crossplatform 903 * @atomicservice 904 * @since 11 905 */ 906 borderWidth?: Length; 907 908 /** 909 * Set the text content. 910 * 911 * @type { ?string } 912 * @syscap SystemCapability.ArkUI.ArkUI.Full 913 * @since 10 914 */ 915 /** 916 * Set the text content. 917 * 918 * @type { ?string } 919 * @syscap SystemCapability.ArkUI.ArkUI.Full 920 * @crossplatform 921 * @atomicservice 922 * @since 11 923 */ 924 content?: string; 925 926 /** 927 * Set the text style. 928 * 929 * @type { ?Font } 930 * @syscap SystemCapability.ArkUI.ArkUI.Full 931 * @since 10 932 */ 933 /** 934 * Set the text style. 935 * 936 * @type { ?Font } 937 * @syscap SystemCapability.ArkUI.ArkUI.Full 938 * @crossplatform 939 * @atomicservice 940 * @since 11 941 */ 942 font?: Font; 943 944 /** 945 * Set the text fontColor. 946 * 947 * @type { ?ResourceColor } 948 * @syscap SystemCapability.ArkUI.ArkUI.Full 949 * @since 10 950 */ 951 /** 952 * Set the text fontColor. 953 * 954 * @type { ?ResourceColor } 955 * @syscap SystemCapability.ArkUI.ArkUI.Full 956 * @crossplatform 957 * @atomicservice 958 * @since 11 959 */ 960 fontColor?: ResourceColor; 961 962 /** 963 * show default percentage. 964 * 965 * @type { ?boolean } 966 * @default false 967 * @syscap SystemCapability.ArkUI.ArkUI.Full 968 * @since 10 969 */ 970 /** 971 * show default percentage. 972 * 973 * @type { ?boolean } 974 * @default false 975 * @syscap SystemCapability.ArkUI.ArkUI.Full 976 * @crossplatform 977 * @atomicservice 978 * @since 11 979 */ 980 showDefaultPercentage?: boolean; 981} 982 983/** 984 * Type of progress bar 985 * 986 * @enum { number } 987 * @syscap SystemCapability.ArkUI.ArkUI.Full 988 * @since 7 989 */ 990/** 991 * Type of progress bar 992 * 993 * @enum { number } 994 * @syscap SystemCapability.ArkUI.ArkUI.Full 995 * @since 9 996 * @form 997 */ 998/** 999 * Type of progress bar 1000 * 1001 * @enum { number } 1002 * @syscap SystemCapability.ArkUI.ArkUI.Full 1003 * @crossplatform 1004 * @since 10 1005 * @form 1006 */ 1007/** 1008 * Type of progress bar 1009 * 1010 * @enum { number } 1011 * @syscap SystemCapability.ArkUI.ArkUI.Full 1012 * @crossplatform 1013 * @atomicservice 1014 * @since 11 1015 * @form 1016 */ 1017declare enum ProgressStyle { 1018 /** 1019 * Linear progress bar style. 1020 * 1021 * @syscap SystemCapability.ArkUI.ArkUI.Full 1022 * @since 7 1023 */ 1024 /** 1025 * Linear progress bar style. 1026 * 1027 * @syscap SystemCapability.ArkUI.ArkUI.Full 1028 * @since 9 1029 * @form 1030 */ 1031 /** 1032 * Linear progress bar style. 1033 * 1034 * @syscap SystemCapability.ArkUI.ArkUI.Full 1035 * @crossplatform 1036 * @since 10 1037 * @form 1038 */ 1039 /** 1040 * Linear progress bar style. 1041 * 1042 * @syscap SystemCapability.ArkUI.ArkUI.Full 1043 * @crossplatform 1044 * @atomicservice 1045 * @since 11 1046 * @form 1047 */ 1048 Linear, 1049 1050 /** 1051 * Ring progress bar. 1052 * 1053 * @syscap SystemCapability.ArkUI.ArkUI.Full 1054 * @since 8 1055 */ 1056 /** 1057 * Ring progress bar. 1058 * 1059 * @syscap SystemCapability.ArkUI.ArkUI.Full 1060 * @since 9 1061 * @form 1062 */ 1063 /** 1064 * Ring progress bar. 1065 * 1066 * @syscap SystemCapability.ArkUI.ArkUI.Full 1067 * @crossplatform 1068 * @since 10 1069 * @form 1070 */ 1071 /** 1072 * Ring progress bar. 1073 * 1074 * @syscap SystemCapability.ArkUI.ArkUI.Full 1075 * @crossplatform 1076 * @atomicservice 1077 * @since 11 1078 * @form 1079 */ 1080 Ring, 1081 1082 /** 1083 * Eclipse progress bar. 1084 * 1085 * @syscap SystemCapability.ArkUI.ArkUI.Full 1086 * @since 7 1087 */ 1088 /** 1089 * Eclipse progress bar. 1090 * 1091 * @syscap SystemCapability.ArkUI.ArkUI.Full 1092 * @since 9 1093 * @form 1094 */ 1095 /** 1096 * Eclipse progress bar. 1097 * 1098 * @syscap SystemCapability.ArkUI.ArkUI.Full 1099 * @crossplatform 1100 * @since 10 1101 * @form 1102 */ 1103 /** 1104 * Eclipse progress bar. 1105 * 1106 * @syscap SystemCapability.ArkUI.ArkUI.Full 1107 * @crossplatform 1108 * @atomicservice 1109 * @since 11 1110 * @form 1111 */ 1112 Eclipse, 1113 1114 /** 1115 * ScaleRing progress bar. 1116 * 1117 * @syscap SystemCapability.ArkUI.ArkUI.Full 1118 * @since 8 1119 */ 1120 /** 1121 * ScaleRing progress bar. 1122 * 1123 * @syscap SystemCapability.ArkUI.ArkUI.Full 1124 * @since 9 1125 * @form 1126 */ 1127 /** 1128 * ScaleRing progress bar. 1129 * 1130 * @syscap SystemCapability.ArkUI.ArkUI.Full 1131 * @crossplatform 1132 * @since 10 1133 * @form 1134 */ 1135 /** 1136 * ScaleRing progress bar. 1137 * 1138 * @syscap SystemCapability.ArkUI.ArkUI.Full 1139 * @crossplatform 1140 * @atomicservice 1141 * @since 11 1142 * @form 1143 */ 1144 ScaleRing, 1145 1146 /** 1147 * Capsule progress bar. 1148 * 1149 * @syscap SystemCapability.ArkUI.ArkUI.Full 1150 * @since 8 1151 */ 1152 /** 1153 * Capsule progress bar. 1154 * 1155 * @syscap SystemCapability.ArkUI.ArkUI.Full 1156 * @since 9 1157 * @form 1158 */ 1159 /** 1160 * Capsule progress bar. 1161 * 1162 * @syscap SystemCapability.ArkUI.ArkUI.Full 1163 * @crossplatform 1164 * @since 10 1165 * @form 1166 */ 1167 /** 1168 * Capsule progress bar. 1169 * 1170 * @syscap SystemCapability.ArkUI.ArkUI.Full 1171 * @crossplatform 1172 * @atomicservice 1173 * @since 11 1174 * @form 1175 */ 1176 Capsule, 1177} 1178 1179/** 1180 * Defines the map for progress type and style. 1181 * 1182 * @interface ProgressStyleMap 1183 * @syscap SystemCapability.ArkUI.ArkUI.Full 1184 * @since 10 1185 */ 1186/** 1187 * Defines the map for progress type and style. 1188 * 1189 * @interface ProgressStyleMap 1190 * @syscap SystemCapability.ArkUI.ArkUI.Full 1191 * @atomicservice 1192 * @since 11 1193 */ 1194declare interface ProgressStyleMap { 1195 /** 1196 * Defines the map for Linear progress. 1197 * 1198 * @syscap SystemCapability.ArkUI.ArkUI.Full 1199 * @since 10 1200 */ 1201 /** 1202 * Defines the map for Linear progress. 1203 * 1204 * @syscap SystemCapability.ArkUI.ArkUI.Full 1205 * @atomicservice 1206 * @since 11 1207 */ 1208 [ProgressType.Linear]: LinearStyleOptions | ProgressStyleOptions; 1209 1210 /** 1211 * Defines the map for Ring progress. 1212 * 1213 * @syscap SystemCapability.ArkUI.ArkUI.Full 1214 * @since 10 1215 */ 1216 /** 1217 * Defines the map for Ring progress. 1218 * 1219 * @syscap SystemCapability.ArkUI.ArkUI.Full 1220 * @atomicservice 1221 * @since 11 1222 */ 1223 [ProgressType.Ring]: RingStyleOptions | ProgressStyleOptions; 1224 1225 /** 1226 * Defines the map for Eclipse progress. 1227 * 1228 * @syscap SystemCapability.ArkUI.ArkUI.Full 1229 * @since 10 1230 */ 1231 /** 1232 * Defines the map for Eclipse progress. 1233 * 1234 * @syscap SystemCapability.ArkUI.ArkUI.Full 1235 * @atomicservice 1236 * @since 11 1237 */ 1238 [ProgressType.Eclipse]: EclipseStyleOptions | ProgressStyleOptions; 1239 1240 /** 1241 * Defines the map for ScaleRing progress. 1242 * 1243 * @syscap SystemCapability.ArkUI.ArkUI.Full 1244 * @since 10 1245 */ 1246 /** 1247 * Defines the map for ScaleRing progress. 1248 * 1249 * @syscap SystemCapability.ArkUI.ArkUI.Full 1250 * @atomicservice 1251 * @since 11 1252 */ 1253 [ProgressType.ScaleRing]: ScaleRingStyleOptions | ProgressStyleOptions; 1254 1255 /** 1256 * Defines the map for Capsule progress. 1257 * 1258 * @syscap SystemCapability.ArkUI.ArkUI.Full 1259 * @since 10 1260 */ 1261 /** 1262 * Defines the map for Capsule progress. 1263 * 1264 * @syscap SystemCapability.ArkUI.ArkUI.Full 1265 * @atomicservice 1266 * @since 11 1267 */ 1268 [ProgressType.Capsule]: CapsuleStyleOptions | ProgressStyleOptions; 1269} 1270 1271/** 1272 * Provides the progress bar interface. 1273 * 1274 * @interface ProgressInterface 1275 * @syscap SystemCapability.ArkUI.ArkUI.Full 1276 * @since 7 1277 */ 1278/** 1279 * Provides the progress bar interface. 1280 * 1281 * @interface ProgressInterface 1282 * @syscap SystemCapability.ArkUI.ArkUI.Full 1283 * @since 9 1284 * @form 1285 */ 1286/** 1287 * Provides the progress bar interface. 1288 * 1289 * @interface ProgressInterface 1290 * @syscap SystemCapability.ArkUI.ArkUI.Full 1291 * @crossplatform 1292 * @since 10 1293 * @form 1294 */ 1295/** 1296 * Provides the progress bar interface. 1297 * 1298 * @interface ProgressInterface 1299 * @syscap SystemCapability.ArkUI.ArkUI.Full 1300 * @crossplatform 1301 * @atomicservice 1302 * @since 11 1303 * @form 1304 */ 1305interface ProgressInterface { 1306 /** 1307 * Called when the progress bar is set. 1308 * 1309 * @param { ProgressOptions<Type> } options 1310 * @returns { ProgressAttribute<Type> } 1311 * @syscap SystemCapability.ArkUI.ArkUI.Full 1312 * @since 7 1313 */ 1314 /** 1315 * Called when the progress bar is set. 1316 * 1317 * @param { ProgressOptions<Type> } options 1318 * @returns { ProgressAttribute<Type> } 1319 * @syscap SystemCapability.ArkUI.ArkUI.Full 1320 * @since 9 1321 * @form 1322 */ 1323 /** 1324 * Called when the progress bar is set. 1325 * 1326 * @param { ProgressOptions<Type> } options 1327 * @returns { ProgressAttribute<Type> } 1328 * @syscap SystemCapability.ArkUI.ArkUI.Full 1329 * @crossplatform 1330 * @since 10 1331 * @form 1332 */ 1333 /** 1334 * Called when the progress bar is set. 1335 * 1336 * @param { ProgressOptions<Type> } options 1337 * @returns { ProgressAttribute<Type> } 1338 * @syscap SystemCapability.ArkUI.ArkUI.Full 1339 * @crossplatform 1340 * @atomicservice 1341 * @since 11 1342 * @form 1343 */ 1344 <Type extends keyof ProgressStyleMap>(options: ProgressOptions<Type>): ProgressAttribute<Type>; 1345} 1346 1347/** 1348 * Defines the progress attribute functions. 1349 * 1350 * @extends CommonMethod<ProgressAttribute<Type>> 1351 * @syscap SystemCapability.ArkUI.ArkUI.Full 1352 * @since 7 1353 */ 1354/** 1355 * Defines the progress attribute functions. 1356 * 1357 * @extends CommonMethod<ProgressAttribute<Type>> 1358 * @syscap SystemCapability.ArkUI.ArkUI.Full 1359 * @since 9 1360 * @form 1361 */ 1362/** 1363 * Defines the progress attribute functions. 1364 * 1365 * @extends CommonMethod<ProgressAttribute<Type>> 1366 * @syscap SystemCapability.ArkUI.ArkUI.Full 1367 * @crossplatform 1368 * @since 10 1369 * @form 1370 */ 1371/** 1372 * Defines the progress attribute functions. 1373 * 1374 * @extends CommonMethod<ProgressAttribute<Type>> 1375 * @syscap SystemCapability.ArkUI.ArkUI.Full 1376 * @crossplatform 1377 * @atomicservice 1378 * @since 11 1379 * @form 1380 */ 1381declare class ProgressAttribute<Type extends keyof ProgressStyleMap = keyof ProgressStyleMap, 1382 Style extends ProgressStyleMap[Type] = ProgressStyleMap[Type]> extends CommonMethod<ProgressAttribute<Type>> { 1383 /** 1384 * Called when the current progress value is set. 1385 * 1386 * @param { number } value 1387 * @returns { ProgressAttribute<Type> } 1388 * @syscap SystemCapability.ArkUI.ArkUI.Full 1389 * @since 7 1390 */ 1391 /** 1392 * Called when the current progress value is set. 1393 * 1394 * @param { number } value 1395 * @returns { ProgressAttribute<Type> } 1396 * @syscap SystemCapability.ArkUI.ArkUI.Full 1397 * @since 9 1398 * @form 1399 */ 1400 /** 1401 * Called when the current progress value is set. 1402 * 1403 * @param { number } value 1404 * @returns { ProgressAttribute<Type> } 1405 * @syscap SystemCapability.ArkUI.ArkUI.Full 1406 * @crossplatform 1407 * @since 10 1408 * @form 1409 */ 1410 /** 1411 * Called when the current progress value is set. 1412 * 1413 * @param { number } value 1414 * @returns { ProgressAttribute<Type> } 1415 * @syscap SystemCapability.ArkUI.ArkUI.Full 1416 * @crossplatform 1417 * @atomicservice 1418 * @since 11 1419 * @form 1420 */ 1421 value(value: number): ProgressAttribute<Type>; 1422 1423 /** 1424 * Called when the progress bar foreground is set. 1425 * 1426 * @param { ResourceColor | LinearGradient } value 1427 * @returns { ProgressAttribute<Type> } 1428 * @syscap SystemCapability.ArkUI.ArkUI.Full 1429 * @since 7 1430 */ 1431 /** 1432 * Called when the progress bar foreground is set. 1433 * 1434 * @param { ResourceColor | LinearGradient } value 1435 * @returns { ProgressAttribute<Type> } 1436 * @syscap SystemCapability.ArkUI.ArkUI.Full 1437 * @since 9 1438 * @form 1439 */ 1440 /** 1441 * Called when the progress bar foreground is set. 1442 * 1443 * @param { ResourceColor | LinearGradient } value - indicates the color of the progress. 1444 * @returns { ProgressAttribute<Type> } the attribute of the progress. 1445 * @syscap SystemCapability.ArkUI.ArkUI.Full 1446 * @crossplatform 1447 * @since 10 1448 * @form 1449 */ 1450 /** 1451 * Called when the progress bar foreground is set. 1452 * 1453 * @param { ResourceColor | LinearGradient } value - indicates the color of the progress. 1454 * @returns { ProgressAttribute<Type> } the attribute of the progress. 1455 * @syscap SystemCapability.ArkUI.ArkUI.Full 1456 * @crossplatform 1457 * @atomicservice 1458 * @since 11 1459 * @form 1460 */ 1461 color(value: ResourceColor | LinearGradient): ProgressAttribute<Type>; 1462 1463 /** 1464 * Called when the style of progress bar is set. 1465 * 1466 * @param { Style } value 1467 * @returns { ProgressAttribute<Type> } 1468 * @syscap SystemCapability.ArkUI.ArkUI.Full 1469 * @since 8 1470 */ 1471 /** 1472 * Called when the style of progress bar is set. 1473 * 1474 * @param { Style } value 1475 * @returns { ProgressAttribute<Type> } 1476 * @syscap SystemCapability.ArkUI.ArkUI.Full 1477 * @since 9 1478 * @form 1479 */ 1480 /** 1481 * Called when the style of progress bar is set. 1482 * 1483 * @param { Style } value - indicates the style of the progress. 1484 * @returns { ProgressAttribute<Type> } the attribute of the progress. 1485 * @syscap SystemCapability.ArkUI.ArkUI.Full 1486 * @crossplatform 1487 * @since 10 1488 * @form 1489 */ 1490 /** 1491 * Called when the style of progress bar is set. 1492 * 1493 * @param { Style } value - indicates the style of the progress. 1494 * @returns { ProgressAttribute<Type> } the attribute of the progress. 1495 * @syscap SystemCapability.ArkUI.ArkUI.Full 1496 * @crossplatform 1497 * @atomicservice 1498 * @since 11 1499 * @form 1500 */ 1501 style(value: Style): ProgressAttribute<Type>; 1502} 1503 1504/** 1505 * Defines Progress Component. 1506 * 1507 * @syscap SystemCapability.ArkUI.ArkUI.Full 1508 * @since 7 1509 */ 1510/** 1511 * Defines Progress Component. 1512 * 1513 * @syscap SystemCapability.ArkUI.ArkUI.Full 1514 * @since 9 1515 * @form 1516 */ 1517/** 1518 * Defines Progress Component. 1519 * 1520 * @syscap SystemCapability.ArkUI.ArkUI.Full 1521 * @crossplatform 1522 * @since 10 1523 * @form 1524 */ 1525/** 1526 * Defines Progress Component. 1527 * 1528 * @syscap SystemCapability.ArkUI.ArkUI.Full 1529 * @crossplatform 1530 * @atomicservice 1531 * @since 11 1532 * @form 1533 */ 1534declare const Progress: ProgressInterface; 1535 1536/** 1537 * Defines Progress Component instance. 1538 * 1539 * @syscap SystemCapability.ArkUI.ArkUI.Full 1540 * @since 7 1541 */ 1542/** 1543 * Defines Progress Component instance. 1544 * 1545 * @syscap SystemCapability.ArkUI.ArkUI.Full 1546 * @since 9 1547 * @form 1548 */ 1549/** 1550 * Defines Progress Component instance. 1551 * 1552 * @syscap SystemCapability.ArkUI.ArkUI.Full 1553 * @crossplatform 1554 * @since 10 1555 * @form 1556 */ 1557/** 1558 * Defines Progress Component instance. 1559 * 1560 * @syscap SystemCapability.ArkUI.ArkUI.Full 1561 * @crossplatform 1562 * @atomicservice 1563 * @since 11 1564 * @form 1565 */ 1566declare const ProgressInstance: ProgressAttribute<keyof ProgressStyleMap>; 1567