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 */ 20import drawing from '../@ohos.graphics.drawing'; 21import type common2D from '../@ohos.graphics.common2D'; 22import { Resource } from '../global/resource'; 23 24/*** if arkts 1.2 */ 25import { ResourceColor } from './component/units' 26import { BorderStyle } from './component/enums' 27/*** endif */ 28 29/** 30 * Size info. 31 * Returns the width and height of the component. The default unit is vp, but APIs that use the Size type may specify a 32 * different unit, in which case the unit specified by the API takes precedence. 33 * 34 * @interface Size 35 * @syscap SystemCapability.ArkUI.ArkUI.Full 36 * @crossplatform 37 * @since 11 38 */ 39/** 40 * Size info. 41 * Returns the width and height of the component. The default unit is vp, but APIs that use the Size type may specify a 42 * different unit, in which case the unit specified by the API takes precedence. 43 * 44 * @interface Size 45 * @syscap SystemCapability.ArkUI.ArkUI.Full 46 * @crossplatform 47 * @atomicservice 48 * @since arkts {'1.1':'12','1.2':'20'} 49 * @arkts 1.1&1.2 50 */ 51export interface Size { 52 /** 53 * Get the width of the Size. 54 * Unit: vp. 55 * Value range: [0, +∞). 56 * 57 * @type { number } 58 * @syscap SystemCapability.ArkUI.ArkUI.Full 59 * @crossplatform 60 * @since 11 61 */ 62 /** 63 * Get the width of the Size. 64 * Unit: vp. 65 * Value range: [0, +∞). 66 * 67 * @type { number } 68 * @syscap SystemCapability.ArkUI.ArkUI.Full 69 * @crossplatform 70 * @atomicservice 71 * @since arkts {'1.1':'12','1.2':'20'} 72 * @arkts 1.1&1.2 73 */ 74 width: number; 75 76 /** 77 * Get the height of the Size. 78 * Unit: vp. 79 * Value range: [0, +∞). 80 * 81 * @type { number } 82 * @syscap SystemCapability.ArkUI.ArkUI.Full 83 * @crossplatform 84 * @since 11 85 */ 86 /** 87 * Get the height of the Size. 88 * Unit: vp. 89 * Value range: [0, +∞). 90 * 91 * @type { number } 92 * @syscap SystemCapability.ArkUI.ArkUI.Full 93 * @crossplatform 94 * @atomicservice 95 * @since arkts {'1.1':'12','1.2':'20'} 96 * @arkts 1.1&1.2 97 */ 98 height: number; 99} 100 101/** 102 * Defines DrawContext. 103 * 104 * @syscap SystemCapability.ArkUI.ArkUI.Full 105 * @crossplatform 106 * @since 11 107 */ 108/** 109 * Defines DrawContext. 110 * Graphics drawing context, which provides the canvas width and height required for drawing. 111 * 112 * @syscap SystemCapability.ArkUI.ArkUI.Full 113 * @crossplatform 114 * @atomicservice 115 * @since 12 116 */ 117/** 118 * Defines DrawContext. 119 * 120 * @syscap SystemCapability.ArkUI.ArkUI.Full 121 * @crossplatform 122 * @atomicservice 123 * @since 20 124 * @arkts 1.1&1.2 125 */ 126export declare class DrawContext { 127 128 /** 129 * Get size of the DrawContext. 130 * 131 * @returns { Size } The size of the DrawContext. 132 * @syscap SystemCapability.ArkUI.ArkUI.Full 133 * @crossplatform 134 * @since arkts {'1.1':'11','1.2':'20'} 135 * @arkts 1.1&1.2 136 */ 137 /** 138 * Get size of the DrawContext. 139 * 140 * @returns { Size } The size of the DrawContext. 141 * @syscap SystemCapability.ArkUI.ArkUI.Full 142 * @crossplatform 143 * @atomicservice 144 * @since arkts {'1.1':'12','1.2':'20'} 145 * @arkts 1.1&1.2 146 */ 147 get size(): Size; 148 149 /** 150 * Get size of the DrawContext with pixel unit. 151 * 152 * @returns { Size } The size of the DrawContext with pixel unit. 153 * @syscap SystemCapability.ArkUI.ArkUI.Full 154 * @crossplatform 155 * @atomicservice 156 * @since arkts {'1.1':'12','1.2':'20'} 157 * @arkts 1.1&1.2 158 */ 159 get sizeInPixel(): Size; 160 161 /** 162 * Get canvas of the DrawContext. 163 * 164 * @returns { drawing.Canvas } The canvas of the DrawContext. 165 * @syscap SystemCapability.ArkUI.ArkUI.Full 166 * @crossplatform 167 * @since arkts {'1.1':'11','1.2':'20'} 168 * @arkts 1.1&1.2 169 */ 170 /** 171 * Get canvas of the DrawContext. 172 * 173 * @returns { drawing.Canvas } The canvas of the DrawContext. 174 * @syscap SystemCapability.ArkUI.ArkUI.Full 175 * @crossplatform 176 * @atomicservice 177 * @since arkts {'1.1':'12','1.2':'20'} 178 * @arkts 1.1&1.2 179 */ 180 get canvas(): drawing.Canvas; 181} 182 183/** 184 * Defined a vector with two values. 185 * 186 * @interface Vector2 187 * @syscap SystemCapability.ArkUI.ArkUI.Full 188 * @crossplatform 189 * @since 11 190 */ 191 /** 192 * Defined a vector with two values. 193 * 194 * @interface Vector2 195 * @syscap SystemCapability.ArkUI.ArkUI.Full 196 * @crossplatform 197 * @atomicservice 198 * @since arkts {'1.1':'12','1.2':'20'} 199 * @arkts 1.1&1.2 200 */ 201interface Vector2 { 202 /** 203 * Value for x-axis of the vector. 204 * Value range: (-∞, +∞). 205 * 206 * @type { number } 207 * @syscap SystemCapability.ArkUI.ArkUI.Full 208 * @crossplatform 209 * @since 11 210 */ 211 /** 212 * Value for x-axis of the vector. 213 * Value range: (-∞, +∞). 214 * 215 * @type { number } 216 * @syscap SystemCapability.ArkUI.ArkUI.Full 217 * @crossplatform 218 * @atomicservice 219 * @since arkts {'1.1':'12','1.2':'20'} 220 * @arkts 1.1&1.2 221 */ 222 x: number 223 224 /** 225 * Value for y-axis of the vector. 226 * Value range: (-∞, +∞). 227 * 228 * @type { number } 229 * @syscap SystemCapability.ArkUI.ArkUI.Full 230 * @crossplatform 231 * @since 11 232 */ 233 /** 234 * Value for y-axis of the vector. 235 * Value range: (-∞, +∞). 236 * 237 * @type { number } 238 * @syscap SystemCapability.ArkUI.ArkUI.Full 239 * @crossplatform 240 * @atomicservice 241 * @since arkts {'1.1':'12','1.2':'20'} 242 * @arkts 1.1&1.2 243 */ 244 y: number 245} 246 247 /** 248 * Defined a vector with two T type values. 249 * 250 * @interface Vector2T 251 * @syscap SystemCapability.ArkUI.ArkUI.Full 252 * @crossplatform 253 * @atomicservice 254 * @since arkts {'1.1':'12','1.2':'20'} 255 * @arkts 1.1&1.2 256 */ 257 interface Vector2T<T> { 258 259 /** 260 * Value for x-axis of the vector. 261 * 262 * @type { T } 263 * @syscap SystemCapability.ArkUI.ArkUI.Full 264 * @crossplatform 265 * @atomicservice 266 * @since arkts {'1.1':'12','1.2':'20'} 267 * @arkts 1.1&1.2 268 */ 269 x: T 270 271 /** 272 * Value for y-axis of the vector. 273 * 274 * @type { T } 275 * @syscap SystemCapability.ArkUI.ArkUI.Full 276 * @crossplatform 277 * @atomicservice 278 * @since arkts {'1.1':'12','1.2':'20'} 279 * @arkts 1.1&1.2 280 */ 281 y: T 282} 283 284/** 285 * Defined a vector with three values. 286 * 287 * @interface Vector3 288 * @syscap SystemCapability.ArkUI.ArkUI.Full 289 * @crossplatform 290 * @since 11 291 */ 292/** 293 * Defined a vector with three values. 294 * 295 * @interface Vector3 296 * @syscap SystemCapability.ArkUI.ArkUI.Full 297 * @crossplatform 298 * @atomicservice 299 * @since arkts {'1.1':'12','1.2':'20'} 300 * @arkts 1.1&1.2 301 */ 302interface Vector3 { 303 /** 304 * Value for x-axis of the vector. 305 * Value range: (-∞, +∞). 306 * 307 * @type { number } 308 * @syscap SystemCapability.ArkUI.ArkUI.Full 309 * @crossplatform 310 * @since 11 311 */ 312 /** 313 * Value for x-axis of the vector. 314 * Value range: (-∞, +∞). 315 * 316 * @type { number } 317 * @syscap SystemCapability.ArkUI.ArkUI.Full 318 * @crossplatform 319 * @atomicservice 320 * @since arkts {'1.1':'12','1.2':'20'} 321 * @arkts 1.1&1.2 322 */ 323 x: number; 324 325 /** 326 * Value for y-axis of the vector. 327 * Value range: (-∞, +∞). 328 * 329 * @type { number } 330 * @syscap SystemCapability.ArkUI.ArkUI.Full 331 * @crossplatform 332 * @since 11 333 */ 334 /** 335 * Value for y-axis of the vector. 336 * Value range: (-∞, +∞). 337 * 338 * @type { number } 339 * @syscap SystemCapability.ArkUI.ArkUI.Full 340 * @crossplatform 341 * @atomicservice 342 * @since arkts {'1.1':'12','1.2':'20'} 343 * @arkts 1.1&1.2 344 */ 345 y: number; 346 347 /** 348 * Value for z-axis of the vector. 349 * Value range: (-∞, +∞). 350 * 351 * @type { number } 352 * @syscap SystemCapability.ArkUI.ArkUI.Full 353 * @crossplatform 354 * @since 11 355 */ 356 /** 357 * Value for z-axis of the vector. 358 * Value range: (-∞, +∞). 359 * 360 * @type { number } 361 * @syscap SystemCapability.ArkUI.ArkUI.Full 362 * @crossplatform 363 * @atomicservice 364 * @since arkts {'1.1':'12','1.2':'20'} 365 * @arkts 1.1&1.2 366 */ 367 z: number; 368} 369 370/** 371 * It's a 4x4 matrix, represent by number[]. 372 * Value range of each number: (-∞, +∞) 373 * 374 * @typedef { number[] } Matrix4 375 * @syscap SystemCapability.ArkUI.ArkUI.Full 376 * @crossplatform 377 * @since 11 378 */ 379/** 380 * It's a 4x4 matrix, represent by number[]. 381 * Value range of each number: (-∞, +∞) 382 * 383 * @typedef { number[] } Matrix4 384 * @syscap SystemCapability.ArkUI.ArkUI.Full 385 * @crossplatform 386 * @atomicservice 387 * @since arkts {'1.1':'12','1.2':'20'} 388 * @arkts 1.1&1.2 389 */ 390export type Matrix4 = [ 391 number, 392 number, 393 number, 394 number, 395 number, 396 number, 397 number, 398 number, 399 number, 400 number, 401 number, 402 number, 403 number, 404 number, 405 number, 406 number 407]; 408 409/** 410 * Offset info. 411 * Unit: vp. 412 * 413 * @typedef { Vector2 } Offset 414 * @syscap SystemCapability.ArkUI.ArkUI.Full 415 * @crossplatform 416 * @since 11 417 */ 418/** 419 * Offset info. 420 * Unit: vp. 421 * 422 * @typedef { Vector2 } Offset 423 * @syscap SystemCapability.ArkUI.ArkUI.Full 424 * @crossplatform 425 * @atomicservice 426 * @since arkts {'1.1':'12','1.2':'20'} 427 * @arkts 1.1&1.2 428 */ 429export type Offset = Vector2; 430 431/** 432 * Position info. 433 * Unit: vp. 434 * 435 * @typedef { Vector2 } Position 436 * @syscap SystemCapability.ArkUI.ArkUI.Full 437 * @crossplatform 438 * @since 11 439 */ 440/** 441 * Position info. 442 * Unit: vp. 443 * 444 * @typedef { Vector2 } Position 445 * @syscap SystemCapability.ArkUI.ArkUI.Full 446 * @crossplatform 447 * @atomicservice 448 * @since arkts {'1.1':'12','1.2':'20'} 449 * @arkts 1.1&1.2 450 */ 451export type Position = Vector2; 452 453/** 454 * PositionT info. 455 * Unit: vp. 456 * @typedef {Vector2T<T> } 457 * @syscap SystemCapability.ArkUI.ArkUI.Full 458 * @crossplatform 459 * @atomicservice 460 * @since arkts {'1.1':'12','1.2':'20'} 461 * @arkts 1.1&1.2 462 */ 463export type PositionT<T> = Vector2T<T>; 464 465/** 466 * Pivot info. 467 * As the rotation or scaling center of the component, the pivot affects the rotation and scaling effects. 468 * The value is a floating point number in the range [0.0, 1.0], and the default value is 0.5. 469 * 470 * @typedef { Vector2 } Pivot 471 * @syscap SystemCapability.ArkUI.ArkUI.Full 472 * @crossplatform 473 * @since 11 474 */ 475/** 476 * Pivot info. 477 * As the rotation or scaling center of the component, the pivot affects the rotation and scaling effects. 478 * The value is a floating point number in the range [0.0, 1.0], and the default value is 0.5. 479 * 480 * @typedef { Vector2 } Pivot 481 * @syscap SystemCapability.ArkUI.ArkUI.Full 482 * @crossplatform 483 * @atomicservice 484 * @since arkts {'1.1':'12','1.2':'20'} 485 * @arkts 1.1&1.2 486 */ 487export type Pivot = Vector2; 488 489/** 490 * Scale info. 491 * The value is a floating point number, and the default value is 1.0. 492 * 493 * @typedef { Vector2 } Scale 494 * @syscap SystemCapability.ArkUI.ArkUI.Full 495 * @crossplatform 496 * @since 11 497 */ 498/** 499 * Scale info. 500 * The value is a floating point number, and the default value is 1.0. 501 * 502 * @typedef { Vector2 } Scale 503 * @syscap SystemCapability.ArkUI.ArkUI.Full 504 * @crossplatform 505 * @atomicservice 506 * @since arkts {'1.1':'12','1.2':'20'} 507 * @arkts 1.1&1.2 508 */ 509export type Scale = Vector2; 510 511/** 512 * Translation info. 513 * Unit: px 514 * 515 * @typedef { Vector2 } Translation 516 * @syscap SystemCapability.ArkUI.ArkUI.Full 517 * @crossplatform 518 * @since 11 519 */ 520/** 521 * Translation info. 522 * Unit: px 523 * 524 * @typedef { Vector2 } Translation 525 * @syscap SystemCapability.ArkUI.ArkUI.Full 526 * @crossplatform 527 * @atomicservice 528 * @since arkts {'1.1':'12','1.2':'20'} 529 * @arkts 1.1&1.2 530 */ 531export type Translation = Vector2; 532 533/** 534 * Rotation info. 535 * Unit: degree 536 * 537 * @typedef { Vector3 } Rotation 538 * @syscap SystemCapability.ArkUI.ArkUI.Full 539 * @crossplatform 540 * @since 11 541 */ 542/** 543 * Rotation info. 544 * Unit: degree 545 * 546 * @typedef { Vector3 } Rotation 547 * @syscap SystemCapability.ArkUI.ArkUI.Full 548 * @crossplatform 549 * @atomicservice 550 * @since arkts {'1.1':'12','1.2':'20'} 551 * @arkts 1.1&1.2 552 */ 553export type Rotation = Vector3; 554 555/** 556 * Frame info, include the position info and size info. 557 * 558 * @interface Frame 559 * @syscap SystemCapability.ArkUI.ArkUI.Full 560 * @crossplatform 561 * @since 11 562 */ 563/** 564 * Frame info, include the position info and size info. 565 * 566 * @interface Frame 567 * @syscap SystemCapability.ArkUI.ArkUI.Full 568 * @crossplatform 569 * @atomicservice 570 * @since arkts {'1.1':'12','1.2':'20'} 571 * @arkts 1.1&1.2 572 */ 573export declare interface Frame { 574 /** 575 * Position value for x-axis of the frame info. 576 * Unit: vp. 577 * Value range: (-∞, +∞). 578 * 579 * @type { number } 580 * @syscap SystemCapability.ArkUI.ArkUI.Full 581 * @crossplatform 582 * @since 11 583 */ 584 /** 585 * Position value for x-axis of the frame info. 586 * Unit: vp. 587 * Value range: (-∞, +∞). 588 * 589 * @type { number } 590 * @syscap SystemCapability.ArkUI.ArkUI.Full 591 * @crossplatform 592 * @atomicservice 593 * @since arkts {'1.1':'12','1.2':'20'} 594 * @arkts 1.1&1.2 595 */ 596 x: number; 597 598 /** 599 * Position value for y-axis of the frame info. 600 * Unit: vp. 601 * Value range: (-∞, +∞). 602 * 603 * @type { number } 604 * @syscap SystemCapability.ArkUI.ArkUI.Full 605 * @crossplatform 606 * @since 11 607 */ 608 /** 609 * Position value for y-axis of the frame info. 610 * Unit: vp. 611 * Value range: (-∞, +∞). 612 * 613 * @type { number } 614 * @syscap SystemCapability.ArkUI.ArkUI.Full 615 * @crossplatform 616 * @atomicservice 617 * @since arkts {'1.1':'12','1.2':'20'} 618 * @arkts 1.1&1.2 619 */ 620 y: number; 621 622 /** 623 * Size value for width of the frame info. 624 * Unit: vp. 625 * Value range: [0, +∞). 626 * 627 * @type { number } 628 * @syscap SystemCapability.ArkUI.ArkUI.Full 629 * @crossplatform 630 * @since 11 631 */ 632 /** 633 * Size value for width of the frame info. 634 * Unit: vp. 635 * Value range: [0, +∞). 636 * 637 * @type { number } 638 * @syscap SystemCapability.ArkUI.ArkUI.Full 639 * @crossplatform 640 * @atomicservice 641 * @since arkts {'1.1':'12','1.2':'20'} 642 * @arkts 1.1&1.2 643 */ 644 width: number; 645 646 /** 647 * Size value for height of the frame info. 648 * Unit: vp. 649 * Value range: [0, +∞). 650 * 651 * @type { number } 652 * @syscap SystemCapability.ArkUI.ArkUI.Full 653 * @crossplatform 654 * @since 11 655 */ 656 /** 657 * Size value for height of the frame info. 658 * Unit: vp. 659 * Value range: [0, +∞). 660 * 661 * @type { number } 662 * @syscap SystemCapability.ArkUI.ArkUI.Full 663 * @crossplatform 664 * @atomicservice 665 * @since arkts {'1.1':'12','1.2':'20'} 666 * @arkts 1.1&1.2 667 */ 668 height: number; 669} 670 671/** 672 * Defines the Edge property. 673 * 674 * @interface Edges 675 * @syscap SystemCapability.ArkUI.ArkUI.Full 676 * @crossplatform 677 * @atomicservice 678 * @since arkts {'1.1':'12','1.2':'20'} 679 * @arkts 1.1&1.2 680 */ 681export interface Edges<T> { 682 /** 683 * Left property. 684 * 685 * @type { T } 686 * @syscap SystemCapability.ArkUI.ArkUI.Full 687 * @crossplatform 688 * @atomicservice 689 * @since arkts {'1.1':'12','1.2':'20'} 690 * @arkts 1.1&1.2 691 */ 692 left: T, 693 694 /** 695 * Right property. 696 * 697 * @type { T } 698 * @syscap SystemCapability.ArkUI.ArkUI.Full 699 * @crossplatform 700 * @atomicservice 701 * @since arkts {'1.1':'12','1.2':'20'} 702 * @arkts 1.1&1.2 703 */ 704 right: T, 705 706 /** 707 * Top property. 708 * 709 * @type { T } 710 * @syscap SystemCapability.ArkUI.ArkUI.Full 711 * @crossplatform 712 * @atomicservice 713 * @since arkts {'1.1':'12','1.2':'20'} 714 * @arkts 1.1&1.2 715 */ 716 top: T, 717 718 /** 719 * Bottom property. 720 * 721 * @type { T } 722 * @syscap SystemCapability.ArkUI.ArkUI.Full 723 * @crossplatform 724 * @atomicservice 725 * @since arkts {'1.1':'12','1.2':'20'} 726 * @arkts 1.1&1.2 727 */ 728 bottom: T 729} 730 731/** 732 * Defines the Length Unit. 733 * 734 * @enum { number } 735 * @syscap SystemCapability.ArkUI.ArkUI.Full 736 * @crossplatform 737 * @atomicservice 738 * @since 12 739 */ 740/** 741 * Defines the Length Unit. 742 * 743 * @enum { number } 744 * @syscap SystemCapability.ArkUI.ArkUI.Full 745 * @crossplatform 746 * @atomicservice 747 * @since 20 748 * @arkts 1.1&1.2 749 */ 750export declare enum LengthUnit { 751 /** 752 * Logical pixel used in Ace1.0. It's based on frontend design width. 753 * For example, when a frontend with 750px design width running on a 754 * device with 1080 pixels width, 1px represents 1.44 pixels. 755 * 756 * @syscap SystemCapability.ArkUI.ArkUI.Full 757 * @crossplatform 758 * @atomicservice 759 * @since arkts {'1.1':'12','1.2':'20'} 760 * @arkts 1.1&1.2 761 */ 762 PX = 0, 763 764 /** 765 * Density independent pixels, one vp is one pixel on a 160 dpi screen. 766 * 767 * @syscap SystemCapability.ArkUI.ArkUI.Full 768 * @crossplatform 769 * @atomicservice 770 * @since arkts {'1.1':'12','1.2':'20'} 771 * @arkts 1.1&1.2 772 */ 773 VP = 1, 774 775 /** 776 * Scale independent pixels. This is like VP but will be scaled by 777 * user's font size preference. 778 * 779 * @syscap SystemCapability.ArkUI.ArkUI.Full 780 * @crossplatform 781 * @atomicservice 782 * @since arkts {'1.1':'12','1.2':'20'} 783 * @arkts 1.1&1.2 784 */ 785 FP = 2, 786 787 /** 788 * The percentage of either a value from the element's parent or from 789 * another property of the element itself. 790 * 791 * @syscap SystemCapability.ArkUI.ArkUI.Full 792 * @crossplatform 793 * @atomicservice 794 * @since arkts {'1.1':'12','1.2':'20'} 795 * @arkts 1.1&1.2 796 */ 797 PERCENT = 3, 798 799 /** 800 * Logic pixels used in ACE2.0 instead of PX, and PX is the physical pixels in ACE2.0. 801 * 802 * @syscap SystemCapability.ArkUI.ArkUI.Full 803 * @crossplatform 804 * @atomicservice 805 * @since arkts {'1.1':'12','1.2':'20'} 806 * @arkts 1.1&1.2 807 */ 808 LPX = 4, 809} 810 811/** 812 * Defines the Size property. 813 * 814 * @interface SizeT 815 * @syscap SystemCapability.ArkUI.ArkUI.Full 816 * @crossplatform 817 * @atomicservice 818 * @since arkts {'1.1':'12','1.2':'20'} 819 * @arkts 1.1&1.2 820 */ 821export interface SizeT<T> { 822 /** 823 * Width property. 824 * 825 * @type { T } 826 * @syscap SystemCapability.ArkUI.ArkUI.Full 827 * @crossplatform 828 * @atomicservice 829 * @since arkts {'1.1':'12','1.2':'20'} 830 * @arkts 1.1&1.2 831 */ 832 width: T; 833 834 /** 835 * Height property. 836 * 837 * @type { T } 838 * @syscap SystemCapability.ArkUI.ArkUI.Full 839 * @crossplatform 840 * @atomicservice 841 * @since arkts {'1.1':'12','1.2':'20'} 842 * @arkts 1.1&1.2 843 */ 844 height: T; 845} 846 847/** 848 * Enumerates the length metrics unit. 849 * 850 * @enum { number } 851 * @syscap SystemCapability.ArkUI.ArkUI.Full 852 * @crossplatform 853 * @atomicservice 854 * @since arkts {'1.1':'12','1.2':'20'} 855 * @arkts 1.1&1.2 856 */ 857export enum LengthMetricsUnit { 858 859 /** 860 * The default length metrics unit, in vp. 861 * 862 * @syscap SystemCapability.ArkUI.ArkUI.Full 863 * @crossplatform 864 * @atomicservice 865 * @since arkts {'1.1':'12','1.2':'20'} 866 * @arkts 1.1&1.2 867 */ 868 DEFAULT = 0, 869 870 /** 871 * The pixel length metrics unit. 872 * 873 * @syscap SystemCapability.ArkUI.ArkUI.Full 874 * @crossplatform 875 * @atomicservice 876 * @since arkts {'1.1':'12','1.2':'20'} 877 * @arkts 1.1&1.2 878 */ 879 PX = 1 880} 881 882/** 883 * Defines the Length Metrics. 884 * When the length unit is PERCENT, the value 1 indicates 100%. 885 * 886 * @syscap SystemCapability.ArkUI.ArkUI.Full 887 * @crossplatform 888 * @atomicservice 889 * @since 12 890 */ 891/** 892 * Defines the Length Metrics. 893 * 894 * @syscap SystemCapability.ArkUI.ArkUI.Full 895 * @crossplatform 896 * @atomicservice 897 * @since 20 898 * @arkts 1.1&1.2 899 */ 900export declare class LengthMetrics { 901 /** 902 * Constructor. 903 * If the unit parameter is omitted or explicitly set to undefined, the default unit VP is used. 904 * If it is set to a value that is not of the LengthUnit type, the default value 0 VP is used. 905 * 906 * @param { number } value - The value of length. 907 * @param { LengthUnit } [unit] - The length unit. 908 * The default value is VP. 909 * @syscap SystemCapability.ArkUI.ArkUI.Full 910 * @crossplatform 911 * @atomicservice 912 * @since arkts {'1.1':'12','1.2':'20'} 913 * @arkts 1.1&1.2 914 */ 915 constructor(value: number, unit?:LengthUnit); 916 917 /** 918 * Init a lengthMetrics with px unit. 919 * 920 * @param { number } value - The value of the length metrics. 921 * Value range: (-∞, +∞). 922 * @returns { LengthMetrics } Returns the lengthMetrics object with unit px. 923 * @static 924 * @syscap SystemCapability.ArkUI.ArkUI.Full 925 * @crossplatform 926 * @atomicservice 927 * @since arkts {'1.1':'12','1.2':'20'} 928 * @arkts 1.1&1.2 929 */ 930 static px(value: number): LengthMetrics; 931 932 /** 933 * Init a lengthMetrics with vp unit. 934 * 935 * @param { number } value - The value of the length metrics. 936 * Value range: (-∞, +∞). 937 * @returns { LengthMetrics } - Returns the lengthMetrics object with unit vp. 938 * @static 939 * @syscap SystemCapability.ArkUI.ArkUI.Full 940 * @crossplatform 941 * @atomicservice 942 * @since arkts {'1.1':'12','1.2':'20'} 943 * @arkts 1.1&1.2 944 */ 945 static vp(value: number): LengthMetrics; 946 947 /** 948 * Init a lengthMetrics with fp unit. 949 * 950 * @param { number } value - The value of the length metrics. 951 * Value range: (-∞, +∞). 952 * @returns { LengthMetrics } Returns the lengthMetrics object with unit fp. 953 * @static 954 * @syscap SystemCapability.ArkUI.ArkUI.Full 955 * @crossplatform 956 * @atomicservice 957 * @since arkts {'1.1':'12','1.2':'20'} 958 * @arkts 1.1&1.2 959 */ 960 static fp(value: number): LengthMetrics; 961 962 /** 963 * Init a lengthMetrics with percent unit. 964 * The value 1 indicates 100%. 965 * 966 * @param { number } value - The value of the length metrics. 967 * Value range: [0, 1]. 968 * @returns { LengthMetrics } Returns the lengthMetrics object with unit percent. 969 * @static 970 * @syscap SystemCapability.ArkUI.ArkUI.Full 971 * @crossplatform 972 * @atomicservice 973 * @since arkts {'1.1':'12','1.2':'20'} 974 * @arkts 1.1&1.2 975 */ 976 static percent(value: number): LengthMetrics; 977 978 /** 979 * Init a lengthMetrics with lpx unit. 980 * 981 * @param { number } value - The value of the length metrics. 982 * Value range: (-∞, +∞). 983 * @returns { LengthMetrics } Returns the lengthMetrics object with unit lpx. 984 * @static 985 * @syscap SystemCapability.ArkUI.ArkUI.Full 986 * @crossplatform 987 * @atomicservice 988 * @since arkts {'1.1':'12','1.2':'20'} 989 * @arkts 1.1&1.2 990 */ 991 static lpx(value: number): LengthMetrics; 992 993 /** 994 * Init a lengthMetrics with Resource unit. 995 * 996 * @param { Resource } value - The value of the length metrics. 997 * @returns { LengthMetrics } Returns the lengthMetrics object with unit Resource. 998 * @static 999 * @syscap SystemCapability.ArkUI.ArkUI.Full 1000 * @crossplatform 1001 * @atomicservice 1002 * @since arkts {'1.1':'12','1.2':'20'} 1003 * @arkts 1.1&1.2 1004 */ 1005 static resource(value: Resource): LengthMetrics; 1006 1007 /** 1008 * The unit of the LengthMetrics. The default value is VP. 1009 * 1010 * @type { LengthUnit } 1011 * @default VP 1012 * @syscap SystemCapability.ArkUI.ArkUI.Full 1013 * @crossplatform 1014 * @atomicservice 1015 * @since arkts {'1.1':'12','1.2':'20'} 1016 * @arkts 1.1&1.2 1017 */ 1018 public unit: LengthUnit; 1019 1020 /** 1021 * The value of the LengthMetrics. 1022 * 1023 * @type { number } 1024 * @syscap SystemCapability.ArkUI.ArkUI.Full 1025 * @crossplatform 1026 * @atomicservice 1027 * @since arkts {'1.1':'12','1.2':'20'} 1028 * @arkts 1.1&1.2 1029 */ 1030 public value: number; 1031} 1032 1033/** 1034 * Defines the ColorMetrics class. 1035 * 1036 * @syscap SystemCapability.ArkUI.ArkUI.Full 1037 * @crossplatform 1038 * @atomicservice 1039 * @since 12 1040 */ 1041/** 1042 * Defines the ColorMetrics class. 1043 * 1044 * @syscap SystemCapability.ArkUI.ArkUI.Full 1045 * @crossplatform 1046 * @atomicservice 1047 * @since 20 1048 * @arkts 1.1&1.2 1049 */ 1050export declare class ColorMetrics { 1051 /** 1052 * Instantiate the ColorMetrics class using color number 1053 * 1054 * @param { number } value - color number, in HEX format 1055 * RGB and ARGB color values are supported. 1056 * @returns { ColorMetrics } ColorMetrics class 1057 * @syscap SystemCapability.ArkUI.ArkUI.Full 1058 * @crossplatform 1059 * @atomicservice 1060 * @since arkts {'1.1':'12','1.2':'20'} 1061 * @arkts 1.1&1.2 1062 */ 1063 static numeric(value: number): ColorMetrics; 1064 1065 /** 1066 * Instantiate the ColorMetrics class using color rgb 1067 * 1068 * @param { number } red - red value of rgba 1069 * The value is an integer ranging from 0 to 255. 1070 * @param { number } green - green value of rgba 1071 * The value is an integer ranging from 0 to 255. 1072 * @param { number } blue - blue value of rgba 1073 * The value is an integer ranging from 0 to 255. 1074 * @param { number } alpha - opacity value of rgba 1075 * The value is a floating point number ranging from 0.0 to 1.0. The default value is 1.0 (fully opaque). 1076 * @returns { ColorMetrics } ColorMetrics class 1077 * @syscap SystemCapability.ArkUI.ArkUI.Full 1078 * @crossplatform 1079 * @atomicservice 1080 * @since arkts {'1.1':'12','1.2':'20'} 1081 * @arkts 1.1&1.2 1082 */ 1083 static rgba(red: number, green: number, blue: number, alpha?: number): ColorMetrics; 1084 1085 /** 1086 * Instantiate the ColorMetrics class using colorSpace and rgba. 1087 * Only some properties support setting color in display-p3 colorSpace. 1088 * 1089 * @param { ColorSpace } colorSpace - colorSpace of color. 1090 * @param { number } red - red value of rgba. The range of the red channel is [0, 1]. 1091 * @param { number } green - green value of rgba. The range of the green channel is [0, 1]. 1092 * @param { number } blue - blue value of rgba. The range of the blue channel is [0, 1]. 1093 * @param { number } [alpha] - alpha value of rgba. The range of the alpha channel is [0, 1]. The default value is 1. 1094 * @returns { ColorMetrics } ColorMetrics class 1095 * @static 1096 * @syscap SystemCapability.ArkUI.ArkUI.Full 1097 * @crossplatform 1098 * @atomicservice 1099 * @since 20 1100 */ 1101 static colorWithSpace(colorSpace: ColorSpace, red: number, green: number, blue: number, alpha?: number): ColorMetrics; 1102 1103 /** 1104 * Instantiate the ColorMetrics class using ResourceColor 1105 * 1106 * @param { ResourceColor } color - resource color 1107 * @returns { ColorMetrics } ColorMetrics class 1108 * @throws { BusinessError } 180003 - Failed to obtain the color resource. 1109 * @throws { BusinessError } 401 - Parameter error. Possible cause: 1110 * 1. The type of the input color parameter is not ResourceColor. 1111 * 2. The format of the input color string is not RGB or RGBA. 1112 * @syscap SystemCapability.ArkUI.ArkUI.Full 1113 * @crossplatform 1114 * @atomicservice 1115 * @since arkts {'1.1':'12','1.2':'20'} 1116 * @arkts 1.1&1.2 1117 */ 1118 static resourceColor(color: ResourceColor): ColorMetrics; 1119 1120 /** 1121 * blend color 1122 * 1123 * @param { ColorMetrics } overlayColor - overlay color 1124 * @returns { ColorMetrics } ColorMetrics class 1125 * @throws { BusinessError } 401 - Parameter error. The type of the input parameter is not ColorMetrics. 1126 * @syscap SystemCapability.ArkUI.ArkUI.Full 1127 * @crossplatform 1128 * @atomicservice 1129 * @since arkts {'1.1':'12','1.2':'20'} 1130 * @arkts 1.1&1.2 1131 */ 1132 blendColor(overlayColor: ColorMetrics): ColorMetrics; 1133 1134 /** 1135 * Get color of the ColorMetrics. 1136 * The return value is a string indicating an RGBA color value. 1137 * 1138 * @returns { string } The color of the ColorMetrics. 1139 * String indicating an RGBA color value. Example: 'rgba(255, 100, 255, 0.5)' 1140 * @syscap SystemCapability.ArkUI.ArkUI.Full 1141 * @crossplatform 1142 * @atomicservice 1143 * @since arkts {'1.1':'12','1.2':'20'} 1144 * @arkts 1.1&1.2 1145 */ 1146 get color(): string; 1147 1148 /** 1149 * Get red value of the ColorMetrics. 1150 * 1151 * @returns { number } The red value of the ColorMetrics. 1152 * The value is an integer ranging from 0 to 255. 1153 * @syscap SystemCapability.ArkUI.ArkUI.Full 1154 * @crossplatform 1155 * @atomicservice 1156 * @since arkts {'1.1':'12','1.2':'20'} 1157 * @arkts 1.1&1.2 1158 */ 1159 get red(): number; 1160 1161 /** 1162 * Get green value of the ColorMetrics. 1163 * 1164 * @returns { number } The green value of the ColorMetrics. 1165 * The value is an integer ranging from 0 to 255. 1166 * @syscap SystemCapability.ArkUI.ArkUI.Full 1167 * @crossplatform 1168 * @atomicservice 1169 * @since arkts {'1.1':'12','1.2':'20'} 1170 * @arkts 1.1&1.2 1171 */ 1172 get green(): number; 1173 1174 /** 1175 * Get blue value of the ColorMetrics. 1176 * 1177 * @returns { number } The blue value of the ColorMetrics. 1178 * The value is an integer ranging from 0 to 255. 1179 * @syscap SystemCapability.ArkUI.ArkUI.Full 1180 * @crossplatform 1181 * @atomicservice 1182 * @since arkts {'1.1':'12','1.2':'20'} 1183 * @arkts 1.1&1.2 1184 */ 1185 get blue(): number; 1186 1187 /** 1188 * Get opacity value of the ColorMetrics. 1189 * 1190 * @returns { number } The opacity value of the ColorMetrics. 1191 * The value is an integer ranging from 0 to 1. 1192 * @syscap SystemCapability.ArkUI.ArkUI.Full 1193 * @crossplatform 1194 * @atomicservice 1195 * @since arkts {'1.1':'12','1.2':'20'} 1196 * @arkts 1.1&1.2 1197 */ 1198 get alpha(): number; 1199} 1200 1201/** 1202 * Defines the Corner property. 1203 * 1204 * @interface Corners 1205 * @syscap SystemCapability.ArkUI.ArkUI.Full 1206 * @crossplatform 1207 * @atomicservice 1208 * @since arkts {'1.1':'12','1.2':'20'} 1209 * @arkts 1.1&1.2 1210 */ 1211interface Corners<T> { 1212 /** 1213 * TopLeft property. 1214 * 1215 * @type { T } 1216 * @syscap SystemCapability.ArkUI.ArkUI.Full 1217 * @crossplatform 1218 * @atomicservice 1219 * @since arkts {'1.1':'12','1.2':'20'} 1220 * @arkts 1.1&1.2 1221 */ 1222 topLeft: T, 1223 1224 /** 1225 * TopRight property. 1226 * 1227 * @type { T } 1228 * @syscap SystemCapability.ArkUI.ArkUI.Full 1229 * @crossplatform 1230 * @atomicservice 1231 * @since arkts {'1.1':'12','1.2':'20'} 1232 * @arkts 1.1&1.2 1233 */ 1234 topRight: T, 1235 1236 /** 1237 * BottomLeft property. 1238 * 1239 * @type { T } 1240 * @syscap SystemCapability.ArkUI.ArkUI.Full 1241 * @crossplatform 1242 * @atomicservice 1243 * @since arkts {'1.1':'12','1.2':'20'} 1244 * @arkts 1.1&1.2 1245 */ 1246 bottomLeft: T, 1247 1248 /** 1249 * BottomRight property. 1250 * 1251 * @type { T } 1252 * @syscap SystemCapability.ArkUI.ArkUI.Full 1253 * @crossplatform 1254 * @atomicservice 1255 * @since arkts {'1.1':'12','1.2':'20'} 1256 * @arkts 1.1&1.2 1257 */ 1258 bottomRight: T 1259} 1260 1261/** 1262 * Defines the Corner radius. 1263 * 1264 * @typedef { Corners<Vector2> } CornerRadius 1265 * @syscap SystemCapability.ArkUI.ArkUI.Full 1266 * @crossplatform 1267 * @atomicservice 1268 * @since arkts {'1.1':'12','1.2':'20'} 1269 * @arkts 1.1&1.2 1270 */ 1271export type CornerRadius = Corners<Vector2>; 1272 1273/** 1274 * BorderRadiuses info. 1275 * 1276 * @typedef { Corners<number> } BorderRadiuses 1277 * @syscap SystemCapability.ArkUI.ArkUI.Full 1278 * @crossplatform 1279 * @atomicservice 1280 * @since arkts {'1.1':'12','1.2':'20'} 1281 * @arkts 1.1&1.2 1282 */ 1283export type BorderRadiuses = Corners<number>; 1284 1285/** 1286 * Rect info. 1287 * 1288 * @typedef { common2D.Rect } Rect 1289 * @syscap SystemCapability.ArkUI.ArkUI.Full 1290 * @crossplatform 1291 * @atomicservice 1292 * @since arkts {'1.1':'12','1.2':'20'} 1293 * @arkts 1.1&1.2 1294 */ 1295export type Rect = common2D.Rect; 1296 1297/** 1298 * Defines the RoundRect. 1299 * 1300 * @interface RoundRect 1301 * @syscap SystemCapability.ArkUI.ArkUI.Full 1302 * @crossplatform 1303 * @atomicservice 1304 * @since arkts {'1.1':'12','1.2':'20'} 1305 * @arkts 1.1&1.2 1306 */ 1307export interface RoundRect { 1308 /** 1309 * Rect property. 1310 * 1311 * @type { Rect } 1312 * @syscap SystemCapability.ArkUI.ArkUI.Full 1313 * @crossplatform 1314 * @atomicservice 1315 * @since arkts {'1.1':'12','1.2':'20'} 1316 * @arkts 1.1&1.2 1317 */ 1318 rect: Rect, 1319 1320 /** 1321 * Corners property. 1322 * 1323 * @type { CornerRadius } 1324 * @syscap SystemCapability.ArkUI.ArkUI.Full 1325 * @crossplatform 1326 * @atomicservice 1327 * @since arkts {'1.1':'12','1.2':'20'} 1328 * @arkts 1.1&1.2 1329 */ 1330 corners: CornerRadius 1331} 1332 1333/** 1334 * Defines the Circle. 1335 * 1336 * @interface Circle 1337 * @syscap SystemCapability.ArkUI.ArkUI.Full 1338 * @crossplatform 1339 * @atomicservice 1340 * @since arkts {'1.1':'12','1.2':'20'} 1341 * @arkts 1.1&1.2 1342 */ 1343export interface Circle { 1344 /** 1345 * The x-coordinate of the center of the Circle, in px. 1346 * 1347 * @type { number } 1348 * @syscap SystemCapability.ArkUI.ArkUI.Full 1349 * @crossplatform 1350 * @atomicservice 1351 * @since arkts {'1.1':'12','1.2':'20'} 1352 * @arkts 1.1&1.2 1353 */ 1354 centerX: number, 1355 1356 /** 1357 * The y-coordinate of the center of the Circle, in px. 1358 * 1359 * @type { number } 1360 * @syscap SystemCapability.ArkUI.ArkUI.Full 1361 * @crossplatform 1362 * @atomicservice 1363 * @since arkts {'1.1':'12','1.2':'20'} 1364 * @arkts 1.1&1.2 1365 */ 1366 centerY: number, 1367 1368 /** 1369 * The radius of the Circle, in px. 1370 * Value range: [0, +∞). 1371 * 1372 * @type { number } 1373 * @syscap SystemCapability.ArkUI.ArkUI.Full 1374 * @crossplatform 1375 * @atomicservice 1376 * @since arkts {'1.1':'12','1.2':'20'} 1377 * @arkts 1.1&1.2 1378 */ 1379 radius: number 1380} 1381 1382/** 1383 * Defines the CommandPath. 1384 * 1385 * @interface CommandPath 1386 * @syscap SystemCapability.ArkUI.ArkUI.Full 1387 * @crossplatform 1388 * @atomicservice 1389 * @since arkts {'1.1':'12','1.2':'20'} 1390 * @arkts 1.1&1.2 1391 */ 1392export interface CommandPath { 1393 /** 1394 * The commands of CommandPath. 1395 * For details about how to convert the pixel unit, see Pixel Unit Conversion. 1396 * Unit: px 1397 * 1398 * @type { string } 1399 * @syscap SystemCapability.ArkUI.ArkUI.Full 1400 * @crossplatform 1401 * @atomicservice 1402 * @since arkts {'1.1':'12','1.2':'20'} 1403 * @arkts 1.1&1.2 1404 */ 1405 commands: string 1406} 1407 1408/** 1409 * Defines ShapeMask. 1410 * 1411 * @syscap SystemCapability.ArkUI.ArkUI.Full 1412 * @crossplatform 1413 * @atomicservice 1414 * @since arkts {'1.1':'12','1.2':'20'} 1415 * @arkts 1.1&1.2 1416 */ 1417export declare class ShapeMask { 1418 /** 1419 * Constructor. 1420 * 1421 * @syscap SystemCapability.ArkUI.ArkUI.Full 1422 * @crossplatform 1423 * @atomicservice 1424 * @since arkts {'1.1':'12','1.2':'20'} 1425 * @arkts 1.1&1.2 1426 */ 1427 constructor(); 1428 1429 /** 1430 * Set the rect shape of the ShapeMask. 1431 * 1432 * @param { Rect } rect - The rect shape will be set. 1433 * @syscap SystemCapability.ArkUI.ArkUI.Full 1434 * @crossplatform 1435 * @atomicservice 1436 * @since arkts {'1.1':'12','1.2':'20'} 1437 * @arkts 1.1&1.2 1438 */ 1439 setRectShape(rect: Rect): void; 1440 1441 /** 1442 * Set the round rect shape of the ShapeMask. 1443 * 1444 * @param { RoundRect } roundRect - The round rect shape will be set. 1445 * @syscap SystemCapability.ArkUI.ArkUI.Full 1446 * @crossplatform 1447 * @atomicservice 1448 * @since arkts {'1.1':'12','1.2':'20'} 1449 * @arkts 1.1&1.2 1450 */ 1451 setRoundRectShape(roundRect: RoundRect): void; 1452 1453 /** 1454 * Set the circle shape of the ShapeMask. 1455 * 1456 * @param { Circle } circle - The circle shape will be set. 1457 * @syscap SystemCapability.ArkUI.ArkUI.Full 1458 * @crossplatform 1459 * @atomicservice 1460 * @since arkts {'1.1':'12','1.2':'20'} 1461 * @arkts 1.1&1.2 1462 */ 1463 setCircleShape(circle: Circle): void; 1464 1465 /** 1466 * Set the oval shape of the ShapeMask. 1467 * 1468 * @param { Rect } oval - The oval shape will be set. 1469 * @syscap SystemCapability.ArkUI.ArkUI.Full 1470 * @crossplatform 1471 * @atomicservice 1472 * @since arkts {'1.1':'12','1.2':'20'} 1473 * @arkts 1.1&1.2 1474 */ 1475 setOvalShape(oval: Rect): void; 1476 1477 /** 1478 * Set the command path of the ShapeMask. 1479 * 1480 * @param { CommandPath } path - The command path will be set. 1481 * @syscap SystemCapability.ArkUI.ArkUI.Full 1482 * @crossplatform 1483 * @atomicservice 1484 * @since arkts {'1.1':'12','1.2':'20'} 1485 * @arkts 1.1&1.2 1486 */ 1487 setCommandPath(path: CommandPath): void; 1488 1489 /** 1490 * The fill color of the ShapeMask, in ARGB format. 1491 * The default value is 0XFF000000. 1492 * 1493 * @type { number } 1494 * @default 0XFF000000 1495 * @syscap SystemCapability.ArkUI.ArkUI.Full 1496 * @crossplatform 1497 * @atomicservice 1498 * @since arkts {'1.1':'12','1.2':'20'} 1499 * @arkts 1.1&1.2 1500 */ 1501 fillColor: number; 1502 1503 /** 1504 * The stroke color of the ShapeMask, in ARGB format. 1505 * The default value is 0XFF000000. 1506 * 1507 * @type { number } 1508 * @default 0XFF000000 1509 * @syscap SystemCapability.ArkUI.ArkUI.Full 1510 * @crossplatform 1511 * @atomicservice 1512 * @since arkts {'1.1':'12','1.2':'20'} 1513 * @arkts 1.1&1.2 1514 */ 1515 strokeColor: number; 1516 1517 /** 1518 * The stroke width of the ShapeMask, in px. 1519 * The default value is 0. 1520 * 1521 * @type { number } 1522 * @default 0 1523 * @syscap SystemCapability.ArkUI.ArkUI.Full 1524 * @crossplatform 1525 * @atomicservice 1526 * @since arkts {'1.1':'12','1.2':'20'} 1527 * @arkts 1.1&1.2 1528 */ 1529 strokeWidth: number; 1530} 1531 1532 1533/** 1534 * Define ShapeClip. Record the type and parameters of the shape used for clipping. 1535 * 1536 * @syscap SystemCapability.ArkUI.ArkUI.Full 1537 * @crossplatform 1538 * @atomicservice 1539 * @since arkts {'1.1':'12','1.2':'20'} 1540 * @arkts 1.1&1.2 1541 */ 1542export declare class ShapeClip { 1543 /** 1544 * Constructor. 1545 * 1546 * @syscap SystemCapability.ArkUI.ArkUI.Full 1547 * @crossplatform 1548 * @atomicservice 1549 * @since arkts {'1.1':'12','1.2':'20'} 1550 * @arkts 1.1&1.2 1551 */ 1552 constructor(); 1553 1554 /** 1555 * Set the rect shape of the ShapeClip. 1556 * 1557 * @param { Rect } rect - The rect shape will be set. 1558 * @syscap SystemCapability.ArkUI.ArkUI.Full 1559 * @crossplatform 1560 * @atomicservice 1561 * @since arkts {'1.1':'12','1.2':'20'} 1562 * @arkts 1.1&1.2 1563 */ 1564 setRectShape(rect: Rect): void; 1565 1566 /** 1567 * Set the round rect shape of the ShapeClip. 1568 * 1569 * @param { RoundRect } roundRect - The round rect shape will be set. 1570 * @syscap SystemCapability.ArkUI.ArkUI.Full 1571 * @crossplatform 1572 * @atomicservice 1573 * @since arkts {'1.1':'12','1.2':'20'} 1574 * @arkts 1.1&1.2 1575 */ 1576 setRoundRectShape(roundRect: RoundRect): void; 1577 1578 /** 1579 * Set the circle shape of the ShapeClip. 1580 * 1581 * @param { Circle } circle - The circle shape will be set. 1582 * @syscap SystemCapability.ArkUI.ArkUI.Full 1583 * @crossplatform 1584 * @atomicservice 1585 * @since arkts {'1.1':'12','1.2':'20'} 1586 * @arkts 1.1&1.2 1587 */ 1588 setCircleShape(circle: Circle): void; 1589 1590 /** 1591 * Set the oval shape of the ShapeClip. 1592 * 1593 * @param { Rect } oval - The oval shape will be set. 1594 * @syscap SystemCapability.ArkUI.ArkUI.Full 1595 * @crossplatform 1596 * @atomicservice 1597 * @since arkts {'1.1':'12','1.2':'20'} 1598 * @arkts 1.1&1.2 1599 */ 1600 setOvalShape(oval: Rect): void; 1601 1602 /** 1603 * Set the command path of the ShapeClip. 1604 * 1605 * @param { CommandPath } path - The command path will be set. 1606 * @syscap SystemCapability.ArkUI.ArkUI.Full 1607 * @crossplatform 1608 * @atomicservice 1609 * @since arkts {'1.1':'12','1.2':'20'} 1610 * @arkts 1.1&1.2 1611 */ 1612 setCommandPath(path: CommandPath): void; 1613} 1614 1615/** 1616 * Obtain a object with all edges are set to the same color. 1617 * 1618 * @param { number } all - The edge color will be set, in ARGB format, for example, 0xffff00ff. 1619 * Value range: [0, 0xffffffff] 1620 * @returns { Edges<number> } - The object with all edges are set to the same color. 1621 * @syscap SystemCapability.ArkUI.ArkUI.Full 1622 * @crossplatform 1623 * @atomicservice 1624 * @since 12 1625 */ 1626/** 1627 * Obtain a object with all edges are set to the same color. 1628 * 1629 * @param { number } all - The edge color will be set. 1630 * @returns { Edges<number> } - The object with all edges are set to the same color. 1631 * @syscap SystemCapability.ArkUI.ArkUI.Full 1632 * @crossplatform 1633 * @atomicservice 1634 * @since 20 1635 * @arkts 1.1&1.2 1636 */ 1637export declare function edgeColors(all: number): Edges<number>; 1638 1639/** 1640 * Obtain a object with all edges are set to the same width. 1641 * 1642 * @param { number } all - The edge width will be set, in vp. 1643 * Value range: [0, +∞). 1644 * @returns { Edges<number> } - The object with all edges are set to the same width. 1645 * @syscap SystemCapability.ArkUI.ArkUI.Full 1646 * @crossplatform 1647 * @atomicservice 1648 * @since 12 1649 */ 1650/** 1651 * Obtain a object with all edges are set to the same width. 1652 * 1653 * @param { number } all - The edge width will be set. 1654 * @returns { Edges<number> } - The object with all edges are set to the same width. 1655 * @syscap SystemCapability.ArkUI.ArkUI.Full 1656 * @crossplatform 1657 * @atomicservice 1658 * @since 20 1659 * @arkts 1.1&1.2 1660 */ 1661export declare function edgeWidths(all: number): Edges<number>; 1662 1663/** 1664 * Obtain a object with all edges are set to the same style. 1665 * 1666 * @param { BorderStyle } all - The edge style will be set. 1667 * @returns { Edges<BorderStyle> } - The object with all edges are set to the same style. 1668 * @syscap SystemCapability.ArkUI.ArkUI.Full 1669 * @crossplatform 1670 * @atomicservice 1671 * @since 12 1672 */ 1673/** 1674 * Obtain a object with all edges are set to the same style. 1675 * 1676 * @param { BorderStyle } all - The edge style will be set. 1677 * @returns { Edges<BorderStyle> } - The object with all edges are set to the same style. 1678 * @syscap SystemCapability.ArkUI.ArkUI.Full 1679 * @crossplatform 1680 * @atomicservice 1681 * @since 20 1682 * @arkts 1.1&1.2 1683 */ 1684export declare function borderStyles(all: BorderStyle): Edges<BorderStyle>; 1685 1686/** 1687 * Obtain a BorderRadiuses object with all edges are set to the same radius. 1688 * 1689 * @param { number } all - The edge radius will be set. 1690 * Unit: vp. 1691 * Value range: [0, +∞). 1692 * @returns { BorderRadiuses } - The BorderRadiuses object. 1693 * @syscap SystemCapability.ArkUI.ArkUI.Full 1694 * @crossplatform 1695 * @atomicservice 1696 * @since 12 1697 */ 1698/** 1699 * Obtain a BorderRadiuses object with all edges are set to the same radius. 1700 * 1701 * @param { number } all - The edge radius will be set. 1702 * @returns { BorderRadiuses } - The BorderRadiuses object. 1703 * @syscap SystemCapability.ArkUI.ArkUI.Full 1704 * @crossplatform 1705 * @atomicservice 1706 * @since 20 1707 * @arkts 1.1&1.2 1708 */ 1709export declare function borderRadiuses(all: number): BorderRadiuses; 1710