1/* 2 * Copyright (c) 2021-2025 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 OriginalContext from '../../application/Context'; 23import { Resource } from '../../global/resource'; 24import pointer from '../../@ohos.multimodalInput.pointer'; 25import image from '../../@ohos.multimedia.image'; 26import unifiedDataChannel from '../../@ohos.data.unifiedDataChannel'; 27import promptAction from '../../@ohos.promptAction'; 28import uniformTypeDescriptor from '../../@ohos.data.uniformTypeDescriptor'; 29import Want from '../../@ohos.app.ability.Want'; 30import { IntentionCode } from '../../@ohos.multimodalInput.intentionCode'; 31import { SymbolGlyphModifier } from '../../arkui/SymbolGlyphModifier'; 32import { CircleShape, EllipseShape, PathShape, RectShape } from '../../@ohos.arkui.shape'; 33import uiObserver from '../../@ohos.arkui.observer'; 34import { UIContext } from '../../@ohos.arkui.UIContext'; 35import { DrawContext, LengthMetrics } from '../../arkui/Graphics'; 36import uiEffect from '../../@ohos.graphics.uiEffect'; 37import { FocusBoxStyle, FocusPriority } from './focus'; 38import { ComponentContent } from '../../arkui/ComponentContent'; 39import { ResizableOptions } from './image'; 40import { Theme } from '../../@ohos.arkui.theme'; 41import intl from '../../@ohos.intl'; 42import { ButtonType, ButtonStyleMode, ButtonRole } from './button'; 43import { 44 Area, ResourceColor, Dimension, ResourceStr, Font, Length, EdgeColors, 45 LocalizedEdgeColors, BorderRadiuses, EdgeWidths, LocalizedEdgeWidths, SizeOptions, Bias, 46 EdgeStyles, Position, LocalizedBorderRadiuses, Margin, ChainWeightOptions, Padding, LocalizedPadding, LocalizedMargin, 47 BorderOptions, OutlineOptions, EdgeOutlineStyles, EdgeOutlineWidths, OutlineRadiuses, Edges, LocalizedEdges, LocalizedPosition, 48 AccessibilityOptions, ConstraintSizeOptions, EdgeWidth, DirectionalEdgesT, VoidCallback 49 } from './units'; 50import { BaseGestureEvent, GestureRecognizer, GestureJudgeResult, GestureType, 51 GestureMask, GestureHandler, GesturePriority, GestureInfo 52 } from './gesture'; 53import { ScrollState } from './list'; 54import { 55 AccessibilityHoverType, Curve, PlayMode, SharedTransitionEffectType, KeySource, BorderStyle, 56 HorizontalAlign, VerticalAlign, MouseButton, MouseAction, TransitionType, FontWeight, TouchType, 57 FontStyle, Color, ColoringStrategy, Placement, ArrowPointPosition, ClickEffectLevel, NestedScrollMode, HitTestMode, 58 Alignment, ImageRepeat, ImageSize, HoverEffect, Visibility, ItemAlign, Direction, Axis, GradientDirection, FunctionKey, 59 ModifierKey, ObscuredReasons, RenderFit, LineCapStyle, LineJoinStyle, PixelRoundCalcPolicy, IlluminatedType, TextDecorationType, 60 TextDecorationStyle, KeyType, ResponseType, BarState, EdgeEffect, ScrollSource, InteractionHand, AxisAction, AxisModel, CrownAction, 61 FocusDrawLevel, CrownSensitivity 62} from './enums'; 63import { TextRange } from './textCommon'; 64import { StyledString } from './styledString'; 65import { CircleAttribute } from './circle'; 66import { RectAttribute } from './rect'; 67import { PathAttribute } from './path'; 68import { EllipseAttribute } from './ellipse'; 69import { LocalStorage } from '../stateManagement/storages/localStorage'; 70import { CustomBuilder } from './builder'; 71/*** endif */ 72 73/** 74 * The type for SpringLoadingContext, see the detailed description in dragController. 75 * 76 * @typedef {import('../api/@ohos.arkui.dragController').default.SpringLoadingContext} SpringLoadingContext 77 * @syscap SystemCapability.ArkUI.ArkUI.Full 78 * @atomicservice 79 * @since 20 80 */ 81declare type SpringLoadingContext = import('../api/@ohos.arkui.dragController').default.SpringLoadingContext; 82 83/** 84 * The type for DragSpringLoadingConfiguration, see the detailed description in dragController. 85 * 86 * @typedef {import('../api/@ohos.arkui.dragController').default.DragSpringLoadingConfiguration} DragSpringLoadingConfiguration 87 * @syscap SystemCapability.ArkUI.ArkUI.Full 88 * @atomicservice 89 * @since 20 90 */ 91declare type DragSpringLoadingConfiguration = import('../api/@ohos.arkui.dragController').default.DragSpringLoadingConfiguration; 92 93/** 94 * Defines the options of Component ClassDecorator. 95 * 96 * @interface ComponentOptions 97 * @syscap SystemCapability.ArkUI.ArkUI.Full 98 * @crossplatform 99 * @form 100 * @since 11 101 */ 102/** 103 * Defines the options of Component ClassDecorator. 104 * 105 * @interface ComponentOptions 106 * @syscap SystemCapability.ArkUI.ArkUI.Full 107 * @crossplatform 108 * @form 109 * @atomicservice 110 * @since 12 111 */ 112declare interface ComponentOptions { 113 /** 114 * freeze UI state. 115 * 116 * @type { boolean } 117 * @default false 118 * @syscap SystemCapability.ArkUI.ArkUI.Full 119 * @crossplatform 120 * @form 121 * @since 11 122 */ 123 /** 124 * freeze UI state. 125 * 126 * @type { boolean } 127 * @default false 128 * @syscap SystemCapability.ArkUI.ArkUI.Full 129 * @crossplatform 130 * @form 131 * @atomicservice 132 * @since 12 133 */ 134 freezeWhenInactive : boolean, 135} 136 137/** 138 * Define the ratio of characters entered by the the percentage of InputCounterOptions. 139 * 140 * @interface InputCounterOptions 141 * @syscap SystemCapability.ArkUI.ArkUI.Full 142 * @crossplatform 143 * @since 11 144 */ 145/** 146 * Define the ratio of characters entered by the the percentage of InputCounterOptions. 147 * 148 * @interface InputCounterOptions 149 * @syscap SystemCapability.ArkUI.ArkUI.Full 150 * @crossplatform 151 * @atomicservice 152 * @since arkts {'1.1':'12','1.2':'20'} 153 * @arkts 1.1&1.2 154 */ 155declare interface InputCounterOptions { 156 /** 157 * It is the numerator bit of the percentage and used as a threshold. If the number of characters input 158 * reaches the maximum number of characters multiplied by this threshold, the counter is displayed. 159 * @type { ?number } 160 * @syscap SystemCapability.ArkUI.ArkUI.Full 161 * @crossplatform 162 * @since 11 163 */ 164 /** 165 * It is the numerator bit of the percentage and used as a threshold. If the number of characters input 166 * reaches the maximum number of characters multiplied by this threshold, the counter is displayed. 167 * 168 * <p><strong>NOTE</strong>: 169 * <br>Threshold percentage for displaying the character counter. 170 * <br>The character counter is displayed when the number of characters that have been entered is greater than 171 * the maximum number of characters multiplied by the threshold percentage value. 172 * <br>When displayed, the character counter is in the following format: 173 * <br>Number of characters that have been entered/Maximum number of characters allowed. 174 * <br>It is visible when the number of characters entered is greater than 175 * the character limit multiplied by the threshold percentage value. 176 * <br>Value range: [1, 100] 177 * <br>If the value is not an integer, it is rounded down to the nearest integer. 178 * <br>If the value exceeds the valid value range, the character counter is not displayed. 179 * <br>If the value is <em>undefined</em>, the character counter is displayed, but this parameter has no effect. 180 * </p> 181 * 182 * @type { ?number } 183 * @syscap SystemCapability.ArkUI.ArkUI.Full 184 * @crossplatform 185 * @atomicservice 186 * @since arkts {'1.1':'12','1.2':'20'} 187 * @arkts 1.1&1.2 188 */ 189 thresholdPercentage?: number; 190 191 /** 192 * If the current input character count reaches the maximum character count and users want to exceed the 193 * normal input, the border will turn red. If this parameter is true, the red border displayed. 194 * @type { ?boolean } 195 * @default true 196 * @syscap SystemCapability.ArkUI.ArkUI.Full 197 * @crossplatform 198 * @since 11 199 */ 200 /** 201 * If the current input character count reaches the maximum character count and users want to exceed the 202 * normal input, the border will turn red. If this parameter is true, the red border displayed. 203 * 204 * <p><strong>NOTE</strong>: 205 * <br>Whether to highlight the text box border and character counter subscript in red. 206 * <br>If options is not set, the text box border and character counter subscript turn red 207 * <br>when the number of characters entered reaches the limit. 208 * <br>If the character counter is displayed and thresholdPercentage is set to a valid value, 209 * the text box border and character counter subscript turn red when the number of entered characters exceeds the limit. 210 * <br>The value true (default) means to highlight the text box border and character counter subscript in red. 211 * </p> 212 * 213 * @type { ?boolean } 214 * @default true 215 * @syscap SystemCapability.ArkUI.ArkUI.Full 216 * @crossplatform 217 * @atomicservice 218 * @since arkts {'1.1':'12','1.2':'20'} 219 * @arkts 1.1&1.2 220 */ 221 highlightBorder?: boolean; 222} 223 224/** 225 * Defines the options of decoration. 226 * 227 * @interface TextDecorationOptions 228 * @syscap SystemCapability.ArkUI.ArkUI.Full 229 * @crossplatform 230 * @atomicservice 231 * @since arkts {'1.1':'12','1.2':'20'} 232 * @arkts 1.1&1.2 233 */ 234declare interface TextDecorationOptions { 235 /** 236 * The decoration type. 237 * 238 * @type { TextDecorationType } 239 * @syscap SystemCapability.ArkUI.ArkUI.Full 240 * @crossplatform 241 * @atomicservice 242 * @since arkts {'1.1':'12','1.2':'20'} 243 * @arkts 1.1&1.2 244 */ 245 type: TextDecorationType; 246 247 /** 248 * Sets the color of decoration. 249 * 250 * @type { ?ResourceColor } 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 color?: ResourceColor; 258 259 /** 260 * The style value of decoration. 261 * 262 * @type { ?TextDecorationStyle } 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 style?: TextDecorationStyle; 270} 271 272/** 273 * Defining Component ClassDecorator 274 * 275 * @syscap SystemCapability.ArkUI.ArkUI.Full 276 * @since 7 277 */ 278/** 279 * Defining Component ClassDecorator 280 * 281 * @syscap SystemCapability.ArkUI.ArkUI.Full 282 * @form 283 * @since 9 284 */ 285/** 286 * Defining Component ClassDecorator 287 * 288 * @syscap SystemCapability.ArkUI.ArkUI.Full 289 * @crossplatform 290 * @form 291 * @since 10 292 */ 293/** 294 * Defining Component ClassDecorator 295 * 296 * Component is a ClassDecorator and it supports ComponentOptions as parameters. 297 * @syscap SystemCapability.ArkUI.ArkUI.Full 298 * @crossplatform 299 * @form 300 * @atomicservice 301 * @since 11 302 */ 303declare const Component: ClassDecorator & ((options: ComponentOptions) => ClassDecorator); 304 305/** 306 * Defining ComponentV2 ClassDecorator 307 * 308 * ComponentV2 is a ClassDecorator and it supports ComponentOptions as parameters. 309 * @syscap SystemCapability.ArkUI.ArkUI.Full 310 * @crossplatform 311 * @atomicservice 312 * @since 12 313 */ 314declare const ComponentV2: ClassDecorator & ((options: ComponentOptions) => ClassDecorator); 315 316/** 317 * Defines the options of Entry ClassDecorator. 318 * 319 * @interface EntryOptions 320 * @syscap SystemCapability.ArkUI.ArkUI.Full 321 * @form 322 * @since 10 323 */ 324/** 325 * Defines the options of Entry ClassDecorator. 326 * 327 * @interface EntryOptions 328 * @syscap SystemCapability.ArkUI.ArkUI.Full 329 * @form 330 * @atomicservice 331 * @since 11 332 */ 333declare interface EntryOptions { 334 /** 335 * Named route name. 336 * 337 * @type { ?string } 338 * @syscap SystemCapability.ArkUI.ArkUI.Full 339 * @form 340 * @since 10 341 */ 342 /** 343 * Named route name. 344 * 345 * @type { ?string } 346 * @syscap SystemCapability.ArkUI.ArkUI.Full 347 * @form 348 * @atomicservice 349 * @since 11 350 */ 351 routeName? : string, 352 353 /** 354 * LocalStorage to be passed. 355 * 356 * @type { ?LocalStorage } 357 * @syscap SystemCapability.ArkUI.ArkUI.Full 358 * @form 359 * @since 10 360 */ 361 /** 362 * LocalStorage to be passed. 363 * 364 * @type { ?LocalStorage } 365 * @syscap SystemCapability.ArkUI.ArkUI.Full 366 * @form 367 * @atomicservice 368 * @since 11 369 */ 370 storage? : LocalStorage, 371 372 /** 373 * Determines whether to use the LocalStorage instance object returned by the LocalStorage.getShared() interface. 374 * 375 * @type { ?boolean } 376 * @syscap SystemCapability.ArkUI.ArkUI.Full 377 * @crossplatform 378 * @form 379 * @atomicservice 380 * @since arkts {'1.1':'12','1.2':'20'} 381 * @arkts 1.1&1.2 382 */ 383 useSharedStorage? : boolean, 384} 385 386/** 387 * Provides an interface for the style of an divider including stroke width, color, start margin 388 * and end margin 389 * 390 * @interface DividerStyle 391 * @syscap SystemCapability.ArkUI.ArkUI.Full 392 * @atomicservice 393 * @since 20 394 * @arkts 1.2 395 */ 396declare interface DividerStyle { 397 /** 398 * Define the stroke width of the divider 399 * 400 * @type { Length } 401 * @default 0 402 * @syscap SystemCapability.ArkUI.ArkUI.Full 403 * @atomicservice 404 * @since 20 405 * @arkts 1.2 406 */ 407 strokeWidth: Length; 408 409 /** 410 * Define the color of the divider 411 * 412 * @type { ?ResourceColor } 413 * @syscap SystemCapability.ArkUI.ArkUI.Full 414 * @atomicservice 415 * @since 20 416 * @arkts 1.2 417 */ 418 color?: ResourceColor; 419 420 /** 421 * Define the start margin of the divider 422 * 423 * @type { ?Length } 424 * @default 0 425 * @syscap SystemCapability.ArkUI.ArkUI.Full 426 * @atomicservice 427 * @since 20 428 * @arkts 1.2 429 */ 430 startMargin?: Length; 431 432 /** 433 * Define the end margin of the divider 434 * 435 * @type { ?Length } 436 * @default 0 437 * @syscap SystemCapability.ArkUI.ArkUI.Full 438 * @atomicservice 439 * @since 20 440 * @arkts 1.2 441 */ 442 endMargin?: Length; 443} 444 445/** 446 * Defines Entry ClassDecorator. 447 * 448 * @syscap SystemCapability.ArkUI.ArkUI.Full 449 * @since 7 450 */ 451/** 452 * Defines Entry ClassDecorator. 453 * 454 * Entry is a ClassDecorator and it supports LocalStorage as parameters. 455 * @syscap SystemCapability.ArkUI.ArkUI.Full 456 * @form 457 * @since 9 458 */ 459/** 460 * Defines Entry ClassDecorator. 461 * 462 * Entry is a ClassDecorator and it supports LocalStorage or EntryOptions as parameters. 463 * @syscap SystemCapability.ArkUI.ArkUI.Full 464 * @crossplatform 465 * @form 466 * @since 10 467 */ 468/** 469 * Defines Entry ClassDecorator. 470 * 471 * Entry is a ClassDecorator and it supports LocalStorage or EntryOptions as parameters. 472 * @syscap SystemCapability.ArkUI.ArkUI.Full 473 * @crossplatform 474 * @form 475 * @atomicservice 476 * @since 11 477 */ 478declare const Entry: ClassDecorator & ((options?: LocalStorage | EntryOptions) => ClassDecorator); 479 480/** 481 * Defining Observed ClassDecorator. 482 * 483 * @syscap SystemCapability.ArkUI.ArkUI.Full 484 * @since 7 485 */ 486/** 487 * Defining Observed ClassDecorator. 488 * 489 * @syscap SystemCapability.ArkUI.ArkUI.Full 490 * @form 491 * @since 9 492 */ 493/** 494 * Defining Observed ClassDecorator. 495 * 496 * @syscap SystemCapability.ArkUI.ArkUI.Full 497 * @crossplatform 498 * @form 499 * @since 10 500 */ 501/** 502 * Defining Observed ClassDecorator. 503 * 504 * @syscap SystemCapability.ArkUI.ArkUI.Full 505 * @crossplatform 506 * @form 507 * @atomicservice 508 * @since 11 509 */ 510declare const Observed: ClassDecorator; 511 512/** 513 * Defining ObservedV2 ClassDecorator. 514 * 515 * @syscap SystemCapability.ArkUI.ArkUI.Full 516 * @crossplatform 517 * @form 518 * @atomicservice 519 * @since 12 520 */ 521declare const ObservedV2: ClassDecorator; 522 523/** 524 * Defining Preview ClassDecorator. 525 * 526 * @syscap SystemCapability.ArkUI.ArkUI.Full 527 * @since 7 528 */ 529/** 530 * Defining Preview ClassDecorator. 531 * 532 * @syscap SystemCapability.ArkUI.ArkUI.Full 533 * @form 534 * @since 9 535 */ 536/** 537 * Defining Preview ClassDecorator. 538 * 539 * @syscap SystemCapability.ArkUI.ArkUI.Full 540 * @crossplatform 541 * @form 542 * @since 10 543 */ 544/** 545 * Defining Preview ClassDecorator. 546 * 547 * @syscap SystemCapability.ArkUI.ArkUI.Full 548 * @crossplatform 549 * @form 550 * @atomicservice 551 * @since 11 552 */ 553declare const Preview: ClassDecorator & ((value: PreviewParams) => ClassDecorator); 554 555/** 556 * Defining Require PropertyDecorator. 557 * 558 * @syscap SystemCapability.ArkUI.ArkUI.Full 559 * @crossplatform 560 * @form 561 * @atomicservice 562 * @since 11 563 */ 564declare const Require: PropertyDecorator; 565 566/** 567 * Defining BuilderParam PropertyDecorator 568 * 569 * @syscap SystemCapability.ArkUI.ArkUI.Full 570 * @since 7 571 */ 572/** 573 * Defining BuilderParam PropertyDecorator 574 * 575 * @syscap SystemCapability.ArkUI.ArkUI.Full 576 * @form 577 * @since 9 578 */ 579/** 580 * Defining BuilderParam PropertyDecorator 581 * 582 * @syscap SystemCapability.ArkUI.ArkUI.Full 583 * @crossplatform 584 * @form 585 * @since 10 586 */ 587/** 588 * Defining BuilderParam PropertyDecorator 589 * 590 * @syscap SystemCapability.ArkUI.ArkUI.Full 591 * @crossplatform 592 * @form 593 * @atomicservice 594 * @since 11 595 */ 596declare const BuilderParam: PropertyDecorator; 597 598/** 599 * Defining Local PropertyDecorator. 600 * 601 * @syscap SystemCapability.ArkUI.ArkUI.Full 602 * @crossplatform 603 * @atomicservice 604 * @since 12 605 */ 606declare const Local: PropertyDecorator; 607 608/** 609 * Defining Param PropertyDecorator. 610 * 611 * @syscap SystemCapability.ArkUI.ArkUI.Full 612 * @crossplatform 613 * @atomicservice 614 * @since 12 615 */ 616declare const Param: PropertyDecorator; 617 618/** 619 * Defining Once PropertyDecorator. 620 * 621 * @syscap SystemCapability.ArkUI.ArkUI.Full 622 * @crossplatform 623 * @atomicservice 624 * @since 12 625 */ 626declare const Once: PropertyDecorator; 627 628/** 629 * Defining Event PropertyDecorator. 630 * 631 * @syscap SystemCapability.ArkUI.ArkUI.Full 632 * @crossplatform 633 * @atomicservice 634 * @since 12 635 */ 636declare const Event: PropertyDecorator; 637 638/** 639 * Defining State PropertyDecorator. 640 * 641 * @syscap SystemCapability.ArkUI.ArkUI.Full 642 * @since 7 643 */ 644/** 645 * Defining State PropertyDecorator. 646 * 647 * @syscap SystemCapability.ArkUI.ArkUI.Full 648 * @form 649 * @since 9 650 */ 651/** 652 * Defining State PropertyDecorator. 653 * 654 * @syscap SystemCapability.ArkUI.ArkUI.Full 655 * @crossplatform 656 * @form 657 * @since 10 658 */ 659/** 660 * Defining State PropertyDecorator. 661 * 662 * @syscap SystemCapability.ArkUI.ArkUI.Full 663 * @crossplatform 664 * @form 665 * @atomicservice 666 * @since 11 667 */ 668declare const State: PropertyDecorator; 669 670/** 671 * Defining Track PropertyDecorator. 672 * 673 * @syscap SystemCapability.ArkUI.ArkUI.Full 674 * @crossplatform 675 * @form 676 * @since 11 677 */ 678/** 679 * Defining Track PropertyDecorator. 680 * 681 * @syscap SystemCapability.ArkUI.ArkUI.Full 682 * @crossplatform 683 * @form 684 * @atomicservice 685 * @since 12 686 */ 687declare const Track: PropertyDecorator; 688 689/** 690 * Defining Trace PropertyDecorator. 691 * 692 * @syscap SystemCapability.ArkUI.ArkUI.Full 693 * @crossplatform 694 * @form 695 * @atomicservice 696 * @since 12 697 */ 698declare const Trace: PropertyDecorator; 699 700/** 701 * Defining Prop PropertyDecorator. 702 * 703 * @syscap SystemCapability.ArkUI.ArkUI.Full 704 * @since 7 705 */ 706/** 707 * Defining Prop PropertyDecorator. 708 * 709 * @syscap SystemCapability.ArkUI.ArkUI.Full 710 * @form 711 * @since 9 712 */ 713/** 714 * Defining Prop PropertyDecorator. 715 * 716 * @syscap SystemCapability.ArkUI.ArkUI.Full 717 * @crossplatform 718 * @form 719 * @since 10 720 */ 721/** 722 * Defining Prop PropertyDecorator. 723 * 724 * @syscap SystemCapability.ArkUI.ArkUI.Full 725 * @crossplatform 726 * @form 727 * @atomicservice 728 * @since 11 729 */ 730declare const Prop: PropertyDecorator; 731 732/** 733 * Defining Link PropertyDecorator. 734 * 735 * @syscap SystemCapability.ArkUI.ArkUI.Full 736 * @since 7 737 */ 738/** 739 * Defining Link PropertyDecorator. 740 * 741 * @syscap SystemCapability.ArkUI.ArkUI.Full 742 * @form 743 * @since 9 744 */ 745/** 746 * Defining Link PropertyDecorator. 747 * 748 * @syscap SystemCapability.ArkUI.ArkUI.Full 749 * @crossplatform 750 * @form 751 * @since 10 752 */ 753/** 754 * Defining Link PropertyDecorator. 755 * 756 * @syscap SystemCapability.ArkUI.ArkUI.Full 757 * @crossplatform 758 * @form 759 * @atomicservice 760 * @since 11 761 */ 762declare const Link: PropertyDecorator; 763 764/** 765 * Defining ObjectLink PropertyDecorator. 766 * 767 * @syscap SystemCapability.ArkUI.ArkUI.Full 768 * @since 7 769 */ 770/** 771 * Defining ObjectLink PropertyDecorator. 772 * 773 * @syscap SystemCapability.ArkUI.ArkUI.Full 774 * @form 775 * @since 9 776 */ 777/** 778 * Defining ObjectLink PropertyDecorator. 779 * 780 * @syscap SystemCapability.ArkUI.ArkUI.Full 781 * @crossplatform 782 * @form 783 * @since 10 784 */ 785/** 786 * Defining ObjectLink PropertyDecorator. 787 * 788 * @syscap SystemCapability.ArkUI.ArkUI.Full 789 * @crossplatform 790 * @form 791 * @atomicservice 792 * @since 11 793 */ 794declare const ObjectLink: PropertyDecorator; 795 796/** 797 * Defines the options of Provide PropertyDecorator. 798 * 799 * @interface ProvideOptions 800 * @syscap SystemCapability.ArkUI.ArkUI.Full 801 * @crossplatform 802 * @form 803 * @atomicservice 804 * @since 11 805 */ 806declare interface ProvideOptions { 807 /** 808 * Override the @Provide of any parent or parent of parent @Component.@Provide({allowOverride: "name"}) is 809 * also allowed to be used even when there is no ancestor @Component whose @Provide would be overridden. 810 * 811 * @type { ?string } 812 * @syscap SystemCapability.ArkUI.ArkUI.Full 813 * @crossplatform 814 * @form 815 * @atomicservice 816 * @since 11 817 */ 818 allowOverride?: string, 819} 820 821/** 822 * Defining Provide PropertyDecorator. 823 * 824 * @syscap SystemCapability.ArkUI.ArkUI.Full 825 * @since 7 826 */ 827/** 828 * Defining Provide PropertyDecorator. 829 * 830 * @syscap SystemCapability.ArkUI.ArkUI.Full 831 * @form 832 * @since 9 833 */ 834/** 835 * Defining Provide PropertyDecorator. 836 * 837 * @syscap SystemCapability.ArkUI.ArkUI.Full 838 * @crossplatform 839 * @form 840 * @since 10 841 */ 842/** 843 * Defining Provide PropertyDecorator. 844 * 845 * @syscap SystemCapability.ArkUI.ArkUI.Full 846 * @crossplatform 847 * @form 848 * @atomicservice 849 * @since 11 850 */ 851declare const Provide: PropertyDecorator & ((value: string | ProvideOptions) => PropertyDecorator); 852 853/** 854 * Defining Provider PropertyDecorator, aliasName is the only matching key and if aliasName is the default, the default attribute name is regarded as aliasName. 855 * @syscap SystemCapability.ArkUI.ArkUI.Full 856 * @crossplatform 857 * @atomicservice 858 * @since 12 859 */ 860declare const Provider: (aliasName?: string) => PropertyDecorator; 861 862/** 863 * Defining Consume PropertyDecorator. 864 * 865 * @syscap SystemCapability.ArkUI.ArkUI.Full 866 * @since 7 867 */ 868/** 869 * Defining Consume PropertyDecorator. 870 * 871 * @syscap SystemCapability.ArkUI.ArkUI.Full 872 * @form 873 * @since 9 874 */ 875/** 876 * Defining Consume PropertyDecorator. 877 * 878 * @syscap SystemCapability.ArkUI.ArkUI.Full 879 * @crossplatform 880 * @form 881 * @since 10 882 */ 883/** 884 * Defining Consume PropertyDecorator. 885 * 886 * @syscap SystemCapability.ArkUI.ArkUI.Full 887 * @crossplatform 888 * @form 889 * @atomicservice 890 * @since 11 891 */ 892declare const Consume: PropertyDecorator & ((value: string) => PropertyDecorator); 893 894/** 895* Defining Consumer PropertyDecorator, aliasName is the only matching key and if aliasName is the default, the default attribute name is regarded as aliasName. 896* And @Consumer will find the nearest @Provider. 897* @syscap SystemCapability.ArkUI.ArkUI.Full 898* @crossplatform 899* @atomicservice 900* @since 12 901*/ 902declare const Consumer: (aliasName?: string) => PropertyDecorator; 903 904/** 905* Defining Computed MethodDecorator. 906* 907* @syscap SystemCapability.ArkUI.ArkUI.Full 908* @crossplatform 909* @atomicservice 910* @since 12 911*/ 912declare const Computed: MethodDecorator; 913 914/** 915 * Defining StorageProp PropertyDecorator. 916 * 917 * @syscap SystemCapability.ArkUI.ArkUI.Full 918 * @since 7 919 */ 920/** 921 * Defining StorageProp PropertyDecorator. 922 * 923 * @syscap SystemCapability.ArkUI.ArkUI.Full 924 * @crossplatform 925 * @since 10 926 */ 927/** 928 * Defining StorageProp PropertyDecorator. 929 * 930 * @syscap SystemCapability.ArkUI.ArkUI.Full 931 * @crossplatform 932 * @atomicservice 933 * @since 11 934 */ 935declare const StorageProp: (value: string) => PropertyDecorator; 936 937/** 938 * Defining StorageLink PropertyDecorator. 939 * 940 * @syscap SystemCapability.ArkUI.ArkUI.Full 941 * @since 7 942 */ 943/** 944 * Defining StorageLink PropertyDecorator. 945 * 946 * @syscap SystemCapability.ArkUI.ArkUI.Full 947 * @crossplatform 948 * @since 10 949 */ 950/** 951 * Defining StorageLink PropertyDecorator. 952 * 953 * @syscap SystemCapability.ArkUI.ArkUI.Full 954 * @crossplatform 955 * @atomicservice 956 * @since 11 957 */ 958declare const StorageLink: (value: string) => PropertyDecorator; 959 960/** 961 * Defining Watch PropertyDecorator. 962 * 963 * @syscap SystemCapability.ArkUI.ArkUI.Full 964 * @since 7 965 */ 966/** 967 * Defining Watch PropertyDecorator. 968 * 969 * @syscap SystemCapability.ArkUI.ArkUI.Full 970 * @form 971 * @since 9 972 */ 973/** 974 * Defining Watch PropertyDecorator. 975 * 976 * @syscap SystemCapability.ArkUI.ArkUI.Full 977 * @crossplatform 978 * @form 979 * @since 10 980 */ 981/** 982 * Defining Watch PropertyDecorator. 983 * 984 * @syscap SystemCapability.ArkUI.ArkUI.Full 985 * @crossplatform 986 * @form 987 * @atomicservice 988 * @since 11 989 */ 990declare const Watch: (value: string) => PropertyDecorator; 991 992/** 993 * Defining Builder MethodDecorator 994 * 995 * @syscap SystemCapability.ArkUI.ArkUI.Full 996 * @since 7 997 */ 998/** 999 * Defining Builder MethodDecorator 1000 * 1001 * @syscap SystemCapability.ArkUI.ArkUI.Full 1002 * @form 1003 * @since 9 1004 */ 1005/** 1006 * Defining Builder MethodDecorator 1007 * 1008 * @syscap SystemCapability.ArkUI.ArkUI.Full 1009 * @crossplatform 1010 * @form 1011 * @since 10 1012 */ 1013/** 1014 * Defining Builder MethodDecorator 1015 * 1016 * @syscap SystemCapability.ArkUI.ArkUI.Full 1017 * @crossplatform 1018 * @form 1019 * @atomicservice 1020 * @since 11 1021 */ 1022declare const Builder: MethodDecorator; 1023 1024/** 1025 * Defining LocalBuilder MethodDecorator 1026 * 1027 * @syscap SystemCapability.ArkUI.ArkUI.Full 1028 * @crossplatform 1029 * @form 1030 * @atomicservice 1031 * @since 12 1032 */ 1033declare const LocalBuilder: MethodDecorator; 1034 1035/** 1036 * Defining Styles MethodDecorator 1037 * 1038 * @syscap SystemCapability.ArkUI.ArkUI.Full 1039 * @since 8 1040 */ 1041/** 1042 * Defining Styles MethodDecorator 1043 * 1044 * @syscap SystemCapability.ArkUI.ArkUI.Full 1045 * @form 1046 * @since 9 1047 */ 1048/** 1049 * Defining Styles MethodDecorator 1050 * 1051 * @syscap SystemCapability.ArkUI.ArkUI.Full 1052 * @crossplatform 1053 * @form 1054 * @since 10 1055 */ 1056/** 1057 * Defining Styles MethodDecorator 1058 * 1059 * @syscap SystemCapability.ArkUI.ArkUI.Full 1060 * @crossplatform 1061 * @form 1062 * @atomicservice 1063 * @since 11 1064 */ 1065declare const Styles: MethodDecorator; 1066 1067/** 1068 * Defining Extend MethodDecorator 1069 * 1070 * @syscap SystemCapability.ArkUI.ArkUI.Full 1071 * @since 7 1072 */ 1073/** 1074 * Defining Extend MethodDecorator 1075 * 1076 * @syscap SystemCapability.ArkUI.ArkUI.Full 1077 * @form 1078 * @since 9 1079 */ 1080/** 1081 * Defining Extend MethodDecorator 1082 * 1083 * @syscap SystemCapability.ArkUI.ArkUI.Full 1084 * @crossplatform 1085 * @form 1086 * @since 10 1087 */ 1088/** 1089 * Defining Extend MethodDecorator 1090 * 1091 * @syscap SystemCapability.ArkUI.ArkUI.Full 1092 * @crossplatform 1093 * @form 1094 * @atomicservice 1095 * @since 11 1096 */ 1097declare const Extend: MethodDecorator & ((value: any) => MethodDecorator); 1098 1099/** 1100 * Define AnimatableExtend MethodDecorator 1101 * 1102 * @syscap SystemCapability.ArkUI.ArkUI.Full 1103 * @crossplatform 1104 * @since 10 1105 */ 1106/** 1107 * Define AnimatableExtend MethodDecorator 1108 * 1109 * @syscap SystemCapability.ArkUI.ArkUI.Full 1110 * @crossplatform 1111 * @atomicservice 1112 * @since 11 1113 */ 1114 declare const AnimatableExtend: MethodDecorator & ((value: Object) => MethodDecorator); 1115 1116/** 1117 * Define Monitor MethodDecorator 1118 * 1119 * @syscap SystemCapability.ArkUI.ArkUI.Full 1120 * @crossplatform 1121 * @atomicservice 1122 * @since 12 1123 */ 1124declare const Monitor: MonitorDecorator; 1125 1126/** 1127 * Define Monitor Decorator type 1128 * 1129 * @typedef { function } MonitorDecorator 1130 * @param { string } value - Monitored path input by the user 1131 * @param { string[] } args - Monitored path(s) input by the user 1132 * @returns { MethodDecorator } Monitor decorator 1133 * @syscap SystemCapability.ArkUI.ArkUI.Full 1134 * @crossplatform 1135 * @atomicservice 1136 * @since 12 1137 */ 1138declare type MonitorDecorator = (value: string, ...args: string[]) => MethodDecorator; 1139 1140/** 1141 * Define IMonitor interface 1142 * 1143 * @interface IMonitor 1144 * @syscap SystemCapability.ArkUI.ArkUI.Full 1145 * @crossplatform 1146 * @atomicservice 1147 * @since 12 1148 */ 1149declare interface IMonitor { 1150 /** 1151 * Array of changed paths(keys) 1152 * 1153 * @type { Array<string> } 1154 * @syscap SystemCapability.ArkUI.ArkUI.Full 1155 * @crossplatform 1156 * @atomicservice 1157 * @since 12 1158 */ 1159 dirty: Array<string>; 1160 1161 /** 1162 * Return the pair of the value before the most recent change and current value for given path. 1163 * If path does not exist, return undefined; If path is not specified, return the value pair corresponding to the first path in dirty. 1164 * 1165 * @param { string } [path] 1166 * @returns { IMonitorValue<T> | undefined } 1167 * @syscap SystemCapability.ArkUI.ArkUI.Full 1168 * @crossplatform 1169 * @atomicservice 1170 * @since 12 1171 */ 1172 value<T>(path?: string): IMonitorValue<T> | undefined; 1173} 1174 1175/** 1176 * Define IMonitorValue interface 1177 * 1178 * @interface IMonitorValue<T> 1179 * @syscap SystemCapability.ArkUI.ArkUI.Full 1180 * @crossplatform 1181 * @atomicservice 1182 * @since 12 1183 */ 1184declare interface IMonitorValue<T> { 1185 /** 1186 * Get the previous value. 1187 * 1188 * @type { T } 1189 * @syscap SystemCapability.ArkUI.ArkUI.Full 1190 * @crossplatform 1191 * @atomicservice 1192 * @since 12 1193 */ 1194 before: T; 1195 1196 /** 1197 * Get current value. 1198 * 1199 * @type { T } 1200 * @syscap SystemCapability.ArkUI.ArkUI.Full 1201 * @crossplatform 1202 * @atomicservice 1203 * @since 12 1204 */ 1205 now: T; 1206 1207 /** 1208 * Monitored path input by the user. 1209 * 1210 * @type { string } 1211 * @syscap SystemCapability.ArkUI.ArkUI.Full 1212 * @crossplatform 1213 * @atomicservice 1214 * @since 12 1215 */ 1216 path: string; 1217} 1218 1219/** 1220 * The **AnimatableArithmetic** API defines the animation operation rules for 1221 * non-number data types. To animate non-number data (such as arrays, structs, 1222 * and colors), implement the addition, subtraction, multiplication, and 1223 * equality judgment functions in the **AnimatableArithmetic\<T\>** API. 1224 * In this way, the data can be involved in an interpolation operation of the 1225 * animation and identify whether the data changes, that is, the non-number data 1226 * is defined as the types that implement the **AnimatableArithmetic\<T\>** API. 1227 * 1228 * @interface AnimatableArithmetic 1229 * @syscap SystemCapability.ArkUI.ArkUI.Full 1230 * @crossplatform 1231 * @since 10 1232 */ 1233/** 1234 * The **AnimatableArithmetic** API defines the animation operation rules for 1235 * non-number data types. To animate non-number data (such as arrays, structs, 1236 * and colors), implement the addition, subtraction, multiplication, and 1237 * equality judgment functions in the **AnimatableArithmetic\<T\>** API. 1238 * In this way, the data can be involved in an interpolation operation of the 1239 * animation and identify whether the data changes, that is, the non-number data 1240 * is defined as the types that implement the **AnimatableArithmetic\<T\>** API. 1241 * 1242 * @interface AnimatableArithmetic 1243 * @syscap SystemCapability.ArkUI.ArkUI.Full 1244 * @crossplatform 1245 * @atomicservice 1246 * @since arkts {'1.1':'11','1.2':'20'} 1247 * @arkts 1.1&1.2 1248 */ 1249 declare interface AnimatableArithmetic<T> { 1250 /** 1251 * Defines the addition rule of the data type. 1252 * 1253 * @param { AnimatableArithmetic<T> } rhs - another value 1254 * @returns { AnimatableArithmetic<T> } new value which implements AnimatableArithmetic<T> interface 1255 * @syscap SystemCapability.ArkUI.ArkUI.Full 1256 * @crossplatform 1257 * @since 10 1258 */ 1259 /** 1260 * Defines the addition rule of the data type. 1261 * 1262 * @param { AnimatableArithmetic<T> } rhs - another value 1263 * @returns { AnimatableArithmetic<T> } new value which implements AnimatableArithmetic<T> interface 1264 * @syscap SystemCapability.ArkUI.ArkUI.Full 1265 * @crossplatform 1266 * @atomicservice 1267 * @since arkts {'1.1':'11','1.2':'20'} 1268 * @arkts 1.1&1.2 1269 */ 1270 plus(rhs: AnimatableArithmetic<T>): AnimatableArithmetic<T>; 1271 1272 /** 1273 * Defines the subtraction rule of the data type. 1274 * 1275 * @param { AnimatableArithmetic<T> } rhs - another value 1276 * @returns { AnimatableArithmetic<T> } new value which implements AnimatableArithmetic<T> interface 1277 * @syscap SystemCapability.ArkUI.ArkUI.Full 1278 * @crossplatform 1279 * @since 10 1280 */ 1281 /** 1282 * Defines the subtraction rule of the data type. 1283 * 1284 * @param { AnimatableArithmetic<T> } rhs - another value 1285 * @returns { AnimatableArithmetic<T> } new value which implements AnimatableArithmetic<T> interface 1286 * @syscap SystemCapability.ArkUI.ArkUI.Full 1287 * @crossplatform 1288 * @atomicservice 1289 * @since arkts {'1.1':'11','1.2':'20'} 1290 * @arkts 1.1&1.2 1291 */ 1292 subtract(rhs: AnimatableArithmetic<T>): AnimatableArithmetic<T>; 1293 1294 /** 1295 * Defines the multiplication rule of the data type. 1296 * 1297 * @param { number } scale - scale value 1298 * @returns { AnimatableArithmetic<T> } new value which implements AnimatableArithmetic<T> interface 1299 * @syscap SystemCapability.ArkUI.ArkUI.Full 1300 * @crossplatform 1301 * @since 10 1302 */ 1303 /** 1304 * Defines the multiplication rule of the data type. 1305 * 1306 * @param { number } scale - scale value 1307 * @returns { AnimatableArithmetic<T> } new value which implements AnimatableArithmetic<T> interface 1308 * @syscap SystemCapability.ArkUI.ArkUI.Full 1309 * @crossplatform 1310 * @atomicservice 1311 * @since arkts {'1.1':'11','1.2':'20'} 1312 * @arkts 1.1&1.2 1313 */ 1314 multiply(scale: number): AnimatableArithmetic<T>; 1315 1316 /** 1317 * Defines the equality judgment rule of the data type. 1318 * 1319 * @param { AnimatableArithmetic<T> } rhs - another value 1320 * @returns { boolean } is equals 1321 * @syscap SystemCapability.ArkUI.ArkUI.Full 1322 * @crossplatform 1323 * @since 10 1324 */ 1325 /** 1326 * Defines the equality judgment rule of the data type. 1327 * 1328 * @param { AnimatableArithmetic<T> } rhs - another value 1329 * @returns { boolean } is equals 1330 * @syscap SystemCapability.ArkUI.ArkUI.Full 1331 * @crossplatform 1332 * @atomicservice 1333 * @since arkts {'1.1':'11','1.2':'20'} 1334 * @arkts 1.1&1.2 1335 */ 1336 equals(rhs: AnimatableArithmetic<T>): boolean; 1337} 1338 1339/** 1340 * Defining Concurrent MethodDecorator 1341 * 1342 * @syscap SystemCapability.ArkUI.ArkUI.Full 1343 * @since 9 1344 */ 1345/** 1346 * Defining Concurrent MethodDecorator 1347 * 1348 * @syscap SystemCapability.ArkUI.ArkUI.Full 1349 * @crossplatform 1350 * @since 10 1351 */ 1352/** 1353 * Defining Concurrent MethodDecorator 1354 * 1355 * @syscap SystemCapability.ArkUI.ArkUI.Full 1356 * @crossplatform 1357 * @atomicservice 1358 * @since 11 1359 */ 1360declare const Concurrent: MethodDecorator; 1361 1362/** 1363 * Defining Sendable ClassDecorator 1364 * The Sendable decorator can be used only for classes. A class with this decorator is marked as sendable, and the class object can be shared globally. 1365 * Since 12, the Sendable decorator can be used for function and typeAlias also. 1366 * A function with this decorator is marked as sendable, and the function can be an shareable property of sendable-class object. 1367 * A typeAlias with this decorator is marked as sendable, and the typeAlias can be used to declare properties, variables, 1368 * and arguments that need to be assigned with sendable-function. 1369 * 1370 * @syscap SystemCapability.ArkUI.ArkUI.Full 1371 * @crossplatform 1372 * @atomicservice 1373 * @since 11 1374 */ 1375declare const Sendable: ClassDecorator; 1376 1377/** 1378 * Defining CustomDialog ClassDecorator 1379 * 1380 * @syscap SystemCapability.ArkUI.ArkUI.Full 1381 * @since 7 1382 */ 1383/** 1384 * Defining CustomDialog ClassDecorator 1385 * 1386 * @syscap SystemCapability.ArkUI.ArkUI.Full 1387 * @crossplatform 1388 * @since 10 1389 */ 1390/** 1391 * Defining CustomDialog ClassDecorator 1392 * 1393 * @syscap SystemCapability.ArkUI.ArkUI.Full 1394 * @crossplatform 1395 * @atomicservice 1396 * @since 11 1397 */ 1398declare const CustomDialog: ClassDecorator; 1399 1400/** 1401 * Defining LocalStorageLink PropertyDecorator. 1402 * 1403 * @syscap SystemCapability.ArkUI.ArkUI.Full 1404 * @since 9 1405 */ 1406/** 1407 * Defining LocalStorageLink PropertyDecorator. 1408 * 1409 * @syscap SystemCapability.ArkUI.ArkUI.Full 1410 * @crossplatform 1411 * @since 10 1412 */ 1413/** 1414 * Defining LocalStorageLink PropertyDecorator. 1415 * 1416 * @syscap SystemCapability.ArkUI.ArkUI.Full 1417 * @crossplatform 1418 * @atomicservice 1419 * @since 11 1420 */ 1421declare const LocalStorageLink: (value: string) => PropertyDecorator; 1422 1423/** 1424 * Defining LocalStorageProp PropertyDecorator 1425 * 1426 * @syscap SystemCapability.ArkUI.ArkUI.Full 1427 * @form 1428 * @since 9 1429 */ 1430/** 1431 * Defining LocalStorageProp PropertyDecorator 1432 * 1433 * @syscap SystemCapability.ArkUI.ArkUI.Full 1434 * @crossplatform 1435 * @form 1436 * @since 10 1437 */ 1438/** 1439 * Defining LocalStorageProp PropertyDecorator 1440 * 1441 * @syscap SystemCapability.ArkUI.ArkUI.Full 1442 * @crossplatform 1443 * @form 1444 * @atomicservice 1445 * @since 11 1446 */ 1447declare const LocalStorageProp: (value: string) => PropertyDecorator; 1448 1449/** 1450 * Obtains the Context object associated with a component on the page. 1451 * 1452 * @param { Object } component - indicate the component on the page. 1453 * If no component is passed in or the passed-in parameter type is invalid, the default context is returned. 1454 * The default context is the context obtained by tracing the call chain of the API. 1455 * If this API is used in an asynchronous callback or not initially called on the current page, the context of the 1456 * instance may fail to be traced. In this case, undefined is returned. 1457 * @returns { Context } 1458 * The context type depends on the ability type. 1459 * For example, if this API is called on a page of the UIAbility, the return value type is UIAbilityContext; 1460 * if this API is called on a page of the ExtensionAbility, the return value type is ExtensionContext. 1461 * @syscap SystemCapability.ArkUI.ArkUI.Full 1462 * @StageModelOnly 1463 * @since 9 1464 */ 1465/** 1466 * Obtains the Context object associated with a component on the page. 1467 * 1468 * @param { Object } component - indicate the component on the page. 1469 * If no component is passed in or the passed-in parameter type is invalid, the default context is returned. 1470 * The default context is the context obtained by tracing the call chain of the API. 1471 * If this API is used in an asynchronous callback or not initially called on the current page, the context of the 1472 * instance may fail to be traced. In this case, undefined is returned. 1473 * @returns { Context } 1474 * The context type depends on the ability type. 1475 * For example, if this API is called on a page of the UIAbility, the return value type is UIAbilityContext; 1476 * if this API is called on a page of the ExtensionAbility, the return value type is ExtensionContext. 1477 * @syscap SystemCapability.ArkUI.ArkUI.Full 1478 * @StageModelOnly 1479 * @crossplatform 1480 * @since 10 1481 */ 1482/** 1483 * Obtains the Context object associated with a component on the page. 1484 * 1485 * @param { Object } component - indicate the component on the page. 1486 * If no component is passed in or the passed-in parameter type is invalid, the default context is returned. 1487 * The default context is the context obtained by tracing the call chain of the API. 1488 * If this API is used in an asynchronous callback or not initially called on the current page, the context of the 1489 * instance may fail to be traced. In this case, undefined is returned. 1490 * @returns { Context } 1491 * The context type depends on the ability type. 1492 * For example, if this API is called on a page of the UIAbility, the return value type is UIAbilityContext; 1493 * if this API is called on a page of the ExtensionAbility, the return value type is ExtensionContext. 1494 * @syscap SystemCapability.ArkUI.ArkUI.Full 1495 * @StageModelOnly 1496 * @crossplatform 1497 * @atomicservice 1498 * @since 11 1499 * @deprecated since 18 1500 * @useinstead ohos.arkui.UIContext.UIContext#getHostContext 1501 */ 1502declare function getContext(component?: Object): Context; 1503 1504/** 1505 * Defining Reusable ClassDecorator. 1506 * 1507 * @syscap SystemCapability.ArkUI.ArkUI.Full 1508 * @crossplatform 1509 * @since 10 1510 */ 1511/** 1512 * Defining Reusable ClassDecorator. 1513 * 1514 * @syscap SystemCapability.ArkUI.ArkUI.Full 1515 * @crossplatform 1516 * @atomicservice 1517 * @since 11 1518 */ 1519declare const Reusable: ClassDecorator; 1520 1521/** 1522 * Defining ReusableV2 ClassDecorator that is used to decorate @ComponentV2. 1523 * 1524 * @syscap SystemCapability.ArkUI.ArkUI.Full 1525 * @crossplatform 1526 * @atomicservice 1527 * @since 18 1528 */ 1529declare const ReusableV2: ClassDecorator; 1530 1531 /** 1532 * ReuseId callback type. It is used to compute reuseId. 1533 * 1534 * @typedef { function } ReuseIdCallback 1535 * @returns { string } 1536 * @syscap SystemCapability.ArkUI.ArkUI.Full 1537 * @crossplatform 1538 * @atomicservice 1539 * @since arkts {'1.1':'18','1.2':'20'} 1540 * @arkts 1.1&1.2 1541 */ 1542 declare type ReuseIdCallback = () => string; 1543 1544/** 1545 * Defining the reusable configuration parameters. 1546 * 1547 * @interface ReuseOptions 1548 * @syscap SystemCapability.ArkUI.ArkUI.Full 1549 * @crossplatform 1550 * @atomicservice 1551 * @since arkts {'1.1':'18','1.2':'20'} 1552 * @arkts 1.1&1.2 1553 */ 1554declare interface ReuseOptions { 1555 /** 1556 * Defining reuseId function. The default reuseId is the custom component name. 1557 * 1558 * @type { ?ReuseIdCallback } 1559 * @syscap SystemCapability.ArkUI.ArkUI.Full 1560 * @crossplatform 1561 * @atomicservice 1562 * @since arkts {'1.1':'18','1.2':'20'} 1563 * @arkts 1.1&1.2 1564 */ 1565 reuseId? : ReuseIdCallback; 1566} 1567/** 1568 * Get context. 1569 * 1570 * @typedef { import('../api/application/Context').default } Context 1571 * @syscap SystemCapability.ArkUI.ArkUI.Full 1572 * @StageModelOnly 1573 * @since 9 1574 */ 1575/** 1576 * Get context. 1577 * 1578 * @typedef { import('../api/application/Context').default } Context 1579 * @syscap SystemCapability.ArkUI.ArkUI.Full 1580 * @StageModelOnly 1581 * @crossplatform 1582 * @since 10 1583 */ 1584/** 1585 * Get context. 1586 * 1587 * @typedef { import('../api/application/Context').default } Context 1588 * @syscap SystemCapability.ArkUI.ArkUI.Full 1589 * @StageModelOnly 1590 * @crossplatform 1591 * @atomicservice 1592 * @since 11 1593 */ 1594declare type Context = import('../api/application/Context').default; 1595 1596/** 1597 * Export Context. 1598 * 1599 * @typedef { OriginalContext } Context 1600 * @syscap SystemCapability.ArkUI.ArkUI.Full 1601 * @stagemodelonly 1602 * @crossplatform 1603 * @atomicservice 1604 * @since 20 1605 * @arkts 1.2 1606 */ 1607export type Context = OriginalContext; 1608 1609/** 1610 * Post Card Action. 1611 * 1612 * @param { Object } component - indicate the card entry component. 1613 * @param { Object } action - indicate the router, message or call event. 1614 * @syscap SystemCapability.ArkUI.ArkUI.Full 1615 * @StageModelOnly 1616 * @form 1617 * @since 9 1618 */ 1619/** 1620 * Post Card Action. 1621 * 1622 * @param { Object } component - indicate the card entry component. 1623 * @param { Object } action - indicate the router, message or call event. 1624 * @syscap SystemCapability.ArkUI.ArkUI.Full 1625 * @StageModelOnly 1626 * @crossplatform 1627 * @form 1628 * @since 10 1629 */ 1630/** 1631 * Post Card Action. 1632 * 1633 * @param { Object } component - indicate the card entry component. 1634 * @param { Object } action - indicate the router, message or call event. 1635 * @syscap SystemCapability.ArkUI.ArkUI.Full 1636 * @StageModelOnly 1637 * @crossplatform 1638 * @form 1639 * @atomicservice 1640 * @since arkts {'1.1':'11','1.2':'20'} 1641 * @arkts 1.1&1.2 1642 */ 1643declare function postCardAction(component: Object, action: Object): void; 1644 1645/** 1646 * Defines the data type of the interface restriction. 1647 * 1648 * @interface Configuration 1649 * @syscap SystemCapability.ArkUI.ArkUI.Full 1650 * @since 7 1651 */ 1652/** 1653 * Defines the data type of the interface restriction. 1654 * 1655 * @interface Configuration 1656 * @syscap SystemCapability.ArkUI.ArkUI.Full 1657 * @form 1658 * @since 9 1659 */ 1660/** 1661 * Defines the data type of the interface restriction. 1662 * 1663 * @interface Configuration 1664 * @syscap SystemCapability.ArkUI.ArkUI.Full 1665 * @crossplatform 1666 * @form 1667 * @since 10 1668 */ 1669/** 1670 * Defines the data type of the interface restriction. 1671 * 1672 * @interface Configuration 1673 * @syscap SystemCapability.ArkUI.ArkUI.Full 1674 * @crossplatform 1675 * @form 1676 * @atomicservice 1677 * @since arkts {'1.1':'11','1.2':'20'} 1678 * @arkts 1.1&1.2 1679 */ 1680declare interface Configuration { 1681 /** 1682 * Set colorMode. 1683 * 1684 * @type { string } 1685 * @readonly 1686 * @syscap SystemCapability.ArkUI.ArkUI.Full 1687 * @since 7 1688 */ 1689 /** 1690 * Set colorMode. 1691 * 1692 * @type { string } 1693 * @readonly 1694 * @syscap SystemCapability.ArkUI.ArkUI.Full 1695 * @form 1696 * @since 9 1697 */ 1698 /** 1699 * Set colorMode. 1700 * 1701 * @type { string } 1702 * @readonly 1703 * @syscap SystemCapability.ArkUI.ArkUI.Full 1704 * @crossplatform 1705 * @form 1706 * @since 10 1707 */ 1708 /** 1709 * Set colorMode. 1710 * 1711 * @type { string } 1712 * @readonly 1713 * @syscap SystemCapability.ArkUI.ArkUI.Full 1714 * @crossplatform 1715 * @form 1716 * @atomicservice 1717 * @since arkts {'1.1':'11','1.2':'20'} 1718 * @arkts 1.1&1.2 1719 */ 1720 readonly colorMode: string; 1721 1722 /** 1723 * Set fontScale. 1724 * 1725 * @type { number } 1726 * @readonly 1727 * @syscap SystemCapability.ArkUI.ArkUI.Full 1728 * @since 7 1729 */ 1730 /** 1731 * Set fontScale. 1732 * 1733 * @type { number } 1734 * @readonly 1735 * @syscap SystemCapability.ArkUI.ArkUI.Full 1736 * @form 1737 * @since 9 1738 */ 1739 /** 1740 * Set fontScale. 1741 * 1742 * @type { number } 1743 * @readonly 1744 * @syscap SystemCapability.ArkUI.ArkUI.Full 1745 * @crossplatform 1746 * @form 1747 * @since 10 1748 */ 1749 /** 1750 * Set fontScale. 1751 * 1752 * @type { number } 1753 * @readonly 1754 * @syscap SystemCapability.ArkUI.ArkUI.Full 1755 * @crossplatform 1756 * @form 1757 * @atomicservice 1758 * @since arkts {'1.1':'11','1.2':'20'} 1759 * @arkts 1.1&1.2 1760 */ 1761 readonly fontScale: number; 1762} 1763 1764/** 1765 * Defines the data type of the interface restriction. 1766 * 1767 * @interface Rectangle 1768 * @syscap SystemCapability.ArkUI.ArkUI.Full 1769 * @since 8 1770 */ 1771/** 1772 * Defines the data type of the interface restriction. 1773 * 1774 * @interface Rectangle 1775 * @syscap SystemCapability.ArkUI.ArkUI.Full 1776 * @form 1777 * @since 9 1778 */ 1779/** 1780 * Defines the data type of the interface restriction. 1781 * 1782 * @interface Rectangle 1783 * @syscap SystemCapability.ArkUI.ArkUI.Full 1784 * @crossplatform 1785 * @form 1786 * @since 10 1787 */ 1788/** 1789 * Defines the data type of the interface restriction. 1790 * 1791 * @interface Rectangle 1792 * @syscap SystemCapability.ArkUI.ArkUI.Full 1793 * @crossplatform 1794 * @form 1795 * @atomicservice 1796 * @since arkts {'1.1':'11','1.2':'20'} 1797 * @arkts 1.1&1.2 1798 */ 1799declare interface Rectangle { 1800 /** 1801 * x:Horizontal coordinate 1802 * 1803 * @type { ?Length } 1804 * @syscap SystemCapability.ArkUI.ArkUI.Full 1805 * @since 8 1806 */ 1807 /** 1808 * x:Horizontal coordinate 1809 * 1810 * @type { ?Length } 1811 * @syscap SystemCapability.ArkUI.ArkUI.Full 1812 * @form 1813 * @since 9 1814 */ 1815 /** 1816 * x:Horizontal coordinate 1817 * 1818 * @type { ?Length } 1819 * @syscap SystemCapability.ArkUI.ArkUI.Full 1820 * @crossplatform 1821 * @form 1822 * @since 10 1823 */ 1824 /** 1825 * x:Horizontal coordinate 1826 * 1827 * @type { ?Length } 1828 * @syscap SystemCapability.ArkUI.ArkUI.Full 1829 * @crossplatform 1830 * @form 1831 * @atomicservice 1832 * @since arkts {'1.1':'11','1.2':'20'} 1833 * @arkts 1.1&1.2 1834 */ 1835 x?: Length; 1836 1837 /** 1838 * y:Vertical axis coordinate. 1839 * 1840 * @type { ?Length } 1841 * @syscap SystemCapability.ArkUI.ArkUI.Full 1842 * @since 8 1843 */ 1844 /** 1845 * y:Vertical axis coordinate. 1846 * 1847 * @type { ?Length } 1848 * @syscap SystemCapability.ArkUI.ArkUI.Full 1849 * @form 1850 * @since 9 1851 */ 1852 /** 1853 * y:Vertical axis coordinate. 1854 * 1855 * @type { ?Length } 1856 * @syscap SystemCapability.ArkUI.ArkUI.Full 1857 * @crossplatform 1858 * @form 1859 * @since 10 1860 */ 1861 /** 1862 * y:Vertical axis coordinate. 1863 * 1864 * @type { ?Length } 1865 * @syscap SystemCapability.ArkUI.ArkUI.Full 1866 * @crossplatform 1867 * @form 1868 * @atomicservice 1869 * @since arkts {'1.1':'11','1.2':'20'} 1870 * @arkts 1.1&1.2 1871 */ 1872 y?: Length; 1873 1874 /** 1875 * Sets the width of the current touchRect. 1876 * 1877 * @type { ?Length } 1878 * @syscap SystemCapability.ArkUI.ArkUI.Full 1879 * @since 8 1880 */ 1881 /** 1882 * Sets the width of the current touchRect. 1883 * 1884 * @type { ?Length } 1885 * @syscap SystemCapability.ArkUI.ArkUI.Full 1886 * @form 1887 * @since 9 1888 */ 1889 /** 1890 * Sets the width of the current touchRect. 1891 * 1892 * @type { ?Length } 1893 * @syscap SystemCapability.ArkUI.ArkUI.Full 1894 * @crossplatform 1895 * @form 1896 * @since 10 1897 */ 1898 /** 1899 * Sets the width of the current touchRect. 1900 * 1901 * @type { ?Length } 1902 * @syscap SystemCapability.ArkUI.ArkUI.Full 1903 * @crossplatform 1904 * @form 1905 * @atomicservice 1906 * @since arkts {'1.1':'11','1.2':'20'} 1907 * @arkts 1.1&1.2 1908 */ 1909 width?: Length; 1910 1911 /** 1912 * Sets the height of the current touchRect. 1913 * 1914 * @type { ?Length } 1915 * @syscap SystemCapability.ArkUI.ArkUI.Full 1916 * @since 8 1917 */ 1918 /** 1919 * Sets the height of the current touchRect. 1920 * 1921 * @type { ?Length } 1922 * @syscap SystemCapability.ArkUI.ArkUI.Full 1923 * @form 1924 * @since 9 1925 */ 1926 /** 1927 * Sets the height of the current touchRect. 1928 * 1929 * @type { ?Length } 1930 * @syscap SystemCapability.ArkUI.ArkUI.Full 1931 * @crossplatform 1932 * @form 1933 * @since 10 1934 */ 1935 /** 1936 * Sets the height of the current touchRect. 1937 * 1938 * @type { ?Length } 1939 * @syscap SystemCapability.ArkUI.ArkUI.Full 1940 * @crossplatform 1941 * @form 1942 * @atomicservice 1943 * @since arkts {'1.1':'11','1.2':'20'} 1944 * @arkts 1.1&1.2 1945 */ 1946 height?: Length; 1947} 1948 1949/** 1950 * Interface for ExpectedFrameRateRange. 1951 * 1952 * @interface ExpectedFrameRateRange 1953 * @syscap SystemCapability.ArkUI.ArkUI.Full 1954 * @since 11 1955 */ 1956/** 1957 * Interface for ExpectedFrameRateRange. 1958 * 1959 * @interface ExpectedFrameRateRange 1960 * @syscap SystemCapability.ArkUI.ArkUI.Full 1961 * @atomicservice 1962 * @since 12 1963 */ 1964/** 1965 * Interface for ExpectedFrameRateRange. 1966 * 1967 * @interface ExpectedFrameRateRange 1968 * @syscap SystemCapability.ArkUI.ArkUI.Full 1969 * @crossplatform 1970 * @atomicservice 1971 * @since arkts {'1.1':'19','1.2':'20'} 1972 * @arkts 1.1&1.2 1973 */ 1974declare interface ExpectedFrameRateRange { 1975 /** 1976 * The minimum animation drawing FPS. 1977 * The minimum value should be less than or equal to the maximum value. 1978 * @type { number } 1979 * @syscap SystemCapability.ArkUI.ArkUI.Full 1980 * @since 11 1981 */ 1982 /** 1983 * The minimum animation drawing FPS. 1984 * The minimum value should be less than or equal to the maximum value. 1985 * @type { number } 1986 * @syscap SystemCapability.ArkUI.ArkUI.Full 1987 * @atomicservice 1988 * @since 12 1989 */ 1990 /** 1991 * The minimum animation drawing FPS. 1992 * The minimum value should be less than or equal to the maximum value. 1993 * @type { number } 1994 * @syscap SystemCapability.ArkUI.ArkUI.Full 1995 * @crossplatform 1996 * @atomicservice 1997 * @since arkts {'1.1':'19','1.2':'20'} 1998 * @arkts 1.1&1.2 1999 */ 2000 min: number, 2001 /** 2002 * The maximum animation drawing FPS. 2003 * The maximum value should be greater than or equal to the minimum value. 2004 * @type { number } 2005 * @syscap SystemCapability.ArkUI.ArkUI.Full 2006 * @since 11 2007 */ 2008 /** 2009 * The maximum animation drawing FPS. 2010 * The maximum value should be greater than or equal to the minimum value. 2011 * @type { number } 2012 * @syscap SystemCapability.ArkUI.ArkUI.Full 2013 * @atomicservice 2014 * @since 12 2015 */ 2016 /** 2017 * The maximum animation drawing FPS. 2018 * The maximum value should be greater than or equal to the minimum value. 2019 * @type { number } 2020 * @syscap SystemCapability.ArkUI.ArkUI.Full 2021 * @crossplatform 2022 * @atomicservice 2023 * @since arkts {'1.1':'19','1.2':'20'} 2024 * @arkts 1.1&1.2 2025 */ 2026 max: number, 2027 /** 2028 * The expected frame rate of dynamical callback rate range. 2029 * The value should be between the minimum and maximum value. 2030 * Otherwise, the actual callback rate will be dynamically 2031 * adjusted to better align with other animation sources. 2032 * @type { number } 2033 * @syscap SystemCapability.ArkUI.ArkUI.Full 2034 * @since 11 2035 */ 2036 /** 2037 * The expected frame rate of dynamical callback rate range. 2038 * The value should be between the minimum and maximum value. 2039 * Otherwise, the actual callback rate will be dynamically 2040 * adjusted to better align with other animation sources. 2041 * @type { number } 2042 * @syscap SystemCapability.ArkUI.ArkUI.Full 2043 * @atomicservice 2044 * @since 12 2045 */ 2046 /** 2047 * The expected frame rate of dynamical callback rate range. 2048 * The value should be between the minimum and maximum value. 2049 * Otherwise, the actual callback rate will be dynamically 2050 * adjusted to better align with other animation sources. 2051 * @type { number } 2052 * @syscap SystemCapability.ArkUI.ArkUI.Full 2053 * @crossplatform 2054 * @atomicservice 2055 * @since arkts {'1.1':'19','1.2':'20'} 2056 * @arkts 1.1&1.2 2057 */ 2058 expected: number, 2059} 2060 2061/** 2062 * global $r function 2063 * 2064 * @param { string } value 2065 * The value format is 'belonging.type.name'. 2066 * belonging: group to which the resource belongs, which can be 'sys' or 'app'. 2067 * type: resource type, which can be 'boolean', 'color', 'float', 'intarray', 'integer', 'pattern', 'plural', 2068 * 'strarray', 'string', or 'media'. 2069 * name: resource name, which is determined during resource definition. 2070 * @param { any[] } params 2071 * @returns { Resource } 2072 * @syscap SystemCapability.ArkUI.ArkUI.Full 2073 * @since 7 2074 */ 2075/** 2076 * global $r function 2077 * 2078 * @param { string } value 2079 * The value format is 'belonging.type.name'. 2080 * belonging: group to which the resource belongs, which can be 'sys' or 'app'. 2081 * type: resource type, which can be 'boolean', 'color', 'float', 'intarray', 'integer', 'pattern', 'plural', 2082 * 'strarray', 'string', or 'media'. 2083 * name: resource name, which is determined during resource definition. 2084 * @param { any[] } params 2085 * @returns { Resource } 2086 * @syscap SystemCapability.ArkUI.ArkUI.Full 2087 * @form 2088 * @since 9 2089 */ 2090/** 2091 * global $r function 2092 * 2093 * @param { string } value 2094 * The value format is 'belonging.type.name'. 2095 * belonging: group to which the resource belongs, which can be 'sys' or 'app'. 2096 * type: resource type, which can be 'boolean', 'color', 'float', 'intarray', 'integer', 'pattern', 'plural', 2097 * 'strarray', 'string', or 'media'. 2098 * name: resource name, which is determined during resource definition. 2099 * @param { any[] } params 2100 * @returns { Resource } 2101 * @syscap SystemCapability.ArkUI.ArkUI.Full 2102 * @crossplatform 2103 * @form 2104 * @since 10 2105 */ 2106/** 2107 * global $r function 2108 * 2109 * @param { string } value 2110 * The value format is 'belonging.type.name'. 2111 * belonging: group to which the resource belongs, which can be 'sys' or 'app'. 2112 * type: resource type, which can be 'boolean', 'color', 'float', 'intarray', 'integer', 'pattern', 'plural', 2113 * 'strarray', 'string', or 'media'. 2114 * name: resource name, which is determined during resource definition. 2115 * @param { any[] } params 2116 * @returns { Resource } 2117 * @syscap SystemCapability.ArkUI.ArkUI.Full 2118 * @crossplatform 2119 * @form 2120 * @atomicservice 2121 * @since 11 2122 */ 2123declare function $r(value: string, ...params: any[]): Resource; 2124 2125/** 2126 * global $r function 2127 * 2128 * @param { string } value 2129 * @param { (Object | null | undefined)[] } params 2130 * @returns { Resource } 2131 * @syscap SystemCapability.ArkUI.ArkUI.Full 2132 * @crossplatform 2133 * @form 2134 * @atomicservice 2135 * @since 20 2136 * @arkts 1.2 2137 */ 2138declare function $r(value: string, ...params: (Object | null | undefined)[]): Resource; 2139 2140/** 2141 * global $rawfile function 2142 * 2143 * @param { string } value 2144 * name of the file in the resources/rawfile directory of the project. 2145 * When referencing resources of the Resource type, make sure the data type is the same as that of the attribute method. 2146 * For example, if an attribute method supports the string | Resource types, the data type of the Resource type must be 2147 * string. 2148 * @returns { Resource } 2149 * @syscap SystemCapability.ArkUI.ArkUI.Full 2150 * @since 7 2151 */ 2152/** 2153 * global $rawfile function 2154 * 2155 * @param { string } value 2156 * name of the file in the resources/rawfile directory of the project. 2157 * When referencing resources of the Resource type, make sure the data type is the same as that of the attribute method. 2158 * For example, if an attribute method supports the string | Resource types, the data type of the Resource type must be 2159 * string. 2160 * @returns { Resource } 2161 * @syscap SystemCapability.ArkUI.ArkUI.Full 2162 * @form 2163 * @since 9 2164 */ 2165/** 2166 * global $rawfile function 2167 * 2168 * @param { string } value 2169 * name of the file in the resources/rawfile directory of the project. 2170 * When referencing resources of the Resource type, make sure the data type is the same as that of the attribute method. 2171 * For example, if an attribute method supports the string | Resource types, the data type of the Resource type must be 2172 * string. 2173 * @returns { Resource } 2174 * @syscap SystemCapability.ArkUI.ArkUI.Full 2175 * @crossplatform 2176 * @form 2177 * @since 10 2178 */ 2179/** 2180 * global $rawfile function 2181 * 2182 * @param { string } value 2183 * name of the file in the resources/rawfile directory of the project. 2184 * When referencing resources of the Resource type, make sure the data type is the same as that of the attribute method. 2185 * For example, if an attribute method supports the string | Resource types, the data type of the Resource type must be 2186 * string. 2187 * @returns { Resource } 2188 * @syscap SystemCapability.ArkUI.ArkUI.Full 2189 * @crossplatform 2190 * @form 2191 * @atomicservice 2192 * @since arkts {'1.1':'11','1.2':'20'} 2193 * @arkts 1.1&1.2 2194 */ 2195declare function $rawfile(value: string): Resource; 2196/** 2197 * Defines the same page mode 2198 * @enum { number } 2199 * @syscap SystemCapability.ArkUI.ArkUI.Full 2200 * @crossplatform 2201 * @form 2202 * @atomicservice 2203 * @since arkts {'1.1':'18','1.2':'20'} 2204 * @arkts 1.1&1.2 2205 */ 2206declare enum AccessibilitySamePageMode { 2207 /** 2208 * the first page and root page event is not send.but if application load new page whith navigation,the page event will be sent. 2209 * this mode is to solve skipping focus 2210 * @syscap SystemCapability.ArkUI.ArkUI.Full 2211 * @crossplatform 2212 * @form 2213 * @atomicservice 2214 * @since arkts {'1.1':'18','1.2':'20'} 2215 * @arkts 1.1&1.2 2216 */ 2217 SEMI_SILENT = 0, 2218 /** 2219 * the all page event is not send 2220 * @syscap SystemCapability.ArkUI.ArkUI.Full 2221 * @crossplatform 2222 * @form 2223 * @atomicservice 2224 * @since arkts {'1.1':'18','1.2':'20'} 2225 * @arkts 1.1&1.2 2226 */ 2227 FULL_SILENT = 1, 2228} 2229/** 2230 * Enum for accessibility component type 2231 * @enum { number } 2232 * @syscap SystemCapability.ArkUI.ArkUI.Full 2233 * @crossplatform 2234 * @form 2235 * @atomicservice 2236 * @since arkts {'1.1':'18','1.2':'20'} 2237 * @arkts 1.1&1.2 2238 */ 2239declare enum AccessibilityRoleType { 2240 /** 2241 * ActionSheet component type 2242 * @syscap SystemCapability.ArkUI.ArkUI.Full 2243 * @crossplatform 2244 * @form 2245 * @atomicservice 2246 * @since arkts {'1.1':'18','1.2':'20'} 2247 * @arkts 1.1&1.2 2248 */ 2249 ACTION_SHEET = 0, 2250 /** 2251 * AlertDialog component type 2252 * @syscap SystemCapability.ArkUI.ArkUI.Full 2253 * @crossplatform 2254 * @form 2255 * @atomicservice 2256 * @since arkts {'1.1':'18','1.2':'20'} 2257 * @arkts 1.1&1.2 2258 */ 2259 ALERT_DIALOG = 1, 2260 /** 2261 * AlphabetIndexer component type 2262 * @syscap SystemCapability.ArkUI.ArkUI.Full 2263 * @crossplatform 2264 * @form 2265 * @atomicservice 2266 * @since arkts {'1.1':'18','1.2':'20'} 2267 * @arkts 1.1&1.2 2268 */ 2269 INDEXER_COMPONENT = 2, 2270 /** 2271 * badge component type 2272 * @syscap SystemCapability.ArkUI.ArkUI.Full 2273 * @crossplatform 2274 * @form 2275 * @atomicservice 2276 * @since arkts {'1.1':'18','1.2':'20'} 2277 * @arkts 1.1&1.2 2278 */ 2279 BADGE_COMPONENT = 3, 2280 /** 2281 * blank component type 2282 * @syscap SystemCapability.ArkUI.ArkUI.Full 2283 * @crossplatform 2284 * @form 2285 * @atomicservice 2286 * @since arkts {'1.1':'18','1.2':'20'} 2287 * @arkts 1.1&1.2 2288 */ 2289 BLANK = 4, 2290 /** 2291 * button component type 2292 * @syscap SystemCapability.ArkUI.ArkUI.Full 2293 * @crossplatform 2294 * @form 2295 * @atomicservice 2296 * @since arkts {'1.1':'18','1.2':'20'} 2297 * @arkts 1.1&1.2 2298 */ 2299 BUTTON = 5, 2300 /** 2301 * button component type 2302 * @syscap SystemCapability.ArkUI.ArkUI.Full 2303 * @crossplatform 2304 * @form 2305 * @atomicservice 2306 * @since arkts {'1.1':'18','1.2':'20'} 2307 * @arkts 1.1&1.2 2308 */ 2309 BACK_BUTTON = 6, 2310 /** 2311 * sheet drag bar component type 2312 * @syscap SystemCapability.ArkUI.ArkUI.Full 2313 * @crossplatform 2314 * @form 2315 * @atomicservice 2316 * @since arkts {'1.1':'18','1.2':'20'} 2317 * @arkts 1.1&1.2 2318 */ 2319 SHEET_DRAG_BAR = 7, 2320 /** 2321 * calendar picker component type 2322 * @syscap SystemCapability.ArkUI.ArkUI.Full 2323 * @crossplatform 2324 * @form 2325 * @atomicservice 2326 * @since arkts {'1.1':'18','1.2':'20'} 2327 * @arkts 1.1&1.2 2328 */ 2329 CALENDAR_PICKER = 8, 2330 /** 2331 * calendar component type 2332 * @syscap SystemCapability.ArkUI.ArkUI.Full 2333 * @crossplatform 2334 * @form 2335 * @atomicservice 2336 * @since arkts {'1.1':'18','1.2':'20'} 2337 * @arkts 1.1&1.2 2338 */ 2339 CALENDAR = 9, 2340 /** 2341 * canvas component type 2342 * @syscap SystemCapability.ArkUI.ArkUI.Full 2343 * @crossplatform 2344 * @form 2345 * @atomicservice 2346 * @since arkts {'1.1':'18','1.2':'20'} 2347 * @arkts 1.1&1.2 2348 */ 2349 CANVAS = 10, 2350 /** 2351 * canvas gradient component type 2352 * @syscap SystemCapability.ArkUI.ArkUI.Full 2353 * @crossplatform 2354 * @form 2355 * @atomicservice 2356 * @since arkts {'1.1':'18','1.2':'20'} 2357 * @arkts 1.1&1.2 2358 */ 2359 CANVAS_GRADIENT = 11, 2360 /** 2361 * canvas pattern component type 2362 * @syscap SystemCapability.ArkUI.ArkUI.Full 2363 * @crossplatform 2364 * @form 2365 * @atomicservice 2366 * @since arkts {'1.1':'18','1.2':'20'} 2367 * @arkts 1.1&1.2 2368 */ 2369 CANVAS_PATTERN = 12, 2370 /** 2371 * checkbox component type 2372 * @syscap SystemCapability.ArkUI.ArkUI.Full 2373 * @crossplatform 2374 * @form 2375 * @atomicservice 2376 * @since arkts {'1.1':'18','1.2':'20'} 2377 * @arkts 1.1&1.2 2378 */ 2379 CHECKBOX = 13, 2380 /** 2381 * checkbox group component type 2382 * @syscap SystemCapability.ArkUI.ArkUI.Full 2383 * @crossplatform 2384 * @form 2385 * @atomicservice 2386 * @since arkts {'1.1':'18','1.2':'20'} 2387 * @arkts 1.1&1.2 2388 */ 2389 CHECKBOX_GROUP = 14, 2390 /** 2391 * circle component type 2392 * @syscap SystemCapability.ArkUI.ArkUI.Full 2393 * @crossplatform 2394 * @form 2395 * @atomicservice 2396 * @since arkts {'1.1':'18','1.2':'20'} 2397 * @arkts 1.1&1.2 2398 */ 2399 CIRCLE = 15, 2400 /** 2401 * column split component type 2402 * @syscap SystemCapability.ArkUI.ArkUI.Full 2403 * @crossplatform 2404 * @form 2405 * @atomicservice 2406 * @since arkts {'1.1':'18','1.2':'20'} 2407 * @arkts 1.1&1.2 2408 */ 2409 COLUMN_SPLIT = 16, 2410 /** 2411 * column component type 2412 * @syscap SystemCapability.ArkUI.ArkUI.Full 2413 * @crossplatform 2414 * @form 2415 * @atomicservice 2416 * @since arkts {'1.1':'18','1.2':'20'} 2417 * @arkts 1.1&1.2 2418 */ 2419 COLUMN = 17, 2420 /** 2421 * canvas rendering context 2d component type 2422 * @syscap SystemCapability.ArkUI.ArkUI.Full 2423 * @crossplatform 2424 * @form 2425 * @atomicservice 2426 * @since arkts {'1.1':'18','1.2':'20'} 2427 * @arkts 1.1&1.2 2428 */ 2429 CANVAS_RENDERING_CONTEXT_2D = 18, 2430 /** 2431 * chart component type 2432 * @syscap SystemCapability.ArkUI.ArkUI.Full 2433 * @crossplatform 2434 * @form 2435 * @atomicservice 2436 * @since arkts {'1.1':'18','1.2':'20'} 2437 * @arkts 1.1&1.2 2438 */ 2439 CHART = 19, 2440 /** 2441 * counter component type 2442 * @syscap SystemCapability.ArkUI.ArkUI.Full 2443 * @crossplatform 2444 * @form 2445 * @atomicservice 2446 * @since arkts {'1.1':'18','1.2':'20'} 2447 * @arkts 1.1&1.2 2448 */ 2449 COUNTER = 20, 2450 /** 2451 * counter modal component type 2452 * @syscap SystemCapability.ArkUI.ArkUI.Full 2453 * @crossplatform 2454 * @form 2455 * @atomicservice 2456 * @since arkts {'1.1':'18','1.2':'20'} 2457 * @arkts 1.1&1.2 2458 */ 2459 CONTAINER_MODAL = 21, 2460 /** 2461 * data panel component type 2462 * @syscap SystemCapability.ArkUI.ArkUI.Full 2463 * @crossplatform 2464 * @form 2465 * @atomicservice 2466 * @since arkts {'1.1':'18','1.2':'20'} 2467 * @arkts 1.1&1.2 2468 */ 2469 DATA_PANEL = 22, 2470 /** 2471 * data picker component type 2472 * @syscap SystemCapability.ArkUI.ArkUI.Full 2473 * @crossplatform 2474 * @form 2475 * @atomicservice 2476 * @since arkts {'1.1':'18','1.2':'20'} 2477 * @arkts 1.1&1.2 2478 */ 2479 DATE_PICKER = 23, 2480 /** 2481 * dialog component type 2482 * @syscap SystemCapability.ArkUI.ArkUI.Full 2483 * @crossplatform 2484 * @form 2485 * @atomicservice 2486 * @since arkts {'1.1':'18','1.2':'20'} 2487 * @arkts 1.1&1.2 2488 */ 2489 DIALOG = 24, 2490 /** 2491 * divider component type 2492 * @syscap SystemCapability.ArkUI.ArkUI.Full 2493 * @crossplatform 2494 * @form 2495 * @atomicservice 2496 * @since arkts {'1.1':'18','1.2':'20'} 2497 * @arkts 1.1&1.2 2498 */ 2499 DIVIDER = 25, 2500 /** 2501 * drag bar component type 2502 * @syscap SystemCapability.ArkUI.ArkUI.Full 2503 * @crossplatform 2504 * @form 2505 * @atomicservice 2506 * @since arkts {'1.1':'18','1.2':'20'} 2507 * @arkts 1.1&1.2 2508 */ 2509 DRAG_BAR = 26, 2510 /** 2511 * effect component type 2512 * @syscap SystemCapability.ArkUI.ArkUI.Full 2513 * @crossplatform 2514 * @form 2515 * @atomicservice 2516 * @since arkts {'1.1':'18','1.2':'20'} 2517 * @arkts 1.1&1.2 2518 */ 2519 EFFECT_COMPONENT = 27, 2520 /** 2521 * ellipse component type 2522 * @syscap SystemCapability.ArkUI.ArkUI.Full 2523 * @crossplatform 2524 * @form 2525 * @atomicservice 2526 * @since arkts {'1.1':'18','1.2':'20'} 2527 * @arkts 1.1&1.2 2528 */ 2529 ELLIPSE = 28, 2530 /** 2531 * flex component type 2532 * @syscap SystemCapability.ArkUI.ArkUI.Full 2533 * @crossplatform 2534 * @form 2535 * @atomicservice 2536 * @since arkts {'1.1':'18','1.2':'20'} 2537 * @arkts 1.1&1.2 2538 */ 2539 FLEX = 29, 2540 /** 2541 * flow item component type 2542 * @syscap SystemCapability.ArkUI.ArkUI.Full 2543 * @crossplatform 2544 * @form 2545 * @atomicservice 2546 * @since arkts {'1.1':'18','1.2':'20'} 2547 * @arkts 1.1&1.2 2548 */ 2549 FLOW_ITEM = 30, 2550 /** 2551 * form component type 2552 * @syscap SystemCapability.ArkUI.ArkUI.Full 2553 * @crossplatform 2554 * @form 2555 * @atomicservice 2556 * @since arkts {'1.1':'18','1.2':'20'} 2557 * @arkts 1.1&1.2 2558 */ 2559 FORM_COMPONENT = 31, 2560 /** 2561 * form link component type 2562 * @syscap SystemCapability.ArkUI.ArkUI.Full 2563 * @crossplatform 2564 * @form 2565 * @atomicservice 2566 * @since arkts {'1.1':'18','1.2':'20'} 2567 * @arkts 1.1&1.2 2568 */ 2569 FORM_LINK = 32, 2570 /** 2571 * gauge component type 2572 * @syscap SystemCapability.ArkUI.ArkUI.Full 2573 * @crossplatform 2574 * @form 2575 * @atomicservice 2576 * @since arkts {'1.1':'18','1.2':'20'} 2577 * @arkts 1.1&1.2 2578 */ 2579 GAUGE = 33, 2580 /** 2581 * grid component type 2582 * @syscap SystemCapability.ArkUI.ArkUI.Full 2583 * @crossplatform 2584 * @form 2585 * @atomicservice 2586 * @since arkts {'1.1':'18','1.2':'20'} 2587 * @arkts 1.1&1.2 2588 */ 2589 GRID = 34, 2590 /** 2591 * grid col component type 2592 * @syscap SystemCapability.ArkUI.ArkUI.Full 2593 * @crossplatform 2594 * @form 2595 * @atomicservice 2596 * @since arkts {'1.1':'18','1.2':'20'} 2597 * @arkts 1.1&1.2 2598 */ 2599 GRID_COL = 35, 2600 /** 2601 * grid container component type 2602 * @syscap SystemCapability.ArkUI.ArkUI.Full 2603 * @crossplatform 2604 * @form 2605 * @atomicservice 2606 * @since arkts {'1.1':'18','1.2':'20'} 2607 * @arkts 1.1&1.2 2608 */ 2609 GRID_CONTAINER = 36, 2610 /** 2611 * grid item component type 2612 * @syscap SystemCapability.ArkUI.ArkUI.Full 2613 * @crossplatform 2614 * @form 2615 * @atomicservice 2616 * @since arkts {'1.1':'18','1.2':'20'} 2617 * @arkts 1.1&1.2 2618 */ 2619 GRID_ITEM = 37, 2620 /** 2621 * grid row component type 2622 * @syscap SystemCapability.ArkUI.ArkUI.Full 2623 * @crossplatform 2624 * @form 2625 * @atomicservice 2626 * @since arkts {'1.1':'18','1.2':'20'} 2627 * @arkts 1.1&1.2 2628 */ 2629 GRID_ROW = 38, 2630 /** 2631 * hyperlink component type 2632 * @syscap SystemCapability.ArkUI.ArkUI.Full 2633 * @crossplatform 2634 * @form 2635 * @atomicservice 2636 * @since arkts {'1.1':'18','1.2':'20'} 2637 * @arkts 1.1&1.2 2638 */ 2639 HYPERLINK = 39, 2640 /** 2641 * image component type 2642 * @syscap SystemCapability.ArkUI.ArkUI.Full 2643 * @crossplatform 2644 * @form 2645 * @atomicservice 2646 * @since arkts {'1.1':'18','1.2':'20'} 2647 * @arkts 1.1&1.2 2648 */ 2649 IMAGE = 40, 2650 /** 2651 * image animator component type 2652 * @syscap SystemCapability.ArkUI.ArkUI.Full 2653 * @crossplatform 2654 * @form 2655 * @atomicservice 2656 * @since arkts {'1.1':'18','1.2':'20'} 2657 * @arkts 1.1&1.2 2658 */ 2659 IMAGE_ANIMATOR = 41, 2660 /** 2661 * image bitmap component type 2662 * @syscap SystemCapability.ArkUI.ArkUI.Full 2663 * @crossplatform 2664 * @form 2665 * @atomicservice 2666 * @since arkts {'1.1':'18','1.2':'20'} 2667 * @arkts 1.1&1.2 2668 */ 2669 IMAGE_BITMAP = 42, 2670 /** 2671 * image data component type 2672 * @syscap SystemCapability.ArkUI.ArkUI.Full 2673 * @crossplatform 2674 * @form 2675 * @atomicservice 2676 * @since arkts {'1.1':'18','1.2':'20'} 2677 * @arkts 1.1&1.2 2678 */ 2679 IMAGE_DATA = 43, 2680 /** 2681 * image span component type 2682 * @syscap SystemCapability.ArkUI.ArkUI.Full 2683 * @crossplatform 2684 * @form 2685 * @atomicservice 2686 * @since arkts {'1.1':'18','1.2':'20'} 2687 * @arkts 1.1&1.2 2688 */ 2689 IMAGE_SPAN = 44, 2690 /** 2691 * label component type 2692 * @syscap SystemCapability.ArkUI.ArkUI.Full 2693 * @crossplatform 2694 * @form 2695 * @atomicservice 2696 * @since arkts {'1.1':'18','1.2':'20'} 2697 * @arkts 1.1&1.2 2698 */ 2699 LABEL = 45, 2700 /** 2701 * line component type 2702 * @syscap SystemCapability.ArkUI.ArkUI.Full 2703 * @crossplatform 2704 * @form 2705 * @atomicservice 2706 * @since arkts {'1.1':'18','1.2':'20'} 2707 * @arkts 1.1&1.2 2708 */ 2709 LINE = 46, 2710 /** 2711 * list component type 2712 * @syscap SystemCapability.ArkUI.ArkUI.Full 2713 * @crossplatform 2714 * @form 2715 * @atomicservice 2716 * @since arkts {'1.1':'18','1.2':'20'} 2717 * @arkts 1.1&1.2 2718 */ 2719 LIST = 47, 2720 /** 2721 * list item component type 2722 * @syscap SystemCapability.ArkUI.ArkUI.Full 2723 * @crossplatform 2724 * @form 2725 * @atomicservice 2726 * @since arkts {'1.1':'18','1.2':'20'} 2727 * @arkts 1.1&1.2 2728 */ 2729 LIST_ITEM = 48, 2730 /** 2731 * list item group component type 2732 * @syscap SystemCapability.ArkUI.ArkUI.Full 2733 * @crossplatform 2734 * @form 2735 * @atomicservice 2736 * @since arkts {'1.1':'18','1.2':'20'} 2737 * @arkts 1.1&1.2 2738 */ 2739 LIST_ITEM_GROUP = 49, 2740 /** 2741 * loading progress component type 2742 * @syscap SystemCapability.ArkUI.ArkUI.Full 2743 * @crossplatform 2744 * @form 2745 * @atomicservice 2746 * @since arkts {'1.1':'18','1.2':'20'} 2747 * @arkts 1.1&1.2 2748 */ 2749 LOADING_PROGRESS = 50, 2750 /** 2751 * marquee component type 2752 * @syscap SystemCapability.ArkUI.ArkUI.Full 2753 * @crossplatform 2754 * @form 2755 * @atomicservice 2756 * @since arkts {'1.1':'18','1.2':'20'} 2757 * @arkts 1.1&1.2 2758 */ 2759 MARQUEE = 51, 2760 /** 2761 * matrix2d component type 2762 * @syscap SystemCapability.ArkUI.ArkUI.Full 2763 * @crossplatform 2764 * @form 2765 * @atomicservice 2766 * @since arkts {'1.1':'18','1.2':'20'} 2767 * @arkts 1.1&1.2 2768 */ 2769 MATRIX2D = 52, 2770 /** 2771 * menu component type 2772 * @syscap SystemCapability.ArkUI.ArkUI.Full 2773 * @crossplatform 2774 * @form 2775 * @atomicservice 2776 * @since arkts {'1.1':'18','1.2':'20'} 2777 * @arkts 1.1&1.2 2778 */ 2779 MENU = 53, 2780 /** 2781 * menu item component type 2782 * @syscap SystemCapability.ArkUI.ArkUI.Full 2783 * @crossplatform 2784 * @form 2785 * @atomicservice 2786 * @since arkts {'1.1':'18','1.2':'20'} 2787 * @arkts 1.1&1.2 2788 */ 2789 MENU_ITEM = 54, 2790 /** 2791 * menu item group component type 2792 * @syscap SystemCapability.ArkUI.ArkUI.Full 2793 * @crossplatform 2794 * @form 2795 * @atomicservice 2796 * @since arkts {'1.1':'18','1.2':'20'} 2797 * @arkts 1.1&1.2 2798 */ 2799 MENU_ITEM_GROUP = 55, 2800 /** 2801 * navdestination component type 2802 * @syscap SystemCapability.ArkUI.ArkUI.Full 2803 * @crossplatform 2804 * @form 2805 * @atomicservice 2806 * @since arkts {'1.1':'18','1.2':'20'} 2807 * @arkts 1.1&1.2 2808 */ 2809 NAV_DESTINATION = 56, 2810 /** 2811 * navrouter component type 2812 * @syscap SystemCapability.ArkUI.ArkUI.Full 2813 * @crossplatform 2814 * @form 2815 * @atomicservice 2816 * @since arkts {'1.1':'18','1.2':'20'} 2817 * @arkts 1.1&1.2 2818 */ 2819 NAV_ROUTER = 57, 2820 /** 2821 * navigation component type 2822 * @syscap SystemCapability.ArkUI.ArkUI.Full 2823 * @crossplatform 2824 * @form 2825 * @atomicservice 2826 * @since arkts {'1.1':'18','1.2':'20'} 2827 * @arkts 1.1&1.2 2828 */ 2829 NAVIGATION = 58, 2830 /** 2831 * navigation bar component type 2832 * @syscap SystemCapability.ArkUI.ArkUI.Full 2833 * @crossplatform 2834 * @form 2835 * @atomicservice 2836 * @since arkts {'1.1':'18','1.2':'20'} 2837 * @arkts 1.1&1.2 2838 */ 2839 NAVIGATION_BAR = 59, 2840 /** 2841 * navigation menu component type 2842 * @syscap SystemCapability.ArkUI.ArkUI.Full 2843 * @crossplatform 2844 * @form 2845 * @atomicservice 2846 * @since arkts {'1.1':'18','1.2':'20'} 2847 * @arkts 1.1&1.2 2848 */ 2849 NAVIGATION_MENU = 60, 2850 /** 2851 * navigator component type 2852 * @syscap SystemCapability.ArkUI.ArkUI.Full 2853 * @crossplatform 2854 * @form 2855 * @atomicservice 2856 * @since arkts {'1.1':'18','1.2':'20'} 2857 * @arkts 1.1&1.2 2858 */ 2859 NAVIGATOR = 61, 2860 /** 2861 * offscreen canvas component type 2862 * @syscap SystemCapability.ArkUI.ArkUI.Full 2863 * @crossplatform 2864 * @form 2865 * @atomicservice 2866 * @since arkts {'1.1':'18','1.2':'20'} 2867 * @arkts 1.1&1.2 2868 */ 2869 OFFSCREEN_CANVAS = 62, 2870 /** 2871 * offscreen canvas rendering context2d component type 2872 * @syscap SystemCapability.ArkUI.ArkUI.Full 2873 * @crossplatform 2874 * @form 2875 * @atomicservice 2876 * @since arkts {'1.1':'18','1.2':'20'} 2877 * @arkts 1.1&1.2 2878 */ 2879 OFFSCREEN_CANVAS_RENDERING_CONTEXT2D = 63, 2880 /** 2881 * option component type 2882 * @syscap SystemCapability.ArkUI.ArkUI.Full 2883 * @crossplatform 2884 * @form 2885 * @atomicservice 2886 * @since arkts {'1.1':'18','1.2':'20'} 2887 * @arkts 1.1&1.2 2888 */ 2889 OPTION = 64, 2890 /** 2891 * panel component type 2892 * @syscap SystemCapability.ArkUI.ArkUI.Full 2893 * @crossplatform 2894 * @form 2895 * @atomicservice 2896 * @since arkts {'1.1':'18','1.2':'20'} 2897 * @arkts 1.1&1.2 2898 */ 2899 PANEL = 65, 2900 /** 2901 * paper page component type 2902 * @syscap SystemCapability.ArkUI.ArkUI.Full 2903 * @crossplatform 2904 * @form 2905 * @atomicservice 2906 * @since arkts {'1.1':'18','1.2':'20'} 2907 * @arkts 1.1&1.2 2908 */ 2909 PAPER_PAGE = 66, 2910 /** 2911 * path component type 2912 * @syscap SystemCapability.ArkUI.ArkUI.Full 2913 * @crossplatform 2914 * @form 2915 * @atomicservice 2916 * @since arkts {'1.1':'18','1.2':'20'} 2917 * @arkts 1.1&1.2 2918 */ 2919 PATH = 67, 2920 /** 2921 * path 2d component type 2922 * @syscap SystemCapability.ArkUI.ArkUI.Full 2923 * @crossplatform 2924 * @form 2925 * @atomicservice 2926 * @since arkts {'1.1':'18','1.2':'20'} 2927 * @arkts 1.1&1.2 2928 */ 2929 PATH2D = 68, 2930 /** 2931 * pattern lock component type 2932 * @syscap SystemCapability.ArkUI.ArkUI.Full 2933 * @crossplatform 2934 * @form 2935 * @atomicservice 2936 * @since arkts {'1.1':'18','1.2':'20'} 2937 * @arkts 1.1&1.2 2938 */ 2939 PATTERN_LOCK = 69, 2940 /** 2941 * picker component type 2942 * @syscap SystemCapability.ArkUI.ArkUI.Full 2943 * @crossplatform 2944 * @form 2945 * @atomicservice 2946 * @since arkts {'1.1':'18','1.2':'20'} 2947 * @arkts 1.1&1.2 2948 */ 2949 PICKER = 70, 2950 /** 2951 * picker view component type 2952 * @syscap SystemCapability.ArkUI.ArkUI.Full 2953 * @crossplatform 2954 * @form 2955 * @atomicservice 2956 * @since arkts {'1.1':'18','1.2':'20'} 2957 * @arkts 1.1&1.2 2958 */ 2959 PICKER_VIEW = 71, 2960 /** 2961 * plugin component type 2962 * @syscap SystemCapability.ArkUI.ArkUI.Full 2963 * @crossplatform 2964 * @form 2965 * @atomicservice 2966 * @since arkts {'1.1':'18','1.2':'20'} 2967 * @arkts 1.1&1.2 2968 */ 2969 PLUGIN_COMPONENT = 72, 2970 /** 2971 * polygon component type 2972 * @syscap SystemCapability.ArkUI.ArkUI.Full 2973 * @crossplatform 2974 * @form 2975 * @atomicservice 2976 * @since arkts {'1.1':'18','1.2':'20'} 2977 * @arkts 1.1&1.2 2978 */ 2979 POLYGON = 73, 2980 /** 2981 * polyline component type 2982 * @syscap SystemCapability.ArkUI.ArkUI.Full 2983 * @crossplatform 2984 * @form 2985 * @atomicservice 2986 * @since arkts {'1.1':'18','1.2':'20'} 2987 * @arkts 1.1&1.2 2988 */ 2989 POLYLINE = 74, 2990 /** 2991 * pop up component type 2992 * @syscap SystemCapability.ArkUI.ArkUI.Full 2993 * @crossplatform 2994 * @form 2995 * @atomicservice 2996 * @since arkts {'1.1':'18','1.2':'20'} 2997 * @arkts 1.1&1.2 2998 */ 2999 POPUP = 75, 3000 /** 3001 * progress component type 3002 * @syscap SystemCapability.ArkUI.ArkUI.Full 3003 * @crossplatform 3004 * @form 3005 * @atomicservice 3006 * @since arkts {'1.1':'18','1.2':'20'} 3007 * @arkts 1.1&1.2 3008 */ 3009 PROGRESS = 76, 3010 /** 3011 * qr code component type 3012 * @syscap SystemCapability.ArkUI.ArkUI.Full 3013 * @crossplatform 3014 * @form 3015 * @atomicservice 3016 * @since arkts {'1.1':'18','1.2':'20'} 3017 * @arkts 1.1&1.2 3018 */ 3019 QRCODE = 77, 3020 /** 3021 * radio component type 3022 * @syscap SystemCapability.ArkUI.ArkUI.Full 3023 * @crossplatform 3024 * @form 3025 * @atomicservice 3026 * @since arkts {'1.1':'18','1.2':'20'} 3027 * @arkts 1.1&1.2 3028 */ 3029 RADIO = 78, 3030 /** 3031 * rating component type 3032 * @syscap SystemCapability.ArkUI.ArkUI.Full 3033 * @crossplatform 3034 * @form 3035 * @atomicservice 3036 * @since arkts {'1.1':'18','1.2':'20'} 3037 * @arkts 1.1&1.2 3038 */ 3039 RATING = 79, 3040 /** 3041 * rect component type 3042 * @syscap SystemCapability.ArkUI.ArkUI.Full 3043 * @crossplatform 3044 * @form 3045 * @atomicservice 3046 * @since arkts {'1.1':'18','1.2':'20'} 3047 * @arkts 1.1&1.2 3048 */ 3049 RECT = 80, 3050 /** 3051 * refresh component type 3052 * @syscap SystemCapability.ArkUI.ArkUI.Full 3053 * @crossplatform 3054 * @form 3055 * @atomicservice 3056 * @since arkts {'1.1':'18','1.2':'20'} 3057 * @arkts 1.1&1.2 3058 */ 3059 REFRESH = 81, 3060 /** 3061 * relative container component type 3062 * @syscap SystemCapability.ArkUI.ArkUI.Full 3063 * @crossplatform 3064 * @form 3065 * @atomicservice 3066 * @since arkts {'1.1':'18','1.2':'20'} 3067 * @arkts 1.1&1.2 3068 */ 3069 RELATIVE_CONTAINER = 82, 3070 /** 3071 * remote window component type 3072 * @syscap SystemCapability.ArkUI.ArkUI.Full 3073 * @crossplatform 3074 * @form 3075 * @atomicservice 3076 * @since arkts {'1.1':'18','1.2':'20'} 3077 * @arkts 1.1&1.2 3078 */ 3079 REMOTE_WINDOW = 83, 3080 /** 3081 * rich editor component type 3082 * @syscap SystemCapability.ArkUI.ArkUI.Full 3083 * @crossplatform 3084 * @form 3085 * @atomicservice 3086 * @since arkts {'1.1':'18','1.2':'20'} 3087 * @arkts 1.1&1.2 3088 */ 3089 RICH_EDITOR = 84, 3090 /** 3091 * rich text component type 3092 * @syscap SystemCapability.ArkUI.ArkUI.Full 3093 * @crossplatform 3094 * @form 3095 * @atomicservice 3096 * @since arkts {'1.1':'18','1.2':'20'} 3097 * @arkts 1.1&1.2 3098 */ 3099 RICH_TEXT = 85, 3100 /** 3101 * rolepager component type 3102 * @syscap SystemCapability.ArkUI.ArkUI.Full 3103 * @crossplatform 3104 * @form 3105 * @atomicservice 3106 * @since arkts {'1.1':'18','1.2':'20'} 3107 * @arkts 1.1&1.2 3108 */ 3109 ROLE_PAGER = 86, 3110 /** 3111 * row component type 3112 * @syscap SystemCapability.ArkUI.ArkUI.Full 3113 * @crossplatform 3114 * @form 3115 * @atomicservice 3116 * @since arkts {'1.1':'18','1.2':'20'} 3117 * @arkts 1.1&1.2 3118 */ 3119 ROW = 87, 3120 /** 3121 * row split component type 3122 * @syscap SystemCapability.ArkUI.ArkUI.Full 3123 * @crossplatform 3124 * @form 3125 * @atomicservice 3126 * @since arkts {'1.1':'18','1.2':'20'} 3127 * @arkts 1.1&1.2 3128 */ 3129 ROW_SPLIT = 88, 3130 /** 3131 * scroll component type 3132 * @syscap SystemCapability.ArkUI.ArkUI.Full 3133 * @crossplatform 3134 * @form 3135 * @atomicservice 3136 * @since arkts {'1.1':'18','1.2':'20'} 3137 * @arkts 1.1&1.2 3138 */ 3139 SCROLL = 89, 3140 /** 3141 * scroll bar component type 3142 * @syscap SystemCapability.ArkUI.ArkUI.Full 3143 * @crossplatform 3144 * @form 3145 * @atomicservice 3146 * @since arkts {'1.1':'18','1.2':'20'} 3147 * @arkts 1.1&1.2 3148 */ 3149 SCROLL_BAR = 90, 3150 /** 3151 * search component type 3152 * @syscap SystemCapability.ArkUI.ArkUI.Full 3153 * @crossplatform 3154 * @form 3155 * @atomicservice 3156 * @since arkts {'1.1':'18','1.2':'20'} 3157 * @arkts 1.1&1.2 3158 */ 3159 SEARCH = 91, 3160 /** 3161 * search field component type 3162 * @syscap SystemCapability.ArkUI.ArkUI.Full 3163 * @crossplatform 3164 * @form 3165 * @atomicservice 3166 * @since arkts {'1.1':'18','1.2':'20'} 3167 * @arkts 1.1&1.2 3168 */ 3169 SEARCH_FIELD = 92, 3170 /** 3171 * select component type 3172 * @syscap SystemCapability.ArkUI.ArkUI.Full 3173 * @crossplatform 3174 * @form 3175 * @atomicservice 3176 * @since arkts {'1.1':'18','1.2':'20'} 3177 * @arkts 1.1&1.2 3178 */ 3179 SELECT = 93, 3180 /** 3181 * shape component type 3182 * @syscap SystemCapability.ArkUI.ArkUI.Full 3183 * @crossplatform 3184 * @form 3185 * @atomicservice 3186 * @since arkts {'1.1':'18','1.2':'20'} 3187 * @arkts 1.1&1.2 3188 */ 3189 SHAPE = 94, 3190 /** 3191 * sidebar container component type 3192 * @syscap SystemCapability.ArkUI.ArkUI.Full 3193 * @crossplatform 3194 * @form 3195 * @atomicservice 3196 * @since arkts {'1.1':'18','1.2':'20'} 3197 * @arkts 1.1&1.2 3198 */ 3199 SIDEBAR_CONTAINER = 95, 3200 /** 3201 * slider component type 3202 * @syscap SystemCapability.ArkUI.ArkUI.Full 3203 * @crossplatform 3204 * @form 3205 * @atomicservice 3206 * @since arkts {'1.1':'18','1.2':'20'} 3207 * @arkts 1.1&1.2 3208 */ 3209 SLIDER = 96, 3210 /** 3211 * span component type 3212 * @syscap SystemCapability.ArkUI.ArkUI.Full 3213 * @crossplatform 3214 * @form 3215 * @atomicservice 3216 * @since arkts {'1.1':'18','1.2':'20'} 3217 * @arkts 1.1&1.2 3218 */ 3219 SPAN = 97, 3220 /** 3221 * stack component type 3222 * @syscap SystemCapability.ArkUI.ArkUI.Full 3223 * @crossplatform 3224 * @form 3225 * @atomicservice 3226 * @since arkts {'1.1':'18','1.2':'20'} 3227 * @arkts 1.1&1.2 3228 */ 3229 STACK = 98, 3230 /** 3231 * stepper component type 3232 * @syscap SystemCapability.ArkUI.ArkUI.Full 3233 * @crossplatform 3234 * @form 3235 * @atomicservice 3236 * @since arkts {'1.1':'18','1.2':'20'} 3237 * @arkts 1.1&1.2 3238 */ 3239 STEPPER = 99, 3240 /** 3241 * stepper item component type 3242 * @syscap SystemCapability.ArkUI.ArkUI.Full 3243 * @crossplatform 3244 * @form 3245 * @atomicservice 3246 * @since arkts {'1.1':'18','1.2':'20'} 3247 * @arkts 1.1&1.2 3248 */ 3249 STEPPER_ITEM = 100, 3250 /** 3251 * swiper component type 3252 * @syscap SystemCapability.ArkUI.ArkUI.Full 3253 * @crossplatform 3254 * @form 3255 * @atomicservice 3256 * @since arkts {'1.1':'18','1.2':'20'} 3257 * @arkts 1.1&1.2 3258 */ 3259 SWIPER = 101, 3260 /** 3261 * swiper indicator component type 3262 * @syscap SystemCapability.ArkUI.ArkUI.Full 3263 * @crossplatform 3264 * @form 3265 * @atomicservice 3266 * @since arkts {'1.1':'18','1.2':'20'} 3267 * @arkts 1.1&1.2 3268 */ 3269 SWIPER_INDICATOR = 102, 3270 /** 3271 * switch component type 3272 * @syscap SystemCapability.ArkUI.ArkUI.Full 3273 * @crossplatform 3274 * @form 3275 * @atomicservice 3276 * @since arkts {'1.1':'18','1.2':'20'} 3277 * @arkts 1.1&1.2 3278 */ 3279 SWITCH = 103, 3280 /** 3281 * symbol glyph component type 3282 * @syscap SystemCapability.ArkUI.ArkUI.Full 3283 * @crossplatform 3284 * @form 3285 * @atomicservice 3286 * @since arkts {'1.1':'18','1.2':'20'} 3287 * @arkts 1.1&1.2 3288 */ 3289 SYMBOL_GLYPH = 104, 3290 /** 3291 * tab content component type 3292 * @syscap SystemCapability.ArkUI.ArkUI.Full 3293 * @crossplatform 3294 * @form 3295 * @atomicservice 3296 * @since arkts {'1.1':'18','1.2':'20'} 3297 * @arkts 1.1&1.2 3298 */ 3299 TAB_CONTENT = 105, 3300 /** 3301 * tab bar component type 3302 * @syscap SystemCapability.ArkUI.ArkUI.Full 3303 * @crossplatform 3304 * @form 3305 * @atomicservice 3306 * @since arkts {'1.1':'18','1.2':'20'} 3307 * @arkts 1.1&1.2 3308 */ 3309 TAB_BAR = 106, 3310 /** 3311 * tabs component type 3312 * @syscap SystemCapability.ArkUI.ArkUI.Full 3313 * @crossplatform 3314 * @form 3315 * @atomicservice 3316 * @since arkts {'1.1':'18','1.2':'20'} 3317 * @arkts 1.1&1.2 3318 */ 3319 TABS = 107, 3320 /** 3321 * text component type 3322 * @syscap SystemCapability.ArkUI.ArkUI.Full 3323 * @crossplatform 3324 * @form 3325 * @atomicservice 3326 * @since arkts {'1.1':'18','1.2':'20'} 3327 * @arkts 1.1&1.2 3328 */ 3329 TEXT = 108, 3330 /** 3331 * text clock component type 3332 * @syscap SystemCapability.ArkUI.ArkUI.Full 3333 * @crossplatform 3334 * @form 3335 * @atomicservice 3336 * @since arkts {'1.1':'18','1.2':'20'} 3337 * @arkts 1.1&1.2 3338 */ 3339 TEXT_CLOCK = 109, 3340 /** 3341 * text entry component type 3342 * @syscap SystemCapability.ArkUI.ArkUI.Full 3343 * @crossplatform 3344 * @form 3345 * @atomicservice 3346 * @since arkts {'1.1':'18','1.2':'20'} 3347 * @arkts 1.1&1.2 3348 */ 3349 TEXT_ENTRY = 110, 3350 /** 3351 * text input component type 3352 * @syscap SystemCapability.ArkUI.ArkUI.Full 3353 * @crossplatform 3354 * @form 3355 * @atomicservice 3356 * @since arkts {'1.1':'18','1.2':'20'} 3357 * @arkts 1.1&1.2 3358 */ 3359 TEXT_INPUT = 111, 3360 /** 3361 * text picker component type 3362 * @syscap SystemCapability.ArkUI.ArkUI.Full 3363 * @crossplatform 3364 * @form 3365 * @atomicservice 3366 * @since arkts {'1.1':'18','1.2':'20'} 3367 * @arkts 1.1&1.2 3368 */ 3369 TEXT_PICKER = 112, 3370 /** 3371 * text timer component type 3372 * @syscap SystemCapability.ArkUI.ArkUI.Full 3373 * @crossplatform 3374 * @form 3375 * @atomicservice 3376 * @since arkts {'1.1':'18','1.2':'20'} 3377 * @arkts 1.1&1.2 3378 */ 3379 TEXT_TIMER = 113, 3380 /** 3381 * text area component type 3382 * @syscap SystemCapability.ArkUI.ArkUI.Full 3383 * @crossplatform 3384 * @form 3385 * @atomicservice 3386 * @since arkts {'1.1':'18','1.2':'20'} 3387 * @arkts 1.1&1.2 3388 */ 3389 TEXT_AREA = 114, 3390 /** 3391 * text field component type 3392 * @syscap SystemCapability.ArkUI.ArkUI.Full 3393 * @crossplatform 3394 * @form 3395 * @atomicservice 3396 * @since arkts {'1.1':'18','1.2':'20'} 3397 * @arkts 1.1&1.2 3398 */ 3399 TEXT_FIELD = 115, 3400 /** 3401 * time picker component type 3402 * @syscap SystemCapability.ArkUI.ArkUI.Full 3403 * @crossplatform 3404 * @form 3405 * @atomicservice 3406 * @since arkts {'1.1':'18','1.2':'20'} 3407 * @arkts 1.1&1.2 3408 */ 3409 TIME_PICKER = 116, 3410 /** 3411 * title bar component type 3412 * @syscap SystemCapability.ArkUI.ArkUI.Full 3413 * @crossplatform 3414 * @form 3415 * @atomicservice 3416 * @since arkts {'1.1':'18','1.2':'20'} 3417 * @arkts 1.1&1.2 3418 */ 3419 TITLE_BAR = 117, 3420 /** 3421 * toggler component type 3422 * @syscap SystemCapability.ArkUI.ArkUI.Full 3423 * @crossplatform 3424 * @form 3425 * @atomicservice 3426 * @since arkts {'1.1':'18','1.2':'20'} 3427 * @arkts 1.1&1.2 3428 */ 3429 TOGGLER = 118, 3430 /** 3431 * uiextensioncomponent component type 3432 * @syscap SystemCapability.ArkUI.ArkUI.Full 3433 * @crossplatform 3434 * @form 3435 * @atomicservice 3436 * @since arkts {'1.1':'18','1.2':'20'} 3437 * @arkts 1.1&1.2 3438 */ 3439 UI_EXTENSION_COMPONENT = 119, 3440 /** 3441 * video component type 3442 * @syscap SystemCapability.ArkUI.ArkUI.Full 3443 * @crossplatform 3444 * @form 3445 * @atomicservice 3446 * @since arkts {'1.1':'18','1.2':'20'} 3447 * @arkts 1.1&1.2 3448 */ 3449 VIDEO = 120, 3450 /** 3451 * water flow component type 3452 * @syscap SystemCapability.ArkUI.ArkUI.Full 3453 * @crossplatform 3454 * @form 3455 * @atomicservice 3456 * @since arkts {'1.1':'18','1.2':'20'} 3457 * @arkts 1.1&1.2 3458 */ 3459 WATER_FLOW = 121, 3460 /** 3461 * web component type 3462 * @syscap SystemCapability.ArkUI.ArkUI.Full 3463 * @crossplatform 3464 * @form 3465 * @atomicservice 3466 * @since arkts {'1.1':'18','1.2':'20'} 3467 * @arkts 1.1&1.2 3468 */ 3469 WEB = 122, 3470 /** 3471 * xcomponent component type 3472 * @syscap SystemCapability.ArkUI.ArkUI.Full 3473 * @crossplatform 3474 * @form 3475 * @atomicservice 3476 * @since arkts {'1.1':'18','1.2':'20'} 3477 * @arkts 1.1&1.2 3478 */ 3479 XCOMPONENT = 123, 3480 /** 3481 * none component type: screen reader will not broadcast the component type. 3482 * @syscap SystemCapability.ArkUI.ArkUI.Full 3483 * @crossplatform 3484 * @form 3485 * @atomicservice 3486 * @since arkts {'1.1':'18','1.2':'20'} 3487 * @arkts 1.1&1.2 3488 */ 3489 ROLE_NONE = 124, 3490} 3491 3492/** 3493 * Defines the callback type used in accessibility focus. The value of isFocus indicates whether the current component is focused 3494 * @typedef {function} AccessibilityFocusCallback 3495 * @param {boolean} isFocus - if component is focused,isFocus will be true. else isFocus is false. 3496 * @syscap SystemCapability.ArkUI.ArkUI.Full 3497 * @crossplatform 3498 * @form 3499 * @atomicservice 3500 * @since arkts {'1.1':'18','1.2':'20'} 3501 * @arkts 1.1&1.2 3502 */ 3503declare type AccessibilityFocusCallback = (isFocus: boolean) => void; 3504 3505/** 3506 * Enum for accessibility action type 3507 * @enum { number } 3508 * @syscap SystemCapability.ArkUI.ArkUI.Full 3509 * @crossplatform 3510 * @form 3511 * @atomicservice 3512 * @since 20 3513 */ 3514declare enum AccessibilityAction { 3515 /** 3516 * undefined action type 3517 * @syscap SystemCapability.ArkUI.ArkUI.Full 3518 * @crossplatform 3519 * @form 3520 * @atomicservice 3521 * @since 20 3522 */ 3523 UNDEFINED_ACTION = 0, 3524 /** 3525 * accessibility click action 3526 * @syscap SystemCapability.ArkUI.ArkUI.Full 3527 * @crossplatform 3528 * @form 3529 * @atomicservice 3530 * @since 20 3531 */ 3532 ACCESSIBILITY_CLICK = 1, 3533} 3534 3535/** 3536 * Enum for the result of accessibility action intercept function 3537 * @enum { number } 3538 * @syscap SystemCapability.ArkUI.ArkUI.Full 3539 * @crossplatform 3540 * @form 3541 * @atomicservice 3542 * @since 20 3543 */ 3544declare enum AccessibilityActionInterceptResult { 3545 /** 3546 * intercept the accessibility action 3547 * @syscap SystemCapability.ArkUI.ArkUI.Full 3548 * @crossplatform 3549 * @form 3550 * @atomicservice 3551 * @since 20 3552 */ 3553 ACTION_INTERCEPT = 0, 3554 /** 3555 * the accessibility action can be continued 3556 * @syscap SystemCapability.ArkUI.ArkUI.Full 3557 * @crossplatform 3558 * @form 3559 * @atomicservice 3560 * @since 20 3561 */ 3562 ACTION_CONTINUE = 1, 3563 /** 3564 * the accessibility action need to bubble up for execution 3565 * @syscap SystemCapability.ArkUI.ArkUI.Full 3566 * @crossplatform 3567 * @form 3568 * @atomicservice 3569 * @since 20 3570 */ 3571 ACTION_RISE = 2, 3572} 3573 3574/** 3575 * Defines the callback type used in accessibility action intercept. 3576 * The value of action indicates the accessibility action type. 3577 * @typedef { function } AccessibilityActionInterceptCallback 3578 * @param { AccessibilityAction } action - the enum of accessibility action type. 3579 * @returns { AccessibilityActionInterceptResult } the result of continuing to execute the action or interrupting it or bubbling up 3580 * @syscap SystemCapability.ArkUI.ArkUI.Full 3581 * @crossplatform 3582 * @form 3583 * @atomicservice 3584 * @since 20 3585 */ 3586declare type AccessibilityActionInterceptCallback = (action: AccessibilityAction) => AccessibilityActionInterceptResult; 3587 3588/** 3589 * Enum for FinishCallbackType. 3590 * 3591 * @enum { number } 3592 * @syscap SystemCapability.ArkUI.ArkUI.Full 3593 * @crossplatform 3594 * @form 3595 * @since 11 3596 */ 3597/** 3598 * Enum for FinishCallbackType. 3599 * 3600 * @enum { number } 3601 * @syscap SystemCapability.ArkUI.ArkUI.Full 3602 * @crossplatform 3603 * @form 3604 * @atomicservice 3605 * @since arkts {'1.1':'12','1.2':'20'} 3606 * @arkts 1.1&1.2 3607 */ 3608declare enum FinishCallbackType { 3609 /** 3610 * The callback is invoked when the entire animation is removed once it has finished. 3611 * 3612 * @syscap SystemCapability.ArkUI.ArkUI.Full 3613 * @crossplatform 3614 * @form 3615 * @since 11 3616 */ 3617 /** 3618 * The callback is invoked when the entire animation is removed once it has finished. 3619 * 3620 * @syscap SystemCapability.ArkUI.ArkUI.Full 3621 * @crossplatform 3622 * @form 3623 * @atomicservice 3624 * @since arkts {'1.1':'12','1.2':'20'} 3625 * @arkts 1.1&1.2 3626 */ 3627 REMOVED = 0, 3628 /** 3629 * When the animation is logically down but may still be in its long tail, the callback is triggered. 3630 * 3631 * @syscap SystemCapability.ArkUI.ArkUI.Full 3632 * @crossplatform 3633 * @form 3634 * @since 11 3635 */ 3636 /** 3637 * The callback is invoked when the animation logically enters the falling state, 3638 * though it may still be in its long tail state. 3639 * 3640 * @syscap SystemCapability.ArkUI.ArkUI.Full 3641 * @crossplatform 3642 * @form 3643 * @atomicservice 3644 * @since arkts {'1.1':'12','1.2':'20'} 3645 * @arkts 1.1&1.2 3646 */ 3647 LOGICALLY = 1, 3648} 3649 3650/** 3651 * Defines the touch test strategy object. 3652 * 3653 * @enum { number } 3654 * @syscap SystemCapability.ArkUI.ArkUI.Full 3655 * @crossplatform 3656 * @form 3657 * @since 11 3658 */ 3659/** 3660 * Defines the touch test strategy object. 3661 * 3662 * @enum { number } 3663 * @syscap SystemCapability.ArkUI.ArkUI.Full 3664 * @crossplatform 3665 * @form 3666 * @atomicservice 3667 * @since arkts {'1.1':'12','1.2':'20'} 3668 * @arkts 1.1&1.2 3669 */ 3670declare enum TouchTestStrategy { 3671 /** 3672 * Do framework touch test. 3673 * 3674 * @syscap SystemCapability.ArkUI.ArkUI.Full 3675 * @crossplatform 3676 * @form 3677 * @since 11 3678 */ 3679 /** 3680 * Custom dispatch has no effect; the system distributes events based on the hit status of the current node. 3681 * 3682 * @syscap SystemCapability.ArkUI.ArkUI.Full 3683 * @crossplatform 3684 * @form 3685 * @atomicservice 3686 * @since arkts {'1.1':'12','1.2':'20'} 3687 * @arkts 1.1&1.2 3688 */ 3689 DEFAULT = 0, 3690 3691 /** 3692 * Specify the component to do touch test and follow the framework touch test 3693 * 3694 * @syscap SystemCapability.ArkUI.ArkUI.Full 3695 * @crossplatform 3696 * @form 3697 * @since 11 3698 */ 3699 /** 3700 * The specified event is forwarded to a particular child node, and the system determines whether to 3701 * distribute the event to other sibling nodes. 3702 * 3703 * @syscap SystemCapability.ArkUI.ArkUI.Full 3704 * @crossplatform 3705 * @form 3706 * @atomicservice 3707 * @since arkts {'1.1':'12','1.2':'20'} 3708 * @arkts 1.1&1.2 3709 */ 3710 FORWARD_COMPETITION = 1, 3711 3712 /** 3713 * Specify the component to do touch test and not follow the framework touch test 3714 * 3715 * @syscap SystemCapability.ArkUI.ArkUI.Full 3716 * @crossplatform 3717 * @form 3718 * @since 11 3719 */ 3720 /** 3721 * The specified event is forwarded to a particular child node, and the system no longer distributes 3722 * the event to other sibling nodes. 3723 * 3724 * @syscap SystemCapability.ArkUI.ArkUI.Full 3725 * @crossplatform 3726 * @form 3727 * @atomicservice 3728 * @since arkts {'1.1':'12','1.2':'20'} 3729 * @arkts 1.1&1.2 3730 */ 3731 FORWARD = 2 3732} 3733 3734/** 3735 * Defines the animate function params. 3736 * 3737 * @interface AnimateParam 3738 * @syscap SystemCapability.ArkUI.ArkUI.Full 3739 * @since 7 3740 */ 3741/** 3742 * Defines the animate function params. 3743 * 3744 * @interface AnimateParam 3745 * @syscap SystemCapability.ArkUI.ArkUI.Full 3746 * @form 3747 * @since 9 3748 */ 3749/** 3750 * Defines the animate function params. 3751 * 3752 * @interface AnimateParam 3753 * @syscap SystemCapability.ArkUI.ArkUI.Full 3754 * @crossplatform 3755 * @form 3756 * @since 10 3757 */ 3758/** 3759 * Defines the animate function params. 3760 * 3761 * @interface AnimateParam 3762 * @syscap SystemCapability.ArkUI.ArkUI.Full 3763 * @crossplatform 3764 * @form 3765 * @atomicservice 3766 * @since arkts {'1.1':'11','1.2':'20'} 3767 * @arkts 1.1&1.2 3768 */ 3769declare interface AnimateParam { 3770 /** 3771 * Animation duration, in ms. 3772 * 3773 * @type { ?number } 3774 * @default 1000 3775 * @syscap SystemCapability.ArkUI.ArkUI.Full 3776 * @since 7 3777 */ 3778 /** 3779 * Animation duration, in ms. 3780 * 3781 * @type { ?number } 3782 * @default 1000 3783 * @syscap SystemCapability.ArkUI.ArkUI.Full 3784 * @form 3785 * @since 9 3786 */ 3787 /** 3788 * Animation duration, in ms. 3789 * 3790 * @type { ?number } 3791 * @default 1000 3792 * @syscap SystemCapability.ArkUI.ArkUI.Full 3793 * @crossplatform 3794 * @form 3795 * @since 10 3796 */ 3797 /** 3798 * Animation duration, in ms. 3799 * 3800 * @type { ?number } 3801 * @default 1000 3802 * @syscap SystemCapability.ArkUI.ArkUI.Full 3803 * @crossplatform 3804 * @form 3805 * @atomicservice 3806 * @since arkts {'1.1':'11','1.2':'20'} 3807 * @arkts 1.1&1.2 3808 */ 3809 duration?: number; 3810 /** 3811 * Animation playback speed. A larger value indicates faster animation playback, and a smaller value indicates slower 3812 * animation playback. The value 0 means that there is no animation. 3813 * <br>Default value: **1.0**. 3814 * 3815 * @type { ?number } 3816 * @default 1.0 3817 * @syscap SystemCapability.ArkUI.ArkUI.Full 3818 * @since 7 3819 */ 3820 /** 3821 * Animation playback speed. A larger value indicates faster animation playback, and a smaller value indicates slower 3822 * animation playback. The value 0 means that there is no animation. 3823 * <br>Default value: **1.0**. 3824 * 3825 * @type { ?number } 3826 * @default 1.0 3827 * @syscap SystemCapability.ArkUI.ArkUI.Full 3828 * @crossplatform 3829 * @since 10 3830 */ 3831 /** 3832 * Animation playback speed. A larger value indicates faster animation playback, and a smaller value indicates slower 3833 * animation playback. The value 0 means that there is no animation. 3834 * 3835 * @type { ?number } 3836 * @default 1.0 3837 * @syscap SystemCapability.ArkUI.ArkUI.Full 3838 * @crossplatform 3839 * @atomicservice 3840 * @since arkts {'1.1':'11','1.2':'20'} 3841 * @arkts 1.1&1.2 3842 */ 3843 tempo?: number; 3844 /** 3845 * Animation curve. 3846 * 3847 * @type { ?(Curve | string) } 3848 * @default Curve.EaseInOut 3849 * @syscap SystemCapability.ArkUI.ArkUI.Full 3850 * @since 7 3851 */ 3852 /** 3853 * Animation curve. 3854 * 3855 * @type { ?(Curve | string | ICurve) } 3856 * @default Curve.EaseInOut 3857 * @syscap SystemCapability.ArkUI.ArkUI.Full 3858 * @form 3859 * @since 9 3860 */ 3861 /** 3862 * Animation curve. 3863 * 3864 * @type { ?(Curve | string | ICurve) } 3865 * @default Curve.EaseInOut 3866 * @syscap SystemCapability.ArkUI.ArkUI.Full 3867 * @crossplatform 3868 * @form 3869 * @since 10 3870 */ 3871 /** 3872 * Animation curve. 3873 * 3874 * @type { ?(Curve | string | ICurve) } 3875 * @default Curve.EaseInOut 3876 * @syscap SystemCapability.ArkUI.ArkUI.Full 3877 * @crossplatform 3878 * @form 3879 * @atomicservice 3880 * @since arkts {'1.1':'11','1.2':'20'} 3881 * @arkts 1.1&1.2 3882 */ 3883 curve?: Curve | string | ICurve; 3884 3885 /** 3886 * Animation delay time, in ms. By default, the animation has no delay. 3887 * 3888 * @type { ?number } 3889 * @default 0 3890 * @syscap SystemCapability.ArkUI.ArkUI.Full 3891 * @since 7 3892 */ 3893 /** 3894 * Animation delay time, in ms. By default, the animation has no delay. 3895 * 3896 * @type { ?number } 3897 * @default 0 3898 * @syscap SystemCapability.ArkUI.ArkUI.Full 3899 * @crossplatform 3900 * @since 10 3901 */ 3902 /** 3903 * Animation delay time, in ms. By default, the animation has no delay. 3904 * 3905 * @type { ?number } 3906 * @default 0 3907 * @syscap SystemCapability.ArkUI.ArkUI.Full 3908 * @crossplatform 3909 * @atomicservice 3910 * @since arkts {'1.1':'11','1.2':'20'} 3911 * @arkts 1.1&1.2 3912 */ 3913 delay?: number; 3914 3915 /** 3916 * Number of times that the animation is played. By default, the animation is played once. 3917 * The value **-1** indicates that the animation is played for an unlimited number of times. 3918 * The value **0** indicates that there is no animation. 3919 * 3920 * @type { ?number } 3921 * @default 1 3922 * @syscap SystemCapability.ArkUI.ArkUI.Full 3923 * @since 7 3924 */ 3925 /** 3926 * Number of times that the animation is played. By default, the animation is played once. 3927 * The value **-1** indicates that the animation is played for an unlimited number of times. 3928 * The value **0** indicates that there is no animation. 3929 * 3930 * @type { ?number } 3931 * @default 1 3932 * @syscap SystemCapability.ArkUI.ArkUI.Full 3933 * @crossplatform 3934 * @since 10 3935 */ 3936 /** 3937 * Number of times that the animation is played. By default, the animation is played once. 3938 * The value **-1** indicates that the animation is played for an unlimited number of times. 3939 * The value **0** indicates that there is no animation. 3940 * 3941 * @type { ?number } 3942 * @default 1 3943 * @syscap SystemCapability.ArkUI.ArkUI.Full 3944 * @crossplatform 3945 * @atomicservice 3946 * @since arkts {'1.1':'11','1.2':'20'} 3947 * @arkts 1.1&1.2 3948 */ 3949 iterations?: number; 3950 3951 /** 3952 * Playback mode. By default, the animation is played from the beginning after the playback is complete. 3953 * 3954 * @type { ?PlayMode } 3955 * @default PlayMode.Normal 3956 * @syscap SystemCapability.ArkUI.ArkUI.Full 3957 * @since 7 3958 */ 3959 /** 3960 * Playback mode. By default, the animation is played from the beginning after the playback is complete. 3961 * 3962 * @type { ?PlayMode } 3963 * @default PlayMode.Normal 3964 * @syscap SystemCapability.ArkUI.ArkUI.Full 3965 * @form 3966 * @since 9 3967 */ 3968 /** 3969 * Playback mode. By default, the animation is played from the beginning after the playback is complete. 3970 * 3971 * @type { ?PlayMode } 3972 * @default PlayMode.Normal 3973 * @syscap SystemCapability.ArkUI.ArkUI.Full 3974 * @crossplatform 3975 * @form 3976 * @since 10 3977 */ 3978 /** 3979 * Playback mode. By default, the animation is played from the beginning after the playback is complete. 3980 * 3981 * @type { ?PlayMode } 3982 * @default PlayMode.Normal 3983 * @syscap SystemCapability.ArkUI.ArkUI.Full 3984 * @crossplatform 3985 * @form 3986 * @atomicservice 3987 * @since arkts {'1.1':'11','1.2':'20'} 3988 * @arkts 1.1&1.2 3989 */ 3990 playMode?: PlayMode; 3991 3992 /** 3993 * Callback invoked when the animation playback is complete. 3994 * 3995 * @type { ?function } 3996 * @syscap SystemCapability.ArkUI.ArkUI.Full 3997 * @since 7 3998 */ 3999 /** 4000 * Callback invoked when the animation playback is complete. 4001 * 4002 * @type { ?function } 4003 * @syscap SystemCapability.ArkUI.ArkUI.Full 4004 * @form 4005 * @since 9 4006 */ 4007 /** 4008 * Callback invoked when the animation playback is complete. 4009 * 4010 * @type { ?function } 4011 * @syscap SystemCapability.ArkUI.ArkUI.Full 4012 * @crossplatform 4013 * @form 4014 * @since 10 4015 */ 4016 /** 4017 * Callback invoked when the animation playback is complete. 4018 * 4019 * @type { ?function } 4020 * @syscap SystemCapability.ArkUI.ArkUI.Full 4021 * @crossplatform 4022 * @form 4023 * @atomicservice 4024 * @since arkts {'1.1':'11','1.2':'20'} 4025 * @arkts 1.1&1.2 4026 */ 4027 onFinish?: () => void; 4028 4029 /** 4030 * Type of the **onFinish** callback. 4031 * 4032 * @type { ?FinishCallbackType } 4033 * @syscap SystemCapability.ArkUI.ArkUI.Full 4034 * @crossplatform 4035 * @form 4036 * @since 11 4037 */ 4038 /** 4039 * Type of the **onFinish** callback. 4040 * Default value: FinishCallbackType.REMOVED. 4041 * 4042 * @type { ?FinishCallbackType } 4043 * @syscap SystemCapability.ArkUI.ArkUI.Full 4044 * @crossplatform 4045 * @form 4046 * @atomicservice 4047 * @since arkts {'1.1':'12','1.2':'20'} 4048 * @arkts 1.1&1.2 4049 */ 4050 finishCallbackType?: FinishCallbackType; 4051 4052 /** 4053 * Expected frame rate range of the animation. 4054 * 4055 * @type { ?ExpectedFrameRateRange } 4056 * @syscap SystemCapability.ArkUI.ArkUI.Full 4057 * @since 11 4058 */ 4059 /** 4060 * Expected frame rate range of the animation. 4061 * 4062 * @type { ?ExpectedFrameRateRange } 4063 * @syscap SystemCapability.ArkUI.ArkUI.Full 4064 * @atomicservice 4065 * @since arkts {'1.1':'12','1.2':'20'} 4066 * @arkts 1.1&1.2 4067 */ 4068 expectedFrameRateRange?: ExpectedFrameRateRange; 4069} 4070 4071/** 4072 * Interface for curve object. 4073 * 4074 * @interface ICurve 4075 * @syscap SystemCapability.ArkUI.ArkUI.Full 4076 * @form 4077 * @since 9 4078 */ 4079/** 4080 * Interface for curve object. 4081 * 4082 * @interface ICurve 4083 * @syscap SystemCapability.ArkUI.ArkUI.Full 4084 * @crossplatform 4085 * @form 4086 * @since 10 4087 */ 4088/** 4089 * Interface for curve object. 4090 * 4091 * @interface ICurve 4092 * @syscap SystemCapability.ArkUI.ArkUI.Full 4093 * @crossplatform 4094 * @form 4095 * @atomicservice 4096 * @since arkts {'1.1':'11','1.2':'20'} 4097 * @arkts 1.1&1.2 4098 */ 4099interface ICurve { 4100 /** 4101 * Implements calculation. 4102 * 4103 * @param { number } fraction - Current normalized time. Value range: [0, 1]. 4104 * <p>**NOTE**: 4105 * <br>A value less than 0 is handed as **0**. A value greater than 1 is handed as **1**. 4106 * </p> 4107 * @returns { number } 4108 * @syscap SystemCapability.ArkUI.ArkUI.Full 4109 * @form 4110 * @since 9 4111 */ 4112 /** 4113 * Implements calculation. 4114 * 4115 * @param { number } fraction - Current normalized time. Value range: [0, 1]. 4116 * <p>**NOTE**: 4117 * <br>A value less than 0 is handed as **0**. A value greater than 1 is handed as **1**. 4118 * </p> 4119 * @returns { number } 4120 * @syscap SystemCapability.ArkUI.ArkUI.Full 4121 * @crossplatform 4122 * @form 4123 * @since 10 4124 */ 4125 /** 4126 * Implements calculation. 4127 * 4128 * @param { number } fraction - Current normalized time. Value range: [0, 1]. 4129 * <p>**NOTE**: 4130 * <br>A value less than 0 is handed as **0**. A value greater than 1 is handed as **1**. 4131 * </p> 4132 * @returns { number } 4133 * @syscap SystemCapability.ArkUI.ArkUI.Full 4134 * @crossplatform 4135 * @form 4136 * @atomicservice 4137 * @since arkts {'1.1':'11','1.2':'20'} 4138 * @arkts 1.1&1.2 4139 */ 4140 interpolate(fraction: number): number; 4141} 4142 4143/** 4144 * Defines the motion path options. 4145 * 4146 * @interface MotionPathOptions 4147 * @syscap SystemCapability.ArkUI.ArkUI.Full 4148 * @since 7 4149 */ 4150/** 4151 * Defines the motion path options. 4152 * 4153 * @interface MotionPathOptions 4154 * @syscap SystemCapability.ArkUI.ArkUI.Full 4155 * @crossplatform 4156 * @since 10 4157 */ 4158/** 4159 * Defines the motion path options. 4160 * 4161 * @interface MotionPathOptions 4162 * @syscap SystemCapability.ArkUI.ArkUI.Full 4163 * @crossplatform 4164 * @atomicservice 4165 * @since arkts {'1.1':'11','1.2':'20'} 4166 * @arkts 1.1&1.2 4167 */ 4168declare interface MotionPathOptions { 4169 /** 4170 * Motion path of the translation animation. 4171 * The **svg** path string is used. 4172 * In the value, **start** and **end** can be used in place of the start point and end point, 4173 * for example, **'Mstart.x start.y L50 50 Lend.x end.y Z'**. 4174 * If this parameter is set to an empty string, the path animation is not set. 4175 * 4176 * @type { string } 4177 * @syscap SystemCapability.ArkUI.ArkUI.Full 4178 * @since 7 4179 */ 4180 /** 4181 * Motion path of the translation animation. 4182 * The **svg** path string is used. 4183 * In the value, **start** and **end** can be used in place of the start point and end point, 4184 * for example, **'Mstart.x start.y L50 50 Lend.x end.y Z'**. 4185 * If this parameter is set to an empty string, the path animation is not set. 4186 * 4187 * @type { string } 4188 * @syscap SystemCapability.ArkUI.ArkUI.Full 4189 * @crossplatform 4190 * @since 10 4191 */ 4192 /** 4193 * Motion path of the translation animation. 4194 * The **svg** path string is used. 4195 * In the value, **start** and **end** can be used in place of the start point and end point, 4196 * for example, **'Mstart.x start.y L50 50 Lend.x end.y Z'**. 4197 * If this parameter is set to an empty string, the path animation is not set. 4198 * 4199 * @type { string } 4200 * @syscap SystemCapability.ArkUI.ArkUI.Full 4201 * @crossplatform 4202 * @atomicservice 4203 * @since arkts {'1.1':'11','1.2':'20'} 4204 * @arkts 1.1&1.2 4205 */ 4206 path: string; 4207 4208 /** 4209 * Start point of the motion path. 4210 * Value range: [0, 1]. 4211 * A value less than 0 or greater than 1 evaluates to the default value **0**. 4212 * 4213 * @type { ?number } 4214 * @default 0.0 4215 * @syscap SystemCapability.ArkUI.ArkUI.Full 4216 * @since 7 4217 */ 4218 /** 4219 * Start point of the motion path. 4220 * Value range: [0, 1]. 4221 * A value less than 0 or greater than 1 evaluates to the default value **0**. 4222 * 4223 * @type { ?number } 4224 * @default 0.0 4225 * @syscap SystemCapability.ArkUI.ArkUI.Full 4226 * @crossplatform 4227 * @since 10 4228 */ 4229 /** 4230 * Start point of the motion path. 4231 * Value range: [0, 1]. 4232 * A value less than 0 or greater than 1 evaluates to the default value **0**. 4233 * 4234 * @type { ?number } 4235 * @default 0.0 4236 * @syscap SystemCapability.ArkUI.ArkUI.Full 4237 * @crossplatform 4238 * @atomicservice 4239 * @since arkts {'1.1':'11','1.2':'20'} 4240 * @arkts 1.1&1.2 4241 */ 4242 from?: number; 4243 4244 /** 4245 * End point of the motion path. 4246 * Value range: [0, 1]. 4247 * A value less than 0 or greater than 1 evaluates to the default value **1**, 4248 * provided that the value of **to** is greater than or equal to the value of **from**. 4249 * 4250 * @type { ?number } 4251 * @default 1.0 4252 * @syscap SystemCapability.ArkUI.ArkUI.Full 4253 * @since 7 4254 */ 4255 /** 4256 * End point of the motion path. 4257 * Value range: [0, 1]. 4258 * A value less than 0 or greater than 1 evaluates to the default value **1**, 4259 * provided that the value of **to** is greater than or equal to the value of **from**. 4260 * 4261 * @type { ?number } 4262 * @default 1.0 4263 * @syscap SystemCapability.ArkUI.ArkUI.Full 4264 * @crossplatform 4265 * @since 10 4266 */ 4267 /** 4268 * End point of the motion path. 4269 * Value range: [0, 1]. 4270 * A value less than 0 or greater than 1 evaluates to the default value **1**, 4271 * provided that the value of **to** is greater than or equal to the value of **from**. 4272 * 4273 * @type { ?number } 4274 * @default 1.0 4275 * @syscap SystemCapability.ArkUI.ArkUI.Full 4276 * @crossplatform 4277 * @atomicservice 4278 * @since arkts {'1.1':'11','1.2':'20'} 4279 * @arkts 1.1&1.2 4280 */ 4281 to?: number; 4282 4283 /** 4284 * Whether to rotate along the path. 4285 * 4286 * @type { ?boolean } 4287 * @default false 4288 * @syscap SystemCapability.ArkUI.ArkUI.Full 4289 * @since 7 4290 */ 4291 /** 4292 * Whether to rotate along the path. 4293 * 4294 * @type { ?boolean } 4295 * @default false 4296 * @syscap SystemCapability.ArkUI.ArkUI.Full 4297 * @crossplatform 4298 * @since 10 4299 */ 4300 /** 4301 * Whether to rotate along the path. 4302 * 4303 * @type { ?boolean } 4304 * @default false 4305 * @syscap SystemCapability.ArkUI.ArkUI.Full 4306 * @crossplatform 4307 * @atomicservice 4308 * @since arkts {'1.1':'11','1.2':'20'} 4309 * @arkts 1.1&1.2 4310 */ 4311 rotatable?: boolean; 4312} 4313 4314/** 4315 * Defines the shard transition function params. 4316 * 4317 * @interface sharedTransitionOptions 4318 * @syscap SystemCapability.ArkUI.ArkUI.Full 4319 * @since 7 4320 */ 4321/** 4322 * Defines the shard transition function params. 4323 * 4324 * @interface sharedTransitionOptions 4325 * @syscap SystemCapability.ArkUI.ArkUI.Full 4326 * @crossplatform 4327 * @since 10 4328 */ 4329/** 4330 * Defines the shard transition function params. 4331 * 4332 * @interface sharedTransitionOptions 4333 * @syscap SystemCapability.ArkUI.ArkUI.Full 4334 * @crossplatform 4335 * @atomicservice 4336 * @since arkts {'1.1':'11','1.2':'20'} 4337 * @arkts 1.1&1.2 4338 */ 4339declare interface sharedTransitionOptions { 4340 /** 4341 * Animation duration, in ms. 4342 * 4343 * @type { ?number } 4344 * @default 1000 4345 * @syscap SystemCapability.ArkUI.ArkUI.Full 4346 * @since 7 4347 */ 4348 /** 4349 * Animation duration. 4350 * <br>Default value: **1000**. 4351 * <br>Unit: ms. 4352 * <br>Value range: [0, +∞). 4353 * 4354 * @type { ?number } 4355 * @default 1000 4356 * @syscap SystemCapability.ArkUI.ArkUI.Full 4357 * @crossplatform 4358 * @since 10 4359 */ 4360 /** 4361 * Animation duration. 4362 * <br>Default value: **1000**. 4363 * <br>Unit: ms. 4364 * <br>Value range: [0, +∞). 4365 * 4366 * @type { ?number } 4367 * @default 1000 4368 * @syscap SystemCapability.ArkUI.ArkUI.Full 4369 * @crossplatform 4370 * @atomicservice 4371 * @since arkts {'1.1':'11','1.2':'20'} 4372 * @arkts 1.1&1.2 4373 */ 4374 duration?: number; 4375 4376 /** 4377 * Animation curve.<br>You are advised to specify the curve using the Curve or ICurve type. 4378 * 4379 * @type { ?(Curve | string | ICurve) } 4380 * @syscap SystemCapability.ArkUI.ArkUI.Full 4381 * @since 7 4382 */ 4383 /** 4384 * Animation curve.<br>You are advised to specify the curve using the **Curve** or 4385 * ** ICurve** type.<br>For the string type, this parameter indicates an animation 4386 * interpolation curve. For available values, see the **curve** parameter in 4387 * AnimateParam. 4388 * <br>Default value: **Curve.Linear**. 4389 * 4390 * @type { ?(Curve | string | ICurve) } 4391 * @syscap SystemCapability.ArkUI.ArkUI.Full 4392 * @crossplatform 4393 * @since 10 4394 */ 4395 /** 4396 * Animation curve.<br>You are advised to specify the curve using the **Curve** or 4397 * ** ICurve** type.<br>For the string type, this parameter indicates an animation 4398 * interpolation curve. For available values, see the **curve** parameter in 4399 * AnimateParam. 4400 * <br>Default value: **Curve.Linear**. 4401 * 4402 * @type { ?(Curve | string | ICurve) } 4403 * @syscap SystemCapability.ArkUI.ArkUI.Full 4404 * @crossplatform 4405 * @atomicservice 4406 * @since arkts {'1.1':'11','1.2':'20'} 4407 * @arkts 1.1&1.2 4408 */ 4409 curve?: Curve | string | ICurve; 4410 4411 /** 4412 * Animation playback mode. By default, the animation is played from the beginning after the playback is complete. 4413 * 4414 * @type { ?number } 4415 * @default 0 4416 * @syscap SystemCapability.ArkUI.ArkUI.Full 4417 * @since 7 4418 */ 4419 /** 4420 * Animation delay time, in ms. 4421 * 4422 * @type { ?number } 4423 * @default 0 4424 * @syscap SystemCapability.ArkUI.ArkUI.Full 4425 * @crossplatform 4426 * @since 10 4427 */ 4428 /** 4429 * Animation delay time, in ms. 4430 * 4431 * @type { ?number } 4432 * @default 0 4433 * @syscap SystemCapability.ArkUI.ArkUI.Full 4434 * @crossplatform 4435 * @atomicservice 4436 * @since arkts {'1.1':'11','1.2':'20'} 4437 * @arkts 1.1&1.2 4438 */ 4439 delay?: number; 4440 4441 /** 4442 * The motion path info. 4443 * 4444 * @type { ?MotionPathOptions } 4445 * @syscap SystemCapability.ArkUI.ArkUI.Full 4446 * @since 7 4447 */ 4448 /** 4449 * The motion path info. 4450 * 4451 * @type { ?MotionPathOptions } 4452 * @syscap SystemCapability.ArkUI.ArkUI.Full 4453 * @crossplatform 4454 * @since 10 4455 */ 4456 /** 4457 * The motion path info. 4458 * 4459 * @type { ?MotionPathOptions } 4460 * @syscap SystemCapability.ArkUI.ArkUI.Full 4461 * @crossplatform 4462 * @atomicservice 4463 * @since arkts {'1.1':'11','1.2':'20'} 4464 * @arkts 1.1&1.2 4465 */ 4466 motionPath?: MotionPathOptions; 4467 4468 /** 4469 * Z index info. 4470 * 4471 * @type { ?number } 4472 * @syscap SystemCapability.ArkUI.ArkUI.Full 4473 * @since 7 4474 */ 4475 /** 4476 * Z index info. 4477 * 4478 * @type { ?number } 4479 * @syscap SystemCapability.ArkUI.ArkUI.Full 4480 * @crossplatform 4481 * @since 10 4482 */ 4483 /** 4484 * Z index info. 4485 * 4486 * @type { ?number } 4487 * @syscap SystemCapability.ArkUI.ArkUI.Full 4488 * @crossplatform 4489 * @atomicservice 4490 * @since arkts {'1.1':'11','1.2':'20'} 4491 * @arkts 1.1&1.2 4492 */ 4493 zIndex?: number; 4494 4495 /** 4496 * the animate type. 4497 * 4498 * @type { ?SharedTransitionEffectType } 4499 * @default SharedTransitionEffectType.Exchange 4500 * @syscap SystemCapability.ArkUI.ArkUI.Full 4501 * @since 7 4502 */ 4503 /** 4504 * the animate type. 4505 * 4506 * @type { ?SharedTransitionEffectType } 4507 * @default SharedTransitionEffectType.Exchange 4508 * @syscap SystemCapability.ArkUI.ArkUI.Full 4509 * @crossplatform 4510 * @since 10 4511 */ 4512 /** 4513 * the animate type. 4514 * 4515 * @type { ?SharedTransitionEffectType } 4516 * @default SharedTransitionEffectType.Exchange 4517 * @syscap SystemCapability.ArkUI.ArkUI.Full 4518 * @crossplatform 4519 * @atomicservice 4520 * @since arkts {'1.1':'11','1.2':'20'} 4521 * @arkts 1.1&1.2 4522 */ 4523 type?: SharedTransitionEffectType; 4524} 4525 4526/** 4527 * Defines the options of geometry transition. 4528 * 4529 * @interface GeometryTransitionOptions 4530 * @syscap SystemCapability.ArkUI.ArkUI.Full 4531 * @crossplatform 4532 * @since 11 4533 */ 4534/** 4535 * Defines the options of geometry transition. 4536 * 4537 * @interface GeometryTransitionOptions 4538 * @syscap SystemCapability.ArkUI.ArkUI.Full 4539 * @crossplatform 4540 * @atomicservice 4541 * @since arkts {'1.1':'12','1.2':'20'} 4542 * @arkts 1.1&1.2 4543 */ 4544declare interface GeometryTransitionOptions { 4545 /** 4546 * whether follow target for the component still in the hierarchy, default: false, stay current. 4547 * 4548 * @type { ?boolean } 4549 * @default false 4550 * @syscap SystemCapability.ArkUI.ArkUI.Full 4551 * @crossplatform 4552 * @since 11 4553 */ 4554 /** 4555 * whether follow target for the component still in the hierarchy, default: false, stay current. 4556 * 4557 * @type { ?boolean } 4558 * @default false 4559 * @syscap SystemCapability.ArkUI.ArkUI.Full 4560 * @crossplatform 4561 * @atomicservice 4562 * @since arkts {'1.1':'12','1.2':'20'} 4563 * @arkts 1.1&1.2 4564 */ 4565 follow?: boolean; 4566 /** 4567 * Defines movement strategy of source and target in the hierarchy during geometry transition. 4568 * 4569 * @type { ?TransitionHierarchyStrategy } 4570 * @default TransitionHierarchyStrategy.ADAPTIVE 4571 * @syscap SystemCapability.ArkUI.ArkUI.Full 4572 * @systemapi 4573 * @atomicservice 4574 * @since 12 4575 */ 4576 /** 4577 * Defines movement strategy of source and target in the hierarchy during geometry transition. 4578 * 4579 * @type { ?TransitionHierarchyStrategy } 4580 * @default TransitionHierarchyStrategy.ADAPTIVE 4581 * @syscap SystemCapability.ArkUI.ArkUI.Full 4582 * @systemapi 4583 * @since arkts {'1.1':'13','1.2':'20'} 4584 * @arkts 1.1&1.2 4585 */ 4586 hierarchyStrategy?: TransitionHierarchyStrategy 4587} 4588 4589/** 4590 * Defines the options of linear gradient. 4591 * 4592 * @interface LinearGradientOptions 4593 * @syscap SystemCapability.ArkUI.ArkUI.Full 4594 * @crossplatform 4595 * @form 4596 * @atomicservice 4597 * @since arkts {'1.1':'18','1.2':'20'} 4598 * @arkts 1.1&1.2 4599 */ 4600declare interface LinearGradientOptions { 4601 /** 4602 * angle: Angle of Linear Gradient. The default value is 180; 4603 * 4604 * @type { ?(number | string) } 4605 * @syscap SystemCapability.ArkUI.ArkUI.Full 4606 * @since 7 4607 */ 4608 /** 4609 * angle: Angle of Linear Gradient. The default value is 180; 4610 * 4611 * @type { ?(number | string) } 4612 * @syscap SystemCapability.ArkUI.ArkUI.Full 4613 * @form 4614 * @since 9 4615 */ 4616 /** 4617 * angle: Angle of Linear Gradient. The default value is 180; 4618 * 4619 * @type { ?(number | string) } 4620 * @syscap SystemCapability.ArkUI.ArkUI.Full 4621 * @crossplatform 4622 * @form 4623 * @since 10 4624 */ 4625 /** 4626 * angle: Angle of Linear Gradient. The default value is 180; 4627 * 4628 * @type { ?(number | string) } 4629 * @syscap SystemCapability.ArkUI.ArkUI.Full 4630 * @crossplatform 4631 * @form 4632 * @atomicservice 4633 * @since 11 4634 */ 4635 /** 4636 * angle: Angle of Linear Gradient. The default value is 180; 4637 * 4638 * @type { ?(number | string) } 4639 * @syscap SystemCapability.ArkUI.ArkUI.Full 4640 * @crossplatform 4641 * @form 4642 * @atomicservice 4643 * @since 12 4644 */ 4645 /** 4646 * Defines starting angle of linear gradient. 4647 * 4648 * Anonymous Object Rectification. 4649 * @type { ?(number | string) } 4650 * @default 180 4651 * @syscap SystemCapability.ArkUI.ArkUI.Full 4652 * @crossplatform 4653 * @form 4654 * @atomicservice 4655 * @since arkts {'1.1':'18','1.2':'20'} 4656 * @arkts 1.1&1.2 4657 */ 4658 angle?: number | string; 4659 4660 /** 4661 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 4662 * 4663 * @type { ?GradientDirection } 4664 * @syscap SystemCapability.ArkUI.ArkUI.Full 4665 * @since 7 4666 */ 4667 /** 4668 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 4669 * 4670 * @type { ?GradientDirection } 4671 * @syscap SystemCapability.ArkUI.ArkUI.Full 4672 * @form 4673 * @since 9 4674 */ 4675 /** 4676 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 4677 * 4678 * @type { ?GradientDirection } 4679 * @syscap SystemCapability.ArkUI.ArkUI.Full 4680 * @crossplatform 4681 * @form 4682 * @since 10 4683 */ 4684 /** 4685 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 4686 * 4687 * @type { ?GradientDirection } 4688 * @syscap SystemCapability.ArkUI.ArkUI.Full 4689 * @crossplatform 4690 * @form 4691 * @atomicservice 4692 * @since 11 4693 */ 4694 /** 4695 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 4696 * 4697 * @type { ?GradientDirection } 4698 * @syscap SystemCapability.ArkUI.ArkUI.Full 4699 * @crossplatform 4700 * @form 4701 * @atomicservice 4702 * @since 12 4703 */ 4704 /** 4705 * Defines the direction of linear gradient. 4706 * 4707 * Anonymous Object Rectification. 4708 * @type { ?GradientDirection } 4709 * @default GradientDirection.Bottom 4710 * @syscap SystemCapability.ArkUI.ArkUI.Full 4711 * @crossplatform 4712 * @form 4713 * @atomicservice 4714 * @since arkts {'1.1':'18','1.2':'20'} 4715 * @arkts 1.1&1.2 4716 */ 4717 direction?: GradientDirection; 4718 4719 /** 4720 * colors: Color description for gradients. 4721 * 4722 * @type { Array<[ResourceColor, number]> } 4723 * @syscap SystemCapability.ArkUI.ArkUI.Full 4724 * @since 7 4725 */ 4726 /** 4727 * colors: Color description for gradients. 4728 * 4729 * @type { Array<[ResourceColor, number]> } 4730 * @syscap SystemCapability.ArkUI.ArkUI.Full 4731 * @form 4732 * @since 9 4733 */ 4734 /** 4735 * colors: Color description for gradients. 4736 * 4737 * @type { Array<[ResourceColor, number]> } 4738 * @syscap SystemCapability.ArkUI.ArkUI.Full 4739 * @crossplatform 4740 * @form 4741 * @since 10 4742 */ 4743 /** 4744 * colors: Color description for gradients. 4745 * 4746 * @type { Array<[ResourceColor, number]> } 4747 * @syscap SystemCapability.ArkUI.ArkUI.Full 4748 * @crossplatform 4749 * @form 4750 * @atomicservice 4751 * @since 11 4752 */ 4753 /** 4754 * colors: Color description for gradients. 4755 * 4756 * @type { Array<[ResourceColor, number]> } 4757 * @syscap SystemCapability.ArkUI.ArkUI.Full 4758 * @crossplatform 4759 * @form 4760 * @atomicservice 4761 * @since 12 4762 */ 4763 /** 4764 * Defines color description for gradients. 4765 * 4766 * Anonymous Object Rectification. 4767 * @type { Array<[ResourceColor, number]> } 4768 * @syscap SystemCapability.ArkUI.ArkUI.Full 4769 * @crossplatform 4770 * @form 4771 * @atomicservice 4772 * @since arkts {'1.1':'18','1.2':'20'} 4773 * @arkts 1.1&1.2 4774 */ 4775 colors: Array<[ResourceColor, number]>; 4776 4777 /** 4778 * repeating: repeating. The default value is false 4779 * 4780 * @type { ?boolean } 4781 * @syscap SystemCapability.ArkUI.ArkUI.Full 4782 * @since 7 4783 */ 4784 /** 4785 * repeating: repeating. The default value is false 4786 * 4787 * @type { ?boolean } 4788 * @syscap SystemCapability.ArkUI.ArkUI.Full 4789 * @form 4790 * @since 9 4791 */ 4792 /** 4793 * repeating: repeating. The default value is false 4794 * 4795 * @type { ?boolean } 4796 * @syscap SystemCapability.ArkUI.ArkUI.Full 4797 * @crossplatform 4798 * @form 4799 * @since 10 4800 */ 4801 /** 4802 * repeating: repeating. The default value is false 4803 * 4804 * @type { ?boolean } 4805 * @syscap SystemCapability.ArkUI.ArkUI.Full 4806 * @crossplatform 4807 * @form 4808 * @atomicservice 4809 * @since 11 4810 */ 4811 /** 4812 * repeating: repeating. The default value is false 4813 * 4814 * @type { ?boolean } 4815 * @syscap SystemCapability.ArkUI.ArkUI.Full 4816 * @crossplatform 4817 * @form 4818 * @atomicservice 4819 * @since 12 4820 */ 4821 /** 4822 * Defines gradient colors with repeated coloring. 4823 * 4824 * Anonymous Object Rectification. 4825 * @type { ?boolean } 4826 * @default false 4827 * @syscap SystemCapability.ArkUI.ArkUI.Full 4828 * @crossplatform 4829 * @form 4830 * @atomicservice 4831 * @since arkts {'1.1':'18','1.2':'20'} 4832 * @arkts 1.1&1.2 4833 */ 4834 repeating?: boolean; 4835} 4836 4837/** 4838 * Defines the options of radial gradient. 4839 * 4840 * @interface SweepGradientOptions 4841 * @syscap SystemCapability.ArkUI.ArkUI.Full 4842 * @crossplatform 4843 * @form 4844 * @atomicservice 4845 * @since arkts {'1.1':'18','1.2':'20'} 4846 * @arkts 1.1&1.2 4847 */ 4848declare interface SweepGradientOptions { 4849 /** 4850 * center:is the center point of the angle gradient 4851 * 4852 * @type { [Length, Length] } 4853 * @syscap SystemCapability.ArkUI.ArkUI.Full 4854 * @since 7 4855 */ 4856 /** 4857 * center:is the center point of the angle gradient 4858 * 4859 * @type { [Length, Length] } 4860 * @syscap SystemCapability.ArkUI.ArkUI.Full 4861 * @form 4862 * @since 9 4863 */ 4864 /** 4865 * center:is the center point of the angle gradient 4866 * 4867 * @type { [Length, Length] } 4868 * @syscap SystemCapability.ArkUI.ArkUI.Full 4869 * @crossplatform 4870 * @form 4871 * @since 10 4872 */ 4873 /** 4874 * center:is the center point of the angle gradient 4875 * 4876 * @type { [Length, Length] } 4877 * @syscap SystemCapability.ArkUI.ArkUI.Full 4878 * @crossplatform 4879 * @form 4880 * @atomicservice 4881 * @since 11 4882 */ 4883 /** 4884 * center:is the center point of the angle gradient 4885 * 4886 * @type { [Length, Length] } 4887 * @syscap SystemCapability.ArkUI.ArkUI.Full 4888 * @crossplatform 4889 * @form 4890 * @atomicservice 4891 * @since 12 4892 */ 4893 /** 4894 * Defines center point for angle gradient. 4895 * 4896 * Anonymous Object Rectification. 4897 * @type { [Length, Length] } 4898 * @syscap SystemCapability.ArkUI.ArkUI.Full 4899 * @crossplatform 4900 * @form 4901 * @atomicservice 4902 * @since arkts {'1.1':'18','1.2':'20'} 4903 * @arkts 1.1&1.2 4904 */ 4905 center: [Length, Length]; 4906 4907 /** 4908 * start:Start point of angle gradient. The default value is 0 4909 * 4910 * @param { ?(number | string) } 4911 * @syscap SystemCapability.ArkUI.ArkUI.Full 4912 * @since 7 4913 */ 4914 /** 4915 * start:Start point of angle gradient. The default value is 0 4916 * 4917 * @type { ?(number | string) } 4918 * @syscap SystemCapability.ArkUI.ArkUI.Full 4919 * @form 4920 * @since 9 4921 */ 4922 /** 4923 * Angle Gradient 4924 * start:Start point of angle gradient. The default value is 0 4925 * 4926 * @type { ?(number | string) } 4927 * @syscap SystemCapability.ArkUI.ArkUI.Full 4928 * @crossplatform 4929 * @form 4930 * @since 10 4931 */ 4932 /** 4933 * start:Start point of angle gradient. The default value is 0 4934 * 4935 * @type { ?(number | string) } 4936 * @syscap SystemCapability.ArkUI.ArkUI.Full 4937 * @crossplatform 4938 * @form 4939 * @atomicservice 4940 * @since 11 4941 */ 4942 /** 4943 * start:Start point of angle gradient. The default value is 0 4944 * 4945 * @type { ?(number | string) } 4946 * @syscap SystemCapability.ArkUI.ArkUI.Full 4947 * @crossplatform 4948 * @form 4949 * @atomicservice 4950 * @since 12 4951 */ 4952 /** 4953 * Defines the starting point of angle gradient. 4954 * 4955 * Anonymous Object Rectification. 4956 * @type { ?(number | string) } 4957 * @default 0 4958 * @syscap SystemCapability.ArkUI.ArkUI.Full 4959 * @crossplatform 4960 * @form 4961 * @atomicservice 4962 * @since arkts {'1.1':'18','1.2':'20'} 4963 * @arkts 1.1&1.2 4964 */ 4965 start?: number | string; 4966 4967 /** 4968 * end:End point of angle gradient. The default value is 0 4969 * @type { ?(number | string) } 4970 * @syscap SystemCapability.ArkUI.ArkUI.Full 4971 * @since 7 4972 */ 4973 /** 4974 * end:End point of angle gradient. The default value is 0 4975 * 4976 * @type { ?(number | string) } 4977 * @syscap SystemCapability.ArkUI.ArkUI.Full 4978 * @form 4979 * @since 9 4980 */ 4981 /** 4982 * end:End point of angle gradient. The default value is 0 4983 * 4984 * @type { ?(number | string) } 4985 * @syscap SystemCapability.ArkUI.ArkUI.Full 4986 * @crossplatform 4987 * @form 4988 * @since 10 4989 */ 4990 /** 4991 * end:End point of angle gradient. The default value is 0 4992 * 4993 * @type { ?(number | string) } 4994 * @syscap SystemCapability.ArkUI.ArkUI.Full 4995 * @crossplatform 4996 * @form 4997 * @atomicservice 4998 * @since 11 4999 */ 5000 /** 5001 * end:End point of angle gradient. The default value is 0 5002 * 5003 * @type { ?(number | string) } 5004 * @syscap SystemCapability.ArkUI.ArkUI.Full 5005 * @crossplatform 5006 * @form 5007 * @atomicservice 5008 * @since 12 5009 */ 5010 /** 5011 * Defines end point of angle gradient. 5012 * 5013 * Anonymous Object Rectification. 5014 * @type { ?(number | string) } 5015 * @default 0 5016 * @syscap SystemCapability.ArkUI.ArkUI.Full 5017 * @crossplatform 5018 * @form 5019 * @atomicservice 5020 * @since arkts {'1.1':'18','1.2':'20'} 5021 * @arkts 1.1&1.2 5022 */ 5023 end?: number | string; 5024 5025 /** 5026 * rotating:rotating. The default value is 0 5027 * 5028 * @type { ?(number | string) } 5029 * @syscap SystemCapability.ArkUI.ArkUI.Full 5030 * @since 7 5031 */ 5032 /** 5033 * rotating:rotating. The default value is 0 5034 * 5035 * @type { ?(number | string) } 5036 * @syscap SystemCapability.ArkUI.ArkUI.Full 5037 * @form 5038 * @since 9 5039 */ 5040 /** 5041 * rotating:rotating. The default value is 0 5042 * 5043 * @type { ?(number | string) } 5044 * @syscap SystemCapability.ArkUI.ArkUI.Full 5045 * @crossplatform 5046 * @form 5047 * @since 10 5048 */ 5049 /** 5050 * rotating:rotating. The default value is 0 5051 * 5052 * @type { ?(number | string) } 5053 * @syscap SystemCapability.ArkUI.ArkUI.Full 5054 * @crossplatform 5055 * @form 5056 * @atomicservice 5057 * @since 11 5058 */ 5059 /** 5060 * rotating:rotating. The default value is 0 5061 * 5062 * @type { ?(number | string) } 5063 * @syscap SystemCapability.ArkUI.ArkUI.Full 5064 * @crossplatform 5065 * @form 5066 * @atomicservice 5067 * @since 12 5068 */ 5069 /** 5070 * Defines the rotation angle of the gradient. 5071 * 5072 * Anonymous Object Rectification. 5073 * @type { ?(number | string) } 5074 * @default 0 5075 * @syscap SystemCapability.ArkUI.ArkUI.Full 5076 * @crossplatform 5077 * @form 5078 * @atomicservice 5079 * @since arkts {'1.1':'18','1.2':'20'} 5080 * @arkts 1.1&1.2 5081 */ 5082 rotation?: number | string; 5083 5084 /** 5085 * colors:Color description for gradients 5086 * 5087 * @type { Array<[ResourceColor, number]> } 5088 * @syscap SystemCapability.ArkUI.ArkUI.Full 5089 * @since 7 5090 */ 5091 /** 5092 * colors:Color description for gradients 5093 * 5094 * @type { Array<[ResourceColor, number]> } 5095 * @syscap SystemCapability.ArkUI.ArkUI.Full 5096 * @form 5097 * @since 9 5098 */ 5099 /** 5100 * colors:Color description for gradients 5101 * 5102 * @type { Array<[ResourceColor, number]> } 5103 * @syscap SystemCapability.ArkUI.ArkUI.Full 5104 * @crossplatform 5105 * @form 5106 * @since 10 5107 */ 5108 /** 5109 * colors:Color description for gradients 5110 * 5111 * @type { Array<[ResourceColor, number]> } 5112 * @syscap SystemCapability.ArkUI.ArkUI.Full 5113 * @crossplatform 5114 * @form 5115 * @atomicservice 5116 * @since 11 5117 */ 5118 /** 5119 * colors:Color description for gradients 5120 * 5121 * @type { Array<[ResourceColor, number]> } 5122 * @syscap SystemCapability.ArkUI.ArkUI.Full 5123 * @crossplatform 5124 * @form 5125 * @atomicservice 5126 * @since 12 5127 */ 5128 /** 5129 * Defines color description for gradients. 5130 * 5131 * Anonymous Object Rectification. 5132 * @type { Array<[ResourceColor, number]> } 5133 * @syscap SystemCapability.ArkUI.ArkUI.Full 5134 * @crossplatform 5135 * @form 5136 * @atomicservice 5137 * @since arkts {'1.1':'18','1.2':'20'} 5138 * @arkts 1.1&1.2 5139 */ 5140 colors: Array<[ResourceColor, number]>; 5141 5142 /** 5143 * Defines color description in ColorMetrics format for gradients. 5144 * This parameter takes precedence over colors parameter. 5145 * 5146 * @type { ?Array<[ColorMetrics, number]> } 5147 * @syscap SystemCapability.ArkUI.ArkUI.Full 5148 * @crossplatform 5149 * @atomicservice 5150 * @since 20 5151 */ 5152 metricsColors?: Array<[ColorMetrics, number]>; 5153 5154 /** 5155 * repeating:repeating. The default value is false 5156 * 5157 * @type { ?boolean } 5158 * @syscap SystemCapability.ArkUI.ArkUI.Full 5159 * @since 7 5160 */ 5161 /** 5162 * repeating:repeating. The default value is false 5163 * 5164 * @type { ?boolean } 5165 * @syscap SystemCapability.ArkUI.ArkUI.Full 5166 * @form 5167 * @since 9 5168 */ 5169 /** 5170 * repeating:repeating. The default value is false 5171 * 5172 * @type { ?boolean } 5173 * @syscap SystemCapability.ArkUI.ArkUI.Full 5174 * @crossplatform 5175 * @form 5176 * @since 10 5177 */ 5178 /** 5179 * repeating:repeating. The default value is false 5180 * 5181 * @type { ?boolean } 5182 * @syscap SystemCapability.ArkUI.ArkUI.Full 5183 * @crossplatform 5184 * @form 5185 * @atomicservice 5186 * @since 11 5187 */ 5188 /** 5189 * repeating:repeating. The default value is false 5190 * 5191 * @type { ?boolean } 5192 * @syscap SystemCapability.ArkUI.ArkUI.Full 5193 * @crossplatform 5194 * @form 5195 * @atomicservice 5196 * @since 12 5197 */ 5198 /** 5199 * Defines gradient colors with repeated coloring. 5200 * 5201 * Anonymous Object Rectification. 5202 * @type { ?boolean } 5203 * @default false 5204 * @syscap SystemCapability.ArkUI.ArkUI.Full 5205 * @crossplatform 5206 * @form 5207 * @atomicservice 5208 * @since arkts {'1.1':'18','1.2':'20'} 5209 * @arkts 1.1&1.2 5210 */ 5211 repeating?: boolean; 5212} 5213 5214/** 5215 * Defines the options of radial gradient. 5216 * 5217 * @interface RadialGradientOptions 5218 * @syscap SystemCapability.ArkUI.ArkUI.Full 5219 * @crossplatform 5220 * @form 5221 * @atomicservice 5222 * @since arkts {'1.1':'18','1.2':'20'} 5223 * @arkts 1.1&1.2 5224 */ 5225declare interface RadialGradientOptions { 5226 /** 5227 * center:Center point of radial gradient 5228 * 5229 * @type { [Length, Length] } 5230 * @syscap SystemCapability.ArkUI.ArkUI.Full 5231 * @since 7 5232 */ 5233 /** 5234 * center:Center point of radial gradient 5235 * 5236 * @type { [Length, Length] } 5237 * @syscap SystemCapability.ArkUI.ArkUI.Full 5238 * @form 5239 * @since 9 5240 */ 5241 /** 5242 * center:Center point of radial gradient 5243 * 5244 * @type { [Length, Length] } 5245 * @syscap SystemCapability.ArkUI.ArkUI.Full 5246 * @crossplatform 5247 * @form 5248 * @since 10 5249 */ 5250 /** 5251 * center:Center point of radial gradient 5252 * 5253 * @type { [Length, Length] } 5254 * @syscap SystemCapability.ArkUI.ArkUI.Full 5255 * @crossplatform 5256 * @form 5257 * @atomicservice 5258 * @since 11 5259 */ 5260 /** 5261 * center:Center point of radial gradient 5262 * 5263 * @type { [Length, Length] } 5264 * @syscap SystemCapability.ArkUI.ArkUI.Full 5265 * @crossplatform 5266 * @form 5267 * @atomicservice 5268 * @since 12 5269 */ 5270 /** 5271 * Defines center point for radial gradient. 5272 * 5273 * Anonymous Object Rectification. 5274 * @type { [Length, Length] } 5275 * @syscap SystemCapability.ArkUI.ArkUI.Full 5276 * @crossplatform 5277 * @form 5278 * @atomicservice 5279 * @since arkts {'1.1':'18','1.2':'20'} 5280 * @arkts 1.1&1.2 5281 */ 5282 center: [Length, Length]; 5283 5284 /** 5285 * radius:Radius of Radial Gradient. value range [0, +∞) 5286 * 5287 * @type { number | string } 5288 * @syscap SystemCapability.ArkUI.ArkUI.Full 5289 * @since 7 5290 */ 5291 /** 5292 * radius:Radius of Radial Gradient. value range [0, +∞) 5293 * 5294 * @type { number | string } 5295 * @syscap SystemCapability.ArkUI.ArkUI.Full 5296 * @form 5297 * @since 9 5298 */ 5299 /** 5300 * radius:Radius of Radial Gradient. value range [0, +∞) 5301 * 5302 * @type { number | string } 5303 * @syscap SystemCapability.ArkUI.ArkUI.Full 5304 * @crossplatform 5305 * @form 5306 * @since 10 5307 */ 5308 /** 5309 * radius:Radius of Radial Gradient. value range [0, +∞) 5310 * 5311 * @type { number | string } 5312 * @syscap SystemCapability.ArkUI.ArkUI.Full 5313 * @crossplatform 5314 * @form 5315 * @atomicservice 5316 * @since 11 5317 */ 5318 /** 5319 * radius:Radius of Radial Gradient. value range [0, +∞) 5320 * 5321 * @type { number | string } 5322 * @syscap SystemCapability.ArkUI.ArkUI.Full 5323 * @crossplatform 5324 * @form 5325 * @atomicservice 5326 * @since 12 5327 */ 5328 /** 5329 * Defines radius of the radial gradient. 5330 * 5331 * Anonymous Object Rectification. 5332 * @type { Length } 5333 * @syscap SystemCapability.ArkUI.ArkUI.Full 5334 * @crossplatform 5335 * @form 5336 * @atomicservice 5337 * @since arkts {'1.1':'18','1.2':'20'} 5338 * @arkts 1.1&1.2 5339 */ 5340 radius: Length; 5341 5342 /** 5343 * colors:Color description for gradients 5344 * 5345 * @type { Array<[ResourceColor, number]> } 5346 * @syscap SystemCapability.ArkUI.ArkUI.Full 5347 * @since 7 5348 */ 5349 /** 5350 * colors:Color description for gradients 5351 * 5352 * @type { Array<[ResourceColor, number]> } 5353 * @syscap SystemCapability.ArkUI.ArkUI.Full 5354 * @form 5355 * @since 9 5356 */ 5357 /** 5358 * colors:Color description for gradients 5359 * 5360 * @type { Array<[ResourceColor, number]> } 5361 * @syscap SystemCapability.ArkUI.ArkUI.Full 5362 * @crossplatform 5363 * @form 5364 * @since 10 5365 */ 5366 /** 5367 * colors:Color description for gradients 5368 * 5369 * @type { Array<[ResourceColor, number]> } 5370 * @syscap SystemCapability.ArkUI.ArkUI.Full 5371 * @crossplatform 5372 * @form 5373 * @atomicservice 5374 * @since 11 5375 */ 5376 /** 5377 * colors:Color description for gradients 5378 * 5379 * @type { Array<[ResourceColor, number]> } 5380 * @syscap SystemCapability.ArkUI.ArkUI.Full 5381 * @crossplatform 5382 * @form 5383 * @atomicservice 5384 * @since 12 5385 */ 5386 /** 5387 * Defines color description for gradients. 5388 * 5389 * Anonymous Object Rectification. 5390 * @type { Array<[ResourceColor, number]> } 5391 * @syscap SystemCapability.ArkUI.ArkUI.Full 5392 * @crossplatform 5393 * @form 5394 * @atomicservice 5395 * @since arkts {'1.1':'18','1.2':'20'} 5396 * @arkts 1.1&1.2 5397 */ 5398 colors: Array<[ResourceColor, number]>; 5399 5400 /** 5401 * repeating: Refill. The default value is false 5402 * 5403 * @type { ?boolean } value 5404 * @syscap SystemCapability.ArkUI.ArkUI.Full 5405 * @since 7 5406 */ 5407 /** 5408 * repeating: Refill. The default value is false 5409 * 5410 * @type { ?boolean } value 5411 * @syscap SystemCapability.ArkUI.ArkUI.Full 5412 * @form 5413 * @since 9 5414 */ 5415 /** 5416 * repeating: Refill. The default value is false 5417 * 5418 * @type { ?boolean } value 5419 * @syscap SystemCapability.ArkUI.ArkUI.Full 5420 * @crossplatform 5421 * @form 5422 * @since 10 5423 */ 5424 /** 5425 * repeating: Refill. The default value is false 5426 * 5427 * @type { ?boolean } value 5428 * @syscap SystemCapability.ArkUI.ArkUI.Full 5429 * @crossplatform 5430 * @form 5431 * @atomicservice 5432 * @since 11 5433 */ 5434 /** 5435 * repeating: Refill. The default value is false 5436 * 5437 * @type { ?boolean } 5438 * @syscap SystemCapability.ArkUI.ArkUI.Full 5439 * @crossplatform 5440 * @form 5441 * @atomicservice 5442 * @since 12 5443 */ 5444 /** 5445 * Defines gradient colors with repeated coloring. 5446 * 5447 * Anonymous Object Rectification. 5448 * @type { ?boolean } 5449 * @default false 5450 * @syscap SystemCapability.ArkUI.ArkUI.Full 5451 * @crossplatform 5452 * @form 5453 * @atomicservice 5454 * @since arkts {'1.1':'18','1.2':'20'} 5455 * @arkts 1.1&1.2 5456 */ 5457 repeating?: boolean; 5458} 5459 5460/** 5461 * Source and target are two matched elements during the geometry transition. 5462 * The animation starts at the source and ends at the target. 5463 * TransitionHierarchyStrategy enumeration defines how levels of source and target elements 5464 * would be changed in the hierarchy during the geometry transition. 5465 * 5466 * @enum { number } 5467 * @syscap SystemCapability.ArkUI.ArkUI.Full 5468 * @systemapi 5469 * @atomicservice 5470 * @since 12 5471 */ 5472/** 5473 * Source and target are two matched elements during the geometry transition. 5474 * The animation starts at the source and ends at the target. 5475 * TransitionHierarchyStrategy enumeration defines how levels of source and target elements 5476 * would be changed in the hierarchy during the geometry transition. 5477 * 5478 * @enum { number } 5479 * @syscap SystemCapability.ArkUI.ArkUI.Full 5480 * @systemapi 5481 * @since arkts {'1.1':'13','1.2':'20'} 5482 * @arkts 1.1&1.2 5483 */ 5484declare enum TransitionHierarchyStrategy { 5485 /** 5486 * None mode. 5487 * Source and target staty in the original level in the hierarchy during geometry transition. 5488 * 5489 * @syscap SystemCapability.ArkUI.ArkUI.Full 5490 * @systemapi 5491 * @atomicservice 5492 * @since 12 5493 */ 5494 /** 5495 * None mode. 5496 * Source and target staty in the original level in the hierarchy during geometry transition. 5497 * 5498 * @syscap SystemCapability.ArkUI.ArkUI.Full 5499 * @systemapi 5500 * @since arkts {'1.1':'13','1.2':'20'} 5501 * @arkts 1.1&1.2 5502 */ 5503 NONE = 0, 5504 5505 /** 5506 * ADAPTIVE mode. 5507 * Lower level one of source and target is elevated to higher level of both, 5508 * indicating that two elements are in same high level. 5509 * 5510 * @syscap SystemCapability.ArkUI.ArkUI.Full 5511 * @systemapi 5512 * @atomicservice 5513 * @since 12 5514 */ 5515 /** 5516 * ADAPTIVE mode. 5517 * Lower level one of source and target is elevated to higher level of both, 5518 * indicating that two elements are in same high level. 5519 * 5520 * @syscap SystemCapability.ArkUI.ArkUI.Full 5521 * @systemapi 5522 * @since arkts {'1.1':'13','1.2':'20'} 5523 * @arkts 1.1&1.2 5524 */ 5525 ADAPTIVE = 1, 5526} 5527 5528/** 5529 * Defines the options of translate. 5530 * 5531 * @interface TranslateOptions 5532 * @syscap SystemCapability.ArkUI.ArkUI.Full 5533 * @since 7 5534 */ 5535/** 5536 * Defines the options of translate. 5537 * 5538 * @interface TranslateOptions 5539 * @syscap SystemCapability.ArkUI.ArkUI.Full 5540 * @form 5541 * @since 9 5542 */ 5543/** 5544 * Defines the options of translate. 5545 * 5546 * @interface TranslateOptions 5547 * @syscap SystemCapability.ArkUI.ArkUI.Full 5548 * @crossplatform 5549 * @form 5550 * @since 10 5551 */ 5552/** 5553 * Defines the options of translate. 5554 * 5555 * @interface TranslateOptions 5556 * @syscap SystemCapability.ArkUI.ArkUI.Full 5557 * @crossplatform 5558 * @form 5559 * @atomicservice 5560 * @since arkts {'1.1':'11','1.2':'20'} 5561 * @arkts 1.1&1.2 5562 */ 5563declare interface TranslateOptions { 5564 /** 5565 * Translation distance along the x-axis. 5566 * For the number type, the unit is VP, and the value range is (-∞, +∞). 5567 * For the string type, the value follows the format of Length string type. 5568 * 5569 * @type { ?(number | string) } 5570 * @syscap SystemCapability.ArkUI.ArkUI.Full 5571 * @since 7 5572 */ 5573 /** 5574 * Translation distance along the x-axis. 5575 * For the number type, the unit is VP, and the value range is (-∞, +∞). 5576 * For the string type, the value follows the format of Length string type. 5577 * 5578 * @type { ?(number | string) } 5579 * @syscap SystemCapability.ArkUI.ArkUI.Full 5580 * @form 5581 * @since 9 5582 */ 5583 /** 5584 * Translation distance along the x-axis. 5585 * For the number type, the unit is VP, and the value range is (-∞, +∞). 5586 * For the string type, the value follows the format of Length string type. 5587 * 5588 * @type { ?(number | string) } 5589 * @syscap SystemCapability.ArkUI.ArkUI.Full 5590 * @crossplatform 5591 * @form 5592 * @since 10 5593 */ 5594 /** 5595 * Translation distance along the x-axis. 5596 * For the number type, the unit is VP, and the value range is (-∞, +∞). 5597 * For the string type, the value follows the format of length string type. 5598 * 5599 * @type { ?(number | string) } 5600 * @syscap SystemCapability.ArkUI.ArkUI.Full 5601 * @crossplatform 5602 * @form 5603 * @atomicservice 5604 * @since arkts {'1.1':'11','1.2':'20'} 5605 * @arkts 1.1&1.2 5606 */ 5607 x?: number | string; 5608 5609 /** 5610 * Translation distance along the y-axis. 5611 * For the number type, the unit is VP, and the value range is (-∞, +∞). 5612 * For the string type, the value follows the format of length string type. 5613 * 5614 * @type { ?(number | string) } 5615 * @syscap SystemCapability.ArkUI.ArkUI.Full 5616 * @since 7 5617 */ 5618 /** 5619 * Translation distance along the y-axis. 5620 * For the number type, the unit is VP, and the value range is (-∞, +∞). 5621 * For the string type, the value follows the format of length string type. 5622 * 5623 * @type { ?(number | string) } 5624 * @syscap SystemCapability.ArkUI.ArkUI.Full 5625 * @form 5626 * @since 9 5627 */ 5628 /** 5629 * Translation distance along the y-axis. 5630 * For the number type, the unit is VP, and the value range is (-∞, +∞). 5631 * For the string type, the value follows the format of length string type. 5632 * 5633 * @type { ?(number | string) } 5634 * @syscap SystemCapability.ArkUI.ArkUI.Full 5635 * @crossplatform 5636 * @form 5637 * @since 10 5638 */ 5639 /** 5640 * Translation distance along the y-axis. 5641 * For the number type, the unit is VP, and the value range is (-∞, +∞). 5642 * For the string type, the value follows the format of length string type. 5643 * 5644 * @type { ?(number | string) } 5645 * @syscap SystemCapability.ArkUI.ArkUI.Full 5646 * @crossplatform 5647 * @form 5648 * @atomicservice 5649 * @since arkts {'1.1':'11','1.2':'20'} 5650 * @arkts 1.1&1.2 5651 */ 5652 y?: number | string; 5653 5654 /** 5655 * Distance to translate along the z-axis. The value is a floating 5656 * point number, the default value is 0.0, and the unit is px. 5657 * 5658 * @type { ?(number | string) } 5659 * @syscap SystemCapability.ArkUI.ArkUI.Full 5660 * @since 7 5661 */ 5662 /** 5663 * Distance to translate along the z-axis. The value is a floating 5664 * point number, the default value is 0.0, and the unit is px. 5665 * 5666 * @type { ?(number | string) } 5667 * @syscap SystemCapability.ArkUI.ArkUI.Full 5668 * @form 5669 * @since 9 5670 */ 5671 /** 5672 * Distance to translate along the z-axis. The value is a floating 5673 * point number, the default value is 0.0, and the unit is px. 5674 * 5675 * @type { ?(number | string) } 5676 * @syscap SystemCapability.ArkUI.ArkUI.Full 5677 * @crossplatform 5678 * @form 5679 * @since 10 5680 */ 5681 /** 5682 * Distance to translate along the z-axis. The value is a floating 5683 * point number, the default value is 0.0, and the unit is px. 5684 * 5685 * @type { ?(number | string) } 5686 * @syscap SystemCapability.ArkUI.ArkUI.Full 5687 * @crossplatform 5688 * @form 5689 * @atomicservice 5690 * @since arkts {'1.1':'11','1.2':'20'} 5691 * @arkts 1.1&1.2 5692 */ 5693 z?: number | string; 5694} 5695 5696/** 5697 * Defines the options of scale. 5698 * 5699 * @interface ScaleOptions 5700 * @syscap SystemCapability.ArkUI.ArkUI.Full 5701 * @since 7 5702 */ 5703/** 5704 * Defines the options of scale. 5705 * 5706 * @interface ScaleOptions 5707 * @syscap SystemCapability.ArkUI.ArkUI.Full 5708 * @form 5709 * @since 9 5710 */ 5711/** 5712 * Defines the options of scale. 5713 * 5714 * @interface ScaleOptions 5715 * @syscap SystemCapability.ArkUI.ArkUI.Full 5716 * @crossplatform 5717 * @form 5718 * @since 10 5719 */ 5720/** 5721 * Defines the options of scale. 5722 * 5723 * @interface ScaleOptions 5724 * @syscap SystemCapability.ArkUI.ArkUI.Full 5725 * @crossplatform 5726 * @form 5727 * @atomicservice 5728 * @since arkts {'1.1':'11','1.2':'20'} 5729 * @arkts 1.1&1.2 5730 */ 5731declare interface ScaleOptions { 5732 /** 5733 * Scale ratio along the x-axis. 5734 * x > 1: The component is scaled up along the x-axis. 5735 * 0 < x < 1: The component is scaled down along the x-axis. 5736 * x < 0: The component is scaled in the reverse direction of the x-axis. 5737 * 5738 * @type { ?number } 5739 * @syscap SystemCapability.ArkUI.ArkUI.Full 5740 * @since 7 5741 */ 5742 /** 5743 * Scale ratio along the x-axis. 5744 * x > 1: The component is scaled up along the x-axis. 5745 * 0 < x < 1: The component is scaled down along the x-axis. 5746 * x < 0: The component is scaled in the reverse direction of the x-axis. 5747 * 5748 * @type { ?number } 5749 * @syscap SystemCapability.ArkUI.ArkUI.Full 5750 * @form 5751 * @since 9 5752 */ 5753 /** 5754 * Scale ratio along the x-axis. 5755 * x > 1: The component is scaled up along the x-axis. 5756 * 0 < x < 1: The component is scaled down along the x-axis. 5757 * x < 0: The component is scaled in the reverse direction of the x-axis. 5758 * 5759 * @type { ?number } 5760 * @syscap SystemCapability.ArkUI.ArkUI.Full 5761 * @crossplatform 5762 * @form 5763 * @since 10 5764 */ 5765 /** 5766 * Scale ratio along the x-axis. 5767 * x > 1: The component is scaled up along the x-axis. 5768 * 0 < x < 1: The component is scaled down along the x-axis. 5769 * x < 0: The component is scaled in the reverse direction of the x-axis. 5770 * 5771 * @type { ?number } 5772 * @syscap SystemCapability.ArkUI.ArkUI.Full 5773 * @crossplatform 5774 * @form 5775 * @atomicservice 5776 * @since arkts {'1.1':'11','1.2':'20'} 5777 * @arkts 1.1&1.2 5778 */ 5779 x?: number; 5780 5781 /** 5782 * Scale ratio along the y-axis. 5783 * y > 1: The component is scaled up along the y-axis. 5784 * 0 < y < 1: The component is scaled down along the y-axis. 5785 * y < 0: The component is scaled in the reverse direction of the y-axis. 5786 * 5787 * @type { ?number } 5788 * @syscap SystemCapability.ArkUI.ArkUI.Full 5789 * @since 7 5790 */ 5791 /** 5792 * Scale ratio along the y-axis. 5793 * y > 1: The component is scaled up along the y-axis. 5794 * 0 < y < 1: The component is scaled down along the y-axis. 5795 * y < 0: The component is scaled in the reverse direction of the y-axis. 5796 * 5797 * @type { ?number } 5798 * @syscap SystemCapability.ArkUI.ArkUI.Full 5799 * @form 5800 * @since 9 5801 */ 5802 /** 5803 * Scale ratio along the y-axis. 5804 * y > 1: The component is scaled up along the y-axis. 5805 * 0 < y < 1: The component is scaled down along the y-axis. 5806 * y < 0: The component is scaled in the reverse direction of the y-axis. 5807 * 5808 * @type { ?number } 5809 * @syscap SystemCapability.ArkUI.ArkUI.Full 5810 * @crossplatform 5811 * @form 5812 * @since 10 5813 */ 5814 /** 5815 * Scale ratio along the y-axis. 5816 * y > 1: The component is scaled up along the y-axis. 5817 * 0 < y < 1: The component is scaled down along the y-axis. 5818 * y < 0: The component is scaled in the reverse direction of the y-axis. 5819 * 5820 * @type { ?number } 5821 * @syscap SystemCapability.ArkUI.ArkUI.Full 5822 * @crossplatform 5823 * @form 5824 * @atomicservice 5825 * @since arkts {'1.1':'11','1.2':'20'} 5826 * @arkts 1.1&1.2 5827 */ 5828 y?: number; 5829 5830 /** 5831 * Scale ratio along the z-axis. z > 1: The component is scaled up along the z-axis. 5832 * <br>0 < z < 1: The component is scaled down along the z-axis. 5833 * <br>z < 0: The component is scaled in the reverse direction of the z-axis. 5834 * 5835 * @type { ?number } 5836 * @syscap SystemCapability.ArkUI.ArkUI.Full 5837 * @since 7 5838 */ 5839 /** 5840 * Scale ratio along the z-axis. z > 1: The component is scaled up along the z-axis. 5841 * <br>0 < z < 1: The component is scaled down along the z-axis. 5842 * <br>z < 0: The component is scaled in the reverse direction of the z-axis. 5843 * 5844 * @type { ?number } 5845 * @syscap SystemCapability.ArkUI.ArkUI.Full 5846 * @form 5847 * @since 9 5848 */ 5849 /** 5850 * Scale ratio along the z-axis. z > 1: The component is scaled up along the z-axis. 5851 * <br>0 < z < 1: The component is scaled down along the z-axis. 5852 * <br>z < 0: The component is scaled in the reverse direction of the z-axis. 5853 * 5854 * @type { ?number } 5855 * @syscap SystemCapability.ArkUI.ArkUI.Full 5856 * @crossplatform 5857 * @form 5858 * @since 10 5859 */ 5860 /** 5861 * Scale ratio along the z-axis. z > 1: The component is scaled up along the z-axis. 5862 * <br>0 < z < 1: The component is scaled down along the z-axis. 5863 * <br>z < 0: The component is scaled in the reverse direction of the z-axis. 5864 * 5865 * @type { ?number } 5866 * @syscap SystemCapability.ArkUI.ArkUI.Full 5867 * @crossplatform 5868 * @form 5869 * @atomicservice 5870 * @since arkts {'1.1':'11','1.2':'20'} 5871 * @arkts 1.1&1.2 5872 */ 5873 z?: number; 5874 5875 /** 5876 * X coordinate of the transformation center point (anchor). Unit is vp. 5877 * 5878 * @type { ?(number | string) } 5879 * @syscap SystemCapability.ArkUI.ArkUI.Full 5880 * @since 7 5881 */ 5882 /** 5883 * X coordinate of the transformation center point (anchor). Unit is vp. 5884 * 5885 * @type { ?(number | string) } 5886 * @syscap SystemCapability.ArkUI.ArkUI.Full 5887 * @form 5888 * @since 9 5889 */ 5890 /** 5891 * X coordinate of the transformation center point (anchor). Unit is vp. 5892 * 5893 * @type { ?(number | string) } 5894 * @syscap SystemCapability.ArkUI.ArkUI.Full 5895 * @crossplatform 5896 * @form 5897 * @since 10 5898 */ 5899 /** 5900 * X coordinate of the transformation center point (anchor). Unit is vp. 5901 * 5902 * @type { ?(number | string) } 5903 * @syscap SystemCapability.ArkUI.ArkUI.Full 5904 * @crossplatform 5905 * @form 5906 * @atomicservice 5907 * @since arkts {'1.1':'11','1.2':'20'} 5908 * @arkts 1.1&1.2 5909 */ 5910 centerX?: number | string; 5911 5912 /** 5913 * Y coordinate of the transformation center point (anchor). Unit is vp. 5914 * 5915 * @type { ?(number | string) } 5916 * @syscap SystemCapability.ArkUI.ArkUI.Full 5917 * @since 7 5918 */ 5919 /** 5920 * Y coordinate of the transformation center point (anchor). Unit is vp. 5921 * 5922 * @type { ?(number | string) } 5923 * @syscap SystemCapability.ArkUI.ArkUI.Full 5924 * @form 5925 * @since 9 5926 */ 5927 /** 5928 * Y coordinate of the transformation center point (anchor). Unit is vp. 5929 * 5930 * @type { ?(number | string) } 5931 * @syscap SystemCapability.ArkUI.ArkUI.Full 5932 * @crossplatform 5933 * @form 5934 * @since 10 5935 */ 5936 /** 5937 * Y coordinate of the transformation center point (anchor). Unit is vp. 5938 * 5939 * @type { ?(number | string) } 5940 * @syscap SystemCapability.ArkUI.ArkUI.Full 5941 * @crossplatform 5942 * @form 5943 * @atomicservice 5944 * @since arkts {'1.1':'11','1.2':'20'} 5945 * @arkts 1.1&1.2 5946 */ 5947 centerY?: number | string; 5948} 5949 5950/** 5951 * Defines the align rule options of relative container. 5952 * 5953 * @interface AlignRuleParam 5954 * @syscap SystemCapability.ArkUI.ArkUI.Full 5955 * @crossplatform 5956 * @form 5957 * @atomicservice 5958 * @since 20 5959 * @arkts 1.2 5960 */ 5961declare interface AlignRuleParam<T> { 5962 /** 5963 * The param of anchor. 5964 * 5965 * @type { ?string } 5966 * @syscap SystemCapability.ArkUI.ArkUI.Full 5967 * @crossplatform 5968 * @form 5969 * @atomicservice 5970 * @since 20 5971 * @arkts 1.2 5972 */ 5973 anchor: string; 5974 /** 5975 * The param of align. 5976 * 5977 * @type { T } 5978 * @syscap SystemCapability.ArkUI.ArkUI.Full 5979 * @crossplatform 5980 * @form 5981 * @atomicservice 5982 * @since 20 5983 * @arkts 1.2 5984 */ 5985 align: T 5986} 5987 5988/** 5989 * Defines the align rule options of relative container. 5990 * 5991 * @interface AlignRuleOption 5992 * @syscap SystemCapability.ArkUI.ArkUI.Full 5993 * @crossplatform 5994 * @form 5995 * @atomicservice 5996 * @since 20 5997 * @arkts 1.2 5998 */ 5999declare interface AlignRuleOption { 6000 /** 6001 * The param of left align. 6002 * 6003 * @type { ?AlignRuleParam<HorizontalAlign> } 6004 * @syscap SystemCapability.ArkUI.ArkUI.Full 6005 * @crossplatform 6006 * @form 6007 * @atomicservice 6008 * @since 20 6009 * @arkts 1.2 6010 */ 6011 left?:AlignRuleParam<HorizontalAlign>; 6012 6013 /** 6014 * The param of right align. 6015 * 6016 * @type { ?AlignRuleParam<HorizontalAlign> } 6017 * @syscap SystemCapability.ArkUI.ArkUI.Full 6018 * @crossplatform 6019 * @form 6020 * @atomicservice 6021 * @since 20 6022 * @arkts 1.2 6023 */ 6024 right?: AlignRuleParam<HorizontalAlign>; 6025 6026 /** 6027 * The param of middle align. 6028 * 6029 * @type { ?AlignRuleParam<HorizontalAlign> } 6030 * @syscap SystemCapability.ArkUI.ArkUI.Full 6031 * @crossplatform 6032 * @form 6033 * @atomicservice 6034 * @since 20 6035 * @arkts 1.2 6036 */ 6037 middle?: AlignRuleParam<HorizontalAlign>; 6038 6039 /** 6040 * The param of top align. 6041 * 6042 * @type { ?AlignRuleParam<VerticalAlign> } 6043 * @syscap SystemCapability.ArkUI.ArkUI.Full 6044 * @crossplatform 6045 * @form 6046 * @atomicservice 6047 * @since 20 6048 * @arkts 1.2 6049 */ 6050 top?: AlignRuleParam<VerticalAlign>; 6051 6052 /** 6053 * The param of bottom align. 6054 * 6055 * @type { ?AlignRuleParam<VerticalAlign> } 6056 * @syscap SystemCapability.ArkUI.ArkUI.Full 6057 * @form 6058 * @atomicservice 6059 * @since 20 6060 * @arkts 1.2 6061 */ 6062 bottom?: AlignRuleParam<VerticalAlign>; 6063 6064 /** 6065 * The param of center align. 6066 * 6067 * @type { ?AlignRuleParam<VerticalAlign> } 6068 * @syscap SystemCapability.ArkUI.ArkUI.Full 6069 * @crossplatform 6070 * @form 6071 * @atomicservice 6072 * @since 20 6073 * @arkts 1.2 6074 */ 6075 center?: AlignRuleParam<VerticalAlign>; 6076 6077 /** 6078 * Defines the bias ratio in horizontal and vertical direction. 6079 * 6080 * @type { ?Bias } 6081 * @default {horizontal:0.5,vertical:0.5} 6082 * @syscap SystemCapability.ArkUI.ArkUI.Full 6083 * @crossplatform 6084 * @form 6085 * @atomicservice 6086 * @since 20 6087 * @arkts 1.2 6088 */ 6089 bias?: Bias; 6090} 6091 6092 6093/** 6094 * Defines the align rule options of relative container. 6095 * 6096 * @interface AlignRuleOption 6097 * @syscap SystemCapability.ArkUI.ArkUI.Full 6098 * @form 6099 * @since 9 6100 */ 6101/** 6102 * Defines the align rule options of relative container. 6103 * 6104 * @interface AlignRuleOption 6105 * @syscap SystemCapability.ArkUI.ArkUI.Full 6106 * @crossplatform 6107 * @form 6108 * @since 10 6109 */ 6110/** 6111 * Defines the align rule options of relative container. 6112 * 6113 * @interface AlignRuleOption 6114 * @syscap SystemCapability.ArkUI.ArkUI.Full 6115 * @crossplatform 6116 * @form 6117 * @atomicservice 6118 * @since 11 6119 */ 6120declare interface AlignRuleOption { 6121 /** 6122 * The param of left align. 6123 * 6124 * @type { ?object } 6125 * @syscap SystemCapability.ArkUI.ArkUI.Full 6126 * @form 6127 * @since 9 6128 */ 6129 /** 6130 * The param of left align. 6131 * 6132 * @type { ?object } 6133 * @syscap SystemCapability.ArkUI.ArkUI.Full 6134 * @crossplatform 6135 * @form 6136 * @since 10 6137 */ 6138 /** 6139 * Left alignment. 6140 * <br>anchor: ID of the component that functions as the anchor point. 6141 * <br>align: alignment mode relative to the anchor component. 6142 * 6143 * @type { ?object } 6144 * @syscap SystemCapability.ArkUI.ArkUI.Full 6145 * @crossplatform 6146 * @form 6147 * @atomicservice 6148 * @since 11 6149 */ 6150 left?: { anchor: string, align: HorizontalAlign }; 6151 6152 /** 6153 * The param of right align. 6154 * 6155 * @type { ?object } 6156 * @syscap SystemCapability.ArkUI.ArkUI.Full 6157 * @form 6158 * @since 9 6159 */ 6160 /** 6161 * The param of right align. 6162 * 6163 * @type { ?object } 6164 * @syscap SystemCapability.ArkUI.ArkUI.Full 6165 * @crossplatform 6166 * @form 6167 * @since 10 6168 */ 6169 /** 6170 * Right alignment. 6171 * <br>anchor: ID of the component that functions as the anchor point. 6172 * <br>align: alignment mode relative to the anchor component. 6173 * 6174 * @type { ?object } 6175 * @syscap SystemCapability.ArkUI.ArkUI.Full 6176 * @crossplatform 6177 * @form 6178 * @atomicservice 6179 * @since 11 6180 */ 6181 right?: { anchor: string, align: HorizontalAlign }; 6182 6183 /** 6184 * The param of middle align. 6185 * 6186 * @type { ?object } 6187 * @syscap SystemCapability.ArkUI.ArkUI.Full 6188 * @form 6189 * @since 9 6190 */ 6191 /** 6192 * The param of middle align. 6193 * 6194 * @type { ?object } 6195 * @syscap SystemCapability.ArkUI.ArkUI.Full 6196 * @crossplatform 6197 * @form 6198 * @since 10 6199 */ 6200 /** 6201 * Horizontal center alignment. 6202 * <br>anchor: ID of the component that functions as the anchor point. 6203 * <br>align: alignment mode relative to the anchor component. 6204 * 6205 * @type { ?object } 6206 * @syscap SystemCapability.ArkUI.ArkUI.Full 6207 * @crossplatform 6208 * @form 6209 * @atomicservice 6210 * @since 11 6211 */ 6212 middle?: { anchor: string, align: HorizontalAlign }; 6213 6214 /** 6215 * The param of top align. 6216 * 6217 * @type { ?object } 6218 * @syscap SystemCapability.ArkUI.ArkUI.Full 6219 * @form 6220 * @since 9 6221 */ 6222 /** 6223 * The param of top align. 6224 * 6225 * @type { ?object } 6226 * @syscap SystemCapability.ArkUI.ArkUI.Full 6227 * @crossplatform 6228 * @form 6229 * @since 10 6230 */ 6231 /** 6232 * Top alignment. 6233 * <br>anchor: ID of the component that functions as the anchor point. 6234 * <br>align: alignment mode relative to the anchor component. 6235 * 6236 * @type { ?object } 6237 * @syscap SystemCapability.ArkUI.ArkUI.Full 6238 * @crossplatform 6239 * @form 6240 * @atomicservice 6241 * @since 11 6242 */ 6243 top?: { anchor: string, align: VerticalAlign }; 6244 6245 /** 6246 * The param of bottom align. 6247 * 6248 * @type { ?object } 6249 * @syscap SystemCapability.ArkUI.ArkUI.Full 6250 * @form 6251 * @since 9 6252 */ 6253 /** 6254 * The param of bottom align. 6255 * 6256 * @type { ?object } 6257 * @syscap SystemCapability.ArkUI.ArkUI.Full 6258 * @form 6259 * @since 10 6260 */ 6261 /** 6262 * Bottom alignment. 6263 * <br>anchor: ID of the component that functions as the anchor point. 6264 * <br>align: alignment mode relative to the anchor component. 6265 * 6266 * @type { ?object } 6267 * @syscap SystemCapability.ArkUI.ArkUI.Full 6268 * @form 6269 * @atomicservice 6270 * @since 11 6271 */ 6272 bottom?: { anchor: string, align: VerticalAlign }; 6273 6274 /** 6275 * The param of center align. 6276 * 6277 * @type { ?object } 6278 * @syscap SystemCapability.ArkUI.ArkUI.Full 6279 * @form 6280 * @since 9 6281 */ 6282 /** 6283 * The param of center align. 6284 * 6285 * @type { ?object } 6286 * @syscap SystemCapability.ArkUI.ArkUI.Full 6287 * @crossplatform 6288 * @form 6289 * @since 10 6290 */ 6291 /** 6292 * Vertical center alignment. 6293 * <br>anchor: ID of the component that functions as the anchor point. 6294 * <br>align: alignment mode relative to the anchor component. 6295 * 6296 * @type { ?object } 6297 * @syscap SystemCapability.ArkUI.ArkUI.Full 6298 * @crossplatform 6299 * @form 6300 * @atomicservice 6301 * @since 11 6302 */ 6303 center?: { anchor: string, align: VerticalAlign }; 6304 6305 /** 6306 * Defines the bias ratio in horizontal and vertical direction. 6307 * 6308 * @type { ?Bias } 6309 * @default {horizontal:0.5,vertical:0.5} 6310 * @syscap SystemCapability.ArkUI.ArkUI.Full 6311 * @crossplatform 6312 * @form 6313 * @since 11 6314 */ 6315 /** 6316 * Offset of the component under the anchor constraints. 6317 * <br>The value is the ratio of the distance to the left/upper anchor to the total distance between anchors. 6318 * 6319 * @type { ?Bias } 6320 * @default {horizontal:0.5,vertical:0.5} 6321 * @syscap SystemCapability.ArkUI.ArkUI.Full 6322 * @crossplatform 6323 * @form 6324 * @atomicservice 6325 * @since 12 6326 */ 6327 bias?: Bias; 6328} 6329 6330/** 6331 * Defines the localized horizontal align param of relative container. 6332 * 6333 * @interface LocalizedHorizontalAlignParam 6334 * @syscap SystemCapability.ArkUI.ArkUI.Full 6335 * @crossplatform 6336 * @atomicservice 6337 * @since arkts {'1.1':'12','1.2':'20'} 6338 * @arkts 1.1&1.2 6339 */ 6340declare interface LocalizedHorizontalAlignParam { 6341 /** 6342 * ID of the component that serves as the anchor. 6343 * 6344 * @type { string } 6345 * @syscap SystemCapability.ArkUI.ArkUI.Full 6346 * @crossplatform 6347 * @atomicservice 6348 * @since arkts {'1.1':'12','1.2':'20'} 6349 * @arkts 1.1&1.2 6350 */ 6351 anchor: string; 6352 6353 /** 6354 * Horizontal alignment mode relative to the anchor component. 6355 * 6356 * @type { HorizontalAlign } 6357 * @syscap SystemCapability.ArkUI.ArkUI.Full 6358 * @crossplatform 6359 * @atomicservice 6360 * @since arkts {'1.1':'12','1.2':'20'} 6361 * @arkts 1.1&1.2 6362 */ 6363 align: HorizontalAlign; 6364} 6365 6366/** 6367 * Defines the localized vertical align param of relative container. 6368 * 6369 * @interface LocalizedVerticalAlignParam 6370 * @syscap SystemCapability.ArkUI.ArkUI.Full 6371 * @crossplatform 6372 * @atomicservice 6373 * @since arkts {'1.1':'12','1.2':'20'} 6374 * @arkts 1.1&1.2 6375 */ 6376declare interface LocalizedVerticalAlignParam { 6377 /** 6378 * ID of the component that serves as the anchor. 6379 * 6380 * @type { string } 6381 * @syscap SystemCapability.ArkUI.ArkUI.Full 6382 * @crossplatform 6383 * @atomicservice 6384 * @since arkts {'1.1':'12','1.2':'20'} 6385 * @arkts 1.1&1.2 6386 */ 6387 anchor: string; 6388 6389 /** 6390 * Vertical alignment mode relative to the anchor component. 6391 * 6392 * @type { VerticalAlign } 6393 * @syscap SystemCapability.ArkUI.ArkUI.Full 6394 * @crossplatform 6395 * @atomicservice 6396 * @since arkts {'1.1':'12','1.2':'20'} 6397 * @arkts 1.1&1.2 6398 */ 6399 align: VerticalAlign; 6400} 6401 6402/** 6403 * Defines the Localized align rule options of relative container. 6404 * 6405 * @interface LocalizedAlignRuleOptions 6406 * @syscap SystemCapability.ArkUI.ArkUI.Full 6407 * @crossplatform 6408 * @atomicservice 6409 * @since arkts {'1.1':'12','1.2':'20'} 6410 * @arkts 1.1&1.2 6411 */ 6412declare interface LocalizedAlignRuleOptions { 6413 /** 6414 * Left alignment with left-to-right scripts and right alignment with right-to-left scripts in the horizontal direction. 6415 * 6416 * @type { ?LocalizedHorizontalAlignParam } 6417 * @syscap SystemCapability.ArkUI.ArkUI.Full 6418 * @crossplatform 6419 * @atomicservice 6420 * @since arkts {'1.1':'12','1.2':'20'} 6421 * @arkts 1.1&1.2 6422 */ 6423 start?: LocalizedHorizontalAlignParam; 6424 6425 /** 6426 * Right alignment with left-to-right scripts and left alignment with right-to-left scripts in the horizontal direction. 6427 * 6428 * @type { ?LocalizedHorizontalAlignParam } 6429 * @syscap SystemCapability.ArkUI.ArkUI.Full 6430 * @crossplatform 6431 * @atomicservice 6432 * @since arkts {'1.1':'12','1.2':'20'} 6433 * @arkts 1.1&1.2 6434 */ 6435 end?: LocalizedHorizontalAlignParam; 6436 6437 /** 6438 * Center alignment in the horizontal direction. 6439 * 6440 * @type { ?LocalizedHorizontalAlignParam } 6441 * @syscap SystemCapability.ArkUI.ArkUI.Full 6442 * @crossplatform 6443 * @atomicservice 6444 * @since arkts {'1.1':'12','1.2':'20'} 6445 * @arkts 1.1&1.2 6446 */ 6447 middle?: LocalizedHorizontalAlignParam; 6448 6449 /** 6450 * Top alignment in the vertical direction. 6451 * 6452 * @type { ?LocalizedVerticalAlignParam } 6453 * @syscap SystemCapability.ArkUI.ArkUI.Full 6454 * @crossplatform 6455 * @atomicservice 6456 * @since arkts {'1.1':'12','1.2':'20'} 6457 * @arkts 1.1&1.2 6458 */ 6459 top?: LocalizedVerticalAlignParam; 6460 6461 /** 6462 * Bottom alignment in the vertical direction. 6463 * 6464 * @type { ?LocalizedVerticalAlignParam } 6465 * @syscap SystemCapability.ArkUI.ArkUI.Full 6466 * @crossplatform 6467 * @atomicservice 6468 * @since arkts {'1.1':'12','1.2':'20'} 6469 * @arkts 1.1&1.2 6470 */ 6471 bottom?: LocalizedVerticalAlignParam; 6472 6473 /** 6474 * Center alignment in the vertical direction. 6475 * 6476 * @type { ?LocalizedVerticalAlignParam } 6477 * @syscap SystemCapability.ArkUI.ArkUI.Full 6478 * @crossplatform 6479 * @atomicservice 6480 * @since arkts {'1.1':'12','1.2':'20'} 6481 * @arkts 1.1&1.2 6482 */ 6483 center?: LocalizedVerticalAlignParam; 6484 6485 /** 6486 * Offset of the component under the anchor constraints. 6487 * <br>The value is the ratio of the distance to the left/upper anchor to the total distance between anchors. 6488 * 6489 * @type { ?Bias } 6490 * @default {horizontal:0.5,vertical:0.5} 6491 * @syscap SystemCapability.ArkUI.ArkUI.Full 6492 * @crossplatform 6493 * @atomicservice 6494 * @since arkts {'1.1':'12','1.2':'20'} 6495 * @arkts 1.1&1.2 6496 */ 6497 bias?: Bias; 6498} 6499 6500/** 6501 * Enumerates the chain styles in relative container. 6502 * 6503 * @enum { number } 6504 * @syscap SystemCapability.ArkUI.ArkUI.Full 6505 * @crossplatform 6506 * @atomicservice 6507 * @since arkts {'1.1':'12','1.2':'20'} 6508 * @arkts 1.1&1.2 6509 */ 6510declare enum ChainStyle { 6511 /** 6512 * Child components are evenly distributed among constraint anchors. 6513 * 6514 * @syscap SystemCapability.ArkUI.ArkUI.Full 6515 * @crossplatform 6516 * @atomicservice 6517 * @since arkts {'1.1':'12','1.2':'20'} 6518 * @arkts 1.1&1.2 6519 */ 6520 SPREAD, 6521 6522 /** 6523 * All child components except the first and last ones are evenly distributed among constraint anchors. 6524 * 6525 * @syscap SystemCapability.ArkUI.ArkUI.Full 6526 * @crossplatform 6527 * @atomicservice 6528 * @since arkts {'1.1':'12','1.2':'20'} 6529 * @arkts 1.1&1.2 6530 */ 6531 SPREAD_INSIDE, 6532 6533 /** 6534 * There is no gap between child components in the chain. 6535 * 6536 * @syscap SystemCapability.ArkUI.ArkUI.Full 6537 * @crossplatform 6538 * @atomicservice 6539 * @since arkts {'1.1':'12','1.2':'20'} 6540 * @arkts 1.1&1.2 6541 */ 6542 PACKED, 6543} 6544 6545/** 6546 * The param of rotate. 6547 * 6548 * @interface RotateOptions 6549 * @syscap SystemCapability.ArkUI.ArkUI.Full 6550 * @since 7 6551 */ 6552/** 6553 * The param of rotate. 6554 * 6555 * @interface RotateOptions 6556 * @syscap SystemCapability.ArkUI.ArkUI.Full 6557 * @form 6558 * @since 9 6559 */ 6560/** 6561 * The param of rotate. 6562 * 6563 * @interface RotateOptions 6564 * @syscap SystemCapability.ArkUI.ArkUI.Full 6565 * @crossplatform 6566 * @form 6567 * @since 10 6568 */ 6569/** 6570 * The param of rotate. 6571 * 6572 * @interface RotateOptions 6573 * @syscap SystemCapability.ArkUI.ArkUI.Full 6574 * @crossplatform 6575 * @form 6576 * @atomicservice 6577 * @since arkts {'1.1':'11','1.2':'20'} 6578 * @arkts 1.1&1.2 6579 */ 6580declare interface RotateOptions { 6581 /** 6582 * X coordinate of the rotation axis vector. 6583 * 6584 * @type { ?number } 6585 * @syscap SystemCapability.ArkUI.ArkUI.Full 6586 * @since 7 6587 */ 6588 /** 6589 * X coordinate of the rotation axis vector. 6590 * 6591 * @type { ?number } 6592 * @syscap SystemCapability.ArkUI.ArkUI.Full 6593 * @form 6594 * @since 9 6595 */ 6596 /** 6597 * X coordinate of the rotation axis vector. 6598 * 6599 * @type { ?number } 6600 * @syscap SystemCapability.ArkUI.ArkUI.Full 6601 * @crossplatform 6602 * @form 6603 * @since 10 6604 */ 6605 /** 6606 * X coordinate of the rotation axis vector. 6607 * 6608 * @type { ?number } 6609 * @syscap SystemCapability.ArkUI.ArkUI.Full 6610 * @crossplatform 6611 * @form 6612 * @atomicservice 6613 * @since arkts {'1.1':'11','1.2':'20'} 6614 * @arkts 1.1&1.2 6615 */ 6616 x?: number; 6617 6618 /** 6619 * Y coordinate of the rotation axis vector. 6620 * 6621 * @type { ?number } 6622 * @syscap SystemCapability.ArkUI.ArkUI.Full 6623 * @since 7 6624 */ 6625 /** 6626 * Y coordinate of the rotation axis vector. 6627 * 6628 * @type { ?number } 6629 * @syscap SystemCapability.ArkUI.ArkUI.Full 6630 * @form 6631 * @since 9 6632 */ 6633 /** 6634 * Y coordinate of the rotation axis vector. 6635 * 6636 * @type { ?number } 6637 * @syscap SystemCapability.ArkUI.ArkUI.Full 6638 * @crossplatform 6639 * @form 6640 * @since 10 6641 */ 6642 /** 6643 * Y coordinate of the rotation axis vector. 6644 * 6645 * @type { ?number } 6646 * @syscap SystemCapability.ArkUI.ArkUI.Full 6647 * @crossplatform 6648 * @form 6649 * @atomicservice 6650 * @since arkts {'1.1':'11','1.2':'20'} 6651 * @arkts 1.1&1.2 6652 */ 6653 y?: number; 6654 6655 /** 6656 * Z coordinate of the rotation axis vector. 6657 * 6658 * @type { ?number } 6659 * @syscap SystemCapability.ArkUI.ArkUI.Full 6660 * @since 7 6661 */ 6662 /** 6663 * Z coordinate of the rotation axis vector. 6664 * 6665 * @type { ?number } 6666 * @syscap SystemCapability.ArkUI.ArkUI.Full 6667 * @form 6668 * @since 9 6669 */ 6670 /** 6671 * Z coordinate of the rotation axis vector. 6672 * 6673 * @type { ?number } 6674 * @syscap SystemCapability.ArkUI.ArkUI.Full 6675 * @crossplatform 6676 * @form 6677 * @since 10 6678 */ 6679 /** 6680 * Z coordinate of the rotation axis vector. 6681 * 6682 * @type { ?number } 6683 * @syscap SystemCapability.ArkUI.ArkUI.Full 6684 * @crossplatform 6685 * @form 6686 * @atomicservice 6687 * @since arkts {'1.1':'11','1.2':'20'} 6688 * @arkts 1.1&1.2 6689 */ 6690 z?: number; 6691 6692 /** 6693 * X coordinate of the transformation center point (anchor). Unit is vp. 6694 * 6695 * @type { ?(number | string) } 6696 * @syscap SystemCapability.ArkUI.ArkUI.Full 6697 * @since 7 6698 */ 6699 /** 6700 * X coordinate of the transformation center point (anchor). Unit is vp. 6701 * 6702 * @type { ?(number | string) } 6703 * @syscap SystemCapability.ArkUI.ArkUI.Full 6704 * @form 6705 * @since 9 6706 */ 6707 /** 6708 * X coordinate of the transformation center point (anchor). Unit is vp. 6709 * 6710 * @type { ?(number | string) } 6711 * @syscap SystemCapability.ArkUI.ArkUI.Full 6712 * @crossplatform 6713 * @form 6714 * @since 10 6715 */ 6716 /** 6717 * X coordinate of the transformation center point (anchor). Unit is vp. 6718 * 6719 * @type { ?(number | string) } 6720 * @syscap SystemCapability.ArkUI.ArkUI.Full 6721 * @crossplatform 6722 * @form 6723 * @atomicservice 6724 * @since arkts {'1.1':'11','1.2':'20'} 6725 * @arkts 1.1&1.2 6726 */ 6727 centerX?: number | string; 6728 6729 /** 6730 * Y coordinate of the transformation center point (anchor). Unit is vp. 6731 * 6732 * @type { ?(number | string) } 6733 * @syscap SystemCapability.ArkUI.ArkUI.Full 6734 * @since 7 6735 */ 6736 /** 6737 * Y coordinate of the transformation center point (anchor). Unit is vp. 6738 * 6739 * @type { ?(number | string) } 6740 * @syscap SystemCapability.ArkUI.ArkUI.Full 6741 * @since 9 6742 */ 6743 /** 6744 * Y coordinate of the transformation center point (anchor). Unit is vp. 6745 * 6746 * @type { ?(number | string) } 6747 * @syscap SystemCapability.ArkUI.ArkUI.Full 6748 * @crossplatform 6749 * @form 6750 * @since 10 6751 */ 6752 /** 6753 * Y coordinate of the transformation center point (anchor). Unit is vp. 6754 * 6755 * @type { ?(number | string) } 6756 * @syscap SystemCapability.ArkUI.ArkUI.Full 6757 * @crossplatform 6758 * @form 6759 * @atomicservice 6760 * @since arkts {'1.1':'11','1.2':'20'} 6761 * @arkts 1.1&1.2 6762 */ 6763 centerY?: number | string; 6764 6765 /** 6766 * Z-axis anchor, that is, the z-component of the 3D rotation center point. 6767 * 6768 * @type { ?number } 6769 * @default 0 6770 * @syscap SystemCapability.ArkUI.ArkUI.Full 6771 * @crossplatform 6772 * @form 6773 * @since 10 6774 */ 6775 /** 6776 * Z-axis anchor, that is, the z-component of the 3D rotation center point. 6777 * 6778 * @type { ?number } 6779 * @default 0 6780 * @syscap SystemCapability.ArkUI.ArkUI.Full 6781 * @crossplatform 6782 * @form 6783 * @atomicservice 6784 * @since arkts {'1.1':'11','1.2':'20'} 6785 * @arkts 1.1&1.2 6786 */ 6787 centerZ?: number; 6788 6789 /** 6790 * Distance from the user to the z=0 plane. 6791 * The axis and center of rotation are set based on the coordinate system, 6792 * which remains where it is when the component is moved. 6793 * 6794 * @type { ?number } 6795 * @default 0 6796 * @syscap SystemCapability.ArkUI.ArkUI.Full 6797 * @crossplatform 6798 * @form 6799 * @since 10 6800 */ 6801 /** 6802 * Distance from the user to the z=0 plane. 6803 * The axis and center of rotation are set based on the coordinate system, 6804 * which remains where it is when the component is moved. 6805 * 6806 * @type { ?number } 6807 * @default 0 6808 * @syscap SystemCapability.ArkUI.ArkUI.Full 6809 * @crossplatform 6810 * @form 6811 * @atomicservice 6812 * @since arkts {'1.1':'11','1.2':'20'} 6813 * @arkts 1.1&1.2 6814 */ 6815 perspective?: number; 6816 6817 /** 6818 * The param of angle. 6819 * 6820 * @type { number | string } 6821 * @syscap SystemCapability.ArkUI.ArkUI.Full 6822 * @since 7 6823 */ 6824 /** 6825 * The param of angle. 6826 * 6827 * @type { number | string } 6828 * @syscap SystemCapability.ArkUI.ArkUI.Full 6829 * @form 6830 * @since 9 6831 */ 6832 /** 6833 * The param of angle. 6834 * 6835 * @type { number | string } 6836 * @syscap SystemCapability.ArkUI.ArkUI.Full 6837 * @crossplatform 6838 * @form 6839 * @since 10 6840 */ 6841 /** 6842 * The param of angle. 6843 * 6844 * @type { number | string } 6845 * @syscap SystemCapability.ArkUI.ArkUI.Full 6846 * @crossplatform 6847 * @form 6848 * @atomicservice 6849 * @since arkts {'1.1':'11','1.2':'20'} 6850 * @arkts 1.1&1.2 6851 */ 6852 angle: number | string; 6853} 6854 6855/** 6856 * The rotation parameters containing multi-axis angle information. 6857 * 6858 * @interface RotateAngleOptions 6859 * @syscap SystemCapability.ArkUI.ArkUI.Full 6860 * @crossplatform 6861 * @form 6862 * @atomicservice 6863 * @since 20 6864 */ 6865declare interface RotateAngleOptions { 6866 /** 6867 * the angle of the x-axis direction. 6868 * 6869 * @type { ?(number | string) } 6870 * @default 0 6871 * @syscap SystemCapability.ArkUI.ArkUI.Full 6872 * @crossplatform 6873 * @form 6874 * @atomicservice 6875 * @since 20 6876 */ 6877 angleX?: number | string; 6878 6879 /** 6880 * the angle of the y-axis direction. 6881 * 6882 * @type { ?(number | string) } 6883 * @default 0 6884 * @syscap SystemCapability.ArkUI.ArkUI.Full 6885 * @crossplatform 6886 * @form 6887 * @atomicservice 6888 * @since 20 6889 */ 6890 angleY?: number | string; 6891 6892 /** 6893 * the angle of the z-axis direction. 6894 * 6895 * @type { ?(number | string) } 6896 * @default 0 6897 * @syscap SystemCapability.ArkUI.ArkUI.Full 6898 * @crossplatform 6899 * @form 6900 * @atomicservice 6901 * @since 20 6902 */ 6903 angleZ?: number | string; 6904 6905 /** 6906 * The param of center point of x. 6907 * 6908 * @type { ?(number | string) } 6909 * @default '50%' 6910 * @syscap SystemCapability.ArkUI.ArkUI.Full 6911 * @crossplatform 6912 * @form 6913 * @atomicservice 6914 * @since 20 6915 */ 6916 centerX?: number | string; 6917 6918 /** 6919 * The param of center point of y. 6920 * 6921 * @type { ?(number | string) } 6922 * @default '50%' 6923 * @syscap SystemCapability.ArkUI.ArkUI.Full 6924 * @crossplatform 6925 * @form 6926 * @atomicservice 6927 * @since 20 6928 */ 6929 centerY?: number | string; 6930 6931 /** 6932 * The param of center point of z. 6933 * 6934 * @type { ?number } 6935 * @default 0 6936 * @syscap SystemCapability.ArkUI.ArkUI.Full 6937 * @crossplatform 6938 * @form 6939 * @atomicservice 6940 * @since 20 6941 */ 6942 centerZ?: number; 6943 6944 /** 6945 * The param of camera distance, value range (-∞, ∞). 6946 * @type { ?number } 6947 * @default 0 6948 * @syscap SystemCapability.ArkUI.ArkUI.Full 6949 * @crossplatform 6950 * @form 6951 * @atomicservice 6952 * @since 20 6953 */ 6954 perspective?: number; 6955} 6956 6957/** 6958 * Defines the param of transition. 6959 * 6960 * @interface TransitionOptions 6961 * @syscap SystemCapability.ArkUI.ArkUI.Full 6962 * @since 7 6963 * @deprecated since 10 6964 * @useinstead TransitionEffect 6965 */ 6966declare interface TransitionOptions { 6967 /** 6968 * Transition type.<br> 6969 * Default value: **TransitionType.All**. 6970 * <br>**NOTE**<br>If **type** is not specified, the default value **TransitionType.All** 6971 * is used, which means that the transition effect works for both component addition and deletion. 6972 * 6973 * @type { ?TransitionType } 6974 * @syscap SystemCapability.ArkUI.ArkUI.Full 6975 * @since 7 6976 * @deprecated since 10 6977 */ 6978 type?: TransitionType; 6979 /** 6980 * Opacity of the component during transition, which is the value of the 6981 * start point of insertion and the end point of deletion. 6982 * <br>Value range: [0, 1]. 6983 * <br>**NOTE**<br>If the value specified is less than 0, the value **0** is used. 6984 * If the value specified is greater than 1, the value **1** is used. 6985 * 6986 * @type { ?number } 6987 * @syscap SystemCapability.ArkUI.ArkUI.Full 6988 * @since 7 6989 * @deprecated since 10 6990 */ 6991 opacity?: number; 6992 /** 6993 * Translation of the component during transition, 6994 * which is the value of the start point of insertion and the end point of deletion. 6995 * **x**: distance to translate along the x-axis. 6996 * **y**: distance to translate along the y-axis. 6997 * **z**: distance to translate along the z-axis. 6998 * 6999 * @type { ?TranslateOptions } 7000 * @syscap SystemCapability.ArkUI.ArkUI.Full 7001 * @since 7 7002 * @deprecated since 10 7003 */ 7004 translate?: TranslateOptions; 7005 /** 7006 * Scaling of the component during transition, which is the value of the start point of insertion and the end point 7007 * of deletion. **x**: scale factor along the x-axis. **y**: scale factor along the y-axis. **z**: scale factor along 7008 * the z-axis (not effective for the current 2D graphics). **centerX** and **centerY**: scale center point. The 7009 * default values are both **"50%"**, indicating the center point of the page. If the center point is (0, 0), it 7010 * refers to the upper left corner of the component. 7011 * <p>**NOTE**: 7012 * <br>If **centerX** or **centerY** is set to an invalid string (for example, **"illegalString"**), 7013 * the default value **"0"** is used. 7014 * </p> 7015 * 7016 * @type { ?ScaleOptions } 7017 * @syscap SystemCapability.ArkUI.ArkUI.Full 7018 * @since 7 7019 * @deprecated since 10 7020 */ 7021 scale?: ScaleOptions; 7022 /** 7023 * Rotation of the component during transition, which is the value of the start point of insertion and the end point 7024 * of deletion. **x**: X-component of the rotation vector. **y**: Y-component of the rotation vector. **z**: 7025 * Z-component of the rotation vector. **centerX** and **centerY**: rotation center point. The default values are 7026 * both **"50%"**, indicating the center point of the page.If the center point is (0, 0), it refers to the upper left 7027 * corner of the component. 7028 * 7029 * @type { ?RotateOptions } 7030 * @syscap SystemCapability.ArkUI.ArkUI.Full 7031 * @since 7 7032 * @deprecated since 10 7033 */ 7034 rotate?: RotateOptions; 7035} 7036 7037/** 7038 * Defines the Edge object. 7039 * 7040 * @enum { number } 7041 * @syscap SystemCapability.ArkUI.ArkUI.Full 7042 * @crossplatform 7043 * @form 7044 * @since 10 7045 */ 7046/** 7047 * Defines the Edge object. 7048 * 7049 * @enum { number } 7050 * @syscap SystemCapability.ArkUI.ArkUI.Full 7051 * @crossplatform 7052 * @form 7053 * @atomicservice 7054 * @since arkts {'1.1':'11','1.2':'20'} 7055 * @arkts 1.1&1.2 7056 */ 7057declare enum TransitionEdge { 7058 /** 7059 * Top edge 7060 * 7061 * @syscap SystemCapability.ArkUI.ArkUI.Full 7062 * @crossplatform 7063 * @form 7064 * @since 10 7065 */ 7066 /** 7067 * Top edge 7068 * 7069 * @syscap SystemCapability.ArkUI.ArkUI.Full 7070 * @crossplatform 7071 * @form 7072 * @atomicservice 7073 * @since arkts {'1.1':'11','1.2':'20'} 7074 * @arkts 1.1&1.2 7075 */ 7076 TOP, 7077 7078 /** 7079 * Bottom edge of the window. 7080 * 7081 * @syscap SystemCapability.ArkUI.ArkUI.Full 7082 * @crossplatform 7083 * @form 7084 * @since 10 7085 */ 7086 /** 7087 * Bottom edge of the window. 7088 * 7089 * @syscap SystemCapability.ArkUI.ArkUI.Full 7090 * @crossplatform 7091 * @form 7092 * @atomicservice 7093 * @since arkts {'1.1':'11','1.2':'20'} 7094 * @arkts 1.1&1.2 7095 */ 7096 BOTTOM, 7097 7098 /** 7099 * Start edge of the window, which is the left edge for left-to-right 7100 * scripts and the right edge for right-to-left scripts. 7101 * 7102 * @syscap SystemCapability.ArkUI.ArkUI.Full 7103 * @crossplatform 7104 * @form 7105 * @since 10 7106 */ 7107 /** 7108 * Start edge of the window, which is the left edge for left-to-right 7109 * scripts and the right edge for right-to-left scripts. 7110 * 7111 * @syscap SystemCapability.ArkUI.ArkUI.Full 7112 * @crossplatform 7113 * @form 7114 * @atomicservice 7115 * @since arkts {'1.1':'11','1.2':'20'} 7116 * @arkts 1.1&1.2 7117 */ 7118 START, 7119 7120 /** 7121 * End edge of the window, which is the right edge for left-to-right scripts 7122 * and the left edge for right-to-left scripts. 7123 * 7124 * @syscap SystemCapability.ArkUI.ArkUI.Full 7125 * @crossplatform 7126 * @form 7127 * @since 10 7128 */ 7129 /** 7130 * End edge of the window, which is the right edge for left-to-right scripts 7131 * and the left edge for right-to-left scripts. 7132 * 7133 * @syscap SystemCapability.ArkUI.ArkUI.Full 7134 * @crossplatform 7135 * @form 7136 * @atomicservice 7137 * @since arkts {'1.1':'11','1.2':'20'} 7138 * @arkts 1.1&1.2 7139 */ 7140 END 7141} 7142 7143/** 7144 * Defines all transition effects. 7145 * 7146 * @typedef { object } TransitionEffects 7147 * @syscap SystemCapability.ArkUI.ArkUI.Full 7148 * @crossplatform 7149 * @form 7150 * @since 10 7151 */ 7152/** 7153 * Defines all transition effects. 7154 * 7155 * @typedef { object } TransitionEffects 7156 * @syscap SystemCapability.ArkUI.ArkUI.Full 7157 * @crossplatform 7158 * @form 7159 * @atomicservice 7160 * @since 11 7161 */ 7162declare type TransitionEffects = { 7163 identity: undefined; 7164 opacity: number; 7165 slideSwitch: undefined; 7166 move: TransitionEdge; 7167 translate: TranslateOptions; 7168 rotate: RotateOptions; 7169 scale: ScaleOptions; 7170 asymmetric: { 7171 appear: TransitionEffect; 7172 disappear: TransitionEffect; 7173 }; 7174}; 7175 7176/** 7177 * Defines the option of asymmetric transition. 7178 * 7179 * @interface AsymmetricTransitionOption 7180 * @syscap SystemCapability.ArkUI.ArkUI.Full 7181 * @crossplatform 7182 * @form 7183 * @atomicservice 7184 * @since 20 7185 * @arkts 1.2 7186 */ 7187declare interface AsymmetricTransitionOption { 7188 /** 7189 * TransitionEffect used for appearing 7190 * 7191 * @type { TransitionEffect } 7192 * @syscap SystemCapability.ArkUI.ArkUI.Full 7193 * @crossplatform 7194 * @form 7195 * @atomicservice 7196 * @since 20 7197 * @arkts 1.2 7198 */ 7199 appear: TransitionEffect; 7200 7201 /** 7202 * TransitionEffect used for disappearing 7203 * 7204 * @type { TransitionEffect } 7205 * @syscap SystemCapability.ArkUI.ArkUI.Full 7206 * @crossplatform 7207 * @form 7208 * @atomicservice 7209 * @since 20 7210 * @arkts 1.2 7211 */ 7212 disappear: TransitionEffect; 7213} 7214 7215/** 7216 * Defined the draw modifier of node. Provides draw callbacks for the associated Node. 7217 * Each DrawModifier instance can be set for only one component. Repeated setting is not allowed. 7218 * 7219 * @syscap SystemCapability.ArkUI.ArkUI.Full 7220 * @crossplatform 7221 * @atomicservice 7222 * @since arkts {'1.1':'12','1.2':'20'} 7223 * @arkts 1.1&1.2 7224 */ 7225declare class DrawModifier { 7226 /** 7227 * drawBehind Method. Executed before drawing associated Node. 7228 * 7229 * @param { DrawContext } drawContext - The drawContext used to draw. 7230 * @syscap SystemCapability.ArkUI.ArkUI.Full 7231 * @crossplatform 7232 * @atomicservice 7233 * @since 12 7234 */ 7235 drawBehind?(drawContext: DrawContext): void; 7236 7237 /** 7238 * drawBehind Method. Executed before drawing associated Node. 7239 * 7240 * @param { DrawContext } drawContext - The drawContext used to draw. 7241 * @syscap SystemCapability.ArkUI.ArkUI.Full 7242 * @crossplatform 7243 * @atomicservice 7244 * @since 20 7245 * @arkts 1.2 7246 */ 7247 drawBehind(drawContext: DrawContext): void; 7248 7249 /** 7250 * drawContent Method. Executed when associated Node is drawing, the default drawContent method will be replaced 7251 * if this method is set. 7252 * 7253 * @param { DrawContext } drawContext - The drawContext used to draw. 7254 * @syscap SystemCapability.ArkUI.ArkUI.Full 7255 * @crossplatform 7256 * @atomicservice 7257 * @since 12 7258 */ 7259 drawContent?(drawContext: DrawContext): void; 7260 7261 /** 7262 * drawContent Method. Executed when associated Node is drawing, the default drawContent method will be replaced 7263 * if this method is set. 7264 * 7265 * @param { DrawContext } drawContext - The drawContext used to draw. 7266 * @syscap SystemCapability.ArkUI.ArkUI.Full 7267 * @crossplatform 7268 * @atomicservice 7269 * @since 20 7270 * @arkts 1.2 7271 */ 7272 drawContent(drawContext: DrawContext): void; 7273 7274 7275 /** 7276 * drawFront Method. Executed after drawing associated Node. 7277 * 7278 * @param { DrawContext } drawContext - The drawContext used to draw. 7279 * @syscap SystemCapability.ArkUI.ArkUI.Full 7280 * @crossplatform 7281 * @atomicservice 7282 * @since 12 7283 */ 7284 drawFront?(drawContext: DrawContext): void; 7285 7286 /** 7287 * drawforeground Method. This method is executed after drawing associated Node and its children. 7288 * It allows you to perform additional drawing operations on top of the already rendered content. 7289 * This can be useful for adding visual elements that should appear above the main content. 7290 * 7291 * @param { DrawContext } drawContext - The drawContext used to draw 7292 * @syscap SystemCapability.ArkUI.ArkUI.Full 7293 * @crossplatform 7294 * @atomicservice 7295 * @since 20 7296 */ 7297 drawForeground(drawContext: DrawContext): void; 7298 /** 7299 * drawforeground Method. This method is executed after drawing associated Node and its children. 7300 * It allows you to perform additional drawing operations on top of the already rendered content. 7301 * This can be useful for adding visual elements that should appear above the main content. 7302 * 7303 * @param { DrawContext } drawContext - The drawContext used to draw. 7304 * @syscap SystemCapability.ArkUI.ArkUI.Full 7305 * @crossplatform 7306 * @atomicservice 7307 * @since 20 7308 * @arkts 1.2 7309 */ 7310 drawFront(drawContext: DrawContext): void; 7311 7312 /** 7313 * Invalidate the component, which will cause a re-render of the component. 7314 * No overloading is allowed or needed. 7315 * 7316 * @syscap SystemCapability.ArkUI.ArkUI.Full 7317 * @crossplatform 7318 * @atomicservice 7319 * @since arkts {'1.1':'12','1.2':'20'} 7320 * @arkts 1.1&1.2 7321 */ 7322 invalidate(): void; 7323} 7324 7325/** 7326 * Defines the transition effect 7327 * 7328 * @syscap SystemCapability.ArkUI.ArkUI.Full 7329 * @crossplatform 7330 * @form 7331 * @since 10 7332 */ 7333/** 7334 * Defines the transition effect 7335 * 7336 * @syscap SystemCapability.ArkUI.ArkUI.Full 7337 * @crossplatform 7338 * @form 7339 * @atomicservice 7340 * @since 11 7341 */ 7342declare class TransitionEffect< 7343 Type extends keyof TransitionEffects = keyof TransitionEffects, 7344 Effect extends TransitionEffects[Type] = TransitionEffects[Type] 7345> { 7346 /** 7347 * Disables the transition effect 7348 * 7349 * @type { TransitionEffect<"identity"> } 7350 * @readonly 7351 * @static 7352 * @syscap SystemCapability.ArkUI.ArkUI.Full 7353 * @crossplatform 7354 * @form 7355 * @since 10 7356 */ 7357 /** 7358 * Disables the transition effect 7359 * 7360 * @type { TransitionEffect<"identity"> } 7361 * @readonly 7362 * @static 7363 * @syscap SystemCapability.ArkUI.ArkUI.Full 7364 * @crossplatform 7365 * @form 7366 * @atomicservice 7367 * @since 11 7368 */ 7369 static readonly IDENTITY: TransitionEffect<"identity">; 7370 7371 /** 7372 * Applies a transition effect with the opacity changing from 0 to 1 when the component appears 7373 * And from 1 to 0 when the component disappears. This is equivalent to **TransitionEffect.opacity(0)** 7374 * 7375 * @type { TransitionEffect<"opacity"> } 7376 * @readonly 7377 * @static 7378 * @syscap SystemCapability.ArkUI.ArkUI.Full 7379 * @crossplatform 7380 * @form 7381 * @since 10 7382 */ 7383 /** 7384 * Applies a transition effect with the opacity changing from 0 to 1 when the component appears 7385 * And from 1 to 0 when the component disappears. This is equivalent to **TransitionEffect.opacity(0)** 7386 * 7387 * @type { TransitionEffect<"opacity"> } 7388 * @readonly 7389 * @static 7390 * @syscap SystemCapability.ArkUI.ArkUI.Full 7391 * @crossplatform 7392 * @form 7393 * @atomicservice 7394 * @since 11 7395 */ 7396 static readonly OPACITY: TransitionEffect<"opacity">; 7397 7398 /** 7399 * Applies a transition effect of sliding in from the start edge when the component 7400 * appears and sliding out from the end edge when the component disappears. 7401 * This means sliding in from the left edge and sliding out from the right edge for 7402 * left-to-right scripts, and sliding in from the right edge and sliding out from 7403 * the left edge for right-to-left scripts. This is equivalent to 7404 * TransitionEffect.asymmetric(TransitionEffect.move(TransitionEdge.START), 7405 * TransitionEffect.move(TransitionEdge.END)). 7406 * 7407 * @type { TransitionEffect< 7408 * "asymmetric", 7409 * {appear: TransitionEffect<"move", TransitionEdge>; 7410 * disappear: TransitionEffect<"move", TransitionEdge>; 7411 * }> } 7412 * @readonly 7413 * @static 7414 * @syscap SystemCapability.ArkUI.ArkUI.Full 7415 * @crossplatform 7416 * @form 7417 * @since 10 7418 */ 7419 /** 7420 * Applies a transition effect of sliding in from the start edge when the component 7421 * appears and sliding out from the end edge when the component disappears. 7422 * This means sliding in from the left edge and sliding out from the right edge for 7423 * left-to-right scripts, and sliding in from the right edge and sliding out from 7424 * the left edge for right-to-left scripts. This is equivalent to 7425 * TransitionEffect.asymmetric(TransitionEffect.move(TransitionEdge.START), 7426 * TransitionEffect.move(TransitionEdge.END)). 7427 * 7428 * @type { TransitionEffect< 7429 * "asymmetric", 7430 * {appear: TransitionEffect<"move", TransitionEdge>; 7431 * disappear: TransitionEffect<"move", TransitionEdge>; 7432 * }> } 7433 * @readonly 7434 * @static 7435 * @syscap SystemCapability.ArkUI.ArkUI.Full 7436 * @crossplatform 7437 * @form 7438 * @atomicservice 7439 * @since 11 7440 */ 7441 static readonly SLIDE: TransitionEffect< 7442 "asymmetric", 7443 { 7444 appear: TransitionEffect<"move", TransitionEdge>; 7445 disappear: TransitionEffect<"move", TransitionEdge>; 7446 } 7447 >; 7448 7449 /** 7450 * Applies a transition effect of sliding in from the right with first scaling down and then scaling up 7451 * when the component appears and sliding out from the right 7452 * with first scaling down and then scaling up when the component disappears. 7453 * This transition effect comes with its own animation parameters, which can also be overridden. 7454 * The default animation duration is 600 milliseconds, 7455 * with a specified animation curve of cubicBezierCurve(0.24, 0.0, 0.50, 1.0) and a minimum scale factor of 0.8. 7456 * 7457 * @type { TransitionEffect<"slideSwitch"> } 7458 * @readonly 7459 * @static 7460 * @syscap SystemCapability.ArkUI.ArkUI.Full 7461 * @crossplatform 7462 * @form 7463 * @since 10 7464 */ 7465 /** 7466 * Applies a transition effect of sliding in from the right with first scaling down and then scaling up 7467 * when the component appears and sliding out from the right 7468 * with first scaling down and then scaling up when the component disappears. 7469 * This transition effect comes with its own animation parameters, which can also be overridden. 7470 * The default animation duration is 600 milliseconds, 7471 * with a specified animation curve of cubicBezierCurve(0.24, 0.0, 0.50, 1.0) and a minimum scale factor of 0.8. 7472 * 7473 * @type { TransitionEffect<"slideSwitch"> } 7474 * @readonly 7475 * @static 7476 * @syscap SystemCapability.ArkUI.ArkUI.Full 7477 * @crossplatform 7478 * @form 7479 * @atomicservice 7480 * @since 11 7481 */ 7482 static readonly SLIDE_SWITCH: TransitionEffect<"slideSwitch">; 7483 7484 /** 7485 * Translation of the component during transition, which is the value of the start point 7486 * of insertion and the end point of deletion. 7487 * 7488 * @param { TranslateOptions } options - translate options. 7489 * <br>-**x**: distance to translate along the x-axis. Unit is vp. 7490 * <br>-**y**: distance to translate along the y-axis. Unit is vp. 7491 * <br>-**z**: distance to translate along the z-axis. Unit is vp. 7492 * @returns { TransitionEffect<"translate"> } 7493 * @syscap SystemCapability.ArkUI.ArkUI.Full 7494 * @crossplatform 7495 * @form 7496 * @since 10 7497 */ 7498 /** 7499 * Translation of the component during transition, which is the value of the start point 7500 * of insertion and the end point of deletion. 7501 * 7502 * @param { TranslateOptions } options - translate options. 7503 * <br>-**x**: distance to translate along the x-axis. Unit is vp. 7504 * <br>-**y**: distance to translate along the y-axis. Unit is vp. 7505 * <br>-**z**: distance to translate along the z-axis. Unit is vp. 7506 * @returns { TransitionEffect<"translate"> } 7507 * @syscap SystemCapability.ArkUI.ArkUI.Full 7508 * @crossplatform 7509 * @form 7510 * @atomicservice 7511 * @since 11 7512 */ 7513 static translate(options: TranslateOptions): TransitionEffect<"translate">; 7514 7515 /** 7516 * Rotation of the component during transition, which is the value of the start 7517 * point of insertion and the end point of deletion. 7518 * <br>- **x**: X-component of the rotation vector. 7519 * <br>- **y**: Y-component of the rotation vector. 7520 * <br>- **z**: Z-component of the rotation vector. 7521 * <br>- **centerX** and **centerY**: rotation center point. The default values 7522 * are both **"50%"**, indicating the center point of the page. 7523 * <br>- If the center point is (0, 0), it refers to the upper left corner of the component. 7524 * <br>- **centerZ**: z-axis anchor point, that is, the z-component of the 3D rotation 7525 * center point. The default value is **0**. 7526 * <br>- **perspective**: viewing distance. It is not supported for use in transition animations. 7527 * <br>**Widget capability**: This API can be used in ArkTS widgets since API version 10. 7528 * 7529 * @param { RotateOptions } options - Rotate options. 7530 * @returns { TransitionEffect<"rotate"> } 7531 * @syscap SystemCapability.ArkUI.ArkUI.Full 7532 * @crossplatform 7533 * @form 7534 * @since 10 7535 */ 7536 /** 7537 * Rotation of the component during transition, which is the value of the start 7538 * point of insertion and the end point of deletion. 7539 * <br>- **x**: X-component of the rotation vector. 7540 * <br>- **y**: Y-component of the rotation vector. 7541 * <br>- **z**: Z-component of the rotation vector. 7542 * <br>- **centerX** and **centerY**: rotation center point. The default values 7543 * are both **"50%"**, indicating the center point of the page. 7544 * <br>- If the center point is (0, 0), it refers to the upper left corner of the component. 7545 * <br>- **centerZ**: z-axis anchor point, that is, the z-component of the 3D rotation 7546 * center point. The default value is **0**. 7547 * <br>- **perspective**: viewing distance. It is not supported for use in transition animations. 7548 * <br>**Widget capability**: This API can be used in ArkTS widgets since API version 10. 7549 * 7550 * @param { RotateOptions } options - Rotate options. 7551 * @returns { TransitionEffect<"rotate"> } 7552 * @syscap SystemCapability.ArkUI.ArkUI.Full 7553 * @crossplatform 7554 * @form 7555 * @atomicservice 7556 * @since 11 7557 */ 7558 static rotate(options: RotateOptions): TransitionEffect<"rotate">; 7559 7560 /** 7561 * Scaling of the component during transition, which is the value of the start point of insertion and 7562 * the end point of deletion. 7563 * 7564 * @param { ScaleOptions } options - scale options 7565 * @returns { TransitionEffect<"scale"> } 7566 * @syscap SystemCapability.ArkUI.ArkUI.Full 7567 * @crossplatform 7568 * @form 7569 * @since 10 7570 */ 7571 /** 7572 * Scaling of the component during transition, which is the value of the start point of insertion and 7573 * the end point of deletion. 7574 * 7575 * @param { ScaleOptions } options - scale options 7576 * @returns { TransitionEffect<"scale"> } 7577 * @syscap SystemCapability.ArkUI.ArkUI.Full 7578 * @crossplatform 7579 * @form 7580 * @atomicservice 7581 * @since 11 7582 */ 7583 static scale(options: ScaleOptions): TransitionEffect<"scale">; 7584 7585 /** 7586 * Creates an opacity transition effect with alpha value 7587 * 7588 * @param { number } alpha - opacity alpha value, value range [0, 1]. 7589 * @returns { TransitionEffect<"opacity"> } 7590 * @syscap SystemCapability.ArkUI.ArkUI.Full 7591 * @crossplatform 7592 * @form 7593 * @since 10 7594 */ 7595 /** 7596 * Creates an opacity transition effect with alpha value 7597 * 7598 * @param { number } alpha - opacity alpha value, value range [0, 1]. 7599 * @returns { TransitionEffect<"opacity"> } 7600 * @syscap SystemCapability.ArkUI.ArkUI.Full 7601 * @crossplatform 7602 * @form 7603 * @atomicservice 7604 * @since 11 7605 */ 7606 /** 7607 * Creates an opacity transition effect with alpha value 7608 * 7609 * @param { number } alpha - opacity alpha value, value range [0, 1]. 7610 * Illegal values less than 0 are treated as 0, and illegal values greater than 1 are treated as 1. 7611 * @returns { TransitionEffect<"opacity"> } 7612 * @syscap SystemCapability.ArkUI.ArkUI.Full 7613 * @crossplatform 7614 * @form 7615 * @atomicservice 7616 * @since 12 7617 */ 7618 static opacity(alpha: number): TransitionEffect<"opacity">; 7619 7620 /** 7621 * Slide-in and slide-out of the component from the screen edge during transition. 7622 * It is essentially a translation effect, which is the value of the start point of insertion 7623 * and the end point of deletion. 7624 * 7625 * @param { TransitionEdge } edge - the edge that component will move to 7626 * @returns { TransitionEffect<"move"> } 7627 * @syscap SystemCapability.ArkUI.ArkUI.Full 7628 * @crossplatform 7629 * @form 7630 * @since 10 7631 */ 7632 /** 7633 * Slide-in and slide-out of the component from the screen edge during transition. 7634 * It is essentially a translation effect, which is the value of the start point of insertion 7635 * and the end point of deletion. 7636 * 7637 * @param { TransitionEdge } edge - the edge that component will move to 7638 * @returns { TransitionEffect<"move"> } 7639 * @syscap SystemCapability.ArkUI.ArkUI.Full 7640 * @crossplatform 7641 * @form 7642 * @atomicservice 7643 * @since 11 7644 */ 7645 static move(edge: TransitionEdge): TransitionEffect<"move">; 7646 7647 /** 7648 * Creates an asymmetric transition effect 7649 * 7650 * @param { TransitionEffect } appear - the transition which will be attached when the component is appear 7651 * @param { TransitionEffect } disappear - the transition which will be attached when the component is disappear 7652 * @returns { TransitionEffect<"asymmetric"> } 7653 * @syscap SystemCapability.ArkUI.ArkUI.Full 7654 * @crossplatform 7655 * @form 7656 * @since 10 7657 */ 7658 /** 7659 * Creates an asymmetric transition effect 7660 * 7661 * @param { TransitionEffect } appear - the transition which will be attached when the component is appear 7662 * @param { TransitionEffect } disappear - the transition which will be attached when the component is disappear 7663 * @returns { TransitionEffect<"asymmetric"> } 7664 * @syscap SystemCapability.ArkUI.ArkUI.Full 7665 * @crossplatform 7666 * @form 7667 * @atomicservice 7668 * @since 11 7669 */ 7670 static asymmetric( 7671 appear: TransitionEffect, 7672 disappear: TransitionEffect 7673 ): TransitionEffect<"asymmetric">; 7674 7675 /** 7676 * TransitionEffect constructor 7677 * 7678 * @param { Type } type - transition type 7679 * @param { Effect } effect - transition options 7680 * @syscap SystemCapability.ArkUI.ArkUI.Full 7681 * @crossplatform 7682 * @form 7683 * @since 10 7684 */ 7685 /** 7686 * TransitionEffect constructor 7687 * 7688 * @param { Type } type - transition type 7689 * @param { Effect } effect - transition options 7690 * @syscap SystemCapability.ArkUI.ArkUI.Full 7691 * @crossplatform 7692 * @form 7693 * @atomicservice 7694 * @since 11 7695 */ 7696 constructor(type: Type, effect: Effect); 7697 7698 /** 7699 * Set the animation of current transition effect 7700 * 7701 * @param { AnimateParam } value - animation parameters 7702 * @returns { TransitionEffect } 7703 * @syscap SystemCapability.ArkUI.ArkUI.Full 7704 * @crossplatform 7705 * @form 7706 * @since 10 7707 */ 7708 /** 7709 * Set the animation of current transition effect 7710 * 7711 * @param { AnimateParam } value - animation parameters 7712 * @returns { TransitionEffect } 7713 * @syscap SystemCapability.ArkUI.ArkUI.Full 7714 * @crossplatform 7715 * @form 7716 * @atomicservice 7717 * @since 11 7718 */ 7719 animation(value: AnimateParam): TransitionEffect; 7720 7721 /** 7722 * Combination of transition effects. 7723 * 7724 * @param { TransitionEffect } transitionEffect - transition effect which is be combined 7725 * @returns { TransitionEffect } combined transition effect 7726 * @syscap SystemCapability.ArkUI.ArkUI.Full 7727 * @crossplatform 7728 * @form 7729 * @since 10 7730 */ 7731 /** 7732 * Combination of transition effects. 7733 * 7734 * @param { TransitionEffect } transitionEffect - transition effect which is be combined 7735 * @returns { TransitionEffect } combined transition effect 7736 * @syscap SystemCapability.ArkUI.ArkUI.Full 7737 * @crossplatform 7738 * @form 7739 * @atomicservice 7740 * @since 11 7741 */ 7742 combine(transitionEffect: TransitionEffect): TransitionEffect; 7743} 7744 7745/** 7746 * Defines the transition effect 7747 * 7748 * @syscap SystemCapability.ArkUI.ArkUI.Full 7749 * @crossplatform 7750 * @form 7751 * @atomicservice 7752 * @since 20 7753 * @arkts 1.2 7754 */ 7755declare class TransitionEffect { 7756 7757 /** 7758 * Disables the transition effect 7759 * 7760 * @type { TransitionEffect } 7761 * @readonly 7762 * @static 7763 * @syscap SystemCapability.ArkUI.ArkUI.Full 7764 * @crossplatform 7765 * @form 7766 * @atomicservice 7767 * @since 20 7768 * @arkts 1.2 7769 */ 7770 static readonly IDENTITY: TransitionEffect; 7771 7772 /** 7773 * Specifies a transition effect with transparency of 0, which is equivalent to TransitionEffect.opacity(0). 7774 * 7775 * @type { TransitionEffect } 7776 * @readonly 7777 * @static 7778 * @syscap SystemCapability.ArkUI.ArkUI.Full 7779 * @crossplatform 7780 * @form 7781 * @atomicservice 7782 * @since 20 7783 * @arkts 1.2 7784 */ 7785 static readonly OPACITY: TransitionEffect; 7786 7787 /** 7788 * Defines a slide transition effect 7789 * 7790 * @type { TransitionEffect } 7791 * @readonly 7792 * @static 7793 * @syscap SystemCapability.ArkUI.ArkUI.Full 7794 * @crossplatform 7795 * @form 7796 * @atomicservice 7797 * @since 20 7798 * @arkts 1.2 7799 */ 7800 static readonly SLIDE: TransitionEffect; 7801 7802 /** 7803 * Specify a transition effect where the element enters by shrinking first and then expanding as it slides in from the right, 7804 * and exits by shrinking first and then expanding as it slides out to the left, with a minimum scale ratio of 0.8. 7805 * It comes with default animation parameters, which can also be overridden. 7806 * The default animation duration is set to 600ms, and the specified animation curve is cubicBezierCurve(0.24, 0.0, 0.50, 1.0). 7807 * 7808 * @type { TransitionEffect } 7809 * @readonly 7810 * @static 7811 * @syscap SystemCapability.ArkUI.ArkUI.Full 7812 * @crossplatform 7813 * @form 7814 * @atomicservice 7815 * @since 20 7816 * @arkts 1.2 7817 */ 7818 static readonly SLIDE_SWITCH: TransitionEffect; 7819 7820 /** 7821 * Creates a translate transition effect 7822 * 7823 * @param { TranslateOptions } options - translate options 7824 * @returns { TransitionEffect } 7825 * @static 7826 * @syscap SystemCapability.ArkUI.ArkUI.Full 7827 * @crossplatform 7828 * @form 7829 * @atomicservice 7830 * @since 20 7831 * @arkts 1.2 7832 */ 7833 static translate(options: TranslateOptions): TransitionEffect; 7834 7835 /** 7836 * Creates a rotation transition effect 7837 * 7838 * @param { RotateOptions } options - rotate options 7839 * Set the rotation effect for component transitions when inserting and deleting. 7840 * The value represents the starting rotation point for the inserting animation and the ending rotation point for the deleting animation. 7841 * -x: Horizontal component of the rotational vector. 7842 * -y: Vertical component of the rotational vector. 7843 * -z: Vertical component of the rotational vector. 7844 * -centerX, centerY specify the rotation center point, with default values of "50%", 7845 * meaning that the default rotation center point is the center point of the component. 7846 * -The center point of (0, 0) represents the upper-left corner of the component. 7847 * -centerZ refers to the Z-axis anchor point. The default value of centerZ is 0. 7848 * -perspective indicates the visual distance. The perspective property does not support transition animation. 7849 * @returns { TransitionEffect } 7850 * @static 7851 * @syscap SystemCapability.ArkUI.ArkUI.Full 7852 * @crossplatform 7853 * @form 7854 * @atomicservice 7855 * @since 20 7856 * @arkts 1.2 7857 */ 7858 static rotate(options: RotateOptions): TransitionEffect; 7859 7860 /** 7861 * Creates a scale transition effect 7862 * 7863 * @param { ScaleOptions } options - scale options 7864 * @returns { TransitionEffect } 7865 * @static 7866 * @syscap SystemCapability.ArkUI.ArkUI.Full 7867 * @crossplatform 7868 * @form 7869 * @atomicservice 7870 * @since 20 7871 * @arkts 1.2 7872 */ 7873 static scale(options: ScaleOptions): TransitionEffect; 7874 7875 /** 7876 * Creates an opacity transition effect with alpha value 7877 * 7878 * @param { number } alpha - opacity alpha value, value range [0, 1]. 7879 * Illegal values less than 0 are treated as 0, and illegal values greater than 1 are treated as 1. 7880 * @returns { TransitionEffect } 7881 * @static 7882 * @syscap SystemCapability.ArkUI.ArkUI.Full 7883 * @crossplatform 7884 * @form 7885 * @atomicservice 7886 * @since 20 7887 * @arkts 1.2 7888 */ 7889 static opacity(alpha: number): TransitionEffect; 7890 7891 /** 7892 * Creates a move transition effect 7893 * 7894 * @param { TransitionEdge } edge - the edge that component will move to 7895 * @returns { TransitionEffect } 7896 * @static 7897 * @syscap SystemCapability.ArkUI.ArkUI.Full 7898 * @crossplatform 7899 * @form 7900 * @atomicservice 7901 * @since 20 7902 * @arkts 1.2 7903 */ 7904 static move(edge: TransitionEdge): TransitionEffect; 7905 7906 /** 7907 * Creates an asymmetric transition effect 7908 * 7909 * @param { TransitionEffect } appear - the transition which will be attached when the component is appear 7910 * @param { TransitionEffect } disappear - the transition which will be attached when the component is disappear 7911 * @returns { TransitionEffect } 7912 * @static 7913 * @syscap SystemCapability.ArkUI.ArkUI.Full 7914 * @crossplatform 7915 * @form 7916 * @atomicservice 7917 * @since 20 7918 * @arkts 1.2 7919 */ 7920 static asymmetric(appear: TransitionEffect, disappear: TransitionEffect): TransitionEffect; 7921 7922 /** 7923 * identity or slideSwitch TransitionEffect constructor 7924 * 7925 * @param { 'identity' | 'slideSwitch' } type - transition type 7926 * @param { undefined } effect - transition options 7927 * @syscap SystemCapability.ArkUI.ArkUI.Full 7928 * @crossplatform 7929 * @form 7930 * @atomicservice 7931 * @since 20 7932 * @arkts 1.2 7933 */ 7934 constructor(type: 'identity' | 'slideSwitch', effect: undefined); 7935 7936 /** 7937 * opacity TransitionEffect constructor 7938 * 7939 * @param { 'opacity' } type - transition type 7940 * @param { number } effect - transition options 7941 * @syscap SystemCapability.ArkUI.ArkUI.Full 7942 * @crossplatform 7943 * @form 7944 * @atomicservice 7945 * @since 20 7946 * @arkts 1.2 7947 */ 7948 constructor(type: 'opacity', effect: number); 7949 7950 /** 7951 * move TransitionEffect constructor 7952 * 7953 * @param { 'move' } type - transition type 7954 * @param { TransitionEdge } effect - transition options 7955 * @syscap SystemCapability.ArkUI.ArkUI.Full 7956 * @crossplatform 7957 * @form 7958 * @atomicservice 7959 * @since 20 7960 * @arkts 1.2 7961 */ 7962 constructor(type: 'move', effect: TransitionEdge); 7963 7964 /** 7965 * translate TransitionEffect constructor 7966 * 7967 * @param { 'translate' } type - transition type 7968 * @param { TranslateOptions } effect - transition options 7969 * @syscap SystemCapability.ArkUI.ArkUI.Full 7970 * @crossplatform 7971 * @form 7972 * @atomicservice 7973 * @since 20 7974 * @arkts 1.2 7975 */ 7976 constructor(type: 'translate', effect:TranslateOptions); 7977 7978 /** 7979 * rotate TransitionEffect constructor 7980 * 7981 * @param { 'rotate' } type - transition type 7982 * @param { RotateOptions } effect - transition options 7983 * @syscap SystemCapability.ArkUI.ArkUI.Full 7984 * @crossplatform 7985 * @form 7986 * @atomicservice 7987 * @since 20 7988 * @arkts 1.2 7989 */ 7990 constructor(type: 'rotate', effect: RotateOptions); 7991 7992 /** 7993 * scale TransitionEffect constructor 7994 * 7995 * @param { 'scale' } type - transition type 7996 * @param { ScaleOptions } effect - transition options 7997 * @syscap SystemCapability.ArkUI.ArkUI.Full 7998 * @crossplatform 7999 * @form 8000 * @atomicservice 8001 * @since 20 8002 * @arkts 1.2 8003 */ 8004 constructor(type: 'scale', effect: ScaleOptions); 8005 8006 /** 8007 * asymmetric TransitionEffect constructor 8008 * 8009 * @param { 'asymmetric' } type - transition type 8010 * @param { AsymmetricTransitionOption } effect - transition options 8011 * @syscap SystemCapability.ArkUI.ArkUI.Full 8012 * @crossplatform 8013 * @form 8014 * @atomicservice 8015 * @since 20 8016 * @arkts 1.2 8017 */ 8018 constructor(type: 'asymmetric', effect: AsymmetricTransitionOption); 8019 8020 /** 8021 * Set the animation of current transition effect 8022 * 8023 * @param { AnimateParam } value - animation parameters 8024 * @returns { TransitionEffect } 8025 * @syscap SystemCapability.ArkUI.ArkUI.Full 8026 * @crossplatform 8027 * @form 8028 * @atomicservice 8029 * @since 20 8030 * @arkts 1.2 8031 */ 8032 animation(value: AnimateParam): TransitionEffect; 8033 8034 /** 8035 * Combines another transition effect 8036 * 8037 * @param { TransitionEffect } transitionEffect - transition effect which is be combined 8038 * @returns { TransitionEffect } combined transition effect 8039 * @syscap SystemCapability.ArkUI.ArkUI.Full 8040 * @crossplatform 8041 * @form 8042 * @atomicservice 8043 * @since 20 8044 * @arkts 1.2 8045 */ 8046 combine(transitionEffect: TransitionEffect): TransitionEffect; 8047} 8048 8049/** 8050 * Define Preview property 8051 * 8052 * @interface PreviewParams 8053 * @syscap SystemCapability.ArkUI.ArkUI.Full 8054 * @form 8055 * @since 9 8056 */ 8057/** 8058 * Define Preview property 8059 * 8060 * @interface PreviewParams 8061 * @syscap SystemCapability.ArkUI.ArkUI.Full 8062 * @crossplatform 8063 * @form 8064 * @atomicservice 8065 * @since 11 8066 */ 8067interface PreviewParams { 8068 /** 8069 * Define Preview title 8070 * 8071 * @type { ?string } 8072 * @syscap SystemCapability.ArkUI.ArkUI.Full 8073 * @form 8074 * @since 9 8075 */ 8076 /** 8077 * Define Preview title 8078 * 8079 * @type { ?string } 8080 * @syscap SystemCapability.ArkUI.ArkUI.Full 8081 * @crossplatform 8082 * @form 8083 * @atomicservice 8084 * @since 11 8085 */ 8086 title?: string; 8087 8088 /** 8089 * Define Preview width 8090 * 8091 * @type { ?number } 8092 * @syscap SystemCapability.ArkUI.ArkUI.Full 8093 * @form 8094 * @since 9 8095 */ 8096 /** 8097 * Define Preview width 8098 * 8099 * @type { ?number } 8100 * @syscap SystemCapability.ArkUI.ArkUI.Full 8101 * @crossplatform 8102 * @form 8103 * @atomicservice 8104 * @since 11 8105 */ 8106 width?: number; 8107 8108 /** 8109 * Define Preview height 8110 * 8111 * @type { ?number } 8112 * @syscap SystemCapability.ArkUI.ArkUI.Full 8113 * @form 8114 * @since 9 8115 */ 8116 /** 8117 * Define Preview height 8118 * 8119 * @type { ?number } 8120 * @syscap SystemCapability.ArkUI.ArkUI.Full 8121 * @crossplatform 8122 * @form 8123 * @atomicservice 8124 * @since 11 8125 */ 8126 height?: number; 8127 8128 /** 8129 * Define Preview locale 8130 * 8131 * @type { ?string } 8132 * @syscap SystemCapability.ArkUI.ArkUI.Full 8133 * @form 8134 * @since 9 8135 */ 8136 /** 8137 * Define Preview locale 8138 * 8139 * @type { ?string } 8140 * @syscap SystemCapability.ArkUI.ArkUI.Full 8141 * @form 8142 * @atomicservice 8143 * @since 11 8144 */ 8145 locale?: string; 8146 8147 /** 8148 * Define Preview colorMode 8149 * 8150 * @type { ?string } 8151 * @syscap SystemCapability.ArkUI.ArkUI.Full 8152 * @form 8153 * @since 9 8154 */ 8155 /** 8156 * Define Preview colorMode 8157 * 8158 * @type { ?string } 8159 * @syscap SystemCapability.ArkUI.ArkUI.Full 8160 * @crossplatform 8161 * @form 8162 * @atomicservice 8163 * @since 11 8164 */ 8165 colorMode?: string; 8166 8167 /** 8168 * Define Preview deviceType 8169 * 8170 * @type { ?string } 8171 * @syscap SystemCapability.ArkUI.ArkUI.Full 8172 * @form 8173 * @since 9 8174 */ 8175 /** 8176 * Define Preview deviceType 8177 * 8178 * @type { ?string } 8179 * @syscap SystemCapability.ArkUI.ArkUI.Full 8180 * @form 8181 * @atomicservice 8182 * @since 11 8183 */ 8184 deviceType?: string; 8185 8186 /** 8187 * Define Preview dpi 8188 * 8189 * @type { ?number } 8190 * @syscap SystemCapability.ArkUI.ArkUI.Full 8191 * @form 8192 * @since 9 8193 */ 8194 /** 8195 * Define Preview dpi 8196 * 8197 * @type { ?number } 8198 * @syscap SystemCapability.ArkUI.ArkUI.Full 8199 * @form 8200 * @atomicservice 8201 * @since 11 8202 */ 8203 dpi?: number; 8204 8205 /** 8206 * Define Preview orientation 8207 * 8208 * @type { ?string } 8209 * @syscap SystemCapability.ArkUI.ArkUI.Full 8210 * @form 8211 * @since 9 8212 */ 8213 /** 8214 * Define Preview orientation 8215 * 8216 * @type { ?string } 8217 * @syscap SystemCapability.ArkUI.ArkUI.Full 8218 * @form 8219 * @atomicservice 8220 * @since 11 8221 */ 8222 orientation?: string; 8223 8224 /** 8225 * Define Preview roundScreen 8226 * 8227 * @type { ?boolean } 8228 * @syscap SystemCapability.ArkUI.ArkUI.Full 8229 * @form 8230 * @since 9 8231 */ 8232 /** 8233 * Define Preview roundScreen 8234 * 8235 * @type { ?boolean } 8236 * @syscap SystemCapability.ArkUI.ArkUI.Full 8237 * @form 8238 * @atomicservice 8239 * @since 11 8240 */ 8241 roundScreen?: boolean; 8242} 8243 8244/** 8245 * ItemDragInfo object description 8246 * 8247 * @interface ItemDragInfo 8248 * @syscap SystemCapability.ArkUI.ArkUI.Full 8249 * @since 8 8250 */ 8251/** 8252 * ItemDragInfo object description 8253 * 8254 * @interface ItemDragInfo 8255 * @syscap SystemCapability.ArkUI.ArkUI.Full 8256 * @crossplatform 8257 * @since 10 8258 */ 8259/** 8260 * ItemDragInfo object description 8261 * 8262 * @interface ItemDragInfo 8263 * @syscap SystemCapability.ArkUI.ArkUI.Full 8264 * @crossplatform 8265 * @atomicservice 8266 * @since arkts {'1.1':'11','1.2':'20'} 8267 * @arkts 1.1&1.2 8268 */ 8269declare interface ItemDragInfo { 8270 /** 8271 * Obtains the X coordinate of the drag window, in vp. 8272 * 8273 * @type { number } 8274 * @syscap SystemCapability.ArkUI.ArkUI.Full 8275 * @since 8 8276 */ 8277 /** 8278 * Obtains the X coordinate of the drag window, in vp. 8279 * 8280 * @type { number } 8281 * @syscap SystemCapability.ArkUI.ArkUI.Full 8282 * @crossplatform 8283 * @since 10 8284 */ 8285 /** 8286 * Obtains the X coordinate of the drag window, in vp. 8287 * 8288 * @type { number } 8289 * @syscap SystemCapability.ArkUI.ArkUI.Full 8290 * @crossplatform 8291 * @atomicservice 8292 * @since arkts {'1.1':'11','1.2':'20'} 8293 * @arkts 1.1&1.2 8294 */ 8295 x: number; 8296 8297 /** 8298 * Obtains the Y coordinate of the drag window, in vp. 8299 * 8300 * @type { number } 8301 * @syscap SystemCapability.ArkUI.ArkUI.Full 8302 * @since 8 8303 */ 8304 /** 8305 * Obtains the Y coordinate of the drag window, in vp. 8306 * 8307 * @type { number } 8308 * @syscap SystemCapability.ArkUI.ArkUI.Full 8309 * @crossplatform 8310 * @since 10 8311 */ 8312 /** 8313 * Obtains the Y coordinate of the drag window, in vp. 8314 * 8315 * @type { number } 8316 * @syscap SystemCapability.ArkUI.ArkUI.Full 8317 * @crossplatform 8318 * @atomicservice 8319 * @since arkts {'1.1':'11','1.2':'20'} 8320 * @arkts 1.1&1.2 8321 */ 8322 y: number; 8323} 8324 8325/** 8326 * Enum of using the effects template mode. 8327 * 8328 * @enum { number } 8329 * @syscap SystemCapability.ArkUI.ArkUI.Full 8330 * @atomicservice 8331 * @since arkts {'1.1':'14','1.2':'20'} 8332 * @arkts 1.1&1.2 8333 */ 8334declare enum EffectType { 8335 /** 8336 * Define use the effects template defined by the parent effectComponent. 8337 * 8338 * @syscap SystemCapability.ArkUI.ArkUI.Full 8339 * @atomicservice 8340 * @since arkts {'1.1':'14','1.2':'20'} 8341 * @arkts 1.1&1.2 8342 */ 8343 DEFAULT = 0, 8344 /** 8345 * Define use the effects template defined by the window. 8346 * 8347 * @syscap SystemCapability.ArkUI.ArkUI.Full 8348 * @atomicservice 8349 * @since arkts {'1.1':'14','1.2':'20'} 8350 * @arkts 1.1&1.2 8351 */ 8352 WINDOW_EFFECT = 1, 8353} 8354 8355/** 8356 * Defines the drag status before drag action. 8357 * 8358 * @enum { number } 8359 * @syscap SystemCapability.ArkUI.ArkUI.Full 8360 * @atomicservice 8361 * @since arkts {'1.1':'12','1.2':'20'} 8362 * @arkts 1.1&1.2 8363 */ 8364declare enum PreDragStatus { 8365 /** 8366 * Define the status for user prepare to start long press gesture. 8367 * 8368 * @syscap SystemCapability.ArkUI.ArkUI.Full 8369 * @atomicservice 8370 * @since arkts {'1.1':'12','1.2':'20'} 8371 * @arkts 1.1&1.2 8372 */ 8373 ACTION_DETECTING_STATUS = 0, 8374 8375 /** 8376 * Define the status for user can start drag action. 8377 * 8378 * @syscap SystemCapability.ArkUI.ArkUI.Full 8379 * @atomicservice 8380 * @since arkts {'1.1':'12','1.2':'20'} 8381 * @arkts 1.1&1.2 8382 */ 8383 READY_TO_TRIGGER_DRAG_ACTION = 1, 8384 8385 /** 8386 * Define the status for dragItem lift animation started. 8387 * 8388 * @syscap SystemCapability.ArkUI.ArkUI.Full 8389 * @atomicservice 8390 * @since arkts {'1.1':'12','1.2':'20'} 8391 * @arkts 1.1&1.2 8392 */ 8393 PREVIEW_LIFT_STARTED = 2, 8394 8395 /** 8396 * Define the status for dragItem lift animation finished. 8397 * 8398 * @syscap SystemCapability.ArkUI.ArkUI.Full 8399 * @atomicservice 8400 * @since arkts {'1.1':'12','1.2':'20'} 8401 * @arkts 1.1&1.2 8402 */ 8403 PREVIEW_LIFT_FINISHED = 3, 8404 8405 /** 8406 * Define the status for dragItem landing animation started. 8407 * 8408 * @syscap SystemCapability.ArkUI.ArkUI.Full 8409 * @atomicservice 8410 * @since arkts {'1.1':'12','1.2':'20'} 8411 * @arkts 1.1&1.2 8412 */ 8413 PREVIEW_LANDING_STARTED = 4, 8414 8415 /** 8416 * Define the status for dragItem landing animation finished. 8417 * 8418 * @syscap SystemCapability.ArkUI.ArkUI.Full 8419 * @atomicservice 8420 * @since arkts {'1.1':'12','1.2':'20'} 8421 * @arkts 1.1&1.2 8422 */ 8423 PREVIEW_LANDING_FINISHED = 5, 8424 8425 /** 8426 * Define the status for user cancel drag action. 8427 * 8428 * @syscap SystemCapability.ArkUI.ArkUI.Full 8429 * @atomicservice 8430 * @since arkts {'1.1':'12','1.2':'20'} 8431 * @arkts 1.1&1.2 8432 */ 8433 ACTION_CANCELED_BEFORE_DRAG = 6, 8434 8435 /** 8436 * Define the status for user to sense the availability of drag in advance. 8437 * 8438 * @syscap SystemCapability.ArkUI.ArkUI.Full 8439 * @atomicservice 8440 * @since arkts {'1.1':'18','1.2':'20'} 8441 * @arkts 1.1&1.2 8442 */ 8443 PREPARING_FOR_DRAG_DETECTION = 7, 8444} 8445 8446/** 8447 * DragItemInfo object description 8448 * 8449 * @interface DragItemInfo 8450 * @syscap SystemCapability.ArkUI.ArkUI.Full 8451 * @since 8 8452 */ 8453/** 8454 * DragItemInfo object description 8455 * 8456 * @interface DragItemInfo 8457 * @syscap SystemCapability.ArkUI.ArkUI.Full 8458 * @atomicservice 8459 * @since 11 8460 */ 8461/** 8462 * DragItemInfo object description 8463 * 8464 * @interface DragItemInfo 8465 * @syscap SystemCapability.ArkUI.ArkUI.Full 8466 * @crossplatform 8467 * @atomicservice 8468 * @since arkts {'1.1':'14','1.2':'20'} 8469 * @arkts 1.1&1.2 8470 */ 8471declare interface DragItemInfo { 8472 /** 8473 * Uses the pixelMap object for drawing. 8474 * 8475 * @type { ?PixelMap } 8476 * @syscap SystemCapability.ArkUI.ArkUI.Full 8477 * @since 8 8478 */ 8479 /** 8480 * Uses the pixelMap object for drawing. 8481 * 8482 * @type { ?PixelMap } 8483 * @syscap SystemCapability.ArkUI.ArkUI.Full 8484 * @atomicservice 8485 * @since 11 8486 */ 8487 /** 8488 * Uses the pixelMap object for drawing. 8489 * 8490 * @type { ?PixelMap } 8491 * @syscap SystemCapability.ArkUI.ArkUI.Full 8492 * @crossplatform 8493 * @atomicservice 8494 * @since arkts{'1.1':'14','1.2':'20'} 8495 * @arkts 1.1&1.2 8496 */ 8497 pixelMap?: PixelMap; 8498 8499 /** 8500 * Uses the custom builder for drawing, if pixelMap is set, this value is ignored. 8501 * 8502 * @type { ?CustomBuilder } 8503 * @syscap SystemCapability.ArkUI.ArkUI.Full 8504 * @since 8 8505 */ 8506 /** 8507 * Uses the custom builder for drawing, if pixelMap is set, this value is ignored. 8508 * 8509 * @type { ?CustomBuilder } 8510 * @syscap SystemCapability.ArkUI.ArkUI.Full 8511 * @atomicservice 8512 * @since 11 8513 */ 8514 /** 8515 * Uses the custom builder for drawing, if pixelMap is set, this value is ignored. 8516 * 8517 * @type { ?CustomBuilder } 8518 * @syscap SystemCapability.ArkUI.ArkUI.Full 8519 * @crossplatform 8520 * @atomicservice 8521 * @since arkts {'1.1':'14','1.2':'20'} 8522 * @arkts 1.1&1.2 8523 */ 8524 builder?: CustomBuilder; 8525 8526 /** 8527 * Sets the extra info for drag event. 8528 * 8529 * @type { ?string } 8530 * @syscap SystemCapability.ArkUI.ArkUI.Full 8531 * @since 8 8532 */ 8533 /** 8534 * Sets the extra info for drag event. 8535 * 8536 * @type { ?string } 8537 * @syscap SystemCapability.ArkUI.ArkUI.Full 8538 * @atomicservice 8539 * @since 11 8540 */ 8541 /** 8542 * Sets the extra info for drag event. 8543 * 8544 * @type { ?string } 8545 * @syscap SystemCapability.ArkUI.ArkUI.Full 8546 * @crossplatform 8547 * @atomicservice 8548 * @since arkts {'1.1':'14','1.2':'20'} 8549 * @arkts 1.1&1.2 8550 */ 8551 extraInfo?: string; 8552} 8553 8554/** 8555 * Defining animation function. 8556 * 8557 * @param { AnimateParam } value 8558 * @param { function } event 8559 * @syscap SystemCapability.ArkUI.ArkUI.Full 8560 * @since 7 8561 */ 8562/** 8563 * Defining animation function. 8564 * 8565 * @param { AnimateParam } value 8566 * @param { function } event 8567 * @syscap SystemCapability.ArkUI.ArkUI.Full 8568 * @form 8569 * @since 9 8570 */ 8571/** 8572 * Defining animation function. 8573 * 8574 * @param { AnimateParam } value 8575 * @param { function } event 8576 * @syscap SystemCapability.ArkUI.ArkUI.Full 8577 * @crossplatform 8578 * @form 8579 * @since 10 8580 */ 8581/** 8582 * Defining animation function. 8583 * 8584 * @param { AnimateParam } value 8585 * @param { function } event 8586 * @syscap SystemCapability.ArkUI.ArkUI.Full 8587 * @crossplatform 8588 * @form 8589 * @atomicservice 8590 * @since arkts {'1.1':'11','1.2':'20'} 8591 * @arkts 1.1&1.2 8592 * @deprecated since 18 8593 * @useinstead ohos.arkui.UIContext.UIContext#animateTo 8594 */ 8595declare function animateTo(value: AnimateParam, event: () => void): void; 8596 8597/** 8598 * Implements immediate delivery of an explicit animation through a **UIContext** object. 8599 * When multiple property animations are loaded at once, you can call this API to immediately 8600 * execute the transition animation for state changes caused by the specified closure function. 8601 * 8602 * @param { AnimateParam } value - Set animation effect parameters. 8603 * @param { function } event - Specify the closure function that displays dynamic effects, 8604 * and the system will automatically insert transition animations for state changes caused by the closure function. 8605 * @syscap SystemCapability.ArkUI.ArkUI.Full 8606 * @atomicservice 8607 * @since arkts {'1.1':'12','1.2':'20'} 8608 * @arkts 1.1&1.2 8609 */ 8610declare function animateToImmediately(value: AnimateParam, event: () => void): void; 8611 8612/** 8613 * Converts a value in vp units to a value in px. 8614 * By default, the virtual pixel ratio of the screen where the current UI instance is located is used for conversion. 8615 * If no UI instance is available, the virtual pixel ratio of the default screen is used instead. 8616 * 8617 * @param { number } value 8618 * Value range of value: (-∞, +∞). 8619 * @returns { number } 8620 * Value range of the return value: (-∞, +∞). 8621 * @syscap SystemCapability.ArkUI.ArkUI.Full 8622 * @since 7 8623 */ 8624/** 8625 * Converts a value in vp units to a value in px. 8626 * By default, the virtual pixel ratio of the screen where the current UI instance is located is used for conversion. 8627 * If no UI instance is available, the virtual pixel ratio of the default screen is used instead. 8628 * 8629 * @param { number } value 8630 * Value range of value: (-∞, +∞). 8631 * @returns { number } 8632 * Value range of the return value: (-∞, +∞). 8633 * @syscap SystemCapability.ArkUI.ArkUI.Full 8634 * @form 8635 * @since 9 8636 */ 8637/** 8638 * Converts a value in vp units to a value in px. 8639 * By default, the virtual pixel ratio of the screen where the current UI instance is located is used for conversion. 8640 * If no UI instance is available, the virtual pixel ratio of the default screen is used instead. 8641 * 8642 * @param { number } value 8643 * Value range of value: (-∞, +∞). 8644 * @returns { number } 8645 * Value range of the return value: (-∞, +∞). 8646 * @syscap SystemCapability.ArkUI.ArkUI.Full 8647 * @crossplatform 8648 * @form 8649 * @since 10 8650 */ 8651/** 8652 * Converts a value in vp units to a value in px. 8653 * By default, the virtual pixel ratio of the screen where the current UI instance is located is used for conversion. 8654 * If no UI instance is available, the virtual pixel ratio of the default screen is used instead. 8655 * 8656 * @param { number } value 8657 * Value range of value: (-∞, +∞). 8658 * @returns { number } 8659 * Value range of the return value: (-∞, +∞). 8660 * @syscap SystemCapability.ArkUI.ArkUI.Full 8661 * @crossplatform 8662 * @form 8663 * @atomicservice 8664 * @since arkts {'1.1':'11','1.2':'20'} 8665 * @arkts 1.1&1.2 8666 * @deprecated since 18 8667 * @useinstead ohos.arkui.UIContext.UIContext#vp2px 8668 */ 8669declare function vp2px(value: number): number; 8670 8671/** 8672 * Converts a number in units of px to a number in units of vp. 8673 * By default, the virtual pixel ratio of the screen where the current UI instance is located is used for conversion. 8674 * If no UI instance is available, the virtual pixel ratio of the default screen is used instead. 8675 * 8676 * @param { number } value 8677 * Value range of value: (-∞, +∞). 8678 * @returns { number } 8679 * Value range of the return value: (-∞, +∞). 8680 * @syscap SystemCapability.ArkUI.ArkUI.Full 8681 * @since 7 8682 */ 8683/** 8684 * Converts a number in units of px to a number in units of vp. 8685 * By default, the virtual pixel ratio of the screen where the current UI instance is located is used for conversion. 8686 * If no UI instance is available, the virtual pixel ratio of the default screen is used instead. 8687 * 8688 * @param { number } value 8689 * Value range of value: (-∞, +∞). 8690 * @returns { number } 8691 * Value range of the return value: (-∞, +∞). 8692 * @syscap SystemCapability.ArkUI.ArkUI.Full 8693 * @form 8694 * @since 9 8695 */ 8696/** 8697 * Converts a number in units of px to a number in units of vp. 8698 * By default, the virtual pixel ratio of the screen where the current UI instance is located is used for conversion. 8699 * If no UI instance is available, the virtual pixel ratio of the default screen is used instead. 8700 * 8701 * @param { number } value 8702 * Value range of value: (-∞, +∞). 8703 * @returns { number } 8704 * Value range of the return value: (-∞, +∞). 8705 * @syscap SystemCapability.ArkUI.ArkUI.Full 8706 * @crossplatform 8707 * @form 8708 * @since 10 8709 */ 8710/** 8711 * Converts a number in units of px to a number in units of vp. 8712 * By default, the virtual pixel ratio of the screen where the current UI instance is located is used for conversion. 8713 * If no UI instance is available, the virtual pixel ratio of the default screen is used instead. 8714 * 8715 * @param { number } value 8716 * Value range of value: (-∞, +∞). 8717 * @returns { number } 8718 * Value range of the return value: (-∞, +∞). 8719 * @syscap SystemCapability.ArkUI.ArkUI.Full 8720 * @crossplatform 8721 * @form 8722 * @atomicservice 8723 * @since arkts {'1.1':'11','1.2':'20'} 8724 * @arkts 1.1&1.2 8725 * @deprecated since 18 8726 * @useinstead ohos.arkui.UIContext.UIContext#px2vp 8727 */ 8728declare function px2vp(value: number): number; 8729 8730/** 8731 * Converts a number in fp units to a number in px. 8732 * 8733 * @param { number } value 8734 * Value range of value: (-∞, +∞). 8735 * @returns { number } 8736 * Value range of the return value: (-∞, +∞). 8737 * @syscap SystemCapability.ArkUI.ArkUI.Full 8738 * @since 7 8739 */ 8740/** 8741 * Converts a number in fp units to a number in px. 8742 * 8743 * @param { number } value 8744 * Value range of value: (-∞, +∞). 8745 * @returns { number } 8746 * Value range of the return value: (-∞, +∞). 8747 * @syscap SystemCapability.ArkUI.ArkUI.Full 8748 * @form 8749 * @since 9 8750 */ 8751/** 8752 * Converts a number in fp units to a number in px. 8753 * 8754 * @param { number } value 8755 * Value range of value: (-∞, +∞). 8756 * @returns { number } 8757 * Value range of the return value: (-∞, +∞). 8758 * @syscap SystemCapability.ArkUI.ArkUI.Full 8759 * @crossplatform 8760 * @form 8761 * @since 10 8762 */ 8763/** 8764 * Converts a number in fp units to a number in px. 8765 * 8766 * @param { number } value 8767 * Value range of value: (-∞, +∞). 8768 * @returns { number } 8769 * Value range of the return value: (-∞, +∞). 8770 * @syscap SystemCapability.ArkUI.ArkUI.Full 8771 * @crossplatform 8772 * @form 8773 * @atomicservice 8774 * @since 11 8775 * @deprecated since 18 8776 * @useinstead ohos.arkui.UIContext.UIContext#fp2px 8777 */ 8778declare function fp2px(value: number): number; 8779 8780/** 8781 * Converts a number in units of px to a number in units of fp. 8782 * 8783 * @param { number } value 8784 * Value range of value: (-∞, +∞). 8785 * @returns { number } 8786 * Value range of the return value: (-∞, +∞). 8787 * @syscap SystemCapability.ArkUI.ArkUI.Full 8788 * @since 7 8789 */ 8790/** 8791 * Converts a number in units of px to a number in units of fp. 8792 * 8793 * @param { number } value 8794 * Value range of value: (-∞, +∞). 8795 * @returns { number } 8796 * Value range of the return value: (-∞, +∞). 8797 * @syscap SystemCapability.ArkUI.ArkUI.Full 8798 * @form 8799 * @since 9 8800 */ 8801/** 8802 * Converts a number in units of px to a number in units of fp. 8803 * 8804 * @param { number } value 8805 * Value range of value: (-∞, +∞). 8806 * @returns { number } 8807 * Value range of the return value: (-∞, +∞). 8808 * @syscap SystemCapability.ArkUI.ArkUI.Full 8809 * @crossplatform 8810 * @form 8811 * @since 10 8812 */ 8813/** 8814 * Converts a number in units of px to a number in units of fp. 8815 * 8816 * @param { number } value 8817 * Value range of value: (-∞, +∞). 8818 * @returns { number } 8819 * Value range of the return value: (-∞, +∞). 8820 * @syscap SystemCapability.ArkUI.ArkUI.Full 8821 * @crossplatform 8822 * @form 8823 * @atomicservice 8824 * @since 11 8825 * @deprecated since 18 8826 * @useinstead ohos.arkui.UIContext.UIContext#px2fp 8827 */ 8828declare function px2fp(value: number): number; 8829 8830/** 8831 * Converts a number in units of lpx to a number in units of px. 8832 * 8833 * @param { number } value 8834 * Value range of value: (-∞, +∞). 8835 * @returns { number } 8836 * Value range of the return value: (-∞, +∞). 8837 * @syscap SystemCapability.ArkUI.ArkUI.Full 8838 * @since 7 8839 */ 8840/** 8841 * Converts a number in units of lpx to a number in units of px. 8842 * 8843 * @param { number } value 8844 * Value range of value: (-∞, +∞). 8845 * @returns { number } 8846 * Value range of the return value: (-∞, +∞). 8847 * @syscap SystemCapability.ArkUI.ArkUI.Full 8848 * @form 8849 * @since 9 8850 */ 8851/** 8852 * Converts a number in units of lpx to a number in units of px. 8853 * 8854 * @param { number } value 8855 * Value range of value: (-∞, +∞). 8856 * @returns { number } 8857 * Value range of the return value: (-∞, +∞). 8858 * @syscap SystemCapability.ArkUI.ArkUI.Full 8859 * @crossplatform 8860 * @form 8861 * @since 10 8862 */ 8863/** 8864 * Converts a number in units of lpx to a number in units of px. 8865 * 8866 * @param { number } value 8867 * Value range of value: (-∞, +∞). 8868 * @returns { number } 8869 * Value range of the return value: (-∞, +∞). 8870 * @syscap SystemCapability.ArkUI.ArkUI.Full 8871 * @crossplatform 8872 * @form 8873 * @atomicservice 8874 * @since 11 8875 * @deprecated since 18 8876 * @useinstead ohos.arkui.UIContext.UIContext#lpx2px 8877 */ 8878declare function lpx2px(value: number): number; 8879 8880/** 8881 * Converts a number in units of px to a number in units of lpx. 8882 * 8883 * @param { number } value 8884 * Value range of value: (-∞, +∞). 8885 * @returns { number } 8886 * Value range of the return value: (-∞, +∞). 8887 * @syscap SystemCapability.ArkUI.ArkUI.Full 8888 * @since 7 8889 */ 8890/** 8891 * Converts a number in units of px to a number in units of lpx. 8892 * 8893 * @param { number } value 8894 * Value range of value: (-∞, +∞). 8895 * @returns { number } 8896 * Value range of the return value: (-∞, +∞). 8897 * @syscap SystemCapability.ArkUI.ArkUI.Full 8898 * @form 8899 * @since 9 8900 */ 8901/** 8902 * Converts a number in units of px to a number in units of lpx. 8903 * 8904 * @param { number } value 8905 * Value range of value: (-∞, +∞). 8906 * @returns { number } 8907 * Value range of the return value: (-∞, +∞). 8908 * @syscap SystemCapability.ArkUI.ArkUI.Full 8909 * @crossplatform 8910 * @form 8911 * @since 10 8912 */ 8913/** 8914 * Converts a number in units of px to a number in units of lpx. 8915 * 8916 * @param { number } value 8917 * Value range of value: (-∞, +∞). 8918 * @returns { number } 8919 * Value range of the return value: (-∞, +∞). 8920 * @syscap SystemCapability.ArkUI.ArkUI.Full 8921 * @crossplatform 8922 * @form 8923 * @atomicservice 8924 * @since 11 8925 * @deprecated since 18 8926 * @useinstead ohos.arkui.UIContext.UIContext#px2lpx 8927 */ 8928declare function px2lpx(value: number): number; 8929 8930/** 8931 * Defines the namespace of focus controller. 8932 * 8933 * @namespace focusControl 8934 * @syscap SystemCapability.ArkUI.ArkUI.Full 8935 * @crossplatform 8936 * @form 8937 * @since 9 8938 */ 8939/** 8940 * Defines the namespace of focus controller. 8941 * 8942 * @namespace focusControl 8943 * @syscap SystemCapability.ArkUI.ArkUI.Full 8944 * @crossplatform 8945 * @form 8946 * @atomicservice 8947 * @since arkts {'1.1':'11','1.2':'20'} 8948 * @arkts 1.1&1.2 8949 */ 8950declare namespace focusControl { 8951 /** 8952 * Request focus to the specific component by param: 'id/key'. 8953 * 8954 * @param { string } value 8955 * @returns { boolean } 8956 * @syscap SystemCapability.ArkUI.ArkUI.Full 8957 * @since 9 8958 */ 8959 /** 8960 * Request focus to the specific component by param: 'id/key'. 8961 * 8962 * @param { string } value 8963 * @returns { boolean } 8964 * @syscap SystemCapability.ArkUI.ArkUI.Full 8965 * @crossplatform 8966 * @since 10 8967 */ 8968 /** 8969 * Request focus to the specific component by param: 'id/key'. 8970 * 8971 * @param { string } value 8972 * @returns { boolean } 8973 * @syscap SystemCapability.ArkUI.ArkUI.Full 8974 * @crossplatform 8975 * @atomicservice 8976 * @since arkts {'1.1':'11','1.2':'20'} 8977 * @arkts 1.1&1.2 8978 */ 8979 function requestFocus(value: string): boolean; 8980} 8981 8982/** 8983 * Import the PointerStyle type object for setCursor. 8984 * 8985 * @typedef { import('../api/@ohos.multimodalInput.pointer').default.PointerStyle } PointerStyle 8986 * @syscap SystemCapability.ArkUI.ArkUI.Full 8987 * @since 11 8988 */ 8989/** 8990 * Import the PointerStyle type object for setCursor. 8991 * 8992 * @typedef { import('../api/@ohos.multimodalInput.pointer').default.PointerStyle } PointerStyle 8993 * @syscap SystemCapability.ArkUI.ArkUI.Full 8994 * @atomicservice 8995 * @since 12 8996 */ 8997declare type PointerStyle = import('../api/@ohos.multimodalInput.pointer').default.PointerStyle; 8998 8999/** 9000 * Import the PointerStyle type object for setCursor. 9001 * 9002 * @typedef { pointer.PointerStyle } PointerStyle 9003 * @syscap SystemCapability.ArkUI.ArkUI.Full 9004 * @atomicservice 9005 * @since 20 9006 * @arkts 1.2 9007 */ 9008declare type PointerStyle = pointer.PointerStyle; 9009 9010/** 9011 * CursorControl 9012 * 9013 * @namespace cursorControl 9014 * @syscap SystemCapability.ArkUI.ArkUI.Full 9015 * @since 11 9016 */ 9017/** 9018 * CursorControl 9019 * 9020 * @namespace cursorControl 9021 * @syscap SystemCapability.ArkUI.ArkUI.Full 9022 * @atomicservice 9023 * @since arkts {'1.1':'12','1.2':'20'} 9024 * @arkts 1.1&1.2 9025 */ 9026declare namespace cursorControl { 9027 9028 /** 9029 * Change the mouse cursor style by param: 'PointerStyle'. 9030 * 9031 * @param { PointerStyle } value 9032 * @syscap SystemCapability.ArkUI.ArkUI.Full 9033 * @crossplatform 9034 * @since 11 9035 */ 9036 /** 9037 * Change the mouse cursor style by param: 'PointerStyle'. 9038 * 9039 * @param { PointerStyle } value - Cursor style. 9040 * @syscap SystemCapability.ArkUI.ArkUI.Full 9041 * @crossplatform 9042 * @atomicservice 9043 * @since arkts {'1.1':'12','1.2':'20'} 9044 * @arkts 1.1&1.2 9045 */ 9046 function setCursor(value: PointerStyle): void; 9047 9048 /** 9049 * Restore the default mouse cursor style. 9050 * 9051 * @syscap SystemCapability.ArkUI.ArkUI.Full 9052 * @crossplatform 9053 * @since 11 9054 */ 9055 /** 9056 * Restore the default mouse cursor style. 9057 * 9058 * @syscap SystemCapability.ArkUI.ArkUI.Full 9059 * @crossplatform 9060 * @atomicservice 9061 * @since arkts {'1.1':'12','1.2':'20'} 9062 * @arkts 1.1&1.2 9063 */ 9064 function restoreDefault(): void; 9065} 9066 9067/** 9068 * Defines the event target. 9069 * 9070 * @interface EventTarget 9071 * @syscap SystemCapability.ArkUI.ArkUI.Full 9072 * @since 8 9073 */ 9074/** 9075 * Defines the event target. 9076 * 9077 * @interface EventTarget 9078 * @syscap SystemCapability.ArkUI.ArkUI.Full 9079 * @form 9080 * @since 9 9081 */ 9082/** 9083 * Defines the event target. 9084 * 9085 * @interface EventTarget 9086 * @syscap SystemCapability.ArkUI.ArkUI.Full 9087 * @crossplatform 9088 * @form 9089 * @since 10 9090 */ 9091/** 9092 * Defines the event target. 9093 * 9094 * @interface EventTarget 9095 * @syscap SystemCapability.ArkUI.ArkUI.Full 9096 * @crossplatform 9097 * @form 9098 * @atomicservice 9099 * @since arkts {'1.1':'11','1.2':'20'} 9100 * @arkts 1.1&1.2 9101 */ 9102declare interface EventTarget { 9103 /** 9104 * Area of current target. 9105 * 9106 * @type { Area } 9107 * @syscap SystemCapability.ArkUI.ArkUI.Full 9108 * @since 8 9109 */ 9110 /** 9111 * Area of current target. 9112 * 9113 * @type { Area } 9114 * @syscap SystemCapability.ArkUI.ArkUI.Full 9115 * @form 9116 * @since 9 9117 */ 9118 /** 9119 * Area of current target. 9120 * 9121 * @type { Area } 9122 * @syscap SystemCapability.ArkUI.ArkUI.Full 9123 * @crossplatform 9124 * @form 9125 * @since 10 9126 */ 9127 /** 9128 * Area information of the target element. 9129 * 9130 * @type { Area } 9131 * @syscap SystemCapability.ArkUI.ArkUI.Full 9132 * @crossplatform 9133 * @form 9134 * @atomicservice 9135 * @since arkts {'1.1':'11','1.2':'20'} 9136 * @arkts 1.1&1.2 9137 */ 9138 area: Area; 9139 9140 /** 9141 * Node id of current target. 9142 * 9143 * @type { ?string } 9144 * @syscap SystemCapability.ArkUI.ArkUI.Full 9145 * @crossplatform 9146 * @form 9147 * @atomicservice 9148 * @since arkts {'1.1':'15','1.2':'20'} 9149 * @arkts 1.1&1.2 9150 */ 9151 id?: string; 9152} 9153 9154/** 9155 * Defines the event source type. 9156 * 9157 * @enum { number } 9158 * @syscap SystemCapability.ArkUI.ArkUI.Full 9159 * @since 8 9160 */ 9161/** 9162 * Defines the event source type. 9163 * 9164 * @enum { number } 9165 * @syscap SystemCapability.ArkUI.ArkUI.Full 9166 * @crossplatform 9167 * @since 10 9168 */ 9169/** 9170 * Defines the event source type. 9171 * 9172 * @enum { number } 9173 * @syscap SystemCapability.ArkUI.ArkUI.Full 9174 * @crossplatform 9175 * @atomicservice 9176 * @since arkts {'1.1':'11','1.2':'20'} 9177 * @arkts 1.1&1.2 9178 */ 9179declare enum SourceType { 9180 /** 9181 * Unknown type. 9182 * 9183 * @syscap SystemCapability.ArkUI.ArkUI.Full 9184 * @since 8 9185 */ 9186 /** 9187 * Unknown type. 9188 * 9189 * @syscap SystemCapability.ArkUI.ArkUI.Full 9190 * @crossplatform 9191 * @since 10 9192 */ 9193 /** 9194 * Unknown device type. 9195 * 9196 * @syscap SystemCapability.ArkUI.ArkUI.Full 9197 * @crossplatform 9198 * @atomicservice 9199 * @since arkts {'1.1':'11','1.2':'20'} 9200 * @arkts 1.1&1.2 9201 */ 9202 Unknown, 9203 9204 /** 9205 * The mouse type. 9206 * 9207 * @syscap SystemCapability.ArkUI.ArkUI.Full 9208 * @since 8 9209 */ 9210 /** 9211 * The mouse type. 9212 * 9213 * @syscap SystemCapability.ArkUI.ArkUI.Full 9214 * @crossplatform 9215 * @since 10 9216 */ 9217 /** 9218 * The mouse type. 9219 * 9220 * @syscap SystemCapability.ArkUI.ArkUI.Full 9221 * @crossplatform 9222 * @atomicservice 9223 * @since arkts {'1.1':'11','1.2':'20'} 9224 * @arkts 1.1&1.2 9225 */ 9226 Mouse, 9227 9228 /** 9229 * The touch screen type. 9230 * 9231 * @syscap SystemCapability.ArkUI.ArkUI.Full 9232 * @since 8 9233 */ 9234 /** 9235 * The touch screen type. 9236 * 9237 * @syscap SystemCapability.ArkUI.ArkUI.Full 9238 * @crossplatform 9239 * @since 10 9240 */ 9241 /** 9242 * The touch screen type. 9243 * 9244 * @syscap SystemCapability.ArkUI.ArkUI.Full 9245 * @crossplatform 9246 * @atomicservice 9247 * @since arkts {'1.1':'11','1.2':'20'} 9248 * @arkts 1.1&1.2 9249 */ 9250 TouchScreen, 9251} 9252 9253/** 9254 * Defines the event tool type. 9255 * 9256 * @enum { number } 9257 * @syscap SystemCapability.ArkUI.ArkUI.Full 9258 * @since 9 9259 */ 9260/** 9261 * Defines the event tool type. 9262 * 9263 * @enum { number } 9264 * @syscap SystemCapability.ArkUI.ArkUI.Full 9265 * @crossplatform 9266 * @since 10 9267 */ 9268/** 9269 * Defines the event tool type. 9270 * 9271 * @enum { number } 9272 * @syscap SystemCapability.ArkUI.ArkUI.Full 9273 * @crossplatform 9274 * @atomicservice 9275 * @since arkts {'1.1':'11','1.2':'20'} 9276 * @arkts 1.1&1.2 9277 */ 9278declare enum SourceTool { 9279 /** 9280 * Unknown type. 9281 * 9282 * @syscap SystemCapability.ArkUI.ArkUI.Full 9283 * @since 9 9284 */ 9285 /** 9286 * Unknown type. 9287 * 9288 * @syscap SystemCapability.ArkUI.ArkUI.Full 9289 * @crossplatform 9290 * @since 10 9291 */ 9292 /** 9293 * Unknown input source. 9294 * 9295 * @syscap SystemCapability.ArkUI.ArkUI.Full 9296 * @crossplatform 9297 * @atomicservice 9298 * @since arkts {'1.1':'11','1.2':'20'} 9299 * @arkts 1.1&1.2 9300 */ 9301 Unknown, 9302 9303 /** 9304 * The finger type. 9305 * 9306 * @syscap SystemCapability.ArkUI.ArkUI.Full 9307 * @since 9 9308 */ 9309 /** 9310 * The finger type. 9311 * 9312 * @syscap SystemCapability.ArkUI.ArkUI.Full 9313 * @crossplatform 9314 * @since 10 9315 */ 9316 /** 9317 * The finger type. 9318 * 9319 * @syscap SystemCapability.ArkUI.ArkUI.Full 9320 * @crossplatform 9321 * @atomicservice 9322 * @since arkts {'1.1':'11','1.2':'20'} 9323 * @arkts 1.1&1.2 9324 */ 9325 Finger, 9326 9327 /** 9328 * The pen type. 9329 * 9330 * @syscap SystemCapability.ArkUI.ArkUI.Full 9331 * @since 9 9332 */ 9333 /** 9334 * The pen type. 9335 * 9336 * @syscap SystemCapability.ArkUI.ArkUI.Full 9337 * @crossplatform 9338 * @since 10 9339 */ 9340 /** 9341 * The pen type. 9342 * 9343 * @syscap SystemCapability.ArkUI.ArkUI.Full 9344 * @crossplatform 9345 * @atomicservice 9346 * @since arkts {'1.1':'11','1.2':'20'} 9347 * @arkts 1.1&1.2 9348 */ 9349 Pen, 9350 9351 /** 9352 * The mouse type. 9353 * 9354 * @syscap SystemCapability.ArkUI.ArkUI.Full 9355 * @crossplatform 9356 * @atomicservice 9357 * @since arkts {'1.1':'12','1.2':'20'} 9358 * @arkts 1.1&1.2 9359 */ 9360 MOUSE, 9361 9362 /** 9363 * The touchpad type. 9364 * 9365 * @syscap SystemCapability.ArkUI.ArkUI.Full 9366 * @crossplatform 9367 * @atomicservice 9368 * @since arkts {'1.1':'12','1.2':'20'} 9369 * @arkts 1.1&1.2 9370 */ 9371 TOUCHPAD, 9372 9373 /** 9374 * The joystick type. 9375 * 9376 * @syscap SystemCapability.ArkUI.ArkUI.Full 9377 * @crossplatform 9378 * @atomicservice 9379 * @since arkts {'1.1':'12','1.2':'20'} 9380 * @arkts 1.1&1.2 9381 */ 9382 JOYSTICK, 9383} 9384 9385/** 9386 * Defines the Border Image Repeat Mode. 9387 * 9388 * @enum { number } 9389 * @syscap SystemCapability.ArkUI.ArkUI.Full 9390 * @form 9391 * @since 9 9392 */ 9393/** 9394 * Defines the Border Image Repeat Mode. 9395 * 9396 * @enum { number } 9397 * @syscap SystemCapability.ArkUI.ArkUI.Full 9398 * @crossplatform 9399 * @form 9400 * @since 10 9401 */ 9402/** 9403 * Defines the Border Image Repeat Mode. 9404 * 9405 * @enum { number } 9406 * @syscap SystemCapability.ArkUI.ArkUI.Full 9407 * @crossplatform 9408 * @form 9409 * @atomicservice 9410 * @since arkts {'1.1':'11','1.2':'20'} 9411 * @arkts 1.1&1.2 9412 */ 9413declare enum RepeatMode { 9414 /** 9415 * Repeat mode. 9416 * 9417 * @syscap SystemCapability.ArkUI.ArkUI.Full 9418 * @form 9419 * @since 9 9420 */ 9421 /** 9422 * Repeat mode. 9423 * 9424 * @syscap SystemCapability.ArkUI.ArkUI.Full 9425 * @crossplatform 9426 * @form 9427 * @since 10 9428 */ 9429 /** 9430 * The source image's slices are tiled. Tiles beyond the border box will be clipped. 9431 * 9432 * @syscap SystemCapability.ArkUI.ArkUI.Full 9433 * @crossplatform 9434 * @form 9435 * @atomicservice 9436 * @since arkts {'1.1':'11','1.2':'20'} 9437 * @arkts 1.1&1.2 9438 */ 9439 Repeat, 9440 9441 /** 9442 * Stretch mode. 9443 * 9444 * @syscap SystemCapability.ArkUI.ArkUI.Full 9445 * @form 9446 * @since 9 9447 */ 9448 /** 9449 * Stretch mode. 9450 * 9451 * @syscap SystemCapability.ArkUI.ArkUI.Full 9452 * @crossplatform 9453 * @form 9454 * @since 10 9455 */ 9456 /** 9457 * The source image's slices are stretched to fill the border box. 9458 * 9459 * @syscap SystemCapability.ArkUI.ArkUI.Full 9460 * @crossplatform 9461 * @form 9462 * @atomicservice 9463 * @since arkts {'1.1':'11','1.2':'20'} 9464 * @arkts 1.1&1.2 9465 */ 9466 Stretch, 9467 9468 /** 9469 * Round mode. 9470 * 9471 * @syscap SystemCapability.ArkUI.ArkUI.Full 9472 * @form 9473 * @since 9 9474 */ 9475 /** 9476 * Round mode. 9477 * 9478 * @syscap SystemCapability.ArkUI.ArkUI.Full 9479 * @crossplatform 9480 * @form 9481 * @since 10 9482 */ 9483 /** 9484 * The source image's slices are tiled to fill the border box. Tiles may be compressed when needed. 9485 * 9486 * @syscap SystemCapability.ArkUI.ArkUI.Full 9487 * @crossplatform 9488 * @form 9489 * @atomicservice 9490 * @since arkts {'1.1':'11','1.2':'20'} 9491 * @arkts 1.1&1.2 9492 */ 9493 Round, 9494 9495 /** 9496 * Space mode. 9497 * 9498 * @syscap SystemCapability.ArkUI.ArkUI.Full 9499 * @form 9500 * @since 9 9501 */ 9502 /** 9503 * Space mode. 9504 * 9505 * @syscap SystemCapability.ArkUI.ArkUI.Full 9506 * @crossplatform 9507 * @form 9508 * @since 10 9509 */ 9510 /** 9511 * The source image's slices are tiled to fill the border box. Extra space will be distributed in between tiles. 9512 * 9513 * @syscap SystemCapability.ArkUI.ArkUI.Full 9514 * @crossplatform 9515 * @form 9516 * @atomicservice 9517 * @since arkts {'1.1':'11','1.2':'20'} 9518 * @arkts 1.1&1.2 9519 */ 9520 Space, 9521} 9522 9523/** 9524 * enum Blur style 9525 * 9526 * @enum { number } 9527 * @syscap SystemCapability.ArkUI.ArkUI.Full 9528 * @form 9529 * @since 9 9530 */ 9531/** 9532 * enum Blur style 9533 * 9534 * @enum { number } 9535 * @syscap SystemCapability.ArkUI.ArkUI.Full 9536 * @crossplatform 9537 * @form 9538 * @since 10 9539 */ 9540/** 9541 * enum Blur style 9542 * 9543 * @enum { number } 9544 * @syscap SystemCapability.ArkUI.ArkUI.Full 9545 * @crossplatform 9546 * @form 9547 * @atomicservice 9548 * @since arkts {'1.1':'11','1.2':'20'} 9549 * @arkts 1.1&1.2 9550 */ 9551declare enum BlurStyle { 9552 /** 9553 * Thin material. 9554 * 9555 * @syscap SystemCapability.ArkUI.ArkUI.Full 9556 * @form 9557 * @since 9 9558 */ 9559 /** 9560 * Thin material. 9561 * 9562 * @syscap SystemCapability.ArkUI.ArkUI.Full 9563 * @crossplatform 9564 * @form 9565 * @since 10 9566 */ 9567 /** 9568 * Thin material. 9569 * 9570 * @syscap SystemCapability.ArkUI.ArkUI.Full 9571 * @crossplatform 9572 * @form 9573 * @atomicservice 9574 * @since arkts {'1.1':'11','1.2':'20'} 9575 * @arkts 1.1&1.2 9576 */ 9577 Thin, 9578 9579 /** 9580 * Regular material. 9581 * 9582 * @syscap SystemCapability.ArkUI.ArkUI.Full 9583 * @form 9584 * @since 9 9585 */ 9586 /** 9587 * Regular material. 9588 * 9589 * @syscap SystemCapability.ArkUI.ArkUI.Full 9590 * @crossplatform 9591 * @form 9592 * @since 10 9593 */ 9594 /** 9595 * Regular material. 9596 * 9597 * @syscap SystemCapability.ArkUI.ArkUI.Full 9598 * @crossplatform 9599 * @form 9600 * @atomicservice 9601 * @since arkts {'1.1':'11','1.2':'20'} 9602 * @arkts 1.1&1.2 9603 */ 9604 Regular, 9605 9606 /** 9607 * Thick material. 9608 * 9609 * @syscap SystemCapability.ArkUI.ArkUI.Full 9610 * @form 9611 * @since 9 9612 */ 9613 /** 9614 * Thick material. 9615 * 9616 * @syscap SystemCapability.ArkUI.ArkUI.Full 9617 * @crossplatform 9618 * @form 9619 * @since 10 9620 */ 9621 /** 9622 * Thick material. 9623 * 9624 * @syscap SystemCapability.ArkUI.ArkUI.Full 9625 * @crossplatform 9626 * @form 9627 * @atomicservice 9628 * @since arkts {'1.1':'11','1.2':'20'} 9629 * @arkts 1.1&1.2 9630 */ 9631 Thick, 9632 9633 /** 9634 * Material that creates the minimum depth of field effect. 9635 * 9636 * @syscap SystemCapability.ArkUI.ArkUI.Full 9637 * @crossplatform 9638 * @since 10 9639 */ 9640 /** 9641 * Material that creates the minimum depth of field effect. 9642 * 9643 * @syscap SystemCapability.ArkUI.ArkUI.Full 9644 * @crossplatform 9645 * @form 9646 * @atomicservice 9647 * @since arkts {'1.1':'11','1.2':'20'} 9648 * @arkts 1.1&1.2 9649 */ 9650 BACKGROUND_THIN, 9651 9652 /** 9653 * Material that creates a medium shallow depth of field effect. 9654 * 9655 * @syscap SystemCapability.ArkUI.ArkUI.Full 9656 * @crossplatform 9657 * @since 10 9658 */ 9659 /** 9660 * Material that creates a medium shallow depth of field effect. 9661 * 9662 * @syscap SystemCapability.ArkUI.ArkUI.Full 9663 * @crossplatform 9664 * @form 9665 * @atomicservice 9666 * @since arkts {'1.1':'11','1.2':'20'} 9667 * @arkts 1.1&1.2 9668 */ 9669 BACKGROUND_REGULAR, 9670 9671 /** 9672 * Material that creates a high shallow depth of field effect. 9673 * 9674 * @syscap SystemCapability.ArkUI.ArkUI.Full 9675 * @crossplatform 9676 * @since 10 9677 */ 9678 /** 9679 * Material that creates a high shallow depth of field effect. 9680 * 9681 * @syscap SystemCapability.ArkUI.ArkUI.Full 9682 * @crossplatform 9683 * @form 9684 * @atomicservice 9685 * @since arkts {'1.1':'11','1.2':'20'} 9686 * @arkts 1.1&1.2 9687 */ 9688 BACKGROUND_THICK, 9689 9690 /** 9691 * Material that creates the maximum depth of field effect. 9692 * 9693 * @syscap SystemCapability.ArkUI.ArkUI.Full 9694 * @crossplatform 9695 * @since 10 9696 */ 9697 /** 9698 * Material that creates the maximum depth of field effect. 9699 * 9700 * @syscap SystemCapability.ArkUI.ArkUI.Full 9701 * @crossplatform 9702 * @form 9703 * @atomicservice 9704 * @since arkts {'1.1':'11','1.2':'20'} 9705 * @arkts 1.1&1.2 9706 */ 9707 BACKGROUND_ULTRA_THICK, 9708 9709 /** 9710 * No blur. 9711 * 9712 * @syscap SystemCapability.ArkUI.ArkUI.Full 9713 * @crossplatform 9714 * @form 9715 * @since 10 9716 */ 9717 /** 9718 * No blur. 9719 * 9720 * @syscap SystemCapability.ArkUI.ArkUI.Full 9721 * @crossplatform 9722 * @form 9723 * @atomicservice 9724 * @since arkts {'1.1':'11','1.2':'20'} 9725 * @arkts 1.1&1.2 9726 */ 9727 NONE, 9728 9729 /** 9730 * Component ultra-thin material. 9731 * 9732 * @syscap SystemCapability.ArkUI.ArkUI.Full 9733 * @crossplatform 9734 * @form 9735 * @since 11 9736 */ 9737 /** 9738 * Component ultra-thin material. 9739 * 9740 * @syscap SystemCapability.ArkUI.ArkUI.Full 9741 * @crossplatform 9742 * @form 9743 * @atomicservice 9744 * @since arkts {'1.1':'12','1.2':'20'} 9745 * @arkts 1.1&1.2 9746 */ 9747 COMPONENT_ULTRA_THIN = 8, 9748 9749 /** 9750 * Defines the thin component material. 9751 * 9752 * @syscap SystemCapability.ArkUI.ArkUI.Full 9753 * @crossplatform 9754 * @form 9755 * @since 11 9756 */ 9757 /** 9758 * Component thin material. 9759 * 9760 * @syscap SystemCapability.ArkUI.ArkUI.Full 9761 * @crossplatform 9762 * @form 9763 * @atomicservice 9764 * @since arkts {'1.1':'12','1.2':'20'} 9765 * @arkts 1.1&1.2 9766 */ 9767 COMPONENT_THIN = 9, 9768 9769 /** 9770 * Defines the regular component material. 9771 * 9772 * @syscap SystemCapability.ArkUI.ArkUI.Full 9773 * @crossplatform 9774 * @form 9775 * @since 11 9776 */ 9777 /** 9778 * Component regular material. 9779 * 9780 * @syscap SystemCapability.ArkUI.ArkUI.Full 9781 * @crossplatform 9782 * @form 9783 * @atomicservice 9784 * @since arkts {'1.1':'12','1.2':'20'} 9785 * @arkts 1.1&1.2 9786 */ 9787 COMPONENT_REGULAR = 10, 9788 9789 /** 9790 * Defines the thick component material. 9791 * 9792 * @syscap SystemCapability.ArkUI.ArkUI.Full 9793 * @crossplatform 9794 * @form 9795 * @since 11 9796 */ 9797 /** 9798 * Defines the thick component material. 9799 * 9800 * @syscap SystemCapability.ArkUI.ArkUI.Full 9801 * @crossplatform 9802 * @form 9803 * @atomicservice 9804 * @since arkts {'1.1':'12','1.2':'20'} 9805 * @arkts 1.1&1.2 9806 */ 9807 COMPONENT_THICK = 11, 9808 9809 /** 9810 * Defines the ultra thick component material. 9811 * 9812 * @syscap SystemCapability.ArkUI.ArkUI.Full 9813 * @crossplatform 9814 * @form 9815 * @since 11 9816 */ 9817 /** 9818 * Defines the ultra thick component material. 9819 * 9820 * @syscap SystemCapability.ArkUI.ArkUI.Full 9821 * @crossplatform 9822 * @form 9823 * @atomicservice 9824 * @since arkts {'1.1':'12','1.2':'20'} 9825 * @arkts 1.1&1.2 9826 */ 9827 COMPONENT_ULTRA_THICK = 12, 9828} 9829 9830/** 9831 * Enumerates the policies for activating the blur style. 9832 * 9833 * @enum { number } 9834 * @syscap SystemCapability.ArkUI.ArkUI.Full 9835 * @crossplatform 9836 * @atomicservice 9837 * @since arkts {'1.1':'14','1.2':'20'} 9838 * @arkts 1.1&1.2 9839 */ 9840declare enum BlurStyleActivePolicy { 9841 /** 9842 * The component has the blur effect only when the window is focused. 9843 * 9844 * @syscap SystemCapability.ArkUI.ArkUI.Full 9845 * @crossplatform 9846 * @atomicservice 9847 * @since arkts {'1.1':'14','1.2':'20'} 9848 * @arkts 1.1&1.2 9849 */ 9850 FOLLOWS_WINDOW_ACTIVE_STATE = 0, 9851 9852 /** 9853 * The component always has the blur effect, regardless of whether the window is focused. 9854 * 9855 * @syscap SystemCapability.ArkUI.ArkUI.Full 9856 * @crossplatform 9857 * @atomicservice 9858 * @since arkts {'1.1':'14','1.2':'20'} 9859 * @arkts 1.1&1.2 9860 */ 9861 ALWAYS_ACTIVE = 1, 9862 9863 /** 9864 * The component does not have the blur effect, regardless of whether the window is focused. 9865 * 9866 * @syscap SystemCapability.ArkUI.ArkUI.Full 9867 * @crossplatform 9868 * @atomicservice 9869 * @since arkts {'1.1':'14','1.2':'20'} 9870 * @arkts 1.1&1.2 9871 */ 9872 ALWAYS_INACTIVE = 2, 9873} 9874 9875/** 9876 * enum color mode 9877 * 9878 * @enum { number } 9879 * @syscap SystemCapability.ArkUI.ArkUI.Full 9880 * @crossplatform 9881 * @since 10 9882 */ 9883/** 9884 * enum color mode 9885 * 9886 * @enum { number } 9887 * @syscap SystemCapability.ArkUI.ArkUI.Full 9888 * @crossplatform 9889 * @atomicservice 9890 * @since arkts {'1.1':'11','1.2':'20'} 9891 * @arkts 1.1&1.2 9892 */ 9893declare enum ThemeColorMode { 9894 /** 9895 * Defines the mode which is follow up with system. 9896 * 9897 * @syscap SystemCapability.ArkUI.ArkUI.Full 9898 * @crossplatform 9899 * @since 10 9900 */ 9901 /** 9902 * Defines the mode which is follow up with system. 9903 * 9904 * @syscap SystemCapability.ArkUI.ArkUI.Full 9905 * @crossplatform 9906 * @atomicservice 9907 * @since arkts {'1.1':'11','1.2':'20'} 9908 * @arkts 1.1&1.2 9909 */ 9910 SYSTEM, 9911 9912 /** 9913 * Defines the light mode. 9914 * 9915 * @syscap SystemCapability.ArkUI.ArkUI.Full 9916 * @crossplatform 9917 * @since 10 9918 */ 9919 /** 9920 * Defines the light mode. 9921 * 9922 * @syscap SystemCapability.ArkUI.ArkUI.Full 9923 * @crossplatform 9924 * @atomicservice 9925 * @since arkts {'1.1':'11','1.2':'20'} 9926 * @arkts 1.1&1.2 9927 */ 9928 LIGHT, 9929 9930 /** 9931 * Defines the dark mode. 9932 * 9933 * @syscap SystemCapability.ArkUI.ArkUI.Full 9934 * @crossplatform 9935 * @since 10 9936 */ 9937 /** 9938 * Defines the dark mode. 9939 * 9940 * @syscap SystemCapability.ArkUI.ArkUI.Full 9941 * @crossplatform 9942 * @atomicservice 9943 * @since arkts {'1.1':'11','1.2':'20'} 9944 * @arkts 1.1&1.2 9945 */ 9946 DARK, 9947} 9948 9949/** 9950 * Defines adaptive color 9951 * 9952 * @enum { number } 9953 * @syscap SystemCapability.ArkUI.ArkUI.Full 9954 * @crossplatform 9955 * @since 10 9956 */ 9957/** 9958 * Defines adaptive color 9959 * 9960 * @enum { number } 9961 * @syscap SystemCapability.ArkUI.ArkUI.Full 9962 * @crossplatform 9963 * @atomicservice 9964 * @since arkts {'1.1':'11','1.2':'20'} 9965 * @arkts 1.1&1.2 9966 */ 9967declare enum AdaptiveColor { 9968 /** 9969 * Adaptive color mode is not used. 9970 * The default color is used as the mask color. Using a mode other than **DEFAULT** can be more time-consuming. 9971 * 9972 * @syscap SystemCapability.ArkUI.ArkUI.Full 9973 * @crossplatform 9974 * @since 10 9975 */ 9976 /** 9977 * Adaptive color mode is not used. 9978 * The default color is used as the mask color. Using a mode other than **DEFAULT** can be more time-consuming. 9979 * 9980 * @syscap SystemCapability.ArkUI.ArkUI.Full 9981 * @crossplatform 9982 * @atomicservice 9983 * @since arkts {'1.1':'11','1.2':'20'} 9984 * @arkts 1.1&1.2 9985 */ 9986 DEFAULT, 9987 9988 /** 9989 * Adaptive color mode is used. The average color value of the color picking area is used as the mask color. 9990 * 9991 * @syscap SystemCapability.ArkUI.ArkUI.Full 9992 * @crossplatform 9993 * @since 10 9994 */ 9995 /** 9996 * Adaptive color mode is used. The average color value of the color picking area is used as the mask color. 9997 * 9998 * @syscap SystemCapability.ArkUI.ArkUI.Full 9999 * @crossplatform 10000 * @atomicservice 10001 * @since arkts {'1.1':'11','1.2':'20'} 10002 * @arkts 1.1&1.2 10003 */ 10004 AVERAGE, 10005} 10006 10007/** 10008 * Defines modal transition type. 10009 * 10010 * @enum { number } 10011 * @syscap SystemCapability.ArkUI.ArkUI.Full 10012 * @crossplatform 10013 * @since 10 10014 */ 10015/** 10016 * Defines modal transition type. 10017 * 10018 * @enum { number } 10019 * @syscap SystemCapability.ArkUI.ArkUI.Full 10020 * @crossplatform 10021 * @atomicservice 10022 * @since arkts {'1.1':'11','1.2':'20'} 10023 * @arkts 1.1&1.2 10024 */ 10025declare enum ModalTransition { 10026 /** 10027 * Use default animation. 10028 * Upward animation when entering and downward animation when exiting. 10029 * 10030 * @syscap SystemCapability.ArkUI.ArkUI.Full 10031 * @crossplatform 10032 * @since 10 10033 */ 10034 /** 10035 * Use default animation. 10036 * Upward animation when entering and downward animation when exiting. 10037 * 10038 * @syscap SystemCapability.ArkUI.ArkUI.Full 10039 * @crossplatform 10040 * @atomicservice 10041 * @since arkts {'1.1':'11','1.2':'20'} 10042 * @arkts 1.1&1.2 10043 */ 10044 DEFAULT, 10045 10046 /** 10047 * No transition animation for the modal. 10048 * 10049 * @syscap SystemCapability.ArkUI.ArkUI.Full 10050 * @crossplatform 10051 * @since 10 10052 */ 10053 /** 10054 * No transition animation for the modal. 10055 * 10056 * @syscap SystemCapability.ArkUI.ArkUI.Full 10057 * @crossplatform 10058 * @atomicservice 10059 * @since arkts {'1.1':'11','1.2':'20'} 10060 * @arkts 1.1&1.2 10061 */ 10062 NONE, 10063 10064 /** 10065 * Use alpha animation. 10066 * 10067 * @syscap SystemCapability.ArkUI.ArkUI.Full 10068 * @crossplatform 10069 * @since 10 10070 */ 10071 /** 10072 * Use alpha animation. 10073 * 10074 * @syscap SystemCapability.ArkUI.ArkUI.Full 10075 * @crossplatform 10076 * @atomicservice 10077 * @since arkts {'1.1':'11','1.2':'20'} 10078 * @arkts 1.1&1.2 10079 */ 10080 ALPHA, 10081} 10082 10083/** 10084 * Defines the options of backgroundBlurStyle 10085 * 10086 * @extends BlurStyleOption 10087 * @interface BackgroundBlurStyleOptions 10088 * @syscap SystemCapability.ArkUI.ArkUI.Full 10089 * @crossplatform 10090 * @since 10 10091 */ 10092/** 10093 * Defines the options of backgroundBlurStyle 10094 * 10095 * @extends BlurStyleOption 10096 * @interface BackgroundBlurStyleOptions 10097 * @syscap SystemCapability.ArkUI.ArkUI.Full 10098 * @crossplatform 10099 * @atomicservice 10100 * @since arkts {'1.1':'11','1.2':'20'} 10101 * @arkts 1.1&1.2 10102 */ 10103declare interface BackgroundBlurStyleOptions extends BlurStyleOptions { 10104 /** 10105 * Defines the policy for activating the blur style. 10106 * 10107 * @type { ?BlurStyleActivePolicy } 10108 * @default BlurStyleActivePolicy.ALWAYS_ACTIVE 10109 * @syscap SystemCapability.ArkUI.ArkUI.Full 10110 * @crossplatform 10111 * @atomicservice 10112 * @since arkts {'1.1':'14','1.2':'20'} 10113 * @arkts 1.1&1.2 10114 */ 10115 policy?: BlurStyleActivePolicy; 10116 10117 /** 10118 * Color of the background effect when the window is not focused. 10119 * 10120 * @type { ?ResourceColor } 10121 * @default Color.Transparent 10122 * @syscap SystemCapability.ArkUI.ArkUI.Full 10123 * @crossplatform 10124 * @atomicservice 10125 * @since arkts {'1.1':'14','1.2':'20'} 10126 * @arkts 1.1&1.2 10127 */ 10128 inactiveColor?: ResourceColor; 10129} 10130 10131/** 10132 * Defines the options of ForegroundBlurStyle 10133 * 10134 * @extends BlurStyleOptions 10135 * @interface ForegroundBlurStyleOptions 10136 * @syscap SystemCapability.ArkUI.ArkUI.Full 10137 * @crossplatform 10138 * @since 10 10139 */ 10140/** 10141 * Defines the options of ForegroundBlurStyle 10142 * 10143 * @extends BlurStyleOptions 10144 * @interface ForegroundBlurStyleOptions 10145 * @syscap SystemCapability.ArkUI.ArkUI.Full 10146 * @crossplatform 10147 * @atomicservice 10148 * @since arkts {'1.1':'11','1.2':'20'} 10149 * @arkts 1.1&1.2 10150 */ 10151declare interface ForegroundBlurStyleOptions extends BlurStyleOptions {} 10152 10153 10154/** 10155 * Defines the options of blur 10156 * 10157 * @interface BlurOptions 10158 * @syscap SystemCapability.ArkUI.ArkUI.Full 10159 * @crossplatform 10160 * @since 11 10161 */ 10162/** 10163 * Defines the options of blur 10164 * 10165 * @interface BlurOptions 10166 * @syscap SystemCapability.ArkUI.ArkUI.Full 10167 * @crossplatform 10168 * @atomicservice 10169 * @since arkts {'1.1':'12','1.2':'20'} 10170 * @arkts 1.1&1.2 10171 */ 10172declare interface BlurOptions { 10173 /** 10174 * Fuzzy gray scale parameter. 10175 * @type { [number, number] } 10176 * @syscap SystemCapability.ArkUI.ArkUI.Full 10177 * @crossplatform 10178 * @since 11 10179 */ 10180 /** 10181 * Fuzzy gray scale parameter. 10182 * @type { [number, number] } 10183 * @syscap SystemCapability.ArkUI.ArkUI.Full 10184 * @crossplatform 10185 * @atomicservice 10186 * @since arkts {'1.1':'12','1.2':'20'} 10187 * @arkts 1.1&1.2 10188 */ 10189 grayscale: [number, number]; 10190} 10191 10192/** 10193 * Defines the SystemAdaptiveOptions interface 10194 * 10195 * @interface SystemAdaptiveOptions 10196 * @syscap SystemCapability.ArkUI.ArkUI.Full 10197 * @crossplatform 10198 * @form 10199 * @atomicservice 10200 * @since arkts {'1.1':'19','1.2':'20'} 10201 * @arkts 1.1&1.2 10202 */ 10203declare interface SystemAdaptiveOptions { 10204 /** 10205 * Whether to disable system adaptive. 10206 * 10207 * @type { ?boolean } 10208 * @syscap SystemCapability.ArkUI.ArkUI.Full 10209 * @crossplatform 10210 * @form 10211 * @atomicservice 10212 * @since arkts {'1.1':'19','1.2':'20'} 10213 * @arkts 1.1&1.2 10214 */ 10215 disableSystemAdaptation?: boolean; 10216} 10217 10218/** 10219 * Defines the options of blurStyle 10220 * 10221 * @interface BlurStyleOptions 10222 * @syscap SystemCapability.ArkUI.ArkUI.Full 10223 * @crossplatform 10224 * @since 10 10225 */ 10226/** 10227 * Defines the options of blurStyle 10228 * 10229 * @interface BlurStyleOptions 10230 * @syscap SystemCapability.ArkUI.ArkUI.Full 10231 * @crossplatform 10232 * @atomicservice 10233 * @since arkts {'1.1':'11','1.2':'20'} 10234 * @arkts 1.1&1.2 10235 */ 10236declare interface BlurStyleOptions { 10237 /** 10238 * Color mode used for the foreground blur. 10239 * <br>Default value: **ThemeColorMode.SYSTEM**. 10240 * 10241 * @type { ?ThemeColorMode } 10242 * @default ThemeColorMode.SYSTEM 10243 * @syscap SystemCapability.ArkUI.ArkUI.Full 10244 * @since 10 10245 */ 10246 /** 10247 * Color mode used for the foreground blur. 10248 * <br>Default value: **ThemeColorMode.SYSTEM**. 10249 * 10250 * @type { ?ThemeColorMode } 10251 * @default ThemeColorMode.SYSTEM 10252 * @syscap SystemCapability.ArkUI.ArkUI.Full 10253 * @crossplatform 10254 * @atomicservice 10255 * @since arkts {'1.1':'11','1.2':'20'} 10256 * @arkts 1.1&1.2 10257 */ 10258 colorMode?: ThemeColorMode; 10259 10260 /** 10261 * Adaptive color mode. 10262 * <br>Default value: **AdaptiveColor.DEFAULT**. 10263 * 10264 * @type { ?AdaptiveColor } 10265 * @default AdaptiveColor.DEFAULT 10266 * @syscap SystemCapability.ArkUI.ArkUI.Full 10267 * @since 10 10268 */ 10269 /** 10270 * Adaptive color mode. 10271 * <br>Default value: **AdaptiveColor.DEFAULT**. 10272 * 10273 * @type { ?AdaptiveColor } 10274 * @default AdaptiveColor.DEFAULT 10275 * @syscap SystemCapability.ArkUI.ArkUI.Full 10276 * @crossplatform 10277 * @atomicservice 10278 * @since arkts {'1.1':'11','1.2':'20'} 10279 * @arkts 1.1&1.2 10280 */ 10281 adaptiveColor?: AdaptiveColor; 10282 10283 /** 10284 * Foreground blur scale. 10285 * <br>Default value: **1.0**. 10286 * <br>Value range: [0.0, 1.0]. 10287 * 10288 * @type { ?number } 10289 * @default 1.0 10290 * @syscap SystemCapability.ArkUI.ArkUI.Full 10291 * @atomicservice 10292 * @since arkts {'1.1':'12','1.2':'20'} 10293 * @arkts 1.1&1.2 10294 */ 10295 scale?: number; 10296 10297 /** 10298 * Defines the options of blur 10299 * 10300 * @type { ?BlurOptions } 10301 * @default { grayScale: [0,0] } 10302 * @syscap SystemCapability.ArkUI.ArkUI.Full 10303 * @crossplatform 10304 * @since 11 10305 */ 10306 /** 10307 * Defines the options of blur 10308 * 10309 * @type { ?BlurOptions } 10310 * @default { grayScale: [0,0] } 10311 * @syscap SystemCapability.ArkUI.ArkUI.Full 10312 * @crossplatform 10313 * @atomicservice 10314 * @since arkts {'1.1':'12','1.2':'20'} 10315 * @arkts 1.1&1.2 10316 */ 10317 blurOptions?: BlurOptions; 10318} 10319 10320/** 10321 * Defines the options of BackgroundEffect 10322 * 10323 * @interface BackgroundEffectOptions 10324 * @syscap SystemCapability.ArkUI.ArkUI.Full 10325 * @crossplatform 10326 * @since 11 10327 */ 10328/** 10329 * Defines the options of BackgroundEffect 10330 * 10331 * @interface BackgroundEffectOptions 10332 * @syscap SystemCapability.ArkUI.ArkUI.Full 10333 * @crossplatform 10334 * @atomicservice 10335 * @since arkts {'1.1':'12','1.2':'20'} 10336 * @arkts 1.1&1.2 10337 */ 10338declare interface BackgroundEffectOptions { 10339 10340 /** 10341 * Blur radius. 10342 * Value range: [0, +∞). 10343 * Default value: **0**. 10344 * 10345 * @type { number } 10346 * @syscap SystemCapability.ArkUI.ArkUI.Full 10347 * @crossplatform 10348 * @since 11 10349 */ 10350 /** 10351 * Blur radius. 10352 * Value range: [0, +∞). 10353 * Default value: **0**. 10354 * 10355 * @type { number } 10356 * @syscap SystemCapability.ArkUI.ArkUI.Full 10357 * @crossplatform 10358 * @atomicservice 10359 * @since arkts {'1.1':'12','1.2':'20'} 10360 * @arkts 1.1&1.2 10361 */ 10362 radius: number; 10363 10364 /** 10365 * Saturation. 10366 * Value range: [0, +∞). 10367 * Recommended value range: [0, 50]. 10368 * 10369 * @type { ?number } 10370 * @default 1 10371 * @syscap SystemCapability.ArkUI.ArkUI.Full 10372 * @crossplatform 10373 * @since 11 10374 */ 10375 /** 10376 * Saturation. 10377 * Value range: [0, +∞). 10378 * Recommended value range: [0, 50]. 10379 * 10380 * @type { ?number } 10381 * @default 1 10382 * @syscap SystemCapability.ArkUI.ArkUI.Full 10383 * @crossplatform 10384 * @atomicservice 10385 * @since arkts {'1.1':'12','1.2':'20'} 10386 * @arkts 1.1&1.2 10387 */ 10388 saturation?: number; 10389 10390 /** 10391 * Brightness. 10392 * <br>Value range: [0, +∞). 10393 * <br>Default value: **1** Recommended value range: [0, 2]. 10394 * 10395 * @type { ?number } 10396 * @default 1 10397 * @syscap SystemCapability.ArkUI.ArkUI.Full 10398 * @crossplatform 10399 * @since 11 10400 */ 10401 /** 10402 * Brightness. 10403 * <br>Value range: [0, +∞). 10404 * <br>Default value: **1** Recommended value range: [0, 2]. 10405 * 10406 * @type { ?number } 10407 * @default 1 10408 * @syscap SystemCapability.ArkUI.ArkUI.Full 10409 * @crossplatform 10410 * @atomicservice 10411 * @since arkts {'1.1':'12','1.2':'20'} 10412 * @arkts 1.1&1.2 10413 */ 10414 brightness?: number; 10415 10416 /** 10417 * Color. 10418 * 10419 * @type { ?ResourceColor } 10420 * @default Color.Transparent 10421 * @syscap SystemCapability.ArkUI.ArkUI.Full 10422 * @crossplatform 10423 * @since 11 10424 */ 10425 /** 10426 * Color. 10427 * 10428 * @type { ?ResourceColor } 10429 * @default Color.Transparent 10430 * @syscap SystemCapability.ArkUI.ArkUI.Full 10431 * @crossplatform 10432 * @atomicservice 10433 * @since arkts {'1.1':'12','1.2':'20'} 10434 * @arkts 1.1&1.2 10435 */ 10436 color?: ResourceColor; 10437 10438 /** 10439 * Define the adaptiveColor of BackgroundEffect. 10440 * 10441 * @type { ?AdaptiveColor } 10442 * @default AdaptiveColor.DEFAULT 10443 * @syscap SystemCapability.ArkUI.ArkUI.Full 10444 * @crossplatform 10445 * @since 11 10446 */ 10447 /** 10448 * Define the adaptiveColor of BackgroundEffect. 10449 * 10450 * @type { ?AdaptiveColor } 10451 * @default AdaptiveColor.DEFAULT 10452 * @syscap SystemCapability.ArkUI.ArkUI.Full 10453 * @crossplatform 10454 * @atomicservice 10455 * @since arkts {'1.1':'12','1.2':'20'} 10456 * @arkts 1.1&1.2 10457 */ 10458 adaptiveColor?: AdaptiveColor; 10459 10460 /** 10461 * Define the blurOptions of BackgroundEffect. 10462 * 10463 * @type { ?BlurOptions } 10464 * @default { grayScale: [0,1] } 10465 * @syscap SystemCapability.ArkUI.ArkUI.Full 10466 * @crossplatform 10467 * @since 11 10468 */ 10469 /** 10470 * Define the blurOptions of BackgroundEffect. 10471 * 10472 * @type { ?BlurOptions } 10473 * @default { grayScale: [0,0] } 10474 * @syscap SystemCapability.ArkUI.ArkUI.Full 10475 * @crossplatform 10476 * @atomicservice 10477 * @since arkts {'1.1':'12','1.2':'20'} 10478 * @arkts 1.1&1.2 10479 */ 10480 blurOptions?: BlurOptions; 10481 10482 /** 10483 * Defines the policy for activating the blur style. 10484 * 10485 * @type { ?BlurStyleActivePolicy } 10486 * @default BlurStyleActivePolicy.ALWAYS_ACTIVE 10487 * @syscap SystemCapability.ArkUI.ArkUI.Full 10488 * @crossplatform 10489 * @atomicservice 10490 * @since arkts {'1.1':'14','1.2':'20'} 10491 * @arkts 1.1&1.2 10492 */ 10493 policy?: BlurStyleActivePolicy; 10494 10495 /** 10496 * Color of the background effect when the window is not focused. 10497 * 10498 * @type { ?ResourceColor } 10499 * @default Color.Transparent 10500 * @syscap SystemCapability.ArkUI.ArkUI.Full 10501 * @crossplatform 10502 * @atomicservice 10503 * @since arkts {'1.1':'14','1.2':'20'} 10504 * @arkts 1.1&1.2 10505 */ 10506 inactiveColor?: ResourceColor; 10507} 10508 10509/** 10510 * Defines the options of ForegroundEffect 10511 * 10512 * @interface ForegroundEffectOptions 10513 * @syscap SystemCapability.ArkUI.ArkUI.Full 10514 * @crossplatform 10515 * @atomicservice 10516 * @since arkts {'1.1':'12','1.2':'20'} 10517 * @arkts 1.1&1.2 10518 */ 10519declare interface ForegroundEffectOptions { 10520 10521 /** 10522 * Define the radius size of ForegroundEffect.The range of this value is [0, ∞) 10523 * 10524 * @type { number } 10525 * @syscap SystemCapability.ArkUI.ArkUI.Full 10526 * @crossplatform 10527 * @atomicservice 10528 * @since arkts {'1.1':'12','1.2':'20'} 10529 * @arkts 1.1&1.2 10530 */ 10531 radius: number; 10532} 10533 10534/** 10535 * Provide an interface for the text style of picker 10536 * 10537 * @interface PickerTextStyle 10538 * @syscap SystemCapability.ArkUI.ArkUI.Full 10539 * @crossplatform 10540 * @since 10 10541 */ 10542/** 10543 * Provide an interface for the text style of picker 10544 * 10545 * @interface PickerTextStyle 10546 * @syscap SystemCapability.ArkUI.ArkUI.Full 10547 * @crossplatform 10548 * @atomicservice 10549 * @since arkts {'1.1':'11','1.2':'20'} 10550 * @arkts 1.1&1.2 10551 */ 10552declare interface PickerTextStyle { 10553 /** 10554 * Define the text color of picker. 10555 * 10556 * @type { ?ResourceColor } 10557 * @syscap SystemCapability.ArkUI.ArkUI.Full 10558 * @crossplatform 10559 * @since 10 10560 */ 10561 /** 10562 * Font color. 10563 * 10564 * @type { ?ResourceColor } 10565 * @syscap SystemCapability.ArkUI.ArkUI.Full 10566 * @crossplatform 10567 * @atomicservice 10568 * @since arkts {'1.1':'11','1.2':'20'} 10569 * @arkts 1.1&1.2 10570 */ 10571 color?: ResourceColor; 10572 10573 /** 10574 * Define the text font of picker. 10575 * Only support size and weight. 10576 * 10577 * @type { ?Font } 10578 * @syscap SystemCapability.ArkUI.ArkUI.Full 10579 * @crossplatform 10580 * @since 10 10581 */ 10582 /** 10583 * Text style. 10584 * 10585 * @type { ?Font } 10586 * @syscap SystemCapability.ArkUI.ArkUI.Full 10587 * @crossplatform 10588 * @atomicservice 10589 * @since arkts {'1.1':'11','1.2':'20'} 10590 * @arkts 1.1&1.2 10591 */ 10592 font?: Font; 10593} 10594 10595/** 10596 * Provide an interface for the button style of picker 10597 * 10598 * @interface PickerDialogButtonStyle 10599 * @syscap SystemCapability.ArkUI.ArkUI.Full 10600 * @crossplatform 10601 * @atomicservice 10602 * @since arkts {'1.1':'12','1.2':'20'} 10603 * @arkts 1.1&1.2 10604 */ 10605declare interface PickerDialogButtonStyle { 10606 /** 10607 * Describes the button style. 10608 * 10609 * @type { ?ButtonType } 10610 * @syscap SystemCapability.ArkUI.ArkUI.Full 10611 * @crossplatform 10612 * @atomicservice 10613 * @since arkts {'1.1':'12','1.2':'20'} 10614 * @arkts 1.1&1.2 10615 */ 10616 type?: ButtonType; 10617 10618 /** 10619 * Describes the button style. 10620 * 10621 * @type { ?ButtonStyleMode } 10622 * @syscap SystemCapability.ArkUI.ArkUI.Full 10623 * @crossplatform 10624 * @atomicservice 10625 * @since arkts {'1.1':'12','1.2':'20'} 10626 * @arkts 1.1&1.2 10627 */ 10628 style?: ButtonStyleMode; 10629 10630 /** 10631 * Describes the button role. 10632 * 10633 * @type { ?ButtonRole } 10634 * @syscap SystemCapability.ArkUI.ArkUI.Full 10635 * @crossplatform 10636 * @atomicservice 10637 * @since arkts {'1.1':'12','1.2':'20'} 10638 * @arkts 1.1&1.2 10639 */ 10640 role?: ButtonRole; 10641 10642 /** 10643 * Describes the button text size. 10644 * 10645 * @type { ?Length } 10646 * @syscap SystemCapability.ArkUI.ArkUI.Full 10647 * @crossplatform 10648 * @atomicservice 10649 * @since arkts {'1.1':'12','1.2':'20'} 10650 * @arkts 1.1&1.2 10651 */ 10652 fontSize?: Length; 10653 10654 /** 10655 * Describes the button text color. 10656 * 10657 * @type { ?ResourceColor } 10658 * @syscap SystemCapability.ArkUI.ArkUI.Full 10659 * @crossplatform 10660 * @atomicservice 10661 * @since arkts {'1.1':'12','1.2':'20'} 10662 * @arkts 1.1&1.2 10663 */ 10664 fontColor?: ResourceColor; 10665 10666 /** 10667 * Describes the button font weight. 10668 * 10669 * @type { ?(FontWeight | number | string) } 10670 * @syscap SystemCapability.ArkUI.ArkUI.Full 10671 * @crossplatform 10672 * @atomicservice 10673 * @since arkts {'1.1':'12','1.2':'20'} 10674 * @arkts 1.1&1.2 10675 */ 10676 fontWeight?: FontWeight | number | string; 10677 10678 /** 10679 * Describes the button font style. 10680 * 10681 * @type { ?FontStyle } 10682 * @syscap SystemCapability.ArkUI.ArkUI.Full 10683 * @crossplatform 10684 * @atomicservice 10685 * @since arkts {'1.1':'12','1.2':'20'} 10686 * @arkts 1.1&1.2 10687 */ 10688 fontStyle?: FontStyle; 10689 10690 /** 10691 * Describes the button font family. 10692 * 10693 * @type { ?(Resource | string) } 10694 * @syscap SystemCapability.ArkUI.ArkUI.Full 10695 * @crossplatform 10696 * @atomicservice 10697 * @since arkts {'1.1':'12','1.2':'20'} 10698 * @arkts 1.1&1.2 10699 */ 10700 fontFamily?: Resource | string; 10701 10702 /** 10703 * Describes the button background color. 10704 * 10705 * @type { ?ResourceColor } 10706 * @syscap SystemCapability.ArkUI.ArkUI.Full 10707 * @crossplatform 10708 * @atomicservice 10709 * @since arkts {'1.1':'12','1.2':'20'} 10710 * @arkts 1.1&1.2 10711 */ 10712 backgroundColor?: ResourceColor; 10713 10714 /** 10715 * Describes the button border radius. 10716 * 10717 * @type { ?(Length | BorderRadiuses) } 10718 * @syscap SystemCapability.ArkUI.ArkUI.Full 10719 * @crossplatform 10720 * @atomicservice 10721 * @since arkts {'1.1':'12','1.2':'20'} 10722 * @arkts 1.1&1.2 10723 */ 10724 borderRadius?: Length | BorderRadiuses; 10725 10726 /** 10727 * Define whether the button default to responding to the Enter key 10728 * 10729 * @type { ?boolean } 10730 * @syscap SystemCapability.ArkUI.ArkUI.Full 10731 * @crossplatform 10732 * @atomicservice 10733 * @since arkts {'1.1':'12','1.2':'20'} 10734 * @arkts 1.1&1.2 10735 */ 10736 primary?: boolean; 10737} 10738 10739/** 10740 * Define the type of shadow 10741 * 10742 * @enum { number } 10743 * @syscap SystemCapability.ArkUI.ArkUI.Full 10744 * @crossplatform 10745 * @since 10 10746 */ 10747/** 10748 * Define the type of shadow 10749 * 10750 * @enum { number } 10751 * @syscap SystemCapability.ArkUI.ArkUI.Full 10752 * @crossplatform 10753 * @atomicservice 10754 * @since arkts {'1.1':'11','1.2':'20'} 10755 * @arkts 1.1&1.2 10756 */ 10757declare enum ShadowType { 10758 /** 10759 * Define a color type of shadow 10760 * 10761 * @syscap SystemCapability.ArkUI.ArkUI.Full 10762 * @crossplatform 10763 * @since 10 10764 */ 10765 /** 10766 * Define a color type of shadow 10767 * 10768 * @syscap SystemCapability.ArkUI.ArkUI.Full 10769 * @crossplatform 10770 * @atomicservice 10771 * @since arkts {'1.1':'11','1.2':'20'} 10772 * @arkts 1.1&1.2 10773 */ 10774 COLOR, 10775 10776 /** 10777 * Blur. 10778 * 10779 * @syscap SystemCapability.ArkUI.ArkUI.Full 10780 * @crossplatform 10781 * @since 10 10782 */ 10783 /** 10784 * Blur. 10785 * 10786 * @syscap SystemCapability.ArkUI.ArkUI.Full 10787 * @crossplatform 10788 * @atomicservice 10789 * @since arkts {'1.1':'11','1.2':'20'} 10790 * @arkts 1.1&1.2 10791 */ 10792 BLUR, 10793} 10794 10795/** 10796 * Define the options of shadow 10797 * 10798 * @interface ShadowOptions 10799 * @syscap SystemCapability.ArkUI.ArkUI.Full 10800 * @since 7 10801 */ 10802/** 10803 * Define the options of shadow 10804 * 10805 * @interface ShadowOptions 10806 * @syscap SystemCapability.ArkUI.ArkUI.Full 10807 * @form 10808 * @since 9 10809 */ 10810/** 10811 * Define the options of shadow 10812 * 10813 * @interface ShadowOptions 10814 * @syscap SystemCapability.ArkUI.ArkUI.Full 10815 * @crossplatform 10816 * @form 10817 * @since 10 10818 */ 10819/** 10820 * Define the options of shadow 10821 * 10822 * @interface ShadowOptions 10823 * @syscap SystemCapability.ArkUI.ArkUI.Full 10824 * @crossplatform 10825 * @form 10826 * @atomicservice 10827 * @since arkts {'1.1':'11','1.2':'20'} 10828 * @arkts 1.1&1.2 10829 */ 10830declare interface ShadowOptions { 10831 /** 10832 * Blur radius of the shadow. 10833 * 10834 * @type { number | Resource } 10835 * @syscap SystemCapability.ArkUI.ArkUI.Full 10836 * @since 7 10837 */ 10838 /** 10839 * Blur radius of the shadow. 10840 * 10841 * @type { number | Resource } 10842 * @syscap SystemCapability.ArkUI.ArkUI.Full 10843 * @form 10844 * @since 9 10845 */ 10846 /** 10847 * Blur radius of the shadow. 10848 * 10849 * @type { number | Resource } 10850 * @syscap SystemCapability.ArkUI.ArkUI.Full 10851 * @crossplatform 10852 * @form 10853 * @since 10 10854 */ 10855 /** 10856 * Blur radius of the shadow. 10857 * 10858 * @type { number | Resource } 10859 * @syscap SystemCapability.ArkUI.ArkUI.Full 10860 * @crossplatform 10861 * @form 10862 * @atomicservice 10863 * @since arkts {'1.1':'11','1.2':'20'} 10864 * @arkts 1.1&1.2 10865 */ 10866 radius: number | Resource; 10867 10868 /** 10869 * Shadow type. 10870 * <br>Default value: **COLOR**. 10871 * 10872 * @type { ?ShadowType } 10873 * @default ShadowType.COLOR 10874 * @syscap SystemCapability.ArkUI.ArkUI.Full 10875 * @crossplatform 10876 * @since 10 10877 */ 10878 /** 10879 * Shadow type. 10880 * <br>Default value: **COLOR**. 10881 * 10882 * @type { ?ShadowType } 10883 * @default ShadowType.COLOR 10884 * @syscap SystemCapability.ArkUI.ArkUI.Full 10885 * @crossplatform 10886 * @atomicservice 10887 * @since arkts {'1.1':'11','1.2':'20'} 10888 * @arkts 1.1&1.2 10889 */ 10890 type?: ShadowType; 10891 10892 /** 10893 * Color of the shadow. Default value: **Black** 10894 * 10895 * @type { ?(Color | string | Resource) } 10896 * @syscap SystemCapability.ArkUI.ArkUI.Full 10897 * @since 7 10898 */ 10899 /** 10900 * Color of the shadow. Default value: **Black** 10901 * 10902 * @type { ?(Color | string | Resource) } 10903 * @syscap SystemCapability.ArkUI.ArkUI.Full 10904 * @form 10905 * @since 9 10906 */ 10907 /** 10908 * Color of the shadow. Default value: **Black** 10909 * 10910 * @type { ?(Color | string | Resource) } 10911 * @syscap SystemCapability.ArkUI.ArkUI.Full 10912 * @crossplatform 10913 * @form 10914 * @since 10 10915 */ 10916 /** 10917 * Color of the shadow. Default value: **Black** 10918 * 10919 * @type { ?(Color | string | Resource| ColoringStrategy) } 10920 * @syscap SystemCapability.ArkUI.ArkUI.Full 10921 * @crossplatform 10922 * @form 10923 * @atomicservice 10924 * @since arkts {'1.1':'11','1.2':'20'} 10925 * @arkts 1.1&1.2 10926 */ 10927 color?: Color | string | Resource | ColoringStrategy; 10928 10929 /** 10930 * Offset of the shadow along the x-axis. Unit is px. Default value is 0. 10931 * 10932 * @type { ?(number | Resource) } 10933 * @syscap SystemCapability.ArkUI.ArkUI.Full 10934 * @since 7 10935 */ 10936 /** 10937 * Offset of the shadow along the x-axis. Unit is px. Default value is 0. 10938 * 10939 * @type { ?(number | Resource) } 10940 * @syscap SystemCapability.ArkUI.ArkUI.Full 10941 * @form 10942 * @since 9 10943 */ 10944 /** 10945 * Offset of the shadow along the x-axis. Unit is px. Default value is 0. 10946 * 10947 * @type { ?(number | Resource) } 10948 * @syscap SystemCapability.ArkUI.ArkUI.Full 10949 * @crossplatform 10950 * @form 10951 * @since 10 10952 */ 10953 /** 10954 * Offset of the shadow along the x-axis. Unit is px. Default value is 0. 10955 * 10956 * @type { ?(number | Resource) } 10957 * @syscap SystemCapability.ArkUI.ArkUI.Full 10958 * @crossplatform 10959 * @form 10960 * @atomicservice 10961 * @since arkts {'1.1':'11','1.2':'20'} 10962 * @arkts 1.1&1.2 10963 */ 10964 offsetX?: number | Resource; 10965 10966 /** 10967 * Offset of the shadow along the y-axis. Unit is px. Default value is 0. 10968 * 10969 * @type { ?(number | Resource) } 10970 * @syscap SystemCapability.ArkUI.ArkUI.Full 10971 * @since 7 10972 */ 10973 /** 10974 * Offset of the shadow along the y-axis. Unit is px. Default value is 0. 10975 * 10976 * @type { ?(number | Resource) } 10977 * @syscap SystemCapability.ArkUI.ArkUI.Full 10978 * @form 10979 * @since 9 10980 */ 10981 /** 10982 * Offset of the shadow along the y-axis. Unit is px. Default value is 0. 10983 * 10984 * @type { ?(number | Resource) } 10985 * @syscap SystemCapability.ArkUI.ArkUI.Full 10986 * @crossplatform 10987 * @form 10988 * @since 10 10989 */ 10990 /** 10991 * Offset of the shadow along the y-axis. Unit is px. Default value is 0. 10992 * 10993 * @type { ?(number | Resource) } 10994 * @syscap SystemCapability.ArkUI.ArkUI.Full 10995 * @crossplatform 10996 * @form 10997 * @atomicservice 10998 * @since arkts {'1.1':'11','1.2':'20'} 10999 * @arkts 1.1&1.2 11000 */ 11001 offsetY?: number | Resource; 11002 11003 /** 11004 * Whether to fill the inside of the component with shadow. **true**: Fill 11005 * the inside of the component with shadow. 11006 * <br>**false**: Do not fill the inside of the component with shadow. 11007 * <br>The default value is **false**. 11008 * <br>**NOTE**<br>This attribute does not take effect in textShadow. 11009 * 11010 * @type { ?boolean } 11011 * @default false 11012 * @syscap SystemCapability.ArkUI.ArkUI.Full 11013 * @crossplatform 11014 * @since 11 11015 */ 11016 /** 11017 * Whether to fill the inside of the component with shadow. **true**: Fill 11018 * the inside of the component with shadow. 11019 * <br>**false**: Do not fill the inside of the component with shadow. 11020 * <br>The default value is **false**. 11021 * <br>**NOTE**<br>This attribute does not take effect in textShadow. 11022 * 11023 * @type { ?boolean } 11024 * @default false 11025 * @syscap SystemCapability.ArkUI.ArkUI.Full 11026 * @crossplatform 11027 * @atomicservice 11028 * @since arkts {'1.1':'12','1.2':'20'} 11029 * @arkts 1.1&1.2 11030 */ 11031 fill?: boolean; 11032} 11033 11034/** 11035 * enum Shadow style 11036 * 11037 * @enum { number } 11038 * @syscap SystemCapability.ArkUI.ArkUI.Full 11039 * @crossplatform 11040 * @since 10 11041 */ 11042/** 11043 * enum Shadow style 11044 * 11045 * @enum { number } 11046 * @syscap SystemCapability.ArkUI.ArkUI.Full 11047 * @crossplatform 11048 * @atomicservice 11049 * @since arkts {'1.1':'11','1.2':'20'} 11050 * @arkts 1.1&1.2 11051 */ 11052declare enum ShadowStyle { 11053 /** 11054 * Defines the super small default shadow style. 11055 * 11056 * @syscap SystemCapability.ArkUI.ArkUI.Full 11057 * @crossplatform 11058 * @since 10 11059 */ 11060 /** 11061 * Defines the super small default shadow style. 11062 * 11063 * @syscap SystemCapability.ArkUI.ArkUI.Full 11064 * @crossplatform 11065 * @atomicservice 11066 * @since arkts {'1.1':'11','1.2':'20'} 11067 * @arkts 1.1&1.2 11068 */ 11069 OUTER_DEFAULT_XS, 11070 11071 /** 11072 * Defines the small default shadow style. 11073 * 11074 * @syscap SystemCapability.ArkUI.ArkUI.Full 11075 * @crossplatform 11076 * @since 10 11077 */ 11078 /** 11079 * Defines the small default shadow style. 11080 * 11081 * @syscap SystemCapability.ArkUI.ArkUI.Full 11082 * @crossplatform 11083 * @atomicservice 11084 * @since arkts {'1.1':'11','1.2':'20'} 11085 * @arkts 1.1&1.2 11086 */ 11087 OUTER_DEFAULT_SM, 11088 11089 /** 11090 * Medium shadow. 11091 * 11092 * @syscap SystemCapability.ArkUI.ArkUI.Full 11093 * @crossplatform 11094 * @since 10 11095 */ 11096 /** 11097 * Medium shadow. 11098 * 11099 * @syscap SystemCapability.ArkUI.ArkUI.Full 11100 * @crossplatform 11101 * @atomicservice 11102 * @since arkts {'1.1':'11','1.2':'20'} 11103 * @arkts 1.1&1.2 11104 */ 11105 OUTER_DEFAULT_MD, 11106 11107 /** 11108 * Large shadow. 11109 * 11110 * @syscap SystemCapability.ArkUI.ArkUI.Full 11111 * @crossplatform 11112 * @since 10 11113 */ 11114 /** 11115 * Large shadow. 11116 * 11117 * @syscap SystemCapability.ArkUI.ArkUI.Full 11118 * @crossplatform 11119 * @atomicservice 11120 * @since arkts {'1.1':'11','1.2':'20'} 11121 * @arkts 1.1&1.2 11122 */ 11123 OUTER_DEFAULT_LG, 11124 11125 /** 11126 * Floating medium shadow. 11127 * 11128 * @syscap SystemCapability.ArkUI.ArkUI.Full 11129 * @crossplatform 11130 * @since 10 11131 */ 11132 /** 11133 * Floating medium shadow. 11134 * 11135 * @syscap SystemCapability.ArkUI.ArkUI.Full 11136 * @crossplatform 11137 * @atomicservice 11138 * @since arkts {'1.1':'11','1.2':'20'} 11139 * @arkts 1.1&1.2 11140 */ 11141 OUTER_FLOATING_SM, 11142 11143 /** 11144 * Defines the medium floating shadow style. 11145 * 11146 * @syscap SystemCapability.ArkUI.ArkUI.Full 11147 * @crossplatform 11148 * @since 10 11149 */ 11150 /** 11151 * Floating medium shadow. 11152 * 11153 * @syscap SystemCapability.ArkUI.ArkUI.Full 11154 * @crossplatform 11155 * @atomicservice 11156 * @since arkts {'1.1':'11','1.2':'20'} 11157 * @arkts 1.1&1.2 11158 */ 11159 OUTER_FLOATING_MD, 11160} 11161 11162/** 11163 * Defines the options of Shadow. 11164 * 11165 * @interface MultiShadowOptions 11166 * @syscap SystemCapability.ArkUI.ArkUI.Full 11167 * @crossplatform 11168 * @since 10 11169 */ 11170/** 11171 * Defines the options of Shadow. 11172 * 11173 * @interface MultiShadowOptions 11174 * @syscap SystemCapability.ArkUI.ArkUI.Full 11175 * @crossplatform 11176 * @atomicservice 11177 * @since arkts {'1.1':'11','1.2':'20'} 11178 * @arkts 1.1&1.2 11179 */ 11180declare interface MultiShadowOptions { 11181 /** 11182 * Shadow blur radius. 11183 * Unit: vp. 11184 * <p>**NOTE**: 11185 * <br>A value less than or equal to 0 is handled as the default value. 11186 * </p> 11187 * 11188 * @type { ?(number | Resource) } 11189 * @default 5 11190 * @syscap SystemCapability.ArkUI.ArkUI.Full 11191 * @crossplatform 11192 * @since 10 11193 */ 11194 /** 11195 * Shadow blur radius. 11196 * Unit: vp. 11197 * <p>**NOTE**: 11198 * <br>A value less than or equal to 0 is handled as the default value. 11199 * </p> 11200 * 11201 * @type { ?(number | Resource) } 11202 * @default 20 11203 * @syscap SystemCapability.ArkUI.ArkUI.Full 11204 * @crossplatform 11205 * @atomicservice 11206 * @since arkts {'1.1':'11','1.2':'20'} 11207 * @arkts 1.1&1.2 11208 */ 11209 radius?: number | Resource; 11210 11211 /** 11212 * Offset on the x-axis. 11213 * Unit: vp. 11214 * 11215 * @type { ?(number | Resource) } 11216 * @default 5 11217 * @syscap SystemCapability.ArkUI.ArkUI.Full 11218 * @crossplatform 11219 * @since 10 11220 */ 11221 /** 11222 * Offset on the x-axis. 11223 * Unit: vp. 11224 * 11225 * @type { ?(number | Resource) } 11226 * @default 5 11227 * @syscap SystemCapability.ArkUI.ArkUI.Full 11228 * @crossplatform 11229 * @atomicservice 11230 * @since arkts {'1.1':'11','1.2':'20'} 11231 * @arkts 1.1&1.2 11232 */ 11233 offsetX?: number | Resource; 11234 11235 /** 11236 * Offset on the y-axis. 11237 * Unit: vp. 11238 * 11239 * @type { ?(number | Resource) } 11240 * @default 5 11241 * @syscap SystemCapability.ArkUI.ArkUI.Full 11242 * @crossplatform 11243 * @since 10 11244 */ 11245 /** 11246 * Offset on the y-axis. 11247 * Unit: vp. 11248 * 11249 * @type { ?(number | Resource) } 11250 * @default 5 11251 * @syscap SystemCapability.ArkUI.ArkUI.Full 11252 * @crossplatform 11253 * @atomicservice 11254 * @since arkts {'1.1':'11','1.2':'20'} 11255 * @arkts 1.1&1.2 11256 */ 11257 offsetY?: number | Resource; 11258} 11259 11260/** 11261 * Enumerates the safe area types. 11262 * 11263 * @enum { number } 11264 * @syscap SystemCapability.ArkUI.ArkUI.Full 11265 * @since 10 11266 */ 11267/** 11268 * The types of expanded safe areas. 11269 * 11270 * @enum { number } 11271 * @syscap SystemCapability.ArkUI.ArkUI.Full 11272 * @crossplatform 11273 * @atomicservice 11274 * @since arkts {'1.1':'11','1.2':'20'} 11275 * @arkts 1.1&1.2 11276 */ 11277declare enum SafeAreaType { 11278 /** 11279 * Default area of the system, including the status bar and navigation bar. 11280 * 11281 * @syscap SystemCapability.ArkUI.ArkUI.Full 11282 * @since 10 11283 */ 11284 /** 11285 * Default non-safe area of the system, including the status bar and navigation bar. 11286 * 11287 * @syscap SystemCapability.ArkUI.ArkUI.Full 11288 * @crossplatform 11289 * @atomicservice 11290 * @since arkts {'1.1':'11','1.2':'20'} 11291 * @arkts 1.1&1.2 11292 */ 11293 SYSTEM, 11294 11295 /** 11296 * Notch or punch hole. 11297 * 11298 * @syscap SystemCapability.ArkUI.ArkUI.Full 11299 * @since 10 11300 */ 11301 /** 11302 * Non-safe area of the device like Notch or punch hole. 11303 * 11304 * @syscap SystemCapability.ArkUI.ArkUI.Full 11305 * @crossplatform 11306 * @atomicservice 11307 * @since arkts {'1.1':'11','1.2':'20'} 11308 * @arkts 1.1&1.2 11309 */ 11310 CUTOUT, 11311 11312 /** 11313 * Soft keyboard area. 11314 * 11315 * @syscap SystemCapability.ArkUI.ArkUI.Full 11316 * @since 10 11317 */ 11318 /** 11319 * Soft keyboard area. 11320 * 11321 * @syscap SystemCapability.ArkUI.ArkUI.Full 11322 * @crossplatform 11323 * @atomicservice 11324 * @since arkts {'1.1':'11','1.2':'20'} 11325 * @arkts 1.1&1.2 11326 */ 11327 KEYBOARD 11328} 11329 11330/** 11331 * Enumerates the safe area edges. 11332 * 11333 * @enum { number } 11334 * @syscap SystemCapability.ArkUI.ArkUI.Full 11335 * @since 10 11336 */ 11337/** 11338 * Enumerates the safe area edges. 11339 * 11340 * @enum { number } 11341 * @syscap SystemCapability.ArkUI.ArkUI.Full 11342 * @crossplatform 11343 * @atomicservice 11344 * @since arkts {'1.1':'11','1.2':'20'} 11345 * @arkts 1.1&1.2 11346 */ 11347declare enum SafeAreaEdge { 11348 /** 11349 * Top edge of the safe area. 11350 * 11351 * @syscap SystemCapability.ArkUI.ArkUI.Full 11352 * @since 10 11353 */ 11354 /** 11355 * Top edge. 11356 * 11357 * @syscap SystemCapability.ArkUI.ArkUI.Full 11358 * @crossplatform 11359 * @atomicservice 11360 * @since arkts {'1.1':'11','1.2':'20'} 11361 * @arkts 1.1&1.2 11362 */ 11363 TOP, 11364 11365 /** 11366 * Bottom edge of the safe area. 11367 * 11368 * @syscap SystemCapability.ArkUI.ArkUI.Full 11369 * @since 10 11370 */ 11371 /** 11372 * Bottom edge. 11373 * 11374 * @syscap SystemCapability.ArkUI.ArkUI.Full 11375 * @crossplatform 11376 * @atomicservice 11377 * @since arkts {'1.1':'11','1.2':'20'} 11378 * @arkts 1.1&1.2 11379 */ 11380 BOTTOM, 11381 11382 /** 11383 * Start edge of the safe area. 11384 * 11385 * @syscap SystemCapability.ArkUI.ArkUI.Full 11386 * @since 10 11387 */ 11388 /** 11389 * Start edge. 11390 * 11391 * @syscap SystemCapability.ArkUI.ArkUI.Full 11392 * @crossplatform 11393 * @atomicservice 11394 * @since arkts {'1.1':'11','1.2':'20'} 11395 * @arkts 1.1&1.2 11396 */ 11397 START, 11398 11399 /** 11400 * End edge of the safe area. 11401 * 11402 * @syscap SystemCapability.ArkUI.ArkUI.Full 11403 * @since 10 11404 */ 11405 /** 11406 * End edge. 11407 * 11408 * @syscap SystemCapability.ArkUI.ArkUI.Full 11409 * @crossplatform 11410 * @atomicservice 11411 * @since arkts {'1.1':'11','1.2':'20'} 11412 * @arkts 1.1&1.2 11413 */ 11414 END 11415} 11416 11417/** 11418 * Describe the types for expanding the safe area in layout. 11419 * 11420 * @enum { number } 11421 * @syscap SystemCapability.ArkUI.ArkUI.Full 11422 * @crossplatform 11423 * @atomicservice 11424 * @since arkts {'1.1':'12','1.2':'20'} 11425 * @arkts 1.1&1.2 11426 */ 11427declare enum LayoutSafeAreaType { 11428 /** 11429 * Default non-safe area of the system, including the status bar and navigation bar. 11430 * 11431 * @syscap SystemCapability.ArkUI.ArkUI.Full 11432 * @crossplatform 11433 * @atomicservice 11434 * @since arkts {'1.1':'12','1.2':'20'} 11435 * @arkts 1.1&1.2 11436 */ 11437 SYSTEM = 0, 11438} 11439 11440/** 11441 * Define the edges for expanding the safe area in layout. 11442 * 11443 * @enum { number } 11444 * @syscap SystemCapability.ArkUI.ArkUI.Full 11445 * @crossplatform 11446 * @atomicservice 11447 * @since arkts {'1.1':'12','1.2':'20'} 11448 * @arkts 1.1&1.2 11449 */ 11450declare enum LayoutSafeAreaEdge { 11451 /** 11452 * Top edge. 11453 * 11454 * @syscap SystemCapability.ArkUI.ArkUI.Full 11455 * @crossplatform 11456 * @atomicservice 11457 * @since arkts {'1.1':'12','1.2':'20'} 11458 * @arkts 1.1&1.2 11459 */ 11460 TOP = 0, 11461 11462 /** 11463 * Bottom edge. 11464 * 11465 * @syscap SystemCapability.ArkUI.ArkUI.Full 11466 * @crossplatform 11467 * @atomicservice 11468 * @since arkts {'1.1':'12','1.2':'20'} 11469 * @arkts 1.1&1.2 11470 */ 11471 BOTTOM = 1, 11472 11473 /** 11474 * Start edge of the safe area. 11475 * 11476 * @syscap SystemCapability.ArkUI.ArkUI.Full 11477 * @crossplatform 11478 * @atomicservice 11479 * @since 20 11480 */ 11481 START = 2, 11482 11483 /** 11484 * End edge of the safe area. 11485 * 11486 * @syscap SystemCapability.ArkUI.ArkUI.Full 11487 * @crossplatform 11488 * @atomicservice 11489 * @since 20 11490 */ 11491 END = 3, 11492 11493 /** 11494 * Vertical edge of the safe area. 11495 * 11496 * @syscap SystemCapability.ArkUI.ArkUI.Full 11497 * @crossplatform 11498 * @atomicservice 11499 * @since 20 11500 */ 11501 VERTICAL = 4, 11502 11503 /** 11504 * Horizontal edge of the safe area. 11505 * 11506 * @syscap SystemCapability.ArkUI.ArkUI.Full 11507 * @crossplatform 11508 * @atomicservice 11509 * @since 20 11510 */ 11511 HORIZONTAL = 5, 11512 11513 /** 11514 * All edges of the safe area. 11515 * 11516 * @syscap SystemCapability.ArkUI.ArkUI.Full 11517 * @crossplatform 11518 * @atomicservice 11519 * @since 20 11520 */ 11521 ALL = 6, 11522} 11523 11524/** 11525 * Defines sheet size type. 11526 * 11527 * @enum { number } 11528 * @syscap SystemCapability.ArkUI.ArkUI.Full 11529 * @crossplatform 11530 * @since 10 11531 */ 11532/** 11533 * Defines sheet size type. 11534 * 11535 * @enum { number } 11536 * @syscap SystemCapability.ArkUI.ArkUI.Full 11537 * @crossplatform 11538 * @atomicservice 11539 * @since arkts {'1.1':'11','1.2':'20'} 11540 * @arkts 1.1&1.2 11541 */ 11542declare enum SheetSize { 11543 /** 11544 * The sheet height is half of the screen height. 11545 * 11546 * @syscap SystemCapability.ArkUI.ArkUI.Full 11547 * @crossplatform 11548 * @since 10 11549 */ 11550 /** 11551 * The sheet height is half of the screen height. 11552 * 11553 * @syscap SystemCapability.ArkUI.ArkUI.Full 11554 * @crossplatform 11555 * @atomicservice 11556 * @since arkts {'1.1':'11','1.2':'20'} 11557 * @arkts 1.1&1.2 11558 */ 11559 MEDIUM, 11560 11561 /** 11562 * The sheet height is almost the screen height. 11563 * 11564 * @syscap SystemCapability.ArkUI.ArkUI.Full 11565 * @crossplatform 11566 * @since 10 11567 */ 11568 /** 11569 * The sheet height is almost the screen height. 11570 * 11571 * @syscap SystemCapability.ArkUI.ArkUI.Full 11572 * @crossplatform 11573 * @atomicservice 11574 * @since arkts {'1.1':'11','1.2':'20'} 11575 * @arkts 1.1&1.2 11576 */ 11577 LARGE, 11578 11579 /** 11580 * The sheet height automatically adapts to the content. 11581 * 11582 * @syscap SystemCapability.ArkUI.ArkUI.Full 11583 * @crossplatform 11584 * @since 11 11585 */ 11586 /** 11587 * The sheet height automatically adapts to the content. 11588 * 11589 * @syscap SystemCapability.ArkUI.ArkUI.Full 11590 * @crossplatform 11591 * @atomicservice 11592 * @since arkts {'1.1':'12','1.2':'20'} 11593 * @arkts 1.1&1.2 11594 */ 11595 FIT_CONTENT = 2, 11596} 11597 11598/** 11599 * The modifier key state query function block. 11600 * 11601 * @typedef { function } ModifierKeyStateGetter 11602 * @param { Array<string> } keys - Indicate the modifier keys to query. 11603 * @returns { boolean } - the query result 11604 * @syscap SystemCapability.ArkUI.ArkUI.Full 11605 * @crossplatform 11606 * @atomicservice 11607 * @since 20 11608 * @arkts 1.2 11609 */ 11610declare type ModifierKeyStateGetter = (keys: Array<string>) => boolean; 11611 11612/** 11613 * Defines the base event. 11614 * 11615 * @interface BaseEvent 11616 * @syscap SystemCapability.ArkUI.ArkUI.Full 11617 * @since 8 11618 */ 11619/** 11620 * Defines the base event. 11621 * 11622 * @interface BaseEvent 11623 * @syscap SystemCapability.ArkUI.ArkUI.Full 11624 * @form 11625 * @since 9 11626 */ 11627/** 11628 * Defines the base event. 11629 * 11630 * @interface BaseEvent 11631 * @syscap SystemCapability.ArkUI.ArkUI.Full 11632 * @crossplatform 11633 * @form 11634 * @since 10 11635 */ 11636/** 11637 * Defines the base event. 11638 * 11639 * @interface BaseEvent 11640 * @syscap SystemCapability.ArkUI.ArkUI.Full 11641 * @crossplatform 11642 * @form 11643 * @atomicservice 11644 * @since arkts {'1.1':'11','1.2':'20'} 11645 * @arkts 1.1&1.2 11646 */ 11647declare interface BaseEvent { 11648 /** 11649 * Defines the current target which fires this event. 11650 * 11651 * @type { EventTarget } 11652 * @syscap SystemCapability.ArkUI.ArkUI.Full 11653 * @since 8 11654 */ 11655 /** 11656 * Defines the current target which fires this event. 11657 * 11658 * @type { EventTarget } 11659 * @syscap SystemCapability.ArkUI.ArkUI.Full 11660 * @form 11661 * @since 9 11662 */ 11663 /** 11664 * Defines the current target which fires this event. 11665 * 11666 * @type { EventTarget } 11667 * @syscap SystemCapability.ArkUI.ArkUI.Full 11668 * @crossplatform 11669 * @form 11670 * @since 10 11671 */ 11672 /** 11673 * Display area of the element that triggers the gesture event. 11674 * 11675 * @type { EventTarget } 11676 * @syscap SystemCapability.ArkUI.ArkUI.Full 11677 * @crossplatform 11678 * @form 11679 * @atomicservice 11680 * @since arkts {'1.1':'11','1.2':'20'} 11681 * @arkts 1.1&1.2 11682 */ 11683 target: EventTarget; 11684 11685 /** 11686 * Event timestamp. 11687 * 11688 * @type { number } 11689 * @syscap SystemCapability.ArkUI.ArkUI.Full 11690 * @since 8 11691 */ 11692 /** 11693 * Event timestamp. 11694 * 11695 * @type { number } 11696 * @syscap SystemCapability.ArkUI.ArkUI.Full 11697 * @form 11698 * @since 9 11699 */ 11700 /** 11701 * Event timestamp. 11702 * 11703 * @type { number } 11704 * @syscap SystemCapability.ArkUI.ArkUI.Full 11705 * @crossplatform 11706 * @form 11707 * @since 10 11708 */ 11709 /** 11710 * Timestamp of the event. 11711 * 11712 * @type { number } 11713 * @syscap SystemCapability.ArkUI.ArkUI.Full 11714 * @crossplatform 11715 * @form 11716 * @atomicservice 11717 * @since arkts {'1.1':'11','1.2':'20'} 11718 * @arkts 1.1&1.2 11719 */ 11720 timestamp: number; 11721 11722 /** 11723 * the event source info. 11724 * 11725 * @type { SourceType } 11726 * @syscap SystemCapability.ArkUI.ArkUI.Full 11727 * @since 8 11728 */ 11729 /** 11730 * the event source info. 11731 * 11732 * @type { SourceType } 11733 * @syscap SystemCapability.ArkUI.ArkUI.Full 11734 * @form 11735 * @since 9 11736 */ 11737 /** 11738 * the event source info. 11739 * 11740 * @type { SourceType } 11741 * @syscap SystemCapability.ArkUI.ArkUI.Full 11742 * @crossplatform 11743 * @form 11744 * @since 10 11745 */ 11746 /** 11747 * Event input device. 11748 * 11749 * @type { SourceType } 11750 * @syscap SystemCapability.ArkUI.ArkUI.Full 11751 * @crossplatform 11752 * @form 11753 * @atomicservice 11754 * @since arkts {'1.1':'11','1.2':'20'} 11755 * @arkts 1.1&1.2 11756 */ 11757 source: SourceType; 11758 11759 /** 11760 * the Horizontal axis coordinate. 11761 * 11762 * @type { ?number } 11763 * @syscap SystemCapability.ArkUI.ArkUI.Full 11764 * @crossplatform 11765 * @form 11766 * @atomicservice 11767 * @since arkts {'1.1':'12','1.2':'20'} 11768 * @arkts 1.1&1.2 11769 */ 11770 axisHorizontal?: number; 11771 11772 /** 11773 * the Vertical axis coordinate. 11774 * 11775 * @type { ?number } 11776 * @syscap SystemCapability.ArkUI.ArkUI.Full 11777 * @crossplatform 11778 * @form 11779 * @atomicservice 11780 * @since arkts {'1.1':'12','1.2':'20'} 11781 * @arkts 1.1&1.2 11782 */ 11783 axisVertical?: number; 11784 11785 /** 11786 * Touch pressure. 11787 * 11788 * @type { number } 11789 * @syscap SystemCapability.ArkUI.ArkUI.Full 11790 * @form 11791 * @since 9 11792 */ 11793 /** 11794 * Touch pressure. 11795 * 11796 * @type { number } 11797 * @syscap SystemCapability.ArkUI.ArkUI.Full 11798 * @crossplatform 11799 * @form 11800 * @since 10 11801 */ 11802 /** 11803 * Press pressure. 11804 * 11805 * @type { number } 11806 * @syscap SystemCapability.ArkUI.ArkUI.Full 11807 * @crossplatform 11808 * @form 11809 * @atomicservice 11810 * @since arkts {'1.1':'11','1.2':'20'} 11811 * @arkts 1.1&1.2 11812 */ 11813 pressure: number; 11814 11815 /** 11816 * The angle between pencil projection on plane-X-Y and axis-Z. 11817 * 11818 * @type { number } 11819 * @syscap SystemCapability.ArkUI.ArkUI.Full 11820 * @form 11821 * @since 9 11822 */ 11823 /** 11824 * The angle between pencil projection on plane-X-Y and axis-Z. 11825 * 11826 * @type { number } 11827 * @syscap SystemCapability.ArkUI.ArkUI.Full 11828 * @crossplatform 11829 * @form 11830 * @since 10 11831 */ 11832 /** 11833 * Angle between the projection of the stylus on the device plane and the x-axis. 11834 * 11835 * @type { number } 11836 * @syscap SystemCapability.ArkUI.ArkUI.Full 11837 * @crossplatform 11838 * @form 11839 * @atomicservice 11840 * @since arkts {'1.1':'11','1.2':'20'} 11841 * @arkts 1.1&1.2 11842 */ 11843 tiltX: number; 11844 11845 /** 11846 * The angle between pencil projection on plane-Y-Z and axis-Z. 11847 * 11848 * @type { number } 11849 * @syscap SystemCapability.ArkUI.ArkUI.Full 11850 * @form 11851 * @since 9 11852 */ 11853 /** 11854 * The angle between pencil projection on plane-Y-Z and axis-Z. 11855 * 11856 * @type { number } 11857 * @syscap SystemCapability.ArkUI.ArkUI.Full 11858 * @crossplatform 11859 * @form 11860 * @since 10 11861 */ 11862 /** 11863 * Angle between the projection of the stylus on the device plane and the y-axis. 11864 * 11865 * @type { number } 11866 * @syscap SystemCapability.ArkUI.ArkUI.Full 11867 * @crossplatform 11868 * @form 11869 * @atomicservice 11870 * @since arkts {'1.1':'11','1.2':'20'} 11871 * @arkts 1.1&1.2 11872 */ 11873 tiltY: number; 11874 11875 /** 11876 * Indicates the angle at which the stylus rotates around the Z-axis. 11877 * 11878 * @type { number } 11879 * @syscap SystemCapability.ArkUI.ArkUI.Full 11880 * @crossplatform 11881 * @form 11882 * @atomicservice 11883 * @since arkts {'1.1':'17','1.2':'20'} 11884 * @arkts 1.1&1.2 11885 */ 11886 rollAngle?: number; 11887 11888 /** 11889 * The event tool type info. 11890 * 11891 * @type { SourceTool } 11892 * @syscap SystemCapability.ArkUI.ArkUI.Full 11893 * @form 11894 * @since 9 11895 */ 11896 /** 11897 * The event tool type info. 11898 * 11899 * @type { SourceTool } 11900 * @syscap SystemCapability.ArkUI.ArkUI.Full 11901 * @crossplatform 11902 * @form 11903 * @since 10 11904 */ 11905 /** 11906 * Event input source. 11907 * 11908 * @type { SourceTool } 11909 * @syscap SystemCapability.ArkUI.ArkUI.Full 11910 * @crossplatform 11911 * @form 11912 * @atomicservice 11913 * @since arkts {'1.1':'11','1.2':'20'} 11914 * @arkts 1.1&1.2 11915 */ 11916 sourceTool: SourceTool; 11917 11918 /** 11919 * Obtains the pressed status of modifier keys. The following modifier keys are supported: 'Ctrl'|'Alt'|'Shift'. 11920 * 11921 * @param { Array<string> } keys - indicate the keys of the ModifierKey. 11922 * @returns { boolean } 11923 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 11924 * @syscap SystemCapability.ArkUI.ArkUI.Full 11925 * @crossplatform 11926 * @atomicservice 11927 * @since 12 11928 */ 11929 getModifierKeyState?(keys: Array<string>): boolean; 11930 11931 /** 11932 * Query the modifier key press state, support 'ctrl'|'alt'|'shift' 11933 * 11934 * @type { ?ModifierKeyStateGetter } 11935 * @syscap SystemCapability.ArkUI.ArkUI.Full 11936 * @crossplatform 11937 * @atomicservice 11938 * @since 20 11939 * @arkts 1.2 11940 */ 11941 getModifierKeyState?: ModifierKeyStateGetter; 11942 11943 /** 11944 * Indicates the ID of the input device that triggers the current event. 11945 * 11946 * @type { ?number } [deviceId] The ID of the input device that triggers the current event 11947 * @syscap SystemCapability.ArkUI.ArkUI.Full 11948 * @crossplatform 11949 * @atomicservice 11950 * @since arkts {'1.1':'12','1.2':'20'} 11951 * @arkts 1.1&1.2 11952 */ 11953 deviceId?: number; 11954 11955 /** 11956 * Indicates the screen ID on which the event occurred. 11957 * 11958 * @type { ?number } [targetDisplayId] The screen ID on which the event occurred. 11959 * @syscap SystemCapability.ArkUI.ArkUI.Full 11960 * @crossplatform 11961 * @atomicservice 11962 * @since arkts {'1.1':'15','1.2':'20'} 11963 * @arkts 1.1&1.2 11964 */ 11965 targetDisplayId?: number; 11966} 11967 11968/** 11969 * Border image option 11970 * 11971 * @interface BorderImageOption 11972 * @syscap SystemCapability.ArkUI.ArkUI.Full 11973 * @form 11974 * @since 9 11975 */ 11976/** 11977 * Border image option 11978 * 11979 * @interface BorderImageOption 11980 * @syscap SystemCapability.ArkUI.ArkUI.Full 11981 * @crossplatform 11982 * @form 11983 * @since 10 11984 */ 11985/** 11986 * Border image option 11987 * 11988 * @interface BorderImageOption 11989 * @syscap SystemCapability.ArkUI.ArkUI.Full 11990 * @crossplatform 11991 * @form 11992 * @atomicservice 11993 * @since arkts {'1.1':'11','1.2':'20'} 11994 * @arkts 1.1&1.2 11995 */ 11996declare interface BorderImageOption { 11997 /** 11998 * Border image slice 11999 * 12000 * @type { ?(Length | EdgeWidths) } 12001 * @syscap SystemCapability.ArkUI.ArkUI.Full 12002 * @form 12003 * @since 9 12004 */ 12005 /** 12006 * Border image slice 12007 * 12008 * @type { ?(Length | EdgeWidths) } 12009 * @syscap SystemCapability.ArkUI.ArkUI.Full 12010 * @crossplatform 12011 * @form 12012 * @since 10 12013 */ 12014 /** 12015 * Border image slice 12016 * 12017 * @type { ?(Length | EdgeWidths) } 12018 * @syscap SystemCapability.ArkUI.ArkUI.Full 12019 * @crossplatform 12020 * @form 12021 * @atomicservice 12022 * @since 11 12023 */ 12024 /** 12025 * Slice width of the upper left corner, upper right corner, lower left corner, 12026 * and lower right corner of the border image. 12027 * 12028 * @type { ?(Length | EdgeWidths | LocalizedEdgeWidths) } 12029 * @default 0 12030 * @syscap SystemCapability.ArkUI.ArkUI.Full 12031 * @crossplatform 12032 * @form 12033 * @atomicservice 12034 * @since arkts {'1.1':'12','1.2':'20'} 12035 * @arkts 1.1&1.2 12036 */ 12037 slice?: Length | EdgeWidths | LocalizedEdgeWidths, 12038 12039 /** 12040 * Border image repeat 12041 * 12042 * @type { ?RepeatMode } 12043 * @syscap SystemCapability.ArkUI.ArkUI.Full 12044 * @form 12045 * @since 9 12046 */ 12047 /** 12048 * Border image repeat 12049 * 12050 * @type { ?RepeatMode } 12051 * @syscap SystemCapability.ArkUI.ArkUI.Full 12052 * @crossplatform 12053 * @form 12054 * @since 10 12055 */ 12056 /** 12057 * Repeat mode of the source image's slices on the border. 12058 * 12059 * @type { ?RepeatMode } 12060 * @default RepeatMode.Stretch 12061 * @syscap SystemCapability.ArkUI.ArkUI.Full 12062 * @crossplatform 12063 * @form 12064 * @atomicservice 12065 * @since arkts {'1.1':'11','1.2':'20'} 12066 * @arkts 1.1&1.2 12067 */ 12068 repeat?: RepeatMode, 12069 12070 /** 12071 * Border image source 12072 * 12073 * @type { ?(string | Resource | LinearGradient) } 12074 * @syscap SystemCapability.ArkUI.ArkUI.Full 12075 * @form 12076 * @since 9 12077 */ 12078 /** 12079 * Border image source 12080 * 12081 * @type { ?(string | Resource | LinearGradient) } 12082 * @syscap SystemCapability.ArkUI.ArkUI.Full 12083 * @crossplatform 12084 * @form 12085 * @since 10 12086 */ 12087 /** 12088 * Source or gradient color of the border image. 12089 * When the type is string, this parameter sets the border image source. 12090 * For details about how to reference image resources, see Loading Image Resources. 12091 * 12092 * <p><strong>NOTE</strong>: 12093 * <br>The border image source applies only to container components, such as Row, Column, and Flex. 12094 * </p> 12095 * 12096 * @type { ?(string | Resource | LinearGradient) } 12097 * @syscap SystemCapability.ArkUI.ArkUI.Full 12098 * @crossplatform 12099 * @form 12100 * @atomicservice 12101 * @since 11 12102 */ 12103 source?: string | Resource | LinearGradient, 12104 12105 /** 12106 * Border image source 12107 * 12108 * @type { ?(string | Resource | LinearGradientOptions) } 12109 * @syscap SystemCapability.ArkUI.ArkUI.Full 12110 * @crossplatform 12111 * @form 12112 * @atomicservice 12113 * @since 20 12114 * @arkts 1.2 12115 */ 12116 source?: string | Resource | LinearGradientOptions, 12117 12118 /** 12119 * Border image width 12120 * 12121 * @type { ?(Length | EdgeWidths) } 12122 * @syscap SystemCapability.ArkUI.ArkUI.Full 12123 * @form 12124 * @since 9 12125 */ 12126 /** 12127 * Border image width 12128 * 12129 * @type { ?(Length | EdgeWidths) } 12130 * @syscap SystemCapability.ArkUI.ArkUI.Full 12131 * @crossplatform 12132 * @form 12133 * @since 10 12134 */ 12135 /** 12136 * Border image width 12137 * 12138 * @type { ?(Length | EdgeWidths) } 12139 * @syscap SystemCapability.ArkUI.ArkUI.Full 12140 * @crossplatform 12141 * @form 12142 * @atomicservice 12143 * @since 11 12144 */ 12145 /** 12146 * Width of the border image. 12147 * 12148 * @type { ?(Length | EdgeWidths | LocalizedEdgeWidths) } 12149 * @default 0 12150 * @syscap SystemCapability.ArkUI.ArkUI.Full 12151 * @crossplatform 12152 * @form 12153 * @atomicservice 12154 * @since arkts {'1.1':'12','1.2':'20'} 12155 * @arkts 1.1&1.2 12156 */ 12157 width?: Length | EdgeWidths | LocalizedEdgeWidths, 12158 12159 /** 12160 * Border image outset 12161 * 12162 * @type { ?(Length | EdgeWidths) } 12163 * @syscap SystemCapability.ArkUI.ArkUI.Full 12164 * @form 12165 * @since 9 12166 */ 12167 /** 12168 * Border image outset 12169 * 12170 * @type { ?(Length | EdgeWidths) } 12171 * @syscap SystemCapability.ArkUI.ArkUI.Full 12172 * @crossplatform 12173 * @form 12174 * @since 10 12175 */ 12176 /** 12177 * Border image outset 12178 * 12179 * @type { ?(Length | EdgeWidths) } 12180 * @syscap SystemCapability.ArkUI.ArkUI.Full 12181 * @crossplatform 12182 * @form 12183 * @atomicservice 12184 * @since 11 12185 */ 12186 /** 12187 * Amount by which the border image is extended beyond the border box. 12188 * 12189 * @type { ?(Length | EdgeWidths | LocalizedEdgeWidths) } 12190 * @default 0 12191 * @syscap SystemCapability.ArkUI.ArkUI.Full 12192 * @crossplatform 12193 * @form 12194 * @atomicservice 12195 * @since arkts {'1.1':'12','1.2':'20'} 12196 * @arkts 1.1&1.2 12197 */ 12198 outset?: Length | EdgeWidths | LocalizedEdgeWidths, 12199 12200 /** 12201 * Border image center fill 12202 * 12203 * @type { ?boolean } 12204 * @syscap SystemCapability.ArkUI.ArkUI.Full 12205 * @form 12206 * @since 9 12207 */ 12208 /** 12209 * Border image center fill 12210 * 12211 * @type { ?boolean } 12212 * @syscap SystemCapability.ArkUI.ArkUI.Full 12213 * @crossplatform 12214 * @form 12215 * @since 10 12216 */ 12217 /** 12218 * Whether to fill the center of the border image. 12219 * true: Fill the center of the border image. 12220 * false: Do not fill the center of the border image. 12221 * 12222 * @type { ?boolean } 12223 * @default false 12224 * @syscap SystemCapability.ArkUI.ArkUI.Full 12225 * @crossplatform 12226 * @form 12227 * @atomicservice 12228 * @since arkts {'1.1':'11','1.2':'20'} 12229 * @arkts 1.1&1.2 12230 */ 12231 fill?: boolean 12232} 12233 12234/** 12235 * Defines the policy of Layout 12236 * 12237 * @syscap SystemCapability.ArkUI.ArkUI.Full 12238 * @crossplatform 12239 * @form 12240 * @atomicservice 12241 * @since arkts {'1.1':'15','1.2':'20'} 12242 * @arkts 1.1&1.2 12243 */ 12244declare class LayoutPolicy { 12245 /** 12246 * The component fills its parent which means its size is as large as its parent. 12247 * 12248 * @type { LayoutPolicy } 12249 * @readonly 12250 * @static 12251 * @syscap SystemCapability.ArkUI.ArkUI.Full 12252 * @crossplatform 12253 * @form 12254 * @atomicservice 12255 * @since arkts {'1.1':'15','1.2':'20'} 12256 * @arkts 1.1&1.2 12257 */ 12258 static readonly matchParent: LayoutPolicy; 12259 /** 12260 * The component fills its content which means its size is as large as its children but it is constained by its parent. 12261 * 12262 * @type { LayoutPolicy } 12263 * @readonly 12264 * @static 12265 * @syscap SystemCapability.ArkUI.ArkUI.Full 12266 * @crossplatform 12267 * @form 12268 * @atomicservice 12269 * @since 20 12270 */ 12271 static readonly wrapContent: LayoutPolicy; 12272 /** 12273 * The component fills its content which means its size is as large as its children. 12274 * 12275 * @type { LayoutPolicy } 12276 * @readonly 12277 * @static 12278 * @syscap SystemCapability.ArkUI.ArkUI.Full 12279 * @crossplatform 12280 * @form 12281 * @atomicservice 12282 * @since 20 12283 */ 12284 static readonly fixAtIdealSize: LayoutPolicy; 12285} 12286 12287/** 12288 * The tap action triggers this method invocation. 12289 * 12290 * @extends BaseEvent 12291 * @interface ClickEvent 12292 * @syscap SystemCapability.ArkUI.ArkUI.Full 12293 * @since 7 12294 */ 12295/** 12296 * The tap action triggers this method invocation. 12297 * 12298 * @extends BaseEvent 12299 * @interface ClickEvent 12300 * @syscap SystemCapability.ArkUI.ArkUI.Full 12301 * @form 12302 * @since 9 12303 */ 12304/** 12305 * The tap action triggers this method invocation. 12306 * 12307 * @extends BaseEvent 12308 * @interface ClickEvent 12309 * @syscap SystemCapability.ArkUI.ArkUI.Full 12310 * @crossplatform 12311 * @form 12312 * @since 10 12313 */ 12314/** 12315 * The tap action triggers this method invocation. 12316 * 12317 * @extends BaseEvent 12318 * @interface ClickEvent 12319 * @syscap SystemCapability.ArkUI.ArkUI.Full 12320 * @crossplatform 12321 * @form 12322 * @atomicservice 12323 * @since arkts {'1.1':'11','1.2':'20'} 12324 * @arkts 1.1&1.2 12325 */ 12326declare interface ClickEvent extends BaseEvent { 12327 /** 12328 * X coordinate of the point relative to the global display. 12329 * 12330 * @type { ?number } 12331 * @syscap SystemCapability.ArkUI.ArkUI.Full 12332 * @crossplatform 12333 * @atomicservice 12334 * @since 20 12335 */ 12336 globalDisplayX?: number; 12337 12338 /** 12339 * Y coordinate of the point relative to the global display. 12340 * 12341 * @type { ?number } 12342 * @syscap SystemCapability.ArkUI.ArkUI.Full 12343 * @crossplatform 12344 * @atomicservice 12345 * @since 20 12346 */ 12347 globalDisplayY?: number; 12348 12349 /** 12350 * X coordinate of the click point relative to the left edge of the device screen. 12351 * 12352 * @type { number } 12353 * @syscap SystemCapability.ArkUI.ArkUI.Full 12354 * @crossplatform 12355 * @since 10 12356 */ 12357 /** 12358 * X coordinate of the click relative to the upper left corner of the application screen. 12359 * 12360 * @type { number } 12361 * @syscap SystemCapability.ArkUI.ArkUI.Full 12362 * @crossplatform 12363 * @atomicservice 12364 * @since arkts {'1.1':'11','1.2':'20'} 12365 * @arkts 1.1&1.2 12366 */ 12367 displayX: number; 12368 12369 /** 12370 * Y coordinate of the click point relative to the upper edge of the device screen. 12371 * 12372 * @type { number } 12373 * @syscap SystemCapability.ArkUI.ArkUI.Full 12374 * @crossplatform 12375 * @since 10 12376 */ 12377 /** 12378 * Y coordinate of the click relative to the upper left corner of the application screen. 12379 * 12380 * @type { number } 12381 * @syscap SystemCapability.ArkUI.ArkUI.Full 12382 * @crossplatform 12383 * @atomicservice 12384 * @since arkts {'1.1':'11','1.2':'20'} 12385 * @arkts 1.1&1.2 12386 */ 12387 displayY: number; 12388 12389 /** 12390 * X coordinate of the click point relative to the left edge of the current window. 12391 * 12392 * @type { number } 12393 * @syscap SystemCapability.ArkUI.ArkUI.Full 12394 * @crossplatform 12395 * @since 10 12396 */ 12397 /** 12398 * X coordinate of the click relative to the upper left corner of the application window. 12399 * 12400 * @type { number } 12401 * @syscap SystemCapability.ArkUI.ArkUI.Full 12402 * @crossplatform 12403 * @atomicservice 12404 * @since arkts {'1.1':'11','1.2':'20'} 12405 * @arkts 1.1&1.2 12406 */ 12407 windowX: number; 12408 12409 /** 12410 * Y coordinate of the click point relative to the upper edge of the current window. 12411 * 12412 * @type { number } 12413 * @syscap SystemCapability.ArkUI.ArkUI.Full 12414 * @crossplatform 12415 * @since 10 12416 */ 12417 /** 12418 * Y coordinate of the click relative to the upper left corner of the application window. 12419 * 12420 * @type { number } 12421 * @syscap SystemCapability.ArkUI.ArkUI.Full 12422 * @crossplatform 12423 * @atomicservice 12424 * @since arkts {'1.1':'11','1.2':'20'} 12425 * @arkts 1.1&1.2 12426 */ 12427 windowY: number; 12428 12429 /** 12430 * X coordinate of the click relative to the upper left corner of the application window. 12431 * 12432 * @type { number } 12433 * @syscap SystemCapability.ArkUI.ArkUI.Full 12434 * @since 7 12435 * @deprecated since 10 12436 * @useinstead ClickEvent#windowX 12437 */ 12438 screenX: number; 12439 12440 /** 12441 * Y coordinate of the click relative to the upper left corner of the application window. 12442 * 12443 * @type { number } 12444 * @syscap SystemCapability.ArkUI.ArkUI.Full 12445 * @since 7 12446 * @deprecated since 10 12447 * @useinstead ClickEvent#windowY 12448 */ 12449 screenY: number; 12450 12451 /** 12452 * X coordinate of the click point relative to the left edge of the clicked element. 12453 * 12454 * @type { number } 12455 * @syscap SystemCapability.ArkUI.ArkUI.Full 12456 * @since 7 12457 */ 12458 /** 12459 * X coordinate of the click point relative to the left edge of the clicked element. 12460 * 12461 * @type { number } 12462 * @syscap SystemCapability.ArkUI.ArkUI.Full 12463 * @form 12464 * @since 9 12465 */ 12466 /** 12467 * X coordinate of the click point relative to the left edge of the clicked element. 12468 * 12469 * @type { number } 12470 * @syscap SystemCapability.ArkUI.ArkUI.Full 12471 * @crossplatform 12472 * @form 12473 * @since 10 12474 */ 12475 /** 12476 * X coordinate of the click point relative to the left edge of the clicked element. 12477 * 12478 * @type { number } 12479 * @syscap SystemCapability.ArkUI.ArkUI.Full 12480 * @crossplatform 12481 * @form 12482 * @atomicservice 12483 * @since arkts {'1.1':'11','1.2':'20'} 12484 * @arkts 1.1&1.2 12485 */ 12486 x: number; 12487 12488 /** 12489 * Y coordinate of the click point relative to the upper edge of the clicked element. 12490 * 12491 * @type { number } 12492 * @syscap SystemCapability.ArkUI.ArkUI.Full 12493 * @since 7 12494 */ 12495 /** 12496 * Y coordinate of the click point relative to the left edge of the clicked element. 12497 * 12498 * @type { number } 12499 * @syscap SystemCapability.ArkUI.ArkUI.Full 12500 * @form 12501 * @since 9 12502 */ 12503 /** 12504 * Y coordinate of the click point relative to the left edge of the clicked element. 12505 * 12506 * @type { number } 12507 * @syscap SystemCapability.ArkUI.ArkUI.Full 12508 * @crossplatform 12509 * @form 12510 * @since 10 12511 */ 12512 /** 12513 * Y coordinate of the click point relative to the left edge of the clicked element. 12514 * 12515 * @type { number } 12516 * @syscap SystemCapability.ArkUI.ArkUI.Full 12517 * @crossplatform 12518 * @form 12519 * @atomicservice 12520 * @since arkts {'1.1':'11','1.2':'20'} 12521 * @arkts 1.1&1.2 12522 */ 12523 y: number; 12524 12525 /** 12526 * Whether the event is triggered by a left-hand or right-hand tap. 12527 * 12528 * @type { InteractionHand } 12529 * @syscap SystemCapability.ArkUI.ArkUI.Full 12530 * @crossplatform 12531 * @atomicservice 12532 * @since arkts {'1.1':'15','1.2':'20'} 12533 * @arkts 1.1&1.2 12534 */ 12535 hand?: InteractionHand; 12536 12537 /** 12538 * Prevent the default function. 12539 * 12540 * @type { function } 12541 * @throws { BusinessError } 100017 - Component does not support prevent function. 12542 * @syscap SystemCapability.ArkUI.ArkUI.Full 12543 * @crossplatform 12544 * @atomicservice 12545 * @since arkts {'1.1':'12','1.2':'20'} 12546 * @arkts 1.1&1.2 12547 */ 12548 preventDefault: () => void; 12549} 12550 12551/** 12552 * The hover action triggers this method invocation. 12553 * 12554 * @extends BaseEvent 12555 * @interface HoverEvent 12556 * @syscap SystemCapability.ArkUI.ArkUI.Full 12557 * @since 10 12558 */ 12559/** 12560 * The hover action triggers this method invocation. 12561 * 12562 * @extends BaseEvent 12563 * @interface HoverEvent 12564 * @syscap SystemCapability.ArkUI.ArkUI.Full 12565 * @atomicservice 12566 * @since arkts {'1.1':'11','1.2':'20'} 12567 * @arkts 1.1&1.2 12568 */ 12569declare interface HoverEvent extends BaseEvent { 12570 /** 12571 * X coordinate of the hover point relative to the left edge of the hover element. 12572 * 12573 * @type { number } 12574 * @syscap SystemCapability.ArkUI.ArkUI.Full 12575 * @atomicservice 12576 * @since arkts {'1.1':'15','1.2':'20'} 12577 * @arkts 1.1&1.2 12578 */ 12579 x?: number; 12580 12581 /** 12582 * Y coordinate of the hover point relative to the upper edge of the hover element. 12583 * 12584 * @type { number } 12585 * @syscap SystemCapability.ArkUI.ArkUI.Full 12586 * @atomicservice 12587 * @since arkts {'1.1':'15','1.2':'20'} 12588 * @arkts 1.1&1.2 12589 */ 12590 y?: number; 12591 12592 /** 12593 * X coordinate of the hover point relative to the left edge of the current window. 12594 * 12595 * @type { number } 12596 * @syscap SystemCapability.ArkUI.ArkUI.Full 12597 * @atomicservice 12598 * @since arkts {'1.1':'15','1.2':'20'} 12599 * @arkts 1.1&1.2 12600 */ 12601 windowX?: number; 12602 12603 /** 12604 * Y coordinate of the hover point relative to the upper edge of the current window. 12605 * 12606 * @type { number } 12607 * @syscap SystemCapability.ArkUI.ArkUI.Full 12608 * @atomicservice 12609 * @since arkts {'1.1':'15','1.2':'20'} 12610 * @arkts 1.1&1.2 12611 */ 12612 windowY?: number; 12613 12614 /** 12615 * X coordinate of the hover point relative to the left edge of the device screen. 12616 * 12617 * @type { number } 12618 * @syscap SystemCapability.ArkUI.ArkUI.Full 12619 * @atomicservice 12620 * @since arkts {'1.1':'15','1.2':'20'} 12621 * @arkts 1.1&1.2 12622 */ 12623 displayX?: number; 12624 12625 /** 12626 * Y coordinate of the hover point relative to the upper edge of the device screen. 12627 * 12628 * @type { number } 12629 * @syscap SystemCapability.ArkUI.ArkUI.Full 12630 * @atomicservice 12631 * @since arkts {'1.1':'15','1.2':'20'} 12632 * @arkts 1.1&1.2 12633 */ 12634 displayY?: number; 12635 12636 /** 12637 * X coordinate of the point relative to the global display. 12638 * 12639 * @type { ?number } 12640 * @syscap SystemCapability.ArkUI.ArkUI.Full 12641 * @atomicservice 12642 * @since 20 12643 */ 12644 globalDisplayX?: number; 12645 12646 /** 12647 * Y coordinate of the point relative to the global display. 12648 * 12649 * @type { ?number } 12650 * @syscap SystemCapability.ArkUI.ArkUI.Full 12651 * @atomicservice 12652 * @since 20 12653 */ 12654 globalDisplayY?: number; 12655 12656 /** 12657 * The blocking hover event pops up. 12658 * 12659 * @type { function } 12660 * @syscap SystemCapability.ArkUI.ArkUI.Full 12661 * @since 10 12662 */ 12663 /** 12664 * The blocking hover event pops up. 12665 * 12666 * @type { function } 12667 * @syscap SystemCapability.ArkUI.ArkUI.Full 12668 * @atomicservice 12669 * @since arkts {'1.1':'11','1.2':'20'} 12670 * @arkts 1.1&1.2 12671 */ 12672 stopPropagation: () => void; 12673} 12674 12675/** 12676 * The mouse click action triggers this method invocation. 12677 * 12678 * @extends BaseEvent 12679 * @interface MouseEvent 12680 * @syscap SystemCapability.ArkUI.ArkUI.Full 12681 * @since 8 12682 */ 12683/** 12684 * The mouse click action triggers this method invocation. 12685 * 12686 * @extends BaseEvent 12687 * @interface MouseEvent 12688 * @syscap SystemCapability.ArkUI.ArkUI.Full 12689 * @atomicservice 12690 * @since arkts {'1.1':'11','1.2':'20'} 12691 * @arkts 1.1&1.2 12692 */ 12693declare interface MouseEvent extends BaseEvent { 12694 /** 12695 * Mouse button of the click event. 12696 * 12697 * @type { MouseButton } 12698 * @syscap SystemCapability.ArkUI.ArkUI.Full 12699 * @since 8 12700 */ 12701 /** 12702 * Mouse button of the click event. 12703 * 12704 * @type { MouseButton } 12705 * @syscap SystemCapability.ArkUI.ArkUI.Full 12706 * @atomicservice 12707 * @since arkts {'1.1':'11','1.2':'20'} 12708 * @arkts 1.1&1.2 12709 */ 12710 button: MouseButton; 12711 12712 /** 12713 * Mouse action of the click event. 12714 * 12715 * @type { MouseAction } 12716 * @syscap SystemCapability.ArkUI.ArkUI.Full 12717 * @since 8 12718 */ 12719 /** 12720 * Mouse action of the click event. 12721 * 12722 * @type { MouseAction } 12723 * @syscap SystemCapability.ArkUI.ArkUI.Full 12724 * @atomicservice 12725 * @since arkts {'1.1':'11','1.2':'20'} 12726 * @arkts 1.1&1.2 12727 */ 12728 action: MouseAction; 12729 12730 /** 12731 * X coordinate of the point relative to the global display. 12732 * 12733 * @type { ?number } 12734 * @syscap SystemCapability.ArkUI.ArkUI.Full 12735 * @atomicservice 12736 * @since 20 12737 */ 12738 globalDisplayX?: number; 12739 12740 /** 12741 * Y coordinate of the point relative to the global display. 12742 * 12743 * @type { ?number } 12744 * @syscap SystemCapability.ArkUI.ArkUI.Full 12745 * @atomicservice 12746 * @since 20 12747 */ 12748 globalDisplayY?: number; 12749 12750 /** 12751 * X coordinate of the mouse point relative to the left edge of the device screen. 12752 * 12753 * @type { number } 12754 * @syscap SystemCapability.ArkUI.ArkUI.Full 12755 * @since 10 12756 */ 12757 /** 12758 * X coordinate of the mouse pointer relative to the upper left corner of the application screen. 12759 * 12760 * @type { number } 12761 * @syscap SystemCapability.ArkUI.ArkUI.Full 12762 * @atomicservice 12763 * @since arkts {'1.1':'11','1.2':'20'} 12764 * @arkts 1.1&1.2 12765 */ 12766 displayX: number; 12767 12768 /** 12769 * Y coordinate of the mouse point relative to the upper edge of the device screen. 12770 * 12771 * @type { number } 12772 * @syscap SystemCapability.ArkUI.ArkUI.Full 12773 * @since 10 12774 */ 12775 /** 12776 * Y coordinate of the mouse pointer relative to the upper left corner of the application screen. 12777 * 12778 * @type { number } 12779 * @syscap SystemCapability.ArkUI.ArkUI.Full 12780 * @atomicservice 12781 * @since arkts {'1.1':'11','1.2':'20'} 12782 * @arkts 1.1&1.2 12783 */ 12784 displayY: number; 12785 12786 /** 12787 * X coordinate of the mouse point relative to the left edge of the current window. 12788 * 12789 * @type { number } 12790 * @syscap SystemCapability.ArkUI.ArkUI.Full 12791 * @since 10 12792 */ 12793 /** 12794 * X coordinate of the mouse pointer relative to the upper left corner of the application window. 12795 * 12796 * @type { number } 12797 * @syscap SystemCapability.ArkUI.ArkUI.Full 12798 * @atomicservice 12799 * @since arkts {'1.1':'11','1.2':'20'} 12800 * @arkts 1.1&1.2 12801 */ 12802 windowX: number; 12803 12804 /** 12805 * Y coordinate of the mouse point relative to the upper edge of the current window. 12806 * 12807 * @type { number } 12808 * @syscap SystemCapability.ArkUI.ArkUI.Full 12809 * @since 10 12810 */ 12811 /** 12812 * Y coordinate of the mouse pointer relative to the upper left corner of the application window. 12813 * 12814 * @type { number } 12815 * @syscap SystemCapability.ArkUI.ArkUI.Full 12816 * @atomicservice 12817 * @since arkts {'1.1':'11','1.2':'20'} 12818 * @arkts 1.1&1.2 12819 */ 12820 windowY: number; 12821 12822 /** 12823 * X coordinate of the mouse pointer relative to the upper left corner of the application window. 12824 * 12825 * @type { number } 12826 * @syscap SystemCapability.ArkUI.ArkUI.Full 12827 * @since 8 12828 * @deprecated since 10 12829 * @useinstead MouseEvent#windowX 12830 */ 12831 screenX: number; 12832 12833 /** 12834 * Y coordinate of the mouse pointer relative to the upper left corner of the application window. 12835 * 12836 * @type { number } 12837 * @syscap SystemCapability.ArkUI.ArkUI.Full 12838 * @since 8 12839 * @deprecated since 10 12840 * @useinstead MouseEvent#windowY 12841 */ 12842 screenY: number; 12843 12844 /** 12845 * X coordinate of the mouse point relative to the left edge of the mouse hit element. 12846 * 12847 * @type { number } 12848 * @syscap SystemCapability.ArkUI.ArkUI.Full 12849 * @since 8 12850 */ 12851 /** 12852 * X coordinate of the mouse pointer relative to the upper left corner of the component being clicked. 12853 * 12854 * @type { number } 12855 * @syscap SystemCapability.ArkUI.ArkUI.Full 12856 * @atomicservice 12857 * @since arkts {'1.1':'11','1.2':'20'} 12858 * @arkts 1.1&1.2 12859 */ 12860 x: number; 12861 12862 /** 12863 * Y coordinate of the mouse point relative to the upper edge of the mouse hit element. 12864 * 12865 * @type { number } 12866 * @syscap SystemCapability.ArkUI.ArkUI.Full 12867 * @since 8 12868 */ 12869 /** 12870 * Y coordinate of the mouse pointer relative to the upper left corner of the component being clicked. 12871 * 12872 * @type { number } 12873 * @syscap SystemCapability.ArkUI.ArkUI.Full 12874 * @atomicservice 12875 * @since arkts {'1.1':'11','1.2':'20'} 12876 * @arkts 1.1&1.2 12877 */ 12878 y: number; 12879 12880 /** 12881 * The blocking event pops up. 12882 * 12883 * @type { function } 12884 * @syscap SystemCapability.ArkUI.ArkUI.Full 12885 * @since 8 12886 */ 12887 /** 12888 * Stops the event from bubbling upwards or downwards. 12889 * 12890 * @type { function } 12891 * @syscap SystemCapability.ArkUI.ArkUI.Full 12892 * @atomicservice 12893 * @since arkts {'1.1':'11','1.2':'20'} 12894 * @arkts 1.1&1.2 12895 */ 12896 stopPropagation: () => void; 12897 12898 /** 12899 * X axis offset relative to the previous reported mouse pointer position. When the mouse pointer is at 12900 * the edge of the screen, the value may be less than the difference of the X coordinate reported twice. 12901 * 12902 * @type { ?number } 12903 * @syscap SystemCapability.ArkUI.ArkUI.Full 12904 * @atomicservice 12905 * @since arkts {'1.1':'15','1.2':'20'} 12906 * @arkts 1.1&1.2 12907 */ 12908 rawDeltaX?: number; 12909 12910 /** 12911 * Y axis offset relative to the previous reported mouse pointer position. When the mouse pointer is at 12912 * the edge of the screen, the value may be less than the difference of the Y coordinate reported twice. 12913 * 12914 * @type { ?number } 12915 * @syscap SystemCapability.ArkUI.ArkUI.Full 12916 * @atomicservice 12917 * @since arkts {'1.1':'15','1.2':'20'} 12918 * @arkts 1.1&1.2 12919 */ 12920 rawDeltaY?: number; 12921 12922 /** 12923 * Array of all mouse buttons that are currently pressed. 12924 * 12925 * @type { ?MouseButton[] } 12926 * @syscap SystemCapability.ArkUI.ArkUI.Full 12927 * @atomicservice 12928 * @since arkts {'1.1':'15','1.2':'20'} 12929 * @arkts 1.1&1.2 12930 */ 12931 pressedButtons?: MouseButton[]; 12932} 12933 12934/** 12935 * The accessibility hover action triggers this method invocation. 12936 * 12937 * @extends BaseEvent 12938 * @typedef AccessibilityHoverEvent 12939 * @syscap SystemCapability.ArkUI.ArkUI.Full 12940 * @atomicservice 12941 * @since arkts {'1.1':'12','1.2':'20'} 12942 * @arkts 1.1&1.2 12943 */ 12944declare interface AccessibilityHoverEvent extends BaseEvent { 12945 /** 12946 * Type of the accessibility hover event. 12947 * 12948 * @type { AccessibilityHoverType } 12949 * @syscap SystemCapability.ArkUI.ArkUI.Full 12950 * @atomicservice 12951 * @since arkts {'1.1':'12','1.2':'20'} 12952 * @arkts 1.1&1.2 12953 */ 12954 type: AccessibilityHoverType; 12955 12956 /** 12957 * X coordinate of the accessibility hover point relative to the left edge of the event hit element. 12958 * 12959 * @type { number } 12960 * @syscap SystemCapability.ArkUI.ArkUI.Full 12961 * @atomicservice 12962 * @since arkts {'1.1':'12','1.2':'20'} 12963 * @arkts 1.1&1.2 12964 */ 12965 x: number; 12966 12967 /** 12968 * Y coordinate of the accessibility hover point relative to the upper edge of the event hit element. 12969 * 12970 * @type { number } 12971 * @syscap SystemCapability.ArkUI.ArkUI.Full 12972 * @atomicservice 12973 * @since arkts {'1.1':'12','1.2':'20'} 12974 * @arkts 1.1&1.2 12975 */ 12976 y: number; 12977 12978 /** 12979 * X coordinate of the accessibility hover point relative to the left edge of the device screen. 12980 * 12981 * @type { number } 12982 * @syscap SystemCapability.ArkUI.ArkUI.Full 12983 * @atomicservice 12984 * @since arkts {'1.1':'12','1.2':'20'} 12985 * @arkts 1.1&1.2 12986 */ 12987 displayX: number; 12988 12989 /** 12990 * Y coordinate of the accessibility hover point relative to the upper edge of the device screen. 12991 * 12992 * @type { number } 12993 * @syscap SystemCapability.ArkUI.ArkUI.Full 12994 * @atomicservice 12995 * @since arkts {'1.1':'12','1.2':'20'} 12996 * @arkts 1.1&1.2 12997 */ 12998 displayY: number; 12999 13000 /** 13001 * X coordinate of the accessibility hover point relative to the left edge of the current window. 13002 * 13003 * @type { number } 13004 * @syscap SystemCapability.ArkUI.ArkUI.Full 13005 * @atomicservice 13006 * @since arkts {'1.1':'12','1.2':'20'} 13007 * @arkts 1.1&1.2 13008 */ 13009 windowX: number; 13010 13011 /** 13012 * Y coordinate of the accessibility hover point relative to the upper edge of the current window. 13013 * 13014 * @type { number } 13015 * @syscap SystemCapability.ArkUI.ArkUI.Full 13016 * @atomicservice 13017 * @since arkts {'1.1':'12','1.2':'20'} 13018 * @arkts 1.1&1.2 13019 */ 13020 windowY: number; 13021 13022 /** 13023 * X coordinate of the point relative to the global display. 13024 * 13025 * @type { ?number } 13026 * @syscap SystemCapability.ArkUI.ArkUI.Full 13027 * @atomicservice 13028 * @since 20 13029 */ 13030 globalDisplayX?: number; 13031 13032 /** 13033 * Y coordinate of the point relative to the global display. 13034 * 13035 * @type { ?number } 13036 * @syscap SystemCapability.ArkUI.ArkUI.Full 13037 * @atomicservice 13038 * @since 20 13039 */ 13040 globalDisplayY?: number; 13041} 13042 13043/** 13044 * Type of the touch event. 13045 * 13046 * @interface TouchObject 13047 * @syscap SystemCapability.ArkUI.ArkUI.Full 13048 * @since 7 13049 */ 13050/** 13051 * Type of the touch event. 13052 * 13053 * @interface TouchObject 13054 * @syscap SystemCapability.ArkUI.ArkUI.Full 13055 * @crossplatform 13056 * @since 10 13057 */ 13058/** 13059 * Type of the touch event. 13060 * 13061 * @interface TouchObject 13062 * @syscap SystemCapability.ArkUI.ArkUI.Full 13063 * @crossplatform 13064 * @atomicservice 13065 * @since arkts {'1.1':'11','1.2':'20'} 13066 * @arkts 1.1&1.2 13067 */ 13068declare interface TouchObject { 13069 /** 13070 * Type of the touch event. 13071 * 13072 * @type { TouchType } 13073 * @syscap SystemCapability.ArkUI.ArkUI.Full 13074 * @since 7 13075 */ 13076 /** 13077 * Type of the touch event. 13078 * 13079 * @type { TouchType } 13080 * @syscap SystemCapability.ArkUI.ArkUI.Full 13081 * @crossplatform 13082 * @since 10 13083 */ 13084 /** 13085 * Type of the touch event. 13086 * 13087 * @type { TouchType } 13088 * @syscap SystemCapability.ArkUI.ArkUI.Full 13089 * @crossplatform 13090 * @atomicservice 13091 * @since arkts {'1.1':'11','1.2':'20'} 13092 * @arkts 1.1&1.2 13093 */ 13094 type: TouchType; 13095 13096 /** 13097 * Finger unique identifier. 13098 * 13099 * @type { number } 13100 * @syscap SystemCapability.ArkUI.ArkUI.Full 13101 * @since 7 13102 */ 13103 /** 13104 * Finger unique identifier. 13105 * 13106 * @type { number } 13107 * @syscap SystemCapability.ArkUI.ArkUI.Full 13108 * @crossplatform 13109 * @since 10 13110 */ 13111 /** 13112 * Unique identifier of a finger. 13113 * 13114 * @type { number } 13115 * @syscap SystemCapability.ArkUI.ArkUI.Full 13116 * @crossplatform 13117 * @atomicservice 13118 * @since arkts {'1.1':'11','1.2':'20'} 13119 * @arkts 1.1&1.2 13120 */ 13121 id: number; 13122 13123 /** 13124 * X coordinate of the point relative to the global display. 13125 * 13126 * @type { ?number } 13127 * @syscap SystemCapability.ArkUI.ArkUI.Full 13128 * @crossplatform 13129 * @atomicservice 13130 * @since 20 13131 */ 13132 globalDisplayX?: number; 13133 13134 /** 13135 * Y coordinate of the point relative to the global display. 13136 * 13137 * @type { ?number } 13138 * @syscap SystemCapability.ArkUI.ArkUI.Full 13139 * @crossplatform 13140 * @atomicservice 13141 * @since 20 13142 */ 13143 globalDisplayY?: number; 13144 13145 /** 13146 * X coordinate of the touch point relative to the left edge of the device screen. 13147 * 13148 * @type { number } 13149 * @syscap SystemCapability.ArkUI.ArkUI.Full 13150 * @crossplatform 13151 * @since 10 13152 */ 13153 /** 13154 * X coordinate of the touch point relative to the upper left corner of the application screen. 13155 * 13156 * @type { number } 13157 * @syscap SystemCapability.ArkUI.ArkUI.Full 13158 * @crossplatform 13159 * @atomicservice 13160 * @since arkts {'1.1':'11','1.2':'20'} 13161 * @arkts 1.1&1.2 13162 */ 13163 displayX: number; 13164 13165 /** 13166 * Y coordinate of the touch point relative to the upper edge of the device screen. 13167 * 13168 * @type { number } 13169 * @syscap SystemCapability.ArkUI.ArkUI.Full 13170 * @crossplatform 13171 * @since 10 13172 */ 13173 /** 13174 * Y coordinate of the touch point relative to the upper left corner of the application screen. 13175 * 13176 * @type { number } 13177 * @syscap SystemCapability.ArkUI.ArkUI.Full 13178 * @crossplatform 13179 * @atomicservice 13180 * @since arkts {'1.1':'11','1.2':'20'} 13181 * @arkts 1.1&1.2 13182 */ 13183 displayY: number; 13184 13185 /** 13186 * X coordinate of the touch point relative to the left edge of the current window. 13187 * 13188 * @type { number } 13189 * @syscap SystemCapability.ArkUI.ArkUI.Full 13190 * @crossplatform 13191 * @since 10 13192 */ 13193 /** 13194 * X coordinate of the touch point relative to the upper left corner of the application window. 13195 * 13196 * @type { number } 13197 * @syscap SystemCapability.ArkUI.ArkUI.Full 13198 * @crossplatform 13199 * @atomicservice 13200 * @since arkts {'1.1':'11','1.2':'20'} 13201 * @arkts 1.1&1.2 13202 */ 13203 windowX: number; 13204 13205 /** 13206 * Y coordinate of the touch point relative to the upper edge of the current window. 13207 * 13208 * @type { number } 13209 * @syscap SystemCapability.ArkUI.ArkUI.Full 13210 * @crossplatform 13211 * @since 10 13212 */ 13213 /** 13214 * Y coordinate of the touch point relative to the upper left corner of the application window. 13215 * 13216 * @type { number } 13217 * @syscap SystemCapability.ArkUI.ArkUI.Full 13218 * @crossplatform 13219 * @atomicservice 13220 * @since arkts {'1.1':'11','1.2':'20'} 13221 * @arkts 1.1&1.2 13222 */ 13223 windowY: number; 13224 13225 /** 13226 * X coordinate of the touch point relative to the upper left corner of the application window. 13227 * 13228 * @type { number } 13229 * @syscap SystemCapability.ArkUI.ArkUI.Full 13230 * @since 7 13231 * @deprecated since 10 13232 * @useinstead TouchObject#windowX 13233 */ 13234 screenX: number; 13235 13236 /** 13237 * Y coordinate of the touch point relative to the upper left corner of the application window. 13238 * 13239 * @type { number } 13240 * @syscap SystemCapability.ArkUI.ArkUI.Full 13241 * @since 7 13242 * @deprecated since 10 13243 * @useinstead TouchObject#windowY 13244 */ 13245 screenY: number; 13246 13247 /** 13248 * X coordinate of the touch point relative to the left edge of the touched element. 13249 * 13250 * @type { number } 13251 * @syscap SystemCapability.ArkUI.ArkUI.Full 13252 * @since 7 13253 */ 13254 /** 13255 * X coordinate of the touch point relative to the left edge of the touched element. 13256 * 13257 * @type { number } 13258 * @syscap SystemCapability.ArkUI.ArkUI.Full 13259 * @crossplatform 13260 * @since 10 13261 */ 13262 /** 13263 * X coordinate of the touch point relative to the upper left corner of the event responding component. 13264 * 13265 * @type { number } 13266 * @syscap SystemCapability.ArkUI.ArkUI.Full 13267 * @crossplatform 13268 * @atomicservice 13269 * @since arkts {'1.1':'11','1.2':'20'} 13270 * @arkts 1.1&1.2 13271 */ 13272 x: number; 13273 13274 /** 13275 * Y coordinate of the touch point relative to the upper edge of the touched element. 13276 * 13277 * @type { number } 13278 * @syscap SystemCapability.ArkUI.ArkUI.Full 13279 * @since 7 13280 */ 13281 /** 13282 * Y coordinate of the touch point relative to the upper edge of the touched element. 13283 * 13284 * @type { number } 13285 * @syscap SystemCapability.ArkUI.ArkUI.Full 13286 * @crossplatform 13287 * @since 10 13288 */ 13289 /** 13290 * Y coordinate of the touch point relative to the upper left corner of the event responding component. 13291 * 13292 * @type { number } 13293 * @syscap SystemCapability.ArkUI.ArkUI.Full 13294 * @crossplatform 13295 * @atomicservice 13296 * @since arkts {'1.1':'11','1.2':'20'} 13297 * @arkts 1.1&1.2 13298 */ 13299 y: number; 13300 13301 /** 13302 * Whether the event is triggered by a left-hand or right-hand tap. 13303 * 13304 * @type { InteractionHand } 13305 * @syscap SystemCapability.ArkUI.ArkUI.Full 13306 * @crossplatform 13307 * @atomicservice 13308 * @since arkts {'1.1':'15','1.2':'20'} 13309 * @arkts 1.1&1.2 13310 */ 13311 hand?: InteractionHand; 13312 13313 /** 13314 * Time when the finger is pressed. 13315 * 13316 * @type { ?number } 13317 * @syscap SystemCapability.ArkUI.ArkUI.Full 13318 * @crossplatform 13319 * @atomicservice 13320 * @since arkts {'1.1':'15','1.2':'20'} 13321 * @arkts 1.1&1.2 13322 */ 13323 pressedTime?: number; 13324 /** 13325 * Pressure value of the finger press. 13326 * 13327 * @type { ?number } 13328 * @syscap SystemCapability.ArkUI.ArkUI.Full 13329 * @crossplatform 13330 * @atomicservice 13331 * @since arkts {'1.1':'15','1.2':'20'} 13332 * @arkts 1.1&1.2 13333 */ 13334 pressure?: number; 13335 13336 /** 13337 * Width of the area pressed by the finger. 13338 * 13339 * @type { ?number } 13340 * @syscap SystemCapability.ArkUI.ArkUI.Full 13341 * @crossplatform 13342 * @atomicservice 13343 * @since arkts {'1.1':'15','1.2':'20'} 13344 * @arkts 1.1&1.2 13345 */ 13346 width?: number; 13347 13348 /** 13349 * Height of the area pressed by the finger. 13350 * 13351 * @type { ?number } 13352 * @syscap SystemCapability.ArkUI.ArkUI.Full 13353 * @crossplatform 13354 * @atomicservice 13355 * @since arkts {'1.1':'15','1.2':'20'} 13356 * @arkts 1.1&1.2 13357 */ 13358 height?: number; 13359} 13360 13361/** 13362 * TouchObject getHistoricalPoints Function Parameters 13363 * 13364 * @interface HistoricalPoint 13365 * @syscap SystemCapability.ArkUI.ArkUI.Full 13366 * @crossplatform 13367 * @since 10 13368 */ 13369/** 13370 * TouchObject getHistoricalPoints Function Parameters 13371 * 13372 * @interface HistoricalPoint 13373 * @syscap SystemCapability.ArkUI.ArkUI.Full 13374 * @crossplatform 13375 * @atomicservice 13376 * @since arkts {'1.1':'11','1.2':'20'} 13377 * @arkts 1.1&1.2 13378 */ 13379declare interface HistoricalPoint { 13380 /** 13381 * The base touchObject information of historicalPoint 13382 * 13383 * @type { TouchObject } 13384 * @syscap SystemCapability.ArkUI.ArkUI.Full 13385 * @crossplatform 13386 * @since 10 13387 */ 13388 /** 13389 * The base touchObject information of historicalPoint 13390 * 13391 * @type { TouchObject } 13392 * @syscap SystemCapability.ArkUI.ArkUI.Full 13393 * @crossplatform 13394 * @atomicservice 13395 * @since arkts {'1.1':'11','1.2':'20'} 13396 * @arkts 1.1&1.2 13397 */ 13398 touchObject: TouchObject; 13399 13400 /** 13401 * Contact area between the finger pad and the screen. 13402 * 13403 * @type { number } 13404 * @syscap SystemCapability.ArkUI.ArkUI.Full 13405 * @crossplatform 13406 * @since 10 13407 */ 13408 /** 13409 * Contact area between the finger pad and the screen. 13410 * 13411 * @type { number } 13412 * @syscap SystemCapability.ArkUI.ArkUI.Full 13413 * @crossplatform 13414 * @atomicservice 13415 * @since arkts {'1.1':'11','1.2':'20'} 13416 * @arkts 1.1&1.2 13417 */ 13418 size: number; 13419 13420 /** 13421 * Pressure of the touch event. 13422 * 13423 * @type { number } 13424 * @syscap SystemCapability.ArkUI.ArkUI.Full 13425 * @crossplatform 13426 * @since 10 13427 */ 13428 /** 13429 * Pressure of the touch event. 13430 * 13431 * @type { number } 13432 * @syscap SystemCapability.ArkUI.ArkUI.Full 13433 * @crossplatform 13434 * @atomicservice 13435 * @since arkts {'1.1':'11','1.2':'20'} 13436 * @arkts 1.1&1.2 13437 */ 13438 force: number; 13439 13440 /** 13441 * Timestamp of the touch event. 13442 * 13443 * @type { number } 13444 * @syscap SystemCapability.ArkUI.ArkUI.Full 13445 * @crossplatform 13446 * @since 10 13447 */ 13448 /** 13449 * Timestamp of the touch event. 13450 * 13451 * @type { number } 13452 * @syscap SystemCapability.ArkUI.ArkUI.Full 13453 * @crossplatform 13454 * @atomicservice 13455 * @since arkts {'1.1':'11','1.2':'20'} 13456 * @arkts 1.1&1.2 13457 */ 13458 timestamp: number; 13459} 13460 13461/** 13462 * Touch Action Function Parameters 13463 * 13464 * @extends BaseEvent 13465 * @interface TouchEvent 13466 * @syscap SystemCapability.ArkUI.ArkUI.Full 13467 * @since 7 13468 */ 13469/** 13470 * Touch Action Function Parameters 13471 * 13472 * @extends BaseEvent 13473 * @interface TouchEvent 13474 * @syscap SystemCapability.ArkUI.ArkUI.Full 13475 * @crossplatform 13476 * @since 10 13477 */ 13478/** 13479 * Touch Action Function Parameters 13480 * 13481 * @extends BaseEvent 13482 * @interface TouchEvent 13483 * @syscap SystemCapability.ArkUI.ArkUI.Full 13484 * @crossplatform 13485 * @atomicservice 13486 * @since arkts {'1.1':'11','1.2':'20'} 13487 * @arkts 1.1&1.2 13488 */ 13489declare interface TouchEvent extends BaseEvent { 13490 /** 13491 * Type of the touch event. 13492 * 13493 * @type { TouchType } 13494 * @syscap SystemCapability.ArkUI.ArkUI.Full 13495 * @since 7 13496 */ 13497 /** 13498 * Type of the touch event. 13499 * 13500 * @type { TouchType } 13501 * @syscap SystemCapability.ArkUI.ArkUI.Full 13502 * @crossplatform 13503 * @since 10 13504 */ 13505 /** 13506 * Type of the touch event. 13507 * 13508 * @type { TouchType } 13509 * @syscap SystemCapability.ArkUI.ArkUI.Full 13510 * @crossplatform 13511 * @atomicservice 13512 * @since arkts {'1.1':'11','1.2':'20'} 13513 * @arkts 1.1&1.2 13514 */ 13515 type: TouchType; 13516 13517 /** 13518 * All finger information. 13519 * 13520 * @type { TouchObject[] } 13521 * @syscap SystemCapability.ArkUI.ArkUI.Full 13522 * @since 7 13523 */ 13524 /** 13525 * All finger information. 13526 * 13527 * @type { TouchObject[] } 13528 * @syscap SystemCapability.ArkUI.ArkUI.Full 13529 * @crossplatform 13530 * @since 10 13531 */ 13532 /** 13533 * All finger information. 13534 * 13535 * @type { TouchObject[] } 13536 * @syscap SystemCapability.ArkUI.ArkUI.Full 13537 * @crossplatform 13538 * @atomicservice 13539 * @since arkts {'1.1':'11','1.2':'20'} 13540 * @arkts 1.1&1.2 13541 */ 13542 touches: TouchObject[]; 13543 13544 /** 13545 * Indicates the current changed finger information. 13546 * 13547 * @type { TouchObject[] } 13548 * @syscap SystemCapability.ArkUI.ArkUI.Full 13549 * @since 7 13550 */ 13551 /** 13552 * Indicates the current changed finger information. 13553 * 13554 * @type { TouchObject[] } 13555 * @syscap SystemCapability.ArkUI.ArkUI.Full 13556 * @crossplatform 13557 * @since 10 13558 */ 13559 /** 13560 * Finger information changed. 13561 * 13562 * @type { TouchObject[] } 13563 * @syscap SystemCapability.ArkUI.ArkUI.Full 13564 * @crossplatform 13565 * @atomicservice 13566 * @since arkts {'1.1':'11','1.2':'20'} 13567 * @arkts 1.1&1.2 13568 */ 13569 changedTouches: TouchObject[]; 13570 13571 /** 13572 * The blocking event pops up. 13573 * 13574 * @type { function } 13575 * @syscap SystemCapability.ArkUI.ArkUI.Full 13576 * @since 7 13577 */ 13578 /** 13579 * The blocking event pops up. 13580 * 13581 * @type { function } 13582 * @syscap SystemCapability.ArkUI.ArkUI.Full 13583 * @crossplatform 13584 * @since 10 13585 */ 13586 /** 13587 * Stops the event from bubbling upwards or downwards. 13588 * 13589 * @type { function } 13590 * @syscap SystemCapability.ArkUI.ArkUI.Full 13591 * @crossplatform 13592 * @atomicservice 13593 * @since arkts {'1.1':'11','1.2':'20'} 13594 * @arkts 1.1&1.2 13595 */ 13596 stopPropagation: () => void; 13597 13598 /** 13599 * Get the historical points. 13600 * 13601 * @returns { Array<HistoricalPoint> } - return all historical points. 13602 * @syscap SystemCapability.ArkUI.ArkUI.Full 13603 * @crossplatform 13604 * @since 10 13605 */ 13606 /** 13607 * Obtains all historical points of the current frame. 13608 * 13609 * @returns { Array<HistoricalPoint> } - return all historical points. 13610 * @syscap SystemCapability.ArkUI.ArkUI.Full 13611 * @crossplatform 13612 * @atomicservice 13613 * @since arkts {'1.1':'11','1.2':'20'} 13614 * @arkts 1.1&1.2 13615 */ 13616 getHistoricalPoints(): Array<HistoricalPoint>; 13617 13618 /** 13619 * Blocks the default event. 13620 * 13621 * @type { function } 13622 * @throws { BusinessError } 100017 - Component does not support prevent function. 13623 * @syscap SystemCapability.ArkUI.ArkUI.Full 13624 * @crossplatform 13625 * @atomicservice 13626 * @since arkts {'1.1':'12','1.2':'20'} 13627 * @arkts 1.1&1.2 13628 */ 13629 preventDefault: () => void; 13630} 13631 13632/** 13633 * The axis event triggers this method invocation. 13634 * 13635 * @extends BaseEvent 13636 * @interface AxisEvent 13637 * @syscap SystemCapability.ArkUI.ArkUI.Full 13638 * @atomicservice 13639 * @since arkts {'1.1':'17','1.2':'20'} 13640 * @arkts 1.1&1.2 13641 */ 13642declare interface AxisEvent extends BaseEvent { 13643 /** 13644 * Axis action of the axis event. 13645 * 13646 * @type { AxisAction } 13647 * @syscap SystemCapability.ArkUI.ArkUI.Full 13648 * @atomicservice 13649 * @since arkts {'1.1':'17','1.2':'20'} 13650 * @arkts 1.1&1.2 13651 */ 13652 action: AxisAction; 13653 13654 /** 13655 * X coordinate of the point relative to the global display. 13656 * 13657 * @type { ?number } 13658 * @syscap SystemCapability.ArkUI.ArkUI.Full 13659 * @atomicservice 13660 * @since 20 13661 */ 13662 globalDisplayX?: number; 13663 13664 /** 13665 * Y coordinate of the point relative to the global display. 13666 * 13667 * @type { ?number } 13668 * @syscap SystemCapability.ArkUI.ArkUI.Full 13669 * @atomicservice 13670 * @since 20 13671 */ 13672 globalDisplayY?: number; 13673 13674 /** 13675 * X coordinate of the mouse cursor relative to the left edge of the device screen. 13676 * 13677 * @type { number } 13678 * @syscap SystemCapability.ArkUI.ArkUI.Full 13679 * @atomicservice 13680 * @since arkts {'1.1':'17','1.2':'20'} 13681 * @arkts 1.1&1.2 13682 */ 13683 displayX: number; 13684 13685 /** 13686 * Y coordinate of the mouse cursor relative to the upper edge of the device screen. 13687 * 13688 * @type { number } 13689 * @syscap SystemCapability.ArkUI.ArkUI.Full 13690 * @atomicservice 13691 * @since arkts {'1.1':'17','1.2':'20'} 13692 * @arkts 1.1&1.2 13693 */ 13694 displayY: number; 13695 13696 /** 13697 * X coordinate of the mouse cursor relative to the left edge of the current window. 13698 * 13699 * @type { number } 13700 * @syscap SystemCapability.ArkUI.ArkUI.Full 13701 * @atomicservice 13702 * @since arkts {'1.1':'17','1.2':'20'} 13703 * @arkts 1.1&1.2 13704 */ 13705 windowX: number; 13706 13707 /** 13708 * Y coordinate of the mouse cursor relative to the upper edge of the current window. 13709 * 13710 * @type { number } 13711 * @syscap SystemCapability.ArkUI.ArkUI.Full 13712 * @atomicservice 13713 * @since arkts {'1.1':'17','1.2':'20'} 13714 * @arkts 1.1&1.2 13715 */ 13716 windowY: number; 13717 13718 /** 13719 * X coordinate of the mouse cursor relative to the left edge of the axis event hit element. 13720 * 13721 * @type { number } 13722 * @syscap SystemCapability.ArkUI.ArkUI.Full 13723 * @atomicservice 13724 * @since arkts {'1.1':'17','1.2':'20'} 13725 * @arkts 1.1&1.2 13726 */ 13727 x: number; 13728 13729 /** 13730 * Y coordinate of the mouse cursor relative to the upper edge of the axis event hit element. 13731 * 13732 * @type { number } 13733 * @syscap SystemCapability.ArkUI.ArkUI.Full 13734 * @atomicservice 13735 * @since arkts {'1.1':'17','1.2':'20'} 13736 * @arkts 1.1&1.2 13737 */ 13738 y: number; 13739 13740 /** 13741 * Scroll step configuration which is only mouse wheel has. 13742 * * 13743 * @type { ?number } 13744 * @syscap SystemCapability.ArkUI.ArkUI.Full 13745 * @atomicservice 13746 * @since arkts {'1.1':'17','1.2':'20'} 13747 * @arkts 1.1&1.2 13748 */ 13749 scrollStep?: number; 13750 13751 /** 13752 * Active event bubbling. 13753 * 13754 * @type { Callback<void> } 13755 * @syscap SystemCapability.ArkUI.ArkUI.Full 13756 * @atomicservice 13757 * @since arkts {'1.1':'17','1.2':'20'} 13758 * @arkts 1.1&1.2 13759 */ 13760 propagation: Callback<void>; 13761 13762 /** 13763 * Obtains the value of the horizontal scroll axis for this axis event. 13764 * 13765 * @returns { number } 13766 * @syscap SystemCapability.ArkUI.ArkUI.Full 13767 * @atomicservice 13768 * @since arkts {'1.1':'17','1.2':'20'} 13769 * @arkts 1.1&1.2 13770 */ 13771 getHorizontalAxisValue(): number; 13772 13773 /** 13774 * Obtains the value of the vertical scroll axis for this axis event. 13775 * 13776 * @returns { number } 13777 * @syscap SystemCapability.ArkUI.ArkUI.Full 13778 * @atomicservice 13779 * @since arkts {'1.1':'17','1.2':'20'} 13780 * @arkts 1.1&1.2 13781 */ 13782 getVerticalAxisValue(): number; 13783} 13784 13785/** 13786 * Defines the callback type used in onSizeChange. 13787 * <br>oldValue - the width and height of the component before the change. 13788 * <br>newValue - the width and height of the component after the change. 13789 * 13790 * @typedef { function } SizeChangeCallback 13791 * @syscap SystemCapability.ArkUI.ArkUI.Full 13792 * @crossplatform 13793 * @form 13794 * @atomicservice 13795 * @since arkts {'1.1':'12','1.2':'20'} 13796 * @arkts 1.1&1.2 13797 */ 13798declare type SizeChangeCallback = (oldValue: SizeOptions, newValue: SizeOptions) => void; 13799 13800/** 13801 * Defines the callback type used in onGestureRecognizerJudgeBegin. 13802 * 13803 * @typedef { function } GestureRecognizerJudgeBeginCallback 13804 * @param { BaseGestureEvent } event - the event information 13805 * @param { GestureRecognizer } current - the current gesture recognizer of the component 13806 * @param { Array<GestureRecognizer> } recognizers - the gesture recognizers of the component on the response chain 13807 * @returns { GestureJudgeResult } the gesture judge result 13808 * @syscap SystemCapability.ArkUI.ArkUI.Full 13809 * @crossplatform 13810 * @atomicservice 13811 * @since 12 13812 */ 13813/** 13814 * Defines the callback type used in onGestureRecognizerJudgeBegin. 13815 * 13816 * @typedef { function } GestureRecognizerJudgeBeginCallback 13817 * @param { BaseGestureEvent } event - the event information 13818 * @param { GestureRecognizer } current - the current gesture recognizer of the component 13819 * @param { Array<GestureRecognizer> } recognizers - the gesture recognizers of the component on the response chain 13820 * @param { Array<TouchRecognizer> } [touchRecognizers] - the touch recognizers of the component on the response chain 13821 * @returns { GestureJudgeResult } the gesture judge result 13822 * @syscap SystemCapability.ArkUI.ArkUI.Full 13823 * @crossplatform 13824 * @atomicservice 13825 * @since 20 13826 */ 13827declare type GestureRecognizerJudgeBeginCallback = (event: BaseGestureEvent, current: GestureRecognizer, recognizers: Array<GestureRecognizer>, 13828 touchRecognizers?: Array<TouchRecognizer>) => GestureJudgeResult; 13829 13830/** 13831 * Defines the callback type used in onGestureRecognizerJudgeBegin. 13832 * 13833 * @typedef { function } GestureRecognizerJudgeBeginCallback 13834 * @param { BaseGestureEvent } event - the event information 13835 * @param { GestureRecognizer } current - the current gesture recognizer of the component 13836 * @param { Array<GestureRecognizer> } recognizers - the gesture recognizers of the component on the response chain 13837 * @returns { GestureJudgeResult } the gesture judge result 13838 * @syscap SystemCapability.ArkUI.ArkUI.Full 13839 * @crossplatform 13840 * @atomicservice 13841 * @since 20 13842 * @arkts 1.2 13843 */ 13844declare type GestureRecognizerJudgeBeginCallback = (event: BaseGestureEvent, current: GestureRecognizer, recognizers: Array<GestureRecognizer>) => GestureJudgeResult; 13845 13846/** 13847 * Defines the callback type used in shouldBuiltInRecognizerParallelWith. 13848 * 13849 * @typedef { function } ShouldBuiltInRecognizerParallelWithCallback 13850 * @param { GestureRecognizer } current - the current gesture recognizer of the component 13851 * @param { Array<GestureRecognizer> } others - the gesture recognizers of the component on the response chain 13852 * @returns { GestureRecognizer } gesture recognizer of the component 13853 * @syscap SystemCapability.ArkUI.ArkUI.Full 13854 * @crossplatform 13855 * @atomicservice 13856 * @since arkts {'1.1':'12','1.2':'20'} 13857 * @arkts 1.1&1.2 13858 */ 13859declare type ShouldBuiltInRecognizerParallelWithCallback = (current: GestureRecognizer, others: Array<GestureRecognizer>) => GestureRecognizer; 13860 13861/** 13862 * Defines the finish callback type used in transition. 13863 * 13864 * @typedef { function } TransitionFinishCallback 13865 * @param { boolean } transitionIn - a boolean value indicates whether it is the callback of transitionIn or transitionOut. 13866 * @syscap SystemCapability.ArkUI.ArkUI.Full 13867 * @crossplatform 13868 * @form 13869 * @atomicservice 13870 * @since arkts {'1.1':'12','1.2':'20'} 13871 * @arkts 1.1&1.2 13872 */ 13873declare type TransitionFinishCallback = (transitionIn: boolean) => void; 13874 13875/** 13876 * Defines the callback type used in onTouchTestDone. 13877 * When the user touch down, the system performs hit test process to collect all gesture recognizers 13878 * based on the press location, when the collection is completed, and before gesture begin to be recognizing, 13879 * the callback is triggered, you can get all recognizer's information from this callback. 13880 * 13881 * @typedef { function } TouchTestDoneCallback 13882 * @param { BaseGestureEvent } event - the event information, basicly is the touch down information 13883 * @param { Array<GestureRecognizer> } recognizers - the gesture recognizers of the component on the response chain 13884 * @syscap SystemCapability.ArkUI.ArkUI.Full 13885 * @crossplatform 13886 * @atomicservice 13887 * @since 20 13888 */ 13889declare type TouchTestDoneCallback = (event: BaseGestureEvent, recognizers: Array<GestureRecognizer>) => void; 13890 13891/** 13892 * Defines the PixelMap type object for ui component. 13893 * 13894 * @syscap SystemCapability.ArkUI.ArkUI.Full 13895 * @since 7 13896 */ 13897/** 13898 * Defines the PixelMap type object for ui component. 13899 * 13900 * @syscap SystemCapability.ArkUI.ArkUI.Full 13901 * @crossplatform 13902 * @since 10 13903 */ 13904/** 13905 * Defines the PixelMap type object for ui component. 13906 * 13907 * @typedef { import('../api/@ohos.multimedia.image').default.PixelMap } PixelMap 13908 * @syscap SystemCapability.ArkUI.ArkUI.Full 13909 * @crossplatform 13910 * @atomicservice 13911 * @since 11 13912 */ 13913declare type PixelMap = import('../api/@ohos.multimedia.image').default.PixelMap; 13914 13915/** 13916 * Defines the PixelMap type object for ui component. 13917 * 13918 * @typedef { image.PixelMap } PixelMap 13919 * @syscap SystemCapability.ArkUI.ArkUI.Full 13920 * @crossplatform 13921 * @atomicservice 13922 * @since 20 13923 * @arkts 1.2 13924 */ 13925declare type PixelMap = image.PixelMap; 13926 13927/** 13928 * pixelmap object with release function. 13929 * 13930 * @interface PixelMapMock 13931 * @syscap SystemCapability.ArkUI.ArkUI.Full 13932 * @systemapi 13933 * @since arkts {'1.1':'7','1.2':'20'} 13934 * @arkts 1.1&1.2 13935 */ 13936declare interface PixelMapMock { 13937 /** 13938 * release function. 13939 * 13940 * @syscap SystemCapability.ArkUI.ArkUI.Full 13941 * @systemapi 13942 * @since arkts {'1.1':'7','1.2':'20'} 13943 * @arkts 1.1&1.2 13944 */ 13945 release(): void; 13946} 13947 13948/** 13949 * Enum for Drag Behavior. 13950 * 13951 * @enum { number } 13952 * @syscap SystemCapability.ArkUI.ArkUI.Full 13953 * @since 10 13954 */ 13955/** 13956 * Enum for Drag Behavior. 13957 * 13958 * @enum { number } 13959 * @syscap SystemCapability.ArkUI.ArkUI.Full 13960 * @atomicservice 13961 * @since 11 13962 */ 13963/** 13964 * Enum for Drag Behavior. 13965 * 13966 * <strong>NOTE</strong>:<br> 13967 * DragBehavior serves to inform you about the intended method of data handling, 13968 * whether it's a copy or a move, but it does not actually dictate the real processing of the data. 13969 * 13970 * @enum { number } 13971 * @syscap SystemCapability.ArkUI.ArkUI.Full 13972 * @crossplatform 13973 * @atomicservice 13974 * @since arkts {'1.1':'18','1.2':'20'} 13975 * @arkts 1.1&1.2 13976 */ 13977declare enum DragBehavior { 13978 /** 13979 * If drag use copy event, then set DragBehavior.COPY. 13980 * 13981 * @syscap SystemCapability.ArkUI.ArkUI.Full 13982 * @since 10 13983 */ 13984 /** 13985 * If drag use copy event, then set DragBehavior.COPY. 13986 * 13987 * @syscap SystemCapability.ArkUI.ArkUI.Full 13988 * @atomicservice 13989 * @since 11 13990 */ 13991 /** 13992 * If drag use copy event, then set DragBehavior.COPY. 13993 * 13994 * @syscap SystemCapability.ArkUI.ArkUI.Full 13995 * @crossplatform 13996 * @atomicservice 13997 * @since arkts {'1.1':'18','1.2':'20'} 13998 * @arkts 1.1&1.2 13999 */ 14000 COPY, 14001 /** 14002 * If drag use move event, then set DragBehavior.MOVE. 14003 * 14004 * @syscap SystemCapability.ArkUI.ArkUI.Full 14005 * @since 10 14006 */ 14007 /** 14008 * If drag use move event, then set DragBehavior.MOVE. 14009 * 14010 * @syscap SystemCapability.ArkUI.ArkUI.Full 14011 * @atomicservice 14012 * @since 11 14013 */ 14014 /** 14015 * If drag use move event, then set DragBehavior.MOVE. 14016 * 14017 * @syscap SystemCapability.ArkUI.ArkUI.Full 14018 * @crossplatform 14019 * @atomicservice 14020 * @since arkts {'1.1':'18','1.2':'20'} 14021 * @arkts 1.1&1.2 14022 */ 14023 MOVE 14024} 14025 14026/** 14027 * Import the UnifiedData type object for ui component. 14028 * 14029 * @typedef { import('../api/@ohos.data.unifiedDataChannel').default.UnifiedData } UnifiedData 14030 * @syscap SystemCapability.ArkUI.ArkUI.Full 14031 * @crossplatform 14032 * @since 10 14033 */ 14034/** 14035 * Import the UnifiedData type object for ui component. 14036 * 14037 * @typedef { import('../api/@ohos.data.unifiedDataChannel').default.UnifiedData } UnifiedData 14038 * @syscap SystemCapability.ArkUI.ArkUI.Full 14039 * @crossplatform 14040 * @atomicservice 14041 * @since 11 14042 */ 14043declare type UnifiedData = import('../api/@ohos.data.unifiedDataChannel').default.UnifiedData; 14044 14045/** 14046 * Import the UnifiedData type object for ui component. 14047 * 14048 * @typedef { unifiedDataChannel.UnifiedData } UnifiedData 14049 * @syscap SystemCapability.ArkUI.ArkUI.Full 14050 * @crossplatform 14051 * @atomicservice 14052 * @since 20 14053 * @arkts 1.2 14054 */ 14055declare type UnifiedData = unifiedDataChannel.UnifiedData; 14056 14057/** 14058 * Import the Summary type object for ui component. 14059 * 14060 * @typedef { import('../api/@ohos.data.unifiedDataChannel').default.Summary } Summary 14061 * @syscap SystemCapability.ArkUI.ArkUI.Full 14062 * @since 10 14063 */ 14064/** 14065 * Import the Summary type object for ui component. 14066 * 14067 * @typedef { import('../api/@ohos.data.unifiedDataChannel').default.Summary } Summary 14068 * @syscap SystemCapability.ArkUI.ArkUI.Full 14069 * @atomicservice 14070 * @since 11 14071 */ 14072declare type Summary = import('../api/@ohos.data.unifiedDataChannel').default.Summary; 14073 14074/** 14075 * Import the Summary type object for ui component. 14076 * 14077 * @typedef { unifiedDataChannel.Summary } Summary 14078 * @syscap SystemCapability.ArkUI.ArkUI.Full 14079 * @atomicservice 14080 * @since 20 14081 * @arkts 1.2 14082 */ 14083declare type Summary = unifiedDataChannel.Summary; 14084 14085/** 14086 * Import the UniformDataType type object for ui component. 14087 * 14088 * @typedef { import('../api/@ohos.data.uniformTypeDescriptor').default.UniformDataType } UniformDataType 14089 * @syscap SystemCapability.ArkUI.ArkUI.Full 14090 * @since 10 14091 */ 14092/** 14093 * Import the UniformDataType type object for ui component. 14094 * 14095 * @typedef { import('../api/@ohos.data.uniformTypeDescriptor').default.UniformDataType } UniformDataType 14096 * @syscap SystemCapability.ArkUI.ArkUI.Full 14097 * @atomicservice 14098 * @since 11 14099 */ 14100declare type UniformDataType = import('../api/@ohos.data.uniformTypeDescriptor').default.UniformDataType; 14101 14102/** 14103 * Import the GetDataParams type object for ui component. 14104 * 14105 * @typedef { import('../api/@ohos.data.unifiedDataChannel').default.GetDataParams } GetDataParams 14106 * @syscap SystemCapability.ArkUI.ArkUI.Full 14107 * @crossplatform 14108 * @atomicservice 14109 * @since 15 14110 */ 14111declare type DataSyncOptions = import('../api/@ohos.data.unifiedDataChannel').default.GetDataParams; 14112 14113/** 14114 * Import the UniformDataType type object for ui component. 14115 * 14116 * @typedef { uniformTypeDescriptor.UniformDataType } UniformDataType 14117 * @syscap SystemCapability.ArkUI.ArkUI.Full 14118 * @atomicservice 14119 * @since 20 14120 * @arkts 1.2 14121 */ 14122declare type UniformDataType = uniformTypeDescriptor.UniformDataType; 14123 14124/** 14125 * Import the DataLoadParams type object for ui component. 14126 * 14127 * @typedef { import('../api/@ohos.data.unifiedDataChannel').default.DataLoadParams } DataLoadParams 14128 * @syscap SystemCapability.ArkUI.ArkUI.Full 14129 * @crossplatform 14130 * @atomicservice 14131 * @since 20 14132 */ 14133declare type DataLoadParams = import('../api/@ohos.data.unifiedDataChannel').default.DataLoadParams; 14134 14135/** 14136 * Enum for Drag Result. 14137 * 14138 * @enum { number } 14139 * @syscap SystemCapability.ArkUI.ArkUI.Full 14140 * @since 10 14141 */ 14142/** 14143 * Enum for Drag Result. 14144 * 14145 * @enum { number } 14146 * @syscap SystemCapability.ArkUI.ArkUI.Full 14147 * @atomicservice 14148 * @since 11 14149 */ 14150/** 14151 * Enum for Drag Result. 14152 * 14153 * @enum { number } 14154 * @syscap SystemCapability.ArkUI.ArkUI.Full 14155 * @crossplatform 14156 * @atomicservice 14157 * @since arkts {'1.1':'14','1.2':'20'} 14158 * @arkts 1.1&1.2 14159 */ 14160declare enum DragResult { 14161 /** 14162 * If the drag is not finished and the result is not set by receiver, return DragResult.UNKNOWN. 14163 * 14164 * @syscap SystemCapability.ArkUI.ArkUI.Full 14165 * @crossplatform 14166 * @atomicservice 14167 * @since 20 14168 * @arkts 1.2 14169 */ 14170 UNKNOWN = -1, 14171 /** 14172 * If the drag is successful, return DragResult.DRAG_SUCCESSFUL. 14173 * 14174 * @syscap SystemCapability.ArkUI.ArkUI.Full 14175 * @since 10 14176 */ 14177 /** 14178 * If the drag is successful, return DragResult.DRAG_SUCCESSFUL. 14179 * 14180 * @syscap SystemCapability.ArkUI.ArkUI.Full 14181 * @atomicservice 14182 * @since 11 14183 */ 14184 /** 14185 * If the drag is successful, return DragResult.DRAG_SUCCESSFUL. 14186 * 14187 * @syscap SystemCapability.ArkUI.ArkUI.Full 14188 * @crossplatform 14189 * @atomicservice 14190 * @since arkts {'1.1':'14','1.2':'20'} 14191 * @arkts 1.1&1.2 14192 */ 14193 DRAG_SUCCESSFUL = 0, 14194 /** 14195 * If drag fail, return DragResult.DRAG_FAILED. 14196 * 14197 * @syscap SystemCapability.ArkUI.ArkUI.Full 14198 * @since 10 14199 */ 14200 /** 14201 * If drag fail, return DragResult.DRAG_FAILED. 14202 * 14203 * @syscap SystemCapability.ArkUI.ArkUI.Full 14204 * @atomicservice 14205 * @since 11 14206 */ 14207 /** 14208 * If drag fail, return DragResult.DRAG_FAILED. 14209 * 14210 * @syscap SystemCapability.ArkUI.ArkUI.Full 14211 * @crossplatform 14212 * @atomicservice 14213 * @since arkts {'1.1':'14','1.2':'20'} 14214 * @arkts 1.1&1.2 14215 */ 14216 DRAG_FAILED = 1, 14217 /** 14218 * If drag action cancel, return DragResult.DRAG_CANCELED. 14219 * 14220 * @syscap SystemCapability.ArkUI.ArkUI.Full 14221 * @since 10 14222 */ 14223 /** 14224 * If drag action cancel, return DragResult.DRAG_CANCELED. 14225 * 14226 * @syscap SystemCapability.ArkUI.ArkUI.Full 14227 * @atomicservice 14228 * @since arkts {'1.1':'11','1.2':'20'} 14229 * @arkts 1.1&1.2 14230 */ 14231 DRAG_CANCELED = 2, 14232 /** 14233 * If node allow drop in, return DragResult.DROP_ENABLED. 14234 * 14235 * @syscap SystemCapability.ArkUI.ArkUI.Full 14236 * @since 10 14237 */ 14238 /** 14239 * If node allow drop in, return DragResult.DROP_ENABLED. 14240 * 14241 * @syscap SystemCapability.ArkUI.ArkUI.Full 14242 * @atomicservice 14243 * @since arkts {'1.1':'11','1.2':'20'} 14244 * @arkts 1.1&1.2 14245 */ 14246 DROP_ENABLED = 3, 14247 /** 14248 * If node don't allow drop in, return DragResult.DROP_DISABLED. 14249 * 14250 * @syscap SystemCapability.ArkUI.ArkUI.Full 14251 * @since 10 14252 */ 14253 /** 14254 * If node don't allow drop in, return DragResult.DROP_DISABLED. 14255 * 14256 * @syscap SystemCapability.ArkUI.ArkUI.Full 14257 * @atomicservice 14258 * @since arkts {'1.1':'11','1.2':'20'} 14259 * @arkts 1.1&1.2 14260 */ 14261 DROP_DISABLED = 4 14262} 14263 14264/** 14265 * Enum for BlendMode. 14266 * Blend modes for compositing current component 14267 * with overlapping content. Use overlapping content 14268 * as dst, current component as src. 14269 * 14270 * @enum { number } 14271 * @syscap SystemCapability.ArkUI.ArkUI.Full 14272 * @crossplatform 14273 * @form 14274 * @since 11 14275 */ 14276/** 14277 * Enum for BlendMode. 14278 * Blend modes for compositing current component 14279 * with overlapping content. Use overlapping content 14280 * as dst, current component as src. 14281 * 14282 * @enum { number } 14283 * @syscap SystemCapability.ArkUI.ArkUI.Full 14284 * @crossplatform 14285 * @form 14286 * @atomicservice 14287 * @since arkts {'1.1':'12','1.2':'20'} 14288 * @arkts 1.1&1.2 14289 */ 14290declare enum BlendMode { 14291 /** 14292 * The top image is superimposed on the bottom image without any blending. 14293 * 14294 * @syscap SystemCapability.ArkUI.ArkUI.Full 14295 * @crossplatform 14296 * @form 14297 * @since 11 14298 */ 14299 /** 14300 * The top image is superimposed on the bottom image without any blending. 14301 * 14302 * @syscap SystemCapability.ArkUI.ArkUI.Full 14303 * @crossplatform 14304 * @form 14305 * @atomicservice 14306 * @since arkts {'1.1':'12','1.2':'20'} 14307 * @arkts 1.1&1.2 14308 */ 14309 NONE = 0, 14310 /** 14311 * The target pixels covered by the source pixels are erased by being turned to completely transparent. 14312 * 14313 * @syscap SystemCapability.ArkUI.ArkUI.Full 14314 * @crossplatform 14315 * @form 14316 * @since 11 14317 */ 14318 /** 14319 * The target pixels covered by the source pixels are erased by being turned to completely transparent. 14320 * 14321 * @syscap SystemCapability.ArkUI.ArkUI.Full 14322 * @crossplatform 14323 * @form 14324 * @atomicservice 14325 * @since arkts {'1.1':'12','1.2':'20'} 14326 * @arkts 1.1&1.2 14327 */ 14328 CLEAR = 1, 14329 /** 14330 * r = s: Only the source pixels are displayed. 14331 * 14332 * @syscap SystemCapability.ArkUI.ArkUI.Full 14333 * @crossplatform 14334 * @form 14335 * @since 11 14336 */ 14337 /** 14338 * r = s: Only the source pixels are displayed. 14339 * 14340 * @syscap SystemCapability.ArkUI.ArkUI.Full 14341 * @crossplatform 14342 * @form 14343 * @atomicservice 14344 * @since arkts {'1.1':'12','1.2':'20'} 14345 * @arkts 1.1&1.2 14346 */ 14347 SRC = 2, 14348 /** 14349 * r = d 14350 * 14351 * @syscap SystemCapability.ArkUI.ArkUI.Full 14352 * @crossplatform 14353 * @form 14354 * @since 11 14355 */ 14356 /** 14357 * r = d 14358 * 14359 * @syscap SystemCapability.ArkUI.ArkUI.Full 14360 * @crossplatform 14361 * @form 14362 * @atomicservice 14363 * @since arkts {'1.1':'12','1.2':'20'} 14364 * @arkts 1.1&1.2 14365 */ 14366 DST = 3, 14367 /** 14368 * r = s + (1 - sa) * d: The source pixels are blended based on opacity and cover the target pixels. 14369 * 14370 * @syscap SystemCapability.ArkUI.ArkUI.Full 14371 * @crossplatform 14372 * @form 14373 * @since 11 14374 */ 14375 /** 14376 * r = s + (1 - sa) * d: The source pixels are blended based on opacity and cover the target pixels. 14377 * 14378 * @syscap SystemCapability.ArkUI.ArkUI.Full 14379 * @crossplatform 14380 * @form 14381 * @atomicservice 14382 * @since arkts {'1.1':'12','1.2':'20'} 14383 * @arkts 1.1&1.2 14384 */ 14385 SRC_OVER = 4, 14386 /** 14387 * r = d + (1 - da) * s: The target pixels are blended based on opacity and cover on the source pixels. 14388 * 14389 * @syscap SystemCapability.ArkUI.ArkUI.Full 14390 * @crossplatform 14391 * @form 14392 * @since 11 14393 */ 14394 /** 14395 * r = d + (1 - da) * s: The target pixels are blended based on opacity and cover on the source pixels. 14396 * 14397 * @syscap SystemCapability.ArkUI.ArkUI.Full 14398 * @crossplatform 14399 * @form 14400 * @atomicservice 14401 * @since arkts {'1.1':'12','1.2':'20'} 14402 * @arkts 1.1&1.2 14403 */ 14404 DST_OVER = 5, 14405 /** 14406 * r = s * da: Only the part of the source pixels that overlap with the target pixels is displayed. 14407 * 14408 * @syscap SystemCapability.ArkUI.ArkUI.Full 14409 * @crossplatform 14410 * @form 14411 * @since 11 14412 */ 14413 /** 14414 * r = s * da: Only the part of the source pixels that overlap with the target pixels is displayed. 14415 * 14416 * @syscap SystemCapability.ArkUI.ArkUI.Full 14417 * @crossplatform 14418 * @form 14419 * @atomicservice 14420 * @since arkts {'1.1':'12','1.2':'20'} 14421 * @arkts 1.1&1.2 14422 */ 14423 SRC_IN = 6, 14424 /** 14425 * r = d * sa: Only the part of the target pixels that overlap with the source pixels is displayed. 14426 * 14427 * @syscap SystemCapability.ArkUI.ArkUI.Full 14428 * @crossplatform 14429 * @form 14430 * @since 11 14431 */ 14432 /** 14433 * r = d * sa: Only the part of the target pixels that overlap with the source pixels is displayed. 14434 * 14435 * @syscap SystemCapability.ArkUI.ArkUI.Full 14436 * @crossplatform 14437 * @form 14438 * @atomicservice 14439 * @since arkts {'1.1':'12','1.2':'20'} 14440 * @arkts 1.1&1.2 14441 */ 14442 DST_IN = 7, 14443 /** 14444 * r = s * (1 - da) 14445 * 14446 * @syscap SystemCapability.ArkUI.ArkUI.Full 14447 * @crossplatform 14448 * @form 14449 * @since 11 14450 */ 14451 /** 14452 * r = s * (1 - da) 14453 * 14454 * @syscap SystemCapability.ArkUI.ArkUI.Full 14455 * @crossplatform 14456 * @form 14457 * @atomicservice 14458 * @since arkts {'1.1':'12','1.2':'20'} 14459 * @arkts 1.1&1.2 14460 */ 14461 SRC_OUT = 8, 14462 /** 14463 * r = d * (1 - sa) 14464 * 14465 * @syscap SystemCapability.ArkUI.ArkUI.Full 14466 * @crossplatform 14467 * @form 14468 * @since 11 14469 */ 14470 /** 14471 * r = d * (1 - sa), retains the parts of the destination pixels that do not overlap with the source. 14472 * 14473 * @syscap SystemCapability.ArkUI.ArkUI.Full 14474 * @crossplatform 14475 * @form 14476 * @atomicservice 14477 * @since arkts {'1.1':'12','1.2':'20'} 14478 * @arkts 1.1&1.2 14479 */ 14480 DST_OUT = 9, 14481 /** 14482 * r = s * da + d * (1 - sa): The part of the source pixels that overlap with the target pixels is displayed 14483 * and the part of the target pixels that do not overlap with the source pixels are displayed. 14484 * 14485 * @syscap SystemCapability.ArkUI.ArkUI.Full 14486 * @crossplatform 14487 * @form 14488 * @since 11 14489 */ 14490 /** 14491 * r = s * da + d * (1 - sa): The part of the source pixels that overlap with the target pixels is displayed 14492 * and the part of the target pixels that do not overlap with the source pixels are displayed. 14493 * 14494 * @syscap SystemCapability.ArkUI.ArkUI.Full 14495 * @crossplatform 14496 * @form 14497 * @atomicservice 14498 * @since arkts {'1.1':'12','1.2':'20'} 14499 * @arkts 1.1&1.2 14500 */ 14501 SRC_ATOP = 10, 14502 /** 14503 * r = d * sa + s * (1 - da) 14504 * 14505 * @syscap SystemCapability.ArkUI.ArkUI.Full 14506 * @crossplatform 14507 * @form 14508 * @since 11 14509 */ 14510 /** 14511 * r = d * sa + s * (1 - da): The part of the target pixels that overlap with the source pixels 14512 * and the part of the source pixels that do not overlap with the target pixels are displayed. 14513 * 14514 * @syscap SystemCapability.ArkUI.ArkUI.Full 14515 * @crossplatform 14516 * @form 14517 * @atomicservice 14518 * @since arkts {'1.1':'12','1.2':'20'} 14519 * @arkts 1.1&1.2 14520 */ 14521 DST_ATOP = 11, 14522 /** 14523 * r = s * (1 - da) + d * (1 - sa) 14524 * 14525 * @syscap SystemCapability.ArkUI.ArkUI.Full 14526 * @crossplatform 14527 * @form 14528 * @since 11 14529 */ 14530 /** 14531 * r = s * (1 - da) + d * (1 - sa) 14532 * 14533 * @syscap SystemCapability.ArkUI.ArkUI.Full 14534 * @crossplatform 14535 * @form 14536 * @atomicservice 14537 * @since arkts {'1.1':'12','1.2':'20'} 14538 * @arkts 1.1&1.2 14539 */ 14540 XOR = 12, 14541 /** 14542 * r = min(s + d, 1) 14543 * 14544 * @syscap SystemCapability.ArkUI.ArkUI.Full 14545 * @crossplatform 14546 * @form 14547 * @since 11 14548 */ 14549 /** 14550 * r = min(s + d, 1): 14551 * New pixels resulting from adding the source pixels to the target pixels are displayed. 14552 * 14553 * @syscap SystemCapability.ArkUI.ArkUI.Full 14554 * @crossplatform 14555 * @form 14556 * @atomicservice 14557 * @since arkts {'1.1':'12','1.2':'20'} 14558 * @arkts 1.1&1.2 14559 */ 14560 PLUS = 13, 14561 /** 14562 * r = s * d 14563 * 14564 * @syscap SystemCapability.ArkUI.ArkUI.Full 14565 * @crossplatform 14566 * @form 14567 * @since 11 14568 */ 14569 /** 14570 * r = s * d 14571 * 14572 * @syscap SystemCapability.ArkUI.ArkUI.Full 14573 * @crossplatform 14574 * @form 14575 * @atomicservice 14576 * @since arkts {'1.1':'12','1.2':'20'} 14577 * @arkts 1.1&1.2 14578 */ 14579 MODULATE = 14, 14580 /** 14581 * r = s + d - s * d 14582 * 14583 * @syscap SystemCapability.ArkUI.ArkUI.Full 14584 * @crossplatform 14585 * @form 14586 * @since 11 14587 */ 14588 /** 14589 * r = s + d - s * d 14590 * 14591 * @syscap SystemCapability.ArkUI.ArkUI.Full 14592 * @crossplatform 14593 * @form 14594 * @atomicservice 14595 * @since arkts {'1.1':'12','1.2':'20'} 14596 * @arkts 1.1&1.2 14597 */ 14598 SCREEN = 15, 14599 /** 14600 * multiply or screen, depending on destination 14601 * 14602 * @syscap SystemCapability.ArkUI.ArkUI.Full 14603 * @crossplatform 14604 * @form 14605 * @since 11 14606 */ 14607 /** 14608 * multiply or screen, depending on destination 14609 * 14610 * @syscap SystemCapability.ArkUI.ArkUI.Full 14611 * @crossplatform 14612 * @form 14613 * @atomicservice 14614 * @since arkts {'1.1':'12','1.2':'20'} 14615 * @arkts 1.1&1.2 14616 */ 14617 OVERLAY = 16, 14618 /** 14619 * rc = s + d - max(s * da, d * sa), ra = kSrcOver 14620 * 14621 * @syscap SystemCapability.ArkUI.ArkUI.Full 14622 * @crossplatform 14623 * @form 14624 * @since 11 14625 */ 14626 /** 14627 * rc = s + d - max(s * da, d * sa), ra = kSrcOver 14628 * 14629 * @syscap SystemCapability.ArkUI.ArkUI.Full 14630 * @crossplatform 14631 * @form 14632 * @atomicservice 14633 * @since arkts {'1.1':'12','1.2':'20'} 14634 * @arkts 1.1&1.2 14635 */ 14636 DARKEN = 17, 14637 /** 14638 * rc = s + d - min(s * da, d * sa), ra = kSrcOver 14639 * 14640 * @syscap SystemCapability.ArkUI.ArkUI.Full 14641 * @crossplatform 14642 * @form 14643 * @since 11 14644 */ 14645 /** 14646 * rc = s + d - min(s * da, d * sa), ra = kSrcOver 14647 * 14648 * @syscap SystemCapability.ArkUI.ArkUI.Full 14649 * @crossplatform 14650 * @form 14651 * @atomicservice 14652 * @since arkts {'1.1':'12','1.2':'20'} 14653 * @arkts 1.1&1.2 14654 */ 14655 LIGHTEN = 18, 14656 /** 14657 * brighten destination to reflect source 14658 * 14659 * @syscap SystemCapability.ArkUI.ArkUI.Full 14660 * @crossplatform 14661 * @form 14662 * @since 11 14663 */ 14664 /** 14665 * brighten destination to reflect source 14666 * 14667 * @syscap SystemCapability.ArkUI.ArkUI.Full 14668 * @crossplatform 14669 * @form 14670 * @atomicservice 14671 * @since arkts {'1.1':'12','1.2':'20'} 14672 * @arkts 1.1&1.2 14673 */ 14674 COLOR_DODGE = 19, 14675 /** 14676 * darken destination to reflect source 14677 * 14678 * @syscap SystemCapability.ArkUI.ArkUI.Full 14679 * @crossplatform 14680 * @form 14681 * @since 11 14682 */ 14683 /** 14684 * darken destination to reflect source 14685 * 14686 * @syscap SystemCapability.ArkUI.ArkUI.Full 14687 * @crossplatform 14688 * @form 14689 * @atomicservice 14690 * @since arkts {'1.1':'12','1.2':'20'} 14691 * @arkts 1.1&1.2 14692 */ 14693 COLOR_BURN = 20, 14694 /** 14695 * multiply or screen, depending on source 14696 * 14697 * @syscap SystemCapability.ArkUI.ArkUI.Full 14698 * @crossplatform 14699 * @form 14700 * @since 11 14701 */ 14702 /** 14703 * multiply or screen, depending on source 14704 * 14705 * @syscap SystemCapability.ArkUI.ArkUI.Full 14706 * @crossplatform 14707 * @form 14708 * @atomicservice 14709 * @since arkts {'1.1':'12','1.2':'20'} 14710 * @arkts 1.1&1.2 14711 */ 14712 HARD_LIGHT = 21, 14713 /** 14714 * The LIGHTEN or DARKEN mode is used, depending on the source pixels. 14715 * 14716 * @syscap SystemCapability.ArkUI.ArkUI.Full 14717 * @crossplatform 14718 * @form 14719 * @since 11 14720 */ 14721 /** 14722 * The LIGHTEN or DARKEN mode is used, depending on the source pixels. 14723 * 14724 * @syscap SystemCapability.ArkUI.ArkUI.Full 14725 * @crossplatform 14726 * @form 14727 * @atomicservice 14728 * @since arkts {'1.1':'12','1.2':'20'} 14729 * @arkts 1.1&1.2 14730 */ 14731 SOFT_LIGHT = 22, 14732 /** 14733 * rc = s + d - 2 * (min(s * da, d * sa)), ra = kSrcOver 14734 * 14735 * @syscap SystemCapability.ArkUI.ArkUI.Full 14736 * @crossplatform 14737 * @form 14738 * @since 11 14739 */ 14740 /** 14741 * rc = s + d - 2 * (min(s * da, d * sa)), ra = kSrcOver: The final pixel is the result of subtracting 14742 * the darker of the two pixels (source and target) from the lighter one. 14743 * 14744 * @syscap SystemCapability.ArkUI.ArkUI.Full 14745 * @crossplatform 14746 * @form 14747 * @atomicservice 14748 * @since arkts {'1.1':'12','1.2':'20'} 14749 * @arkts 1.1&1.2 14750 */ 14751 DIFFERENCE = 23, 14752 /** 14753 * rc = s + d - two(s * d), ra = kSrcOver 14754 * 14755 * @syscap SystemCapability.ArkUI.ArkUI.Full 14756 * @crossplatform 14757 * @form 14758 * @since 11 14759 */ 14760 /** 14761 * rc = s + d - two(s * d), ra = kSrcOver 14762 * 14763 * @syscap SystemCapability.ArkUI.ArkUI.Full 14764 * @crossplatform 14765 * @form 14766 * @atomicservice 14767 * @since arkts {'1.1':'12','1.2':'20'} 14768 * @arkts 1.1&1.2 14769 */ 14770 EXCLUSION = 24, 14771 /** 14772 * r = s * (1 - da) + d * (1 - sa) + s * d: 14773 * The final pixel is the result of multiplying the source pixel by the target pixel. 14774 * 14775 * @syscap SystemCapability.ArkUI.ArkUI.Full 14776 * @crossplatform 14777 * @form 14778 * @since 11 14779 */ 14780 /** 14781 * r = s * (1 - da) + d * (1 - sa) + s * d: 14782 * The final pixel is the result of multiplying the source pixel by the target pixel. 14783 * 14784 * @syscap SystemCapability.ArkUI.ArkUI.Full 14785 * @crossplatform 14786 * @form 14787 * @atomicservice 14788 * @since arkts {'1.1':'12','1.2':'20'} 14789 * @arkts 1.1&1.2 14790 */ 14791 MULTIPLY = 25, 14792 /** 14793 * hue of source with saturation and luminosity of destination 14794 * 14795 * @syscap SystemCapability.ArkUI.ArkUI.Full 14796 * @crossplatform 14797 * @form 14798 * @since 11 14799 */ 14800 /** 14801 * hue of source with saturation and luminosity of destination 14802 * 14803 * @syscap SystemCapability.ArkUI.ArkUI.Full 14804 * @crossplatform 14805 * @form 14806 * @atomicservice 14807 * @since arkts {'1.1':'12','1.2':'20'} 14808 * @arkts 1.1&1.2 14809 */ 14810 HUE = 26, 14811 /** 14812 * saturation of source with hue and luminosity of destination 14813 * 14814 * @syscap SystemCapability.ArkUI.ArkUI.Full 14815 * @crossplatform 14816 * @form 14817 * @since 11 14818 */ 14819 /** 14820 * saturation of source with hue and luminosity of destination 14821 * 14822 * @syscap SystemCapability.ArkUI.ArkUI.Full 14823 * @crossplatform 14824 * @form 14825 * @atomicservice 14826 * @since arkts {'1.1':'12','1.2':'20'} 14827 * @arkts 1.1&1.2 14828 */ 14829 SATURATION = 27, 14830 /** 14831 * hue and saturation of source with luminosity of destination 14832 * 14833 * @syscap SystemCapability.ArkUI.ArkUI.Full 14834 * @crossplatform 14835 * @form 14836 * @since 11 14837 */ 14838 /** 14839 * hue and saturation of source with luminosity of destination 14840 * 14841 * @syscap SystemCapability.ArkUI.ArkUI.Full 14842 * @crossplatform 14843 * @form 14844 * @atomicservice 14845 * @since arkts {'1.1':'12','1.2':'20'} 14846 * @arkts 1.1&1.2 14847 */ 14848 COLOR = 28, 14849 /** 14850 * luminosity of source with hue and saturation of destination 14851 * 14852 * @syscap SystemCapability.ArkUI.ArkUI.Full 14853 * @crossplatform 14854 * @form 14855 * @since 11 14856 */ 14857 /** 14858 * luminosity of source with hue and saturation of destination 14859 * 14860 * @syscap SystemCapability.ArkUI.ArkUI.Full 14861 * @crossplatform 14862 * @form 14863 * @atomicservice 14864 * @since arkts {'1.1':'12','1.2':'20'} 14865 * @arkts 1.1&1.2 14866 */ 14867 LUMINOSITY = 29 14868} 14869 14870/** 14871 * Enum for BlendApplyType. 14872 * Indicate how to apply specified blend mode to 14873 * the view's content. 14874 * 14875 * @enum { number } 14876 * @syscap SystemCapability.ArkUI.ArkUI.Full 14877 * @crossplatform 14878 * @form 14879 * @since 11 14880 */ 14881/** 14882 * Enum for BlendApplyType. 14883 * Indicate how to apply specified blend mode to 14884 * the view's content. 14885 * 14886 * @enum { number } 14887 * @syscap SystemCapability.ArkUI.ArkUI.Full 14888 * @crossplatform 14889 * @form 14890 * @atomicservice 14891 * @since arkts {'1.1':'12','1.2':'20'} 14892 * @arkts 1.1&1.2 14893 */ 14894declare enum BlendApplyType { 14895 /** 14896 * The content of the view is blended in sequence on the target image. 14897 * 14898 * @syscap SystemCapability.ArkUI.ArkUI.Full 14899 * @crossplatform 14900 * @form 14901 * @since 11 14902 */ 14903 /** 14904 * The content of the view is blended in sequence on the target image. 14905 * 14906 * @syscap SystemCapability.ArkUI.ArkUI.Full 14907 * @crossplatform 14908 * @form 14909 * @atomicservice 14910 * @since arkts {'1.1':'12','1.2':'20'} 14911 * @arkts 1.1&1.2 14912 */ 14913 FAST = 0, 14914 14915 /** 14916 * The content of the component and its child components are drawn on the 14917 * offscreen canvas, and then blended with the existing content on the canvas. 14918 * 14919 * @syscap SystemCapability.ArkUI.ArkUI.Full 14920 * @crossplatform 14921 * @form 14922 * @since 11 14923 */ 14924 /** 14925 * The content of the component and its child components are drawn on the 14926 * offscreen canvas, and then blended with the existing content on the canvas. 14927 * 14928 * @syscap SystemCapability.ArkUI.ArkUI.Full 14929 * @crossplatform 14930 * @form 14931 * @atomicservice 14932 * @since arkts {'1.1':'12','1.2':'20'} 14933 * @arkts 1.1&1.2 14934 */ 14935 OFFSCREEN = 1, 14936} 14937 14938/** 14939 * DragEvent object description 14940 * 14941 * @interface DragEvent 14942 * @syscap SystemCapability.ArkUI.ArkUI.Full 14943 * @since 7 14944 */ 14945/** 14946 * DragEvent object description 14947 * 14948 * @interface DragEvent 14949 * @syscap SystemCapability.ArkUI.ArkUI.Full 14950 * @atomicservice 14951 * @since 11 14952 */ 14953/** 14954 * DragEvent object description 14955 * 14956 * @interface DragEvent 14957 * @syscap SystemCapability.ArkUI.ArkUI.Full 14958 * @crossplatform 14959 * @atomicservice 14960 * @since arkts {'1.1':'14','1.2':'20'} 14961 * @arkts 1.1&1.2 14962 */ 14963declare interface DragEvent { 14964 /** 14965 * X coordinate of the point relative to the global display. 14966 * 14967 * @returns { number } 14968 * @syscap SystemCapability.ArkUI.ArkUI.Full 14969 * @atomicservice 14970 * @since 20 14971 */ 14972 getGlobalDisplayX(): number; 14973 14974 /** 14975 * Y coordinate of the point relative to the global display. 14976 * 14977 * @returns { number } 14978 * @syscap SystemCapability.ArkUI.ArkUI.Full 14979 * @atomicservice 14980 * @since 20 14981 */ 14982 getGlobalDisplayY(): number; 14983 14984 /** 14985 * X coordinate of the touch point relative to the left edge of the device screen. 14986 * 14987 * @returns { number } 14988 * @syscap SystemCapability.ArkUI.ArkUI.Full 14989 * @since 10 14990 */ 14991 /** 14992 * X coordinate of the touch point relative to the left edge of the device screen. 14993 * 14994 * @returns { number } 14995 * @syscap SystemCapability.ArkUI.ArkUI.Full 14996 * @atomicservice 14997 * @since 11 14998 */ 14999 /** 15000 * X coordinate of the touch point relative to the left edge of the device screen. 15001 * 15002 * @returns { number } 15003 * @syscap SystemCapability.ArkUI.ArkUI.Full 15004 * @crossplatform 15005 * @atomicservice 15006 * @since arkts {'1.1':'14','1.2':'20'} 15007 * @arkts 1.1&1.2 15008 */ 15009 getDisplayX(): number; 15010 15011 /** 15012 * Y coordinate of the touch point relative to the upper edge of the device screen. 15013 * 15014 * @returns { number } 15015 * @syscap SystemCapability.ArkUI.ArkUI.Full 15016 * @since 10 15017 */ 15018 /** 15019 * Y coordinate of the touch point relative to the upper edge of the device screen. 15020 * 15021 * @returns { number } 15022 * @syscap SystemCapability.ArkUI.ArkUI.Full 15023 * @atomicservice 15024 * @since 11 15025 */ 15026 /** 15027 * Y coordinate of the touch point relative to the upper edge of the device screen. 15028 * 15029 * @returns { number } 15030 * @syscap SystemCapability.ArkUI.ArkUI.Full 15031 * @crossplatform 15032 * @atomicservice 15033 * @since arkts {'1.1':'14','1.2':'20'} 15034 * @arkts 1.1&1.2 15035 */ 15036 getDisplayY(): number; 15037 15038 /** 15039 * X coordinate of the touch point relative to the left edge of the current window. 15040 * 15041 * @returns { number } 15042 * @syscap SystemCapability.ArkUI.ArkUI.Full 15043 * @since 10 15044 */ 15045 /** 15046 * X coordinate of the touch point relative to the left edge of the current window. 15047 * 15048 * @returns { number } 15049 * @syscap SystemCapability.ArkUI.ArkUI.Full 15050 * @atomicservice 15051 * @since 11 15052 */ 15053 /** 15054 * X coordinate of the touch point relative to the left edge of the current window. 15055 * 15056 * @returns { number } 15057 * @syscap SystemCapability.ArkUI.ArkUI.Full 15058 * @crossplatform 15059 * @atomicservice 15060 * @since arkts {'1.1':'14','1.2':'20'} 15061 * @arkts 1.1&1.2 15062 */ 15063 getWindowX(): number; 15064 15065 /** 15066 * Y coordinate of the touch point relative to the left edge of the current window. 15067 * 15068 * @returns { number } 15069 * @syscap SystemCapability.ArkUI.ArkUI.Full 15070 * @since 10 15071 */ 15072 /** 15073 * Y coordinate of the touch point relative to the left edge of the current window. 15074 * 15075 * @returns { number } 15076 * @syscap SystemCapability.ArkUI.ArkUI.Full 15077 * @atomicservice 15078 * @since 11 15079 */ 15080 /** 15081 * Y coordinate of the touch point relative to the left edge of the current window. 15082 * 15083 * @returns { number } 15084 * @syscap SystemCapability.ArkUI.ArkUI.Full 15085 * @crossplatform 15086 * @atomicservice 15087 * @since arkts {'1.1':'14','1.2':'20'} 15088 * @arkts 1.1&1.2 15089 */ 15090 getWindowY(): number; 15091 15092 /** 15093 * X coordinate of the touch point relative to the left edge of the current window. in vp. 15094 * 15095 * @returns { number } 15096 * @syscap SystemCapability.ArkUI.ArkUI.Full 15097 * @since 7 15098 * @deprecated since 10 15099 * @useinstead DragEvent#getWindowX 15100 */ 15101 getX(): number; 15102 15103 /** 15104 * Y coordinate of the touch point relative to the left edge of the current window. in vp. 15105 * 15106 * @returns { number } 15107 * @syscap SystemCapability.ArkUI.ArkUI.Full 15108 * @since 7 15109 * @deprecated since 10 15110 * @useinstead DragEvent#getWindowY 15111 */ 15112 getY(): number; 15113 15114 /** 15115 * If copy is COPY, this DragEvent is a copy event. 15116 * @type { DragBehavior } Operation, if use copy then set COPY, else set MOVE. 15117 * @default COPY 15118 * @syscap SystemCapability.ArkUI.ArkUI.Full 15119 * @since 10 15120 */ 15121 /** 15122 * If copy is COPY, this DragEvent is a copy event. 15123 * @type { DragBehavior } Operation, if use copy then set COPY, else set MOVE. 15124 * @default COPY 15125 * @syscap SystemCapability.ArkUI.ArkUI.Full 15126 * @atomicservice 15127 * @since 11 15128 */ 15129 /** 15130 * If copy is COPY, this DragEvent is a copy event. 15131 * @type { DragBehavior } Operation, if use copy then set COPY, else set MOVE. 15132 * @default COPY 15133 * @syscap SystemCapability.ArkUI.ArkUI.Full 15134 * @crossplatform 15135 * @atomicservice 15136 * @since arkts {'1.1':'18','1.2':'20'} 15137 * @arkts 1.1&1.2 15138 */ 15139 dragBehavior: DragBehavior; 15140 15141 /** 15142 * If useCustomDropAnimation is true, System will not use drop animation. 15143 * 15144 * @type { boolean } 15145 * @syscap SystemCapability.ArkUI.ArkUI.Full 15146 * @since 10 15147 */ 15148 /** 15149 * If useCustomDropAnimation is true, System will not use drop animation. 15150 * 15151 * @type { boolean } 15152 * @syscap SystemCapability.ArkUI.ArkUI.Full 15153 * @atomicservice 15154 * @since arkts {'1.1':'11','1.2':'20'} 15155 * @arkts 1.1&1.2 15156 */ 15157 useCustomDropAnimation: boolean; 15158 15159 /** 15160 * Set dragData into DragEvent. 15161 * 15162 * @param { UnifiedData } unifiedData - dragData. 15163 * @syscap SystemCapability.ArkUI.ArkUI.Full 15164 * @crossplatform 15165 * @since 10 15166 */ 15167 /** 15168 * Set dragData into DragEvent. 15169 * 15170 * @param { UnifiedData } unifiedData - dragData. 15171 * @syscap SystemCapability.ArkUI.ArkUI.Full 15172 * @crossplatform 15173 * @atomicservice 15174 * @since arkts {'1.1':'11','1.2':'20'} 15175 * @arkts 1.1&1.2 15176 */ 15177 setData(unifiedData: UnifiedData): void; 15178 15179 /** 15180 * Get dragData from DragEvent. 15181 * 15182 * @returns { UnifiedData } - get dragData. 15183 * @throws { BusinessError } 190001 - Data not found. 15184 * @throws { BusinessError } 190002 - Data error. 15185 * @syscap SystemCapability.ArkUI.ArkUI.Full 15186 * @crossplatform 15187 * @since 10 15188 */ 15189 /** 15190 * Get dragData from DragEvent. 15191 * 15192 * @returns { UnifiedData } - get dragData. 15193 * @throws { BusinessError } 190001 - Data not found. 15194 * @throws { BusinessError } 190002 - Data error. 15195 * @syscap SystemCapability.ArkUI.ArkUI.Full 15196 * @crossplatform 15197 * @atomicservice 15198 * @since arkts {'1.1':'11','1.2':'20'} 15199 * @arkts 1.1&1.2 15200 */ 15201 getData(): UnifiedData; 15202 15203 /** 15204 * Get dragData summary from DragEvent. 15205 * 15206 * @returns { Summary } - get Summary Data. 15207 * @syscap SystemCapability.ArkUI.ArkUI.Full 15208 * @crossplatform 15209 * @since 10 15210 */ 15211 /** 15212 * Get dragData summary from DragEvent. 15213 * 15214 * @returns { Summary } - get Summary Data. 15215 * @syscap SystemCapability.ArkUI.ArkUI.Full 15216 * @crossplatform 15217 * @atomicservice 15218 * @since arkts {'1.1':'11','1.2':'20'} 15219 * @arkts 1.1&1.2 15220 */ 15221 getSummary(): Summary; 15222 15223 /** 15224 * Set dragEvent result to DragEvent. 15225 * 15226 * @param { DragResult } dragResult - the return of dragEvent. 15227 * @syscap SystemCapability.ArkUI.ArkUI.Full 15228 * @since 10 15229 */ 15230 /** 15231 * Set dragEvent result to DragEvent. 15232 * 15233 * @param { DragResult } dragResult - the return of dragEvent. 15234 * @syscap SystemCapability.ArkUI.ArkUI.Full 15235 * @atomicservice 15236 * @since 11 15237 */ 15238 /** 15239 * Set dragEvent result to DragEvent. 15240 * 15241 * @param { DragResult } dragResult - the return of dragEvent. 15242 * @syscap SystemCapability.ArkUI.ArkUI.Full 15243 * @crossplatform 15244 * @atomicservice 15245 * @since arkts {'1.1':'14','1.2':'20'} 15246 * @arkts 1.1&1.2 15247 */ 15248 setResult(dragResult: DragResult): void; 15249 15250 /** 15251 * Get dragEvent result from DragEvent. 15252 * 15253 * @returns { DragResult } - dragResult Data. 15254 * @syscap SystemCapability.ArkUI.ArkUI.Full 15255 * @since 10 15256 */ 15257 /** 15258 * Get dragEvent result from DragEvent. 15259 * 15260 * @returns { DragResult } - dragResult Data. 15261 * @syscap SystemCapability.ArkUI.ArkUI.Full 15262 * @atomicservice 15263 * @since 11 15264 */ 15265 /** 15266 * Get dragEvent result from DragEvent. 15267 * 15268 * @returns { DragResult } - dragResult Data. 15269 * @syscap SystemCapability.ArkUI.ArkUI.Full 15270 * @crossplatform 15271 * @atomicservice 15272 * @since arkts {'1.1':'14','1.2':'20'} 15273 * @arkts 1.1&1.2 15274 */ 15275 getResult(): DragResult; 15276 15277 /** 15278 * Get the rectangle of drag window. 15279 * 15280 * @returns { Rectangle } - getPreview rectangle. 15281 * @syscap SystemCapability.ArkUI.ArkUI.Full 15282 * @since 10 15283 */ 15284 /** 15285 * Get the rectangle of drag window. 15286 * 15287 * @returns { Rectangle } - getPreview rectangle. 15288 * @syscap SystemCapability.ArkUI.ArkUI.Full 15289 * @atomicservice 15290 * @since 11 15291 */ 15292 /** 15293 * Get the rectangle of drag window. 15294 * 15295 * @returns { Rectangle } - getPreview rectangle. 15296 * @syscap SystemCapability.ArkUI.ArkUI.Full 15297 * @crossplatform 15298 * @atomicservice 15299 * @since arkts {'1.1':'14','1.2':'20'} 15300 * @arkts 1.1&1.2 15301 */ 15302 getPreviewRect(): Rectangle; 15303 15304 /** 15305 * Get the x axis velocity of drag gesture. 15306 * 15307 * @returns { number } - get x axis velocity. 15308 * @syscap SystemCapability.ArkUI.ArkUI.Full 15309 * @crossplatform 15310 * @since 10 15311 */ 15312 /** 15313 * Get the x axis velocity of drag gesture. 15314 * 15315 * @returns { number } - get x axis velocity. 15316 * @syscap SystemCapability.ArkUI.ArkUI.Full 15317 * @crossplatform 15318 * @atomicservice 15319 * @since arkts {'1.1':'11','1.2':'20'} 15320 * @arkts 1.1&1.2 15321 */ 15322 getVelocityX(): number; 15323 15324 /** 15325 * Get the y axis velocity of drag gesture. 15326 * 15327 * @returns { number } - get y axis velocity. 15328 * @syscap SystemCapability.ArkUI.ArkUI.Full 15329 * @crossplatform 15330 * @since 10 15331 */ 15332 /** 15333 * Get the y axis velocity of drag gesture. 15334 * 15335 * @returns { number } - get y axis velocity. 15336 * @syscap SystemCapability.ArkUI.ArkUI.Full 15337 * @crossplatform 15338 * @atomicservice 15339 * @since arkts {'1.1':'11','1.2':'20'} 15340 * @arkts 1.1&1.2 15341 */ 15342 getVelocityY(): number; 15343 15344 /** 15345 * Get the velocity of drag gesture. 15346 * 15347 * @returns { number } - get velocity. 15348 * @syscap SystemCapability.ArkUI.ArkUI.Full 15349 * @crossplatform 15350 * @since 10 15351 */ 15352 /** 15353 * Get the velocity of drag gesture. 15354 * 15355 * @returns { number } - get velocity. 15356 * @syscap SystemCapability.ArkUI.ArkUI.Full 15357 * @crossplatform 15358 * @atomicservice 15359 * @since arkts {'1.1':'11','1.2':'20'} 15360 * @arkts 1.1&1.2 15361 */ 15362 getVelocity(): number; 15363 15364 /** 15365 * Query the ModifierKey press state, support 'ctrl'|'alt'|'shift' 15366 * 15367 * @param { Array<string> } keys - indicate the keys of the ModifierKey. 15368 * @returns { boolean } 15369 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 15370 * @syscap SystemCapability.ArkUI.ArkUI.Full 15371 * @crossplatform 15372 * @since 12 15373 */ 15374 /** 15375 * Query the ModifierKey press state, support 'ctrl'|'alt'|'shift' 15376 * 15377 * @param { Array<string> } keys - indicate the keys of the ModifierKey. 15378 * @returns { boolean } 15379 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 15380 * @syscap SystemCapability.ArkUI.ArkUI.Full 15381 * @crossplatform 15382 * @atomicservice 15383 * @since 13 15384 */ 15385 getModifierKeyState?(keys: Array<string>): boolean; 15386 15387 /** 15388 * Query the modifier key press state, support 'ctrl'|'alt'|'shift' 15389 * 15390 * @type { ?ModifierKeyStateGetter } 15391 * @syscap SystemCapability.ArkUI.ArkUI.Full 15392 * @crossplatform 15393 * @atomicservice 15394 * @since 20 15395 * @arkts 1.2 15396 */ 15397 getModifierKeyState?: ModifierKeyStateGetter; 15398 15399 /** 15400 * Setup one drop animation execution callback, which will be triggered by system when user drops. 15401 * Use this way to implement the custom drop animation instead of doing it in onDrop, as the system 15402 * will decide when to trigger the callback during the drop handling. 15403 * [Note]: 15404 * 1. Please set useCustomDropAnimation to true as well when using this method. 15405 * 2. Do not implement the animation no-related logics in the callback. 15406 * 15407 * @param { Callback<void> } customDropAnimation - the custom drop animation function. 15408 * @syscap SystemCapability.ArkUI.ArkUI.Full 15409 * @crossplatform 15410 * @atomicservice 15411 * @since arkts {'1.1':'18','1.2':'20'} 15412 * @arkts 1.1&1.2 15413 */ 15414 executeDropAnimation(customDropAnimation: Callback<void>): void; 15415 15416 /** 15417 * Request the drag data to be synchronized to caller, can be notified with the synchronization progress. 15418 * Only can be used in onDrop event processing. 15419 * 15420 * @param { DataSyncOptions } options - the data sync options. 15421 * @returns { string } The data key returned by system, which can be used as the identify of the request. 15422 * @throws { BusinessError } 401 - Parameter error. 15423 * @throws { BusinessError } 190003 - Operation not allowed for current phase. 15424 * @syscap SystemCapability.ArkUI.ArkUI.Full 15425 * @atomicservice 15426 * @since 15 15427 */ 15428 startDataLoading(options: DataSyncOptions): string; 15429 15430 /** 15431 * Retrieve the bundle information of the drag source application. 15432 * 15433 * @returns { string } 15434 * @syscap SystemCapability.ArkUI.ArkUI.Full 15435 * @atomicservice 15436 * @since 20 15437 */ 15438 getDragSource(): string; 15439 15440 /** 15441 * Call this method to determine whether the current drag operation is a cross-device drag. 15442 * 15443 * @returns { boolean } 15444 * @syscap SystemCapability.ArkUI.ArkUI.Full 15445 * @atomicservice 15446 * @since 20 15447 */ 15448 isRemote(): boolean; 15449 15450 /** 15451 * Get the id of display which the drag event is occuring on. 15452 * 15453 * @returns { number } 15454 * @syscap SystemCapability.ArkUI.ArkUI.Full 15455 * @crossplatform 15456 * @atomicservice 15457 * @since 20 15458 */ 15459 getDisplayId(): number; 15460 15461 /** 15462 * Use this method to provide a data representation to the system instead of directly providing a complete data 15463 * object. When the user releases the drag over the target application, the system will use this data 15464 * representation to request the actual data from drag source. This approach significantly improves the 15465 * efficiency of initiating drag operations for large volumes of data and enhances the effectiveness of data 15466 * reception. It is recommended to use this method instead of the setData method. 15467 * 15468 * @param { DataLoadParams } dataLoadParams The data backend representation. 15469 * @syscap SystemCapability.ArkUI.ArkUI.Full 15470 * @atomicservice 15471 * @since 20 15472 */ 15473 setDataLoadParams(dataLoadParams: DataLoadParams): void; 15474 15475 /** 15476 * Enable the internal drop animation, which is only avaiable for system applications. 15477 * 15478 * The animations' configuration need to be provided through the input paramerter, and it is a string in json format. 15479 * 15480 * This method can only be called in onDrop, and please do not use custom drop animation after this method, 15481 * as it will reset the calling result, and use custom drop animation insteadly. 15482 * 15483 * @param { string } configuration - the internal drop animation's configuration. 15484 * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. 15485 * @throws { BusinessError } 801 - Capability not supported. 15486 * @throws { BusinessError } 190003 - Operation not allowed for current phase. 15487 * @syscap SystemCapability.ArkUI.ArkUI.Full 15488 * @systemapi 15489 * @since 20 15490 */ 15491 enableInternalDropAnimation(configuration: string): void; 15492} 15493 15494/** 15495 * The event callback function for drag and drop common interfaces. 15496 * @typedef { function } OnDragEventCallback 15497 * @param { DragEvent } event - the event object indicating current drag status. 15498 * @param { string } [extraParams] - extra information set by user or system. 15499 * @syscap SystemCapability.ArkUI.ArkUI.Full 15500 * @crossplatform 15501 * @atomicservice 15502 * @since arkts {'1.1':'15','1.2':'20'} 15503 * @arkts 1.1&1.2 15504 */ 15505declare type OnDragEventCallback = (event: DragEvent, extraParams?: string) => void; 15506 15507/** 15508 * Defines the options for the drop handling. 15509 * 15510 * @interface DropOptions 15511 * @syscap SystemCapability.ArkUI.ArkUI.Full 15512 * @crossplatform 15513 * @atomicservice 15514 * @since arkts {'1.1':'15','1.2':'20'} 15515 * @arkts 1.1&1.2 15516 */ 15517declare interface DropOptions { 15518 15519 /** 15520 * Indicating to disable the UDMF data prefetch action by system or not. 15521 * The system will try to fetch data before calling user's onDrop for some situation, 15522 * it will retry to get data until the max time limit (2.4s for now) reaches, 15523 * this's useful for the cross device draging operation, as the system helps to eliminate 15524 * the communication instability, but it's redundant for startDataLoading method, as this 15525 * method will take care the data fetching with asynchronous mechanism, so must set this 15526 * field to true if using startDataLoading in onDrop to avoid the data is fetched before 15527 * onDrop executing unexpectedly. 15528 * 15529 * @type { boolean } 15530 * @syscap SystemCapability.ArkUI.ArkUI.Full 15531 * @crossplatform 15532 * @atomicservice 15533 * @since arkts {'1.1':'15','1.2':'20'} 15534 * @arkts 1.1&1.2 15535 */ 15536 disableDataPrefetch?: boolean; 15537} 15538 15539/** 15540 * Import the IntentionCode type object for IntentionCode. 15541 * 15542 * @typedef { import('../api/@ohos.multimodalInput.intentionCode').IntentionCode } IntentionCode 15543 * @syscap SystemCapability.ArkUI.ArkUI.Full 15544 * @since 10 15545 */ 15546/** 15547 * Import the IntentionCode type object for IntentionCode. 15548 * 15549 * @typedef { import('../api/@ohos.multimodalInput.intentionCode').IntentionCode } IntentionCode 15550 * @syscap SystemCapability.ArkUI.ArkUI.Full 15551 * @atomicservice 15552 * @since 11 15553 */ 15554declare type IntentionCode = import('../api/@ohos.multimodalInput.intentionCode').IntentionCode; 15555 15556/** 15557 * KeyEvent object description: 15558 * 15559 * @interface KeyEvent 15560 * @syscap SystemCapability.ArkUI.ArkUI.Full 15561 * @since 7 15562 */ 15563/** 15564 * KeyEvent object description: 15565 * 15566 * @interface KeyEvent 15567 * @syscap SystemCapability.ArkUI.ArkUI.Full 15568 * @crossplatform 15569 * @since 10 15570 */ 15571/** 15572 * KeyEvent object description: 15573 * 15574 * @interface KeyEvent 15575 * @syscap SystemCapability.ArkUI.ArkUI.Full 15576 * @crossplatform 15577 * @atomicservice 15578 * @since arkts {'1.1':'11','1.2':'20'} 15579 * @arkts 1.1&1.2 15580 */ 15581declare interface KeyEvent { 15582 /** 15583 * Type of a key. 15584 * 15585 * @type { KeyType } 15586 * @syscap SystemCapability.ArkUI.ArkUI.Full 15587 * @since 7 15588 */ 15589 /** 15590 * Type of a key. 15591 * 15592 * @type { KeyType } 15593 * @syscap SystemCapability.ArkUI.ArkUI.Full 15594 * @crossplatform 15595 * @since 10 15596 */ 15597 /** 15598 * Type of a key. 15599 * 15600 * @type { KeyType } 15601 * @syscap SystemCapability.ArkUI.ArkUI.Full 15602 * @crossplatform 15603 * @atomicservice 15604 * @since arkts {'1.1':'11','1.2':'20'} 15605 * @arkts 1.1&1.2 15606 */ 15607 type: KeyType; 15608 15609 /** 15610 * Key code of a key 15611 * 15612 * @type { number } 15613 * @syscap SystemCapability.ArkUI.ArkUI.Full 15614 * @since 7 15615 */ 15616 /** 15617 * Key code of a key 15618 * 15619 * @type { number } 15620 * @syscap SystemCapability.ArkUI.ArkUI.Full 15621 * @crossplatform 15622 * @since 10 15623 */ 15624 /** 15625 * Key code of a key 15626 * 15627 * @type { number } 15628 * @syscap SystemCapability.ArkUI.ArkUI.Full 15629 * @crossplatform 15630 * @atomicservice 15631 * @since arkts {'1.1':'11','1.2':'20'} 15632 * @arkts 1.1&1.2 15633 */ 15634 keyCode: number; 15635 15636 /** 15637 * Key value of a key. 15638 * 15639 * @type { string } 15640 * @syscap SystemCapability.ArkUI.ArkUI.Full 15641 * @since 7 15642 */ 15643 /** 15644 * Key value of a key. 15645 * 15646 * @type { string } 15647 * @syscap SystemCapability.ArkUI.ArkUI.Full 15648 * @crossplatform 15649 * @since 10 15650 */ 15651 /** 15652 * Key value of a key. 15653 * 15654 * @type { string } 15655 * @syscap SystemCapability.ArkUI.ArkUI.Full 15656 * @crossplatform 15657 * @atomicservice 15658 * @since arkts {'1.1':'11','1.2':'20'} 15659 * @arkts 1.1&1.2 15660 */ 15661 keyText: string; 15662 15663 /** 15664 * Type of the input device that triggers the current key, such as the keyboard or handle. 15665 * 15666 * @type { KeySource } 15667 * @syscap SystemCapability.ArkUI.ArkUI.Full 15668 * @since 7 15669 */ 15670 /** 15671 * Type of the input device that triggers the current key, such as the keyboard or handle. 15672 * 15673 * @type { KeySource } 15674 * @syscap SystemCapability.ArkUI.ArkUI.Full 15675 * @crossplatform 15676 * @since 10 15677 */ 15678 /** 15679 * Type of the input device that triggers the current key, such as the keyboard or handle. 15680 * 15681 * @type { KeySource } 15682 * @syscap SystemCapability.ArkUI.ArkUI.Full 15683 * @crossplatform 15684 * @atomicservice 15685 * @since arkts {'1.1':'11','1.2':'20'} 15686 * @arkts 1.1&1.2 15687 */ 15688 keySource: KeySource; 15689 15690 /** 15691 * Indicates the ID of the input device that triggers the current key. 15692 * 15693 * @type { number } 15694 * @syscap SystemCapability.ArkUI.ArkUI.Full 15695 * @since 7 15696 */ 15697 /** 15698 * Indicates the ID of the input device that triggers the current key. 15699 * 15700 * @type { number } 15701 * @syscap SystemCapability.ArkUI.ArkUI.Full 15702 * @crossplatform 15703 * @since 10 15704 */ 15705 /** 15706 * Indicates the ID of the input device that triggers the current key. 15707 * 15708 * @type { number } 15709 * @syscap SystemCapability.ArkUI.ArkUI.Full 15710 * @crossplatform 15711 * @atomicservice 15712 * @since arkts {'1.1':'11','1.2':'20'} 15713 * @arkts 1.1&1.2 15714 */ 15715 deviceId: number; 15716 15717 /** 15718 * Indicates the status of the key when the key is pressed. 15719 * The value 1 indicates the pressed state, and the value 0 indicates the unpressed state. 15720 * 15721 * @type { number } 15722 * @syscap SystemCapability.ArkUI.ArkUI.Full 15723 * @since 7 15724 */ 15725 /** 15726 * Indicates the status of the key when the key is pressed. 15727 * The value 1 indicates the pressed state, and the value 0 indicates the unpressed state. 15728 * 15729 * @type { number } 15730 * @syscap SystemCapability.ArkUI.ArkUI.Full 15731 * @crossplatform 15732 * @since 10 15733 */ 15734 /** 15735 * Indicates the status of the key when the key is pressed. 15736 * The value 1 indicates the pressed state, and the value 0 indicates the unpressed state. 15737 * 15738 * @type { number } 15739 * @syscap SystemCapability.ArkUI.ArkUI.Full 15740 * @crossplatform 15741 * @atomicservice 15742 * @since arkts {'1.1':'11','1.2':'20'} 15743 * @arkts 1.1&1.2 15744 */ 15745 metaKey: number; 15746 15747 /** 15748 * Timestamp when the key was pressed. 15749 * 15750 * @type { number } 15751 * @syscap SystemCapability.ArkUI.ArkUI.Full 15752 * @since 7 15753 */ 15754 /** 15755 * Timestamp when the key was pressed. 15756 * 15757 * @type { number } 15758 * @syscap SystemCapability.ArkUI.ArkUI.Full 15759 * @crossplatform 15760 * @since 10 15761 */ 15762 /** 15763 * Timestamp when the key was pressed. 15764 * 15765 * @type { number } 15766 * @syscap SystemCapability.ArkUI.ArkUI.Full 15767 * @crossplatform 15768 * @atomicservice 15769 * @since arkts {'1.1':'11','1.2':'20'} 15770 * @arkts 1.1&1.2 15771 */ 15772 timestamp: number; 15773 15774 /** 15775 * Block event bubbling. 15776 * 15777 * @type { function } 15778 * @syscap SystemCapability.ArkUI.ArkUI.Full 15779 * @since 7 15780 */ 15781 /** 15782 * Block event bubbling. 15783 * 15784 * @type { function } 15785 * @syscap SystemCapability.ArkUI.ArkUI.Full 15786 * @crossplatform 15787 * @since 10 15788 */ 15789 /** 15790 * Block event bubbling. 15791 * 15792 * @type { function } 15793 * @syscap SystemCapability.ArkUI.ArkUI.Full 15794 * @crossplatform 15795 * @atomicservice 15796 * @since arkts {'1.1':'11','1.2':'20'} 15797 * @arkts 1.1&1.2 15798 */ 15799 stopPropagation: () => void; 15800 15801 /** 15802 * Intention code of a key or modifier keys. 15803 * 15804 * @type { IntentionCode } 15805 * @default IntentionCode.INTENTION_UNKNOWN 15806 * @syscap SystemCapability.ArkUI.ArkUI.Full 15807 * @since 10 15808 */ 15809 /** 15810 * Intention code of a key or modifier keys. 15811 * 15812 * @type { IntentionCode } 15813 * @default IntentionCode.INTENTION_UNKNOWN 15814 * @syscap SystemCapability.ArkUI.ArkUI.Full 15815 * @atomicservice 15816 * @since arkts {'1.1':'11','1.2':'20'} 15817 * @arkts 1.1&1.2 15818 */ 15819 intentionCode: IntentionCode; 15820 15821 /** 15822 * Get the modifier keys press state, support 'ctrl'|'alt'|'shift' 15823 * 15824 * @param { Array<string> } keys - indicate the modifier keys. 15825 * @returns { boolean } 15826 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 15827 * @syscap SystemCapability.ArkUI.ArkUI.Full 15828 * @crossplatform 15829 * @since 12 15830 */ 15831 /** 15832 * Get the modifier keys press state, support 'ctrl'|'alt'|'shift' 15833 * 15834 * @param { Array<string> } keys - indicate the modifier keys. 15835 * @returns { boolean } 15836 * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. 2. Parameter verification failed. 15837 * @syscap SystemCapability.ArkUI.ArkUI.Full 15838 * @crossplatform 15839 * @atomicservice 15840 * @since 13 15841 */ 15842 getModifierKeyState?(keys: Array<string>): boolean; 15843 15844 /** 15845 * Query the modifier key press state, support 'ctrl'|'alt'|'shift' 15846 * 15847 * @type { ?ModifierKeyStateGetter } 15848 * @syscap SystemCapability.ArkUI.ArkUI.Full 15849 * @crossplatform 15850 * @atomicservice 15851 * @since 20 15852 * @arkts 1.2 15853 */ 15854 getModifierKeyState?: ModifierKeyStateGetter; 15855 15856 /** 15857 * Unicode of a key 15858 * 15859 * @type { ?number } 15860 * @syscap SystemCapability.ArkUI.ArkUI.Full 15861 * @atomicservice 15862 * @since arkts {'1.1':'14','1.2':'20'} 15863 * @arkts 1.1&1.2 15864 */ 15865 unicode?: number; 15866 15867 /** 15868 * Whether Num Lock is on 15869 * 15870 * @type { ?boolean } 15871 * @syscap SystemCapability.ArkUI.ArkUI.Full 15872 * @atomicservice 15873 * @since 19 15874 */ 15875 isNumLockOn?: boolean; 15876 15877 /** 15878 * Whether Caps Lock is on 15879 * 15880 * @type { ?boolean } 15881 * @syscap SystemCapability.ArkUI.ArkUI.Full 15882 * @atomicservice 15883 * @since 19 15884 */ 15885 isCapsLockOn?: boolean; 15886 15887 /** 15888 * Whether Scroll Lock is on 15889 * 15890 * @type { ?boolean } 15891 * @syscap SystemCapability.ArkUI.ArkUI.Full 15892 * @atomicservice 15893 * @since 19 15894 */ 15895 isScrollLockOn?: boolean; 15896} 15897 15898/** 15899 * Focus axis event object description. 15900 * 15901 * @extends BaseEvent 15902 * @interface FocusAxisEvent 15903 * @syscap SystemCapability.ArkUI.ArkUI.Full 15904 * @atomicservice 15905 * @since arkts {'1.1':'15','1.2':'20'} 15906 * @arkts 1.1&1.2 15907 */ 15908declare interface FocusAxisEvent extends BaseEvent { 15909 /** 15910 * The axis values of axis event. 15911 * 15912 * @type { Map<AxisModel, number> } 15913 * @syscap SystemCapability.ArkUI.ArkUI.Full 15914 * @atomicservice 15915 * @since arkts {'1.1':'15','1.2':'20'} 15916 * @arkts 1.1&1.2 15917 */ 15918 axisMap: Map<AxisModel, number>; 15919 15920 /** 15921 * The blocking event pops up. 15922 * 15923 * @type { Callback<void> } 15924 * @syscap SystemCapability.ArkUI.ArkUI.Full 15925 * @atomicservice 15926 * @since arkts {'1.1':'15','1.2':'20'} 15927 * @arkts 1.1&1.2 15928 */ 15929 stopPropagation: Callback<void>; 15930} 15931 15932/** 15933 * CrownEvent object description 15934 * 15935 * @interface CrownEvent 15936 * @syscap SystemCapability.ArkUI.ArkUI.Full 15937 * @atomicservice 15938 * @since arkts {'1.1':'18','1.2':'20'} 15939 * @arkts 1.1&1.2 15940 */ 15941declare interface CrownEvent { 15942 /** 15943 *The timestamp of the rotating crown event. 15944 * 15945 * @type { number } 15946 * @syscap SystemCapability.ArkUI.ArkUI.Full 15947 * @atomicservice 15948 * @since arkts {'1.1':'18','1.2':'20'} 15949 * @arkts 1.1&1.2 15950 */ 15951 timestamp: number; 15952 15953 /** 15954 * The angular velocity of a rotating crown. 15955 * 15956 * @type { number } 15957 * @syscap SystemCapability.ArkUI.ArkUI.Full 15958 * @atomicservice 15959 * @since arkts {'1.1':'18','1.2':'20'} 15960 * @arkts 1.1&1.2 15961 */ 15962 angularVelocity: number; 15963 15964 /** 15965 * The rotation angle of the rotating crown. 15966 * 15967 * @type { number } 15968 * @syscap SystemCapability.ArkUI.ArkUI.Full 15969 * @atomicservice 15970 * @since arkts {'1.1':'18','1.2':'20'} 15971 * @arkts 1.1&1.2 15972 */ 15973 degree: number; 15974 15975 /** 15976 * The behavior of rotating crown. 15977 * 15978 * @type { CrownAction } 15979 * @syscap SystemCapability.ArkUI.ArkUI.Full 15980 * @atomicservice 15981 * @since arkts {'1.1':'18','1.2':'20'} 15982 * @arkts 1.1&1.2 15983 */ 15984 action: CrownAction; 15985 15986 /** 15987 * The blocking event pops up. 15988 * 15989 * @type { Callback<void> } 15990 * @syscap SystemCapability.ArkUI.ArkUI.Full 15991 * @atomicservice 15992 * @since arkts {'1.1':'18','1.2':'20'} 15993 * @arkts 1.1&1.2 15994 */ 15995 stopPropagation: Callback<void>; 15996} 15997 15998/** 15999 * Overlay module options 16000 * 16001 * @interface BindOptions 16002 * @syscap SystemCapability.ArkUI.ArkUI.Full 16003 * @crossplatform 16004 * @since 10 16005 */ 16006/** 16007 * Overlay module options 16008 * 16009 * @interface BindOptions 16010 * @syscap SystemCapability.ArkUI.ArkUI.Full 16011 * @crossplatform 16012 * @atomicservice 16013 * @since arkts {'1.1':'11','1.2':'20'} 16014 * @arkts 1.1&1.2 16015 */ 16016declare interface BindOptions { 16017 /** 16018 * Background color of the sheet. 16019 * <br>Default value: **Color.White**. 16020 * 16021 * @type { ?ResourceColor } 16022 * @syscap SystemCapability.ArkUI.ArkUI.Full 16023 * @crossplatform 16024 * @since 10 16025 */ 16026 /** 16027 * Background color of the sheet. 16028 * <br>Default value: **Color.White**. 16029 * 16030 * @type { ?ResourceColor } 16031 * @syscap SystemCapability.ArkUI.ArkUI.Full 16032 * @crossplatform 16033 * @atomicservice 16034 * @since arkts {'1.1':'11','1.2':'20'} 16035 * @arkts 1.1&1.2 16036 */ 16037 backgroundColor?: ResourceColor; 16038 16039 /** 16040 * Callback for when the sheet is displayed (after the animation ends). 16041 * 16042 * @type { ?function } 16043 * @syscap SystemCapability.ArkUI.ArkUI.Full 16044 * @crossplatform 16045 * @since 10 16046 */ 16047 /** 16048 * Callback for when the sheet is displayed (after the animation ends). 16049 * 16050 * @type { ?function } 16051 * @syscap SystemCapability.ArkUI.ArkUI.Full 16052 * @crossplatform 16053 * @atomicservice 16054 * @since arkts {'1.1':'11','1.2':'20'} 16055 * @arkts 1.1&1.2 16056 */ 16057 onAppear?: () => void; 16058 16059 /** 16060 * Callback for when the sheet disappears (after the animation ends). 16061 * 16062 * @type { ?function } 16063 * @syscap SystemCapability.ArkUI.ArkUI.Full 16064 * @crossplatform 16065 * @since 10 16066 */ 16067 /** 16068 * Callback for when the sheet disappears (after the animation ends). 16069 * 16070 * @type { ?function } 16071 * @syscap SystemCapability.ArkUI.ArkUI.Full 16072 * @crossplatform 16073 * @atomicservice 16074 * @since arkts {'1.1':'11','1.2':'20'} 16075 * @arkts 1.1&1.2 16076 */ 16077 onDisappear?: () => void; 16078 16079 /** 16080 * Callback for when the sheet is about to be displayed (before the animation starts). 16081 * 16082 * @type { ?function } 16083 * @syscap SystemCapability.ArkUI.ArkUI.Full 16084 * @crossplatform 16085 * @atomicservice 16086 * @since arkts {'1.1':'12','1.2':'20'} 16087 * @arkts 1.1&1.2 16088 */ 16089 onWillAppear?: () => void; 16090 16091 /** 16092 * Callback function before overlay popAnimation starts. 16093 * 16094 * @type { ?function } 16095 * @syscap SystemCapability.ArkUI.ArkUI.Full 16096 * @crossplatform 16097 * @atomicservice 16098 * @since arkts {'1.1':'12','1.2':'20'} 16099 * @arkts 1.1&1.2 16100 */ 16101 onWillDisappear?: () => void; 16102} 16103 16104/** 16105 * Component content cover dismiss 16106 * 16107 * @interface DismissContentCoverAction 16108 * @syscap SystemCapability.ArkUI.ArkUI.Full 16109 * @crossplatform 16110 * @atomicservice 16111 * @since 12 16112 */ 16113declare interface DismissContentCoverAction { 16114 /** 16115 * Defines content cover dismiss function 16116 * 16117 * @type { Callback<void> } 16118 * @syscap SystemCapability.ArkUI.ArkUI.Full 16119 * @crossplatform 16120 * @atomicservice 16121 * @since 12 16122 */ 16123 dismiss: Callback<void>; 16124 16125 /** 16126 * Defines content cover dismiss reason 16127 * 16128 * @type { DismissReason } 16129 * @syscap SystemCapability.ArkUI.ArkUI.Full 16130 * @crossplatform 16131 * @atomicservice 16132 * @since 12 16133 */ 16134 reason: DismissReason; 16135} 16136 16137/** 16138 * Component content cover dismiss 16139 * 16140 * @interface DismissContentCoverAction 16141 * @syscap SystemCapability.ArkUI.ArkUI.Full 16142 * @crossplatform 16143 * @atomicservice 16144 * @arkts 1.2 16145 * @since 20 16146 */ 16147declare interface DismissContentCoverAction { 16148 /** 16149 * Defines content cover dismiss function 16150 * 16151 * @type { VoidCallback } 16152 * @syscap SystemCapability.ArkUI.ArkUI.Full 16153 * @crossplatform 16154 * @atomicservice 16155 * @arkts 1.2 16156 * @since 20 16157 */ 16158 dismiss: VoidCallback; 16159 16160 /** 16161 * Defines content cover dismiss reason 16162 * 16163 * @type { DismissReason } 16164 * @syscap SystemCapability.ArkUI.ArkUI.Full 16165 * @crossplatform 16166 * @atomicservice 16167 * @arkts 1.2 16168 * @since 20 16169 */ 16170 reason: DismissReason; 16171} 16172 16173/** 16174 * Component content cover options 16175 * 16176 * @extends BindOptions 16177 * @interface ContentCoverOptions 16178 * @syscap SystemCapability.ArkUI.ArkUI.Full 16179 * @crossplatform 16180 * @since 10 16181 */ 16182/** 16183 * Component content cover options 16184 * 16185 * @extends BindOptions 16186 * @interface ContentCoverOptions 16187 * @syscap SystemCapability.ArkUI.ArkUI.Full 16188 * @crossplatform 16189 * @atomicservice 16190 * @since arkts {'1.1':'11','1.2':'20'} 16191 * @arkts 1.1&1.2 16192 */ 16193declare interface ContentCoverOptions extends BindOptions { 16194 /** 16195 * Defines transition type 16196 * 16197 * @type { ?ModalTransition } 16198 * @default ModalTransition.DEFAULT 16199 * @syscap SystemCapability.ArkUI.ArkUI.Full 16200 * @crossplatform 16201 * @since 10 16202 */ 16203 /** 16204 * Defines transition type 16205 * 16206 * @type { ?ModalTransition } 16207 * @default ModalTransition.DEFAULT 16208 * @syscap SystemCapability.ArkUI.ArkUI.Full 16209 * @crossplatform 16210 * @atomicservice 16211 * @since arkts {'1.1':'11','1.2':'20'} 16212 * @arkts 1.1&1.2 16213 */ 16214 modalTransition?: ModalTransition, 16215 16216 /** 16217 * Callback function when the content cover interactive dismiss 16218 * 16219 * @type { ?Callback<DismissContentCoverAction> } 16220 * @syscap SystemCapability.ArkUI.ArkUI.Full 16221 * @crossplatform 16222 * @atomicservice 16223 * @since arkts {'1.1':'12','1.2':'20'} 16224 * @arkts 1.1&1.2 16225 */ 16226 onWillDismiss?: Callback<DismissContentCoverAction>; 16227 16228 /** 16229 * Defines transition effect param 16230 * 16231 * @type { ?TransitionEffect } 16232 * @syscap SystemCapability.ArkUI.ArkUI.Full 16233 * @crossplatform 16234 * @atomicservice 16235 * @since arkts {'1.1':'12','1.2':'20'} 16236 * @arkts 1.1&1.2 16237 */ 16238 transition?: TransitionEffect; 16239 16240 /** 16241 * Set contentCover content adapts to safeArea. 16242 * 16243 * @type { ?boolean } 16244 * @default false 16245 * @syscap SystemCapability.ArkUI.ArkUI.Full 16246 * @crossplatform 16247 * @atomicservice 16248 * @since 20 16249 */ 16250 enableSafeArea?: boolean; 16251} 16252 16253/** 16254 * Component sheet title options 16255 * 16256 * @interface SheetTitleOptions 16257 * @syscap SystemCapability.ArkUI.ArkUI.Full 16258 * @crossplatform 16259 * @since 11 16260 */ 16261/** 16262 * Component sheet title options 16263 * 16264 * @interface SheetTitleOptions 16265 * @syscap SystemCapability.ArkUI.ArkUI.Full 16266 * @crossplatform 16267 * @atomicservice 16268 * @since arkts {'1.1':'12','1.2':'20'} 16269 * @arkts 1.1&1.2 16270 */ 16271declare interface SheetTitleOptions { 16272 /** 16273 * Defines title text 16274 * 16275 * @type { ResourceStr } 16276 * @syscap SystemCapability.ArkUI.ArkUI.Full 16277 * @crossplatform 16278 * @since 11 16279 */ 16280 /** 16281 * Defines title text 16282 * 16283 * @type { ResourceStr } 16284 * @syscap SystemCapability.ArkUI.ArkUI.Full 16285 * @crossplatform 16286 * @atomicservice 16287 * @since arkts {'1.1':'12','1.2':'20'} 16288 * @arkts 1.1&1.2 16289 */ 16290 title: ResourceStr; 16291 16292 /** 16293 * Defines subtitle text 16294 * 16295 * @type { ?ResourceStr } 16296 * @syscap SystemCapability.ArkUI.ArkUI.Full 16297 * @crossplatform 16298 * @since 11 16299 */ 16300 /** 16301 * Defines subtitle text 16302 * 16303 * @type { ?ResourceStr } 16304 * @syscap SystemCapability.ArkUI.ArkUI.Full 16305 * @crossplatform 16306 * @atomicservice 16307 * @since arkts {'1.1':'12','1.2':'20'} 16308 * @arkts 1.1&1.2 16309 */ 16310 subtitle?: ResourceStr; 16311} 16312 16313/** 16314 * Defines the sheet type. 16315 * 16316 * @enum { number } 16317 * @syscap SystemCapability.ArkUI.ArkUI.Full 16318 * @crossplatform 16319 * @since 11 16320 */ 16321/** 16322 * Defines the sheet type. 16323 * 16324 * @enum { number } 16325 * @syscap SystemCapability.ArkUI.ArkUI.Full 16326 * @crossplatform 16327 * @atomicservice 16328 * @since arkts {'1.1':'12','1.2':'20'} 16329 * @arkts 1.1&1.2 16330 */ 16331declare enum SheetType { 16332 /** 16333 * Bottom sheet. 16334 * 16335 * @syscap SystemCapability.ArkUI.ArkUI.Full 16336 * @crossplatform 16337 * @since 11 16338 */ 16339 /** 16340 * Bottom sheet. 16341 * 16342 * @syscap SystemCapability.ArkUI.ArkUI.Full 16343 * @crossplatform 16344 * @atomicservice 16345 * @since arkts {'1.1':'12','1.2':'20'} 16346 * @arkts 1.1&1.2 16347 */ 16348 BOTTOM = 0, 16349 16350 /** 16351 * Center sheet. 16352 * 16353 * @syscap SystemCapability.ArkUI.ArkUI.Full 16354 * @crossplatform 16355 * @since 11 16356 */ 16357 /** 16358 * Center sheet. 16359 * 16360 * @syscap SystemCapability.ArkUI.ArkUI.Full 16361 * @crossplatform 16362 * @atomicservice 16363 * @since arkts {'1.1':'12','1.2':'20'} 16364 * @arkts 1.1&1.2 16365 */ 16366 CENTER = 1, 16367 16368 /** 16369 * Popup sheet. The popup sheet cannot be dismissed with a pull-down gesture. 16370 * 16371 * @syscap SystemCapability.ArkUI.ArkUI.Full 16372 * @crossplatform 16373 * @since 11 16374 */ 16375 /** 16376 * Defines popup sheet type. 16377 * 16378 * @syscap SystemCapability.ArkUI.ArkUI.Full 16379 * @crossplatform 16380 * @atomicservice 16381 * @since arkts {'1.1':'12','1.2':'20'} 16382 * @arkts 1.1&1.2 16383 */ 16384 POPUP = 2, 16385 16386 /** 16387 * Defines side sheet type. 16388 * 16389 * @syscap SystemCapability.ArkUI.ArkUI.Full 16390 * @crossplatform 16391 * @atomicservice 16392 * @since 20 16393 */ 16394 SIDE = 3, 16395 16396 /** 16397 * Defines content cover type. 16398 * 16399 * @syscap SystemCapability.ArkUI.ArkUI.Full 16400 * @crossplatform 16401 * @atomicservice 16402 * @since 20 16403 */ 16404 CONTENT_COVER = 4, 16405} 16406 16407/** 16408 * Define the display mode of the sheet. 16409 * 16410 * @enum { number } 16411 * @syscap SystemCapability.ArkUI.ArkUI.Full 16412 * @crossplatform 16413 * @atomicservice 16414 * @since arkts {'1.1':'12','1.2':'20'} 16415 * @arkts 1.1&1.2 16416 */ 16417declare enum SheetMode { 16418 /** 16419 * The sheet is displayed at the top of the window corresponding to the current **UIContext** instance, 16420 * above all pages. It is displayed at the same level as dialog boxes. 16421 * 16422 * @syscap SystemCapability.ArkUI.ArkUI.Full 16423 * @crossplatform 16424 * @atomicservice 16425 * @since arkts {'1.1':'12','1.2':'20'} 16426 * @arkts 1.1&1.2 16427 */ 16428 OVERLAY = 0, 16429 16430 /** 16431 * The sheet is displayed at the top of the current page. 16432 * <br>**NOTE**<br>Currently, the sheet can only be mounted on a **Page** 16433 * or **NavDestination** node, with priority given to the **NavDestination** 16434 * node if it is present. This means that, the sheet can only be displayed at 16435 * the top of these two types of pages.<br> In this mode, new pages can overlay 16436 * the sheet, and when the user returns to the previous page, the sheet remains 16437 * present without losing its content.<br> In this mode, you must ensure that 16438 * the target page node, such as the **Page** node, has been attached to the tree 16439 * before bringing up the sheet; otherwise, the sheet will not be able to be 16440 * attached to the corresponding page node. 16441 * 16442 * @syscap SystemCapability.ArkUI.ArkUI.Full 16443 * @crossplatform 16444 * @atomicservice 16445 * @since arkts {'1.1':'12','1.2':'20'} 16446 * @arkts 1.1&1.2 16447 */ 16448 EMBEDDED = 1, 16449} 16450 16451/** 16452 * Define the scroll size mode of the sheet. 16453 * 16454 * @enum { number } 16455 * @syscap SystemCapability.ArkUI.ArkUI.Full 16456 * @crossplatform 16457 * @atomicservice 16458 * @since arkts {'1.1':'12','1.2':'20'} 16459 * @arkts 1.1&1.2 16460 */ 16461declare enum ScrollSizeMode { 16462 /** 16463 * Sheet change scroll size after the slide ends. 16464 * 16465 * @syscap SystemCapability.ArkUI.ArkUI.Full 16466 * @crossplatform 16467 * @atomicservice 16468 * @since arkts {'1.1':'12','1.2':'20'} 16469 * @arkts 1.1&1.2 16470 */ 16471 FOLLOW_DETENT = 0, 16472 16473 /** 16474 * Sheet change scroll size during the sliding process. 16475 * 16476 * @syscap SystemCapability.ArkUI.ArkUI.Full 16477 * @crossplatform 16478 * @atomicservice 16479 * @since arkts {'1.1':'12','1.2':'20'} 16480 * @arkts 1.1&1.2 16481 */ 16482 CONTINUOUS = 1, 16483} 16484 16485/** 16486 * Define the mode of sheet how to avoid keyboard. 16487 * 16488 * @enum { number } 16489 * @syscap SystemCapability.ArkUI.ArkUI.Full 16490 * @crossplatform 16491 * @atomicservice 16492 * @since arkts {'1.1':'13','1.2':'20'} 16493 * @arkts 1.1&1.2 16494 */ 16495declare enum SheetKeyboardAvoidMode { 16496 /** 16497 * Sheet will not aovid keyboard. 16498 * 16499 * @syscap SystemCapability.ArkUI.ArkUI.Full 16500 * @crossplatform 16501 * @atomicservice 16502 * @since arkts {'1.1':'13','1.2':'20'} 16503 * @arkts 1.1&1.2 16504 */ 16505 NONE = 0, 16506 16507 /** 16508 * Firstly sheet will avoid keyboard by changing its height. 16509 * And then sheet will avoid by resizing after reaching its maximum height. 16510 * 16511 * @syscap SystemCapability.ArkUI.ArkUI.Full 16512 * @crossplatform 16513 * @atomicservice 16514 * @since arkts {'1.1':'13','1.2':'20'} 16515 * @arkts 1.1&1.2 16516 */ 16517 TRANSLATE_AND_RESIZE = 1, 16518 16519 /** 16520 * Sheet will only avoid keyboard by resizing the content. 16521 * 16522 * @syscap SystemCapability.ArkUI.ArkUI.Full 16523 * @crossplatform 16524 * @atomicservice 16525 * @since arkts {'1.1':'13','1.2':'20'} 16526 * @arkts 1.1&1.2 16527 */ 16528 RESIZE_ONLY = 2, 16529 16530 /** 16531 * Firstly sheet will avoid keyboard by changing its height. 16532 * And then sheet will avoid keyboard by scrolling after reaching its maximum height. 16533 * 16534 * @syscap SystemCapability.ArkUI.ArkUI.Full 16535 * @crossplatform 16536 * @atomicservice 16537 * @since arkts {'1.1':'13','1.2':'20'} 16538 * @arkts 1.1&1.2 16539 */ 16540 TRANSLATE_AND_SCROLL = 3, 16541 16542 /** 16543 * Popup sheet will avoid keyboard by default. 16544 * 16545 * @syscap SystemCapability.ArkUI.ArkUI.Full 16546 * @crossplatform 16547 * @atomicservice 16548 * @since 20 16549 */ 16550 POPUP_SHEET = 4, 16551} 16552 16553/** 16554 * Component sheet dismiss 16555 * 16556 * @interface SheetDismiss 16557 * @syscap SystemCapability.ArkUI.ArkUI.Full 16558 * @crossplatform 16559 * @since 11 16560 */ 16561/** 16562 * Component sheet dismiss 16563 * 16564 * @interface SheetDismiss 16565 * @syscap SystemCapability.ArkUI.ArkUI.Full 16566 * @crossplatform 16567 * @atomicservice 16568 * @since 12 16569 */ 16570declare interface SheetDismiss { 16571 /** 16572 * Defines sheet dismiss function 16573 * 16574 * @type { function } 16575 * @syscap SystemCapability.ArkUI.ArkUI.Full 16576 * @crossplatform 16577 * @since 11 16578 */ 16579 /** 16580 * Defines sheet dismiss function 16581 * 16582 * @type { function } 16583 * @syscap SystemCapability.ArkUI.ArkUI.Full 16584 * @crossplatform 16585 * @atomicservice 16586 * @since 12 16587 */ 16588 dismiss: () => void; 16589} 16590 16591/** 16592 * Component sheet dismiss 16593 * 16594 * @interface SheetDismiss 16595 * @syscap SystemCapability.ArkUI.ArkUI.Full 16596 * @crossplatform 16597 * @atomicservice 16598 * @since 20 16599 * @arkts 1.2 16600 */ 16601declare interface SheetDismiss { 16602 /** 16603 * Defines sheet dismiss function 16604 * 16605 * @type { VoidCallback } 16606 * @syscap SystemCapability.ArkUI.ArkUI.Full 16607 * @crossplatform 16608 * @atomicservice 16609 * @since 20 16610 * @arkts 1.2 16611 */ 16612 dismiss: VoidCallback; 16613} 16614 16615/** 16616 * Component sheet dismiss 16617 * 16618 * @interface DismissSheetAction 16619 * @syscap SystemCapability.ArkUI.ArkUI.Full 16620 * @crossplatform 16621 * @atomicservice 16622 * @since 12 16623 */ 16624declare interface DismissSheetAction { 16625 16626 /** 16627 * Defines sheet dismiss function 16628 * 16629 * @type { Callback<void> } 16630 * @syscap SystemCapability.ArkUI.ArkUI.Full 16631 * @crossplatform 16632 * @atomicservice 16633 * @since 12 16634 */ 16635 dismiss: Callback<void>; 16636 16637 /** 16638 * Dismiss reason type. 16639 * 16640 * @type { DismissReason } 16641 * @syscap SystemCapability.ArkUI.ArkUI.Full 16642 * @crossplatform 16643 * @atomicservice 16644 * @since 12 16645 */ 16646 reason: DismissReason; 16647} 16648 16649/** 16650 * Component sheet dismiss 16651 * 16652 * @interface DismissSheetAction 16653 * @syscap SystemCapability.ArkUI.ArkUI.Full 16654 * @crossplatform 16655 * @atomicservice 16656 * @since 20 16657 * @arkts 1.2 16658 */ 16659declare interface DismissSheetAction { 16660 16661 /** 16662 * Defines sheet dismiss function 16663 * 16664 * @type { VoidCallback } 16665 * @syscap SystemCapability.ArkUI.ArkUI.Full 16666 * @crossplatform 16667 * @atomicservice 16668 * @since 20 16669 * @arkts 1.2 16670 */ 16671 dismiss: VoidCallback; 16672 16673 /** 16674 * Dismiss reason type. 16675 * 16676 * @type { DismissReason } 16677 * @syscap SystemCapability.ArkUI.ArkUI.Full 16678 * @crossplatform 16679 * @atomicservice 16680 * @since 20 16681 * @arkts 1.2 16682 */ 16683 reason: DismissReason; 16684} 16685 16686/** 16687 * Defines sheet spring back action 16688 * 16689 * @interface SpringBackAction 16690 * @syscap SystemCapability.ArkUI.ArkUI.Full 16691 * @crossplatform 16692 * @atomicservice 16693 * @since 12 16694 */ 16695declare interface SpringBackAction { 16696 /** 16697 * Defines spring back function 16698 * 16699 * @type { Callback<void> } 16700 * @syscap SystemCapability.ArkUI.ArkUI.Full 16701 * @crossplatform 16702 * @atomicservice 16703 * @since 12 16704 */ 16705 springBack: Callback<void>; 16706} 16707 16708/** 16709 * Defines sheet spring back action 16710 * 16711 * @interface SpringBackAction 16712 * @syscap SystemCapability.ArkUI.ArkUI.Full 16713 * @crossplatform 16714 * @atomicservice 16715 * @since 20 16716 * @arkts 1.2 16717 */ 16718declare interface SpringBackAction { 16719 /** 16720 * Defines spring back function 16721 * 16722 * @type { VoidCallback } 16723 * @syscap SystemCapability.ArkUI.ArkUI.Full 16724 * @crossplatform 16725 * @atomicservice 16726 * @since 20 16727 * @arkts 1.2 16728 */ 16729 springBack: VoidCallback; 16730} 16731 16732 16733/** 16734 * Defines the detent array of a single length. 16735 * 16736 * @typedef { [SheetSize | Length] } SingleLengthDetent 16737 * @syscap SystemCapability.ArkUI.ArkUI.Full 16738 * @crossplatform 16739 * @atomicservice 16740 * @since 20 16741 * @arkts 1.2 16742 */ 16743declare type SingleLengthDetent = [SheetSize | Length]; 16744 16745/** 16746 * Defines the detent array of a two-length. 16747 * 16748 * @typedef { [(SheetSize | Length), SheetSize | Length | undefined] } DoubleLengthDetents 16749 * @syscap SystemCapability.ArkUI.ArkUI.Full 16750 * @crossplatform 16751 * @atomicservice 16752 * @since 20 16753 * @arkts 1.2 16754 */ 16755declare type DoubleLengthDetents = [(SheetSize | Length), SheetSize | Length | undefined]; 16756 16757/** 16758 * Defines the detent array of a three-length. 16759 * 16760 * @typedef { [(SheetSize | Length), SheetSize | Length | undefined, SheetSize | Length | undefined] } TripleLengthDetents 16761 * @syscap SystemCapability.ArkUI.ArkUI.Full 16762 * @crossplatform 16763 * @atomicservice 16764 * @since 20 16765 * @arkts 1.2 16766 */ 16767declare type TripleLengthDetents = [(SheetSize | Length), SheetSize | Length | undefined, SheetSize | Length | undefined]; 16768 16769/** 16770 * Component sheet options 16771 * 16772 * @extends BindOptions 16773 * @interface SheetOptions 16774 * @syscap SystemCapability.ArkUI.ArkUI.Full 16775 * @crossplatform 16776 * @since 10 16777 */ 16778/** 16779 * Component sheet options 16780 * 16781 * @extends BindOptions 16782 * @interface SheetOptions 16783 * @syscap SystemCapability.ArkUI.ArkUI.Full 16784 * @crossplatform 16785 * @atomicservice 16786 * @since arkts {'1.1':'11','1.2':'20'} 16787 * @arkts 1.1&1.2 16788 */ 16789declare interface SheetOptions extends BindOptions { 16790 /** 16791 * Defines sheet height 16792 * 16793 * @type { ?(SheetSize | Length) } 16794 * @default SheetSize.LARGE 16795 * @syscap SystemCapability.ArkUI.ArkUI.Full 16796 * @crossplatform 16797 * @since 10 16798 */ 16799 /** 16800 * Defines sheet height 16801 * 16802 * @type { ?(SheetSize | Length) } 16803 * @default SheetSize.LARGE 16804 * @syscap SystemCapability.ArkUI.ArkUI.Full 16805 * @crossplatform 16806 * @atomicservice 16807 * @since arkts {'1.1':'11','1.2':'20'} 16808 * @arkts 1.1&1.2 16809 */ 16810 height?: SheetSize | Length; 16811 16812 /** 16813 * Whether to display the drag bar. 16814 * <br>**NOTE**<br>By default, the drag bar is displayed only when the sheet's 16815 * **detents** attribute is set to multiple heights and the settings take effect. 16816 * 16817 * @type { ?boolean } 16818 * @default true 16819 * @syscap SystemCapability.ArkUI.ArkUI.Full 16820 * @crossplatform 16821 * @since 10 16822 */ 16823 /** 16824 * Whether to display the drag bar. 16825 * <br>**NOTE**<br>By default, the drag bar is displayed only when the sheet's 16826 * **detents** attribute is set to multiple heights and the settings take effect. 16827 * 16828 * @type { ?boolean } 16829 * @default true 16830 * @syscap SystemCapability.ArkUI.ArkUI.Full 16831 * @crossplatform 16832 * @atomicservice 16833 * @since arkts {'1.1':'11','1.2':'20'} 16834 * @arkts 1.1&1.2 16835 */ 16836 dragBar?: boolean; 16837 16838 /** 16839 * Defines whether the sheet dragbar is floating, when it's displayed. 16840 * 16841 * @type { ?boolean } 16842 * @default false 16843 * @syscap SystemCapability.ArkUI.ArkUI.Full 16844 * @crossplatform 16845 * @atomicservice 16846 * @since 20 16847 */ 16848 enableFloatingDragBar?: boolean; 16849 16850 /** 16851 * Defines transition type when preferType is SheetType.CONTENT_COVER. 16852 * 16853 * @type { ?ModalTransition } 16854 * @default ModalTransition.DEFAULT 16855 * @syscap SystemCapability.ArkUI.ArkUI.Full 16856 * @crossplatform 16857 * @atomicservice 16858 * @since 20 16859 */ 16860 modalTransition?: ModalTransition; 16861 16862 /** 16863 * Mask color of the sheet. 16864 * 16865 * @type { ?ResourceColor } 16866 * @syscap SystemCapability.ArkUI.ArkUI.Full 16867 * @crossplatform 16868 * @since 10 16869 */ 16870 /** 16871 * Mask color of the sheet. 16872 * 16873 * @type { ?ResourceColor } 16874 * @syscap SystemCapability.ArkUI.ArkUI.Full 16875 * @crossplatform 16876 * @atomicservice 16877 * @since arkts {'1.1':'11','1.2':'20'} 16878 * @arkts 1.1&1.2 16879 */ 16880 maskColor?: ResourceColor; 16881 16882 /** 16883 * Defines sheet detents 16884 * @type { ?[(SheetSize | Length), (SheetSize | Length)?, (SheetSize | Length)?] } 16885 * @syscap SystemCapability.ArkUI.ArkUI.Full 16886 * @crossplatform 16887 * @since 11 16888 */ 16889 /** 16890 * Array of heights where the sheet can rest. 16891 * <p>**NOTE**: 16892 * <br>Since API version 12, this attribute takes effect for a bottom sheet in landscape mode. 16893 * <br>In earlier versions, this attribute takes effect only for the bottom sheet in portrait mode. 16894 * <br>The first height in the tuple is the initial height. 16895 * <br>The sheet can switch between heights by dragging. 16896 * <br>After the sheet is dragged and released, it switches to the target height or remains at the current height, 16897 * depending on the velocity and distance. 16898 * <br>If the velocity exceeds the threshold, the sheet switches to the target height in the same direction as the 16899 * velocity. 16900 * <br>If the velocity is less than the threshold, the displacement distance is used for judgement. 16901 * <br>If the displacement distance is greater than 1/2 of the distance between the current and target positions, 16902 * the sheet switches to the target height in the same direction as the velocity; otherwise, the sheet remains at the 16903 * current height. 16904 * <br>Velocity threshold: 1000; Distance threshold: 50%. 16905 * </p> 16906 * 16907 * @type { ?[(SheetSize | Length), (SheetSize | Length)?, (SheetSize | Length)?] } 16908 * @syscap SystemCapability.ArkUI.ArkUI.Full 16909 * @crossplatform 16910 * @atomicservice 16911 * @since 12 16912 */ 16913 detents?: [(SheetSize | Length), (SheetSize | Length)?, (SheetSize | Length)?]; 16914 16915 /** 16916 * Defines sheet detents 16917 * 16918 * @type { ?(SingleLengthDetent | DoubleLengthDetents | TripleLengthDetents) } 16919 * @syscap SystemCapability.ArkUI.ArkUI.Full 16920 * @crossplatform 16921 * @atomicservice 16922 * @since 20 16923 * @arkts 1.2 16924 */ 16925 detents?: SingleLengthDetent | DoubleLengthDetents | TripleLengthDetents; 16926 16927 /** 16928 * Background blur of the sheet. By default, there is no background blur. 16929 * 16930 * @type { ?BlurStyle } 16931 * @default BlurStyle.NONE 16932 * @syscap SystemCapability.ArkUI.ArkUI.Full 16933 * @crossplatform 16934 * @since 11 16935 */ 16936 /** 16937 * Background blur of the sheet. By default, there is no background blur. 16938 * 16939 * @type { ?BlurStyle } 16940 * @default BlurStyle.NONE 16941 * @syscap SystemCapability.ArkUI.ArkUI.Full 16942 * @crossplatform 16943 * @atomicservice 16944 * @since arkts {'1.1':'12','1.2':'20'} 16945 * @arkts 1.1&1.2 16946 */ 16947 blurStyle?: BlurStyle; 16948 16949 /** 16950 * Defines whether the close icon is displayed 16951 * 16952 * @type { ?(boolean | Resource) } 16953 * @default true 16954 * @syscap SystemCapability.ArkUI.ArkUI.Full 16955 * @crossplatform 16956 * @since 11 16957 */ 16958 /** 16959 * Defines whether the close icon is displayed 16960 * 16961 * @type { ?(boolean | Resource) } 16962 * @default true 16963 * @syscap SystemCapability.ArkUI.ArkUI.Full 16964 * @crossplatform 16965 * @atomicservice 16966 * @since arkts {'1.1':'12','1.2':'20'} 16967 * @arkts 1.1&1.2 16968 */ 16969 showClose?: boolean | Resource; 16970 16971 /** 16972 * Type of the sheet. 16973 * <br>**NOTE**<br>The types supported by the sheet vary by window. 16974 * <br>1. Width < 600 vp: bottom. 16975 * <br>2. 600 vp <= Width: bottom, center, and popup (default). 16976 * <br>3. Width >= 840 vp: bottom, center, and popup (default). 16977 * 16978 * @type { ?(SheetType.CENTER | SheetType.POPUP) } 16979 * @syscap SystemCapability.ArkUI.ArkUI.Full 16980 * @crossplatform 16981 * @since 11 16982 */ 16983 /** 16984 * Type of the sheet. 16985 * <br>**NOTE**<br>The types supported by the sheet vary by window. 16986 * <br>1. Width < 600 vp: bottom. 16987 * <br>2. 600 vp <= Width: bottom, center, and popup (default). 16988 * <br>3. Width >= 840 vp: bottom, center, and popup (default). 16989 * 16990 * @type { ?SheetType } 16991 * @syscap SystemCapability.ArkUI.ArkUI.Full 16992 * @crossplatform 16993 * @atomicservice 16994 * @since arkts {'1.1':'12','1.2':'20'} 16995 * @arkts 1.1&1.2 16996 */ 16997 preferType?: SheetType; 16998 16999 /** 17000 * Title of the sheet. 17001 * 17002 * @type { ?(SheetTitleOptions | CustomBuilder) } 17003 * @syscap SystemCapability.ArkUI.ArkUI.Full 17004 * @crossplatform 17005 * @since 11 17006 */ 17007 /** 17008 * Title of the sheet. 17009 * 17010 * @type { ?(SheetTitleOptions | CustomBuilder) } 17011 * @syscap SystemCapability.ArkUI.ArkUI.Full 17012 * @crossplatform 17013 * @atomicservice 17014 * @since arkts {'1.1':'12','1.2':'20'} 17015 * @arkts 1.1&1.2 17016 */ 17017 title?: SheetTitleOptions | CustomBuilder; 17018 17019 /** 17020 * Callback invoked when the user performs an interactive dismiss operation: pulling down or clicking 17021 * the back button, the mask, or the close icon.<br>**NOTE**<br>If this callback is registered, the 17022 * sheet is not dismissed immediately when the user performs the above operations. To dismiss the sheet, 17023 * you must call **shouldDismiss.dismiss()** in the callback.<br>If this callback is not registered, the 17024 * sheet is dismissed immediately when the user performs the above operations, without any additional 17025 * behavior.<br>It is recommended that this API be used in scenarios where a secondary confirmation is required. 17026 * 17027 * @type { ?function } 17028 * @syscap SystemCapability.ArkUI.ArkUI.Full 17029 * @crossplatform 17030 * @since 11 17031 */ 17032 /** 17033 * Callback invoked when the user performs an interactive dismiss operation: pulling down or clicking 17034 * the back button, the mask, or the close icon.<br>**NOTE**<br>If this callback is registered, the 17035 * sheet is not dismissed immediately when the user performs the above operations. To dismiss the sheet, 17036 * you must call **shouldDismiss.dismiss()** in the callback.<br>If this callback is not registered, the 17037 * sheet is dismissed immediately when the user performs the above operations, without any additional 17038 * behavior.<br>It is recommended that this API be used in scenarios where a secondary confirmation is required. 17039 * 17040 * @type { ?function } 17041 * @syscap SystemCapability.ArkUI.ArkUI.Full 17042 * @crossplatform 17043 * @atomicservice 17044 * @since arkts {'1.1':'12','1.2':'20'} 17045 * @arkts 1.1&1.2 17046 */ 17047 shouldDismiss?: (sheetDismiss: SheetDismiss) => void; 17048 17049 /** 17050 * Callback invoked when the user performs an interactive dismiss operation: 17051 * pulling down or clicking the back button, the mask, or the close icon, 17052 * to obtain the type of dismiss operation and decide whether to dismiss the sheet. 17053 * <p>**NOTE**: 17054 * <br>If this callback is registered, the sheet is not dismissed immediately when the user performs the above 17055 * operations. 17056 * <br>Instead, you can use the DismissSheetAction parameter in the callback to determine the type of 17057 * dismiss operation and decide whether to dismiss the sheet. 17058 * <br>If this callback is not registered, the sheet is dismissed immediately when the user performs the above 17059 * operations, without any additional behavior. 17060 * <br>No further interception with onWillDismiss is allowed in an onWillDismiss callback. 17061 * </p> 17062 * 17063 * @type { ?Callback<DismissSheetAction> } 17064 * @syscap SystemCapability.ArkUI.ArkUI.Full 17065 * @crossplatform 17066 * @atomicservice 17067 * @since arkts {'1.1':'12','1.2':'20'} 17068 * @arkts 1.1&1.2 17069 */ 17070 onWillDismiss?: Callback<DismissSheetAction>; 17071 17072 /** 17073 * Callback invoked when the user performs a pull-down-to-dismiss gesture, to control the bounce effect. 17074 * <p>**NOTE**: 17075 * <br>If this callback is registered along with **shouldDismiss** or **onWillDismiss** you can control whether the 17076 * sheet bounces back during the pull-down-to-dismiss operation by calling **springBack** in the callback. 17077 * <br>If this callback is not registered but **shouldDismiss** or **onWillDismiss** is registered, the sheet will 17078 * bounce back before remaining open or being dismissed based on the callback behavior. 17079 * <br>If neither this callback nor **shouldDismiss** or **onWillDismiss** is registered, the sheet is dismissed by 17080 * default during the pull-down-to-dismiss operation. 17081 * </p> 17082 * 17083 * @type { ?Callback<SpringBackAction> } 17084 * @syscap SystemCapability.ArkUI.ArkUI.Full 17085 * @crossplatform 17086 * @atomicservice 17087 * @since arkts {'1.1':'12','1.2':'20'} 17088 * @arkts 1.1&1.2 17089 */ 17090 onWillSpringBackWhenDismiss?: Callback<SpringBackAction>; 17091 17092 /** 17093 * Whether to allow users to interact with the page pertaining to the sheet. 17094 * <br>**NOTE**<br>The value **true** means that interactions are allowed, in which 17095 * case no mask is not displayed. The value **false** means that interactions are not 17096 * allowed, in which case a mask is displayed. If this parameter is not set, interactions 17097 * are allowed for the popup sheet, but not for bottom and center sheets. If this parameter 17098 * is set to **true**, the setting of **maskColor** does not take effect. 17099 * 17100 * @type { ?boolean } 17101 * @default false 17102 * @syscap SystemCapability.ArkUI.ArkUI.Full 17103 * @crossplatform 17104 * @since 11 17105 */ 17106 /** 17107 * Whether to allow users to interact with the page pertaining to the sheet. 17108 * <br>**NOTE**<br>The value **true** means that interactions are allowed, in which 17109 * case no mask is not displayed. The value **false** means that interactions are not 17110 * allowed, in which case a mask is displayed. If this parameter is not set, interactions 17111 * are allowed for the popup sheet, but not for bottom and center sheets. If this parameter 17112 * is set to **true**, the setting of **maskColor** does not take effect. 17113 * 17114 * @type { ?boolean } 17115 * @default false 17116 * @syscap SystemCapability.ArkUI.ArkUI.Full 17117 * @crossplatform 17118 * @atomicservice 17119 * @since arkts {'1.1':'12','1.2':'20'} 17120 * @arkts 1.1&1.2 17121 */ 17122 enableOutsideInteractive?: boolean; 17123 17124 /** 17125 * Width of the sheet. 17126 * Percentage parameter method: Set the width of the sheet as a percentage of the width of the parent element. 17127 * 17128 * @type { ?Dimension } 17129 * @syscap SystemCapability.ArkUI.ArkUI.Full 17130 * @crossplatform 17131 * @atomicservice 17132 * @since arkts {'1.1':'12','1.2':'20'} 17133 * @arkts 1.1&1.2 17134 */ 17135 width?: Dimension; 17136 17137 /** 17138 * Border width of the sheet. 17139 * You can set the width for all four sides or set separate widths for individual sides. 17140 * Default value: **0**. 17141 * Percentage parameter method: 17142 * Set the border width of the sheet as a percentage of the width of the parent element. 17143 * If the left and right border widths of the sheet are greater than the width of the sheet, and the top 17144 * and bottom border widths are greater than the height of the sheet, the display may not appear as expected. 17145 * <p>**Note**: 17146 * <br>For bottom sheets, the bottom border width setting is ineffective. 17147 * </p> 17148 * 17149 * @type { ?(Dimension | EdgeWidths | LocalizedEdgeWidths) } 17150 * @syscap SystemCapability.ArkUI.ArkUI.Full 17151 * @crossplatform 17152 * @atomicservice 17153 * @since arkts {'1.1':'12','1.2':'20'} 17154 * @arkts 1.1&1.2 17155 */ 17156 borderWidth?: Dimension | EdgeWidths | LocalizedEdgeWidths; 17157 17158 /** 17159 * Border color of the sheet. 17160 * **borderColor** must be used with **borderWidth** in pairs. 17161 * <p>**NOTE**: 17162 * <br>For bottom sheets, the bottom border color setting is ineffective. 17163 * </p> 17164 * 17165 * @type { ?(ResourceColor | EdgeColors | LocalizedEdgeColors) } 17166 * @default Color.Black 17167 * @syscap SystemCapability.ArkUI.ArkUI.Full 17168 * @crossplatform 17169 * @atomicservice 17170 * @since arkts {'1.1':'12','1.2':'20'} 17171 * @arkts 1.1&1.2 17172 */ 17173 borderColor?: ResourceColor | EdgeColors | LocalizedEdgeColors; 17174 17175 /** 17176 * Defines the sheet's border style. 17177 * 17178 * @type { ?(BorderStyle | EdgeStyles) } 17179 * @syscap SystemCapability.ArkUI.ArkUI.Full 17180 * @crossplatform 17181 * @atomicservice 17182 * @since arkts {'1.1':'12','1.2':'20'} 17183 * @arkts 1.1&1.2 17184 */ 17185 borderStyle?: BorderStyle | EdgeStyles; 17186 17187 /** 17188 * Shadow of the sheet. 17189 * Default value for 2-in-1 devices: **ShadowStyle.OUTER_FLOATING_SM**. 17190 * 17191 * @type { ?(ShadowOptions | ShadowStyle) } 17192 * @syscap SystemCapability.ArkUI.ArkUI.Full 17193 * @crossplatform 17194 * @atomicservice 17195 * @since arkts {'1.1':'12','1.2':'20'} 17196 * @arkts 1.1&1.2 17197 */ 17198 shadow?: ShadowOptions | ShadowStyle; 17199 17200 /** 17201 * Callback for changes in the height of the sheet. 17202 * <p>**Note**: 17203 * <br>For a bottom sheet, the height of each frame is only returned when there are changes in detents or during drag 17204 * actions. 17205 * <br>When the sheet is pulled up or making space for the soft keyboard, only the final height is returned. 17206 * <br>For other types of sheets, the final height is only returned when the sheet is pulled up. 17207 * <br>The return value is in px. 17208 * <p> 17209 * 17210 * @type { ?Callback<number> } 17211 * @syscap SystemCapability.ArkUI.ArkUI.Full 17212 * @crossplatform 17213 * @atomicservice 17214 * @since arkts {'1.1':'12','1.2':'20'} 17215 * @arkts 1.1&1.2 17216 */ 17217 onHeightDidChange?: Callback<number>; 17218 17219 /** 17220 * Determine the level sheet shows, whether sheet should be displayed within the page. 17221 * 17222 * @type { ?SheetMode } 17223 * @default SheetMode.OVERLAY 17224 * @syscap SystemCapability.ArkUI.ArkUI.Full 17225 * @crossplatform 17226 * @atomicservice 17227 * @since arkts {'1.1':'12','1.2':'20'} 17228 * @arkts 1.1&1.2 17229 */ 17230 mode?: SheetMode; 17231 17232 /** 17233 * Content update mode of the sheet when it is scrolled. 17234 * 17235 * @type { ?ScrollSizeMode } 17236 * @default ScrollSizeMode.FELLOW_DETEND 17237 * @syscap SystemCapability.ArkUI.ArkUI.Full 17238 * @crossplatform 17239 * @atomicservice 17240 * @since arkts {'1.1':'12','1.2':'20'} 17241 * @arkts 1.1&1.2 17242 */ 17243 scrollSizeMode?: ScrollSizeMode; 17244 17245 /** 17246 * Callback for changes in the detents of the sheet. 17247 * <p>**NOTE**: 17248 * <br>For a bottom sheet, the final height is returned when there are changes in detents. 17249 * <br>The return value is in px. 17250 * </p> 17251 * @type { ?Callback<number> } 17252 * @syscap SystemCapability.ArkUI.ArkUI.Full 17253 * @crossplatform 17254 * @atomicservice 17255 * @since arkts {'1.1':'12','1.2':'20'} 17256 * @arkts 1.1&1.2 17257 */ 17258 onDetentsDidChange?: Callback<number>; 17259 17260 /** 17261 * Called when width of the sheet changed 17262 * 17263 * @type { ?Callback<number> } 17264 * @syscap SystemCapability.ArkUI.ArkUI.Full 17265 * @crossplatform 17266 * @atomicservice 17267 * @since arkts {'1.1':'12','1.2':'20'} 17268 * @arkts 1.1&1.2 17269 */ 17270 onWidthDidChange?: Callback<number>; 17271 17272 /** 17273 * Called when the sheet type changed 17274 * 17275 * @type { ?Callback<SheetType> } 17276 * @syscap SystemCapability.ArkUI.ArkUI.Full 17277 * @crossplatform 17278 * @atomicservice 17279 * @since arkts {'1.1':'12','1.2':'20'} 17280 * @arkts 1.1&1.2 17281 */ 17282 onTypeDidChange?: Callback<SheetType>; 17283 17284 /** 17285 * The UIContext that the sheet belongs to 17286 * 17287 * @type { ?UIContext } 17288 * @syscap SystemCapability.ArkUI.ArkUI.Full 17289 * @crossplatform 17290 * @atomicservice 17291 * @since arkts {'1.1':'12','1.2':'20'} 17292 * @arkts 1.1&1.2 17293 */ 17294 uiContext?: UIContext; 17295 17296 /** 17297 * Determine the mode of sheet how to avoid keyboard. 17298 * 17299 * @type { ?SheetKeyboardAvoidMode } 17300 * @default SheetKeyboardAvoidMode.TRANSLATE_AND_SCROLL 17301 * @syscap SystemCapability.ArkUI.ArkUI.Full 17302 * @crossplatform 17303 * @atomicservice 17304 * @since arkts {'1.1':'13','1.2':'20'} 17305 * @arkts 1.1&1.2 17306 */ 17307 keyboardAvoidMode?: SheetKeyboardAvoidMode; 17308 17309 /** 17310 * Defines whether to respond to the hover mode. 17311 * 17312 * @type { ?boolean } 17313 * @default false 17314 * @syscap SystemCapability.ArkUI.ArkUI.Full 17315 * @crossplatform 17316 * @atomicservice 17317 * @since arkts {'1.1':'14','1.2':'20'} 17318 * @arkts 1.1&1.2 17319 */ 17320 enableHoverMode?: boolean; 17321 17322 /** 17323 * Defines the sheet's display area in hover mode. 17324 * 17325 * @type { ?HoverModeAreaType } 17326 * @default HoverModeAreaType.BOTTOM_SCREEN 17327 * @syscap SystemCapability.ArkUI.ArkUI.Full 17328 * @crossplatform 17329 * @atomicservice 17330 * @since arkts {'1.1':'14','1.2':'20'} 17331 * @arkts 1.1&1.2 17332 */ 17333 hoverModeArea?: HoverModeAreaType; 17334 17335 /** 17336 * Sets the position offset of the bindSheet. 17337 * 17338 * @type { ?Position } 17339 * @syscap SystemCapability.ArkUI.ArkUI.Full 17340 * @systemapi 17341 * @since arkts {'1.1':'14','1.2':'20'} 17342 * @arkts 1.1&1.2 17343 */ 17344 offset?: Position 17345 17346 /** 17347 * Sets whether the sheet edge has spring effect. 17348 * 17349 * @type { ?number } 17350 * @default 3 17351 * @syscap SystemCapability.ArkUI.ArkUI.Full 17352 * @crossplatform 17353 * @atomicservice 17354 * @since arkts {'1.1':'18','1.2':'20'} 17355 * @arkts 1.1&1.2 17356 */ 17357 effectEdge?: number 17358 17359 /** 17360 * Defines sheet radius 17361 * 17362 * @type { ?(LengthMetrics | BorderRadiuses | LocalizedBorderRadiuses) } 17363 * @syscap SystemCapability.ArkUI.ArkUI.Full 17364 * @crossplatform 17365 * @atomicservice 17366 * @since arkts {'1.1':'15','1.2':'20'} 17367 * @arkts 1.1&1.2 17368 */ 17369 radius?: LengthMetrics | BorderRadiuses | LocalizedBorderRadiuses; 17370 17371 /** 17372 * Select a detent from detents property 17373 * 17374 * @type { ?(SheetSize | Length) } 17375 * @default detents[0] 17376 * @syscap SystemCapability.ArkUI.ArkUI.Full 17377 * @crossplatform 17378 * @atomicservice 17379 * @since arkts {'1.1':'15','1.2':'20'} 17380 * @arkts 1.1&1.2 17381 */ 17382 detentSelection?: SheetSize | Length; 17383 17384 /** 17385 * Whether to display in the sub window 17386 * 17387 * @type { ?boolean } 17388 * @default false 17389 * @syscap SystemCapability.ArkUI.ArkUI.Full 17390 * @crossplatform 17391 * @atomicservice 17392 * @since arkts {'1.1':'19','1.2':'20'} 17393 * @arkts 1.1&1.2 17394 */ 17395 showInSubWindow?: boolean; 17396 17397 /** 17398 * The placement of popup sheet type. 17399 * Supports all positions defined in Placement. 17400 * 17401 * @type { ?Placement } 17402 * @default Placement.Bottom 17403 * @syscap SystemCapability.ArkUI.ArkUI.Full 17404 * @crossplatform 17405 * @atomicservice 17406 * @since arkts {'1.1':'18','1.2':'20'} 17407 * @arkts 1.1&1.2 17408 */ 17409 placement?: Placement; 17410 17411 /** 17412 * placement On target node 17413 * 17414 * @type { ?boolean } 17415 * @default true 17416 * @syscap SystemCapability.ArkUI.ArkUI.Full 17417 * @crossplatform 17418 * @atomicservice 17419 * @since arkts {'1.1':'18','1.2':'20'} 17420 * @arkts 1.1&1.2 17421 */ 17422 placementOnTarget?: boolean; 17423} 17424 17425/** 17426 * The custom styles function block. 17427 * 17428 * @typedef { function } CustomStyles 17429 * @param { CommonMethod } instance - The component instance which can be used to set common attributes. 17430 * @syscap SystemCapability.ArkUI.ArkUI.Full 17431 * @crossplatform 17432 * @atomicservice 17433 * @since 20 17434 * @arkts 1.2 17435 */ 17436declare type CustomStyles = (instance: CommonMethod) => void; 17437 17438/** 17439 * Component State Styles. 17440 * 17441 * @interface StateStyles 17442 * @syscap SystemCapability.ArkUI.ArkUI.Full 17443 * @since 8 17444 */ 17445/** 17446 * Component State Styles. 17447 * 17448 * @interface StateStyles 17449 * @syscap SystemCapability.ArkUI.ArkUI.Full 17450 * @form 17451 * @since 9 17452 */ 17453/** 17454 * Component State Styles. 17455 * 17456 * @interface StateStyles 17457 * @syscap SystemCapability.ArkUI.ArkUI.Full 17458 * @crossplatform 17459 * @form 17460 * @since 10 17461 */ 17462/** 17463 * Component State Styles. 17464 * 17465 * @interface StateStyles 17466 * @syscap SystemCapability.ArkUI.ArkUI.Full 17467 * @crossplatform 17468 * @form 17469 * @atomicservice 17470 * @since arkts {'1.1':'11','1.2':'20'} 17471 * @arkts 1.1&1.2 17472 */ 17473declare interface StateStyles { 17474 /** 17475 * Defines normal state styles. 17476 * 17477 * @type { ?any } 17478 * @syscap SystemCapability.ArkUI.ArkUI.Full 17479 * @since 8 17480 */ 17481 /** 17482 * Defines normal state styles. 17483 * 17484 * @type { ?any } 17485 * @syscap SystemCapability.ArkUI.ArkUI.Full 17486 * @form 17487 * @since 9 17488 */ 17489 /** 17490 * Defines normal state styles. 17491 * 17492 * @type { ?any } 17493 * @syscap SystemCapability.ArkUI.ArkUI.Full 17494 * @crossplatform 17495 * @form 17496 * @since 10 17497 */ 17498 /** 17499 * Defines normal state styles. 17500 * 17501 * @type { ?any } 17502 * @syscap SystemCapability.ArkUI.ArkUI.Full 17503 * @crossplatform 17504 * @form 17505 * @atomicservice 17506 * @since 11 17507 */ 17508 normal?: any; 17509 17510 17511 /** 17512 * Defines normal state styles. 17513 * 17514 * @type { ?CustomStyles } 17515 * @syscap SystemCapability.ArkUI.ArkUI.Full 17516 * @crossplatform 17517 * @form 17518 * @atomicservice 17519 * @since 20 17520 * @arkts 1.2 17521 */ 17522 normal?: CustomStyles; 17523 17524 /** 17525 * Defines pressed state styles. 17526 * 17527 * @type { ?any } 17528 * @syscap SystemCapability.ArkUI.ArkUI.Full 17529 * @since 8 17530 */ 17531 /** 17532 * Defines pressed state styles. 17533 * 17534 * @type { ?any } 17535 * @syscap SystemCapability.ArkUI.ArkUI.Full 17536 * @form 17537 * @since 9 17538 */ 17539 /** 17540 * Defines pressed state styles. 17541 * 17542 * @type { ?any } 17543 * @syscap SystemCapability.ArkUI.ArkUI.Full 17544 * @crossplatform 17545 * @form 17546 * @since 10 17547 */ 17548 /** 17549 * Defines pressed state styles. 17550 * 17551 * @type { ?any } 17552 * @syscap SystemCapability.ArkUI.ArkUI.Full 17553 * @crossplatform 17554 * @form 17555 * @atomicservice 17556 * @since 11 17557 */ 17558 pressed?: any; 17559 17560 /** 17561 * Defines pressed state styles. 17562 * 17563 * @type { ?CustomStyles } 17564 * @syscap SystemCapability.ArkUI.ArkUI.Full 17565 * @crossplatform 17566 * @form 17567 * @atomicservice 17568 * @since 20 17569 * @arkts 1.2 17570 */ 17571 pressed?: CustomStyles; 17572 17573 /** 17574 * Defines disabled state styles. 17575 * 17576 * @type { ?any } 17577 * @syscap SystemCapability.ArkUI.ArkUI.Full 17578 * @since 8 17579 */ 17580 /** 17581 * Defines disabled state styles. 17582 * 17583 * @type { ?any } 17584 * @syscap SystemCapability.ArkUI.ArkUI.Full 17585 * @form 17586 * @since 9 17587 */ 17588 /** 17589 * Defines disabled state styles. 17590 * 17591 * @type { ?any } 17592 * @syscap SystemCapability.ArkUI.ArkUI.Full 17593 * @crossplatform 17594 * @form 17595 * @since 10 17596 */ 17597 /** 17598 * Defines disabled state styles. 17599 * 17600 * @type { ?any } 17601 * @syscap SystemCapability.ArkUI.ArkUI.Full 17602 * @crossplatform 17603 * @form 17604 * @atomicservice 17605 * @since 11 17606 */ 17607 disabled?: any; 17608 17609 /** 17610 * Defines disabled state styles. 17611 * 17612 * @type { ?CustomStyles } 17613 * @syscap SystemCapability.ArkUI.ArkUI.Full 17614 * @crossplatform 17615 * @form 17616 * @atomicservice 17617 * @since 20 17618 * @arkts 1.2 17619 */ 17620 disabled?: CustomStyles; 17621 17622 /** 17623 * Defines focused state styles. 17624 * 17625 * @type { ?any } 17626 * @syscap SystemCapability.ArkUI.ArkUI.Full 17627 * @since 8 17628 */ 17629 /** 17630 * Defines focused state styles. 17631 * 17632 * @type { ?any } 17633 * @syscap SystemCapability.ArkUI.ArkUI.Full 17634 * @form 17635 * @since 9 17636 */ 17637 /** 17638 * Defines focused state styles. 17639 * 17640 * @type { ?any } 17641 * @syscap SystemCapability.ArkUI.ArkUI.Full 17642 * @crossplatform 17643 * @form 17644 * @since 10 17645 */ 17646 /** 17647 * Defines focused state styles. 17648 * 17649 * @type { ?any } 17650 * @syscap SystemCapability.ArkUI.ArkUI.Full 17651 * @crossplatform 17652 * @form 17653 * @atomicservice 17654 * @since 11 17655 */ 17656 focused?: any; 17657 17658 /** 17659 * Defines focused state styles. 17660 * 17661 * @type { ?CustomStyles } 17662 * @syscap SystemCapability.ArkUI.ArkUI.Full 17663 * @crossplatform 17664 * @form 17665 * @atomicservice 17666 * @since 20 17667 * @arkts 1.2 17668 */ 17669 focused?: CustomStyles; 17670 17671 /** 17672 * Defines clicked state styles. 17673 * 17674 * @type { ?any } 17675 * @syscap SystemCapability.ArkUI.ArkUI.Full 17676 * @since 8 17677 */ 17678 /** 17679 * Defines clicked state styles. 17680 * 17681 * @type { ?any } 17682 * @syscap SystemCapability.ArkUI.ArkUI.Full 17683 * @form 17684 * @since 9 17685 */ 17686 /** 17687 * Defines clicked state styles. 17688 * 17689 * @type { ?any } 17690 * @syscap SystemCapability.ArkUI.ArkUI.Full 17691 * @crossplatform 17692 * @form 17693 * @since 10 17694 */ 17695 /** 17696 * Defines clicked state styles. 17697 * 17698 * @type { ?any } 17699 * @syscap SystemCapability.ArkUI.ArkUI.Full 17700 * @crossplatform 17701 * @form 17702 * @atomicservice 17703 * @since 11 17704 */ 17705 clicked?: any; 17706 17707 /** 17708 * Defines clicked state styles. 17709 * 17710 * @type { ?CustomStyles } 17711 * @syscap SystemCapability.ArkUI.ArkUI.Full 17712 * @crossplatform 17713 * @form 17714 * @atomicservice 17715 * @since 20 17716 * @arkts 1.2 17717 */ 17718 clicked?: CustomStyles; 17719 17720 /** 17721 * Defines selected state styles. 17722 * 17723 * @type { ?object } 17724 * @syscap SystemCapability.ArkUI.ArkUI.Full 17725 * @crossplatform 17726 * @form 17727 * @since 10 17728 */ 17729 /** 17730 * Defines selected state styles. 17731 * 17732 * @type { ?object } 17733 * @syscap SystemCapability.ArkUI.ArkUI.Full 17734 * @crossplatform 17735 * @form 17736 * @atomicservice 17737 * @since 11 17738 */ 17739 selected?: object; 17740 17741 /** 17742 * Defines selected state styles. 17743 * 17744 * @type { ?CustomStyles } 17745 * @syscap SystemCapability.ArkUI.ArkUI.Full 17746 * @crossplatform 17747 * @form 17748 * @atomicservice 17749 * @since 20 17750 * @arkts 1.2 17751 */ 17752 selected?: CustomStyles; 17753 17754} 17755 17756/** 17757 * Defines the options of popup message. 17758 * 17759 * @interface PopupMessageOptions 17760 * @syscap SystemCapability.ArkUI.ArkUI.Full 17761 * @crossplatform 17762 * @since 10 17763 */ 17764/** 17765 * Defines the options of popup message. 17766 * 17767 * @interface PopupMessageOptions 17768 * @syscap SystemCapability.ArkUI.ArkUI.Full 17769 * @crossplatform 17770 * @atomicservice 17771 * @since arkts {'1.1':'11','1.2':'20'} 17772 * @arkts 1.1&1.2 17773 */ 17774declare interface PopupMessageOptions { 17775 /** 17776 * Sets the color of popup text. 17777 * 17778 * @type { ?ResourceColor } 17779 * @syscap SystemCapability.ArkUI.ArkUI.Full 17780 * @crossplatform 17781 * @since 10 17782 */ 17783 /** 17784 * Sets the color of popup text. 17785 * 17786 * @type { ?ResourceColor } 17787 * @syscap SystemCapability.ArkUI.ArkUI.Full 17788 * @crossplatform 17789 * @atomicservice 17790 * @since arkts {'1.1':'11','1.2':'20'} 17791 * @arkts 1.1&1.2 17792 */ 17793 textColor?: ResourceColor; 17794 17795 /** 17796 * Sets the font of popup text. 17797 * 17798 * @type { ?Font } 17799 * @syscap SystemCapability.ArkUI.ArkUI.Full 17800 * @crossplatform 17801 * @since 10 17802 */ 17803 /** 17804 * Sets the font of popup text. 17805 * 17806 * @type { ?Font } 17807 * @syscap SystemCapability.ArkUI.ArkUI.Full 17808 * @crossplatform 17809 * @atomicservice 17810 * @since arkts {'1.1':'11','1.2':'20'} 17811 * @arkts 1.1&1.2 17812 */ 17813 font?: Font; 17814} 17815 17816/** 17817 * Dismiss reason type. 17818 * 17819 * @enum { number } 17820 * @syscap SystemCapability.ArkUI.ArkUI.Full 17821 * @crossplatform 17822 * @atomicservice 17823 * @since arkts {'1.1':'12','1.2':'20'} 17824 * @arkts 1.1&1.2 17825 */ 17826declare enum DismissReason { 17827 /** 17828 * Touching the Back button, swiping left or right on the screen, or pressing the Esc key. 17829 * 17830 * @syscap SystemCapability.ArkUI.ArkUI.Full 17831 * @crossplatform 17832 * @atomicservice 17833 * @since arkts {'1.1':'12','1.2':'20'} 17834 * @arkts 1.1&1.2 17835 */ 17836 PRESS_BACK = 0, 17837 17838 /** 17839 * Touching the mask. 17840 * 17841 * @syscap SystemCapability.ArkUI.ArkUI.Full 17842 * @crossplatform 17843 * @atomicservice 17844 * @since arkts {'1.1':'12','1.2':'20'} 17845 * @arkts 1.1&1.2 17846 */ 17847 TOUCH_OUTSIDE = 1, 17848 17849 /** 17850 * Touching the Close button. 17851 * 17852 * @syscap SystemCapability.ArkUI.ArkUI.Full 17853 * @crossplatform 17854 * @atomicservice 17855 * @since arkts {'1.1':'12','1.2':'20'} 17856 * @arkts 1.1&1.2 17857 */ 17858 CLOSE_BUTTON = 2, 17859 17860 /** 17861 * Slide down 17862 * <p><strong>NOTE</strong>: 17863 * <br>This API is effective only in sheet transition. 17864 * </p> 17865 * 17866 * @syscap SystemCapability.ArkUI.ArkUI.Full 17867 * @crossplatform 17868 * @atomicservice 17869 * @since arkts {'1.1':'12','1.2':'20'} 17870 * @arkts 1.1&1.2 17871 */ 17872 SLIDE_DOWN = 3, 17873 17874 /** 17875 * Slide, not slide down. 17876 * Default means slide right, after mirroring it means slide left. 17877 * Choosing to slide left or slide right is not supported. 17878 * 17879 * @syscap SystemCapability.ArkUI.ArkUI.Full 17880 * @crossplatform 17881 * @atomicservice 17882 * @since 20 17883 */ 17884 SLIDE = 4, 17885} 17886 17887/** 17888 * Component popup dismiss 17889 * 17890 * @interface DismissPopupAction 17891 * @syscap SystemCapability.ArkUI.ArkUI.Full 17892 * @crossplatform 17893 * @atomicservice 17894 * @since arkts {'1.1':'12','1.2':'20'} 17895 * @arkts 1.1&1.2 17896 */ 17897declare interface DismissPopupAction { 17898 /** 17899 * Defines popup dismiss function 17900 * 17901 * @type { Callback<void> } 17902 * @syscap SystemCapability.ArkUI.ArkUI.Full 17903 * @crossplatform 17904 * @atomicservice 17905 * @since arkts {'1.1':'12','1.2':'20'} 17906 * @arkts 1.1&1.2 17907 */ 17908 dismiss: Callback<void>; 17909 17910 /** 17911 * Defines popup dismiss reason 17912 * 17913 * @type { DismissReason } 17914 * @syscap SystemCapability.ArkUI.ArkUI.Full 17915 * @crossplatform 17916 * @atomicservice 17917 * @since arkts {'1.1':'12','1.2':'20'} 17918 * @arkts 1.1&1.2 17919 */ 17920 reason: DismissReason; 17921} 17922 17923/** 17924 * Popup state change param 17925 * 17926 * @interface PopupStateChangeParam 17927 * @syscap SystemCapability.ArkUI.ArkUI.Full 17928 * @crossplatform 17929 * @atomicservice 17930 * @since arkts {'1.1':'18','1.2':'20'} 17931 * @arkts 1.1&1.2 17932 */ 17933declare interface PopupStateChangeParam { 17934 /** 17935 * is Visible. 17936 * 17937 * @type { boolean } 17938 * @syscap SystemCapability.ArkUI.ArkUI.Full 17939 * @crossplatform 17940 * @atomicservice 17941 * @since arkts {'1.1':'18','1.2':'20'} 17942 * @arkts 1.1&1.2 17943 */ 17944 isVisible: boolean; 17945} 17946 17947/** 17948 * Popup state change callback 17949 * 17950 * @typedef { function } PopupStateChangeCallback 17951 * @param { PopupStateChangeParam } event - The parameter of state change callback. 17952 * @syscap SystemCapability.ArkUI.ArkUI.Full 17953 * @crossplatform 17954 * @atomicservice 17955 * @since arkts {'1.1':'18','1.2':'20'} 17956 * @arkts 1.1&1.2 17957 */ 17958declare type PopupStateChangeCallback = (event: PopupStateChangeParam) => void; 17959 17960/** 17961 * Popup mask type 17962 * 17963 * @interface PopupMaskType 17964 * @syscap SystemCapability.ArkUI.ArkUI.Full 17965 * @crossplatform 17966 * @atomicservice 17967 * @since arkts {'1.1':'18','1.2':'20'} 17968 * @arkts 1.1&1.2 17969 */ 17970declare interface PopupMaskType { 17971 /** 17972 * Color. 17973 * 17974 * @type { ResourceColor } 17975 * @syscap SystemCapability.ArkUI.ArkUI.Full 17976 * @crossplatform 17977 * @atomicservice 17978 * @since arkts {'1.1':'18','1.2':'20'} 17979 * @arkts 1.1&1.2 17980 */ 17981 color: ResourceColor; 17982} 17983 17984/** 17985 * Popup border LinearGradient 17986 * 17987 * @interface PopupBorderLinearGradient 17988 * @syscap SystemCapability.ArkUI.ArkUI.Full 17989 * @crossplatform 17990 * @atomicservice 17991 * @since 20 17992 */ 17993declare interface PopupBorderLinearGradient { 17994 /** 17995 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 17996 * 17997 * @type { ?GradientDirection } 17998 * @syscap SystemCapability.ArkUI.ArkUI.Full 17999 * @crossplatform 18000 * @atomicservice 18001 * @since 20 18002 */ 18003 direction?: GradientDirection; 18004 18005 /** 18006 * Defines color description for gradients. 18007 * number: The position of the color stop. The value range is 0 to 1. 18008 * 18009 * @type { Array<[ResourceColor, number]> } 18010 * @syscap SystemCapability.ArkUI.ArkUI.Full 18011 * @crossplatform 18012 * @atomicservice 18013 * @since 20 18014 */ 18015 colors: Array<[ResourceColor, number]>; 18016} 18017 18018/** 18019 * Popup common options 18020 * 18021 * @interface PopupCommonOptions 18022 * @syscap SystemCapability.ArkUI.ArkUI.Full 18023 * @crossplatform 18024 * @atomicservice 18025 * @since arkts {'1.1':'18','1.2':'20'} 18026 * @arkts 1.1&1.2 18027 */ 18028declare interface PopupCommonOptions { 18029 /** 18030 * placement of popup. 18031 * 18032 * @type { ?Placement } 18033 * @default Placement.Bottom 18034 * @syscap SystemCapability.ArkUI.ArkUI.Full 18035 * @crossplatform 18036 * @atomicservice 18037 * @since arkts {'1.1':'18','1.2':'20'} 18038 * @arkts 1.1&1.2 18039 */ 18040 placement?: Placement; 18041 18042 /** 18043 * Set the background color of the popup. 18044 * 18045 * @type { ?ResourceColor } 18046 * @syscap SystemCapability.ArkUI.ArkUI.Full 18047 * @crossplatform 18048 * @atomicservice 18049 * @since arkts {'1.1':'18','1.2':'20'} 18050 * @arkts 1.1&1.2 18051 */ 18052 popupColor?: ResourceColor; 18053 18054 /** 18055 * whether show arrow 18056 * 18057 * @type { ?boolean } 18058 * @default true 18059 * @syscap SystemCapability.ArkUI.ArkUI.Full 18060 * @crossplatform 18061 * @atomicservice 18062 * @since arkts {'1.1':'18','1.2':'20'} 18063 * @arkts 1.1&1.2 18064 */ 18065 enableArrow?: boolean; 18066 18067 /** 18068 * Whether hide popup when click mask 18069 * 18070 * @type { ?boolean } 18071 * @default true 18072 * @syscap SystemCapability.ArkUI.ArkUI.Full 18073 * @crossplatform 18074 * @atomicservice 18075 * @since arkts {'1.1':'18','1.2':'20'} 18076 * @arkts 1.1&1.2 18077 */ 18078 autoCancel?: boolean; 18079 18080 /** 18081 * on State Change 18082 * 18083 * @type { ?function } 18084 * @syscap SystemCapability.ArkUI.ArkUI.Full 18085 * @crossplatform 18086 * @atomicservice 18087 * @since arkts {'1.1':'18','1.2':'20'} 18088 * @arkts 1.1&1.2 18089 */ 18090 onStateChange?: PopupStateChangeCallback; 18091 18092 /** 18093 * The offset of the sharp corner of popup. 18094 * 18095 * @type { ?Length } 18096 * @syscap SystemCapability.ArkUI.ArkUI.Full 18097 * @crossplatform 18098 * @atomicservice 18099 * @since arkts {'1.1':'18','1.2':'20'} 18100 * @arkts 1.1&1.2 18101 */ 18102 arrowOffset?: Length; 18103 18104 /** 18105 * Whether to display in the sub window. 18106 * 18107 * @type { ?boolean } 18108 * @default false 18109 * @syscap SystemCapability.ArkUI.ArkUI.Full 18110 * @crossplatform 18111 * @atomicservice 18112 * @since arkts {'1.1':'18','1.2':'20'} 18113 * @arkts 1.1&1.2 18114 */ 18115 showInSubWindow?: boolean; 18116 18117 /** 18118 * The mask to block gesture events of popup. 18119 * When mask is set false, gesture events are not blocked. 18120 * When mask is set true, gesture events are blocked and mask color is transparent. 18121 * 18122 * @type { ?(boolean | PopupMaskType) } 18123 * @syscap SystemCapability.ArkUI.ArkUI.Full 18124 * @crossplatform 18125 * @atomicservice 18126 * @since arkts {'1.1':'18','1.2':'20'} 18127 * @arkts 1.1&1.2 18128 */ 18129 mask?: boolean | PopupMaskType; 18130 18131 /** 18132 * Sets the space of between the popup and target. 18133 * 18134 * @type { ?Length } 18135 * @syscap SystemCapability.ArkUI.ArkUI.Full 18136 * @crossplatform 18137 * @atomicservice 18138 * @since arkts {'1.1':'18','1.2':'20'} 18139 * @arkts 1.1&1.2 18140 */ 18141 targetSpace?: Length; 18142 18143 /** 18144 * Sets the position offset of the popup. 18145 * 18146 * @type { ?Position } 18147 * @default { x: 0, y: 0 } 18148 * @syscap SystemCapability.ArkUI.ArkUI.Full 18149 * @crossplatform 18150 * @atomicservice 18151 * @since arkts {'1.1':'18','1.2':'20'} 18152 * @arkts 1.1&1.2 18153 */ 18154 offset?: Position; 18155 18156 /** 18157 * Set the width of the popup. 18158 * 18159 * @type { ?Dimension } 18160 * @syscap SystemCapability.ArkUI.ArkUI.Full 18161 * @crossplatform 18162 * @atomicservice 18163 * @since arkts {'1.1':'18','1.2':'20'} 18164 * @arkts 1.1&1.2 18165 */ 18166 width?: Dimension; 18167 18168 /** 18169 * The position of the sharp corner of popup. 18170 * 18171 * @type { ?ArrowPointPosition } 18172 * @syscap SystemCapability.ArkUI.ArkUI.Full 18173 * @crossplatform 18174 * @atomicservice 18175 * @since arkts {'1.1':'18','1.2':'20'} 18176 * @arkts 1.1&1.2 18177 */ 18178 arrowPointPosition?: ArrowPointPosition; 18179 18180 /** 18181 * The width of the arrow. 18182 * 18183 * @type { ?Dimension } 18184 * @default 16.0_vp. 18185 * @syscap SystemCapability.ArkUI.ArkUI.Full 18186 * @crossplatform 18187 * @atomicservice 18188 * @since arkts {'1.1':'18','1.2':'20'} 18189 * @arkts 1.1&1.2 18190 */ 18191 arrowWidth?: Dimension; 18192 18193 /** 18194 * The height of the arrow. 18195 * 18196 * @type { ?Dimension } 18197 * @default 8.0_vp. 18198 * @syscap SystemCapability.ArkUI.ArkUI.Full 18199 * @crossplatform 18200 * @atomicservice 18201 * @since arkts {'1.1':'18','1.2':'20'} 18202 * @arkts 1.1&1.2 18203 */ 18204 arrowHeight?: Dimension; 18205 18206 /** 18207 * The round corners of the popup. 18208 * 18209 * @type { ?Dimension } 18210 * @default 20.0_vp. 18211 * @syscap SystemCapability.ArkUI.ArkUI.Full 18212 * @crossplatform 18213 * @atomicservice 18214 * @since arkts {'1.1':'18','1.2':'20'} 18215 * @arkts 1.1&1.2 18216 */ 18217 radius?: Dimension; 18218 18219 /** 18220 * The style of popup Shadow. 18221 * 18222 * @type { ?(ShadowOptions | ShadowStyle) } 18223 * @default ShadowStyle.OUTER_DEFAULT_MD. 18224 * @syscap SystemCapability.ArkUI.ArkUI.Full 18225 * @crossplatform 18226 * @atomicservice 18227 * @since arkts {'1.1':'18','1.2':'20'} 18228 * @arkts 1.1&1.2 18229 */ 18230 shadow?: ShadowOptions | ShadowStyle; 18231 18232 /** 18233 * Defines popup background blur Style 18234 * 18235 * @type { ?BlurStyle } 18236 * @default BlurStyle.COMPONENT_ULTRA_THICK 18237 * @syscap SystemCapability.ArkUI.ArkUI.Full 18238 * @crossplatform 18239 * @atomicservice 18240 * @since arkts {'1.1':'18','1.2':'20'} 18241 * @arkts 1.1&1.2 18242 */ 18243 backgroundBlurStyle?: BlurStyle; 18244 18245 /** 18246 * Set popup focusable 18247 * 18248 * @type { ?boolean } 18249 * @default false 18250 * @syscap SystemCapability.ArkUI.ArkUI.Full 18251 * @crossplatform 18252 * @atomicservice 18253 * @since arkts {'1.1':'18','1.2':'20'} 18254 * @arkts 1.1&1.2 18255 */ 18256 focusable?: boolean; 18257 18258 /** 18259 * Defines the transition effect of popup opening and closing 18260 * 18261 * @type { ?TransitionEffect } 18262 * @syscap SystemCapability.ArkUI.ArkUI.Full 18263 * @crossplatform 18264 * @atomicservice 18265 * @since arkts {'1.1':'18','1.2':'20'} 18266 * @arkts 1.1&1.2 18267 */ 18268 transition?: TransitionEffect; 18269 18270 /** 18271 * Callback function when the popup interactive dismiss. 18272 * Use boolean to respond all interactive dismiss event. Use Callback to customize which event should be responded. 18273 * 18274 * @type { ?(boolean | Callback<DismissPopupAction>) } 18275 * @syscap SystemCapability.ArkUI.ArkUI.Full 18276 * @crossplatform 18277 * @atomicservice 18278 * @since arkts {'1.1':'18','1.2':'20'} 18279 * @arkts 1.1&1.2 18280 */ 18281 onWillDismiss?: boolean | Callback<DismissPopupAction>; 18282 18283 /** 18284 * Determine if it is compatible popup's half folded. 18285 * 18286 * @type { ?boolean } 18287 * @default false 18288 * @syscap SystemCapability.ArkUI.ArkUI.Full 18289 * @crossplatform 18290 * @atomicservice 18291 * @since arkts {'1.1':'18','1.2':'20'} 18292 * @arkts 1.1&1.2 18293 */ 18294 enableHoverMode?: boolean; 18295 18296 /** 18297 * Determine if popup can follow the target node when it has rotation or scale. 18298 * 18299 * @type { ?boolean } 18300 * @default false 18301 * @syscap SystemCapability.ArkUI.ArkUI.Full 18302 * @crossplatform 18303 * @atomicservice 18304 * @since arkts {'1.1':'18','1.2':'20'} 18305 * @arkts 1.1&1.2 18306 */ 18307 followTransformOfTarget?: boolean; 18308 18309 /** 18310 * Determine if popup can avoid the target when the display space is insufficient. 18311 * 18312 * @type { ?AvoidanceMode } 18313 * @default AvoidanceMode.COVER_TARGET 18314 * @syscap SystemCapability.ArkUI.ArkUI.Full 18315 * @crossplatform 18316 * @atomicservice 18317 * @since 20 18318 */ 18319 avoidTarget?: AvoidanceMode; 18320 18321 /** 18322 * The width of popup's outline. 18323 * 18324 * @type { ?Dimension } 18325 * @syscap SystemCapability.ArkUI.ArkUI.Full 18326 * @crossplatform 18327 * @atomicservice 18328 * @since 20 18329 */ 18330 outlineWidth?: Dimension; 18331 18332 /** 18333 * The width of popup's border. 18334 * 18335 * @type { ?Dimension } 18336 * @syscap SystemCapability.ArkUI.ArkUI.Full 18337 * @crossplatform 18338 * @atomicservice 18339 * @since 20 18340 */ 18341 borderWidth?: Dimension; 18342 18343 /** 18344 * The LinearGradient of popup's outline. 18345 * 18346 * @type { ?PopupBorderLinearGradient } 18347 * @syscap SystemCapability.ArkUI.ArkUI.Full 18348 * @crossplatform 18349 * @atomicservice 18350 * @since 20 18351 */ 18352 outlineLinearGradient?: PopupBorderLinearGradient; 18353 18354 /** 18355 * The LinearGradient of popup's innerline. 18356 * 18357 * @type { ?PopupBorderLinearGradient } 18358 * @syscap SystemCapability.ArkUI.ArkUI.Full 18359 * @crossplatform 18360 * @atomicservice 18361 * @since 20 18362 */ 18363 borderLinearGradient?: PopupBorderLinearGradient; 18364} 18365 18366/** 18367 * Defines the Tips options. 18368 * 18369 * @interface TipsOptions 18370 * @syscap SystemCapability.ArkUI.ArkUI.Full 18371 * @crossplatform 18372 * @atomicservice 18373 * @since arkts {'1.1':'19','1.2':'20'} 18374 * @arkts 1.1&1.2 18375 */ 18376declare interface TipsOptions { 18377 18378 /** 18379 * Defines the delay time for appearing. 18380 * 18381 * @type { ?number } 18382 * @syscap SystemCapability.ArkUI.ArkUI.Full 18383 * @crossplatform 18384 * @atomicservice 18385 * @since arkts {'1.1':'19','1.2':'20'} 18386 * @arkts 1.1&1.2 18387 */ 18388 appearingTime?: number; 18389 18390 /** 18391 * Defines the delay time for disappearing. 18392 * 18393 * @type { ?number } 18394 * @syscap SystemCapability.ArkUI.ArkUI.Full 18395 * @crossplatform 18396 * @atomicservice 18397 * @since arkts {'1.1':'19','1.2':'20'} 18398 * @arkts 1.1&1.2 18399 */ 18400 disappearingTime?: number; 18401 18402 /** 18403 * Define the delay time for the appearance of continuous operations. 18404 * 18405 * @type { ?number } 18406 * @syscap SystemCapability.ArkUI.ArkUI.Full 18407 * @crossplatform 18408 * @atomicservice 18409 * @since arkts {'1.1':'19','1.2':'20'} 18410 * @arkts 1.1&1.2 18411 */ 18412 appearingTimeWithContinuousOperation?: number; 18413 18414 /** 18415 * Define the delay time for the disappearance of continuous operations. 18416 * 18417 * @type { ?number } 18418 * @syscap SystemCapability.ArkUI.ArkUI.Full 18419 * @crossplatform 18420 * @atomicservice 18421 * @since arkts {'1.1':'19','1.2':'20'} 18422 * @arkts 1.1&1.2 18423 */ 18424 disappearingTimeWithContinuousOperation?: number; 18425 18426 /** 18427 * whether show arrow 18428 * 18429 * @type { ?boolean } 18430 * @default true 18431 * @syscap SystemCapability.ArkUI.ArkUI.Full 18432 * @crossplatform 18433 * @atomicservice 18434 * @since arkts {'1.1':'19','1.2':'20'} 18435 * @arkts 1.1&1.2 18436 */ 18437 enableArrow?: boolean; 18438 18439 /** 18440 * The position of the sharp corner of Tips. 18441 * 18442 * @type { ?ArrowPointPosition } 18443 * @syscap SystemCapability.ArkUI.ArkUI.Full 18444 * @crossplatform 18445 * @atomicservice 18446 * @since arkts {'1.1':'19','1.2':'20'} 18447 * @arkts 1.1&1.2 18448 */ 18449 arrowPointPosition?: ArrowPointPosition; 18450 18451 /** 18452 * The width of the arrow. 18453 * 18454 * @type { ?Dimension } 18455 * @default 16.0_vp. 18456 * @syscap SystemCapability.ArkUI.ArkUI.Full 18457 * @crossplatform 18458 * @atomicservice 18459 * @since arkts {'1.1':'19','1.2':'20'} 18460 * @arkts 1.1&1.2 18461 */ 18462 arrowWidth?: Dimension; 18463 18464 /** 18465 * The height of the arrow. 18466 * 18467 * @type { ?Dimension } 18468 * @default 8.0_vp. 18469 * @syscap SystemCapability.ArkUI.ArkUI.Full 18470 * @crossplatform 18471 * @atomicservice 18472 * @since arkts {'1.1':'19','1.2':'20'} 18473 * @arkts 1.1&1.2 18474 */ 18475 arrowHeight?: Dimension; 18476 18477 /** 18478 * The position of the tips. 18479 * 18480 * @type { ?TipsAnchorType } 18481 * @syscap SystemCapability.ArkUI.ArkUI.Full 18482 * @crossplatform 18483 * @atomicservice 18484 * @since 20 18485 */ 18486 showAtAnchor?: TipsAnchorType; 18487} 18488 18489/** 18490 * Defines the popup button. 18491 * 18492 * @interface PopupButton 18493 * @syscap SystemCapability.ArkUI.ArkUI.Full 18494 * @crossplatform 18495 * @atomicservice 18496 * @since 20 18497 * @arkts 1.2 18498 */ 18499declare interface PopupButton { 18500 18501 /** 18502 * Button text value 18503 * 18504 * @type { string } 18505 * @syscap SystemCapability.ArkUI.ArkUI.Full 18506 * @crossplatform 18507 * @atomicservice 18508 * @since 20 18509 * @arkts 1.2 18510 */ 18511 value: string; 18512 18513 /** 18514 * action 18515 * 18516 * @type { VoidCallback } 18517 * @syscap SystemCapability.ArkUI.ArkUI.Full 18518 * @crossplatform 18519 * @atomicservice 18520 * @since 20 18521 * @arkts 1.2 18522 */ 18523 action: VoidCallback; 18524} 18525 18526/** 18527 * Defines the popup options. 18528 * 18529 * @interface PopupOptions 18530 * @syscap SystemCapability.ArkUI.ArkUI.Full 18531 * @since 7 18532 */ 18533/** 18534 * Defines the popup options. 18535 * 18536 * @interface PopupOptions 18537 * @syscap SystemCapability.ArkUI.ArkUI.Full 18538 * @crossplatform 18539 * @since 10 18540 */ 18541/** 18542 * Defines the popup options. 18543 * 18544 * @interface PopupOptions 18545 * @syscap SystemCapability.ArkUI.ArkUI.Full 18546 * @crossplatform 18547 * @atomicservice 18548 * @since arkts {'1.1':'11','1.2':'20'} 18549 * @arkts 1.1&1.2 18550 */ 18551declare interface PopupOptions { 18552 /** 18553 * Information in the pop-up window. 18554 * 18555 * @type { string } 18556 * @syscap SystemCapability.ArkUI.ArkUI.Full 18557 * @since 7 18558 */ 18559 /** 18560 * Information in the pop-up window. 18561 * 18562 * @type { string } 18563 * @syscap SystemCapability.ArkUI.ArkUI.Full 18564 * @crossplatform 18565 * @since 10 18566 */ 18567 /** 18568 * Content of the popup message. 18569 * 18570 * @type { string } 18571 * @syscap SystemCapability.ArkUI.ArkUI.Full 18572 * @crossplatform 18573 * @atomicservice 18574 * @since arkts {'1.1':'11','1.2':'20'} 18575 * @arkts 1.1&1.2 18576 */ 18577 message: string; 18578 18579 /** 18580 * placement On Top 18581 * 18582 * @type { ?boolean } 18583 * @syscap SystemCapability.ArkUI.ArkUI.Full 18584 * @since 7 18585 * @deprecated since 10 18586 * @useinstead PopupOptions#placement 18587 */ 18588 placementOnTop?: boolean; 18589 18590 /** 18591 * The placement of popup. 18592 * Supports all positions defined in Placement. 18593 * 18594 * @type { ?Placement } 18595 * @default Placement.Bottom 18596 * @syscap SystemCapability.ArkUI.ArkUI.Full 18597 * @crossplatform 18598 * @since 10 18599 */ 18600 /** 18601 * The placement of popup. 18602 * Supports all positions defined in Placement. 18603 * 18604 * @type { ?Placement } 18605 * @default Placement.Bottom 18606 * @syscap SystemCapability.ArkUI.ArkUI.Full 18607 * @crossplatform 18608 * @atomicservice 18609 * @since arkts {'1.1':'11','1.2':'20'} 18610 * @arkts 1.1&1.2 18611 */ 18612 placement?: Placement; 18613 18614 /** 18615 * The first button. 18616 * 18617 * @type { ?object } 18618 * @syscap SystemCapability.ArkUI.ArkUI.Full 18619 * @since 7 18620 */ 18621 /** 18622 * The first button. 18623 * 18624 * @type { ?object } 18625 * @syscap SystemCapability.ArkUI.ArkUI.Full 18626 * @crossplatform 18627 * @since 10 18628 */ 18629 /** 18630 * The first button. 18631 * 18632 * @type { ?object } 18633 * @syscap SystemCapability.ArkUI.ArkUI.Full 18634 * @crossplatform 18635 * @atomicservice 18636 * @since 11 18637 */ 18638 primaryButton?: { 18639 /** 18640 * Button text value 18641 * 18642 * @type { string } 18643 * @syscap SystemCapability.ArkUI.ArkUI.Full 18644 * @since 7 18645 */ 18646 /** 18647 * Button text value 18648 * 18649 * @type { string } 18650 * @syscap SystemCapability.ArkUI.ArkUI.Full 18651 * @crossplatform 18652 * @since 10 18653 */ 18654 /** 18655 * Button text value 18656 * 18657 * @type { string } 18658 * @syscap SystemCapability.ArkUI.ArkUI.Full 18659 * @crossplatform 18660 * @atomicservice 18661 * @since 11 18662 */ 18663 value: string; 18664 18665 /** 18666 * action 18667 * 18668 * @type { function } 18669 * @syscap SystemCapability.ArkUI.ArkUI.Full 18670 * @since 7 18671 */ 18672 /** 18673 * action 18674 * 18675 * @type { function } 18676 * @syscap SystemCapability.ArkUI.ArkUI.Full 18677 * @crossplatform 18678 * @since 10 18679 */ 18680 /** 18681 * action 18682 * 18683 * @type { function } 18684 * @syscap SystemCapability.ArkUI.ArkUI.Full 18685 * @crossplatform 18686 * @atomicservice 18687 * @since 11 18688 */ 18689 action: () => void; 18690 }; 18691 18692 /** 18693 * The first button. 18694 * 18695 * @type { ?PopupButton } 18696 * @syscap SystemCapability.ArkUI.ArkUI.Full 18697 * @crossplatform 18698 * @atomicservice 18699 * @since 20 18700 * @arkts 1.2 18701 */ 18702 primaryButton?: PopupButton; 18703 /** 18704 * The second button. 18705 * 18706 * @type { ?object } 18707 * @syscap SystemCapability.ArkUI.ArkUI.Full 18708 * @since 7 18709 */ 18710 /** 18711 * The second button. 18712 * 18713 * @type { ?object } 18714 * @syscap SystemCapability.ArkUI.ArkUI.Full 18715 * @crossplatform 18716 * @since 10 18717 */ 18718 /** 18719 * The second button. 18720 * 18721 * @type { ?object } 18722 * @syscap SystemCapability.ArkUI.ArkUI.Full 18723 * @crossplatform 18724 * @atomicservice 18725 * @since 11 18726 */ 18727 secondaryButton?: { 18728 /** 18729 * Button text value 18730 * 18731 * @type { string } 18732 * @syscap SystemCapability.ArkUI.ArkUI.Full 18733 * @since 7 18734 */ 18735 /** 18736 * Button text value 18737 * 18738 * @type { string } 18739 * @syscap SystemCapability.ArkUI.ArkUI.Full 18740 * @crossplatform 18741 * @since 10 18742 */ 18743 /** 18744 * Button text value 18745 * 18746 * @type { string } 18747 * @syscap SystemCapability.ArkUI.ArkUI.Full 18748 * @crossplatform 18749 * @atomicservice 18750 * @since 11 18751 */ 18752 value: string; 18753 18754 /** 18755 * action 18756 * 18757 * @type { function } 18758 * @syscap SystemCapability.ArkUI.ArkUI.Full 18759 * @since 7 18760 */ 18761 /** 18762 * action 18763 * 18764 * @type { function } 18765 * @syscap SystemCapability.ArkUI.ArkUI.Full 18766 * @crossplatform 18767 * @since 10 18768 */ 18769 /** 18770 * action 18771 * 18772 * @type { function } 18773 * @syscap SystemCapability.ArkUI.ArkUI.Full 18774 * @crossplatform 18775 * @atomicservice 18776 * @since 11 18777 */ 18778 action: () => void; 18779 }; 18780 18781 /** 18782 * The second button. 18783 * 18784 * @type { ?PopupButton } 18785 * @syscap SystemCapability.ArkUI.ArkUI.Full 18786 * @crossplatform 18787 * @atomicservice 18788 * @since 20 18789 * @arkts 1.2 18790 */ 18791 secondaryButton?:PopupButton 18792 18793 /** 18794 * on State Change 18795 * 18796 * @type { ?function } 18797 * @syscap SystemCapability.ArkUI.ArkUI.Full 18798 * @since 7 18799 */ 18800 /** 18801 * on State Change 18802 * 18803 * @type { ?function } 18804 * @syscap SystemCapability.ArkUI.ArkUI.Full 18805 * @crossplatform 18806 * @since 10 18807 */ 18808 /** 18809 * on State Change 18810 * 18811 * @type { ?function } 18812 * @syscap SystemCapability.ArkUI.ArkUI.Full 18813 * @crossplatform 18814 * @atomicservice 18815 * @since 11 18816 */ 18817 onStateChange?: (event: { 18818 /** 18819 * is Visible. 18820 * 18821 * @type { boolean } 18822 * @syscap SystemCapability.ArkUI.ArkUI.Full 18823 * @crossplatform 18824 * @since 10 18825 */ 18826 /** 18827 * is Visible. 18828 * 18829 * @type { boolean } 18830 * @syscap SystemCapability.ArkUI.ArkUI.Full 18831 * @crossplatform 18832 * @atomicservice 18833 * @since 11 18834 */ 18835 isVisible: boolean 18836 }) => void; 18837 18838 /** 18839 * on State Change 18840 * 18841 * @type { ?PopupStateChangeCallback } 18842 * @syscap SystemCapability.ArkUI.ArkUI.Full 18843 * @crossplatform 18844 * @atomicservice 18845 * @since 20 18846 * @arkts 1.2 18847 */ 18848 onStateChange?: PopupStateChangeCallback; 18849 18850 /** 18851 * The offset of the sharp corner of popup. 18852 * 18853 * @type { ?Length } 18854 * @syscap SystemCapability.ArkUI.ArkUI.Full 18855 * @since 9 18856 */ 18857 /** 18858 * The offset of the sharp corner of popup. 18859 * 18860 * @type { ?Length } 18861 * @syscap SystemCapability.ArkUI.ArkUI.Full 18862 * @crossplatform 18863 * @since 10 18864 */ 18865 /** 18866 * The offset of the sharp corner of popup. 18867 * 18868 * @type { ?Length } 18869 * @syscap SystemCapability.ArkUI.ArkUI.Full 18870 * @crossplatform 18871 * @atomicservice 18872 * @since arkts {'1.1':'11','1.2':'20'} 18873 * @arkts 1.1&1.2 18874 */ 18875 arrowOffset?: Length; 18876 18877 /** 18878 * Whether to display in the sub window. 18879 * 18880 * @type { ?boolean } 18881 * @syscap SystemCapability.ArkUI.ArkUI.Full 18882 * @since 9 18883 */ 18884 /** 18885 * Whether to display in the sub window. 18886 * 18887 * @type { ?boolean } 18888 * @syscap SystemCapability.ArkUI.ArkUI.Full 18889 * @crossplatform 18890 * @since 10 18891 */ 18892 /** 18893 * Whether to display in the sub window. 18894 * 18895 * @type { ?boolean } 18896 * @default false 18897 * @syscap SystemCapability.ArkUI.ArkUI.Full 18898 * @crossplatform 18899 * @atomicservice 18900 * @since arkts {'1.1':'11','1.2':'20'} 18901 * @arkts 1.1&1.2 18902 */ 18903 showInSubWindow?: boolean; 18904 18905 /** 18906 * The mask to block gesture events of popup. 18907 * When mask is set false, gesture events are not blocked. 18908 * When mask is set true, gesture events are blocked and mask color is transparent. 18909 * 18910 * @type { ?(boolean | { color: ResourceColor }) } 18911 * @syscap SystemCapability.ArkUI.ArkUI.Full 18912 * @crossplatform 18913 * @since 10 18914 */ 18915 /** 18916 * The mask to block gesture events of popup. 18917 * When mask is set false, gesture events are not blocked. 18918 * When mask is set true, gesture events are blocked and mask color is transparent. 18919 * 18920 * @type { ?(boolean | { color: ResourceColor }) } 18921 * @syscap SystemCapability.ArkUI.ArkUI.Full 18922 * @crossplatform 18923 * @atomicservice 18924 * @since 11 18925 */ 18926 mask?: boolean | { color: ResourceColor }; 18927 18928 /** 18929 * The mask to block gesture events of popup. 18930 * When mask is set false, gesture events are not blocked. 18931 * When mask is set true, gesture events are blocked and mask color is transparent. 18932 * 18933 * @type { ?(boolean | PopupMaskType) } 18934 * @syscap SystemCapability.ArkUI.ArkUI.Full 18935 * @crossplatform 18936 * @atomicservice 18937 * @since 20 18938 * @arkts 1.2 18939 */ 18940 mask?: boolean | PopupMaskType; 18941 18942 /** 18943 * Sets the options of popup message. 18944 * 18945 * @type { ?PopupMessageOptions } 18946 * @syscap SystemCapability.ArkUI.ArkUI.Full 18947 * @crossplatform 18948 * @since 10 18949 */ 18950 /** 18951 * Parameters of the popup message. 18952 * 18953 * @type { ?PopupMessageOptions } 18954 * @syscap SystemCapability.ArkUI.ArkUI.Full 18955 * @crossplatform 18956 * @atomicservice 18957 * @since arkts {'1.1':'11','1.2':'20'} 18958 * @arkts 1.1&1.2 18959 */ 18960 messageOptions?: PopupMessageOptions 18961 18962 /** 18963 * Sets the space of between the popup and target. 18964 * 18965 * @type { ?Length } 18966 * @syscap SystemCapability.ArkUI.ArkUI.Full 18967 * @crossplatform 18968 * @since 10 18969 */ 18970 /** 18971 * Sets the space of between the popup and target. 18972 * 18973 * @type { ?Length } 18974 * @syscap SystemCapability.ArkUI.ArkUI.Full 18975 * @crossplatform 18976 * @atomicservice 18977 * @since arkts {'1.1':'11','1.2':'20'} 18978 * @arkts 1.1&1.2 18979 */ 18980 targetSpace?: Length 18981 18982 /** 18983 * whether show arrow 18984 * 18985 * @type { ?boolean } 18986 * @default true 18987 * @syscap SystemCapability.ArkUI.ArkUI.Full 18988 * @since 10 18989 */ 18990 /** 18991 * whether show arrow 18992 * 18993 * @type { ?boolean } 18994 * @default true 18995 * @syscap SystemCapability.ArkUI.ArkUI.Full 18996 * @crossplatform 18997 * @atomicservice 18998 * @since arkts {'1.1':'11','1.2':'20'} 18999 * @arkts 1.1&1.2 19000 */ 19001 enableArrow?: boolean; 19002 /** 19003 * Sets the position offset of the popup. 19004 * 19005 * @type { ?Position } 19006 * @syscap SystemCapability.ArkUI.ArkUI.Full 19007 * @crossplatform 19008 * @since 10 19009 */ 19010 /** 19011 * Sets the position offset of the popup. 19012 * 19013 * @type { ?Position } 19014 * @default { x: 0, y: 0 } 19015 * @syscap SystemCapability.ArkUI.ArkUI.Full 19016 * @crossplatform 19017 * @atomicservice 19018 * @since arkts {'1.1':'11','1.2':'20'} 19019 * @arkts 1.1&1.2 19020 */ 19021 offset?: Position 19022 19023 /** 19024 * Set the background color of the popup. 19025 * 19026 * @type { ?(Color | string | Resource | number) } 19027 * @syscap SystemCapability.ArkUI.ArkUI.Full 19028 * @crossplatform 19029 * @since 11 19030 */ 19031 /** 19032 * Set the background color of the popup. 19033 * 19034 * @type { ?(Color | string | Resource | number) } 19035 * @syscap SystemCapability.ArkUI.ArkUI.Full 19036 * @crossplatform 19037 * @atomicservice 19038 * @since arkts {'1.1':'12','1.2':'20'} 19039 * @arkts 1.1&1.2 19040 */ 19041 popupColor?: Color | string | Resource | number; 19042 19043 /** 19044 * Whether hide popup when click mask. 19045 * 19046 * @type { ?boolean } 19047 * @default true 19048 * @syscap SystemCapability.ArkUI.ArkUI.Full 19049 * @crossplatform 19050 * @since 11 19051 */ 19052 /** 19053 * Whether hide popup when click mask. 19054 * 19055 * @type { ?boolean } 19056 * @default true 19057 * @syscap SystemCapability.ArkUI.ArkUI.Full 19058 * @crossplatform 19059 * @atomicservice 19060 * @since arkts {'1.1':'12','1.2':'20'} 19061 * @arkts 1.1&1.2 19062 */ 19063 autoCancel?: boolean; 19064 19065 /** 19066 * Set the width of the popup. 19067 * 19068 * @type { ?Dimension } 19069 * @syscap SystemCapability.ArkUI.ArkUI.Full 19070 * @crossplatform 19071 * @since 11 19072 */ 19073 /** 19074 * Set the width of the popup. 19075 * 19076 * @type { ?Dimension } 19077 * @syscap SystemCapability.ArkUI.ArkUI.Full 19078 * @crossplatform 19079 * @atomicservice 19080 * @since arkts {'1.1':'12','1.2':'20'} 19081 * @arkts 1.1&1.2 19082 */ 19083 width?: Dimension; 19084 19085 /** 19086 * The position of the sharp corner of popup. 19087 * 19088 * @type { ?ArrowPointPosition } 19089 * @syscap SystemCapability.ArkUI.ArkUI.Full 19090 * @crossplatform 19091 * @since 11 19092 */ 19093 /** 19094 * The position of the sharp corner of popup. 19095 * 19096 * @type { ?ArrowPointPosition } 19097 * @syscap SystemCapability.ArkUI.ArkUI.Full 19098 * @crossplatform 19099 * @atomicservice 19100 * @since arkts {'1.1':'12','1.2':'20'} 19101 * @arkts 1.1&1.2 19102 */ 19103 arrowPointPosition?: ArrowPointPosition; 19104 19105 /** 19106 * The width of the arrow. 19107 * 19108 * @type { ?Dimension } 19109 * @default 16.0_vp. 19110 * @syscap SystemCapability.ArkUI.ArkUI.Full 19111 * @crossplatform 19112 * @since 11 19113 */ 19114 /** 19115 * The width of the arrow. 19116 * 19117 * @type { ?Dimension } 19118 * @default 16.0_vp. 19119 * @syscap SystemCapability.ArkUI.ArkUI.Full 19120 * @crossplatform 19121 * @atomicservice 19122 * @since arkts {'1.1':'12','1.2':'20'} 19123 * @arkts 1.1&1.2 19124 */ 19125 arrowWidth?: Dimension; 19126 19127 /** 19128 * The height of the arrow. 19129 * 19130 * @type { ?Dimension } 19131 * @default 8.0_vp. 19132 * @syscap SystemCapability.ArkUI.ArkUI.Full 19133 * @crossplatform 19134 * @since 11 19135 */ 19136 /** 19137 * The height of the arrow. 19138 * 19139 * @type { ?Dimension } 19140 * @default 8.0_vp. 19141 * @syscap SystemCapability.ArkUI.ArkUI.Full 19142 * @crossplatform 19143 * @atomicservice 19144 * @since arkts {'1.1':'12','1.2':'20'} 19145 * @arkts 1.1&1.2 19146 */ 19147 arrowHeight?: Dimension; 19148 19149 /** 19150 * The round corners of the popup. 19151 * 19152 * @type { ?Dimension } 19153 * @default 20.0_vp. 19154 * @syscap SystemCapability.ArkUI.ArkUI.Full 19155 * @crossplatform 19156 * @since 11 19157 */ 19158 /** 19159 * The round corners of the popup. 19160 * 19161 * @type { ?Dimension } 19162 * @default 20.0_vp. 19163 * @syscap SystemCapability.ArkUI.ArkUI.Full 19164 * @crossplatform 19165 * @atomicservice 19166 * @since arkts {'1.1':'12','1.2':'20'} 19167 * @arkts 1.1&1.2 19168 */ 19169 radius?: Dimension; 19170 19171 /** 19172 * The style of popup Shadow. 19173 * 19174 * @type { ?(ShadowOptions | ShadowStyle) } 19175 * @default ShadowStyle.OUTER_DEFAULT_MD. 19176 * @syscap SystemCapability.ArkUI.ArkUI.Full 19177 * @crossplatform 19178 * @since 11 19179 */ 19180 /** 19181 * The style of popup Shadow. 19182 * 19183 * @type { ?(ShadowOptions | ShadowStyle) } 19184 * @default ShadowStyle.OUTER_DEFAULT_MD. 19185 * @syscap SystemCapability.ArkUI.ArkUI.Full 19186 * @crossplatform 19187 * @atomicservice 19188 * @since arkts {'1.1':'12','1.2':'20'} 19189 * @arkts 1.1&1.2 19190 */ 19191 shadow?: ShadowOptions | ShadowStyle; 19192 19193 /** 19194 * Defines popup background blur Style 19195 * 19196 * @type { ?BlurStyle } 19197 * @default BlurStyle.COMPONENT_ULTRA_THICK 19198 * @syscap SystemCapability.ArkUI.ArkUI.Full 19199 * @crossplatform 19200 * @since 11 19201 */ 19202 /** 19203 * Defines popup background blur Style 19204 * 19205 * @type { ?BlurStyle } 19206 * @default BlurStyle.COMPONENT_ULTRA_THICK 19207 * @syscap SystemCapability.ArkUI.ArkUI.Full 19208 * @crossplatform 19209 * @atomicservice 19210 * @since arkts {'1.1':'12','1.2':'20'} 19211 * @arkts 1.1&1.2 19212 */ 19213 backgroundBlurStyle?: BlurStyle; 19214 19215 /** 19216 * Defines the transition effect of popup opening and closing 19217 * 19218 * @type { ?TransitionEffect } 19219 * @syscap SystemCapability.ArkUI.ArkUI.Full 19220 * @crossplatform 19221 * @atomicservice 19222 * @since arkts {'1.1':'12','1.2':'20'} 19223 * @arkts 1.1&1.2 19224 */ 19225 transition?: TransitionEffect; 19226 19227 /** 19228 * Callback function when the popup interactive dismiss 19229 * 19230 * @type { ?(boolean | Callback<DismissPopupAction>) } 19231 * @syscap SystemCapability.ArkUI.ArkUI.Full 19232 * @crossplatform 19233 * @atomicservice 19234 * @since arkts {'1.1':'12','1.2':'20'} 19235 * @arkts 1.1&1.2 19236 */ 19237 onWillDismiss?: boolean | Callback<DismissPopupAction>; 19238 19239 /** 19240 * Determine if it is compatible popup's half folded. 19241 * 19242 * @type { ?boolean } 19243 * @default false 19244 * @syscap SystemCapability.ArkUI.ArkUI.Full 19245 * @crossplatform 19246 * @atomicservice 19247 * @since arkts {'1.1':'18','1.2':'20'} 19248 * @arkts 1.1&1.2 19249 */ 19250 enableHoverMode?: boolean; 19251 19252 /** 19253 * Determine if popup can follow the target node when it has rotation or scale. 19254 * 19255 * @type { ?boolean } 19256 * @default false 19257 * @syscap SystemCapability.ArkUI.ArkUI.Full 19258 * @crossplatform 19259 * @atomicservice 19260 * @since arkts {'1.1':'13','1.2':'20'} 19261 * @arkts 1.1&1.2 19262 */ 19263 followTransformOfTarget?: boolean; 19264 19265 /** 19266 * Define the popup avoid keyboard mode. 19267 * 19268 * @type { ?KeyboardAvoidMode } 19269 * @default KeyboardAvoidMode.NONE 19270 * @syscap SystemCapability.ArkUI.ArkUI.Full 19271 * @crossplatform 19272 * @atomicservice 19273 * @since arkts {'1.1':'15','1.2':'20'} 19274 * @arkts 1.1&1.2 19275 */ 19276 keyboardAvoidMode?: KeyboardAvoidMode; 19277 19278 /** 19279 * Determine if popup can avoid the target when the display space is insufficient. 19280 * 19281 * @type { ?AvoidanceMode } 19282 * @default AvoidanceMode.COVER_TARGET 19283 * @syscap SystemCapability.ArkUI.ArkUI.Full 19284 * @crossplatform 19285 * @atomicservice 19286 * @since 20 19287 */ 19288 avoidTarget?: AvoidanceMode; 19289 19290 /** 19291 * The width of popup's outline. 19292 * 19293 * @type { ?Dimension } 19294 * @syscap SystemCapability.ArkUI.ArkUI.Full 19295 * @crossplatform 19296 * @atomicservice 19297 * @since 20 19298 */ 19299 outlineWidth?: Dimension; 19300 19301 /** 19302 * The width of popup's border. 19303 * 19304 * @type { ?Dimension } 19305 * @syscap SystemCapability.ArkUI.ArkUI.Full 19306 * @crossplatform 19307 * @atomicservice 19308 * @since 20 19309 */ 19310 borderWidth?: Dimension; 19311 19312 /** 19313 * The LinearGradient of popup's outline. 19314 * 19315 * @type { ?PopupBorderLinearGradient } 19316 * @syscap SystemCapability.ArkUI.ArkUI.Full 19317 * @crossplatform 19318 * @atomicservice 19319 * @since 20 19320 */ 19321 outlineLinearGradient?: PopupBorderLinearGradient; 19322 19323 /** 19324 * The LinearGradient of popup's innerline. 19325 * 19326 * @type { ?PopupBorderLinearGradient } 19327 * @syscap SystemCapability.ArkUI.ArkUI.Full 19328 * @crossplatform 19329 * @atomicservice 19330 * @since 20 19331 */ 19332 borderLinearGradient?: PopupBorderLinearGradient; 19333} 19334 19335/** 19336 * Defines the custom popup options. 19337 * 19338 * @interface CustomPopupOptions 19339 * @syscap SystemCapability.ArkUI.ArkUI.Full 19340 * @since 8 19341 */ 19342/** 19343 * Defines the custom popup options. 19344 * 19345 * @interface CustomPopupOptions 19346 * @syscap SystemCapability.ArkUI.ArkUI.Full 19347 * @crossplatform 19348 * @since 10 19349 */ 19350/** 19351 * Defines the custom popup options. 19352 * 19353 * @interface CustomPopupOptions 19354 * @syscap SystemCapability.ArkUI.ArkUI.Full 19355 * @crossplatform 19356 * @atomicservice 19357 * @since arkts {'1.1':'11','1.2':'20'} 19358 * @arkts 1.1&1.2 19359 */ 19360declare interface CustomPopupOptions { 19361 /** 19362 * builder of popup 19363 * 19364 * @type { CustomBuilder } 19365 * @syscap SystemCapability.ArkUI.ArkUI.Full 19366 * @since 8 19367 */ 19368 /** 19369 * builder of popup 19370 * 19371 * @type { CustomBuilder } 19372 * @syscap SystemCapability.ArkUI.ArkUI.Full 19373 * @crossplatform 19374 * @since 10 19375 */ 19376 /** 19377 * Popup builder. 19378 * <p><strong>NOTE</strong>: 19379 * <br>The popup attribute is a universal attribute. A custom popup does not support display of another popup. 19380 * <br>The position attribute cannot be used for the first-layer container in the builder. 19381 * <br>If the position attribute is used, the popup will not be displayed. 19382 * <br>If a custom component is used in the builder, the aboutToAppear and aboutToDisappear lifecycle callbacks 19383 * of the custom component are irrelevant to the visibility of the popup. As such, the lifecycle of the 19384 * custom component cannot be used to determine whether the popup is displayed or not. 19385 * </p> 19386 * 19387 * @type { CustomBuilder } 19388 * @syscap SystemCapability.ArkUI.ArkUI.Full 19389 * @crossplatform 19390 * @atomicservice 19391 * @since arkts {'1.1':'11','1.2':'20'} 19392 * @arkts 1.1&1.2 19393 */ 19394 builder: CustomBuilder; 19395 19396 /** 19397 * placement of popup 19398 * 19399 * @type { ?Placement } 19400 * @default Placement.Bottom 19401 * @syscap SystemCapability.ArkUI.ArkUI.Full 19402 * @since 8 19403 */ 19404 /** 19405 * placement of popup 19406 * 19407 * @type { ?Placement } 19408 * @default Placement.Bottom 19409 * @syscap SystemCapability.ArkUI.ArkUI.Full 19410 * @crossplatform 19411 * @since 10 19412 */ 19413 /** 19414 * Preferred position of the popup. If the set position is insufficient for holding the popup, 19415 * it will be automatically adjusted. 19416 * 19417 * @type { ?Placement } 19418 * @default Placement.Bottom 19419 * @syscap SystemCapability.ArkUI.ArkUI.Full 19420 * @crossplatform 19421 * @atomicservice 19422 * @since arkts {'1.1':'11','1.2':'20'} 19423 * @arkts 1.1&1.2 19424 */ 19425 placement?: Placement; 19426 19427 /** 19428 * mask color of popup 19429 * 19430 * @type { ?(Color | string | Resource | number) } 19431 * @syscap SystemCapability.ArkUI.ArkUI.Full 19432 * @since 8 19433 * @deprecated since 10 19434 * @useinstead CustomPopupOptions#mask 19435 */ 19436 maskColor?: Color | string | Resource | number; 19437 19438 /** 19439 * background color of popup 19440 * 19441 * @type { ?(Color | string | Resource | number) } 19442 * @syscap SystemCapability.ArkUI.ArkUI.Full 19443 * @since 8 19444 */ 19445 /** 19446 * background color of popup 19447 * 19448 * @type { ?(Color | string | Resource | number) } 19449 * @default '#4d4d4d' 19450 * @syscap SystemCapability.ArkUI.ArkUI.Full 19451 * @crossplatform 19452 * @since 10 19453 */ 19454 /** 19455 * Color of the popup. To remove the background blur, set backgroundBlurStyle to BlurStyle.NONE. 19456 * 19457 * @type { ?(Color | string | Resource | number) } 19458 * @default TRANSPARENT plus COMPONENT_ULTRA_THICK 19459 * @syscap SystemCapability.ArkUI.ArkUI.Full 19460 * @crossplatform 19461 * @atomicservice 19462 * @since arkts {'1.1':'11','1.2':'20'} 19463 * @arkts 1.1&1.2 19464 */ 19465 popupColor?: Color | string | Resource | number; 19466 19467 /** 19468 * whether show arrow 19469 * 19470 * @type { ?boolean } 19471 * @syscap SystemCapability.ArkUI.ArkUI.Full 19472 * @since 8 19473 */ 19474 /** 19475 * whether show arrow 19476 * 19477 * @type { ?boolean } 19478 * @syscap SystemCapability.ArkUI.ArkUI.Full 19479 * @crossplatform 19480 * @since 10 19481 */ 19482 /** 19483 * whether show arrow 19484 * 19485 * @type { ?boolean } 19486 * @default true 19487 * @syscap SystemCapability.ArkUI.ArkUI.Full 19488 * @crossplatform 19489 * @atomicservice 19490 * @since arkts {'1.1':'11','1.2':'20'} 19491 * @arkts 1.1&1.2 19492 */ 19493 enableArrow?: boolean; 19494 19495 /** 19496 * whether hide popup when click mask. 19497 * 19498 * @type { ?boolean } 19499 * @syscap SystemCapability.ArkUI.ArkUI.Full 19500 * @since 8 19501 */ 19502 /** 19503 * whether hide popup when click mask. 19504 * 19505 * @type { ?boolean } 19506 * @syscap SystemCapability.ArkUI.ArkUI.Full 19507 * @crossplatform 19508 * @since 10 19509 */ 19510 /** 19511 * Whether to automatically dismiss the popup when an operation is performed on the page. 19512 * <p><strong>NOTE</strong>: 19513 * <br>To enable the popup to disappear upon a click on it, place a layout component in the builder place the 19514 * <Popup> component in the layout component, and modify the value of the bindPopup variable (show: boolean) 19515 * in the onClick event of the layout component. 19516 * </p> 19517 * 19518 * @type { ?boolean } 19519 * @default true 19520 * @syscap SystemCapability.ArkUI.ArkUI.Full 19521 * @crossplatform 19522 * @atomicservice 19523 * @since arkts {'1.1':'11','1.2':'20'} 19524 * @arkts 1.1&1.2 19525 */ 19526 autoCancel?: boolean; 19527 19528 /** 19529 * on State Change 19530 * 19531 * @type { ?function } 19532 * @syscap SystemCapability.ArkUI.ArkUI.Full 19533 * @since 8 19534 */ 19535 /** 19536 * on State Change 19537 * 19538 * @type { ?function } 19539 * @syscap SystemCapability.ArkUI.ArkUI.Full 19540 * @crossplatform 19541 * @since 10 19542 */ 19543 /** 19544 * Callback for the popup status change event. 19545 * 19546 * @type { ?function } 19547 * @syscap SystemCapability.ArkUI.ArkUI.Full 19548 * @crossplatform 19549 * @atomicservice 19550 * @since 11 19551 */ 19552 onStateChange?: (event: { 19553 /** 19554 * is Visible. 19555 * 19556 * @type { boolean } 19557 * @syscap SystemCapability.ArkUI.ArkUI.Full 19558 * @crossplatform 19559 * @since 10 19560 */ 19561 /** 19562 * is Visible. 19563 * 19564 * @type { boolean } 19565 * @syscap SystemCapability.ArkUI.ArkUI.Full 19566 * @crossplatform 19567 * @atomicservice 19568 * @since 11 19569 */ 19570 isVisible: boolean 19571 }) => void; 19572 19573 /** 19574 * on State Change 19575 * 19576 * @type { ?PopupStateChangeCallback } 19577 * @syscap SystemCapability.ArkUI.ArkUI.Full 19578 * @crossplatform 19579 * @atomicservice 19580 * @since 20 19581 * @arkts 1.2 19582 */ 19583 onStateChange?: PopupStateChangeCallback; 19584 19585 /** 19586 * The offset of the sharp corner of popup. 19587 * 19588 * @type { ?Length } 19589 * @syscap SystemCapability.ArkUI.ArkUI.Full 19590 * @since 9 19591 */ 19592 /** 19593 * The offset of the sharp corner of popup. 19594 * 19595 * @type { ?Length } 19596 * @syscap SystemCapability.ArkUI.ArkUI.Full 19597 * @crossplatform 19598 * @since 10 19599 */ 19600 /** 19601 * The offset of the sharp corner of popup. 19602 * 19603 * Offset of the popup arrow relative to the popup. When the arrow is at the top or bottom of the popup: 19604 * <br>The value 0 indicates that the arrow is located on the leftmost, and any other value indicates the distance 19605 * from the arrow to the leftmost; the arrow is centered by default. When the arrow is on the left or right 19606 * side of the popup: The value indicates the distance from the arrow to the top; the arrow is centered by 19607 * default. When the popup is displayed on either edge of the screen, it will automatically deviate leftward 19608 * or rightward to stay within the safe area. When the value is 0, the arrow always points to the bound component. 19609 * 19610 * @type { ?Length } 19611 * @syscap SystemCapability.ArkUI.ArkUI.Full 19612 * @crossplatform 19613 * @atomicservice 19614 * @since arkts {'1.1':'11','1.2':'20'} 19615 * @arkts 1.1&1.2 19616 */ 19617 arrowOffset?: Length; 19618 19619 /** 19620 * Whether to display in the sub window. 19621 * 19622 * @type { ?boolean } 19623 * @syscap SystemCapability.ArkUI.ArkUI.Full 19624 * @since 9 19625 */ 19626 /** 19627 * Whether to display in the sub window. 19628 * 19629 * @type { ?boolean } 19630 * @syscap SystemCapability.ArkUI.ArkUI.Full 19631 * @crossplatform 19632 * @since 10 19633 */ 19634 /** 19635 * Whether to display in the sub window. 19636 * 19637 * @type { ?boolean } 19638 * @default false 19639 * @syscap SystemCapability.ArkUI.ArkUI.Full 19640 * @crossplatform 19641 * @atomicservice 19642 * @since arkts {'1.1':'11','1.2':'20'} 19643 * @arkts 1.1&1.2 19644 */ 19645 showInSubWindow?: boolean; 19646 19647 /** 19648 * The mask to block gesture events of popup. 19649 * When mask is set false, gesture events are not blocked. 19650 * When mask is set true, gesture events are blocked and mask color is transparent. 19651 * 19652 * @type { ?(boolean | { color: ResourceColor }) } 19653 * @syscap SystemCapability.ArkUI.ArkUI.Full 19654 * @crossplatform 19655 * @since 10 19656 */ 19657 /** 19658 * Whether to apply a mask to the popup. 19659 * <br>The value true means to apply a transparent mask to the popup, false means not to apply a mask to the popup, 19660 * and a color value means to apply a mask in the corresponding color to the popup. 19661 * 19662 * @type { ?(boolean | { color: ResourceColor }) } 19663 * @syscap SystemCapability.ArkUI.ArkUI.Full 19664 * @crossplatform 19665 * @atomicservice 19666 * @since 11 19667 */ 19668 mask?: boolean | { color: ResourceColor }; 19669 19670 /** 19671 * The mask to block gesture events of popup. 19672 * When mask is set false, gesture events are not blocked. 19673 * When mask is set true, gesture events are blocked and mask color is transparent. 19674 * 19675 * @type { ?(boolean | PopupMaskType) } 19676 * @syscap SystemCapability.ArkUI.ArkUI.Full 19677 * @crossplatform 19678 * @atomicservice 19679 * @since 20 19680 * @arkts 1.2 19681 */ 19682 mask?: boolean | PopupMaskType; 19683 19684 /** 19685 * Sets the space of between the popup and target. 19686 * 19687 * @type { ?Length } 19688 * @syscap SystemCapability.ArkUI.ArkUI.Full 19689 * @crossplatform 19690 * @since 10 19691 */ 19692 /** 19693 * Sets the space of between the popup and target. 19694 * 19695 * @type { ?Length } 19696 * @syscap SystemCapability.ArkUI.ArkUI.Full 19697 * @crossplatform 19698 * @atomicservice 19699 * @since arkts {'1.1':'11','1.2':'20'} 19700 * @arkts 1.1&1.2 19701 */ 19702 targetSpace?: Length 19703 19704 /** 19705 * Sets the position offset of the popup. 19706 * 19707 * @type { ?Position } 19708 * @syscap SystemCapability.ArkUI.ArkUI.Full 19709 * @crossplatform 19710 * @since 10 19711 */ 19712 /** 19713 * Sets the position offset of the popup. 19714 * 19715 * @type { ?Position } 19716 * @default { x: 0, y: 0 } 19717 * @syscap SystemCapability.ArkUI.ArkUI.Full 19718 * @crossplatform 19719 * @atomicservice 19720 * @since arkts {'1.1':'11','1.2':'20'} 19721 * @arkts 1.1&1.2 19722 */ 19723 offset?: Position 19724 19725 /** 19726 * Set the width of the popup. 19727 * 19728 * @type { ?Dimension } 19729 * @syscap SystemCapability.ArkUI.ArkUI.Full 19730 * @crossplatform 19731 * @since 11 19732 */ 19733 /** 19734 * Width of the popup. 19735 * 19736 * @type { ?Dimension } 19737 * @syscap SystemCapability.ArkUI.ArkUI.Full 19738 * @crossplatform 19739 * @atomicservice 19740 * @since arkts {'1.1':'12','1.2':'20'} 19741 * @arkts 1.1&1.2 19742 */ 19743 width?: Dimension; 19744 19745 /** 19746 * The position of the sharp corner of popup. 19747 * 19748 * @type { ?ArrowPointPosition } 19749 * @syscap SystemCapability.ArkUI.ArkUI.Full 19750 * @crossplatform 19751 * @since 11 19752 */ 19753 /** 19754 * Position of the popup arrow relative to its parent component. Available positions are Start, Center, and End, 19755 * in both vertical and horizontal directions. All these positions are within the parent component area. 19756 * 19757 * @type { ?ArrowPointPosition } 19758 * @syscap SystemCapability.ArkUI.ArkUI.Full 19759 * @crossplatform 19760 * @atomicservice 19761 * @since arkts {'1.1':'12','1.2':'20'} 19762 * @arkts 1.1&1.2 19763 */ 19764 arrowPointPosition?: ArrowPointPosition; 19765 19766 /** 19767 * The width of the arrow. 19768 * 19769 * @type { ?Dimension } 19770 * @default 16.0_vp. 19771 * @syscap SystemCapability.ArkUI.ArkUI.Full 19772 * @crossplatform 19773 * @since 11 19774 */ 19775 /** 19776 * Arrow thickness. If the arrow thickness exceeds the length of the edge minus twice the size of the popup 19777 * rounded corner, the arrow is not drawn. 19778 * 19779 * @type { ?Dimension } 19780 * @default 16.0_vp. 19781 * <p><strong>NOTE</strong>: 19782 * <br>This parameter cannot be set in percentage. 19783 * </p> 19784 * 19785 * @syscap SystemCapability.ArkUI.ArkUI.Full 19786 * @crossplatform 19787 * @atomicservice 19788 * @since arkts {'1.1':'12','1.2':'20'} 19789 * @arkts 1.1&1.2 19790 */ 19791 arrowWidth?: Dimension; 19792 19793 /** 19794 * The height of the arrow. 19795 * 19796 * @type { ?Dimension } 19797 * @default 8.0_vp. 19798 * @syscap SystemCapability.ArkUI.ArkUI.Full 19799 * @crossplatform 19800 * @since 11 19801 */ 19802 /** 19803 * The height of the arrow. 19804 * 19805 * @type { ?Dimension } 19806 * @default 8.0_vp. 19807 * <p><strong>NOTE</strong>: 19808 * <br>This parameter cannot be set in percentage. 19809 * </p> 19810 * 19811 * @syscap SystemCapability.ArkUI.ArkUI.Full 19812 * @crossplatform 19813 * @atomicservice 19814 * @since arkts {'1.1':'12','1.2':'20'} 19815 * @arkts 1.1&1.2 19816 */ 19817 arrowHeight?: Dimension; 19818 19819 /** 19820 * The round corners of the popup. 19821 * 19822 * @type { ?Dimension } 19823 * @default 20.0_vp. 19824 * @syscap SystemCapability.ArkUI.ArkUI.Full 19825 * @crossplatform 19826 * @since 11 19827 */ 19828 /** 19829 * Rounded corner radius of the popup. 19830 * 19831 * @type { ?Dimension } 19832 * @default 20.0_vp. 19833 * @syscap SystemCapability.ArkUI.ArkUI.Full 19834 * @crossplatform 19835 * @atomicservice 19836 * @since arkts {'1.1':'12','1.2':'20'} 19837 * @arkts 1.1&1.2 19838 */ 19839 radius?: Dimension; 19840 19841 /** 19842 * The style of popup Shadow. 19843 * 19844 * @type { ?(ShadowOptions | ShadowStyle) } 19845 * @default ShadowStyle.OUTER_DEFAULT_MD. 19846 * @syscap SystemCapability.ArkUI.ArkUI.Full 19847 * @crossplatform 19848 * @since 11 19849 */ 19850 /** 19851 * Popup shadow. 19852 * 19853 * @type { ?(ShadowOptions | ShadowStyle) } 19854 * @default ShadowStyle.OUTER_DEFAULT_MD. 19855 * @syscap SystemCapability.ArkUI.ArkUI.Full 19856 * @crossplatform 19857 * @atomicservice 19858 * @since arkts {'1.1':'12','1.2':'20'} 19859 * @arkts 1.1&1.2 19860 */ 19861 shadow?: ShadowOptions | ShadowStyle; 19862 19863 /** 19864 * Defines popup background blur Style 19865 * 19866 * @type { ?BlurStyle } 19867 * @default BlurStyle.COMPONENT_ULTRA_THICK 19868 * @syscap SystemCapability.ArkUI.ArkUI.Full 19869 * @crossplatform 19870 * @since 11 19871 */ 19872 /** 19873 * Background blur style of the popup. 19874 * 19875 * @type { ?BlurStyle } 19876 * @default BlurStyle.COMPONENT_ULTRA_THICK 19877 * @syscap SystemCapability.ArkUI.ArkUI.Full 19878 * @crossplatform 19879 * @atomicservice 19880 * @since arkts {'1.1':'12','1.2':'20'} 19881 * @arkts 1.1&1.2 19882 */ 19883 backgroundBlurStyle?: BlurStyle; 19884 19885 /** 19886 * Set popup focusable 19887 * 19888 * @type { ?boolean } 19889 * @default true 19890 * @syscap SystemCapability.ArkUI.ArkUI.Full 19891 * @crossplatform 19892 * @since 11 19893 */ 19894 /** 19895 * Set popup focusable 19896 * 19897 * @type { ?boolean } 19898 * @default false 19899 * @syscap SystemCapability.ArkUI.ArkUI.Full 19900 * @crossplatform 19901 * @atomicservice 19902 * @since arkts {'1.1':'12','1.2':'20'} 19903 * @arkts 1.1&1.2 19904 */ 19905 focusable?: boolean; 19906 19907 /** 19908 * Defines the transition effect of popup opening and closing 19909 * 19910 * @type { ?TransitionEffect } 19911 * @syscap SystemCapability.ArkUI.ArkUI.Full 19912 * @crossplatform 19913 * @atomicservice 19914 * @since arkts {'1.1':'12','1.2':'20'} 19915 * @arkts 1.1&1.2 19916 */ 19917 transition?: TransitionEffect; 19918 19919 /** 19920 * Whether to perform dismissal event interception and interception callback. 19921 * 1. If this parameter is set to false, the system does not respond to the dismissal event initiated by 19922 * touching the Back button, swiping left or right on the screen, or pressing the Esc key; and the system 19923 * dismisses the popup only when show is set to false. If this parameter is set to true, the system responds 19924 * to the dismissal event as expected. 19925 * 2. If this parameter is set to a function, the dismissal event is intercepted and the callback function 19926 * is executed. 19927 * <p><strong>NOTE</strong>: 19928 * <br>No more onWillDismiss callback is allowed in an onWillDismiss callback. 19929 * </p> 19930 * 19931 * @type { ?(boolean | Callback<DismissPopupAction>) } 19932 * @default true 19933 * @syscap SystemCapability.ArkUI.ArkUI.Full 19934 * @crossplatform 19935 * @atomicservice 19936 * @since arkts {'1.1':'12','1.2':'20'} 19937 * @arkts 1.1&1.2 19938 */ 19939 onWillDismiss?: boolean | Callback<DismissPopupAction>; 19940 19941 /** 19942 * Determine if it is compatible popup's half folded. 19943 * 19944 * @type { ?boolean } 19945 * @default false 19946 * @syscap SystemCapability.ArkUI.ArkUI.Full 19947 * @crossplatform 19948 * @atomicservice 19949 * @since arkts {'1.1':'18','1.2':'20'} 19950 * @arkts 1.1&1.2 19951 */ 19952 enableHoverMode?: boolean; 19953 19954 /** 19955 * Determine if popup can follow the target node when it has rotation or scale. 19956 * 19957 * @type { ?boolean } 19958 * @default false 19959 * @syscap SystemCapability.ArkUI.ArkUI.Full 19960 * @crossplatform 19961 * @atomicservice 19962 * @since arkts {'1.1':'13','1.2':'20'} 19963 * @arkts 1.1&1.2 19964 */ 19965 followTransformOfTarget?: boolean; 19966 19967 /** 19968 * Define the popup avoid keyboard mode. 19969 * 19970 * @type { ?KeyboardAvoidMode } 19971 * @default KeyboardAvoidMode.NONE 19972 * @syscap SystemCapability.ArkUI.ArkUI.Full 19973 * @crossplatform 19974 * @atomicservice 19975 * @since arkts {'1.1':'15','1.2':'20'} 19976 * @arkts 1.1&1.2 19977 */ 19978 keyboardAvoidMode?: KeyboardAvoidMode; 19979 19980 /** 19981 * Determine if popup can avoid the target when the display space is insufficient. 19982 * 19983 * @type { ?AvoidanceMode } 19984 * @default AvoidanceMode.COVER_TARGET 19985 * @syscap SystemCapability.ArkUI.ArkUI.Full 19986 * @crossplatform 19987 * @atomicservice 19988 * @since 20 19989 */ 19990 avoidTarget?: AvoidanceMode; 19991 19992 /** 19993 * The width of popup's outline. 19994 * 19995 * @type { ?Dimension } 19996 * @syscap SystemCapability.ArkUI.ArkUI.Full 19997 * @crossplatform 19998 * @atomicservice 19999 * @since 20 20000 */ 20001 outlineWidth?: Dimension; 20002 20003 /** 20004 * The width of popup's border. 20005 * 20006 * @type { ?Dimension } 20007 * @syscap SystemCapability.ArkUI.ArkUI.Full 20008 * @crossplatform 20009 * @atomicservice 20010 * @since 20 20011 */ 20012 borderWidth?: Dimension; 20013 20014 /** 20015 * The LinearGradient of popup's outline. 20016 * 20017 * @type { ?PopupBorderLinearGradient } 20018 * @syscap SystemCapability.ArkUI.ArkUI.Full 20019 * @crossplatform 20020 * @atomicservice 20021 * @since 20 20022 */ 20023 outlineLinearGradient?: PopupBorderLinearGradient; 20024 20025 /** 20026 * The LinearGradient of popup's innerline. 20027 * 20028 * @type { ?PopupBorderLinearGradient } 20029 * @syscap SystemCapability.ArkUI.ArkUI.Full 20030 * @crossplatform 20031 * @atomicservice 20032 * @since 20 20033 */ 20034 borderLinearGradient?: PopupBorderLinearGradient; 20035} 20036 20037/** 20038 * Defines the menu preview mode. 20039 * 20040 * @enum { number } 20041 * @syscap SystemCapability.ArkUI.ArkUI.Full 20042 * @crossplatform 20043 * @since 11 20044 */ 20045/** 20046 * Defines the menu preview mode. 20047 * 20048 * @enum { number } 20049 * @syscap SystemCapability.ArkUI.ArkUI.Full 20050 * @crossplatform 20051 * @atomicservice 20052 * @since arkts {'1.1':'12','1.2':'20'} 20053 * @arkts 1.1&1.2 20054 */ 20055declare enum MenuPreviewMode { 20056 /** 20057 * No preview content. 20058 * 20059 * @syscap SystemCapability.ArkUI.ArkUI.Full 20060 * @crossplatform 20061 * @since 11 20062 */ 20063 /** 20064 * No preview content. 20065 * 20066 * @syscap SystemCapability.ArkUI.ArkUI.Full 20067 * @crossplatform 20068 * @atomicservice 20069 * @since arkts {'1.1':'12','1.2':'20'} 20070 * @arkts 1.1&1.2 20071 */ 20072 NONE = 0, 20073 /** 20074 * Defines image type preview content. 20075 * 20076 * @syscap SystemCapability.ArkUI.ArkUI.Full 20077 * @crossplatform 20078 * @since 11 20079 */ 20080 /** 20081 * The preview is a screenshot of the component on which a long-press triggers the context menu. 20082 * 20083 * @syscap SystemCapability.ArkUI.ArkUI.Full 20084 * @crossplatform 20085 * @atomicservice 20086 * @since arkts {'1.1':'12','1.2':'20'} 20087 * @arkts 1.1&1.2 20088 */ 20089 IMAGE = 1 20090} 20091 20092/** 20093 * Defines the animator range of start and end property. 20094 * 20095 * @typedef { [from: T, to: T] } AnimationRange<T> 20096 * @syscap SystemCapability.ArkUI.ArkUI.Full 20097 * @crossplatform 20098 * @since 11 20099 */ 20100/** 20101 * Defines the animator range of start and end property. 20102 * 20103 * @typedef { [from: T, to: T] } AnimationRange<T> 20104 * @syscap SystemCapability.ArkUI.ArkUI.Full 20105 * @crossplatform 20106 * @atomicservice 20107 * @since 12 20108 */ 20109declare type AnimationRange<T> = [from: T, to: T]; 20110 20111/** 20112 * Defines the animator range of start and end property. 20113 * 20114 * @typedef { [number, number] } AnimationNumberRange 20115 * @syscap SystemCapability.ArkUI.ArkUI.Full 20116 * @crossplatform 20117 * @atomicservice 20118 * @since 20 20119 * @arkts 1.2 20120 */ 20121declare type AnimationNumberRange = [number, number]; 20122 20123/** 20124 * Defines the ContextMenu's preview animator options. 20125 * 20126 * @interface ContextMenuAnimationOptions 20127 * @syscap SystemCapability.ArkUI.ArkUI.Full 20128 * @crossplatform 20129 * @since 11 20130 */ 20131/** 20132 * Defines the ContextMenu's preview animator options. 20133 * 20134 * @interface ContextMenuAnimationOptions 20135 * @syscap SystemCapability.ArkUI.ArkUI.Full 20136 * @crossplatform 20137 * @atomicservice 20138 * @since arkts {'1.1':'12','1.2':'20'} 20139 * @arkts 1.1&1.2 20140 */ 20141interface ContextMenuAnimationOptions { 20142 /** 20143 * Sets the start animator scale and end animator scale. 20144 * 20145 * @type { ?AnimationRange<number> } 20146 * @default [0.95, 1.1] 20147 * @syscap SystemCapability.ArkUI.ArkUI.Full 20148 * @crossplatform 20149 * @since 11 20150 */ 20151 /** 20152 * Sets the start animator scale and end animator scale. 20153 * 20154 * @type { ?AnimationRange<number> } 20155 * @syscap SystemCapability.ArkUI.ArkUI.Full 20156 * @crossplatform 20157 * @atomicservice 20158 * @since 12 20159 */ 20160 scale?: AnimationRange<number>; 20161 /** 20162 * Sets the start animator scale and end animator scale. 20163 * 20164 * @type { ?AnimationNumberRange } 20165 * @default - 20166 * @syscap SystemCapability.ArkUI.ArkUI.Full 20167 * @crossplatform 20168 * @atomicservice 20169 * @since 20 20170 * @arkts 1.2 20171 */ 20172 scale?: AnimationNumberRange; 20173 /** 20174 * Defines the transition effect of menu preview opening and closing. 20175 * 20176 * @type { ?TransitionEffect } 20177 * @syscap SystemCapability.ArkUI.ArkUI.Full 20178 * @crossplatform 20179 * @atomicservice 20180 * @since arkts {'1.1':'12','1.2':'20'} 20181 * @arkts 1.1&1.2 20182 */ 20183 transition?: TransitionEffect; 20184 20185 /** 20186 * Sets the scale start and end animator of the image displayed before the custom builder preview is displayed. 20187 * 20188 * @type { ?AnimationRange<number> } 20189 * @syscap SystemCapability.ArkUI.ArkUI.Full 20190 * @crossplatform 20191 * @atomicservice 20192 * @since 12 20193 */ 20194 hoverScale?: AnimationRange<number>; 20195 20196 /** 20197 * Sets the scale start and end animator of the image displayed before the custom builder preview is displayed. 20198 * 20199 * @type { ?AnimationNumberRange } 20200 * @syscap SystemCapability.ArkUI.ArkUI.Full 20201 * @crossplatform 20202 * @atomicservice 20203 * @since 20 20204 * @arkts 1.2 20205 */ 20206 hoverScale?: AnimationNumberRange; 20207 20208 /** 20209 * Sets whether support to interrupt the process of hover scale. 20210 * 20211 * @type { ?boolean } 20212 * @default false 20213 * @syscap SystemCapability.ArkUI.ArkUI.Full 20214 * @crossplatform 20215 * @atomicservice 20216 * @since 20 20217 */ 20218 hoverScaleInterruption?: boolean; 20219} 20220 20221/** 20222 * Defines the type of border radius. 20223 * 20224 * @typedef { Length | BorderRadiuses | LocalizedBorderRadiuses } 20225 * @syscap SystemCapability.ArkUI.ArkUI.Full 20226 * @crossplatform 20227 * @atomicservice 20228 * @since arkts {'1.1':'19','1.2':'20'} 20229 * @arkts 1.1&1.2 20230 */ 20231type BorderRadiusType = Length | BorderRadiuses | LocalizedBorderRadiuses; 20232 20233/** 20234 * Defines the menu haptic feedback mode. 20235 * 20236 * @enum { number } 20237 * @syscap SystemCapability.ArkUI.ArkUI.Full 20238 * @crossplatform 20239 * @atomicservice 20240 * @since arkts {'1.1':'18','1.2':'20'} 20241 * @arkts 1.1&1.2 20242 */ 20243declare enum HapticFeedbackMode { 20244 /** 20245 * No haptic feedback. 20246 * 20247 * @syscap SystemCapability.ArkUI.ArkUI.Full 20248 * @crossplatform 20249 * @atomicservice 20250 * @since arkts {'1.1':'18','1.2':'20'} 20251 * @arkts 1.1&1.2 20252 */ 20253 DISABLED = 0, 20254 /** 20255 * Defines menu always haptic feedback. 20256 * 20257 * @syscap SystemCapability.ArkUI.ArkUI.Full 20258 * @crossplatform 20259 * @atomicservice 20260 * @since arkts {'1.1':'18','1.2':'20'} 20261 * @arkts 1.1&1.2 20262 */ 20263 ENABLED = 1, 20264 /** 20265 * Defines menu automatically haptic feedback. 20266 * 20267 * @syscap SystemCapability.ArkUI.ArkUI.Full 20268 * @crossplatform 20269 * @atomicservice 20270 * @since arkts {'1.1':'18','1.2':'20'} 20271 * @arkts 1.1&1.2 20272 */ 20273 AUTO = 2 20274} 20275 20276/** 20277 * Define the modal mode of menu. 20278 * 20279 * @enum { number } 20280 * @syscap SystemCapability.ArkUI.ArkUI.Full 20281 * @crossplatform 20282 * @atomicservice 20283 * @since 20 20284 */ 20285declare enum ModalMode { 20286 /** 20287 * Modal modal automatically. 20288 * 20289 * @syscap SystemCapability.ArkUI.ArkUI.Full 20290 * @crossplatform 20291 * @atomicservice 20292 * @since 20 20293 */ 20294 AUTO = 0, 20295 /** 20296 * Operation takes effect around menu. 20297 * 20298 * @syscap SystemCapability.ArkUI.ArkUI.Full 20299 * @crossplatform 20300 * @atomicservice 20301 * @since 20 20302 */ 20303 NONE = 1, 20304 /** 20305 * Operation takes no effect around menu in target window. 20306 * 20307 * @syscap SystemCapability.ArkUI.ArkUI.Full 20308 * @crossplatform 20309 * @atomicservice 20310 * @since 20 20311 */ 20312 TARGET_WINDOW = 2 20313} 20314 20315/** 20316 * Menu mask type 20317 * 20318 * @interface MenuMaskType 20319 * @syscap SystemCapability.ArkUI.ArkUI.Full 20320 * @crossplatform 20321 * @atomicservice 20322 * @since 20 20323 */ 20324declare interface MenuMaskType { 20325 /** 20326 * Mask color of menu. 20327 * 20328 * @type { ?ResourceColor } 20329 * @syscap SystemCapability.ArkUI.ArkUI.Full 20330 * @crossplatform 20331 * @atomicservice 20332 * @since 20 20333 */ 20334 color?: ResourceColor; 20335 20336 /** 20337 * Set menu mask background blur Style. 20338 * 20339 * @type { ?BlurStyle } 20340 * @default BlurStyle.BACKGROUND_THIN 20341 * @syscap SystemCapability.ArkUI.ArkUI.Full 20342 * @crossplatform 20343 * @atomicservice 20344 * @since 20 20345 */ 20346 backgroundBlurStyle?: BlurStyle; 20347} 20348 20349/** 20350 * Defines the scaling mode for custom preview of contextMenu. 20351 * 20352 * @enum { number } 20353 * @syscap SystemCapability.ArkUI.ArkUI.Full 20354 * @crossplatform 20355 * @atomicservice 20356 * @since 20 20357 */ 20358declare enum PreviewScaleMode { 20359 /** 20360 * Automatically resize preview based on the layout area. 20361 * 20362 * @syscap SystemCapability.ArkUI.ArkUI.Full 20363 * @crossplatform 20364 * @atomicservice 20365 * @since 20 20366 */ 20367 AUTO = 0, 20368 20369 /** 20370 * Maintain original size of preview content without scaling. 20371 * 20372 * @syscap SystemCapability.ArkUI.ArkUI.Full 20373 * @crossplatform 20374 * @atomicservice 20375 * @since 20 20376 */ 20377 CONSTANT = 1, 20378 20379 /** 20380 * Maintain aspect ratio to scale preview. 20381 * 20382 * @syscap SystemCapability.ArkUI.ArkUI.Full 20383 * @crossplatform 20384 * @atomicservice 20385 * @since 20 20386 */ 20387 MAINTAIN = 2, 20388} 20389 20390/** 20391 * Defines the available layout area. 20392 * 20393 * @enum { number } 20394 * @syscap SystemCapability.ArkUI.ArkUI.Full 20395 * @crossplatform 20396 * @atomicservice 20397 * @since 20 20398 */ 20399declare enum AvailableLayoutArea { 20400 /** 20401 * Size of safe area. 20402 * 20403 * @syscap SystemCapability.ArkUI.ArkUI.Full 20404 * @crossplatform 20405 * @atomicservice 20406 * @since 20 20407 */ 20408 SAFE_AREA = 0, 20409} 20410 20411/** 20412 * Defines the context menu options. 20413 * 20414 * @interface ContextMenuOptions 20415 * @syscap SystemCapability.ArkUI.ArkUI.Full 20416 * @crossplatform 20417 * @since 10 20418 */ 20419/** 20420 * Defines the context menu options. 20421 * 20422 * @interface ContextMenuOptions 20423 * @syscap SystemCapability.ArkUI.ArkUI.Full 20424 * @crossplatform 20425 * @atomicservice 20426 * @since arkts {'1.1':'11','1.2':'20'} 20427 * @arkts 1.1&1.2 20428 */ 20429declare interface ContextMenuOptions { 20430 /** 20431 * Sets the position offset of the context menu window. 20432 * 20433 * @type { ?Position } 20434 * @default - 20435 * @syscap SystemCapability.ArkUI.ArkUI.Full 20436 * @crossplatform 20437 * @since 10 20438 */ 20439 /** 20440 * Offset for showing the context menu, which should not cause the menu to extend beyond the screen. 20441 * <p><strong>NOTE</strong>: 20442 * <br>When the menu is displayed relative to the parent component area, the width or height of the area is 20443 * automatically counted into the offset based on the placement attribute of the menu. When the menu is 20444 * displayed above the parent component (that is, placement is set to Placement.TopLeft, Placement.Top, or 20445 * Placement.TopRight), a positive value of x indicates rightward movement relative to the parent component, 20446 * and a positive value of y indicates upward movement. When the menu is displayed below the parent component 20447 * (that is, placement is set to Placement.BottomLeft, Placement.Bottom, or Placement.BottomRight), a positive 20448 * value of x indicates rightward movement relative to the parent component, and a positive value of y indicates 20449 * downward movement. When the menu is displayed on the left of the parent component (that is, placement is set 20450 * to Placement.LeftTop, Placement.Left, or Placement.LeftBottom), a positive value of x indicates leftward 20451 * movement relative to the parent component, and a positive value of y indicates downward movement. When the 20452 * menu is displayed on the right of the parent component (that is, placement is set to Placement.RightTop, 20453 * Placement.Right, or Placement.RightBottom), a positive value of x indicates rightward movement relative to 20454 * the parent component, and a positive value of y indicates downward movement. If the display position of the 20455 * menu is adjusted (different from the main direction of the initial placement value), the offset value is invalid. 20456 * </p> 20457 * 20458 * @type { ?Position } 20459 * @default {x:0,y:0} - Percentage values are not supported. 20460 * @syscap SystemCapability.ArkUI.ArkUI.Full 20461 * @crossplatform 20462 * @atomicservice 20463 * @since arkts {'1.1':'11','1.2':'20'} 20464 * @arkts 1.1&1.2 20465 */ 20466 offset?: Position; 20467 20468 /** 20469 * Sets the placement of the context menu window. 20470 * 20471 * @type { ?Placement } 20472 * @default - 20473 * @syscap SystemCapability.ArkUI.ArkUI.Full 20474 * @crossplatform 20475 * @since 10 20476 */ 20477 /** 20478 * Preferred position of the context menu. If the set position is insufficient for holding the component, it will be 20479 * automatically adjusted. 20480 * <p><strong>NOTE</strong>: 20481 * <br>If a menu is displayed by pressing and holding or right-clicking, the menu is displayed at the clicked 20482 * position. 20483 * </p> 20484 * 20485 * @type { ?Placement } 20486 * @default Placement.BottomLeft 20487 * @syscap SystemCapability.ArkUI.ArkUI.Full 20488 * @crossplatform 20489 * @atomicservice 20490 * @since arkts {'1.1':'11','1.2':'20'} 20491 * @arkts 1.1&1.2 20492 */ 20493 placement?: Placement; 20494 20495 /** 20496 * whether show arrow belong to the menu. 20497 * 20498 * @type { ?boolean } 20499 * @default false 20500 * @syscap SystemCapability.ArkUI.ArkUI.Full 20501 * @since 10 20502 */ 20503 /** 20504 * whether show arrow belong to the menu. 20505 * <p><strong>NOTE</strong>: 20506 * <br>When enableArrow is true, an arrow is displayed in the position specified by placement. 20507 * <br>If placement is not set or its value is invalid, the arrow is displayed above the target. 20508 * <br>If the position is insufficient for holding the arrow, it is automatically adjusted. 20509 * <br>When enableArrow is undefined, no arrow is displayed. 20510 * <br>This API is supported in bindContextMenu since API version 10 and bindMenu since API version 12. 20511 * </p> 20512 * 20513 * @type { ?boolean } 20514 * @default false 20515 * @syscap SystemCapability.ArkUI.ArkUI.Full 20516 * @crossplatform 20517 * @atomicservice 20518 * @since arkts {'1.1':'11','1.2':'20'} 20519 * @arkts 1.1&1.2 20520 */ 20521 enableArrow?: boolean; 20522 20523 /** 20524 * The horizontal offset to the left of menu or vertical offset to the top of menu 20525 * 20526 * @type { ?Length } 20527 * @default 0vp 20528 * @syscap SystemCapability.ArkUI.ArkUI.Full 20529 * @since 10 20530 */ 20531 /** 20532 * Offset of the arrow relative to the context menu. The offset settings take effect only when the value is valid, 20533 * can be converted to a number greater than 0, and does not cause the arrow to extend beyond the safe area of 20534 * the context menu. 20535 * <p><strong>NOTE</strong>: 20536 * <br>The safe distance of the arrow from the four sides of the menu is the sum of the menu's corner radius and 20537 * half the width of the arrow. The value of placement determines whether the offset is horizontal or vertical. 20538 * When the arrow is in the horizontal direction of the menu, the offset is the distance from the arrow to the 20539 * leftmost arrow's safe distance. When the arrow is in the vertical direction of the menu, the offset is the 20540 * distance from the arrow to the topmost arrow's safe distance. The default position where the arrow is 20541 * displayed varies with the value of placement: Without any avoidance by the menu, when placement is set to 20542 * Placement.Top or Placement.Bottom, the arrow is displayed horizontally and is centered by default; when 20543 * placement is set to Placement.Left or Placement.Right, the arrow is displayed vertically and is centered by 20544 * default; when placement is set to Placement.TopLeft or Placement.BottomLeft, the arrow is displayed 20545 * horizontally by default, and the distance from the arrow to the left edge of the menu is the arrow's safe 20546 * distance; when placement is set to Placement.TopRight or Placement.BottomRight, the arrow is displayed 20547 * horizontally by default, and the distance from the arrow to the right edge of the menu is the arrow's safe 20548 * distance; when placement is set to Placement.LeftTop or Placement.RightTop, the arrow is displayed vertically 20549 * by default, and the distance from the arrow to the top edge of the menu is the arrow's safe distance; when 20550 * placement is set to Placement.LeftBottom or Placement.RightBottom, the arrow is displayed vertically by 20551 * default, and the distance from the arrow to the bottom edge of the menu is the arrow's safe distance. 20552 * <br>This API is supported in bindContextMenu since API version 10 and bindMenu since API version 12. 20553 * </p> 20554 * 20555 * @type { ?Length } 20556 * @default 0vp 20557 * @syscap SystemCapability.ArkUI.ArkUI.Full 20558 * @crossplatform 20559 * @atomicservice 20560 * @since arkts {'1.1':'11','1.2':'20'} 20561 * @arkts 1.1&1.2 20562 */ 20563 arrowOffset?: Length; 20564 20565 /** 20566 * The preview content of context menu. 20567 * 20568 * @type { ?(MenuPreviewMode | CustomBuilder) } 20569 * @default MenuPreviewMode.NONE 20570 * @syscap SystemCapability.ArkUI.ArkUI.Full 20571 * @crossplatform 20572 * @since 11 20573 */ 20574 /** 20575 * Preview displayed when the context menu is triggered by a long-press or use the isShown variable of 20576 * bindContextMenu to display the preview content style of the menu. 20577 * <p><strong>NOTE</strong>: 20578 * <br>This parameter has no effect when responseType is set to ResponseType.RightClick. 20579 * <br>If preview is set to MenuPreviewMode.NONE or is not set, the enableArrow parameter is effective. 20580 * <br>If preview is set to MenuPreviewMode.IMAGE or CustomBuilder, no arrow will be displayed even when 20581 * enableArrow is true. 20582 * </p> 20583 * 20584 * @type { ?(MenuPreviewMode | CustomBuilder) } 20585 * @default MenuPreviewMode.NONE 20586 * @syscap SystemCapability.ArkUI.ArkUI.Full 20587 * @crossplatform 20588 * @atomicservice 20589 * @since arkts {'1.1':'12','1.2':'20'} 20590 * @arkts 1.1&1.2 20591 */ 20592 preview?: MenuPreviewMode | CustomBuilder; 20593 20594 /** 20595 * Defines the border radius for preview of menu. 20596 * 20597 * @type { ?BorderRadiusType } 20598 * @default 16vp 20599 * @syscap SystemCapability.ArkUI.ArkUI.Full 20600 * @crossplatform 20601 * @atomicservice 20602 * @since arkts {'1.1':'19','1.2':'20'} 20603 * @arkts 1.1&1.2 20604 */ 20605 previewBorderRadius?: BorderRadiusType; 20606 20607 /** 20608 * Border radius of the menu. 20609 * <p><strong>NOTE</strong>: 20610 * <br>The value can be in percentage. 20611 * <br>If the sum of the two maximum corner radii in the horizontal direction exceeds the menu's width, or if the sum 20612 * of the two maximum corner radii in the vertical direction exceeds the menu's height, the default corner radius of 20613 * the menu will be used. 20614 * </p> 20615 * 20616 * @type { ?(Length | BorderRadiuses | LocalizedBorderRadiuses) } 20617 * @default 8vp for 2-in-1 devices and 20vp for other devices 20618 * @syscap SystemCapability.ArkUI.ArkUI.Full 20619 * @crossplatform 20620 * @atomicservice 20621 * @since arkts {'1.1':'12','1.2':'20'} 20622 * @arkts 1.1&1.2 20623 */ 20624 borderRadius?: Length | BorderRadiuses | LocalizedBorderRadiuses; 20625 20626 /** 20627 * Callback function when the context menu appears. 20628 * 20629 * @type { ?function } 20630 * @syscap SystemCapability.ArkUI.ArkUI.Full 20631 * @crossplatform 20632 * @since 10 20633 */ 20634 /** 20635 * Callback triggered when the menu is displayed. 20636 * 20637 * @type { ?function } 20638 * @syscap SystemCapability.ArkUI.ArkUI.Full 20639 * @crossplatform 20640 * @atomicservice 20641 * @since arkts {'1.1':'11','1.2':'20'} 20642 * @arkts 1.1&1.2 20643 */ 20644 onAppear?: () => void; 20645 20646 /** 20647 * Callback triggered when the menu is hidden. 20648 * 20649 * @type { ?function } 20650 * @syscap SystemCapability.ArkUI.ArkUI.Full 20651 * @crossplatform 20652 * @since 10 20653 */ 20654 /** 20655 * Callback function when the context menu disappear. 20656 * 20657 * @type { ?function } 20658 * @syscap SystemCapability.ArkUI.ArkUI.Full 20659 * @crossplatform 20660 * @atomicservice 20661 * @since arkts {'1.1':'11','1.2':'20'} 20662 * @arkts 1.1&1.2 20663 */ 20664 onDisappear?: () => void; 20665 20666 /** 20667 * Callback function before the context menu animation starts. 20668 * 20669 * @type { ?function } 20670 * @syscap SystemCapability.ArkUI.ArkUI.Full 20671 * @crossplatform 20672 * @since 11 20673 */ 20674 /** 20675 * Callback triggered when the menu is about to appear. 20676 * 20677 * @type { ?function } 20678 * @syscap SystemCapability.ArkUI.ArkUI.Full 20679 * @crossplatform 20680 * @atomicservice 20681 * @since arkts {'1.1':'12','1.2':'20'} 20682 * @arkts 1.1&1.2 20683 */ 20684 aboutToAppear?: () => void; 20685 20686 /** 20687 * Callback function before the context menu popAnimation starts. 20688 * 20689 * @type { ?function } 20690 * @syscap SystemCapability.ArkUI.ArkUI.Full 20691 * @crossplatform 20692 * @since 11 20693 */ 20694 /** 20695 * Callback triggered when the menu is about to disappear. 20696 * 20697 * @type { ?function } 20698 * @syscap SystemCapability.ArkUI.ArkUI.Full 20699 * @crossplatform 20700 * @atomicservice 20701 * @since arkts {'1.1':'12','1.2':'20'} 20702 * @arkts 1.1&1.2 20703 */ 20704 aboutToDisappear?: () => void; 20705 20706 /** 20707 * The margin of menu's layoutRegion. 20708 * 20709 * @type { ?Margin } 20710 * @default 12vp for left and right, 16vp for top and bottom 20711 * @syscap SystemCapability.ArkUI.ArkUI.Full 20712 * @crossplatform 20713 * @atomicservice 20714 * @since arkts {'1.1':'13','1.2':'20'} 20715 * @arkts 1.1&1.2 20716 */ 20717 layoutRegionMargin?: Margin; 20718 20719 /** 20720 * The preview animator options. 20721 * 20722 * @type { ?ContextMenuAnimationOptions } 20723 * @syscap SystemCapability.ArkUI.ArkUI.Full 20724 * @crossplatform 20725 * @since 11 20726 */ 20727 /** 20728 * The preview animator options. 20729 * 20730 * @type { ?ContextMenuAnimationOptions } 20731 * @default { scale: [0.95, 1.1], transition: undefined, hoverScale: undefined } 20732 * @syscap SystemCapability.ArkUI.ArkUI.Full 20733 * @crossplatform 20734 * @atomicservice 20735 * @since arkts {'1.1':'12','1.2':'20'} 20736 * @arkts 1.1&1.2 20737 */ 20738 previewAnimationOptions?: ContextMenuAnimationOptions; 20739 20740 /** 20741 * Defines the menu's background color 20742 * 20743 * @type { ?ResourceColor } 20744 * @default Color.Transparent 20745 * @syscap SystemCapability.ArkUI.ArkUI.Full 20746 * @crossplatform 20747 * @since 11 20748 */ 20749 /** 20750 * Background color of the menu. 20751 * 20752 * @type { ?ResourceColor } 20753 * @default Color.Transparent 20754 * @syscap SystemCapability.ArkUI.ArkUI.Full 20755 * @crossplatform 20756 * @atomicservice 20757 * @since arkts {'1.1':'12','1.2':'20'} 20758 * @arkts 1.1&1.2 20759 */ 20760 backgroundColor?: ResourceColor; 20761 20762 /** 20763 * Defines menu background blur Style 20764 * 20765 * @type { ?BlurStyle } 20766 * @default BlurStyle.COMPONENT_ULTRA_THICK 20767 * @syscap SystemCapability.ArkUI.ArkUI.Full 20768 * @crossplatform 20769 * @since 11 20770 */ 20771 /** 20772 * Background blur style of the menu. 20773 * 20774 * @type { ?BlurStyle } 20775 * @default BlurStyle.COMPONENT_ULTRA_THICK 20776 * @syscap SystemCapability.ArkUI.ArkUI.Full 20777 * @crossplatform 20778 * @atomicservice 20779 * @since arkts {'1.1':'12','1.2':'20'} 20780 * @arkts 1.1&1.2 20781 */ 20782 backgroundBlurStyle?: BlurStyle; 20783 20784 /** 20785 * Defines the menu's background blur style with options 20786 * 20787 * @type { ?BackgroundBlurStyleOptions } 20788 * @syscap SystemCapability.ArkUI.ArkUI.Full 20789 * @crossplatform 20790 * @atomicservice 20791 * @since arkts {'1.1':'18','1.2':'20'} 20792 * @arkts 1.1&1.2 20793 */ 20794 backgroundBlurStyleOptions?: BackgroundBlurStyleOptions; 20795 20796 /** 20797 * Defines the menu's background effect with options 20798 * 20799 * @type { ?BackgroundEffectOptions } 20800 * @syscap SystemCapability.ArkUI.ArkUI.Full 20801 * @crossplatform 20802 * @atomicservice 20803 * @since arkts {'1.1':'18','1.2':'20'} 20804 * @arkts 1.1&1.2 20805 */ 20806 backgroundEffect?: BackgroundEffectOptions; 20807 20808 /** 20809 * Defines the transition effect of menu opening and closing. 20810 * 20811 * @type { ?TransitionEffect } 20812 * @syscap SystemCapability.ArkUI.ArkUI.Full 20813 * @crossplatform 20814 * @atomicservice 20815 * @since arkts {'1.1':'12','1.2':'20'} 20816 * @arkts 1.1&1.2 20817 */ 20818 transition?: TransitionEffect; 20819 20820 /** 20821 * Determine if it is compatible menu's half folded. 20822 * 20823 * @type { ?boolean } 20824 * @default true for 2-in-1 devices and false for other devices 20825 * @syscap SystemCapability.ArkUI.ArkUI.Full 20826 * @crossplatform 20827 * @atomicservice 20828 * @since arkts {'1.1':'18','1.2':'20'} 20829 * @arkts 1.1&1.2 20830 */ 20831 enableHoverMode?: boolean; 20832 20833 /** 20834 * The color of menu's outer border. 20835 * 20836 * @type { ?(ResourceColor | EdgeColors) } 20837 * @default '#19ffffff' 20838 * @syscap SystemCapability.ArkUI.ArkUI.Full 20839 * @crossplatform 20840 * @atomicservice 20841 * @since 20 20842 * @arkts 1.1&1.2 20843 */ 20844 outlineColor?: ResourceColor | EdgeColors; 20845 20846 /** 20847 * The width of menu's outer border. 20848 * If outline effects are required, outlineWidth is required. 20849 * 20850 * @type { ?(Dimension | EdgeOutlineWidths) } 20851 * @default 0vp - Percentage values are not supported. 20852 * @syscap SystemCapability.ArkUI.ArkUI.Full 20853 * @crossplatform 20854 * @atomicservice 20855 * @since 20 20856 * @arkts 1.1&1.2 20857 */ 20858 outlineWidth?: Dimension | EdgeOutlineWidths; 20859 20860 /** 20861 * Defines the haptic feedback mode of menu. 20862 * 20863 * @type { ?HapticFeedbackMode } 20864 * @default HapticFeedbackMode.DISABLED 20865 * @syscap SystemCapability.ArkUI.ArkUI.Full 20866 * @crossplatform 20867 * @atomicservice 20868 * @since arkts {'1.1':'18','1.2':'20'} 20869 * @arkts 1.1&1.2 20870 */ 20871 hapticFeedbackMode?: HapticFeedbackMode; 20872 20873 /** 20874 * Whether it is a menu without mask. 20875 * 20876 * @type { ?(boolean | MenuMaskType) } 20877 * @default true when preview is enabled, or is false 20878 * @syscap SystemCapability.ArkUI.ArkUI.Full 20879 * @crossplatform 20880 * @atomicservice 20881 * @since 20 20882 */ 20883 mask?: boolean | MenuMaskType; 20884 20885 /** 20886 * Defines modal mode of menu. 20887 * 20888 * @type { ?ModalMode } 20889 * @default ModalMode.AUTO 20890 * @syscap SystemCapability.ArkUI.ArkUI.Full 20891 * @crossplatform 20892 * @atomicservice 20893 * @since 20 20894 */ 20895 modalMode?: ModalMode; 20896 20897 /** 20898 * Callback function when the menu appears. 20899 * 20900 * @type { ?Callback<void> } 20901 * @syscap SystemCapability.ArkUI.ArkUI.Full 20902 * @crossplatform 20903 * @atomicservice 20904 * @since 20 20905 */ 20906 onDidAppear?: Callback<void>; 20907 20908 /** 20909 * Callback function when the menu disappears. 20910 * 20911 * @type { ?Callback<void> } 20912 * @syscap SystemCapability.ArkUI.ArkUI.Full 20913 * @crossplatform 20914 * @atomicservice 20915 * @since 20 20916 */ 20917 onDidDisappear?: Callback<void>; 20918 20919 /** 20920 * Callback function before the menu openAnimation starts. 20921 * 20922 * @type { ?Callback<void> } 20923 * @syscap SystemCapability.ArkUI.ArkUI.Full 20924 * @crossplatform 20925 * @atomicservice 20926 * @since 20 20927 */ 20928 onWillAppear?: Callback<void>; 20929 20930 /** 20931 * Callback function before the menu closeAnimation starts. 20932 * 20933 * @type { ?Callback<void> } 20934 * @syscap SystemCapability.ArkUI.ArkUI.Full 20935 * @crossplatform 20936 * @atomicservice 20937 * @since 20 20938 */ 20939 onWillDisappear?: Callback<void>; 20940 20941 /** 20942 * Defines the scaling mode for custom preview of contextMenu. 20943 * 20944 * @type { ?PreviewScaleMode } 20945 * @default PreviewScaleMode.AUTO 20946 * @syscap SystemCapability.ArkUI.ArkUI.Full 20947 * @crossplatform 20948 * @atomicservice 20949 * @since 20 20950 */ 20951 previewScaleMode?: PreviewScaleMode; 20952 20953 /** 20954 * Defines the available layout area of preview. 20955 * 20956 * @type { ?AvailableLayoutArea } 20957 * @syscap SystemCapability.ArkUI.ArkUI.Full 20958 * @crossplatform 20959 * @atomicservice 20960 * @since 20 20961 */ 20962 availableLayoutArea?: AvailableLayoutArea; 20963 20964 /** 20965 * Defines the menu position. 20966 * 20967 * @type { ?Position } 20968 * @default { x: 0, y: 0 } 20969 * @syscap SystemCapability.ArkUI.ArkUI.Full 20970 * @crossplatform 20971 * @atomicservice 20972 * @since 20 20973 */ 20974 anchorPosition?: Position; 20975} 20976 20977/** 20978 * Defines the menu options. 20979 * 20980 * @extends ContextMenuOptions 20981 * @interface MenuOptions 20982 * @syscap SystemCapability.ArkUI.ArkUI.Full 20983 * @crossplatform 20984 * @since 10 20985 */ 20986/** 20987 * Defines the menu options. 20988 * 20989 * @extends ContextMenuOptions 20990 * @interface MenuOptions 20991 * @syscap SystemCapability.ArkUI.ArkUI.Full 20992 * @crossplatform 20993 * @atomicservice 20994 * @since arkts {'1.1':'11','1.2':'20'} 20995 * @arkts 1.1&1.2 20996 */ 20997declare interface MenuOptions extends ContextMenuOptions { 20998 /** 20999 * Sets the title of the menu window. 21000 * 21001 * @type { ?ResourceStr } 21002 * @syscap SystemCapability.ArkUI.ArkUI.Full 21003 * @crossplatform 21004 * @since 10 21005 */ 21006 /** 21007 * Sets the title of the menu window. 21008 * 21009 * @type { ?ResourceStr } 21010 * @syscap SystemCapability.ArkUI.ArkUI.Full 21011 * @crossplatform 21012 * @atomicservice 21013 * @since arkts {'1.1':'11','1.2':'20'} 21014 * @arkts 1.1&1.2 21015 */ 21016 title?: ResourceStr; 21017 21018 /** 21019 * Whether to display in the sub window. 21020 * 21021 * @type { ?boolean } 21022 * @syscap SystemCapability.ArkUI.ArkUI.Full 21023 * @crossplatform 21024 * @since 11 21025 */ 21026 /** 21027 * Whether to display in the sub window. 21028 * 21029 * @type { ?boolean } 21030 * @default true for 2-in-1 devices 21031 * @syscap SystemCapability.ArkUI.ArkUI.Full 21032 * @crossplatform 21033 * @atomicservice 21034 * @since arkts {'1.1':'12','1.2':'20'} 21035 * @arkts 1.1&1.2 21036 */ 21037 showInSubWindow?: boolean; 21038} 21039 21040/** 21041 * Defines the ProgressMask class. 21042 * 21043 * @syscap SystemCapability.ArkUI.ArkUI.Full 21044 * @crossplatform 21045 * @since 10 21046 */ 21047/** 21048 * Implements a ProgressMask object to set the progress, maximum value, and color of the mask. 21049 * 21050 * @syscap SystemCapability.ArkUI.ArkUI.Full 21051 * @crossplatform 21052 * @atomicservice 21053 * @since arkts {'1.1':'11','1.2':'20'} 21054 * @arkts 1.1&1.2 21055 */ 21056declare class ProgressMask { 21057 /** 21058 * constructor. 21059 * 21060 * @param { number } value - indicates the current value of the progress. 21061 * @param { number } total - indicates the total value of the progress. 21062 * @param { ResourceColor } color - indicates the color of the mask. 21063 * @syscap SystemCapability.ArkUI.ArkUI.Full 21064 * @crossplatform 21065 * @since 10 21066 */ 21067 /** 21068 * constructor. 21069 * 21070 * @param { number } value - Current value of the progress mask. Value range: [0.0, +∞). 21071 * @param { number } total - Maximum value of the progress mask. Value range: [0.0, +∞). 21072 * @param { ResourceColor } color - Color of the progress mask. 21073 * @syscap SystemCapability.ArkUI.ArkUI.Full 21074 * @crossplatform 21075 * @atomicservice 21076 * @since arkts {'1.1':'11','1.2':'20'} 21077 * @arkts 1.1&1.2 21078 */ 21079 constructor(value: number, total: number, color: ResourceColor); 21080 21081 /** 21082 * Update the current value of the progress. 21083 * 21084 * @param { number } value - indicates the current value of the progress. 21085 * @syscap SystemCapability.ArkUI.ArkUI.Full 21086 * @crossplatform 21087 * @since 10 21088 */ 21089 /** 21090 * Updates the progress value of the progress mask. 21091 * 21092 * @param { number } value - Current value of the progress mask. 21093 * @syscap SystemCapability.ArkUI.ArkUI.Full 21094 * @crossplatform 21095 * @atomicservice 21096 * @since arkts {'1.1':'11','1.2':'20'} 21097 * @arkts 1.1&1.2 21098 */ 21099 updateProgress(value: number): void; 21100 21101 /** 21102 * Update the color of the mask. 21103 * 21104 * @param { ResourceColor } value - indicates the color of the mask. 21105 * @syscap SystemCapability.ArkUI.ArkUI.Full 21106 * @crossplatform 21107 * @since 10 21108 */ 21109 /** 21110 * Update the color of the mask. 21111 * 21112 * @param { ResourceColor } value - Color of the progress mask. 21113 * @syscap SystemCapability.ArkUI.ArkUI.Full 21114 * @crossplatform 21115 * @atomicservice 21116 * @since arkts {'1.1':'11','1.2':'20'} 21117 * @arkts 1.1&1.2 21118 */ 21119 updateColor(value: ResourceColor): void; 21120 21121 /** 21122 * Enable the breathe animation of mask. 21123 * 21124 * @param { boolean } value 21125 * @syscap SystemCapability.ArkUI.ArkUI.Full 21126 * @crossplatform 21127 * @atomicservice 21128 * @since arkts {'1.1':'12','1.2':'20'} 21129 * @arkts 1.1&1.2 21130 */ 21131 enableBreathingAnimation(value: boolean): void; 21132} 21133 21134/** 21135 * Defines TouchTestInfo class. 21136 * 21137 * @syscap SystemCapability.ArkUI.ArkUI.Full 21138 * @crossplatform 21139 * @since 11 21140 */ 21141/** 21142 * Defines TouchTestInfo class. 21143 * 21144 * @syscap SystemCapability.ArkUI.ArkUI.Full 21145 * @crossplatform 21146 * @atomicservice 21147 * @since arkts {'1.1':'12','1.2':'20'} 21148 * @arkts 1.1&1.2 21149 */ 21150declare class TouchTestInfo { 21151 /** 21152 * Get the X-coordinate relative to the window. 21153 * 21154 * @type { number } 21155 * @syscap SystemCapability.ArkUI.ArkUI.Full 21156 * @crossplatform 21157 * @since 11 21158 */ 21159 /** 21160 * Get the X-coordinate relative to the window. 21161 * 21162 * @type { number } 21163 * @syscap SystemCapability.ArkUI.ArkUI.Full 21164 * @crossplatform 21165 * @atomicservice 21166 * @since arkts {'1.1':'12','1.2':'20'} 21167 * @arkts 1.1&1.2 21168 */ 21169 windowX: number; 21170 21171 /** 21172 * Get the Y-coordinate relative to the window. 21173 * 21174 * @type { number } 21175 * @syscap SystemCapability.ArkUI.ArkUI.Full 21176 * @crossplatform 21177 * @since 11 21178 */ 21179 /** 21180 * Get the Y-coordinate relative to the window. 21181 * 21182 * @type { number } 21183 * @syscap SystemCapability.ArkUI.ArkUI.Full 21184 * @crossplatform 21185 * @atomicservice 21186 * @since arkts {'1.1':'12','1.2':'20'} 21187 * @arkts 1.1&1.2 21188 */ 21189 windowY: number; 21190 21191 /** 21192 * Get the X-coordinate relative to the current component. 21193 * 21194 * @type { number } 21195 * @syscap SystemCapability.ArkUI.ArkUI.Full 21196 * @crossplatform 21197 * @since 11 21198 */ 21199 /** 21200 * Get the X-coordinate relative to the current component. 21201 * 21202 * @type { number } 21203 * @syscap SystemCapability.ArkUI.ArkUI.Full 21204 * @crossplatform 21205 * @atomicservice 21206 * @since arkts {'1.1':'12','1.2':'20'} 21207 * @arkts 1.1&1.2 21208 */ 21209 parentX: number; 21210 21211 /** 21212 * Get the Y-coordinate relative to the current component. 21213 * 21214 * @type { number } 21215 * @syscap SystemCapability.ArkUI.ArkUI.Full 21216 * @crossplatform 21217 * @since 11 21218 */ 21219 /** 21220 * Get the Y-coordinate relative to the current component. 21221 * 21222 * @type { number } 21223 * @syscap SystemCapability.ArkUI.ArkUI.Full 21224 * @crossplatform 21225 * @atomicservice 21226 * @since arkts {'1.1':'12','1.2':'20'} 21227 * @arkts 1.1&1.2 21228 */ 21229 parentY: number; 21230 21231 /** 21232 * Get the X-coordinate relative to the sub component. 21233 * 21234 * @type { number } 21235 * @syscap SystemCapability.ArkUI.ArkUI.Full 21236 * @crossplatform 21237 * @since 11 21238 */ 21239 /** 21240 * Get the X-coordinate relative to the sub component. 21241 * 21242 * @type { number } 21243 * @syscap SystemCapability.ArkUI.ArkUI.Full 21244 * @crossplatform 21245 * @atomicservice 21246 * @since arkts {'1.1':'12','1.2':'20'} 21247 * @arkts 1.1&1.2 21248 */ 21249 x: number; 21250 21251 /** 21252 * Get the Y-coordinate relative to the sub component. 21253 * 21254 * @type { number } 21255 * @syscap SystemCapability.ArkUI.ArkUI.Full 21256 * @crossplatform 21257 * @since 11 21258 */ 21259 /** 21260 * Get the Y-coordinate relative to the sub component. 21261 * 21262 * @type { number } 21263 * @syscap SystemCapability.ArkUI.ArkUI.Full 21264 * @crossplatform 21265 * @atomicservice 21266 * @since arkts {'1.1':'12','1.2':'20'} 21267 * @arkts 1.1&1.2 21268 */ 21269 y: number; 21270 21271 /** 21272 * Get the rectangle of sub component. 21273 * 21274 * @type { RectResult } 21275 * @syscap SystemCapability.ArkUI.ArkUI.Full 21276 * @crossplatform 21277 * @since 11 21278 */ 21279 /** 21280 * Get the rectangle of sub component. 21281 * 21282 * @type { RectResult } 21283 * @syscap SystemCapability.ArkUI.ArkUI.Full 21284 * @crossplatform 21285 * @atomicservice 21286 * @since arkts {'1.1':'12','1.2':'20'} 21287 * @arkts 1.1&1.2 21288 */ 21289 rect: RectResult; 21290 21291 /** 21292 * Get the name of sub component. 21293 * 21294 * @type { string } 21295 * @syscap SystemCapability.ArkUI.ArkUI.Full 21296 * @crossplatform 21297 * @since 11 21298 */ 21299 /** 21300 * Get the name of sub component. 21301 * 21302 * @type { string } 21303 * @syscap SystemCapability.ArkUI.ArkUI.Full 21304 * @crossplatform 21305 * @atomicservice 21306 * @since arkts {'1.1':'12','1.2':'20'} 21307 * @arkts 1.1&1.2 21308 */ 21309 id: string; 21310} 21311 21312/** 21313 * Defines TouchResult class. 21314 * 21315 * @syscap SystemCapability.ArkUI.ArkUI.Full 21316 * @crossplatform 21317 * @since 11 21318 */ 21319/** 21320 * Defines TouchResult class. 21321 * 21322 * @syscap SystemCapability.ArkUI.ArkUI.Full 21323 * @crossplatform 21324 * @atomicservice 21325 * @since arkts {'1.1':'12','1.2':'20'} 21326 * @arkts 1.1&1.2 21327 */ 21328declare class TouchResult { 21329 /** 21330 * Defines the touch test strategy. 21331 * 21332 * @type { TouchTestStrategy } 21333 * @syscap SystemCapability.ArkUI.ArkUI.Full 21334 * @crossplatform 21335 * @since 11 21336 */ 21337 /** 21338 * Defines the touch test strategy. 21339 * 21340 * @type { TouchTestStrategy } 21341 * @syscap SystemCapability.ArkUI.ArkUI.Full 21342 * @crossplatform 21343 * @atomicservice 21344 * @since arkts {'1.1':'12','1.2':'20'} 21345 * @arkts 1.1&1.2 21346 */ 21347 strategy: TouchTestStrategy; 21348 21349 /** 21350 * Defines the component's name. 21351 * 21352 * @type { ?string } 21353 * @syscap SystemCapability.ArkUI.ArkUI.Full 21354 * @crossplatform 21355 * @since 11 21356 */ 21357 /** 21358 * Defines the component's name. 21359 * 21360 * @type { ?string } 21361 * @syscap SystemCapability.ArkUI.ArkUI.Full 21362 * @crossplatform 21363 * @atomicservice 21364 * @since arkts {'1.1':'12','1.2':'20'} 21365 * @arkts 1.1&1.2 21366 */ 21367 id?: string; 21368} 21369 21370/** 21371 * Set the edge blur effect distance of the corresponding defense line of the component 21372 * When the component expand out, no re-layout is triggered 21373 * 21374 * @interface PixelStretchEffectOptions 21375 * @syscap SystemCapability.ArkUI.ArkUI.Full 21376 * @crossplatform 21377 * @since 10 21378 */ 21379/** 21380 * Set the edge blur effect distance of the corresponding defense line of the component 21381 * When the component expand out, no re-layout is triggered 21382 * 21383 * @interface PixelStretchEffectOptions 21384 * @syscap SystemCapability.ArkUI.ArkUI.Full 21385 * @crossplatform 21386 * @atomicservice 21387 * @since arkts {'1.1':'11','1.2':'20'} 21388 * @arkts 1.1&1.2 21389 */ 21390declare interface PixelStretchEffectOptions { 21391 /** 21392 * top property. value range (-∞, ∞) 21393 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 21394 * 21395 * @type { ?Length } 21396 * @default 0 21397 * @syscap SystemCapability.ArkUI.ArkUI.Full 21398 * @crossplatform 21399 * @since 10 21400 */ 21401 /** 21402 * top property. value range (-∞, ∞) 21403 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 21404 * 21405 * @type { ?Length } 21406 * @default 0 21407 * @syscap SystemCapability.ArkUI.ArkUI.Full 21408 * @crossplatform 21409 * @atomicservice 21410 * @since arkts {'1.1':'11','1.2':'20'} 21411 * @arkts 1.1&1.2 21412 */ 21413 top?: Length; 21414 21415 /** 21416 * bottom property. value range (-∞, ∞) 21417 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 21418 * 21419 * @type { ?Length } 21420 * @default 0 21421 * @syscap SystemCapability.ArkUI.ArkUI.Full 21422 * @crossplatform 21423 * @since 10 21424 */ 21425 /** 21426 * bottom property. value range (-∞, ∞) 21427 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 21428 * 21429 * @type { ?Length } 21430 * @default 0 21431 * @syscap SystemCapability.ArkUI.ArkUI.Full 21432 * @crossplatform 21433 * @atomicservice 21434 * @since arkts {'1.1':'11','1.2':'20'} 21435 * @arkts 1.1&1.2 21436 */ 21437 bottom?: Length; 21438 21439 /** 21440 * left property. value range (-∞, ∞) 21441 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 21442 * 21443 * @type { ?Length } 21444 * @default 0 21445 * @syscap SystemCapability.ArkUI.ArkUI.Full 21446 * @crossplatform 21447 * @since 10 21448 */ 21449 /** 21450 * left property. value range (-∞, ∞) 21451 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 21452 * 21453 * @type { ?Length } 21454 * @default 0 21455 * @syscap SystemCapability.ArkUI.ArkUI.Full 21456 * @crossplatform 21457 * @atomicservice 21458 * @since arkts {'1.1':'11','1.2':'20'} 21459 * @arkts 1.1&1.2 21460 */ 21461 left?: Length; 21462 21463 /** 21464 * right property. value range (-∞, ∞) 21465 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 21466 * 21467 * @type { ?Length } 21468 * @default 0 21469 * @syscap SystemCapability.ArkUI.ArkUI.Full 21470 * @crossplatform 21471 * @since 10 21472 */ 21473 /** 21474 * right property. value range (-∞, ∞) 21475 * If value > 0, expand outward elements. Else first shrink by value and then expand outward pixels. 21476 * 21477 * @type { ?Length } 21478 * @default 0 21479 * @syscap SystemCapability.ArkUI.ArkUI.Full 21480 * @crossplatform 21481 * @atomicservice 21482 * @since arkts {'1.1':'11','1.2':'20'} 21483 * @arkts 1.1&1.2 21484 */ 21485 right?: Length; 21486} 21487 21488/** 21489 * Defines the click effect. 21490 * 21491 * @interface ClickEffect 21492 * @syscap SystemCapability.ArkUI.ArkUI.Full 21493 * @crossplatform 21494 * @since 10 21495 */ 21496/** 21497 * Defines the click effect. 21498 * 21499 * @interface ClickEffect 21500 * @syscap SystemCapability.ArkUI.ArkUI.Full 21501 * @crossplatform 21502 * @atomicservice 21503 * @since arkts {'1.1':'11','1.2':'20'} 21504 * @arkts 1.1&1.2 21505 */ 21506declare interface ClickEffect { 21507 /** 21508 * Set the click effect level. 21509 * 21510 * @type { ClickEffectLevel } 21511 * @default ClickEffectLevel.Light 21512 * @syscap SystemCapability.ArkUI.ArkUI.Full 21513 * @since 10 21514 */ 21515 /** 21516 * Set the click effect level. 21517 * 21518 * @type { ClickEffectLevel } 21519 * @default ClickEffectLevel.Light 21520 * @syscap SystemCapability.ArkUI.ArkUI.Full 21521 * @atomicservice 21522 * @since arkts {'1.1':'11','1.2':'20'} 21523 * @arkts 1.1&1.2 21524 */ 21525 level: ClickEffectLevel; 21526 21527 /** 21528 * Set scale number. 21529 * This default scale is same as the scale of click effect level. 21530 * 21531 * @type { ?number } 21532 * @syscap SystemCapability.ArkUI.ArkUI.Full 21533 * @since 10 21534 */ 21535 /** 21536 * Set scale number. 21537 * This default scale is same as the scale of click effect level. 21538 * 21539 * <p><strong>NOTE</strong>: 21540 * <br> This parameter works based on the setting of ClickEffectLevel. 21541 * <br> If level is set to ClickEffectLevel.LIGHT, the default value is 0.90. 21542 * <br> If level is set to ClickEffectLevel.MIDDLE or ClickEffectLevel.HEAVY, the default value is 0.95. 21543 * <br> If level is set to undefined or null (both of which evaluate to ClickEffectLevel.LIGHT), the default value is 0.90. 21544 * <br> If scale is set to undefined or null, the default zoom ratio for the set level will be used. 21545 * </p> 21546 * @type { ?number } 21547 * @syscap SystemCapability.ArkUI.ArkUI.Full 21548 * @atomicservice 21549 * @since arkts {'1.1':'11','1.2':'20'} 21550 * @arkts 1.1&1.2 21551 */ 21552 scale?: number; 21553} 21554 21555/** 21556 * Defines the fadingEdge options. 21557 * 21558 * @typedef FadingEdgeOptions 21559 * @syscap SystemCapability.ArkUI.ArkUI.Full 21560 * @crossplatform 21561 * @atomicservice 21562 * @since arkts {'1.1':'14','1.2':'20'} 21563 * @arkts 1.1&1.2 21564 */ 21565declare interface FadingEdgeOptions { 21566 /** 21567 * The length of FadingEdge. 21568 * 21569 * @type { LengthMetrics } 21570 * @default 32vp 21571 * @syscap SystemCapability.ArkUI.ArkUI.Full 21572 * @crossplatform 21573 * @atomicservice 21574 * @since arkts {'1.1':'14','1.2':'20'} 21575 * @arkts 1.1&1.2 21576 */ 21577 fadingEdgeLength?: LengthMetrics; 21578} 21579 21580/** 21581 * Define nested scroll options 21582 * 21583 * @interface NestedScrollOptions 21584 * @syscap SystemCapability.ArkUI.ArkUI.Full 21585 * @since 10 21586 */ 21587/** 21588 * Define nested scroll options 21589 * 21590 * @interface NestedScrollOptions 21591 * @syscap SystemCapability.ArkUI.ArkUI.Full 21592 * @atomicservice 21593 * @since arkts {'1.1':'11','1.2':'20'} 21594 * @arkts 1.1&1.2 21595 */ 21596declare interface NestedScrollOptions { 21597 /** 21598 * Set NestedScrollMode when the scrollable component scrolls forward 21599 * 21600 * @type { NestedScrollMode } 21601 * @syscap SystemCapability.ArkUI.ArkUI.Full 21602 * @since 10 21603 */ 21604 /** 21605 * Set NestedScrollMode when the scrollable component scrolls forward 21606 * 21607 * @type { NestedScrollMode } 21608 * @syscap SystemCapability.ArkUI.ArkUI.Full 21609 * @crossplatform 21610 * @atomicservice 21611 * @since arkts {'1.1':'11','1.2':'20'} 21612 * @arkts 1.1&1.2 21613 */ 21614 scrollForward: NestedScrollMode; 21615 21616 /** 21617 * Set NestedScrollMode when the scrollable component scrolls backward 21618 * 21619 * @type { NestedScrollMode } 21620 * @syscap SystemCapability.ArkUI.ArkUI.Full 21621 * @since 10 21622 */ 21623 /** 21624 * Set NestedScrollMode when the scrollable component scrolls backward 21625 * 21626 * @type { NestedScrollMode } 21627 * @syscap SystemCapability.ArkUI.ArkUI.Full 21628 * @crossplatform 21629 * @atomicservice 21630 * @since arkts {'1.1':'11','1.2':'20'} 21631 * @arkts 1.1&1.2 21632 */ 21633 scrollBackward: NestedScrollMode; 21634} 21635 21636/** 21637 * Defines the menu element. 21638 * 21639 * @interface MenuElement 21640 * @syscap SystemCapability.ArkUI.ArkUI.Full 21641 * @since 7 21642 */ 21643/** 21644 * Defines the menu element. 21645 * 21646 * @interface MenuElement 21647 * @syscap SystemCapability.ArkUI.ArkUI.Full 21648 * @crossplatform 21649 * @since 10 21650 */ 21651/** 21652 * Defines the menu element. 21653 * 21654 * @interface MenuElement 21655 * @syscap SystemCapability.ArkUI.ArkUI.Full 21656 * @crossplatform 21657 * @atomicservice 21658 * @since arkts {'1.1':'11','1.2':'20'} 21659 * @arkts 1.1&1.2 21660 */ 21661declare interface MenuElement { 21662 /** 21663 * Sets the value of the menu element. 21664 * 21665 * @type { ResourceStr } 21666 * @syscap SystemCapability.ArkUI.ArkUI.Full 21667 * @since 7 21668 */ 21669 /** 21670 * Sets the value of the menu element. 21671 * 21672 * @type { ResourceStr } 21673 * @syscap SystemCapability.ArkUI.ArkUI.Full 21674 * @crossplatform 21675 * @since 10 21676 */ 21677 /** 21678 * Sets the value of the menu element. 21679 * 21680 * @type { ResourceStr } 21681 * @syscap SystemCapability.ArkUI.ArkUI.Full 21682 * @crossplatform 21683 * @atomicservice 21684 * @since arkts {'1.1':'11','1.2':'20'} 21685 * @arkts 1.1&1.2 21686 */ 21687 value: ResourceStr; 21688 21689 /** 21690 * Sets the icon of the menu element. 21691 * 21692 * @type { ?ResourceStr } 21693 * @syscap SystemCapability.ArkUI.ArkUI.Full 21694 * @crossplatform 21695 * @since 10 21696 */ 21697 /** 21698 * Sets the icon of the menu element. 21699 * 21700 * @type { ?ResourceStr } 21701 * @syscap SystemCapability.ArkUI.ArkUI.Full 21702 * @crossplatform 21703 * @atomicservice 21704 * @since arkts {'1.1':'11','1.2':'20'} 21705 * @arkts 1.1&1.2 21706 */ 21707 icon?: ResourceStr; 21708 21709 /** 21710 * Sets the symbol of the menu element. 21711 * 21712 * @type { ?SymbolGlyphModifier } 21713 * @syscap SystemCapability.ArkUI.ArkUI.Full 21714 * @atomicservice 21715 * @since 12 21716 */ 21717 /** 21718 * Sets the symbol of the menu element. 21719 * 21720 * @type { ?SymbolGlyphModifier } 21721 * @syscap SystemCapability.ArkUI.ArkUI.Full 21722 * @crossplatform 21723 * @atomicservice 21724 * @since 20 21725 * @arkts 1.1&1.2 21726 */ 21727 symbolIcon?: SymbolGlyphModifier; 21728 21729 /** 21730 * If the value is true, the menu element is available and can respond to operations such as clicking. 21731 * If the value is false, the menu element is not available and click operations are not responded. 21732 * 21733 * @type { ?boolean } 21734 * @default true 21735 * @syscap SystemCapability.ArkUI.ArkUI.Full 21736 * @crossplatform 21737 * @since 11 21738 */ 21739 /** 21740 * If the value is true, the menu element is available and can respond to operations such as clicking. 21741 * If the value is false, the menu element is not available and click operations are not responded. 21742 * 21743 * @type { ?boolean } 21744 * @default true 21745 * @syscap SystemCapability.ArkUI.ArkUI.Full 21746 * @crossplatform 21747 * @atomicservice 21748 * @since arkts {'1.1':'12','1.2':'20'} 21749 * @arkts 1.1&1.2 21750 */ 21751 enabled?: boolean; 21752 21753 /** 21754 * Method executed by the callback. 21755 * 21756 * @type { function } 21757 * @syscap SystemCapability.ArkUI.ArkUI.Full 21758 * @since 7 21759 */ 21760 /** 21761 * Method executed by the callback. 21762 * 21763 * @type { function } 21764 * @syscap SystemCapability.ArkUI.ArkUI.Full 21765 * @crossplatform 21766 * @since 10 21767 */ 21768 /** 21769 * Method executed by the callback. 21770 * 21771 * @type { function } 21772 * @syscap SystemCapability.ArkUI.ArkUI.Full 21773 * @crossplatform 21774 * @atomicservice 21775 * @since arkts {'1.1':'11','1.2':'20'} 21776 * @arkts 1.1&1.2 21777 */ 21778 action: () => void; 21779} 21780 21781/** 21782 * Defines the attribute modifier. 21783 * 21784 * @interface AttributeModifier<T> 21785 * @syscap SystemCapability.ArkUI.ArkUI.Full 21786 * @crossplatform 21787 * @since 11 21788 */ 21789/** 21790 * Defines the attribute modifier. 21791 * 21792 * @interface AttributeModifier<T> 21793 * @syscap SystemCapability.ArkUI.ArkUI.Full 21794 * @crossplatform 21795 * @atomicservice 21796 * @since 12 21797 */ 21798declare interface AttributeModifier<T> { 21799 21800 /** 21801 * Defines the normal update attribute function. 21802 * 21803 * @param { T } instance 21804 * @syscap SystemCapability.ArkUI.ArkUI.Full 21805 * @crossplatform 21806 * @since 11 21807 */ 21808 /** 21809 * Defines the normal update attribute function. 21810 * 21811 * @param { T } instance 21812 * @syscap SystemCapability.ArkUI.ArkUI.Full 21813 * @crossplatform 21814 * @atomicservice 21815 * @since 12 21816 */ 21817 applyNormalAttribute?(instance: T) : void; 21818 21819 /** 21820 * Defines the pressed update attribute function. 21821 * 21822 * @param { T } instance 21823 * @syscap SystemCapability.ArkUI.ArkUI.Full 21824 * @crossplatform 21825 * @since 11 21826 */ 21827 /** 21828 * Defines the pressed update attribute function. 21829 * 21830 * @param { T } instance 21831 * @syscap SystemCapability.ArkUI.ArkUI.Full 21832 * @crossplatform 21833 * @atomicservice 21834 * @since 12 21835 */ 21836 applyPressedAttribute?(instance: T) : void; 21837 21838 /** 21839 * Defines the focused update attribute function. 21840 * 21841 * @param { T } instance 21842 * @syscap SystemCapability.ArkUI.ArkUI.Full 21843 * @crossplatform 21844 * @since 11 21845 */ 21846 /** 21847 * Defines the focused update attribute function. 21848 * 21849 * @param { T } instance 21850 * @syscap SystemCapability.ArkUI.ArkUI.Full 21851 * @crossplatform 21852 * @atomicservice 21853 * @since 12 21854 */ 21855 applyFocusedAttribute?(instance: T) : void; 21856 21857 /** 21858 * Defines the disabled update attribute function. 21859 * 21860 * @param { T } instance 21861 * @syscap SystemCapability.ArkUI.ArkUI.Full 21862 * @crossplatform 21863 * @since 11 21864 */ 21865 /** 21866 * Defines the disabled update attribute function. 21867 * 21868 * @param { T } instance 21869 * @syscap SystemCapability.ArkUI.ArkUI.Full 21870 * @crossplatform 21871 * @atomicservice 21872 * @since 12 21873 */ 21874 applyDisabledAttribute?(instance: T) : void; 21875 21876 /** 21877 * Defines the selected update attribute function. 21878 * 21879 * @param { T } instance 21880 * @syscap SystemCapability.ArkUI.ArkUI.Full 21881 * @crossplatform 21882 * @since 11 21883 */ 21884 /** 21885 * Defines the selected update attribute function. 21886 * 21887 * @param { T } instance 21888 * @syscap SystemCapability.ArkUI.ArkUI.Full 21889 * @crossplatform 21890 * @atomicservice 21891 * @since 12 21892 */ 21893 applySelectedAttribute?(instance: T) : void; 21894} 21895 21896/** 21897 * Defines the attribute modifier. 21898 * 21899 * @interface AttributeModifier<T> 21900 * @syscap SystemCapability.ArkUI.ArkUI.Full 21901 * @crossplatform 21902 * @atomicservice 21903 * @since 20 21904 * @arkts 1.2 21905 */ 21906declare interface AttributeModifier<T> { 21907 21908 21909 /** 21910 * Defines the normal update attribute function. 21911 * 21912 * @syscap SystemCapability.ArkUI.ArkUI.Full 21913 * @crossplatform 21914 * @atomicservice 21915 * @since 20 21916 * @arkts 1.2 21917 */ 21918 applyNormalAttribute?:(instance: T) => void; 21919 21920 21921 /** 21922 * Defines the pressed update attribute function. 21923 * 21924 * @syscap SystemCapability.ArkUI.ArkUI.Full 21925 * @crossplatform 21926 * @atomicservice 21927 * @since 20 21928 * @arkts 1.2 21929 */ 21930 applyPressedAttribute?:(instance: T) => void; 21931 21932 /** 21933 * Defines the focused update attribute function. 21934 * 21935 * @syscap SystemCapability.ArkUI.ArkUI.Full 21936 * @crossplatform 21937 * @atomicservice 21938 * @since 20 21939 * @arkts 1.2 21940 */ 21941 applyFocusedAttribute?:(instance: T) => void; 21942 21943 21944 /** 21945 * Defines the disabled update attribute function. 21946 * 21947 * @syscap SystemCapability.ArkUI.ArkUI.Full 21948 * @crossplatform 21949 * @atomicservice 21950 * @since 20 21951 * @arkts 1.2 21952 */ 21953 applyDisabledAttribute?:(instance: T) => void; 21954 21955 21956 /** 21957 * Defines the selected update attribute function. 21958 * 21959 * @syscap SystemCapability.ArkUI.ArkUI.Full 21960 * @crossplatform 21961 * @atomicservice 21962 * @since 20 21963 * @arkts 1.2 21964 */ 21965 applySelectedAttribute?:(instance: T) => void; 21966} 21967/** 21968 * Defines the content modifier. 21969 * 21970 * @interface ContentModifier 21971 * @syscap SystemCapability.ArkUI.ArkUI.Full 21972 * @crossplatform 21973 * @atomicservice 21974 * @since arkts {'1.1':'12','1.2':'20'} 21975 * @arkts 1.1&1.2 21976 */ 21977declare interface ContentModifier<T> { 21978 21979 /** 21980 * Defining applyContent function. 21981 * 21982 * @returns { WrappedBuilder<[T]> } 21983 * Component attribute class, which is used to distinguish different information required by different components 21984 * after content areas are customized, for example, ButtonConfiguration for the Button component and 21985 * CheckBoxConfiguration of the Checkbox component. 21986 * @syscap SystemCapability.ArkUI.ArkUI.Full 21987 * @crossplatform 21988 * @atomicservice 21989 * @since 12 21990 */ 21991 applyContent(): WrappedBuilder<[T]> 21992 21993 /** 21994 * Defining applyContent function. 21995 * 21996 * @returns { WrappedBuilder<[T]> } 21997 * @syscap SystemCapability.ArkUI.ArkUI.Full 21998 * @crossplatform 21999 * @atomicservice 22000 * @since 20 22001 * @arkts 1.2 22002 */ 22003 applyContent(): WrappedBuilder<Array<Object>> 22004} 22005 22006/** 22007 * Defines the common configuration. 22008 * 22009 * @interface CommonConfiguration 22010 * @syscap SystemCapability.ArkUI.ArkUI.Full 22011 * @crossplatform 22012 * @atomicservice 22013 * @since arkts {'1.1':'12','1.2':'20'} 22014 * @arkts 1.1&1.2 22015 */ 22016declare interface CommonConfiguration<T> { 22017 22018 /** 22019 * If the value is true, the contentModifier is available and can respond to operations such as triggerChange. 22020 * If it is set to false, triggerChange operations are not responded. 22021 * 22022 * @type { boolean } 22023 * @syscap SystemCapability.ArkUI.ArkUI.Full 22024 * @crossplatform 22025 * @atomicservice 22026 * @since arkts {'1.1':'12','1.2':'20'} 22027 * @arkts 1.1&1.2 22028 */ 22029 enabled: boolean, 22030 22031 /** 22032 * Obtains the contentModifier instance object 22033 * 22034 * @type { ContentModifier<T> } 22035 * @syscap SystemCapability.ArkUI.ArkUI.Full 22036 * @crossplatform 22037 * @atomicservice 22038 * @since arkts {'1.1':'12','1.2':'20'} 22039 * @arkts 1.1&1.2 22040 */ 22041 contentModifier: ContentModifier<T> 22042} 22043 22044/** 22045 * Outline Style 22046 * 22047 * @enum { number } 22048 * @syscap SystemCapability.ArkUI.ArkUI.Full 22049 * @crossplatform 22050 * @form 22051 * @since 11 22052 */ 22053/** 22054 * Outline Style 22055 * 22056 * @enum { number } 22057 * @syscap SystemCapability.ArkUI.ArkUI.Full 22058 * @crossplatform 22059 * @form 22060 * @atomicservice 22061 * @since arkts {'1.1':'12','1.2':'20'} 22062 * @arkts 1.1&1.2 22063 */ 22064declare enum OutlineStyle { 22065 /** 22066 * Solid border. 22067 * 22068 * @syscap SystemCapability.ArkUI.ArkUI.Full 22069 * @crossplatform 22070 * @form 22071 * @since 11 22072 */ 22073 /** 22074 * Solid border. 22075 * 22076 * @syscap SystemCapability.ArkUI.ArkUI.Full 22077 * @crossplatform 22078 * @form 22079 * @atomicservice 22080 * @since arkts {'1.1':'12','1.2':'20'} 22081 * @arkts 1.1&1.2 22082 */ 22083 SOLID = 0, 22084 22085 /** 22086 * Dashed border. 22087 * 22088 * @syscap SystemCapability.ArkUI.ArkUI.Full 22089 * @crossplatform 22090 * @form 22091 * @since 11 22092 */ 22093 /** 22094 * Dashed border. 22095 * 22096 * @syscap SystemCapability.ArkUI.ArkUI.Full 22097 * @crossplatform 22098 * @form 22099 * @atomicservice 22100 * @since arkts {'1.1':'12','1.2':'20'} 22101 * @arkts 1.1&1.2 22102 */ 22103 DASHED = 1, 22104 22105 /** 22106 * Displays as a series of dots with a radius of half the borderWidth. 22107 * 22108 * @syscap SystemCapability.ArkUI.ArkUI.Full 22109 * @crossplatform 22110 * @form 22111 * @since 11 22112 */ 22113 /** 22114 * Dotted border. The radius of a dot is half of **outlineWidth**. 22115 * 22116 * @syscap SystemCapability.ArkUI.ArkUI.Full 22117 * @crossplatform 22118 * @form 22119 * @atomicservice 22120 * @since arkts {'1.1':'12','1.2':'20'} 22121 * @arkts 1.1&1.2 22122 */ 22123 DOTTED = 2, 22124} 22125 22126/** 22127 * Defines the drag preview mode. 22128 * 22129 * @enum { number } 22130 * @syscap SystemCapability.ArkUI.ArkUI.Full 22131 * @since 11 22132 */ 22133/** 22134 * Defines the drag preview mode. 22135 * 22136 * @enum { number } 22137 * @syscap SystemCapability.ArkUI.ArkUI.Full 22138 * @atomicservice 22139 * @since 12 22140 */ 22141/** 22142 * Defines the drag preview mode. 22143 * 22144 * @enum { number } 22145 * @syscap SystemCapability.ArkUI.ArkUI.Full 22146 * @crossplatform 22147 * @atomicservice 22148 * @since arkts {'1.1':'18','1.2':'20'} 22149 * @arkts 1.1&1.2 22150 */ 22151declare enum DragPreviewMode { 22152 /** 22153 * Default preview mode, let system process preview scale. 22154 * 22155 * @syscap SystemCapability.ArkUI.ArkUI.Full 22156 * @since 11 22157 */ 22158 /** 22159 * Default preview mode, let system process preview scale. 22160 * 22161 * @syscap SystemCapability.ArkUI.ArkUI.Full 22162 * @atomicservice 22163 * @since 12 22164 */ 22165 /** 22166 * Default preview mode, let system process preview scale. 22167 * 22168 * @syscap SystemCapability.ArkUI.ArkUI.Full 22169 * @crossplatform 22170 * @atomicservice 22171 * @since arkts {'1.1':'18','1.2':'20'} 22172 * @arkts 1.1&1.2 22173 */ 22174 AUTO = 1, 22175 /** 22176 * Disable system scale to preview panel 22177 * 22178 * @syscap SystemCapability.ArkUI.ArkUI.Full 22179 * @since 11 22180 */ 22181 /** 22182 * Disable system scale to preview panel 22183 * 22184 * @syscap SystemCapability.ArkUI.ArkUI.Full 22185 * @atomicservice 22186 * @since 12 22187 */ 22188 /** 22189 * Disable system scale to preview panel 22190 * 22191 * @syscap SystemCapability.ArkUI.ArkUI.Full 22192 * @crossplatform 22193 * @atomicservice 22194 * @since arkts {'1.1':'18','1.2':'20'} 22195 * @arkts 1.1&1.2 22196 */ 22197 DISABLE_SCALE = 2, 22198 /** 22199 * Enable the default shadow effect of preview. 22200 * 22201 * @syscap SystemCapability.ArkUI.ArkUI.Full 22202 * @atomicservice 22203 * @since 12 22204 */ 22205 /** 22206 * Enable the default shadow effect of preview. 22207 * 22208 * @syscap SystemCapability.ArkUI.ArkUI.Full 22209 * @crossplatform 22210 * @atomicservice 22211 * @since arkts {'1.1':'18','1.2':'20'} 22212 * @arkts 1.1&1.2 22213 */ 22214 ENABLE_DEFAULT_SHADOW = 3, 22215 /** 22216 * Enable the default radius effect of preview. 22217 * 22218 * @syscap SystemCapability.ArkUI.ArkUI.Full 22219 * @atomicservice 22220 * @since 12 22221 */ 22222 /** 22223 * Enable the default radius effect of preview. 22224 * 22225 * @syscap SystemCapability.ArkUI.ArkUI.Full 22226 * @crossplatform 22227 * @atomicservice 22228 * @since arkts {'1.1':'18','1.2':'20'} 22229 * @arkts 1.1&1.2 22230 */ 22231 ENABLE_DEFAULT_RADIUS = 4, 22232 /** 22233 * Enable the default gray effect on the dragging item. 22234 * 22235 * @syscap SystemCapability.ArkUI.ArkUI.Full 22236 * @atomicservice 22237 * @since arkts {'1.1':'18','1.2':'20'} 22238 * @arkts 1.1&1.2 22239 */ 22240 ENABLE_DRAG_ITEM_GRAY_EFFECT = 5, 22241 /** 22242 * Enable the tile effect for multi drag, each dragged graph is display in the original relative position. 22243 * 22244 * @syscap SystemCapability.ArkUI.ArkUI.Full 22245 * @atomicservice 22246 * @since arkts {'1.1':'18','1.2':'20'} 22247 * @arkts 1.1&1.2 22248 */ 22249 ENABLE_MULTI_TILE_EFFECT = 6, 22250 /** 22251 * Enable the touch point calculation position based on final preview rect. 22252 * 22253 * @syscap SystemCapability.ArkUI.ArkUI.Full 22254 * @atomicservice 22255 * @since arkts {'1.1':'19','1.2':'20'} 22256 * @arkts 1.1&1.2 22257 */ 22258 ENABLE_TOUCH_POINT_CALCULATION_BASED_ON_FINAL_PREVIEW = 7, 22259} 22260 22261/** 22262 * Define drag start animation effect from drag preview to the handle drag image 22263 * 22264 * @enum { number } 22265 * @syscap SystemCapability.ArkUI.ArkUI.Full 22266 * @atomicservice 22267 * @since arkts {'1.1':'19','1.2':'20'} 22268 * @arkts 1.1&1.2 22269 */ 22270declare enum DraggingSizeChangeEffect { 22271 /** 22272 * Default effect, no transition. 22273 * 22274 * @syscap SystemCapability.ArkUI.ArkUI.Full 22275 * @atomicservice 22276 * @since arkts {'1.1':'19','1.2':'20'} 22277 * @arkts 1.1&1.2 22278 */ 22279 DEFAULT = 0, 22280 22281 /** 22282 * Only scaled transition, this parameter take effect when PREVIEW_MODE is not DISABLE_SCALE. 22283 * 22284 * @syscap SystemCapability.ArkUI.ArkUI.Full 22285 * @atomicservice 22286 * @since arkts {'1.1':'19','1.2':'20'} 22287 * @arkts 1.1&1.2 22288 */ 22289 SIZE_TRANSITION = 1, 22290 22291 /** 22292 * Scaled and content transition together, this size transition take effect when PREVIEW_MODE is not DISABLE_SCALE. 22293 * 22294 * @syscap SystemCapability.ArkUI.ArkUI.Full 22295 * @atomicservice 22296 * @since arkts {'1.1':'19','1.2':'20'} 22297 * @arkts 1.1&1.2 22298 */ 22299 SIZE_CONTENT_TRANSITION = 2, 22300} 22301 22302/** 22303 * Define the menu pop-up policy 22304 * 22305 * @enum { number } 22306 * @syscap SystemCapability.ArkUI.ArkUI.Full 22307 * @crossplatform 22308 * @atomicservice 22309 * @since arkts {'1.1':'12','1.2':'20'} 22310 * @arkts 1.1&1.2 22311 */ 22312declare enum MenuPolicy { 22313 /** 22314 * Default value. The default logic of whether to pop up a menu depends on the scene. 22315 * 22316 * @syscap SystemCapability.ArkUI.ArkUI.Full 22317 * @crossplatform 22318 * @atomicservice 22319 * @since arkts {'1.1':'12','1.2':'20'} 22320 * @arkts 1.1&1.2 22321 */ 22322 DEFAULT = 0, 22323 22324 /** 22325 * The menu is always hidden. 22326 * 22327 * @syscap SystemCapability.ArkUI.ArkUI.Full 22328 * @crossplatform 22329 * @atomicservice 22330 * @since arkts {'1.1':'12','1.2':'20'} 22331 * @arkts 1.1&1.2 22332 */ 22333 HIDE = 1, 22334 22335 /** 22336 * The menu is always displayed. 22337 * 22338 * @syscap SystemCapability.ArkUI.ArkUI.Full 22339 * @crossplatform 22340 * @atomicservice 22341 * @since arkts {'1.1':'12','1.2':'20'} 22342 * @arkts 1.1&1.2 22343 */ 22344 SHOW = 2, 22345} 22346 22347/** 22348 * ImageModifier 22349 * 22350 * @typedef { import('../api/arkui/ImageModifier').ImageModifier } ImageModifier 22351 * @syscap SystemCapability.ArkUI.ArkUI.Full 22352 * @crossplatform 22353 * @atomicservice 22354 * @since 12 22355 */ 22356declare type ImageModifier = import('../api/arkui/ImageModifier').ImageModifier; 22357 22358/** 22359 * SymbolGlyphModifier 22360 * 22361 * @typedef {import('../api/arkui/SymbolGlyphModifier').SymbolGlyphModifier} SymbolGlyphModifier 22362 * @syscap SystemCapability.ArkUI.ArkUI.Full 22363 * @atomicservice 22364 * @since 12 22365 */ 22366/** 22367 * SymbolGlyphModifier 22368 * 22369 * @typedef {import('../api/arkui/SymbolGlyphModifier').SymbolGlyphModifier} SymbolGlyphModifier 22370 * @syscap SystemCapability.ArkUI.ArkUI.Full 22371 * @crossplatform 22372 * @atomicservice 22373 * @since 20 22374 */ 22375declare type SymbolGlyphModifier = import('../api/arkui/SymbolGlyphModifier').SymbolGlyphModifier; 22376 22377/** 22378 * Defines the preview options. 22379 * 22380 * @interface DragPreviewOptions 22381 * @syscap SystemCapability.ArkUI.ArkUI.Full 22382 * @since 11 22383 */ 22384/** 22385 * Defines the preview options. 22386 * 22387 * @interface DragPreviewOptions 22388 * @syscap SystemCapability.ArkUI.ArkUI.Full 22389 * @atomicservice 22390 * @since 12 22391 */ 22392/** 22393 * Defines the preview options. 22394 * 22395 * @interface DragPreviewOptions 22396 * @syscap SystemCapability.ArkUI.ArkUI.Full 22397 * @crossplatform 22398 * @atomicservice 22399 * @since arkts {'1.1':'18','1.2':'20'} 22400 * @arkts 1.1&1.2 22401 */ 22402declare interface DragPreviewOptions { 22403 /** 22404 * Drag preview mode. 22405 * 22406 * @type { ?DragPreviewMode } 22407 * @syscap SystemCapability.ArkUI.ArkUI.Full 22408 * @since 11 22409 */ 22410 /** 22411 * Drag preview mode. 22412 * 22413 * @type { ?(DragPreviewMode | Array<DragPreviewMode>) } 22414 * @syscap SystemCapability.ArkUI.ArkUI.Full 22415 * @atomicservice 22416 * @since 12 22417 */ 22418 /** 22419 * Drag preview mode. 22420 * 22421 * @type { ?(DragPreviewMode | Array<DragPreviewMode>) } 22422 * @default DragPreviewMode.AUTO 22423 * @syscap SystemCapability.ArkUI.ArkUI.Full 22424 * @crossplatform 22425 * @atomicservice 22426 * @since arkts {'1.1':'18','1.2':'20'} 22427 * @arkts 1.1&1.2 22428 */ 22429 mode?: DragPreviewMode | Array<DragPreviewMode>; 22430 22431 /** 22432 * Drag preview modifier. 22433 * 22434 * @type { ?ImageModifier } 22435 * @syscap SystemCapability.ArkUI.ArkUI.Full 22436 * @atomicservice 22437 * @since 12 22438 */ 22439 /** 22440 * Drag preview modifier. 22441 * 22442 * @type { ?ImageModifier } 22443 * @syscap SystemCapability.ArkUI.ArkUI.Full 22444 * @crossplatform 22445 * @atomicservice 22446 * @since 18 22447 */ 22448 modifier?: ImageModifier; 22449 22450 /** 22451 * The flag for number showing. 22452 * 22453 * @type { ?(boolean | number) } 22454 * @syscap SystemCapability.ArkUI.ArkUI.Full 22455 * @atomicservice 22456 * @since 12 22457 */ 22458 /** 22459 * The flag for number showing. 22460 * 22461 * @type { ?(boolean | number) } 22462 * @default true 22463 * @syscap SystemCapability.ArkUI.ArkUI.Full 22464 * @crossplatform 22465 * @atomicservice 22466 * @since arkts {'1.1':'18','1.2':'20'} 22467 * @arkts 1.1&1.2 22468 */ 22469 numberBadge?: boolean | number; 22470 22471 /** 22472 * Drag start animation effect from drag preview to the handle drag image. 22473 * 22474 * @type { ?DraggingSizeChangeEffect } 22475 * @default DraggingSizeChangeEffect.DEFAULT 22476 * @syscap SystemCapability.ArkUI.ArkUI.Full 22477 * @atomicservice 22478 * @since arkts {'1.1':'19','1.2':'20'} 22479 * @arkts 1.1&1.2 22480 */ 22481 sizeChangeEffect?: DraggingSizeChangeEffect; 22482} 22483 22484/** 22485 * Defines the drag options. 22486 * 22487 * @interface DragInteractionOptions 22488 * @syscap SystemCapability.ArkUI.ArkUI.Full 22489 * @atomicservice 22490 * @since arkts {'1.1':'12','1.2':'20'} 22491 * @arkts 1.1&1.2 22492 */ 22493declare interface DragInteractionOptions { 22494 /** 22495 * Define whether to gather selected nodes in grid or list. 22496 * 22497 * @type { ?boolean } 22498 * @default false 22499 * @syscap SystemCapability.ArkUI.ArkUI.Full 22500 * @atomicservice 22501 * @since arkts {'1.1':'12','1.2':'20'} 22502 * @arkts 1.1&1.2 22503 */ 22504 isMultiSelectionEnabled?: boolean; 22505 22506 /** 22507 * Define whether to execute animation before preview floating. 22508 * 22509 * @type { ?boolean } 22510 * @default false 22511 * @syscap SystemCapability.ArkUI.ArkUI.Full 22512 * @atomicservice 22513 * @since arkts {'1.1':'12','1.2':'20'} 22514 * @arkts 1.1&1.2 22515 */ 22516 defaultAnimationBeforeLifting?: boolean; 22517 22518 /** 22519 * Define whether to enable the haptic feedback when dragging, the default value is false. 22520 * 22521 * @type { ?boolean } 22522 * @default false 22523 * @syscap SystemCapability.ArkUI.ArkUI.Full 22524 * @atomicservice 22525 * @since arkts {'1.1':'18','1.2':'20'} 22526 * @arkts 1.1&1.2 22527 */ 22528 enableHapticFeedback?: boolean; 22529 22530 /** 22531 * Config if auto scrolling should be triggered when the drag hovered on a scrollable controller's edge. 22532 * 22533 * @type { ?boolean } 22534 * @default true 22535 * @syscap SystemCapability.ArkUI.ArkUI.Full 22536 * @atomicservice 22537 * @since arkts {'1.1':'18','1.2':'20'} 22538 * @arkts 1.1&1.2 22539 */ 22540 enableEdgeAutoScroll?: boolean; 22541 22542 /** 22543 * Define whether to lifting trigger drag by finger. 22544 * 22545 * @type { ?boolean } 22546 * @default false 22547 * @syscap SystemCapability.ArkUI.ArkUI.Full 22548 * @atomicservice 22549 * @since arkts {'1.1':'15','1.2':'20'} 22550 * @arkts 1.1&1.2 22551 */ 22552 isLiftingDisabled?: boolean; 22553} 22554 22555/** 22556 * Defines the drag preview configuration. 22557 * 22558 * @interface PreviewConfiguration 22559 * @syscap SystemCapability.ArkUI.ArkUI.Full 22560 * @atomicservice 22561 * @since arkts {'1.1':'15','1.2':'20'} 22562 * @arkts 1.1&1.2 22563 */ 22564declare interface PreviewConfiguration { 22565 /** 22566 * Define whether to only use for lifting. 22567 * 22568 * @type { ?boolean } 22569 * @default false 22570 * @syscap SystemCapability.ArkUI.ArkUI.Full 22571 * @atomicservice 22572 * @since arkts {'1.1':'15','1.2':'20'} 22573 * @arkts 1.1&1.2 22574 */ 22575 onlyForLifting?: boolean; 22576 22577 /** 22578 * Define whether to delay create builder. 22579 * 22580 * @type { ?boolean } 22581 * @default false 22582 * @syscap SystemCapability.ArkUI.ArkUI.Full 22583 * @atomicservice 22584 * @since arkts {'1.1':'15','1.2':'20'} 22585 * @arkts 1.1&1.2 22586 */ 22587 delayCreating?: boolean; 22588} 22589 22590/** 22591 * Define the options of invert 22592 * 22593 * @interface InvertOptions 22594 * @syscap SystemCapability.ArkUI.ArkUI.Full 22595 * @since 11 22596 */ 22597/** 22598 * Define the options of invert 22599 * 22600 * @interface InvertOptions 22601 * @syscap SystemCapability.ArkUI.ArkUI.Full 22602 * @atomicservice 22603 * @since arkts {'1.1':'12','1.2':'20'} 22604 * @arkts 1.1&1.2 22605 */ 22606declare interface InvertOptions { 22607 22608 /** 22609 * Defines the low value of threshold 22610 * 22611 * @type { number } 22612 * @syscap SystemCapability.ArkUI.ArkUI.Full 22613 * @crossplatform 22614 * @since 11 22615 */ 22616 /** 22617 * Defines the low value of threshold 22618 * 22619 * @type { number } 22620 * @syscap SystemCapability.ArkUI.ArkUI.Full 22621 * @crossplatform 22622 * @atomicservice 22623 * @since arkts {'1.1':'12','1.2':'20'} 22624 * @arkts 1.1&1.2 22625 */ 22626 low: number; 22627 22628 /** 22629 * Defines the high value of threshold 22630 * 22631 * @type { number } 22632 * @syscap SystemCapability.ArkUI.ArkUI.Full 22633 * @crossplatform 22634 * @since 11 22635 */ 22636 /** 22637 * Defines the high value of threshold 22638 * 22639 * @type { number } 22640 * @syscap SystemCapability.ArkUI.ArkUI.Full 22641 * @crossplatform 22642 * @atomicservice 22643 * @since arkts {'1.1':'12','1.2':'20'} 22644 * @arkts 1.1&1.2 22645 */ 22646 high: number; 22647 22648 /** 22649 * Defines the threshold 22650 * 22651 * @type { number } 22652 * @syscap SystemCapability.ArkUI.ArkUI.Full 22653 * @crossplatform 22654 * @since 11 22655 */ 22656 /** 22657 * Defines the threshold 22658 * 22659 * @type { number } 22660 * @syscap SystemCapability.ArkUI.ArkUI.Full 22661 * @crossplatform 22662 * @atomicservice 22663 * @since arkts {'1.1':'12','1.2':'20'} 22664 * @arkts 1.1&1.2 22665 */ 22666 threshold: number; 22667 22668 /** 22669 *Defines the threshold range 22670 * 22671 * @type { number } 22672 * @syscap SystemCapability.ArkUI.ArkUI.Full 22673 * @crossplatform 22674 * @since 11 22675 */ 22676 /** 22677 *Defines the threshold range 22678 * 22679 * @type { number } 22680 * @syscap SystemCapability.ArkUI.ArkUI.Full 22681 * @crossplatform 22682 * @atomicservice 22683 * @since arkts {'1.1':'12','1.2':'20'} 22684 * @arkts 1.1&1.2 22685 */ 22686 thresholdRange: number; 22687} 22688 22689/** 22690 * Import the CircleShape type object for common method. 22691 * 22692 * @typedef { import('../api/@ohos.arkui.shape').CircleShape } CircleShape 22693 * @syscap SystemCapability.ArkUI.ArkUI.Full 22694 * @crossplatform 22695 * @form 22696 * @atomicservice 22697 * @since 12 22698 */ 22699declare type CircleShape = import('../api/@ohos.arkui.shape').CircleShape; 22700 22701/** 22702 * Import the EllipseShape type object for common method. 22703 * 22704 * @typedef { import('../api/@ohos.arkui.shape').EllipseShape } EllipseShape 22705 * @syscap SystemCapability.ArkUI.ArkUI.Full 22706 * @crossplatform 22707 * @form 22708 * @atomicservice 22709 * @since 12 22710 */ 22711declare type EllipseShape = import('../api/@ohos.arkui.shape').EllipseShape; 22712 22713/** 22714 * Import the PathShape type object for common method. 22715 * 22716 * @typedef { import('../api/@ohos.arkui.shape').PathShape } PathShape 22717 * @syscap SystemCapability.ArkUI.ArkUI.Full 22718 * @crossplatform 22719 * @form 22720 * @atomicservice 22721 * @since 12 22722 */ 22723declare type PathShape = import('../api/@ohos.arkui.shape').PathShape; 22724 22725/** 22726 * Import the RectShape type object for common method. 22727 * 22728 * @typedef { import('../api/@ohos.arkui.shape').RectShape } RectShape 22729 * @syscap SystemCapability.ArkUI.ArkUI.Full 22730 * @crossplatform 22731 * @form 22732 * @atomicservice 22733 * @since 12 22734 */ 22735declare type RectShape = import('../api/@ohos.arkui.shape').RectShape; 22736 22737/** 22738 * Defines the type that can be undefined. 22739 * 22740 * @typedef { T | undefined } Optional<T> 22741 * @syscap SystemCapability.ArkUI.ArkUI.Full 22742 * @crossplatform 22743 * @form 22744 * @atomicservice 22745 * @since arkts {'1.1':'12','1.2':'20'} 22746 * @arkts 1.1&1.2 22747 */ 22748declare type Optional<T> = T | undefined; 22749 22750/** 22751 * Defines the TipsMessageType property with ResourceStr and StyledString. 22752 * 22753 * @typedef { ResourceStr | StyledString } TipsMessageType 22754 * @syscap SystemCapability.ArkUI.ArkUI.Full 22755 * @crossplatform 22756 * @atomicservice 22757 * @since arkts {'1.1':'19','1.2':'20'} 22758 * @arkts 1.1&1.2 22759 */ 22760declare type TipsMessageType = ResourceStr | StyledString; 22761 22762/** 22763 * Import the Matrix4Transit type object for common method. 22764 * 22765 * @typedef { import('../api/@ohos.matrix4').default.Matrix4Transit } Matrix4Transit 22766 * @syscap SystemCapability.ArkUI.ArkUI.Full 22767 * @crossplatform 22768 * @atomicservice 22769 * @since 20 22770 */ 22771declare type Matrix4Transit = import('../api/@ohos.matrix4').default.Matrix4Transit; 22772 22773/** 22774 * Define the options for background image. 22775 * 22776 * @interface BackgroundImageOptions 22777 * @syscap SystemCapability.ArkUI.ArkUI.Full 22778 * @crossplatform 22779 * @form 22780 * @atomicservice 22781 * @since arkts {'1.1':'18','1.2':'20'} 22782 * @arkts 1.1&1.2 22783 */ 22784interface BackgroundImageOptions { 22785 /** 22786 * Sets the synchronous or asynchronous mode for background image loading. 22787 * The default parameter type is bool, and the default value is false. 22788 * 22789 * @type { ?boolean } 22790 * @param { boolean } value 22791 * @syscap SystemCapability.ArkUI.ArkUI.Full 22792 * @crossplatform 22793 * @form 22794 * @atomicservice 22795 * @since arkts {'1.1':'18','1.2':'20'} 22796 * @arkts 1.1&1.2 22797 */ 22798 syncLoad?: boolean; 22799 /** 22800 * Set the repeat style of the background image. 22801 * 22802 * @type { ?ImageRepeat } 22803 * @param { ImageRepeat } value 22804 * @syscap SystemCapability.ArkUI.ArkUI.Full 22805 * @crossplatform 22806 * @form 22807 * @atomicservice 22808 * @since arkts {'1.1':'18','1.2':'20'} 22809 * @arkts 1.1&1.2 22810 */ 22811 repeat?: ImageRepeat; 22812} 22813 22814/** 22815 * Defines background options. 22816 * 22817 * @interface BackgroundOptions 22818 * @syscap SystemCapability.ArkUI.ArkUI.Full 22819 * @crossplatform 22820 * @atomicservice 22821 * @since 20 22822 * @arkts 1.1&1.2 22823 */ 22824declare interface BackgroundOptions { 22825 /** 22826 * Set the alignment of the custom background and component. 22827 * 22828 * @type { ?Alignment} align 22829 * @syscap SystemCapability.ArkUI.ArkUI.Full 22830 * @crossplatform 22831 * @since 10 22832 */ 22833 /** 22834 * Set the alignment of the custom background and component. 22835 * 22836 * @type { ?Alignment} align 22837 * @syscap SystemCapability.ArkUI.ArkUI.Full 22838 * @crossplatform 22839 * @atomicservice 22840 * @since 11 22841 */ 22842 /** 22843 * Set the alignment of the custom background and component. 22844 * 22845 * Anonymous Object Rectification. 22846 * @type { ?Alignment } 22847 * @default Alignment.Center 22848 * @syscap SystemCapability.ArkUI.ArkUI.Full 22849 * @crossplatform 22850 * @atomicservice 22851 * @since 20 22852 * @arkts 1.1&1.2 22853 */ 22854 align?: Alignment; 22855 /** 22856 * The set of edges for which to ignore layout safe area. To respect safe area insets on all edges, explicitly pass empty edge set. 22857 * 22858 * @type { ?Array<LayoutSafeAreaEdge> } 22859 * @default The default value is LayoutSafeAreaEdge.ALL when background is ResourceColor, otherwise it is an empty array []. 22860 * @syscap SystemCapability.ArkUI.ArkUI.Full 22861 * @atomicservice 22862 * @since 20 22863 */ 22864 ignoresLayoutSafeAreaEdges?: Array<LayoutSafeAreaEdge>; 22865} 22866 22867/** 22868 * CommonMethod. 22869 * 22870 * @syscap SystemCapability.ArkUI.ArkUI.Full 22871 * @since 7 22872 */ 22873/** 22874 * CommonMethod. 22875 * 22876 * @syscap SystemCapability.ArkUI.ArkUI.Full 22877 * @form 22878 * @since 9 22879 */ 22880/** 22881 * CommonMethod. 22882 * 22883 * @syscap SystemCapability.ArkUI.ArkUI.Full 22884 * @crossplatform 22885 * @form 22886 * @since 10 22887 */ 22888/** 22889 * CommonMethod. 22890 * 22891 * @syscap SystemCapability.ArkUI.ArkUI.Full 22892 * @crossplatform 22893 * @form 22894 * @atomicservice 22895 * @since arkts {'1.1':'11','1.2':'20'} 22896 * @arkts 1.1&1.2 22897 */ 22898declare class CommonMethod<T> { 22899 /** 22900 * constructor. 22901 * 22902 * @syscap SystemCapability.ArkUI.ArkUI.Full 22903 * @systemapi 22904 * @since 7 22905 */ 22906 /** 22907 * constructor. 22908 * 22909 * @syscap SystemCapability.ArkUI.ArkUI.Full 22910 * @systemapi 22911 * @form 22912 * @since arkts {'1.1':'9','1.2':'20'} 22913 * @arkts 1.1&1.2 22914 */ 22915 constructor(); 22916 22917 /** 22918 * Sets the width of the current component. 22919 * 22920 * @param { Length } value 22921 * @returns { T } 22922 * @syscap SystemCapability.ArkUI.ArkUI.Full 22923 * @since 7 22924 */ 22925 /** 22926 * Sets the width of the current component. 22927 * 22928 * @param { Length } value 22929 * @returns { T } 22930 * @syscap SystemCapability.ArkUI.ArkUI.Full 22931 * @form 22932 * @since 9 22933 */ 22934 /** 22935 * Sets the width of the current component. 22936 * 22937 * @param { Length } value 22938 * @returns { T } 22939 * @syscap SystemCapability.ArkUI.ArkUI.Full 22940 * @crossplatform 22941 * @form 22942 * @since 10 22943 */ 22944 /** 22945 * Sets the width of the component. By default, the width required to fully hold the 22946 * component content is used.If the width of the component is greater than that of 22947 * the parent container, the component will be drawn beyond the parent container scope. 22948 * 22949 * @param { Length } value 22950 * @returns { T } 22951 * @syscap SystemCapability.ArkUI.ArkUI.Full 22952 * @crossplatform 22953 * @form 22954 * @atomicservice 22955 * @since arkts {'1.1':'11','1.2':'20'} 22956 * @arkts 1.1&1.2 22957 */ 22958 width(value: Length): T; 22959 /** 22960 * Sets the width of the component or its horizontal layout policy. By default, the 22961 * component uses the width required for its content. If the width of the component is 22962 * greater than that of the parent container, the component will be drawn beyond the 22963 * parent container scope. 22964 * 22965 * @param { Length | LayoutPolicy } widthValue 22966 * @returns { T } 22967 * @syscap SystemCapability.ArkUI.ArkUI.Full 22968 * @crossplatform 22969 * @form 22970 * @atomicservice 22971 * @since arkts {'1.1':'15','1.2':'20'} 22972 * @arkts 1.1&1.2 22973 */ 22974 width(widthValue: Length | LayoutPolicy): T; 22975 22976 /** 22977 * Sets the height of the current component. 22978 * 22979 * @param { Length } value 22980 * @returns { T } 22981 * @syscap SystemCapability.ArkUI.ArkUI.Full 22982 * @since 7 22983 */ 22984 /** 22985 * Sets the height of the current component. 22986 * 22987 * @param { Length } value 22988 * @returns { T } 22989 * @syscap SystemCapability.ArkUI.ArkUI.Full 22990 * @form 22991 * @since 9 22992 */ 22993 /** 22994 * Sets the height of the current component. 22995 * 22996 * @param { Length } value 22997 * @returns { T } 22998 * @syscap SystemCapability.ArkUI.ArkUI.Full 22999 * @crossplatform 23000 * @form 23001 * @since 10 23002 */ 23003 /** 23004 * Sets the height of the component. By default, the height required to fully hold the 23005 * component content is used. If the height of the component is greater than that of 23006 * the parent container, the component will be drawn beyond the parent container scope. 23007 * 23008 * @param { Length } value 23009 * @returns { T } 23010 * @syscap SystemCapability.ArkUI.ArkUI.Full 23011 * @crossplatform 23012 * @form 23013 * @atomicservice 23014 * @since arkts {'1.1':'11','1.2':'20'} 23015 * @arkts 1.1&1.2 23016 */ 23017 height(value: Length): T; 23018 /** 23019 * Sets the height of the component or its vertical layout policy. By default, the 23020 * component uses the height required for its content. If the height of the component 23021 * is greater than that of the parent container, the component will be drawn beyond 23022 * the parent container scope. 23023 * 23024 * @param { Length | LayoutPolicy } heightValue 23025 * @returns { T } 23026 * @syscap SystemCapability.ArkUI.ArkUI.Full 23027 * @crossplatform 23028 * @form 23029 * @atomicservice 23030 * @since arkts {'1.1':'15','1.2':'20'} 23031 * @arkts 1.1&1.2 23032 */ 23033 height(heightValue: Length | LayoutPolicy): T; 23034 23035 /** 23036 * Sets the drawModifier of the current component. 23037 * 23038 * @param { DrawModifier | undefined } modifier - drawModifier used to draw, or undefined if it is not available. 23039 * Default value: undefined 23040 * A custom modifier applies only to the FrameNode of the currently bound component, not to its subnodes. 23041 * @returns { T } 23042 * @syscap SystemCapability.ArkUI.ArkUI.Full 23043 * @crossplatform 23044 * @atomicservice 23045 * @since arkts {'1.1':'12','1.2':'20'} 23046 * @arkts 1.1&1.2 23047 */ 23048 drawModifier(modifier: DrawModifier | undefined): T; 23049 23050 /** 23051 * Sets the custom property of the current component. 23052 * This API does not work for custom components. 23053 * 23054 * @param { string } name - the name of the custom property. 23055 * @param { Optional<Object> } value - the value of the custom property. 23056 * @returns { T } 23057 * @syscap SystemCapability.ArkUI.ArkUI.Full 23058 * @crossplatform 23059 * @atomicservice 23060 * @since arkts {'1.1':'12','1.2':'20'} 23061 * @arkts 1.1&1.2 23062 */ 23063 customProperty(name: string, value: Optional<Object>): T; 23064 23065 /** 23066 * Expands the safe area. 23067 * 23068 * @param { Array<SafeAreaType> } types - Indicates the types of the safe area. 23069 * @param { Array<SafeAreaEdge> } edges - Indicates the edges of the safe area. 23070 * @returns { T } The component instance. 23071 * @syscap SystemCapability.ArkUI.ArkUI.Full 23072 * @crossplatform 23073 * @since 10 23074 */ 23075 /** 23076 * Sets the safe area to be expanded to. 23077 * default:{types: [SafeAreaType.SYSTEM, SafeAreaType.CUTOUT, SafeAreaType.KEYBOARD], 23078 * edges: [SafeAreaEdge.TOP, SafeAreaEdge.BOTTOM, SafeAreaEdge.START, SafeAreaEdge.END]} 23079 * 23080 * @param { Array<SafeAreaType> } types - Indicates the types of the safe area. 23081 * @param { Array<SafeAreaEdge> } edges - Indicates the edges of the safe area. 23082 * @returns { T } The component instance. 23083 * @syscap SystemCapability.ArkUI.ArkUI.Full 23084 * @crossplatform 23085 * @atomicservice 23086 * @since arkts {'1.1':'11','1.2':'20'} 23087 * @arkts 1.1&1.2 23088 */ 23089 expandSafeArea(types?: Array<SafeAreaType>, edges?: Array<SafeAreaEdge>): T; 23090 23091 /** 23092 * Expands the layout safe area of a component. 23093 * 23094 * @param { Array<LayoutSafeAreaType> } [types] - The region type to expand the component's layout safe area into. The default value is LayoutSafeAreaType.SYSTEM. 23095 * @param { Array<LayoutSafeAreaEdge> } [edges] - The set of edges for which to ignore layout safe area. The default value is LayoutSafeAreaEdge.ALL. 23096 * @returns { T } 23097 * @syscap SystemCapability.ArkUI.ArkUI.Full 23098 * @crossplatform 23099 * @atomicservice 23100 * @since 20 23101 */ 23102 ignoreLayoutSafeArea(types?: Array<LayoutSafeAreaType>, edges?: Array<LayoutSafeAreaEdge>): T; 23103 23104 /** 23105 * Sets the response region of the current component. 23106 * 23107 * @param { Array<Rectangle> | Rectangle } value 23108 * @returns { T } 23109 * @syscap SystemCapability.ArkUI.ArkUI.Full 23110 * @since 8 23111 */ 23112 /** 23113 * Sets the response region of the current component. 23114 * 23115 * @param { Array<Rectangle> | Rectangle } value 23116 * @returns { T } 23117 * @syscap SystemCapability.ArkUI.ArkUI.Full 23118 * @form 23119 * @since 9 23120 */ 23121 /** 23122 * Sets the response region of the current component. 23123 * 23124 * @param { Array<Rectangle> | Rectangle } value 23125 * @returns { T } 23126 * @syscap SystemCapability.ArkUI.ArkUI.Full 23127 * @crossplatform 23128 * @form 23129 * @since 10 23130 */ 23131 /** 23132 * Sets the response region of the current component. 23133 * 23134 * @param { Array<Rectangle> | Rectangle } value 23135 * @returns { T } 23136 * @syscap SystemCapability.ArkUI.ArkUI.Full 23137 * @crossplatform 23138 * @form 23139 * @atomicservice 23140 * @since arkts {'1.1':'11','1.2':'20'} 23141 * @arkts 1.1&1.2 23142 */ 23143 responseRegion(value: Array<Rectangle> | Rectangle): T; 23144 23145 /** 23146 * Sets the mouse response region of current component 23147 * 23148 * @param { Array<Rectangle> | Rectangle } value 23149 * @returns { T } return the component attribute 23150 * @syscap SystemCapability.ArkUI.ArkUI.Full 23151 * @crossplatform 23152 * @since 10 23153 */ 23154 /** 23155 * Sets the mouse response region of current component 23156 * 23157 * @param { Array<Rectangle> | Rectangle } value 23158 * @returns { T } return the component attribute 23159 * @syscap SystemCapability.ArkUI.ArkUI.Full 23160 * @crossplatform 23161 * @atomicservice 23162 * @since arkts {'1.1':'11','1.2':'20'} 23163 * @arkts 1.1&1.2 23164 */ 23165 mouseResponseRegion(value: Array<Rectangle> | Rectangle): T; 23166 23167 /** 23168 * The size of the current component. 23169 * 23170 * @param { SizeOptions } value 23171 * @returns { T } 23172 * @syscap SystemCapability.ArkUI.ArkUI.Full 23173 * @since 7 23174 */ 23175 /** 23176 * The size of the current component. 23177 * 23178 * @param { SizeOptions } value 23179 * @returns { T } 23180 * @syscap SystemCapability.ArkUI.ArkUI.Full 23181 * @form 23182 * @since 9 23183 */ 23184 /** 23185 * The size of the current component. 23186 * 23187 * @param { SizeOptions } value 23188 * @returns { T } 23189 * @syscap SystemCapability.ArkUI.ArkUI.Full 23190 * @crossplatform 23191 * @form 23192 * @since 10 23193 */ 23194 /** 23195 * Sets the size of the component. 23196 * 23197 * @param { SizeOptions } value 23198 * @returns { T } 23199 * @syscap SystemCapability.ArkUI.ArkUI.Full 23200 * @crossplatform 23201 * @form 23202 * @atomicservice 23203 * @since arkts {'1.1':'11','1.2':'20'} 23204 * @arkts 1.1&1.2 23205 */ 23206 size(value: SizeOptions): T; 23207 23208 /** 23209 * constraint Size: 23210 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 23211 * 23212 * @param { ConstraintSizeOptions } value 23213 * @returns { T } 23214 * @syscap SystemCapability.ArkUI.ArkUI.Full 23215 * @since 7 23216 */ 23217 /** 23218 * constraint Size: 23219 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 23220 * 23221 * @param { ConstraintSizeOptions } value 23222 * @returns { T } 23223 * @syscap SystemCapability.ArkUI.ArkUI.Full 23224 * @form 23225 * @since 9 23226 */ 23227 /** 23228 * constraint Size: 23229 * minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height. 23230 * 23231 * @param { ConstraintSizeOptions } value 23232 * @returns { T } 23233 * @syscap SystemCapability.ArkUI.ArkUI.Full 23234 * @crossplatform 23235 * @form 23236 * @since 10 23237 */ 23238 /** 23239 * Sets the constraint size of the component, which is used to limit the size range during component layout. 23240 * Default value: **{minWidth: 0, maxWidth: Infinity, minHeight: 0, maxHeight: Infinity}**. 23241 * 23242 * @param { ConstraintSizeOptions } value 23243 * @returns { T } 23244 * @syscap SystemCapability.ArkUI.ArkUI.Full 23245 * @crossplatform 23246 * @form 23247 * @atomicservice 23248 * @since arkts {'1.1':'11','1.2':'20'} 23249 * @arkts 1.1&1.2 23250 */ 23251 constraintSize(value: ConstraintSizeOptions): T; 23252 23253 /** 23254 * Sets the touchable of the current component 23255 * 23256 * @param { boolean } value 23257 * @returns { T } 23258 * @syscap SystemCapability.ArkUI.ArkUI.Full 23259 * @since 7 23260 * @deprecated since 9 23261 * @useinstead hitTestBehavior 23262 */ 23263 touchable(value: boolean): T; 23264 23265 /** 23266 * Defines the component's hit test behavior in touch events. 23267 * 23268 * @param { HitTestMode } value - the hit test mode. 23269 * @returns { T } 23270 * @syscap SystemCapability.ArkUI.ArkUI.Full 23271 * @since 9 23272 */ 23273 /** 23274 * Defines the component's hit test behavior in touch events. 23275 * 23276 * @param { HitTestMode } value - the hit test mode. 23277 * @returns { T } 23278 * @syscap SystemCapability.ArkUI.ArkUI.Full 23279 * @crossplatform 23280 * @since 10 23281 */ 23282 /** 23283 * Sets how the component behaves during hit testing. 23284 * 23285 * @param { HitTestMode } value - the hit test mode. 23286 * @default HitTestMode.default - Both the node and its child nodes respond to the hit test of a touch event, 23287 * but its sibling nodes are blocked from the hit test. The hit test for ancestor nodes is not affected. 23288 * @returns { T } 23289 * @syscap SystemCapability.ArkUI.ArkUI.Full 23290 * @crossplatform 23291 * @atomicservice 23292 * @since arkts {'1.1':'11','1.2':'20'} 23293 * @arkts 1.1&1.2 23294 */ 23295 hitTestBehavior(value: HitTestMode): T; 23296 23297 /** 23298 * Defines the pre-touch test of sub component in touch events. 23299 * 23300 * @param { function } event 23301 * @returns { T } 23302 * @syscap SystemCapability.ArkUI.ArkUI.Full 23303 * @crossplatform 23304 * @since 11 23305 */ 23306 /** 23307 * Called to specify how to perform the touch test on the children of this component. 23308 * 23309 * @param { function } event 23310 * @returns { T } 23311 * @syscap SystemCapability.ArkUI.ArkUI.Full 23312 * @crossplatform 23313 * @atomicservice 23314 * @since arkts {'1.1':'12','1.2':'20'} 23315 * @arkts 1.1&1.2 23316 */ 23317 onChildTouchTest(event: (value: Array<TouchTestInfo>) => TouchResult): T; 23318 23319 /** 23320 * layout Weight 23321 * 23322 * @param { number | string } value 23323 * @returns { T } 23324 * @syscap SystemCapability.ArkUI.ArkUI.Full 23325 * @since 7 23326 */ 23327 /** 23328 * layout Weight 23329 * 23330 * @param { number | string } value 23331 * @returns { T } 23332 * @syscap SystemCapability.ArkUI.ArkUI.Full 23333 * @form 23334 * @since 9 23335 */ 23336 /** 23337 * layout Weight 23338 * 23339 * @param { number | string } value 23340 * @returns { T } 23341 * @syscap SystemCapability.ArkUI.ArkUI.Full 23342 * @crossplatform 23343 * @form 23344 * @since 10 23345 */ 23346 /** 23347 * Sets the weight of the component during layout. A component with this attribute is allocated space 23348 * along the main axis of its parent container (Row, Column, or Flex) based on its specified weight. 23349 * Default value: **0**. 23350 * 23351 * @param { number | string } value 23352 * @returns { T } 23353 * @syscap SystemCapability.ArkUI.ArkUI.Full 23354 * @crossplatform 23355 * @form 23356 * @atomicservice 23357 * @since arkts {'1.1':'11','1.2':'20'} 23358 * @arkts 1.1&1.2 23359 */ 23360 layoutWeight(value: number | string): T; 23361 23362 /** 23363 * Sets the weight of the component in a chain, which is used to re-lay out components that form the chain. 23364 * <br>This API has effect only when the parent container is RelativeContainer. 23365 * 23366 * @param { ChainWeightOptions } chainWeight 23367 * @returns { T } 23368 * @syscap SystemCapability.ArkUI.ArkUI.Full 23369 * @crossplatform 23370 * @atomicservice 23371 * @since arkts {'1.1':'14','1.2':'20'} 23372 * @arkts 1.1&1.2 23373 */ 23374 chainWeight(chainWeight: ChainWeightOptions): T; 23375 23376 /** 23377 * Inner margin. 23378 * 23379 * @param { Padding | Length } value 23380 * @returns { T } 23381 * @syscap SystemCapability.ArkUI.ArkUI.Full 23382 * @since 7 23383 */ 23384 /** 23385 * Inner margin. 23386 * 23387 * @param { Padding | Length } value 23388 * @returns { T } 23389 * @syscap SystemCapability.ArkUI.ArkUI.Full 23390 * @form 23391 * @since 9 23392 */ 23393 /** 23394 * Inner margin. 23395 * 23396 * @param { Padding | Length } value 23397 * @returns { T } 23398 * @syscap SystemCapability.ArkUI.ArkUI.Full 23399 * @crossplatform 23400 * @form 23401 * @since 10 23402 */ 23403 /** 23404 * Inner margin. 23405 * 23406 * @param { Padding | Length } value 23407 * @returns { T } 23408 * @syscap SystemCapability.ArkUI.ArkUI.Full 23409 * @crossplatform 23410 * @form 23411 * @atomicservice 23412 * @since 11 23413 */ 23414 /** 23415 * Sets the padding of the component. 23416 * Default value: **0**. 23417 * 23418 * @param { Padding | Length | LocalizedPadding } value 23419 * @returns { T } 23420 * @syscap SystemCapability.ArkUI.ArkUI.Full 23421 * @crossplatform 23422 * @form 23423 * @atomicservice 23424 * @since arkts {'1.1':'12','1.2':'20'} 23425 * @arkts 1.1&1.2 23426 */ 23427 padding(value: Padding | Length | LocalizedPadding): T; 23428 23429 /** 23430 * Sets the safe area padding. It enables a container to add a component-level 23431 * safe area for child components to expand into. 23432 * Default value: **LengthMetrics.vp(0)** 23433 * 23434 * @param { Padding | LengthMetrics | LocalizedPadding } paddingValue - Indicates safeArea padding values 23435 * @returns { T } 23436 * @syscap SystemCapability.ArkUI.ArkUI.Full 23437 * @crossplatform 23438 * @form 23439 * @atomicservice 23440 * @since arkts {'1.1':'14','1.2':'20'} 23441 * @arkts 1.1&1.2 23442 */ 23443 safeAreaPadding(paddingValue: Padding | LengthMetrics | LocalizedPadding): T; 23444 23445 /** 23446 * Outer Margin. 23447 * 23448 * @param { Margin | Length } value 23449 * @returns { T } 23450 * @syscap SystemCapability.ArkUI.ArkUI.Full 23451 * @since 7 23452 */ 23453 /** 23454 * Outer Margin. 23455 * 23456 * @param { Margin | Length } value 23457 * @returns { T } 23458 * @syscap SystemCapability.ArkUI.ArkUI.Full 23459 * @form 23460 * @since 9 23461 */ 23462 /** 23463 * Outer Margin. 23464 * 23465 * @param { Margin | Length } value 23466 * @returns { T } 23467 * @syscap SystemCapability.ArkUI.ArkUI.Full 23468 * @crossplatform 23469 * @form 23470 * @since 10 23471 */ 23472 /** 23473 * Outer Margin. 23474 * 23475 * @param { Margin | Length } value 23476 * @returns { T } 23477 * @syscap SystemCapability.ArkUI.ArkUI.Full 23478 * @crossplatform 23479 * @form 23480 * @atomicservice 23481 * @since 11 23482 */ 23483 /** 23484 * Sets the margin of the component. 23485 * Default value: **0**. 23486 * 23487 * @param { Margin | Length | LocalizedMargin } value 23488 * @returns { T } 23489 * @syscap SystemCapability.ArkUI.ArkUI.Full 23490 * @crossplatform 23491 * @form 23492 * @atomicservice 23493 * @since arkts {'1.1':'12','1.2':'20'} 23494 * @arkts 1.1&1.2 23495 */ 23496 margin(value: Margin | Length | LocalizedMargin): T; 23497 23498 /** 23499 * Sets the background color of the component. 23500 * 23501 * @param { CustomBuilder } builder - Custom background. 23502 * @param { object } options - Alignment mode between the custom background and the component. 23503 * <br>If **background**, **backgroundColor**, and **backgroundImage** are set at the same time 23504 * <br>They will all take effect, with **background** at the top layer. 23505 * @returns { T } 23506 * @syscap SystemCapability.ArkUI.ArkUI.Full 23507 * @crossplatform 23508 * @since 10 23509 */ 23510 /** 23511 * Sets the background color of the component. 23512 * 23513 * @param { CustomBuilder } builder - Custom background. 23514 * @param { object } options - Alignment mode between the custom background and the component. 23515 * <br>If **background**, **backgroundColor**, and **backgroundImage** are set at the same time 23516 * <br>They will all take effect, with **background** at the top layer. 23517 * @returns { T } 23518 * @syscap SystemCapability.ArkUI.ArkUI.Full 23519 * @crossplatform 23520 * @atomicservice 23521 * @since 11 23522 */ 23523 /** 23524 * Add a background for the component. 23525 * 23526 * Anonymous Object Rectification. 23527 * @param { CustomBuilder | ResourceColor } content 23528 * @param { BackgroundOptions } [options] 23529 * @returns { T } 23530 * @syscap SystemCapability.ArkUI.ArkUI.Full 23531 * @crossplatform 23532 * @atomicservice 23533 * @since 20 23534 */ 23535 background(content: CustomBuilder | ResourceColor, options?: BackgroundOptions): T; 23536 23537 /** 23538 * Add a background for the component. 23539 * 23540 * Anonymous Object Rectification. 23541 * @param { CustomBuilder } builder 23542 * @param { BackgroundOptions } options 23543 * @returns { T } 23544 * @syscap SystemCapability.ArkUI.ArkUI.Full 23545 * @crossplatform 23546 * @atomicservice 23547 * @since 20 23548 * @arkts 1.2 23549 */ 23550 background(builder: CustomBuilder, options?: BackgroundOptions): T; 23551 23552 /** 23553 * Background color 23554 * 23555 * @param { ResourceColor } value 23556 * @returns { T } 23557 * @syscap SystemCapability.ArkUI.ArkUI.Full 23558 * @since 7 23559 */ 23560 /** 23561 * Background color 23562 * 23563 * @param { ResourceColor } value 23564 * @returns { T } 23565 * @syscap SystemCapability.ArkUI.ArkUI.Full 23566 * @form 23567 * @since 9 23568 */ 23569 /** 23570 * Background color 23571 * 23572 * @param { ResourceColor } value 23573 * @returns { T } 23574 * @syscap SystemCapability.ArkUI.ArkUI.Full 23575 * @crossplatform 23576 * @form 23577 * @since 10 23578 */ 23579 /** 23580 * Background color 23581 * 23582 * @param { ResourceColor } value 23583 * @returns { T } 23584 * @syscap SystemCapability.ArkUI.ArkUI.Full 23585 * @crossplatform 23586 * @form 23587 * @atomicservice 23588 * @since arkts {'1.1':'11','1.2':'20'} 23589 * @arkts 1.1&1.2 23590 */ 23591 backgroundColor(value: ResourceColor): T; 23592 23593 /** 23594 * Background color 23595 * 23596 * @param { Optional<ResourceColor> } color 23597 * @returns { T } 23598 * @syscap SystemCapability.ArkUI.ArkUI.Full 23599 * @crossplatform 23600 * @form 23601 * @atomicservice 23602 * @since arkts {'1.1':'18','1.2':'20'} 23603 * @arkts 1.1&1.2 23604 */ 23605 backgroundColor(color: Optional<ResourceColor>): T; 23606 23607 /** 23608 * Background color 23609 * 23610 * @param { Optional<ResourceColor | ColorMetrics> } color 23611 * @returns { T } 23612 * @syscap SystemCapability.ArkUI.ArkUI.Full 23613 * @crossplatform 23614 * @form 23615 * @atomicservice 23616 * @since 20 23617 */ 23618 backgroundColor(color: Optional<ResourceColor | ColorMetrics>): T; 23619 23620 /** 23621 * Sets the pixel rounding policy for the current component in the specified direction. 23622 * <br>If a direction is not set, the pixels are rounded to the nearest whole number in that direction. 23623 * 23624 * @param { PixelRoundPolicy } value - indicates the rounding policy for the bounds of the component. 23625 * @returns { T } 23626 * @syscap SystemCapability.ArkUI.ArkUI.Full 23627 * @crossplatform 23628 * @form 23629 * @atomicservice 23630 * @since arkts {'1.1':'11','1.2':'20'} 23631 * @arkts 1.1&1.2 23632 */ 23633 pixelRound(value: PixelRoundPolicy): T; 23634 23635 /** 23636 * Background image 23637 * src: Image address url 23638 * 23639 * @param { ResourceStr } src 23640 * @param { ImageRepeat } repeat 23641 * @returns { T } 23642 * @syscap SystemCapability.ArkUI.ArkUI.Full 23643 * @since 7 23644 */ 23645 /** 23646 * Background image 23647 * src: Image address url 23648 * 23649 * @param { ResourceStr } src 23650 * @param { ImageRepeat } repeat 23651 * @returns { T } 23652 * @syscap SystemCapability.ArkUI.ArkUI.Full 23653 * @form 23654 * @since 9 23655 */ 23656 /** 23657 * Background image 23658 * src: Image address url 23659 * 23660 * @param { ResourceStr } src 23661 * @param { ImageRepeat } repeat 23662 * @returns { T } 23663 * @syscap SystemCapability.ArkUI.ArkUI.Full 23664 * @crossplatform 23665 * @form 23666 * @since 10 23667 */ 23668 /** 23669 * Background image 23670 * src: Image address url 23671 * 23672 * @param { ResourceStr } src 23673 * @param { ImageRepeat } repeat 23674 * @returns { T } 23675 * @syscap SystemCapability.ArkUI.ArkUI.Full 23676 * @crossplatform 23677 * @form 23678 * @atomicservice 23679 * @since 11 23680 */ 23681 /** 23682 * Background image 23683 * src: Image address url 23684 * 23685 * @param { ResourceStr | PixelMap } src 23686 * @param { ImageRepeat } repeat 23687 * @returns { T } 23688 * @syscap SystemCapability.ArkUI.ArkUI.Full 23689 * @crossplatform 23690 * @form 23691 * @atomicservice 23692 * @since arkts {'1.1':'12','1.2':'20'} 23693 * @arkts 1.1&1.2 23694 */ 23695 backgroundImage(src: ResourceStr | PixelMap, repeat?: ImageRepeat): T; 23696 23697 /** 23698 * Background image 23699 * 23700 * @param { ResourceStr | PixelMap } src - the background image source 23701 * @param { BackgroundImageOptions } [options] - config the options 23702 * @returns { T } 23703 * @syscap SystemCapability.ArkUI.ArkUI.Full 23704 * @crossplatform 23705 * @form 23706 * @atomicservice 23707 * @since arkts {'1.1':'18','1.2':'20'} 23708 * @arkts 1.1&1.2 23709 */ 23710 backgroundImage(src: ResourceStr | PixelMap, options?: BackgroundImageOptions): T; 23711 23712 /** 23713 * Background image size 23714 * 23715 * @param { SizeOptions | ImageSize } value 23716 * @returns { T } 23717 * @syscap SystemCapability.ArkUI.ArkUI.Full 23718 * @since 7 23719 */ 23720 /** 23721 * Background image size 23722 * 23723 * @param { SizeOptions | ImageSize } value 23724 * @returns { T } 23725 * @syscap SystemCapability.ArkUI.ArkUI.Full 23726 * @form 23727 * @since 9 23728 */ 23729 /** 23730 * Background image size 23731 * 23732 * @param { SizeOptions | ImageSize } value 23733 * @returns { T } 23734 * @syscap SystemCapability.ArkUI.ArkUI.Full 23735 * @crossplatform 23736 * @form 23737 * @since 10 23738 */ 23739 /** 23740 * Background image size 23741 * 23742 * @param { SizeOptions | ImageSize } value - The width and height of the background image. 23743 * @returns { T } 23744 * @syscap SystemCapability.ArkUI.ArkUI.Full 23745 * @crossplatform 23746 * @form 23747 * @atomicservice 23748 * @since arkts {'1.1':'11','1.2':'20'} 23749 * @arkts 1.1&1.2 23750 */ 23751 backgroundImageSize(value: SizeOptions | ImageSize): T; 23752 23753 /** 23754 * Background image position 23755 * x:Horizontal coordinate;y:Vertical axis coordinate. 23756 * 23757 * @param { Position | Alignment } value 23758 * @returns { T } 23759 * @syscap SystemCapability.ArkUI.ArkUI.Full 23760 * @since 7 23761 */ 23762 /** 23763 * Background image position 23764 * x:Horizontal coordinate;y:Vertical axis coordinate. 23765 * 23766 * @param { Position | Alignment } value 23767 * @returns { T } 23768 * @syscap SystemCapability.ArkUI.ArkUI.Full 23769 * @form 23770 * @since 9 23771 */ 23772 /** 23773 * Background image position 23774 * x:Horizontal coordinate;y:Vertical axis coordinate. 23775 * 23776 * @param { Position | Alignment } value 23777 * @returns { T } 23778 * @syscap SystemCapability.ArkUI.ArkUI.Full 23779 * @crossplatform 23780 * @form 23781 * @since 10 23782 */ 23783 /** 23784 * Background image position 23785 * x:Horizontal coordinate;y:Vertical axis coordinate. 23786 * 23787 * @param { Position | Alignment } value 23788 * @returns { T } 23789 * @syscap SystemCapability.ArkUI.ArkUI.Full 23790 * @crossplatform 23791 * @form 23792 * @atomicservice 23793 * @since arkts {'1.1':'11','1.2':'20'} 23794 * @arkts 1.1&1.2 23795 */ 23796 backgroundImagePosition(value: Position | Alignment): T; 23797 23798 /** 23799 * Defines the blur style to apply between the background and content of a component. 23800 * It encapsulates various blur radius, mask color, mask opacity, saturation 23801 * and brightness values through enum values. 23802 * 23803 * @param { BlurStyle } value - Settings of the background blur style 23804 * <br>including the blur radius, mask color, mask opacity, saturation, and brightness. 23805 * @param { BackgroundBlurStyleOptions } options - Background blur options. 23806 * @returns { T } 23807 * @syscap SystemCapability.ArkUI.ArkUI.Full 23808 * @form 23809 * @since 9 23810 */ 23811 /** 23812 * Defines the blur style to apply between the background and content of a component. 23813 * It encapsulates various blur radius, mask color, mask opacity, saturation 23814 * and brightness values through enum values. 23815 * 23816 * @param { BlurStyle } value - Settings of the background blur style 23817 * <br>including the blur radius, mask color, mask opacity, saturation, and brightness. 23818 * @param { BackgroundBlurStyleOptions } options - Background blur options. 23819 * @returns { T } 23820 * @syscap SystemCapability.ArkUI.ArkUI.Full 23821 * @crossplatform 23822 * @form 23823 * @since 10 23824 */ 23825 /** 23826 * Defines the blur style to apply between the background and content of a component. 23827 * It encapsulates various blur radius, mask color, mask opacity, saturation 23828 * and brightness values through enum values. 23829 * 23830 * @param { BlurStyle } value - Settings of the background blur style 23831 * <br>including the blur radius, mask color, mask opacity, saturation, and brightness. 23832 * @param { BackgroundBlurStyleOptions } options - Background blur options. 23833 * @returns { T } 23834 * @syscap SystemCapability.ArkUI.ArkUI.Full 23835 * @crossplatform 23836 * @form 23837 * @atomicservice 23838 * @since arkts {'1.1':'11','1.2':'20'} 23839 * @arkts 1.1&1.2 23840 */ 23841 backgroundBlurStyle(value: BlurStyle, options?: BackgroundBlurStyleOptions): T; 23842 23843 /** 23844 * Background blur style. 23845 * 23846 * @param { Optional<BlurStyle> } style - Settings of the background blur style 23847 * <br>including the blur radius, mask color, mask opacity, saturation, and brightness. 23848 * @param { BackgroundBlurStyleOptions } [options] - Background blur options. 23849 * @returns { T } 23850 * @syscap SystemCapability.ArkUI.ArkUI.Full 23851 * @crossplatform 23852 * @form 23853 * @atomicservice 23854 * @since 18 23855 */ 23856 backgroundBlurStyle(style: Optional<BlurStyle>, options?: BackgroundBlurStyleOptions): T; 23857 23858 /** 23859 * Background blur style. 23860 * 23861 * @param { Optional<BlurStyle> } style - Settings of the background blur style 23862 * <br>including the blur radius, mask color, mask opacity, saturation, and brightness. 23863 * @param { BackgroundBlurStyleOptions } [options] - Background blur options. 23864 * @param { SystemAdaptiveOptions } [sysOptions] - System adaptive options. 23865 * @returns { T } 23866 * @syscap SystemCapability.ArkUI.ArkUI.Full 23867 * @crossplatform 23868 * @form 23869 * @atomicservice 23870 * @since arkts {'1.1':'19','1.2':'20'} 23871 * @arkts 1.1&1.2 23872 */ 23873 backgroundBlurStyle(style: Optional<BlurStyle>, options?: BackgroundBlurStyleOptions, sysOptions?: SystemAdaptiveOptions): T; 23874 23875 /** 23876 * Sets the background effect of the component, including the blur radius, brightness, saturation, and color. 23877 * 23878 * @param { BackgroundEffectOptions } options - Background effect, including saturation, brightness, and color. 23879 * @returns { T } 23880 * @syscap SystemCapability.ArkUI.ArkUI.Full 23881 * @crossplatform 23882 * @since 11 23883 */ 23884 /** 23885 * Sets the background effect of the component, including the blur radius, brightness, saturation, and color. 23886 * 23887 * @param { BackgroundEffectOptions } options - Background effect, including saturation, brightness, and color. 23888 * @returns { T } 23889 * @syscap SystemCapability.ArkUI.ArkUI.Full 23890 * @crossplatform 23891 * @atomicservice 23892 * @since arkts {'1.1':'12','1.2':'20'} 23893 * @arkts 1.1&1.2 23894 */ 23895 backgroundEffect(options: BackgroundEffectOptions): T; 23896 23897 /** 23898 * Sets the background effect of the component, including the blur radius, brightness, 23899 * saturation, and color. Compared to backgroundEffect<sup>11+</sup>, 23900 * this API supports the **undefined** type for the **options** parameter. 23901 * 23902 * @param { Optional<BackgroundEffectOptions> } options - Background effect, including saturation, 23903 * brightness, and color. 23904 * <br>If **options** is **undefined**, the background reverts to its default state with no effect. 23905 * @param { SystemAdaptiveOptions } [ sysOptions ] - System adaptive adjustment options. 23906 * <br>Default value: **{ disableSystemAdaptation: false }**. 23907 * @returns { T } 23908 * @syscap SystemCapability.ArkUI.ArkUI.Full 23909 * @crossplatform 23910 * @atomicservice 23911 * @since 18 23912 */ 23913 backgroundEffect(options: Optional<BackgroundEffectOptions>): T; 23914 23915 /** 23916 * options:background effect options. 23917 * sysOptions: system adaptive options. 23918 * 23919 * @param { Optional<BackgroundEffectOptions> } options - options indicates the effect options. 23920 * @param { SystemAdaptiveOptions } [ sysOptions ] - system adaptive options. 23921 * @returns { T } 23922 * @syscap SystemCapability.ArkUI.ArkUI.Full 23923 * @crossplatform 23924 * @atomicservice 23925 * @since arkts {'1.1':'19','1.2':'20'} 23926 * @arkts 1.1&1.2 23927 */ 23928 backgroundEffect(options: Optional<BackgroundEffectOptions>, sysOptions?: SystemAdaptiveOptions): T; 23929 23930 /** 23931 * Background image resizable. 23932 * value:resizable options 23933 * 23934 * @param { ResizableOptions } value - Indicates the resizable options. 23935 * @returns { T } 23936 * @syscap SystemCapability.ArkUI.ArkUI.Full 23937 * @crossplatform 23938 * @atomicservice 23939 * @since arkts {'1.1':'12','1.2':'20'} 23940 * @arkts 1.1&1.2 23941 */ 23942 backgroundImageResizable(value: ResizableOptions): T; 23943 23944 /** 23945 * Foreground effect. 23946 * 23947 * @param { ForegroundEffectOptions } options - options indicates the effect options. 23948 * @returns { T } 23949 * @syscap SystemCapability.ArkUI.ArkUI.Full 23950 * @crossplatform 23951 * @atomicservice 23952 * @since arkts {'1.1':'12','1.2':'20'} 23953 * @arkts 1.1&1.2 23954 */ 23955 foregroundEffect(options: ForegroundEffectOptions): T; 23956 23957 /** 23958 * Sets a visual effect that is not a filter effect. 23959 * 23960 * @param { VisualEffect } effect - Visual effect parameters. 23961 * @returns { T } 23962 * @syscap SystemCapability.ArkUI.ArkUI.Full 23963 * @crossplatform 23964 * @atomicservice 23965 * @since arkts {'1.1':'12','1.2':'20'} 23966 * @arkts 1.1&1.2 23967 */ 23968 visualEffect(effect: VisualEffect): T; 23969 23970 /** 23971 * Sets the visual effect of the background filter. 23972 * 23973 * @param { Filter } filter - Filter effect parameters. 23974 * @returns { T } 23975 * @syscap SystemCapability.ArkUI.ArkUI.Full 23976 * @crossplatform 23977 * @atomicservice 23978 * @since arkts {'1.1':'12','1.2':'20'} 23979 * @arkts 1.1&1.2 23980 */ 23981 backgroundFilter(filter: Filter): T; 23982 23983 /** 23984 * Sets the visual effect of the foreground (content) filter. 23985 * 23986 * @param { Filter } filter - Filter effect parameters. 23987 * @returns { T } 23988 * @syscap SystemCapability.ArkUI.ArkUI.Full 23989 * @crossplatform 23990 * @atomicservice 23991 * @since arkts {'1.1':'12','1.2':'20'} 23992 * @arkts 1.1&1.2 23993 */ 23994 foregroundFilter(filter: Filter): T; 23995 23996 /** 23997 * Sets the visual effect of the compositing filter. 23998 * 23999 * @param { Filter } filter - Filter effect parameters. 24000 * @returns { T } 24001 * @syscap SystemCapability.ArkUI.ArkUI.Full 24002 * @crossplatform 24003 * @atomicservice 24004 * @since arkts {'1.1':'12','1.2':'20'} 24005 * @arkts 1.1&1.2 24006 */ 24007 compositingFilter(filter: Filter): T; 24008 24009 /** 24010 * Applies a foreground blur style to the component. 24011 * 24012 * @param { BlurStyle } value - Settings of the foreground blur style. 24013 * @param { ForegroundBlurStyleOptions } options - Foreground blur options. 24014 * @returns { T } 24015 * @syscap SystemCapability.ArkUI.ArkUI.Full 24016 * @crossplatform 24017 * @since 10 24018 */ 24019 /** 24020 * Applies a foreground blur style to the component. 24021 * 24022 * @param { BlurStyle } value - Settings of the foreground blur style. 24023 * @param { ForegroundBlurStyleOptions } options - Foreground blur options. 24024 * @returns { T } 24025 * @syscap SystemCapability.ArkUI.ArkUI.Full 24026 * @crossplatform 24027 * @atomicservice 24028 * @since arkts {'1.1':'11','1.2':'20'} 24029 * @arkts 1.1&1.2 24030 */ 24031 foregroundBlurStyle(value: BlurStyle, options?: ForegroundBlurStyleOptions): T; 24032 24033 /** 24034 * Foreground blur style. 24035 * blurStyle:Blur style type. 24036 * 24037 * @param { Optional<BlurStyle> } style 24038 * @param { ForegroundBlurStyleOptions } [options] 24039 * @returns { T } 24040 * @syscap SystemCapability.ArkUI.ArkUI.Full 24041 * @crossplatform 24042 * @atomicservice 24043 * @since 18 24044 */ 24045 foregroundBlurStyle(style: Optional<BlurStyle>, options?: ForegroundBlurStyleOptions): T; 24046 24047 /** 24048 * Foreground blur style. 24049 * blurStyle:Blur style type. 24050 * sysOptions: system adaptive options. 24051 * 24052 * @param { Optional<BlurStyle> } style 24053 * @param { ForegroundBlurStyleOptions } [options] 24054 * @param { SystemAdaptiveOptions } [sysOptions] 24055 * @returns { T } 24056 * @syscap SystemCapability.ArkUI.ArkUI.Full 24057 * @crossplatform 24058 * @atomicservice 24059 * @since arkts {'1.1':'19','1.2':'20'} 24060 * @arkts 1.1&1.2 24061 */ 24062 foregroundBlurStyle(style: Optional<BlurStyle>, options?: ForegroundBlurStyleOptions, sysOptions?: SystemAdaptiveOptions): T; 24063 24064 /** 24065 * Sets the opacity of the component. 24066 * 24067 * @param { number | Resource } value - Opacity of the component. The value ranges from 0 to 1. 24068 * @returns { T } 24069 * @syscap SystemCapability.ArkUI.ArkUI.Full 24070 * @since 7 24071 */ 24072 /** 24073 * Sets the opacity of the component. 24074 * 24075 * @param { number | Resource } value - Opacity of the component. The value ranges from 0 to 1. 24076 * @returns { T } 24077 * @syscap SystemCapability.ArkUI.ArkUI.Full 24078 * @form 24079 * @since 9 24080 */ 24081 /** 24082 * Sets the opacity of the component. 24083 * 24084 * @param { number | Resource } value - Opacity of the component. The value ranges from 0 to 1. 24085 * @returns { T } 24086 * @syscap SystemCapability.ArkUI.ArkUI.Full 24087 * @crossplatform 24088 * @form 24089 * @since 10 24090 */ 24091 /** 24092 * Sets the opacity of the component. 24093 * 24094 * @param { number | Resource } value - Opacity of the component. The value ranges from 0 to 1. 24095 * @returns { T } 24096 * @syscap SystemCapability.ArkUI.ArkUI.Full 24097 * @crossplatform 24098 * @form 24099 * @atomicservice 24100 * @since arkts {'1.1':'11','1.2':'20'} 24101 * @arkts 1.1&1.2 24102 */ 24103 opacity(value: number | Resource): T; 24104 24105 /** 24106 * Sets the opacity of the component. 24107 * 24108 * @param { Optional<number | Resource> } opacity - Opacity of the component. The value ranges from 0 to 1. 24109 * @returns { T } 24110 * @syscap SystemCapability.ArkUI.ArkUI.Full 24111 * @crossplatform 24112 * @form 24113 * @atomicservice 24114 * @since arkts {'1.1':'18','1.2':'20'} 24115 * @arkts 1.1&1.2 24116 */ 24117 opacity(opacity: Optional<number | Resource>): T; 24118 24119 /** 24120 * Border 24121 * width:Border width;color:Border color;radius:Border radius; 24122 * 24123 * @param { BorderOptions } value 24124 * @returns { T } 24125 * @syscap SystemCapability.ArkUI.ArkUI.Full 24126 * @since 7 24127 */ 24128 /** 24129 * Border 24130 * width:Border width;color:Border color;radius:Border radius; 24131 * 24132 * @param { BorderOptions } value 24133 * @returns { T } 24134 * @syscap SystemCapability.ArkUI.ArkUI.Full 24135 * @form 24136 * @since 9 24137 */ 24138 /** 24139 * Border 24140 * width:Border width;color:Border color;radius:Border radius; 24141 * 24142 * @param { BorderOptions } value 24143 * @returns { T } 24144 * @syscap SystemCapability.ArkUI.ArkUI.Full 24145 * @crossplatform 24146 * @form 24147 * @since 10 24148 */ 24149 /** 24150 * Sets the border. 24151 * 24152 * @param { BorderOptions } value 24153 * @returns { T } 24154 * @syscap SystemCapability.ArkUI.ArkUI.Full 24155 * @crossplatform 24156 * @form 24157 * @atomicservice 24158 * @since arkts {'1.1':'11','1.2':'20'} 24159 * @arkts 1.1&1.2 24160 */ 24161 border(value: BorderOptions): T; 24162 24163 /** 24164 * Border style 24165 * 24166 * @param { BorderStyle } value 24167 * @returns { T } 24168 * @syscap SystemCapability.ArkUI.ArkUI.Full 24169 * @since 7 24170 */ 24171 /** 24172 * Border style 24173 * 24174 * @param { BorderStyle | EdgeStyles } value 24175 * @returns { T } 24176 * @syscap SystemCapability.ArkUI.ArkUI.Full 24177 * @form 24178 * @since 9 24179 */ 24180 /** 24181 * Border style 24182 * 24183 * @param { BorderStyle | EdgeStyles } value 24184 * @returns { T } 24185 * @syscap SystemCapability.ArkUI.ArkUI.Full 24186 * @crossplatform 24187 * @form 24188 * @since 10 24189 */ 24190 /** 24191 * Sets the border style. 24192 * Default value: **BorderStyle.Solid**. 24193 * 24194 * @param { BorderStyle | EdgeStyles } value 24195 * @returns { T } 24196 * @syscap SystemCapability.ArkUI.ArkUI.Full 24197 * @crossplatform 24198 * @form 24199 * @atomicservice 24200 * @since arkts {'1.1':'11','1.2':'20'} 24201 * @arkts 1.1&1.2 24202 */ 24203 borderStyle(value: BorderStyle | EdgeStyles): T; 24204 24205 /** 24206 * Border width 24207 * 24208 * @param { Length } value 24209 * @returns { T } 24210 * @syscap SystemCapability.ArkUI.ArkUI.Full 24211 * @since 7 24212 */ 24213 /** 24214 * Border width 24215 * 24216 * @param { Length | EdgeWidths } value 24217 * @returns { T } 24218 * @syscap SystemCapability.ArkUI.ArkUI.Full 24219 * @form 24220 * @since 9 24221 */ 24222 /** 24223 * Border width 24224 * 24225 * @param { Length | EdgeWidths } value 24226 * @returns { T } 24227 * @syscap SystemCapability.ArkUI.ArkUI.Full 24228 * @crossplatform 24229 * @form 24230 * @since 10 24231 */ 24232 /** 24233 * Border width 24234 * 24235 * @param { Length | EdgeWidths } value 24236 * @returns { T } 24237 * @syscap SystemCapability.ArkUI.ArkUI.Full 24238 * @crossplatform 24239 * @form 24240 * @atomicservice 24241 * @since 11 24242 */ 24243 /** 24244 * Sets the border width. 24245 * Percentage values are not supported. 24246 * 24247 * @param { Length | EdgeWidths | LocalizedEdgeWidths } value 24248 * @returns { T } 24249 * @syscap SystemCapability.ArkUI.ArkUI.Full 24250 * @crossplatform 24251 * @form 24252 * @atomicservice 24253 * @since arkts {'1.1':'12','1.2':'20'} 24254 * @arkts 1.1&1.2 24255 */ 24256 borderWidth(value: Length | EdgeWidths | LocalizedEdgeWidths): T; 24257 24258 /** 24259 * Border color 24260 * 24261 * @param { ResourceColor } value 24262 * @returns { T } 24263 * @syscap SystemCapability.ArkUI.ArkUI.Full 24264 * @since 7 24265 */ 24266 /** 24267 * Border color 24268 * 24269 * @param { ResourceColor | EdgeColors } value 24270 * @returns { T } 24271 * @syscap SystemCapability.ArkUI.ArkUI.Full 24272 * @form 24273 * @since 9 24274 */ 24275 /** 24276 * Border color 24277 * 24278 * @param { ResourceColor | EdgeColors } value 24279 * @returns { T } 24280 * @syscap SystemCapability.ArkUI.ArkUI.Full 24281 * @crossplatform 24282 * @form 24283 * @since 10 24284 */ 24285 /** 24286 * Border color 24287 * 24288 * @param { ResourceColor | EdgeColors } value 24289 * @returns { T } 24290 * @syscap SystemCapability.ArkUI.ArkUI.Full 24291 * @crossplatform 24292 * @form 24293 * @atomicservice 24294 * @since 11 24295 */ 24296 /** 24297 * Sets the border color. 24298 * Default value: **Color.Black**. 24299 * @param { ResourceColor | EdgeColors | LocalizedEdgeColors } value 24300 * @returns { T } 24301 * @syscap SystemCapability.ArkUI.ArkUI.Full 24302 * @crossplatform 24303 * @form 24304 * @atomicservice 24305 * @since arkts {'1.1':'12','1.2':'20'} 24306 * @arkts 1.1&1.2 24307 */ 24308 borderColor(value: ResourceColor | EdgeColors | LocalizedEdgeColors): T; 24309 24310 /** 24311 * Border radius 24312 * 24313 * @param { Length } value 24314 * @returns { T } 24315 * @syscap SystemCapability.ArkUI.ArkUI.Full 24316 * @since 7 24317 */ 24318 /** 24319 * Border radius 24320 * 24321 * @param { Length | BorderRadiuses } value 24322 * @returns { T } 24323 * @syscap SystemCapability.ArkUI.ArkUI.Full 24324 * @form 24325 * @since 9 24326 */ 24327 /** 24328 * Border radius 24329 * 24330 * @param { Length | BorderRadiuses } value 24331 * @returns { T } 24332 * @syscap SystemCapability.ArkUI.ArkUI.Full 24333 * @crossplatform 24334 * @form 24335 * @since 10 24336 */ 24337 /** 24338 * Border radius 24339 * 24340 * @param { Length | BorderRadiuses } value 24341 * @returns { T } 24342 * @syscap SystemCapability.ArkUI.ArkUI.Full 24343 * @crossplatform 24344 * @form 24345 * @atomicservice 24346 * @since 11 24347 */ 24348 /** 24349 * Sets the radius of the border rounded corners. 24350 * <br>The radius is restricted by the component size. The maximum value is half of the component width or height. 24351 * 24352 * @param { Length | BorderRadiuses | LocalizedBorderRadiuses } value 24353 * @returns { T } 24354 * @syscap SystemCapability.ArkUI.ArkUI.Full 24355 * @crossplatform 24356 * @form 24357 * @atomicservice 24358 * @since arkts {'1.1':'12','1.2':'20'} 24359 * @arkts 1.1&1.2 24360 */ 24361 borderRadius(value: Length | BorderRadiuses | LocalizedBorderRadiuses): T; 24362 24363 /** 24364 * Border image 24365 * 24366 * @param { BorderImageOption } value 24367 * @returns { T } 24368 * @syscap SystemCapability.ArkUI.ArkUI.Full 24369 * @form 24370 * @since 9 24371 */ 24372 /** 24373 * Border image 24374 * 24375 * @param { BorderImageOption } value 24376 * @returns { T } 24377 * @syscap SystemCapability.ArkUI.ArkUI.Full 24378 * @crossplatform 24379 * @form 24380 * @since 10 24381 */ 24382 /** 24383 * Sets the border image of the component. 24384 * 24385 * @param { BorderImageOption } value - Border image or border gradient. 24386 * @returns { T } 24387 * @syscap SystemCapability.ArkUI.ArkUI.Full 24388 * @crossplatform 24389 * @form 24390 * @atomicservice 24391 * @since arkts {'1.1':'11','1.2':'20'} 24392 * @arkts 1.1&1.2 24393 */ 24394 borderImage(value: BorderImageOption): T; 24395 24396 /** 24397 * Sets the outline attributes in one declaration. 24398 * 24399 * @param { OutlineOptions } value - Outline attributes. 24400 * @returns { T } 24401 * @syscap SystemCapability.ArkUI.ArkUI.Full 24402 * @crossplatform 24403 * @form 24404 * @since 11 24405 */ 24406 /** 24407 * Sets the outline attributes in one declaration. 24408 * 24409 * @param { OutlineOptions } value - Outline attributes. 24410 * @returns { T } 24411 * @syscap SystemCapability.ArkUI.ArkUI.Full 24412 * @crossplatform 24413 * @form 24414 * @atomicservice 24415 * @since arkts {'1.1':'12','1.2':'20'} 24416 * @arkts 1.1&1.2 24417 */ 24418 outline(value: OutlineOptions): T; 24419 24420 /** 24421 * Sets the outline attributes in one declaration. Compared to outline, 24422 * this API supports the **undefined** type for the **options** parameter. 24423 * 24424 * @param { Optional<OutlineOptions> } options - Outline attributes.<br>If **options** is **undefined**, 24425 * the component reverts to its original style with no outline. 24426 * @returns { T } 24427 * @syscap SystemCapability.ArkUI.ArkUI.Full 24428 * @crossplatform 24429 * @form 24430 * @atomicservice 24431 * @since arkts {'1.1':'18','1.2':'20'} 24432 * @arkts 1.1&1.2 24433 */ 24434 outline(options: Optional<OutlineOptions>): T; 24435 24436 /** 24437 * Sets the style of the outline. 24438 * 24439 * @param { OutlineStyle | EdgeOutlineStyles } value - Outline style. 24440 * <br>Default value: **OutlineStyle.SOLID**. 24441 * @returns { T } 24442 * @syscap SystemCapability.ArkUI.ArkUI.Full 24443 * @crossplatform 24444 * @form 24445 * @since 11 24446 */ 24447 /** 24448 * Sets the style of the outline. 24449 * 24450 * @param { OutlineStyle | EdgeOutlineStyles } value - Outline style. 24451 * <br>Default value: **OutlineStyle.SOLID**. 24452 * @returns { T } 24453 * @syscap SystemCapability.ArkUI.ArkUI.Full 24454 * @crossplatform 24455 * @form 24456 * @atomicservice 24457 * @since arkts {'1.1':'12','1.2':'20'} 24458 * @arkts 1.1&1.2 24459 */ 24460 outlineStyle(value: OutlineStyle | EdgeOutlineStyles): T; 24461 24462 /** 24463 * Sets the style of the outline. Compared to outlineStyle, 24464 * this API supports the **undefined** type for the **style** parameter. 24465 * 24466 * @param { Optional<OutlineStyle | EdgeOutlineStyles> } style - Outline style. 24467 * <br>Default value: **OutlineStyle.SOLID**. 24468 * <br>If **style** is **undefined**, the component reverts to its original 24469 * style with no outline. 24470 * @returns { T } 24471 * @syscap SystemCapability.ArkUI.ArkUI.Full 24472 * @crossplatform 24473 * @form 24474 * @atomicservice 24475 * @since arkts {'1.1':'18','1.2':'20'} 24476 * @arkts 1.1&1.2 24477 */ 24478 outlineStyle(style: Optional<OutlineStyle | EdgeOutlineStyles>): T; 24479 24480 /** 24481 * Sets the thickness of the outline. 24482 * 24483 * @param { Dimension | EdgeOutlineWidths } value - Outline thickness. Percentage values are not supported. 24484 * <br>Default value: **0**Outline thickness. Percentage values are not supported. 24485 * <br>Default value: **0**. 24486 * @returns { T } 24487 * @syscap SystemCapability.ArkUI.ArkUI.Full 24488 * @crossplatform 24489 * @form 24490 * @since 11 24491 */ 24492 /** 24493 * Sets the thickness of the outline. 24494 * 24495 * @param { Dimension | EdgeOutlineWidths } value - Outline thickness. Percentage values are not supported. 24496 * <br>Default value: **0**Outline thickness. Percentage values are not supported. 24497 * <br>Default value: **0**. 24498 * @returns { T } 24499 * @syscap SystemCapability.ArkUI.ArkUI.Full 24500 * @crossplatform 24501 * @form 24502 * @atomicservice 24503 * @since arkts {'1.1':'12','1.2':'20'} 24504 * @arkts 1.1&1.2 24505 */ 24506 outlineWidth(value: Dimension | EdgeOutlineWidths): T; 24507 24508 /** 24509 * Sets the thickness of the outline. Compared to outlineWidth, 24510 * this API supports the **undefined** type for the **width** parameter. 24511 * 24512 * @param { Optional<Dimension | EdgeOutlineWidths> } width - Outline thickness. Percentage values are not supported. 24513 * <br>Default value: **0**. 24514 * <br>If **width** is **undefined**, the component reverts to its original style with no outline width. 24515 * @returns { T } 24516 * @syscap SystemCapability.ArkUI.ArkUI.Full 24517 * @crossplatform 24518 * @form 24519 * @atomicservice 24520 * @since arkts {'1.1':'18','1.2':'20'} 24521 * @arkts 1.1&1.2 24522 */ 24523 outlineWidth(width: Optional<Dimension | EdgeOutlineWidths>): T; 24524 24525 /** 24526 * Sets the color of the outline. 24527 * 24528 * @param { ResourceColor | EdgeColors } value - Outline color. 24529 * <br>Default value: **Color.Black**. 24530 * @returns { T } 24531 * @syscap SystemCapability.ArkUI.ArkUI.Full 24532 * @crossplatform 24533 * @form 24534 * @since 11 24535 */ 24536 /** 24537 * Sets the color of the outline. 24538 * 24539 * @param { ResourceColor | EdgeColors | LocalizedEdgeColors } value - Outline color. 24540 * <br>Default value: **Color.Black**. 24541 * @returns { T } 24542 * @syscap SystemCapability.ArkUI.ArkUI.Full 24543 * @crossplatform 24544 * @form 24545 * @atomicservice 24546 * @since arkts {'1.1':'12','1.2':'20'} 24547 * @arkts 1.1&1.2 24548 */ 24549 outlineColor(value: ResourceColor | EdgeColors | LocalizedEdgeColors): T; 24550 24551 /** 24552 * Sets the color of the outline. Compared to outlineColor, 24553 * this API supports the **undefined** type for the **color** parameter. 24554 * 24555 * @param { Optional<ResourceColor | EdgeColors | LocalizedEdgeColors> } color - Outline color. 24556 * <br>Default value: **Color.Black**. 24557 * <br>If **color** is **undefined**, the component reverts to its original style with the 24558 * outline color of **Color.Black**. 24559 * @returns { T } 24560 * @syscap SystemCapability.ArkUI.ArkUI.Full 24561 * @crossplatform 24562 * @form 24563 * @atomicservice 24564 * @since arkts {'1.1':'18','1.2':'20'} 24565 * @arkts 1.1&1.2 24566 */ 24567 outlineColor(color: Optional<ResourceColor | EdgeColors | LocalizedEdgeColors>): T; 24568 24569 /** 24570 * Sets the radius of the outline corners. 24571 * 24572 * @param { Dimension | OutlineRadiuses } value - adius of the outline corners. Percentage 24573 * values are not supported. 24574 * <br>Default value: **0**. 24575 * <br>Maximum effective value: Component width/2 + outlineWidth or component height/2 + outlineWidth. 24576 * @returns { T } 24577 * @syscap SystemCapability.ArkUI.ArkUI.Full 24578 * @crossplatform 24579 * @form 24580 * @since 11 24581 */ 24582 /** 24583 * Sets the radius of the outline corners. 24584 * 24585 * @param { Dimension | OutlineRadiuses } value - adius of the outline corners. Percentage 24586 * values are not supported. 24587 * <br>Default value: **0**. 24588 * <br>Maximum effective value: Component width/2 + outlineWidth or component height/2 + outlineWidth. 24589 * @returns { T } 24590 * @syscap SystemCapability.ArkUI.ArkUI.Full 24591 * @crossplatform 24592 * @form 24593 * @atomicservice 24594 * @since arkts {'1.1':'12','1.2':'20'} 24595 * @arkts 1.1&1.2 24596 */ 24597 outlineRadius(value: Dimension | OutlineRadiuses): T; 24598 24599 /** 24600 * Sets the radius of the outline corners. Compared to outlineRadius, this API 24601 * supports the **undefined** type for the **radius** parameter. 24602 * 24603 * @param { Optional<Dimension | OutlineRadiuses> } radius - Radius of the outline corners. Percentage 24604 * values are not supported. 24605 * <br>Default value: **0**. 24606 * <br>Maximum effective value: Component width/2 + outlineWidth or component height/2 + outlineWidth. 24607 * <br>If **radius** is **undefined**, the component reverts to its original style with the 24608 * outline corner radius of 0. 24609 * @returns { T } 24610 * @syscap SystemCapability.ArkUI.ArkUI.Full 24611 * @crossplatform 24612 * @form 24613 * @atomicservice 24614 * @since arkts {'1.1':'18','1.2':'20'} 24615 * @arkts 1.1&1.2 24616 */ 24617 outlineRadius(radius: Optional<Dimension | OutlineRadiuses>): T; 24618 24619 /** 24620 * Sets the foreground color of the component. 24621 * If the component does not have a foreground color set, it inherits the color from its parent component by default. 24622 * 24623 * @param { ResourceColor | ColoringStrategy } value - Foreground color. 24624 * <br>The value can be a specific color or a coloring strategy. Property animations are supported. 24625 * @returns { T } 24626 * @syscap SystemCapability.ArkUI.ArkUI.Full 24627 * @crossplatform 24628 * @since 10 24629 */ 24630 /** 24631 * Sets the foreground color of the component. 24632 * If the component does not have a foreground color set, it inherits the color from its parent component by default. 24633 * 24634 * @param { ResourceColor | ColoringStrategy } value - Foreground color. 24635 * <br>The value can be a specific color or a coloring strategy. Property animations are supported. 24636 * @returns { T } 24637 * @syscap SystemCapability.ArkUI.ArkUI.Full 24638 * @crossplatform 24639 * @atomicservice 24640 * @since arkts {'1.1':'11','1.2':'20'} 24641 * @arkts 1.1&1.2 24642 */ 24643 foregroundColor(value: ResourceColor | ColoringStrategy): T; 24644 24645 /** 24646 * Sets the foreground color of the component. 24647 * If the component does not have a foreground color set, it inherits the color from its parent component by default. 24648 * Compared to {@link foregroundColor}, this API supports the **undefined** type for the **color** parameter. 24649 * 24650 * @param { Optional<ResourceColor | ColoringStrategy> } color -Foreground color. 24651 * <br>The value can be a specific color or a coloring strategy. Property animations are supported. 24652 * <br>If **color** is set to **undefined**, the previous value is retained. 24653 * @returns { T } 24654 * @syscap SystemCapability.ArkUI.ArkUI.Full 24655 * @crossplatform 24656 * @atomicservice 24657 * @since arkts {'1.1':'18','1.2':'20'} 24658 * @arkts 1.1&1.2 24659 */ 24660 foregroundColor(color: Optional<ResourceColor | ColoringStrategy>): T; 24661 24662 /** 24663 * Trigger a click event when a click is clicked. 24664 * 24665 * @param { function } event 24666 * @returns { T } 24667 * @syscap SystemCapability.ArkUI.ArkUI.Full 24668 * @since 7 24669 */ 24670 /** 24671 * Trigger a click event when a click is clicked. 24672 * 24673 * @param { function } event 24674 * @returns { T } 24675 * @syscap SystemCapability.ArkUI.ArkUI.Full 24676 * @form 24677 * @since 9 24678 */ 24679 /** 24680 * Trigger a click event when a click is clicked. 24681 * 24682 * @param { function } event 24683 * @returns { T } 24684 * @syscap SystemCapability.ArkUI.ArkUI.Full 24685 * @crossplatform 24686 * @form 24687 * @since 10 24688 */ 24689 /** 24690 * Called when a click event occurs. 24691 * 24692 * <p><strong>NOTE</strong>: 24693 * <br> Since API version 9, the following constraints apply when this API is used in service widgets: 24694 * <br> Click events cannot be triggered if the finger is pressed for more than 800 ms. 24695 * <br> Click events cannot be triggered if the finger moves more than 20 px after pressing down. 24696 * </p> 24697 * @param { function } event 24698 * @returns { T } 24699 * @syscap SystemCapability.ArkUI.ArkUI.Full 24700 * @crossplatform 24701 * @form 24702 * @atomicservice 24703 * @since arkts {'1.1':'11','1.2':'20'} 24704 * @arkts 1.1&1.2 24705 */ 24706 onClick(event: (event: ClickEvent) => void): T; 24707 24708 /** 24709 * Trigger a click event when a click is clicked, move distance should smaller than distanceThreshold. 24710 * 24711 * <p><strong>NOTE</strong>: 24712 * <br> If the distanceThreshold value specified is less than or equal to 0 vp, it will be converted to the default value. 24713 * <br> Since API version 12, the following constraints apply when this API is used in service widgets: 24714 * <br> Click events cannot be triggered if the finger is pressed for more than 800 ms. 24715 * <br> Click events cannot be triggered if the finger moves more than 20 px after pressing down. 24716 * </p> 24717 * @param { function } event - this function callback executed when the click action is recognized 24718 * @param { number } distanceThreshold - the distance threshold of finger's movement when detecting a click action 24719 * @default (2^31-1)vp 24720 * @returns { T } 24721 * @syscap SystemCapability.ArkUI.ArkUI.Full 24722 * @crossplatform 24723 * @form 24724 * @atomicservice 24725 * @since arkts {'1.1':'12','1.2':'20'} 24726 * @arkts 1.1&1.2 24727 */ 24728 onClick(event: Callback<ClickEvent>, distanceThreshold: number): T; 24729 24730 /** 24731 * Trigger a hover event. 24732 * 24733 * @param { function } event 24734 * @returns { T } 24735 * @syscap SystemCapability.ArkUI.ArkUI.Full 24736 * @since 8 24737 */ 24738 /** 24739 * Trigger a hover event. 24740 * 24741 * @param { function } event 24742 * @returns { T } 24743 * @syscap SystemCapability.ArkUI.ArkUI.Full 24744 * @crossplatform 24745 * @atomicservice 24746 * @since arkts {'1.1':'11','1.2':'20'} 24747 * @arkts 1.1&1.2 24748 */ 24749 onHover(event: (isHover: boolean, event: HoverEvent) => void): T; 24750 24751 /** 24752 * Trigger a hover move event. 24753 * 24754 * @param { Callback<HoverEvent> } event 24755 * @returns { T } 24756 * @syscap SystemCapability.ArkUI.ArkUI.Full 24757 * @crossplatform 24758 * @atomicservice 24759 * @since arkts {'1.1':'15','1.2':'20'} 24760 * @arkts 1.1&1.2 24761 */ 24762 onHoverMove(event: Callback<HoverEvent>): T; 24763 24764 /** 24765 * Trigger a accessibility hover event. 24766 * 24767 * @param { AccessibilityCallback } callback - A callback instance used when the component is touched after accessibility mode is enabled. 24768 * @returns { T } 24769 * @syscap SystemCapability.ArkUI.ArkUI.Full 24770 * @crossplatform 24771 * @atomicservice 24772 * @since arkts {'1.1':'12','1.2':'20'} 24773 * @arkts 1.1&1.2 24774 */ 24775 onAccessibilityHover(callback: AccessibilityCallback): T; 24776 24777 /** 24778 * prompt for current component and descendants unable to handle accessibility hover event 24779 * 24780 * @param { AccessibilityTransparentCallback } callback - A callback instance used when current component and 24781 * descendants not handled accessibility hover event 24782 * @returns { T } 24783 * @syscap SystemCapability.ArkUI.ArkUI.Full 24784 * @crossplatform 24785 * @atomicservice 24786 * @since 20 24787 */ 24788 onAccessibilityHoverTransparent(callback: AccessibilityTransparentCallback): T; 24789 24790 /** 24791 * Set hover effect. 24792 * 24793 * @param { HoverEffect } value 24794 * @returns { T } 24795 * @syscap SystemCapability.ArkUI.ArkUI.Full 24796 * @since 8 24797 */ 24798 /** 24799 * Set hover effect. 24800 * 24801 * @param { HoverEffect } value 24802 * @returns { T } 24803 * @syscap SystemCapability.ArkUI.ArkUI.Full 24804 * @crossplatform 24805 * @since 10 24806 */ 24807 /** 24808 * Set hover effect. 24809 * 24810 * @param { HoverEffect } value - Hover effect of the component in hover state. 24811 * @returns { T } 24812 * @syscap SystemCapability.ArkUI.ArkUI.Full 24813 * @crossplatform 24814 * @atomicservice 24815 * @since arkts {'1.1':'11','1.2':'20'} 24816 * @arkts 1.1&1.2 24817 */ 24818 hoverEffect(value: HoverEffect): T; 24819 24820 /** 24821 * Trigger a mouse event. 24822 * 24823 * @param { function } event 24824 * @returns { T } 24825 * @syscap SystemCapability.ArkUI.ArkUI.Full 24826 * @since 8 24827 */ 24828 /** 24829 * Triggered when the component is clicked by a mouse button or the mouse pointer moves on the component. 24830 * 24831 * @param { function } event 24832 * @returns { T } 24833 * @syscap SystemCapability.ArkUI.ArkUI.Full 24834 * @atomicservice 24835 * @since arkts {'1.1':'11','1.2':'20'} 24836 * @arkts 1.1&1.2 24837 */ 24838 onMouse(event: (event: MouseEvent) => void): T; 24839 24840 /** 24841 * Trigger a touch event when touched. 24842 * 24843 * @param { function } event 24844 * @returns { T } 24845 * @syscap SystemCapability.ArkUI.ArkUI.Full 24846 * @since 7 24847 */ 24848 /** 24849 * Trigger a touch event when touched. 24850 * 24851 * @param { function } event 24852 * @returns { T } 24853 * @syscap SystemCapability.ArkUI.ArkUI.Full 24854 * @crossplatform 24855 * @since 10 24856 */ 24857 /** 24858 * Invoked when a touch event is triggered. 24859 * 24860 * @param { function } event 24861 * @returns { T } 24862 * @syscap SystemCapability.ArkUI.ArkUI.Full 24863 * @crossplatform 24864 * @atomicservice 24865 * @since arkts {'1.1':'11','1.2':'20'} 24866 * @arkts 1.1&1.2 24867 */ 24868 onTouch(event: (event: TouchEvent) => void): T; 24869 24870 /** 24871 * Keyboard input 24872 * 24873 * @param { function } event 24874 * @returns { T } 24875 * @syscap SystemCapability.ArkUI.ArkUI.Full 24876 * @since 7 24877 */ 24878 /** 24879 * Keyboard input 24880 * 24881 * @param { function } event 24882 * @returns { T } 24883 * @syscap SystemCapability.ArkUI.ArkUI.Full 24884 * @crossplatform 24885 * @since 10 24886 */ 24887 /** 24888 * Keyboard input 24889 * 24890 * @param { function } event 24891 * @returns { T } 24892 * @syscap SystemCapability.ArkUI.ArkUI.Full 24893 * @crossplatform 24894 * @atomicservice 24895 * @since arkts {'1.1':'11','1.2':'20'} 24896 * @arkts 1.1&1.2 24897 */ 24898 onKeyEvent(event: (event: KeyEvent) => void): T; 24899 24900 /** 24901 * Keyboard input 24902 * 24903 * @param { Callback<KeyEvent, boolean> } event - Callback for handling the key event. 24904 * @returns { T } 24905 * @syscap SystemCapability.ArkUI.ArkUI.Full 24906 * @crossplatform 24907 * @atomicservice 24908 * @since arkts {'1.1':'15','1.2':'20'} 24909 * @arkts 1.1&1.2 24910 */ 24911 onKeyEvent(event: Callback<KeyEvent, boolean>): T; 24912 24913 /** 24914 * Digital crown input. 24915 * 24916 * @param { Optional<Callback<CrownEvent>> } handler 24917 * @returns { T } 24918 * @syscap SystemCapability.ArkUI.ArkUI.Full 24919 * @atomicservice 24920 * @since arkts {'1.1':'18','1.2':'20'} 24921 * @arkts 1.1&1.2 24922 */ 24923 onDigitalCrown(handler: Optional<Callback<CrownEvent>>): T; 24924 24925 /** 24926 * Handle keyboard events before input method events. 24927 * 24928 * @param { Callback<KeyEvent, boolean> } event - Callback for handling the key event. 24929 * @returns { T } 24930 * @syscap SystemCapability.ArkUI.ArkUI.Full 24931 * @crossplatform 24932 * @atomicservice 24933 * @since arkts {'1.1':'12','1.2':'20'} 24934 * @arkts 1.1&1.2 24935 */ 24936 onKeyPreIme(event: Callback<KeyEvent, boolean>): T; 24937 24938 /** 24939 * Customize the handling and distribution of key events. 24940 * 24941 * @param { Callback<KeyEvent, boolean> } event 24942 * @returns { T } 24943 * @syscap SystemCapability.ArkUI.ArkUI.Full 24944 * @crossplatform 24945 * @atomicservice 24946 * @since arkts {'1.1':'15','1.2':'20'} 24947 * @arkts 1.1&1.2 24948 */ 24949 onKeyEventDispatch(event: Callback<KeyEvent, boolean>): T; 24950 24951 /** 24952 * Trigger a FocusAxisEvent. 24953 * 24954 * @param { Callback<FocusAxisEvent> } event 24955 * @returns { T } 24956 * @syscap SystemCapability.ArkUI.ArkUI.Full 24957 * @atomicservice 24958 * @since arkts {'1.1':'15','1.2':'20'} 24959 * @arkts 1.1&1.2 24960 */ 24961 onFocusAxisEvent(event: Callback<FocusAxisEvent>): T; 24962 24963 /** 24964 * Handle axis events. 24965 * 24966 * @param { Callback<AxisEvent> } event 24967 * @returns { T } 24968 * @syscap SystemCapability.ArkUI.ArkUI.Full 24969 * @atomicservice 24970 * @since arkts {'1.1':'17','1.2':'20'} 24971 * @arkts 1.1&1.2 24972 */ 24973 onAxisEvent(event: Callback<AxisEvent>): T; 24974 24975 /** 24976 * Set focusable. 24977 * 24978 * @param { boolean } value 24979 * @returns { T } 24980 * @syscap SystemCapability.ArkUI.ArkUI.Full 24981 * @since 8 24982 */ 24983 /** 24984 * Set focusable. 24985 * 24986 * @param { boolean } value 24987 * @returns { T } 24988 * @syscap SystemCapability.ArkUI.ArkUI.Full 24989 * @crossplatform 24990 * @since 10 24991 */ 24992 /** 24993 * Set focusable. 24994 * Components that have default interaction logic, such as Button and TextInput, are focusable by default. Other 24995 * components, such as Text and Image, are not focusable by default. Only focusable components can trigger a focus 24996 * event. 24997 * 24998 * @param { boolean } value 24999 * @returns { T } 25000 * @syscap SystemCapability.ArkUI.ArkUI.Full 25001 * @crossplatform 25002 * @atomicservice 25003 * @since arkts {'1.1':'11','1.2':'20'} 25004 * @arkts 1.1&1.2 25005 */ 25006 focusable(value: boolean): T; 25007 25008 /** 25009 * Set nextFocus. 25010 * 25011 * @param { FocusMovement } nextStep 25012 * @returns { T } 25013 * @syscap SystemCapability.ArkUI.ArkUI.Full 25014 * @crossplatform 25015 * @atomicservice 25016 * @since arkts {'1.1':'18','1.2':'20'} 25017 * @arkts 1.1&1.2 25018 */ 25019 nextFocus(nextStep: Optional<FocusMovement>): T; 25020 25021 /** 25022 * Set TabStop on component focus 25023 * 25024 * @param { boolean } isTabStop 25025 * @returns { T } 25026 * @syscap SystemCapability.ArkUI.ArkUI.Full 25027 * @crossplatform 25028 * @atomicservice 25029 * @since arkts {'1.1':'14','1.2':'20'} 25030 * @arkts 1.1&1.2 25031 */ 25032 tabStop(isTabStop: boolean): T; 25033 25034 /** 25035 * Trigger a event when got focus. 25036 * 25037 * @param { function } event 25038 * @returns { T } 25039 * @syscap SystemCapability.ArkUI.ArkUI.Full 25040 * @since 8 25041 */ 25042 /** 25043 * Trigger a event when got focus. 25044 * 25045 * @param { function } event 25046 * @returns { T } 25047 * @syscap SystemCapability.ArkUI.ArkUI.Full 25048 * @crossplatform 25049 * @since 10 25050 */ 25051 /** 25052 * Trigger a event when got focus. 25053 * 25054 * @param { function } event 25055 * @returns { T } 25056 * @syscap SystemCapability.ArkUI.ArkUI.Full 25057 * @crossplatform 25058 * @atomicservice 25059 * @since arkts {'1.1':'11','1.2':'20'} 25060 * @arkts 1.1&1.2 25061 */ 25062 onFocus(event: () => void): T; 25063 25064 /** 25065 * Triggered when the current component loses focus. 25066 * 25067 * @param { function } event 25068 * @returns { T } 25069 * @syscap SystemCapability.ArkUI.ArkUI.Full 25070 * @since 8 25071 */ 25072 /** 25073 * Triggered when the current component loses focus. 25074 * 25075 * @param { function } event 25076 * @returns { T } 25077 * @syscap SystemCapability.ArkUI.ArkUI.Full 25078 * @crossplatform 25079 * @since 10 25080 */ 25081 /** 25082 * Triggered when the current component loses focus. 25083 * 25084 * @param { function } event 25085 * @returns { T } 25086 * @syscap SystemCapability.ArkUI.ArkUI.Full 25087 * @crossplatform 25088 * @atomicservice 25089 * @since arkts {'1.1':'11','1.2':'20'} 25090 * @arkts 1.1&1.2 25091 */ 25092 onBlur(event: () => void): T; 25093 25094 /** 25095 * Set focus index by key tab. 25096 * 25097 * @param { number } index 25098 * @returns { T } 25099 * @syscap SystemCapability.ArkUI.ArkUI.Full 25100 * @since 9 25101 */ 25102 /** 25103 * Set focus index by key tab. 25104 * 25105 * @param { number } index 25106 * @returns { T } 25107 * @syscap SystemCapability.ArkUI.ArkUI.Full 25108 * @crossplatform 25109 * @since 10 25110 */ 25111 /** 25112 * Set focus index by key tab. 25113 * The tabIndex and focusScopeId cannot be used together. 25114 * @param { number } index 25115 * @returns { T } 25116 * @syscap SystemCapability.ArkUI.ArkUI.Full 25117 * @crossplatform 25118 * @atomicservice 25119 * @since arkts {'1.1':'11','1.2':'20'} 25120 * @arkts 1.1&1.2 25121 */ 25122 tabIndex(index: number): T; 25123 25124 /** 25125 * Set default focused component when a page create. 25126 * 25127 * @param { boolean } value 25128 * @returns { T } 25129 * @syscap SystemCapability.ArkUI.ArkUI.Full 25130 * @since 9 25131 */ 25132 /** 25133 * Set default focused component when a page create. 25134 * 25135 * @param { boolean } value 25136 * @returns { T } 25137 * @syscap SystemCapability.ArkUI.ArkUI.Full 25138 * @crossplatform 25139 * @since 10 25140 */ 25141 /** 25142 * Set default focused component when a page create. 25143 * 25144 * @param { boolean } value - True means to set the component as the default focus, and the value false has no effect. 25145 * @returns { T } 25146 * @syscap SystemCapability.ArkUI.ArkUI.Full 25147 * @crossplatform 25148 * @atomicservice 25149 * @since arkts {'1.1':'11','1.2':'20'} 25150 * @arkts 1.1&1.2 25151 */ 25152 defaultFocus(value: boolean): T; 25153 25154 /** 25155 * Set default focused component when focus on a focus group. 25156 * 25157 * @param { boolean } value 25158 * @returns { T } 25159 * @syscap SystemCapability.ArkUI.ArkUI.Full 25160 * @since 9 25161 */ 25162 /** 25163 * Set default focused component when focus on a focus group. 25164 * 25165 * @param { boolean } value 25166 * @returns { T } 25167 * @syscap SystemCapability.ArkUI.ArkUI.Full 25168 * @crossplatform 25169 * @since 10 25170 */ 25171 /** 25172 * Set default focused component when focus on a focus group. 25173 * 25174 * @param { boolean } value - True means the component is the default focus of the parent container, and 25175 * false means the component is not the default focus of the parent container. 25176 * @returns { T } 25177 * @syscap SystemCapability.ArkUI.ArkUI.Full 25178 * @crossplatform 25179 * @atomicservice 25180 * @since arkts {'1.1':'11','1.2':'20'} 25181 * @arkts 1.1&1.2 25182 */ 25183 groupDefaultFocus(value: boolean): T; 25184 25185 /** 25186 * Set a component focused when the component be touched. 25187 * 25188 * @param { boolean } value 25189 * @returns { T } 25190 * @syscap SystemCapability.ArkUI.ArkUI.Full 25191 * @since 9 25192 */ 25193 /** 25194 * Set a component focused when the component be touched. 25195 * 25196 * @param { boolean } value 25197 * @returns { T } 25198 * @syscap SystemCapability.ArkUI.ArkUI.Full 25199 * @crossplatform 25200 * @since 10 25201 */ 25202 /** 25203 * Set a component focused when the component be touched. 25204 * 25205 * @param { boolean } value - True means the component is focusable on touch, false means the component is not focusable on touch. 25206 * @returns { T } 25207 * @syscap SystemCapability.ArkUI.ArkUI.Full 25208 * @crossplatform 25209 * @atomicservice 25210 * @since arkts {'1.1':'11','1.2':'20'} 25211 * @arkts 1.1&1.2 25212 */ 25213 focusOnTouch(value: boolean): T; 25214 25215 /** 25216 * Set the component's focusBox style. 25217 * 25218 * @param { FocusBoxStyle } style - Component's focusBox style. 25219 * @returns { T } 25220 * @syscap SystemCapability.ArkUI.ArkUI.Full 25221 * @crossplatform 25222 * @atomicservice 25223 * @since arkts {'1.1':'12','1.2':'20'} 25224 * @arkts 1.1&1.2 25225 */ 25226 focusBox(style: FocusBoxStyle): T; 25227 25228 /** 25229 * Set container as a focus group with a specific identifier. 25230 * 25231 * @param { string } id - focus scope identifier. 25232 * @param { boolean } [isGroup] - whether this scope is a focus group, the default value is false 25233 * @returns { T } 25234 * @syscap SystemCapability.ArkUI.ArkUI.Full 25235 * @crossplatform 25236 * @atomicservice 25237 * @since arkts {'1.1':'12','1.2':'20'} 25238 * @arkts 1.1&1.2 25239 */ 25240 focusScopeId(id: string, isGroup?: boolean): T; 25241 /** 25242 * Set container as a focus group with a specific identifier. 25243 * 25244 * @param { string } id - focus scope identifier. 25245 * @param { boolean } [isGroup] - whether this scope is a focus group, the default value is false. 25246 * @param { boolean } [arrowStepOut] - whether the arrow keys can move focus from inside the focus group to outside, 25247 * only effective when isGroup is true, the default value is true. 25248 * @returns { T } 25249 * @syscap SystemCapability.ArkUI.ArkUI.Full 25250 * @crossplatform 25251 * @atomicservice 25252 * @since arkts {'1.1':'14','1.2':'20'} 25253 * @arkts 1.1&1.2 25254 */ 25255 focusScopeId(id: string, isGroup?: boolean, arrowStepOut?: boolean): T; 25256 25257 /** 25258 * Set the focus priority of component in a specific focus scope. 25259 * 25260 * @param { string } scopeId 25261 * @param { FocusPriority } [priority] - the default value is AUTO 25262 * @returns { T } 25263 * @syscap SystemCapability.ArkUI.ArkUI.Full 25264 * @crossplatform 25265 * @atomicservice 25266 * @since arkts {'1.1':'12','1.2':'20'} 25267 * @arkts 1.1&1.2 25268 */ 25269 focusScopePriority(scopeId: string, priority?: FocusPriority): T; 25270 25271 /** 25272 * animation 25273 * 25274 * @param { AnimateParam } value 25275 * @returns { T } 25276 * @syscap SystemCapability.ArkUI.ArkUI.Full 25277 * @since 7 25278 */ 25279 /** 25280 * animation 25281 * 25282 * @param { AnimateParam } value 25283 * @returns { T } 25284 * @syscap SystemCapability.ArkUI.ArkUI.Full 25285 * @form 25286 * @since 9 25287 */ 25288 /** 25289 * animation 25290 * 25291 * @param { AnimateParam } value 25292 * @returns { T } 25293 * @syscap SystemCapability.ArkUI.ArkUI.Full 25294 * @crossplatform 25295 * @form 25296 * @since 10 25297 */ 25298 /** 25299 * animation 25300 * 25301 * @param { AnimateParam } value 25302 * @returns { T } 25303 * @syscap SystemCapability.ArkUI.ArkUI.Full 25304 * @crossplatform 25305 * @form 25306 * @atomicservice 25307 * @since arkts {'1.1':'11','1.2':'20'} 25308 * @arkts 1.1&1.2 25309 */ 25310 animation(value: AnimateParam): T; 25311 25312 /** 25313 * Transition effects for when the component is inserted to show and removed to hide 25314 * as well as the callback for the end of the transition animation. 25315 * 25316 * @param { TransitionOptions | TransitionEffect } value - transition options or transition effect 25317 * @returns { T } 25318 * @syscap SystemCapability.ArkUI.ArkUI.Full 25319 * @since 7 25320 */ 25321 /** 25322 * Transition effects for when the component is inserted to show and removed to hide 25323 * as well as the callback for the end of the transition animation. 25324 * 25325 * @param { TransitionOptions | TransitionEffect } value - transition options or transition effect 25326 * @returns { T } 25327 * @syscap SystemCapability.ArkUI.ArkUI.Full 25328 * @form 25329 * @since 9 25330 */ 25331 /** 25332 * Transition effects for when the component is inserted to show and removed to hide 25333 * as well as the callback for the end of the transition animation. 25334 * 25335 * @param { TransitionOptions | TransitionEffect } value - transition options or transition effect 25336 * @returns { T } 25337 * @syscap SystemCapability.ArkUI.ArkUI.Full 25338 * @crossplatform 25339 * @form 25340 * @since 10 25341 */ 25342 /** 25343 * Transition effects for when the component is inserted to show and removed to hide 25344 * as well as the callback for the end of the transition animation. 25345 * 25346 * @param { TransitionOptions | TransitionEffect } value - transition options or transition effect 25347 * @returns { T } 25348 * @syscap SystemCapability.ArkUI.ArkUI.Full 25349 * @crossplatform 25350 * @form 25351 * @atomicservice 25352 * @since 11 25353 */ 25354 transition(value: TransitionOptions | TransitionEffect): T; 25355 25356 /** 25357 * Set the transition effect of component when it appears and disappears. 25358 * 25359 * @param { TransitionEffect } value - transition effect 25360 * @returns { T } 25361 * @syscap SystemCapability.ArkUI.ArkUI.Full 25362 * @crossplatform 25363 * @form 25364 * @atomicservice 25365 * @since 20 25366 * @arkts 1.2 25367 */ 25368 transition(value: TransitionEffect): T; 25369 25370 /** 25371 * Set the transition effect of component when it appears and disappears. 25372 * 25373 * @param { TransitionEffect } effect - transition effect 25374 * @param { Optional<TransitionFinishCallback> } onFinish - transition finish callback. 25375 * @returns { T } 25376 * @syscap SystemCapability.ArkUI.ArkUI.Full 25377 * @crossplatform 25378 * @form 25379 * @atomicservice 25380 * @since arkts {'1.1':'12','1.2':'20'} 25381 * @arkts 1.1&1.2 25382 */ 25383 transition(effect: TransitionEffect, onFinish: Optional<TransitionFinishCallback>): T; 25384 25385 /** 25386 * Bind gesture recognition. 25387 * gesture:Bound Gesture Type,mask:GestureMask; 25388 * 25389 * @param { GestureType } gesture 25390 * @param { GestureMask } mask 25391 * @returns { T } 25392 * @syscap SystemCapability.ArkUI.ArkUI.Full 25393 * @since 7 25394 */ 25395 /** 25396 * Bind gesture recognition. 25397 * gesture:Bound Gesture Type,mask:GestureMask; 25398 * 25399 * @param { GestureType } gesture 25400 * @param { GestureMask } mask 25401 * @returns { T } 25402 * @syscap SystemCapability.ArkUI.ArkUI.Full 25403 * @crossplatform 25404 * @since 10 25405 */ 25406 /** 25407 * Bind gesture recognition. 25408 * gesture:Bound Gesture Type,mask:GestureMask; 25409 * 25410 * @param { GestureType } gesture 25411 * @param { GestureMask } mask 25412 * @returns { T } 25413 * @syscap SystemCapability.ArkUI.ArkUI.Full 25414 * @crossplatform 25415 * @atomicservice 25416 * @since arkts {'1.1':'11','1.2':'20'} 25417 * @arkts 1.1&1.2 25418 */ 25419 gesture(gesture: GestureType, mask?: GestureMask): T; 25420 25421 /** 25422 * Binding Preferential Recognition Gestures 25423 * gesture:Bound Gesture Type,mask:GestureMask; 25424 * 25425 * @param { GestureType } gesture 25426 * @param { GestureMask } mask 25427 * @returns { T } 25428 * @syscap SystemCapability.ArkUI.ArkUI.Full 25429 * @since 7 25430 */ 25431 /** 25432 * Binding Preferential Recognition Gestures 25433 * gesture:Bound Gesture Type,mask:GestureMask; 25434 * 25435 * @param { GestureType } gesture 25436 * @param { GestureMask } mask 25437 * @returns { T } 25438 * @syscap SystemCapability.ArkUI.ArkUI.Full 25439 * @crossplatform 25440 * @since 10 25441 */ 25442 /** 25443 * Binding Preferential Recognition Gestures 25444 * gesture:Bound Gesture Type,mask:GestureMask; 25445 * 25446 * @param { GestureType } gesture 25447 * @param { GestureMask } mask 25448 * @returns { T } 25449 * @syscap SystemCapability.ArkUI.ArkUI.Full 25450 * @crossplatform 25451 * @atomicservice 25452 * @since arkts {'1.1':'11','1.2':'20'} 25453 * @arkts 1.1&1.2 25454 */ 25455 priorityGesture(gesture: GestureType, mask?: GestureMask): T; 25456 25457 /** 25458 * Binding gestures that can be triggered simultaneously with internal component gestures 25459 * gesture:Bound Gesture Type,mask:GestureMask; 25460 * 25461 * @param { GestureType } gesture 25462 * @param { GestureMask } mask 25463 * @returns { T } 25464 * @syscap SystemCapability.ArkUI.ArkUI.Full 25465 * @since 7 25466 */ 25467 /** 25468 * Binding gestures that can be triggered simultaneously with internal component gestures 25469 * gesture:Bound Gesture Type,mask:GestureMask; 25470 * 25471 * @param { GestureType } gesture 25472 * @param { GestureMask } mask 25473 * @returns { T } 25474 * @syscap SystemCapability.ArkUI.ArkUI.Full 25475 * @crossplatform 25476 * @since 10 25477 */ 25478 /** 25479 * Binding gestures that can be triggered simultaneously with internal component gestures 25480 * gesture:Bound Gesture Type,mask:GestureMask; 25481 * 25482 * @param { GestureType } gesture 25483 * @param { GestureMask } mask 25484 * @returns { T } 25485 * @syscap SystemCapability.ArkUI.ArkUI.Full 25486 * @crossplatform 25487 * @atomicservice 25488 * @since arkts {'1.1':'11','1.2':'20'} 25489 * @arkts 1.1&1.2 25490 */ 25491 parallelGesture(gesture: GestureType, mask?: GestureMask): T; 25492 25493 /** 25494 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 25495 * The larger the blurring radius, the more blurring the content. 25496 * If the value is 0, the content blurring effect is not blurring. 25497 * 25498 * @param { number } value 25499 * @returns { T } 25500 * @syscap SystemCapability.ArkUI.ArkUI.Full 25501 * @since 7 25502 */ 25503 /** 25504 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 25505 * The larger the blurring radius, the more blurring the content. 25506 * If the value is 0, the content blurring effect is not blurring. 25507 * 25508 * @param { number } value - value indicates radius of backdrop blur. 25509 * @returns { T } 25510 * @syscap SystemCapability.ArkUI.ArkUI.Full 25511 * @form 25512 * @since 9 25513 */ 25514 /** 25515 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 25516 * The larger the blurring radius, the more blurring the content. 25517 * If the value is 0, the content blurring effect is not blurring. 25518 * 25519 * @param { number } value - value indicates radius of backdrop blur. 25520 * @returns { T } 25521 * @syscap SystemCapability.ArkUI.ArkUI.Full 25522 * @crossplatform 25523 * @form 25524 * @since 10 25525 */ 25526 /** 25527 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 25528 * The larger the blurring radius, the more blurring the content. 25529 * If the value is 0, the content blurring effect is not blurring. 25530 * 25531 * @param { number } value - value indicates radius of backdrop blur. 25532 * @param { BlurOptions } [options] - options indicates blur options. 25533 * @returns { T } 25534 * @syscap SystemCapability.ArkUI.ArkUI.Full 25535 * @crossplatform 25536 * @form 25537 * @atomicservice 25538 * @since arkts {'1.1':'11','1.2':'20'} 25539 * @arkts 1.1&1.2 25540 */ 25541 blur(value: number, options?: BlurOptions): T; 25542 25543 /** 25544 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 25545 * The larger the blurring radius, the more blurring the content. 25546 * If the value is 0, the content blurring effect is not blurring. 25547 * 25548 * @param { Optional<number> } blurRadius - value indicates radius of backdrop blur. 25549 * @param { BlurOptions } [options] - options indicates blur options. 25550 * @returns { T } 25551 * @syscap SystemCapability.ArkUI.ArkUI.Full 25552 * @crossplatform 25553 * @form 25554 * @atomicservice 25555 * @since 18 25556 */ 25557 blur(blurRadius: Optional<number>, options?: BlurOptions): T; 25558 25559 /** 25560 * Adds the content blurring effect for the current component. The input parameter is the blurring radius. 25561 * The larger the blurring radius, the more blurring the content. 25562 * If the value is 0, the content blurring effect is not blurring. 25563 * 25564 * @param { Optional<number> } blurRadius - value indicates radius of backdrop blur. 25565 * @param { BlurOptions } [options] - options indicates blur options. 25566 * @param { SystemAdaptiveOptions } [sysOptions] - system adaptive options. 25567 * @returns { T } 25568 * @syscap SystemCapability.ArkUI.ArkUI.Full 25569 * @crossplatform 25570 * @form 25571 * @atomicservice 25572 * @since arkts {'1.1':'19','1.2':'20'} 25573 * @arkts 1.1&1.2 25574 */ 25575 blur(blurRadius: Optional<number>, options?: BlurOptions, sysOptions?: SystemAdaptiveOptions): T; 25576 25577 /** 25578 * Applies a linear gradient foreground blur effect to the component. 25579 * 25580 * @param { number } value - the blurring radius. 25581 * The larger the blurring radius, the more blurring the content, and if the value is 0, the content blurring effect is not blurring. 25582 * @param { LinearGradientBlurOptions } options - the linear gradient blur options. 25583 * @returns { T } 25584 * @syscap SystemCapability.ArkUI.ArkUI.Full 25585 * @atomicservice 25586 * @since arkts {'1.1':'12','1.2':'20'} 25587 * @arkts 1.1&1.2 25588 */ 25589 linearGradientBlur(value: number, options: LinearGradientBlurOptions): T; 25590 25591 /** 25592 * Applies a linear gradient foreground blur effect to the component. 25593 * 25594 * @param { Optional<number> } blurRadius - the blurring radius. 25595 * The larger the blurring radius, the more blurring the content, and if the value is 0, the content blurring effect is not blurring. 25596 * @param { Optional<LinearGradientBlurOptions> } options - the linear gradient blur options. 25597 * @returns { T } 25598 * @syscap SystemCapability.ArkUI.ArkUI.Full 25599 * @atomicservice 25600 * @since arkts {'1.1':'18','1.2':'20'} 25601 * @arkts 1.1&1.2 25602 */ 25603 linearGradientBlur(blurRadius: Optional<number>, options: Optional<LinearGradientBlurOptions>): T; 25604 25605 /** 25606 * Apply a motion blur effect to the component being scaled or moved. 25607 * 1.Do not use this API in intra-component transitions, shared element transitions, 25608 * implicit element transitions, or particle animations. Doing so may cause unexpected results. 25609 * 2.The **radius** parameter of **motionBlur** must be set to **0** for the initial state. 25610 * Otherwise, there may be unexpected results during a cold start. 25611 * 3.This API must be used together with the **onFinish** parameter of **AnimateParam**. 25612 * Its **radius** parameter must be set to **0** when the animation ends; otherwise, there may be unexpected results. 25613 * 4.When using this API, do not frequently change the blur radius of the same component; 25614 * otherwise, there may be unexpected results. 25615 * For example, if you frequently click the image in the example, the blur effect may not work sometimes. 25616 * 5.To avoid unexpected results, make sure the coordinates of 25617 * the motion blur anchor point are the same as those of the animation scaling anchor point. 25618 * 6.To avoid unexpected results, set the blur radius to a value less than 1. 25619 * 25620 * @param { MotionBlurOptions } value - Motion blur options. 25621 * @returns { T } 25622 * @syscap SystemCapability.ArkUI.ArkUI.Full 25623 * @crossplatform 25624 * @atomicservice 25625 * @since arkts {'1.1':'12','1.2':'20'} 25626 * @arkts 1.1&1.2 25627 */ 25628 motionBlur(value: MotionBlurOptions):T; 25629 25630 /** 25631 * Component motion blur interface. 25632 * 25633 * @param { Optional<MotionBlurOptions> } motionBlur - the attributes of motion blur. 25634 * @returns { T } 25635 * @syscap SystemCapability.ArkUI.ArkUI.Full 25636 * @crossplatform 25637 * @atomicservice 25638 * @since arkts {'1.1':'18','1.2':'20'} 25639 * @arkts 1.1&1.2 25640 */ 25641 motionBlur(motionBlur: Optional<MotionBlurOptions>):T; 25642 25643 /** 25644 * Applies a brightness effect to the component. 25645 * 25646 * @param { number } value - Brightness of the component. The value **1** indicates no effects. 25647 * The value **0** indicates the complete darkness. If the value is less than **1**, the brightness 25648 * decreases. If the value is greater than **1**, the brightness increases. A larger value indicates 25649 * a higher brightness. A brightness of 2 turns the component completely white. 25650 * <br>Default value: **1.0**<br>Recommended value range: [0, 2]. 25651 * <br>**NOTE** 25652 * <br>A value less than 0 evaluates to the value **0**. 25653 * <br>**Widget capability**: This API can be used in ArkTS widgets since API version 9. 25654 * @returns { T } 25655 * @syscap SystemCapability.ArkUI.ArkUI.Full 25656 * @since 7 25657 */ 25658 /** 25659 * Applies a brightness effect to the component. 25660 * 25661 * @param { number } value - Brightness of the component. The value **1** indicates no effects. 25662 * The value **0** indicates the complete darkness. If the value is less than **1**, the brightness 25663 * decreases. If the value is greater than **1**, the brightness increases. A larger value indicates 25664 * a higher brightness. A brightness of 2 turns the component completely white. 25665 * <br>Default value: **1.0**<br>Recommended value range: [0, 2]. 25666 * <br>**NOTE** 25667 * <br>A value less than 0 evaluates to the value **0**. 25668 * <br>**Widget capability**: This API can be used in ArkTS widgets since API version 9. 25669 * @returns { T } 25670 * @syscap SystemCapability.ArkUI.ArkUI.Full 25671 * @form 25672 * @since 9 25673 */ 25674 /** 25675 * Applies a brightness effect to the component. 25676 * 25677 * @param { number } value - Brightness of the component. The value **1** indicates no effects. 25678 * The value **0** indicates the complete darkness. If the value is less than **1**, the brightness 25679 * decreases. If the value is greater than **1**, the brightness increases. A larger value indicates 25680 * a higher brightness. A brightness of 2 turns the component completely white. 25681 * <br>Default value: **1.0**<br>Recommended value range: [0, 2]. 25682 * <br>**NOTE** 25683 * <br>A value less than 0 evaluates to the value **0**. 25684 * <br>**Widget capability**: This API can be used in ArkTS widgets since API version 9. 25685 * @returns { T } 25686 * @syscap SystemCapability.ArkUI.ArkUI.Full 25687 * @crossplatform 25688 * @form 25689 * @since 10 25690 */ 25691 /** 25692 * Applies a brightness effect to the component. 25693 * 25694 * @param { number } value - Brightness of the component. The value **1** indicates no effects. 25695 * The value **0** indicates the complete darkness. If the value is less than **1**, the brightness 25696 * decreases. If the value is greater than **1**, the brightness increases. A larger value indicates 25697 * a higher brightness. A brightness of 2 turns the component completely white. 25698 * <br>Default value: **1.0**<br>Recommended value range: [0, 2]. 25699 * <br>**NOTE** 25700 * <br>A value less than 0 evaluates to the value **0**. 25701 * <br>**Widget capability**: This API can be used in ArkTS widgets since API version 9. 25702 * @returns { T } 25703 * @syscap SystemCapability.ArkUI.ArkUI.Full 25704 * @crossplatform 25705 * @form 25706 * @atomicservice 25707 * @since arkts {'1.1':'11','1.2':'20'} 25708 * @arkts 1.1&1.2 25709 */ 25710 brightness(value: number): T; 25711 25712 /** 25713 * Applies a brightness effect to the component. Compared to brightness, this 25714 * API supports the **undefined** type for the **brightness** parameter. 25715 * 25716 * @param { Optional<number> } brightness - Brightness of the component. The value **1** indicates 25717 * no effects. The value **0** indicates the complete darkness. If the value is less than **1**, 25718 * the brightness decreases. If the value is greater than **1**, the brightness increases. A larger 25719 * value indicates a higher brightness. A brightness of 2 turns the component completely white. 25720 * <br>Default value: **1.0**. 25721 * <br>Recommended value range: [0, 2]. 25722 * <br>**NOTE** 25723 * <br>A value less than 0 evaluates to the value **0**. 25724 * <br>**Widget capability**: This API can be used in ArkTS widgets since API version 16. 25725 * <br>If **brightness** is **undefined**, the brightness level is reset to **0**. 25726 * @returns { T } 25727 * @syscap SystemCapability.ArkUI.ArkUI.Full 25728 * @crossplatform 25729 * @form 25730 * @atomicservice 25731 * @since arkts {'1.1':'18','1.2':'20'} 25732 * @arkts 1.1&1.2 25733 */ 25734 brightness(brightness: Optional<number>): T; 25735 25736 /** 25737 * Applies a contrast effect to the component. 25738 * 25739 * @param { number } value - Contrast of the component. The input parameter is a 25740 * contrast value. If the value is **1**, the source image is displayed. If the 25741 * value is greater than 1, a larger value indicates a higher contrast and a clearer 25742 * image. If the value is less than 1, a smaller value indicates a lower contrast is. 25743 * If the value is **0**, the image becomes all gray. The unit is percentage. 25744 * <br>Default value: **1.0**. 25745 * <br>Recommended value range: [0, 10). 25746 * <br>**NOTE** 25747 * <br>A value less than 0 evaluates to the value **0**. 25748 * @returns { T } 25749 * @syscap SystemCapability.ArkUI.ArkUI.Full 25750 * @since 7 25751 */ 25752 /** 25753 * Applies a contrast effect to the component. 25754 * 25755 * @param { number } value - Contrast of the component. The input parameter is a 25756 * contrast value. If the value is **1**, the source image is displayed. If the 25757 * value is greater than 1, a larger value indicates a higher contrast and a clearer 25758 * image. If the value is less than 1, a smaller value indicates a lower contrast is. 25759 * If the value is **0**, the image becomes all gray. The unit is percentage. 25760 * <br>Default value: **1.0**. 25761 * <br>Recommended value range: [0, 10). 25762 * <br>**NOTE** 25763 * <br>A value less than 0 evaluates to the value **0**. 25764 * @returns { T } 25765 * @syscap SystemCapability.ArkUI.ArkUI.Full 25766 * @form 25767 * @since 9 25768 */ 25769 /** 25770 * Applies a contrast effect to the component. 25771 * 25772 * @param { number } value - Contrast of the component. The input parameter is a 25773 * contrast value. If the value is **1**, the source image is displayed. If the 25774 * value is greater than 1, a larger value indicates a higher contrast and a clearer 25775 * image. If the value is less than 1, a smaller value indicates a lower contrast is. 25776 * If the value is **0**, the image becomes all gray. The unit is percentage. 25777 * <br>Default value: **1.0**. 25778 * <br>Recommended value range: [0, 10). 25779 * <br>**NOTE** 25780 * <br>A value less than 0 evaluates to the value **0**. 25781 * @returns { T } 25782 * @syscap SystemCapability.ArkUI.ArkUI.Full 25783 * @crossplatform 25784 * @form 25785 * @since 10 25786 */ 25787 /** 25788 * Applies a contrast effect to the component. 25789 * 25790 * @param { number } value - Contrast of the component. The input parameter is a 25791 * contrast value. If the value is **1**, the source image is displayed. If the 25792 * value is greater than 1, a larger value indicates a higher contrast and a clearer 25793 * image. If the value is less than 1, a smaller value indicates a lower contrast is. 25794 * If the value is **0**, the image becomes all gray. The unit is percentage. 25795 * <br>Default value: **1.0**. 25796 * <br>Recommended value range: [0, 10). 25797 * <br>**NOTE** 25798 * <br>A value less than 0 evaluates to the value **0**. 25799 * @returns { T } 25800 * @syscap SystemCapability.ArkUI.ArkUI.Full 25801 * @crossplatform 25802 * @form 25803 * @atomicservice 25804 * @since arkts {'1.1':'11','1.2':'20'} 25805 * @arkts 1.1&1.2 25806 */ 25807 contrast(value: number): T; 25808 25809 /** 25810 * Applies a contrast effect to the component. Compared to contrast, 25811 * this API supports the **undefined** type for the **contrast** parameter. 25812 * 25813 * @param { Optional<number> } contrast - Contrast of the component. The input parameter 25814 * is a contrast value. If the value is **1**, the source image is displayed. If the value 25815 * is greater than 1, a larger value indicates a higher contrast and a clearer image. If the 25816 * value is less than 1, a smaller value indicates a lower contrast is. If the value is **0**, 25817 * the image becomes all gray. The unit is percentage. 25818 * <br>Default value: **1.0**. 25819 * <br>Recommended value range: [0, 10). 25820 * <br>**NOTE** 25821 * <br>A value less than 0 evaluates to the value **0**. 25822 * <br>If **contrast** is **undefined**, the contrast effect is reset to **1.0**. 25823 * @returns { T } 25824 * @syscap SystemCapability.ArkUI.ArkUI.Full 25825 * @crossplatform 25826 * @form 25827 * @atomicservice 25828 * @since arkts {'1.1':'18','1.2':'20'} 25829 * @arkts 1.1&1.2 25830 */ 25831 contrast(contrast: Optional<number>): T; 25832 25833 /** 25834 * Applies a grayscale effect to the component. 25835 * 25836 * @param { number } value - Grayscale conversion ratio of the component. 25837 * <br>If the value is **1.0**, the component is completely converted to grayscale. 25838 * <br>If the value is **0.0**, the component remains unchanged. Between **0** and **1**, 25839 * the value applies a linear multiplier on the grayscale effect. The unit is percentage. 25840 * <br>Default value: **0.0**. 25841 * <br>Value range: [0.0, 1.0]. 25842 * <p>**NOTE**: 25843 * <br>A value less than **0.0** evaluates to the value **0.0**. 25844 * <br>A value greater than **1.0** evaluates to the value **1.0**. 25845 * </p> 25846 * @returns { T } 25847 * @syscap SystemCapability.ArkUI.ArkUI.Full 25848 * @since 7 25849 */ 25850 /** 25851 * Applies a grayscale effect to the component. 25852 * 25853 * @param { number } value - Grayscale conversion ratio of the component. 25854 * <br>If the value is **1.0**, the component is completely converted to grayscale. 25855 * <br>If the value is **0.0**, the component remains unchanged. Between **0** and **1**, 25856 * the value applies a linear multiplier on the grayscale effect. The unit is percentage. 25857 * <br>Default value: **0.0**. 25858 * <br>Value range: [0.0, 1.0]. 25859 * <p>**NOTE**: 25860 * <br>A value less than **0.0** evaluates to the value **0.0**. 25861 * <br>A value greater than **1.0** evaluates to the value **1.0**. 25862 * </p> 25863 * @returns { T } 25864 * @syscap SystemCapability.ArkUI.ArkUI.Full 25865 * @form 25866 * @since 9 25867 */ 25868 /** 25869 * Applies a grayscale effect to the component. 25870 * 25871 * @param { number } value - Grayscale conversion ratio of the component. 25872 * <br>If the value is **1.0**, the component is completely converted to grayscale. 25873 * <br>If the value is **0.0**, the component remains unchanged. Between **0** and **1**, 25874 * the value applies a linear multiplier on the grayscale effect. The unit is percentage. 25875 * <br>Default value: **0.0**. 25876 * <br>Value range: [0.0, 1.0]. 25877 * <p>**NOTE**: 25878 * <br>A value less than **0.0** evaluates to the value **0.0**. 25879 * <br>A value greater than **1.0** evaluates to the value **1.0**. 25880 * </p> 25881 * @returns { T } 25882 * @syscap SystemCapability.ArkUI.ArkUI.Full 25883 * @crossplatform 25884 * @form 25885 * @since 10 25886 */ 25887 /** 25888 * Applies a grayscale effect to the component. 25889 * 25890 * @param { number } value - Grayscale conversion ratio of the component. 25891 * <br>If the value is **1.0**, the component is completely converted to grayscale. 25892 * <br>If the value is **0.0**, the component remains unchanged. Between **0** and **1**, 25893 * <br>the value applies a linear multiplier on the grayscale effect. The unit is percentage. 25894 * <br>Default value: **0.0**. 25895 * <br>Value range: [0.0, 1.0]. 25896 * <p>**NOTE**: 25897 * <br>A value less than **0.0** evaluates to the value **0.0**. 25898 * <br>A value greater than **1.0** evaluates to the value **1.0**. 25899 * </p> 25900 * @returns { T } 25901 * @syscap SystemCapability.ArkUI.ArkUI.Full 25902 * @crossplatform 25903 * @form 25904 * @atomicservice 25905 * @since arkts {'1.1':'11','1.2':'20'} 25906 * @arkts 1.1&1.2 25907 */ 25908 grayscale(value: number): T; 25909 25910 /** 25911 * Applies a grayscale effect to the component. 25912 * Compared to grayscale, this API supports the **undefined** type for the **grayscale** parameter. 25913 * 25914 * @param { Optional<number> } grayscale - Grayscale conversion ratio of the component. 25915 * <br>If the value is **1.0**, the component is completely converted to grayscale. 25916 * <br>If the value is **0.0**, the component remains unchanged. Between **0** and **1**, 25917 * <br>the value applies a linear multiplier on the grayscale effect. The unit is percentage. 25918 * <br>Default value: **0.0**. 25919 * <br>Value range: [0.0, 1.0]. 25920 * <p>**NOTE** 25921 * <br>A value less than **0.0** evaluates to the value **0.0**. 25922 * <br>A value greater than **1.0** evaluates to the value **1.0**. 25923 * </p> 25924 * @returns { T } 25925 * @syscap SystemCapability.ArkUI.ArkUI.Full 25926 * @crossplatform 25927 * @form 25928 * @atomicservice 25929 * @since arkts {'1.1':'18','1.2':'20'} 25930 * @arkts 1.1&1.2 25931 */ 25932 grayscale(grayscale: Optional<number>): T; 25933 25934 /** 25935 * Applies a color blend effect to the component. 25936 * 25937 * @param { Color | string | Resource } value - Color to blend with the component. 25938 * @returns { T } 25939 * @syscap SystemCapability.ArkUI.ArkUI.Full 25940 * @since 7 25941 */ 25942 /** 25943 * Applies a color blend effect to the component. 25944 * 25945 * @param { Color | string | Resource } value - Color to blend with the component. 25946 * @returns { T } 25947 * @syscap SystemCapability.ArkUI.ArkUI.Full 25948 * @form 25949 * @since 9 25950 */ 25951 /** 25952 * Applies a color blend effect to the component. 25953 * 25954 * @param { Color | string | Resource } value - Color to blend with the component. 25955 * @returns { T } 25956 * @syscap SystemCapability.ArkUI.ArkUI.Full 25957 * @crossplatform 25958 * @form 25959 * @since 10 25960 */ 25961 /** 25962 * Applies a color blend effect to the component. 25963 * 25964 * @param { Color | string | Resource } value - Color to blend with the component. 25965 * @returns { T } 25966 * @syscap SystemCapability.ArkUI.ArkUI.Full 25967 * @crossplatform 25968 * @form 25969 * @atomicservice 25970 * @since arkts {'1.1':'11','1.2':'20'} 25971 * @arkts 1.1&1.2 25972 */ 25973 colorBlend(value: Color | string | Resource): T; 25974 25975 /** 25976 * Applies a color blend effect to the component. 25977 * Compared to {@link colorBlend}, this API supports the **undefined** type for the **color** parameter. 25978 * 25979 * @param { Optional<Color | string | Resource> } color - Color to blend with the component. 25980 * <br>If **color** is **undefined**, the component reverts to its original effect with no color blending. 25981 * @returns { T } 25982 * @syscap SystemCapability.ArkUI.ArkUI.Full 25983 * @crossplatform 25984 * @form 25985 * @atomicservice 25986 * @since arkts {'1.1':'18','1.2':'20'} 25987 * @arkts 1.1&1.2 25988 */ 25989 colorBlend(color: Optional<Color | string | Resource>): T; 25990 25991 /** 25992 * Applies a saturation effect to the component. 25993 * 25994 * @param { number } value - Saturation of the component. The saturation is the ratio of the 25995 * chromatic component to the achromatic component (gray) in a color. If the value is **1**, 25996 * the original image is displayed. If the value is greater than **1**, a higher percentage of 25997 * the chromatic component indicates a higher saturation. If the value is less than **1**, a higher 25998 * percentage of the achromatic component indicates a lower saturation. The unit is percentage. 25999 * <br>Default value: **1.0**. 26000 * <br>Recommended value range: [0, 50). 26001 * <br>**NOTE** 26002 * <br>A value less than 0 evaluates to the value **0**. 26003 * @returns { T } 26004 * @syscap SystemCapability.ArkUI.ArkUI.Full 26005 * @since 7 26006 */ 26007 /** 26008 * Applies a saturation effect to the component. 26009 * 26010 * @param { number } value - Saturation of the component. The saturation is the ratio of the 26011 * chromatic component to the achromatic component (gray) in a color. If the value is **1**, 26012 * the original image is displayed. If the value is greater than **1**, a higher percentage of 26013 * the chromatic component indicates a higher saturation. If the value is less than **1**, a higher 26014 * percentage of the achromatic component indicates a lower saturation. The unit is percentage. 26015 * <br>Default value: **1.0**. 26016 * <br>Recommended value range: [0, 50). 26017 * <br>**NOTE** 26018 * <br>A value less than 0 evaluates to the value **0**. 26019 * @returns { T } 26020 * @syscap SystemCapability.ArkUI.ArkUI.Full 26021 * @form 26022 * @since 9 26023 */ 26024 /** 26025 * Applies a saturation effect to the component. 26026 * 26027 * @param { number } value - Saturation of the component. The saturation is the ratio of the 26028 * chromatic component to the achromatic component (gray) in a color. If the value is **1**, 26029 * the original image is displayed. If the value is greater than **1**, a higher percentage of 26030 * the chromatic component indicates a higher saturation. If the value is less than **1**, a higher 26031 * percentage of the achromatic component indicates a lower saturation. The unit is percentage. 26032 * <br>Default value: **1.0**. 26033 * <br>Recommended value range: [0, 50). 26034 * <br>**NOTE** 26035 * <br>A value less than 0 evaluates to the value **0**. 26036 * @returns { T } 26037 * @syscap SystemCapability.ArkUI.ArkUI.Full 26038 * @crossplatform 26039 * @form 26040 * @since 10 26041 */ 26042 /** 26043 * Applies a saturation effect to the component. 26044 * 26045 * @param { number } value - Saturation of the component. The saturation is the ratio of the 26046 * chromatic component to the achromatic component (gray) in a color. If the value is **1**, 26047 * the original image is displayed. If the value is greater than **1**, a higher percentage of 26048 * the chromatic component indicates a higher saturation. If the value is less than **1**, a higher 26049 * percentage of the achromatic component indicates a lower saturation. The unit is percentage. 26050 * <br>Default value: **1.0**. 26051 * <br>Recommended value range: [0, 50). 26052 * <br>**NOTE** 26053 * <br>A value less than 0 evaluates to the value **0**. 26054 * @returns { T } 26055 * @syscap SystemCapability.ArkUI.ArkUI.Full 26056 * @crossplatform 26057 * @form 26058 * @atomicservice 26059 * @since arkts {'1.1':'11','1.2':'20'} 26060 * @arkts 1.1&1.2 26061 */ 26062 saturate(value: number): T; 26063 26064 /** 26065 * Applies a saturation effect to the component. Compared to saturate, this API supports 26066 * the **undefined** type for the **saturate** parameter. 26067 * 26068 * @param { Optional<number> } saturate - Saturation of the component. The saturation is the ratio of 26069 * the chromatic component to the achromatic component (gray) in a color. If the value is **1**, the 26070 * original image is displayed. If the value is greater than **1**, a higher percentage of the chromatic 26071 * component indicates a higher saturation. If the value is less than **1**, a higher percentage of the 26072 * achromatic component indicates a lower saturation. The unit is percentage. 26073 * <br>Default value: **1.0**. 26074 * <br>Recommended value range: [0, 50). 26075 * <br>**NOTE** 26076 * <br>A value less than 0 evaluates to the value **0**. 26077 * <br>If **saturate** is **undefined**, the saturation effect is reset to **1.0**. 26078 * @returns { T } 26079 * @syscap SystemCapability.ArkUI.ArkUI.Full 26080 * @crossplatform 26081 * @form 26082 * @atomicservice 26083 * @since arkts {'1.1':'18','1.2':'20'} 26084 * @arkts 1.1&1.2 26085 */ 26086 saturate(saturate: Optional<number>): T; 26087 26088 /** 26089 * Sepia conversion ratio of the component. 26090 * 26091 * @param { number } value - Sepia conversion ratio of the component. If the value is **1**, the image 26092 * is completely sepia. If the value is **0**, the component remains unchanged. The unit is percentage. 26093 * <br> Value range: [0, +∞). 26094 * @returns { T } 26095 * @syscap SystemCapability.ArkUI.ArkUI.Full 26096 * @since 7 26097 */ 26098 /** 26099 * Sepia conversion ratio of the component. 26100 * 26101 * @param { number } value - Sepia conversion ratio of the component. If the value is **1**, the image 26102 * is completely sepia. If the value is **0**, the component remains unchanged. The unit is percentage. 26103 * <br> Value range: [0, +∞). 26104 * @returns { T } 26105 * @syscap SystemCapability.ArkUI.ArkUI.Full 26106 * @form 26107 * @since 9 26108 */ 26109 /** 26110 * Sepia conversion ratio of the component. 26111 * 26112 * @param { number } value - Sepia conversion ratio of the component. If the value is **1**, the image 26113 * is completely sepia. If the value is **0**, the component remains unchanged. The unit is percentage. 26114 * <br> Value range: [0, +∞). 26115 * @returns { T } 26116 * @syscap SystemCapability.ArkUI.ArkUI.Full 26117 * @crossplatform 26118 * @form 26119 * @since 10 26120 */ 26121 /** 26122 * Sepia conversion ratio of the component. 26123 * 26124 * @param { number } value - Sepia conversion ratio of the component. If the value is **1**, the image 26125 * is completely sepia. If the value is **0**, the component remains unchanged. The unit is percentage. 26126 * <br> Value range: [0, +∞). 26127 * @returns { T } 26128 * @syscap SystemCapability.ArkUI.ArkUI.Full 26129 * @crossplatform 26130 * @form 26131 * @atomicservice 26132 * @since arkts {'1.1':'11','1.2':'20'} 26133 * @arkts 1.1&1.2 26134 */ 26135 sepia(value: number): T; 26136 26137 /** 26138 * Sepia conversion ratio of the component. Compared to sepia, 26139 * this API supports the **undefined** type for the **sepia** parameter. 26140 * 26141 * @param { Optional<number> } sepia - Sepia conversion ratio of the component. If the value is **1**, the 26142 * image is completely sepia. If the value is **0**, the component remains unchanged. The unit is percentage. 26143 * <br>If **sepia** is **undefined**, the component reverts to its original effect. 26144 * <br> Value range: [0, +∞). 26145 * @returns { T } 26146 * @syscap SystemCapability.ArkUI.ArkUI.Full 26147 * @crossplatform 26148 * @form 26149 * @atomicservice 26150 * @since arkts {'1.1':'18','1.2':'20'} 26151 * @arkts 1.1&1.2 26152 */ 26153 sepia(sepia: Optional<number>): T; 26154 26155 /** 26156 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 26157 * A value of 0% does not change the image. (Percentage) 26158 * 26159 * @param { number } value 26160 * @returns { T } 26161 * @syscap SystemCapability.ArkUI.ArkUI.Full 26162 * @since 7 26163 */ 26164 /** 26165 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 26166 * A value of 0% does not change the image. (Percentage) 26167 * 26168 * @param { number } value 26169 * @returns { T } 26170 * @syscap SystemCapability.ArkUI.ArkUI.Full 26171 * @form 26172 * @since 9 26173 */ 26174 /** 26175 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 26176 * A value of 0% does not change the image. (Percentage) 26177 * 26178 * @param { number } value 26179 * @returns { T } 26180 * @syscap SystemCapability.ArkUI.ArkUI.Full 26181 * @crossplatform 26182 * @form 26183 * @since 10 26184 */ 26185 /** 26186 * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. 26187 * A value of 0% does not change the image. (Percentage) 26188 * 26189 * @param { number | InvertOptions } value - value indicates the scale of the conversion or the options of invert. 26190 * @returns { T } 26191 * @syscap SystemCapability.ArkUI.ArkUI.Full 26192 * @crossplatform 26193 * @form 26194 * @atomicservice 26195 * @since arkts {'1.1':'11','1.2':'20'} 26196 * @arkts 1.1&1.2 26197 */ 26198 invert(value: number | InvertOptions): T; 26199 26200 /** 26201 * Inverts the image. Compared to invert, 26202 * this API supports the **undefined** type for the **options** parameter. 26203 * 26204 * @param { Optional<number | InvertOptions> } options - How the image is inverted. 26205 * <br>If the value is of the number type, 26206 * <br>it indicates the inversion ratio. If the value is **1**, 26207 * <br>the image is completely inverted. If the value is **0**, the image remains unchanged. 26208 * <br>The unit is percentage.<br>Value range: [0, 1]<br>A value less than 0 evaluates to the value **0**. 26209 * <br>If the value is of the InvertOptions type, the grayscale value of the background color is compared 26210 * <br>with the threshold range. If the grayscale value is greater than the upper bound of the threshold range, 26211 * <br>the **high** value is used. If the grayscale value is less than the lower bound of the threshold range, 26212 * <br>the **low** value is used. If the grayscale value is within the threshold range, 26213 * <br>the background color changes linearly from high to low.<br>If **options** is **undefined**, 26214 * <br>the component reverts to its original effect. 26215 * @returns { T } 26216 * @syscap SystemCapability.ArkUI.ArkUI.Full 26217 * @crossplatform 26218 * @form 26219 * @atomicservice 26220 * @since arkts {'1.1':'18','1.2':'20'} 26221 * @arkts 1.1&1.2 26222 */ 26223 invert(options: Optional<number | InvertOptions>): T; 26224 26225 /** 26226 * Applies a system bar effect to the component, which means to invert colors based on the background and add a blur. 26227 * 26228 * @returns { T } return the component attribute. 26229 * @syscap SystemCapability.ArkUI.ArkUI.Full 26230 * @atomicservice 26231 * @since arkts {'1.1':'12','1.2':'20'} 26232 * @arkts 1.1&1.2 26233 */ 26234 systemBarEffect(): T; 26235 26236 /** 26237 * Rotates the hue of the component. 26238 * 26239 * @param { number | string } value - Hue rotation angle of the component. 26240 * <br>A rotation of 360 degrees leaves the color unchanged. 26241 * <br>A rotation of 180 degrees and then -180 degrees also leaves the color unchanged. 26242 * <br>When the data type is number, the value **90** is equivalent to **'90deg'**. 26243 * @returns { T } 26244 * @syscap SystemCapability.ArkUI.ArkUI.Full 26245 * @since 7 26246 */ 26247 /** 26248 * Rotates the hue of the component. 26249 * 26250 * @param { number | string } value - Hue rotation angle of the component. 26251 * <br>A rotation of 360 degrees leaves the color unchanged. 26252 * <br>A rotation of 180 degrees and then -180 degrees also leaves the color unchanged. 26253 * <br>When the data type is number, the value **90** is equivalent to **'90deg'**. 26254 * @returns { T } 26255 * @syscap SystemCapability.ArkUI.ArkUI.Full 26256 * @form 26257 * @since 9 26258 */ 26259 /** 26260 * Rotates the hue of the component. 26261 * 26262 * @param { number | string } value - Hue rotation angle of the component. 26263 * <br>A rotation of 360 degrees leaves the color unchanged. 26264 * <br>A rotation of 180 degrees and then -180 degrees also leaves the color unchanged. 26265 * <br>When the data type is number, the value **90** is equivalent to **'90deg'**. 26266 * @returns { T } 26267 * @syscap SystemCapability.ArkUI.ArkUI.Full 26268 * @crossplatform 26269 * @form 26270 * @since 10 26271 */ 26272 /** 26273 * Rotates the hue of the component. 26274 * 26275 * @param { number | string } value - Hue rotation angle of the component. 26276 * <br>A rotation of 360 degrees leaves the color unchanged. 26277 * <br>A rotation of 180 degrees and then -180 degrees also leaves the color unchanged. 26278 * <br>When the data type is number, the value **90** is equivalent to **'90deg'**. 26279 * @returns { T } 26280 * @syscap SystemCapability.ArkUI.ArkUI.Full 26281 * @crossplatform 26282 * @form 26283 * @atomicservice 26284 * @since arkts {'1.1':'11','1.2':'20'} 26285 * @arkts 1.1&1.2 26286 */ 26287 hueRotate(value: number | string): T; 26288 26289 /** 26290 * Rotates the hue of the component. Compared to hueRotate, 26291 * this API supports the **undefined** type for the **rotation** parameter. 26292 * 26293 * @param { Optional<number | string> } rotation 26294 * @returns { T } 26295 * @syscap SystemCapability.ArkUI.ArkUI.Full 26296 * @crossplatform 26297 * @form 26298 * @atomicservice 26299 * @since arkts {'1.1':'18','1.2':'20'} 26300 * @arkts 1.1&1.2 26301 */ 26302 hueRotate(rotation: Optional<number | string>): T; 26303 26304 /** 26305 * Sets whether to draw shadows of child nodes in the component at the same layer, 26306 * so that the shadows of elements at the same layer overlap. 26307 * 26308 * @param { boolean } value - Whether to draw shadows of child nodes in the component 26309 * at the same layer, so that the shadows of elements at the same layer overlap. 26310 * <br>Default value: **false**. 26311 * <br>**NOTE** 26312 * <br>1. When this feature is disabled (default), if the shadow radius of a child node 26313 * is large, the shadows of the child nodes may overlap. This overlap issue does not occur 26314 * when the feature is enabled. 26315 * <br>2. Avoid nesting **useShadowBatching**. When used in nested mode, **useShadowBatching** 26316 * takes effect for the current child node only and cannot be recursively used. 26317 * @returns { T } 26318 * @syscap SystemCapability.ArkUI.ArkUI.Full 26319 * @crossplatform 26320 * @form 26321 * @since 11 26322 */ 26323 /** 26324 * Sets whether to draw shadows of child nodes in the component at the same layer, 26325 * so that the shadows of elements at the same layer overlap. 26326 * 26327 * @param { boolean } value - Whether to draw shadows of child nodes in the component 26328 * at the same layer, so that the shadows of elements at the same layer overlap. 26329 * <br>Default value: **false**. 26330 * <br>**NOTE** 26331 * <br>1. When this feature is disabled (default), if the shadow radius of a child node 26332 * is large, the shadows of the child nodes may overlap. This overlap issue does not occur 26333 * when the feature is enabled. 26334 * <br>2. Avoid nesting **useShadowBatching**. When used in nested mode, **useShadowBatching** 26335 * takes effect for the current child node only and cannot be recursively used. 26336 * @returns { T } 26337 * @syscap SystemCapability.ArkUI.ArkUI.Full 26338 * @crossplatform 26339 * @form 26340 * @atomicservice 26341 * @since arkts {'1.1':'12','1.2':'20'} 26342 * @arkts 1.1&1.2 26343 */ 26344 useShadowBatching(value: boolean): T; 26345 26346 /** 26347 * Sets whether to draw shadows of child nodes in the component at the same layer, 26348 * so that the shadows of elements at the same layer overlap. Compared to 26349 * useShadowBatching<sup>11+</sup>, this API supports the 26350 * **undefined** type for the **use** parameter. 26351 * 26352 * @param { Optional<boolean> } use - Whether to draw shadows of child nodes in the 26353 * component at the same layer, so that the shadows of elements at the same layer overlap. 26354 * <br>Default value: **false**. 26355 * <br>**NOTE** 26356 * <br>1. When this feature is disabled (default), if the shadow radius of a child node is large, 26357 * the shadows of the child nodes may overlap. This overlap issue does not occur when the feature 26358 * is enabled.<br>2. Avoid nesting **useShadowBatching**. When used in nested mode, 26359 * **useShadowBatching** takes effect for the current child node only and cannot be recursively used. 26360 * <br>If **use** is **undefined**, the component reverts to its original effect of not using 26361 * shadow overlapping. 26362 * @returns { T } 26363 * @syscap SystemCapability.ArkUI.ArkUI.Full 26364 * @crossplatform 26365 * @form 26366 * @atomicservice 26367 * @since arkts {'1.1':'18','1.2':'20'} 26368 * @arkts 1.1&1.2 26369 */ 26370 useShadowBatching(use: Optional<boolean>): T; 26371 26372 /** 26373 * Specifies whether to apply the effect defined by <!--Del-->the parent 26374 * [EffectComponent](ts-container-effectcomponent-sys.md) or <!--DelEnd-->the window. 26375 * 26376 * @param { Optional<boolean> } useEffect - Whether to apply the effect defined by <!--Del-->the parent 26377 * **EffectComponent** or <!--DelEnd-->the window. 26378 * <br>The value **true** means to apply the effect defined by <!--Del-->the parent **EffectComponent** 26379 * or <!--DelEnd-->the window. 26380 * <br>Default value: **false**. 26381 * @param { EffectType } [effectType] - Type of effect to apply to the component, which is defined by 26382 * <!--Del-->the parent **EffectComponent** or <!--DelEnd-->the window. 26383 * <br>Default value: **EffectType.DEFAULT**. 26384 * @returns { T } return the component attribute. 26385 * @syscap SystemCapability.ArkUI.ArkUI.Full 26386 * @atomicservice 26387 * @since arkts {'1.1':'14','1.2':'20'} 26388 * @arkts 1.1&1.2 26389 */ 26390 useEffect(useEffect: boolean, effectType: EffectType): T; 26391 26392 /** 26393 * Specifies whether to apply the effect defined by <!--Del-->the parent 26394 * EffectComponent or 26395 * <!--DelEnd-->the window. Compared to useEffect<sup>14+</sup>, 26396 * this API supports the **undefined** type for the **useEffect** parameter. 26397 * 26398 * @param { Optional<boolean> } useEffect - Whether to apply the effect defined by 26399 * <!--Del-->the parent **EffectComponent** or <!--DelEnd-->the window. 26400 * <br>The value **true** means to apply the effect defined by <!--Del-->the parent 26401 * **EffectComponent** or <!--DelEnd-->the window. 26402 * <br>Default value: **false**. 26403 * <br>If **useEffect** is set to **undefined**, the previous value is retained. 26404 * @param { EffectType } [effectType] - Type of effect to apply to the component, which 26405 * is defined by <!--Del-->the parent **EffectComponent** or <!--DelEnd-->the window. 26406 * <br>Default value: **EffectType.DEFAULT**. 26407 * @returns { T } return the component attribute. 26408 * @syscap SystemCapability.ArkUI.ArkUI.Full 26409 * @atomicservice 26410 * @since arkts {'1.1':'18','1.2':'20'} 26411 * @arkts 1.1&1.2 26412 */ 26413 useEffect(useEffect: Optional<boolean>, effectType?: EffectType): T; 26414 26415 /** 26416 * Specifies whether to combine the drawing of special effects, such as background blur. 26417 * 26418 * @param { boolean } value - Whether the component inherits the special effect settings of the 26419 * **EffectComponent** component.<br>The value **true** means that the component inherits the 26420 * special effect settings of the **EffectComponent** component, and **false** means the opposite. 26421 * <br>Default value: **false**. 26422 * @returns { T } return the component attribute. 26423 * @syscap SystemCapability.ArkUI.ArkUI.Full 26424 * @atomicservice 26425 * @since arkts {'1.1':'12','1.2':'20'} 26426 * @arkts 1.1&1.2 26427 */ 26428 useEffect(value: boolean): T; 26429 26430 /** 26431 * Applies a background blur effect to the component. You can customize the blur radius and grayscale parameters. 26432 * 26433 * @param { number } value - Background blur effect to apply to the component. 26434 * <br>The input parameter is the blur radius. The larger the radius is, the more blurred the background is. 26435 * <br>If the value is **0**, the background is not blurred. 26436 * @returns { T } 26437 * @syscap SystemCapability.ArkUI.ArkUI.Full 26438 * @since 7 26439 */ 26440 /** 26441 * Applies a background blur effect to the component. You can customize the blur radius and grayscale parameters. 26442 * 26443 * @param { number } value - Background blur effect to apply to the component. 26444 * <br>The input parameter is the blur radius. The larger the radius is, the more blurred the background is. 26445 * <br>If the value is **0**, the background is not blurred. 26446 * @returns { T } 26447 * @syscap SystemCapability.ArkUI.ArkUI.Full 26448 * @form 26449 * @since 9 26450 */ 26451 /** 26452 * Applies a background blur effect to the component. You can customize the blur radius and grayscale parameters. 26453 * 26454 * @param { number } value - Background blur effect to apply to the component. 26455 * <br>The input parameter is the blur radius. The larger the radius is, the more blurred the background is. 26456 * <br>If the value is **0**, the background is not blurred. 26457 * @returns { T } 26458 * @syscap SystemCapability.ArkUI.ArkUI.Full 26459 * @crossplatform 26460 * @form 26461 * @since 10 26462 */ 26463 /** 26464 * Applies a background blur effect to the component. You can customize the blur radius and grayscale parameters. 26465 * 26466 * @param { number } value - Background blur effect to apply to the component. 26467 * <br>The input parameter is the blur radius. The larger the radius is, the more blurred the background is. 26468 * <br>If the value is **0**, the background is not blurred. 26469 * @param { BlurOptions } [options] - Grayscale parameters. 26470 * @returns { T } 26471 * @syscap SystemCapability.ArkUI.ArkUI.Full 26472 * @crossplatform 26473 * @form 26474 * @atomicservice 26475 * @since arkts {'1.1':'11','1.2':'20'} 26476 * @arkts 1.1&1.2 26477 */ 26478 backdropBlur(value: number, options?: BlurOptions): T; 26479 26480 /** 26481 * Adds the background blur effect for the current component. The input parameter is the blur radius. 26482 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 26483 * 26484 * @param { Optional<number> } radius - radius indicates radius of backdrop blur. 26485 * @param { BlurOptions } [options] - options indicates the backdrop blur options. 26486 * @returns { T } 26487 * @syscap SystemCapability.ArkUI.ArkUI.Full 26488 * @crossplatform 26489 * @form 26490 * @atomicservice 26491 * @since 18 26492 */ 26493 backdropBlur(radius: Optional<number>, options?: BlurOptions): T; 26494 26495 /** 26496 * Adds the background blur effect for the current component. The input parameter is the blur radius. 26497 * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. 26498 * 26499 * @param { Optional<number> } radius - radius indicates radius of backdrop blur. 26500 * @param { BlurOptions } [options] - options indicates the backdrop blur options. 26501 * @param { SystemAdaptiveOptions } [sysOptions] - system adaptive options. 26502 * @returns { T } 26503 * @syscap SystemCapability.ArkUI.ArkUI.Full 26504 * @crossplatform 26505 * @form 26506 * @atomicservice 26507 * @since arkts {'1.1':'19','1.2':'20'} 26508 * @arkts 1.1&1.2 26509 */ 26510 backdropBlur(radius: Optional<number>, options?: BlurOptions, sysOptions?: SystemAdaptiveOptions): T; 26511 26512 /** 26513 * Sets whether the component and its child components are rendered off 26514 * the screen as a whole before being blended with its parent. 26515 * 26516 * @param { boolean } value - Whether the component and its child components are rendered 26517 * off the screen as a whole before being blended with its parent. If the opacity of the 26518 * component is not 1, the drawing effect may vary depending on the value. 26519 * <br>Default value: **false**. 26520 * <br> The value **true** means the component and its child components are rendered off 26521 * the screen as a whole, and **false** means the opposite. 26522 * @returns { T } 26523 * @syscap SystemCapability.ArkUI.ArkUI.Full 26524 * @crossplatform 26525 * @since 10 26526 */ 26527 /** 26528 * Sets whether the component and its child components are rendered off 26529 * the screen as a whole before being blended with its parent. 26530 * 26531 * @param { boolean } value - Whether the component and its child components are rendered 26532 * off the screen as a whole before being blended with its parent. If the opacity of the 26533 * component is not 1, the drawing effect may vary depending on the value. 26534 * <br>Default value: **false**. 26535 * <br> The value **true** means the component and its child components are rendered off 26536 * the screen as a whole, and **false** means the opposite. 26537 * @returns { T } 26538 * @syscap SystemCapability.ArkUI.ArkUI.Full 26539 * @crossplatform 26540 * @atomicservice 26541 * @since 11 26542 */ 26543 /** 26544 * Sets whether the component and its child components are rendered off 26545 * the screen as a whole before being blended with its parent. 26546 * 26547 * @param { boolean } value - Whether the component and its child components are rendered 26548 * off the screen as a whole before being blended with its parent. If the opacity of the 26549 * component is not 1, the drawing effect may vary depending on the value. 26550 * <br>Default value: **false**. 26551 * <br> The value **true** means the component and its child components are rendered off 26552 * the screen as a whole, and **false** means the opposite. 26553 * @returns { T } 26554 * @syscap SystemCapability.ArkUI.ArkUI.Full 26555 * @crossplatform 26556 * @form 26557 * @atomicservice 26558 * @since arkts {'1.1':'12','1.2':'20'} 26559 * @arkts 1.1&1.2 26560 */ 26561 renderGroup(value: boolean): T; 26562 26563 /** 26564 * Sets whether the component and its child components are rendered off the screen as a whole 26565 * before being blended with its parent. Compared to renderGroup<sup>10+</sup>, 26566 * this API supports the **undefined** type for the **isGroup** parameter. 26567 * 26568 * @param { Optional<boolean> } isGroup - Whether the component and its child components are rendered 26569 * off the screen as a whole before being blended with its parent. If the opacity of the component is 26570 * not 1, the drawing effect may vary depending on the value. 26571 * <br>Default value: **false**. 26572 * <br>If **isGroup** is **undefined**, the component reverts to its original effect of not enabling 26573 * offscreen rendering as a whole before blending with the parent component. 26574 * @returns { T } 26575 * @syscap SystemCapability.ArkUI.ArkUI.Full 26576 * @crossplatform 26577 * @form 26578 * @atomicservice 26579 * @since arkts {'1.1':'18','1.2':'20'} 26580 * @arkts 1.1&1.2 26581 */ 26582 renderGroup(isGroup: Optional<boolean>): T; 26583 26584 /** 26585 * Sets whether to freeze the component. When frozen, the component and its children are cached for 26586 * repeated drawing after offscreen rendering, without updating internal attributes. 26587 * 26588 * @param { boolean } value - Whether to freeze the component. When frozen, the component and its children 26589 * are cached for repeated drawing after offscreen rendering, without updating internal attributes. If the 26590 * opacity of the component is not 1, the drawing effect may vary depending on the value. 26591 * <br>Default value: **false**. 26592 * <br> **true**: Freeze the component. 26593 * <br>**false**: Do not freeze the component. 26594 * @returns { T } 26595 * @syscap SystemCapability.ArkUI.ArkUI.Full 26596 * @atomicservice 26597 * @since arkts {'1.1':'12','1.2':'20'} 26598 * @arkts 1.1&1.2 26599 */ 26600 freeze(value: boolean): T; 26601 26602 /** 26603 * Sets whether to freeze the component. When frozen, the component and its children are cached for repeated 26604 * drawing after offscreen rendering, without updating internal attributes. Compared to freeze, 26605 * this API supports the **undefined** type for the **freeze** parameter. 26606 * 26607 * @param { Optional<boolean> } freeze - Whether to freeze the component. When frozen, the component and its 26608 * children are cached for repeated drawing after offscreen rendering, without updating internal attributes. 26609 * If the opacity of the component is not 1, the drawing effect may vary depending on the value. 26610 * <br>Default value: **false**. 26611 * <br> **true**: Freeze the component. 26612 * <br>**false**: Do not freeze the component. 26613 * <br>If **freeze** is set to **undefined**, the previous value is retained. 26614 * @returns { T } 26615 * @syscap SystemCapability.ArkUI.ArkUI.Full 26616 * @atomicservice 26617 * @since arkts {'1.1':'18','1.2':'20'} 26618 * @arkts 1.1&1.2 26619 */ 26620 freeze(freeze: Optional<boolean>): T; 26621 26622 /** 26623 * Sets the translation effect for page transitions. 26624 * 26625 * @param { TranslateOptions } value - Translation effect for page transitions 26626 * <br>specifying the start value for entrance and the end value for exit. default:{x:0,y:0,z:0} 26627 * @returns { T } 26628 * @syscap SystemCapability.ArkUI.ArkUI.Full 26629 * @since 7 26630 */ 26631 /** 26632 * Sets the translation effect for page transitions. 26633 * 26634 * @param { TranslateOptions } value - Translation effect for page transitions 26635 * <br>specifying the start value for entrance and the end value for exit. default:{x:0,y:0,z:0} 26636 * @returns { T } 26637 * @syscap SystemCapability.ArkUI.ArkUI.Full 26638 * @form 26639 * @since 9 26640 */ 26641 /** 26642 * Sets the translation effect for page transitions. 26643 * 26644 * @param { TranslateOptions } value - Translation effect for page transitions 26645 * <br>specifying the start value for entrance and the end value for exit. default:{x:0,y:0,z:0} 26646 * @returns { T } 26647 * @syscap SystemCapability.ArkUI.ArkUI.Full 26648 * @crossplatform 26649 * @form 26650 * @since 10 26651 */ 26652 /** 26653 * Sets the translation effect for page transitions. 26654 * 26655 * @param { TranslateOptions } value - Translation effect for page transitions 26656 * <br>specifying the start value for entrance and the end value for exit. default:{x:0,y:0,z:0} 26657 * @returns { T } 26658 * @syscap SystemCapability.ArkUI.ArkUI.Full 26659 * @crossplatform 26660 * @form 26661 * @atomicservice 26662 * @since arkts {'1.1':'11','1.2':'20'} 26663 * @arkts 1.1&1.2 26664 */ 26665 translate(value: TranslateOptions): T; 26666 26667 /** 26668 * Translates the component. 26669 * Compared to {@link translate}, this API supports the **undefined** type for the **translate** parameter. 26670 26671 * 26672 * @param { Optional<TranslateOptions> } translate - How the component is translated in the coordinate 26673 * <br>system (as shown below) with the upper left corner of the component as the coordinate origin. 26674 * <br>Values of **x**, **y**, and **z** indicate the translation distance along the respective axis. 26675 * <br>default:{x:0,y:0,z:0} 26676 * @returns { T } 26677 * @syscap SystemCapability.ArkUI.ArkUI.Full 26678 * @crossplatform 26679 * @form 26680 * @atomicservice 26681 * @since arkts {'1.1':'18','1.2':'20'} 26682 * @arkts 1.1&1.2 26683 */ 26684 translate(translate: Optional<TranslateOptions>): T; 26685 26686 /** 26687 * Sets the zoom effect during page transition. The value is the start point of entry and end point of exit. 26688 * 26689 * @param { ScaleOptions } value - Scale ratio along the x-, y-, and z-axis. The default value is **1**. 26690 * <br>**centerX** and **centerY** are used to set the scale center point. 26691 * <br>default:{x:1,y:1,z:1,centerX:'50%',centerY:'50%'} 26692 * @returns { T } 26693 * @syscap SystemCapability.ArkUI.ArkUI.Full 26694 * @since 7 26695 */ 26696 /** 26697 * Sets the zoom effect during page transition. The value is the start point of entry and end point of exit. 26698 * 26699 * @param { ScaleOptions } value - Scale ratio along the x-, y-, and z-axis. The default value is **1**. 26700 * <br>**centerX** and **centerY** are used to set the scale center point. 26701 * <br>default:{x:1,y:1,z:1,centerX:'50%',centerY:'50%'} 26702 * @returns { T } 26703 * @syscap SystemCapability.ArkUI.ArkUI.Full 26704 * @form 26705 * @since 9 26706 */ 26707 /** 26708 * Sets the zoom effect during page transition. The value is the start point of entry and end point of exit. 26709 * 26710 * @param { ScaleOptions } value - Scale ratio along the x-, y-, and z-axis. The default value is **1**. 26711 * <br>**centerX** and **centerY** are used to set the scale center point. 26712 * <br>default:{x:1,y:1,z:1,centerX:'50%',centerY:'50%'} 26713 * @returns { T } 26714 * @syscap SystemCapability.ArkUI.ArkUI.Full 26715 * @crossplatform 26716 * @form 26717 * @since 10 26718 */ 26719 /** 26720 * Scales the component. 26721 * 26722 * @param { ScaleOptions } value - Scale ratio along the x-, y-, and z-axis. The default value is **1**. 26723 * <br>**centerX** and **centerY** are used to set the scale center point. 26724 * <br>default:{x:1,y:1,z:1,centerX:'50%',centerY:'50%'} 26725 * @returns { T } 26726 * @syscap SystemCapability.ArkUI.ArkUI.Full 26727 * @crossplatform 26728 * @form 26729 * @atomicservice 26730 * @since arkts {'1.1':'11','1.2':'20'} 26731 * @arkts 1.1&1.2 26732 */ 26733 scale(value: ScaleOptions): T; 26734 26735 /** 26736 * Scales the component. 26737 * Compared to {@link scale} , this API supports the **undefined** type for the **options** parameter. 26738 * 26739 * @param { Optional<ScaleOptions> } options - Scale ratio along the x-, y-, and z-axis. 26740 * <br>The default value is **1**. **centerX** and **centerY** are used to set the scale center point. 26741 * <br>default:{x:1,y:1,z:1,centerX:'50%',centerY:'50%'} 26742 * <br>If **options** is **undefined**, the component reverts to its original state with no scaling. 26743 * @returns { T } 26744 * @syscap SystemCapability.ArkUI.ArkUI.Full 26745 * @crossplatform 26746 * @form 26747 * @atomicservice 26748 * @since arkts {'1.1':'18','1.2':'20'} 26749 * @arkts 1.1&1.2 26750 */ 26751 scale(options: Optional<ScaleOptions>): T; 26752 26753 /** 26754 * Default number of occupied columns, indicating the number of occupied grid columns when the number of columns (span) of the corresponding size is not set in the useSizeType attribute. 26755 * 26756 * @param { number } value 26757 * @returns { T } 26758 * @syscap SystemCapability.ArkUI.ArkUI.Full 26759 * @since 7 26760 */ 26761 /** 26762 * Default number of occupied columns, indicating the number of occupied grid columns when the number of columns (span) of the corresponding size is not set in the useSizeType attribute. 26763 * 26764 * @param { number } value 26765 * @returns { T } 26766 * @syscap SystemCapability.ArkUI.ArkUI.Full 26767 * @crossplatform 26768 * @since 10 26769 */ 26770 /** 26771 * Default number of occupied columns, indicating the number of occupied grid columns when the number of columns (span) of the corresponding size is not set in the useSizeType attribute. 26772 * 26773 * @param { number } value 26774 * @returns { T } 26775 * @syscap SystemCapability.ArkUI.ArkUI.Full 26776 * @crossplatform 26777 * @atomicservice 26778 * @since 11 26779 * @deprecated since 14 26780 * @useinstead grid_col/GridColInterface and grid_row/GridRowInterface 26781 */ 26782 gridSpan(value: number): T; 26783 26784 /** 26785 * The default offset column number indicates the number of offset columns of the current component in the start direction of the parent component when the useSizeType attribute does not set the offset of the corresponding dimension. That is, 26786 * the current component is located in the nth column. 26787 * 26788 * @param { number } value 26789 * @returns { T } 26790 * @syscap SystemCapability.ArkUI.ArkUI.Full 26791 * @since 7 26792 */ 26793 /** 26794 * The default offset column number indicates the number of offset columns of the current component in the start direction of the parent component when the useSizeType attribute does not set the offset of the corresponding dimension. That is, 26795 * the current component is located in the nth column. 26796 * 26797 * @param { number } value 26798 * @returns { T } 26799 * @syscap SystemCapability.ArkUI.ArkUI.Full 26800 * @crossplatform 26801 * @since 10 26802 */ 26803 /** 26804 * The default offset column number indicates the number of offset columns of the current component in the start direction of the parent component when the useSizeType attribute does not set the offset of the corresponding dimension. That is, 26805 * the current component is located in the nth column. 26806 * 26807 * @param { number } value 26808 * @returns { T } 26809 * @syscap SystemCapability.ArkUI.ArkUI.Full 26810 * @crossplatform 26811 * @atomicservice 26812 * @since 11 26813 * @deprecated since 14 26814 * @useinstead grid_col/GridColInterface and grid_row/GridRowInterface 26815 */ 26816 gridOffset(value: number): T; 26817 26818 /** 26819 * Sets the rotation effect during assembly transition. 26820 * The values are the start point during insertion and the end point during deletion. 26821 * 26822 * @param { RotateOptions } value 26823 * @returns { T } 26824 * @syscap SystemCapability.ArkUI.ArkUI.Full 26825 * @since 7 26826 */ 26827 /** 26828 * Sets the rotation effect during assembly transition. 26829 * The values are the start point during insertion and the end point during deletion. 26830 * 26831 * @param { RotateOptions } value 26832 * @returns { T } 26833 * @syscap SystemCapability.ArkUI.ArkUI.Full 26834 * @form 26835 * @since 9 26836 */ 26837 /** 26838 * Sets the rotation effect during assembly transition. 26839 * The values are the start point during insertion and the end point during deletion. 26840 * 26841 * @param { RotateOptions } value 26842 * @returns { T } 26843 * @syscap SystemCapability.ArkUI.ArkUI.Full 26844 * @crossplatform 26845 * @form 26846 * @since 10 26847 */ 26848 /** 26849 * Set component rotation. 26850 * 26851 * @param { RotateOptions } value default:{x:0,y:0,z:0,centerX:'50%',centerY:'50%',centerZ:0,perspective:0} 26852 * @returns { T } 26853 * @syscap SystemCapability.ArkUI.ArkUI.Full 26854 * @crossplatform 26855 * @form 26856 * @atomicservice 26857 * @since arkts {'1.1':'11','1.2':'20'} 26858 * @arkts 1.1&1.2 26859 */ 26860 rotate(value: RotateOptions): T; 26861 26862 /** 26863 * Rotates the component. This API supports the **undefined** type for the **options** parameter. 26864 * 26865 * @param { Optional<RotateOptions> } options default:{x:0,y:0,z:0,centerX:'50%',centerY:'50%',centerZ:0,perspective:0} 26866 * @returns { T } 26867 * @syscap SystemCapability.ArkUI.ArkUI.Full 26868 * @crossplatform 26869 * @form 26870 * @atomicservice 26871 * @since arkts {'1.1':'18','1.2':'20'} 26872 * @arkts 1.1&1.2 26873 */ 26874 rotate(options: Optional<RotateOptions>): T; 26875 26876 /** 26877 * Set component rotation. 26878 * 26879 * @param { Optional<RotateOptions | RotateAngleOptions> } options default:{x:0,y:0,z:0,centerX:'50%',centerY:'50%',centerZ:0,perspective:0,angle:0} 26880 * @returns { T } 26881 * @syscap SystemCapability.ArkUI.ArkUI.Full 26882 * @crossplatform 26883 * @form 26884 * @atomicservice 26885 * @since 20 26886 */ 26887 rotate(options: Optional<RotateOptions | RotateAngleOptions>): T; 26888 26889 /** 26890 * Sets the transformation matrix of the component. 26891 * 26892 * @param { object } value - Transformation matrix of the component. 26893 * @returns { T } 26894 * @syscap SystemCapability.ArkUI.ArkUI.Full 26895 * @since 7 26896 */ 26897 /** 26898 * Sets the transformation matrix of the component. 26899 * 26900 * @param { object } value - Transformation matrix of the component. 26901 * @returns { T } 26902 * @syscap SystemCapability.ArkUI.ArkUI.Full 26903 * @crossplatform 26904 * @since 10 26905 */ 26906 /** 26907 * Sets the transformation matrix of the component. 26908 * 26909 * @param { object } value - Transformation matrix of the component. 26910 * @returns { T } 26911 * @syscap SystemCapability.ArkUI.ArkUI.Full 26912 * @crossplatform 26913 * @atomicservice 26914 * @since arkts {'1.1':'11','1.2':'20'} 26915 * @arkts 1.1&1.2 26916 */ 26917 transform(value: object): T; 26918 26919 /** 26920 * Sets the transformation matrix of the component. 26921 * Compared to {@link transform}, this API supports the **undefined** type for the **transform** parameter. 26922 * 26923 * @param { Optional<object> } transform - How the component is translated in the coordinate 26924 * <br>system (as shown below) with the upper left corner of the component as the coordinate origin. 26925 * @returns { T } 26926 * @syscap SystemCapability.ArkUI.ArkUI.Full 26927 * @crossplatform 26928 * @atomicservice 26929 * @since arkts {'1.1':'18','1.2':'20'} 26930 * @arkts 1.1&1.2 26931 */ 26932 transform(transform: Optional<object>): T; 26933 26934 /** 26935 * Sets the transformation matrix for the current component. 26936 * The interface can display the effect of three-dimensional matrix transformation. 26937 * 26938 * @param { Optional<Matrix4Transit> } transform - transform3D matrix 26939 * @returns { T } 26940 * @syscap SystemCapability.ArkUI.ArkUI.Full 26941 * @crossplatform 26942 * @atomicservice 26943 * @since 20 26944 */ 26945 transform3D(transform: Optional<Matrix4Transit>): T; 26946 26947 /** 26948 * This callback is triggered when a component mounts a display. 26949 * 26950 * @param { function } event 26951 * @returns { T } 26952 * @syscap SystemCapability.ArkUI.ArkUI.Full 26953 * @since 7 26954 */ 26955 /** 26956 * This callback is triggered when a component mounts a display. 26957 * 26958 * @param { function } event 26959 * @returns { T } 26960 * @syscap SystemCapability.ArkUI.ArkUI.Full 26961 * @form 26962 * @since 9 26963 */ 26964 /** 26965 * This callback is triggered when a component mounts a display. 26966 * 26967 * @param { function } event 26968 * @returns { T } 26969 * @syscap SystemCapability.ArkUI.ArkUI.Full 26970 * @crossplatform 26971 * @form 26972 * @since 10 26973 */ 26974 /** 26975 * This callback is triggered when a component mounts a display. 26976 * 26977 * @param { function } event 26978 * @returns { T } 26979 * @syscap SystemCapability.ArkUI.ArkUI.Full 26980 * @crossplatform 26981 * @form 26982 * @atomicservice 26983 * @since arkts {'1.1':'11','1.2':'20'} 26984 * @arkts 1.1&1.2 26985 */ 26986 onAppear(event: () => void): T; 26987 26988 /** 26989 * This callback is triggered when component uninstallation disappears. 26990 * 26991 * @param { function } event 26992 * @returns { T } 26993 * @syscap SystemCapability.ArkUI.ArkUI.Full 26994 * @since 7 26995 */ 26996 /** 26997 * This callback is triggered when component uninstallation disappears. 26998 * 26999 * @param { function } event 27000 * @returns { T } 27001 * @syscap SystemCapability.ArkUI.ArkUI.Full 27002 * @form 27003 * @since 9 27004 */ 27005 /** 27006 * This callback is triggered when component uninstallation disappears. 27007 * 27008 * @param { function } event 27009 * @returns { T } 27010 * @syscap SystemCapability.ArkUI.ArkUI.Full 27011 * @crossplatform 27012 * @form 27013 * @since 10 27014 */ 27015 /** 27016 * This callback is triggered when component uninstallation disappears. 27017 * 27018 * @param { function } event 27019 * @returns { T } 27020 * @syscap SystemCapability.ArkUI.ArkUI.Full 27021 * @crossplatform 27022 * @form 27023 * @atomicservice 27024 * @since arkts {'1.1':'11','1.2':'20'} 27025 * @arkts 1.1&1.2 27026 */ 27027 onDisAppear(event: () => void): T; 27028 27029 /** 27030 * This callback is triggered when a component mounts to view tree. 27031 * 27032 * @param { Callback<void> } callback 27033 * @returns { T } 27034 * @syscap SystemCapability.ArkUI.ArkUI.Full 27035 * @crossplatform 27036 * @atomicservice 27037 * @since 12 27038 */ 27039 onAttach(callback: Callback<void>): T; 27040 27041 /** 27042 * This callback is triggered when a component mounts to view tree. 27043 * 27044 * @param { VoidCallback } callback 27045 * @returns { T } 27046 * @syscap SystemCapability.ArkUI.ArkUI.Full 27047 * @crossplatform 27048 * @atomicservice 27049 * @since 20 27050 * @arkts 1.2 27051 */ 27052 onAttach(callback: VoidCallback): T; 27053 27054 /** 27055 * This callback is triggered when a component is detached from view tree. 27056 * 27057 * @param { Callback<void> } callback 27058 * @returns { T } 27059 * @syscap SystemCapability.ArkUI.ArkUI.Full 27060 * @crossplatform 27061 * @atomicservice 27062 * @since 12 27063 */ 27064 onDetach(callback: Callback<void>): T; 27065 27066 /** 27067 * This callback is triggered when a component is detached from view tree. 27068 * 27069 * @param { VoidCallback } callback 27070 * @returns { T } 27071 * @syscap SystemCapability.ArkUI.ArkUI.Full 27072 * @crossplatform 27073 * @atomicservice 27074 * @since 20 27075 * @arkts 1.2 27076 */ 27077 onDetach(callback: VoidCallback): T; 27078 27079 /** 27080 * This callback is triggered when the size or position of this component change finished. 27081 * 27082 * @param { function } event - event callback. 27083 * @returns { T } 27084 * @syscap SystemCapability.ArkUI.ArkUI.Full 27085 * @since 8 27086 */ 27087 /** 27088 * This callback is triggered when the size or position of this component change finished. 27089 * 27090 * @param { function } event - event callback. 27091 * @returns { T } 27092 * @syscap SystemCapability.ArkUI.ArkUI.Full 27093 * @crossplatform 27094 * @since 10 27095 */ 27096 /** 27097 * This callback is triggered when the size or position of this component change finished. 27098 * 27099 * @param { function } event - event callback. 27100 * @returns { T } 27101 * @syscap SystemCapability.ArkUI.ArkUI.Full 27102 * @crossplatform 27103 * @atomicservice 27104 * @since arkts {'1.1':'11','1.2':'20'} 27105 * @arkts 1.1&1.2 27106 */ 27107 onAreaChange(event: (oldValue: Area, newValue: Area) => void): T; 27108 27109 /** 27110 * Controls the display or hide of the current component. 27111 * 27112 * @param { Visibility } value 27113 * @returns { T } 27114 * @syscap SystemCapability.ArkUI.ArkUI.Full 27115 * @since 7 27116 */ 27117 /** 27118 * Controls the display or hide of the current component. 27119 * 27120 * @param { Visibility } value 27121 * @returns { T } 27122 * @syscap SystemCapability.ArkUI.ArkUI.Full 27123 * @form 27124 * @since 9 27125 */ 27126 /** 27127 * Controls the display or hide of the current component. 27128 * 27129 * @param { Visibility } value 27130 * @returns { T } 27131 * @syscap SystemCapability.ArkUI.ArkUI.Full 27132 * @crossplatform 27133 * @form 27134 * @since 10 27135 */ 27136 /** 27137 * Controls the display or hide of the current component. 27138 * 27139 * @param { Visibility } value - Whether the component is visible. 27140 * @returns { T } 27141 * @syscap SystemCapability.ArkUI.ArkUI.Full 27142 * @crossplatform 27143 * @form 27144 * @atomicservice 27145 * @since arkts {'1.1':'11','1.2':'20'} 27146 * @arkts 1.1&1.2 27147 */ 27148 visibility(value: Visibility): T; 27149 27150 /** 27151 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 27152 * 27153 * @param { number } value 27154 * @returns { T } 27155 * @syscap SystemCapability.ArkUI.ArkUI.Full 27156 * @since 7 27157 */ 27158 /** 27159 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 27160 * 27161 * @param { number } value 27162 * @returns { T } 27163 * @syscap SystemCapability.ArkUI.ArkUI.Full 27164 * @form 27165 * @since 9 27166 */ 27167 /** 27168 * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. 27169 * 27170 * @param { number } value 27171 * @returns { T } 27172 * @syscap SystemCapability.ArkUI.ArkUI.Full 27173 * @crossplatform 27174 * @form 27175 * @since 10 27176 */ 27177 /** 27178 * Sets the percentage of the parent container's remaining space that is allocated to the component. 27179 * Default value: **0**. 27180 * 27181 * @param { number } value 27182 * @returns { T } 27183 * @syscap SystemCapability.ArkUI.ArkUI.Full 27184 * @crossplatform 27185 * @form 27186 * @atomicservice 27187 * @since arkts {'1.1':'11','1.2':'20'} 27188 * @arkts 1.1&1.2 27189 */ 27190 flexGrow(value: number): T; 27191 27192 /** 27193 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 27194 * 27195 * @param { number } value 27196 * @returns { T } 27197 * @syscap SystemCapability.ArkUI.ArkUI.Full 27198 * @since 7 27199 */ 27200 /** 27201 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 27202 * 27203 * @param { number } value 27204 * @returns { T } 27205 * @syscap SystemCapability.ArkUI.ArkUI.Full 27206 * @form 27207 * @since 9 27208 */ 27209 /** 27210 * The proportion of the Flex container compression size assigned to the component on which this attribute resides. 27211 * 27212 * @param { number } value 27213 * @returns { T } 27214 * @syscap SystemCapability.ArkUI.ArkUI.Full 27215 * @crossplatform 27216 * @form 27217 * @since 10 27218 */ 27219 /** 27220 * Sets the percentage of the parent container's shrink size that is allocated to the component. 27221 * Default value: 0 when the parent container is Column or Row, 1 when the parent container is Flex.. 27222 * 27223 * @param { number } value 27224 * @returns { T } 27225 * @syscap SystemCapability.ArkUI.ArkUI.Full 27226 * @crossplatform 27227 * @form 27228 * @atomicservice 27229 * @since arkts {'1.1':'11','1.2':'20'} 27230 * @arkts 1.1&1.2 27231 */ 27232 flexShrink(value: number): T; 27233 27234 /** 27235 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 27236 * 27237 * @param { number | string } value 27238 * @returns { T } 27239 * @syscap SystemCapability.ArkUI.ArkUI.Full 27240 * @since 7 27241 */ 27242 /** 27243 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 27244 * 27245 * @param { number | string } value 27246 * @returns { T } 27247 * @syscap SystemCapability.ArkUI.ArkUI.Full 27248 * @form 27249 * @since 9 27250 */ 27251 /** 27252 * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. 27253 * 27254 * @param { number | string } value 27255 * @returns { T } 27256 * @syscap SystemCapability.ArkUI.ArkUI.Full 27257 * @crossplatform 27258 * @form 27259 * @since 10 27260 */ 27261 /** 27262 * Sets the base size of the component in the main axis of the parent container. 27263 * Default value: **'auto'**. 27264 * 27265 * @param { number | string } value 27266 * @returns { T } 27267 * @syscap SystemCapability.ArkUI.ArkUI.Full 27268 * @crossplatform 27269 * @form 27270 * @atomicservice 27271 * @since arkts {'1.1':'11','1.2':'20'} 27272 * @arkts 1.1&1.2 27273 */ 27274 flexBasis(value: number | string): T; 27275 27276 /** 27277 * Overrides the default configuration of alignItems in the Flex Layout container. 27278 * 27279 * @param { ItemAlign } value 27280 * @returns { T } 27281 * @syscap SystemCapability.ArkUI.ArkUI.Full 27282 * @since 7 27283 */ 27284 /** 27285 * Overrides the default configuration of alignItems in the Flex Layout container. 27286 * 27287 * @param { ItemAlign } value 27288 * @returns { T } 27289 * @syscap SystemCapability.ArkUI.ArkUI.Full 27290 * @form 27291 * @since 9 27292 */ 27293 /** 27294 * Overrides the default configuration of alignItems in the Flex Layout container. 27295 * 27296 * @param { ItemAlign } value 27297 * @returns { T } 27298 * @syscap SystemCapability.ArkUI.ArkUI.Full 27299 * @crossplatform 27300 * @form 27301 * @since 10 27302 */ 27303 /** 27304 * Sets the alignment mode of the child components along the cross axis of the parent container. 27305 * Default value: **ItemAlign.Auto**. 27306 * 27307 * @param { ItemAlign } value 27308 * @returns { T } 27309 * @syscap SystemCapability.ArkUI.ArkUI.Full 27310 * @crossplatform 27311 * @form 27312 * @atomicservice 27313 * @since arkts {'1.1':'11','1.2':'20'} 27314 * @arkts 1.1&1.2 27315 */ 27316 alignSelf(value: ItemAlign): T; 27317 27318 /** 27319 * Defines the align rules of child component in Stack container. 27320 * 27321 * @param { LocalizedAlignment} alignment 27322 * @returns { T } 27323 * @syscap SystemCapability.ArkUI.ArkUI.Full 27324 * @crossplatform 27325 * @form 27326 * @atomicservice 27327 * @since 20 27328 */ 27329 layoutGravity(alignment: LocalizedAlignment): T; 27330 27331 /** 27332 * Sets the current component and displays the priority in the layout container. This parameter is valid only in Row, Column, and Flex single-row layouts. 27333 * 27334 * @param { number } value 27335 * @returns { T } 27336 * @syscap SystemCapability.ArkUI.ArkUI.Full 27337 * @since 7 27338 */ 27339 /** 27340 * Sets the current component and displays the priority in the layout container. This parameter is valid only in Row, Column, and Flex single-row layouts. 27341 * 27342 * @param { number } value 27343 * @returns { T } 27344 * @syscap SystemCapability.ArkUI.ArkUI.Full 27345 * @form 27346 * @since 9 27347 */ 27348 /** 27349 * Sets the current component and displays the priority in the layout container. This parameter is valid only in Row, Column, and Flex single-row layouts. 27350 * 27351 * @param { number } value 27352 * @returns { T } 27353 * @syscap SystemCapability.ArkUI.ArkUI.Full 27354 * @crossplatform 27355 * @form 27356 * @since 10 27357 */ 27358 /** 27359 * Sets the display priority for the component in the layout container. 27360 * <br>This parameter is only effective in Row, Column, and Flex (single-line) container components. 27361 * 27362 * @param { number } value 27363 * @returns { T } 27364 * @syscap SystemCapability.ArkUI.ArkUI.Full 27365 * @crossplatform 27366 * @form 27367 * @atomicservice 27368 * @since arkts {'1.1':'11','1.2':'20'} 27369 * @arkts 1.1&1.2 27370 */ 27371 displayPriority(value: number): T; 27372 27373 /** 27374 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 27375 * 27376 * @param { number } value 27377 * @returns { T } 27378 * @syscap SystemCapability.ArkUI.ArkUI.Full 27379 * @since 7 27380 */ 27381 /** 27382 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 27383 * 27384 * @param { number } value 27385 * @returns { T } 27386 * @syscap SystemCapability.ArkUI.ArkUI.Full 27387 * @form 27388 * @since 9 27389 */ 27390 /** 27391 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 27392 * 27393 * @param { number } value 27394 * @returns { T } 27395 * @syscap SystemCapability.ArkUI.ArkUI.Full 27396 * @crossplatform 27397 * @form 27398 * @since 10 27399 */ 27400 /** 27401 * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. 27402 * 27403 * @param { number } value 27404 * @returns { T } 27405 * @syscap SystemCapability.ArkUI.ArkUI.Full 27406 * @crossplatform 27407 * @form 27408 * @atomicservice 27409 * @since arkts {'1.1':'11','1.2':'20'} 27410 * @arkts 1.1&1.2 27411 */ 27412 zIndex(value: number): T; 27413 27414 /** 27415 * If the components of the two pages are configured with the same ID. 27416 * The shared element transition is performed during transition. 27417 * If the parameter is set to an empty string, the shared element transition does not occur. 27418 * For details about the options parameter, see the options parameter description. 27419 * 27420 * @param { string } id - Transition of the shared element. 27421 * <br>If the same **id** value is configured for a component on the two pages, 27422 * <br>this component is considered as a shared element of the pages. 27423 * <br>If the **id** value is an empty string, no transition will be applied to the component. 27424 * @param { sharedTransitionOptions } options - Parameters of the shared element transition animation. 27425 * @returns { T } 27426 * @syscap SystemCapability.ArkUI.ArkUI.Full 27427 * @since 7 27428 */ 27429 /** 27430 * If the components of the two pages are configured with the same ID. 27431 * The shared element transition is performed during transition. 27432 * If the parameter is set to an empty string, the shared element transition does not occur. 27433 * For details about the options parameter, see the options parameter description. 27434 * 27435 * @param { string } id - Transition of the shared element. 27436 * <br>If the same **id** value is configured for a component on the two pages, 27437 * <br>this component is considered as a shared element of the pages. 27438 * <br>If the **id** value is an empty string, no transition will be applied to the component. 27439 * @param { sharedTransitionOptions } options - Parameters of the shared element transition animation. 27440 * @returns { T } 27441 * @syscap SystemCapability.ArkUI.ArkUI.Full 27442 * @crossplatform 27443 * @since 10 27444 */ 27445 /** 27446 * If the components of the two pages are configured with the same ID. 27447 * The shared element transition is performed during transition. 27448 * If the parameter is set to an empty string, the shared element transition does not occur. 27449 * For details about the options parameter, see the options parameter description. 27450 * 27451 * @param { string } id - Transition of the shared element. 27452 * <br>If the same **id** value is configured for a component on the two pages, 27453 * <br>this component is considered as a shared element of the pages. 27454 * <br>If the **id** value is an empty string, no transition will be applied to the component. 27455 * @param { sharedTransitionOptions } options - Parameters of the shared element transition animation. 27456 * @returns { T } 27457 * @syscap SystemCapability.ArkUI.ArkUI.Full 27458 * @crossplatform 27459 * @atomicservice 27460 * @since arkts {'1.1':'11','1.2':'20'} 27461 * @arkts 1.1&1.2 27462 */ 27463 sharedTransition(id: string, options?: sharedTransitionOptions): T; 27464 27465 /** 27466 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 27467 * 27468 * @param { Direction } value 27469 * @returns { T } 27470 * @syscap SystemCapability.ArkUI.ArkUI.Full 27471 * @since 7 27472 */ 27473 /** 27474 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 27475 * 27476 * @param { Direction } value 27477 * @returns { T } 27478 * @syscap SystemCapability.ArkUI.ArkUI.Full 27479 * @form 27480 * @since 9 27481 */ 27482 /** 27483 * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). 27484 * 27485 * @param { Direction } value 27486 * @returns { T } 27487 * @syscap SystemCapability.ArkUI.ArkUI.Full 27488 * @crossplatform 27489 * @form 27490 * @since 10 27491 */ 27492 /** 27493 * Sets how elements are laid out along the main axis of the container. 27494 * Default value: **Direction.Auto**. 27495 * 27496 * @param { Direction } value 27497 * @returns { T } 27498 * @syscap SystemCapability.ArkUI.ArkUI.Full 27499 * @crossplatform 27500 * @form 27501 * @atomicservice 27502 * @since arkts {'1.1':'11','1.2':'20'} 27503 * @arkts 1.1&1.2 27504 */ 27505 direction(value: Direction): T; 27506 27507 /** 27508 * align 27509 * 27510 * @param { Alignment } value 27511 * @returns { T } 27512 * @syscap SystemCapability.ArkUI.ArkUI.Full 27513 * @since 7 27514 */ 27515 /** 27516 * align 27517 * 27518 * @param { Alignment } value 27519 * @returns { T } 27520 * @syscap SystemCapability.ArkUI.ArkUI.Full 27521 * @form 27522 * @since 9 27523 */ 27524 /** 27525 * align 27526 * 27527 * @param { Alignment } value 27528 * @returns { T } 27529 * @syscap SystemCapability.ArkUI.ArkUI.Full 27530 * @crossplatform 27531 * @form 27532 * @since 10 27533 */ 27534 /** 27535 * Sets the alignment mode of the component content in the drawing area. 27536 * Default value: **Alignment.Center**. 27537 * 27538 * @param { Alignment } value 27539 * @returns { T } 27540 * @syscap SystemCapability.ArkUI.ArkUI.Full 27541 * @crossplatform 27542 * @form 27543 * @atomicservice 27544 * @since arkts {'1.1':'11','1.2':'20'} 27545 * @arkts 1.1&1.2 27546 */ 27547 align(value: Alignment): T; 27548 27549 /** 27550 * align 27551 * 27552 * @param { Alignment | LocalizedAlignment } alignment 27553 * @returns { T } 27554 * @syscap SystemCapability.ArkUI.ArkUI.Full 27555 * @crossplatform 27556 * @form 27557 * @atomicservice 27558 * @since 20 27559 */ 27560 align(alignment: Alignment | LocalizedAlignment): T; 27561 27562 /** 27563 * position 27564 * 27565 * @param { Position } value 27566 * @returns { T } 27567 * @syscap SystemCapability.ArkUI.ArkUI.Full 27568 * @since 7 27569 */ 27570 /** 27571 * position 27572 * 27573 * @param { Position } value 27574 * @returns { T } 27575 * @syscap SystemCapability.ArkUI.ArkUI.Full 27576 * @form 27577 * @since 9 27578 */ 27579 /** 27580 * position 27581 * 27582 * @param { Position } value 27583 * @returns { T } 27584 * @syscap SystemCapability.ArkUI.ArkUI.Full 27585 * @crossplatform 27586 * @form 27587 * @since 10 27588 */ 27589 /** 27590 * position 27591 * 27592 * @param { Position } value 27593 * @returns { T } 27594 * @syscap SystemCapability.ArkUI.ArkUI.Full 27595 * @crossplatform 27596 * @form 27597 * @atomicservice 27598 * @since 11 27599 */ 27600 /** 27601 * Sets the absolute position of the component relative to the position of the parent component. 27602 * <br>The attribute is not available for a layout container whose width and height are zero. 27603 * 27604 * @param { Position | Edges | LocalizedEdges } value 27605 * @returns { T } 27606 * @syscap SystemCapability.ArkUI.ArkUI.Full 27607 * @crossplatform 27608 * @form 27609 * @atomicservice 27610 * @since arkts {'1.1':'12','1.2':'20'} 27611 * @arkts 1.1&1.2 27612 */ 27613 position(value: Position | Edges | LocalizedEdges): T; 27614 27615 /** 27616 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 27617 * 27618 * @param { Position } value 27619 * @returns { T } 27620 * @syscap SystemCapability.ArkUI.ArkUI.Full 27621 * @since 7 27622 */ 27623 /** 27624 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 27625 * 27626 * @param { Position } value 27627 * @returns { T } 27628 * @syscap SystemCapability.ArkUI.ArkUI.Full 27629 * @form 27630 * @since 9 27631 */ 27632 /** 27633 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 27634 * 27635 * @param { Position } value 27636 * @returns { T } 27637 * @syscap SystemCapability.ArkUI.ArkUI.Full 27638 * @crossplatform 27639 * @form 27640 * @since 10 27641 */ 27642 /** 27643 * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. 27644 * 27645 * @param { Position } value 27646 * @returns { T } 27647 * @syscap SystemCapability.ArkUI.ArkUI.Full 27648 * @crossplatform 27649 * @form 27650 * @atomicservice 27651 * @since 11 27652 */ 27653 /** 27654 * Sets the anchor for locating the component, which is used to move the component 27655 * further away from the position specified by position or offset. 27656 * 27657 * @param { Position | LocalizedPosition} value 27658 * @returns { T } 27659 * @syscap SystemCapability.ArkUI.ArkUI.Full 27660 * @crossplatform 27661 * @form 27662 * @atomicservice 27663 * @since arkts {'1.1':'12','1.2':'20'} 27664 * @arkts 1.1&1.2 27665 */ 27666 markAnchor(value: Position | LocalizedPosition): T; 27667 27668 /** 27669 * Coordinate offset relative to the layout completion position. 27670 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 27671 * 27672 * @param { Position } value 27673 * @returns { T } 27674 * @syscap SystemCapability.ArkUI.ArkUI.Full 27675 * @since 7 27676 */ 27677 /** 27678 * Coordinate offset relative to the layout completion position. 27679 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 27680 * 27681 * @param { Position } value 27682 * @returns { T } 27683 * @syscap SystemCapability.ArkUI.ArkUI.Full 27684 * @form 27685 * @since 9 27686 */ 27687 /** 27688 * Coordinate offset relative to the layout completion position. 27689 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 27690 * 27691 * @param { Position } value 27692 * @returns { T } 27693 * @syscap SystemCapability.ArkUI.ArkUI.Full 27694 * @crossplatform 27695 * @form 27696 * @since 10 27697 */ 27698 /** 27699 * Coordinate offset relative to the layout completion position. 27700 * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. 27701 * 27702 * @param { Position } value 27703 * @returns { T } 27704 * @syscap SystemCapability.ArkUI.ArkUI.Full 27705 * @crossplatform 27706 * @form 27707 * @atomicservice 27708 * @since 11 27709 */ 27710 /** 27711 * Sets the offset of the component relative to its original position. 27712 * <br>The offset attribute does not affect the layout of the parent container. 27713 * It adjusts the component position only during drawing. 27714 * 27715 * @param { Position | Edges | LocalizedEdges } value 27716 * @returns { T } 27717 * @syscap SystemCapability.ArkUI.ArkUI.Full 27718 * @crossplatform 27719 * @form 27720 * @atomicservice 27721 * @since arkts {'1.1':'12','1.2':'20'} 27722 * @arkts 1.1&1.2 27723 */ 27724 offset(value: Position | Edges | LocalizedEdges): T; 27725 27726 /** 27727 * If the value is true, the component is available and can respond to operations such as clicking. 27728 * If it is set to false, click operations are not responded. 27729 * 27730 * @param { boolean } value 27731 * @returns { T } 27732 * @syscap SystemCapability.ArkUI.ArkUI.Full 27733 * @since 7 27734 */ 27735 /** 27736 * If the value is true, the component is available and can respond to operations such as clicking. 27737 * If it is set to false, click operations are not responded. 27738 * 27739 * @param { boolean } value 27740 * @returns { T } 27741 * @syscap SystemCapability.ArkUI.ArkUI.Full 27742 * @form 27743 * @since 9 27744 */ 27745 /** 27746 * If the value is true, the component is available and can respond to operations such as clicking. 27747 * If it is set to false, click operations are not responded. 27748 * 27749 * @param { boolean } value 27750 * @returns { T } 27751 * @syscap SystemCapability.ArkUI.ArkUI.Full 27752 * @crossplatform 27753 * @form 27754 * @since 10 27755 */ 27756 /** 27757 * If the value is true, the component is available and can respond to operations such as clicking. 27758 * If it is set to false, click operations are not responded. 27759 * 27760 * @param { boolean } value 27761 * @returns { T } 27762 * @syscap SystemCapability.ArkUI.ArkUI.Full 27763 * @crossplatform 27764 * @form 27765 * @atomicservice 27766 * @since arkts {'1.1':'11','1.2':'20'} 27767 * @arkts 1.1&1.2 27768 */ 27769 enabled(value: boolean): T; 27770 27771 /** 27772 * Sets the number of occupied columns and offset columns for a specific device width type. 27773 * 27774 * @param { object } value 27775 * @returns { T } 27776 * @syscap SystemCapability.ArkUI.ArkUI.Full 27777 * @since 7 27778 * @deprecated since 9 27779 * @useinstead grid_col/GridColColumnOption and grid_row/GridRowColumnOption 27780 */ 27781 useSizeType(value: { 27782 xs?: number | { span: number; offset: number }; 27783 sm?: number | { span: number; offset: number }; 27784 md?: number | { span: number; offset: number }; 27785 lg?: number | { span: number; offset: number }; 27786 }): T; 27787 27788 /** 27789 * Specifies the alignRules of relative container 27790 * 27791 * @param { AlignRuleOption } value 27792 * @returns { T } 27793 * @syscap SystemCapability.ArkUI.ArkUI.Full 27794 * @form 27795 * @since 9 27796 */ 27797 /** 27798 * Specifies the alignRules of relative container 27799 * 27800 * @param { AlignRuleOption } value 27801 * @returns { T } 27802 * @syscap SystemCapability.ArkUI.ArkUI.Full 27803 * @crossplatform 27804 * @form 27805 * @since 10 27806 */ 27807 /** 27808 * Sets the alignment rules in the relative container. 27809 * This API is valid only when the container is RelativeContainer. 27810 * 27811 * @param { AlignRuleOption } value 27812 * @returns { T } 27813 * @syscap SystemCapability.ArkUI.ArkUI.Full 27814 * @crossplatform 27815 * @form 27816 * @atomicservice 27817 * @since arkts {'1.1':'11','1.2':'20'} 27818 * @arkts 1.1&1.2 27819 */ 27820 alignRules(value: AlignRuleOption): T; 27821 27822 /** 27823 * Sets the alignment rules in the relative container. 27824 * <br>This API is valid only when the container is RelativeContainer. 27825 * <br>This API takes the right-to-left scripts into account, using start and end instead of 27826 * left and right for alignment in the horizontal direction. Prioritize this API in aligning 27827 * child components in the relative container. 27828 * 27829 * @param { LocalizedAlignRuleOptions } alignRule 27830 * @returns { T } 27831 * @syscap SystemCapability.ArkUI.ArkUI.Full 27832 * @crossplatform 27833 * @form 27834 * @atomicservice 27835 * @since arkts {'1.1':'12','1.2':'20'} 27836 * @arkts 1.1&1.2 27837 */ 27838 alignRules(alignRule: LocalizedAlignRuleOptions): T; 27839 27840 /** 27841 * Sets the parameters of the chain in which the component is the head. 27842 * <br>This parameter has effect only when the parent container is RelativeContainer. 27843 * <br>The chain head is the first component in the chain that satisfies the chain formation rules. 27844 * In a horizontal layout, it starts from the left (or from the right in a mirrored language 27845 * layout). In a vertical layout, it starts from the top. 27846 * 27847 * @param { Axis } direction - indicates direction of the chain 27848 * @param { ChainStyle } style - indicates style of the chain 27849 * @returns { T } 27850 * @syscap SystemCapability.ArkUI.ArkUI.Full 27851 * @crossplatform 27852 * @atomicservice 27853 * @since arkts {'1.1':'12','1.2':'20'} 27854 * @arkts 1.1&1.2 27855 */ 27856 chainMode(direction: Axis, style: ChainStyle): T; 27857 27858 /** 27859 * Specifies the aspect ratio of the current component. 27860 * 27861 * @param { number } value 27862 * @returns { T } 27863 * @syscap SystemCapability.ArkUI.ArkUI.Full 27864 * @since 7 27865 */ 27866 /** 27867 * Specifies the aspect ratio of the current component. 27868 * 27869 * @param { number } value 27870 * @returns { T } 27871 * @syscap SystemCapability.ArkUI.ArkUI.Full 27872 * @form 27873 * @since 9 27874 */ 27875 /** 27876 * Specifies the aspect ratio of the current component. 27877 * 27878 * @param { number } value 27879 * @returns { T } 27880 * @syscap SystemCapability.ArkUI.ArkUI.Full 27881 * @crossplatform 27882 * @form 27883 * @since 10 27884 */ 27885 /** 27886 * Sets the aspect ratio of the component, which can be obtained using the following formula: width/height. 27887 * <br>If only width and aspectRatio are set, the height is calculated using the following formula: width/aspectRatio. 27888 * <br>If only height and aspectRatio are set, the width is calculated using the following formula: height x aspectRatio. 27889 * <br>If width, height, and aspectRatio are all set, the explicitly set height is ignored, and the effective height is 27890 * calculated using the following formula: width/aspectRatio. 27891 * <br>This parameter takes effect only when a valid value greater than 0 is specified. 27892 * 27893 * @param { number } value 27894 * @returns { T } 27895 * @syscap SystemCapability.ArkUI.ArkUI.Full 27896 * @crossplatform 27897 * @form 27898 * @atomicservice 27899 * @since arkts {'1.1':'11','1.2':'20'} 27900 * @arkts 1.1&1.2 27901 */ 27902 aspectRatio(value: number): T; 27903 27904 /** 27905 * The click effect level and scale number. 27906 * 27907 * @param { ClickEffect | null } value 27908 * @returns { T } return the component attribute. 27909 * @syscap SystemCapability.ArkUI.ArkUI.Full 27910 * @crossplatform 27911 * @since 10 27912 */ 27913 /** 27914 * The click effect level and scale number. 27915 * 27916 * @param { ClickEffect | null } value 27917 * @returns { T } return the component attribute. 27918 * @syscap SystemCapability.ArkUI.ArkUI.Full 27919 * @crossplatform 27920 * @atomicservice 27921 * @since arkts {'1.1':'11','1.2':'20'} 27922 * @arkts 1.1&1.2 27923 */ 27924 clickEffect(value: ClickEffect | null): T; 27925 27926 /** 27927 * The click effect level and scale number. 27928 * 27929 * @param { Optional<ClickEffect | null> } effect 27930 * @returns { T } return the component attribute. 27931 * @syscap SystemCapability.ArkUI.ArkUI.Full 27932 * @crossplatform 27933 * @atomicservice 27934 * @since arkts {'1.1':'18','1.2':'20'} 27935 * @arkts 1.1&1.2 27936 */ 27937 clickEffect(effect: Optional<ClickEffect | null>): T; 27938 27939 /** 27940 * After a listener is bound, the component can be dragged. After the drag occurs, a callback is triggered. 27941 * (To be triggered, press and hold for 170 milliseconds (ms)) 27942 * 27943 * @param { function } event 27944 * @returns { T } 27945 * @syscap SystemCapability.ArkUI.ArkUI.Full 27946 * @since 8 27947 */ 27948 /** 27949 * After a listener is bound, the component can be dragged. After the drag occurs, a callback is triggered. 27950 * (To be triggered, press and hold for 170 milliseconds (ms)) 27951 * 27952 * @param { function } event 27953 * @returns { T } 27954 * @syscap SystemCapability.ArkUI.ArkUI.Full 27955 * @atomicservice 27956 * @since 11 27957 */ 27958 /** 27959 * After a listener is bound, the component can be dragged. After the drag occurs, a callback is triggered. 27960 * (To be triggered, press and hold for 170 milliseconds (ms)) 27961 * 27962 * <strong>NOTE</strong>:<br> 27963 * The global builder is not supported. 27964 * 27965 * @param { function } event 27966 * @returns { T } 27967 * @syscap SystemCapability.ArkUI.ArkUI.Full 27968 * @crossplatform 27969 * @atomicservice 27970 * @since arkts {'1.1':'14','1.2':'20'} 27971 * @arkts 1.1&1.2 27972 */ 27973 onDragStart(event: (event: DragEvent, extraParams?: string) => CustomBuilder | DragItemInfo): T; 27974 27975 /** 27976 * After binding, a callback is triggered when the component is dragged to the range of the component. 27977 * 27978 * @param { function } event 27979 * @returns { T } 27980 * @syscap SystemCapability.ArkUI.ArkUI.Full 27981 * @since 8 27982 */ 27983 /** 27984 * After binding, a callback is triggered when the component is dragged to the range of the component. 27985 * 27986 * @param { function } event 27987 * @returns { T } 27988 * @syscap SystemCapability.ArkUI.ArkUI.Full 27989 * @atomicservice 27990 * @since 11 27991 */ 27992 /** 27993 * After binding, a callback is triggered when the component is dragged to the range of the component. 27994 * 27995 * @param { function } event 27996 * @returns { T } 27997 * @syscap SystemCapability.ArkUI.ArkUI.Full 27998 * @crossplatform 27999 * @atomicservice 28000 * @since arkts {'1.1':'14','1.2':'20'} 28001 * @arkts 1.1&1.2 28002 */ 28003 onDragEnter(event: (event: DragEvent, extraParams?: string) => void): T; 28004 28005 /** 28006 * After binding, a callback is triggered when the drag moves within the range of a placeable component. 28007 * 28008 * @param { function } event 28009 * @returns { T } 28010 * @syscap SystemCapability.ArkUI.ArkUI.Full 28011 * @since 8 28012 */ 28013 /** 28014 * After binding, a callback is triggered when the drag moves within the range of a placeable component. 28015 * 28016 * @param { function } event 28017 * @returns { T } 28018 * @syscap SystemCapability.ArkUI.ArkUI.Full 28019 * @atomicservice 28020 * @since 11 28021 */ 28022 /** 28023 * After binding, a callback is triggered when the drag moves within the range of a placeable component. 28024 * 28025 * @param { function } event 28026 * @returns { T } 28027 * @syscap SystemCapability.ArkUI.ArkUI.Full 28028 * @crossplatform 28029 * @atomicservice 28030 * @since arkts {'1.1':'14','1.2':'20'} 28031 * @arkts 1.1&1.2 28032 */ 28033 onDragMove(event: (event: DragEvent, extraParams?: string) => void): T; 28034 28035 /** 28036 * After binding, a callback is triggered when the component is dragged out of the component range. 28037 * 28038 * @param { function } event 28039 * @returns { T } 28040 * @syscap SystemCapability.ArkUI.ArkUI.Full 28041 * @since 8 28042 */ 28043 /** 28044 * After binding, a callback is triggered when the component is dragged out of the component range. 28045 * 28046 * @param { function } event 28047 * @returns { T } 28048 * @syscap SystemCapability.ArkUI.ArkUI.Full 28049 * @atomicservice 28050 * @since 11 28051 */ 28052 /** 28053 * After binding, a callback is triggered when the component is dragged out of the component range. 28054 * 28055 * @param { function } event 28056 * @returns { T } 28057 * @syscap SystemCapability.ArkUI.ArkUI.Full 28058 * @crossplatform 28059 * @atomicservice 28060 * @since arkts {'1.1':'14','1.2':'20'} 28061 * @arkts 1.1&1.2 28062 */ 28063 onDragLeave(event: (event: DragEvent, extraParams?: string) => void): T; 28064 28065 /** 28066 * The component bound to this event can be used as the drag release target. 28067 * This callback is triggered when the drag behavior is stopped within the scope of the component. 28068 * 28069 * @param { function } event 28070 * @returns { T } 28071 * @syscap SystemCapability.ArkUI.ArkUI.Full 28072 * @since 8 28073 */ 28074 /** 28075 * The component bound to this event can be used as the drag release target. 28076 * This callback is triggered when the drag behavior is stopped within the scope of the component. 28077 * 28078 * @param { function } event 28079 * @returns { T } 28080 * @syscap SystemCapability.ArkUI.ArkUI.Full 28081 * @atomicservice 28082 * @since 11 28083 */ 28084 /** 28085 * The component bound to this event can be used as the drag release target. 28086 * This callback is triggered when the drag behavior is stopped within the scope of the component. 28087 * 28088 * @param { function } event 28089 * @returns { T } 28090 * @syscap SystemCapability.ArkUI.ArkUI.Full 28091 * @crossplatform 28092 * @atomicservice 28093 * @since arkts {'1.1':'14','1.2':'20'} 28094 * @arkts 1.1&1.2 28095 */ 28096 onDrop(event: (event: DragEvent, extraParams?: string) => void): T; 28097 28098 /** 28099 * The component bound to this event can be used as the drag release target. 28100 * This callback is triggered when the drag behavior is stopped within the scope of the component. 28101 * 28102 * @param { OnDragEventCallback } eventCallback - event callback. 28103 * @param { DropOptions } [dropOptions] - the drop handling options. 28104 * @returns { T } 28105 * @syscap SystemCapability.ArkUI.ArkUI.Full 28106 * @crossplatform 28107 * @atomicservice 28108 * @since arkts {'1.1':'15','1.2':'20'} 28109 * @arkts 1.1&1.2 28110 */ 28111 onDrop(eventCallback: OnDragEventCallback, dropOptions?: DropOptions): T; 28112 28113 /** 28114 * This function is called when the drag event is end. 28115 * 28116 * @param { function } event - indicates the function to be called. 28117 * @returns { T } property value of type T. 28118 * @syscap SystemCapability.ArkUI.ArkUI.Full 28119 * @since 10 28120 */ 28121 /** 28122 * This function is called when the drag event is end. 28123 * 28124 * @param { function } event - indicates the function to be called. 28125 * @returns { T } property value of type T. 28126 * @syscap SystemCapability.ArkUI.ArkUI.Full 28127 * @atomicservice 28128 * @since 11 28129 */ 28130 /** 28131 * This function is called when the drag event is end. 28132 * 28133 * @param { function } event - indicates the function to be called. 28134 * @returns { T } property value of type T. 28135 * @syscap SystemCapability.ArkUI.ArkUI.Full 28136 * @crossplatform 28137 * @atomicservice 28138 * @since arkts {'1.1':'14','1.2':'20'} 28139 * @arkts 1.1&1.2 28140 */ 28141 onDragEnd(event: (event: DragEvent, extraParams?: string) => void): T; 28142 28143 /** 28144 * Allowed drop uniformData type for this node. 28145 * 28146 * @param { Array<UniformDataType> } value - the uniformData type for this node. 28147 * @returns { T } property value of type T. 28148 * @syscap SystemCapability.ArkUI.ArkUI.Full 28149 * @crossplatform 28150 * @since 10 28151 */ 28152 /** 28153 * Allowed drop uniformData type for this node. 28154 * 28155 * @param { Array<UniformDataType> } value - the uniformData type for this node. 28156 * @returns { T } property value of type T. 28157 * @syscap SystemCapability.ArkUI.ArkUI.Full 28158 * @crossplatform 28159 * @atomicservice 28160 * @since 11 28161 */ 28162 /** 28163 * Allowed drop uniformData type for this node. 28164 * 28165 * @param { Array<UniformDataType> | null } value - the uniformData type for this node. 28166 * @returns { T } property value of type T. 28167 * @syscap SystemCapability.ArkUI.ArkUI.Full 28168 * @crossplatform 28169 * @atomicservice 28170 * @since arkts {'1.1':'12','1.2':'20'} 28171 * @arkts 1.1&1.2 28172 */ 28173 allowDrop(value: Array<UniformDataType> | null): T; 28174 28175 /** 28176 * Enable the selectable area can be dragged. 28177 * 28178 * @param { boolean } value - true means the area can be dragged, false means the area can't be dragged. 28179 * @returns { T } property value of type T. 28180 * @syscap SystemCapability.ArkUI.ArkUI.Full 28181 * @since 10 28182 */ 28183 /** 28184 * Enable the selectable area can be dragged. 28185 * 28186 * @param { boolean } value - true means the area can be dragged, false means the area can't be dragged. 28187 * The default value is false. 28188 * @returns { T } property value of type T. 28189 * @syscap SystemCapability.ArkUI.ArkUI.Full 28190 * @crossplatform 28191 * @atomicservice 28192 * @since arkts {'1.1':'11','1.2':'20'} 28193 * @arkts 1.1&1.2 28194 */ 28195 draggable(value: boolean): T; 28196 28197 /** 28198 * Set preview of the component for dragging process 28199 * 28200 * @param { CustomBuilder | DragItemInfo } value - preview of the component for dragging process 28201 * @returns { T } property value of type T. 28202 * @syscap SystemCapability.ArkUI.ArkUI.Full 28203 * @since 11 28204 */ 28205 /** 28206 * Set preview of the component for dragging process 28207 * 28208 * @param { CustomBuilder | DragItemInfo | string } value - preview of the component for dragging process 28209 * @returns { T } property value of type T. 28210 * @syscap SystemCapability.ArkUI.ArkUI.Full 28211 * @atomicservice 28212 * @since arkts {'1.1':'12','1.2':'20'} 28213 * @arkts 1.1&1.2 28214 */ 28215 dragPreview(value: CustomBuilder | DragItemInfo | string): T; 28216 28217 /** 28218 * Set preview of the component for dragging process 28219 * 28220 * @param { CustomBuilder | DragItemInfo | string } preview - preview of the component for dragging process 28221 * @param { PreviewConfiguration } config - drag preview configuration. 28222 * @returns { T } property value of type T. 28223 * @syscap SystemCapability.ArkUI.ArkUI.Full 28224 * @atomicservice 28225 * @since arkts {'1.1':'15','1.2':'20'} 28226 * @arkts 1.1&1.2 28227 */ 28228 dragPreview(preview: CustomBuilder | DragItemInfo | string, config?: PreviewConfiguration): T; 28229 28230 /** 28231 * Set the selectable area drag preview options. 28232 * 28233 * @param { DragPreviewOptions } value - preview options value. 28234 * @returns { T } property value of type T. 28235 * @syscap SystemCapability.ArkUI.ArkUI.Full 28236 * @since 11 28237 */ 28238 /** 28239 * Set the selectable area drag preview options. 28240 * 28241 * @param { DragPreviewOptions } value - preview options value. 28242 * @param { DragInteractionOptions } options - drag interaction options value. 28243 * @returns { T } property value of type T. 28244 * @syscap SystemCapability.ArkUI.ArkUI.Full 28245 * @atomicservice 28246 * @since arkts {'1.1':'12','1.2':'20'} 28247 * @arkts 1.1&1.2 28248 */ 28249 dragPreviewOptions(value: DragPreviewOptions, options?: DragInteractionOptions): T; 28250 28251 /** 28252 * After binding, a callback is triggered when the preDrag status change finished. 28253 * 28254 * @param { Callback<PreDragStatus> } callback callback - The callback will be triggered when the preDrag status change. 28255 * @returns { T } property value of type T. 28256 * @syscap SystemCapability.ArkUI.ArkUI.Full 28257 * @atomicservice 28258 * @since arkts {'1.1':'12','1.2':'20'} 28259 * @arkts 1.1&1.2 28260 */ 28261 onPreDrag(callback: Callback<PreDragStatus>): T; 28262 28263 /** 28264 * Add mask text to the current component. The layout is the same as that of the current component. 28265 * 28266 * @param { string } value 28267 * @param { object } options 28268 * @returns { T } 28269 * @syscap SystemCapability.ArkUI.ArkUI.Full 28270 * @since 7 28271 */ 28272 /** 28273 * Add mask text to the current component. The layout is the same as that of the current component. 28274 * 28275 * @param { string } value 28276 * @param { object } options 28277 * @returns { T } 28278 * @syscap SystemCapability.ArkUI.ArkUI.Full 28279 * @form 28280 * @since 9 28281 */ 28282 /** 28283 * Add mask text to the current component. The layout is the same as that of the current component. 28284 * 28285 * @param { string | CustomBuilder } value 28286 * @param { object } options 28287 * @returns { T } 28288 * @syscap SystemCapability.ArkUI.ArkUI.Full 28289 * @crossplatform 28290 * @form 28291 * @since 10 28292 */ 28293 /** 28294 * Add mask text to the current component. The layout is the same as that of the current component. 28295 * 28296 * @param { string | CustomBuilder } value 28297 * @param { object } options 28298 * @returns { T } 28299 * @syscap SystemCapability.ArkUI.ArkUI.Full 28300 * @crossplatform 28301 * @form 28302 * @atomicservice 28303 * @since 11 28304 */ 28305 /** 28306 * Add mask text to the current component. The layout is the same as that of the current component. 28307 * 28308 * @param { string | CustomBuilder | ComponentContent } value 28309 * @param { OverlayOptions } options 28310 * @returns { T } 28311 * @syscap SystemCapability.ArkUI.ArkUI.Full 28312 * @crossplatform 28313 * @form 28314 * @atomicservice 28315 * @since arkts {'1.1':'12','1.2':'20'} 28316 * @arkts 1.1&1.2 28317 */ 28318 overlay(value: string | CustomBuilder | ComponentContent, options?: OverlayOptions): T; 28319 28320 /** 28321 * Config toolbar for current component. 28322 * 28323 * @param { CustomBuilder } value 28324 * @returns { T } 28325 * @syscap SystemCapability.ArkUI.ArkUI.Full 28326 * @crossplatform 28327 * @since 20 28328 */ 28329 toolbar(value: CustomBuilder): T; 28330 28331 /** 28332 * Linear Gradient 28333 * angle: Angle of Linear Gradient. The default value is 180; 28334 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 28335 * colors: Color description for gradients. 28336 * repeating: repeating. The default value is false 28337 * 28338 * @param { object } value - Linear gradient. 28339 * @returns { T } 28340 * @syscap SystemCapability.ArkUI.ArkUI.Full 28341 * @since 7 28342 */ 28343 /** 28344 * Linear Gradient 28345 * angle: Angle of Linear Gradient. The default value is 180; 28346 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 28347 * colors: Color description for gradients. 28348 * repeating: repeating. The default value is false 28349 * 28350 * @param { object } value - Linear gradient. 28351 * @returns { T } 28352 * @syscap SystemCapability.ArkUI.ArkUI.Full 28353 * @form 28354 * @since 9 28355 */ 28356 /** 28357 * Linear Gradient 28358 * angle: Angle of Linear Gradient. The default value is 180; 28359 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 28360 * colors: Color description for gradients. 28361 * repeating: repeating. The default value is false 28362 * 28363 * @param { object } value - Linear gradient. 28364 * @returns { T } 28365 * @syscap SystemCapability.ArkUI.ArkUI.Full 28366 * @crossplatform 28367 * @form 28368 * @since 10 28369 */ 28370 /** 28371 * Linear Gradient 28372 * angle: Angle of Linear Gradient. The default value is 180; 28373 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 28374 * colors: Color description for gradients. 28375 * repeating: repeating. The default value is false 28376 * 28377 * @param { object } value - Linear gradient. 28378 * @returns { T } 28379 * @syscap SystemCapability.ArkUI.ArkUI.Full 28380 * @crossplatform 28381 * @form 28382 * @atomicservice 28383 * @since 11 28384 */ 28385 /** 28386 * Linear Gradient 28387 * angle: Angle of Linear Gradient. The default value is 180; 28388 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 28389 * colors: Color description for gradients. 28390 * repeating: repeating. The default value is false 28391 * 28392 * @param { object } value - Linear gradient. 28393 * @returns { T } 28394 * @syscap SystemCapability.ArkUI.ArkUI.Full 28395 * @crossplatform 28396 * @form 28397 * @atomicservice 28398 * @since 12 28399 */ 28400 /** 28401 * Linear Gradient 28402 * angle: Angle of Linear Gradient. The default value is 180; 28403 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 28404 * colors: Color description for gradients. 28405 * repeating: repeating. The default value is false 28406 * 28407 * @param { object } value - Linear gradient. 28408 * <br>If **options** is **undefined**, the linear gradient is disabled. 28409 * @returns { T } 28410 * @syscap SystemCapability.ArkUI.ArkUI.Full 28411 * @crossplatform 28412 * @form 28413 * @atomicservice 28414 * @since arkts {'1.1':'18','1.2':'20'} 28415 * @arkts 1.1&1.2 28416 */ 28417 linearGradient(value: LinearGradientOptions): T; 28418 28419 /** 28420 * Linear Gradient 28421 * angle: Angle of Linear Gradient. The default value is 180; 28422 * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; 28423 * colors: Color description for gradients. 28424 * repeating: repeating. The default value is false 28425 * 28426 * @param { Optional<LinearGradientOptions> } options - Linear gradient. 28427 * <br>If **options** is **undefined**, the linear gradient is disabled. 28428 * @returns { T } 28429 * @syscap SystemCapability.ArkUI.ArkUI.Full 28430 * @crossplatform 28431 * @form 28432 * @atomicservice 28433 * @since arkts {'1.1':'18','1.2':'20'} 28434 * @arkts 1.1&1.2 28435 */ 28436 linearGradient(options: Optional<LinearGradientOptions>): T; 28437 28438 /** 28439 * Creates a sweep gradient. 28440 * 28441 * @param { SweepGradientOptions } value - Sweep gradient, which can sweep around the specified 28442 * center point in the 0–360 degree range. If the rotation angle exceeds the range, a monochrome 28443 * color instead of a gradient will be drawn.<br>- **center**: center of the sweep gradient, that 28444 * is, the coordinates relative to the upper left corner of the current component. 28445 * <br>- **start**: start angle of the sweep gradient. 28446 * <br> Default value: **0**<br>If the angle is specified with a string, only the deg, grad, rad, 28447 * and turn types are supported.<br>- **end**: end angle of the sweep gradient. 28448 * <br> Default value: **0**<br>If the angle is specified with a string, only the deg, grad, rad, 28449 * and turn types are supported.<br>- **rotation**: rotation angle of the sweep gradient. 28450 * <br> Default value: **0**<br>If the angle is specified with a string, only the deg, grad, rad, 28451 * and turn types are supported.<br>- colors: array of color stops, 28452 * each of which consists of a color and its stop position. Invalid colors are automatically skipped. 28453 * <br>- **repeating**: whether the colors are repeated. 28454 * <br> Default value: **false**. 28455 * <br>**NOTE** 28456 * <br>A value less than 0 is treated as **0**. A value greater than 360 is treated as **360**. 28457 * <br>When **start**, **end**, or **rotation** is specified with a string, the string must be a number 28458 * or a number followed by one of the following units: deg, rad, grad, and turn. Valid value examples 28459 * are "90", "90deg", and "1.57rad". 28460 * @returns { T } 28461 * @syscap SystemCapability.ArkUI.ArkUI.Full 28462 * @since 7 28463 */ 28464 /** 28465 * Creates a sweep gradient. 28466 * 28467 * @param { SweepGradientOptions } value - Sweep gradient, which can sweep around the specified 28468 * center point in the 0–360 degree range. If the rotation angle exceeds the range, a monochrome 28469 * color instead of a gradient will be drawn.<br>- **center**: center of the sweep gradient, that 28470 * is, the coordinates relative to the upper left corner of the current component. 28471 * <br>- **start**: start angle of the sweep gradient. 28472 * <br> Default value: **0**<br>If the angle is specified with a string, only the deg, grad, rad, 28473 * and turn types are supported.<br>- **end**: end angle of the sweep gradient. 28474 * <br> Default value: **0**<br>If the angle is specified with a string, only the deg, grad, rad, 28475 * and turn types are supported.<br>- **rotation**: rotation angle of the sweep gradient. 28476 * <br> Default value: **0**<br>If the angle is specified with a string, only the deg, grad, rad, 28477 * and turn types are supported.<br>- colors: array of color stops, 28478 * each of which consists of a color and its stop position. Invalid colors are automatically skipped. 28479 * <br>- **repeating**: whether the colors are repeated. 28480 * <br> Default value: **false**. 28481 * <br>**NOTE** 28482 * <br>A value less than 0 is treated as **0**. A value greater than 360 is treated as **360**. 28483 * <br>When **start**, **end**, or **rotation** is specified with a string, the string must be a number 28484 * or a number followed by one of the following units: deg, rad, grad, and turn. Valid value examples 28485 * are "90", "90deg", and "1.57rad". 28486 * @returns { T } 28487 * @syscap SystemCapability.ArkUI.ArkUI.Full 28488 * @form 28489 * @since 9 28490 */ 28491 /** 28492 * Creates a sweep gradient. 28493 * 28494 * @param { SweepGradientOptions } value - Sweep gradient, which can sweep around the specified 28495 * center point in the 0–360 degree range. If the rotation angle exceeds the range, a monochrome 28496 * color instead of a gradient will be drawn.<br>- **center**: center of the sweep gradient, that 28497 * is, the coordinates relative to the upper left corner of the current component. 28498 * <br>- **start**: start angle of the sweep gradient. 28499 * <br> Default value: **0**<br>If the angle is specified with a string, only the deg, grad, rad, 28500 * and turn types are supported.<br>- **end**: end angle of the sweep gradient. 28501 * <br> Default value: **0**<br>If the angle is specified with a string, only the deg, grad, rad, 28502 * and turn types are supported.<br>- **rotation**: rotation angle of the sweep gradient. 28503 * <br> Default value: **0**<br>If the angle is specified with a string, only the deg, grad, rad, 28504 * and turn types are supported.<br>- colors: array of color stops, 28505 * each of which consists of a color and its stop position. Invalid colors are automatically skipped. 28506 * <br>- **repeating**: whether the colors are repeated. 28507 * <br> Default value: **false**. 28508 * <br>**NOTE** 28509 * <br>A value less than 0 is treated as **0**. A value greater than 360 is treated as **360**. 28510 * <br>When **start**, **end**, or **rotation** is specified with a string, the string must be a number 28511 * or a number followed by one of the following units: deg, rad, grad, and turn. Valid value examples 28512 * are "90", "90deg", and "1.57rad". 28513 * @returns { T } 28514 * @syscap SystemCapability.ArkUI.ArkUI.Full 28515 * @crossplatform 28516 * @form 28517 * @since 10 28518 */ 28519 /** 28520 * Creates a sweep gradient. 28521 * 28522 * @param { SweepGradientOptions } value - Sweep gradient, which can sweep around the specified 28523 * center point in the 0–360 degree range. If the rotation angle exceeds the range, a monochrome 28524 * color instead of a gradient will be drawn.<br>- **center**: center of the sweep gradient, that 28525 * is, the coordinates relative to the upper left corner of the current component. 28526 * <br>- **start**: start angle of the sweep gradient. 28527 * <br> Default value: **0**<br>If the angle is specified with a string, only the deg, grad, rad, 28528 * and turn types are supported.<br>- **end**: end angle of the sweep gradient. 28529 * <br> Default value: **0**<br>If the angle is specified with a string, only the deg, grad, rad, 28530 * and turn types are supported.<br>- **rotation**: rotation angle of the sweep gradient. 28531 * <br> Default value: **0**<br>If the angle is specified with a string, only the deg, grad, rad, 28532 * and turn types are supported.<br>- colors: array of color stops, 28533 * each of which consists of a color and its stop position. Invalid colors are automatically skipped. 28534 * <br>- **repeating**: whether the colors are repeated. 28535 * <br> Default value: **false**. 28536 * <br>**NOTE** 28537 * <br>A value less than 0 is treated as **0**. A value greater than 360 is treated as **360**. 28538 * <br>When **start**, **end**, or **rotation** is specified with a string, the string must be a number 28539 * or a number followed by one of the following units: deg, rad, grad, and turn. Valid value examples 28540 * are "90", "90deg", and "1.57rad". 28541 * @returns { T } 28542 * @syscap SystemCapability.ArkUI.ArkUI.Full 28543 * @crossplatform 28544 * @form 28545 * @atomicservice 28546 * @since 11 28547 */ 28548 /** 28549 * Creates a sweep gradient. 28550 * 28551 * @param { SweepGradientOptions } value - Sweep gradient, which can sweep around the specified 28552 * center point in the 0–360 degree range. If the rotation angle exceeds the range, a monochrome 28553 * color instead of a gradient will be drawn.<br>- **center**: center of the sweep gradient, that 28554 * is, the coordinates relative to the upper left corner of the current component. 28555 * <br>- **start**: start angle of the sweep gradient. 28556 * <br> Default value: **0**<br>If the angle is specified with a string, only the deg, grad, rad, 28557 * and turn types are supported.<br>- **end**: end angle of the sweep gradient. 28558 * <br> Default value: **0**<br>If the angle is specified with a string, only the deg, grad, rad, 28559 * and turn types are supported.<br>- **rotation**: rotation angle of the sweep gradient. 28560 * <br> Default value: **0**<br>If the angle is specified with a string, only the deg, grad, rad, 28561 * and turn types are supported.<br>- colors: array of color stops, 28562 * each of which consists of a color and its stop position. Invalid colors are automatically skipped. 28563 * <br>- **repeating**: whether the colors are repeated. 28564 * <br> Default value: **false**. 28565 * <br>**NOTE** 28566 * <br>A value less than 0 is treated as **0**. A value greater than 360 is treated as **360**. 28567 * <br>When **start**, **end**, or **rotation** is specified with a string, the string must be a number 28568 * or a number followed by one of the following units: deg, rad, grad, and turn. Valid value examples 28569 * are "90", "90deg", and "1.57rad". 28570 * @returns { T } 28571 * @syscap SystemCapability.ArkUI.ArkUI.Full 28572 * @crossplatform 28573 * @form 28574 * @atomicservice 28575 * @since 12 28576 */ 28577 /** 28578 * Creates a sweep gradient. 28579 * 28580 * @param { SweepGradientOptions } value - Sweep gradient, which can sweep around the specified 28581 * center point in the 0–360 degree range. If the rotation angle exceeds the range, a monochrome 28582 * color instead of a gradient will be drawn.<br>- **center**: center of the sweep gradient, that 28583 * is, the coordinates relative to the upper left corner of the current component. 28584 * <br>- **start**: start angle of the sweep gradient. 28585 * <br> Default value: **0**<br>If the angle is specified with a string, only the deg, grad, rad, 28586 * and turn types are supported.<br>- **end**: end angle of the sweep gradient. 28587 * <br> Default value: **0**<br>If the angle is specified with a string, only the deg, grad, rad, 28588 * and turn types are supported.<br>- **rotation**: rotation angle of the sweep gradient. 28589 * <br> Default value: **0**<br>If the angle is specified with a string, only the deg, grad, rad, 28590 * and turn types are supported.<br>- colors: array of color stops, 28591 * each of which consists of a color and its stop position. Invalid colors are automatically skipped. 28592 * <br>- **repeating**: whether the colors are repeated. 28593 * <br> Default value: **false**. 28594 * <br>**NOTE** 28595 * <br>A value less than 0 is treated as **0**. A value greater than 360 is treated as **360**. 28596 * <br>When **start**, **end**, or **rotation** is specified with a string, the string must be a number 28597 * or a number followed by one of the following units: deg, rad, grad, and turn. Valid value examples 28598 * are "90", "90deg", and "1.57rad". 28599 * @returns { T } 28600 * @syscap SystemCapability.ArkUI.ArkUI.Full 28601 * @crossplatform 28602 * @form 28603 * @atomicservice 28604 * @since arkts {'1.1':'18','1.2':'20'} 28605 * @arkts 1.1&1.2 28606 */ 28607 sweepGradient(value: SweepGradientOptions): T; 28608 28609 /** 28610 * Creates a sweep gradient. Compared to sweepGradient, 28611 * this API supports the **undefined** type for the **options** parameter. 28612 * 28613 * @param { Optional<SweepGradientOptions> } options - Sweep gradient. 28614 * <br>If **options** is **undefined**, the sweep gradient is disabled. 28615 * @returns { T } 28616 * @syscap SystemCapability.ArkUI.ArkUI.Full 28617 * @crossplatform 28618 * @form 28619 * @atomicservice 28620 * @since arkts {'1.1':'18','1.2':'20'} 28621 * @arkts 1.1&1.2 28622 */ 28623 sweepGradient(options: Optional<SweepGradientOptions>): T; 28624 28625 /** 28626 * Creates a radial gradient. 28627 * 28628 * @param { object } value - Radial gradient. 28629 * <br>- **center**: center of the radial gradient, that is, the coordinates relative 28630 * to the upper left corner of the current component. 28631 * <br>- **radius**: radius of the radial gradient. 28632 * <br> Value range: [0, +∞). 28633 * <br>**NOTE** 28634 * <br>A value less than 0 is treated as **0**. 28635 * <br>- colors: array of color stops, each of which consists 28636 * of a color and its stop position. Invalid colors are automatically skipped. 28637 * <br>- **repeating**: whether the colors are repeated. 28638 * <br> Default value: **false**. 28639 * @returns { T } 28640 * @syscap SystemCapability.ArkUI.ArkUI.Full 28641 * @since 7 28642 */ 28643 /** 28644 * Creates a radial gradient. 28645 * 28646 * @param { object } value - Radial gradient. 28647 * <br>- **center**: center of the radial gradient, that is, the coordinates relative 28648 * to the upper left corner of the current component. 28649 * <br>- **radius**: radius of the radial gradient. 28650 * <br> Value range: [0, +∞). 28651 * <br>**NOTE** 28652 * <br>A value less than 0 is treated as **0**. 28653 * <br>- colors: array of color stops, each of which consists 28654 * of a color and its stop position. Invalid colors are automatically skipped. 28655 * <br>- **repeating**: whether the colors are repeated. 28656 * <br> Default value: **false**. 28657 * @returns { T } 28658 * @syscap SystemCapability.ArkUI.ArkUI.Full 28659 * @form 28660 * @since 9 28661 */ 28662 /** 28663 * Creates a radial gradient. 28664 * 28665 * @param { object } value - Radial gradient. 28666 * <br>- **center**: center of the radial gradient, that is, the coordinates relative 28667 * to the upper left corner of the current component. 28668 * <br>- **radius**: radius of the radial gradient. 28669 * <br> Value range: [0, +∞). 28670 * <br>**NOTE** 28671 * <br>A value less than 0 is treated as **0**. 28672 * <br>- colors: array of color stops, each of which consists 28673 * of a color and its stop position. Invalid colors are automatically skipped. 28674 * <br>- **repeating**: whether the colors are repeated. 28675 * <br> Default value: **false**. 28676 * @returns { T } 28677 * @syscap SystemCapability.ArkUI.ArkUI.Full 28678 * @crossplatform 28679 * @form 28680 * @since 10 28681 */ 28682 /** 28683 * Creates a radial gradient. 28684 * 28685 * @param { object } value - Radial gradient. 28686 * <br>- **center**: center of the radial gradient, that is, the coordinates relative 28687 * to the upper left corner of the current component. 28688 * <br>- **radius**: radius of the radial gradient. 28689 * <br> Value range: [0, +∞). 28690 * <br>**NOTE** 28691 * <br>A value less than 0 is treated as **0**. 28692 * <br>- colors: array of color stops, each of which consists 28693 * of a color and its stop position. Invalid colors are automatically skipped. 28694 * <br>- **repeating**: whether the colors are repeated. 28695 * <br> Default value: **false**. 28696 * @returns { T } 28697 * @syscap SystemCapability.ArkUI.ArkUI.Full 28698 * @crossplatform 28699 * @form 28700 * @atomicservice 28701 * @since 11 28702 */ 28703 /** 28704 * Creates a radial gradient. 28705 * 28706 * @param { object } value - Radial gradient. 28707 * <br>- **center**: center of the radial gradient, that is, the coordinates relative 28708 * to the upper left corner of the current component. 28709 * <br>- **radius**: radius of the radial gradient. 28710 * <br> Value range: [0, +∞). 28711 * <br>**NOTE** 28712 * <br>A value less than 0 is treated as **0**. 28713 * <br>- colors: array of color stops, each of which consists 28714 * of a color and its stop position. Invalid colors are automatically skipped. 28715 * <br>- **repeating**: whether the colors are repeated. 28716 * <br> Default value: **false**. 28717 * @returns { T } 28718 * @syscap SystemCapability.ArkUI.ArkUI.Full 28719 * @crossplatform 28720 * @form 28721 * @atomicservice 28722 * @since 12 28723 */ 28724 /** 28725 * Creates a radial gradient. 28726 * 28727 * Anonymous Object Rectification. 28728 * @param { RadialGradientOptions } value - Radial gradient. 28729 * <br>- **center**: center of the radial gradient, that is, the coordinates relative 28730 * to the upper left corner of the current component. 28731 * <br>- **radius**: radius of the radial gradient. 28732 * <br> Value range: [0, +∞). 28733 * <br>**NOTE** 28734 * <br>A value less than 0 is treated as **0**. 28735 * <br>- colors: array of color stops, each of which consists 28736 * of a color and its stop position. Invalid colors are automatically skipped. 28737 * <br>- **repeating**: whether the colors are repeated. 28738 * <br> Default value: **false**. 28739 * @returns { T } 28740 * @syscap SystemCapability.ArkUI.ArkUI.Full 28741 * @crossplatform 28742 * @form 28743 * @atomicservice 28744 * @since arkts {'1.1':'18','1.2':'20'} 28745 * @arkts 1.1&1.2 28746 */ 28747 radialGradient(value: RadialGradientOptions): T; 28748 28749 /** 28750 * Creates a radial gradient. Compared to radialGradient, 28751 * this API supports the **undefined** type for the **options** parameter. 28752 * 28753 * @param { Optional<RadialGradientOptions> } options - Radial gradient. 28754 * <br>If **options** is **undefined**, the radial gradient is disabled. 28755 * @returns { T } 28756 * @syscap SystemCapability.ArkUI.ArkUI.Full 28757 * @crossplatform 28758 * @form 28759 * @atomicservice 28760 * @since arkts {'1.1':'18','1.2':'20'} 28761 * @arkts 1.1&1.2 28762 */ 28763 radialGradient(options: Optional<RadialGradientOptions>): T; 28764 28765 /** 28766 * Set the motion path of the component. 28767 * 28768 * @param { MotionPathOptions } value - Motion path of the component. 28769 * @returns { T } 28770 * @syscap SystemCapability.ArkUI.ArkUI.Full 28771 * @since 7 28772 */ 28773 /** 28774 * Set the motion path of the component. 28775 * 28776 * @param { MotionPathOptions } value - Motion path of the component. 28777 * @returns { T } 28778 * @syscap SystemCapability.ArkUI.ArkUI.Full 28779 * @crossplatform 28780 * @since 10 28781 */ 28782 /** 28783 * Set the motion path of the component. 28784 * 28785 * @param { MotionPathOptions } value - Motion path of the component. 28786 * @returns { T } 28787 * @syscap SystemCapability.ArkUI.ArkUI.Full 28788 * @crossplatform 28789 * @atomicservice 28790 * @since arkts {'1.1':'11','1.2':'20'} 28791 * @arkts 1.1&1.2 28792 */ 28793 motionPath(value: MotionPathOptions): T; 28794 28795 /** 28796 * Applies a shadow effect to the component. 28797 * 28798 * @param { ShadowOptions } value - Shadow of the component. 28799 * <br>When the value type is **ShadowOptions**, the blur radius, shadow color, 28800 * and offset along the x-axis and y-axis can be specified. 28801 * @returns { T } 28802 * @syscap SystemCapability.ArkUI.ArkUI.Full 28803 * @since 7 28804 */ 28805 /** 28806 * Applies a shadow effect to the component. 28807 * 28808 * @param { ShadowOptions } value - Shadow of the component. 28809 * <br>When the value type is **ShadowOptions**, the blur radius, shadow color, 28810 * and offset along the x-axis and y-axis can be specified. 28811 * @returns { T } 28812 * @syscap SystemCapability.ArkUI.ArkUI.Full 28813 * @form 28814 * @since 9 28815 */ 28816 /** 28817 * Applies a shadow effect to the component. 28818 * 28819 * @param { ShadowOptions | ShadowStyle } value - Shadow of the component. 28820 * <br>When the value type is **ShadowOptions**, the blur radius, shadow color, 28821 * and offset along the x-axis and y-axis can be specified. 28822 * <br>When the value type is **ShadowStyle**, the shadow style can be specified. 28823 * @returns { T } 28824 * @syscap SystemCapability.ArkUI.ArkUI.Full 28825 * @crossplatform 28826 * @form 28827 * @since 10 28828 */ 28829 /** 28830 * Applies a shadow effect to the component. 28831 * 28832 * @param { ShadowOptions | ShadowStyle } value - Shadow of the component. 28833 * <br>When the value type is **ShadowOptions**, the blur radius, shadow color, 28834 * and offset along the x-axis and y-axis can be specified. 28835 * <br>When the value type is **ShadowStyle**, the shadow style can be specified. 28836 * @returns { T } 28837 * @syscap SystemCapability.ArkUI.ArkUI.Full 28838 * @crossplatform 28839 * @form 28840 * @atomicservice 28841 * @since arkts {'1.1':'11','1.2':'20'} 28842 * @arkts 1.1&1.2 28843 */ 28844 shadow(value: ShadowOptions | ShadowStyle): T; 28845 28846 /** 28847 * Applies a shadow effect to the component. 28848 * Compared to {@link shadow}, this API supports the **undefined** type for the **options** parameter. 28849 * 28850 * @param { Optional<ShadowOptions | ShadowStyle> } options - Shadow of the component. 28851 * <br>When the value type is **ShadowOptions**, the blur radius, shadow color, 28852 * and offset along the x-axis and y-axis can be specified. 28853 * <br>When the value type is **ShadowStyle**, the shadow style can be specified. 28854 * <br>If **options** is **undefined**, the component reverts to its original effect with no shadow. 28855 * @returns { T } 28856 * @syscap SystemCapability.ArkUI.ArkUI.Full 28857 * @crossplatform 28858 * @form 28859 * @atomicservice 28860 * @since arkts {'1.1':'18','1.2':'20'} 28861 * @arkts 1.1&1.2 28862 */ 28863 shadow(options: Optional<ShadowOptions | ShadowStyle>): T; 28864 28865 /** 28866 * Defines how the component's content (including the content of it child components) 28867 * is blended with the existing content on the canvas (possibly offscreen canvas) below. 28868 * 28869 * @param { BlendMode } value - Blend mode. 28870 * <br>Default value: **BlendMode.NONE**. 28871 * <br>**NOTE** 28872 * <br>When **BlendMode.NONE** is used, the blend effect is **BlendMode.SRC_OVER** 28873 * by default, and **BlendApplyType** does not take effect. 28874 * @param { BlendApplyType } [type] - Whether the blend mode is implemented offscreen. 28875 * <br>Default value: **BlendApplyType.FAST**. 28876 * <br>**NOTE** 28877 * <br>1. **BlendApplyType.FAST**: The blend mode is not implemented offscreen. 28878 * <br>2. **BlendApplyType.OFFSCREEN**: An offscreen canvas of the size of the current component 28879 * is created. The content of the current component (including child components) is then drawn 28880 * onto the offscreen canvas, and blended with the existing content on the canvas below using 28881 * the specified blend mode. This approach may cause issues with screen capture for APIs such 28882 * as linearGradientBlur<sup>12+</sup>, backgroundEffect, and brightness. 28883 * @returns { T } 28884 * @syscap SystemCapability.ArkUI.ArkUI.Full 28885 * @crossplatform 28886 * @form 28887 * @since 11 28888 */ 28889 /** 28890 * Defines how the component's content (including the content of it child components) 28891 * is blended with the existing content on the canvas (possibly offscreen canvas) below. 28892 * 28893 * @param { BlendMode } value - Blend mode. 28894 * <br>Default value: **BlendMode.NONE**. 28895 * <br>**NOTE** 28896 * <br>When **BlendMode.NONE** is used, the blend effect is **BlendMode.SRC_OVER** 28897 * by default, and **BlendApplyType** does not take effect. 28898 * @param { BlendApplyType } [type] - Whether the blend mode is implemented offscreen. 28899 * <br>Default value: **BlendApplyType.FAST**. 28900 * <br>**NOTE** 28901 * <br>1. **BlendApplyType.FAST**: The blend mode is not implemented offscreen. 28902 * <br>2. **BlendApplyType.OFFSCREEN**: An offscreen canvas of the size of the current component 28903 * is created. The content of the current component (including child components) is then drawn 28904 * onto the offscreen canvas, and blended with the existing content on the canvas below using 28905 * the specified blend mode. This approach may cause issues with screen capture for APIs such 28906 * as linearGradientBlur<sup>12+</sup>, backgroundEffect, and brightness. 28907 * @returns { T } 28908 * @syscap SystemCapability.ArkUI.ArkUI.Full 28909 * @crossplatform 28910 * @form 28911 * @atomicservice 28912 * @since arkts {'1.1':'12','1.2':'20'} 28913 * @arkts 1.1&1.2 28914 */ 28915 blendMode(value: BlendMode, type?: BlendApplyType): T; 28916 28917 /** 28918 * Defines how the component's content (including the content of it child components) is 28919 * blended with the existing content on the canvas (possibly offscreen canvas) below. 28920 * Compared to blendMode<sup>11+</sup>, this API supports the **undefined** 28921 * type for the **mode** parameter. 28922 * 28923 * @param { Optional<BlendMode> } mode - Blend mode. 28924 * <br>Default value: **BlendMode.NONE**. 28925 * <br>If **mode** is **undefined**, the component reverts to its original effect of not 28926 * enabling offscreen rendering as a whole before blending with the parent component. 28927 * <br>**NOTE** 28928 * <br>When **BlendMode.NONE** is used, the blend effect is **BlendMode.SRC_OVER** 28929 * by default, and **BlendApplyType** does not take effect. 28930 * @param { BlendApplyType } [type] - Whether the blend mode is implemented offscreen. 28931 * <br>Default value: **BlendApplyType.FAST**. 28932 * <br>**NOTE** 28933 * <br>1. **BlendApplyType.FAST**: The blend mode is not implemented offscreen. 28934 * <br>2. **BlendApplyType.OFFSCREEN**: An offscreen canvas of the size of the current component 28935 * is created. The content of the current component (including child components) is then drawn 28936 * onto the offscreen canvas, and blended with the existing content on the canvas below using 28937 * the specified blend mode. This approach may cause issues with screen capture for APIs such 28938 * as linearGradientBlur<sup>12+</sup>, backgroundEffect, and brightness. 28939 * @returns { T } 28940 * @syscap SystemCapability.ArkUI.ArkUI.Full 28941 * @crossplatform 28942 * @form 28943 * @atomicservice 28944 * @since arkts {'1.1':'18','1.2':'20'} 28945 * @arkts 1.1&1.2 28946 */ 28947 blendMode(mode: Optional<BlendMode>, type?: BlendApplyType): T; 28948 28949 /** 28950 * Add a blendMode effect to the current component.Cannot be used together with the blendMode interface. 28951 * 28952 * @param { BlendMode | Blender } effect - When the effect type is BlendMode type, define Different hybrid modes. 28953 * When the effect type is Blender type, Define the corresponding blending effect. 28954 * @param { BlendApplyType } [type] - Different blend apply type 28955 * @returns { T } 28956 * @syscap SystemCapability.ArkUI.ArkUI.Full 28957 * @systemapi 28958 * @form 28959 * @since arkts {'1.1':'13','1.2':'20'} 28960 * @arkts 1.1&1.2 28961 */ 28962 advancedBlendMode(effect: BlendMode | Blender, type?: BlendApplyType): T; 28963 28964 /** 28965 * Sets whether to clip the areas of child components that extend beyond this component's boundaries, 28966 * That is, whether to perform clipping based on the edge contour of the parent container. 28967 * 28968 * @param { boolean } value - Whether to perform clipping based on the edge contour of the parent container. 28969 * <br>Default value: **false**. 28970 * <br>**true**: Perform clipping. **false**: Do not perform clipping. 28971 * <br>If this parameter is set to **true**. 28972 * <br>child components exceeding the current component's bounds will not respond to bound gesture events. 28973 * @returns { T } 28974 * @syscap SystemCapability.ArkUI.ArkUI.Full 28975 * @crossplatform 28976 * @form 28977 * @atomicservice 28978 * @since arkts {'1.1':'12','1.2':'20'} 28979 * @arkts 1.1&1.2 28980 */ 28981 clip(value: boolean): T; 28982 28983 /** 28984 * Sets whether to clip the areas of child components that extend beyond this component's boundaries, 28985 * That is, whether to perform clipping based on the edge contour of the parent container. 28986 * This API supports the **undefined** type for the **clip** parameter. 28987 * 28988 * @param { Optional<boolean> } clip - Whether to perform clipping based on the edge contour of the parent container. 28989 * <br>Default value: **false**. 28990 * <br>If this parameter is set to **true**, 28991 * child components exceeding the current component's bounds will not respond to bound gesture events. 28992 * <br>If **clip** is set to **undefined**, clipping is disabled, and child components are not clipped. 28993 * @returns { T } 28994 * @syscap SystemCapability.ArkUI.ArkUI.Full 28995 * @crossplatform 28996 * @form 28997 * @atomicservice 28998 * @since arkts {'1.1':'18','1.2':'20'} 28999 * @arkts 1.1&1.2 29000 */ 29001 clip(clip: Optional<boolean>): T; 29002 29003 /** 29004 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 29005 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 29006 * 29007 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value - Clip mode. 29008 * <br>If the value is a shape attribute, the component is clipped based on the specified shape. 29009 * <br>If the value is of the Boolean type, 29010 * it specifies whether to clip the component based on the boundaries of the parent container. 29011 * <br>Default value: **false**. 29012 * <br>If the value is a shape attribute, the clipped area can still respond to bound gesture events. 29013 * <br>If the value is of the Boolean type, the clipped area will not respond to bound gesture events. 29014 * @returns { T } 29015 * @syscap SystemCapability.ArkUI.ArkUI.Full 29016 * @since 7 29017 */ 29018 /** 29019 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 29020 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 29021 * 29022 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value - Clip mode. 29023 * <br>If the value is a shape attribute, the component is clipped based on the specified shape. 29024 * <br>If the value is of the Boolean type, 29025 * it specifies whether to clip the component based on the boundaries of the parent container. 29026 * <br>Default value: **false**. 29027 * <br>If the value is a shape attribute, the clipped area can still respond to bound gesture events. 29028 * <br>If the value is of the Boolean type, the clipped area will not respond to bound gesture events. 29029 * @returns { T } 29030 * @syscap SystemCapability.ArkUI.ArkUI.Full 29031 * @form 29032 * @since 9 29033 */ 29034 /** 29035 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 29036 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 29037 * 29038 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value - Clip mode. 29039 * <br>If the value is a shape attribute, the component is clipped based on the specified shape. 29040 * <br>If the value is of the Boolean type, 29041 * it specifies whether to clip the component based on the boundaries of the parent container. 29042 * <br>Default value: **false**. 29043 * <br>If the value is a shape attribute, the clipped area can still respond to bound gesture events. 29044 * <br>If the value is of the Boolean type, the clipped area will not respond to bound gesture events. 29045 * @returns { T } 29046 * @syscap SystemCapability.ArkUI.ArkUI.Full 29047 * @crossplatform 29048 * @form 29049 * @since 10 29050 */ 29051 /** 29052 * When the parameter is of the Shape type, the current component is cropped according to the specified shape. 29053 * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. 29054 * 29055 * @param { boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute } value - Clip mode. 29056 * <br>If the value is a shape attribute, the component is clipped based on the specified shape. 29057 * <br>If the value is of the Boolean type, 29058 * it specifies whether to clip the component based on the boundaries of the parent container. 29059 * <br>Default value: **false**. 29060 * <br>If the value is a shape attribute, the clipped area can still respond to bound gesture events. 29061 * <br>If the value is of the Boolean type, the clipped area will not respond to bound gesture events. 29062 * @returns { T } 29063 * @syscap SystemCapability.ArkUI.ArkUI.Full 29064 * @crossplatform 29065 * @form 29066 * @atomicservice 29067 * @since 11 29068 * @deprecated since 12 29069 * @useinstead CommonMethod#clipShape 29070 */ 29071 clip(value: boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute): T; 29072 29073 /** 29074 * Clips this component based on the given shape. 29075 * 29076 * @param { CircleShape | EllipseShape | PathShape | RectShape } value - Shape that the component to be clipped into. 29077 * <br>The clipped area remains responsive to bound gesture events. 29078 * @returns { T } 29079 * @syscap SystemCapability.ArkUI.ArkUI.Full 29080 * @crossplatform 29081 * @form 29082 * @atomicservice 29083 * @since arkts {'1.1':'12','1.2':'20'} 29084 * @arkts 1.1&1.2 29085 */ 29086 clipShape(value: CircleShape | EllipseShape | PathShape | RectShape): T; 29087 29088 /** 29089 * Sets whether to clip this component based on the given shape. 29090 * Compared to {@link clipShape}, this API supports the **undefined** type for the **shape** parameter. 29091 * 29092 * @param { Optional<CircleShape | EllipseShape | PathShape | RectShape> } shape - Shape that the component to 29093 * <br>be clipped into. 29094 * <br>The clipped area remains responsive to bound gesture events. 29095 * <br>If **shape** is set to **undefined**, the previous value is retained. 29096 * @returns { T } 29097 * @syscap SystemCapability.ArkUI.ArkUI.Full 29098 * @crossplatform 29099 * @form 29100 * @atomicservice 29101 * @since arkts {'1.1':'18','1.2':'20'} 29102 * @arkts 1.1&1.2 29103 */ 29104 clipShape(shape: Optional<CircleShape | EllipseShape | PathShape | RectShape>): T; 29105 29106 /** 29107 * Adds a mask to the component to indicate the progress. 29108 * 29109 * @param { ProgressMask } value - Mask to add to the component, which allows for dynamic 29110 * adjustment of progress, maximum value, and color settings. 29111 * @returns { T } 29112 * @syscap SystemCapability.ArkUI.ArkUI.Full 29113 * @crossplatform 29114 * @atomicservice 29115 * @since arkts {'1.1':'12','1.2':'20'} 29116 * @arkts 1.1&1.2 29117 */ 29118 mask(value: ProgressMask): T; 29119 29120 /** 29121 * Adds a mask to the component to indicate the progress. Compared to mask<sup>12+</sup>, 29122 * this API supports the **undefined** type for the **mask** parameter. 29123 * 29124 * @param { Optional<ProgressMask> } mask - Mask to add to the component, which allows for dynamic 29125 * adjustment of progress, maximum value, and color settings.<br>If **mask** is set to **undefined**, 29126 * the component to revert to its original effect without the mask to indicate the progress. 29127 * @returns { T } 29128 * @syscap SystemCapability.ArkUI.ArkUI.Full 29129 * @crossplatform 29130 * @atomicservice 29131 * @since arkts {'1.1':'18','1.2':'20'} 29132 * @arkts 1.1&1.2 29133 */ 29134 mask(mask: Optional<ProgressMask>): T; 29135 29136 /** 29137 * Applies a mask of the specified shape to the current assembly. 29138 * 29139 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value 29140 * @returns { T } 29141 * @syscap SystemCapability.ArkUI.ArkUI.Full 29142 * @since 7 29143 */ 29144 /** 29145 * Applies a mask of the specified shape to the current assembly. 29146 * 29147 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value - indicates the shape of the mask. 29148 * @returns { T } 29149 * @syscap SystemCapability.ArkUI.ArkUI.Full 29150 * @form 29151 * @since 9 29152 */ 29153 /** 29154 * Applies a mask of the specified shape to the current assembly. 29155 * 29156 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value - indicates the shape of the mask. 29157 * @returns { T } 29158 * @syscap SystemCapability.ArkUI.ArkUI.Full 29159 * @crossplatform 29160 * @form 29161 * @since 10 29162 */ 29163 /** 29164 * Applies a mask of the specified shape to the current assembly. 29165 * 29166 * @param { CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask } value - indicates the shape of the mask. 29167 * @returns { T } 29168 * @syscap SystemCapability.ArkUI.ArkUI.Full 29169 * @crossplatform 29170 * @form 29171 * @atomicservice 29172 * @since 11 29173 * @deprecated since 12 29174 * @useinstead CommonMethod#maskShape 29175 */ 29176 mask(value: CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute | ProgressMask): T; 29177 29178 /** 29179 * Adds a mask of the specified shape to the component. 29180 * 29181 * @param { CircleShape | EllipseShape | PathShape | RectShape } value - Mask of the specified 29182 * shape to add to the component. 29183 * @returns { T } 29184 * @syscap SystemCapability.ArkUI.ArkUI.Full 29185 * @crossplatform 29186 * @form 29187 * @atomicservice 29188 * @since arkts {'1.1':'12','1.2':'20'} 29189 * @arkts 1.1&1.2 29190 */ 29191 maskShape(value: CircleShape | EllipseShape | PathShape | RectShape): T; 29192 29193 /** 29194 * Adds a mask of the specified shape to the component. Compared to maskShape<sup>12+</sup>, 29195 * this API supports the **undefined** type for the **shape** parameter. 29196 * 29197 * @param { Optional<CircleShape | EllipseShape | PathShape | RectShape> } shape - Mask of the specified shape to 29198 * add to the component.<br>If **shape** is set to **undefined**, the previous value is retained. 29199 * @returns { T } 29200 * @syscap SystemCapability.ArkUI.ArkUI.Full 29201 * @crossplatform 29202 * @form 29203 * @atomicservice 29204 * @since arkts {'1.1':'18','1.2':'20'} 29205 * @arkts 1.1&1.2 29206 */ 29207 maskShape(shape: Optional<CircleShape | EllipseShape | PathShape | RectShape>): T; 29208 29209 /** 29210 * Key. User can set an key to the component to identify it. 29211 * 29212 * @param { string } value 29213 * @returns { T } 29214 * @syscap SystemCapability.ArkUI.ArkUI.Full 29215 * @atomicservice 29216 * @since arkts {'1.1':'12','1.2':'20'} 29217 * @test 29218 * @arkts 1.1&1.2 29219 */ 29220 key(value: string): T; 29221 29222 /** 29223 * Id. User can set an id to the component to identify it. 29224 * 29225 * @param { string } value 29226 * @returns { T } 29227 * @syscap SystemCapability.ArkUI.ArkUI.Full 29228 * @since 8 29229 */ 29230 /** 29231 * Id. User can set an id to the component to identify it. 29232 * 29233 * @param { string } value 29234 * @returns { T } 29235 * @syscap SystemCapability.ArkUI.ArkUI.Full 29236 * @form 29237 * @since 9 29238 */ 29239 /** 29240 * Id. User can set an id to the component to identify it. 29241 * 29242 * @param { string } value 29243 * @returns { T } 29244 * @syscap SystemCapability.ArkUI.ArkUI.Full 29245 * @crossplatform 29246 * @form 29247 * @since 10 29248 */ 29249 /** 29250 * Id. User can set an id to the component to identify it. 29251 * 29252 * @param { string } value 29253 * @returns { T } 29254 * @syscap SystemCapability.ArkUI.ArkUI.Full 29255 * @crossplatform 29256 * @form 29257 * @atomicservice 29258 * @since arkts {'1.1':'11','1.2':'20'} 29259 * @arkts 1.1&1.2 29260 */ 29261 id(value: string): T; 29262 29263 /** 29264 * geometryTransition 29265 * 29266 * @param { string } id 29267 * @returns { T } 29268 * @syscap SystemCapability.ArkUI.ArkUI.Full 29269 * @since 7 29270 */ 29271 /** 29272 * geometryTransition 29273 * 29274 * @param { string } id 29275 * @returns { T } 29276 * @syscap SystemCapability.ArkUI.ArkUI.Full 29277 * @crossplatform 29278 * @since 10 29279 */ 29280 /** 29281 * geometryTransition 29282 * 29283 * @param { string } id 29284 * @returns { T } 29285 * @syscap SystemCapability.ArkUI.ArkUI.Full 29286 * @crossplatform 29287 * @atomicservice 29288 * @since arkts {'1.1':'11','1.2':'20'} 29289 * @arkts 1.1&1.2 29290 */ 29291 geometryTransition(id: string): T; 29292 /** 29293 * Shared geometry transition 29294 * 29295 * @param { string } id - geometry transition id 29296 * @param { GeometryTransitionOptions } options - Indicates the options of geometry transition. 29297 * @returns { T } 29298 * @syscap SystemCapability.ArkUI.ArkUI.Full 29299 * @crossplatform 29300 * @since 11 29301 */ 29302 /** 29303 * Shared geometry transition 29304 * 29305 * @param { string } id - geometry transition id 29306 * @param { GeometryTransitionOptions } options - Indicates the options of geometry transition. 29307 * @returns { T } 29308 * @syscap SystemCapability.ArkUI.ArkUI.Full 29309 * @crossplatform 29310 * @atomicservice 29311 * @since arkts {'1.1':'12','1.2':'20'} 29312 * @arkts 1.1&1.2 29313 */ 29314 geometryTransition(id: string, options?: GeometryTransitionOptions): T; 29315 29316 /** 29317 * Tips control 29318 * 29319 * @param { TipsMessageType } message 29320 * @param { TipsOptions } [options] 29321 * @returns { T } 29322 * @syscap SystemCapability.ArkUI.ArkUI.Full 29323 * @crossplatform 29324 * @atomicservice 29325 * @since arkts {'1.1':'19','1.2':'20'} 29326 * @arkts 1.1&1.2 29327 */ 29328 bindTips(message: TipsMessageType, options?: TipsOptions): T; 29329 29330 /** 29331 * Popup control 29332 * 29333 * @param { boolean } show 29334 * @param { PopupOptions } popup 29335 * @returns { T } 29336 * @syscap SystemCapability.ArkUI.ArkUI.Full 29337 * @since 7 29338 */ 29339 /** 29340 * Popup control 29341 * 29342 * @param { boolean } show 29343 * @param { PopupOptions | CustomPopupOptions } popup 29344 * @returns { T } 29345 * @syscap SystemCapability.ArkUI.ArkUI.Full 29346 * @since 8 29347 */ 29348 /** 29349 * Popup control 29350 * <p><strong>NOTE</strong>: 29351 * <br>The popup can be displayed only after the entire page is fully constructed. Therefore, to avoid incorrect 29352 * display positions and shapes, do not set this parameter to true while the page is still being constructed. 29353 * </p> 29354 * 29355 * @param { boolean } show - Whether to show the popup, default is false. 29356 * @param { PopupOptions | CustomPopupOptions } popup 29357 * @returns { T } 29358 * @syscap SystemCapability.ArkUI.ArkUI.Full 29359 * @crossplatform 29360 * @atomicservice 29361 * @since arkts {'1.1':'11','1.2':'20'} 29362 * @arkts 1.1&1.2 29363 */ 29364 bindPopup(show: boolean, popup: PopupOptions | CustomPopupOptions): T; 29365 29366 /** 29367 * Menu control 29368 * 29369 * @param { { value: ResourceStr; icon?: ResourceStr; action: () => void }[] | CustomBuilder } content 29370 * action: () => void }[] | CustomBuilder } content - Indicates the content of menu. 29371 * @param { MenuOptions } options 29372 * @returns { T } 29373 * @syscap SystemCapability.ArkUI.ArkUI.Full 29374 * @since 7 29375 */ 29376 /** 29377 * Menu control 29378 * 29379 * @param { { value: ResourceStr; icon?: ResourceStr; action: () => void }[] | CustomBuilder } content 29380 * action: () => void }[] | CustomBuilder } content - Indicates the content of menu. 29381 * @param { MenuOptions } options - Indicates the options of menu. 29382 * @returns { T } 29383 * @syscap SystemCapability.ArkUI.ArkUI.Full 29384 * @crossplatform 29385 * @since 10 29386 */ 29387 /** 29388 * Menu control 29389 * 29390 * @param { Array<MenuElement> | CustomBuilder } content - Indicates the content of menu. 29391 * @param { MenuOptions } options - Indicates the options of menu. 29392 * @returns { T } 29393 * @syscap SystemCapability.ArkUI.ArkUI.Full 29394 * @crossplatform 29395 * @atomicservice 29396 * @since arkts {'1.1':'11','1.2':'20'} 29397 * @arkts 1.1&1.2 29398 */ 29399 bindMenu(content: Array<MenuElement> | CustomBuilder, options?: MenuOptions): T; 29400 29401 /** 29402 * Menu control 29403 * 29404 * @param { boolean } isShow true means display menu, false means hide menu. 29405 * @param { Array<MenuElement> | CustomBuilder } content - Indicates the content of menu. 29406 * @param { MenuOptions } options - Indicates the options of menu. 29407 * @returns { T } 29408 * @syscap SystemCapability.ArkUI.ArkUI.Full 29409 * @crossplatform 29410 * @since 11 29411 */ 29412 /** 29413 * Menu control 29414 * 29415 * @param { boolean } isShow true means display menu, false means hide menu, default is false. 29416 * @param { Array<MenuElement> | CustomBuilder } content - Indicates the content of menu. 29417 * @param { MenuOptions } options - Indicates the options of menu. 29418 * @returns { T } 29419 * @syscap SystemCapability.ArkUI.ArkUI.Full 29420 * @crossplatform 29421 * @atomicservice 29422 * @since arkts {'1.1':'12','1.2':'20'} 29423 * @arkts 1.1&1.2 29424 */ 29425 bindMenu(isShow: boolean, content: Array<MenuElement> | CustomBuilder, options?: MenuOptions): T; 29426 29427 /** 29428 * ContextMenu control 29429 * 29430 * @param { CustomBuilder } content 29431 * @param { ResponseType } responseType 29432 * @param { ContextMenuOptions } options 29433 * @returns { T } 29434 * @syscap SystemCapability.ArkUI.ArkUI.Full 29435 * @since 8 29436 */ 29437 /** 29438 * ContextMenu control 29439 * 29440 * @param { CustomBuilder } content - Indicates the content of context menu. 29441 * @param { ResponseType } responseType - Indicates response type of context menu. 29442 * @param { ContextMenuOptions } options - Indicates the options of context menu. 29443 * @returns { T } 29444 * @syscap SystemCapability.ArkUI.ArkUI.Full 29445 * @crossplatform 29446 * @since 10 29447 */ 29448 /** 29449 * Binds a context menu to this component, which is displayed when the user long-presses or right-clicks the 29450 * component. Only custom menu items are supported. 29451 * 29452 * @param { CustomBuilder } content - Indicates the content of context menu. 29453 * @param { ResponseType } responseType - Indicates response type of context menu, Long pressing with a mouse device 29454 * is not supported. 29455 * @param { ContextMenuOptions } options - Indicates the options of context menu. 29456 * @returns { T } 29457 * @syscap SystemCapability.ArkUI.ArkUI.Full 29458 * @crossplatform 29459 * @atomicservice 29460 * @since arkts {'1.1':'11','1.2':'20'} 29461 * @arkts 1.1&1.2 29462 */ 29463 bindContextMenu(content: CustomBuilder, responseType: ResponseType, options?: ContextMenuOptions): T; 29464 29465 /** 29466 * Binds a context menu to the component, whose visibility is subject to the isShown settings. 29467 * 29468 * @param { boolean } isShown - true means display content, false means hide content, default is false. 29469 * <p><strong>NOTE</strong>: 29470 * <br>The menu can be displayed properly only when the related page has been constructed. If this parameter is set 29471 * to true before the construction is complete, display issues, such as misplacement, distortion, or failure to pop 29472 * up, may occur. To trigger dragging by long presses is not supported. 29473 * </p> 29474 * 29475 * @param { CustomBuilder } content - Indicates the content of context menu. 29476 * @param { ContextMenuOptions } [options] - Indicates the options of context menu. 29477 * @returns { T } 29478 * @syscap SystemCapability.ArkUI.ArkUI.Full 29479 * @crossplatform 29480 * @atomicservice 29481 * @since arkts {'1.1':'12','1.2':'20'} 29482 * @arkts 1.1&1.2 29483 */ 29484 bindContextMenu(isShown: boolean, content: CustomBuilder, options?: ContextMenuOptions): T; 29485 29486 /** 29487 * Binds a modal page to the component, whose visibility is subject to the isShow settings. 29488 * 29489 * @param { boolean } isShow - true means display content, false means hide content. 29490 * @param { CustomBuilder } builder - the content to be displayed. 29491 * @param { ModalTransition } type - transition type. 29492 * @returns { T } 29493 * @syscap SystemCapability.ArkUI.ArkUI.Full 29494 * @crossplatform 29495 * @since 10 29496 */ 29497 /** 29498 * Binds a modal page to the component, whose visibility is subject to the isShow settings. 29499 * 29500 * @param { boolean } isShow - true means display content, false means hide content. 29501 * @param { CustomBuilder } builder - the content to be displayed. 29502 * @param { ModalTransition } type - transition type. 29503 * @returns { T } 29504 * @syscap SystemCapability.ArkUI.ArkUI.Full 29505 * @crossplatform 29506 * @atomicservice 29507 * @since arkts {'1.1':'11','1.2':'20'} 29508 * @arkts 1.1&1.2 29509 */ 29510 bindContentCover(isShow: boolean, builder: CustomBuilder, type?: ModalTransition): T; 29511 29512 /** 29513 * Bind content cover 29514 * 29515 * @param { boolean } isShow - true means display content, false means hide content. 29516 * @param { CustomBuilder } builder - the content to be displayed. 29517 * @param { ContentCoverOptions } options - options of content cover. 29518 * @returns { T } 29519 * @syscap SystemCapability.ArkUI.ArkUI.Full 29520 * @crossplatform 29521 * @since 10 29522 */ 29523 /** 29524 * Binds a modal page to the component, whose visibility is subject to the isShow settings. 29525 * 29526 * @param { boolean } isShow - true means display content, false means hide content. 29527 * @param { CustomBuilder } builder - the content to be displayed. 29528 * @param { ContentCoverOptions } options - options of content cover. 29529 * @returns { T } 29530 * @syscap SystemCapability.ArkUI.ArkUI.Full 29531 * @crossplatform 29532 * @atomicservice 29533 * @since arkts {'1.1':'11','1.2':'20'} 29534 * @arkts 1.1&1.2 29535 */ 29536 bindContentCover(isShow: boolean, builder: CustomBuilder, options?: ContentCoverOptions): T; 29537 29538 /** 29539 * Binds a sheet page to the component, whose visibility is subject to the isShow settings. 29540 * 29541 * @param { boolean } isShow - true means display sheet, false means hide sheet. 29542 * @param { CustomBuilder } builder - the sheet to be displayed. 29543 * @param { SheetOptions } options - options of sheet. 29544 * @returns { T } - template type 29545 * @syscap SystemCapability.ArkUI.ArkUI.Full 29546 * @crossplatform 29547 * @since 10 29548 */ 29549 /** 29550 * Binds a sheet page to the component, whose visibility is subject to the isShow settings. 29551 * 29552 * @param { boolean } isShow - true means display sheet, false means hide sheet. 29553 * @param { CustomBuilder } builder - the sheet to be displayed. 29554 * @param { SheetOptions } options - options of sheet. 29555 * @returns { T } - template type 29556 * @syscap SystemCapability.ArkUI.ArkUI.Full 29557 * @crossplatform 29558 * @atomicservice 29559 * @since arkts {'1.1':'11','1.2':'20'} 29560 * @arkts 1.1&1.2 29561 */ 29562 bindSheet(isShow: boolean, builder: CustomBuilder, options?: SheetOptions): T; 29563 29564 /** 29565 * Sets styles for component state. 29566 * 29567 * @param { StateStyles } value 29568 * @returns { T } 29569 * @syscap SystemCapability.ArkUI.ArkUI.Full 29570 * @since 8 29571 */ 29572 /** 29573 * Sets styles for component state. 29574 * 29575 * @param { StateStyles } value 29576 * @returns { T } 29577 * @syscap SystemCapability.ArkUI.ArkUI.Full 29578 * @form 29579 * @since 9 29580 */ 29581 /** 29582 * Sets styles for component state. 29583 * 29584 * @param { StateStyles } value 29585 * @returns { T } 29586 * @syscap SystemCapability.ArkUI.ArkUI.Full 29587 * @crossplatform 29588 * @form 29589 * @since 10 29590 */ 29591 /** 29592 * Sets styles for component state. 29593 * 29594 * @param { StateStyles } value 29595 * @returns { T } 29596 * @syscap SystemCapability.ArkUI.ArkUI.Full 29597 * @crossplatform 29598 * @form 29599 * @atomicservice 29600 * @since arkts {'1.1':'11','1.2':'20'} 29601 * @arkts 1.1&1.2 29602 */ 29603 stateStyles(value: StateStyles): T; 29604 29605 /** 29606 * id for distribute identification. 29607 * 29608 * @param { number } value 29609 * @returns { T } 29610 * @syscap SystemCapability.ArkUI.ArkUI.Full 29611 * @since 8 29612 */ 29613 /** 29614 * id for distribute identification. 29615 * 29616 * @param { number } value 29617 * @returns { T } 29618 * @syscap SystemCapability.ArkUI.ArkUI.Full 29619 * @crossplatform 29620 * @atomicservice 29621 * @since arkts {'1.1':'11','1.2':'20'} 29622 * @arkts 1.1&1.2 29623 */ 29624 restoreId(value: number): T; 29625 29626 /** 29627 * Trigger a visible area change event. 29628 * 29629 * @param { Array<number> } ratios 29630 * @param { function } event 29631 * @returns { T } 29632 * @syscap SystemCapability.ArkUI.ArkUI.Full 29633 * @since 9 29634 */ 29635 /** 29636 * Trigger a visible area change event. 29637 * 29638 * @param { Array<number> } ratios 29639 * @param { function } event 29640 * @returns { T } 29641 * @syscap SystemCapability.ArkUI.ArkUI.Full 29642 * @crossplatform 29643 * @since 10 29644 */ 29645 /** 29646 * Trigger a visible area change event. 29647 * 29648 * @param { Array<number> } ratios 29649 * @param { function } event 29650 * @returns { T } 29651 * @syscap SystemCapability.ArkUI.ArkUI.Full 29652 * @crossplatform 29653 * @atomicservice 29654 * @since 11 29655 */ 29656 /** 29657 * Trigger a visible area change event. 29658 * 29659 * @param { Array<number> } ratios - Threshold array. Each threshold represents a ratio of the component's visible area to the component's total area. 29660 * The value range of the threshold is [0.0, 1.0]. 29661 * @param { VisibleAreaChangeCallback } event - Callback for visible area changes of the component. 29662 * @returns { T } 29663 * @syscap SystemCapability.ArkUI.ArkUI.Full 29664 * @crossplatform 29665 * @atomicservice 29666 * @since arkts {'1.1':'13','1.2':'20'} 29667 * @arkts 1.1&1.2 29668 */ 29669 onVisibleAreaChange(ratios: Array<number>, event: VisibleAreaChangeCallback): T; 29670 29671 29672 /** 29673 * Set or reset the callback which is triggered when the visibleArea of component changed. 29674 * The interval between two visible area change callbacks will not be less than the expected update interval. 29675 * 29676 * @param { VisibleAreaEventOptions } options - The options for the visibility event. 29677 * @param { VisibleAreaChangeCallback | undefined } event - The callback will be triggered when the visibleArea of component changed and get close to any number in ratios defined by options. 29678 * If set undefined will reset the target callback. 29679 * @syscap SystemCapability.ArkUI.ArkUI.Full 29680 * @crossplatform 29681 * @atomicservice 29682 * @since arkts {'1.1':'17','1.2':'20'} 29683 * @arkts 1.1&1.2 29684 */ 29685 onVisibleAreaApproximateChange(options: VisibleAreaEventOptions, event: VisibleAreaChangeCallback | undefined): void; 29686 29687 /** 29688 * Applies a spherical effect to the component. 29689 * 29690 * @param { number } value - Spherical degree of the component. 29691 * <br>The value ranges from 0 to 1. 29692 * <p>**NOTE**: 29693 * <br>1. If the value is **0**, the component remains unchanged. If the value is 1, the component is completely 29694 * spherical. Between **0** and **1**, a larger value indicates a higher spherical degree. A value less than 0 is 29695 * handled as the value **0**. A value greater than 1 is handled as the value **1**. 29696 * <br>2. The component's shadow and outer stroke do not support spherical effects. 29697 * <br>3. If the value is greater than 0, the component is frozen and not updated, and its content is drawn to the 29698 * transparent offscreen buffer. To update the component attributes, set the value to **0**. 29699 * </p> 29700 * 29701 * @returns { T } 29702 * @syscap SystemCapability.ArkUI.ArkUI.Full 29703 * @crossplatform 29704 * @atomicservice 29705 * @since arkts {'1.1':'12','1.2':'20'} 29706 * @arkts 1.1&1.2 29707 */ 29708 sphericalEffect(value: number): T; 29709 29710 /** 29711 * Set the spherical effect of the component. 29712 * 29713 * @param { Optional<number> } effect - The value ranges from 0 to 1. 29714 * <p>**NOTE**: 29715 * <br>1. If the value is **0**, the component remains unchanged. If the value is 1, the component is completely 29716 * spherical. Between **0** and **1**, a larger value indicates a higher spherical degree.A value less than 0 is 29717 * handled as the value **0**. A value greater than 1 is handled as the value **1**. 29718 * <br>2. The component's shadow and outer stroke do not support spherical effects. 29719 * <br>3. If the value is greater than 0, the component is frozen and not updated, and its content is drawn to the 29720 * transparent offscreen buffer. To update the component attributes, set the value to **0**. If **effect** is 29721 * **undefined**, the spherical degree reverts to **0**. 29722 * </p> 29723 * 29724 * @returns { T } 29725 * @syscap SystemCapability.ArkUI.ArkUI.Full 29726 * @crossplatform 29727 * @atomicservice 29728 * @since arkts {'1.1':'18','1.2':'20'} 29729 * @arkts 1.1&1.2 29730 */ 29731 sphericalEffect(effect: Optional<number>): T; 29732 29733 /** 29734 * Applies a light up effect to the component. 29735 * 29736 * @param { number } value - Light up degree of the component. 29737 * <br>The value ranges from 0 to 1. 29738 * <br>If the value is **0**, the component is dark. If the value is **1**, the component is fully illuminated. 29739 * <br>Between **0** and **1**, a larger value indicates higher luminance. 29740 * <br>A value less than 0 is handled as the value **0**. 29741 * <br>A value greater than 1 is handled as the value **1**. 29742 * @returns { T } 29743 * @syscap SystemCapability.ArkUI.ArkUI.Full 29744 * @crossplatform 29745 * @atomicservice 29746 * @since arkts {'1.1':'12','1.2':'20'} 29747 * @arkts 1.1&1.2 29748 */ 29749 lightUpEffect(value: number): T; 29750 29751 /** 29752 * Applies a light up effect to the component. Compared to lightUpEffect, 29753 * this API supports the **undefined** type for the **degree** parameter. 29754 * 29755 * @param { Optional<number> } degree - Light up degree of the component. 29756 * <br>The value ranges from 0 to 1. 29757 * <br>If the value is **0**, the component is dark. If the value is **1**, the component is fully illuminated. 29758 * <br>Between **0** and **1**, a larger value indicates higher luminance. 29759 * <br>A value less than 0 is handled as the value **0**. 29760 * <br>A value greater than 1 is handled as the value **1**. 29761 * <br>If **degree** is **undefined**, the light up degree reverts to **1**. 29762 * @returns { T } 29763 * @syscap SystemCapability.ArkUI.ArkUI.Full 29764 * @crossplatform 29765 * @atomicservice 29766 * @since arkts {'1.1':'18','1.2':'20'} 29767 * @arkts 1.1&1.2 29768 */ 29769 lightUpEffect(degree: Optional<number>): T; 29770 29771 /** 29772 * Applies a pixel stretch effect to the component. 29773 * 29774 * @param { PixelStretchEffectOptions } options - Pixel stretch effect options. 29775 * <br>The value includes the length by which a pixel is stretched toward the four edges. 29776 * <p>**NOTE**: 29777 * <br>1. If the length is a positive value, the original image is stretched, and the image size increases. The edge 29778 * pixels grow by the set length toward the top, bottom, left, and right edges. 29779 * <br>2. If the length is a negative value, the original image shrinks as follows, but the image size remains 29780 * unchanged: 29781 * <br>Shrinking mode: 29782 * <br>(1) The image shrinks from the four edges by the absolute value of length set through **options**. 29783 * <br>(2) The image is stretched back to the original size with edge pixels. 29784 * <br>3. Constraints on **options**: 29785 * <br>(1) The length values for the four edges must be all positive or all negative. That is, the four edges are 29786 * stretched or shrink at the same time in the same direction. 29787 * <br>(2) The length values must all be a percentage or a specific value. Combined use of the percentage and 29788 * specific value is not allowed. 29789 * <br>(3) If the input value is invalid, the image is displayed as {0, 0, 0, 0}, that is, the image is the same as 29790 * the original image. 29791 * </p> 29792 * @returns { T } 29793 * @syscap SystemCapability.ArkUI.ArkUI.Full 29794 * @crossplatform 29795 * @atomicservice 29796 * @since arkts {'1.1':'12','1.2':'20'} 29797 * @arkts 1.1&1.2 29798 */ 29799 pixelStretchEffect(options: PixelStretchEffectOptions): T; 29800 29801 /** 29802 * Applies a pixel stretch effect to the component. Compared to pixelStretchEffect, 29803 * this API supports the **undefined** type for the **options** parameter. 29804 * 29805 * @param { Optional<PixelStretchEffectOptions> } options - Pixel stretch effect options. 29806 * <br>The value includes the length by which a pixel is stretched toward the four edges. 29807 * <p>**NOTE**: 29808 * <br>1. If the length is a positive value, the original image is stretched, and the image size increases. The edge 29809 * pixels grow by the set length toward the top, bottom, left, and right edges. 29810 * <br>2. If the length is a negative value, the original image shrinks as follows, but the image size remains 29811 * unchanged: 29812 * <br>Shrinking mode: 29813 * <br>(1) The image shrinks from the four edges by the absolute value of length set through **options**. 29814 * <br>(2) The image is stretched back to the original size with edge pixels. 29815 * <br>3. Constraints on **options**: 29816 * <br>(1) The length values for the four edges must be all positive or all negative. That is, the four edges are 29817 * stretched or shrink at the same time in the same direction. 29818 * <br>(2) The length values must all be a percentage or a specific value. Combined use of the percentage and 29819 * specific value is not allowed. 29820 * <br>(3) If the input value is invalid, the image is displayed as {0, 0, 0, 0}, that is, the image is the same as 29821 * the original image. 29822 * </p> 29823 * @returns { T } 29824 * @syscap SystemCapability.ArkUI.ArkUI.Full 29825 * @crossplatform 29826 * @atomicservice 29827 * @since arkts {'1.1':'18','1.2':'20'} 29828 * @arkts 1.1&1.2 29829 */ 29830 pixelStretchEffect(options: Optional<PixelStretchEffectOptions>): T; 29831 29832 /** 29833 * Sets hot keys 29834 * 29835 * @param { string | FunctionKey } value - Character of the combination key. 29836 * @param { Array<ModifierKey> } keys - The modifier keys modify the action of key when the key are pressed at the same time. 29837 * @param { function } [action] - Callback function, triggered when the shortcut keyboard is pressed. 29838 * @returns { T } 29839 * @syscap SystemCapability.ArkUI.ArkUI.Full 29840 * @crossplatform 29841 * @since 10 29842 */ 29843 /** 29844 * Sets hot keys 29845 * 29846 * @param { string | FunctionKey } value - Character of the combination key. 29847 * @param { Array<ModifierKey> } keys - The modifier keys modify the action of key when the key are pressed at the same time. 29848 * @param { function } [action] - Callback function, triggered when the shortcut keyboard is pressed. 29849 * @returns { T } 29850 * @syscap SystemCapability.ArkUI.ArkUI.Full 29851 * @crossplatform 29852 * @atomicservice 29853 * @since arkts {'1.1':'11','1.2':'20'} 29854 * @arkts 1.1&1.2 29855 */ 29856 keyboardShortcut(value: string | FunctionKey, keys: Array<ModifierKey>, action?: () => void): T; 29857 29858 /** 29859 * Sets whether to enable accessibility grouping. 29860 * 29861 * @param { boolean } value - set group with accessibility, default value is false. 29862 * @returns { T } 29863 * @syscap SystemCapability.ArkUI.ArkUI.Full 29864 * @crossplatform 29865 * @since 10 29866 */ 29867 /** 29868 * Sets whether to enable accessibility grouping. 29869 * 29870 * @param { boolean } value - set group with accessibility, default value is false. 29871 * @returns { T } 29872 * @syscap SystemCapability.ArkUI.ArkUI.Full 29873 * @crossplatform 29874 * @atomicservice 29875 * @since 11 29876 */ 29877 /** 29878 * Sets whether to enable accessibility grouping. 29879 * 29880 * <p><strong>NOTE</strong> 29881 * <br>Whether to enable accessibility grouping. When accessibility grouping is enabled, 29882 * <br>the component and all its children are treated as a single selectable unit, and the accessibility 29883 * <br>service will no longer focus on the individual child components.</p> 29884 * 29885 * @param { boolean } value - set group with accessibility, default value is false. 29886 * @returns { T } 29887 * @syscap SystemCapability.ArkUI.ArkUI.Full 29888 * @crossplatform 29889 * @form 29890 * @atomicservice 29891 * @since arkts {'1.1':'12','1.2':'20'} 29892 * @arkts 1.1&1.2 29893 */ 29894 accessibilityGroup(value: boolean): T; 29895 29896 /** 29897 * Sets whether to enable accessibility grouping. 29898 * 29899 * <p><strong>NOTE</strong> 29900 * <br>If accessibility grouping is enabled and the component does not contain a universal text attribute 29901 * <br>or an accessibility text attribute, the system will concatenate the universal text attributes of 29902 * <br>its child components to form a merged text for the component. If a child component lacks a universal 29903 * <br>text attribute, it will be ignored in the concatenation process. 29904 * 29905 * <br>When accessibilityPreferred is set to true, the system will prioritize concatenating the accessibility 29906 * <br>text attributes of the child components to form the merged text. If a child component lacks an 29907 * <br>accessibility text attribute, the system will continue to concatenate its universal text attribute. 29908 * <br>If a child component lacks both, it will be ignored.</p> 29909 * 29910 * @param { boolean } isGroup - set group with accessibility, default value is false. 29911 * @param { AccessibilityOptions } accessibilityOptions - accessibilityOptions for accessibility, default value is false. 29912 * @returns { T } 29913 * @syscap SystemCapability.ArkUI.ArkUI.Full 29914 * @crossplatform 29915 * @form 29916 * @atomicservice 29917 * @since arkts {'1.1':'14','1.2':'20'} 29918 * @arkts 1.1&1.2 29919 */ 29920 accessibilityGroup(isGroup: boolean, accessibilityOptions: AccessibilityOptions): T; 29921 29922 /** 29923 * Sets the accessibility text. 29924 * 29925 * @param { string } value - set accessibility text, default value is "". 29926 * @returns { T } 29927 * @syscap SystemCapability.ArkUI.ArkUI.Full 29928 * @crossplatform 29929 * @since 10 29930 */ 29931 /** 29932 * Sets the accessibility text. 29933 * 29934 * @param { string } value - set accessibility text, default value is "". 29935 * @returns { T } 29936 * @syscap SystemCapability.ArkUI.ArkUI.Full 29937 * @crossplatform 29938 * @atomicservice 29939 * @since 11 29940 */ 29941 /** 29942 * Sets the accessibility text. 29943 * When a component does not contain a text attribute, you can use this API to set an accessibility 29944 * text attribute, so that accessibility services can announce the specified content for the component. 29945 * 29946 * @param { string } value - set accessibility text, default value is "". 29947 * @returns { T } 29948 * @syscap SystemCapability.ArkUI.ArkUI.Full 29949 * @crossplatform 29950 * @form 29951 * @atomicservice 29952 * @since arkts {'1.1':'12','1.2':'20'} 29953 * @arkts 1.1&1.2 29954 */ 29955 accessibilityText(value: string): T; 29956 29957 /** 29958 * Sets accessibility next focus id 29959 * @param { string } nextId - set component next accessibility focus id 29960 * @returns { T } 29961 * @syscap SystemCapability.ArkUI.ArkUI.Full 29962 * @crossplatform 29963 * @form 29964 * @atomicservice 29965 * @since arkts {'1.1':'18','1.2':'20'} 29966 * @arkts 1.1&1.2 29967 */ 29968 accessibilityNextFocusId(nextId: string): T; 29969 29970 /** 29971 * Sets the accessibility default foucs flag 29972 * @param { boolean } focus - if the component is accessibility default focus,focus set true 29973 * @returns { T } 29974 * @syscap SystemCapability.ArkUI.ArkUI.Full 29975 * @crossplatform 29976 * @form 29977 * @atomicservice 29978 * @since arkts {'1.1':'18','1.2':'20'} 29979 * @arkts 1.1&1.2 29980 */ 29981 accessibilityDefaultFocus(focus: boolean): T; 29982 29983 /** 29984 * Sets accessibility same page mode 29985 * @param { AccessibilitySamePageMode } pageMode - accessibility same page mode 29986 * @returns { T } 29987 * @syscap SystemCapability.ArkUI.ArkUI.Full 29988 * @crossplatform 29989 * @form 29990 * @atomicservice 29991 * @since arkts {'1.1':'18','1.2':'20'} 29992 * @arkts 1.1&1.2 29993 */ 29994 accessibilityUseSamePage(pageMode: AccessibilitySamePageMode): T; 29995 29996 /** 29997 * Sets accessibilityScrollTriggerable 29998 * @param { boolean } isTriggerable - set property of supporting scroll in accessibility 29999 * @returns { T } 30000 * @syscap SystemCapability.ArkUI.ArkUI.Full 30001 * @crossplatform 30002 * @form 30003 * @atomicservice 30004 * @since arkts {'1.1':'18','1.2':'20'} 30005 * @arkts 1.1&1.2 30006 */ 30007 accessibilityScrollTriggerable(isTriggerable: boolean): T; 30008 30009 /** 30010 * Sets the accessibility text. 30011 * <p><strong>NOTE</strong> 30012 * If a component has both text content and accessibility text, only the accessibility text is announced. 30013 * <br>If a component is grouped for accessibility purposes but lacks both text content and accessibility 30014 * <br>text, the screen reader will concatenate text from its child components (depth-first traversal). 30015 * <br>To prioritize accessibility text concatenation, set accessibilityPreferred in accessibilityGroup. 30016 * </p> 30017 * @param { Resource } text - set accessibility text 30018 * @returns { T } 30019 * @syscap SystemCapability.ArkUI.ArkUI.Full 30020 * @crossplatform 30021 * @form 30022 * @atomicservice 30023 * @since arkts {'1.1':'12','1.2':'20'} 30024 * @arkts 1.1&1.2 30025 */ 30026 accessibilityText(text: Resource): T; 30027 30028 /** 30029 * Sets accessibility role,role indicates the custom type of the component 30030 * @param { AccessibilityRoleType } role - set accessibility component type 30031 * @returns { T } 30032 * @syscap SystemCapability.ArkUI.ArkUI.Full 30033 * @crossplatform 30034 * @form 30035 * @atomicservice 30036 * @since arkts {'1.1':'18','1.2':'20'} 30037 * @arkts 1.1&1.2 30038 */ 30039 accessibilityRole(role: AccessibilityRoleType): T; 30040 30041 /** 30042 * Register accessibility focus callback,when the component is focused or out of focus,the callback will be executed 30043 * @param { AccessibilityFocusCallback } callback - accessibility focus callback function 30044 * @returns { T } 30045 * @syscap SystemCapability.ArkUI.ArkUI.Full 30046 * @crossplatform 30047 * @form 30048 * @atomicservice 30049 * @since arkts {'1.1':'18','1.2':'20'} 30050 * @arkts 1.1&1.2 30051 */ 30052 onAccessibilityFocus(callback: AccessibilityFocusCallback): T; 30053 30054 /** 30055 * Register accessibility action intercept callback, 30056 * when accessibility action is to be executed,the callback will be executed 30057 * @param { AccessibilityActionInterceptCallback } callback - accessibility action intercept callback function 30058 * @returns { T } 30059 * @syscap SystemCapability.ArkUI.ArkUI.Full 30060 * @crossplatform 30061 * @form 30062 * @atomicservice 30063 * @since 20 30064 */ 30065 onAccessibilityActionIntercept(callback: AccessibilityActionInterceptCallback): T; 30066 30067 /** 30068 * Sets accessibilityTextHint 30069 * 30070 * @param { string } value - set accessibility text hint 30071 * @returns { T } 30072 * @syscap SystemCapability.ArkUI.ArkUI.Full 30073 * @crossplatform 30074 * @form 30075 * @atomicservice 30076 * @since arkts {'1.1':'12','1.2':'20'} 30077 * @arkts 1.1&1.2 30078 */ 30079 accessibilityTextHint(value: string): T; 30080 30081 /** 30082 * Sets accessibilityDescription 30083 * 30084 * @param { string } value - set description of accessibility, default value is "". 30085 * @returns { T } 30086 * @syscap SystemCapability.ArkUI.ArkUI.Full 30087 * @crossplatform 30088 * @since 10 30089 */ 30090 /** 30091 * Sets accessibilityDescription 30092 * 30093 * @param { string } value - set description of accessibility, default value is "". 30094 * @returns { T } 30095 * @syscap SystemCapability.ArkUI.ArkUI.Full 30096 * @crossplatform 30097 * @atomicservice 30098 * @since 11 30099 */ 30100 /** 30101 * Sets accessibilityDescription 30102 * 30103 * @param { string } value - set description of accessibility, default value is "". 30104 * @returns { T } 30105 * @syscap SystemCapability.ArkUI.ArkUI.Full 30106 * @crossplatform 30107 * @form 30108 * @atomicservice 30109 * @since arkts {'1.1':'12','1.2':'20'} 30110 * @arkts 1.1&1.2 30111 */ 30112 accessibilityDescription(value: string): T; 30113 30114 /** 30115 * Sets accessibilityDescription 30116 * 30117 * with support for resource references using Resource. 30118 * This property provides additional context or explanation for the component, 30119 * helping users understand the action or function it performs. 30120 * <p><strong>NOTE</strong>: 30121 * <br>Reference resource of the accessibility description. You can specify further explanation 30122 * <br>of the current component, for example, possible operation consequences, especially those that 30123 * <br>cannot be learned from component attributes and accessibility text. If a component contains 30124 * <br>both text information and the accessibility description, the text is read first and then the 30125 * <br>accessibility description, when the component is selected.</p> 30126 * @param { Resource } description - set description of accessibility 30127 * @returns { T } 30128 * @syscap SystemCapability.ArkUI.ArkUI.Full 30129 * @crossplatform 30130 * @form 30131 * @atomicservice 30132 * @since arkts {'1.1':'12','1.2':'20'} 30133 * @arkts 1.1&1.2 30134 */ 30135 accessibilityDescription(description: Resource): T; 30136 30137 /** 30138 * Sets the accessibility level. 30139 * This property determines whether the component can be recognized by accessibility services. 30140 * 30141 * @param { string } value - set accessibility level, default value is auto. 30142 * @returns { T } 30143 * @syscap SystemCapability.ArkUI.ArkUI.Full 30144 * @crossplatform 30145 * @since 10 30146 */ 30147 /** 30148 * Sets the accessibility level. 30149 * This property determines whether the component can be recognized by accessibility services. 30150 * 30151 * @param { string } value - set accessibility level, default value is auto. 30152 * @returns { T } 30153 * @syscap SystemCapability.ArkUI.ArkUI.Full 30154 * @crossplatform 30155 * @atomicservice 30156 * @since 11 30157 */ 30158 /** 30159 * Sets the accessibility level. 30160 * This property determines whether the component can be recognized by accessibility services. 30161 * <p> 30162 * Accessibility level, which is used to decide whether a component can be identified by the accessibility service. 30163 * <br>The options are as follows: 30164 * <br>"auto": The component's recognizability is determined by the accessibility grouping service and ArkUI. 30165 * <br>"yes": The component can be recognized by accessibility services. 30166 * <br>"no": The component cannot be recognized by accessibility services. 30167 * <br>"no-hide-descendants": Neither the component nor its child components can be recognized by accessibility services. 30168 * <strong>NOTE</strong> 30169 * <br>When accessibilityLevel is set to "auto", the component's recognizability depends on the following factors: 30170 * <br>1. The accessibility service internally determines whether the component can be recognized. 30171 * <br>2. If the parent component's accessibilityGroup property has isGroup set to true, the accessibility service will 30172 * <br>not focus on its child components, making them unrecognizable. 30173 * <br>3. If the parent component's accessibilityLevel is set to "no-hide-descendants", the component will not be 30174 * <br>recognized by accessibility services.</p> 30175 * @param { string } value - set accessibility level, default value is auto. 30176 * @returns { T } 30177 * @syscap SystemCapability.ArkUI.ArkUI.Full 30178 * @crossplatform 30179 * @form 30180 * @atomicservice 30181 * @since arkts {'1.1':'12','1.2':'20'} 30182 * @arkts 1.1&1.2 30183 */ 30184 accessibilityLevel(value: string): T; 30185 30186 /** 30187 * Sets accessibilityVirtualNode 30188 * 30189 * @param { CustomBuilder } builder - set virtual node of accessibility 30190 * @returns { T } 30191 * @syscap SystemCapability.ArkUI.ArkUI.Full 30192 * @crossplatform 30193 * @atomicservice 30194 * @since 11 30195 */ 30196 /** 30197 * Sets accessibilityVirtualNode 30198 * 30199 * @param { CustomBuilder } builder - set virtual node of accessibility 30200 * @returns { T } 30201 * @syscap SystemCapability.ArkUI.ArkUI.Full 30202 * @crossplatform 30203 * @form 30204 * @atomicservice 30205 * @since arkts {'1.1':'12','1.2':'20'} 30206 * @arkts 1.1&1.2 30207 */ 30208 accessibilityVirtualNode(builder: CustomBuilder): T; 30209 30210 /** 30211 * Sets accessibilityChecked 30212 * 30213 * @param { boolean } isCheck - set accessibility checked status 30214 * @returns { T } 30215 * @syscap SystemCapability.ArkUI.ArkUI.Full 30216 * @crossplatform 30217 * @form 30218 * @atomicservice 30219 * @since arkts {'1.1':'13','1.2':'20'} 30220 * @arkts 1.1&1.2 30221 */ 30222 accessibilityChecked(isCheck: boolean): T; 30223 30224 /** 30225 * Sets accessibilitySelected 30226 * 30227 * @param { boolean } isSelect - set accessibility selected status 30228 * @returns { T } 30229 * @syscap SystemCapability.ArkUI.ArkUI.Full 30230 * @crossplatform 30231 * @form 30232 * @atomicservice 30233 * @since arkts {'1.1':'13','1.2':'20'} 30234 * @arkts 1.1&1.2 30235 */ 30236 accessibilitySelected(isSelect: boolean): T; 30237 30238 /** 30239 * Sets obscured 30240 * 30241 * @param { Array<ObscuredReasons> } reasons - reasons of obscuration 30242 * @returns { T } 30243 * @syscap SystemCapability.ArkUI.ArkUI.Full 30244 * @crossplatform 30245 * @since 10 30246 */ 30247 /** 30248 * Sets obscured 30249 * 30250 * @param { Array<ObscuredReasons> } reasons - reasons of obscuration 30251 * @returns { T } 30252 * @syscap SystemCapability.ArkUI.ArkUI.Full 30253 * @crossplatform 30254 * @atomicservice 30255 * @since arkts {'1.1':'11','1.2':'20'} 30256 * @arkts 1.1&1.2 30257 */ 30258 obscured(reasons: Array<ObscuredReasons>): T; 30259 30260 /** 30261 * Reuse id is used for identify the reuse type for each custom node. 30262 * 30263 * @param { string } id - The id for reusable custom node. 30264 * @returns { T } 30265 * @syscap SystemCapability.ArkUI.ArkUI.Full 30266 * @crossplatform 30267 * @since 10 30268 */ 30269 /** 30270 * Reuse id is used for identify the reuse type for each custom node. 30271 * 30272 * @param { string } id - The id for reusable custom node. 30273 * @returns { T } 30274 * @syscap SystemCapability.ArkUI.ArkUI.Full 30275 * @crossplatform 30276 * @atomicservice 30277 * @since arkts {'1.1':'11','1.2':'20'} 30278 * @arkts 1.1&1.2 30279 */ 30280 reuseId(id: string): T; 30281 30282 /** 30283 * Reuse id is used for identify the reuse type of each @ComponentV2 custom component, which can give user control of sub-component recycle and reuse. 30284 * 30285 * @param { ReuseOptions } options - The configuration parameter for reusable custom component. 30286 * @returns { T } 30287 * @syscap SystemCapability.ArkUI.ArkUI.Full 30288 * @crossplatform 30289 * @atomicservice 30290 * @since arkts {'1.1':'18','1.2':'20'} 30291 * @arkts 1.1&1.2 30292 */ 30293 reuse(options: ReuseOptions): T; 30294 30295 /** 30296 * How the final state of the component's content is rendered during its width and height animation process. 30297 * 30298 * @param { RenderFit } fitMode - How the final state of the component's content is rendered during. 30299 * <br>its width and height animation process. 30300 * <br>If **renderFit** is not set, the default value **RenderFit.TOP_LEFT** is used. 30301 * @returns { T } 30302 * @syscap SystemCapability.ArkUI.ArkUI.Full 30303 * @crossplatform 30304 * @since 10 30305 */ 30306 /** 30307 * How the final state of the component's content is rendered during its width and height animation process. 30308 * 30309 * @param { RenderFit } fitMode - How the final state of the component's content is rendered during. 30310 * <br>its width and height animation process. 30311 * <br>If **renderFit** is not set, the default value **RenderFit.TOP_LEFT** is used. 30312 * @returns { T } 30313 * @syscap SystemCapability.ArkUI.ArkUI.Full 30314 * @crossplatform 30315 * @atomicservice 30316 * @since 11 30317 */ 30318 /** 30319 * How the final state of the component's content is rendered during its width and height animation process. 30320 * 30321 * @param { RenderFit } fitMode - How the final state of the component's content is rendered during. 30322 * <br>its width and height animation process. 30323 * <br>If **renderFit** is not set, the default value **RenderFit.TOP_LEFT** is used. 30324 * @returns { T } 30325 * @syscap SystemCapability.ArkUI.ArkUI.Full 30326 * @crossplatform 30327 * @form 30328 * @atomicservice 30329 * @since arkts {'1.1':'18','1.2':'20'} 30330 * @arkts 1.1&1.2 30331 */ 30332 renderFit(fitMode: RenderFit): T; 30333 30334 /** 30335 * How the final state of the component's content is rendered during its width and height animation process. 30336 * Compared to {@link renderFit}, this API supports the **undefined** type for the **fitMode** parameter. 30337 * 30338 * @param { Optional<RenderFit> } fitMode - How the final state of the component's content is rendered during. 30339 * <br>its width and height animation process. 30340 * <br>If **fitMode** is set to **undefined**, the default value is used, 30341 * which is equivalent to **RenderFit.TOP_LEFT**. 30342 * @returns { T } 30343 * @syscap SystemCapability.ArkUI.ArkUI.Full 30344 * @crossplatform 30345 * @form 30346 * @atomicservice 30347 * @since arkts {'1.1':'18','1.2':'20'} 30348 * @arkts 1.1&1.2 30349 */ 30350 renderFit(fitMode: Optional<RenderFit>): T; 30351 30352 /** 30353 * Sets the attribute modifier. 30354 * 30355 * @param { AttributeModifier<T> } modifier 30356 * @returns { T } 30357 * @syscap SystemCapability.ArkUI.ArkUI.Full 30358 * @crossplatform 30359 * @since 11 30360 */ 30361 /** 30362 * Sets the attribute modifier. 30363 * 30364 * @param { AttributeModifier<T> } modifier 30365 * The if/else syntax is supported. 30366 * You need a custom class to implement the AttributeModifier API. 30367 * @returns { T } 30368 * @syscap SystemCapability.ArkUI.ArkUI.Full 30369 * @crossplatform 30370 * @atomicservice 30371 * @since 12 30372 */ 30373 attributeModifier(modifier: AttributeModifier<T>): T; 30374 30375 /** 30376 * Sets the gesture modifier. 30377 * 30378 * @param { GestureModifier } modifier 30379 * @returns { T } 30380 * @syscap SystemCapability.ArkUI.ArkUI.Full 30381 * @crossplatform 30382 * @atomicservice 30383 * @since arkts {'1.1':'12','1.2':'20'} 30384 * @arkts 1.1&1.2 30385 */ 30386 gestureModifier(modifier: GestureModifier): T; 30387 30388 /** 30389 * Sets the background brightness of the component. 30390 * 30391 * @param { BackgroundBrightnessOptions } params - Parameters for setting the background brightness. 30392 * @returns { T } 30393 * @syscap SystemCapability.ArkUI.ArkUI.Full 30394 * @atomicservice 30395 * @since arkts {'1.1':'12','1.2':'20'} 30396 * @arkts 1.1&1.2 30397 */ 30398 backgroundBrightness(params: BackgroundBrightnessOptions): T; 30399 30400 /** 30401 * Sets the background brightness of the component. Compared to backgroundBrightness<sup>12+</sup>, 30402 * this API supports the **undefined** type for the **options** parameter. 30403 * 30404 * @param { Optional<BackgroundBrightnessOptions> } options - Parameters for setting the background brightness. 30405 * <br>If **options** is **undefined**, the background reverts to its default state with no brightness effect. 30406 * @returns { T } 30407 * @syscap SystemCapability.ArkUI.ArkUI.Full 30408 * @atomicservice 30409 * @since arkts {'1.1':'18','1.2':'20'} 30410 * @arkts 1.1&1.2 30411 */ 30412 backgroundBrightness(options: Optional<BackgroundBrightnessOptions>): T; 30413 30414 /** 30415 * When a gesture bound to this component will be accepted, a user-defined callback is triggered to get the result 30416 * 30417 * @param { function } callback - A callback instance used when a gesture bound to this component will be accepted. 30418 * @returns { T } 30419 * @syscap SystemCapability.ArkUI.ArkUI.Full 30420 * @crossplatform 30421 * @since 11 30422 */ 30423 /** 30424 * When a gesture bound to this component will be accepted, a user-defined callback is triggered to get the result 30425 * 30426 * @param { function } callback - A callback instance used when a gesture bound to this component will be accepted. 30427 * @returns { T } 30428 * @syscap SystemCapability.ArkUI.ArkUI.Full 30429 * @crossplatform 30430 * @atomicservice 30431 * @since arkts {'1.1':'12','1.2':'20'} 30432 * @arkts 1.1&1.2 30433 */ 30434 onGestureJudgeBegin(callback: (gestureInfo: GestureInfo, event: BaseGestureEvent) => GestureJudgeResult): T; 30435 30436 /** 30437 * Binds a custom gesture recognizer judgment callback to the component. 30438 * 30439 * @param { GestureRecognizerJudgeBeginCallback } callback - A callback instance used when a gesture bound to this component will be accepted. 30440 * @returns { T } 30441 * @syscap SystemCapability.ArkUI.ArkUI.Full 30442 * @crossplatform 30443 * @atomicservice 30444 * @since arkts {'1.1':'12','1.2':'20'} 30445 * @arkts 1.1&1.2 30446 */ 30447 onGestureRecognizerJudgeBegin(callback: GestureRecognizerJudgeBeginCallback): T; 30448 30449 /** 30450 * Binds a custom gesture recognizer judgment callback to the component. 30451 * 30452 * <p><strong>NOTE</strong>: 30453 * <br> For a composite component, setting exposeInnerGesture to true exposes the internal gesture recognizer of the 30454 * <br> composite component in the current parameter callback. Currently, only the Tabs component is supported. 30455 * 30456 * <br> Do not set exposeInnerGesture for other components. When exposeInnerGesture is set to false, this API provides the same functionality 30457 * <br> as the onGestureRecognizerJudgeBegin API. 30458 * </p> 30459 * @param { GestureRecognizerJudgeBeginCallback } callback - A callback instance used when a gesture bound to this component will be accepted. 30460 * @param { boolean } exposeInnerGesture - This parameter is a flag. This flag determines whether to expose internal gestures. 30461 * @default false 30462 * @returns { T } 30463 * @syscap SystemCapability.ArkUI.ArkUI.Full 30464 * @crossplatform 30465 * @atomicservice 30466 * @since arkts {'1.1':'13','1.2':'20'} 30467 * @arkts 1.1&1.2 30468 */ 30469 onGestureRecognizerJudgeBegin(callback: GestureRecognizerJudgeBeginCallback, exposeInnerGesture: boolean): T; 30470 30471 /** 30472 * Provides a callback to set the parallel relationship between built-in gestures and gestures of other components in the response chain. 30473 * 30474 * @param { ShouldBuiltInRecognizerParallelWithCallback } callback - A callback instance used when a component is doing touch test. 30475 * @returns { T } 30476 * @syscap SystemCapability.ArkUI.ArkUI.Full 30477 * @crossplatform 30478 * @atomicservice 30479 * @since arkts {'1.1':'12','1.2':'20'} 30480 * @arkts 1.1&1.2 30481 */ 30482 shouldBuiltInRecognizerParallelWith(callback: ShouldBuiltInRecognizerParallelWithCallback): T; 30483 30484 /** 30485 * Events are monopolized by components. 30486 * 30487 * @param { boolean } monopolize - indicate the monopoly of events 30488 * @returns { T } 30489 * @syscap SystemCapability.ArkUI.ArkUI.Full 30490 * @crossplatform 30491 * @since 11 30492 */ 30493 /** 30494 * Sets whether the component exclusively handles events. 30495 * true: The component exclusively handles events. false: The component does not exclusively handle events. 30496 * 30497 * @param { boolean } monopolize - indicate the monopoly of events 30498 * @default false 30499 * @returns { T } 30500 * @syscap SystemCapability.ArkUI.ArkUI.Full 30501 * @crossplatform 30502 * @atomicservice 30503 * @since arkts {'1.1':'12','1.2':'20'} 30504 * @arkts 1.1&1.2 30505 */ 30506 monopolizeEvents(monopolize: boolean): T; 30507 30508 /** 30509 * When the component does a touch test, a user-defined callback is triggered. 30510 * 30511 * @param { Callback<TouchEvent, HitTestMode> } callback - A callback instance used when the component does a touch test. 30512 * @returns { T } 30513 * @syscap SystemCapability.ArkUI.ArkUI.Full 30514 * @crossplatform 30515 * @atomicservice 30516 * @since arkts {'1.1':'12','1.2':'20'} 30517 * @arkts 1.1&1.2 30518 */ 30519 onTouchIntercept(callback: Callback<TouchEvent, HitTestMode>): T; 30520 30521 /** 30522 * This callback is triggered when the component size changes due to layout updates. 30523 * This event is not triggered for render attribute changes caused by re-rendering. 30524 * 30525 * @param { SizeChangeCallback } event - event callback. 30526 * @returns { T } 30527 * @syscap SystemCapability.ArkUI.ArkUI.Full 30528 * @crossplatform 30529 * @form 30530 * @atomicservice 30531 * @since arkts {'1.1':'12','1.2':'20'} 30532 * @arkts 1.1&1.2 30533 */ 30534 onSizeChange(event: SizeChangeCallback): T; 30535 30536 /** 30537 * Accessibility focus draw level, and the default value is FocusDrawLevel.SELF. 30538 * 30539 * @param { FocusDrawLevel } drawLevel - indicates accessibility focus draw level. 30540 * @returns { T } 30541 * @syscap SystemCapability.ArkUI.ArkUI.Full 30542 * @crossplatform 30543 * @form 30544 * @atomicservice 30545 * @since arkts {'1.1':'19','1.2':'20'} 30546 * @arkts 1.1&1.2 30547 */ 30548 accessibilityFocusDrawLevel(drawLevel: FocusDrawLevel): T; 30549 30550 /** 30551 * Register one callback which will be executed when all gesture recognizers are collected done, this happens 30552 * when user touchs down, the system do hit test process and collect gesture recognizers base on the touch 30553 * position, after this, before handling any move events, the component can use this interface to know which 30554 * gesture recognizers will participate in the recognition and competing with each other. 30555 * 30556 * @param { TouchTestDoneCallback } callback - A callback instance used when all gesture recognizers are collected. 30557 * @returns { T } 30558 * @syscap SystemCapability.ArkUI.ArkUI.Full 30559 * @crossplatform 30560 * @atomicservice 30561 * @since 20 30562 */ 30563 onTouchTestDone(callback: TouchTestDoneCallback): T; 30564 30565 /** 30566 * Enables the component as a drag-and-drop target with spring loading functionality. 30567 * 30568 * When a dragged object hovers over the target, it triggers a callback notification. Spring Loading is an enhanced 30569 * feature for drag-and-drop operations, allowing users to automatically trigger view transitions during dragging 30570 * by hovering (hover) without needing to use another hand. 30571 * This feature is primarily designed to enhance the smoothness and efficiency of drag-and-drop operations. Below are 30572 * some common scenarios suitable for supporting this feature: 30573 * - In a file manager, when dragging a file and hovering over a folder, the folder is automatically opened. 30574 * - On a desktop launcher, when dragging a file and hovering over an application icon, the application is 30575 * automatically opened. 30576 * 30577 * Please note: 30578 * 1. Registering spring-loaded or drag-and-drop events (onDragEnter/Move/Leave/Drop) on a component makes it a 30579 * drag-and-drop target. Only one target can be the responder at the same time when user drags and hovers on, and 30580 * child components always have higher priority. 30581 * 2. Once a complete spring loading is triggered on a component, new spring loading detection will only occur after the 30582 * dragged object leaves and re-enters the component's range. 30583 * 30584 * @param { Callback<SpringLoadingContext> | null } callback Registers the callback for spring loading response, or 30585 * sets it to null to disable the support for spring loading. 30586 * @param { DragSpringLoadingConfiguration } [configuration] The initialized spring loading configuration which is 30587 * only used when the entire spring detecting. 30588 * @returns { T } 30589 * @syscap SystemCapability.ArkUI.ArkUI.Full 30590 * @atomicservice 30591 * @since 20 30592 */ 30593 onDragSpringLoading(callback: Callback<SpringLoadingContext> | null, configuration?: DragSpringLoadingConfiguration): T 30594} 30595 30596/** 30597 * CommonAttribute for ide. 30598 * 30599 * @extends CommonMethod<CommonAttribute> 30600 * @syscap SystemCapability.ArkUI.ArkUI.Full 30601 * @since 7 30602 */ 30603/** 30604 * CommonAttribute for ide. 30605 * 30606 * @extends CommonMethod<CommonAttribute> 30607 * @syscap SystemCapability.ArkUI.ArkUI.Full 30608 * @form 30609 * @since 9 30610 */ 30611/** 30612 * CommonAttribute for ide. 30613 * 30614 * @extends CommonMethod<CommonAttribute> 30615 * @syscap SystemCapability.ArkUI.ArkUI.Full 30616 * @crossplatform 30617 * @form 30618 * @since 10 30619 */ 30620/** 30621 * CommonAttribute for ide. 30622 * 30623 * @extends CommonMethod<CommonAttribute> 30624 * @syscap SystemCapability.ArkUI.ArkUI.Full 30625 * @crossplatform 30626 * @form 30627 * @atomicservice 30628 * @since 11 30629 */ 30630declare class CommonAttribute extends CommonMethod<CommonAttribute> {} 30631 30632/** 30633 * CommonAttribute for ide. 30634 * 30635 * @typedef { CommonMethod } CommonAttribute 30636 * @syscap SystemCapability.ArkUI.ArkUI.Full 30637 * @crossplatform 30638 * @form 30639 * @atomicservice 30640 * @since 20 30641 * @arkts 1.2 30642 */ 30643declare type CommonAttribute = CommonMethod 30644/** 30645 * CommonInterface for ide. 30646 * 30647 * @interface CommonInterface 30648 * @syscap SystemCapability.ArkUI.ArkUI.Full 30649 * @since 7 30650 */ 30651/** 30652 * CommonInterface for ide. 30653 * 30654 * @interface CommonInterface 30655 * @syscap SystemCapability.ArkUI.ArkUI.Full 30656 * @form 30657 * @since 9 30658 */ 30659/** 30660 * CommonInterface for ide. 30661 * 30662 * @interface CommonInterface 30663 * @syscap SystemCapability.ArkUI.ArkUI.Full 30664 * @crossplatform 30665 * @form 30666 * @since 10 30667 */ 30668/** 30669 * CommonInterface for ide. 30670 * 30671 * @interface CommonInterface 30672 * @syscap SystemCapability.ArkUI.ArkUI.Full 30673 * @crossplatform 30674 * @form 30675 * @atomicservice 30676 * @since 11 30677 */ 30678interface CommonInterface { 30679 /** 30680 * Constructor. 30681 * 30682 * @returns { CommonAttribute } 30683 * @syscap SystemCapability.ArkUI.ArkUI.Full 30684 * @since 7 30685 */ 30686 /** 30687 * Constructor 30688 * 30689 * @returns { CommonAttribute } 30690 * @syscap SystemCapability.ArkUI.ArkUI.Full 30691 * @form 30692 * @since 9 30693 */ 30694 /** 30695 * Constructor 30696 * 30697 * @returns { CommonAttribute } 30698 * @syscap SystemCapability.ArkUI.ArkUI.Full 30699 * @crossplatform 30700 * @form 30701 * @since 10 30702 */ 30703 /** 30704 * Constructor 30705 * 30706 * @returns { CommonAttribute } 30707 * @syscap SystemCapability.ArkUI.ArkUI.Full 30708 * @crossplatform 30709 * @form 30710 * @atomicservice 30711 * @since 11 30712 */ 30713 (): CommonAttribute; 30714} 30715 30716/** 30717 * CommonInstance for ide. 30718 * 30719 * @syscap SystemCapability.ArkUI.ArkUI.Full 30720 * @since 7 30721 */ 30722/** 30723 * CommonInstance for ide. 30724 * 30725 * @syscap SystemCapability.ArkUI.ArkUI.Full 30726 * @form 30727 * @since 9 30728 */ 30729/** 30730 * CommonInstance for ide. 30731 * 30732 * @syscap SystemCapability.ArkUI.ArkUI.Full 30733 * @crossplatform 30734 * @form 30735 * @since 10 30736 */ 30737/** 30738 * CommonInstance for ide. 30739 * 30740 * @syscap SystemCapability.ArkUI.ArkUI.Full 30741 * @crossplatform 30742 * @form 30743 * @atomicservice 30744 * @since 11 30745 */ 30746declare const CommonInstance: CommonAttribute; 30747 30748/** 30749 * Common for ide. 30750 * 30751 * @syscap SystemCapability.ArkUI.ArkUI.Full 30752 * @since 7 30753 */ 30754/** 30755 * Common for ide. 30756 * 30757 * @syscap SystemCapability.ArkUI.ArkUI.Full 30758 * @form 30759 * @since 9 30760 */ 30761/** 30762 * Common for ide. 30763 * 30764 * @syscap SystemCapability.ArkUI.ArkUI.Full 30765 * @crossplatform 30766 * @form 30767 * @since 10 30768 */ 30769/** 30770 * Common for ide. 30771 * 30772 * @syscap SystemCapability.ArkUI.ArkUI.Full 30773 * @crossplatform 30774 * @form 30775 * @atomicservice 30776 * @since 11 30777 */ 30778declare const Common: CommonInterface; 30779 30780/** 30781 * Defines the CustomBuilder Type. 30782 * 30783 * @typedef { (() => any) | void } CustomBuilder 30784 * @syscap SystemCapability.ArkUI.ArkUI.Full 30785 * @since 8 30786 */ 30787/** 30788 * Defines the CustomBuilder Type. 30789 * 30790 * @typedef { (() => any) | void } CustomBuilder 30791 * @syscap SystemCapability.ArkUI.ArkUI.Full 30792 * @form 30793 * @since 9 30794 */ 30795/** 30796 * Defines the CustomBuilder Type. 30797 * 30798 * @typedef { (() => any) | void } CustomBuilder 30799 * @syscap SystemCapability.ArkUI.ArkUI.Full 30800 * @crossplatform 30801 * @form 30802 * @since 10 30803 */ 30804/** 30805 * Defines the CustomBuilder Type. 30806 * 30807 * @typedef { (() => any) | void } CustomBuilder 30808 * @syscap SystemCapability.ArkUI.ArkUI.Full 30809 * @crossplatform 30810 * @form 30811 * @atomicservice 30812 * @since 11 30813 */ 30814declare type CustomBuilder = (() => any) | void; 30815 30816/** 30817 * Defines the OverlayOptions interface. 30818 * 30819 * <strong>NOTE</strong>:<br> 30820 * When both align and offset are set, the effects are combined. 30821 * The overlay is first aligned relative to the component and then offset from its current upper left corner. 30822 * 30823 * @typedef OverlayOptions 30824 * @syscap SystemCapability.ArkUI.ArkUI.Full 30825 * @crossplatform 30826 * @form 30827 * @atomicservice 30828 * @since arkts {'1.1':'12','1.2':'20'} 30829 * @arkts 1.1&1.2 30830 */ 30831declare interface OverlayOptions { 30832 /** 30833 * Defines align type. 30834 * 30835 * @type { ?Alignment } 30836 * @syscap SystemCapability.ArkUI.ArkUI.Full 30837 * @since 7 30838 */ 30839 /** 30840 * Defines align type. 30841 * 30842 * @type { ?Alignment } 30843 * @syscap SystemCapability.ArkUI.ArkUI.Full 30844 * @form 30845 * @since 9 30846 */ 30847 /** 30848 * Defines align type. 30849 * 30850 * @type { ?Alignment } 30851 * @syscap SystemCapability.ArkUI.ArkUI.Full 30852 * @crossplatform 30853 * @form 30854 * @since 10 30855 */ 30856 /** 30857 * Defines align type. 30858 * 30859 * @type { ?Alignment } 30860 * @default TopStart 30861 * @syscap SystemCapability.ArkUI.ArkUI.Full 30862 * @crossplatform 30863 * @form 30864 * @atomicservice 30865 * @since arkts {'1.1':'11','1.2':'20'} 30866 * @arkts 1.1&1.2 30867 */ 30868 align?: Alignment; 30869 30870 /** 30871 * Defines offset type. 30872 * 30873 * @type { ?OverlayOffset } 30874 * @syscap SystemCapability.ArkUI.ArkUI.Full 30875 * @since 7 30876 */ 30877 /** 30878 * Defines offset type. 30879 * 30880 * @type { ?OverlayOffset } 30881 * @syscap SystemCapability.ArkUI.ArkUI.Full 30882 * @form 30883 * @since 9 30884 */ 30885 /** 30886 * Defines offset type. 30887 * 30888 * @type { ?OverlayOffset } 30889 * @syscap SystemCapability.ArkUI.ArkUI.Full 30890 * @crossplatform 30891 * @form 30892 * @since 10 30893 */ 30894 /** 30895 * Defines offset type. 30896 * 30897 * @type { ?OverlayOffset } 30898 * @default - the overlay is in the upper left corner of the component. 30899 * @syscap SystemCapability.ArkUI.ArkUI.Full 30900 * @crossplatform 30901 * @form 30902 * @atomicservice 30903 * @since arkts {'1.1':'11','1.2':'20'} 30904 * @arkts 1.1&1.2 30905 */ 30906 offset?: OverlayOffset; 30907} 30908 30909/** 30910 * Defines the OverlayOffset. 30911 * 30912 * @typedef OverlayOffset 30913 * @syscap SystemCapability.ArkUI.ArkUI.Full 30914 * @crossplatform 30915 * @form 30916 * @atomicservice 30917 * @since arkts {'1.1':'12','1.2':'20'} 30918 * @arkts 1.1&1.2 30919 */ 30920declare interface OverlayOffset { 30921 /** 30922 * Defines x. 30923 * 30924 * @type { ?number } 30925 * @syscap SystemCapability.ArkUI.ArkUI.Full 30926 * @since 7 30927 */ 30928 /** 30929 * Defines x. 30930 * 30931 * @type { ?number } 30932 * @syscap SystemCapability.ArkUI.ArkUI.Full 30933 * @form 30934 * @since 9 30935 */ 30936 /** 30937 * Defines x. 30938 * 30939 * @type { ?number } 30940 * @syscap SystemCapability.ArkUI.ArkUI.Full 30941 * @crossplatform 30942 * @form 30943 * @since 10 30944 */ 30945 /** 30946 * Defines x. 30947 * 30948 * @type { ?number } 30949 * @syscap SystemCapability.ArkUI.ArkUI.Full 30950 * @crossplatform 30951 * @form 30952 * @atomicservice 30953 * @since arkts {'1.1':'11','1.2':'20'} 30954 * @arkts 1.1&1.2 30955 */ 30956 x?: number; 30957 /** 30958 * Defines y. 30959 * 30960 * @type { ?number } 30961 * @syscap SystemCapability.ArkUI.ArkUI.Full 30962 * @since 7 30963 */ 30964 /** 30965 * Defines y. 30966 * 30967 * @type { ?number } 30968 * @syscap SystemCapability.ArkUI.ArkUI.Full 30969 * @form 30970 * @since 9 30971 */ 30972 /** 30973 * Defines y. 30974 * 30975 * @type { ?number } 30976 * @syscap SystemCapability.ArkUI.ArkUI.Full 30977 * @crossplatform 30978 * @form 30979 * @since 10 30980 */ 30981 /** 30982 * Defines y. 30983 * 30984 * @type { ?number } 30985 * @syscap SystemCapability.ArkUI.ArkUI.Full 30986 * @crossplatform 30987 * @form 30988 * @atomicservice 30989 * @since arkts {'1.1':'11','1.2':'20'} 30990 * @arkts 1.1&1.2 30991 */ 30992 y?: number; 30993} 30994 30995/** 30996 * Defines the segment of blur. 30997 * The first element in the tuple means fraction. 30998 * The range of this value is [0,1]. A value of 1 means opaque and 0 means completely transparent. 30999 * The second element means the stop position. 31000 * The range of this value is [0,1]. A value of 1 means region ending position and 0 means region starting position. 31001 * 31002 * @typedef { [ number, number ] } FractionStop 31003 * @syscap SystemCapability.ArkUI.ArkUI.Full 31004 * @atomicservice 31005 * @since arkts {'1.1':'12','1.2':'20'} 31006 * @arkts 1.1&1.2 31007 */ 31008declare type FractionStop = [ number, number ]; 31009 31010/** 31011 * CommonShapeMethod 31012 * 31013 * @extends CommonMethod<T> 31014 * @syscap SystemCapability.ArkUI.ArkUI.Full 31015 * @since 7 31016 */ 31017/** 31018 * CommonShapeMethod 31019 * 31020 * @extends CommonMethod<T> 31021 * @syscap SystemCapability.ArkUI.ArkUI.Full 31022 * @form 31023 * @since 9 31024 */ 31025/** 31026 * CommonShapeMethod 31027 * 31028 * @extends CommonMethod<T> 31029 * @syscap SystemCapability.ArkUI.ArkUI.Full 31030 * @crossplatform 31031 * @form 31032 * @since 10 31033 */ 31034/** 31035 * CommonShapeMethod 31036 * 31037 * @extends CommonMethod<T> 31038 * @syscap SystemCapability.ArkUI.ArkUI.Full 31039 * @crossplatform 31040 * @form 31041 * @atomicservice 31042 * @since arkts {'1.1':'11','1.2':'20'} 31043 * @arkts 1.1&1.2 31044 */ 31045declare class CommonShapeMethod<T> extends CommonMethod<T> { 31046 /** 31047 * constructor. 31048 * 31049 * @syscap SystemCapability.ArkUI.ArkUI.Full 31050 * @systemapi 31051 * @since 7 31052 */ 31053 /** 31054 * constructor. 31055 * 31056 * @syscap SystemCapability.ArkUI.ArkUI.Full 31057 * @systemapi 31058 * @form 31059 * @since arkts {'1.1':'9','1.2':'20'} 31060 * @arkts 1.1&1.2 31061 */ 31062 constructor(); 31063 31064 /** 31065 * Sets the stroke color. 31066 * If this attribute is not set, the component does not have any stroke. 31067 * If the value is invalid, no stroke will be drawn. 31068 * 31069 * @param { ResourceColor } value - Stroke color. 31070 * @returns { T } 31071 * @syscap SystemCapability.ArkUI.ArkUI.Full 31072 * @since 7 31073 */ 31074 /** 31075 * Sets the stroke color. 31076 * If this attribute is not set, the component does not have any stroke. 31077 * If the value is invalid, no stroke will be drawn. 31078 * 31079 * @param { ResourceColor } value - Stroke color. 31080 * @returns { T } 31081 * @syscap SystemCapability.ArkUI.ArkUI.Full 31082 * @form 31083 * @since 9 31084 */ 31085 /** 31086 * Sets the stroke color. 31087 * If this attribute is not set, the component does not have any stroke. 31088 * If the value is invalid, no stroke will be drawn. 31089 * 31090 * @param { ResourceColor } value - Stroke color. 31091 * @returns { T } 31092 * @syscap SystemCapability.ArkUI.ArkUI.Full 31093 * @crossplatform 31094 * @form 31095 * @since 10 31096 */ 31097 /** 31098 * Sets the stroke color. 31099 * If this attribute is not set, the component does not have any stroke. 31100 * If the value is invalid, no stroke will be drawn. 31101 * 31102 * @param { ResourceColor } value - Stroke color. 31103 * @returns { T } 31104 * @syscap SystemCapability.ArkUI.ArkUI.Full 31105 * @crossplatform 31106 * @form 31107 * @atomicservice 31108 * @since arkts {'1.1':'11','1.2':'20'} 31109 * @arkts 1.1&1.2 31110 */ 31111 stroke(value: ResourceColor): T; 31112 31113 /** 31114 * Sets the color of the fill area. 31115 * An invalid value is handled as the default value. 31116 * If this attribute and the universal attribute foregroundColor are both set, whichever is set later takes effect. 31117 * 31118 * @param { ResourceColor } value - Color of the fill area. Default value: Color.Black. 31119 * @returns { T } 31120 * @syscap SystemCapability.ArkUI.ArkUI.Full 31121 * @since 7 31122 */ 31123 /** 31124 * Sets the color of the fill area. 31125 * An invalid value is handled as the default value. 31126 * If this attribute and the universal attribute foregroundColor are both set, whichever is set later takes effect. 31127 * 31128 * @param { ResourceColor } value - Color of the fill area. Default value: Color.Black. 31129 * @returns { T } 31130 * @syscap SystemCapability.ArkUI.ArkUI.Full 31131 * @form 31132 * @since 9 31133 */ 31134 /** 31135 * Sets the color of the fill area. 31136 * An invalid value is handled as the default value. 31137 * If this attribute and the universal attribute foregroundColor are both set, whichever is set later takes effect. 31138 * 31139 * @param { ResourceColor } value - Color of the fill area. Default value: Color.Black. 31140 * @returns { T } 31141 * @syscap SystemCapability.ArkUI.ArkUI.Full 31142 * @crossplatform 31143 * @form 31144 * @since 10 31145 */ 31146 /** 31147 * Sets the color of the fill area. 31148 * An invalid value is handled as the default value. 31149 * If this attribute and the universal attribute foregroundColor are both set, whichever is set later takes effect. 31150 * 31151 * @param { ResourceColor } value - Color of the fill area. Default value: Color.Black. 31152 * @returns { T } 31153 * @syscap SystemCapability.ArkUI.ArkUI.Full 31154 * @crossplatform 31155 * @form 31156 * @atomicservice 31157 * @since arkts {'1.1':'11','1.2':'20'} 31158 * @arkts 1.1&1.2 31159 */ 31160 fill(value: ResourceColor): T; 31161 31162 /** 31163 * Sets the offset of the start point for drawing the stroke. 31164 * An invalid value is handled as the default value. 31165 * 31166 * @param { number | string } value - Offset of the start point for drawing the stroke. 31167 * Default value: 0 31168 * Default unit: vp 31169 * @returns { T } 31170 * @syscap SystemCapability.ArkUI.ArkUI.Full 31171 * @since 7 31172 */ 31173 /** 31174 * Sets the offset of the start point for drawing the stroke. 31175 * An invalid value is handled as the default value. 31176 * 31177 * @param { number | string } value - Offset of the start point for drawing the stroke. 31178 * Default value: 0 31179 * Default unit: vp 31180 * @returns { T } 31181 * @syscap SystemCapability.ArkUI.ArkUI.Full 31182 * @form 31183 * @since 9 31184 */ 31185 /** 31186 * Sets the offset of the start point for drawing the stroke. 31187 * An invalid value is handled as the default value. 31188 * 31189 * @param { number | string } value - Offset of the start point for drawing the stroke. 31190 * Default value: 0 31191 * Default unit: vp 31192 * @returns { T } 31193 * @syscap SystemCapability.ArkUI.ArkUI.Full 31194 * @crossplatform 31195 * @form 31196 * @since 10 31197 */ 31198 /** 31199 * Sets the offset of the start point for drawing the stroke. 31200 * An invalid value is handled as the default value. 31201 * 31202 * @param { number | string } value - Offset of the start point for drawing the stroke. 31203 * Default value: 0 31204 * Default unit: vp 31205 * @returns { T } 31206 * @syscap SystemCapability.ArkUI.ArkUI.Full 31207 * @crossplatform 31208 * @form 31209 * @atomicservice 31210 * @since arkts {'1.1':'11','1.2':'20'} 31211 * @arkts 1.1&1.2 31212 */ 31213 strokeDashOffset(value: number | string): T; 31214 31215 /** 31216 * Sets the cap style of the stroke. 31217 * 31218 * @param { LineCapStyle } value - Cap style of the stroke. Default value: LineCapStyle.Butt 31219 * @returns { T } 31220 * @syscap SystemCapability.ArkUI.ArkUI.Full 31221 * @since 7 31222 */ 31223 /** 31224 * Sets the cap style of the stroke. 31225 * 31226 * @param { LineCapStyle } value - Cap style of the stroke. Default value: LineCapStyle.Butt 31227 * @returns { T } 31228 * @syscap SystemCapability.ArkUI.ArkUI.Full 31229 * @form 31230 * @since 9 31231 */ 31232 /** 31233 * Sets the cap style of the stroke. 31234 * 31235 * @param { LineCapStyle } value - Cap style of the stroke. Default value: LineCapStyle.Butt 31236 * @returns { T } 31237 * @syscap SystemCapability.ArkUI.ArkUI.Full 31238 * @crossplatform 31239 * @form 31240 * @since 10 31241 */ 31242 /** 31243 * Sets the cap style of the stroke. 31244 * 31245 * @param { LineCapStyle } value - Cap style of the stroke. Default value: LineCapStyle.Butt 31246 * @returns { T } 31247 * @syscap SystemCapability.ArkUI.ArkUI.Full 31248 * @crossplatform 31249 * @form 31250 * @atomicservice 31251 * @since arkts {'1.1':'11','1.2':'20'} 31252 * @arkts 1.1&1.2 31253 */ 31254 strokeLineCap(value: LineCapStyle): T; 31255 31256 /** 31257 * Sets the join style of the stroke. 31258 * This attribute does not work for the Circle component, which does not have corners. 31259 * 31260 * @param { LineJoinStyle } value - Join style of the stroke. Default value: LineJoinStyle.Miter 31261 * @returns { T } 31262 * @syscap SystemCapability.ArkUI.ArkUI.Full 31263 * @since 7 31264 */ 31265 /** 31266 * Sets the join style of the stroke. 31267 * This attribute does not work for the Circle component, which does not have corners. 31268 * 31269 * @param { LineJoinStyle } value - Join style of the stroke. Default value: LineJoinStyle.Miter 31270 * @returns { T } 31271 * @syscap SystemCapability.ArkUI.ArkUI.Full 31272 * @form 31273 * @since 9 31274 */ 31275 /** 31276 * Sets the join style of the stroke. 31277 * This attribute does not work for the Circle component, which does not have corners. 31278 * 31279 * @param { LineJoinStyle } value - Join style of the stroke. Default value: LineJoinStyle.Miter 31280 * @returns { T } 31281 * @syscap SystemCapability.ArkUI.ArkUI.Full 31282 * @crossplatform 31283 * @form 31284 * @since 10 31285 */ 31286 /** 31287 * Sets the join style of the stroke. 31288 * This attribute does not work for the Circle component, which does not have corners. 31289 * 31290 * @param { LineJoinStyle } value - Join style of the stroke. Default value: LineJoinStyle.Miter 31291 * @returns { T } 31292 * @syscap SystemCapability.ArkUI.ArkUI.Full 31293 * @crossplatform 31294 * @form 31295 * @atomicservice 31296 * @since arkts {'1.1':'11','1.2':'20'} 31297 * @arkts 1.1&1.2 31298 */ 31299 strokeLineJoin(value: LineJoinStyle): T; 31300 31301 /** 31302 * Limits for drawing acute angles as bevels 31303 * 31304 * @param { number | string } value 31305 * @returns { T } 31306 * @syscap SystemCapability.ArkUI.ArkUI.Full 31307 * @since 7 31308 */ 31309 /** 31310 * Limits for drawing acute angles as bevels 31311 * 31312 * @param { number | string } value 31313 * @returns { T } 31314 * @syscap SystemCapability.ArkUI.ArkUI.Full 31315 * @form 31316 * @since 9 31317 */ 31318 /** 31319 * Limits for drawing acute angles as bevels 31320 * 31321 * @param { number | string } value 31322 * @returns { T } 31323 * @syscap SystemCapability.ArkUI.ArkUI.Full 31324 * @crossplatform 31325 * @form 31326 * @since 10 31327 */ 31328 /** 31329 * Limits for drawing acute angles as bevels 31330 * 31331 * @param { number | string } value 31332 * @returns { T } 31333 * @syscap SystemCapability.ArkUI.ArkUI.Full 31334 * @crossplatform 31335 * @form 31336 * @atomicservice 31337 * @since arkts {'1.1':'11','1.2':'20'} 31338 * @arkts 1.1&1.2 31339 */ 31340 strokeMiterLimit(value: number | string): T; 31341 31342 /** 31343 * Sets the stroke opacity. 31344 * The value range is [0.0, 1.0]. 31345 * A value less than 0.0 evaluates to the value 0.0. A value greater than 1.0 evaluates to the value 1.0. 31346 * Any other value evaluates to the value 1.0. 31347 * 31348 * @param { number | string | Resource } value - Stroke opacity. Default value: 1 31349 * @returns { T } 31350 * @syscap SystemCapability.ArkUI.ArkUI.Full 31351 * @since 7 31352 */ 31353 /** 31354 * Sets the stroke opacity. 31355 * The value range is [0.0, 1.0]. 31356 * A value less than 0.0 evaluates to the value 0.0. A value greater than 1.0 evaluates to the value 1.0. 31357 * Any other value evaluates to the value 1.0. 31358 * 31359 * @param { number | string | Resource } value - Stroke opacity. Default value: 1 31360 * @returns { T } 31361 * @syscap SystemCapability.ArkUI.ArkUI.Full 31362 * @form 31363 * @since 9 31364 */ 31365 /** 31366 * Sets the stroke opacity. 31367 * The value range is [0.0, 1.0]. 31368 * A value less than 0.0 evaluates to the value 0.0. A value greater than 1.0 evaluates to the value 1.0. 31369 * Any other value evaluates to the value 1.0. 31370 * 31371 * @param { number | string | Resource } value - Stroke opacity. Default value: 1 31372 * @returns { T } 31373 * @syscap SystemCapability.ArkUI.ArkUI.Full 31374 * @crossplatform 31375 * @form 31376 * @since 10 31377 */ 31378 /** 31379 * Sets the stroke opacity. 31380 * The value range is [0.0, 1.0]. 31381 * A value less than 0.0 evaluates to the value 0.0. A value greater than 1.0 evaluates to the value 1.0. 31382 * Any other value evaluates to the value 1.0. 31383 * 31384 * @param { number | string | Resource } value - Stroke opacity. Default value: 1 31385 * @returns { T } 31386 * @syscap SystemCapability.ArkUI.ArkUI.Full 31387 * @crossplatform 31388 * @form 31389 * @atomicservice 31390 * @since arkts {'1.1':'11','1.2':'20'} 31391 * @arkts 1.1&1.2 31392 */ 31393 strokeOpacity(value: number | string | Resource): T; 31394 31395 /** 31396 * Sets the opacity of the fill area. 31397 * The value range is [0.0, 1.0]. 31398 * A value less than 0.0 evaluates to the value 0.0. A value greater than 1.0 evaluates to the value 1.0. 31399 * Any other value evaluates to the value 1.0. 31400 * 31401 * @param { number | string | Resource } value - Opacity of the fill area. Default value: 1 31402 * @returns { T } 31403 * @syscap SystemCapability.ArkUI.ArkUI.Full 31404 * @since 7 31405 */ 31406 /** 31407 * Sets the opacity of the fill area. 31408 * The value range is [0.0, 1.0]. 31409 * A value less than 0.0 evaluates to the value 0.0. A value greater than 1.0 evaluates to the value 1.0. 31410 * Any other value evaluates to the value 1.0. 31411 * 31412 * @param { number | string | Resource } value - Opacity of the fill area. Default value: 1 31413 * @returns { T } 31414 * @syscap SystemCapability.ArkUI.ArkUI.Full 31415 * @form 31416 * @since 9 31417 */ 31418 /** 31419 * Sets the opacity of the fill area. 31420 * The value range is [0.0, 1.0]. 31421 * A value less than 0.0 evaluates to the value 0.0. A value greater than 1.0 evaluates to the value 1.0. 31422 * Any other value evaluates to the value 1.0. 31423 * 31424 * @param { number | string | Resource } value - Opacity of the fill area. Default value: 1 31425 * @returns { T } 31426 * @syscap SystemCapability.ArkUI.ArkUI.Full 31427 * @crossplatform 31428 * @form 31429 * @since 10 31430 */ 31431 /** 31432 * Sets the opacity of the fill area. 31433 * The value range is [0.0, 1.0]. 31434 * A value less than 0.0 evaluates to the value 0.0. A value greater than 1.0 evaluates to the value 1.0. 31435 * Any other value evaluates to the value 1.0. 31436 * 31437 * @param { number | string | Resource } value - Opacity of the fill area. Default value: 1 31438 * @returns { T } 31439 * @syscap SystemCapability.ArkUI.ArkUI.Full 31440 * @crossplatform 31441 * @form 31442 * @atomicservice 31443 * @since arkts {'1.1':'11','1.2':'20'} 31444 * @arkts 1.1&1.2 31445 */ 31446 fillOpacity(value: number | string | Resource): T; 31447 31448 /** 31449 * Sets the stroke width. 31450 * If this attribute is of the string type, percentage values are not supported and will be treated as 1 px. 31451 * 31452 * @param { Length } value - Stroke width. 31453 * The value must be greater than or equal to 0. 31454 * Default value: 1. 31455 * Default unit: vp. 31456 * An invalid value is handled as the default value. 31457 * @returns { T } 31458 * @syscap SystemCapability.ArkUI.ArkUI.Full 31459 * @since 7 31460 */ 31461 /** 31462 * Sets the stroke width. 31463 * If this attribute is of the string type, percentage values are not supported and will be treated as 1 px. 31464 * 31465 * @param { Length } value - Stroke width. 31466 * The value must be greater than or equal to 0. 31467 * Default value: 1. 31468 * Default unit: vp. 31469 * An invalid value is handled as the default value. 31470 * @returns { T } 31471 * @syscap SystemCapability.ArkUI.ArkUI.Full 31472 * @form 31473 * @since 9 31474 */ 31475 /** 31476 * Sets the stroke width. 31477 * If this attribute is of the string type, percentage values are not supported and will be treated as 1 px. 31478 * 31479 * @param { Length } value - Stroke width. 31480 * The value must be greater than or equal to 0. 31481 * Default value: 1. 31482 * Default unit: vp. 31483 * An invalid value is handled as the default value. 31484 * @returns { T } 31485 * @syscap SystemCapability.ArkUI.ArkUI.Full 31486 * @crossplatform 31487 * @form 31488 * @since 10 31489 */ 31490 /** 31491 * Sets the stroke width. 31492 * If this attribute is of the string type, percentage values are not supported and will be treated as 1 px. 31493 * 31494 * @param { Length } value - Stroke width. 31495 * The value must be greater than or equal to 0. 31496 * Default value: 1. 31497 * Default unit: vp. 31498 * An invalid value is handled as the default value. 31499 * @returns { T } 31500 * @syscap SystemCapability.ArkUI.ArkUI.Full 31501 * @crossplatform 31502 * @form 31503 * @atomicservice 31504 * @since arkts {'1.1':'11','1.2':'20'} 31505 * @arkts 1.1&1.2 31506 */ 31507 strokeWidth(value: Length): T; 31508 31509 /** 31510 * Specifies whether anti-aliasing is enabled. 31511 * 31512 * @param { boolean } value - Whether anti-aliasing is enabled. 31513 * true: Anti-aliasing is enabled. 31514 * false: Anti-aliasing is disabled. 31515 * Default value: true 31516 * @returns { T } 31517 * @syscap SystemCapability.ArkUI.ArkUI.Full 31518 * @since 7 31519 */ 31520 /** 31521 * Specifies whether anti-aliasing is enabled. 31522 * 31523 * @param { boolean } value - Whether anti-aliasing is enabled. 31524 * true: Anti-aliasing is enabled. 31525 * false: Anti-aliasing is disabled. 31526 * Default value: true 31527 * @returns { T } 31528 * @syscap SystemCapability.ArkUI.ArkUI.Full 31529 * @form 31530 * @since 9 31531 */ 31532 /** 31533 * Specifies whether anti-aliasing is enabled. 31534 * 31535 * @param { boolean } value - Whether anti-aliasing is enabled. 31536 * true: Anti-aliasing is enabled. 31537 * false: Anti-aliasing is disabled. 31538 * Default value: true 31539 * @returns { T } 31540 * @syscap SystemCapability.ArkUI.ArkUI.Full 31541 * @crossplatform 31542 * @form 31543 * @since 10 31544 */ 31545 /** 31546 * Specifies whether anti-aliasing is enabled. 31547 * 31548 * @param { boolean } value - Whether anti-aliasing is enabled. 31549 * true: Anti-aliasing is enabled. 31550 * false: Anti-aliasing is disabled. 31551 * Default value: true 31552 * @returns { T } 31553 * @syscap SystemCapability.ArkUI.ArkUI.Full 31554 * @crossplatform 31555 * @form 31556 * @atomicservice 31557 * @since arkts {'1.1':'11','1.2':'20'} 31558 * @arkts 1.1&1.2 31559 */ 31560 antiAlias(value: boolean): T; 31561 31562 /** 31563 * Sets stroke dashes. 31564 * The value must be greater than or equal to 0. Invalid values are treated as the default value. 31565 * 31566 * @param { Array<any> } value - Stroke dashes. 31567 * Default value: [] 31568 * Default unit: vp 31569 * @returns { T } 31570 * @syscap SystemCapability.ArkUI.ArkUI.Full 31571 * @since 7 31572 */ 31573 /** 31574 * Sets stroke dashes. 31575 * The value must be greater than or equal to 0. Invalid values are treated as the default value. 31576 * 31577 * @param { Array<any> } value - Stroke dashes. 31578 * Default value: [] 31579 * Default unit: vp 31580 * @returns { T } 31581 * @syscap SystemCapability.ArkUI.ArkUI.Full 31582 * @form 31583 * @since 9 31584 */ 31585 /** 31586 * Sets stroke dashes. 31587 * The value must be greater than or equal to 0. Invalid values are treated as the default value. 31588 * 31589 * @param { Array<any> } value - Stroke dashes. 31590 * Default value: [] 31591 * Default unit: vp 31592 * @returns { T } 31593 * @syscap SystemCapability.ArkUI.ArkUI.Full 31594 * @crossplatform 31595 * @form 31596 * @since 10 31597 */ 31598 /** 31599 * Sets stroke dashes. 31600 * The value must be greater than or equal to 0. Invalid values are treated as the default value. 31601 * 31602 * @param { Array<any> } value - Stroke dashes. 31603 * Default value: [] 31604 * Default unit: vp 31605 * @returns { T } 31606 * @syscap SystemCapability.ArkUI.ArkUI.Full 31607 * @crossplatform 31608 * @form 31609 * @atomicservice 31610 * @since 11 31611 */ 31612 strokeDashArray(value: Array<any>): T; 31613 31614 /** 31615 * Sets the gap for the border. 31616 * 31617 * @param { Array<Length> } value 31618 * @returns { T } 31619 * @syscap SystemCapability.ArkUI.ArkUI.Full 31620 * @crossplatform 31621 * @form 31622 * @atomicservice 31623 * @since 20 31624 * @arkts 1.2 31625 */ 31626 strokeDashArray(value: Array<Length>): T; 31627} 31628 31629/** 31630 * Linear Gradient Interface 31631 * 31632 * @interface LinearGradient 31633 * @syscap SystemCapability.ArkUI.ArkUI.Full 31634 * @since 9 31635 */ 31636/** 31637 * Linear Gradient Interface 31638 * 31639 * @interface LinearGradient 31640 * @syscap SystemCapability.ArkUI.ArkUI.Full 31641 * @crossplatform 31642 * @since 10 31643 */ 31644/** 31645 * Linear Gradient Interface 31646 * 31647 * @interface LinearGradient 31648 * @syscap SystemCapability.ArkUI.ArkUI.Full 31649 * @crossplatform 31650 * @atomicservice 31651 * @since 11 31652 */ 31653declare interface LinearGradient { 31654 /** 31655 * Linear Gradient Angle 31656 * 31657 * @type { ?(number | string) } 31658 * @syscap SystemCapability.ArkUI.ArkUI.Full 31659 * @since 9 31660 */ 31661 /** 31662 * Linear Gradient Angle 31663 * 31664 * @type { ?(number | string) } 31665 * @syscap SystemCapability.ArkUI.ArkUI.Full 31666 * @crossplatform 31667 * @since 10 31668 */ 31669 /** 31670 * Linear Gradient Angle 31671 * 31672 * @type { ?(number | string) } 31673 * @syscap SystemCapability.ArkUI.ArkUI.Full 31674 * @crossplatform 31675 * @atomicservice 31676 * @since 11 31677 */ 31678 angle?: number | string; 31679 /** 31680 * Linear Gradient Direction 31681 * 31682 * @type { ?GradientDirection } 31683 * @syscap SystemCapability.ArkUI.ArkUI.Full 31684 * @since 9 31685 */ 31686 /** 31687 * Linear Gradient Direction 31688 * 31689 * @type { ?GradientDirection } 31690 * @syscap SystemCapability.ArkUI.ArkUI.Full 31691 * @crossplatform 31692 * @since 10 31693 */ 31694 /** 31695 * Linear Gradient Direction 31696 * 31697 * @type { ?GradientDirection } 31698 * @syscap SystemCapability.ArkUI.ArkUI.Full 31699 * @crossplatform 31700 * @atomicservice 31701 * @since 11 31702 */ 31703 direction?: GradientDirection; 31704 /** 31705 * Linear Gradient Colors 31706 * 31707 * @type { Array<any> } 31708 * @syscap SystemCapability.ArkUI.ArkUI.Full 31709 * @since 9 31710 */ 31711 /** 31712 * Linear Gradient Colors 31713 * 31714 * @type { Array<any> } 31715 * @syscap SystemCapability.ArkUI.ArkUI.Full 31716 * @crossplatform 31717 * @since 10 31718 */ 31719 /** 31720 * Linear Gradient Colors 31721 * 31722 * @type { Array<any> } 31723 * @syscap SystemCapability.ArkUI.ArkUI.Full 31724 * @crossplatform 31725 * @atomicservice 31726 * @since 11 31727 */ 31728 /** 31729 * Linear Gradient Colors 31730 * 31731 * @type { Array<[ResourceColor, number]> } 31732 * @syscap SystemCapability.ArkUI.ArkUI.Full 31733 * @crossplatform 31734 * @atomicservice 31735 * @since 12 31736 */ 31737 colors: Array<[ResourceColor, number]>; 31738 /** 31739 * Linear Gradient Repeating 31740 * 31741 * @type { ?boolean } 31742 * @syscap SystemCapability.ArkUI.ArkUI.Full 31743 * @since 9 31744 */ 31745 /** 31746 * Linear Gradient Repeating 31747 * 31748 * @type { ?boolean } 31749 * @syscap SystemCapability.ArkUI.ArkUI.Full 31750 * @crossplatform 31751 * @since 10 31752 */ 31753 /** 31754 * Linear Gradient Repeating 31755 * 31756 * @type { ?boolean } 31757 * @syscap SystemCapability.ArkUI.ArkUI.Full 31758 * @crossplatform 31759 * @atomicservice 31760 * @since 11 31761 */ 31762 repeating?: boolean; 31763} 31764 31765/** 31766 * Defines the direction of pixel rounding at the component level. 31767 * 31768 * @interface PixelRoundPolicy 31769 * @syscap SystemCapability.ArkUI.ArkUI.Full 31770 * @crossplatform 31771 * @form 31772 * @atomicservice 31773 * @since arkts {'1.1':'11','1.2':'20'} 31774 * @arkts 1.1&1.2 31775 */ 31776declare interface PixelRoundPolicy { 31777 /** 31778 * Rounding for alignment with the start edge. 31779 * 31780 * @type { ?PixelRoundCalcPolicy } 31781 * @default PixelRoundCalcPolicy.NO_FORCE_ROUND 31782 * @syscap SystemCapability.ArkUI.ArkUI.Full 31783 * @crossplatform 31784 * @form 31785 * @atomicservice 31786 * @since arkts {'1.1':'11','1.2':'20'} 31787 * @arkts 1.1&1.2 31788 */ 31789 start?: PixelRoundCalcPolicy; 31790 31791 /** 31792 * Rounding for alignment with the top edge. 31793 * 31794 * @type { ?PixelRoundCalcPolicy } 31795 * @default PixelRoundCalcPolicy.NO_FORCE_ROUND 31796 * @syscap SystemCapability.ArkUI.ArkUI.Full 31797 * @crossplatform 31798 * @form 31799 * @atomicservice 31800 * @since arkts {'1.1':'11','1.2':'20'} 31801 * @arkts 1.1&1.2 31802 */ 31803 top?: PixelRoundCalcPolicy; 31804 31805 /** 31806 * Rounding for alignment with the end edge. 31807 * 31808 * @type { ?PixelRoundCalcPolicy } 31809 * @default PixelRoundCalcPolicy.NO_FORCE_ROUND 31810 * @syscap SystemCapability.ArkUI.ArkUI.Full 31811 * @crossplatform 31812 * @form 31813 * @atomicservice 31814 * @since arkts {'1.1':'11','1.2':'20'} 31815 * @arkts 1.1&1.2 31816 */ 31817 end?: PixelRoundCalcPolicy; 31818 31819 /** 31820 * Rounding for alignment with the bottom edge. 31821 * 31822 * @type { ?PixelRoundCalcPolicy } 31823 * @default PixelRoundCalcPolicy.NO_FORCE_ROUND 31824 * @syscap SystemCapability.ArkUI.ArkUI.Full 31825 * @crossplatform 31826 * @form 31827 * @atomicservice 31828 * @since arkts {'1.1':'11','1.2':'20'} 31829 * @arkts 1.1&1.2 31830 */ 31831 bottom?: PixelRoundCalcPolicy; 31832} 31833 31834/** 31835 * Linear Gradient Blur Interface 31836 * 31837 * @interface LinearGradientBlurOptions 31838 * @syscap SystemCapability.ArkUI.ArkUI.Full 31839 * @atomicservice 31840 * @since arkts {'1.1':'12','1.2':'20'} 31841 * @arkts 1.1&1.2 31842 */ 31843declare interface LinearGradientBlurOptions { 31844 /** 31845 * Percentage of blurring effect. 31846 * 31847 * @type { FractionStop[] } 31848 * @syscap SystemCapability.ArkUI.ArkUI.Full 31849 * @atomicservice 31850 * @since arkts {'1.1':'12','1.2':'20'} 31851 * @arkts 1.1&1.2 31852 */ 31853 fractionStops: FractionStop[]; 31854 /** 31855 * Direction of linear gradient blur. 31856 * 31857 * @type { GradientDirection } 31858 * @syscap SystemCapability.ArkUI.ArkUI.Full 31859 * @atomicservice 31860 * @since arkts {'1.1':'12','1.2':'20'} 31861 * @arkts 1.1&1.2 31862 */ 31863 direction: GradientDirection; 31864} 31865 31866/** 31867 * Define motion blur anchor coordinates. 31868 * 31869 * @interface MotionBlurAnchor 31870 * @syscap SystemCapability.ArkUI.ArkUI.Full 31871 * @crossplatform 31872 * @atomicservice 31873 * @since arkts {'1.1':'12','1.2':'20'} 31874 * @arkts 1.1&1.2 31875 */ 31876declare interface MotionBlurAnchor { 31877 /** 31878 * Define anchor coordinate x-value.Value range [0.0, 1.0]. 31879 * 31880 * @type { number } 31881 * @syscap SystemCapability.ArkUI.ArkUI.Full 31882 * @atomicservice 31883 * @since arkts {'1.1':'12','1.2':'20'} 31884 * @arkts 1.1&1.2 31885 */ 31886 x: number; 31887 /** 31888 * Define anchor coordinate y-value.Value range [0.0, 1.0]. 31889 * 31890 * @type { number } 31891 * @syscap SystemCapability.ArkUI.ArkUI.Full 31892 * @atomicservice 31893 * @since arkts {'1.1':'12','1.2':'20'} 31894 * @arkts 1.1&1.2 31895 */ 31896 y: number; 31897} 31898 31899/** 31900 * Define motion blur options. 31901 * 31902 * @interface MotionBlurOptions 31903 * @syscap SystemCapability.ArkUI.ArkUI.Full 31904 * @crossplatform 31905 * @atomicservice 31906 * @since arkts {'1.1':'12','1.2':'20'} 31907 * @arkts 1.1&1.2 31908 */ 31909declare interface MotionBlurOptions { 31910 /** 31911 * Define the size of motion blur radius.The range of this value is [0.0, ∞). 31912 * 31913 * @type { number } 31914 * @syscap SystemCapability.ArkUI.ArkUI.Full 31915 * @atomicservice 31916 * @since arkts {'1.1':'12','1.2':'20'} 31917 * @arkts 1.1&1.2 31918 */ 31919 radius: number; 31920 /** 31921 * Define motion blur anchor coordinates. 31922 * 31923 * @type { MotionBlurAnchor } 31924 * @syscap SystemCapability.ArkUI.ArkUI.Full 31925 * @atomicservice 31926 * @since arkts {'1.1':'12','1.2':'20'} 31927 * @arkts 1.1&1.2 31928 */ 31929 anchor: MotionBlurAnchor; 31930} 31931 31932/** 31933 * Sub component border info. 31934 * 31935 * @interface LayoutBorderInfo 31936 * @syscap SystemCapability.ArkUI.ArkUI.Full 31937 * @form 31938 * @since 9 31939 * @deprecated since 10 31940 */ 31941declare interface LayoutBorderInfo { 31942 /** 31943 * Sub component borderWidth info. 31944 * 31945 * @type { EdgeWidths } 31946 * @syscap SystemCapability.ArkUI.ArkUI.Full 31947 * @form 31948 * @since 9 31949 * @deprecated since 10 31950 */ 31951 borderWidth: EdgeWidths; 31952 31953 /** 31954 * Sub component margin info. 31955 * 31956 * @type { Margin } 31957 * @syscap SystemCapability.ArkUI.ArkUI.Full 31958 * @form 31959 * @since 9 31960 * @deprecated since 10 31961 */ 31962 margin: Margin, 31963 31964 /** 31965 * Custom component padding info. 31966 * 31967 * @type { Padding } 31968 * @syscap SystemCapability.ArkUI.ArkUI.Full 31969 * @form 31970 * @since 9 31971 * @deprecated since 10 31972 */ 31973 padding: Padding, 31974} 31975 31976/** 31977 * Sub component layout info. 31978 * 31979 * @interface LayoutInfo 31980 * @syscap SystemCapability.ArkUI.ArkUI.Full 31981 * @form 31982 * @since 9 31983 * @deprecated since 10 31984 */ 31985declare interface LayoutInfo { 31986 /** 31987 * Sub component position info. 31988 * 31989 * @type { Position } 31990 * @syscap SystemCapability.ArkUI.ArkUI.Full 31991 * @form 31992 * @since 9 31993 * @deprecated since 10 31994 */ 31995 position: Position, 31996 31997 /** 31998 * Sub component constraint info. 31999 * 32000 * @type { ConstraintSizeOptions } 32001 * @syscap SystemCapability.ArkUI.ArkUI.Full 32002 * @form 32003 * @since 9 32004 * @deprecated since 10 32005 */ 32006 constraint: ConstraintSizeOptions, 32007} 32008 32009/** 32010 * Sub component info passed from framework when layout and measure happens. 32011 * 32012 * @interface LayoutChild 32013 * @syscap SystemCapability.ArkUI.ArkUI.Full 32014 * @form 32015 * @since 9 32016 * @deprecated since 10 32017 */ 32018declare interface LayoutChild { 32019 /** 32020 * Sub component name. 32021 * 32022 * @type { string } 32023 * @syscap SystemCapability.ArkUI.ArkUI.Full 32024 * @form 32025 * @since 9 32026 * @deprecated since 10 32027 */ 32028 name: string, 32029 32030 /** 32031 * Sub component id. 32032 * 32033 * @type { string } 32034 * @syscap SystemCapability.ArkUI.ArkUI.Full 32035 * @form 32036 * @since 9 32037 * @deprecated since 10 32038 */ 32039 id: string, 32040 32041 /** 32042 * Sub component constraint. 32043 * 32044 * @type { ConstraintSizeOptions } 32045 * @syscap SystemCapability.ArkUI.ArkUI.Full 32046 * @form 32047 * @since 9 32048 * @deprecated since 10 32049 */ 32050 constraint: ConstraintSizeOptions, 32051 32052 /** 32053 * Sub component border info. 32054 * 32055 * @type { LayoutBorderInfo } 32056 * @syscap SystemCapability.ArkUI.ArkUI.Full 32057 * @form 32058 * @since 9 32059 * @deprecated since 10 32060 */ 32061 borderInfo: LayoutBorderInfo, 32062 32063 /** 32064 * Sub component position. 32065 * 32066 * @type { Position } 32067 * @syscap SystemCapability.ArkUI.ArkUI.Full 32068 * @form 32069 * @since 9 32070 * @deprecated since 10 32071 */ 32072 position: Position, 32073 32074 /** 32075 * Call this measure method in onMeasure callback to supply sub component size. 32076 * 32077 * @param { ConstraintSizeOptions } childConstraint 32078 * @syscap SystemCapability.ArkUI.ArkUI.Full 32079 * @form 32080 * @since 9 32081 * @deprecated since 10 32082 */ 32083 measure(childConstraint: ConstraintSizeOptions), 32084 32085 /** 32086 * Call this layout method in onLayout callback to assign layout info to sub component. 32087 * 32088 * @param { LayoutInfo } childLayoutInfo 32089 * @syscap SystemCapability.ArkUI.ArkUI.Full 32090 * @form 32091 * @since 9 32092 * @deprecated since 10 32093 */ 32094 layout(childLayoutInfo: LayoutInfo), 32095} 32096 32097/** 32098 * Custom component layout info. 32099 * 32100 * @extends SizeResult 32101 * @interface GeometryInfo 32102 * @syscap SystemCapability.ArkUI.ArkUI.Full 32103 * @crossplatform 32104 * @since 10 32105 */ 32106/** 32107 * Custom component layout info. 32108 * 32109 * @extends SizeResult 32110 * @interface GeometryInfo 32111 * @syscap SystemCapability.ArkUI.ArkUI.Full 32112 * @crossplatform 32113 * @atomicservice 32114 * @since arkts {'1.1':'11','1.2':'20'} 32115 * @arkts 1.1&1.2 32116 */ 32117declare interface GeometryInfo extends SizeResult { 32118 /** 32119 * Custom component borderWidth info. 32120 * 32121 * @type { EdgeWidth } 32122 * @syscap SystemCapability.ArkUI.ArkUI.Full 32123 * @crossplatform 32124 * @since 10 32125 */ 32126 /** 32127 * Custom component borderWidth info. 32128 * 32129 * @type { EdgeWidth } 32130 * @syscap SystemCapability.ArkUI.ArkUI.Full 32131 * @crossplatform 32132 * @atomicservice 32133 * @since arkts {'1.1':'11','1.2':'20'} 32134 * @arkts 1.1&1.2 32135 */ 32136 borderWidth: EdgeWidth; 32137 32138 /** 32139 * Custom component margin info. 32140 * 32141 * @type { Margin } 32142 * @syscap SystemCapability.ArkUI.ArkUI.Full 32143 * @crossplatform 32144 * @since 10 32145 */ 32146 /** 32147 * Custom component margin info. 32148 * 32149 * @type { Margin } 32150 * @syscap SystemCapability.ArkUI.ArkUI.Full 32151 * @crossplatform 32152 * @atomicservice 32153 * @since arkts {'1.1':'11','1.2':'20'} 32154 * @arkts 1.1&1.2 32155 */ 32156 margin: Margin, 32157 32158 /** 32159 * Sub component padding info. 32160 * 32161 * @type { Padding } 32162 * @syscap SystemCapability.ArkUI.ArkUI.Full 32163 * @crossplatform 32164 * @since 10 32165 */ 32166 /** 32167 * Custom component padding info. 32168 * 32169 * @type { Padding } 32170 * @syscap SystemCapability.ArkUI.ArkUI.Full 32171 * @crossplatform 32172 * @atomicservice 32173 * @since arkts {'1.1':'11','1.2':'20'} 32174 * @arkts 1.1&1.2 32175 */ 32176 padding: Padding, 32177} 32178 32179/** 32180 * Sub component info passed from framework when layout happens. 32181 * 32182 * @interface Layoutable 32183 * @syscap SystemCapability.ArkUI.ArkUI.Full 32184 * @crossplatform 32185 * @since 10 32186 */ 32187/** 32188 * Provides the sub component layout information. 32189 * 32190 * @interface Layoutable 32191 * @syscap SystemCapability.ArkUI.ArkUI.Full 32192 * @crossplatform 32193 * @atomicservice 32194 * @since arkts {'1.1':'11','1.2':'20'} 32195 * @arkts 1.1&1.2 32196 */ 32197declare interface Layoutable { 32198 /** 32199 * Measurement result of the sub component. 32200 * 32201 * @type { MeasureResult } 32202 * @syscap SystemCapability.ArkUI.ArkUI.Full 32203 * @crossplatform 32204 * @since 10 32205 */ 32206 /** 32207 * Measurement result of the sub component. 32208 * 32209 * @type { MeasureResult } 32210 * @syscap SystemCapability.ArkUI.ArkUI.Full 32211 * @crossplatform 32212 * @atomicservice 32213 * @since arkts {'1.1':'11','1.2':'20'} 32214 * @arkts 1.1&1.2 32215 */ 32216 measureResult: MeasureResult, 32217 32218 /** 32219 * Unique ID of the sub component. 32220 * 32221 * @type { ?number } 32222 * @syscap SystemCapability.ArkUI.ArkUI.Full 32223 * @crossplatform 32224 * @atomicservice 32225 * @since arkts {'1.1':'18','1.2':'20'} 32226 * @arkts 1.1&1.2 32227 */ 32228 uniqueId?: number; 32229 32230 /** 32231 * Call this layout method in onLayout callback to assign layout info to sub component. 32232 * 32233 * @param { Position } position 32234 * @syscap SystemCapability.ArkUI.ArkUI.Full 32235 * @crossplatform 32236 * @since 10 32237 */ 32238 /** 32239 * Applies the specified position information to the sub component. 32240 * 32241 * @param { Position } position 32242 * @syscap SystemCapability.ArkUI.ArkUI.Full 32243 * @crossplatform 32244 * @atomicservice 32245 * @since arkts {'1.1':'11','1.2':'20'} 32246 * @arkts 1.1&1.2 32247 */ 32248 layout(position: Position): void, 32249 32250 /** 32251 * Obtains the margin of the sub component. 32252 * 32253 * @returns { DirectionalEdgesT<number> } the margin of sub component, unit is vp 32254 * @syscap SystemCapability.ArkUI.ArkUI.Full 32255 * @crossplatform 32256 * @atomicservice 32257 * @since arkts {'1.1':'12','1.2':'20'} 32258 * @arkts 1.1&1.2 32259 */ 32260 getMargin() : DirectionalEdgesT<number>, 32261 32262 /** 32263 * Call this method to get the padding of sub component. 32264 * 32265 * @returns { DirectionalEdgesT<number> } Padding of the sub component, unit is vp. 32266 * @syscap SystemCapability.ArkUI.ArkUI.Full 32267 * @crossplatform 32268 * @atomicservice 32269 * @since arkts {'1.1':'12','1.2':'20'} 32270 * @arkts 1.1&1.2 32271 */ 32272 getPadding() : DirectionalEdgesT<number>, 32273 32274 /** 32275 * Obtains the border width of the sub component. 32276 * 32277 * @returns { DirectionalEdgesT<number> } the borderWidth of sub component, unit is vp 32278 * @syscap SystemCapability.ArkUI.ArkUI.Full 32279 * @crossplatform 32280 * @atomicservice 32281 * @since arkts {'1.1':'12','1.2':'20'} 32282 * @arkts 1.1&1.2 32283 */ 32284 getBorderWidth() : DirectionalEdgesT<number>, 32285} 32286 32287/** 32288 * Sub component info passed from framework when measure happens. 32289 * 32290 * @interface Measurable 32291 * @syscap SystemCapability.ArkUI.ArkUI.Full 32292 * @crossplatform 32293 * @since 10 32294 */ 32295/** 32296 * Sub component info passed from framework when measure happens. 32297 * 32298 * @interface Measurable 32299 * @syscap SystemCapability.ArkUI.ArkUI.Full 32300 * @crossplatform 32301 * @atomicservice 32302 * @since arkts {'1.1':'11','1.2':'20'} 32303 * @arkts 1.1&1.2 32304 */ 32305declare interface Measurable { 32306 /** 32307 * Unique ID that the system assigns to the sub component. 32308 * 32309 * @type { ?number } 32310 * @syscap SystemCapability.ArkUI.ArkUI.Full 32311 * @crossplatform 32312 * @atomicservice 32313 * @since arkts {'1.1':'18','1.2':'20'} 32314 * @arkts 1.1&1.2 32315 */ 32316 uniqueId?: number; 32317 32318 /** 32319 * Call this measure method in onMeasure callback to supply sub component size. 32320 * 32321 * @param { ConstraintSizeOptions } constraint 32322 * @returns { MeasureResult } 32323 * @syscap SystemCapability.ArkUI.ArkUI.Full 32324 * @crossplatform 32325 * @since 10 32326 */ 32327 /** 32328 * Applies the size constraint to the sub component. 32329 * 32330 * @param { ConstraintSizeOptions } constraint 32331 * @returns { MeasureResult } Provides the measurement result of the component. 32332 * @syscap SystemCapability.ArkUI.ArkUI.Full 32333 * @crossplatform 32334 * @atomicservice 32335 * @since arkts {'1.1':'11','1.2':'20'} 32336 * @arkts 1.1&1.2 32337 */ 32338 measure(constraint: ConstraintSizeOptions) : MeasureResult, 32339 32340 /** 32341 * Obtains the margin of the sub component. 32342 * 32343 * @returns { DirectionalEdgesT<number> } Margin of the sub component, unit is vp. 32344 * @syscap SystemCapability.ArkUI.ArkUI.Full 32345 * @crossplatform 32346 * @atomicservice 32347 * @since arkts {'1.1':'12','1.2':'20'} 32348 * @arkts 1.1&1.2 32349 */ 32350 getMargin() : DirectionalEdgesT<number>, 32351 32352 /** 32353 * Obtains the padding of the sub component. 32354 * 32355 * @returns { DirectionalEdgesT<number> } the padding of sub component, unit is vp 32356 * @syscap SystemCapability.ArkUI.ArkUI.Full 32357 * @crossplatform 32358 * @atomicservice 32359 * @since arkts {'1.1':'12','1.2':'20'} 32360 * @arkts 1.1&1.2 32361 */ 32362 getPadding() : DirectionalEdgesT<number>, 32363 32364 /** 32365 * Obtains the border width of the sub component. 32366 * 32367 * @returns { DirectionalEdgesT<number> } Border width of the sub component, unit is vp. 32368 * @syscap SystemCapability.ArkUI.ArkUI.Full 32369 * @crossplatform 32370 * @atomicservice 32371 * @since arkts {'1.1':'12','1.2':'20'} 32372 * @arkts 1.1&1.2 32373 */ 32374 getBorderWidth() : DirectionalEdgesT<number>, 32375} 32376 32377/** 32378 * Component SizeResult info. 32379 * 32380 * @interface SizeResult 32381 * @syscap SystemCapability.ArkUI.ArkUI.Full 32382 * @crossplatform 32383 * @since 10 32384 */ 32385/** 32386 * Provides the component size information. 32387 * 32388 * @interface SizeResult 32389 * @syscap SystemCapability.ArkUI.ArkUI.Full 32390 * @crossplatform 32391 * @atomicservice 32392 * @since arkts {'1.1':'11','1.2':'20'} 32393 * @arkts 1.1&1.2 32394 */ 32395declare interface SizeResult { 32396 /** 32397 * Width obtained from the measurement result. 32398 * 32399 * @type { number } 32400 * @syscap SystemCapability.ArkUI.ArkUI.Full 32401 * @crossplatform 32402 * @since 10 32403 */ 32404 /** 32405 * Width obtained from the measurement result. Unit: vp. 32406 * 32407 * @type { number } 32408 * @syscap SystemCapability.ArkUI.ArkUI.Full 32409 * @crossplatform 32410 * @atomicservice 32411 * @since arkts {'1.1':'11','1.2':'20'} 32412 * @arkts 1.1&1.2 32413 */ 32414 width: number, 32415 32416 /** 32417 * Height obtained from the measurement result. 32418 * 32419 * @type { number } 32420 * @syscap SystemCapability.ArkUI.ArkUI.Full 32421 * @crossplatform 32422 * @since 10 32423 */ 32424 /** 32425 * Height obtained from the measurement result. Unit: vp. 32426 * 32427 * @type { number } 32428 * @syscap SystemCapability.ArkUI.ArkUI.Full 32429 * @crossplatform 32430 * @atomicservice 32431 * @since arkts {'1.1':'11','1.2':'20'} 32432 * @arkts 1.1&1.2 32433 */ 32434 height: number, 32435} 32436 32437/** 32438 * Component MeasureResult info. 32439 * 32440 * @extends SizeResult 32441 * @interface MeasureResult 32442 * @syscap SystemCapability.ArkUI.ArkUI.Full 32443 * @crossplatform 32444 * @since 10 32445 */ 32446/** 32447 * Provides the measurement result of the component. 32448 * 32449 * @extends SizeResult 32450 * @interface MeasureResult 32451 * @syscap SystemCapability.ArkUI.ArkUI.Full 32452 * @crossplatform 32453 * @atomicservice 32454 * @since arkts {'1.1':'11','1.2':'20'} 32455 * @arkts 1.1&1.2 32456 */ 32457declare interface MeasureResult extends SizeResult { 32458 32459} 32460 32461/** 32462 * The navigation destination information. 32463 * 32464 * @syscap SystemCapability.ArkUI.ArkUI.Full 32465 * @crossplatform 32466 * @since 11 32467 */ 32468/** 32469 * The navigation destination information. 32470 * 32471 * @typedef {import('../api/@ohos.arkui.observer').default.NavDestinationInfo} NavDestinationInfo 32472 * @syscap SystemCapability.ArkUI.ArkUI.Full 32473 * @crossplatform 32474 * @atomicservice 32475 * @since 12 32476 */ 32477declare type NavDestinationInfo = import('../api/@ohos.arkui.observer').default.NavDestinationInfo; 32478 32479 32480/** 32481 * The navigation destination information. 32482 * 32483 * @typedef {uiObserver.NavDestinationInfo} NavDestinationInfo 32484 * @syscap SystemCapability.ArkUI.ArkUI.Full 32485 * @crossplatform 32486 * @atomicservice 32487 * @since 20 32488 * @arkts 1.2 32489 */ 32490declare type NavDestinationInfo = uiObserver.NavDestinationInfo; 32491/** 32492 * The navigation information. 32493 * 32494 * @typedef { uiObserver.NavigationInfo } NavigationInfo 32495 * @syscap SystemCapability.ArkUI.ArkUI.Full 32496 * @crossplatform 32497 * @atomicservice 32498 * @since 20 32499 * @arkts 1.2 32500 */ 32501declare type NavigationInfo = uiObserver.NavigationInfo; 32502 32503/** 32504 * The navigation information. 32505 * 32506 * @typedef {import('../api/@ohos.arkui.observer').default.NavigationInfo} NavigationInfo 32507 * @syscap SystemCapability.ArkUI.ArkUI.Full 32508 * @crossplatform 32509 * @atomicservice 32510 * @since 12 32511 */ 32512declare type NavigationInfo = import('../api/@ohos.arkui.observer').default.NavigationInfo; 32513 32514/** 32515 * The router page information. 32516 * 32517 * @typedef {import('../api/@ohos.arkui.observer').default.RouterPageInfo} RouterPageInfo 32518 * @syscap SystemCapability.ArkUI.ArkUI.Full 32519 * @crossplatform 32520 * @atomicservice 32521 * @since 12 32522 */ 32523declare type RouterPageInfo = import('../api/@ohos.arkui.observer').default.RouterPageInfo; 32524 32525/** 32526 * The router page information. 32527 * 32528 * @typedef {uiObserver.RouterPageInfo} RouterPageInfo 32529 * @syscap SystemCapability.ArkUI.ArkUI.Full 32530 * @crossplatform 32531 * @atomicservice 32532 * @since 20 32533 * @arkts 1.2 32534 */ 32535declare type RouterPageInfo = uiObserver.RouterPageInfo; 32536 32537/** 32538 * UIContext 32539 * 32540 * @syscap SystemCapability.ArkUI.ArkUI.Full 32541 * @crossplatform 32542 * @since 11 32543 */ 32544/** 32545 * UIContext 32546 * 32547 * @typedef { import('../api/@ohos.arkui.UIContext').UIContext } UIContext 32548 * @syscap SystemCapability.ArkUI.ArkUI.Full 32549 * @crossplatform 32550 * @atomicservice 32551 * @since 12 32552 */ 32553declare type UIContext = import('../api/@ohos.arkui.UIContext').UIContext; 32554 32555/** 32556 * DrawContext 32557 * 32558 * @typedef { import('../api/arkui/Graphics').DrawContext } DrawContext 32559 * @syscap SystemCapability.ArkUI.ArkUI.Full 32560 * @crossplatform 32561 * @atomicservice 32562 * @since 12 32563 */ 32564declare type DrawContext = import('../api/arkui/Graphics').DrawContext; 32565 32566/** 32567 * VisualEffect 32568 * 32569 * @typedef { import('../api/@ohos.graphics.uiEffect').default.VisualEffect } VisualEffect 32570 * @syscap SystemCapability.ArkUI.ArkUI.Full 32571 * @crossplatform 32572 * @atomicservice 32573 * @since 12 32574 */ 32575declare type VisualEffect = import('../api/@ohos.graphics.uiEffect').default.VisualEffect; 32576 32577/** 32578 * VisualEffect 32579 * 32580 * @typedef { import('../api/@ohos.graphics.uiEffect').default.VisualEffect } VisualEffect 32581 * @syscap SystemCapability.ArkUI.ArkUI.Full 32582 * @crossplatform 32583 * @atomicservice 32584 * @since 20 32585 * @arkts 1.2 32586 */ 32587declare type VisualEffect = uiEffect.VisualEffect; 32588 32589 32590/** 32591 * Filter 32592 * 32593 * @typedef { import('../api/@ohos.graphics.uiEffect').default.Filter } Filter 32594 * @syscap SystemCapability.ArkUI.ArkUI.Full 32595 * @crossplatform 32596 * @atomicservice 32597 * @since 12 32598 */ 32599declare type Filter = import('../api/@ohos.graphics.uiEffect').default.Filter; 32600 32601/** 32602 * Filter 32603 * 32604 * @typedef { import('../api/@ohos.graphics.uiEffect').default.Filter } Filter 32605 * @syscap SystemCapability.ArkUI.ArkUI.Full 32606 * @crossplatform 32607 * @atomicservice 32608 * @since 20 32609 * @arkts 1.2 32610 */ 32611declare type Filter = uiEffect.Filter; 32612 32613/** 32614 * Blender 32615 * 32616 * @typedef { import('../api/@ohos.graphics.uiEffect').default.Blender } Blender 32617 * @syscap SystemCapability.ArkUI.ArkUI.Full 32618 * @systemapi 32619 * @form 32620 * @since 13 32621 */ 32622declare type Blender = import('../api/@ohos.graphics.uiEffect').default.Blender; 32623 32624/** 32625 * Blender 32626 * 32627 * @typedef { import('../api/@ohos.graphics.uiEffect').default.Blender } Blender 32628 * @syscap SystemCapability.ArkUI.ArkUI.Full 32629 * @systemapi 32630 * @form 32631 * @since 20 32632 * @arkts 1.2 32633 */ 32634declare type Blender = uiEffect.Blender; 32635 32636/** 32637 * ComponentContent. 32638 * 32639 * @typedef {import('../api/arkui/ComponentContent').ComponentContent<T>} ComponentContent<T = Object> 32640 * @syscap SystemCapability.ArkUI.ArkUI.Full 32641 * @crossplatform 32642 * @atomicservice 32643 * @since 12 32644 */ 32645declare type ComponentContent<T = Object> = import('../api/arkui/ComponentContent').ComponentContent<T>; 32646 32647/** 32648 * Theme. 32649 * 32650 * @typedef {import('../api/@ohos.arkui.theme').Theme} Theme 32651 * @syscap SystemCapability.ArkUI.ArkUI.Full 32652 * @crossplatform 32653 * @atomicservice 32654 * @since 12 32655 */ 32656declare type Theme = import('../api/@ohos.arkui.theme').Theme; 32657 32658/** 32659 * Import the DialogController type from promptAction. 32660 * 32661 * @typedef { import('../api/@ohos.promptAction').promptAction.DialogController } PromptActionDialogController 32662 * @syscap SystemCapability.ArkUI.ArkUI.Full 32663 * @atomicservice 32664 * @since 18 32665 */ 32666declare type PromptActionDialogController = import('../api/@ohos.promptAction').promptAction.DialogController; 32667 32668/** 32669 * Import the DialogController type from promptAction. 32670 * 32671 * @typedef { promptAction.DialogController } PromptActionDialogController 32672 * @syscap SystemCapability.ArkUI.ArkUI.Full 32673 * @atomicservice 32674 * @since 20 32675 * @arkts 1.2 32676 */ 32677declare type PromptActionDialogController = promptAction.DialogController; 32678 32679/** 32680 * Custom Component 32681 * 32682 * @extends CommonAttribute 32683 * @syscap SystemCapability.ArkUI.ArkUI.Full 32684 * @since 7 32685 */ 32686/** 32687 * Custom Component 32688 * 32689 * @extends CommonAttribute 32690 * @syscap SystemCapability.ArkUI.ArkUI.Full 32691 * @form 32692 * @since 9 32693 */ 32694/** 32695 * Custom Component 32696 * 32697 * @extends CommonAttribute 32698 * @syscap SystemCapability.ArkUI.ArkUI.Full 32699 * @crossplatform 32700 * @form 32701 * @since 10 32702 */ 32703/** 32704 * Custom Component 32705 * 32706 * @extends CommonAttribute 32707 * @syscap SystemCapability.ArkUI.ArkUI.Full 32708 * @crossplatform 32709 * @form 32710 * @atomicservice 32711 * @since 11 32712 */ 32713/** 32714 * Custom Component 32715 * 32716 * @extends BaseCustomComponent 32717 * @syscap SystemCapability.ArkUI.ArkUI.Full 32718 * @crossplatform 32719 * @form 32720 * @atomicservice 32721 * @since 18 32722 */ 32723declare class CustomComponent extends BaseCustomComponent { 32724 /** 32725 * Invoked when a reusable custom component is re-added to the node tree 32726 * from the reuse cache to receive construction parameters of the component. 32727 * 32728 * @param { object } params - Custom component init params. 32729 * @syscap SystemCapability.ArkUI.ArkUI.Full 32730 * @crossplatform 32731 * @since 10 32732 */ 32733 /** 32734 * Invoked when a reusable custom component is re-added to the node tree 32735 * from the reuse cache to receive construction parameters of the component. 32736 * 32737 * @param { object } params - Custom component init params. 32738 * @syscap SystemCapability.ArkUI.ArkUI.Full 32739 * @crossplatform 32740 * @atomicservice 32741 * @since 11 32742 */ 32743 /** 32744 * Invoked when a reusable custom component is re-added to the node tree 32745 * from the reuse cache to receive construction parameters of the component. 32746 * 32747 * @param { Record<string, Object | undefined | null> } params - Custom component init params. 32748 * @syscap SystemCapability.ArkUI.ArkUI.Full 32749 * @crossplatform 32750 * @atomicservice 32751 * @since 20 32752 */ 32753 aboutToReuse?(params: Record<string, Object | undefined | null>): void; 32754 32755 /** 32756 * Custom component override this method to layout each of its sub components. 32757 * 32758 * @param { Array<LayoutChild> } children 32759 * @param { ConstraintSizeOptions } constraint 32760 * @syscap SystemCapability.ArkUI.ArkUI.Full 32761 * @form 32762 * @since 9 32763 * @deprecated since 10 32764 * @useinstead CustomComponent#onPlaceChildren 32765 */ 32766 onLayout?(children: Array<LayoutChild>, constraint: ConstraintSizeOptions): void; 32767 32768 /** 32769 * Custom component override this method to measure each of its sub components. 32770 * 32771 * @param { Array<LayoutChild> } children 32772 * @param { ConstraintSizeOptions } constraint 32773 * @syscap SystemCapability.ArkUI.ArkUI.Full 32774 * @form 32775 * @since 9 32776 * @deprecated since 10 32777 * @useinstead CustomComponent#onMeasureSize 32778 */ 32779 onMeasure?(children: Array<LayoutChild>, constraint: ConstraintSizeOptions): void; 32780} 32781 32782/** 32783 * Custom ComponentV2 32784 * 32785 * @extends BaseCustomComponent 32786 * @syscap SystemCapability.ArkUI.ArkUI.Full 32787 * @crossplatform 32788 * @form 32789 * @atomicservice 32790 * @since 18 32791 */ 32792declare class CustomComponentV2 extends BaseCustomComponent { 32793 /** 32794 * Invoked when a reusable custom component managed by state management V2 32795 * is taken from the reuse pool and reinserted into the node tree. 32796 * 32797 * @syscap SystemCapability.ArkUI.ArkUI.Full 32798 * @crossplatform 32799 * @atomicservice 32800 * @since 18 32801 */ 32802 aboutToReuse?(): void; 32803} 32804 32805/** 32806 * Custom Component base class and it is migrated from class CustomComponent. 32807 * 32808 * @extends BaseCustomComponent 32809 * @syscap SystemCapability.ArkUI.ArkUI.Full 32810 * @crossplatform 32811 * @form 32812 * @atomicservice 32813 * @since 18 32814 */ 32815declare class BaseCustomComponent extends CommonAttribute { 32816 /** 32817 * Customize the pop-up content constructor . 32818 * 32819 * @syscap SystemCapability.ArkUI.ArkUI.Full 32820 * @since 7 32821 */ 32822 /** 32823 * Customize the pop-up content constructor. 32824 * 32825 * @syscap SystemCapability.ArkUI.ArkUI.Full 32826 * @form 32827 * @since 9 32828 */ 32829 /** 32830 * Customize the pop-up content constructor. 32831 * 32832 * @syscap SystemCapability.ArkUI.ArkUI.Full 32833 * @crossplatform 32834 * @form 32835 * @since 10 32836 */ 32837 /** 32838 * Customize the pop-up content constructor. 32839 * 32840 * @syscap SystemCapability.ArkUI.ArkUI.Full 32841 * @crossplatform 32842 * @form 32843 * @atomicservice 32844 * @since 11 32845 */ 32846 /** 32847 * Customize the pop-up content constructor and it is migrated from class CustomComponent. 32848 * 32849 * @syscap SystemCapability.ArkUI.ArkUI.Full 32850 * @crossplatform 32851 * @form 32852 * @atomicservice 32853 * @since 18 32854 */ 32855 build(): void; 32856 32857 /** 32858 * Invoked after a new instance of the custom component is created 32859 * and before its build() function is executed. You can change state variables in aboutToAppear. 32860 * The change will take effect when you execute the build() function next time. 32861 * The aboutToAppear lifecycle callback of a custom component with a custom layout 32862 * is invoked during the layout process. 32863 * @syscap SystemCapability.ArkUI.ArkUI.Full 32864 * @since 7 32865 */ 32866 /** 32867 * Invoked after a new instance of the custom component is created 32868 * and before its build() function is executed. You can change state variables in aboutToAppear. 32869 * The change will take effect when you execute the build() function next time. 32870 * The aboutToAppear lifecycle callback of a custom component with a custom layout 32871 * is invoked during the layout process. 32872 * @syscap SystemCapability.ArkUI.ArkUI.Full 32873 * @form 32874 * @since 9 32875 */ 32876 /** 32877 * Invoked after a new instance of the custom component is created 32878 * and before its build() function is executed. You can change state variables in aboutToAppear. 32879 * The change will take effect when you execute the build() function next time. 32880 * The aboutToAppear lifecycle callback of a custom component with a custom layout 32881 * is invoked during the layout process. 32882 * @syscap SystemCapability.ArkUI.ArkUI.Full 32883 * @crossplatform 32884 * @form 32885 * @since 10 32886 */ 32887 /** 32888 * Invoked after a new instance of the custom component is created 32889 * and before its build() function is executed. You can change state variables in aboutToAppear. 32890 * The change will take effect when you execute the build() function next time. 32891 * The aboutToAppear lifecycle callback of a custom component with a custom layout 32892 * is invoked during the layout process. 32893 * @syscap SystemCapability.ArkUI.ArkUI.Full 32894 * @crossplatform 32895 * @form 32896 * @atomicservice 32897 * @since 11 32898 */ 32899 /** 32900 * Invoked after a new instance of the custom component is created 32901 * and before its build() function is executed. You can change state variables in aboutToAppear. 32902 * The change will take effect when you execute the build() function next time. 32903 * The aboutToAppear lifecycle callback of a custom component with a custom layout 32904 * is invoked during the layout process. 32905 * @syscap SystemCapability.ArkUI.ArkUI.Full 32906 * @crossplatform 32907 * @form 32908 * @atomicservice 32909 * @since 18 32910 */ 32911 aboutToAppear?(): void; 32912 32913 /** 32914 * Invoked when this component is about to disappear. 32915 * Do not change state variables in the aboutToDisappear function as doing this can cause unexpected errors. 32916 * For example, the modification of the @Link decorated variable may cause unstable application running. 32917 * @syscap SystemCapability.ArkUI.ArkUI.Full 32918 * @since 7 32919 */ 32920 /** 32921 * Invoked when this component is about to disappear. 32922 * Do not change state variables in the aboutToDisappear function as doing this can cause unexpected errors. 32923 * For example, the modification of the @Link decorated variable may cause unstable application running. 32924 * @syscap SystemCapability.ArkUI.ArkUI.Full 32925 * @form 32926 * @since 9 32927 */ 32928 /** 32929 * Invoked when this component is about to disappear. 32930 * Do not change state variables in the aboutToDisappear function as doing this can cause unexpected errors. 32931 * For example, the modification of the @Link decorated variable may cause unstable application running. 32932 * @syscap SystemCapability.ArkUI.ArkUI.Full 32933 * @crossplatform 32934 * @form 32935 * @since 10 32936 */ 32937 /** 32938 * Invoked when this component is about to disappear. 32939 * Do not change state variables in the aboutToDisappear function as doing this can cause unexpected errors. 32940 * For example, the modification of the @Link decorated variable may cause unstable application running. 32941 * @syscap SystemCapability.ArkUI.ArkUI.Full 32942 * @crossplatform 32943 * @form 32944 * @atomicservice 32945 * @since 11 32946 */ 32947 /** 32948 * Invoked when this component is about to disappear. 32949 * Do not change state variables in the aboutToDisappear function as doing this can cause unexpected errors. 32950 * For example, the modification of the @Link decorated variable may cause unstable application running. 32951 * @syscap SystemCapability.ArkUI.ArkUI.Full 32952 * @crossplatform 32953 * @form 32954 * @atomicservice 32955 * @since 18 32956 */ 32957 aboutToDisappear?(): void; 32958 32959 /** 32960 * aboutToRecycle Method 32961 * 32962 * @syscap SystemCapability.ArkUI.ArkUI.Full 32963 * @crossplatform 32964 * @since 10 32965 */ 32966 /** 32967 * aboutToRecycle Method 32968 * 32969 * @syscap SystemCapability.ArkUI.ArkUI.Full 32970 * @crossplatform 32971 * @atomicservice 32972 * @since 11 32973 */ 32974 /** 32975 * aboutToRecycle Method and it is migrated from class CustomComponent. 32976 * 32977 * @syscap SystemCapability.ArkUI.ArkUI.Full 32978 * @crossplatform 32979 * @atomicservice 32980 * @since 18 32981 */ 32982 aboutToRecycle?(): void; 32983 32984 /** 32985 * The onWillApplyTheme function is a custom hook to get active theme object from the context 32986 * 32987 * @param { Theme } theme - Custom theme init params. 32988 * @syscap SystemCapability.ArkUI.ArkUI.Full 32989 * @crossplatform 32990 * @atomicservice 32991 * @since 12 32992 */ 32993 /** 32994 * The onWillApplyTheme function is a custom hook to get active theme object from the context, it is migrated from class CustomComponent. 32995 * 32996 * @param { Theme } theme - Custom theme init params. 32997 * @syscap SystemCapability.ArkUI.ArkUI.Full 32998 * @crossplatform 32999 * @atomicservice 33000 * @since 18 33001 */ 33002 onWillApplyTheme?(theme: Theme): void; 33003 33004 /** 33005 * Custom component override this method to layout each of its sub components. 33006 * 33007 * @param { GeometryInfo } selfLayoutInfo 33008 * @param { Array<Layoutable> } children 33009 * @param { ConstraintSizeOptions } constraint 33010 * @syscap SystemCapability.ArkUI.ArkUI.Full 33011 * @crossplatform 33012 * @since 10 33013 */ 33014 /** 33015 * Custom component override this method to layout each of its sub components. 33016 * 33017 * @param { GeometryInfo } selfLayoutInfo 33018 * @param { Array<Layoutable> } children 33019 * @param { ConstraintSizeOptions } constraint 33020 * @syscap SystemCapability.ArkUI.ArkUI.Full 33021 * @crossplatform 33022 * @atomicservice 33023 * @since 11 33024 */ 33025 /** 33026 * Custom component override this method to layout each of its sub components, it is migrated from class CustomComponent. 33027 * 33028 * @param { GeometryInfo } selfLayoutInfo 33029 * @param { Array<Layoutable> } children 33030 * @param { ConstraintSizeOptions } constraint 33031 * @syscap SystemCapability.ArkUI.ArkUI.Full 33032 * @crossplatform 33033 * @atomicservice 33034 * @since 18 33035 */ 33036 onPlaceChildren?(selfLayoutInfo: GeometryInfo, children: Array<Layoutable>, constraint: ConstraintSizeOptions): void; 33037 33038 /** 33039 * Custom component override this method to measure each of its sub components. 33040 * @param { GeometryInfo } selfLayoutInfo 33041 * @param { Array<Measurable> } children - indicate the measure child 33042 * @param { ConstraintSizeOptions } constraint - indicate child constraint size 33043 * @returns { SizeResult } 33044 * @syscap SystemCapability.ArkUI.ArkUI.Full 33045 * @crossplatform 33046 * @since 10 33047 */ 33048 /** 33049 * Custom component override this method to measure each of its sub components. 33050 * @param { GeometryInfo } selfLayoutInfo 33051 * @param { Array<Measurable> } children - indicate the measure child 33052 * @param { ConstraintSizeOptions } constraint - indicate child constraint size 33053 * @returns { SizeResult } 33054 * @syscap SystemCapability.ArkUI.ArkUI.Full 33055 * @crossplatform 33056 * @atomicservice 33057 * @since 11 33058 */ 33059 /** 33060 * Custom component override this method to measure each of its sub components, it is migrated from class CustomComponent. 33061 * @param { GeometryInfo } selfLayoutInfo 33062 * @param { Array<Measurable> } children - indicate the measure child 33063 * @param { ConstraintSizeOptions } constraint - indicate child constraint size 33064 * @returns { SizeResult } 33065 * @syscap SystemCapability.ArkUI.ArkUI.Full 33066 * @crossplatform 33067 * @atomicservice 33068 * @since 18 33069 */ 33070 onMeasureSize?(selfLayoutInfo: GeometryInfo, children: Array<Measurable>, constraint: ConstraintSizeOptions): SizeResult; 33071 33072 /** 33073 * Invoked each time the page is displayed, for example, during page redirection. 33074 * When the application is switched to the foreground. 33075 * It works only for the custom components decorated by **@Entry**. 33076 * 33077 * @syscap SystemCapability.ArkUI.ArkUI.Full 33078 * @since 7 33079 */ 33080 /** 33081 * Invoked each time the page is displayed, for example, during page redirection. 33082 * When the application is switched to the foreground. 33083 * It works only for the custom components decorated by **@Entry**. 33084 * 33085 * @syscap SystemCapability.ArkUI.ArkUI.Full 33086 * @crossplatform 33087 * @since 10 33088 */ 33089 /** 33090 * Invoked each time the page is displayed, for example, during page redirection. 33091 * When the application is switched to the foreground. 33092 * It works only for the custom components decorated by **@Entry**. 33093 * 33094 * @syscap SystemCapability.ArkUI.ArkUI.Full 33095 * @crossplatform 33096 * @atomicservice 33097 * @since 11 33098 */ 33099 /** 33100 * Invoked each time the page is displayed, for example, during page redirection. 33101 * When the application is switched to the foreground. 33102 * It works only for the custom components decorated by **@Entry**. 33103 * 33104 * @syscap SystemCapability.ArkUI.ArkUI.Full 33105 * @crossplatform 33106 * @atomicservice 33107 * @since 18 33108 */ 33109 onPageShow?(): void; 33110 33111 /** 33112 * Invoked each time the page is hidden, for example, during page redirection. 33113 * When the application is switched to the background. 33114 * It works only for the custom components decorated by **@Entry**. 33115 * 33116 * @syscap SystemCapability.ArkUI.ArkUI.Full 33117 * @since 7 33118 */ 33119 /** 33120 * Invoked each time the page is hidden, for example, during page redirection. 33121 * When the application is switched to the background. 33122 * It works only for the custom components decorated by **@Entry**. 33123 * 33124 * @syscap SystemCapability.ArkUI.ArkUI.Full 33125 * @crossplatform 33126 * @since 10 33127 */ 33128 /** 33129 * Invoked each time the page is hidden, for example, during page redirection. 33130 * When the application is switched to the background. 33131 * It works only for the custom components decorated by **@Entry**. 33132 * 33133 * @syscap SystemCapability.ArkUI.ArkUI.Full 33134 * @crossplatform 33135 * @atomicservice 33136 * @since 11 33137 */ 33138 /** 33139 * Invoked each time the page is hidden, for example, during page redirection. 33140 * When the application is switched to the background. 33141 * It works only for the custom components decorated by **@Entry**. 33142 * 33143 * @syscap SystemCapability.ArkUI.ArkUI.Full 33144 * @crossplatform 33145 * @atomicservice 33146 * @since 18 33147 */ 33148 onPageHide?(): void; 33149 33150 /** 33151 * onFormRecycle Method, this is only for ArkTS form, if form was marked recyclable by form user, when system memory is low, 33152 * it will be recycled after calling this method, you should return a string of params that you wish to be saved, it will be 33153 * passed back as params in onFormRecover, in which you can recover the form 33154 * 33155 * @returns { string } status data of ArkTS form UI, this data will be passed in when recover form later 33156 * @syscap SystemCapability.ArkUI.ArkUI.Full 33157 * @crossplatform 33158 * @form 33159 * @since 11 33160 */ 33161 /** 33162 * onFormRecycle Method, this is only for ArkTS form, if form was marked recyclable by form user, when system memory is low, 33163 * it will be recycled after calling this method, you should return a string of params that you wish to be saved, it will be 33164 * passed back as params in onFormRecover, in which you can recover the form 33165 * 33166 * @returns { string } status data of ArkTS form UI, this data will be passed in when recover form later 33167 * @syscap SystemCapability.ArkUI.ArkUI.Full 33168 * @crossplatform 33169 * @form 33170 * @atomicservice 33171 * @since 12 33172 */ 33173 /** 33174 * onFormRecycle Method, this is only for ArkTS form, if form was marked recyclable by form user, when system memory is low, 33175 * it will be recycled after calling this method, you should return a string of params that you wish to be saved, it will be 33176 * passed back as params in onFormRecover, in which you can recover the form, it is migrated from class CustomComponent. 33177 * 33178 * @returns { string } status data of ArkTS form UI, this data will be passed in when recover form later 33179 * @syscap SystemCapability.ArkUI.ArkUI.Full 33180 * @crossplatform 33181 * @form 33182 * @atomicservice 33183 * @since 18 33184 */ 33185 onFormRecycle?(): string; 33186 33187 /** 33188 * onFormRecover Method, this is only for ArkTS form 33189 * 33190 * @param { string } statusData - indicate status data of ArkTS form UI, which is acquired by calling onFormRecycle, it is used to recover form 33191 * @syscap SystemCapability.ArkUI.ArkUI.Full 33192 * @crossplatform 33193 * @form 33194 * @since 11 33195 */ 33196 /** 33197 * onFormRecover Method, this is only for ArkTS form 33198 * 33199 * @param { string } statusData - indicate status data of ArkTS form UI, which is acquired by calling onFormRecycle, it is used to recover form 33200 * @syscap SystemCapability.ArkUI.ArkUI.Full 33201 * @crossplatform 33202 * @form 33203 * @atomicservice 33204 * @since 12 33205 */ 33206 /** 33207 * onFormRecover Method, this is only for ArkTS form, it is migrated from class CustomComponent. 33208 * 33209 * @param { string } statusData - indicate status data of ArkTS form UI, which is acquired by calling onFormRecycle, it is used to recover form 33210 * @syscap SystemCapability.ArkUI.ArkUI.Full 33211 * @crossplatform 33212 * @form 33213 * @atomicservice 33214 * @since arkts {'1.1':'18','1.2':'20'} 33215 * @arkts 1.1&1.2 33216 */ 33217 onFormRecover?(statusData: string): void; 33218 33219 33220 /** 33221 * onBackPress Method 33222 * 33223 * Invoked when the user clicks the Back button. 33224 * It works only for the custom components decorated by @Entry. 33225 * The value **true** means that the page executes its own return logic. 33226 * And **false** (default) means that the default return logic is used. 33227 * 33228 * @returns { void | boolean } 33229 * @syscap SystemCapability.ArkUI.ArkUI.Full 33230 * @since 7 33231 */ 33232 /** 33233 * onBackPress Method 33234 * 33235 * Invoked when the user clicks the Back button. 33236 * It works only for the custom components decorated by @Entry. 33237 * The value **true** means that the page executes its own return logic. 33238 * And **false** (default) means that the default return logic is used. 33239 * 33240 * @returns { void | boolean } true means that the page itself processes the return logic. 33241 * false means that the default return logic is used. 33242 * If no value is returned, the default return logic is used. 33243 * @syscap SystemCapability.ArkUI.ArkUI.Full 33244 * @crossplatform 33245 * @since 10 33246 */ 33247 /** 33248 * onBackPress Method 33249 * 33250 * Invoked when the user clicks the Back button. 33251 * It works only for the custom components decorated by @Entry. 33252 * The value **true** means that the page executes its own return logic. 33253 * And **false** (default) means that the default return logic is used. 33254 * 33255 * @returns { void | boolean } true means that the page itself processes the return logic. 33256 * false means that the default return logic is used. 33257 * If no value is returned, the default return logic is used. 33258 * @syscap SystemCapability.ArkUI.ArkUI.Full 33259 * @crossplatform 33260 * @atomicservice 33261 * @since 11 33262 */ 33263 /** 33264 * Invoked when the user clicks the Back button. 33265 * It works only for the custom components decorated by @Entry. 33266 * The value **true** means that the page executes its own return logic. 33267 * And **false** (default) means that the default return logic is used. 33268 * 33269 * @returns { void | boolean } true means that the page itself processes the return logic. 33270 * false means that the default return logic is used. 33271 * If no value is returned, the default return logic is used. 33272 * @syscap SystemCapability.ArkUI.ArkUI.Full 33273 * @crossplatform 33274 * @atomicservice 33275 * @since 18 33276 */ 33277 onBackPress?(): void | boolean; 33278 33279 /** 33280 * PageTransition Method. 33281 * Implement Animation when enter this page or move to other pages. 33282 * 33283 * @syscap SystemCapability.ArkUI.ArkUI.Full 33284 * @since 9 33285 */ 33286 /** 33287 * PageTransition Method. 33288 * Implement Animation when enter this page or move to other pages. 33289 * 33290 * @syscap SystemCapability.ArkUI.ArkUI.Full 33291 * @crossplatform 33292 * @since 10 33293 */ 33294 /** 33295 * PageTransition Method. 33296 * Implement Animation when enter this page or move to other pages. 33297 * 33298 * @syscap SystemCapability.ArkUI.ArkUI.Full 33299 * @crossplatform 33300 * @atomicservice 33301 * @since 11 33302 */ 33303 /** 33304 * PageTransition Method and it is migrated from class CustomComponent. 33305 * Implement Animation when enter this page or move to other pages. 33306 * 33307 * @syscap SystemCapability.ArkUI.ArkUI.Full 33308 * @crossplatform 33309 * @atomicservice 33310 * @since arkts {'1.1':'18','1.2':'20'} 33311 * @arkts 1.1&1.2 33312 */ 33313 pageTransition?(): void; 33314 33315 /** 33316 * Get current UIContext 33317 * 33318 * @returns { UIContext } The UIContext that the custom component belongs to. 33319 * @syscap SystemCapability.ArkUI.ArkUI.Full 33320 * @crossplatform 33321 * @since 11 33322 */ 33323 /** 33324 * Get current UIContext 33325 * 33326 * @returns { UIContext } The UIContext that the custom component belongs to. 33327 * @syscap SystemCapability.ArkUI.ArkUI.Full 33328 * @crossplatform 33329 * @atomicservice 33330 * @since 12 33331 */ 33332 /** 33333 * Get current UIContext and it is migrated from class CustomComponent. 33334 * 33335 * @returns { UIContext } The UIContext that the custom component belongs to. 33336 * @syscap SystemCapability.ArkUI.ArkUI.Full 33337 * @crossplatform 33338 * @atomicservice 33339 * @since 18 33340 */ 33341 getUIContext(): UIContext; 33342 33343 /** 33344 * Get uniqueId of the custom component. 33345 * This unique ID is assigned by the system to each component. 33346 * If this API is called before the component's corresponding node is created or after it has been destroyed, an 33347 * invalid unique ID, which is -1, will be returned. 33348 * 33349 * @returns { number } - The uniqueId of the custom component. 33350 * @syscap SystemCapability.ArkUI.ArkUI.Full 33351 * @crossplatform 33352 * @atomicservice 33353 * @since 12 33354 */ 33355 /** 33356 * Get uniqueId of the custom component and it is migrated from class CustomComponent. 33357 * This unique ID is assigned by the system to each component. 33358 * If this API is called before the component's corresponding node is created or after it has been destroyed, an 33359 * invalid unique ID, which is -1, will be returned. 33360 * 33361 * @returns { number } - The uniqueId of the custom component. 33362 * @syscap SystemCapability.ArkUI.ArkUI.Full 33363 * @crossplatform 33364 * @atomicservice 33365 * @since 18 33366 */ 33367 getUniqueId(): number; 33368 33369 /** 33370 * Queries the **NavDestination** information of this custom component. 33371 * 33372 * @returns { NavDestinationInfo | undefined } The navigation destination information, or undefined if it is not available. 33373 * @syscap SystemCapability.ArkUI.ArkUI.Full 33374 * @crossplatform 33375 * @since 11 33376 */ 33377 /** 33378 * Queries the **NavDestination** information of this custom component. 33379 * 33380 * @returns { NavDestinationInfo | undefined } The navigation destination information, or undefined if it is not available. 33381 * @syscap SystemCapability.ArkUI.ArkUI.Full 33382 * @crossplatform 33383 * @atomicservice 33384 * @since 12 33385 */ 33386 /** 33387 * Queries the **NavDestination** information of this custom component. 33388 * 33389 * @returns { NavDestinationInfo | undefined } The navigation destination information, or undefined if it is not available. 33390 * @syscap SystemCapability.ArkUI.ArkUI.Full 33391 * @crossplatform 33392 * @atomicservice 33393 * @since 18 33394 */ 33395 queryNavDestinationInfo(): NavDestinationInfo | undefined; 33396 33397 /** 33398 * Queries the information about the nearest **NavDestination** component 33399 * in the navigation stack for a custom component. 33400 * 33401 * @param { Optional<boolean> } [isInner] 33402 * @returns { NavDestinationInfo | undefined } The navigation destination information, or undefined if it is not available. 33403 * @syscap SystemCapability.ArkUI.ArkUI.Full 33404 * @crossplatform 33405 * @atomicservice 33406 * @since 18 33407 */ 33408 queryNavDestinationInfo(isInner: Optional<boolean>): NavDestinationInfo | undefined; 33409 33410 /** 33411 * Queries the **Navigation** information of this custom component. 33412 * 33413 * @returns { NavigationInfo | undefined } The navigation information, or undefined if it is not available 33414 * @syscap SystemCapability.ArkUI.ArkUI.Full 33415 * @crossplatform 33416 * @atomicservice 33417 * @since 12 33418 */ 33419 /** 33420 * Queries the **Navigation** information of this custom component. 33421 * 33422 * @returns { NavigationInfo | undefined } The navigation information, or undefined if it is not available 33423 * @syscap SystemCapability.ArkUI.ArkUI.Full 33424 * @crossplatform 33425 * @atomicservice 33426 * @since 18 33427 */ 33428 queryNavigationInfo(): NavigationInfo | undefined; 33429 33430 /** 33431 * Obtains a **RouterPageInfo** instance. 33432 * 33433 * @returns { RouterPageInfo | undefined } The router page information, or undefined if it is not available. 33434 * @syscap SystemCapability.ArkUI.ArkUI.Full 33435 * @crossplatform 33436 * @atomicservice 33437 * @since 12 33438 */ 33439 /** 33440 * Obtains a **RouterPageInfo** instance. 33441 * 33442 * @returns { RouterPageInfo | undefined } The router page information, or undefined if it is not available. 33443 * @syscap SystemCapability.ArkUI.ArkUI.Full 33444 * @crossplatform 33445 * @atomicservice 33446 * @since 18 33447 */ 33448 queryRouterPageInfo(): RouterPageInfo | undefined; 33449 33450 /** 33451 * The callback method after the custom component is built. 33452 * 33453 * Triggered when the custom component has been built. 33454 * 33455 * @syscap SystemCapability.ArkUI.ArkUI.Full 33456 * @crossplatform 33457 * @atomicservice 33458 * @since 12 33459 */ 33460 /** 33461 * The callback method after the custom component is built and it is migrated from class CustomComponent. 33462 * 33463 * Triggered when the custom component has been built. 33464 * 33465 * @syscap SystemCapability.ArkUI.ArkUI.Full 33466 * @crossplatform 33467 * @atomicservice 33468 * @since 18 33469 */ 33470 onDidBuild?(): void; 33471 33472 /** 33473 * The dialog controller of the custom component. 33474 * 33475 * @returns { PromptActionDialogController | undefined } The controller of dialog, or undefined if it is not available 33476 * @syscap SystemCapability.ArkUI.ArkUI.Full 33477 * @crossplatform 33478 * @atomicservice 33479 * @since 18 33480 */ 33481 getDialogController(): PromptActionDialogController | undefined; 33482 33483 /** 33484 * Triggered when the Entry custom component has been pushed with singleton mode. 33485 * 33486 * @param { ESObject } param - New parameters pushed with singleton mode. 33487 * @syscap SystemCapability.ArkUI.ArkUI.Full 33488 * @crossplatform 33489 * @atomicservice 33490 * @since 19 33491 */ 33492 onNewParam?(param: ESObject): void; 33493} 33494/** 33495 * View 33496 * 33497 * @syscap SystemCapability.ArkUI.ArkUI.Full 33498 * @systemapi 33499 * @since 7 33500 */ 33501/** 33502 * View 33503 * 33504 * @syscap SystemCapability.ArkUI.ArkUI.Full 33505 * @systemapi 33506 * @form 33507 * @since 9 33508 */ 33509declare class View { 33510 /** 33511 * Just use for generate tsbundle 33512 * 33513 * @param { any } value 33514 * @returns { any } 33515 * @syscap SystemCapability.ArkUI.ArkUI.Full 33516 * @systemapi 33517 * @since 7 33518 */ 33519 /** 33520 * Just use for generate tsbundle 33521 * 33522 * @param { any } value 33523 * @returns { any } 33524 * @syscap SystemCapability.ArkUI.ArkUI.Full 33525 * @systemapi 33526 * @form 33527 * @since 9 33528 */ 33529 create(value: any): any; 33530} 33531 33532/** 33533 * Rect info. 33534 * 33535 * @interface RectResult 33536 * @syscap SystemCapability.ArkUI.ArkUI.Full 33537 * @crossplatform 33538 * @since 10 33539 */ 33540/** 33541 * Describe the position, width, and height of a component. 33542 * 33543 * @interface RectResult 33544 * @syscap SystemCapability.ArkUI.ArkUI.Full 33545 * @crossplatform 33546 * @atomicservice 33547 * @since arkts {'1.1':'11','1.2':'20'} 33548 * @arkts 1.1&1.2 33549 */ 33550declare interface RectResult { 33551 /** 33552 * x:Horizontal coordinate relative to the component. 33553 * 33554 * @type { number } 33555 * @syscap SystemCapability.ArkUI.ArkUI.Full 33556 * @since 10 33557 */ 33558 /** 33559 * Horizontal coordinate. 33560 * 33561 * @type { number } 33562 * @syscap SystemCapability.ArkUI.ArkUI.Full 33563 * @crossplatform 33564 * @atomicservice 33565 * @since arkts {'1.1':'11','1.2':'20'} 33566 * @arkts 1.1&1.2 33567 */ 33568 x: number; 33569 33570 /** 33571 * y:Vertical axis coordinate relative to the component. 33572 * 33573 * @type { number } 33574 * @syscap SystemCapability.ArkUI.ArkUI.Full 33575 * @since 10 33576 */ 33577 /** 33578 * Vertical coordinate. 33579 * 33580 * @type { number } 33581 * @syscap SystemCapability.ArkUI.ArkUI.Full 33582 * @crossplatform 33583 * @atomicservice 33584 * @since arkts {'1.1':'11','1.2':'20'} 33585 * @arkts 1.1&1.2 33586 */ 33587 y: number; 33588 33589 /** 33590 * Get the width of the current textRect. 33591 * 33592 * @type { number } 33593 * @syscap SystemCapability.ArkUI.ArkUI.Full 33594 * @since 10 33595 */ 33596 /** 33597 * Content width. 33598 * 33599 * @type { number } 33600 * @syscap SystemCapability.ArkUI.ArkUI.Full 33601 * @crossplatform 33602 * @atomicservice 33603 * @since arkts {'1.1':'11','1.2':'20'} 33604 * @arkts 1.1&1.2 33605 */ 33606 width: number; 33607 33608 /** 33609 * Get the height of the current textRect. 33610 * 33611 * @type { number } 33612 * @syscap SystemCapability.ArkUI.ArkUI.Full 33613 * @since 10 33614 */ 33615 /** 33616 * Content height. 33617 * 33618 * @type { number } 33619 * @syscap SystemCapability.ArkUI.ArkUI.Full 33620 * @crossplatform 33621 * @atomicservice 33622 * @since arkts {'1.1':'11','1.2':'20'} 33623 * @arkts 1.1&1.2 33624 */ 33625 height: number; 33626} 33627 33628/** 33629 * CaretOffset info. 33630 * 33631 * @interface CaretOffset 33632 * @syscap SystemCapability.ArkUI.ArkUI.Full 33633 * @crossplatform 33634 * @since 11 33635 */ 33636/** 33637 * CaretOffset info. 33638 * 33639 * @interface CaretOffset 33640 * @syscap SystemCapability.ArkUI.ArkUI.Full 33641 * @crossplatform 33642 * @atomicservice 33643 * @since arkts {'1.1':'12','1.2':'20'} 33644 * @arkts 1.1&1.2 33645 */ 33646declare interface CaretOffset { 33647 /** 33648 * Get the index of the CaretOffset 33649 * 33650 * @type { number } 33651 * @syscap SystemCapability.ArkUI.ArkUI.Full 33652 * @since 11 33653 */ 33654 /** 33655 * Get the index of the CaretOffset 33656 * 33657 * @type { number } 33658 * @syscap SystemCapability.ArkUI.ArkUI.Full 33659 * @atomicservice 33660 * @since arkts {'1.1':'12','1.2':'20'} 33661 * @arkts 1.1&1.2 33662 */ 33663 index: number; 33664 33665 /** 33666 * Get the x of the relative position. 33667 * 33668 * @type { number } 33669 * @syscap SystemCapability.ArkUI.ArkUI.Full 33670 * @since 11 33671 */ 33672 /** 33673 * Get the x of the relative position. 33674 * 33675 * @type { number } 33676 * @syscap SystemCapability.ArkUI.ArkUI.Full 33677 * @atomicservice 33678 * @since arkts {'1.1':'12','1.2':'20'} 33679 * @arkts 1.1&1.2 33680 */ 33681 x: number; 33682 33683 /** 33684 * Get the y of the relative position. 33685 * 33686 * @type { number } 33687 * @syscap SystemCapability.ArkUI.ArkUI.Full 33688 * @since 11 33689 */ 33690 /** 33691 * Get the y of the relative position. 33692 * 33693 * @type { number } 33694 * @syscap SystemCapability.ArkUI.ArkUI.Full 33695 * @atomicservice 33696 * @since arkts {'1.1':'12','1.2':'20'} 33697 * @arkts 1.1&1.2 33698 */ 33699 y: number; 33700} 33701 33702/** 33703 * Defines the span options of TextContentController. 33704 * 33705 * @interface TextContentControllerOptions 33706 * @syscap SystemCapability.ArkUI.ArkUI.Full 33707 * @crossplatform 33708 * @atomicservice 33709 * @since arkts {'1.1':'15','1.2':'20'} 33710 * @arkts 1.1&1.2 33711 */ 33712declare interface TextContentControllerOptions { 33713 /** 33714 * the offset that add a text at. 33715 * 33716 * @type { ?number } 33717 * @syscap SystemCapability.ArkUI.ArkUI.Full 33718 * @crossplatform 33719 * @atomicservice 33720 * @since arkts {'1.1':'15','1.2':'20'} 33721 * @arkts 1.1&1.2 33722 */ 33723 offset?: number; 33724} 33725 33726/** 33727 * TextContentControllerBase 33728 * 33729 * @syscap SystemCapability.ArkUI.ArkUI.Full 33730 * @crossplatform 33731 * @since 10 33732 */ 33733/** 33734 * TextContentControllerBase 33735 * 33736 * @syscap SystemCapability.ArkUI.ArkUI.Full 33737 * @crossplatform 33738 * @atomicservice 33739 * @since arkts {'1.1':'11','1.2':'20'} 33740 * @arkts 1.1&1.2 33741 */ 33742declare abstract class TextContentControllerBase { 33743 /** 33744 * Get the index and relative position of the CaretOffset. 33745 * 33746 * @returns { CaretOffset } index and relative position of the CaretOffset. 33747 * @syscap SystemCapability.ArkUI.ArkUI.Full 33748 * @crossplatform 33749 * @since 11 33750 */ 33751 /** 33752 * Get the index and relative position of the CaretOffset. 33753 * 33754 * <p><strong>NOTE</strong>: 33755 * <br>If this API is called when the caret position is updated in the current frame, it will not take effect. 33756 * <br>For the Search component, the returned position information is the offset of the first character 33757 * relative to the search icon in the component. 33758 * <br>If no text is entered in the Search component, 33759 * the return value contains the position information relative to the component. 33760 * <br>The location information in the return value is the location of the caret relative to the editable component. 33761 * </p> 33762 * 33763 * @returns { CaretOffset } index and relative position of the CaretOffset. 33764 * @syscap SystemCapability.ArkUI.ArkUI.Full 33765 * @crossplatform 33766 * @atomicservice 33767 * @since arkts {'1.1':'12','1.2':'20'} 33768 * @arkts 1.1&1.2 33769 */ 33770 getCaretOffset() : CaretOffset; 33771 33772 /** 33773 * Get the start and end positions of the text content. 33774 * 33775 * @returns { RectResult } Text content rect. 33776 * @syscap SystemCapability.ArkUI.ArkUI.Full 33777 * @crossplatform 33778 * @since 10 33779 */ 33780 /** 33781 * Get the start and end positions of the text content. 33782 * 33783 * <p><strong>NOTE</strong>: 33784 * <br>If no text is entered, the return value contains the position information, but the size is 0. 33785 * <br>The position information is the offset of the first character relative to the editable area. 33786 * <br>For the Search component, the returned position information is the offset of the first character 33787 * relative to the search icon in the component. 33788 * <br>If there is input, the width in the return value is the fixed width of the editable area. 33789 * </p> 33790 * 33791 * @returns { RectResult } Text content rect.The unit of the return value is pixel. 33792 * @syscap SystemCapability.ArkUI.ArkUI.Full 33793 * @crossplatform 33794 * @atomicservice 33795 * @since arkts {'1.1':'11','1.2':'20'} 33796 * @arkts 1.1&1.2 33797 */ 33798 getTextContentRect() : RectResult; 33799 33800 /** 33801 * Get the lines number of the text content. 33802 * 33803 * @returns { number } Text content line count 33804 * @syscap SystemCapability.ArkUI.ArkUI.Full 33805 * @crossplatform 33806 * @since 10 33807 */ 33808 /** 33809 * Get the lines number of the text content. 33810 * The getTextContentLineCount type is used to obtain the number of lines of the edited text. 33811 * 33812 * @returns { number } Text content line count 33813 * @syscap SystemCapability.ArkUI.ArkUI.Full 33814 * @crossplatform 33815 * @atomicservice 33816 * @since arkts {'1.1':'11','1.2':'20'} 33817 * @arkts 1.1&1.2 33818 */ 33819 getTextContentLineCount() : number; 33820 33821 /** 33822 * Add a text. 33823 * 33824 * @param { string } text - text value. 33825 * @param { TextContentControllerOptions } [textOperationOptions] - operation info. 33826 * @returns { number } caret index 33827 * @syscap SystemCapability.ArkUI.ArkUI.Full 33828 * @crossplatform 33829 * @atomicservice 33830 * @since arkts {'1.1':'15','1.2':'20'} 33831 * @arkts 1.1&1.2 33832 */ 33833 addText(text: string, textOperationOptions?: TextContentControllerOptions): number; 33834 33835 /** 33836 * Delete text in TextRange. 33837 * 33838 * @param { TextRange } [range] - range for deleting. 33839 * @syscap SystemCapability.ArkUI.ArkUI.Full 33840 * @crossplatform 33841 * @atomicservice 33842 * @since arkts {'1.1':'15','1.2':'20'} 33843 * @arkts 1.1&1.2 33844 */ 33845 deleteText(range?: TextRange): void; 33846 33847 /** 33848 * Gets the selected range of text content. 33849 * 33850 * @returns { TextRange } range for selecting. 33851 * @syscap SystemCapability.ArkUI.ArkUI.Full 33852 * @crossplatform 33853 * @atomicservice 33854 * @since arkts {'1.1':'15','1.2':'20'} 33855 * @arkts 1.1&1.2 33856 */ 33857 getSelection(): TextRange; 33858 33859 /** 33860 * Clear the content of preview. 33861 * 33862 * @syscap SystemCapability.ArkUI.ArkUI.Full 33863 * @atomicservice 33864 * @since arkts {'1.1':'17','1.2':'20'} 33865 * @arkts 1.1&1.2 33866 */ 33867 clearPreviewText(): void; 33868 33869 /** 33870 * Gets the text content of the selected range. 33871 * 33872 * @param { TextRange } [range] - selected range. 33873 * @returns { string } text content of the selected range. 33874 * @syscap SystemCapability.ArkUI.ArkUI.Full 33875 * @systemapi 33876 * @atomicservice 33877 * @since arkts {'1.1':'19','1.2':'20'} 33878 * @arkts 1.1&1.2 33879 */ 33880 getText(range?: TextRange): string; 33881} 33882 33883/** 33884 * Enum of scrollable containers' content clip mode. 33885 * 33886 * @enum { number } 33887 * @syscap SystemCapability.ArkUI.ArkUI.Full 33888 * @crossplatform 33889 * @atomicservice 33890 * @since arkts {'1.1':'14','1.2':'20'} 33891 * @arkts 1.1&1.2 33892 */ 33893declare enum ContentClipMode { 33894 /** 33895 * Clip to content rect inside margin & padding. 33896 * 33897 * @syscap SystemCapability.ArkUI.ArkUI.Full 33898 * @crossplatform 33899 * @atomicservice 33900 * @since arkts {'1.1':'14','1.2':'20'} 33901 * @arkts 1.1&1.2 33902 */ 33903 CONTENT_ONLY = 0, 33904 33905 /** 33906 * Clip to scrollable's outer rect, including padding but inside margin. 33907 * 33908 * @syscap SystemCapability.ArkUI.ArkUI.Full 33909 * @crossplatform 33910 * @atomicservice 33911 * @since arkts {'1.1':'14','1.2':'20'} 33912 * @arkts 1.1&1.2 33913 */ 33914 BOUNDARY = 1, 33915 33916 /** 33917 * Clip to the safeArea of scrollable container. 33918 * 33919 * @syscap SystemCapability.ArkUI.ArkUI.Full 33920 * @crossplatform 33921 * @atomicservice 33922 * @since arkts {'1.1':'14','1.2':'20'} 33923 * @arkts 1.1&1.2 33924 */ 33925 SAFE_AREA = 2, 33926} 33927 33928/** 33929 * CommonScrollableMethod 33930 * 33931 * @extends CommonMethod<T> 33932 * @syscap SystemCapability.ArkUI.ArkUI.Full 33933 * @crossplatform 33934 * @atomicservice 33935 * @since 11 33936 */ 33937/** 33938 * CommonScrollableMethod 33939 * 33940 * @extends CommonMethod<T> 33941 * @syscap SystemCapability.ArkUI.ArkUI.Full 33942 * @crossplatform 33943 * @form 33944 * @atomicservice 33945 * @since arkts {'1.1':'12','1.2':'20'} 33946 * @arkts 1.1&1.2 33947 */ 33948declare class ScrollableCommonMethod<T> extends CommonMethod<T> { 33949 /** 33950 * Sets the scrollbar state. 33951 * 33952 * @param { BarState } barState - Scrollbar state.<br>Default value: <em>BarState.Auto</em> for the <em>List</em>, <em>Grid</em>, 33953 * and <em>Scroll</em> components and <em>BarState.Off</em> for the <em>WaterFlow</em> component 33954 * @returns { T } 33955 * @syscap SystemCapability.ArkUI.ArkUI.Full 33956 * @crossplatform 33957 * @atomicservice 33958 * @since arkts {'1.1':'11','1.2':'20'} 33959 * @arkts 1.1&1.2 33960 */ 33961 scrollBar(barState: BarState): T; 33962 33963 /** 33964 * Sets the scrollbar color. 33965 * 33966 * @param { Color | number | string } color - Scrollbar color.<br>Default value: <em>'\#182431'</em> (40% opacity) 33967 * <br>A number value indicates a HEX color in RGB or ARGB format, 33968 * for example, <em>0xffffff</em>. A string value indicates a color in RGB or ARGB format, for example, <em>'#ffffff'</em>. 33969 * @returns { T } 33970 * @syscap SystemCapability.ArkUI.ArkUI.Full 33971 * @crossplatform 33972 * @atomicservice 33973 * @since arkts {'1.1':'11','1.2':'20'} 33974 * @arkts 1.1&1.2 33975 */ 33976 scrollBarColor(color: Color | number | string): T; 33977 33978 /** 33979 * Sets the scrollbar width. 33980 * 33981 * @param { number | string } value - Scrollbar width.<br>Default value: <em>4</em> 33982 * <br>Unit: vp 33983 * <br>If this parameter is set to a value less than or equal to 0, the default value is used. 33984 * The value <em>0</em> means not to show the scrollbar. 33985 * @returns { T } 33986 * @syscap SystemCapability.ArkUI.ArkUI.Full 33987 * @crossplatform 33988 * @atomicservice 33989 * @since arkts {'1.1':'11','1.2':'20'} 33990 * @arkts 1.1&1.2 33991 */ 33992 scrollBarWidth(value: number | string): T; 33993 33994 /** 33995 * Margin of the scrollbar. 33996 * 33997 * @param { ScrollBarMargin } margin - Margin of the scrollbar. 33998 * @returns { T } 33999 * @syscap SystemCapability.ArkUI.ArkUI.Full 34000 * @crossplatform 34001 * @atomicservice 34002 * @since 20 34003 */ 34004 scrollBarMargin(margin: ScrollBarMargin): T; 34005 34006 /** 34007 * Sets the effect used when the scroll boundary is reached. 34008 * 34009 * @param { EdgeEffect } edgeEffect - Effect used when the scroll boundary is reached. The spring and shadow effects are supported. 34010 * <br>Default value: <em>EdgeEffect.None</em> for the <em>Grid</em>, <em>Scroll</em>, 34011 * and <em>WaterFlow</em> components and <em>EdgeEffect.Spring</em> for the <em>List</em> component 34012 * @param { EdgeEffectOptions } options - Whether to enable the scroll effect when the component content is smaller than the component itself. 34013 * The value <em>{ alwaysEnabled: true }</em> means to enable the scroll effect, and <em>{ alwaysEnabled: false }</em> means the opposite. 34014 * <br>Default value:<br><em>{ alwaysEnabled: false }</em> for the <em>List</em>, <em>Grid</em>, and <em>WaterFlow</em> components, 34015 * and <em>{ alwaysEnabled: true }</em> for the <em>Scroll</em> component 34016 * @returns { T } 34017 * @syscap SystemCapability.ArkUI.ArkUI.Full 34018 * @crossplatform 34019 * @atomicservice 34020 * @since arkts {'1.1':'11','1.2':'20'} 34021 * @arkts 1.1&1.2 34022 */ 34023 edgeEffect(edgeEffect: EdgeEffect, options?: EdgeEffectOptions): T; 34024 34025 /** 34026 * Called when setting whether to enable fading Edge effect. 34027 * 34028 * @param { Optional<boolean> } enabled - Whether to turn on the edge fade effect 34029 * @param { FadingEdgeOptions } [options] - The options of fadingEdge. 34030 * @returns { T } 34031 * @syscap SystemCapability.ArkUI.ArkUI.Full 34032 * @crossplatform 34033 * @atomicservice 34034 * @since arkts {'1.1':'14','1.2':'20'} 34035 * @arkts 1.1&1.2 34036 */ 34037 fadingEdge(enabled: Optional<boolean>, options?: FadingEdgeOptions): T; 34038 34039 /** 34040 * Sets the nested scrolling options. 34041 * 34042 * @param { NestedScrollOptions } value - options for nested scrolling. 34043 * @returns { T } 34044 * @syscap SystemCapability.ArkUI.ArkUI.Full 34045 * @crossplatform 34046 * @atomicservice 34047 * @since arkts {'1.1':'11','1.2':'20'} 34048 * @arkts 1.1&1.2 34049 */ 34050 nestedScroll(value: NestedScrollOptions): T; 34051 34052 /** 34053 * Sets whether to support scroll gestures. 34054 * 34055 * @param { boolean } value - Whether to support scroll gestures.<br>Default value: <em>true</em> 34056 * @returns { T } 34057 * @syscap SystemCapability.ArkUI.ArkUI.Full 34058 * @crossplatform 34059 * @atomicservice 34060 * @since arkts {'1.1':'11','1.2':'20'} 34061 * @arkts 1.1&1.2 34062 */ 34063 enableScrollInteraction(value: boolean): T; 34064 34065 /** 34066 * Sets the friction coefficient. 34067 * 34068 * @param { number | Resource } value - Friction coefficient. 34069 * @returns { T } 34070 * @syscap SystemCapability.ArkUI.ArkUI.Full 34071 * @crossplatform 34072 * @atomicservice 34073 * @since arkts {'1.1':'11','1.2':'20'} 34074 * @arkts 1.1&1.2 34075 */ 34076 friction(value: number | Resource): T; 34077 34078 /** 34079 * Triggered when the scrollable component scrolls. 34080 * 34081 * @param { function } event - callback of scrollable, 34082 * scrollOffset is offset per frame scrolling, ScrollState is current scroll state. 34083 * @returns { T } 34084 * @syscap SystemCapability.ArkUI.ArkUI.Full 34085 * @crossplatform 34086 * @atomicservice 34087 * @since 11 34088 * @deprecated since 12 34089 * @useinstead ScrollableCommonMethod#onDidScroll 34090 */ 34091 onScroll(event: (scrollOffset: number, scrollState: ScrollState) => void): T; 34092 34093 /** 34094 * Called when the scrollable will scroll. 34095 * 34096 * @param { Optional<OnWillScrollCallback> } handler - callback of scrollable. 34097 * @returns { T } 34098 * @syscap SystemCapability.ArkUI.ArkUI.Full 34099 * @crossplatform 34100 * @atomicservice 34101 * @since 12 34102 */ 34103 onWillScroll(handler: Optional<OnWillScrollCallback>): T; 34104 34105 /** 34106 * Triggered when the scrollable component scrolls. 34107 * 34108 * @param { OnScrollCallback } handler - Callback triggered when the scrollable component scrolls. 34109 * @returns { T } 34110 * @syscap SystemCapability.ArkUI.ArkUI.Full 34111 * @crossplatform 34112 * @form 34113 * @atomicservice 34114 * @since 12 34115 */ 34116 onDidScroll(handler: OnScrollCallback): T; 34117 34118 /** 34119 * Called when the scrollable will end dragging. 34120 * 34121 * @param { OnWillStopDraggingCallback } handler - callback of end dragging. 34122 * @returns { T } 34123 * @syscap SystemCapability.ArkUI.ArkUI.Full 34124 * @crossplatform 34125 * @form 34126 * @atomicservice 34127 * @since 20 34128 */ 34129 onWillStopDragging(handler: OnWillStopDraggingCallback): T; 34130 34131 /** 34132 * Triggered when the scrollable component reaches the start position. 34133 * 34134 * @param { function } event - Callback function, triggered when the scrollable reaches the start position. 34135 * @returns { T } 34136 * @syscap SystemCapability.ArkUI.ArkUI.Full 34137 * @crossplatform 34138 * @atomicservice 34139 * @since arkts {'1.1':'11','1.2':'20'} 34140 * @arkts 1.1&1.2 34141 */ 34142 onReachStart(event: () => void): T; 34143 34144 /** 34145 * Triggered when the scrollable component reaches the end position. 34146 * 34147 * @param { function } event - Callback function, triggered when the scrollable reaches the end position. 34148 * @returns { T } 34149 * @syscap SystemCapability.ArkUI.ArkUI.Full 34150 * @crossplatform 34151 * @atomicservice 34152 * @since arkts {'1.1':'11','1.2':'20'} 34153 * @arkts 1.1&1.2 34154 */ 34155 onReachEnd(event: () => void): T; 34156 34157 /** 34158 * Triggered when the scrollable component starts scrolling initiated by the user's finger dragging the component or its scrollbar. 34159 * 34160 * @param { function } event - Callback function, triggered when the scrollable starts scrolling. 34161 * @returns { T } 34162 * @syscap SystemCapability.ArkUI.ArkUI.Full 34163 * @crossplatform 34164 * @atomicservice 34165 * @since arkts {'1.1':'11','1.2':'20'} 34166 * @arkts 1.1&1.2 34167 */ 34168 onScrollStart(event: () => void): T; 34169 34170 /** 34171 * Triggered when scrolling stops after the user's finger leaves the screen. 34172 * 34173 * @param { function } event - Callback function, triggered when the scrollable stops scrolling. 34174 * @returns { T } 34175 * @syscap SystemCapability.ArkUI.ArkUI.Full 34176 * @crossplatform 34177 * @atomicservice 34178 * @since arkts {'1.1':'11','1.2':'20'} 34179 * @arkts 1.1&1.2 34180 */ 34181 onScrollStop(event: () => void): T; 34182 34183 /** 34184 * Sets the maximum initial velocity at the start of the fling animation that occurs after gesture-driven scrolling ends. 34185 * 34186 * @param { number } speedLimit - Maximum initial velocity at the start of the fling animation. 34187 * <br>Default value: <em>9000</em> 34188 * <br>Unit: vp/s 34189 * <br>Value range: (0, +∞). If this parameter is set to a value less than or equal to 0, the default value is used. 34190 * @returns { T } 34191 * @syscap SystemCapability.ArkUI.ArkUI.Full 34192 * @crossplatform 34193 * @atomicservice 34194 * @since arkts {'1.1':'11','1.2':'20'} 34195 * @arkts 1.1&1.2 34196 */ 34197 flingSpeedLimit(speedLimit: number): T; 34198 34199 /** 34200 * Sets the content clipping area for this scrollable component. 34201 * 34202 * @param { ContentClipMode | RectShape } clip - A value from enum ContentClipMode or a customized clip rect. 34203 * @returns { T } 34204 * @syscap SystemCapability.ArkUI.ArkUI.Full 34205 * @crossplatform 34206 * @atomicservice 34207 * @since arkts {'1.1':'14','1.2':'20'} 34208 * @arkts 1.1&1.2 34209 */ 34210 clipContent(clip: ContentClipMode | RectShape): T; 34211 34212 /** 34213 * Set the sensitivity of rotating crown. 34214 * 34215 * @param { Optional<CrownSensitivity> } sensitivity - The sensitivity of rotating crown, default value is { MEDIUM }. 34216 * @returns { T } The component instance. 34217 * @syscap SystemCapability.ArkUI.ArkUI.Full 34218 * @crossplatform 34219 * @atomicservice 34220 * @since arkts {'1.1':'18','1.2':'20'} 34221 * @arkts 1.1&1.2 34222 */ 34223 digitalCrownSensitivity(sensitivity: Optional<CrownSensitivity>): T; 34224 34225 /** 34226 * Sets whether to enable the back-to-top feature for a scrollable component when the status bar is touched. 34227 * 34228 * @param { boolean } backToTop - Whether to enable the back-to-top feature for a scrollable component when the status bar is touched. 34229 * <br>Default value: <em>false</em> 34230 * @returns { T } 34231 * @syscap SystemCapability.ArkUI.ArkUI.Full 34232 * @crossplatform 34233 * @atomicservice 34234 * @since arkts {'1.1':'15','1.2':'20'} 34235 * @arkts 1.1&1.2 34236 */ 34237 backToTop(backToTop: boolean): T; 34238} 34239 34240/** 34241 * The actual offset by which the scrollable scrolls. 34242 * @syscap SystemCapability.ArkUI.ArkUI.Full 34243 * @crossplatform 34244 * @atomicservice 34245 * @since arkts {'1.1':'12','1.2':'20'} 34246 * @arkts 1.1&1.2 34247 */ 34248declare class ScrollResult { 34249 /** 34250 * Actual offset by which the scrollable scrolls in vp. 34251 * @type { number } 34252 * @syscap SystemCapability.ArkUI.ArkUI.Full 34253 * @crossplatform 34254 * @atomicservice 34255 * @since arkts {'1.1':'12','1.2':'20'} 34256 * @arkts 1.1&1.2 34257 */ 34258 offsetRemain: number; 34259} 34260 34261/** 34262 * Called before scroll to allow developer to control real offset the Scrollable can scroll. 34263 * 34264 * @typedef { function } OnWillScrollCallback 34265 * @param { number } scrollOffset - offset this frame will scroll, which may or may not be reached. 34266 * @param { ScrollState } scrollState - current scroll state. 34267 * @param { ScrollSource } scrollSource - source of current scroll. 34268 * @returns { void | ScrollResult } the remain offset for the scrollable, 34269 * same as scrollOffset when no ScrollResult is returned. 34270 * @syscap SystemCapability.ArkUI.ArkUI.Full 34271 * @crossplatform 34272 * @atomicservice 34273 * @since 12 34274 */ 34275declare type OnWillScrollCallback = 34276(scrollOffset: number, scrollState: ScrollState, scrollSource: ScrollSource) => void | ScrollResult; 34277 34278/** 34279 * Called before scroll to allow developer to control real offset the Scrollable can scroll. 34280 * 34281 * @typedef { function } OnWillScrollCallback 34282 * @param { number } scrollOffset - offset this frame will scroll, which may or may not be reached. 34283 * @param { ScrollState } scrollState - current scroll state. 34284 * @param { ScrollSource } scrollSource - source of current scroll. 34285 * @returns { void | ScrollResult } the remain offset for the scrollable, 34286 * same as scrollOffset when no ScrollResult is returned. 34287 * @syscap SystemCapability.ArkUI.ArkUI.Full 34288 * @crossplatform 34289 * @atomicservice 34290 * @since 20 34291 * @arkts 1.2 34292 */ 34293declare type OnWillScrollCallback = 34294(scrollOffset: number, scrollState: ScrollState, scrollSource: ScrollSource) => undefined | ScrollResult; 34295 34296/** 34297 * On scroll callback using in scrollable onDidScroll. 34298 * 34299 * @typedef { function } OnScrollCallback 34300 * @param { number } scrollOffset - offset this frame did scroll. 34301 * @param { ScrollState } scrollState - current scroll state. 34302 * @syscap SystemCapability.ArkUI.ArkUI.Full 34303 * @crossplatform 34304 * @form 34305 * @atomicservice 34306 * @since arkts {'1.1':'12','1.2':'20'} 34307 * @arkts 1.1&1.2 34308 */ 34309declare type OnScrollCallback = (scrollOffset: number, scrollState: ScrollState) => void; 34310 34311/** 34312 * Defines the callback type used in onItemDragStart. 34313 * 34314 * @typedef { function } OnItemDragStartCallback 34315 * @param { ItemDragInfo } event - Information about the dragged item. 34316 * @param { number } itemIndex - The index number of the dragged item. 34317 * @returns {CustomBuilder | undefined} 34318 * @syscap SystemCapability.ArkUI.ArkUI.Full 34319 * @atomicservice 34320 * @since 20 34321 * @arkts 1.2 34322 */ 34323declare type OnItemDragStartCallback = (event: ItemDragInfo, itemIndex: number) => CustomBuilder | undefined; 34324 34325/** 34326 * On scroll callback using in scrollable onWillStopDragging. 34327 * 34328 * @typedef { function } OnWillStopDraggingCallback 34329 * @param { number } velocity - The velocity of the scroll view at the moment the touch was released. 34330 * @syscap SystemCapability.ArkUI.ArkUI.Full 34331 * @crossplatform 34332 * @form 34333 * @atomicservice 34334 * @since 20 34335 */ 34336declare type OnWillStopDraggingCallback = (velocity: number) => void; 34337 34338/** 34339 * Defines the onMove callback. 34340 * 34341 * @typedef { function } OnMoveHandler 34342 * @param { number } from - Index number for moving elements. 34343 * @param { number } to - Target index number for moving elements. 34344 * @syscap SystemCapability.ArkUI.ArkUI.Full 34345 * @crossplatform 34346 * @atomicservice 34347 * @since arkts {'1.1':'12','1.2':'20'} 34348 * @arkts 1.1&1.2 34349 */ 34350declare type OnMoveHandler = (from: number, to: number) => void; 34351 34352/** 34353 * Define item drag event handler. 34354 * 34355 * @interface ItemDragEventHandler 34356 * @syscap SystemCapability.ArkUI.ArkUI.Full 34357 * @crossplatform 34358 * @atomicservice 34359 * @since 20 34360 * @arkts 1.1&1.2 34361 */ 34362declare interface ItemDragEventHandler { 34363 /** 34364 * This callback is triggered when the item is long pressed. 34365 * 34366 * @type { ?Callback<number> } 34367 * @syscap SystemCapability.ArkUI.ArkUI.Full 34368 * @crossplatform 34369 * @atomicservice 34370 * @since 20 34371 * @arkts 1.1&1.2 34372 */ 34373 onLongPress?: Callback<number>; 34374 34375 /** 34376 * This callback is triggered when the item is dragged. 34377 * 34378 * @type { ?Callback<number> } 34379 * @syscap SystemCapability.ArkUI.ArkUI.Full 34380 * @crossplatform 34381 * @atomicservice 34382 * @since 20 34383 * @arkts 1.1&1.2 34384 */ 34385 onDragStart?: Callback<number>; 34386 34387 /** 34388 * This callback is triggered when an item is moved through other items. 34389 * 34390 * @type { ?OnMoveHandler } 34391 * @syscap SystemCapability.ArkUI.ArkUI.Full 34392 * @crossplatform 34393 * @atomicservice 34394 * @since 20 34395 * @arkts 1.1&1.2 34396 */ 34397 onMoveThrough?: OnMoveHandler; 34398 34399 /** 34400 * This callback is triggered when the item is dropped. 34401 * 34402 * @type { ?Callback<number> } 34403 * @syscap SystemCapability.ArkUI.ArkUI.Full 34404 * @crossplatform 34405 * @atomicservice 34406 * @since 20 34407 * @arkts 1.1&1.2 34408 */ 34409 onDrop?: Callback<number>; 34410} 34411 34412/** 34413 * Define DynamicNode. 34414 * 34415 * @syscap SystemCapability.ArkUI.ArkUI.Full 34416 * @crossplatform 34417 * @atomicservice 34418 * @since 12 34419 */ 34420declare class DynamicNode<T> { 34421 /** 34422 * Invoked when data is moved during drag and drop sorting. 34423 * This callback is only applicable in a List component. 34424 * where each ForEach iteration generates a ListItem component. 34425 * It allows you to define custom drag actions and handle various drag events. 34426 * 34427 * @param { Optional<OnMoveHandler> } handler 34428 * @returns { T } 34429 * @syscap SystemCapability.ArkUI.ArkUI.Full 34430 * @crossplatform 34431 * @atomicservice 34432 * @since 12 34433 */ 34434 onMove(handler: Optional<OnMoveHandler>): T; 34435 34436 /** 34437 * Set the move action. 34438 * 34439 * @param { Optional<OnMoveHandler> } handler 34440 * @param { ItemDragEventHandler } eventHandler 34441 * @returns { T } 34442 * @syscap SystemCapability.ArkUI.ArkUI.Full 34443 * @crossplatform 34444 * @atomicservice 34445 * @since 20 34446 */ 34447 onMove(handler: Optional<OnMoveHandler>, eventHandler: ItemDragEventHandler): T; 34448} 34449 34450/** 34451 * Define DynamicNode. 34452 * 34453 * @syscap SystemCapability.ArkUI.ArkUI.Full 34454 * @crossplatform 34455 * @atomicservice 34456 * @since 20 34457 * @arkts 1.2 34458 */ 34459declare interface DynamicNode { 34460 /** 34461 * Set the move action. 34462 * 34463 * @param { Optional<OnMoveHandler> } handler 34464 * @returns { this } 34465 * @syscap SystemCapability.ArkUI.ArkUI.Full 34466 * @crossplatform 34467 * @atomicservice 34468 * @since 20 34469 * @arkts 1.2 34470 */ 34471 onMove(handler: Optional<OnMoveHandler>): this; 34472 34473 /** 34474 * Set the move action. 34475 * 34476 * @param { Optional<OnMoveHandler> } handler 34477 * @param { ItemDragEventHandler } eventHandler 34478 * @returns { this } 34479 * @syscap SystemCapability.ArkUI.ArkUI.Full 34480 * @crossplatform 34481 * @atomicservice 34482 * @since 20 34483 * @arkts 1.2 34484 */ 34485 onMove(handler: Optional<OnMoveHandler>, eventHandler: ItemDragEventHandler): this; 34486} 34487 34488/** 34489 * Define EdgeEffect Options. 34490 * 34491 * @interface EdgeEffectOptions 34492 * @syscap SystemCapability.ArkUI.ArkUI.Full 34493 * @crossplatform 34494 * @since 11 34495 */ 34496/** 34497 * Define EdgeEffect Options. 34498 * 34499 * @interface EdgeEffectOptions 34500 * @syscap SystemCapability.ArkUI.ArkUI.Full 34501 * @crossplatform 34502 * @atomicservice 34503 * @since arkts {'1.1':'12','1.2':'20'} 34504 * @arkts 1.1&1.2 34505 */ 34506declare interface EdgeEffectOptions { 34507 /** 34508 * Enable Sliding effect when component does not full screen. 34509 * 34510 * @type { boolean } 34511 * @syscap SystemCapability.ArkUI.ArkUI.Full 34512 * @crossplatform 34513 * @since 11 34514 */ 34515 /** 34516 * Enable Sliding effect when component does not full screen. 34517 * 34518 * @type { boolean } 34519 * @syscap SystemCapability.ArkUI.ArkUI.Full 34520 * @crossplatform 34521 * @atomicservice 34522 * @since arkts {'1.1':'12','1.2':'20'} 34523 * @arkts 1.1&1.2 34524 */ 34525 alwaysEnabled: boolean; 34526 34527 /** 34528 * Set the effective edge of the edge effect. 34529 * 34530 * @type { ?number } 34531 * @syscap SystemCapability.ArkUI.ArkUI.Full 34532 * @crossplatform 34533 * @atomicservice 34534 * @since arkts {'1.1':'18','1.2':'20'} 34535 * @arkts 1.1&1.2 34536 */ 34537 effectEdge?: number; 34538} 34539 34540/** 34541 * Enumerates the effective edge of the edge effect. 34542 * 34543 * @enum { number } 34544 * @syscap SystemCapability.ArkUI.ArkUI.Full 34545 * @crossplatform 34546 * @atomicservice 34547 * @since arkts {'1.1':'18','1.2':'20'} 34548 * @arkts 1.1&1.2 34549 */ 34550declare enum EffectEdge { 34551 34552 /** 34553 * Effective only for the starting edge. 34554 * 34555 * @syscap SystemCapability.ArkUI.ArkUI.Full 34556 * @crossplatform 34557 * @atomicservice 34558 * @since arkts {'1.1':'18','1.2':'20'} 34559 * @arkts 1.1&1.2 34560 */ 34561 START = 1, 34562 34563 /** 34564 * Effective only for the end edge. 34565 * 34566 * @syscap SystemCapability.ArkUI.ArkUI.Full 34567 * @crossplatform 34568 * @atomicservice 34569 * @since arkts {'1.1':'18','1.2':'20'} 34570 * @arkts 1.1&1.2 34571 */ 34572 END = 2, 34573} 34574 34575/** 34576 * Indicates children main size. 34577 * 34578 * @syscap SystemCapability.ArkUI.ArkUI.Full 34579 * @crossplatform 34580 * @atomicservice 34581 * @since arkts {'1.1':'12','1.2':'20'} 34582 * @arkts 1.1&1.2 34583 */ 34584declare class ChildrenMainSize { 34585 /** 34586 * Creates an instance of ChildrenMainSize. 34587 * 34588 * @param { number } childDefaultSize - default main size, in vp. If the main axis is vertical, it indicates height. 34589 * If the main axis is horizontal, it indicates width. 34590 * @throws { BusinessError } 401 - Parameter error. Possible causes: 34591 * <br> 1. Mandatory parameters are left unspecified. 34592 * <br> 2. Incorrect parameters types. 34593 * <br> 3. Parameter verification failed. 34594 * @syscap SystemCapability.ArkUI.ArkUI.Full 34595 * @crossplatform 34596 * @atomicservice 34597 * @since arkts {'1.1':'12','1.2':'20'} 34598 * @arkts 1.1&1.2 34599 */ 34600 constructor(childDefaultSize: number); 34601 34602 /** 34603 * Set default size. 34604 * 34605 * @param { number } value - default main size, in vp. If the main axis is vertical, it indicates height. 34606 * If the main axis is horizontal, it indicates width. 34607 * @throws { BusinessError } 401 - Parameter error. Possible causes: 34608 * <br> 1. Mandatory parameters are left unspecified. 34609 * <br> 2. Incorrect parameters types. 34610 * <br> 3. Parameter verification failed. 34611 * @syscap SystemCapability.ArkUI.ArkUI.Full 34612 * @crossplatform 34613 * @atomicservice 34614 * @since arkts {'1.1':'12','1.2':'20'} 34615 * @arkts 1.1&1.2 34616 */ 34617 set childDefaultSize(value: number); 34618 34619 /** 34620 * Get default size 34621 * 34622 * @returns { number } - default main size, in vp. If the main axis is vertical, it indicates height. 34623 * If the main axis is horizontal, it indicates width. 34624 * @syscap SystemCapability.ArkUI.ArkUI.Full 34625 * @crossplatform 34626 * @atomicservice 34627 * @since arkts {'1.1':'12','1.2':'20'} 34628 * @arkts 1.1&1.2 34629 */ 34630 get childDefaultSize(): number; 34631 34632 /** 34633 * Changes children main size by removing or replacing existing elements and/or adding new elements in place. 34634 * 34635 * @param { number } start - Zero-based index at which to start changing the children main size. 34636 * @param { number } [deleteCount] - Indicating the number of children main size to remove from start. 34637 * @param { Array<number> } [childrenSize] - Add the new children main size, beginning from start. 34638 * @throws { BusinessError } 401 - Parameter error. Possible causes: 34639 * <br> 1. Mandatory parameters are left unspecified. 34640 * <br> 2. Incorrect parameters types. 34641 * <br> 3. Parameter verification failed. 34642 * @syscap SystemCapability.ArkUI.ArkUI.Full 34643 * @crossplatform 34644 * @atomicservice 34645 * @since arkts {'1.1':'12','1.2':'20'} 34646 * @example splice(1, 0, [100]), Insert a child after first child, the child's main size is 100vp. 34647 * splice(1, 1), Delete the second child. 34648 * splice(1, 2, [100, 100]), Change the main size of the second and third children to 100vp. 34649 * @arkts 1.1&1.2 34650 */ 34651 splice(start: number, deleteCount?: number, childrenSize?: Array<number>): void; 34652 34653 /** 34654 * Updates main size for specified child. 34655 * 34656 * @param { number } index - index of child to be updated. 34657 * @param { number } childSize - new section options. 34658 * @throws { BusinessError } 401 - Parameter error. Possible causes: 34659 * <br> 1. Mandatory parameters are left unspecified. 34660 * <br> 2. Incorrect parameters types. 34661 * <br> 3. Parameter verification failed. 34662 * @syscap SystemCapability.ArkUI.ArkUI.Full 34663 * @crossplatform 34664 * @atomicservice 34665 * @since arkts {'1.1':'12','1.2':'20'} 34666 * @arkts 1.1&1.2 34667 */ 34668 update(index: number, childSize: number): void; 34669} 34670 34671/** 34672 * Define BackgroundBrightness Options. 34673 * 34674 * @interface BackgroundBrightnessOptions 34675 * @syscap SystemCapability.ArkUI.ArkUI.Full 34676 * @atomicservice 34677 * @since arkts {'1.1':'12','1.2':'20'} 34678 * @arkts 1.1&1.2 34679 */ 34680declare interface BackgroundBrightnessOptions { 34681 34682 /** 34683 * Brightness change rate. A higher rate means that brightness decreases more quickly. 34684 * If **rate** is set to **0**, **lightUpDegree** will not take effect, meaning no brightening effect will occur. 34685 * 34686 * @type { number } - The default value is 0.0, value range: (0.0, +∞). 34687 * @syscap SystemCapability.ArkUI.ArkUI.Full 34688 * @atomicservice 34689 * @since arkts {'1.1':'12','1.2':'20'} 34690 * @arkts 1.1&1.2 34691 */ 34692 rate: number; 34693 34694 /** 34695 * Light up degree. A greater degree indicates a greater increase in brightness. 34696 * 34697 * @type { number } - The default value is 0.0, value range: [-1.0, 1.0]. 34698 * @syscap SystemCapability.ArkUI.ArkUI.Full 34699 * @atomicservice 34700 * @since arkts {'1.1':'12','1.2':'20'} 34701 * @arkts 1.1&1.2 34702 */ 34703 lightUpDegree: number; 34704} 34705 34706/** 34707 * PointLightStyle info 34708 * 34709 * @interface PointLightStyle 34710 * @syscap SystemCapability.ArkUI.ArkUI.Full 34711 * @systemapi 34712 * @since arkts {'1.1':'11','1.2':'20'} 34713 * @arkts 1.1&1.2 34714 */ 34715declare interface PointLightStyle { 34716 /** 34717 * Defines the PointLight light intensity and position. 34718 * 34719 * @type { ?LightSource } 34720 * @default undefined 34721 * @syscap SystemCapability.ArkUI.ArkUI.Full 34722 * @systemapi 34723 * @since arkts {'1.1':'11','1.2':'20'} 34724 * @arkts 1.1&1.2 34725 */ 34726 lightSource?: LightSource; 34727 /** 34728 * Defines the PointLight illuminated type. 34729 * 34730 * @type { ?IlluminatedType } 34731 * @default IlluminatedType.NONE 34732 * @syscap SystemCapability.ArkUI.ArkUI.Full 34733 * @systemapi 34734 * @since arkts {'1.1':'11','1.2':'20'} 34735 * @arkts 1.1&1.2 34736 */ 34737 illuminated?: IlluminatedType; 34738 /** 34739 * Defines the PointLight bloom. 34740 * 34741 * @type { ?number } 34742 * @default 0 34743 * @syscap SystemCapability.ArkUI.ArkUI.Full 34744 * @systemapi 34745 * @since arkts {'1.1':'11','1.2':'20'} 34746 * @arkts 1.1&1.2 34747 */ 34748 bloom?: number; 34749} 34750 34751/** 34752 * LightSource info 34753 * 34754 * @interface LightSource 34755 * @syscap SystemCapability.ArkUI.ArkUI.Full 34756 * @systemapi 34757 * @since arkts {'1.1':'11','1.2':'20'} 34758 * @arkts 1.1&1.2 34759 */ 34760declare interface LightSource { 34761 /** 34762 * Defines the PointLight light positionX. 34763 * 34764 * @type { Dimension } 34765 * @syscap SystemCapability.ArkUI.ArkUI.Full 34766 * @systemapi 34767 * @since arkts {'1.1':'11','1.2':'20'} 34768 * @arkts 1.1&1.2 34769 */ 34770 positionX: Dimension; 34771 /** 34772 * Defines the PointLight light positionX. 34773 * 34774 * @type { Dimension } 34775 * @syscap SystemCapability.ArkUI.ArkUI.Full 34776 * @systemapi 34777 * @since arkts {'1.1':'11','1.2':'20'} 34778 * @arkts 1.1&1.2 34779 */ 34780 positionY: Dimension; 34781 /** 34782 * Defines the PointLight light positionX. 34783 * 34784 * @type { Dimension } 34785 * @syscap SystemCapability.ArkUI.ArkUI.Full 34786 * @systemapi 34787 * @since arkts {'1.1':'11','1.2':'20'} 34788 * @arkts 1.1&1.2 34789 */ 34790 positionZ: Dimension; 34791 /** 34792 * Defines the PointLight light intensity. 34793 * 34794 * @type { number } 34795 * @syscap SystemCapability.ArkUI.ArkUI.Full 34796 * @systemapi 34797 * @since arkts {'1.1':'11','1.2':'20'} 34798 * @arkts 1.1&1.2 34799 */ 34800 intensity: number; 34801 /** 34802 * Defines the PointLight light color. 34803 * 34804 * @type { ?ResourceColor } 34805 * @syscap SystemCapability.ArkUI.ArkUI.Full 34806 * @systemapi 34807 * @since arkts {'1.1':'12','1.2':'20'} 34808 * @arkts 1.1&1.2 34809 */ 34810 color?: ResourceColor; 34811} 34812 34813/** 34814 * wrapBuilder is a template function that returns a WrappedBuilder object. 34815 * wrapBuilder only accepts a global @Builder decorated function as its argument. 34816 * Of the WrappedBuilder object it returns, the builder attribute method can be used only inside the struct. 34817 * @param { function } builder 34818 * @returns { WrappedBuilder<Args> } 34819 * @syscap SystemCapability.ArkUI.ArkUI.Full 34820 * @crossplatform 34821 * @since 11 34822 */ 34823/** 34824 * wrapBuilder is a template function that returns a WrappedBuilder object. 34825 * wrapBuilder only accepts a global @Builder decorated function as its argument. 34826 * Of the WrappedBuilder object it returns, the builder attribute method can be used only inside the struct. 34827 * @param { function } builder 34828 * @returns { WrappedBuilder<Args> } 34829 * @syscap SystemCapability.ArkUI.ArkUI.Full 34830 * @crossplatform 34831 * @atomicservice 34832 * @since 12 34833 */ 34834declare function wrapBuilder<Args extends Object[]>(builder: (...args: Args) => void): WrappedBuilder<Args>; 34835/** 34836 * Defining wrapBuilder function. 34837 * @param { function } builder 34838 * @returns { WrappedBuilder<Args> } 34839 * @syscap SystemCapability.ArkUI.ArkUI.Full 34840 * @crossplatform 34841 * @atomicservice 34842 * @since 20 34843 * @arkts 1.2 34844 */ 34845declare function wrapBuilder<Args extends Array<Object>>(builder: (args: Args) => void): WrappedBuilder<Args>; 34846 34847/** 34848 * The WrappedBuilder object is also a template class. 34849 * @syscap SystemCapability.ArkUI.ArkUI.Full 34850 * @crossplatform 34851 * @since 11 34852 */ 34853/** 34854 * The WrappedBuilder object is also a template class. 34855 * @syscap SystemCapability.ArkUI.ArkUI.Full 34856 * @crossplatform 34857 * @atomicservice 34858 * @since 12 34859 */ 34860declare class WrappedBuilder<Args extends Object[]> { 34861 /** 34862 * global @Builder decorated function. 34863 * @type { function } 34864 * @syscap SystemCapability.ArkUI.ArkUI.Full 34865 * @crossplatform 34866 * @since 11 34867 */ 34868 /** 34869 * global @Builder decorated function. 34870 * @type { function } 34871 * @syscap SystemCapability.ArkUI.ArkUI.Full 34872 * @crossplatform 34873 * @atomicservice 34874 * @since 12 34875 */ 34876 builder: (...args: Args) => void; 34877 34878 /** 34879 * @param { function } builder 34880 * @syscap SystemCapability.ArkUI.ArkUI.Full 34881 * @crossplatform 34882 * @since 11 34883 */ 34884 /** 34885 * @param { function } builder 34886 * @syscap SystemCapability.ArkUI.ArkUI.Full 34887 * @crossplatform 34888 * @atomicservice 34889 * @since 12 34890 */ 34891 constructor(builder: (...args: Args) => void); 34892} 34893 34894 34895 34896/** 34897 * Defines the WrappedBuilder class. 34898 * @syscap SystemCapability.ArkUI.ArkUI.Full 34899 * @crossplatform 34900 * @atomicservice 34901 * @since 20 34902 * @arkts 1.2 34903 */ 34904declare class WrappedBuilder<Args extends Array<Object>> { 34905 34906 /** 34907 * @type { function } 34908 * @syscap SystemCapability.ArkUI.ArkUI.Full 34909 * @crossplatform 34910 * @atomicservice 34911 * @since 20 34912 * @arkts 1.2 34913 */ 34914 builder: (args: Args) => void; 34915 34916 /** 34917 * @param { function } builder 34918 * @syscap SystemCapability.ArkUI.ArkUI.Full 34919 * @crossplatform 34920 * @atomicservice 34921 * @since 20 34922 * @arkts 1.2 34923 */ 34924 constructor(builder: (args: Args) => void); 34925} 34926 34927 34928/** 34929 * Defines the overall animation parameters of the keyframe animation. 34930 * 34931 * @interface KeyframeAnimateParam 34932 * @syscap SystemCapability.ArkUI.ArkUI.Full 34933 * @crossplatform 34934 * @since 11 34935 */ 34936/** 34937 * Defines the overall animation parameters of the keyframe animation. 34938 * 34939 * @interface KeyframeAnimateParam 34940 * @syscap SystemCapability.ArkUI.ArkUI.Full 34941 * @crossplatform 34942 * @atomicservice 34943 * @since arkts {'1.1':'12','1.2':'20'} 34944 * @arkts 1.1&1.2 34945 */ 34946declare interface KeyframeAnimateParam { 34947 /** 34948 * Animation delay time, in ms. 34949 * 34950 * @type { ?number } 34951 * @default 0 34952 * @syscap SystemCapability.ArkUI.ArkUI.Full 34953 * @crossplatform 34954 * @since 11 34955 */ 34956 /** 34957 * Animation delay time, in ms. 34958 * 34959 * @type { ?number } 34960 * @default 0 34961 * @syscap SystemCapability.ArkUI.ArkUI.Full 34962 * @crossplatform 34963 * @atomicservice 34964 * @since arkts {'1.1':'12','1.2':'20'} 34965 * @arkts 1.1&1.2 34966 */ 34967 delay?: number; 34968 34969 /** 34970 * Animation iterations. When set to -1, the animation playing it repeatedly. The value range is greater than or equal to -1. 34971 * 34972 * @type { ?number } 34973 * @default 1 34974 * @syscap SystemCapability.ArkUI.ArkUI.Full 34975 * @crossplatform 34976 * @since 11 34977 */ 34978 /** 34979 * Animation iterations. When set to -1, the animation playing it repeatedly. The value range is greater than or equal to -1. 34980 * 34981 * @type { ?number } 34982 * @default 1 34983 * @syscap SystemCapability.ArkUI.ArkUI.Full 34984 * @crossplatform 34985 * @atomicservice 34986 * @since arkts {'1.1':'12','1.2':'20'} 34987 * @arkts 1.1&1.2 34988 */ 34989 iterations?: number; 34990 34991 /** 34992 * Callback invoked when the whole keyframe animation is complete or the ability is about to enter the background. 34993 * 34994 * @type { ?function } 34995 * @syscap SystemCapability.ArkUI.ArkUI.Full 34996 * @crossplatform 34997 * @since 11 34998 */ 34999 /** 35000 * Callback invoked when the whole keyframe animation is complete or the ability is about to enter the background. 35001 * 35002 * @type { ?function } 35003 * @syscap SystemCapability.ArkUI.ArkUI.Full 35004 * @crossplatform 35005 * @atomicservice 35006 * @since arkts {'1.1':'12','1.2':'20'} 35007 * @arkts 1.1&1.2 35008 */ 35009 onFinish?: () => void; 35010 35011 /** 35012 * Indicates expectedFrameRateRange of keyframe animation. 35013 * 35014 * @type { ?ExpectedFrameRateRange } 35015 * @default { min: 0, expected: 0, max: 0 } 35016 * @syscap SystemCapability.ArkUI.ArkUI.Full 35017 * @crossplatform 35018 * @atomicservice 35019 * @since arkts {'1.1':'19','1.2':'20'} 35020 * @arkts 1.1&1.2 35021 */ 35022 expectedFrameRateRange?: ExpectedFrameRateRange; 35023} 35024 35025/** 35026 * Defines a keyframe state. 35027 * 35028 * @interface KeyframeState 35029 * @syscap SystemCapability.ArkUI.ArkUI.Full 35030 * @crossplatform 35031 * @since 11 35032 */ 35033/** 35034 * Defines a keyframe state. 35035 * 35036 * @interface KeyframeState 35037 * @syscap SystemCapability.ArkUI.ArkUI.Full 35038 * @crossplatform 35039 * @atomicservice 35040 * @since arkts {'1.1':'12','1.2':'20'} 35041 * @arkts 1.1&1.2 35042 */ 35043declare interface KeyframeState { 35044 /** 35045 * Animation duration of this keyframe, in ms. 35046 * 35047 * @type { number } 35048 * @syscap SystemCapability.ArkUI.ArkUI.Full 35049 * @crossplatform 35050 * @since 11 35051 */ 35052 /** 35053 * Animation duration of this keyframe, in ms. 35054 * 35055 * @type { number } 35056 * @syscap SystemCapability.ArkUI.ArkUI.Full 35057 * @crossplatform 35058 * @atomicservice 35059 * @since arkts {'1.1':'12','1.2':'20'} 35060 * @arkts 1.1&1.2 35061 */ 35062 duration: number; 35063 35064 /** 35065 * Animation curve of this keyframe. 35066 * 35067 * @type { ?(Curve | string | ICurve) } 35068 * @default Curve.EaseInOut 35069 * @syscap SystemCapability.ArkUI.ArkUI.Full 35070 * @crossplatform 35071 * @since 11 35072 */ 35073 /** 35074 * Animation curve of this keyframe. 35075 * 35076 * @type { ?(Curve | string | ICurve) } 35077 * @default Curve.EaseInOut 35078 * @syscap SystemCapability.ArkUI.ArkUI.Full 35079 * @crossplatform 35080 * @atomicservice 35081 * @since arkts {'1.1':'12','1.2':'20'} 35082 * @arkts 1.1&1.2 35083 */ 35084 curve?: Curve | string | ICurve; 35085 35086 /** 35087 * The closure function to specify the terminating state of this keyframe. 35088 * 35089 * @type { function } 35090 * @syscap SystemCapability.ArkUI.ArkUI.Full 35091 * @crossplatform 35092 * @since 11 35093 */ 35094 /** 35095 * The closure function to specify the terminating state of this keyframe. 35096 * 35097 * @type { function } 35098 * @syscap SystemCapability.ArkUI.ArkUI.Full 35099 * @crossplatform 35100 * @atomicservice 35101 * @since arkts {'1.1':'12','1.2':'20'} 35102 * @arkts 1.1&1.2 35103 */ 35104 event: () => void; 35105} 35106 35107 35108/** 35109 * Defines the basic callback. 35110 * 35111 * @typedef Callback<T, V = void> 35112 * @syscap SystemCapability.ArkUI.ArkUI.Full 35113 * @crossplatform 35114 * @atomicservice 35115 * @since 12 35116 */ 35117declare interface Callback<T, V = void> { 35118 /** 35119 * Defines the callback info. 35120 * 35121 * @param { T } data - the data will be used in the callback. 35122 * @returns { V } - Returns result of the callback. 35123 * @syscap SystemCapability.ArkUI.ArkUI.Full 35124 * @crossplatform 35125 * @atomicservice 35126 * @since 12 35127 */ 35128 (data: T): V; 35129} 35130 35131/** 35132 * Defines the callback 35133 * 35134 * @typedef { function } Callback<T, V = void> 35135 * @param { T } data 35136 * @returns { V } 35137 * @syscap SystemCapability.ArkUI.ArkUI.Full 35138 * @crossplatform 35139 * @atomicservice 35140 * @since 20 35141 * @arkts 1.2 35142 */ 35143export type Callback<T, V = void> = (data: T) => V; 35144 35145/** 35146 * Defines the callback type used in hover events. 35147 * The value of isHover indicates whether the mouse is hovering over the component. 35148 * The value of event contains information about HoverEvent. 35149 * 35150 * @typedef { function } HoverCallback 35151 * @param { boolean } isHover 35152 * @param { HoverEvent} event 35153 * @syscap SystemCapability.ArkUI.ArkUI.Full 35154 * @crossplatform 35155 * @atomicservice 35156 * @since arkts {'1.1':'12','1.2':'20'} 35157 * @arkts 1.1&1.2 35158 */ 35159declare type HoverCallback = (isHover: boolean, event: HoverEvent) => void; 35160 35161/** 35162 * Defines the callback type used in accessibility hover events. 35163 * The value of isHover indicates whether the touch is hovering over the component. 35164 * The value of event contains information about AccessibilityHoverEvent. 35165 * 35166 * @typedef { function } AccessibilityCallback 35167 * @param { boolean } isHover 35168 * @param { AccessibilityHoverEvent } event 35169 * @syscap SystemCapability.ArkUI.ArkUI.Full 35170 * @crossplatform 35171 * @atomicservice 35172 * @since arkts {'1.1':'12','1.2':'20'} 35173 * @arkts 1.1&1.2 35174 */ 35175declare type AccessibilityCallback = (isHover: boolean, event: AccessibilityHoverEvent) => void; 35176 35177/** 35178 * Defines the callback type used in accessibility hover transparent event. 35179 * 35180 * @typedef { function } AccessibilityTransparentCallback 35181 * @param { TouchEvent } event - The value of event contains information about original accessibility hover event. 35182 * @syscap SystemCapability.ArkUI.ArkUI.Full 35183 * @crossplatform 35184 * @atomicservice 35185 * @since 20 35186 */ 35187declare type AccessibilityTransparentCallback = (event: TouchEvent) => void 35188 35189/** 35190 * Defines the options about VisibleAreaEvent. 35191 * 35192 * @interface VisibleAreaEventOptions 35193 * @syscap SystemCapability.ArkUI.ArkUI.Full 35194 * @crossplatform 35195 * @atomicservice 35196 * @since arkts {'1.1':'12','1.2':'20'} 35197 * @arkts 1.1&1.2 35198 */ 35199declare interface VisibleAreaEventOptions { 35200 /** 35201 * Each number in ratios indicates the value of visibility ratio. Each number in the Array value range in [0, 1]. 35202 * 35203 * @type { Array<number> } 35204 * @syscap SystemCapability.ArkUI.ArkUI.Full 35205 * @crossplatform 35206 * @atomicservice 35207 * @since arkts {'1.1':'12','1.2':'20'} 35208 * @arkts 1.1&1.2 35209 */ 35210 ratios: Array<number>; 35211 35212 /** 35213 * The value of expectedUpdateInterval indicates desired update period(ms). 35214 * 35215 * @type { ?number } 35216 * @default 1000 35217 * @syscap SystemCapability.ArkUI.ArkUI.Full 35218 * @crossplatform 35219 * @atomicservice 35220 * @since arkts {'1.1':'12','1.2':'20'} 35221 * @arkts 1.1&1.2 35222 */ 35223 expectedUpdateInterval?: number; 35224} 35225 35226/** 35227 * Defines the callback type used in VisibleAreaChange events. 35228 * 35229 * @typedef { function } VisibleAreaChangeCallback 35230 * @param { boolean } isVisible - Indicates the ratio of the visible area to its own area compared to the last change. 35231 * It is true as the ratio increases and false as the ratio decreases. 35232 * @param { number } currentRatio - The value of currentRatio indicates the visibility ratio of the current component. 35233 * @syscap SystemCapability.ArkUI.ArkUI.Full 35234 * @crossplatform 35235 * @atomicservice 35236 * @since 12 35237 */ 35238/** 35239 * Defines the callback type used in VisibleAreaChange events. 35240 * 35241 * @typedef { function } VisibleAreaChangeCallback 35242 * @param { boolean } isExpanding - Indicates the ratio of the visible area to its own area compared to the last change. 35243 * It is true as the ratio increases and false as the ratio decreases. 35244 * @param { number } currentRatio - The value of currentRatio indicates the visibility ratio of the current component. 35245 * @syscap SystemCapability.ArkUI.ArkUI.Full 35246 * @crossplatform 35247 * @atomicservice 35248 * @since arkts {'1.1':'13','1.2':'20'} 35249 * @arkts 1.1&1.2 35250 */ 35251declare type VisibleAreaChangeCallback = (isExpanding: boolean, currentRatio: number) => void; 35252 35253/** 35254 * Defines a UICommonEvent which is used to set different common event to target component. 35255 * 35256 * @interface UICommonEvent 35257 * @syscap SystemCapability.ArkUI.ArkUI.Full 35258 * @crossplatform 35259 * @atomicservice 35260 * @since arkts {'1.1':'12','1.2':'20'} 35261 * @arkts 1.1&1.2 35262 */ 35263declare interface UICommonEvent { 35264 /** 35265 * Set or reset the callback which will be triggered a click event when clicked. 35266 * 35267 * @param { Callback<ClickEvent> | undefined } callback - The callback about the click event. If set undefined will reset the target callback. 35268 * @syscap SystemCapability.ArkUI.ArkUI.Full 35269 * @crossplatform 35270 * @atomicservice 35271 * @since arkts {'1.1':'12','1.2':'20'} 35272 * @arkts 1.1&1.2 35273 */ 35274 setOnClick(callback: Callback<ClickEvent> | undefined): void; 35275 35276 /** 35277 * Set or reset the callback which will be triggered a touch event when touched. 35278 * 35279 * @param { Callback<TouchEvent> | undefined } callback - The callback about the touch event. If set undefined will reset the target callback. 35280 * @syscap SystemCapability.ArkUI.ArkUI.Full 35281 * @crossplatform 35282 * @atomicservice 35283 * @since arkts {'1.1':'12','1.2':'20'} 35284 * @arkts 1.1&1.2 35285 */ 35286 setOnTouch(callback: Callback<TouchEvent> | undefined): void; 35287 35288 /** 35289 * Set or reset the callback is triggered when a component mounts a display. 35290 * 35291 * @param { Callback<void> | undefined } callback - The callback will be triggered when a component mounts a display. If set undefined will reset the target callback. 35292 * @syscap SystemCapability.ArkUI.ArkUI.Full 35293 * @crossplatform 35294 * @atomicservice 35295 * @since arkts {'1.1':'12','1.2':'20'} 35296 * @arkts 1.1&1.2 35297 */ 35298 setOnAppear(callback: Callback<void> | undefined): void; 35299 35300 /** 35301 * Set or reset the callback is triggered when component uninstallation disappears. 35302 * 35303 * @param { Callback<void> | undefined } callback - The callback will be triggered when component uninstallation disappears. If set undefined will reset the target callback. 35304 * @syscap SystemCapability.ArkUI.ArkUI.Full 35305 * @crossplatform 35306 * @atomicservice 35307 * @since arkts {'1.1':'12','1.2':'20'} 35308 * @arkts 1.1&1.2 35309 */ 35310 setOnDisappear(callback: Callback<void> | undefined): void; 35311 35312 35313 /** 35314 * Set or reset the callback is triggered when component has keyboard input. 35315 * 35316 * @param { Callback<KeyEvent> | undefined } callback - The callback will be triggered when has keyboard input. If set undefined will reset the target callback. 35317 * @syscap SystemCapability.ArkUI.ArkUI.Full 35318 * @crossplatform 35319 * @atomicservice 35320 * @since arkts {'1.1':'12','1.2':'20'} 35321 * @arkts 1.1&1.2 35322 */ 35323 setOnKeyEvent(callback: Callback<KeyEvent> | undefined): void; 35324 35325 /** 35326 * Set or reset the callback which is triggered when component get focus. 35327 * 35328 * @param { Callback<void> | undefined } callback - The callback will be triggered when a component get focus. If set undefined will reset the target callback. 35329 * @syscap SystemCapability.ArkUI.ArkUI.Full 35330 * @crossplatform 35331 * @atomicservice 35332 * @since arkts {'1.1':'12','1.2':'20'} 35333 * @arkts 1.1&1.2 35334 */ 35335 setOnFocus(callback: Callback<void> | undefined): void; 35336 35337 /** 35338 * Set or reset the callback which is triggered when lose focus. 35339 * 35340 * @param { Callback<void> | undefined } callback - The callback will be triggered when a component lose focus. If set undefined will reset the target callback. 35341 * @syscap SystemCapability.ArkUI.ArkUI.Full 35342 * @crossplatform 35343 * @atomicservice 35344 * @since arkts {'1.1':'12','1.2':'20'} 35345 * @arkts 1.1&1.2 35346 */ 35347 setOnBlur(callback: Callback<void> | undefined): void; 35348 35349 /** 35350 * Set or reset the callback which is triggered when has a hover event. 35351 * 35352 * @param { HoverCallback | undefined } callback - The callback will be triggered when has a hover event. If set undefined will reset the target callback. 35353 * @syscap SystemCapability.ArkUI.ArkUI.Full 35354 * @crossplatform 35355 * @atomicservice 35356 * @since arkts {'1.1':'12','1.2':'20'} 35357 * @arkts 1.1&1.2 35358 */ 35359 setOnHover(callback: HoverCallback | undefined): void; 35360 35361 /** 35362 * Set or reset the callback which is triggered when has a mouse event. 35363 * 35364 * @param { Callback<MouseEvent> | undefined } callback - The callback will be triggered when has mouse input. If set undefined will reset the target callback. 35365 * @syscap SystemCapability.ArkUI.ArkUI.Full 35366 * @crossplatform 35367 * @atomicservice 35368 * @since arkts {'1.1':'12','1.2':'20'} 35369 * @arkts 1.1&1.2 35370 */ 35371 setOnMouse(callback: Callback<MouseEvent> | undefined): void; 35372 35373 /** 35374 * Sets the callback for the onSizeChange event. 35375 * 35376 * @param { SizeChangeCallback | undefined } callback - The callback will be triggered when the size of component changed. If set undefined will reset the target callback. 35377 * @syscap SystemCapability.ArkUI.ArkUI.Full 35378 * @crossplatform 35379 * @atomicservice 35380 * @since arkts {'1.1':'12','1.2':'20'} 35381 * @arkts 1.1&1.2 35382 */ 35383 setOnSizeChange(callback: SizeChangeCallback | undefined): void; 35384 35385 /** 35386 * Sets the onVisibleAreaChange callback that limits the callback interval. 35387 * 35388 * @param { VisibleAreaEventOptions } options - The options for the visibility event. 35389 * @param { VisibleAreaChangeCallback | undefined } event - The callback will be triggered when the visibleArea of component changed and get close to any number in ratios defined by options. 35390 * If set undefined will reset the target callback. 35391 * @syscap SystemCapability.ArkUI.ArkUI.Full 35392 * @crossplatform 35393 * @atomicservice 35394 * @since arkts {'1.1':'12','1.2':'20'} 35395 * @arkts 1.1&1.2 35396 */ 35397 setOnVisibleAreaApproximateChange(options: VisibleAreaEventOptions, event: VisibleAreaChangeCallback | undefined): void; 35398} 35399 35400/** 35401 * Defines a UIScrollableCommonEvent which is used to set event to target component. 35402 * 35403 * @extends UICommonEvent 35404 * @interface UIScrollableCommonEvent 35405 * @syscap SystemCapability.ArkUI.ArkUI.Full 35406 * @crossplatform 35407 * @atomicservice 35408 * @since 19 35409 */ 35410declare interface UIScrollableCommonEvent extends UICommonEvent { 35411 /** 35412 * Set or reset the callback which is triggered when the scrolling reaches the start position. 35413 * 35414 * @param { Callback<void> | undefined } callback - callback function, triggered when the 35415 * scrolling reaches the start position. 35416 * @syscap SystemCapability.ArkUI.ArkUI.Full 35417 * @crossplatform 35418 * @atomicservice 35419 * @since 19 35420 */ 35421 setOnReachStart(callback: Callback<void> | undefined): void; 35422 35423 /** 35424 * Set or reset the callback which is triggered when the scrolling reaches the end position. 35425 * 35426 * @param { Callback<void> | undefined } callback - callback function, triggered when the 35427 * scrolling reaches the end position. 35428 * @syscap SystemCapability.ArkUI.ArkUI.Full 35429 * @crossplatform 35430 * @atomicservice 35431 * @since 19 35432 */ 35433 setOnReachEnd(callback: Callback<void> | undefined): void; 35434 35435 /** 35436 * Set or reset the callback which is triggered when the scrolling started. 35437 * 35438 * @param { Callback<void> | undefined } callback - callback function, triggered when the scrolling started. 35439 * @syscap SystemCapability.ArkUI.ArkUI.Full 35440 * @crossplatform 35441 * @atomicservice 35442 * @since 19 35443 */ 35444 setOnScrollStart(callback: Callback<void> | undefined): void; 35445 35446 /** 35447 * Set or reset the callback which is triggered when the scrolling stoped. 35448 * 35449 * @param { Callback<void> | undefined } callback - callback function, triggered when the scrolling stoped. 35450 * @syscap SystemCapability.ArkUI.ArkUI.Full 35451 * @crossplatform 35452 * @atomicservice 35453 * @since 19 35454 */ 35455 setOnScrollStop(callback: Callback<void> | undefined): void; 35456 35457 /** 35458 * Set or reset the callback which is triggered when scrolling begin each frame. 35459 * 35460 * @param { OnScrollFrameBeginCallback | undefined } callback - callback function, triggered when the 35461 * scrolling begin each frame. 35462 * @syscap SystemCapability.ArkUI.ArkUI.Full 35463 * @crossplatform 35464 * @atomicservice 35465 * @since 19 35466 */ 35467 setOnScrollFrameBegin(callback: OnScrollFrameBeginCallback | undefined): void; 35468} 35469 35470/** 35471 * Defines a UIGestureEvent which is used to set different gestures to target component. 35472 * 35473 * @interface UIGestureEvent 35474 * @syscap SystemCapability.ArkUI.ArkUI.Full 35475 * @crossplatform 35476 * @atomicservice 35477 * @since arkts {'1.1':'12','1.2':'20'} 35478 * @arkts 1.1&1.2 35479 */ 35480declare interface UIGestureEvent { 35481 /** 35482 * Add a gesture bound to the component. 35483 * 35484 * @param { GestureHandler<T> } gesture - gesture indicates the gesture bound to a component. 35485 * @param { GesturePriority } priority - priority indicates the gesture's priority. 35486 * @param { GestureMask } mask - mask indicates the gesture's GestureMask value. 35487 * @syscap SystemCapability.ArkUI.ArkUI.Full 35488 * @crossplatform 35489 * @atomicservice 35490 * @since 12 35491 */ 35492 addGesture<T>(gesture: GestureHandler<T>, priority?: GesturePriority, mask?: GestureMask): void; 35493 35494 /** 35495 * Add a gesture bound to the component. 35496 * 35497 * @param { GestureHandler<T> } gesture - gesture indicates the gesture bound to a component. 35498 * @param { GesturePriority } priority - priority indicates the gesture's priority. 35499 * @param { GestureMask } mask - mask indicates the gesture's GestureMask value. 35500 * @syscap SystemCapability.ArkUI.ArkUI.Full 35501 * @crossplatform 35502 * @atomicservice 35503 * @since 20 35504 * @arkts 1.2 35505 */ 35506 addGesture(gesture: GestureHandler, priority?: GesturePriority, mask?: GestureMask): void; 35507 35508 /** 35509 * Adds a gesture that can be recognized at once by the component and its child component. 35510 * 35511 * @param { GestureHandler<T> } gesture - gesture indicates the gesture bound to a component. 35512 * @param { GestureMask } mask - mask indicates the gesture's GestureMask value. 35513 * @syscap SystemCapability.ArkUI.ArkUI.Full 35514 * @crossplatform 35515 * @atomicservice 35516 * @since 12 35517 */ 35518 addParallelGesture<T>(gesture: GestureHandler<T>, mask?: GestureMask): void; 35519 /** 35520 * Add a parallel gesture bound to the component. 35521 * 35522 * @param { GestureHandler<T> } gesture - gesture indicates the gesture bound to a component. 35523 * @param { GestureMask } mask - mask indicates the gesture's GestureMask value. 35524 * @syscap SystemCapability.ArkUI.ArkUI.Full 35525 * @crossplatform 35526 * @atomicservice 35527 * @since 20 35528 * @arkts 1.2 35529 */ 35530 addParallelGesture(gesture: GestureHandler, mask?: GestureMask): void; 35531 35532 /** 35533 * Remove a gesture from a component that has been bound with a specific tag through a modifier. 35534 * 35535 * @param { string } tag - tag indicates the gesture's tag. 35536 * @syscap SystemCapability.ArkUI.ArkUI.Full 35537 * @crossplatform 35538 * @atomicservice 35539 * @since arkts {'1.1':'12','1.2':'20'} 35540 * @arkts 1.1&1.2 35541 */ 35542 removeGestureByTag(tag: string): void; 35543 35544 /** 35545 * Clear gestures bound to the component. 35546 * 35547 * @syscap SystemCapability.ArkUI.ArkUI.Full 35548 * @crossplatform 35549 * @atomicservice 35550 * @since arkts {'1.1':'12','1.2':'20'} 35551 * @arkts 1.1&1.2 35552 */ 35553 clearGestures(): void; 35554} 35555 35556/** 35557 * Defines the gesture modifier. 35558 * 35559 * @interface GestureModifier 35560 * @syscap SystemCapability.ArkUI.ArkUI.Full 35561 * @crossplatform 35562 * @atomicservice 35563 * @since arkts {'1.1':'12','1.2':'20'} 35564 * @arkts 1.1&1.2 35565 */ 35566declare interface GestureModifier { 35567 /** 35568 * Defines the gesture update function. 35569 * 35570 * @param { UIGestureEvent } event 35571 * @syscap SystemCapability.ArkUI.ArkUI.Full 35572 * @crossplatform 35573 * @atomicservice 35574 * @since arkts {'1.1':'12','1.2':'20'} 35575 * @arkts 1.1&1.2 35576 */ 35577 applyGesture(event: UIGestureEvent): void; 35578} 35579 35580/** 35581 * Defines the selection options. 35582 * 35583 * @interface SelectionOptions 35584 * @syscap SystemCapability.ArkUI.ArkUI.Full 35585 * @crossplatform 35586 * @atomicservice 35587 * @since arkts {'1.1':'12','1.2':'20'} 35588 * @arkts 1.1&1.2 35589 */ 35590declare interface SelectionOptions { 35591 /** 35592 * Menu pop-up policy. 35593 * 35594 * @type { ?MenuPolicy } 35595 * @syscap SystemCapability.ArkUI.ArkUI.Full 35596 * @crossplatform 35597 * @atomicservice 35598 * @since arkts {'1.1':'12','1.2':'20'} 35599 * @arkts 1.1&1.2 35600 */ 35601 menuPolicy?: MenuPolicy; 35602} 35603 35604/** 35605 * Defines the next focus item. 35606 * 35607 * @interface FocusMovement 35608 * @syscap SystemCapability.ArkUI.ArkUI.Full 35609 * @crossplatform 35610 * @atomicservice 35611 * @since arkts {'1.1':'18','1.2':'20'} 35612 * @arkts 1.1&1.2 35613 */ 35614declare interface FocusMovement { 35615 /** 35616 * Next focus item's component identifier of forward. 35617 * 35618 * @type { ?string } 35619 * @syscap SystemCapability.ArkUI.ArkUI.Full 35620 * @crossplatform 35621 * @atomicservice 35622 * @since arkts {'1.1':'18','1.2':'20'} 35623 * @arkts 1.1&1.2 35624 */ 35625 forward?: string; 35626 /** 35627 * Next focus item's component identifier of backward. 35628 * 35629 * @type { ?string } 35630 * @syscap SystemCapability.ArkUI.ArkUI.Full 35631 * @crossplatform 35632 * @atomicservice 35633 * @since arkts {'1.1':'18','1.2':'20'} 35634 * @arkts 1.1&1.2 35635 */ 35636 backward?: string; 35637 /** 35638 * Next focus item's component identifier of up. 35639 * 35640 * @type { ?string } 35641 * @syscap SystemCapability.ArkUI.ArkUI.Full 35642 * @crossplatform 35643 * @atomicservice 35644 * @since arkts {'1.1':'18','1.2':'20'} 35645 * @arkts 1.1&1.2 35646 */ 35647 up?: string; 35648 /** 35649 * Next focus item's component identifier of down. 35650 * 35651 * @type { ?string } 35652 * @syscap SystemCapability.ArkUI.ArkUI.Full 35653 * @crossplatform 35654 * @atomicservice 35655 * @since arkts {'1.1':'18','1.2':'20'} 35656 * @arkts 1.1&1.2 35657 */ 35658 down?: string; 35659 /** 35660 * Next focus item's component identifier of left. 35661 * 35662 * @type { ?string } 35663 * @syscap SystemCapability.ArkUI.ArkUI.Full 35664 * @crossplatform 35665 * @atomicservice 35666 * @since arkts {'1.1':'18','1.2':'20'} 35667 * @arkts 1.1&1.2 35668 */ 35669 left?: string; 35670 /** 35671 * Next focus item's component identifier of right. 35672 * 35673 * @type { ?string } 35674 * @syscap SystemCapability.ArkUI.ArkUI.Full 35675 * @crossplatform 35676 * @atomicservice 35677 * @since arkts {'1.1':'18','1.2':'20'} 35678 * @arkts 1.1&1.2 35679 */ 35680 right?: string; 35681} 35682 35683/** 35684 * enum keyboard avoid mode 35685 * 35686 * @enum { number } 35687 * @syscap SystemCapability.ArkUI.ArkUI.Full 35688 * @crossplatform 35689 * @atomicservice 35690 * @since arkts {'1.1':'12','1.2':'20'} 35691 * @arkts 1.1&1.2 35692 */ 35693declare enum KeyboardAvoidMode { 35694 /** 35695 * Automatically avoids the soft keyboard and compresses the height when reaching the maximum limit. 35696 * 35697 * @syscap SystemCapability.ArkUI.ArkUI.Full 35698 * @crossplatform 35699 * @atomicservice 35700 * @since arkts {'1.1':'12','1.2':'20'} 35701 * @arkts 1.1&1.2 35702 */ 35703 DEFAULT = 0, 35704 35705 /** 35706 * Does not avoid the soft keyboard. 35707 * 35708 * @syscap SystemCapability.ArkUI.ArkUI.Full 35709 * @crossplatform 35710 * @atomicservice 35711 * @since arkts {'1.1':'12','1.2':'20'} 35712 * @arkts 1.1&1.2 35713 */ 35714 NONE = 1, 35715} 35716 35717/** 35718 * Enumerates the type of area in hover mode. 35719 * 35720 * @enum { number } 35721 * @syscap SystemCapability.ArkUI.ArkUI.Full 35722 * @crossplatform 35723 * @atomicservice 35724 * @since arkts {'1.1':'14','1.2':'20'} 35725 * @arkts 1.1&1.2 35726 */ 35727declare enum HoverModeAreaType { 35728 35729 /** 35730 * Layout top half screen when the phone in hover mode. 35731 * 35732 * @syscap SystemCapability.ArkUI.ArkUI.Full 35733 * @crossplatform 35734 * @atomicservice 35735 * @since arkts {'1.1':'14','1.2':'20'} 35736 * @arkts 1.1&1.2 35737 */ 35738 TOP_SCREEN = 0, 35739 35740 /** 35741 * Layout bottom half screen when the phone in hover mode. 35742 * 35743 * @syscap SystemCapability.ArkUI.ArkUI.Full 35744 * @crossplatform 35745 * @atomicservice 35746 * @since arkts {'1.1':'14','1.2':'20'} 35747 * @arkts 1.1&1.2 35748 */ 35749 BOTTOM_SCREEN = 1, 35750} 35751 35752/** 35753 * Defines a range of dates. 35754 * 35755 * @interface DateRange 35756 * @syscap SystemCapability.ArkUI.ArkUI.Full 35757 * @crossplatform 35758 * @atomicservice 35759 * @since arkts {'1.1':'19','1.2':'20'} 35760 * @arkts 1.1&1.2 35761 */ 35762declare interface DateRange { 35763 /** 35764 * Defines the start date of the date range. 35765 * 35766 * @type { ?Date } 35767 * @syscap SystemCapability.ArkUI.ArkUI.Full 35768 * @crossplatform 35769 * @atomicservice 35770 * @since arkts {'1.1':'19','1.2':'20'} 35771 * @arkts 1.1&1.2 35772 */ 35773 start?: Date; 35774 35775 /** 35776 * Defines the end date of the date range. 35777 * 35778 * @type { ?Date } 35779 * @syscap SystemCapability.ArkUI.ArkUI.Full 35780 * @crossplatform 35781 * @atomicservice 35782 * @since arkts {'1.1':'19','1.2':'20'} 35783 * @arkts 1.1&1.2 35784 */ 35785 end?: Date; 35786} 35787 35788/** 35789 * Indicates the information when the provider of the embedded UI is terminated. 35790 * 35791 * @interface TerminationInfo 35792 * @syscap SystemCapability.ArkUI.ArkUI.Full 35793 * @since 20 35794 * @arkts 1.2 35795 */ 35796declare interface TerminationInfo { 35797 /** 35798 * Defines the termination code. 35799 * 35800 * @type { number } 35801 * @syscap SystemCapability.ArkUI.ArkUI.Full 35802 * @since 20 35803 * @arkts 1.2 35804 */ 35805 code: number; 35806 35807 /** 35808 * Defines the additional termination information. 35809 * 35810 * @type { ?Want } 35811 * @syscap SystemCapability.ArkUI.ArkUI.Full 35812 * @since 20 35813 * @arkts 1.2 35814 */ 35815 want?: Want; 35816} 35817 35818/** 35819 * Defines the format for displaying dates and times. 35820 * 35821 * @typedef { intl.DateTimeOptions } DateTimeOptions 35822 * @syscap SystemCapability.ArkUI.ArkUI.Full 35823 * @crossplatform 35824 * @atomicservice 35825 * @since 20 35826 * @arkts 1.2 35827 */ 35828declare type DateTimeOptions = intl.DateTimeOptions; 35829 35830/** 35831 * Defines a bindable property 35832 * @interface Bindable<T> 35833 * @syscap SystemCapability.ArkUI.ArkUI.Full 35834 * @crossplatform 35835 * @atomicservice 35836 * @since 20 35837 * @arkts 1.2 35838 */ 35839export declare interface Bindable<T> { 35840 /** 35841 * Defines value of the bindable property. 35842 * @type { T } 35843 * @readonly 35844 * @syscap SystemCapability.ArkUI.ArkUI.Full 35845 * @crossplatform 35846 * @atomicservice 35847 * @since 20 35848 * @arkts 1.2 35849 */ 35850 readonly value: T; 35851 35852 /** 35853 * Defines the callback of the bindable property which will be invork when the property is changed.. 35854 * @type { Callback<T> } 35855 * @readonly 35856 * @syscap SystemCapability.ArkUI.ArkUI.Full 35857 * @since 20 35858 * @arkts 1.2 35859 */ 35860 readonly onChange: Callback<T>; 35861} 35862 35863/** 35864 * Convert to a bindable property. 35865 * 35866 * @param { T } value - indicate the value of a state property. 35867 * @returns { Bindable<T> } 35868 * @syscap SystemCapability.ArkUI.ArkUI.Full 35869 * @since 20 35870 * @arkts 1.2 35871 */ 35872export declare function $$<T>(value: T): Bindable<T>; 35873