1/* 2 * Copyright (c) 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 { Resource } from '../../global/resource'; 23import { ResourceColor } from './units'; 24import { FontWeight } from './enums'; 25import { CommonMethod,Optional } from "./common"; 26/*** endif */ 27 28/** 29 * Provides an interface for SymbolGlyph. 30 * 31 * @interface SymbolGlyphInterface 32 * @syscap SystemCapability.ArkUI.ArkUI.Full 33 * @since 11 34 */ 35/** 36 * Provides an interface for SymbolGlyph. 37 * 38 * @interface SymbolGlyphInterface 39 * @syscap SystemCapability.ArkUI.ArkUI.Full 40 * @form 41 * @atomicservice 42 * @since 12 43 */ 44/** 45 * Provides an interface for SymbolGlyph. 46 * 47 * @interface SymbolGlyphInterface 48 * @syscap SystemCapability.ArkUI.ArkUI.Full 49 * @crossplatform 50 * @form 51 * @atomicservice 52 * @since 20 53 * @arkts 1.1&1.2 54 */ 55interface SymbolGlyphInterface { 56 /** 57 * Called when resource is entered in SymbolGlyph. 58 * 59 * @param { Resource } value 60 * @returns { SymbolGlyphAttribute } 61 * @syscap SystemCapability.ArkUI.ArkUI.Full 62 * @since 11 63 */ 64 /** 65 * Called when resource is entered in SymbolGlyph. 66 * 67 * @param { Resource } value 68 * @returns { SymbolGlyphAttribute } 69 * @syscap SystemCapability.ArkUI.ArkUI.Full 70 * @form 71 * @atomicservice 72 * @since 12 73 */ 74 /** 75 * Called when resource is entered in SymbolGlyph. 76 * 77 * @param { Resource } value 78 * @returns { SymbolGlyphAttribute } 79 * @syscap SystemCapability.ArkUI.ArkUI.Full 80 * @crossplatform 81 * @form 82 * @atomicservice 83 * @since 20 84 * @arkts 1.1&1.2 85 */ 86 (value?: Resource): SymbolGlyphAttribute; 87} 88 89/** 90 * The symbol rendering strategy. 91 * 92 * @enum { number } 93 * @syscap SystemCapability.ArkUI.ArkUI.Full 94 * @since 11 95 */ 96/** 97 * The symbol rendering strategy. 98 * 99 * @enum { number } 100 * @syscap SystemCapability.ArkUI.ArkUI.Full 101 * @form 102 * @atomicservice 103 * @since 12 104 */ 105/** 106 * The symbol rendering strategy. 107 * 108 * @enum { number } 109 * @syscap SystemCapability.ArkUI.ArkUI.Full 110 * @crossplatform 111 * @form 112 * @atomicservice 113 * @since 20 114 * @arkts 1.1&1.2 115 */ 116declare enum SymbolRenderingStrategy { 117 /** 118 * The single rendering strategy. 119 * 120 * @syscap SystemCapability.ArkUI.ArkUI.Full 121 * @since 11 122 */ 123 /** 124 * The single rendering strategy. 125 * 126 * @syscap SystemCapability.ArkUI.ArkUI.Full 127 * @form 128 * @atomicservice 129 * @since 12 130 */ 131 /** 132 * The single rendering strategy. 133 * 134 * @syscap SystemCapability.ArkUI.ArkUI.Full 135 * @crossplatform 136 * @form 137 * @atomicservice 138 * @since 20 139 * @arkts 1.1&1.2 140 */ 141 SINGLE = 0, 142 143 /** 144 * The multiple color rendering strategy. 145 * 146 * @syscap SystemCapability.ArkUI.ArkUI.Full 147 * @since 11 148 */ 149 /** 150 * The multiple color rendering strategy. 151 * 152 * @syscap SystemCapability.ArkUI.ArkUI.Full 153 * @form 154 * @atomicservice 155 * @since 12 156 */ 157 /** 158 * The multiple color rendering strategy. 159 * 160 * @syscap SystemCapability.ArkUI.ArkUI.Full 161 * @crossplatform 162 * @form 163 * @atomicservice 164 * @since 20 165 * @arkts 1.1&1.2 166 */ 167 MULTIPLE_COLOR = 1, 168 169 /** 170 * The multiple opacity rendering strategy. 171 * 172 * @syscap SystemCapability.ArkUI.ArkUI.Full 173 * @since 11 174 */ 175 /** 176 * The multiple opacity rendering strategy. 177 * 178 * @syscap SystemCapability.ArkUI.ArkUI.Full 179 * @form 180 * @atomicservice 181 * @since 12 182 */ 183 /** 184 * The multiple opacity rendering strategy. 185 * 186 * @syscap SystemCapability.ArkUI.ArkUI.Full 187 * @crossplatform 188 * @form 189 * @atomicservice 190 * @since 20 191 * @arkts 1.1&1.2 192 */ 193 MULTIPLE_OPACITY = 2, 194} 195 196/** 197 * The symbol effect strategy. 198 * 199 * @enum { number } 200 * @syscap SystemCapability.ArkUI.ArkUI.Full 201 * @since 11 202 */ 203/** 204 * The symbol effect strategy. 205 * 206 * @enum { number } 207 * @syscap SystemCapability.ArkUI.ArkUI.Full 208 * @form 209 * @atomicservice 210 * @since 12 211 */ 212/** 213 * The symbol effect strategy. 214 * 215 * @enum { number } 216 * @syscap SystemCapability.ArkUI.ArkUI.Full 217 * @crossplatform 218 * @form 219 * @atomicservice 220 * @since 20 221 * @arkts 1.1&1.2 222 */ 223declare enum SymbolEffectStrategy { 224 /** 225 * There is no effect strategy. 226 * 227 * @syscap SystemCapability.ArkUI.ArkUI.Full 228 * @since 11 229 */ 230 /** 231 * There is no effect strategy. 232 * 233 * @syscap SystemCapability.ArkUI.ArkUI.Full 234 * @form 235 * @atomicservice 236 * @since 12 237 */ 238 /** 239 * There is no effect strategy. 240 * 241 * @syscap SystemCapability.ArkUI.ArkUI.Full 242 * @crossplatform 243 * @form 244 * @atomicservice 245 * @since 20 246 * @arkts 1.1&1.2 247 */ 248 NONE = 0, 249 250 /** 251 * The scale effect strategy. 252 * 253 * @syscap SystemCapability.ArkUI.ArkUI.Full 254 * @since 11 255 */ 256 /** 257 * The scale effect strategy. 258 * 259 * @syscap SystemCapability.ArkUI.ArkUI.Full 260 * @form 261 * @atomicservice 262 * @since 12 263 */ 264 /** 265 * The scale effect strategy. 266 * 267 * @syscap SystemCapability.ArkUI.ArkUI.Full 268 * @crossplatform 269 * @form 270 * @atomicservice 271 * @since 20 272 * @arkts 1.1&1.2 273 */ 274 SCALE = 1, 275 276 /** 277 * The hierarchical effect strategy. 278 * 279 * @syscap SystemCapability.ArkUI.ArkUI.Full 280 * @since 11 281 */ 282 /** 283 * The hierarchical effect strategy. 284 * 285 * @syscap SystemCapability.ArkUI.ArkUI.Full 286 * @form 287 * @atomicservice 288 * @since 12 289 */ 290 /** 291 * The hierarchical effect strategy. 292 * 293 * @syscap SystemCapability.ArkUI.ArkUI.Full 294 * @crossplatform 295 * @form 296 * @atomicservice 297 * @since 20 298 * @arkts 1.1&1.2 299 */ 300 HIERARCHICAL = 2, 301} 302 303/** 304 * The direction type of symbol effect 305 * 306 * @enum { number } 307 * @syscap SystemCapability.ArkUI.ArkUI.Full 308 * @form 309 * @atomicservice 310 * @since 12 311 */ 312/** 313 * The direction type of symbol effect 314 * 315 * @enum { number } 316 * @syscap SystemCapability.ArkUI.ArkUI.Full 317 * @crossplatform 318 * @form 319 * @atomicservice 320 * @since 20 321 * @arkts 1.1&1.2 322 */ 323declare enum EffectDirection { 324 /** 325 * The scale down animation of symbol 326 * 327 * @syscap SystemCapability.ArkUI.ArkUI.Full 328 * @form 329 * @atomicservice 330 * @since 12 331 */ 332 /** 333 * The scale down animation of symbol 334 * 335 * @syscap SystemCapability.ArkUI.ArkUI.Full 336 * @crossplatform 337 * @form 338 * @atomicservice 339 * @since 20 340 * @arkts 1.1&1.2 341 */ 342 DOWN = 0, 343 /** 344 * The scale up animation of symbol 345 * 346 * @syscap SystemCapability.ArkUI.ArkUI.Full 347 * @form 348 * @atomicservice 349 * @since 12 350 */ 351 /** 352 * The scale up animation of symbol 353 * 354 * @syscap SystemCapability.ArkUI.ArkUI.Full 355 * @crossplatform 356 * @form 357 * @atomicservice 358 * @since 20 359 * @arkts 1.1&1.2 360 */ 361 UP = 1, 362} 363 364/** 365 * Declare scope type of the symbol effect 366 * 367 * @enum { number } 368 * @syscap SystemCapability.ArkUI.ArkUI.Full 369 * @form 370 * @atomicservice 371 * @since 12 372 */ 373/** 374 * Declare scope type of the symbol effect 375 * 376 * @enum { number } 377 * @syscap SystemCapability.ArkUI.ArkUI.Full 378 * @crossplatform 379 * @form 380 * @atomicservice 381 * @since 20 382 * @arkts 1.1&1.2 383 */ 384declare enum EffectScope { 385 /** 386 * The layered animation of symbol 387 * 388 * @syscap SystemCapability.ArkUI.ArkUI.Full 389 * @form 390 * @atomicservice 391 * @since 12 392 */ 393 /** 394 * The layered animation of symbol 395 * 396 * @syscap SystemCapability.ArkUI.ArkUI.Full 397 * @crossplatform 398 * @form 399 * @atomicservice 400 * @since 20 401 * @arkts 1.1&1.2 402 */ 403 LAYER = 0, 404 /** 405 * The whole animation of symbol 406 * 407 * @syscap SystemCapability.ArkUI.ArkUI.Full 408 * @form 409 * @atomicservice 410 * @since 12 411 */ 412 /** 413 * The whole animation of symbol 414 * 415 * @syscap SystemCapability.ArkUI.ArkUI.Full 416 * @crossplatform 417 * @form 418 * @atomicservice 419 * @since 20 420 * @arkts 1.1&1.2 421 */ 422 WHOLE = 1, 423} 424 425/** 426 * Declare fill style of symbol 427 * 428 * @enum { number } 429 * @syscap SystemCapability.ArkUI.ArkUI.Full 430 * @form 431 * @atomicservice 432 * @since 12 433 */ 434/** 435 * Declare fill style of symbol 436 * 437 * @enum { number } 438 * @syscap SystemCapability.ArkUI.ArkUI.Full 439 * @crossplatform 440 * @form 441 * @atomicservice 442 * @since 20 443 * @arkts 1.1&1.2 444 */ 445declare enum EffectFillStyle { 446 /** 447 * The cumulative fill style of symbol 448 * 449 * @syscap SystemCapability.ArkUI.ArkUI.Full 450 * @form 451 * @atomicservice 452 * @since 12 453 */ 454 /** 455 * The cumulative fill style of symbol 456 * 457 * @syscap SystemCapability.ArkUI.ArkUI.Full 458 * @crossplatform 459 * @form 460 * @atomicservice 461 * @since 20 462 * @arkts 1.1&1.2 463 */ 464 CUMULATIVE = 0, 465 466 /** 467 * The iterative fill style of symbol 468 * 469 * @syscap SystemCapability.ArkUI.ArkUI.Full 470 * @form 471 * @atomicservice 472 * @since 12 473 */ 474 /** 475 * The iterative fill style of symbol 476 * 477 * @syscap SystemCapability.ArkUI.ArkUI.Full 478 * @crossplatform 479 * @form 480 * @atomicservice 481 * @since 20 482 * @arkts 1.1&1.2 483 */ 484 ITERATIVE = 1, 485} 486 487/** 488 * The replace effect type of symbol. 489 * 490 * @enum { number } 491 * @syscap SystemCapability.ArkUI.ArkUI.Full 492 * @crossplatform 493 * @form 494 * @atomicservice 495 * @since 20 496 */ 497declare enum ReplaceEffectType { 498 /** 499 * The default replace effect of symbol, the current symbol fully disappears before the new symbol fades in. 500 * 501 * @syscap SystemCapability.ArkUI.ArkUI.Full 502 * @crossplatform 503 * @form 504 * @atomicservice 505 * @since 20 506 */ 507 SEQUENTIAL = 0, 508 509 /** 510 * The current symbol fades out while the new symbol fades in at the same time, 511 * producing a smoother and faster transition. 512 * 513 * @syscap SystemCapability.ArkUI.ArkUI.Full 514 * @crossplatform 515 * @form 516 * @atomicservice 517 * @since 20 518 */ 519 CROSS_FADE = 1, 520 521 /** 522 * Replaces the current symbol with a symbol that includes a diagonal slash overlay, 523 * typically used to indicate a disabled or inactive state. 524 * If a corresponding slashed symbol variant is not available, the symbol is replaced without animation. 525 * 526 * @syscap SystemCapability.ArkUI.ArkUI.Full 527 * @crossplatform 528 * @form 529 * @atomicservice 530 * @since 20 531 */ 532 SLASH_OVERLAY = 2, 533} 534 535/** 536 * Defines SymbolEffect class. 537 * 538 * @syscap SystemCapability.ArkUI.ArkUI.Full 539 * @form 540 * @atomicservice 541 * @since 12 542 */ 543/** 544 * Defines SymbolEffect class. 545 * 546 * @syscap SystemCapability.ArkUI.ArkUI.Full 547 * @crossplatform 548 * @form 549 * @atomicservice 550 * @since 20 551 * @arkts 1.1&1.2 552 */ 553declare class SymbolEffect { 554} 555 556/** 557 * Defines ScaleSymbolEffect class. 558 * 559 * @extends SymbolEffect 560 * @syscap SystemCapability.ArkUI.ArkUI.Full 561 * @form 562 * @atomicservice 563 * @since 12 564 */ 565/** 566 * Defines ScaleSymbolEffect class. 567 * 568 * @extends SymbolEffect 569 * @syscap SystemCapability.ArkUI.ArkUI.Full 570 * @crossplatform 571 * @form 572 * @atomicservice 573 * @since 20 574 * @arkts 1.1&1.2 575 */ 576declare class ScaleSymbolEffect extends SymbolEffect { 577 /** 578 * constructor. 579 * 580 * @param { EffectScope } [scope] - The scope type of symbol effect. 581 * @param { EffectDirection } [direction] - The direction of symbol effect. 582 * @syscap SystemCapability.ArkUI.ArkUI.Full 583 * @form 584 * @atomicservice 585 * @since 12 586 */ 587 /** 588 * constructor. 589 * 590 * @param { EffectScope } [scope] - The scope type of symbol effect. 591 * @param { EffectDirection } [direction] - The direction of symbol effect. 592 * @syscap SystemCapability.ArkUI.ArkUI.Full 593 * @crossplatform 594 * @form 595 * @atomicservice 596 * @since 20 597 * @arkts 1.1&1.2 598 */ 599 constructor(scope?: EffectScope, direction?: EffectDirection); 600 601 /** 602 * The scope type of symbol effect 603 * 604 * @type { ?EffectScope } 605 * @syscap SystemCapability.ArkUI.ArkUI.Full 606 * @form 607 * @atomicservice 608 * @since 12 609 */ 610 /** 611 * The scope type of symbol effect 612 * 613 * @type { ?EffectScope } 614 * @syscap SystemCapability.ArkUI.ArkUI.Full 615 * @crossplatform 616 * @form 617 * @atomicservice 618 * @since 20 619 * @arkts 1.1&1.2 620 */ 621 scope?: EffectScope; 622 623 /** 624 * The direction of symbol effect 625 * 626 * @type { ?EffectDirection } 627 * @syscap SystemCapability.ArkUI.ArkUI.Full 628 * @form 629 * @atomicservice 630 * @since 12 631 */ 632 /** 633 * The direction of symbol effect 634 * 635 * @type { ?EffectDirection } 636 * @syscap SystemCapability.ArkUI.ArkUI.Full 637 * @crossplatform 638 * @form 639 * @atomicservice 640 * @since 20 641 * @arkts 1.1&1.2 642 */ 643 direction?: EffectDirection; 644} 645 646/** 647 * Defines HierarchicalSymbolEffect class. 648 * 649 * @extends SymbolEffect 650 * @syscap SystemCapability.ArkUI.ArkUI.Full 651 * @form 652 * @atomicservice 653 * @since 12 654 */ 655/** 656 * Defines HierarchicalSymbolEffect class. 657 * 658 * @extends SymbolEffect 659 * @syscap SystemCapability.ArkUI.ArkUI.Full 660 * @crossplatform 661 * @form 662 * @atomicservice 663 * @since 20 664 * @arkts 1.1&1.2 665 */ 666declare class HierarchicalSymbolEffect extends SymbolEffect { 667 /** 668 * constructor. 669 * 670 * @param { EffectFillStyle } [fillStyle] - The fill style of symbol effect. 671 * @syscap SystemCapability.ArkUI.ArkUI.Full 672 * @form 673 * @atomicservice 674 * @since 12 675 */ 676 /** 677 * constructor. 678 * 679 * @param { EffectFillStyle } [fillStyle] - The fill style of symbol effect. 680 * @syscap SystemCapability.ArkUI.ArkUI.Full 681 * @crossplatform 682 * @form 683 * @atomicservice 684 * @since 20 685 * @arkts 1.1&1.2 686 */ 687 constructor(fillStyle?: EffectFillStyle); 688 689 /** 690 * The fill style of symbol effect 691 * 692 * @type { ?EffectFillStyle } 693 * @syscap SystemCapability.ArkUI.ArkUI.Full 694 * @form 695 * @atomicservice 696 * @since 12 697 */ 698 /** 699 * The fill style of symbol effect 700 * 701 * @type { ?EffectFillStyle } 702 * @syscap SystemCapability.ArkUI.ArkUI.Full 703 * @crossplatform 704 * @form 705 * @atomicservice 706 * @since 20 707 * @arkts 1.1&1.2 708 */ 709 fillStyle?: EffectFillStyle; 710} 711 712/** 713 * Defines AppearSymbolEffect class. 714 * 715 * @extends SymbolEffect 716 * @syscap SystemCapability.ArkUI.ArkUI.Full 717 * @form 718 * @atomicservice 719 * @since 12 720 */ 721/** 722 * Defines AppearSymbolEffect class. 723 * 724 * @extends SymbolEffect 725 * @syscap SystemCapability.ArkUI.ArkUI.Full 726 * @crossplatform 727 * @form 728 * @atomicservice 729 * @since 20 730 * @arkts 1.1&1.2 731 */ 732declare class AppearSymbolEffect extends SymbolEffect { 733 /** 734 * constructor. 735 * 736 * @param { EffectScope } [scope] - The scope type of symbol effect. 737 * @syscap SystemCapability.ArkUI.ArkUI.Full 738 * @form 739 * @atomicservice 740 * @since 12 741 */ 742 /** 743 * constructor. 744 * 745 * @param { EffectScope } [scope] - The scope type of symbol effect. 746 * @syscap SystemCapability.ArkUI.ArkUI.Full 747 * @crossplatform 748 * @form 749 * @atomicservice 750 * @since 20 751 * @arkts 1.1&1.2 752 */ 753 constructor(scope?: EffectScope); 754 755 /** 756 * The scope type of symbol effect 757 * 758 * @type { ?EffectScope } 759 * @syscap SystemCapability.ArkUI.ArkUI.Full 760 * @form 761 * @atomicservice 762 * @since 12 763 */ 764 /** 765 * The scope type of symbol effect 766 * 767 * @type { ?EffectScope } 768 * @syscap SystemCapability.ArkUI.ArkUI.Full 769 * @crossplatform 770 * @form 771 * @atomicservice 772 * @since 20 773 * @arkts 1.1&1.2 774 */ 775 scope?: EffectScope; 776} 777 778/** 779 * Defines DisappearSymbolEffect class. 780 * 781 * @extends SymbolEffect 782 * @syscap SystemCapability.ArkUI.ArkUI.Full 783 * @form 784 * @atomicservice 785 * @since 12 786 */ 787/** 788 * Defines DisappearSymbolEffect class. 789 * 790 * @extends SymbolEffect 791 * @syscap SystemCapability.ArkUI.ArkUI.Full 792 * @crossplatform 793 * @form 794 * @atomicservice 795 * @since 20 796 * @arkts 1.1&1.2 797 */ 798declare class DisappearSymbolEffect extends SymbolEffect { 799 /** 800 * constructor. 801 * 802 * @param { EffectScope } [scope] - The scope type of symbol effect. 803 * @syscap SystemCapability.ArkUI.ArkUI.Full 804 * @form 805 * @atomicservice 806 * @since 12 807 */ 808 /** 809 * constructor. 810 * 811 * @param { EffectScope } [scope] - The scope type of symbol effect. 812 * @syscap SystemCapability.ArkUI.ArkUI.Full 813 * @crossplatform 814 * @form 815 * @atomicservice 816 * @since 20 817 * @arkts 1.1&1.2 818 */ 819 constructor(scope?: EffectScope); 820 821 /** 822 * The scope type of symbol effect 823 * 824 * @type { ?EffectScope } 825 * @syscap SystemCapability.ArkUI.ArkUI.Full 826 * @form 827 * @atomicservice 828 * @since 12 829 */ 830 /** 831 * The scope type of symbol effect 832 * 833 * @type { ?EffectScope } 834 * @syscap SystemCapability.ArkUI.ArkUI.Full 835 * @crossplatform 836 * @form 837 * @atomicservice 838 * @since 20 839 * @arkts 1.1&1.2 840 */ 841 scope?: EffectScope; 842} 843 844/** 845 * Defines BounceSymbolEffect class. 846 * 847 * @extends SymbolEffect 848 * @syscap SystemCapability.ArkUI.ArkUI.Full 849 * @form 850 * @atomicservice 851 * @since 12 852 */ 853/** 854 * Defines BounceSymbolEffect class. 855 * 856 * @extends SymbolEffect 857 * @syscap SystemCapability.ArkUI.ArkUI.Full 858 * @crossplatform 859 * @form 860 * @atomicservice 861 * @since 20 862 * @arkts 1.1&1.2 863 */ 864declare class BounceSymbolEffect extends SymbolEffect { 865 /** 866 * constructor. 867 * 868 * @param { EffectScope } [scope] - The scope type of symbol effect. 869 * @param { EffectDirection } [direction] - The direction of symbol effect. 870 * @syscap SystemCapability.ArkUI.ArkUI.Full 871 * @form 872 * @atomicservice 873 * @since 12 874 */ 875 /** 876 * constructor. 877 * 878 * @param { EffectScope } [scope] - The scope type of symbol effect. 879 * @param { EffectDirection } [direction] - The direction of symbol effect. 880 * @syscap SystemCapability.ArkUI.ArkUI.Full 881 * @crossplatform 882 * @form 883 * @atomicservice 884 * @since 20 885 * @arkts 1.1&1.2 886 */ 887 constructor(scope?: EffectScope, direction?: EffectDirection); 888 889 /** 890 * The scope type of symbol effect 891 * 892 * @type { ?EffectScope } 893 * @syscap SystemCapability.ArkUI.ArkUI.Full 894 * @form 895 * @atomicservice 896 * @since 12 897 */ 898 /** 899 * The scope type of symbol effect 900 * 901 * @type { ?EffectScope } 902 * @syscap SystemCapability.ArkUI.ArkUI.Full 903 * @crossplatform 904 * @form 905 * @atomicservice 906 * @since 20 907 * @arkts 1.1&1.2 908 */ 909 scope?: EffectScope; 910 911 /** 912 * The direction of symbol effect 913 * 914 * @type { ?EffectDirection } 915 * @syscap SystemCapability.ArkUI.ArkUI.Full 916 * @form 917 * @atomicservice 918 * @since 12 919 */ 920 /** 921 * The direction of symbol effect 922 * 923 * @type { ?EffectDirection } 924 * @syscap SystemCapability.ArkUI.ArkUI.Full 925 * @crossplatform 926 * @form 927 * @atomicservice 928 * @since 20 929 * @arkts 1.1&1.2 930 */ 931 direction?: EffectDirection; 932} 933 934/** 935 * Defines ReplaceSymbolEffect class. 936 * 937 * @extends SymbolEffect 938 * @syscap SystemCapability.ArkUI.ArkUI.Full 939 * @form 940 * @atomicservice 941 * @since 12 942 */ 943/** 944 * Defines ReplaceSymbolEffect class. 945 * 946 * @extends SymbolEffect 947 * @syscap SystemCapability.ArkUI.ArkUI.Full 948 * @crossplatform 949 * @form 950 * @atomicservice 951 * @since 20 952 * @arkts 1.1&1.2 953 */ 954declare class ReplaceSymbolEffect extends SymbolEffect { 955 /** 956 * constructor. 957 * 958 * @param { EffectScope } [scope] - The scope type of symbol effect. 959 * @syscap SystemCapability.ArkUI.ArkUI.Full 960 * @form 961 * @atomicservice 962 * @since 12 963 */ 964 /** 965 * constructor. 966 * 967 * @param { EffectScope } [scope] - The scope type of symbol effect. 968 * @syscap SystemCapability.ArkUI.ArkUI.Full 969 * @crossplatform 970 * @form 971 * @atomicservice 972 * @since 20 973 * @arkts 1.1&1.2 974 */ 975 constructor(scope?: EffectScope); 976 977 /** 978 * constructor. 979 * @param { EffectScope } [scope] - The scope type of symbol effect. 980 * @param { ReplaceEffectType } [replaceType] - The replace effect type of symbol effect. 981 * @syscap SystemCapability.ArkUI.ArkUI.Full 982 * @crossplatform 983 * @form 984 * @atomicservice 985 * @since 20 986 */ 987 constructor(scope?: EffectScope, replaceType?: ReplaceEffectType); 988 989 /** 990 * The scope type of symbol effect 991 * 992 * @type { ?EffectScope } 993 * @syscap SystemCapability.ArkUI.ArkUI.Full 994 * @form 995 * @atomicservice 996 * @since 12 997 */ 998 /** 999 * The scope type of symbol effect 1000 * 1001 * @type { ?EffectScope } 1002 * @syscap SystemCapability.ArkUI.ArkUI.Full 1003 * @crossplatform 1004 * @form 1005 * @atomicservice 1006 * @since 20 1007 * @arkts 1.1&1.2 1008 */ 1009 scope?: EffectScope; 1010 1011 /** 1012 * The replace effect type of symbol effect. 1013 * 1014 * @type { ?ReplaceEffectType } 1015 * @syscap SystemCapability.ArkUI.ArkUI.Full 1016 * @crossplatform 1017 * @form 1018 * @atomicservice 1019 * @since 20 1020 */ 1021 replaceType?: ReplaceEffectType; 1022} 1023 1024/** 1025 * Defines PulseSymbolEffect class. 1026 * 1027 * @extends SymbolEffect 1028 * @syscap SystemCapability.ArkUI.ArkUI.Full 1029 * @form 1030 * @atomicservice 1031 * @since arkts {'1.1':'12', '1.2':'20'} 1032 * @arkts 1.1&1.2 1033 */ 1034declare class PulseSymbolEffect extends SymbolEffect { 1035} 1036 1037/** 1038 * Provides attribute for SymbolGlyph. 1039 * 1040 * @extends CommonMethod<SymbolGlyphAttribute> 1041 * @syscap SystemCapability.ArkUI.ArkUI.Full 1042 * @since 11 1043 */ 1044/** 1045 * Provides attribute for SymbolGlyph. 1046 * 1047 * @extends CommonMethod<SymbolGlyphAttribute> 1048 * @syscap SystemCapability.ArkUI.ArkUI.Full 1049 * @form 1050 * @atomicservice 1051 * @since 12 1052 */ 1053/** 1054 * Provides attribute for SymbolGlyph. 1055 * 1056 * @extends CommonMethod<SymbolGlyphAttribute> 1057 * @syscap SystemCapability.ArkUI.ArkUI.Full 1058 * @crossplatform 1059 * @form 1060 * @atomicservice 1061 * @since 20 1062 * @arkts 1.1&1.2 1063 */ 1064declare class SymbolGlyphAttribute extends CommonMethod<SymbolGlyphAttribute> { 1065 /** 1066 * Called when the SymbolGlyph size is set. 1067 * 1068 * @param { number | string | Resource } value 1069 * @returns { SymbolGlyphAttribute } 1070 * @syscap SystemCapability.ArkUI.ArkUI.Full 1071 * @since 11 1072 */ 1073 /** 1074 * Called when the SymbolGlyph size is set. 1075 * 1076 * @param { number | string | Resource } value 1077 * @returns { SymbolGlyphAttribute } 1078 * @syscap SystemCapability.ArkUI.ArkUI.Full 1079 * @form 1080 * @atomicservice 1081 * @since 12 1082 */ 1083 /** 1084 * Called when the SymbolGlyph size is set. 1085 * 1086 * @param { number | string | Resource } value 1087 * @returns { SymbolGlyphAttribute } 1088 * @syscap SystemCapability.ArkUI.ArkUI.Full 1089 * @crossplatform 1090 * @form 1091 * @atomicservice 1092 * @since 20 1093 * @arkts 1.1&1.2 1094 */ 1095 fontSize(value: number | string | Resource): SymbolGlyphAttribute; 1096 1097 /** 1098 * Called when the SymbolGlyph color is set. 1099 * 1100 * @param { Array<ResourceColor> } value 1101 * @returns { SymbolGlyphAttribute } The attribute of the SymbolGlyph. 1102 * @syscap SystemCapability.ArkUI.ArkUI.Full 1103 * @since 11 1104 */ 1105 /** 1106 * Called when the SymbolGlyph color is set. 1107 * 1108 * @param { Array<ResourceColor> } value 1109 * @returns { SymbolGlyphAttribute } The attribute of the SymbolGlyph. 1110 * @syscap SystemCapability.ArkUI.ArkUI.Full 1111 * @form 1112 * @atomicservice 1113 * @since 12 1114 */ 1115 /** 1116 * Called when the SymbolGlyph color is set. 1117 * 1118 * @param { Array<ResourceColor> } value 1119 * @returns { SymbolGlyphAttribute } The attribute of the SymbolGlyph. 1120 * @syscap SystemCapability.ArkUI.ArkUI.Full 1121 * @crossplatform 1122 * @form 1123 * @atomicservice 1124 * @since 20 1125 * @arkts 1.1&1.2 1126 */ 1127 fontColor(value: Array<ResourceColor>): SymbolGlyphAttribute; 1128 1129 /** 1130 * Set the shader style of the symbol, such as lineargradient or radialgradient. 1131 * 1132 * If a single `ShaderStyle` is provided, all layers of the symbol will use this shader style. 1133 * If an array is provided, each item corresponds to the shader style of the matching symbol layer. 1134 * - If an array item is `undefined`, that layer will use its default color. 1135 * - Any layers beyond the length of the array will also use their default color. 1136 * 1137 * @param { Array<ShaderStyle | undefined> | ShaderStyle } shader - The shader style(s) to apply. 1138 * - `ShaderStyle`: Apply the same shader style to all symbol layers. 1139 * - `Array<ShaderStyle | undefined>`: Specify shader styles per layer; `undefined` means default 1140 * color for that layer. 1141 * @returns { SymbolGlyphAttribute } 1142 * @syscap SystemCapability.ArkUI.ArkUI.Full 1143 * @atomicservice 1144 * @since 20 1145 */ 1146 shaderStyle(shader: Array<ShaderStyle | undefined> | ShaderStyle): SymbolGlyphAttribute; 1147 1148 /** 1149 * Called when the font symbolGlyph weight is set. 1150 * 1151 * @param { number | FontWeight | string } value 1152 * @returns { SymbolGlyphAttribute } 1153 * @syscap SystemCapability.ArkUI.ArkUI.Full 1154 * @since 11 1155 */ 1156 /** 1157 * Called when the font symbolGlyph weight is set. 1158 * 1159 * @param { number | FontWeight | string } value 1160 * @returns { SymbolGlyphAttribute } 1161 * @syscap SystemCapability.ArkUI.ArkUI.Full 1162 * @form 1163 * @atomicservice 1164 * @since 12 1165 */ 1166 /** 1167 * Called when the font symbolGlyph weight is set. 1168 * 1169 * @param { number | FontWeight | string } value 1170 * @returns { SymbolGlyphAttribute } 1171 * @syscap SystemCapability.ArkUI.ArkUI.Full 1172 * @crossplatform 1173 * @form 1174 * @atomicservice 1175 * @since 20 1176 * @arkts 1.1&1.2 1177 */ 1178 fontWeight(value: number | FontWeight | string): SymbolGlyphAttribute; 1179 1180 /** 1181 * Called when the symbolGlyph effect is set. 1182 * 1183 * @param { SymbolEffectStrategy } value 1184 * @returns { SymbolGlyphAttribute } The attribute of the SymbolGlyph. 1185 * @syscap SystemCapability.ArkUI.ArkUI.Full 1186 * @since 11 1187 */ 1188 /** 1189 * Called when the symbolGlyph effect is set. 1190 * 1191 * @param { SymbolEffectStrategy } value 1192 * @returns { SymbolGlyphAttribute } The attribute of the SymbolGlyph. 1193 * @syscap SystemCapability.ArkUI.ArkUI.Full 1194 * @form 1195 * @atomicservice 1196 * @since 12 1197 */ 1198 /** 1199 * Called when the symbolGlyph effect is set. 1200 * 1201 * @param { SymbolEffectStrategy } value 1202 * @returns { SymbolGlyphAttribute } The attribute of the SymbolGlyph. 1203 * @syscap SystemCapability.ArkUI.ArkUI.Full 1204 * @crossplatform 1205 * @form 1206 * @atomicservice 1207 * @since 20 1208 * @arkts 1.1&1.2 1209 */ 1210 effectStrategy(value: SymbolEffectStrategy): SymbolGlyphAttribute; 1211 1212 /** 1213 * Called when the symbolGlyph rendering strategy is set. 1214 * 1215 * @param { SymbolRenderingStrategy } value 1216 * @returns { SymbolGlyphAttribute } The attribute of the SymbolGlyph. 1217 * @syscap SystemCapability.ArkUI.ArkUI.Full 1218 * @since 11 1219 */ 1220 /** 1221 * Called when the symbolGlyph rendering strategy is set. 1222 * 1223 * @param { SymbolRenderingStrategy } value 1224 * @returns { SymbolGlyphAttribute } The attribute of the SymbolGlyph. 1225 * @syscap SystemCapability.ArkUI.ArkUI.Full 1226 * @form 1227 * @atomicservice 1228 * @since 12 1229 */ 1230 /** 1231 * Called when the symbolGlyph rendering strategy is set. 1232 * 1233 * @param { SymbolRenderingStrategy } value 1234 * @returns { SymbolGlyphAttribute } The attribute of the SymbolGlyph. 1235 * @syscap SystemCapability.ArkUI.ArkUI.Full 1236 * @crossplatform 1237 * @form 1238 * @atomicservice 1239 * @since 20 1240 * @arkts 1.1&1.2 1241 */ 1242 renderingStrategy(value: SymbolRenderingStrategy): SymbolGlyphAttribute; 1243 1244 /** 1245 * Define effect options for SymbolGlyph. 1246 * 1247 * @param { SymbolEffect } [symbolEffect] - The symbol effect type 1248 * @param { boolean } [isActive] - The active state of the effect 1249 * @returns { SymbolGlyphAttribute } The attribute of the SymbolGlyph. 1250 * @syscap SystemCapability.ArkUI.ArkUI.Full 1251 * @form 1252 * @atomicservice 1253 * @since 12 1254 */ 1255 /** 1256 * Define effect options for SymbolGlyph. 1257 * 1258 * @param { SymbolEffect } [symbolEffect] - The symbol effect type 1259 * @param { boolean } [isActive] - The active state of the effect 1260 * @returns { SymbolGlyphAttribute } The attribute of the SymbolGlyph. 1261 * @syscap SystemCapability.ArkUI.ArkUI.Full 1262 * @crossplatform 1263 * @form 1264 * @atomicservice 1265 * @since 20 1266 */ 1267 symbolEffect(symbolEffect: SymbolEffect, isActive?: boolean): SymbolGlyphAttribute; 1268 1269 /** 1270 * Define effect options for SymbolGlyph. 1271 * 1272 * @param { SymbolEffect } [symbolEffect] - The symbol effect type 1273 * @param { number } [triggerValue] - The trigger of the effect 1274 * @returns { SymbolGlyphAttribute } The attribute of the SymbolGlyph. 1275 * @syscap SystemCapability.ArkUI.ArkUI.Full 1276 * @form 1277 * @atomicservice 1278 * @since 12 1279 */ 1280 /** 1281 * Define effect options for SymbolGlyph. 1282 * 1283 * @param { SymbolEffect } [symbolEffect] - The symbol effect type 1284 * @param { number } [triggerValue] - The trigger of the effect 1285 * @returns { SymbolGlyphAttribute } The attribute of the SymbolGlyph. 1286 * @syscap SystemCapability.ArkUI.ArkUI.Full 1287 * @crossplatform 1288 * @form 1289 * @atomicservice 1290 * @since 20 1291 */ 1292 symbolEffect(symbolEffect: SymbolEffect, triggerValue?: number): SymbolGlyphAttribute; 1293 1294 /** 1295 * Define effect options for SymbolGlyph. 1296 * 1297 * @param { SymbolEffect } [symbolEffect] - The symbol effect type 1298 * @param { boolean | number } [triggerValue] - The trigger of the effect 1299 * @returns { SymbolGlyphAttribute } The attribute of the SymbolGlyph. 1300 * @syscap SystemCapability.ArkUI.ArkUI.Full 1301 * @crossplatform 1302 * @form 1303 * @atomicservice 1304 * @since 20 1305 * @arkts 1.2 1306 */ 1307 symbolEffect(symbolEffect: SymbolEffect, triggerValue?: boolean | number): SymbolGlyphAttribute; 1308 1309 /** 1310 * Called when the minimum font scale of the font is set. 1311 * 1312 * @param { Optional<number|Resource> } scale 1313 * @returns { SymbolGlyphAttribute } 1314 * @syscap SystemCapability.ArkUI.ArkUI.Full 1315 * @atomicservice 1316 * @since 18 1317 */ 1318 /** 1319 * Called when the minimum font scale of the font is set. 1320 * 1321 * @param { Optional<number|Resource> } scale 1322 * @returns { SymbolGlyphAttribute } 1323 * @syscap SystemCapability.ArkUI.ArkUI.Full 1324 * @crossplatform 1325 * @atomicservice 1326 * @since 20 1327 * @arkts 1.1&1.2 1328 */ 1329 minFontScale(scale: Optional<number | Resource>): SymbolGlyphAttribute; 1330 1331 /** 1332 * Called when the maximum font scale of the font is set. 1333 * 1334 * @param { Optional<number|Resource> } scale 1335 * @returns { SymbolGlyphAttribute } 1336 * @syscap SystemCapability.ArkUI.ArkUI.Full 1337 * @atomicservice 1338 * @since 18 1339 */ 1340 /** 1341 * Called when the maximum font scale of the font is set. 1342 * 1343 * @param { Optional<number|Resource> } scale 1344 * @returns { SymbolGlyphAttribute } 1345 * @syscap SystemCapability.ArkUI.ArkUI.Full 1346 * @crossplatform 1347 * @atomicservice 1348 * @since 20 1349 * @arkts 1.1&1.2 1350 */ 1351 maxFontScale(scale: Optional<number | Resource>): SymbolGlyphAttribute; 1352 1353 /** 1354 * Set the shadow of symbol. 1355 * 1356 * <p><strong>NOTE</strong>: 1357 * <br>This API does not work with the fill attribute, showType attribute or coloring strategy. 1358 * </p> 1359 * 1360 * @param { Optional<ShadowOptions> } shadow - The shadow options. 1361 * @returns { SymbolGlyphAttribute } 1362 * @syscap SystemCapability.ArkUI.ArkUI.Full 1363 * @form 1364 * @atomicservice 1365 * @since 20 1366 */ 1367 symbolShadow(shadow: Optional<ShadowOptions>): SymbolGlyphAttribute; 1368} 1369 1370/** 1371 * Defines SymbolGlyph Component. 1372 * 1373 * @syscap SystemCapability.ArkUI.ArkUI.Full 1374 * @since 11 1375 */ 1376/** 1377 * Defines SymbolGlyph Component. 1378 * 1379 * @syscap SystemCapability.ArkUI.ArkUI.Full 1380 * @form 1381 * @atomicservice 1382 * @since 12 1383 */ 1384/** 1385 * Defines SymbolGlyph Component. 1386 * 1387 * @syscap SystemCapability.ArkUI.ArkUI.Full 1388 * @crossplatform 1389 * @form 1390 * @atomicservice 1391 * @since 20 1392 */ 1393declare const SymbolGlyph: SymbolGlyphInterface; 1394 1395/** 1396 * Defines SymbolGlyph Component instance. 1397 * 1398 * @syscap SystemCapability.ArkUI.ArkUI.Full 1399 * @since 11 1400 */ 1401/** 1402 * Defines SymbolGlyph Component instance. 1403 * 1404 * @syscap SystemCapability.ArkUI.ArkUI.Full 1405 * @form 1406 * @atomicservice 1407 * @since 12 1408 */ 1409/** 1410 * Defines SymbolGlyph Component instance. 1411 * 1412 * @syscap SystemCapability.ArkUI.ArkUI.Full 1413 * @crossplatform 1414 * @form 1415 * @atomicservice 1416 * @since 20 1417 */ 1418declare const SymbolGlyphInstance: SymbolGlyphAttribute; 1419