From 237c240b51a1c4b88122d18ace8f9e7f855a3de5 Mon Sep 17 00:00:00 2001 From: houhaoyu Date: Fri, 21 Jan 2022 02:12:08 +0800 Subject: [PATCH] houhaoyu@huawei.com Signed-off-by: houhaoyu Change-Id: I8f296ff6e304f61e2e6106e7b465ef10102194ef --- BUILD.gn | 3 +- api/@internal/component/ets/action_sheet.d.ts | 16 + api/@internal/component/ets/alert_dialog.d.ts | 111 ++- .../component/ets/alphabet_indexer.d.ts | 66 +- api/@internal/component/ets/animator.d.ts | 75 +- api/@internal/component/ets/badge.d.ts | 63 +- api/@internal/component/ets/blank.d.ts | 12 +- api/@internal/component/ets/button.d.ts | 57 +- api/@internal/component/ets/calendar.d.ts | 258 ++++-- api/@internal/component/ets/canvas.d.ts | 390 ++++++--- api/@internal/component/ets/checkbox.d.ts | 27 +- .../component/ets/checkboxgroup.d.ts | 36 +- api/@internal/component/ets/circle.d.ts | 21 +- api/@internal/component/ets/column.d.ts | 15 +- api/@internal/component/ets/column_split.d.ts | 12 +- api/@internal/component/ets/common.d.ts | 648 ++++++++++----- api/@internal/component/ets/context_menu.d.ts | 6 +- api/@internal/component/ets/counter.d.ts | 15 +- .../ets/custom_dialog_controller.d.ts | 36 +- api/@internal/component/ets/data_panel.d.ts | 33 +- api/@internal/component/ets/date_picker.d.ts | 84 +- api/@internal/component/ets/divider.d.ts | 21 +- api/@internal/component/ets/ellipse.d.ts | 12 +- api/@internal/component/ets/enums.d.ts | 744 ++++++++++++------ api/@internal/component/ets/flex.d.ts | 27 +- api/@internal/component/ets/forEach.d.ts | 9 +- .../component/ets/form_component.d.ts | 48 +- api/@internal/component/ets/gauge.d.ts | 24 +- api/@internal/component/ets/gesture.d.ts | 258 ++++-- api/@internal/component/ets/grid.d.ts | 72 +- api/@internal/component/ets/gridItem.d.ts | 24 +- .../component/ets/grid_container.d.ts | 42 +- api/@internal/component/ets/hyperlink.d.ts | 12 +- api/@internal/component/ets/image.d.ts | 81 +- .../component/ets/image_animator.d.ts | 48 +- api/@internal/component/ets/inspector.d.ts | 33 +- api/@internal/component/ets/lazyForEach.d.ts | 42 +- api/@internal/component/ets/line.d.ts | 18 +- api/@internal/component/ets/list.d.ts | 81 +- api/@internal/component/ets/listItem.d.ts | 45 +- .../component/ets/loading_progress.d.ts | 30 +- api/@internal/component/ets/marquee.d.ts | 33 +- api/@internal/component/ets/matrix2d.d.ts | 42 +- api/@internal/component/ets/navigation.d.ts | 60 +- api/@internal/component/ets/navigator.d.ts | 36 +- .../component/ets/pageTransition.d.ts | 63 +- api/@internal/component/ets/panel.d.ts | 66 +- api/@internal/component/ets/path.d.ts | 15 +- api/@internal/component/ets/pattern_lock.d.ts | 13 + api/@internal/component/ets/piece.d.ts | 42 +- .../component/ets/plugin_component.d.ts | 7 + api/@internal/component/ets/polygon.d.ts | 12 +- api/@internal/component/ets/polyline.d.ts | 15 +- api/@internal/component/ets/progress.d.ts | 39 +- api/@internal/component/ets/qrcode.d.ts | 15 +- api/@internal/component/ets/radio.d.ts | 24 +- api/@internal/component/ets/rating.d.ts | 21 +- api/@internal/component/ets/rect.d.ts | 21 +- api/@internal/component/ets/refresh.d.ts | 33 +- api/@internal/component/ets/row.d.ts | 15 +- api/@internal/component/ets/row_split.d.ts | 12 +- api/@internal/component/ets/scroll.d.ts | 69 +- api/@internal/component/ets/scroll_bar.d.ts | 30 +- api/@internal/component/ets/search.d.ts | 42 +- api/@internal/component/ets/select.d.ts | 17 + api/@internal/component/ets/shape.d.ts | 48 +- api/@internal/component/ets/sheet.d.ts | 3 + api/@internal/component/ets/slider.d.ts | 78 +- api/@internal/component/ets/span.d.ts | 30 +- api/@internal/component/ets/stack.d.ts | 12 +- .../component/ets/stateManagement.d.ts | 288 ++++--- api/@internal/component/ets/stepper.d.ts | 24 +- api/@internal/component/ets/stepperItem.d.ts | 39 +- api/@internal/component/ets/swiper.d.ts | 25 + api/@internal/component/ets/tab_content.d.ts | 12 +- api/@internal/component/ets/tabs.d.ts | 57 +- api/@internal/component/ets/text.d.ts | 60 +- api/@internal/component/ets/text_area.d.ts | 72 +- api/@internal/component/ets/text_clock.d.ts | 30 +- api/@internal/component/ets/text_input.d.ts | 117 ++- api/@internal/component/ets/text_picker.d.ts | 60 +- api/@internal/component/ets/text_timer.d.ts | 19 + api/@internal/component/ets/toggle.d.ts | 30 +- api/@internal/component/ets/units.d.ts | 57 +- api/@internal/component/ets/video.d.ts | 84 +- api/@internal/component/ets/web.d.ts | 30 +- api/@internal/component/ets/xcomponent.d.ts | 24 +- api/common/@internal/console.d.ts | 6 + api/common/@internal/global.d.ts | 15 + api/common/@internal/viewmodel.d.ts | 260 ++++++ api/common/@system.app.d.ts | 14 + api/common/@system.cipher.d.ts | 24 + api/common/@system.configuration.d.ts | 6 + api/common/@system.file.d.ts | 94 +++ api/common/@system.mediaquery.d.ts | 10 + api/common/@system.prompt.d.ts | 26 + api/common/@system.router.d.ts | 29 + api/liteWearable/@system.app.d.ts | 21 +- api/liteWearable/@system.configuration.d.ts | 3 + api/liteWearable/@system.file.d.ts | 207 +++-- api/liteWearable/@system.router.d.ts | 2 + 101 files changed, 4406 insertions(+), 1907 deletions(-) diff --git a/BUILD.gn b/BUILD.gn index b475a6938f..6748cdba34 100644 --- a/BUILD.gn +++ b/BUILD.gn @@ -165,7 +165,8 @@ ohos_declaration_template("ohos_declaration_phone") { ohos_copy("ace_platform") { sources = [ "api/config", - "api/phone", + "api/common", + "api/liteWearable", ] outputs = [ target_out_dir + "/$target_name/{{source_file_part}}" ] module_source_dir = target_out_dir + "/$target_name" diff --git a/api/@internal/component/ets/action_sheet.d.ts b/api/@internal/component/ets/action_sheet.d.ts index 05b10052b2..0562930a9a 100644 --- a/api/@internal/component/ets/action_sheet.d.ts +++ b/api/@internal/component/ets/action_sheet.d.ts @@ -17,23 +17,27 @@ /** * The information of sheet. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface SheetInfo { /** * Title Properties * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ title: string | Resource; /** * Icon Properties. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ icon?: string | Resource; /** * Callback method after the operation. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ action: () => void; } @@ -41,39 +45,46 @@ interface SheetInfo { /** * Declare the ActionSheet * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class ActionSheet { /** * Invoking method display. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ static show(value: { /** * Title Properties * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ title: string | Resource; /** * message Properties * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ message: string | Resource; /** * Invoke the commit function. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ confirm?: { /** * Text content of the confirmation button. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ value: string | Resource; /** * Method executed by the callback. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ action: () => void; }; @@ -81,30 +92,35 @@ declare class ActionSheet { /** * Execute Cancel Function. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ cancel?: () => void; /** * The Array of sheets * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ sheets: Array; /** * Allows users to click the mask layer to exit. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ autoCancel?: boolean; /** * Alignment in the vertical direction. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ alignment?: DialogAlignment; /** * Offset of the pop-up window relative to the alignment position. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ offset?: { dx: number | string | Resource; dy: number | string | Resource }; }); diff --git a/api/@internal/component/ets/alert_dialog.d.ts b/api/@internal/component/ets/alert_dialog.d.ts index e88783f82c..da3944ea0c 100644 --- a/api/@internal/component/ets/alert_dialog.d.ts +++ b/api/@internal/component/ets/alert_dialog.d.ts @@ -15,149 +15,174 @@ /** * The alignment of dialog, - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum DialogAlignment { /** * Vertical top alignment. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Top, /** * Align vertically to the center. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Center, /** * Vertical bottom alignment. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Bottom, /** * Default alignment. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Default, /** * Align the upper left corner. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ TopStart, /** * Align the upper right corner. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ TopEnd, /** * Left center alignment. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ CenterStart, /** * Right center alignment. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ CenterEnd, /** * Align the lower left corner. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ BottomStart, /** * Align the lower right corner. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ BottomEnd, } /** * Base param used for AlertDialog.show method. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface AlertDialogParam { /** * Title Properties - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ title?: ResourceStr; /** * message Properties - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ message: ResourceStr; /** * Allows users to click the mask layer to exit. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ autoCancel?: boolean; /** * Execute Cancel Function. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ cancel?: () => void; /** * Alignment in the vertical direction. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ alignment?: DialogAlignment; /** * Offset of the pop-up window relative to the alignment position. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ offset?: Offset; /** * Grid count of dialog. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ gridCount?: number; } /** * Defines the AlertDialog with confirm button. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface AlertDialogParamWithConfirm extends AlertDialogParam { /** * Invoke the commit function. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ confirm?: { /** * Text content of the confirmation button. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ value: ResourceStr; /** * Text color of the confirmation button. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fontColor?: ResourceColor; /** * Background color of the confirmation button. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ backgroundColor?: ResourceColor; /** * Method executed by the callback. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ action: () => void; }; @@ -166,60 +191,70 @@ declare interface AlertDialogParamWithConfirm extends AlertDialogParam { declare interface AlertDialogParamWithButtons extends AlertDialogParam { /** * First button. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ primaryButton: { /** * Text content of the confirmation button. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ value: ResourceStr; /** * Text color of the confirmation button. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fontColor?: ResourceColor; /** * Background color of the confirmation button. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ backgroundColor?: ResourceColor; /** * Method executed by the callback. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ action: () => void; }; /** * Second button. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ secondaryButton: { /** * Text content of the confirmation button. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ value: ResourceStr; /** * Text color of the confirmation button. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fontColor?: ResourceColor; /** * Background color of the confirmation button. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ backgroundColor?: ResourceColor; /** * Method executed by the callback. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ action: () => void; }; @@ -227,12 +262,14 @@ declare interface AlertDialogParamWithButtons extends AlertDialogParam { /** * Defines AlertDialog which uses show method to show alert dialog. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class AlertDialog { /** * Invoking method display. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ static show(value: AlertDialogParamWithConfirm | AlertDialogParamWithButtons); } diff --git a/api/@internal/component/ets/alphabet_indexer.d.ts b/api/@internal/component/ets/alphabet_indexer.d.ts index a902431b34..bb7fba78c8 100644 --- a/api/@internal/component/ets/alphabet_indexer.d.ts +++ b/api/@internal/component/ets/alphabet_indexer.d.ts @@ -15,133 +15,155 @@ /** * indexer align property. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum IndexerAlign { /** * A dialog box is displayed on the right of the index bar. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Left, /** * A dialog box is displayed on the left of the index bar. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Right, } /** * Alphabet index bar. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface AlphabetIndexerInterface { /** * ArrayValue: Alphabetical index string array. * selected: ID of the selected item. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value: { arrayValue: Array; selected: number }): AlphabetIndexerAttribute; } /** * Defines the alphabet index bar attribute functions. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class AlphabetIndexerAttribute extends CommonMethod { /** * Index bar selection callback. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onSelected(event: (index: number) => void): AlphabetIndexerAttribute; /** * Definitions color. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ color(value: ResourceColor): AlphabetIndexerAttribute; /** * Select the text color. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ selectedColor(value: ResourceColor): AlphabetIndexerAttribute; /** * Font color of the pop-up prompt text. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ popupColor(value: ResourceColor): AlphabetIndexerAttribute; /** * Select the text background color. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ selectedBackgroundColor(value: ResourceColor): AlphabetIndexerAttribute; /** * Background color of the pop-up window index. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ popupBackground(value: ResourceColor): AlphabetIndexerAttribute; /** * Whether to use pop-up index hints. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ usingPopup(value: boolean): AlphabetIndexerAttribute; /** * Select the text text style, - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ selectedFont(value: Font): AlphabetIndexerAttribute; /** * Select the text background color. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ popupFont(value: Font): AlphabetIndexerAttribute; /** * Size of the letter area on the letter index bar. The letter area is a square. Set the length of the square side. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ itemSize(value: string | number): AlphabetIndexerAttribute; /** * Definitions fonts. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ font(value: Font): AlphabetIndexerAttribute; /** * Alphabet index bar alignment style. The left and right alignment styles are supported, which affects the pop-up position of the pop-up window. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ alignStyle(value: IndexerAlign): AlphabetIndexerAttribute; /** * Index bar selection callback and return the strings which display on pop-up. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onRequestPopupData(event: (index: number) => Array): AlphabetIndexerAttribute; /** * Pop-up selection callback. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onPopupSelected(event: (index: number) => void): AlphabetIndexerAttribute; /** * Select the index. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ selectedIndex(index: number): AlphabetIndexerAttribute; /** * Position of the pop-up windows, relative to the midpoint of the top border of the indexer bar. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ popupPosition(value: {offsetX: number, offsetY: number}): AlphabetIndexerAttribute; } diff --git a/api/@internal/component/ets/animator.d.ts b/api/@internal/component/ets/animator.d.ts index ff253c2eba..7fbc88afde 100644 --- a/api/@internal/component/ets/animator.d.ts +++ b/api/@internal/component/ets/animator.d.ts @@ -15,13 +15,15 @@ /** * Customize spring properties. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ declare class SpringProp { /** * Constructor parameters - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ constructor(mass: number, stiffness: number, damping: number); @@ -29,13 +31,15 @@ declare class SpringProp { /** * Spring animation model. You can build a spring animation based on the start point, end point, initial speed, and spring attributes. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ declare class SpringMotion { /** * Constructor parameters - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ constructor(start: number, end: number, velocity: number, prop: SpringProp); @@ -43,13 +47,15 @@ declare class SpringMotion { /** * Friction animation model. You can build friction animation by friction force, initial position, and initial velocity. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ declare class FrictionMotion { /** * Constructor parameters - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ constructor(friction: number, position: number, velocity: number); @@ -57,13 +63,15 @@ declare class FrictionMotion { /** * Rolling animation model: You can build rolling animation based on the initial position, initial speed, boundary position, and spring attributes. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ declare class ScrollMotion { /** * Constructor parameters - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ constructor(position: number, velocity: number, min: number, max: number, prop: SpringProp); @@ -71,13 +79,15 @@ declare class ScrollMotion { /** * Defines Animtor. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ interface AnimatorInterface { /** * Constructor parameters - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ (value: string): AnimatorAttribute; @@ -85,104 +95,119 @@ interface AnimatorInterface { /** * Defines AnimatorAttribute. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ declare class AnimatorAttribute extends CommonMethod { /** * Controls the playback status. The default value is the initial state. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ state(value: AnimationStatus): AnimatorAttribute; /** * Animation duration, in milliseconds. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ duration(value: number): AnimatorAttribute; /** * Animation curve, default to linear curve - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ curve(value: Curve): AnimatorAttribute; /** * Delayed animation playback duration, in milliseconds. By default, the animation is not delayed. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ delay(value: number): AnimatorAttribute; /** * Sets the state before and after the animation starts. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ fillMode(value: FillMode): AnimatorAttribute; /** * The default playback is once. If the value is -1, the playback is unlimited. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ iterations(value: number): AnimatorAttribute; /** * Sets the animation playback mode. By default, the animation starts to play again after the playback is complete. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ playMode(value: PlayMode): AnimatorAttribute; /** * Configure the physical animation algorithm. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ motion(value: SpringMotion | FrictionMotion | ScrollMotion): AnimatorAttribute; /** * Status callback, which is triggered when the animation starts to play. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ onStart(event: () => void): AnimatorAttribute; /** * Status callback, triggered when the animation pauses. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ onPause(event: () => void): AnimatorAttribute; /** * Status callback, triggered when the animation is replayed. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ onRepeat(event: () => void): AnimatorAttribute; /** * Status callback, which is triggered when the animation is canceled. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ onCancel(event: () => void): AnimatorAttribute; /** * Status callback, which is triggered when the animation playback is complete. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ onFinish(event: () => void): AnimatorAttribute; /** * The callback input parameter is the interpolation during animation playback. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ onFrame(event: (value: number) => void): AnimatorAttribute; diff --git a/api/@internal/component/ets/badge.d.ts b/api/@internal/component/ets/badge.d.ts index 5c7d354ea0..65b7300047 100644 --- a/api/@internal/component/ets/badge.d.ts +++ b/api/@internal/component/ets/badge.d.ts @@ -15,109 +15,127 @@ /** * Defines the badge position property. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum BadgePosition { /** * The dot is displayed vertically centered on the right. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ RightTop, /** * Dots are displayed in the upper right corner. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Right, /** * The dot is displayed in the left vertical center. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Left, } /** * BadgeStyle object - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface BadgeStyle { /** * Text Color - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ color?: ResourceColor; /** * Text size. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fontSize?: number | string; /** * Size of a badge. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ badgeSize?: number | string; /** * Color of the badge. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ badgeColor?: ResourceColor; } /** * Defines the base param of badge. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface BadgeParam { /** * Set the display position of the prompt point. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ position?: BadgePosition; /** * Defines the style of the Badge component, including the text color, size, dot color, and size. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ style: BadgeStyle; } /** * Defines the badge param with count and maxCount. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface BadgeParamWithNumber extends BadgeParam { /** * Set the number of reminder messages. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ count: number; /** * Maximum number of messages. If the number of messages exceeds the maximum, only maxCount+ is displayed. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ maxCount?: number; } /** * Defines the badge param with string value. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface BadgeParamWithString extends BadgeParam { /** * Text string of the prompt content. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ value: string; } /** * Defines Badge Componrnt. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface BadgeInterface { /** @@ -125,7 +143,8 @@ interface BadgeInterface { * maxCount: Maximum number of messages. If the number of messages exceeds the maximum, only maxCount+ is displayed. * count: Set the number of reminder messages. * style: You can set the style of the Badge component, including the text color, size, dot color, and size. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value: BadgeParamWithNumber): BadgeAttribute; @@ -134,14 +153,16 @@ interface BadgeInterface { * position: Set the display position of the prompt point. * maxCount: Maximum number of messages. If the number of messages exceeds the maximum, only maxCount+ is displayed. * style: You can set the style of the Badge component, including the text color, size, dot color, and size. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value: BadgeParamWithString): BadgeAttribute; } /** * Defines Badge Componrnt attribute. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class BadgeAttribute extends CommonMethod {} diff --git a/api/@internal/component/ets/blank.d.ts b/api/@internal/component/ets/blank.d.ts index 4415acc8a0..582556aea1 100644 --- a/api/@internal/component/ets/blank.d.ts +++ b/api/@internal/component/ets/blank.d.ts @@ -15,24 +15,28 @@ /** * Create Blank. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface BlankInterface { /** * The minimum size of the blank fill assembly on the container spindle. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (min?: number | string): BlankAttribute; } /** * Inheritance CommonMethod Set Styles - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class BlankAttribute extends CommonMethod { /** * color: set color. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ color(value: ResourceColor): BlankAttribute; } diff --git a/api/@internal/component/ets/button.d.ts b/api/@internal/component/ets/button.d.ts index 68f472819d..0c65f02d58 100644 --- a/api/@internal/component/ets/button.d.ts +++ b/api/@internal/component/ets/button.d.ts @@ -15,114 +15,133 @@ /** * Provides a button component. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum ButtonType { /** * Capsule button (rounded corners default to half the height). - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Capsule, /** * Round buttons. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Circle, /** * Common button (no rounded corners by default). - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Normal, } /** * Defines the button options. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface ButtonOption { /** * Describes the button style. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ type?: ButtonType; /** * Indicates whether to enable the switchover effect when the button is pressed. When the status is set to false, the switchover effect is disabled. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ stateEffect?: boolean; } /** * Defines the Button Component. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface ButtonInterface { /** * Button object - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (): ButtonAttribute; /** * Create Button with Text child. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (options: ButtonOption): ButtonAttribute; /** * Create Button with inner text label. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (label: ResourceStr, options?: ButtonOption): ButtonAttribute; } /** * Defines the button attribute functions. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class ButtonAttribute extends CommonMethod { /** * Describes the button style. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ type(value: ButtonType): ButtonAttribute; /** * Indicates whether to enable the switchover effect when the button is pressed. When the status is set to false, the switchover effect is disabled. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ stateEffect(value: boolean): ButtonAttribute; /** * Text color. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fontColor(value: ResourceColor): ButtonAttribute; /** * Text size. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fontSize(value: Length): ButtonAttribute; /** * Font weight. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fontWeight(value: number | FontWeight | string): ButtonAttribute; /** * Font style. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fontStyle(value: FontStyle): ButtonAttribute; /** * Font family. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fontFamily(value: string | Resource): ButtonAttribute; } diff --git a/api/@internal/component/ets/calendar.d.ts b/api/@internal/component/ets/calendar.d.ts index 73af8ae527..59b5ad7222 100644 --- a/api/@internal/component/ets/calendar.d.ts +++ b/api/@internal/component/ets/calendar.d.ts @@ -15,14 +15,16 @@ /** * Provides a monthly view component to display information such as date, shift break, and schedule. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ interface CalendarDay { /** * Indicates the sequence number of the 7 x 7 (7 x 6) grid layout on a calendar page by row. * The week sequence is one, two, three, four, five, six. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ index: number; @@ -30,49 +32,56 @@ interface CalendarDay { /** * Lunar moon. * The week sequence is one, two, three, four, five, six. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ lunarMonth: string; /** * Lunar day. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ lunarDay: string; /** * Day. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ dayMark: string; /** * Indicates the off-duty flag information. The options are work and off.By default, the off-duty flag information is not required. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ dayMarkValue: string; /** * Gregorian calendar year. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ year: number; /** * Gregorian calendar month. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ month: number; /** * Gregorian calendar day. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ day: number; @@ -80,7 +89,8 @@ interface CalendarDay { /** * * Indicates whether the default value is Lunar calendar. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ isFirstOfLunar: boolean; @@ -88,14 +98,16 @@ interface CalendarDay { /** * Indicates whether to display has Schedule. * The week sequence is one, two, three, four, five, six. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ hasSchedule: boolean; /** * Display Lunar Date.The week sequence is one, two, three, four, five, six. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ markLunarDay: boolean; @@ -103,27 +115,31 @@ interface CalendarDay { /** * Date object. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ interface MonthData { /** * Gregorian calendar year. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ year: number; /** * Gregorian calendar month. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ month: number; /** * CalendarDay. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ data: CalendarDay[]; @@ -131,167 +147,191 @@ interface MonthData { /** * CurrentDayStyle object. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ interface CurrentDayStyle { /** * Text color. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ dayColor?: ResourceColor; /** * lunar Text color. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ lunarColor?: ResourceColor; /** * lunar Work and rest text color. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ markLunarColor?: ResourceColor; /** * Text fontSize. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ dayFontSize?: number; /** * lunar text fontSize. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ lunarDayFontSize?: number; /** * Single date height. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ dayHeight?: number; /** * Single date width. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ dayWidth?: number; /** * Gregorian calendar height. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ gregorianCalendarHeight?: number; /** * Data y axis Off set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ dayYAxisOffset?: number; /** * Lunar data y axis Off set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ lunarDayYAxisOffset?: number; /** * Under score X Axis Off set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ underscoreXAxisOffset?: number; /** * Under score Y Axis Off set - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ underscoreYAxisOffset?: number; /** * Schedule marker X axis Off set - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ scheduleMarkerXAxisOffset?: number; /** * schedule Marker Y Axis Off set - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ scheduleMarkerYAxisOffset?: number; /** * Number of columns. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ colSpace?: number; /** * Daily five row space. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ dailyFiveRowSpace?: number; /** * Daily six row space. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ dailySixRowSpace?: number; /** * Single lunar height. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ lunarHeight?: number; /** * Under score width. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ underscoreWidth?: number; /** * Under score length. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ underscoreLength?: number; /** * Schedule marker radius. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ scheduleMarkerRadius?: number; /** * Bound dary row offset. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ boundaryRowOffset?: number; /** * Boundary col offset. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ boundaryColOffset?: number; @@ -299,34 +339,39 @@ interface CurrentDayStyle { /** * Non current day style. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ interface NonCurrentDayStyle { /** * Non-current month day color. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ nonCurrentMonthDayColor?: ResourceColor; /** * Lunar style of non-current month. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ nonCurrentMonthLunarColor?: ResourceColor; /** * Non-Current Month Workday Marker Color. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ nonCurrentMonthWorkDayMarkColor?: ResourceColor; /** * Non-Current Month Off Day Marker Color. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ nonCurrentMonthOffDayMarkColor?: ResourceColor; @@ -334,34 +379,39 @@ interface NonCurrentDayStyle { /** * Non current day style. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ interface TodayStyle { /** * Style of focus color. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ focusedDayColor?: ResourceColor; /** * Focus on Lunar Colors. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ focusedLunarColor?: ResourceColor; /** * Background color of the focus area. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ focusedAreaBackgroundColor?: ResourceColor; /** * Focus area radius. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ focusedAreaRadius?: number; @@ -369,55 +419,63 @@ interface TodayStyle { /** * Week Style. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ interface WeekStyle { /** * Style of week color. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ weekColor?: ResourceColor; /** * Style of week day color. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ weekendDayColor?: ResourceColor; /** * Style of lunar color. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ weekendLunarColor?: ResourceColor; /** * Style of week font size. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ weekFontSize?: number; /** * Style of week height. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ weekHeight?: number; /** * Style of week width. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ weekWidth?: number; /** * Style of week space. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ weekAndDayRowSpace?: number; @@ -425,55 +483,63 @@ interface WeekStyle { /** * Work state style. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ interface WorkStateStyle { /** * Style of day color. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ workDayMarkColor?: ResourceColor; /** * Style of day color. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ offDayMarkColor?: ResourceColor; /** * Style of day size. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ workDayMarkSize?: number; /** * Style of day size. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ offDayMarkSize?: number; /** * Style of width. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ workStateWidth?: number; /** * Style of distance. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ workStateHorizontalMovingDistance?: number; /** * Style of distance. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ workStateVerticalMovingDistance?: number; @@ -481,40 +547,46 @@ interface WorkStateStyle { /** * Calendar controller. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ declare class CalendarController { /** * Constructor. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ constructor(); /** * Back to day. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ backToToday(); /** * To the specified element. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ goTo(value: { year: number; month: number; day: number }); } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ interface CalendarInterface { /** * Set value. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ (value: { @@ -527,97 +599,111 @@ interface CalendarInterface { } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ declare class CalendarAttribute { /** * Specifies whether the component displays the lunar calendar information. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ showLunar(value: boolean): CalendarAttribute; /** * Setting whether to display holiday information - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ showHoliday(value: boolean): CalendarAttribute; /** * Indicates whether the page can be scrolled. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ needSlide(value: boolean): CalendarAttribute; /** * Set the start day of the week for the calendar. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ startOfWeek(value: number): CalendarAttribute; /** * Set weekend. The default value is Sunday and Saturday. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ offDays(value: number): CalendarAttribute; /** * Sets the sliding direction. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ direction(value: Axis): CalendarAttribute; /** * Sets the date style in the current month. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ currentDayStyle(value: CurrentDayStyle): CalendarAttribute; /** * Sets the non-monthly date style. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ nonCurrentDayStyle(value: NonCurrentDayStyle): CalendarAttribute; /** * Set the date style for today. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ todayStyle(value: TodayStyle): CalendarAttribute; /** * Sets the date style for the weekend. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ weekStyle(value: WeekStyle): CalendarAttribute; /** * Sets the style of the working state. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ workStateStyle(value: WorkStateStyle): CalendarAttribute; /** * Click a date to return the information about the date you clicked. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ onSelectChange(event: (event: { year: number; month: number; day: number }) => void): CalendarAttribute; /** * When you swipe to switch months, the information about the previous month and the next month is requested. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ onRequestData( diff --git a/api/@internal/component/ets/canvas.d.ts b/api/@internal/component/ets/canvas.d.ts index 24e36b5be7..5b85a119ca 100644 --- a/api/@internal/component/ets/canvas.d.ts +++ b/api/@internal/component/ets/canvas.d.ts @@ -18,7 +18,8 @@ * two configurations are supported: * "evenodd": odd and even round rule * "nonzero": (Default) Non-zero Wrap Rules - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare type CanvasFillRule = "evenodd" | "nonzero"; @@ -28,7 +29,8 @@ declare type CanvasFillRule = "evenodd" | "nonzero"; * "round": Segment ends in a circle * "square": The end of the segment ends in a square, but a rectangular area is added that is the same width * as the segment and is half the thickness of the segment. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare type CanvasLineCap = "butt" | "round" | "square"; @@ -41,7 +43,8 @@ declare type CanvasLineCap = "butt" | "round" | "square"; * so that they intersect at a point. * "round": Draw the shape of the corner by filling in an additional sector with the center at the end of the * connected section. The radius of the fillet is the width of the segment. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare type CanvasLineJoin = "bevel" | "miter" | "round"; @@ -50,7 +53,8 @@ declare type CanvasLineJoin = "bevel" | "miter" | "round"; * "inherit": (Default) Inherit current Canvas component settings * "ltr": The text direction is left to right. * "rtl": The text direction is from right to left. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare type CanvasDirection = "inherit" | "ltr" | "rtl"; @@ -63,7 +67,8 @@ declare type CanvasDirection = "inherit" | "ltr" | "rtl"; * "right": The text is right-aligned. * "start": (Default) Where the text snap line begins (Left alignment refers to the local from left to right, * and right alignment refers to the local from right to left) - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare type CanvasTextAlign = "center" | "end" | "left" | "right" | "start"; @@ -77,7 +82,8 @@ declare type CanvasTextAlign = "center" | "end" | "left" | "right" | "start"; * baseline, the ideograhpic baseline is at the bottom of the character itself. * "middle": The text baseline is in the middle of the text block. * "top": The text baseline is at the top of the text block. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare type CanvasTextBaseline = "alphabetic" | "bottom" | "hanging" | "ideographic" | "middle" | "top"; @@ -86,13 +92,15 @@ declare type CanvasTextBaseline = "alphabetic" | "bottom" | "hanging" | "ideogra * "high": height * "low": (default)low * "medium": medium - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare type ImageSmoothingQuality = "high" | "low" | "medium"; /** * Opaque objects that describe gradients, created by createLinearGradient() or createRadialGradient() - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class CanvasGradient { /** @@ -100,14 +108,16 @@ declare class CanvasGradient { * @param number Value between 0 and 1, out of range throws INDEX_SIZE_ERR error * @param string CSS color value . If the color value cannot be resolved to a valid CSS color value * a SYNTAX_ERR error is thrown. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ addColorStop(offset: number, color: string): void; } /** * Path object, which provides basic methods for drawing paths. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class CanvasPath { /** @@ -119,7 +129,8 @@ declare class CanvasPath { * @param endAngle The end point of the arc, in radians. * @param counterclockwise If the value is true, the arc is drawn counterclockwise. Otherwise, * the arc is drawn clockwise. The default value is false. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ arc(x: number, y: number, radius: number, startAngle: number, endAngle: number, counterclockwise?: boolean): void; @@ -130,7 +141,8 @@ declare class CanvasPath { * @param x2 The x-axis coordinate of the second control point. * @param y2 The y-axis coordinate of the second control point. * @param radius Radius of the arc. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ arcTo(x1: number, y1: number, x2: number, y2: number, radius: number): void; @@ -142,13 +154,15 @@ declare class CanvasPath { * @param cp2y The y-axis coordinate of the second control point. * @param x x-axis coordinate of the end point. * @param y y-axis coordinate of the end point. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ bezierCurveTo(cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number, y: number): void; /** * Returns the pen point to the start point of the current subpath - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ closePath(): void; @@ -164,7 +178,8 @@ declare class CanvasPath { * @param endAngle The angle, in radians, at which the ellipse is to be drawn (not angular degrees). * @param counterclockwise If the value is true, the ellipse is drawn counterclockwise. Otherwise, * the ellipse is drawn clockwise. The default value is false. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ ellipse( x: number, @@ -181,7 +196,8 @@ declare class CanvasPath { * Connect subpaths using straight lines * @param x The x-axis coordinate of the end point of the line. * @param y The y-axis coordinate of the end point of the line. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ lineTo(x: number, y: number): void; @@ -189,7 +205,8 @@ declare class CanvasPath { * Moves the start point of a new subpath to the (x, y) coordinate. * @param x The x-axis coordinate of the point. * @param y The y-axis coordinate of the point. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ moveTo(x: number, y: number): void; @@ -199,7 +216,8 @@ declare class CanvasPath { * @param cpy The y-axis coordinate of the control point. * @param x x-axis coordinate of the end point. * @param y y-axis coordinate of the end point. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ quadraticCurveTo(cpx: number, cpy: number, x: number, y: number): void; @@ -209,205 +227,236 @@ declare class CanvasPath { * @param y The y-axis coordinate of the start point of the rectangle. * @param w Width of the rectangle. * @param h Height of the rectangle. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ rect(x: number, y: number, w: number, h: number): void; } /** * 2D path object for path drawing - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class Path2D extends CanvasPath { /** * Adds a path according to the specified path variable. * @param path Indicates the path object to be added. * @param transform Transformation matrix of the new trail - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ addPath(path: Path2D, transform?: Matrix2D): void; /** * Create an empty path object. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(); /** * Create a copy of a path object * @param path Path object to be copied - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(path: Path2D); /** * Create a new path according to the description. * @param d Indicates the path string that compiles with the SVG path description specifications. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(d: string); } /** * Describes an opaque object of a template, which is created using the createPattern() method. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface CanvasPattern { /** * Adds the matrix transformation effect to the current template. * @param transform transformation matrix - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ setTransform(transform?: Matrix2D): void; } /** * Size information of the text - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface TextMetrics { /** * Double, the distance from the horizontal line indicated by the textBaseline property to the top of * the rectangular boundary of the rendered text. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ readonly actualBoundingBoxAscent: number; /** * Double, the distance from the horizontal line indicated by the textBaseline property to the bottom of * the rectangular boundary of the rendered text. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ readonly actualBoundingBoxDescent: number; /** * Double, parallel to the baseline, distance from the alignment point determined by the textAlign property to * the left of the text rectangle boundary. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ readonly actualBoundingBoxLeft: number; /** * Double, parallel to the baseline, distance from the alignment point determined by the textAlign property to * the right of the text rectangle boundary. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ readonly actualBoundingBoxRight: number; /** * Double, the distance from the horizontal line indicated by the textBaseline property to the alphabetic baseline of * the wireframe. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ readonly alphabeticBaseline: number; /** * Double, the distance from the horizontal line indicated by the textBaseline property to the top of the * em square in the wireframe. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ readonly emHeightAscent: number; /** * Double, distance from the horizontal line indicated by the textBaseline property to the bottom of the * em box in the wireframe. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ readonly emHeightDescent: number; /** * Double, distance from the horizontal line indicated by the textBaseline property to the top of the * highest rectangle boundary of all fonts rendering text. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ readonly fontBoundingBoxAscent: number; /** * Double, distance from the horizontal line indicated by the textBaseline property to the bottom of the * rectangular boundary of all fonts rendering text. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ readonly fontBoundingBoxDescent: number; /** * Double, distance from the horizontal line indicated by the textBaseline property to * the hanging baseline of the wireframe. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ readonly hangingBaseline: number; /** * Double, distance from the horizontal line indicated by the textBaseline property to * the ideographic baseline of the wireframe. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ readonly ideographicBaseline: number; /** * Indicates the width of a character string. The value is of the double type. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ readonly width: number; } /** * Bitmap image object that can be drawn onto the current Canvas - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class ImageBitmap { /** * Indicates the height of the CSS pixel unit of ImageData. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ readonly height: number; /** * Indicates the width of the CSS pixel unit of ImageData. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ readonly width: number; /** * Releases all graphics resources associated with an ImageBitmap. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ close(): void; /** * Create an ImageBitmap object based on the transferred image path. * @param src Path of the image object. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(src: string); /** * Transfer a PixelMap object to construct an ImageBitmap object. * @param data PixelMap object - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(data: PixelMap); } /** * Image data object - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class ImageData { /** * Array containing image pixel data - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ readonly data: Uint8ClampedArray; /** * Width of the image. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ readonly height: number; /** * Height of the image. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ readonly width: number; @@ -416,25 +465,29 @@ declare class ImageData { * @param width Width of the image. * @param height Height of the image. * @param data Data of the image. If this parameter is not specified, the default value is a black rectangular image. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(width: number, height: number, data?: Uint8ClampedArray); } /** * This object allows you to set properties when creating a rendering context - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class RenderingContextSettings { /** * Indicates whether the canvas contains an alpha channel. The default value is false. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ alpha?: boolean; /** * Indicates whether anti-aliasing is enabled for canvas. The default value is false. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ antialias?: boolean; @@ -442,20 +495,23 @@ declare class RenderingContextSettings { * Create an RenderingContextSettings object based on the antialias and alpha. * @param antialias Indicates whether anti-aliasing is enabled for canvas * @param alpha Indicates whether the canvas contains an alpha channel - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(antialias?: boolean, alpha?: boolean); } /** * Canvas renderer for drawing shapes, text, images and other objects - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class CanvasRenderer extends CanvasPath { /** * Transparency. The value ranges from 0.0 (completely transparent) to 1.0 (completely opaque). * The default value is 1.0. If the value is out of range, the assignment is invalid. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ globalAlpha: number; @@ -492,7 +548,8 @@ declare class CanvasRenderer extends CanvasPath { * color: The luminance (luma) of the bottom layer is retained while the hue (hue) and chroma (chroma) of * the top layer are used. * luminosity: The hue and chroma of the bottom layer are maintained while the luminance of the top layer is used. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ globalCompositeOperation: string; @@ -501,7 +558,8 @@ declare class CanvasRenderer extends CanvasPath { * @param image Picture objects drawn to the canvas. * @param dx x-axis coordinate of the upper left corner of the image on the target canvas. * @param dy y-axis coordinate of the upper left corner of the image on the target canvas. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ drawImage(image: ImageBitmap, dx: number, dy: number): void; @@ -512,7 +570,8 @@ declare class CanvasRenderer extends CanvasPath { * @param dy y-axis coordinate of the upper left corner of the image on the target canvas. * @param dw Specifies the drawing width of the image on the target canvas. The width of the drawn image will be scaled. * @param dh Specifies the drawing height of the image on the target canvas. The height of the drawn image will be scaled. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ drawImage(image: ImageBitmap, dx: number, dy: number, dw: number, dh: number): void; @@ -527,7 +586,8 @@ declare class CanvasRenderer extends CanvasPath { * @param dy y-axis coordinate of the upper left corner of the image on the target canvas. * @param dw Specifies the drawing width of the image on the target canvas. The width of the drawn image will be scaled. * @param dh Specifies the drawing height of the image on the target canvas. The height of the drawn image will be scaled. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ drawImage( image: ImageBitmap, @@ -543,14 +603,16 @@ declare class CanvasRenderer extends CanvasPath { /** * Clear the sub-path list and start a new path. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ beginPath(): void; /** * Sets the currently created path as the current clipping path * @param fillRule Algorithm rule. For details, see {@link CanvasFillRule}. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ clip(fillRule?: CanvasFillRule): void; @@ -558,14 +620,16 @@ declare class CanvasRenderer extends CanvasPath { * Tailoring according to the specified path * @param path Path to be cut. * @param fillRule Algorithm rule. For details, see {@link CanvasFillRule}. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ clip(path: Path2D, fillRule?: CanvasFillRule): void; /** * Fills existing paths according to the current fill style. * @param fillRule Algorithm rule. For details, see {@link CanvasFillRule}. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fill(fillRule?: CanvasFillRule): void; @@ -573,20 +637,23 @@ declare class CanvasRenderer extends CanvasPath { * Fills the specified path according to the current fill style * @param path Path to be filled. * @param fillRule Algorithm rule. For details, see {@link CanvasFillRule}. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fill(path: Path2D, fillRule?: CanvasFillRule): void; /** * Draws an existing path according to the current stroke style. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ stroke(): void; /** * Draws the specified path according to the current stroke style * @param path Specified stroke path object - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ stroke(path: Path2D): void; @@ -596,7 +663,8 @@ declare class CanvasRenderer extends CanvasPath { * CanvasGradient: Color gradient object. For details, see {@link CanvasGradient}. * CanvasPattern: Template object. For details, see {@link CanvasPattern}. * @param path Specified stroke path object - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fillStyle: string | CanvasGradient | CanvasPattern; @@ -606,7 +674,8 @@ declare class CanvasRenderer extends CanvasPath { * CanvasGradient: Color gradient object. For details, see {@link CanvasGradient}. * CanvasPattern: Template object. For details, see {@link CanvasPattern}. * @param path Specified stroke path object - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ strokeStyle: string | CanvasGradient | CanvasPattern; @@ -616,7 +685,8 @@ declare class CanvasRenderer extends CanvasPath { * @param y0 The y-axis coordinate of the start point. * @param x1 x-axis coordinate of the end point. * @param y1 y-axis coordinate of the end point. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ createLinearGradient(x0: number, y0: number, x1: number, y1: number): CanvasGradient; @@ -628,7 +698,8 @@ declare class CanvasRenderer extends CanvasPath { * "repeat-x": Repeated images in the X-axis direction but not in the Y-axis direction * "repeat-y": The image is repeated in the Y axis direction, and the image is not repeated in the X axis direction. * "no-repeat": Non-repeating images in both X and Y directions - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ createPattern(image: ImageBitmap, repetition: string | null): CanvasPattern | null; @@ -640,7 +711,8 @@ declare class CanvasRenderer extends CanvasPath { * @param x1 The x-axis coordinate of the end circle. * @param y1 The y-axis coordinate of the end circle. * @param r1 Radius of the end circle. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ createRadialGradient(x0: number, y0: number, r0: number, x1: number, y1: number, r1: number): CanvasGradient; @@ -668,7 +740,8 @@ declare class CanvasRenderer extends CanvasPath { * sepia()：The image is sepia (nostalgic style). At 100%, the image turns completely sepia. * When the value is 0%, there is no change in the image. * none：Turn off filter effects - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ filter(filter: string): void; @@ -676,7 +749,8 @@ declare class CanvasRenderer extends CanvasPath { * Creates a new, empty ImageData object of the specified size * @param sw Width of the ImageData object. * @param sh Height of the ImageData object. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ createImageData(sw: number, sh: number): ImageData; @@ -684,7 +758,8 @@ declare class CanvasRenderer extends CanvasPath { * From an existing ImageData object, copy an object with the same width and height as the image. * The image content is not copied. * @param imagedata ImageData object to be copied. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ createImageData(imagedata: ImageData): ImageData; @@ -694,7 +769,8 @@ declare class CanvasRenderer extends CanvasPath { * @param sy y coordinate of the upper left corner of the rectangular area of the image data to be extracted. * @param sw The width of the rectangular area of the image data to be extracted. * @param sh The height of the rectangular area of the image data to be extracted. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ getImageData(sx: number, sy: number, sw: number, sh: number): ImageData; @@ -703,7 +779,8 @@ declare class CanvasRenderer extends CanvasPath { * @param imagedata ImageData object to be drawn. * @param dx Position offset of the source image data in the target canvas (the offset in the x-axis direction). * @param dy Position offset of the source image data in the target canvas (the offset in the y-axis direction). - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ putImageData(imagedata: ImageData, dx: number, dy: number): void; @@ -720,7 +797,8 @@ declare class CanvasRenderer extends CanvasPath { * The default is the width of the image data. * @param dirtyHeight Height of the rectangular area in the source image data. * The default is the height of the image data. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ putImageData( imagedata: ImageData, @@ -735,49 +813,57 @@ declare class CanvasRenderer extends CanvasPath { /** * Specifies whether to smooth the image. The value true indicates that the image is smooth (default value). * The value false indicates that the image is not smooth. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ imageSmoothingEnabled: boolean; /** * Smoothness level of the current image. For details, see {@link ImageSmoothingQuality}. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ imageSmoothingQuality(quality: ImageSmoothingQuality): void; /** * Line segment endpoint attribute. For details, see {@link CanvasLineCap}. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ lineCap: CanvasLineCap; /** * Dotted line offset attribute. The default value is 0.0. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ lineDashOffset: number; /** * Line segment connection point attribute. For details, see {@link CanvasLineJoin}. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ lineJoin: CanvasLineJoin; /** * Line thickness attribute. The value cannot be 0 or a negative number. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ lineWidth: number; /** * The value of this parameter cannot be 0 or a negative number. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ miterLimit: number; /** * Gets the current segment style. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ getLineDash(): number[]; @@ -785,7 +871,8 @@ declare class CanvasRenderer extends CanvasPath { * Sets the dashed line mode for line drawing. * @param segments A set of numbers that describe the length of alternating drawn line segments and * spacing (coordinate space units). - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ setLineDash(segments: number[]): void; @@ -795,7 +882,8 @@ declare class CanvasRenderer extends CanvasPath { * @param y The y-axis coordinate of the start point of the rectangle. * @param w Width of the rectangle. * @param h Height of the rectangle. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ clearRect(x: number, y: number, w: number, h: number): void; @@ -805,7 +893,8 @@ declare class CanvasRenderer extends CanvasPath { * @param y The y-axis coordinate of the start point of the rectangle. * @param w Width of the rectangle. * @param h Height of the rectangle. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fillRect(x: number, y: number, w: number, h: number): void; @@ -815,43 +904,50 @@ declare class CanvasRenderer extends CanvasPath { * @param y The y-axis coordinate of the start point of the rectangle. * @param w Width of the rectangle. * @param h Height of the rectangle. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ strokeRect(x: number, y: number, w: number, h: number): void; /** * Shadow blur radius. The default value is 0. The value cannot be a negative number. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ shadowBlur: number; /** * Shadow color. The default value is transparent black. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ shadowColor: string; /** * Horizontal offset distance of the shadow. The default value is 0. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ shadowOffsetX: number; /** * Vertical offset distance of the shadow. The default value is 0. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ shadowOffsetY: number; /** * Top of the stack pop-up state in the drawing state stack - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ restore(): void; /** * Saves the current drawing state to the drawing state stack - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ save(): void; @@ -861,14 +957,16 @@ declare class CanvasRenderer extends CanvasPath { * @param x The x-axis coordinate of the start point of the text. * @param y The y-axis coordinate of the start point of the text. * @param maxWidth Maximum width of the drawing. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fillText(text: string, x: number, y: number, maxWidth?: number): void; /** * Measure the size of a specified text. For details about the return value, see {@link TextMetrics}. * @param text Text string to be measured. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ measureText(text: string): TextMetrics; @@ -878,43 +976,50 @@ declare class CanvasRenderer extends CanvasPath { * @param x The x-axis coordinate of the start point of the text. * @param y The y-axis-axis coordinate of the start point of the text. * @param maxWidth Maximum width of the stroke. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ strokeText(text: string, x: number, y: number, maxWidth?: number): void; /** * Text drawing direction. For details, see {@link CanvasDirection}. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ direction(direction: CanvasDirection): void; /** * Font style. The default value is 10px sans-serif. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ font: string; /** * Text alignment mode. For details, see {@link CanvasTextAlign}. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ textAlign: CanvasTextAlign; /** * Text baseline. For details, see {@link CanvasTextBaseline}. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ textBaseline: CanvasTextBaseline; /** * Obtains the currently applied transformation matrix. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ getTransform(): Matrix2D; /** * Resets the current transformation matrix using the identity matrix - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ resetTransform(): void; @@ -922,7 +1027,8 @@ declare class CanvasRenderer extends CanvasPath { * Adds the effect of a rotation * @param angle The radian of clockwise rotation, which can be converted to an angle value using the formula: * degree * Math.PI / 180 - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ rotate(angle: number): void; @@ -930,7 +1036,8 @@ declare class CanvasRenderer extends CanvasPath { * Increases the scaling effect of the X and Y axes. * @param x Horizontal scaling factor * @param y Vertical scaling factor - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ scale(x: number, y: number): void; @@ -943,7 +1050,8 @@ declare class CanvasRenderer extends CanvasPath { * @param d Vertical Zoom * @param e Horizontal movement * @param f Vertical movement - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ setTransform(a: number, b: number, c: number, d: number, e: number, f: number): void; @@ -951,7 +1059,8 @@ declare class CanvasRenderer extends CanvasPath { * The 2D transformation effect is added. The current transformation matrix is not overwritten and * the transformations are superimposed for multiple times. * @param transform 2D transformation matrix. For details, see {@link Matrix2D}. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ setTransform(transform?: Matrix2D): void; @@ -964,7 +1073,8 @@ declare class CanvasRenderer extends CanvasPath { * @param d Vertical Zoom * @param e Horizontal movement * @param f Vertical movement - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ transform(a: number, b: number, c: number, d: number, e: number, f: number): void; @@ -972,39 +1082,45 @@ declare class CanvasRenderer extends CanvasPath { * Increases the translation effect of the X and Y axes * @param x Horizontal movement distance * @param y Vertical travel distance - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ translate(x: number, y: number): void; /** * Set a PixelMap to the current context. The drawing content is synchronized to the PixelMap. * @param value PixelMap object - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ setPixelMap(value?: PixelMap): void; /** * transfer ImageBitmap to content. * @param ImageBitmap - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ transferFromImageBitmap(bitmap: ImageBitmap): void; } /** * Draw context object for the Canvas component. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class CanvasRenderingContext2D extends CanvasRenderer { /** * The default value is 0, which is bound to the height of the specified canvas. The value is read-only. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ readonly height: number; /** * The default value is 0, which is bound to the width of the specified canvas. The value is read-only. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ readonly width: number; @@ -1013,21 +1129,24 @@ declare class CanvasRenderingContext2D extends CanvasRenderer { * @param type Image format. The default value is image/png. * @param quality If the image format is image/jpeg or image/webp, you can select the image quality from 0 to 1. * If the value is out of the range, the default value 0.92 is used. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ toDataURL(type?: string, quality?: any): string; /** * Constructor of the canvas drawing context object, which is used to create a drawing context object. * @param settings Drawing attribute. For details, see {@link RenderingContextSettings}. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(settings?: RenderingContextSettings); } /** * Draw context object for the OffscreenCanvas component. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class OffscreenCanvasRenderingContext2D extends CanvasRenderer { /** @@ -1035,13 +1154,15 @@ declare class OffscreenCanvasRenderingContext2D extends CanvasRenderer { * @param type Image format. The default value is image/png. * @param quality If the image format is image/jpeg or image/webp, you can select the image quality from 0 to 1. * If the value is out of the range, the default value 0.92 is used. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ toDataURL(type?: string, quality?: any): string; /** * transfer the content to ImageBitmap - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ transferToImageBitmap(): ImageBitmap; @@ -1050,31 +1171,36 @@ declare class OffscreenCanvasRenderingContext2D extends CanvasRenderer { * @param width the width of the OffscreenCanvas * @param height the height of the OffscreenCanvas * @param settings Drawing attribute. For details, see {@link RenderingContextSettings}. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(width: number, height: number,settings?: RenderingContextSettings); } /** * Draw an object off the screen. The drawing content is not directly displayed on the screen. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class OffscreenCanvas extends CanvasRenderer { /** * Height of the off-screen canvas. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ height: number; /** * Width of the off-screen canvas. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ width: number; /** * Exports rendered content as an ImageBitmap object - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ transferToImageBitmap(): ImageBitmap; @@ -1082,20 +1208,23 @@ declare class OffscreenCanvas extends CanvasRenderer { * Constructor of the off-screen canvas, which is used to create an off-screen canvas object. * @param width Width of the off-screen canvas. * @param height Height of the off-screen canvas. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(width: number, height: number); } /** *TextTimer component, which provides the text timer capability. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface CanvasInterface { /** * Construct a canvas component. * @param context Canvas context object. For details, see {@link CanvasRenderingContext2D}. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ (context?: CanvasRenderingContext2D): CanvasAttribute; } @@ -1103,7 +1232,8 @@ interface CanvasInterface { declare class CanvasAttribute extends CommonMethod { /** * Event notification after the canvas component is constructed. You can draw the canvas at this time. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onReady(event: () => void): CanvasAttribute; } diff --git a/api/@internal/component/ets/checkbox.d.ts b/api/@internal/component/ets/checkbox.d.ts index 9d842524fe..e36f87d4f3 100644 --- a/api/@internal/component/ets/checkbox.d.ts +++ b/api/@internal/component/ets/checkbox.d.ts @@ -15,56 +15,65 @@ /** * Defines the option of Checkbox. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface CheckboxOption { /** * Current name of Checkbox. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ name?: string; /** * Sets the group of Checkbox. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ group?: string; } /** * Provides an interface for the Checkbox component. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface CheckboxInterface { /** * Construct the Checkbox component. * Called when the Checkbox component is used. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ (options?: CheckboxOption): CheckboxAttribute; } /** * Defines the attribute functions of Checkbox. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class CheckboxAttribute extends CommonMethod { /** * setting whether checkbox is selected. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ select(value: boolean): CheckboxAttribute; /** * setting the display color of checkbox. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ selectedColor(value: ResourceColor): CheckboxAttribute; /** * Called when the selection status changes. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onChange(callback: (value: boolean) => void): CheckboxAttribute; } diff --git a/api/@internal/component/ets/checkboxgroup.d.ts b/api/@internal/component/ets/checkboxgroup.d.ts index 14a2221a4c..03bce79028 100644 --- a/api/@internal/component/ets/checkboxgroup.d.ts +++ b/api/@internal/component/ets/checkboxgroup.d.ts @@ -15,71 +15,83 @@ /** * CheckboxGroup SelectStatus - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum SelectStatus { /** * All checkboxs is selected. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ All, /** * Part of the checkbox is selected. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Part, /** * None of the checkbox is selected. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ None, } /** * Defines the option of CheckboxGroup. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface CheckboxGroupOption { /** * Setting the group of CheckboxGroup. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ group?: string; } /** * Provides an interface for the CheckboxGroup component. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface CheckboxGroupInterface { /** * Called when the CheckboxGroup component is used. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ (options?: CheckboxGroupOption): CheckboxGroupAttribute; } /** * Defines the attribute functions of CheckboxGroup. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class CheckboxGroupAttribute extends CommonMethod { /** * setting whether all checkbox is selected. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ selectAll(value: boolean): CheckboxGroupAttribute; /** * setting the display color of checkbox. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ selectedColor(value: ResourceColor): CheckboxGroupAttribute; /** * Called when the selection status changes. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onChange(callback: (name: Array, status: SelectStatus) => void): CheckboxGroupAttribute; } diff --git a/api/@internal/component/ets/circle.d.ts b/api/@internal/component/ets/circle.d.ts index 56a14c7e18..74859563a8 100644 --- a/api/@internal/component/ets/circle.d.ts +++ b/api/@internal/component/ets/circle.d.ts @@ -15,43 +15,50 @@ /** * Defines circle option for Circle component. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface CircleOption { /** * Defines the width property. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ width?: string | number; /** * Defines the height property. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ height?: string | number; } /** * Defines circle component. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface CircleInterface { /** * use new function to set the value. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ new (value?: CircleOption): CircleAttribute; /** * Set the value.. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value?: CircleOption): CircleAttribute; } /** * Circle drawing component attribute functions. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class CircleAttribute extends CommonShapeMethod {} diff --git a/api/@internal/component/ets/column.d.ts b/api/@internal/component/ets/column.d.ts index f1045dccf4..fbecf57104 100644 --- a/api/@internal/component/ets/column.d.ts +++ b/api/@internal/component/ets/column.d.ts @@ -15,32 +15,37 @@ /** * Defines the Column Component. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface ColumnInterface { /** * Set the value. * useAlign:Use a custom alignment. * space: Vertical layout element spacing. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value?: { space?: string | number }): ColumnAttribute; } /** * Defines the Column component attribute functions. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class ColumnAttribute extends CommonMethod { /** * Sets the alignment format of the subassembly in the horizontal direction. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ alignItems(value: HorizontalAlign): ColumnAttribute; /** * Sets the alignment format of the subassembly in the vertical direction. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ justifyContent(value: FlexAlign): ColumnAttribute; } diff --git a/api/@internal/component/ets/column_split.d.ts b/api/@internal/component/ets/column_split.d.ts index 7b897cf1fa..0499163d9d 100644 --- a/api/@internal/component/ets/column_split.d.ts +++ b/api/@internal/component/ets/column_split.d.ts @@ -15,24 +15,28 @@ /** * Defines the ColumnSplit component. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface ColumnSplitInterface { /** * Layout the subassemblies vertically and insert a horizontal divider line between each subassemblies. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (): ColumnSplitAttribute; } /** * Defines the ColumnSplit component attribute functions. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class ColumnSplitAttribute extends CommonMethod { /** * Indicates whether the split line can be dragged. The default value is false. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ resizeable(value: boolean): ColumnSplitAttribute; } diff --git a/api/@internal/component/ets/common.d.ts b/api/@internal/component/ets/common.d.ts index ca5a28f447..eaff0b9d43 100644 --- a/api/@internal/component/ets/common.d.ts +++ b/api/@internal/component/ets/common.d.ts @@ -14,115 +14,134 @@ */ /** - * Defining Component ClassDecorator * @since 7 + * Defining Component ClassDecorator * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare const Component: ClassDecorator; /** * Defining Entry ClassDecorator. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare const Entry: ClassDecorator; /** * Defining Observed ClassDecorator. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare const Observed: ClassDecorator; /** * Defining Preview ClassDecorator. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare const Preview: ClassDecorator & ((value: PreviewParams) => ClassDecorator); /** * Defining BuilderParam PropertyDecorator - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare const BuilderParam: PropertyDecorator; /** * Defining State PropertyDecorator. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare const State: PropertyDecorator; /** * Defining Prop PropertyDecorator. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare const Prop: PropertyDecorator; /** * Defining Link PropertyDecorator. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare const Link: PropertyDecorator; /** * Defining ObjectLink PropertyDecorator. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare const ObjectLink: PropertyDecorator; /** * Defining Provide PropertyDecorator. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare const Provide: PropertyDecorator & ((value: string) => PropertyDecorator); /** * Defining Consume PropertyDecorator. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare const Consume: PropertyDecorator & ((value: string) => PropertyDecorator); /** * Defining StorageProp PropertyDecorator. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare const StorageProp: (value: string) => PropertyDecorator; /** * Defining StorageLink PropertyDecorator. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare const StorageLink: (value: string) => PropertyDecorator; /** * Defining Watch PropertyDecorator. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare const Watch: (value: string) => PropertyDecorator; /** * Defining Builder MethodDecorator - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare const Builder: MethodDecorator; /** * Defining CustomDialog ClassDecorator - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare const CustomDialog: ClassDecorator; /** * Defines the data type of the interface restriction. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface Configuration { /** * Set colorMode. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ readonly colorMode: string; /** * Set fontScale. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ readonly fontScale: number; } @@ -130,59 +149,68 @@ declare interface Configuration { /** * Defines the data type of the interface restriction. * @devices phone, tablet, car - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface Rectangle { /** * x:Horizontal coordinate * @devices phone, tablet, car - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ x?: Length; /** * y:Vertical axis coordinate. * @devices phone, tablet, car - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ y?: Length; /** * Sets the width of the current touchRect. * @devices phone, tablet, car - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ width?: Length; /** * Sets the height of the current touchRect. * @devices phone, tablet, car - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ height?: Length; } /** * Defining isSystemplugin Constants. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare const isSystemplugin: (...args: string[]) => any; /** * global $r function - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare function $r(value: string, ...params: any[]): Resource; /** * global $rawfile function - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare function $rawfile(value: string): Resource; /** * global getContentStorage function - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare function getContentStorage(value: any): ContentStorage; @@ -190,7 +218,8 @@ declare type Context = any; /** * global getContext function - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare function getContext(value: any): Context; @@ -206,7 +235,8 @@ interface AnimateToParam { /** * Define Preview property - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface PreviewParams { title?: string; @@ -222,391 +252,456 @@ interface PreviewParams { /** * ItemDragInfo object description - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface ItemDragInfo { /** * Obtains the X coordinate of the drag window, in vp. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ x: number; /** * Obtains the Y coordinate of the drag window, in vp. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ y: number; } /** * Defining animation function. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare function animateTo(value: AnimateToParam, event: () => void): void; /** * Converts a value in vp units to a value in px. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare function vp2px(value: number): number; /** * Converts a number in units of px to a number in units of vp. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare function px2vp(value: number): number; /** * Converts a number in fp units to a number in px. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare function fp2px(value: number): number; /** * Converts a number in units of px to a number in units of fp. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare function px2fp(value: number): number; /** * Converts a number in units of lpx to a number in units of px. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare function lpx2px(value: number): number; /** * Converts a number in units of px to a number in units of lpx. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare function px2lpx(value: number): number; /** * Defines the event target. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface EventTarget { /** * Area of current target. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ area: Area; } /** * Defines the event source type. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum SourceType { /** * Unknown type. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Unknown, /** * The mouse type. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Mouse, /** * The touch screen type. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ TouchScreen, } /** * Defines the base event. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface BaseEvent { /** * Defines the current target which fires this event. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ target: EventTarget; /** * Event timestamp. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ timestamp: number; /** * the event source info. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ source: SourceType; } /** * The tap action triggers this method invocation. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface ClickEvent extends BaseEvent { /** * X coordinate of the click point relative to the left edge of the device screen. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ screenX: number; /** * The Y coordinate of the touch point relative to the upper edge of the device screen. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ screenY: number; /** * X coordinate of the click point relative to the left edge of the clicked element. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ x: number; /** * Y coordinate of the click point relative to the upper edge of the clicked element. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ y: number; } /** * The mouse click action triggers this method invocation. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface MouseEvent extends BaseEvent { /** * Mouse button of the click event. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ button: MouseButton; /** * Mouse action of the click event. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ action: MouseAction; /** * X coordinate of the click point relative to the left edge of the device screen. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ screenX: number; /** * The Y coordinate of the click point relative to the upper edge of the device screen. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ screenY: number; /** * X coordinate of the click point relative to the left edge of the clicked element. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ x: number; /** * Y coordinate of the click point relative to the upper edge of the clicked element. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ y: number; /** * The blocking event pops up. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ stopPropagation?: () => void; } /** * Type of the touch event. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface TouchObject { /** * Type of the touch event. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ type: TouchType; /** * Finger unique identifier. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ id: number; /** * X coordinate of the touch point relative to the left edge of the device screen. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ screenX: number; /** * The Y coordinate of the touch point relative to the upper edge of the device screen. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ screenY: number; /** * X coordinate of the touch point relative to the left edge of the touched element. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ x: number; /** * Y coordinate of the touch point relative to the upper edge of the touched element. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ y: number; } /** * Touch Action Function Parameters - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface TouchEvent extends BaseEvent { /** * Type of the touch event. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ type: TouchType; /** * All finger information. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ touches: TouchObject[]; /** * Indicates the current changed finger information. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ changedTouches: TouchObject[]; /** * The blocking event pops up. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ stopPropagation?: () => void; } /** * pixelmap object with release function. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class PixelMap { /** * release function. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ release(): void; } /** * DragEvent object description - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface DragEvent { /** * Obtains the X coordinate of the drag window, in vp. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ getX(): number; /** * Obtains the Y coordinate of the drag window, in vp. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ getY(): number; } /** * KeyEvent object description: - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface KeyEvent { /** * Type of a key. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ type: KeyType; /** * Key code of a key - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ keyCode: number; /** * Key value of a key. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ keyText: string; /** * Type of the input device that triggers the current key, such as the keyboard or handle. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ keySource: KeySource; /** * Indicates the ID of the input device that triggers the current key. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ deviceId: number; /** * Indicates the status of the key when the key is pressed. * The value 1 indicates the pressed state, and the value 0 indicates the unpressed state. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ metaKey: number; /** * Timestamp when the key was pressed. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ timestamp: number; /** * Block event bubbling. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ stopPropagation?: () => void; } /** * Component State Styels. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface StateStyels { /** * Defines normal state styles. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ normal?: any; /** * Defines pressed state styles. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ pressed?: any; /** * Defines disabled state styles. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ disabled?: any; /** * Defines focused state styles. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ focused?: any; /** * Defines clicked state styles. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ clicked?: any; } @@ -614,55 +709,64 @@ interface StateStyels { interface PopupOption { /** * Information in the pop-up window. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ message: string; /** * placement On Top - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ placementOnTop?: boolean; /** * The first button. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ primaryButton?: { /** * Button text value - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ value: string; /** * action - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ action: () => void; }; /** * The second button. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ secondaryButton?: { /** * Button text value - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ value: string; /** * action - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ action: () => void; }; /** * on State Change - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onStateChange?: (event: { isVisible: boolean }) => void; } @@ -670,87 +774,101 @@ interface PopupOption { interface CustomPopupOption { /** * builder of popup - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ builder: CustomBuilder; /** * placement of popup - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ placement?: Placement; /** * mask color of popup - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ maskColor?: Color | string | Resource | number; /** * background color of popup - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ popupColor?: Color | string | Resource | number; /** * whether show arrow - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ enableArrow?: boolean; /** * whether hide popup when click mask - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ autoCancel?: boolean; /** * on State Change - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onStateChange?: (event: { isVisible: boolean }) => void; } /** * CommonMethod - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class CommonMethod { /** * constructor. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(); /** * Sets the width of the current component. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ width(value: Length): T; /** * Sets the width of the current component. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ height(value: Length): T; /** * Sets the response region of the current component. * @devices phone, tablet, car - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ responseRegion(value: Array | Rectangle): T; /** * The size of the current component. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ size(value: { width?: Length; height?: Length }): T; /** * constraint Size： * minWidth：minimum Width，maxWidth：maximum Width，minHeight：minimum Height ，maxHeight：maximum Height， - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ constraintSize(value: { minWidth?: number | string | Resource; @@ -762,65 +880,75 @@ declare class CommonMethod { /** * Sets the touchable of the current component * @devices phone, tablet, car - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ touchable(value: boolean): T; /** * layout Weight * @devices phone, tablet, car. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ layoutWeight(value: number | string): T; /** * Inner margin - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ padding(value: Padding | Length): T; /** * Outer Margin - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ margin(value: Margin | Length): T; /** * Background color - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ backgroundColor(value: Color | number | string | Resource): T; /** * Background image * src: Image address url - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ backgroundImage(src: string, repeat?: ImageRepeat): T; /** * Background image size - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ backgroundImageSize(value: { width?: number | string; height?: number | string } | ImageSize): T; /** * Background image position * x:Horizontal coordinate;y:Vertical axis coordinate. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ backgroundImagePosition(value: { x?: number | string; y?: number | string } | Alignment): T; /** * Opacity - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ opacity(value: number | Resource): T; /** * Opacity * width:Border width;color:Border color;radius:Border radius; - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ border(value: { width?: number | string | Resource; @@ -831,67 +959,78 @@ declare class CommonMethod { /** * Border style - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ borderStyle(value: BorderStyle): T; /** * Border width - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ borderWidth(value: number | string | Resource): T; /** * Border color - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ borderColor(value: Color | number | string | Resource): T; /** * Border radius - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ borderRadius(value: number | string | Resource): T; /** * Trigger a click event when a click is clicked. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onClick(event: (event?: ClickEvent) => void): T; /** * Trigger a mouse hover event. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onHover(event: (isHover?: boolean) => void): T; /** * Set hover effect. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ hoverEffect(value: HoverEffect): T; /** * Trigger a mouse event. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onMouse(event: (event?: MouseEvent) => void): T; /** * Trigger a touch event when touched. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onTouch(event: (event?: TouchEvent) => void): T; /** * Keyboard input - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onKeyEvent(event: (event?: KeyEvent) => void): T; /** * animation - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ animation(value: { duration?: number; @@ -905,7 +1044,8 @@ declare class CommonMethod { /** * Transition parameter - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ transition(value: { type?: TransitionType; @@ -935,21 +1075,24 @@ declare class CommonMethod { /** * Bind gesture recognition. * gesture:Bound Gesture Type,mask:GestureMask; - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ gesture(gesture: GestureType, mask?: GestureMask): T; /** * Binding Preferential Recognition Gestures * gesture:Bound Gesture Type,mask:GestureMask; - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ priorityGesture(gesture: GestureType, mask?: GestureMask): T; /** * Binding gestures that can be triggered simultaneously with internal component gestures * gesture:Bound Gesture Type,mask:GestureMask; - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ parallelGesture(gesture: GestureType, mask?: GestureMask): T; @@ -957,7 +1100,8 @@ declare class CommonMethod { * Adds the content blurring effect for the current component. The input parameter is the blurring radius. * The larger the blurring radius, the more blurring the content. * If the value is 0, the content blurring effect is not blurring. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ blur(value: number): T; @@ -965,14 +1109,16 @@ declare class CommonMethod { * Adds a highlight effect to the current component. * The input parameter is the highlight proportion. 0 indicates no highlight effect, and 1 indicates the maximum highlight proportion. * The component is displayed as all white (percentage). - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ brightness(value: number): T; /** * Adds a contrast effect to the current component. The input parameter is the contrast value. * A larger contrast value indicates a sharper image. When the contrast value is 0, the image becomes gray. (%) - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ contrast(value: number): T; @@ -980,13 +1126,15 @@ declare class CommonMethod { * Adds a grayscale effect to the current component. * The value is the gray scale conversion ratio. If the input parameter is 1.0, the gray scale image is completely converted to the gray scale image. If the input parameter is 0.0, the image does not change. * If the input parameter is between 0.0 and 1.0, the effect changes. (Percentage) - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ grayscale(value: number): T; /** * Adds a color overlay effect for the current component. The input parameter is the superimposed color. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ colorBlend(value: Color | string | Resource): T; @@ -995,21 +1143,24 @@ declare class CommonMethod { * The saturation is the ratio of the color-containing component to the achromatic component (gray). * The larger the color-containing component, the greater the saturation. * The larger the achromatic component, the smaller the saturation. (Percentage) - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ saturate(value: number): T; /** * Converts the image to sepia. Value defines the scale of the conversion. * A value of 1 is completely sepia, and a value of 0 does not change the image. (Percentage) - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ sepia(value: number): T; /** * Inverts the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. * A value of 0% does not change the image. (Percentage) - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ invert(value: number): T; @@ -1017,14 +1168,16 @@ declare class CommonMethod { * Adds the hue rotation effect to the current component. * The input parameter is the rotation angle. When the input parameter is 0deg, the image does not change (the default value is 0deg), and the input parameter does not have a maximum value. * If the value exceeds 360deg, the image is circled again. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ hueRotate(value: number | string): T; /** * Adds the background blur effect for the current component. The input parameter is the blur radius. * The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ backdropBlur(value: number): T; @@ -1032,33 +1185,38 @@ declare class CommonMethod { * Sets the translation effect during page transition. * The value is the start point of entry and end point of exit. * When this parameter is set together with slide, slide takes effect by default. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ translate(value: { x?: number | string; y?: number | string; z?: number | string }): T; /** * Sets the zoom effect during page transition. The value is the start point of entry and end point of exit. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ scale(value: { x?: number; y?: number; z?: number; centerX?: number | string; centerY?: number | string }): T; /** * 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. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ gridSpan(value: number): T; /** * 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, * the current component is located in the nth column. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ gridOffset(value: number): T; /** * Sets the rotation effect during assembly transition. * The values are the start point during insertion and the end point during deletion. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ rotate(value: { x?: number; @@ -1071,74 +1229,86 @@ declare class CommonMethod { /** * Sets the transformation matrix for the current component. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ transform(value: object): T; /** * This callback is triggered when a component mounts a display. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onAppear(event: () => void): T; /** * This callback is triggered when component uninstallation disappears. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onDisAppear(event: () => void): T; /** * This callback is triggered when the size or position of this component has changed. * @param event event callback. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onAreaChange(event: (oldValue: Area, newValue: Area) => void): T; /** * Controls the display or hide of the current component. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ visibility(value: Visibility): T; /** * The percentage of the remaining space of the Flex container allocated to the component on which this property resides. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ flexGrow(value: number): T; /** * The proportion of the Flex container compression size assigned to the component on which this attribute resides. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ flexShrink(value: number): T; /** * The base dimension of the assembly on which this attribute is located in the direction of the principal axis in the Flex container. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ flexBasis(value: number | string): T; /** * Overrides the default configuration of alignItems in the Flex Layout container. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ alignSelf(value: ItemAlign): T; /** * 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. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ displayPriority(value: number): T; /** * The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ zIndex(value: number): T; /** * If the components of the two pages are configured with the same ID, the shared element transition is performed during transition. If the parameter is set to an empty string, the shared element transition does not occur. For details about the options parameter, see the options parameter description. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ sharedTransition( id: string, @@ -1159,45 +1329,52 @@ declare class CommonMethod { /** * Sets the sliding direction. The enumerated value supports logical AND (&) and logical OR (|). - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ direction(value: Direction): T; /** * align - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ align(value: Alignment): T; /** * position - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ position(value: { x?: number | string | Resource; y?: number | string | Resource }): T; /** * Sets the anchor point of the element when it is positioned. The base point is offset from the top start point of the element. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ markAnchor(value: { x?: number | string | Resource; y?: number | string | Resource }): T; /** * Coordinate offset relative to the layout completion position. * Setting this attribute does not affect the layout of the parent container. The position is adjusted only during drawing. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ offset(value: { x?: number | string | Resource; y?: number | string | Resource }): T; /** * If the value is true, the component is available and can respond to operations such as clicking. * If it is set to false, click operations are not responded. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ enabled(value: boolean): T; /** * Sets the number of occupied columns and offset columns for a specific device width type. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ useSizeType(value: { xs?: number | { span: number; offset: number }; @@ -1208,52 +1385,60 @@ declare class CommonMethod { /** * Specifies the aspect ratio of the current component. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ aspectRatio(value: number): T; /** * After a listener is bound, the component can be dragged. After the drag occurs, a callback is triggered. * (To be triggered, press and hold for 170 milliseconds (ms)) - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onDragStart(event: (event?: DragEvent, extraParams?: string) => (() => any) | void): T; /** * After binding, a callback is triggered when the component is dragged to the range of the component. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onDragEnter(event: (event?: DragEvent, extraParams?: string) => void): T; /** * After binding, a callback is triggered when the drag moves within the range of a placeable component. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onDragMove(event: (event?: DragEvent, extraParams?: string) => void): T; /** * After binding, a callback is triggered when the component is dragged out of the component range. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onDragLeave(event: (event?: DragEvent, extraParams?: string) => void): T; /** * The component bound to this event can be used as the drag release target. * This callback is triggered when the drag behavior is stopped within the scope of the component. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onDrop(event: (event?: DragEvent, extraParams?: string) => void): T; /** * Add mask text to the current component. The layout is the same as that of the current component. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ overlay(value: string, options?: { align?: Alignment; offset?: { x?: number; y?: number } }): T; /** * Linear Gradient * angle: Angle of Linear Gradient; direction:Direction of Linear Gradient; colors:Color description for gradients,repeating:repeating. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ linearGradient(value: { angle?: number | string; @@ -1271,7 +1456,8 @@ declare class CommonMethod { * rotating:rotating * colors:Color description for gradients * repeating:repeating - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ sweepGradient(value: { center: Array; @@ -1288,7 +1474,8 @@ declare class CommonMethod { * radius:Radius of Radial Gradient * colors:Color description for gradients * repeating: Refill - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ radialGradient(value: { center: Array; radius: number | string; colors: Array; repeating?: boolean }): T; @@ -1298,13 +1485,15 @@ declare class CommonMethod { * from:Start point of the motion path. The default value is 0.0. * to:End point of the motion path. The default value is 1.0. * rotatble:Whether to follow the path for rotation. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ motionPath(value: { path: string; from?: number; to?: number; rotatable?: boolean }): T; /** * Add a shadow effect to the current component - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ shadow(value: { radius: number | Resource; @@ -1316,163 +1505,190 @@ declare class CommonMethod { /** * When the parameter is of the Shape type, the current component is cropped according to the specified shape. * When the parameter is of the boolean type, this parameter specifies whether to crop based on the edge contour. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ clip(value: boolean | CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute): T; /** * Applies a mask of the specified shape to the current assembly. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ mask(value: CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute): T; /** * Key. User can set an key to the component to identify it. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ key(value: string): T; /** * Id. User can set an id to the component to identify it. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ id(value: string): T; /** * geometryTransition - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ geometryTransition(id: string): T; /** * Popup control - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ bindPopup(show: boolean, popup: PopupOption | CustomPopupOption): T; /** * Menu control - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ bindMenu(content: { value: string; action: () => void }[] | CustomBuilder): T; /** * ContextMenu control - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ bindContextMenu(content: CustomBuilder, responseType : ResponseType): T; /** * Sets styles for component state. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ stateStyles(value: StateStyels): T; } /** * Defines the CustomBuilder Type. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare type CustomBuilder = () => any; /** * CommonShapeMethod - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class CommonShapeMethod extends CommonMethod { /** * constructor. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(); /** * border Color - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ stroke(value: Color | number | string | Resource): T; /** * Fill color. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fill(value: Color | number | string | Resource): T; /** * Offset from the start point of the border drawing. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ strokeDashOffset(value: number | string): T; /** * Path endpoint drawing style. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ strokeLineCap(value: LineCapStyle): T; /** * Border corner drawing style. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ strokeLineJoin(value: LineJoinStyle): T; /** * Limits for drawing acute angles as bevels - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ strokeMiterLimit(value: number | string): T; /** * Sets the opacity of the border. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ strokeOpacity(value: number | string | Resource): T; /** * fill Opacity - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fillOpacity(value: number | string | Resource): T; /** * Sets the width of the dividing line. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ strokeWidth(value: number | string | Resource): T; /** * Indicates whether to enable anti-aliasing - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ antiAlias(value: boolean): T; /** * Sets the gap for the border. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ strokeDashArray(value: Array): T; } /** * Custom Component - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class CustomComponent { /** * Customize the pop-up content constructor. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ build(): void; /** * Private aboutToAppear Method - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ private aboutToAppear?(): void; /** * Private aboutToDisappear Method - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ private aboutToDisappear?(): void; } diff --git a/api/@internal/component/ets/context_menu.d.ts b/api/@internal/component/ets/context_menu.d.ts index 39ac5aeee5..4535818a42 100644 --- a/api/@internal/component/ets/context_menu.d.ts +++ b/api/@internal/component/ets/context_menu.d.ts @@ -15,12 +15,14 @@ /** * Defines Close contextMenu. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class ContextMenu { /** * Invoking method close. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ static close(); } diff --git a/api/@internal/component/ets/counter.d.ts b/api/@internal/component/ets/counter.d.ts index a847e5f02b..425f1dcc54 100644 --- a/api/@internal/component/ets/counter.d.ts +++ b/api/@internal/component/ets/counter.d.ts @@ -15,30 +15,35 @@ /** * Counter component, which provides corresponding increment or decrement counting operations. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface CounterInterface { /** * Return Counter. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (): CounterAttribute; } /** * Defines the Counter attribute functions. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class CounterAttribute extends CommonMethod { /** * Listen to the event that the value increases. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onInc(event: () => void): CounterAttribute; /** * Listens to the number decrease event. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onDec(event: () => void): CounterAttribute; } diff --git a/api/@internal/component/ets/custom_dialog_controller.d.ts b/api/@internal/component/ets/custom_dialog_controller.d.ts index f208a90578..59022cfe23 100644 --- a/api/@internal/component/ets/custom_dialog_controller.d.ts +++ b/api/@internal/component/ets/custom_dialog_controller.d.ts @@ -16,72 +16,84 @@ /** * Defines the option of CustomDialogController. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface CustomDialogControllerOption { /** * Custom builder function. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ builder: any; /** * Defines the cancel function. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ cancel?: () => void; /** * Defines if use auto cancel when click on the outside of the dialog. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ autoCancel?: boolean; /** * Defines the dialog alignment of the screen. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ alignment?: DialogAlignment; /** * Defines the dialog offset. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ offset?: Offset; /** * Defines if use costom style. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ customStyle?: boolean; /** * Grid count of dialog. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ gridCount?: number; } /** * Use the CustomDialogController class to display the custom pop-up window. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class CustomDialogController { /** * The constructor transfers parameter settings. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(value: CustomDialogControllerOption); /** * Display the content of the customized pop-up window. If the content has been displayed, it does not take effect. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ open(); /** * Closes the custom pop-up window. If the window is closed, the window does not take effect. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ close(); } diff --git a/api/@internal/component/ets/data_panel.d.ts b/api/@internal/component/ets/data_panel.d.ts index 82d6f4c68b..a0dd1b93f4 100644 --- a/api/@internal/component/ets/data_panel.d.ts +++ b/api/@internal/component/ets/data_panel.d.ts @@ -16,66 +16,77 @@ /** * DataPanelType enum - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum DataPanelType { /** * Line Type - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Line, /** * Line Rainbow - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Circle, } /** * Defines the option of DataPanel. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface DataPanelOption { /** * Current data value. the max length is 9. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ values: number[]; /** * Maximum value of the current data. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ max?: number; /** * DataPanel Type - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ type?: DataPanelType; } /** * Defines the DataPanel component. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface DataPanelInterface { /** * Return a DataPanel. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (options: DataPanelOption): DataPanelAttribute; } /** * Defines the DataPanel attribute functions. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class DataPanelAttribute extends CommonMethod { /** * Disable the special effect of the data ratio chart. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ closeEffect(value: boolean): DataPanelAttribute; } diff --git a/api/@internal/component/ets/date_picker.d.ts b/api/@internal/component/ets/date_picker.d.ts index 7cec6ba837..5dd5c478ea 100644 --- a/api/@internal/component/ets/date_picker.d.ts +++ b/api/@internal/component/ets/date_picker.d.ts @@ -15,67 +15,78 @@ /** * Defines the type of DatePicker. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum DatePickerType { /** * Application hour and second - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Time, /** * Application data - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Date, } /** * Defines the struct of DatePickerResult. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface DatePickerResult { /** * Application year - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ year?: number; /** * Application month - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ month?: number; /** * Application day - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ day?: number; /** * Application hour - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ hour?: number; /** * Application minute - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ minute?: number; /** * Application second - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ second?: number; } /** * Defines the option of DatePicker. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface DatePickerOption { /** @@ -100,102 +111,119 @@ declare interface DatePickerOption { /** * Defines the DatePicker Component. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface DatePickerInterface { /** * Defines the DatePicker constructor. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ (options?: DatePickerOption): DatePickerAttribute; } /** * Defines the DatePicker attribute functions. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class DatePickerAttribute extends CommonMethod { /** * Date selector: true: displays the lunar calendar. false: The lunar calendar is not displayed. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ lunar(value: boolean): DatePickerAttribute; /** * Time Selector: indicates whether to display the 24-hour clock. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ useMilitaryTime(value: boolean): DatePickerAttribute; /** * This event is triggered when a DatePicker date or time is selected. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onChange(callback: (value: DatePickerResult) => void): DatePickerAttribute; } /** * Defines the DatePickerDialogOption for Data Picker Dialog. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface DatePickerDialogOption extends DatePickerOption { /** * Date selector: true: displays the lunar calendar. false: The lunar calendar is not displayed. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ lunar?: boolean; /** * Time Selector: indicates whether to display the 24-hour clock. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ useMilitaryTime?: boolean; } /** * Defines the event callback status in the pop-up window state. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum DialogStatus { /** * Triggered when a user clicks the OK button. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Accept, /** * Triggered when a user taps the Cancel button. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Cancel, /** * Triggered when a user performs scrolling selection. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Update, } /** * Defines the DatePickerDialogResult for DatePickerDialog. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface DatePickerDialogResult extends DatePickerResult { /** * Operation status of the current user. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ status: DialogStatus; } /** * Defines DatePickerDialog which uses show method to show DatePicker dialog. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class DatePickerDialog { /** * Invoking method display. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ static show(options?: DatePickerDialogOption, callback?: (value: DatePickerDialogResult) => void); } diff --git a/api/@internal/component/ets/divider.d.ts b/api/@internal/component/ets/divider.d.ts index 4ee88aa42e..4f2f8338ba 100644 --- a/api/@internal/component/ets/divider.d.ts +++ b/api/@internal/component/ets/divider.d.ts @@ -16,43 +16,50 @@ /** * Provides a divider component to separate different content blocks/content elements. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface DividerInterface { /** * Return Divider. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (): DividerAttribute; } /** * Defines the Divider attribute functions. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class DividerAttribute extends CommonMethod { /** * Indicates whether to use a horizontal splitter or a vertical splitter. * The options are as follows: false: horizontal splitter; true: vertical splitter. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ vertical(value: boolean): DividerAttribute; /** * Sets the color of the divider line. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ color(value: ResourceColor): DividerAttribute; /** * Sets the width of the dividing line. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ strokeWidth(value: number | string): DividerAttribute; /** * Sets the end style of the split line. The default value is Butt. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ lineCap(value: LineCapStyle): DividerAttribute; } diff --git a/api/@internal/component/ets/ellipse.d.ts b/api/@internal/component/ets/ellipse.d.ts index 2ba7cdbbba..9c859b3542 100644 --- a/api/@internal/component/ets/ellipse.d.ts +++ b/api/@internal/component/ets/ellipse.d.ts @@ -16,24 +16,28 @@ /** * Ellipse drawing. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface EllipseInterface { /** * use new function to set the value. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ new (value?: { width?: string | number; height?: string | number }): EllipseAttribute; /** * Set the value. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value?: { width?: string | number; height?: string | number }): EllipseAttribute; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class EllipseAttribute extends CommonShapeMethod {} diff --git a/api/@internal/component/ets/enums.d.ts b/api/@internal/component/ets/enums.d.ts index bf60ad0024..6082510fcc 100644 --- a/api/@internal/component/ets/enums.d.ts +++ b/api/@internal/component/ets/enums.d.ts @@ -15,957 +15,1116 @@ /** * common enum of color - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum Color { /** * White. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ White, /** * Black. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Black, /** * Blue. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Blue, /** * Brown. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Brown, /** * Gray. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Gray, /** * Green. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Green, /** * Grey. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Grey, /** * Orange. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Orange, /** * color. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Pink, /** * Red. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Red, /** * Yellow. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Yellow, } /** * Image display mode - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum ImageFit { /** * Keep the aspect ratio to zoom out or zoom in so that the image is completely displayed within the display boundary. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Contain, /** * Keep the aspect ratio to zoom out or zoom in so that both sides of the image are greater than or equal to the display boundary. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Cover, /** * Adaptive display - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Auto, /** * Zoom in or out without maintaining the aspect ratio so that the image fills the display boundary. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Fill, /** * Keep the aspect ratio displayed, and the image zooms out or remains unchanged. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ ScaleDown, /** * Keep the original size and display it in the center. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ None, } /** * Border Style - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum BorderStyle { /** * Displays as a series of dots with a radius of half the borderWidth. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Dotted, /** * Shows as a series of short square dashed lines. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Dashed, /** * Shows as a solid line. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Solid, } /** * Line Join Style - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum LineJoinStyle { /** * Connect path segments using bevels. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Miter, /** * Connect path segments using sharp corners. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Round, /** * Connect path segments using fillets. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Bevel, } /** * Function Called by Touch - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum TouchType { /** * Triggered when the finger is pressed. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Down, /** * Triggered when the finger is raised. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Up, /** * Triggered when the finger presses on the screen. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Move, /** * Triggers when the touch event cancels. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Cancel, } /** * Function Called by Mouse - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum MouseButton { /** * Mouse Left Button. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Left, /** * Mouse Right Button. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Right, /** * Mouse Middle Button. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Middle, /** * Mouse Back Button. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Back, /** * Mouse Forward Button. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Forward, /** * Mouse None Button. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ None, } /** * Function Called by Mouse - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum MouseAction { /** * Triggered when the mouse is pressed. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Press, /** * Triggered when the mouse is released. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Release, /** * Triggered when the mouse is Moved. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Move, /** * Triggered when the mouse is Hovered. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Hover, /** * Triggered when the mouse status is None. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ None, } /** * Animation status. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum AnimationStatus { /** * Initial state of the animation. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Initial, /** * The animation is playing. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Running, /** * The animation is paused. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Paused, /** * The animation is stopped. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Stopped, } /** * Sets the animation playback mode. By default, the animation starts to play again after the playback is complete. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum Curve { /** * Indicates that the speed of the animation is the same from start to finish. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Linear, /** * Indicates that the animation starts at a low speed, then accelerates, and then slows down before it ends, CubicBezier(0.25, 0.1, 0.25, 1.0). - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Ease, /** * Indicates that the animation starts at a low speed, CubicBezier(0.42, 0.0, 1.0, 1.0). - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ EaseIn, /** * Indicates that the animation ends at a low speed, CubicBezier(0.0, 0.0, 0.78, 1.0). - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ EaseOut, /** * Indicates that the animation starts and ends at a slow speed, CubicBezier(0.42, 0.0, 0.78, 1.0). - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ EaseInOut, /** * Slow-in, fast-out - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ FastOutSlowIn, /** * Linear Out Slow In - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ LinearOutSlowIn, /** * Fast OutL inear In. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ FastOutLinearIn, /** * Extreme Deceleration. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ ExtremeDeceleration, /** * Sharp. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Sharp, /** * Rhythm. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Rhythm, /** * Smooth. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Smooth, /** * Damping curve, CubicBezier(0.2, 0.0, 0.2, 1.0). - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Friction, } /** * Sets the state before and after the animation starts. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum FillMode { /** * Restores to the initial state after the playback is complete. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ None, /** * Retains the state at the end of the animation when the playback is complete. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Forwards, /** * Applies the start attribute value for the period specified by animation-delay before the animation is displayed. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Backwards, /** * Both forward and backward fill modes are applied. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Both, } /** * Play Mode - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum PlayMode { /** * The animation plays normally. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Normal, /** * The animation plays backwards. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Reverse, /** * The animation plays forward on odd numbers (1, 3, 7...) and backward on even numbers (2, 4, 6...). - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Alternate, /** * The animation plays backwards on odd numbers (1, 3, 7...) and forwards on even numbers (2, 4, 6...).. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ AlternateReverse, } /** * This style allows you to set the window blurring degree and blurring style of the current component layout range, - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum BlurStyle { /** * Small range glow effect. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ SmallLight, /** * Medium range glow effect. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ MediumLight, /** * Wide range of luminous effects. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ LargeLight, /** * Super-range luminous effect. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ XlargeLight, /** * Small range of dark effects. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ SmallDark, /** * Medium range dark effect. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ MediumDark, /** * Wide range of dark effects. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ LargeDark, /** * Extra large range of dark effects. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ XlargeDark, } /** * Type of a key. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum KeyType { /** * Press the key. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Down, /** * The key is released. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Up, } /** * Type of the input device that triggers the current key. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum KeySource { /** * The input device type is unknown. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Unknown, /** * Set Device Type to Keyboard. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Keyboard, } /** * Edge. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum Edge { /** * The top is centered horizontally. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Top, /** * Center horizontal and vertical. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Center, /** * The bottom is centered horizontally. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Bottom, /** * Cross axis direction text baseline alignment. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Baseline, /** * Align the head of the cross axis direction. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Start, /** * Middle - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Middle, /** * Align the head of the cross axis direction. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ End, } /** * Set Weekend - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum Week { /** * Monday. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Mon, /** * Tuesday. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Tue, /** * Wednesday. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Wed, /** * Thursday. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Thur, /** * Friday. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Fri, /** * Saturday. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Sat, /** * Sunday. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Sun, } /** * Sets the horizontal layout of elements. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum Direction { /** * Elements are laid out from left to right. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Ltr, /** * Elements are laid out from right to left. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Rtl, /** * Use the default layout direction. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Auto, } /** * Sets the horizontal layout of elements. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum FocusDirection { /** * From the key up. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Up, /** * From the key down. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Down, /** * From the key left. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Left, /** * From the key right. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Right, /** * From the key tab. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Tab, } /** * Used to set the status of the scroll bar. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum BarState { /** * Not displayed. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Off, /** * On-demand display (displayed when you touch it and disappears after 2 seconds). - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Auto, /** * Resident display. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ On, } /** * Sliding effect - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum EdgeEffect { /** * Elastic physical action, sliding to the edge can continue to slide for a distance based on the initial speed or touch event, and spring back when released. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Spring, /** * Fade. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Fade, /** * Sliding to the edge has no effect. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ None, } /** * Alignment enumeration description. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum Alignment { /** * Top Start. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ TopStart, /** * The top is centered horizontally. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Top, /** * Top tail end. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ TopEnd, /** * The starting end is centered longitudinally. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Start, /** * Center horizontal and vertical. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Center, /** * The tail end is centered longitudinally. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ End, /** * Bottom starting end. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ BottomStart, /** * The bottom is centered horizontally. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Bottom, /** * Bottom end. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ BottomEnd, } /** * TransitionType enumeration description. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum TransitionType { /** * Specifies that the current transition action takes effect in all change scenarios of the component. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ All, /** * Specifies the insertion scenario in which the current transition action takes effect. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Insert, /** * Specifies the deletion scenario in which the current transition action takes effect. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Delete, } /** * RelateType enumeration description - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum RelateType { /** * Scales the current component to fill the parent component. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ FILL, /** * Scales the current component to fit the parent component. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ FIT, } /** * Controls the display or hide of the current component - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum Visibility { /** * Show - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Visible, /** * Hide, but participate in layout for placeholder. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Hidden, /** * Hides but does not participate in layout and does not take place. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ None, } /** * LineCapStyle enumeration description - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum LineCapStyle { /** * The two ends of the dividing line are parallel lines. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Butt, /** * The two ends of the dividing line are semicircles. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Round, /** * Extends half a circle at the end of the path with a width equal to half the line width and a height equal to the line width. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Square, } /** * Axis enumeration description. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum Axis { /** * Longitudinal arrangement - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Vertical, /** * Horizontal arrangement. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Horizontal, } /** * HorizontalAlign enumeration description. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum HorizontalAlign { /** * Aligns the start end in the language direction. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Start, /** * Center alignment. The default alignment mode is used. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Center, /** * Aligns the ends in the language direction. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ End, } /** * FlexAlign enumeration description. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum FlexAlign { /** * The element is aligned at the head of the principal axis, * the first element is aligned with the head of the row, and subsequent elements are aligned with the previous one. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Start, /** * The elements are centered in the direction of the principal axis, * and the first element is the same distance from the beginning of the row as the last element is from the end of the row. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Center, /** * The element is aligned at the tail of the principal axis, * the last element is aligned at the end of the row, and the other elements are aligned with the next. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ End, @@ -973,7 +1132,8 @@ declare enum FlexAlign { * Elastic elements are evenly distributed in the direction of the Flex principal axis, * with the same distance between adjacent elements. * The first element aligns with the beginning of the line, and the last element aligns with the end of the line. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ SpaceBetween, @@ -981,7 +1141,8 @@ declare enum FlexAlign { * Elastic elements are evenly distributed in the direction of the Flex principal axis, * with the same distance between adjacent elements. Half the distance between adjacent elements as the distance between * the first element and the distance between the last element and the end of the row. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ SpaceAround, @@ -989,525 +1150,612 @@ declare enum FlexAlign { * Elements in the Flex axis direction are evenly spaced. * The spacing between adjacent elements, the spacing between the first element and the beginning of the row, * and the spacing between the last element and the end of the row are the same. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ SpaceEvenly, } /** * ItemAlign enumeration description - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum ItemAlign { /** * Use the default configuration in the Flex container. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Auto, /** * The element is in the Flex container with the cross-axis direction head aligned. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Start, /** * The element is centered in the Flex container with the cross axis direction aligned. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Center, /** * The element is bottom aligned in the Flex container with the cross axis direction. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ End, /** * Element In the Flex container, the cross-axis direction text baseline is aligned. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Baseline, /** * Element In a Flex container, the fill is stretched across the axis and, when no dimension is set, to the container size. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Stretch, } /** * FlexDirection enumeration description - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum FlexDirection { /** * The main axis is consistent with the row direction as the layout mode. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Row, /** * The main axis is consistent with the column direction as the layout mode. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Column, /** * The layout is in the opposite direction to the Row direction. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ RowReverse, /** * Layout in the opposite direction to the column. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ ColumnReverse, } /** * FlexWrap enumeration description - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum FlexWrap { /** * The Flex container has a single row/column layout of elements, and children are allowed to go beyond the container. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ NoWrap, /** * The elements of the Flex container are arranged in multiple rows or columns, and the sub-items are allowed to exceed the container. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Wrap, /** * The elements of the Flex container are arranged in reverse multiple rows/columns, and children are allowed to exceed the container. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ WrapReverse, } /** * VerticalAlign enumeration description - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum VerticalAlign { /** * Top alignment. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Top, /** * Center alignment. The default alignment mode is used. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Center, /** * Bottom alignment. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Bottom, } /** * ImageRepeat enumeration description - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum ImageRepeat { /** * Do not draw the picture again. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ NoRepeat, /** * Repeat the drawing only on the horizontal axis. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ X, /** * Repeat the drawing only on the vertical axis. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Y, /** * Draw the picture repeatedly on both axes. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ XY, } /** * ImageSize enumeration description - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum ImageSize { /** * Keep the scale of the original image unchanged. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Auto, /** * Default value. Keep the aspect ratio to zoom in or out the image so that both sides of the image are greater than or equal to the display boundary. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Cover, /** * Keep the aspect ratio to zoom out or zoom in so that the image is completely displayed within the display boundary. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Contain, } /** * GradientDirection enumeration description - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum GradientDirection { /** * Right to left. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Left, /** * From the bottom up. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Top, /** * From left to right. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Right, /** * From the top down. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Bottom, /** * Top Left - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ LeftTop, /** * Left Bottom - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ LeftBottom, /** * Right Top - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ RightTop, /** * Right Bottom - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ RightBottom, /** * None - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ None, } /** * SharedTransitionEffectType enumeration description - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum SharedTransitionEffectType { /** * The location of the destination page element remains unchanged, and you can configure the transparency animation. Currently, * only the static effect configured for redirecting to the target page takes effect. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Static, /** * Move the source page element to the destination page element location and scale it appropriately. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Exchange, } /** * Text style - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum FontStyle { /** * Default style. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Normal, /** * Italic style. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Italic, } /** * The font weight of the text - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum FontWeight { /** * Defines a lighter value than [Inherited Value].. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Lighter, /** * Normal font. Equivalent to a digital value of 400. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Normal, /** * Defines a more general value than [Inherited Value]. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Regular, /** * Defines a value that is more centered than [Inherited Value]. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Medium, /** * Bold. Equivalent to a numeric value of 700. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Bold, /** * Defines a value that is heavier than [Inherited Value]. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Bolder, } /** * Alignment of text. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum TextAlign { /** * Center the text. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Center, /** * The text is aligned in the same direction as the writing - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Start, /** * The text is aligned in the opposite direction of writing - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ End, } /** * Declare how text overflows. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum TextOverflow { /** * When the text is too long, it will be cropped and displayed. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Clip, /** * If the text is too long, the text that cannot be displayed shall be replaced by ellipsis. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Ellipsis, /** * Text is not cropped when it is too long. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ None, } /** * Type of text modifier. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum TextDecorationType { /** * Do not use text decorative lines. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ None, /** * Underline the words. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Underline, /** * Text is in all uppercase. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Overline, /** * A modifier line that passes through the text. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ LineThrough, } /** * Letter type in text - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum TextCase { /** * The default is normal. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Normal, /** * The text is all lowercase. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ LowerCase, /** * The text is all uppercase. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ UpperCase, } /** * ResponseType for contextMenu - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum ResponseType { /** * Right click. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ RightClick, /** * Long press. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ LongPress, } /** * HoverEffect enumeration description - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum HoverEffect { /** * Default effect - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Auto, /** * Zoom in and out effect - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Scale, /** * Highlight effect - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Board, /** * None effect - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ None, } /** * Placement enumeration description - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum Placement { /** * Left placement - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Left, /** * Right placement - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Right, /** * Top placement - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Top, /** * Bottom placement - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Bottom, /** * TopLeft placement - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ TopLeft, /** * TopRight placement - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ TopRight, /** * BottomLeft placement - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ BottomLeft, /** * BottomRight placement - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ BottomRight, } diff --git a/api/@internal/component/ets/flex.d.ts b/api/@internal/component/ets/flex.d.ts index 0e6bb92157..bc961fc8fb 100644 --- a/api/@internal/component/ets/flex.d.ts +++ b/api/@internal/component/ets/flex.d.ts @@ -15,55 +15,64 @@ /** * Defines the option of Flex. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface FlexOption { /** * Sets the horizontal layout of elements. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ direction?: FlexDirection; /** * Whether the Flex container is a single row/column arrangement or a multi-row/column arrangement. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ wrap?: FlexWrap; /** * The alignment format of the subassembly on the Flex container spindle. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ justifyContent?: FlexAlign; /** * Alignment Format for Subassembly on Flex Container Cross Axis. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ alignItems?: ItemAlign; /** * The alignment of multiple lines of content when there is extra space in the cross axis. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ alignContent?: FlexAlign; } /** * Provides a monthly view component to display information such as date, shift break, and schedule. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface FlexInterface { /** * Defines the constructor of Flex. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value?: FlexOption): FlexAttribute; } /** * Defines the Flex attribute functions. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class FlexAttribute extends CommonMethod {} diff --git a/api/@internal/component/ets/forEach.d.ts b/api/@internal/component/ets/forEach.d.ts index d1e8c71767..fd86920f42 100644 --- a/api/@internal/component/ets/forEach.d.ts +++ b/api/@internal/component/ets/forEach.d.ts @@ -15,12 +15,14 @@ /** * looping - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface ForEachInterface { /** * Set the value, array, and key. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ ( arr: Array, @@ -31,6 +33,7 @@ interface ForEachInterface { /** * @devices phone, tablet, car - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare const ForEach: ForEachInterface; diff --git a/api/@internal/component/ets/form_component.d.ts b/api/@internal/component/ets/form_component.d.ts index 1d3fa7dfdd..0afaf6b7f2 100644 --- a/api/@internal/component/ets/form_component.d.ts +++ b/api/@internal/component/ets/form_component.d.ts @@ -16,34 +16,39 @@ /** * Defines the FormDimension enum. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ declare enum FormDimension { /** * 1 x 2 cards - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ Dimension_1_2, /** * 2 x 2 cards - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ Dimension_2_2, /** * 2 x 4 cards - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ Dimension_2_4, /** * 4 x 4 cards - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ Dimension_4_4, @@ -51,13 +56,15 @@ declare enum FormDimension { /** * Defines the FormComponent. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ interface FormComponentInterface { /** * Set a new value. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ (value: { @@ -72,41 +79,47 @@ interface FormComponentInterface { } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ declare class FormComponentAttribute extends CommonMethod { /** * Sets the display area size of the card. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ size(value: { width: number; height: number }): FormComponentAttribute; /** * Card module name. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ moduleName(value: string): FormComponentAttribute; /** * Set the card size. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ dimension(value: FormDimension): FormComponentAttribute; /** * Indicates whether to allow card update. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ allowUpdate(value: boolean): FormComponentAttribute; /** * Whether the card is visible. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ visibility(value: Visibility): FormComponentAttribute; @@ -114,21 +127,24 @@ declare class FormComponentAttribute extends CommonMethod void): FormComponentAttribute; /** * Card loading error. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ onError(callback: (info: { errcode: number; msg: string }) => void): FormComponentAttribute; /** * Card to be redirected. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ onRouter(callback: (info: any) => void): FormComponentAttribute; diff --git a/api/@internal/component/ets/gauge.d.ts b/api/@internal/component/ets/gauge.d.ts index 6002fadf1e..18e98d3711 100644 --- a/api/@internal/component/ets/gauge.d.ts +++ b/api/@internal/component/ets/gauge.d.ts @@ -15,49 +15,57 @@ /** * Defines the Gauge component. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface GaugeInterface { /** * value:Current data value. * min: Current Segment Minimum Value * max: Current Segment Maximum Value - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ (options: { value: number; min?: number; max?: number }): GaugeAttribute; } /** - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class GaugeAttribute extends CommonMethod { /** * Sets the value for the current profile. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ value(value: number): GaugeAttribute; /** * Set the start angle. Clock 0 is 0 degrees and clockwise is positive. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ startAngle(angle: number): GaugeAttribute; /** * Sets the end angle position. Clock 0 is 0 degrees and clockwise is positive. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ endAngle(angle: number): GaugeAttribute; /** * Set the color of the chart. You can set the solid color and segmented gradient color. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ colors(colors: Array): GaugeAttribute; /** * Sets the thickness of the ring chart. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ strokeWidth(length: number): GaugeAttribute; } diff --git a/api/@internal/component/ets/gesture.d.ts b/api/@internal/component/ets/gesture.d.ts index a60d9db85e..3d20ab6f80 100644 --- a/api/@internal/component/ets/gesture.d.ts +++ b/api/@internal/component/ets/gesture.d.ts @@ -15,193 +15,225 @@ /** * Creating an Object - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum GestureDirection { /** * Sliding in all directions. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ All, /** * Sliding horizontally. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Horizontal, /** * Sliding Vertical - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Vertical, } /** * Creating an Object - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum PanDirection { /** * Default. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ None, /** * Sliding horizontally. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Horizontal, /** * Sliding left. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Left, /** * Sliding right. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Right, /** * Sliding Vertical - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Vertical, /** * Sliding up. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Up, /** * Sliding Down. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Down, /** * Sliding in all directions. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ All, } /** * Creating an Object - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum SwipeDirection { /** * Default. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ None, /** * Sliding horizontally. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Horizontal, /** * Sliding Vertical - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Vertical, /** * Sliding in all directions. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ All, } /** * Creating an Object - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum GestureMode { /** * Sequential gesture recognition is performed in sequence according to the gesture registration sequence. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Sequence, /** * Simultaneous recognition. Registration gestures participate in recognition. Everything can be triggered. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Parallel, /** * Mutually exclusive recognition. Only one gesture is successfully recognized. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Exclusive, } /** * Creating an Object - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum GestureMask { /** * High-priority response to the current gesture.When the current gesture fails to be recognized, other gesture responses are triggered.For gestures with the same priority, responses are performed based on the recognition sequence. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Normal, /** * Ignore internal gestures and recognize the current gesture first. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ IgnoreInternal, } /** * Type of the finger information. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface FingerInfo { /** * Finger unique identifier. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ id: number; /** * X coordinate of the touch point relative to the left edge of the device screen. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ globalX: number; /** * The Y coordinate of the touch point relative to the upper edge of the device screen. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ globalY: number; /** * X coordinate of the touch point relative to the left edge of the touched element. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ localX: number; /** * Y coordinate of the touch point relative to the upper edge of the touched element. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ localY: number; } /** * Defines the Gesture Type. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare type GestureType = | TapGestureInterface @@ -214,7 +246,8 @@ declare type GestureType = /** * Defines the GestureEvent type. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare type GestureEvent = | TapGestureEvent @@ -226,30 +259,35 @@ declare type GestureEvent = /** * tap gesture event used in the longpress scenario. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface TapGestureEvent extends BaseGestureEvent { /** * All finger information. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fingerList: FingerInfo[]; } /** * long press gesture event used in the longpress scenario. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface LongPressGestureEvent extends BaseGestureEvent { /** * Indicates whether an event is triggered repeatedly. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ repeat: boolean; /** * All finger information. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fingerList: FingerInfo[]; } @@ -260,13 +298,15 @@ interface LongPressGestureEvent extends BaseGestureEvent { interface PanGestureEvent extends BaseGestureEvent { /** * Gesture event offset X. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ offsetX: number; /** * Gesture event offset Y. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ offsetY: number; } @@ -277,81 +317,94 @@ interface PanGestureEvent extends BaseGestureEvent { interface SwipeGestureEvent extends BaseGestureEvent { /** * Gesture event direction angle. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ angle: number; /** * Gesture event slide speed. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ speed: number; } /** * pinch gesture event used for triggering the pinch gesture. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface PinchGestureEvent extends BaseGestureEvent { /** * Scaling ratio. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ scale: number; /** * X-axis coordinate of the kneading center point, in pixels. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ pinchCenterX: number; /** * Y-axis coordinate of the kneading center point, in pixels. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ pinchCenterY: number; } /** * rotation gesture event used for triggering the pinch gesture. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface RotationGestureEvent extends BaseGestureEvent { /** * Rotation angle. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ angle: number; } /** * base event for gesture. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface BaseGestureEvent extends BaseEvent {} /** * Creating an interface - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface TapGestureInterface { /** * Set the value. * count:Number of consecutive clicks recognized. If the value is less than 1, the default value is used. * fingers:The hand index that triggers the click. If the value is less than 1, the default value is used. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value?: { count?: number; fingers?: number }): TapGestureInterface; /** * Tap gesture recognition success callback. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onAction(event: (event?: GestureEvent) => void): TapGestureInterface; } /** * Creating an interface - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface LongPressGestureInterface { /** @@ -359,193 +412,226 @@ interface LongPressGestureInterface { * fingers: Indicates the hand index that triggers the long press. * repeat: Indicates whether to trigger event callback continuously. * duration: Minimum press and hold time, in milliseconds. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value?: { fingers?: number; repeat?: boolean; duration?: number }): LongPressGestureInterface; /** * LongPress gesture recognition success callback. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onAction(event: (event?: LongPressGestureEvent) => void): LongPressGestureInterface; /** * The LongPress gesture is successfully recognized. When the finger is lifted, the callback is triggered. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onActionEnd(event: (event?: LongPressGestureEvent) => void): LongPressGestureInterface; /** * The LongPress gesture is successfully recognized and a callback is triggered when the touch cancel event is received. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onActionCancel(event: () => void): LongPressGestureInterface; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class PanGestureOption { /** * Constructor parameters. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(value?: { fingers?: number; direction?: PanDirection; distance?: number }); /** * Sets the direction attribute. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ setDirection(value: PanDirection); /** * Sets the setDistance attribute. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ setDistance(value: number); /** * Sets the setFingers attribute. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ setFingers(value: number); } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface PanGestureInterface { /** * Set the value. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value?: { fingers?: number; direction?: PanDirection; distance?: number } | PanGestureOption): PanGestureInterface; /** * Pan gesture recognition success callback. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onActionStart(event: (event?: PanGestureEvent) => void): PanGestureInterface; /** * Callback when the Pan gesture is moving. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onActionUpdate(event: (event?: PanGestureEvent) => void): PanGestureInterface; /** * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onActionEnd(event: (event?: PanGestureEvent) => void): PanGestureInterface; /** * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onActionCancel(event: () => void): PanGestureInterface; } /** - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface SwipeGestureInterface { /** * Set the value. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ (value?: { fingers?: number; direction?: SwipeDirection; speed?: number }): SwipeGestureInterface; /** * Slide gesture recognition success callback. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onAction(event: (event?: SwipeGestureEvent) => void): SwipeGestureInterface; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface PinchGestureInterface { /** * Set the value. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value?: { fingers?: number; distance?: number }): PinchGestureInterface; /** * Pan gesture recognition success callback. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onActionStart(event: (event?: PinchGestureEvent) => void): PinchGestureInterface; /** * Callback when the Pan gesture is moving. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onActionUpdate(event: (event?: PinchGestureEvent) => void): PinchGestureInterface; /** * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onActionEnd(event: (event?: PinchGestureEvent) => void): PinchGestureInterface; /** * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onActionCancel(event: () => void): PinchGestureInterface; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface RotationGestureInterface { /** * Set the value. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value?: { fingers?: number; angle?: number }): RotationGestureInterface; /** * Pan gesture recognition success callback. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onActionStart(event: (event?: RotationGestureEvent) => void): RotationGestureInterface; /** * Callback when the Pan gesture is moving. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onActionUpdate(event: (event?: RotationGestureEvent) => void): RotationGestureInterface; /** * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onActionEnd(event: (event?: RotationGestureEvent) => void): RotationGestureInterface; /** * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onActionCancel(event: () => void): RotationGestureInterface; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface GestureGroupInterface { /** * Return to Obtain GestureGroup. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (mode: GestureMode, ...gesture: GestureType[]): GestureGroupInterface; /** * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onCancel(event: () => void): GestureGroupInterface; } diff --git a/api/@internal/component/ets/grid.d.ts b/api/@internal/component/ets/grid.d.ts index c214e94334..04057a4b40 100644 --- a/api/@internal/component/ets/grid.d.ts +++ b/api/@internal/component/ets/grid.d.ts @@ -15,19 +15,22 @@ /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface GridInterface { /** * Grid is returned when the parameter is transferred. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (scroller?: Scroller): GridAttribute; } /** * The enum of property layoutDirection - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum GridDirection { Row, @@ -37,128 +40,149 @@ declare enum GridDirection { } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class GridAttribute extends CommonMethod { /** * This parameter specifies the number of columns in the current grid layout. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ columnsTemplate(value: string): GridAttribute; /** * Lets you set the number of rows in the current grid layout, - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ rowsTemplate(value: string): GridAttribute; /** * Allows you to set the spacing between columns. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ columnsGap(value: Length): GridAttribute; /** * Lets you set the spacing between rows. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ rowsGap(value: Length): GridAttribute; /** * This parameter specifies the width of the scroll bar. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ scrollBarWidth(value: number | string): GridAttribute; /** * Sets the color of the scroll bar. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ scrollBarColor(value: Color | number | string): GridAttribute; /** * Lets you set the spacing between rows. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ scrollBar(value: BarState): GridAttribute; /** * Sets the status of the scroll bar. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onScrollIndex(event: (first: number) => void): GridAttribute; /** * cached Count - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ cachedCount(value: number): GridAttribute; /** * editMode - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ editMode(value: boolean): GridAttribute; /** * maxCount - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ maxCount(value: number): GridAttribute; /** * minCount - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ minCount(value: number): GridAttribute; /** * cellLength - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ cellLength(value: number): GridAttribute; /** * control GridDirection of the grid. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ layoutDirection(value: GridDirection): GridAttribute; /** * control if the grid supports animation. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ supportAnimation(value: boolean): GridAttribute; /** * After a listener is bound, the component can be dragged. After the drag occurs, a callback is triggered. * (To be triggered, press and hold for 170 milliseconds (ms)) - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onItemDragStart(event: (event: ItemDragInfo, itemIndex: number) => (() => any) | void): GridAttribute; /** * After binding, a callback is triggered when the component is dragged to the range of the component. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onItemDragEnter(event: (event: ItemDragInfo) => void): GridAttribute; /** * After binding, a callback is triggered when the drag moves within the range of a placeable component. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onItemDragMove(event: (event: ItemDragInfo, itemIndex: number, insertIndex: number) => void): GridAttribute; /** * After binding, a callback is triggered when the component is dragged out of the component range. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onItemDragLeave(event: (event: ItemDragInfo, itemIndex: number) => void): GridAttribute; /** * The component bound to this event can be used as the drag release target. * This callback is triggered when the drag behavior is stopped within the scope of the component. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onItemDrop(event: (event: ItemDragInfo, itemIndex: number, insertIndex: number, isSuccess: boolean) => void): GridAttribute; diff --git a/api/@internal/component/ets/gridItem.d.ts b/api/@internal/component/ets/gridItem.d.ts index 53e7a83444..0b76b00390 100644 --- a/api/@internal/component/ets/gridItem.d.ts +++ b/api/@internal/component/ets/gridItem.d.ts @@ -15,47 +15,55 @@ /** * Mesh container for static fixed-size layout scenarios. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface GridItemInterface { /** * Return to get GridItem. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (): GridItemAttribute; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class GridItemAttribute extends CommonMethod { /** * This parameter specifies the start line number of the current element. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ rowStart(value: number): GridItemAttribute; /** * Specifies the end line number of the current element. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ rowEnd(value: number): GridItemAttribute; /** * This parameter specifies the start column number of the current element. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ columnStart(value: number): GridItemAttribute; /** * This parameter specifies the end column number of the current element. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ columnEnd(value: number): GridItemAttribute; /** * This parameter specifies whether to recreate the node when the component build is triggered. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ forceRebuild(value: boolean): GridItemAttribute; } diff --git a/api/@internal/component/ets/grid_container.d.ts b/api/@internal/component/ets/grid_container.d.ts index 86cacbe428..37c4665258 100644 --- a/api/@internal/component/ets/grid_container.d.ts +++ b/api/@internal/component/ets/grid_container.d.ts @@ -15,85 +15,99 @@ /** * Defines the size type. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum SizeType { /** * Select a value based on the device type. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Auto, /** * Select a value based on the device type. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ XS, /** * Small width type device. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ SM, /** * Medium width type device. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ MD, /** * Large width type device. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ LG, } /** * Defines the option of GridContainer. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface GridContainerOption { /** * Sets the total number of columns in the current layout. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ columns?: number | "auto"; /** * Select the device width type. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ sizeType?: SizeType; /** * Grid layout column spacing. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ gutter?: number | string; /** * Spacing on both sides of the grid layout. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ margin?: number | string; } /** * Defines the GridContainer component. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface GridContainerInterface { /** * Defines the constructor of GridContainer. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value?: GridContainerOption): GridContainerAttribute; } /** * Defines the grid container attribute from inheritance Column - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class GridContainerAttribute extends ColumnAttribute {} diff --git a/api/@internal/component/ets/hyperlink.d.ts b/api/@internal/component/ets/hyperlink.d.ts index f5c3dd4da0..38367d9a70 100644 --- a/api/@internal/component/ets/hyperlink.d.ts +++ b/api/@internal/component/ets/hyperlink.d.ts @@ -14,26 +14,30 @@ */ /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface HyperlinkInterface { /** * Return to get Hyperlink. * address: Web page redirected by the hyperlink component. * content: Hyperlinks in the hyperlink component display text. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (address: string | Resource, content?: string | Resource): HyperlinkAttribute; } /** * inheritance CommonMethod - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class HyperlinkAttribute extends CommonMethod { /** * Set Color - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ color(value: ResourceColor): HyperlinkAttribute; } diff --git a/api/@internal/component/ets/image.d.ts b/api/@internal/component/ets/image.d.ts index 9474d5f7c6..67ef959a46 100644 --- a/api/@internal/component/ets/image.d.ts +++ b/api/@internal/component/ets/image.d.ts @@ -14,138 +14,161 @@ */ /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum ImageRenderMode { /** * Render according to the original image, including colors. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Original, /** * Render the image as a template image, ignoring the color information of the image. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Template, } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum ImageInterpolation { /** * Do not use interpolated image data. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ None, /** * Low usage of interpolated image data. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Low, /** * Interpolated image data is used moderately. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Medium, /** * High usage of interpolated image data may affect the speed of image rendering. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ High, } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface ImageInterface { /** * Set src to obtain images. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (src: string | PixelMap | Resource): ImageAttribute; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class ImageAttribute extends CommonMethod { /** * Placeholder displayed on load - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ alt(value: string | Resource): ImageAttribute; /**match Text Direction - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ matchTextDirection(value: boolean): ImageAttribute; /** * Indicates whether the image follows the text direction. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fitOriginalSize(value: boolean): ImageAttribute; /** * fill Color - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fillColor(value: ResourceColor): ImageAttribute; /** * Sets the zoom type of an image. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ objectFit(value: ImageFit): ImageAttribute; /** * Set the repeat style of the picture - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ objectRepeat(value: ImageRepeat): ImageAttribute; /** * Set the auto style of the picture - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ autoResize(value: boolean): ImageAttribute; /** * Sets the image rendering mode. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ renderMode(value: ImageRenderMode): ImageAttribute; /** * Sets the interpolation effect of an image. The interpolation effect is only magnified for the image. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interpolation(value: ImageInterpolation): ImageAttribute; /** * Specifies the picture decoding size. * The original picture is decoded into a picture of a specified size. The unit of the number type is px. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ sourceSize(value: { width: number; height: number }): ImageAttribute; /** * Sets the synchronous or asynchronous mode for image loading. * The default parameter type is bool, and the default value is false. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ syncLoad(value: boolean): ImageAttribute; /** * This callback is triggered when an image is successfully loaded. * The size of the image source that is successfully loaded is returned, in pixels. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onComplete( callback: (event?: { @@ -159,24 +182,28 @@ declare class ImageAttribute extends CommonMethod { /** * This callback is triggered when an exception occurs during image loading. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onError(callback: (event?: { componentWidth: number; componentHeight: number }) => void): ImageAttribute; /** * When the loaded source file is a svg image, this callback is triggered when the playback of the svg image is complete. * If the svg image is a wireless loop image, this callback is not triggered. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onFinish(event: () => void): ImageAttribute; } /** * @devices phone, tablet, car - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare const Image: ImageInterface; /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare const ImageInstance: ImageAttribute; diff --git a/api/@internal/component/ets/image_animator.d.ts b/api/@internal/component/ets/image_animator.d.ts index c30d4db729..082241228b 100644 --- a/api/@internal/component/ets/image_animator.d.ts +++ b/api/@internal/component/ets/image_animator.d.ts @@ -14,24 +14,28 @@ */ /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface ImageAnimatorInterface { /** * ImageAimator is returned. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (): ImageAnimatorAttribute; } /** * inheritance CommonMethod - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class ImageAnimatorAttribute extends CommonMethod { /** * list images - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ images( value: Array<{ @@ -46,73 +50,85 @@ declare class ImageAnimatorAttribute extends CommonMethod void): ImageAnimatorAttribute; /** * Status callback, which is triggered when the animation pauses. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onPause(event: () => void): ImageAnimatorAttribute; /** * Status callback, triggered when the animation is replayed - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onRepeat(event: () => void): ImageAnimatorAttribute; /** * Status callback, which is triggered when the animation is canceled. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onCancel(event: () => void): ImageAnimatorAttribute; /** * Status callback, which is triggered when the animation playback is complete. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onFinish(event: () => void): ImageAnimatorAttribute; } diff --git a/api/@internal/component/ets/inspector.d.ts b/api/@internal/component/ets/inspector.d.ts index 0af83efaff..a8caf4c14f 100644 --- a/api/@internal/component/ets/inspector.d.ts +++ b/api/@internal/component/ets/inspector.d.ts @@ -15,7 +15,8 @@ /** * Get inspector node infos. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi * @deprecated */ @@ -23,7 +24,8 @@ declare function getInspectorNodes(): object; /** * Get inspector node info by node id. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi * @deprecated */ @@ -31,7 +33,8 @@ declare function getInspectorNodeById(id: number): object; /** * Get inspector info by key. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi * @test */ @@ -39,7 +42,8 @@ declare function getInspectorByKey(id: string): string; /** * Get inspector tree. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi * @test */ @@ -47,7 +51,8 @@ declare function getInspectorTree(): string; /** * Send event to inspector by key. Return false if no inspector with key is found. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi * @test */ @@ -55,7 +60,8 @@ declare function sendEventByKey(id: string, action: number, params: string): boo /** * Send touch event. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi * @test */ @@ -63,7 +69,8 @@ declare function sendTouchEvent(event: TouchObject): boolean; /** * Send key event. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi * @test */ @@ -71,7 +78,8 @@ declare function sendKeyEvent(event: KeyEvent): boolean; /** * Send mouse event. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi * @test */ @@ -79,7 +87,8 @@ declare function sendMouseEvent(event: MouseEvent): boolean; /** * Profiler tools for inspectors. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi * @test */ @@ -87,7 +96,8 @@ declare namespace Profiler { /** * Registers vsync callback for profiler. * @param callback the callback info is json string with ui update info. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi * @test */ @@ -95,7 +105,8 @@ declare namespace Profiler { /** * Unregisters vsync callback. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi * @test */ diff --git a/api/@internal/component/ets/lazyForEach.d.ts b/api/@internal/component/ets/lazyForEach.d.ts index 8498b93cb1..6e38932f1c 100644 --- a/api/@internal/component/ets/lazyForEach.d.ts +++ b/api/@internal/component/ets/lazyForEach.d.ts @@ -15,78 +15,91 @@ /** * Data Change Listener. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface DataChangeListener { /** * Data ready. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onDataReloaded(): void; /** * Data added. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onDataAdded(index: number): void; /** * Data moved. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onDataMoved(from: number, to: number): void; /** * Data deleted. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onDataDeleted(index: number): void; /** * Data changed. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onDataChanged(index: number): void; } /** * Data changed. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface IDataSource { /** * Total count. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ totalCount(): number; /** * get data. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ getData(index: number): any; /** * register Data Change Listener - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ registerDataChangeListener(listener: DataChangeListener): void; /** * unregister Data Change Listener - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ unregisterDataChangeListener(listener: DataChangeListener): void; } /** * Lazy loading. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface LazyForEachInterface { /** * Enter the value to obtain the LazyForEach. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ ( dataSource: IDataSource, @@ -96,6 +109,7 @@ interface LazyForEachInterface { } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare const LazyForEach: LazyForEachInterface; diff --git a/api/@internal/component/ets/line.d.ts b/api/@internal/component/ets/line.d.ts index 196d6ce173..005478ad8a 100644 --- a/api/@internal/component/ets/line.d.ts +++ b/api/@internal/component/ets/line.d.ts @@ -15,14 +15,16 @@ /** * Line drawing component. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface LineInterface { /** * Uses new to create the line. * width: Width of the rectangle where the line resides.. * height: Height of the rectangle where the line resides. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ new (value?: { width?: string | number; height?: string | number }): LineAttribute; @@ -30,25 +32,29 @@ interface LineInterface { * The return value of the parameter is Line. * width: Width of the rectangle where the line resides.. * height: Height of the rectangle where the line resides. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value?: { width?: string | number; height?: string | number }): LineAttribute; } /** * inheritance CommonShapeMethod. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class LineAttribute extends CommonShapeMethod { /** * Coordinate of the start point of the line (relative coordinate). - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ startPoint(value: Array): LineAttribute; /** * Line end coordinates (relative coordinates). - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ endPoint(value: Array): LineAttribute; } diff --git a/api/@internal/component/ets/list.d.ts b/api/@internal/component/ets/list.d.ts index ce515c78a0..f2d412e246 100644 --- a/api/@internal/component/ets/list.d.ts +++ b/api/@internal/component/ets/list.d.ts @@ -15,24 +15,28 @@ /** * Declare scroll status - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum ScrollState { /** * Not activated. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Idle, /** * Scrolling status. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Scroll, /** * Drag status. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Fling, } @@ -41,41 +45,48 @@ declare enum ScrollState { /** * The list interface is extended. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface ListInterface { /** * Called when interface data is called. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value?: { initialIndex?: number; space?: number | string; scroller?: Scroller }): ListAttribute; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class ListAttribute extends CommonMethod { /** * Called when the arrangement direction of the list component is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ listDirection(value: Axis): ListAttribute; /** * Called when the display mode of the side slider is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ scrollBar(value: BarState): ListAttribute; /** * Called when the sliding effect is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ edgeEffect(value: EdgeEffect): ListAttribute; /** * Called when the ListItem split line style is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ divider( value: { @@ -88,99 +99,115 @@ declare class ListAttribute extends CommonMethod { /** * Called when judging whether it is in editable mode. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ editMode(value: boolean): ListAttribute; /** * Called when the minimum number of list item caches is set for long list deferred loading. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ cachedCount(value: number): ListAttribute; /** * Called when setting whether to enable chain linkage dynamic effect. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ chainAnimation(value: boolean): ListAttribute; /** * Called when the offset and status callback of the slide are set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onScroll(event: (scrollOffset: number, scrollState: ScrollState) => void): ListAttribute; /** * Called when the start and end positions of the display change. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onScrollIndex(event: (start: number, end: number) => void): ListAttribute; /** * Called when the list begins to arrive. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onReachStart(event: () => void): ListAttribute; /** * Called when the list reaches the end. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onReachEnd(event: () => void): ListAttribute; /** * Called when the slider stops. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onScrollStop(event: () => void): ListAttribute; /** * Called when a list item is deleted. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onItemDelete(event: (index: number) => boolean): ListAttribute; /** * Called when a list item is moved. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onItemMove(event: (from: number, to: number) => boolean): ListAttribute; /** * After a listener is bound, the component can be dragged. After the drag occurs, a callback is triggered. * (To be triggered, press and hold for 170 milliseconds (ms)) - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onItemDragStart(event: (event: ItemDragInfo, itemIndex: number) => ((() => any) | void)): ListAttribute; /** * After binding, a callback is triggered when the component is dragged to the range of the component. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onItemDragEnter(event: (event: ItemDragInfo) => void): ListAttribute; /** * After binding, a callback is triggered when the drag moves within the range of a placeable component. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onItemDragMove(event: (event: ItemDragInfo, itemIndex: number, insertIndex: number) => void): ListAttribute; /** * After binding, a callback is triggered when the component is dragged out of the component range. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onItemDragLeave(event: (event: ItemDragInfo, itemIndex: number) => void): ListAttribute; /** * The component bound to this event can be used as the drag release target. * This callback is triggered when the drag behavior is stopped within the scope of the component. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onItemDrop(event: (event: ItemDragInfo, itemIndex: number, insertIndex: number, isSuccess: boolean) => void): ListAttribute; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare const List: ListInterface; declare const ListInstance: ListAttribute; diff --git a/api/@internal/component/ets/listItem.d.ts b/api/@internal/component/ets/listItem.d.ts index 2f639959ec..9930f196f6 100644 --- a/api/@internal/component/ets/listItem.d.ts +++ b/api/@internal/component/ets/listItem.d.ts @@ -16,24 +16,28 @@ /** * Declare item ceiling attribute. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum Sticky { /** * No sticky. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ None, /** * Normal mode - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Normal, /** * Set opacity. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Opacity, } @@ -41,63 +45,74 @@ declare enum Sticky { /** * Declare whether the ListItem element is editable. * @devices phone, tablet - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum EditMode { /** * Unrestricted operations. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ None, /** * Deleteable. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Deletable, /** * Movable. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Movable, } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ /** * Values in the list - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface ListItemInterface { /** * Called when an interface is used. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value?: string): ListItemAttribute; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class ListItemAttribute extends CommonMethod { /** * Called when setting whether item is ceiling effect. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ sticky(value: Sticky): ListItemAttribute; /** * Called when judging whether it is editable. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ editable(value: boolean | EditMode): ListItemAttribute; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare const ListItemInstance: ListItemAttribute; declare const ListItem: ListItemInterface; diff --git a/api/@internal/component/ets/loading_progress.d.ts b/api/@internal/component/ets/loading_progress.d.ts index 5bc3c49fd9..09fb948379 100644 --- a/api/@internal/component/ets/loading_progress.d.ts +++ b/api/@internal/component/ets/loading_progress.d.ts @@ -15,24 +15,28 @@ /** * Load style of progress bar. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum LoadingProgressStyle { /** * Default style. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Default, /** * Announcement style. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Circular, /** * The style of the track. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Orbital, } @@ -41,34 +45,40 @@ declare enum LoadingProgressStyle { /** * Provides an interface for extending the loading progress. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface LoadingProgressInterface { /** * Called when the progress bar progress is viewed. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ (): LoadingProgressAttribute; } /** * Declare the progress bar being loaded - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class LoadingProgressAttribute extends CommonMethod { /** * Load the color of the progress bar. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ color(value: ResourceColor): LoadingProgressAttribute; } /** - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare const LoadingProgress: LoadingProgressInterface; /** * Loading Progress Extensions on Declarative Classes - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare const LoadingProgressInstance: LoadingProgressAttribute \ No newline at end of file diff --git a/api/@internal/component/ets/marquee.d.ts b/api/@internal/component/ets/marquee.d.ts index ab55150c97..080f04d410 100644 --- a/api/@internal/component/ets/marquee.d.ts +++ b/api/@internal/component/ets/marquee.d.ts @@ -15,66 +15,77 @@ /** * Provides the interface for the marquee attributes. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface MarqueeInterface { /** * Create marquee. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ (value: { start: boolean; step?: number; loop?: number; fromStart?: boolean; src: string }): MarqueeAttribute; } /** * Declares marquee properties. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class MarqueeAttribute extends CommonMethod { /** * Set marquee font Color. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fontColor(value: ResourceColor): MarqueeAttribute; /** * Set marquee font size. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fontSize(value: Length): MarqueeAttribute; /** * Set marquee allow scale. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ allowScale(value: boolean): MarqueeAttribute; /** * Set marquee font weight. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fontWeight(value: number | FontWeight | string): MarqueeAttribute; /** * Set marquee font family. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fontFamily(value: string | Resource): MarqueeAttribute; /** * Called when scrolling starts. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onStart(event: () => void): MarqueeAttribute; /** * Called when scrolling to the bottom. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onBounce(event: () => void): MarqueeAttribute; /** * Called when scrolling is complete. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onFinish(event: () => void): MarqueeAttribute; } diff --git a/api/@internal/component/ets/matrix2d.d.ts b/api/@internal/component/ets/matrix2d.d.ts index 982eb954c0..a5e5ec220d 100644 --- a/api/@internal/component/ets/matrix2d.d.ts +++ b/api/@internal/component/ets/matrix2d.d.ts @@ -15,56 +15,65 @@ /** * 2D transformation matrix, supporting rotation, translation, and scaling of the X-axis and Y-axis - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class Matrix2D { /** * Horizontal Zoom - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ scaleX?: number; /** * Vertical Tilt - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ rotateY?: number; /** * Horizontal Tilt - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ rotateX?: number; /** * Vertical Zoom - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ scaleY?: number; /** * Horizontal movement - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ translateX?: number; /** * Vertical movement - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ translateY?: number; /** * Transforms the current 2D matrix back to the identity matrix (i.e., without any rotational * translation scaling effect) - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ identity(): Matrix2D; /** * Transform the current 2D matrix into an inverse matrix (that is, the transformation effect * is the opposite effect of the original) - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ invert(): Matrix2D; @@ -72,7 +81,8 @@ declare class Matrix2D { * The matrix is superimposed in right multiplication mode. When the input parameter is empty, * the matrix is superimposed. * @param other Matrix to be superimposed - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ multiply(other?: Matrix2D): Matrix2D; @@ -80,7 +90,8 @@ declare class Matrix2D { * Adds the rotation effect of the X and Y axes to the current matrix. * @param rx Rotation effect of the X axis * @param ry Rotation effect of the Y-axis - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ rotate(rx?: number, ry?: number): Matrix2D; @@ -88,7 +99,8 @@ declare class Matrix2D { * Adds the translation effect of the X and Y axes to the current matrix. * @param tx X-axis translation effect * @param ty Y-axis translation effect - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ translate(tx?: number, ty?: number): Matrix2D; @@ -96,13 +108,15 @@ declare class Matrix2D { * Adds the scaling effect of the X and Y axes to the current matrix. * @param sx X-axis scaling effect * @param sy Y-axis scaling effect - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ scale(sx?: number, sy?: number): Matrix2D; /** * Constructs a 2D change matrix object. The default value is the unit matrix. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(); } diff --git a/api/@internal/component/ets/navigation.d.ts b/api/@internal/component/ets/navigation.d.ts index 5130791878..12f70cf84b 100644 --- a/api/@internal/component/ets/navigation.d.ts +++ b/api/@internal/component/ets/navigation.d.ts @@ -15,24 +15,28 @@ /** * Naivagtion title mode. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum NavigationTitleMode { /** * The title is free mode. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Free = 0, /** * The title is full mode. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Full, /** * The title is mini mode. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Mini, } @@ -40,95 +44,111 @@ declare enum NavigationTitleMode { declare interface NavigationMenuItem { /** * The value of navigation menu item. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ value: string; /** * The icon of navigation menu item. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ icon?: string; /** * Trigger by navigation menu item click. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ action?: () => void; } /** * Provide navigator view interface - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface NavigationInterface { /** * Called when the navigator view interface is used. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ (): NavigationAttribute; } /** * Declare Navigation view properties. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class NavigationAttribute extends CommonMethod { /** * Navigation title - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ title(value: string | CustomBuilder): NavigationAttribute; /** * Navigation subtitle - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ subTitle(value: string): NavigationAttribute; /** * Hide navigation bar - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ hideTitleBar(value: boolean): NavigationAttribute; /** * Hide navigation back button - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ hideBackButton(value: boolean): NavigationAttribute; /** * Navigation title mode - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ titleMode(value: NavigationTitleMode): NavigationAttribute; /** * Navigation title bar's menus - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ menus(value: Array | CustomBuilder): NavigationAttribute; /** * The amount of the menu in Navigation. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ menuCount(value: number): NavigationAttribute; /** * Tool bar - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ toolBar(value: object | CustomBuilder): NavigationAttribute; /** * Hide tool bar - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ hideToolBar(value: boolean): NavigationAttribute; /** * Trigger a titleModeChanged event when title mode changed at free mode. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onTitleModeChanged(callback: (titleMode: NavigationTitleMode) => void): NavigationAttribute; } diff --git a/api/@internal/component/ets/navigator.d.ts b/api/@internal/component/ets/navigator.d.ts index 97046bdef4..2cb3a3b0be 100644 --- a/api/@internal/component/ets/navigator.d.ts +++ b/api/@internal/component/ets/navigator.d.ts @@ -15,72 +15,84 @@ /** * Route jump. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum NavigationType { /** * Jump to the next page. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Push, /** * Return to the previous page. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Back, /** * Replace page. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Replace, } /** * Create route - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface NavigatorInterface { /** * Called when the route jumps. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value?: { target: string; type?: NavigationType }): NavigatorAttribute; /** * Called when using the navigator. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (): NavigatorAttribute; } /** * Declare navigator properties. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class NavigatorAttribute extends CommonMethod { /** * Called when determining whether the routing component is active. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ active(value: boolean): NavigatorAttribute; /** * Called when determining whether the routing component is active. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ type(value: NavigationType): NavigatorAttribute; /** * Called when the path to the specified jump target page is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ target(value: string): NavigatorAttribute; /** * Called when data is passed to the target page at the same time during jump. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ params(value: object): NavigatorAttribute; } diff --git a/api/@internal/component/ets/pageTransition.d.ts b/api/@internal/component/ets/pageTransition.d.ts index 9a8b56d408..ae236c5b8d 100644 --- a/api/@internal/component/ets/pageTransition.d.ts +++ b/api/@internal/component/ets/pageTransition.d.ts @@ -15,123 +15,144 @@ /** * Declare the jump method. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum RouteType { /** * The page is not redirected. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ None, /** * Go to the next page. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Push, /** * Redirect to a specified page. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Pop, } /** * Declare the sliding effect of transition. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum SlideEffect { /** * Swipe left. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Left, /** * Swipe right. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Right, /** * Swipe top. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Top, /** * Swipe bottom. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Bottom, } /** * Provides interfaces for common transitions. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class CommonTransition { /** * Called when a transition method is required. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(); /** * Called when the slide in effect of the transition is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ slide(value: SlideEffect): T; /** * Called when the translation effect of page transition is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ translate(value: { x?: number | string; y?: number | string; z?: number | string }): T; /** * Called when setting the zoom effect of page transition. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ scale(value: { x?: number; y?: number; z?: number; centerX?: number | string; centerY?: number | string }): T; /** * Called when the transparency value of the starting point of entry or the ending point of exit is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ opacity(value: number): T; } /** * Provides an interface for page rotation mode. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface PageTransitionEnterInterface extends CommonTransition { /** * Called when page Jump animation is used. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value: { type?: RouteType; duration?: number; curve?: Curve | string; delay?: number }): PageTransitionEnterInterface; /** * Called when the incoming parameter is the normalized progress of the current incoming animation. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onEnter(event: (type?: RouteType, progress?: number) => void): PageTransitionEnterInterface; } /** * Provide an interface to exit the transition. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface PageTransitionExitInterface extends CommonTransition { /** * Called when the transition is delayed. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value: { type?: RouteType; duration?: number; curve?: Curve | string; delay?: number }): PageTransitionExitInterface; /** * Called when the input parameter is the normalized progress of the current exit animation. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onExit(event: (type?: RouteType, progress?: number) => void): PageTransitionExitInterface; } diff --git a/api/@internal/component/ets/panel.d.ts b/api/@internal/component/ets/panel.d.ts index 7b0dc56130..5d190ad452 100644 --- a/api/@internal/component/ets/panel.d.ts +++ b/api/@internal/component/ets/panel.d.ts @@ -15,133 +15,155 @@ /** * Sets the initial state of the slidable panel. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum PanelMode { /** * Minimum state. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Mini, /** * SHalf-screen-like status - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Half, /** * Class Full Screen Status. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Full, } /** * Sets the type of sliding panel. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum PanelType { /** * The switch between the minibar and full-screen display is provided. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Minibar, /** * Permanent content display class. * The switchover effect is provided in three sizes: large (full-screen), medium (half-screen), and small. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Foldable, /** * Temporary content display area. * The switchover effect is provided in three sizes: large (full-screen), medium (half-screen), and small. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Temporary, } /** * Provides a sliding panel interface. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface PanelInterface { /** * Called when the panel slidable panel pops up. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (show: boolean): PanelAttribute; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class PanelAttribute extends CommonMethod { /** * Called when the initial state of the slidable panel is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ mode(value: PanelMode): PanelAttribute; /** * Called when the slidable panel type is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ type(value: PanelType): PanelAttribute; /** * Called when determining whether dragbar exists. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ dragBar(value: boolean): PanelAttribute; /** * Called when the height in the full state is specified. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fullHeight(value: number | string): PanelAttribute; /** * Called when the height in the half state is specified. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ halfHeight(value: number | string): PanelAttribute; /** * Called when the height in the mini state is specified. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ miniHeight(value: number | string): PanelAttribute; /** * Called when the panel slidable panel pops up. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ show(value: boolean): PanelAttribute; /** * Called when the state of the slidable panel changes. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onChange( event: ( /** * Width of content area. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ width: number, /** * Height of content area. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ height: number, /** * Initial state. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ mode: PanelMode, ) => void, diff --git a/api/@internal/component/ets/path.d.ts b/api/@internal/component/ets/path.d.ts index 5544383edc..f41c45785b 100644 --- a/api/@internal/component/ets/path.d.ts +++ b/api/@internal/component/ets/path.d.ts @@ -15,29 +15,34 @@ /** * Provides the path drawing interface. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface PathInterface { /** * Use new to create Path. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ new (value?: { width?: number | string; height?: number | string; commands?: string }): PathAttribute; /** * Called when drawing path. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value?: { width?: number | string; height?: number | string; commands?: string }): PathAttribute; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class PathAttribute extends CommonShapeMethod { /** * Called when the command string drawn by the path is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ commands(value: string): PathAttribute; } diff --git a/api/@internal/component/ets/pattern_lock.d.ts b/api/@internal/component/ets/pattern_lock.d.ts index efc54d9d3b..656d165793 100644 --- a/api/@internal/component/ets/pattern_lock.d.ts +++ b/api/@internal/component/ets/pattern_lock.d.ts @@ -16,6 +16,7 @@ /** * Provides methods for control pattern lock component. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class PatternLockController { /** @@ -32,6 +33,7 @@ declare class PatternLockController { /** * Provides an interface for generating PatternLock. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface PatternLockInterface { (controller?: PatternLockController): PatternLockAttribute; @@ -39,65 +41,76 @@ interface PatternLockInterface { /** * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class PatternLockAttribute extends CommonMethod { /** * The square side length of pattern lock component. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ sideLength(value: Length): PatternLockAttribute; /** * Circle radius. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ circleRadius(value: Length): PatternLockAttribute; /** * The background color. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ backgroundColor(value: ResourceColor): PatternLockAttribute; /** * Regular color. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ regularColor(value: ResourceColor): PatternLockAttribute; /** * The color when cell is selected. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ selectedColor(value: ResourceColor): PatternLockAttribute; /** * The color when cell is active state. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ activeColor(value: ResourceColor): PatternLockAttribute; /** * The path line color. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ pathColor(value: ResourceColor): PatternLockAttribute; /** * The path line stroke width. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ pathStrokeWidth(value: number | string): PatternLockAttribute; /** * Called when the pattern input completed. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onPatternComplete(callback: (input: Array) => void): PatternLockAttribute; /** * Called when judging whether the input state can be reset by touch pattern lock. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ autoReset(value: boolean): PatternLockAttribute; } diff --git a/api/@internal/component/ets/piece.d.ts b/api/@internal/component/ets/piece.d.ts index 5e67176d8c..a38f521c48 100644 --- a/api/@internal/component/ets/piece.d.ts +++ b/api/@internal/component/ets/piece.d.ts @@ -16,77 +16,91 @@ /** * Sets the relative position of icons and text. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum IconPosition { /** * The icon is at the beginning of the text. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Start, /** * The icon is at the end of the text. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ End, } /** * Provides text and icons for setting block entries. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface PieceInterface { /** * Called when setting the position of a block entry. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ (options?: { content: string; icon?: string }): PieceAttribute; } /** - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class PieceAttribute extends CommonMethod { /** * Called when the relative position of the icon and the text is set. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ iconPosition(value: IconPosition): PieceAttribute; /** * Called when the value of Piece fontColor is set - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fontColor(value: ResourceColor): PieceAttribute; /** * Called when the value of Piece fontSize is set - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fontSize(value: Length): PieceAttribute; /** * Called when the value of Piece fontStyle is set - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fontStyle(value: FontStyle): PieceAttribute; /** * Called when the value of Piece fontWeight is set - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fontWeight(value: number | FontWeight | string): PieceAttribute; /** * Called when the value of Piece fontFamily is set - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fontFamily(value: ResourceStr): PieceAttribute; /** * Called when the value of Piece showDelete is set - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ showDelete(value: boolean): PieceAttribute; /** * Default icon is invisible, * Callback onClose function when icon is clicked - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onClose(callback: () => void): PieceAttribute; } diff --git a/api/@internal/component/ets/plugin_component.d.ts b/api/@internal/component/ets/plugin_component.d.ts index 9933928486..21bfb3b2bc 100644 --- a/api/@internal/component/ets/plugin_component.d.ts +++ b/api/@internal/component/ets/plugin_component.d.ts @@ -16,6 +16,7 @@ /** * PluginComponentTemplate * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface PluginComponentTemplate { source: string; @@ -25,34 +26,40 @@ interface PluginComponentTemplate { /** * Provides plugin component. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface PluginComponentInterface { /** * Called when setting the plugin. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ (value: { template: PluginComponentTemplate; data: any }): PluginComponentAttribute; } /** * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class PluginComponentAttribute extends CommonMethod { /** * Set pluginComponent size, * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ size(value: { width: number; height: number }): PluginComponentAttribute; /** * pluginComponent onComplete callback, * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onComplete(callback: () => void): PluginComponentAttribute; /** * pluginComponent onError callback, * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onError(callback: (info: { errcode: number; msg: string }) => void): PluginComponentAttribute; } diff --git a/api/@internal/component/ets/polygon.d.ts b/api/@internal/component/ets/polygon.d.ts index 9d8cdd14a9..a5cdef2024 100644 --- a/api/@internal/component/ets/polygon.d.ts +++ b/api/@internal/component/ets/polygon.d.ts @@ -15,18 +15,21 @@ /** * Provides the polygon drawing interface. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface PolygonInterface{ /** * Uses new to create Polygon. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ new (value?: { width?: string | number; height?: string | number }): PolygonAttribute; /** * Called when drawing a polygon. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value?: { width?: string | number; height?: string | number }): PolygonAttribute; } @@ -34,7 +37,8 @@ interface PolygonInterface{ declare class PolygonAttribute extends CommonShapeMethod { /** * Called when the vertex coordinate list of a polygon is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ points(value: Array): PolygonAttribute; } diff --git a/api/@internal/component/ets/polyline.d.ts b/api/@internal/component/ets/polyline.d.ts index 906b609f5b..b1db1eae67 100644 --- a/api/@internal/component/ets/polyline.d.ts +++ b/api/@internal/component/ets/polyline.d.ts @@ -15,29 +15,34 @@ /** * Provides an interface for drawing polylines. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface PolylineInterface { /** * Uses new to create Polyline. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ new (value?: { width?: string | number; height?: string | number }): PolylineAttribute; /** * Called when using the draw fold. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value?: { width?: string | number; height?: string | number }): PolylineAttribute; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class PolylineAttribute extends CommonShapeMethod { /** * Called when the polyline is set to pass through the coordinate point list. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ points(value: Array): PolylineAttribute; } diff --git a/api/@internal/component/ets/progress.d.ts b/api/@internal/component/ets/progress.d.ts index 80a73a7da0..f014ea6114 100644 --- a/api/@internal/component/ets/progress.d.ts +++ b/api/@internal/component/ets/progress.d.ts @@ -15,82 +15,95 @@ /** * Type of progress bar - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum ProgressStyle { /** * Linear progress bar style. * @devices phone, tablet, car. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Linear, /** * Ring progress bar. * @devices phone, tablet, car. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Ring, /** * Eclipse progress bar. * @devices phone, tablet, car. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Eclipse, /** * ScaleRing progress bar. * @devices phone, tablet, car. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ ScaleRing, /** * Capsule progress bar. * @devices phone, tablet, car. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Capsule, } /** * Provides the progress bar interface. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface ProgressInterface { /** * Called when the progress bar is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (object: { value: number; total?: number; style?: ProgressStyle }): ProgressAttribute; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class ProgressAttribute extends CommonMethod { /** * Called when the current progress value is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ value(value: number): ProgressAttribute; /** * Called when the progress bar foreground is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ color(value: ResourceColor): ProgressAttribute; /** * Called when the style of the circular progress bar is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ circularStyle(value: { strokeWidth?: Length; scaleCount?: number; scaleWidth?: Length }): ProgressAttribute; /** * Called when the style of the cricular progress bar is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard * @deprecated since 7 */ cricularStyle(value: { strokeWidth?: Length; scaleCount?: number; scaleWidth?: Length }): ProgressAttribute; diff --git a/api/@internal/component/ets/qrcode.d.ts b/api/@internal/component/ets/qrcode.d.ts index 61eefc5700..632ccbf1f0 100644 --- a/api/@internal/component/ets/qrcode.d.ts +++ b/api/@internal/component/ets/qrcode.d.ts @@ -15,29 +15,34 @@ /** * Provides an interface for generating QR codes. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface QRCodeInterface { /** * Called when a QR code is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value: string): QRCodeAttribute; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class QRCodeAttribute extends CommonMethod { /** * Called when the QR code color is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ color(value: ResourceColor): QRCodeAttribute; /** * Called when setting the QR code background color. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ backgroundColor(value: ResourceColor): QRCodeAttribute; } diff --git a/api/@internal/component/ets/radio.d.ts b/api/@internal/component/ets/radio.d.ts index d3d749404c..36b4cc3f51 100644 --- a/api/@internal/component/ets/radio.d.ts +++ b/api/@internal/component/ets/radio.d.ts @@ -16,20 +16,23 @@ /** * Input parameter for creating a radio box. * @devices phone, tablet, car - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface RadioOption { /** * Radio group name. * @devices phone, tablet, car - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ group: string; /** * Radio name. * @devices phone, tablet, car - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ value: string; } @@ -37,33 +40,38 @@ declare interface RadioOption { /** * Provides an interface for creating a radio box. * @devices phone, tablet, car - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface RadioInterface { /** * Called when a radio box is created. * @devices phone, tablet, car - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ (options: RadioOption): RadioAttribute; } /** * @devices phone, tablet, car - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class RadioAttribute extends CommonMethod { /** * Called when the radio box is selected. * @devices phone, tablet, car - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ checked(value: boolean): RadioAttribute; /** * Called when the radio box selection status changes. * @devices phone, tablet, car - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onChange(callback: (isChecked: boolean) => void): RadioAttribute; } diff --git a/api/@internal/component/ets/rating.d.ts b/api/@internal/component/ets/rating.d.ts index 09f6740ec7..e08b2ee40a 100644 --- a/api/@internal/component/ets/rating.d.ts +++ b/api/@internal/component/ets/rating.d.ts @@ -15,41 +15,48 @@ /** * Provides the interface for scoring bars. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface RatingInterface { /** * Called when a score bar is created. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (options?: { rating: number; indicator?: boolean }): RatingAttribute; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class RatingAttribute extends CommonMethod { /** * Called when the total number of stars is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ stars(value: number): RatingAttribute; /** * Called when the step size of the operation rating. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ stepSize(value: number): RatingAttribute; /** * Called when a picture is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ starStyle(value: { backgroundUri: string; foregroundUri: string; secondaryUri?: string }): RatingAttribute; /** * Called when the star rating of the operation scoring bar changes. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onChange(callback: (value: number) => void): RatingAttribute; } diff --git a/api/@internal/component/ets/rect.d.ts b/api/@internal/component/ets/rect.d.ts index 7ca9aa72fa..0b3e03f0b5 100644 --- a/api/@internal/component/ets/rect.d.ts +++ b/api/@internal/component/ets/rect.d.ts @@ -16,12 +16,14 @@ /** * Provides an interface for drawing rectangles. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface RectInterface { /** * Use new function to create Rect. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ new ( value?: @@ -40,7 +42,8 @@ interface RectInterface { /** * Called when a rectangle is created. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ ( value?: @@ -59,24 +62,28 @@ interface RectInterface { } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class RectAttribute extends CommonShapeMethod { /** * Called when the fillet width is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ radiusWidth(value: number | string): RectAttribute; /** * Called when the fillet height is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ radiusHeight(value: number | string): RectAttribute; /** * Called when the fillet size is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ radius(value: number | string | Array): RectAttribute; } diff --git a/api/@internal/component/ets/refresh.d.ts b/api/@internal/component/ets/refresh.d.ts index 648528bb7d..a3678862d4 100644 --- a/api/@internal/component/ets/refresh.d.ts +++ b/api/@internal/component/ets/refresh.d.ts @@ -15,65 +15,76 @@ /** * The refresh status of the drop-down refresh. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum RefreshStatus { /** * The refresh status of the drop-down refresh. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Inactive, /** * Drop down, but the drop-down distance is less than the refresh distance. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Drag, /** * The pull-down exceeds the refresh distance. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ OverDrag, /** * After the pull-down, it rebounds to the refresh distance and enters the refresh state. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Refresh, /** * After refresh, return to the initial state. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Done, } /** * Provides a pull-down refresh interface. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface RefreshInterface { /** * Called when the drop-down refresh is set. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ (value: { refreshing: boolean; offset?: number | string; friction?: number | string }): RefreshAttribute; } /** - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class RefreshAttribute extends CommonMethod { /** * Called when the refresh state changes. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onStateChange(callback: (state: RefreshStatus) => void): RefreshAttribute; /** * Called when the refresh state is entered. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onRefreshing(callback: () => void): RefreshAttribute; } diff --git a/api/@internal/component/ets/row.d.ts b/api/@internal/component/ets/row.d.ts index 6d723e4b8b..3698836757 100644 --- a/api/@internal/component/ets/row.d.ts +++ b/api/@internal/component/ets/row.d.ts @@ -15,29 +15,34 @@ /** * The components are laid out horizontally - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface RowInterface { /** * Called when the layout is set in the horizontal direction. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value?: { space?: string | number }): RowAttribute; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class RowAttribute extends CommonMethod { /** * Called when the vertical alignment is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ alignItems(value: VerticalAlign): RowAttribute; /** * Called when the horizontal alignment is set. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ justifyContent(value: FlexAlign): RowAttribute; } diff --git a/api/@internal/component/ets/row_split.d.ts b/api/@internal/component/ets/row_split.d.ts index 38049dc12d..684b8be8df 100644 --- a/api/@internal/component/ets/row_split.d.ts +++ b/api/@internal/component/ets/row_split.d.ts @@ -16,23 +16,27 @@ /** * Provides interfaces for layout in the vertical direction. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface RowSplitInterface { /** * Called when the layout along the vertical direction is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (): RowSplitAttribute; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class RowSplitAttribute extends CommonMethod { /** * Called when judging whether the split line can be dragged. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ resizeable(value: boolean): RowSplitAttribute; } diff --git a/api/@internal/component/ets/scroll.d.ts b/api/@internal/component/ets/scroll.d.ts index 7ea65ec436..0671580e1e 100644 --- a/api/@internal/component/ets/scroll.d.ts +++ b/api/@internal/component/ets/scroll.d.ts @@ -15,47 +15,55 @@ /** * Content scroll direction. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum ScrollDirection { /** * Vertical scrolling is supported. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Vertical, /** * Horizontal scrolling is supported. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Horizontal, /** * Free scrolling is supported. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Free, /** * Non-scrollable. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ None, } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class Scroller { /** * constructor. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(); /** * Called when the setting slides to the specified position. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ scrollTo(value: { xOffset: number | string; @@ -65,90 +73,105 @@ declare class Scroller { /** * Called when scrolling to the edge of the container. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ scrollEdge(value: Edge); /** * Called when page turning mode is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ scrollPage(value: { next: boolean; direction?: Axis }); /** * Called when viewing the scroll offset. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ currentOffset(); /** * Called when sliding to the specified index. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ scrollToIndex(value: number); } /** * Provides interfaces for scrollable containers. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface ScrollInterface { /** * Called when a scrollable container is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (scroller?: Scroller): ScrollAttribute; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class ScrollAttribute extends CommonMethod { /** * Called when the scroll method is slid. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ scrollable(value: ScrollDirection): ScrollAttribute; /** * Called when the setting slides to the specified position. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onScroll(event: (xOffset: number, yOffset: number) => void): ScrollAttribute; /** * Called when scrolling to the edge of the container. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onScrollEdge(event: (side: Edge) => void): ScrollAttribute; /** * Called when scrolling has stopped. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onScrollEnd(event: () => void): ScrollAttribute; /** * Called when the status of the scroll bar is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ scrollBar(barState: BarState): ScrollAttribute; /** * Called when the color of the scroll bar is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ scrollBarColor(color: Color | number | string): ScrollAttribute; /** * Called when the width of the scroll bar is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ scrollBarWidth(value: number | string): ScrollAttribute; /** * Called when the sliding effect is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ edgeEffect(edgeEffect: EdgeEffect): ScrollAttribute; } diff --git a/api/@internal/component/ets/scroll_bar.d.ts b/api/@internal/component/ets/scroll_bar.d.ts index 0a722fca39..c359203778 100644 --- a/api/@internal/component/ets/scroll_bar.d.ts +++ b/api/@internal/component/ets/scroll_bar.d.ts @@ -15,60 +15,70 @@ /** * Content scroll direction. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum ScrollBarDirection { /** * Vertical scrolling is supported. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Vertical, /** * Horizontal scrolling is supported. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Horizontal, } /** * Defines the option of ScrollBar. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface ScrollBarOption { /** * Sets the scroller of scroll bar. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ scroller: Scroller; /** * Sets the direction of scroll bar. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ direction?: ScrollBarDirection; /** * Sets the state of scroll bar. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ state?: BarState; } /** * Provides interfaces for scroll bar. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface ScrollBarInterface { /** * Called when a ScrollBar container is set. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ (value: ScrollBarOption): ScrollBarAttribute; } /** - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class ScrollBarAttribute extends CommonMethod {} declare const ScrollBar: ScrollBarInterface; diff --git a/api/@internal/component/ets/search.d.ts b/api/@internal/component/ets/search.d.ts index 7cb3ae0d5e..1b36cfdf10 100644 --- a/api/@internal/component/ets/search.d.ts +++ b/api/@internal/component/ets/search.d.ts @@ -15,24 +15,28 @@ /** * Provides the method of switching the cursor position. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class SearchController { /** * constructor. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(); /** * Called when the position of the insertion cursor is set. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ caretPosition(value: number): void; } /** * The construct function of search - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface SearchInterface { (options?: { value?: string; @@ -44,60 +48,70 @@ interface SearchInterface { /** * The attribute function of search - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class SearchAttribute extends CommonMethod { /** * Set the search button text - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ searchButton(value: string): SearchAttribute; /** * Set the place hold text color - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ placeholderColor(value: ResourceColor): SearchAttribute; /** * Set the font used for place holder text - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ placeholderFont(value?: Font): SearchAttribute; /** * Set the font used for input text - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ textFont(value?: Font): SearchAttribute; /** * Call the function when clicked the search button - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onSubmit(callback: (value: string) => void): SearchAttribute; /** * Call the function when editing the input text - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onChange(callback: (value: string) => void): SearchAttribute; /** * Called when using the Clipboard menu - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onCopy(callback: (value: string) => void): SearchAttribute; /** * Called when using the Clipboard menu - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onCut(callback: (value: string) => void): SearchAttribute; /** * Called when using the Clipboard menu - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onPaste(callback: (value: string) => void): SearchAttribute; } diff --git a/api/@internal/component/ets/select.d.ts b/api/@internal/component/ets/select.d.ts index 7c5190b8a9..f13e9c698d 100644 --- a/api/@internal/component/ets/select.d.ts +++ b/api/@internal/component/ets/select.d.ts @@ -16,17 +16,20 @@ /** * The declare of slectOption. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface SelectOption { /** * option string. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ value: ResourceStr; /** * option icon. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ icon?: ResourceStr; } @@ -34,11 +37,13 @@ declare interface SelectOption { /** * Provides the select interface. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface SelectInterface { /** * Called when the select is set. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ (options: Array): SelectAttribute; } @@ -46,71 +51,83 @@ interface SelectInterface { /** * The commonMethod of select. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class SelectAttribute extends CommonMethod { /** * Sets the serial number of the select item, starting from 0. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ selected(value: number): SelectAttribute; /** * Sets the text display of the select button itself. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ value(value: string): SelectAttribute; /** * Sets the text properties of the select button itself. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ font(value: Font): SelectAttribute; /** * Sets the text color of the select button itself. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fontColor(value: ResourceColor): SelectAttribute; /** * Sets the background color of the selected items in the select. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ selectedOptionBgColor(value: ResourceColor): SelectAttribute; /** * Sets the text style of the selected items in the select. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ selectedOptionFont(value: Font): SelectAttribute; /** * Sets the text color of the selected item in the select. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ selectedOptionFontColor(value: ResourceColor): SelectAttribute; /** * Sets the background color of the select item. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ optionBgColor(value: ResourceColor): SelectAttribute; /** * Sets the text style for select items. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ optionFont(value: Font): SelectAttribute; /** * Sets the text color for select items. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ optionFontColor(value: ResourceColor): SelectAttribute; /** * Callback for selecting an item from the select. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onSelected(event: (index: number) => void): SelectAttribute; } diff --git a/api/@internal/component/ets/shape.d.ts b/api/@internal/component/ets/shape.d.ts index eab2d6bff5..58ed9349d3 100644 --- a/api/@internal/component/ets/shape.d.ts +++ b/api/@internal/component/ets/shape.d.ts @@ -15,95 +15,111 @@ /** * Provides interfaces for drawing components. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface ShapeInterface { /** * Use the new function to create Shape. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ new (value?: PixelMap): ShapeAttribute; /** * Called when a component is drawn. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value?: PixelMap): ShapeAttribute; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class ShapeAttribute extends CommonMethod { /** * Viewport of shape - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ viewPort(value: { x?: number | string; y?: number | string; width?: number | string; height?: number | string }): ShapeAttribute; /** * Called when the border color is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ stroke(value: ResourceColor): ShapeAttribute; /** * Called when the fill color is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fill(value: ResourceColor): ShapeAttribute; /** * Called when the offset of the starting point of border drawing is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ strokeDashOffset(value: number | string): ShapeAttribute; /** * Called when the gap of the border is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ strokeDashArray(value: Array): ShapeAttribute; /** * Called when the path endpoint drawing style is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ strokeLineCap(value: LineCapStyle): ShapeAttribute; /** * Called when the border corner drawing style is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ strokeLineJoin(value: LineJoinStyle): ShapeAttribute; /** * Called when the limit value for drawing acute angles as oblique angles is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ strokeMiterLimit(value: number | string): ShapeAttribute; /** * Called when the opacity of the border is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ strokeOpacity(value: number | string | Resource): ShapeAttribute; /** * Called when the transparency of the border is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fillOpacity(value: number | string | Resource): ShapeAttribute; /** * Called when the width of the border is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ strokeWidth(value: number | string): ShapeAttribute; /** * Called when setting whether anti aliasing is on. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ antiAlias(value: boolean): ShapeAttribute; } diff --git a/api/@internal/component/ets/sheet.d.ts b/api/@internal/component/ets/sheet.d.ts index 59b190edb3..ecc22573de 100644 --- a/api/@internal/component/ets/sheet.d.ts +++ b/api/@internal/component/ets/sheet.d.ts @@ -16,11 +16,13 @@ /** * Provides the interface for the sheet attributes. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface SheetInterface { /** * Create sheet. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ (): SheetAttribute; } @@ -28,6 +30,7 @@ interface SheetInterface { /** * Declares sheet properties. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class SheetAttribute extends CommonMethod {} diff --git a/api/@internal/component/ets/slider.d.ts b/api/@internal/component/ets/slider.d.ts index ff35cd0559..de04167849 100644 --- a/api/@internal/component/ets/slider.d.ts +++ b/api/@internal/component/ets/slider.d.ts @@ -16,159 +16,185 @@ /** * Declare sliderstyle - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum SliderStyle { /** * The slider is on the slide rail. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ OutSet = 0, /** * The slider is in the slide rail. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ InSet, } /** * Declare SliderChangeMode - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum SliderChangeMode { /** * Start dragging the slider. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Begin = 0, /** * Drag the slider. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Moving, /** * End dragging the slider. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ End, } /** * Defines the option of Slider. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface SliderOption { /** * Current value of Slider. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ value?: number; /** * Sets the min value of Slider. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ min?: number; /** * Sets the max value of Slider. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ max?: number; /** * Sets the step of each slide value. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ step?: number; /** * Sets the slider style. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ style?: SliderStyle; /** * Sets the slider direction style. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ direction?: Axis; /** * Set whether the direction of the slider needs to be reversed. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ reverse?: boolean; } /** * Provides an interface for the slide bar component. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface SliderInterface { /** * Called when the slider bar component is used. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (options?: SliderOption): SliderAttribute; } /** * Defines the attribute functions of Slider. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class SliderAttribute extends CommonMethod { /** * Called when the slider color of the slider bar is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ blockColor(value: ResourceColor): SliderAttribute; /** * Called when the track color of the slider is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ trackColor(value: ResourceColor): SliderAttribute; /** * Called when the slider of the slider bar is set to slide over the area color. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ selectedColor(value: ResourceColor): SliderAttribute; /** * Called when the minimum label is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ minLabel(value: string): SliderAttribute; /** * Called when the maximum label is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ maxLabel(value: string): SliderAttribute; /** * Called when setting whether to display step size. * @devices phone, tablet, car - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ showSteps(value: boolean): SliderAttribute; /** * Called when the percentage of bubble prompt is set when sliding. * @devices phone, tablet, car - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ showTips(value: boolean): SliderAttribute; /** * Called when the selection value changes. * @devices phone, tablet, car - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onChange(callback: (value: number, mode: SliderChangeMode) => void): SliderAttribute; } diff --git a/api/@internal/component/ets/span.d.ts b/api/@internal/component/ets/span.d.ts index 0e5441eccf..e2f2a0295a 100644 --- a/api/@internal/component/ets/span.d.ts +++ b/api/@internal/component/ets/span.d.ts @@ -15,59 +15,69 @@ /** * Provide text decoration. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface SpanInterface { /** * Called when text is entered in span. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value: string | Resource): SpanAttribute; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class SpanAttribute extends CommonMethod { /** * Called when the font color is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fontColor(value: ResourceColor): SpanAttribute; /** * Called when the font size is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fontSize(value: number | string | Resource): SpanAttribute; /** * Called when the font style of a font is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fontStyle(value: FontStyle): SpanAttribute; /** * Called when the font weight is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fontWeight(value: number | FontWeight | string): SpanAttribute; /** * Called when the font list of text is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fontFamily(value: string | Resource): SpanAttribute; /** * Called when the text decoration of the text is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ decoration(value: { type: TextDecorationType; color?: ResourceColor }): SpanAttribute; /** * Called when the distance between text fonts is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ letterSpacing(value: number | string): SpanAttribute; diff --git a/api/@internal/component/ets/stack.d.ts b/api/@internal/component/ets/stack.d.ts index bc12bdacfd..d055c85ad8 100644 --- a/api/@internal/component/ets/stack.d.ts +++ b/api/@internal/component/ets/stack.d.ts @@ -15,23 +15,27 @@ /** * Provides ports for stacking containers. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface StackInterface { /** * Set the value. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value?: { alignContent?: Alignment }): StackAttribute; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class StackAttribute extends CommonMethod { /** * Called when the occupancy of items in the container is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ alignContent(value: Alignment): StackAttribute; } diff --git a/api/@internal/component/ets/stateManagement.d.ts b/api/@internal/component/ets/stateManagement.d.ts index 0fea7d5697..a6ad654311 100644 --- a/api/@internal/component/ets/stateManagement.d.ts +++ b/api/@internal/component/ets/stateManagement.d.ts @@ -15,62 +15,73 @@ /** * Provides an interface for attribute subscribers. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface IPropertySubscriber { /** * Called when the ID of the property subscriber is queried. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ id(): number; /** * Provides a single attribute change user interface. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ aboutToBeDeleted(owningView?: IPropertySubscriber): void; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface ISinglePropertyChangeSubscriber extends IPropertySubscriber { /** * Provides a single attribute change user interface. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ hasChanged(newValue: T): void; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare abstract class SubscribedAbstractProperty { /** * Setting Subscribers. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ protected subscribers_: Set; /** * Private user ID. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ private id_; /** * Private user information. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ private info_?; /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ constructor( /** * Subscriber Information. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ subscribeMe?: IPropertySubscriber, info?: string, @@ -78,259 +89,302 @@ declare abstract class SubscribedAbstractProperty { /** * Called when the subscriber ID is entered. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ id(): number; /** * Called when a subscriber information description is entered. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ info(): string; /** * Called when data is obtained. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ abstract get(): T; /** * Called when data is created. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ abstract set(newValue: T): void; /** * Called when a two-way synchronization is created. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ createTwoWaySync(subscribeMe?: IPropertySubscriber, info?: string): SyncedPropertyTwoWay; /** * Called when a one-way synchronization is created. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ createOneWaySync(subscribeMe?: IPropertySubscriber, info?: string): SyncedPropertyOneWay; /** * Called when the subscriber is unlinked. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ unlinkSuscriber(subscriberId: number): void; /** * Called when the notification has changed. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ protected notifyHasChanged(newValue: T): void; /** * Called when the notification property is read. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ protected notifyPropertyRead(): void; /** * Called when the number of users is queried. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ numberOfSubscrbers(): number; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class SyncedPropertyTwoWay extends SubscribedAbstractProperty implements ISinglePropertyChangeSubscriber { /** * Sources of synchronization attributes bidirectionally. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ private source_; /** * constructor parameters. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(source: SubscribedAbstractProperty, subscribeMe?: IPropertySubscriber, info?: string); /** * Called when processing information about to be deleted. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ aboutToBeDeleted(unsubscribeMe?: IPropertySubscriber): void; /** * Information Changed. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ hasChanged(newValue: T): void; /** * Called when data is obtained. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ get(): T; /** * Called when data is created. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ set(newValue: T): void; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class SyncedPropertyOneWay extends SubscribedAbstractProperty implements ISinglePropertyChangeSubscriber { /** * Pack value for single-item binding. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ private wrappedValue_; /** * Sources of synchronization attributes bidirectionally. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ private source_; /** * Constructor parameters. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(source: SubscribedAbstractProperty, subscribeMe?: IPropertySubscriber, info?: string); /** * Called when processing information about to be deleted. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ aboutToBeDeleted(unsubscribeMe?: IPropertySubscriber): void; /** * Information Changed. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ hasChanged(newValue: T): void; /** * Called when data is obtained. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ get(): T; /** * Called when data is created. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ set(newValue: T): void; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class AppStorage { /** * Called when a link is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ static Link(propName: string): any; /** * Called when a hyperlink is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ static SetAndLink(propName: string, defaultValue: T): SubscribedAbstractProperty; /** * Called when a property is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ static Prop(propName: string): any; /** * Called when dynamic properties are set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ static SetAndProp(propName: string, defaultValue: S): SubscribedAbstractProperty; /** * Called when owning or not. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ static Has(propName: string): boolean; /** * Called when data is obtained. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ static Get(propName: string): T | undefined; /** * Called when setting. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ static Set(propName: string, newValue: T): boolean; /** * Called when setting or creating. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ static SetOrCreate(propName: string, newValue: T): void; /** * Called when a deletion is made. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ static Delete(propName: string): boolean; /** * Called when a dictionary is sorted. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ static Keys(): IterableIterator; /** * Called when a cleanup occurs. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ static staticClear(): boolean; /** * Called when the data can be changed. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ static IsMutable(propName: string): boolean; /** * Called when you check how much data is stored. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ static Size(): number; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class Environment { /** * Constructor. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(); /** * Called when a property value is checked. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ static EnvProp(key: string, value: S): boolean; /** * Called when multiple property values are checked. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ static EnvProps( props: { @@ -341,76 +395,89 @@ declare class Environment { /** * Set the key value. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ static Keys(): Array; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum ColorMode { /** * Bright color. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ LIGHT = 0, /** * Dark. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ DARK, } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum LayoutDirection { /** * Elements are laid out from left to right. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ LTR = 0, /** * Elements are laid out from right to left. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ RTL, /** * Elements are laid out from auto. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Auto } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class PersistentStorage { /** * Constructor parameters. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(appStorage: AppStorage, storage: Storage); /** * Called when a persistence property is stored. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ static PersistProp(key: string, defaultValue: T): void; /** * Called when a property is deleted. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ static DeleteProp(key: string): void; /** * Called when multiple persistence properties are stored. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ static PersistProps( properties: { @@ -421,171 +488,200 @@ declare class PersistentStorage { /** * Set the key value. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ static Keys(): Array; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class Storage { /** * Constructor parameters. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(needCrossThread?: boolean, file?: string); /** * Called when data is obtained. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ get(key: string): string | undefined; /** * Called when setting. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ set(key: string, val: any): void; /** * Called when data is cleared. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ clear(): void; /** * Called when data is deleted. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ delete(key: string): void; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare abstract class SubscribaleAbstract { /** * Returns the ownership attribute set by the. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ private owningProperties_: Set; /** * Constructor. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(); /** * Called when the notification property has changed. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ protected notifyPropertyHasChanged(propName: string, newValue: any): void; /** * Called when adding an already owned property. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ public addOwningProperty(subscriber: IPropertySubscriber): void; /** * Called when an already owned property is deleted. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ public removeOwningProperty(property: IPropertySubscriber): void; /** * Called when an already owned property is deleted by ID - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ public removeOwningPropertyById(subscriberId: number): void; } /** - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class ContentStorage { /** * Called when a link is set. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ link(propName: string): any; /** * Called when a hyperlink is set. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ setAndLink(propName: string, defaultValue: T): SubscribedAbstractProperty; /** * Called when a property is set. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ prop(propName: string): any; /** * Called when dynamic properties are set. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ setAndProp(propName: string, defaultValue: S): SubscribedAbstractProperty; /** * Called when owning or not. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ has(propName: string): boolean; /** * Called when data is obtained. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ get(propName: string): T | undefined; /** * Called when setting. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ set(propName: string, newValue: T): boolean; /** * Called when setting or creating. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ setOrCreate(propName: string, newValue: T): void; /** * Called when a deletion is made. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ delete(propName: string): boolean; /** * Called when a dictionary is sorted. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ keys(): IterableIterator; /** * Called when a cleanup occurs. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ clear(): boolean; /** * Called when the data can be changed. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ isMutable(propName: string): boolean; /** * Called when you check how much data is stored. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ size(): number; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare const appStorage: AppStorage; diff --git a/api/@internal/component/ets/stepper.d.ts b/api/@internal/component/ets/stepper.d.ts index 7133867859..5f2dd0d848 100644 --- a/api/@internal/component/ets/stepper.d.ts +++ b/api/@internal/component/ets/stepper.d.ts @@ -16,54 +16,62 @@ /** * Declare the stepper. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface StepperInterface { /** * Called when the stepper component is used. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ (value?: { index?: number }): StepperAttribute; } /** * Defines the stepper attribute functions - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class StepperAttribute extends CommonMethod { /** * Callback when the finish label is clicked. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onFinish(callback: () => void): StepperAttribute; /** * Callback when the skip label is clicked. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onSkip(callback: () => void): StepperAttribute; /** * Callback when the change label is clicked. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onChange(callback: (prevIndex?: number, index?: number) => void): StepperAttribute; /** * Callback when the next label is clicked. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onNext(callback: (index?: number, pendingIndex?: number) => void): StepperAttribute; /** * Callback when the previous label is clicked. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onPrevious(callback: (index?: number, pendingIndex?: number) => void): StepperAttribute; } diff --git a/api/@internal/component/ets/stepperItem.d.ts b/api/@internal/component/ets/stepperItem.d.ts index 042417cf4c..322c8f5eb6 100644 --- a/api/@internal/component/ets/stepperItem.d.ts +++ b/api/@internal/component/ets/stepperItem.d.ts @@ -16,34 +16,39 @@ /** * ItemState * @devices phone, tablet, car - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum ItemState { /** * Default State * @devices phone, tablet, car - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Normal, /** * Disabled State * @devices phone, tablet, car - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Disabled, /** * Waiting State * @devices phone, tablet, car - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Waiting, /** * Skip State * @devices phone, tablet, car - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Skip, } @@ -51,52 +56,60 @@ declare enum ItemState { /** * Provides an interface for switching the stepperItem view on stepper container. * @devices phone, tablet, car - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface StepperItemInterface { /** * Called when the stepperItem component is used. * @devices phone, tablet, car - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ (): StepperItemAttribute; } /** * @devices phone, tablet, car - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class StepperItemAttribute extends CommonMethod { /** * Called when the value of stepperItem prevLabel is set * @devices phone, tablet, car - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ prevLabel(value: string): StepperItemAttribute; /** * Called when the value of stepperItem nextLabel is set * @devices phone, tablet, car - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ nextLabel(value: string): StepperItemAttribute; /** * Called when the value of stepperItem status is set * @devices phone, tablet, car - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ status(value?: ItemState): StepperItemAttribute; } /** * @devices phone, tablet, car - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare const StepperItemInstance: StepperItemAttribute; /** * @devices phone, tablet, car - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare const StepperItem: StepperItemInterface; diff --git a/api/@internal/component/ets/swiper.d.ts b/api/@internal/component/ets/swiper.d.ts index 77d8b0e6cc..b8892d9aa9 100644 --- a/api/@internal/component/ets/swiper.d.ts +++ b/api/@internal/component/ets/swiper.d.ts @@ -16,29 +16,34 @@ /** * Provides methods for switching components. * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class SwiperController { /** * constructor. * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(); /** * Called when the next child component is displayed. * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ showNext(); /** * Called when the previous subcomponent is displayed. * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ showPrevious(); /** * Called when need to stop the swiper animation. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ finishAnimation(callback?: () => void); } @@ -46,17 +51,20 @@ declare class SwiperController { /** * Declare the size of the swiper on the spindle. * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum SwiperDisplayMode { /** * Carousel map extension. * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Stretch, /** * The rotation chart is self linear. * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ AutoLinear, } @@ -64,100 +72,117 @@ declare enum SwiperDisplayMode { /** * Provides an interface for sliding containers. * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface SwiperInterface { /** * Called when a sliding container is set. * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (controller?: SwiperController): SwiperAttribute; } /** * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class SwiperAttribute extends CommonMethod { /** * Called when the index value of the displayed subcomponent is set in the container. * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ index(value: number): SwiperAttribute; /** * Called when setting whether the subcomponent plays automatically. * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ autoPlay(value: boolean): SwiperAttribute; /** * Called when the time interval for automatic playback is set. * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interval(value: number): SwiperAttribute; /** * Called when you set whether the navigation point indicator is enabled. * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ indicator(value: boolean): SwiperAttribute; /** * Called when setting whether to turn on cyclic sliding. * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ loop(value: boolean): SwiperAttribute; /** * Called when the animation duration of the switch is set. * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ duration(value: number): SwiperAttribute; /** * Called when setting whether to slide vertically. * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ vertical(value: boolean): SwiperAttribute; /** * Called when the size of the rotation chart is set. * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ itemSpace(value: number | string): SwiperAttribute; /** * Called when setting the size of the swiper container on the spindle. * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ displayMode(value: SwiperDisplayMode): SwiperAttribute; /** * Called when setting the cached count of the swiper container one side. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ cachedCount(value: number): SwiperAttribute; /** * This command is invoked when the number of subcomponents is set. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ displayCount(value: number | string): SwiperAttribute; /** * Invoked when setting the sliding effect * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ effectMode(value: EdgeEffect): SwiperAttribute; /** * Called when sliding is disableSwipe * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ disableSwipe(value: boolean): SwiperAttribute; /** * Called when the index value changes. * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onChange(event: (index: number) => void): SwiperAttribute; } diff --git a/api/@internal/component/ets/tab_content.d.ts b/api/@internal/component/ets/tab_content.d.ts index ca258bdfd0..4b6201a2ad 100644 --- a/api/@internal/component/ets/tab_content.d.ts +++ b/api/@internal/component/ets/tab_content.d.ts @@ -15,24 +15,28 @@ /** * Provides an interface for switching the content view on a tab page. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface TabContentInterface { /** * Called when the content view of the switch tab is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (): TabContentAttribute; } /** * Defines the attribute functions of TabContent. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class TabContentAttribute extends CommonMethod { /** * Called when tabbar is entered. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ tabBar(value: string | Resource | CustomBuilder | { icon?: string | Resource; text?: string | Resource }): TabContentAttribute; diff --git a/api/@internal/component/ets/tabs.d.ts b/api/@internal/component/ets/tabs.d.ts index 419672c3d5..69f0f0679f 100644 --- a/api/@internal/component/ets/tabs.d.ts +++ b/api/@internal/component/ets/tabs.d.ts @@ -15,112 +15,131 @@ /** * Declare the graphic format of the bar chart. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum BarMode { /** * The actual layout width of the TabBar is used. If the width exceeds the total width, you can slide the tabbar. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Scrollable, /** * The width of all TabBars is evenly allocated. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Fixed, } /** * Declare the location of the bar chart. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum BarPosition { /** * When the vertical attribute method is set to true, the tab is on the left of the container. When the vertical property method is set to false, the tab is at the top of the container. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Start, /** * When the vertical attribute method is set to true, the tab is located on the right of the container. When the vertical property method is set to false, the tab is at the bottom of the container. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ End, } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class TabsController { /** * constructor. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(); /** * Called when the tab is switched. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ changeIndex(value: number): void; } /** * Provides an interface for switching views. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface TabsInterface { /** * Called when the view is switched. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value?: { barPosition?: BarPosition; index?: number; controller?: TabsController }): TabsAttribute; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class TabsAttribute extends CommonMethod { /** * Called when determining whether the tab is vertical. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ vertical(value: boolean): TabsAttribute; /** * Called when judging whether page switching can be performed by sliding left and right. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ scrollable(value: boolean): TabsAttribute; /** * Called when the graphic format of the bar chart is selected. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ barMode(value: BarMode): TabsAttribute; /** * Called when the width of the bar graph is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ barWidth(value: number): TabsAttribute; /** * Called when the height of the bar graph is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ barHeight(value: number): TabsAttribute; /** * Called when the animation duration of the bar graph is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ animationDuration(value: number): TabsAttribute; /** * Called when the tab is switched. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onChange(event: (index: number) => void): TabsAttribute; } diff --git a/api/@internal/component/ets/text.d.ts b/api/@internal/component/ets/text.d.ts index cdd575d2eb..54eebf45fb 100644 --- a/api/@internal/component/ets/text.d.ts +++ b/api/@internal/component/ets/text.d.ts @@ -16,116 +16,136 @@ /** * Provides an interface for writing texts. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface TextInterface { /** * Called when writing text. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (content?: string | Resource): TextAttribute; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class TextAttribute extends CommonMethod { /** * Called when the font color is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fontColor(value: ResourceColor): TextAttribute; /** * Called when the font size is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fontSize(value: number | string | Resource): TextAttribute; /** * Called when the minimum font size of the font is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ minFontSize(value: number | string | Resource): TextAttribute; /** * Called when the maximum font size of the font is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ maxFontSize(value: number | string | Resource): TextAttribute; /** * Called when the font style of a font is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fontStyle(value: FontStyle): TextAttribute; /** * Called when the font weight is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fontWeight(value: number | FontWeight | string): TextAttribute; /** * Called when the horizontal center mode of the font is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ textAlign(value: TextAlign): TextAttribute; /** * Called when the vertical center mode of the font is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ lineHeight(value: number | string | Resource): TextAttribute; /** * Called when the overflow mode of the font is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ textOverflow(value: { overflow: TextOverflow }): TextAttribute; /** * Called when the font list of text is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fontFamily(value: string | Resource): TextAttribute; /** * Called when the maximum number of lines of text is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ maxLines(value: number): TextAttribute; /** * Called when the text decoration of the text is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ decoration(value: { type: TextDecorationType; color?: ResourceColor }): TextAttribute; /** * Called when the distance between text fonts is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ letterSpacing(value: number | string): TextAttribute; /** * Called when the type of letter in the text font is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ textCase(value: TextCase): TextAttribute; /** * Called when the baseline offset is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ baselineOffset(value: number | string): TextAttribute; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare const TextInstance: TextAttribute; /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare const Text: TextInterface; \ No newline at end of file diff --git a/api/@internal/component/ets/text_area.d.ts b/api/@internal/component/ets/text_area.d.ts index 0bd8669c82..cae2882c16 100644 --- a/api/@internal/component/ets/text_area.d.ts +++ b/api/@internal/component/ets/text_area.d.ts @@ -16,144 +16,168 @@ /** * Provides the method of switching the cursor position. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class TextAreaController { /** * constructor. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(); /** * Called when the position of the insertion cursor is set. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ caretPosition(value: number): void; } /** * Defines the option of TextArea. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface TextAreaOption { /** * The place holder text string. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ placeholder?: ResourceStr; /** * Sets the current value of TextArea. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ text?: ResourceStr; /** * Called when the position of the insertion cursor is set. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ controller?: TextAreaController; } /** * Provides an interface for the multi-line text input component. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface TextAreaInterface { /** * Called when writing multiple lines of text. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value?: TextAreaOption): TextAreaAttribute; } /** * Defines the attribute functions of TextArea. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class TextAreaAttribute extends CommonMethod { /** * Called when the color of the placeholder is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ placeholderColor(value: ResourceColor): TextAreaAttribute; /** * Called when the font property of the placeholder is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ placeholderFont(value: Font): TextAreaAttribute; /** * Called when the alignment of the contents of a multiline text box is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ textAlign(value: TextAlign): TextAreaAttribute; /** * Called when the insertion cursor color is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ caretColor(value: ResourceColor): TextAreaAttribute; /** * Called when the font color is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fontColor(value: ResourceColor): TextAreaAttribute; /** * Called when the font size is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fontSize(value: Length): TextAreaAttribute; /** * Called when the font style of a font is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fontStyle(value: FontStyle): TextAreaAttribute; /** * Called when the font weight is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fontWeight(value: number | FontWeight | string): TextAreaAttribute; /** * Called when the font list of text is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fontFamily(value: ResourceStr): TextAreaAttribute; /** * Called when the inputFilter of text is set. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ inputFilter(value: ResourceStr, error?: (value: string) => void): TextAreaAttribute; /** * Called when the input changes. * @devices phone, tablet, car. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onChange(callback: (value: string) => void): TextAreaAttribute; /** * Called when using the Clipboard menu - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onCopy(callback: (value: string) => void): TextAreaAttribute; /** * Called when using the Clipboard menu - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onCut(callback: (value: string) => void): TextAreaAttribute; /** * Called when using the Clipboard menu - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onPaste(callback: (value: string) => void): TextAreaAttribute; } diff --git a/api/@internal/component/ets/text_clock.d.ts b/api/@internal/component/ets/text_clock.d.ts index d33396e621..9858bf401b 100644 --- a/api/@internal/component/ets/text_clock.d.ts +++ b/api/@internal/component/ets/text_clock.d.ts @@ -15,7 +15,8 @@ /** * TextClock component, which provides the text clock capability. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface TextClockInterface { /** @@ -23,7 +24,8 @@ interface TextClockInterface { * Specifies the current time zone. * The valid value is an integer ranging from - 12 to 12, * Where a negative value indicates the eastern time zone, for example, -8. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ (options?: {hourswest?: number}): TextClockAttribute; } @@ -34,7 +36,8 @@ declare class TextClockAttribute extends CommonMethod { * support time format：yyyy,mm,mmm(English month abbreviation),mmmm(Full name of the month in English), * dd,ddd(English Week abbreviation),dddd(Full name of the week in English), * HH/hh(24-hour clock/12-hour clock),MM/mm(minute),SS/ss(second) - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ format(value: string): TextClockAttribute; /** @@ -42,7 +45,8 @@ declare class TextClockAttribute extends CommonMethod { * when the value is true, the time of the current custom style is displayed. * the time is recalled every second. * if the value is false, the clock stops updating the time and stops updating the callback. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ status(value: boolean): TextClockAttribute; /** @@ -53,32 +57,38 @@ declare class TextClockAttribute extends CommonMethod { * You can listen to this callback, * Use the format attribute method to customize data display in the callback. * @param event Listening date event callback. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onDateChange(event: (value: number) => void): TextClockAttribute; /** * Called when the value of TextClock fontColor is set - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fontColor(value: ResourceColor): TextClockAttribute; /** * Called when the value of TextClock fontSize is set - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fontSize(value: Length): TextClockAttribute; /** * Called when the value of TextClock fontStyle is set - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fontStyle(value: FontStyle): TextClockAttribute; /** * Called when the value of TextClock fontWeight is set - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fontWeight(value: number | FontWeight | string): TextClockAttribute; /** * Called when the value of TextClock fontFamily is set - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fontFamily(value: ResourceStr): TextClockAttribute; } diff --git a/api/@internal/component/ets/text_input.d.ts b/api/@internal/component/ets/text_input.d.ts index 3e3a01c970..0a0624a7bc 100644 --- a/api/@internal/component/ets/text_input.d.ts +++ b/api/@internal/component/ets/text_input.d.ts @@ -16,232 +16,271 @@ /** * Declare the type of input box - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum InputType { /** * Basic input mode. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Normal, /** * Password entry mode. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Number, /** * E-mail address input mode. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Email, /** * Pure digital input mode. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Password, } /** * Declare the type of soft keyboard. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum EnterKeyType { /** * Go. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Go, /** * Search. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Search, /** * Send. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Send, /** * Next. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Next, /** * Done. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ Done, } /** * Provides the method of switching the cursor position. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class TextInputController { /** * constructor. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(); /** * Called when the position of the insertion cursor is set. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ caretPosition(value: number): void; } /** * Defines the option of TextInput. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface TextInputOption { /** * The place holder text string. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ placeholder?: ResourceStr; /** * Sets the current value of TextArea. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ text?: ResourceStr; /** * Called when the position of the insertion cursor is set. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ controller?: TextInputController; } /** * Provides a single-line text input component interface. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface TextInputInterface { /** * Called when writing a single line of text. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value?: TextInputOption): TextInputAttribute; } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class TextInputAttribute extends CommonMethod { /** * Called when the input type is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ type(value: InputType): TextInputAttribute; /** * Called when the color of the placeholder is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ placeholderColor(value: ResourceColor): TextInputAttribute; /** * Called when the font property of the placeholder is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ placeholderFont(value?: Font): TextInputAttribute; /** * Called when the type of soft keyboard input button is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ enterKeyType(value: EnterKeyType): TextInputAttribute; /** * Called when the color of the insertion cursor is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ caretColor(value: ResourceColor): TextInputAttribute; /** * Called when judging whether the text editing has changed. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onEditChanged(callback: (isEditing: boolean) => void): TextInputAttribute; /** * Called when submitted. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onSubmit(callback: (enterKey: EnterKeyType) => void): TextInputAttribute; /** * Called when the input of the input box changes. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onChange(callback: (value: string) => void): TextInputAttribute; /** * Called when the input of maximum text length is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ maxLength(value: number): TextInputAttribute; /** * Called when the font color is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fontColor(value: ResourceColor): TextInputAttribute; /** * Called when the font size is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fontSize(value: Length): TextInputAttribute; /** * Called when the font style of a font is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fontStyle(value: FontStyle): TextInputAttribute; /** * Called when the font weight is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fontWeight(value: number | FontWeight | string): TextInputAttribute; /** * Called when the font list of text is set. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ fontFamily(value: ResourceStr): TextInputAttribute; /** * Called when the inputFilter of text is set. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ inputFilter(value: ResourceStr, error?: (value: string) => void): TextInputAttribute; /** * Called when using the Clipboard menu - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onCopy(callback: (value: string) => void): TextInputAttribute; /** * Called when using the Clipboard menu - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onCut(callback: (value: string) => void): TextInputAttribute; /** * Called when using the Clipboard menu - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onPaste(callback: (value: string) => void): TextInputAttribute; } diff --git a/api/@internal/component/ets/text_picker.d.ts b/api/@internal/component/ets/text_picker.d.ts index a861dd7a7e..0e7ef62b86 100644 --- a/api/@internal/component/ets/text_picker.d.ts +++ b/api/@internal/component/ets/text_picker.d.ts @@ -15,7 +15,8 @@ /** * Defines the option of TextPicker. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface TextPickerOption { /** @@ -33,106 +34,125 @@ declare interface TextPickerOption { } /** - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface TextPickerInterface { /** * Defines the TextPicker constructor. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ (options?: TextPickerOption): TextPickerAttribute; } /** * Style the text selector. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class TextPickerAttribute extends CommonMethod { /** * Called when the default height of the selected element is set. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ defaultPickerItemHeight(value: number | string): TextPickerAttribute; /** * Called when the pop-up value is returned. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onAccept(callback: (value: string, index: number) => void): TextPickerAttribute; /** * Called when the Cancel button in the pop-up window is clicked. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onCancel(callback: () => void): TextPickerAttribute; /** * Called when the OK button in the pop-up window is clicked. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onChange(callback: (value: string, index: number) => void): TextPickerAttribute; } /** * Defines the TextPickerDialogOption for Text Picker Dialog. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface TextPickerDialogOption extends TextPickerOption { /** * Called when the default height of the selected element is set. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ defaultPickerItemHeight?: number | string; } /** * Defines the event callback status in the pop-up window state. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum TextPickerDialogStatus { /** * Triggered when a user clicks the OK button. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Accept, /** * Triggered when a user taps the Cancel button. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Cancel, /** * Triggered when a user performs scrolling selection. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Update, } /** * Defines the TextPickerDialogResult for TextPickerDialog. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface TextPickerDialogResult { /** * The currently selected value. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ value: string; /** * The subscript of the current selection. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ index: number; /** * Operation status of the current user. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ status: TextPickerDialogStatus; } /** * Defines TextPickerDialog which uses show method to show TextPicker dialog. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class TextPickerDialog { /** * Invoking method display. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ static show(options?: TextPickerDialogOption, callback?: (value: TextPickerDialogResult) => void); } diff --git a/api/@internal/component/ets/text_timer.d.ts b/api/@internal/component/ets/text_timer.d.ts index 3001ddf1ee..1cdf4d7090 100644 --- a/api/@internal/component/ets/text_timer.d.ts +++ b/api/@internal/component/ets/text_timer.d.ts @@ -16,29 +16,34 @@ /** * Provides a way to control the process. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class TextTimerController { /** * constructor. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(); /** * Provides a start event for timer. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ start(); /** * Provides a pause event for timer. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ pause(); /** * Provides an event to reset timer. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ reset(); } @@ -46,11 +51,13 @@ declare class TextTimerController { /** * Defines the option of TextTimer. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface TextTimerOption { /** * Sets whether to countdown.The default value is false. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ isCountDown?: boolean; /** @@ -58,12 +65,14 @@ interface TextTimerOption { * In the non-countDown scenario, a negative value indicates that the timer is not limited. * The unit is millisecond. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ count?: number; /** * Controller of Texttimer. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ controller?: TextTimerController; } @@ -71,11 +80,13 @@ interface TextTimerOption { /** * Provides an interface for texttimer containers. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface TextTimerInterface { /** * Defines the TextTimer constructor. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ (options?: TextTimerOption): TextTimerAttribute; } @@ -83,42 +94,50 @@ interface TextTimerInterface { /** * Defines the TextTimer attribute functions. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class TextTimerAttribute extends CommonMethod { /** * Set the display time format, for example, now is hh/mm/ss/ms and current: hh-mm-ss-ms. * The time format string can be hh, mm, ss, or ms. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ format(value: string): TextTimerAttribute; /** * Called when the font color is set. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fontColor(value: ResourceColor): TextTimerAttribute; /** * Called when the font size is set. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fontSize(value: Length): TextTimerAttribute; /** * Called when the fontStyle is set * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fontStyle(value: FontStyle): TextTimerAttribute; /** * Called when the fontWeight is set * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fontWeight(value: number | FontWeight | string): TextTimerAttribute; /** * Called when the fontFamily is set * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fontFamily(value: ResourceStr): TextTimerAttribute; /** * Called when the timer value is returned. * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onTimer(event: (utc: number, elapsedTime: number) => void): TextTimerAttribute; } diff --git a/api/@internal/component/ets/toggle.d.ts b/api/@internal/component/ets/toggle.d.ts index bb8562b1a7..28426f235d 100644 --- a/api/@internal/component/ets/toggle.d.ts +++ b/api/@internal/component/ets/toggle.d.ts @@ -15,58 +15,68 @@ /** * Declare the type of status button - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum ToggleType { /** * Checkbox - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Checkbox, /** * Switch - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Switch, /** * Button - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Button, } /** - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ interface ToggleInterface { /** * Set parameters to obtain the toggle. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ (options: { type: ToggleType; isOn?: boolean }): ToggleAttribute; } /** - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare class ToggleAttribute extends CommonMethod { /** * Called when the selected state of the component changes. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onChange(callback: (isOn: boolean) => void): ToggleAttribute; /** * Called when the color of the selected button is set. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ selectedColor(value: ResourceColor): ToggleAttribute; /** * Called when the color of the selected button is set. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ switchPointColor(color: ResourceColor): ToggleAttribute; } diff --git a/api/@internal/component/ets/units.d.ts b/api/@internal/component/ets/units.d.ts index 0d9d5ba26b..8f0142d658 100644 --- a/api/@internal/component/ets/units.d.ts +++ b/api/@internal/component/ets/units.d.ts @@ -15,43 +15,50 @@ /** * Defines the data type of the interface restriction. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface Resource { /** * Set id. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ readonly id: number; /** * Set type. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ readonly type: number; /** * Set params. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ readonly params?: any[]; } /** * Defines the length property with string, number and resource unit. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare type Length = string | number | Resource; /** * Defines the string which can use resource. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare type ResourceStr = string | Resource; /** * Defines the padding property. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare type Padding = { /** @@ -77,13 +84,15 @@ declare type Padding = { /** * Defines the margin property. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare type Margin = Padding; /** * Defines the offset property. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare type Offset = { /** @@ -99,13 +108,15 @@ declare type Offset = { /** * Defines the color which can use resource. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare type ResourceColor = Color | number | string | Resource; /** * Defines the font used for text. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface Font { /** @@ -131,47 +142,55 @@ declare interface Font { /** * Defines the area property. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface Area { /** * Defines the width property. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ width: Length; /** * Defines the height property. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ height: Length; /** * Defines the local position. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ pos: Position; /** * Defines the global position. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ globalPos: Position; } /** * Defines the position. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare interface Position { /** * Coordinate x of the Position. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ x: Length; /** * Coordinate y of the Position. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ y: Length; } diff --git a/api/@internal/component/ets/video.d.ts b/api/@internal/component/ets/video.d.ts index d03940300b..98363379be 100644 --- a/api/@internal/component/ets/video.d.ts +++ b/api/@internal/component/ets/video.d.ts @@ -15,76 +15,89 @@ /** * Seek mode. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ declare enum SeekMode { /** * Sync to keyframes before the time point. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ PreviousSync, /** * Sync to keyframes after the time point. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ NextSync, /** * Sync to closest keyframes. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ ClosestSync, /** * Seek to frames closest the time point. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ Closest, } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class VideoController { /** * constructor. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(); /** * Provides events to play. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ start(); /** * Provides a pause event for playback. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ pause(); /** * Provide the progress method of video playback. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ setCurrentTime(value: number); /** * Provide the progress method of video playback. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ setCurrentTime(value: number, seekMode: SeekMode); } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ interface VideoInterface { /** * Set the value. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ (value: { src?: string | Resource; @@ -94,84 +107,101 @@ interface VideoInterface { } /** - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ declare class VideoAttribute extends CommonMethod { /** * Called when judging whether the video is muted. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ muted(value: boolean): VideoAttribute; /** * Called when judging whether the video is played automatically. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ autoPlay(value: boolean): VideoAttribute; /** * Called when judging whether the control bar is displayed. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ controls(value: boolean): VideoAttribute; /** * Called when judging whether the video is played circular. - * @since 6 + * @since 6 +* @Syscap SystemCapability.ArkUI.Standard +* @Syscap SystemCapability.ArkUI.Standard +* @Syscap SystemCapability.ArkUI.Standard +* @Syscap SystemCapability.ArkUI.Standard */ loop(value: boolean): VideoAttribute; /** * Called when determining the zoom type of the video source. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ objectFit(value: ImageFit): VideoAttribute; /** * Called when the video is played. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onStart(event: () => void): VideoAttribute; /** * Called when the video is paused. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onPause(event: () => void): VideoAttribute; /** * Called when the video playback ends. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onFinish(event: () => void): VideoAttribute; /** * Called when the video preparation is complete. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onPrepared(callback: (event?: { duration: number }) => void): VideoAttribute; /** * Called when the time information is reported when the progress bar process is operated. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onSeeking(callback: (event?: { time: number }) => void): VideoAttribute; /** * Called when the playback time information is reported after the operation progress bar is completed. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onSeeked(callback: (event?: { time: number }) => void): VideoAttribute; /** * Called when the playback progress changes. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onUpdate(callback: (event?: { time: number }) => void): VideoAttribute; /** * Called when playback fails. - * @since 7 + * @since 7 +* @Syscap SystemCapability.ArkUI.Standard */ onError(event: () => void): VideoAttribute; } diff --git a/api/@internal/component/ets/web.d.ts b/api/@internal/component/ets/web.d.ts index 636060804a..d1089e4886 100644 --- a/api/@internal/component/ets/web.d.ts +++ b/api/@internal/component/ets/web.d.ts @@ -1,25 +1,29 @@ declare class WebController { /** * Constructor. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ constructor(); /** * Means to load a piece of code and execute JS code in the context of the currently displayed page - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ evaluateJavaScript(jscode: string); /** * Indicates that a piece of code is loaded - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ loadDataWithBaseURL(value : {baseUrl: string, data: string, mimeType:string, encoding:string, historyUrl: string}); /** * Load the given URL - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ loadUrl(url : string); } @@ -27,7 +31,8 @@ declare class WebController { declare interface WebOptions { /** * Set the address of the web page to be displayed - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ src: string | Resource; controller: WebController; @@ -36,7 +41,8 @@ declare interface WebOptions { interface WebInterface { /** * Set Value. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ (value: WebOptions): WebAttribute; } @@ -44,25 +50,29 @@ interface WebInterface { declare class WebAttribute extends CommonMethod { /** * Triggered at the end of web page loading - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onPageFinish(callback: (event?:{ url: string }) => void): WebAttribute; /** * Get WebView focus callback event - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ onRequestFocus(event: () => void): WebAttribute; /** * Set whether WebView allows JavaScript scripts to execute - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ javaScriptEnabled(value: boolean): WebAttribute; /** * Enable or disable local file system access in WebView - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard */ fileAccessEnabled(value: boolean): WebAttribute; } diff --git a/api/@internal/component/ets/xcomponent.d.ts b/api/@internal/component/ets/xcomponent.d.ts index 9cbc7cb1cd..77aab03d78 100644 --- a/api/@internal/component/ets/xcomponent.d.ts +++ b/api/@internal/component/ets/xcomponent.d.ts @@ -15,20 +15,23 @@ /** * Defines XComponentController - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ declare class XComponentController { /** * constructor. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ constructor(); /** * get the id of surface created by XComponent. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ getXComponentSurfaceId(); @@ -36,13 +39,15 @@ declare class XComponentController { /** * Defines XComponent. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ interface XComponentInterface { /** * Constructor parameters - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ (value: { @@ -55,20 +60,23 @@ interface XComponentInterface { /** * Defines XComponentAttribute. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ declare class XComponentAttribute extends CommonMethod { /** * Called when judging whether the xcomponent surface is created. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ onLoad(callback: (event?: object) => void): XComponentAttribute; /** * Called when judging whether the xcomponent is destroyed. - * @since 8 + * @since 8 +* @Syscap SystemCapability.ArkUI.Standard * @systemapi */ onDestroy(event: () => void): XComponentAttribute; diff --git a/api/common/@internal/console.d.ts b/api/common/@internal/console.d.ts index 69aa3336d5..de38fb421d 100644 --- a/api/common/@internal/console.d.ts +++ b/api/common/@internal/console.d.ts @@ -15,6 +15,7 @@ /** * @devices tv, phone, tablet, wearable, liteWearable, smartVision +* @Syscap SystemCapability.ArkUI.Standard * @since 3 */ export declare class console { @@ -22,6 +23,7 @@ export declare class console { * Prints "debug" logs. * @param message Text to print. * @devices tv, phone, tablet, wearable, liteWearable, smartVision +* @Syscap SystemCapability.ArkUI.Standard */ static debug(message: string, ...arguments: any[]): void; @@ -29,6 +31,7 @@ export declare class console { * Prints "log" logs. * @param message Text to print. * @devices tv, phone, tablet, wearable, liteWearable, smartVision +* @Syscap SystemCapability.ArkUI.Standard */ static log(message: string, ...arguments: any[]): void; @@ -36,6 +39,7 @@ export declare class console { * Prints "info" logs. * @param message Text to print. * @devices tv, phone, tablet, wearable, liteWearable, smartVision +* @Syscap SystemCapability.ArkUI.Standard */ static info(message: string, ...arguments: any[]): void; @@ -43,6 +47,7 @@ export declare class console { * Prints "warn" logs. * @param message Text to print. * @devices tv, phone, tablet, wearable, liteWearable, smartVision +* @Syscap SystemCapability.ArkUI.Standard */ static warn(message: string, ...arguments: any[]): void; @@ -50,6 +55,7 @@ export declare class console { * Prints "error" logs. * @param message Text to print. * @devices tv, phone, tablet, wearable, liteWearable, smartVision +* @Syscap SystemCapability.ArkUI.Standard */ static error(message: string, ...arguments: any[]): void; } diff --git a/api/common/@internal/global.d.ts b/api/common/@internal/global.d.ts index 04876c20ff..e0afa72ef6 100644 --- a/api/common/@internal/global.d.ts +++ b/api/common/@internal/global.d.ts @@ -20,6 +20,7 @@ * @param arguments Indicates additional arguments to pass to "handler" when the timer goes off. * @returns Returns the timer ID. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard * @since 3 */ export declare function setInterval(handler: Function | string, delay: number, ...arguments: any[]): number; @@ -31,6 +32,7 @@ export declare function setInterval(handler: Function | string, delay: number, . * @param arguments Indicates additional arguments to pass to "handler" when the timer goes off. * @returns Returns the timer ID. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard * @since 3 */ export declare function setTimeout(handler: Function | string, delay?: number, ...arguments: any[]): number; @@ -39,6 +41,7 @@ export declare function setTimeout(handler: Function | string, delay?: number, . * Cancels the interval set by " setInterval()". * @param intervalID Indicates the timer ID returned by "setInterval()". * @devices tv, phone, tablet, wearable, liteWearable, smartVision +* @Syscap SystemCapability.ArkUI.Standard * @since 3 */ export declare function clearInterval(intervalID?: number): void; @@ -47,6 +50,7 @@ export declare function clearInterval(intervalID?: number): void; * Cancels the timer set by "setTimeout()". * @param timeoutID Indicates the timer ID returned by "setTimeout()". * @devices tv, phone, tablet, wearable, liteWearable, smartVision +* @Syscap SystemCapability.ArkUI.Standard * @since 3 */ export declare function clearTimeout(timeoutID?: number): void; @@ -54,6 +58,7 @@ export declare function clearTimeout(timeoutID?: number): void; /** * Obtain the objects exposed in app.js * @devices tv, phone, tablet, wearable, smartVision +* @Syscap SystemCapability.ArkUI.Standard * @since 6 */ export declare function getApp(): object; @@ -61,31 +66,37 @@ export declare function getApp(): object; /** * You can create an Image object by calling new Image(). * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ export declare class Image { /** * Network address or local resource. The internal URI is supported. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ src: string; /** * Image width. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ width?: number; /** * Image height. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ height?: number; /** * Called when an image is successfully loaded. This function has no parameter. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ onload?: () => void; /** * Called when an image fails to be loaded. This function has no parameter. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ onerror?: () => void; } @@ -93,21 +104,25 @@ export declare class Image { /** * An ImageData object is a common object that stores the actual pixel data of a Canvas object. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ export declare class ImageData { /** * Actual width of the ImageData object, in pixels. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ width: number; /** * Actual height of the ImageData object, in pixels. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ height: number; /** * A one-dimensional array of color values. The color values are sorted in the RGBA order and represented by integers from 0 to 255. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ data: Uint8ClampedArray; } diff --git a/api/common/@internal/viewmodel.d.ts b/api/common/@internal/viewmodel.d.ts index 5c80a95a2c..86c2479869 100644 --- a/api/common/@internal/viewmodel.d.ts +++ b/api/common/@internal/viewmodel.d.ts @@ -19,38 +19,46 @@ import { WebGL2RenderingContext } from "../webgl/webgl2"; /** * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ export interface FocusParamObj { /** * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ focus: boolean; } /** * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ export interface RectObj { /** * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ width: number; /** * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ height: number; /** * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ left: number; /** * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ top: number; } /** * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ export interface ContextAttrOptions { antialias: boolean; @@ -58,48 +66,57 @@ export interface ContextAttrOptions { /** * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ export interface AnimateStyle { /** * Width value applied to the component after the animation is executed. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ width: number; /** * Height value applied to the component after the animation is executed. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ height: number; /** * left offset applied to the component after the animation is executed. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ left: number; /** * top offset applied to the component after the animation is executed. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ top: number; /** * right offset applied to the component after the animation is executed. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ right: number; /** * bottom offset applied to the component after the animation is executed. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ bottom: number; /** * Background color applied to the component after the animation is executed. * The default value is none. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ backgroundColor: string; /** * Opacity applied to the component. The value ranges from 0 to 1. * The default value is 1. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ opacity: number; /** @@ -107,6 +124,7 @@ export interface AnimateStyle { * The first value indicates the horizontal position, and the second value indicates the vertical position. * If only one value is specified, the other value is 50% by default. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ backgroundPosition: string; /** @@ -114,11 +132,13 @@ export interface AnimateStyle { * The first value indicates the x-axis position. The value can be left, center, right, a length, or percentage. * The second value indicates the y-axis position. The value can be top, center, bottom, a length, or a percentage. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ transformOrigin: string; /** * Transformation type applied to an element. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ transform: "none" | TransformObject; /** @@ -126,12 +146,14 @@ export interface AnimateStyle { * If there are only two frames, offset can be left empty. * If there are more than two frames, offset is mandatory. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ offset?: number; } /** * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ export interface TransformObject { /** @@ -143,6 +165,7 @@ export interface TransformObject { * @param translateX the translate value for x-axis * @param translateY the translate value for y-axis * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ matrix( scaleX: number, @@ -170,6 +193,7 @@ export interface TransformObject { * @param n32 the value of the 3 row and 2 column of the 4x4 matrix * @param n33 the value of the 3 row and 3 column of the 4x4 matrix * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ matrix3d(n00: number, n01: number, n02: number, n03: number, n10: number, n11: number, n12: number, n13: number, @@ -180,6 +204,7 @@ export interface TransformObject { * @param x the translate value for x-axis * @param y the translate value for y-axis * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ translate(x: number, y: number): void; /** @@ -188,24 +213,28 @@ export interface TransformObject { * @param y the translate value for y-axis * @param z the translate value for z-axis * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ translate3d(x: number, y: number, z: number): void; /** * Defines 2D transformations for translation of the X axes * @param x the translate value for x-axis * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ translateX(x: number): void; /** * Defines 2D transformations for translation of the Y axes * @param y the translate value for y-axis * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ translateY(y: number): void; /** * Defines 3D transformations for translation of the Z axes * @param z the translate value for z-axis * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ translateZ(z: number): void; /** @@ -213,6 +242,7 @@ export interface TransformObject { * @param x the scale value for x-axis * @param y the scale value for y-axis * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ scale(x: number, y: number): void; /** @@ -221,30 +251,35 @@ export interface TransformObject { * @param y the scale value for y-axis * @param z the scale value for z-axis * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ scale3d(x: number, y: number, z: number): void; /** * Defines 2D transformations for scaling of the X axes * @param x the scale value for x-axis * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ scaleX(x: number): void; /** * Defines 2D transformations for scaling of the Y axes * @param y the scale value for y-axis * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ scaleY(y: number): void; /** * Defines 3D transformations for scaling of the Z axes * @param z the scale value for z-axis * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ scaleZ(z: number): void; /** * Define the 2D rotation and specify the angle in the parameters. * @param angle the rotate value for z-axis * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ rotate(angle: number): void; /** @@ -254,24 +289,28 @@ export interface TransformObject { * @param z the vector value of the z-axis * @param angle the rotate value for x&y&z vector. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ rotate3d(x: number, y: number, z: number, angle: number): void; /** * Defines 3D transformations for rotating of the X axes. * @param x the scale value for x-axis * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ rotateX(angle: number): void; /** * Defines 3D transformations for rotating of the Y axes. * @param y the scale value for y-axis * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ rotateY(angle: number): void; /** * Defines 3D transformations for rotating of the Z axes. * @param z the scale value for z-axis * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ rotateZ(angle: number): void; /** @@ -279,36 +318,42 @@ export interface TransformObject { * @param xAngle the angle of inclination along the x axis. * @param yAngle the angle of inclination along the y axis. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ skew(xAngle: number, yAngle: number): void; /** * Defines the 2D skew transition along the X axes. * @param angle the angle of inclination along the x axis. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ skewX(angle: number): void; /** * Defines the 2D skew transition along the Y axes. * @param angle the angle of inclination along the y axis. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ skewY(angle: number): void; /** * Defines a perspective view for the 3D transformation element. * @param n the vertical distance from the observation point to the component plane. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ perspective(verticalDistance: number): void; } /** * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ export interface AnimateOptions { /** * Duration of the animation, in milliseconds. * The default value is 0. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ duration: number; @@ -331,6 +376,7 @@ export interface AnimateOptions { * Step curve. The number must be set and only an integer is supported, step-position is optional. It can be set to start or end. The default value is end. * The default value is ease. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ easing: string; @@ -338,6 +384,7 @@ export interface AnimateOptions { * Delay for the animation start. The default value indicates no delay. * The default value is 0. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ delay: number; @@ -345,6 +392,7 @@ export interface AnimateOptions { * Number of times the animation will be played. number indicates a fixed number of playback operations, and Infinity indicates an unlimited number of playback operations. * The default value is 1. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ iterations: number | string; @@ -352,6 +400,7 @@ export interface AnimateOptions { * The animation playback mode. * The default value is "normal". * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ direction: "normal" | "reverse" | "alternate" | "alternate-reverse"; @@ -360,22 +409,26 @@ export interface AnimateOptions { * none: The initial state is restored after the animation is executed. * forwards: The state at the end of the animation (defined in the last key frame) is retained after the animation is executed. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ fill: "none" | "forwards" | "backwards" | "both"; } /** * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ export interface AnimationResult { /** * Read-only attribute, which indicates whether the animation playback is complete. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ finished: boolean; /** * Read-only attribute, which indicates whether an animation is waiting for the completion of other asynchronous operations (for example, start an animation with a delay). * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ pending: boolean; /** @@ -385,62 +438,74 @@ export interface AnimationResult { * paused: The animation is paused. * finished: Animation playback ends. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ playstate: string; /** * Animation start time. This attribute is similar to that of delay in the options parameters. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ startTime: number; /** * Starts the animation. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ play(): void; /** * Ends the animation. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ finish(): void; /** * Pauses the animation. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ pause(): void; /** * Cancels the animation. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ cancel(): void; /** * Plays the animation in reverse direction. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ reverse(): void; /** * The animation is started. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ onstart: () => void; /** * The animation is finished. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ onfinish: () => void; /** * The animation is canceled. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ oncancel: () => void; /** * The animation is repeated. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ onrepeat: () => void; } /** * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ export interface Element { /** @@ -450,6 +515,7 @@ export interface Element { * This attribute can be defaulted to true. * @param obj { focus: true | false } * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ focus(obj?: FocusParamObj): void; @@ -460,6 +526,7 @@ export interface Element { * This attribute can be defaulted to true. * @param obj { focus: true | false } * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ rotation(obj?: FocusParamObj): void; @@ -469,6 +536,7 @@ export interface Element { * @param options Options. is used to describe animation parameters. * @returns This method returns the animation object. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ animate( keyframes: Array, @@ -479,6 +547,7 @@ export interface Element { * Obtains the size and position of the element. * @returns RectObj the size position of the element. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ getBoundingClientRect(): RectObj; @@ -504,77 +573,91 @@ export interface observer { /** * animation element * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ export interface AnimationElement extends Element { /** * Starts the animation. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ play(): void; /** * Ends the animation. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ finish(): void; /** * Pauses the animation. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ pause(): void; /** * Cancels the animation. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ cancel(): void; /** * Plays the animation in reverse direction. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ reverse(): void; } /** * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ export interface ScrollParam { /** * Offset for scrolling in the horizontal direction, in px. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ dx?: number; /** * Offset for scrolling in the vertical direction, in px. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ dy?: number; /** * Whether a sliding animation is displayed when scroll position is changed. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ smooth?: boolean; } /** * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ export interface CurrentOffsetResultValue { /** * Scrolling offset in the x-axis, in px. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ x: number; /** * Scrolling offset in the y-axis, in px. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ y: number; } /** * @devices tv, phone, tablet, wearable, liteWearable, smartVision +* @Syscap SystemCapability.ArkUI.Standard */ export interface ListScrollToOptions { /** @@ -586,11 +669,13 @@ export interface ListScrollToOptions { /** * The component provides a list container. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ export interface ListElement extends Element { /** * Scrolls the list to the position of the item at the specified index. * @devices tv, phone, tablet, wearable, liteWearable, smartVision +* @Syscap SystemCapability.ArkUI.Standard */ scrollTo(position: ListScrollToOptions): void; @@ -606,6 +691,7 @@ export interface ListElement extends Element { * If smooth is set to true, the list is smoothly scrolled to the top. * @param param * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ scrollTop(param: { smooth: boolean }): void; @@ -614,6 +700,7 @@ export interface ListElement extends Element { * If smooth is set to true, the list is smoothly scrolled to the bottom. * @param param * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ scrollBottom(param: { smooth: boolean }): void; @@ -624,6 +711,7 @@ export interface ListElement extends Element { * If smooth is set to true, the list is smoothly scrolled to another page. * @param params * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ scrollPage(params: { reverse: boolean; smooth: boolean }): void; @@ -634,6 +722,7 @@ export interface ListElement extends Element { * If smooth is set to true, the list is smoothly scrolled. * @param params * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ scrollArrow(params: { reverse: boolean; smooth: boolean }): void; @@ -641,6 +730,7 @@ export interface ListElement extends Element { * Collapses a group. * @param param * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ collapseGroup(param: { /** @@ -654,6 +744,7 @@ export interface ListElement extends Element { * Expands a group. * @param param * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ expandGroup(param: { /** @@ -666,6 +757,7 @@ export interface ListElement extends Element { /** * Returns the offset of the current scrolling. The return value type is Object. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ currentOffset(): CurrentOffsetResultValue; } @@ -673,11 +765,13 @@ export interface ListElement extends Element { /** * The component provides a swiper container. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ export interface SwiperElement extends Element { /** * Scrolls the child component to the position at the specified index. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ swipeTo(position: { /** @@ -689,18 +783,21 @@ export interface SwiperElement extends Element { /** * Shows the next child component. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ showNext(): void; /** * Shows the previous child component. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ showPrevious(): void; } /** * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ export interface CameraTakePhotoOptions { /** @@ -712,6 +809,7 @@ export interface CameraTakePhotoOptions { * Callback function for successful interface invocation. * @param result the request execution result. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ success?: (result: Object) => void; @@ -719,6 +817,7 @@ export interface CameraTakePhotoOptions { * Callback function for interface invocation failure. * @param result the request execution result. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ fail?: (result: Object) => void; @@ -726,6 +825,7 @@ export interface CameraTakePhotoOptions { * Callback function at the end of the interface invoking (executed both successfully and unsuccessfully). * @param result the request execution result. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ complete?: (result: Object) => void; } @@ -733,12 +833,14 @@ export interface CameraTakePhotoOptions { /** * The component provides preview and photographing functions.. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ export interface CameraElement extends Element { /** * Take photos with specified parameters. * @param options the parameters of camera. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ takePhoto(options: CameraTakePhotoOptions): void; } @@ -746,11 +848,13 @@ export interface CameraElement extends Element { /** * The component is a container for displaying web page content. * @devices tv, phone, tablet +* @Syscap SystemCapability.ArkUI.Standard */ export interface WebElement extends Element { /** * Reload the web page content * @devices tv, phone, tablet +* @Syscap SystemCapability.ArkUI.Standard */ reload(): void; } @@ -758,16 +862,19 @@ export interface WebElement extends Element { /** * The component is a custom pop-up container. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ export interface DialogElement extends Element { /** * Shows a dialog box. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ show(): void; /** * Closes a dialog box. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ close(): void; } @@ -775,26 +882,31 @@ export interface DialogElement extends Element { /** * The component is used to provide an image frame animator. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ export interface ImageAnimatorElement extends Element { /** * Starts to play the frame animation of an image. If this method is called again, the playback starts from the first frame. * @devices tv, phone, tablet, wearable, liteWearable, smartVision +* @Syscap SystemCapability.ArkUI.Standard */ start(): void; /** * Pauses the frame animation playback of an image. * @devices tv, phone, tablet, wearable, liteWearable, smartVision +* @Syscap SystemCapability.ArkUI.Standard */ pause(): void; /** * Stops the frame animation playback of an image. * @devices tv, phone, tablet, wearable, liteWearable, smartVision +* @Syscap SystemCapability.ArkUI.Standard */ stop(): void; /** * Resumes the frame animation playback of an image. * @devices tv, phone, tablet, wearable, liteWearable, smartVision +* @Syscap SystemCapability.ArkUI.Standard */ resume(): void; /** @@ -803,6 +915,7 @@ export interface ImageAnimatorElement extends Element { * Paused * Stopped * @devices tv, phone, tablet, wearable, liteWearable, smartVision +* @Syscap SystemCapability.ArkUI.Standard */ getState(): "Playing" | "Paused" | "Stopped"; } @@ -811,17 +924,20 @@ export interface ImageAnimatorElement extends Element { * The component inserts scrolling text, which is displayed in a single line by default. * When the text length exceeds the display area of the component, the marquee effect is displayed. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ export interface MarqueeElement extends Element { /** * Starts scrolling. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ start(): void; /** * Stops scrolling. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ stop(): void; } @@ -829,6 +945,7 @@ export interface MarqueeElement extends Element { /** * The component provides menus as temporary pop-up windows to display operations that can be performed by users. * @devices tv, phone, tablet +* @Syscap SystemCapability.ArkUI.Standard */ export interface MenuElement extends Element { /** @@ -841,6 +958,7 @@ export interface MenuElement extends Element { * When the visible space in the lower part is insufficient, the menu is moved upward. * @param position * @devices tv, phone, tablet +* @Syscap SystemCapability.ArkUI.Standard */ show(position: { x: number; y: number }): void; } @@ -848,6 +966,7 @@ export interface MenuElement extends Element { /** * The component displays line charts, gauge charts, and bar charts. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ export interface ChartElement extends Element { /** @@ -856,6 +975,7 @@ export interface ChartElement extends Element { * datasets[index].data is not updated. Only line charts support this attribute. * The value is incremented by 1 based on the horizontal coordinate and is related to the xAxis min/max setting. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ append(params: { /** @@ -872,6 +992,7 @@ export interface ChartElement extends Element { /** * The component provides an interactive interface to receive user input, which is displayed in a single line by default. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ export interface InputElement extends Element { /** @@ -879,6 +1000,7 @@ export interface InputElement extends Element { * When the component type is set to text, email, date, time, number, or password, the input method can be displayed or collapsed. * @param param If focus is not passed, the default value true is used. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ focus(param: { focus: boolean }): void; @@ -887,12 +1009,14 @@ export interface InputElement extends Element { * This attribute is available when the component type is set to text, email, date, time, number, or password. * @param param * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ showError(param: { error: string }): void; /** * Deletes the previous character at the cursor position. * @devices tv, phone, tablet, wearable +* @Syscap SystemCapability.ArkUI.Standard */ delete(): void; } @@ -900,6 +1024,7 @@ export interface InputElement extends Element { /** * The