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