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