openharmony/interface_sdk-js
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk-js synced 2024-11-23 07:10:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

第二批打标ArkUI增加元服务标签

Browse Source 
Change-Id: I82f5ab9ffe8916d46ef7827d999ad7fd1979f8e6
Signed-off-by: tangjie <1402602435@qq.com>
This commit is contained in:
tangjie 2024-07-16 12:01:05 +08:00
parent 2f5a99ddb0
commit 26c63bf668
171 changed files with 4001 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
api/@internal/component/ets/action_sheet.d.ts vendored
View File

@ -128,6 +128,7 @@ interface SheetInfo {
* @interface DismissDialogAction
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface DismissDialogAction {
@ -137,6 +138,7 @@ declare interface DismissDialogAction {
* @type { Callback<void> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
dismiss: Callback<void>;
@ -147,6 +149,7 @@ declare interface DismissDialogAction {
* @type { DismissReason }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
reason: DismissReason;
@ -619,6 +622,7 @@ interface ActionSheetOptions
* @type { ?Callback<DismissDialogAction> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onWillDismiss?: Callback<DismissDialogAction>;
@ -629,6 +633,7 @@ interface ActionSheetOptions
* @type { ?TransitionEffect }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
transition?: TransitionEffect;
@ -639,6 +644,7 @@ interface ActionSheetOptions
* @type { ?(Dimension | BorderRadiuses | LocalizedBorderRadiuses) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
cornerRadius?: Dimension | BorderRadiuses | LocalizedBorderRadiuses;
@ -649,6 +655,7 @@ interface ActionSheetOptions
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
width?: Dimension;
@ -659,6 +666,7 @@ interface ActionSheetOptions
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
height?: Dimension;
@ -669,6 +677,7 @@ interface ActionSheetOptions
* @type { ?(Dimension | EdgeWidths | LocalizedEdgeWidths) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
borderWidth?: Dimension | EdgeWidths | LocalizedEdgeWidths;
@ -679,6 +688,7 @@ interface ActionSheetOptions
* @type { ?(ResourceColor | EdgeColors | LocalizedEdgeColors) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
borderColor?: ResourceColor | EdgeColors | LocalizedEdgeColors;
@ -689,6 +699,7 @@ interface ActionSheetOptions
* @type { ?(BorderStyle | EdgeStyles) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
borderStyle?: BorderStyle | EdgeStyles;
@ -699,6 +710,7 @@ interface ActionSheetOptions
* @type { ?(ShadowOptions | ShadowStyle) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
shadow?: ShadowOptions | ShadowStyle;

13
api/@internal/component/ets/alert_dialog.d.ts vendored
View File

@ -506,6 +506,7 @@ declare interface AlertDialogButtonOptions {
* @type { ?boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
primary?: boolean;
@ -864,6 +865,7 @@ declare interface AlertDialogParam {
* @type { ?Callback<DismissDialogAction> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onWillDismiss?: Callback<DismissDialogAction>;
@ -874,6 +876,7 @@ declare interface AlertDialogParam {
* @type { ?TransitionEffect }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
transition?: TransitionEffect;
@ -884,6 +887,7 @@ declare interface AlertDialogParam {
* @type { ?(Dimension | BorderRadiuses | LocalizedBorderRadiuses) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
cornerRadius?: Dimension | BorderRadiuses | LocalizedBorderRadiuses;
@ -894,6 +898,7 @@ declare interface AlertDialogParam {
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
width?: Dimension;
@ -904,6 +909,7 @@ declare interface AlertDialogParam {
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
height?: Dimension;
@ -914,6 +920,7 @@ declare interface AlertDialogParam {
* @type { ?(Dimension | EdgeWidths | LocalizedEdgeWidths) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
borderWidth?: Dimension | EdgeWidths | LocalizedEdgeWidths;
@ -924,6 +931,7 @@ declare interface AlertDialogParam {
* @type { ?(ResourceColor | EdgeColors | LocalizedEdgeColors) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
borderColor?: ResourceColor | EdgeColors | LocalizedEdgeColors;
@ -934,6 +942,7 @@ declare interface AlertDialogParam {
* @type { ?(BorderStyle | EdgeStyles) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
borderStyle?: BorderStyle | EdgeStyles;
@ -944,6 +953,7 @@ declare interface AlertDialogParam {
* @type { ?(ShadowOptions | ShadowStyle) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
shadow?: ShadowOptions | ShadowStyle;
@ -1179,6 +1189,7 @@ declare interface AlertDialogParamWithConfirm extends AlertDialogParam {
* @interface DismissDialogAction
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface DismissDialogAction {
@ -1188,6 +1199,7 @@ declare interface DismissDialogAction {
* @type { Callback<void> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
dismiss: Callback<void>;
@ -1198,6 +1210,7 @@ declare interface DismissDialogAction {
* @type { DismissReason }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
reason: DismissReason;

3
api/@internal/component/ets/alphabet_indexer.d.ts vendored
View File

@ -94,6 +94,7 @@ declare enum IndexerAlign {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
START,
@ -103,6 +104,7 @@ declare enum IndexerAlign {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
END,
@ -841,6 +843,7 @@ declare class AlphabetIndexerAttribute extends CommonMethod<AlphabetIndexerAttri
* @param { boolean } value - Default value is true, set false to disable haptic feedback.
* @returns { AlphabetIndexerAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
enableHapticFeedback(value: boolean): AlphabetIndexerAttribute;

11
api/@internal/component/ets/button.d.ts vendored
View File

@ -235,6 +235,7 @@ declare enum ButtonStyleMode {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
declare enum ButtonRole {
@ -244,6 +245,7 @@ declare enum ButtonRole {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
NORMAL = 0,
@ -254,6 +256,7 @@ declare enum ButtonRole {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
ERROR = 1,
@ -267,6 +270,7 @@ declare enum ButtonRole {
* @param { number } yPos - The value of yPos is y coordinate.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare type ButtonTriggerClickCallback = (xPos: number, yPos: number) => void;
@ -277,6 +281,7 @@ declare type ButtonTriggerClickCallback = (xPos: number, yPos: number) => void;
* @interface ButtonConfiguration
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@ -287,6 +292,7 @@ declare interface ButtonConfiguration extends CommonConfiguration<ButtonConfigur
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
label: string;
@ -297,6 +303,7 @@ declare interface ButtonConfiguration extends CommonConfiguration<ButtonConfigur
* @type { boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
pressed: boolean;
@ -307,6 +314,7 @@ declare interface ButtonConfiguration extends CommonConfiguration<ButtonConfigur
* @type { ButtonTriggerClickCallback }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
triggerClick: ButtonTriggerClickCallback;
@ -532,6 +540,7 @@ declare interface ButtonOptions {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
role?: ButtonRole;
@ -995,6 +1004,7 @@ declare class ButtonAttribute extends CommonMethod<ButtonAttribute> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
role(value: ButtonRole): ButtonAttribute;
@ -1206,6 +1216,7 @@ declare class ButtonAttribute extends CommonMethod<ButtonAttribute> {
* @returns { ButtonAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
contentModifier(modifier: ContentModifier<ButtonConfiguration>): ButtonAttribute;

5
api/@internal/component/ets/calendar_picker.d.ts vendored
View File

@ -356,6 +356,7 @@ declare interface CalendarDialogOptions extends CalendarOptions {
* @type { ?PickerDialogButtonStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
acceptButtonStyle?: PickerDialogButtonStyle;
@ -366,6 +367,7 @@ declare interface CalendarDialogOptions extends CalendarOptions {
* @type { ?PickerDialogButtonStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
cancelButtonStyle?: PickerDialogButtonStyle;
@ -398,6 +400,7 @@ declare interface CalendarDialogOptions extends CalendarOptions {
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onWillAppear?: () => void;
@ -408,6 +411,7 @@ declare interface CalendarDialogOptions extends CalendarOptions {
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onWillDisappear?: () => void;
@ -418,6 +422,7 @@ declare interface CalendarDialogOptions extends CalendarOptions {
* @type { ?(ShadowOptions | ShadowStyle) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
shadow?: ShadowOptions | ShadowStyle;

25
api/@internal/component/ets/canvas.d.ts vendored
View File

@ -23,6 +23,7 @@
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare type DrawingCanvas = import('../api/@ohos.graphics.drawing').default.Canvas;
@ -1070,6 +1071,7 @@ declare class Path2D extends CanvasPath {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
constructor(unit: LengthMetricsUnit);
@ -1118,6 +1120,7 @@ declare class Path2D extends CanvasPath {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
constructor(path: Path2D, unit: LengthMetricsUnit);
@ -1166,6 +1169,7 @@ declare class Path2D extends CanvasPath {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
constructor(description: string, unit: LengthMetricsUnit);
@ -1970,6 +1974,7 @@ declare class ImageBitmap {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
constructor(src: string, unit: LengthMetricsUnit);
@ -2007,6 +2012,7 @@ declare class ImageBitmap {
* @param { LengthMetricsUnit } [unit] - the unit mode
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
constructor(data: PixelMap, unit: LengthMetricsUnit);
@ -2205,6 +2211,7 @@ declare class ImageData {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
constructor(width: number, height: number, data?: Uint8ClampedArray, unit?: LengthMetricsUnit);
@ -4995,6 +5002,7 @@ declare class CanvasRenderer extends CanvasPath {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
saveLayer(): void;
@ -5004,6 +5012,7 @@ declare class CanvasRenderer extends CanvasPath {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
restoreLayer(): void;
@ -5013,6 +5022,7 @@ declare class CanvasRenderer extends CanvasPath {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
reset(): void;
@ -5181,6 +5191,7 @@ declare class CanvasRenderingContext2D extends CanvasRenderer {
* @throws { BusinessError } 110001 - Image analysis feature is not supported.
* @throws { BusinessError } 110002 - Image analysis is currently being executed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
startImageAnalyzer(config: ImageAnalyzerConfig): Promise<void>;
@ -5188,6 +5199,7 @@ declare class CanvasRenderingContext2D extends CanvasRenderer {
/**
* Stop image analyzer.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
stopImageAnalyzer(): void;
@ -5236,6 +5248,7 @@ declare class CanvasRenderingContext2D extends CanvasRenderer {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
constructor(settings?: RenderingContextSettings, unit?: LengthMetricsUnit);
@ -5414,6 +5427,7 @@ declare class OffscreenCanvasRenderingContext2D extends CanvasRenderer {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
constructor(width: number, height: number, settings?: RenderingContextSettings, unit?: LengthMetricsUnit);
@ -5635,6 +5649,7 @@ declare class OffscreenCanvas {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
constructor(width: number, height: number, unit: LengthMetricsUnit);
@ -5646,6 +5661,7 @@ declare class OffscreenCanvas {
* @interface Size
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface Size {
@ -5655,6 +5671,7 @@ declare interface Size {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
width: number;
@ -5665,6 +5682,7 @@ declare interface Size {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
height: number;
@ -5675,6 +5693,7 @@ declare interface Size {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class DrawingRenderingContext {
@ -5685,6 +5704,7 @@ declare class DrawingRenderingContext {
* @returns { Size } The size of the DrawingRenderingContext.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
get size(): Size;
@ -5695,6 +5715,7 @@ declare class DrawingRenderingContext {
* @returns { DrawingCanvas } The canvas of the DrawingRenderingContext.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
get canvas(): DrawingCanvas;
@ -5704,6 +5725,7 @@ declare class DrawingRenderingContext {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
invalidate(): void;
@ -5715,6 +5737,7 @@ declare class DrawingRenderingContext {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
constructor(unit?: LengthMetricsUnit);
@ -5813,6 +5836,7 @@ interface CanvasInterface {
* @param { ImageAIOptions } imageAIOptions
* @returns { CanvasAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
(context: CanvasRenderingContext2D | DrawingRenderingContext, imageAIOptions: ImageAIOptions): CanvasAttribute;
@ -5899,6 +5923,7 @@ declare class CanvasAttribute extends CommonMethod<CanvasAttribute> {
* @param { boolean } enable
* @returns { CanvasAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
enableAnalyzer(enable: boolean): CanvasAttribute;

6
api/@internal/component/ets/checkbox.d.ts vendored
View File

@ -131,6 +131,7 @@ declare interface CheckboxOptions {
* @type { ?CustomBuilder }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
indicatorBuilder?: CustomBuilder;
@ -142,6 +143,7 @@ declare interface CheckboxOptions {
* @interface CheckBoxConfiguration
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface CheckBoxConfiguration extends CommonConfiguration<CheckBoxConfiguration> {
@ -151,6 +153,7 @@ declare interface CheckBoxConfiguration extends CommonConfiguration<CheckBoxConf
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
name: string;
@ -161,6 +164,7 @@ declare interface CheckBoxConfiguration extends CommonConfiguration<CheckBoxConf
* @type { boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
selected: boolean;
@ -171,6 +175,7 @@ declare interface CheckBoxConfiguration extends CommonConfiguration<CheckBoxConf
* @type { Callback<boolean> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
triggerChange: Callback<boolean>;
@ -483,6 +488,7 @@ declare class CheckboxAttribute extends CommonMethod<CheckboxAttribute> {
* @returns { CheckboxAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
contentModifier(modifier: ContentModifier<CheckBoxConfiguration>): CheckboxAttribute;

1
api/@internal/component/ets/checkboxgroup.d.ts vendored
View File

@ -608,6 +608,7 @@ declare class CheckboxGroupAttribute extends CommonMethod<CheckboxGroupAttribute
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
checkboxShape(value: CheckBoxShape): CheckboxGroupAttribute;

567
api/@internal/component/ets/common.d.ts vendored
View File

File diff suppressed because it is too large Load Diff

8
api/@internal/component/ets/common_ts_ets_api.d.ts vendored
View File

@ -51,6 +51,7 @@ declare class AppStorage {
* return undefined otherwise
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
static ref<T>(propName: string): AbstractProperty<T> | undefined;
@ -66,6 +67,7 @@ declare class AppStorage {
* @returns { AbstractProperty<T> } AbstractProperty object
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
static setAndRef<T>(propName: string, defaultValue: T): AbstractProperty<T>;
@ -671,6 +673,7 @@ declare class AppStorage {
* @interface AbstractProperty<T>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface AbstractProperty<T> {
@ -680,6 +683,7 @@ declare interface AbstractProperty<T> {
* @returns { T } value of the referenced AppStorage/LocalStorage property.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
get(): T;
@ -691,6 +695,7 @@ declare interface AbstractProperty<T> {
* @param { T } newValue new value set to AppStorage/LocalStorage
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
set(newValue: T): void;
@ -701,6 +706,7 @@ declare interface AbstractProperty<T> {
* @returns { string } name of the referenced property
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
info(): string;
@ -1855,6 +1861,7 @@ declare class LocalStorage {
* return undefined otherwise.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
public ref<T>(propName: string): AbstractProperty<T> | undefined;
@ -1870,6 +1877,7 @@ declare class LocalStorage {
* @returns { AbstractProperty<T> } AbstractProperty object
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
public setAndRef<T>(propName: string, defaultValue: T): AbstractProperty<T>;

19
api/@internal/component/ets/component3d.d.ts vendored
View File

@ -23,6 +23,7 @@
*
* @typedef { import('../api/@ohos.graphics.scene').Scene }
* @syscap SystemCapability.ArkUi.Graphics3D
* @atomicservice
* @since 12
*/
declare type Scene = import('../api/@ohos.graphics.scene').Scene
@ -31,6 +32,7 @@ declare type Scene = import('../api/@ohos.graphics.scene').Scene
* The enum of model type
* @enum { number }
* @syscap SystemCapability.ArkUi.Graphics3D
* @atomicservice
* @since 12
*/
declare enum ModelType {
@ -38,6 +40,7 @@ declare enum ModelType {
* Render to texture, gpu would compose this texture to screen.
*
* @syscap SystemCapability.ArkUi.Graphics3D
* @atomicservice
* @since 12
*/
TEXTURE = 0,
@ -46,6 +49,7 @@ declare enum ModelType {
* Render to surface, special hardware would compose this surface to screen.
*
* @syscap SystemCapability.ArkUi.Graphics3D
* @atomicservice
* @since 12
*/
SURFACE = 1,
@ -56,6 +60,7 @@ declare enum ModelType {
*
* @interface SceneOptions
* @syscap SystemCapability.ArkUi.Graphics3D
* @atomicservice
* @since 12
*/
declare interface SceneOptions {
@ -64,6 +69,7 @@ declare interface SceneOptions {
*
* @type { ?(Resource | Scene) }
* @syscap SystemCapability.ArkUi.Graphics3D
* @atomicservice
* @since 12
*/
scene?: Resource | Scene;
@ -74,6 +80,7 @@ declare interface SceneOptions {
* @type { ?ModelType }
* @default ModelType.SURFACE
* @syscap SystemCapability.ArkUi.Graphics3D
* @atomicservice
* @since 12
*/
modelType?: ModelType;
@ -84,6 +91,7 @@ declare interface SceneOptions {
*
* @interface Component3DInterface
* @syscap SystemCapability.ArkUi.Graphics3D
* @atomicservice
* @since 12
*/
interface Component3DInterface {
@ -93,6 +101,7 @@ interface Component3DInterface {
* @param { SceneOptions } sceneOptions - The 3D scene controller
* @returns { Component3DAttribute }
* @syscap SystemCapability.ArkUi.Graphics3D
* @atomicservice
* @since 12
*/
(sceneOptions?: SceneOptions): Component3DAttribute;
@ -101,6 +110,7 @@ interface Component3DInterface {
/**
* @extends CommonMethod<Component3DAttribute>
* @syscap SystemCapability.ArkUi.Graphics3D
* @atomicservice
* @since 12
*/
declare class Component3DAttribute extends CommonMethod<Component3DAttribute> {
@ -110,6 +120,7 @@ declare class Component3DAttribute extends CommonMethod<Component3DAttribute> {
* @param { Resource } uri - The path of 3D environment resource
* @returns { Component3DAttribute } The attribute of the component3D
* @syscap SystemCapability.ArkUi.Graphics3D
* @atomicservice
* @since 12
*/
environment(uri: Resource): Component3DAttribute;
@ -121,6 +132,7 @@ declare class Component3DAttribute extends CommonMethod<Component3DAttribute> {
* @param { boolean } selfRenderUpdate - Trigger rendering every frame
* @returns { Component3DAttribute } The attribute of the component3D
* @syscap SystemCapability.ArkUi.Graphics3D
* @atomicservice
* @since 12
*/
customRender(uri: Resource, selfRenderUpdate: boolean): Component3DAttribute;
@ -131,6 +143,7 @@ declare class Component3DAttribute extends CommonMethod<Component3DAttribute> {
* @param { Resource } uri - The path of custom shader
* @returns { Component3DAttribute } The attribute of the component3D
* @syscap SystemCapability.ArkUi.Graphics3D
* @atomicservice
* @since 12
*/
shader(uri: Resource): Component3DAttribute;
@ -141,6 +154,7 @@ declare class Component3DAttribute extends CommonMethod<Component3DAttribute> {
* @param { Resource } uri - The path of texture used by shader
* @returns { Component3DAttribute } The attribute of the component3D
* @syscap SystemCapability.ArkUi.Graphics3D
* @atomicservice
* @since 12
*/
shaderImageTexture(uri: Resource): Component3DAttribute;
@ -151,6 +165,7 @@ declare class Component3DAttribute extends CommonMethod<Component3DAttribute> {
* @param { Array<number> } buffer - The uniform buffer of shader input
* @returns { Component3DAttribute } The attribute of the component3D
* @syscap SystemCapability.ArkUi.Graphics3D
* @atomicservice
* @since 12
*/
shaderInputBuffer(buffer: Array<number>): Component3DAttribute;
@ -161,6 +176,7 @@ declare class Component3DAttribute extends CommonMethod<Component3DAttribute> {
* @param { Dimension } value - Width of gpu render target, target would upscale or downscale to view's width.
* @returns { Component3DAttribute } The attribute of the component3D
* @syscap SystemCapability.ArkUi.Graphics3D
* @atomicservice
* @since 12
*/
renderWidth(value: Dimension): Component3DAttribute;
@ -171,6 +187,7 @@ declare class Component3DAttribute extends CommonMethod<Component3DAttribute> {
* @param { Dimension } value - Height of gpu render target, target would upscale or downscale to view's height.
* @returns { Component3DAttribute } The attribute of the component3D
* @syscap SystemCapability.ArkUi.Graphics3D
* @atomicservice
* @since 12
*/
renderHeight(value: Dimension): Component3DAttribute;
@ -180,6 +197,7 @@ declare class Component3DAttribute extends CommonMethod<Component3DAttribute> {
* Defines Component3D component.
*
* @syscap SystemCapability.ArkUi.Graphics3D
* @atomicservice
* @since 12
*/
declare const Component3D: Component3DInterface;
@ -188,6 +206,7 @@ declare const Component3D: Component3DInterface;
* Defines Component3D instance.
*
* @syscap SystemCapability.ArkUi.Graphics3D
* @atomicservice
* @since 12
*/
declare const Component3DInstance: Component3DAttribute;

5
api/@internal/component/ets/content_slot.d.ts vendored
View File

@ -24,6 +24,7 @@
* @typedef {import('../api/@ohos.arkui.node').Content} Content
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare type Content = import('../api/@ohos.arkui.node').Content;
@ -33,6 +34,7 @@ declare type Content = import('../api/@ohos.arkui.node').Content;
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class ContentSlotAttribute {
@ -44,6 +46,7 @@ declare class ContentSlotAttribute {
* @interface ContentSlotInterface
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface ContentSlotInterface {
@ -54,6 +57,7 @@ interface ContentSlotInterface {
* @returns { ContentSlotAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
(content: Content): ContentSlotAttribute;
@ -64,6 +68,7 @@ interface ContentSlotInterface {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare const ContentSlot: ContentSlotInterface;

11
api/@internal/component/ets/custom_dialog_controller.d.ts vendored
View File

@ -384,6 +384,7 @@ declare interface CustomDialogControllerOptions {
* @type { ?Callback<DismissDialogAction> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onWillDismiss?: Callback<DismissDialogAction>;
@ -394,6 +395,7 @@ declare interface CustomDialogControllerOptions {
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
width?: Dimension;
@ -404,6 +406,7 @@ declare interface CustomDialogControllerOptions {
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
height?: Dimension;
@ -414,6 +417,7 @@ declare interface CustomDialogControllerOptions {
* @type { ?(Dimension | EdgeWidths) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
borderWidth?: Dimension | EdgeWidths;
@ -424,6 +428,7 @@ declare interface CustomDialogControllerOptions {
* @type { ?(ResourceColor | EdgeColors) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
borderColor?: ResourceColor | EdgeColors;
@ -434,6 +439,7 @@ declare interface CustomDialogControllerOptions {
* @type { ?(BorderStyle | EdgeStyles) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
borderStyle?: BorderStyle | EdgeStyles;
@ -444,6 +450,7 @@ declare interface CustomDialogControllerOptions {
* @type { ?(ShadowOptions | ShadowStyle) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
shadow?: ShadowOptions | ShadowStyle;
@ -455,6 +462,7 @@ declare interface CustomDialogControllerOptions {
* @default BlurStyle.COMPONENT_ULTRA_THICK
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
backgroundBlurStyle?: BlurStyle;
@ -466,6 +474,7 @@ declare interface CustomDialogControllerOptions {
* @interface DismissDialogAction
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface DismissDialogAction {
@ -475,6 +484,7 @@ declare interface DismissDialogAction {
* @type { Callback<void> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
dismiss: Callback<void>;
@ -485,6 +495,7 @@ declare interface DismissDialogAction {
* @type { DismissReason }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
reason: DismissReason;

4
api/@internal/component/ets/data_panel.d.ts vendored
View File

@ -469,6 +469,7 @@ interface DataPanelInterface {
* @interface DataPanelConfiguration
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface DataPanelConfiguration extends CommonConfiguration<DataPanelConfiguration> {
@ -478,6 +479,7 @@ declare interface DataPanelConfiguration extends CommonConfiguration<DataPanelCo
* @type { number[] }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
values: number[];
@ -488,6 +490,7 @@ declare interface DataPanelConfiguration extends CommonConfiguration<DataPanelCo
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
maxValue: number;
@ -659,6 +662,7 @@ declare class DataPanelAttribute extends CommonMethod<DataPanelAttribute> {
* @returns { DataPanelAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
contentModifier(modifier: ContentModifier<DataPanelConfiguration>): DataPanelAttribute;

6
api/@internal/component/ets/date_picker.d.ts vendored
View File

@ -584,6 +584,7 @@ declare interface DatePickerDialogOptions extends DatePickerOptions {
* @type { ?PickerDialogButtonStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
acceptButtonStyle?: PickerDialogButtonStyle;
@ -594,6 +595,7 @@ declare interface DatePickerDialogOptions extends DatePickerOptions {
* @type { ?PickerDialogButtonStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
cancelButtonStyle?: PickerDialogButtonStyle;
@ -830,6 +832,7 @@ declare interface DatePickerDialogOptions extends DatePickerOptions {
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onWillAppear?: () => void;
@ -840,6 +843,7 @@ declare interface DatePickerDialogOptions extends DatePickerOptions {
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onWillDisappear?: () => void;
@ -850,6 +854,7 @@ declare interface DatePickerDialogOptions extends DatePickerOptions {
* @type { ?(ShadowOptions | ShadowStyle) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
shadow?: ShadowOptions | ShadowStyle;
@ -860,6 +865,7 @@ declare interface DatePickerDialogOptions extends DatePickerOptions {
* @type { ?DateTimeOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
dateTimeOptions?: DateTimeOptions;

10
api/@internal/component/ets/embedded_component.d.ts vendored
View File

@ -25,6 +25,7 @@
*
* @interface EmbeddedComponentInterface
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
interface EmbeddedComponentInterface {
@ -36,6 +37,7 @@ interface EmbeddedComponentInterface {
* @param { EmbeddedType } type - indicates type of the EmbeddedComponent
* @returns { EmbeddedComponentAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
(
@ -49,6 +51,7 @@ interface EmbeddedComponentInterface {
*
* @interface TerminationInfo
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
declare interface TerminationInfo {
@ -57,6 +60,7 @@ declare interface TerminationInfo {
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
code: number;
@ -66,6 +70,7 @@ declare interface TerminationInfo {
*
* @type { ?import('../api/@ohos.app.ability.Want').default }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
want?: import('../api/@ohos.app.ability.Want').default;
@ -76,6 +81,7 @@ declare interface TerminationInfo {
*
* @extends CommonMethod<EmbeddedComponentAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
declare class EmbeddedComponentAttribute extends CommonMethod<EmbeddedComponentAttribute> {
@ -85,6 +91,7 @@ declare class EmbeddedComponentAttribute extends CommonMethod<EmbeddedComponentA
* @param { import('../api/@ohos.base').Callback<TerminationInfo> } callback
* @returns { EmbeddedComponentAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
onTerminated(callback: import('../api/@ohos.base').Callback<TerminationInfo>): EmbeddedComponentAttribute;
@ -95,6 +102,7 @@ declare class EmbeddedComponentAttribute extends CommonMethod<EmbeddedComponentA
* @param { import('../api/@ohos.base').ErrorCallback } callback
* @returns { EmbeddedComponentAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
onError(callback: import('../api/@ohos.base').ErrorCallback): EmbeddedComponentAttribute;
@ -104,6 +112,7 @@ declare class EmbeddedComponentAttribute extends CommonMethod<EmbeddedComponentA
* Defines EmbeddedComponent Component.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
declare const EmbeddedComponent: EmbeddedComponentInterface;
@ -112,6 +121,7 @@ declare const EmbeddedComponent: EmbeddedComponentInterface;
* Defines EmbeddedComponent Component instance.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
declare const EmbeddedComponentInstance: EmbeddedComponentAttribute;

35
api/@internal/component/ets/enums.d.ts vendored
View File

@ -5583,6 +5583,7 @@ declare enum ImageSize {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
FILL = 3,
@ -8191,6 +8192,7 @@ declare enum FunctionKey {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
TAB,
@ -8200,6 +8202,7 @@ declare enum FunctionKey {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
DPAD_UP,
@ -8209,6 +8212,7 @@ declare enum FunctionKey {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
DPAD_DOWN,
@ -8218,6 +8222,7 @@ declare enum FunctionKey {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
DPAD_LEFT,
@ -8227,6 +8232,7 @@ declare enum FunctionKey {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
DPAD_RIGHT,
@ -8661,6 +8667,7 @@ declare enum NestedScrollMode {
* @enum { number } ScrollSource
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum ScrollSource {
@ -8668,6 +8675,7 @@ declare enum ScrollSource {
* Drag events.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
DRAG = 0,
@ -8676,6 +8684,7 @@ declare enum ScrollSource {
* Fling after the drag has ended with velocity.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
FLING,
@ -8684,6 +8693,7 @@ declare enum ScrollSource {
* Over scroll with EdgeEffect.Spring.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
EDGE_EFFECT,
@ -8692,6 +8702,7 @@ declare enum ScrollSource {
* Other user input except drag, such as mouse wheel, key event.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
OTHER_USER_INPUT,
@ -8700,6 +8711,7 @@ declare enum ScrollSource {
* Drag events of scroll bar.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
SCROLL_BAR,
@ -8708,6 +8720,7 @@ declare enum ScrollSource {
* Fling after the drag on scroll bar has ended with velocity.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
SCROLL_BAR_FLING,
@ -8716,6 +8729,7 @@ declare enum ScrollSource {
* Member methods of Scroller without animation.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
SCROLLER,
@ -8724,6 +8738,7 @@ declare enum ScrollSource {
* Member methods of Scroller with animation.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
SCROLLER_ANIMATION,
@ -9140,6 +9155,7 @@ declare enum WordBreak {
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum LineBreakStrategy {
@ -9149,6 +9165,7 @@ declare enum LineBreakStrategy {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
GREEDY = 0,
@ -9159,6 +9176,7 @@ declare enum LineBreakStrategy {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
HIGH_QUALITY = 1,
@ -9169,6 +9187,7 @@ declare enum LineBreakStrategy {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
BALANCED = 2,
@ -9463,6 +9482,7 @@ declare enum FoldStatus {
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
declare enum AppRotation {
@ -9471,6 +9491,7 @@ declare enum AppRotation {
* App does not rotate to display vertically.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
ROTATION_0 = 0,
@ -9479,6 +9500,7 @@ declare enum AppRotation {
* App rotates 90 degrees clockwise to display horizontally.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
ROTATION_90 = 1,
@ -9487,6 +9509,7 @@ declare enum AppRotation {
* App rotates 180 degrees clockwise to display vertically in reverse.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
ROTATION_180 = 2,
@ -9495,6 +9518,7 @@ declare enum AppRotation {
* App rotates 270 degrees clockwise to display horizontally in reverse.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
ROTATION_270 = 3
@ -9505,6 +9529,7 @@ declare enum AppRotation {
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
declare enum EmbeddedType {
@ -9512,6 +9537,7 @@ declare enum EmbeddedType {
* The EmbeddedComponent show the UI in EmbeddedUIExtensionAbility.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
EMBEDDED_UI_EXTENSION = 0,
@ -9523,6 +9549,7 @@ declare enum EmbeddedType {
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum MarqueeUpdateStrategy {
@ -9531,6 +9558,7 @@ declare enum MarqueeUpdateStrategy {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
DEFAULT = 0,
@ -9540,6 +9568,7 @@ declare enum MarqueeUpdateStrategy {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
PRESERVE_POSITION = 1
@ -9551,6 +9580,7 @@ declare enum MarqueeUpdateStrategy {
* @enum {number}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum TextDecorationStyle {
@ -9559,6 +9589,7 @@ declare enum TextDecorationStyle {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
SOLID = 0,
@ -9568,6 +9599,7 @@ declare enum TextDecorationStyle {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
DOUBLE = 1,
@ -9577,6 +9609,7 @@ declare enum TextDecorationStyle {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
DOTTED = 2,
@ -9586,6 +9619,7 @@ declare enum TextDecorationStyle {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
DASHED = 3,
@ -9595,6 +9629,7 @@ declare enum TextDecorationStyle {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
WAVY = 4,

4
api/@internal/component/ets/flex.d.ts vendored
View File

@ -240,6 +240,7 @@ declare interface FlexOptions {
* @type { ?FlexSpaceOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
space?: FlexSpaceOptions;
@ -252,6 +253,7 @@ declare interface FlexOptions {
* @interface FlexSpaceOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@ -262,6 +264,7 @@ declare interface FlexSpaceOptions {
* @type { ?LengthMetrics }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
main?: LengthMetrics;
@ -272,6 +275,7 @@ declare interface FlexSpaceOptions {
* @type { ?LengthMetrics }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
cross?: LengthMetrics;

8
api/@internal/component/ets/focus.d.ts vendored
View File

@ -24,6 +24,7 @@
* @interface FocusBoxStyle
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface FocusBoxStyle {
@ -33,6 +34,7 @@ declare interface FocusBoxStyle {
* @type { ?LengthMetrics }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
margin?: LengthMetrics;
@ -42,6 +44,7 @@ declare interface FocusBoxStyle {
* @type { ?ColorMetrics }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
strokeColor?: ColorMetrics;
@ -51,6 +54,7 @@ declare interface FocusBoxStyle {
* @type { ?LengthMetrics }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
strokeWidth?: LengthMetrics;
@ -62,6 +66,7 @@ declare interface FocusBoxStyle {
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum FocusPriority {
@ -70,6 +75,7 @@ declare enum FocusPriority {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
AUTO = 0,
@ -79,6 +85,7 @@ declare enum FocusPriority {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
PRIOR = 2000,
@ -88,6 +95,7 @@ declare enum FocusPriority {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
PREVIOUS = 3000,

16
api/@internal/component/ets/folder_stack.d.ts vendored
View File

@ -23,6 +23,7 @@
*
* @typedef {import('../api/@ohos.window').default.WindowStatusType} WindowStatusType
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
declare type WindowStatusType = import('../api/@ohos.window').default.WindowStatusType;
@ -132,6 +133,15 @@ declare class FolderStackAttribute extends CommonMethod<FolderStackAttribute> {
* @crossplatform
* @since 11
*/
/**
* folder state.
*
* @type { FoldStatus }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
foldStatus: FoldStatus
}) => void): FolderStackAttribute;
@ -142,6 +152,7 @@ declare class FolderStackAttribute extends CommonMethod<FolderStackAttribute> {
* @param { function } handler - executed when hoverStatus changed
* @returns { FolderStackAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
onHoverStatusChange(handler: (param: HoverEventParam) => void): FolderStackAttribute;
@ -194,6 +205,7 @@ declare class FolderStackAttribute extends CommonMethod<FolderStackAttribute> {
*
* @interface HoverEventParam
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
declare interface HoverEventParam {
@ -202,6 +214,7 @@ declare interface HoverEventParam {
*
* @type { FoldStatus }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
foldStatus: FoldStatus
@ -211,6 +224,7 @@ declare interface HoverEventParam {
*
* @type { boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
isHoverMode: boolean
@ -220,6 +234,7 @@ declare interface HoverEventParam {
*
* @type { AppRotation }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
appRotation: AppRotation
@ -229,6 +244,7 @@ declare interface HoverEventParam {
*
* @type { WindowStatusType }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
windowStatusType: WindowStatusType

6
api/@internal/component/ets/gauge.d.ts vendored
View File

@ -189,6 +189,7 @@ declare interface GaugeIndicatorOptions {
* @interface GaugeConfiguration
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface GaugeConfiguration extends CommonConfiguration<GaugeConfiguration> {
@ -198,6 +199,7 @@ declare interface GaugeConfiguration extends CommonConfiguration<GaugeConfigurat
* @type { number } data value - the current data value.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
value: number;
@ -208,6 +210,7 @@ declare interface GaugeConfiguration extends CommonConfiguration<GaugeConfigurat
* @type { number } segment minimum value - the current segment minimum value.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
min: number;
@ -218,6 +221,7 @@ declare interface GaugeConfiguration extends CommonConfiguration<GaugeConfigurat
* @type { number } segment maximum value - the current segment maximum value.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
max: number;
@ -521,6 +525,7 @@ declare class GaugeAttribute extends CommonMethod<GaugeAttribute> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
privacySensitive(isPrivacySensitiveMode: Optional<boolean>): GaugeAttribute;
@ -532,6 +537,7 @@ declare class GaugeAttribute extends CommonMethod<GaugeAttribute> {
* @returns { GaugeAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
contentModifier(modifier: ContentModifier<GaugeConfiguration>): GaugeAttribute;

86
api/@internal/component/ets/gesture.d.ts vendored
View File

@ -1798,6 +1798,7 @@ interface GestureInterface<T> {
* @returns { T }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
allowedTypes(value: Array<SourceTool>): T;
@ -2176,6 +2177,7 @@ declare class PanGestureOptions {
* @returns { PanDirection } - Pan gesture direction
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
getDirection(): PanDirection;
@ -3031,6 +3033,7 @@ declare const GestureGroup: GestureGroupInterface;
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class GestureHandler<T> implements GestureInterface<T> {
@ -3041,6 +3044,7 @@ declare class GestureHandler<T> implements GestureInterface<T> {
* @returns { T }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
tag(tag: string): T;
@ -3051,6 +3055,7 @@ declare class GestureHandler<T> implements GestureInterface<T> {
* @returns { T }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
allowedTypes(types: Array<SourceTool>): T;
@ -3062,6 +3067,7 @@ declare class GestureHandler<T> implements GestureInterface<T> {
* @interface TapGestureHandlerOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface TapGestureHandlerOptions {
@ -3072,6 +3078,7 @@ interface TapGestureHandlerOptions {
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
count?: number;
@ -3082,6 +3089,7 @@ interface TapGestureHandlerOptions {
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fingers?: number;
@ -3093,6 +3101,7 @@ interface TapGestureHandlerOptions {
* @extends GestureHandler<TapGestureHandler>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class TapGestureHandler extends GestureHandler<TapGestureHandler> {
@ -3102,6 +3111,7 @@ declare class TapGestureHandler extends GestureHandler<TapGestureHandler> {
* @param { TapGestureHandlerOptions } options
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
constructor(options?: TapGestureHandlerOptions);
@ -3112,6 +3122,7 @@ declare class TapGestureHandler extends GestureHandler<TapGestureHandler> {
* @returns { TapGestureHandler }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onAction(event: Callback<GestureEvent>): TapGestureHandler;
@ -3123,6 +3134,7 @@ declare class TapGestureHandler extends GestureHandler<TapGestureHandler> {
* @interface LongPressGestureHandlerOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface LongPressGestureHandlerOptions {
@ -3133,6 +3145,7 @@ interface LongPressGestureHandlerOptions {
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fingers?: number;
@ -3143,6 +3156,7 @@ interface LongPressGestureHandlerOptions {
* @type { ?boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
repeat?: boolean;
@ -3153,6 +3167,7 @@ interface LongPressGestureHandlerOptions {
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
duration?: number;
@ -3164,6 +3179,7 @@ interface LongPressGestureHandlerOptions {
* @extends GestureHandler<LongPressGestureHandler>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class LongPressGestureHandler extends GestureHandler<LongPressGestureHandler> {
@ -3173,6 +3189,7 @@ declare class LongPressGestureHandler extends GestureHandler<LongPressGestureHan
* @param { LongPressGestureHandlerOptions } options
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
constructor(options?: LongPressGestureHandlerOptions);
@ -3183,6 +3200,7 @@ declare class LongPressGestureHandler extends GestureHandler<LongPressGestureHan
* @returns { LongPressGestureHandler }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onAction(event: Callback<GestureEvent>): LongPressGestureHandler;
@ -3193,6 +3211,7 @@ declare class LongPressGestureHandler extends GestureHandler<LongPressGestureHan
* @returns { LongPressGestureHandler }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onActionEnd(event: Callback<GestureEvent>): LongPressGestureHandler;
@ -3203,6 +3222,7 @@ declare class LongPressGestureHandler extends GestureHandler<LongPressGestureHan
* @returns { LongPressGestureHandler }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onActionCancel(event: Callback<void>): LongPressGestureHandler;
@ -3214,6 +3234,7 @@ declare class LongPressGestureHandler extends GestureHandler<LongPressGestureHan
* @interface PanGestureHandlerOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface PanGestureHandlerOptions {
@ -3224,6 +3245,7 @@ interface PanGestureHandlerOptions {
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fingers?: number;
@ -3234,6 +3256,7 @@ interface PanGestureHandlerOptions {
* @type { ?PanDirection }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
direction?: PanDirection;
@ -3244,6 +3267,7 @@ interface PanGestureHandlerOptions {
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
distance?: number;
@ -3255,6 +3279,7 @@ interface PanGestureHandlerOptions {
* @extends GestureHandler<PanGestureHandler>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class PanGestureHandler extends GestureHandler<PanGestureHandler> {
@ -3264,6 +3289,7 @@ declare class PanGestureHandler extends GestureHandler<PanGestureHandler> {
* @param { PanGestureHandlerOptions } options
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
constructor(options?: PanGestureHandlerOptions);
@ -3274,6 +3300,7 @@ declare class PanGestureHandler extends GestureHandler<PanGestureHandler> {
* @returns { PanGestureHandler }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onActionStart(event: Callback<GestureEvent>): PanGestureHandler;
@ -3284,6 +3311,7 @@ declare class PanGestureHandler extends GestureHandler<PanGestureHandler> {
* @returns { PanGestureHandler }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onActionUpdate(event: Callback<GestureEvent>): PanGestureHandler;
@ -3294,6 +3322,7 @@ declare class PanGestureHandler extends GestureHandler<PanGestureHandler> {
* @returns { PanGestureHandler }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onActionEnd(event: Callback<GestureEvent>): PanGestureHandler;
@ -3304,6 +3333,7 @@ declare class PanGestureHandler extends GestureHandler<PanGestureHandler> {
* @returns { PanGestureHandler }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onActionCancel(event: Callback<void>): PanGestureHandler;
@ -3315,6 +3345,7 @@ declare class PanGestureHandler extends GestureHandler<PanGestureHandler> {
* @interface SwipeGestureHandlerOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface SwipeGestureHandlerOptions {
@ -3325,6 +3356,7 @@ interface SwipeGestureHandlerOptions {
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fingers?: number;
@ -3335,6 +3367,7 @@ interface SwipeGestureHandlerOptions {
* @type { ?SwipeDirection }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
direction?: SwipeDirection;
@ -3345,6 +3378,7 @@ interface SwipeGestureHandlerOptions {
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
speed?: number;
@ -3356,6 +3390,7 @@ interface SwipeGestureHandlerOptions {
* @extends GestureHandler<SwipeGestureHandler>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class SwipeGestureHandler extends GestureHandler<SwipeGestureHandler> {
@ -3365,6 +3400,7 @@ declare class SwipeGestureHandler extends GestureHandler<SwipeGestureHandler> {
* @param { SwipeGestureHandlerOptions } options
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
constructor(options?: SwipeGestureHandlerOptions);
@ -3375,6 +3411,7 @@ declare class SwipeGestureHandler extends GestureHandler<SwipeGestureHandler> {
* @returns { SwipeGestureHandler }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onAction(event: Callback<GestureEvent>): SwipeGestureHandler;
@ -3386,6 +3423,7 @@ declare class SwipeGestureHandler extends GestureHandler<SwipeGestureHandler> {
* @interface PinchGestureHandlerOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface PinchGestureHandlerOptions {
@ -3396,6 +3434,7 @@ interface PinchGestureHandlerOptions {
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fingers?: number;
@ -3406,6 +3445,7 @@ interface PinchGestureHandlerOptions {
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
distance?: number;
@ -3417,6 +3457,7 @@ interface PinchGestureHandlerOptions {
* @extends GestureHandler<PinchGestureHandler>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class PinchGestureHandler extends GestureHandler<PinchGestureHandler> {
@ -3426,6 +3467,7 @@ declare class PinchGestureHandler extends GestureHandler<PinchGestureHandler> {
* @param { PinchGestureHandlerOptions } options
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
constructor(options?: PinchGestureHandlerOptions);
@ -3436,6 +3478,7 @@ declare class PinchGestureHandler extends GestureHandler<PinchGestureHandler> {
* @returns { PinchGestureHandler }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onActionStart(event: Callback<GestureEvent>): PinchGestureHandler;
@ -3446,6 +3489,7 @@ declare class PinchGestureHandler extends GestureHandler<PinchGestureHandler> {
* @returns { PinchGestureHandler }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onActionUpdate(event: Callback<GestureEvent>): PinchGestureHandler;
@ -3456,6 +3500,7 @@ declare class PinchGestureHandler extends GestureHandler<PinchGestureHandler> {
* @returns { PinchGestureHandler }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onActionEnd(event: Callback<GestureEvent>): PinchGestureHandler;
@ -3466,6 +3511,7 @@ declare class PinchGestureHandler extends GestureHandler<PinchGestureHandler> {
* @returns { PinchGestureHandler }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onActionCancel(event: Callback<void>): PinchGestureHandler;
@ -3477,6 +3523,7 @@ declare class PinchGestureHandler extends GestureHandler<PinchGestureHandler> {
* @interface RotationGestureHandlerOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface RotationGestureHandlerOptions {
@ -3487,6 +3534,7 @@ interface RotationGestureHandlerOptions {
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fingers?: number;
@ -3497,6 +3545,7 @@ interface RotationGestureHandlerOptions {
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
angle?: number;
@ -3508,6 +3557,7 @@ interface RotationGestureHandlerOptions {
* @extends GestureHandler<RotationGestureHandler>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class RotationGestureHandler extends GestureHandler<RotationGestureHandler> {
@ -3517,6 +3567,7 @@ declare class RotationGestureHandler extends GestureHandler<RotationGestureHandl
* @param { RotationGestureHandlerOptions } options
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
constructor(options?: RotationGestureHandlerOptions);
@ -3527,6 +3578,7 @@ declare class RotationGestureHandler extends GestureHandler<RotationGestureHandl
* @returns { RotationGestureHandler }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onActionStart(event: Callback<GestureEvent>): RotationGestureHandler;
@ -3537,6 +3589,7 @@ declare class RotationGestureHandler extends GestureHandler<RotationGestureHandl
* @returns { RotationGestureHandler }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onActionUpdate(event: Callback<GestureEvent>): RotationGestureHandler;
@ -3547,6 +3600,7 @@ declare class RotationGestureHandler extends GestureHandler<RotationGestureHandl
* @returns { RotationGestureHandler }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onActionEnd(event: Callback<GestureEvent>): RotationGestureHandler;
@ -3557,6 +3611,7 @@ declare class RotationGestureHandler extends GestureHandler<RotationGestureHandl
* @returns { RotationGestureHandler }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onActionCancel(event: Callback<void>): RotationGestureHandler;
@ -3568,6 +3623,7 @@ declare class RotationGestureHandler extends GestureHandler<RotationGestureHandl
* @interface GestureGroupGestureHandlerOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface GestureGroupGestureHandlerOptions {
@ -3577,6 +3633,7 @@ interface GestureGroupGestureHandlerOptions {
* @type { GestureMode }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
mode: GestureMode;
@ -3586,6 +3643,7 @@ interface GestureGroupGestureHandlerOptions {
* @type { GestureHandler<TapGestureHandler | LongPressGestureHandler | PanGestureHandler | SwipeGestureHandler | PinchGestureHandler | RotationGestureHandler | GestureGroupHandler>[] }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
gestures: GestureHandler<TapGestureHandler | LongPressGestureHandler | PanGestureHandler | SwipeGestureHandler | PinchGestureHandler | RotationGestureHandler | GestureGroupHandler>[];
@ -3597,6 +3655,7 @@ interface GestureGroupGestureHandlerOptions {
* @extends GestureHandler<GestureGroupHandler>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class GestureGroupHandler extends GestureHandler<GestureGroupHandler> {
@ -3606,6 +3665,7 @@ declare class GestureGroupHandler extends GestureHandler<GestureGroupHandler> {
* @param { GestureGroupGestureHandlerOptions } options
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
constructor(options?: GestureGroupGestureHandlerOptions);
@ -3616,6 +3676,7 @@ declare class GestureGroupHandler extends GestureHandler<GestureGroupHandler> {
* @returns { GestureGroupHandler }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onCancel(event: Callback<void>): GestureGroupHandler;
@ -3627,6 +3688,7 @@ declare class GestureGroupHandler extends GestureHandler<GestureGroupHandler> {
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum GesturePriority {
@ -3635,6 +3697,7 @@ declare enum GesturePriority {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
NORMAL = 0,
@ -3643,6 +3706,7 @@ declare enum GesturePriority {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
PRIORITY = 1,
@ -3654,6 +3718,7 @@ declare enum GesturePriority {
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum GestureRecognizerState {
@ -3662,6 +3727,7 @@ declare enum GestureRecognizerState {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
READY = 0,
@ -3670,6 +3736,7 @@ declare enum GestureRecognizerState {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
DETECTING = 1,
@ -3678,6 +3745,7 @@ declare enum GestureRecognizerState {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
PENDING = 2,
@ -3686,6 +3754,7 @@ declare enum GestureRecognizerState {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
BLOCKED = 3,
@ -3694,6 +3763,7 @@ declare enum GestureRecognizerState {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
SUCCESSFUL = 4,
@ -3702,6 +3772,7 @@ declare enum GestureRecognizerState {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
FAILED = 5,
@ -3713,6 +3784,7 @@ declare enum GestureRecognizerState {
* @extends EventTargetInfo
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class ScrollableTargetInfo extends EventTargetInfo {
@ -3722,6 +3794,7 @@ declare class ScrollableTargetInfo extends EventTargetInfo {
* @returns { boolean } - true is at begin, false is not at begin
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
isBegin(): boolean;
@ -3731,6 +3804,7 @@ declare class ScrollableTargetInfo extends EventTargetInfo {
* @returns { boolean } - true is at end, false is not at end
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
isEnd(): boolean;
@ -3741,6 +3815,7 @@ declare class ScrollableTargetInfo extends EventTargetInfo {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class EventTargetInfo {
@ -3750,6 +3825,7 @@ declare class EventTargetInfo {
* @returns { string } - the inspector id of the component
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
getId(): string;
@ -3760,6 +3836,7 @@ declare class EventTargetInfo {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class GestureRecognizer {
@ -3769,6 +3846,7 @@ declare class GestureRecognizer {
* @returns { string } - the gesture's tag
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
getTag(): string;
@ -3778,6 +3856,7 @@ declare class GestureRecognizer {
* @returns { GestureControl.GestureType } - the gesture's type
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
getType(): GestureControl.GestureType;
@ -3787,6 +3866,7 @@ declare class GestureRecognizer {
* @returns { boolean } - true is built in recognizer, false is not built in recognizer
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
isBuiltIn(): boolean;
@ -3796,6 +3876,7 @@ declare class GestureRecognizer {
* @param { boolean } isEnabled - Indicates the enabled state.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
setEnabled(isEnabled: boolean): void;
@ -3805,6 +3886,7 @@ declare class GestureRecognizer {
* @returns { boolean } - true is enabled, false is not enabled
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
isEnabled(): boolean;
@ -3814,6 +3896,7 @@ declare class GestureRecognizer {
* @returns { GestureRecognizerState } - the gesture recognizer's state
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
getState(): GestureRecognizerState;
@ -3823,6 +3906,7 @@ declare class GestureRecognizer {
* @returns { EventTargetInfo } - the event target information of the component.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
getEventTargetInfo(): EventTargetInfo;
@ -3834,6 +3918,7 @@ declare class GestureRecognizer {
* @extends GestureRecognizer
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class PanRecognizer extends GestureRecognizer {
@ -3843,6 +3928,7 @@ declare class PanRecognizer extends GestureRecognizer {
* @returns { PanGestureOptions } - Pan gesture options
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
getPanGestureOptions(): PanGestureOptions;

8
api/@internal/component/ets/image.d.ts vendored
View File

@ -39,6 +39,7 @@ declare type DrawableDescriptor = import ('../api/@ohos.arkui.drawableDescriptor
* @typedef DrawingColorFilter
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare type DrawingColorFilter = import('../api/@ohos.graphics.drawing').default.ColorFilter;
@ -172,6 +173,7 @@ declare enum ImageContent {
/**
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
declare enum DynamicRangeMode {
@ -179,6 +181,7 @@ declare enum DynamicRangeMode {
* Allow image content to use an unrestricted extended range.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
HIGH = 0,
@ -187,6 +190,7 @@ declare enum DynamicRangeMode {
* Allow image content to use some extended range.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
CONSTRAINT = 1,
@ -195,6 +199,7 @@ declare enum DynamicRangeMode {
* Restrict the image content dynamic range to the standard range.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
STANDARD = 2,
@ -443,6 +448,7 @@ interface ImageInterface {
* @param { ImageAIOptions } imageAIOptions
* @returns { ImageAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
(src: PixelMap | ResourceStr | DrawableDescriptor, imageAIOptions: ImageAIOptions): ImageAttribute;
@ -812,6 +818,7 @@ declare class ImageAttribute extends CommonMethod<ImageAttribute> {
* @param { DynamicRangeMode } value - Indicates the resizable options.
* @returns { ImageAttribute } Returns the instance of the ImageAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
dynamicRangeMode(value: DynamicRangeMode): ImageAttribute;
@ -1511,6 +1518,7 @@ declare class ImageAttribute extends CommonMethod<ImageAttribute> {
* @returns { ImageAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @atomicservice
* @since 12
*/
privacySensitive(supported: boolean): ImageAttribute;

10
api/@internal/component/ets/image_common.d.ts vendored
View File

@ -23,6 +23,7 @@
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
declare enum ImageAnalyzerType {
@ -30,6 +31,7 @@ declare enum ImageAnalyzerType {
* Image analyze type subject.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
SUBJECT = 0,
@ -38,6 +40,7 @@ declare enum ImageAnalyzerType {
* Image analyze type text.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
TEXT,
@ -46,6 +49,7 @@ declare enum ImageAnalyzerType {
* Image analyze type object lookup.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
OBJECT_LOOKUP,
@ -55,6 +59,7 @@ declare enum ImageAnalyzerType {
* Image analyzer controller.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
declare class ImageAnalyzerController {
@ -62,6 +67,7 @@ declare class ImageAnalyzerController {
* Constructor.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
constructor();
@ -71,6 +77,7 @@ declare class ImageAnalyzerController {
*
* @returns { ImageAnalyzerType[] }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
getImageAnalyzerSupportTypes(): ImageAnalyzerType[];
@ -101,6 +108,7 @@ declare interface ImageAnalyzerConfig {
*
* @interface ImageAIOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
declare interface ImageAIOptions {
@ -109,6 +117,7 @@ declare interface ImageAIOptions {
*
* @type { ?ImageAnalyzerType[] }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
types?: ImageAnalyzerType[];
@ -118,6 +127,7 @@ declare interface ImageAIOptions {
*
* @type { ?ImageAnalyzerController }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
aiController?: ImageAnalyzerController;

14
api/@internal/component/ets/image_span.d.ts vendored
View File

@ -138,6 +138,7 @@ declare class ImageSpanAttribute extends BaseSpan<ImageSpanAttribute> {
* @returns { ImageSpanAttribute } The attribute of the image span.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onComplete(callback: ImageCompleteCallback): ImageSpanAttribute;
@ -150,6 +151,7 @@ declare class ImageSpanAttribute extends BaseSpan<ImageSpanAttribute> {
* @returns { ImageSpanAttribute } The attribute of the image span.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onError(callback: ImageErrorCallback): ImageSpanAttribute;
@ -160,6 +162,7 @@ declare class ImageSpanAttribute extends BaseSpan<ImageSpanAttribute> {
* @param { PixelMap } value
* @returns { ImageSpanAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
alt(value: PixelMap): ImageSpanAttribute;
@ -206,6 +209,7 @@ declare const ImageSpanInstance: ImageSpanAttribute;
* @param { ImageLoadResult } result - the information about the successfully loaded image.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
type ImageCompleteCallback = (result: ImageLoadResult) => void;
@ -216,6 +220,7 @@ type ImageCompleteCallback = (result: ImageLoadResult) => void;
* @interface ImageLoadResult
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface ImageLoadResult {
@ -225,6 +230,7 @@ declare interface ImageLoadResult {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
width: number;
@ -234,6 +240,7 @@ declare interface ImageLoadResult {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
height: number;
@ -243,6 +250,7 @@ declare interface ImageLoadResult {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
componentWidth: number;
@ -252,6 +260,7 @@ declare interface ImageLoadResult {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
componentHeight: number;
@ -263,6 +272,7 @@ declare interface ImageLoadResult {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
loadingStatus: number;
@ -272,6 +282,7 @@ declare interface ImageLoadResult {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
contentWidth: number;
@ -281,6 +292,7 @@ declare interface ImageLoadResult {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
contentHeight: number;
@ -290,6 +302,7 @@ declare interface ImageLoadResult {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
contentOffsetX: number;
@ -299,6 +312,7 @@ declare interface ImageLoadResult {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
contentOffsetY: number;

41
api/@internal/component/ets/lazy_for_each.d.ts vendored
View File

@ -24,6 +24,7 @@
* @enum { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum DataOperationType {
@ -32,6 +33,7 @@ declare enum DataOperationType {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
ADD = 'add',
@ -41,6 +43,7 @@ declare enum DataOperationType {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
DELETE = 'delete',
@ -50,6 +53,7 @@ declare enum DataOperationType {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
EXCHANGE = 'exchange',
@ -59,6 +63,7 @@ declare enum DataOperationType {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
MOVE = 'move',
@ -68,6 +73,7 @@ declare enum DataOperationType {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
CHANGE = 'change',
@ -77,6 +83,7 @@ declare enum DataOperationType {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
RELOAD = 'reload'
@ -88,6 +95,7 @@ declare enum DataOperationType {
* @interface DataAddOperation
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface DataAddOperation {
@ -97,6 +105,7 @@ interface DataAddOperation {
* @type { DataOperationType.ADD }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
type: DataOperationType.ADD,
@ -107,6 +116,7 @@ interface DataAddOperation {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
index: number,
@ -119,6 +129,7 @@ interface DataAddOperation {
* @default 1
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
count?: number,
@ -129,6 +140,7 @@ interface DataAddOperation {
* @type { ?(string | Array<string>) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
key?: string | Array<string>
@ -140,6 +152,7 @@ interface DataAddOperation {
* @interface DataDeleteOperation
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface DataDeleteOperation {
@ -149,6 +162,7 @@ interface DataDeleteOperation {
* @type { DataOperationType.DELETE }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
type: DataOperationType.DELETE,
@ -159,6 +173,7 @@ interface DataDeleteOperation {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
index: number,
@ -171,6 +186,7 @@ interface DataDeleteOperation {
* @default 1
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
count?: number
@ -182,6 +198,7 @@ interface DataDeleteOperation {
* @interface DataChangeOperation
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface DataChangeOperation {
@ -191,6 +208,7 @@ interface DataChangeOperation {
* @type { DataOperationType.CHANGE }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
type: DataOperationType.CHANGE,
@ -201,6 +219,7 @@ interface DataChangeOperation {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
index: number,
@ -211,6 +230,7 @@ interface DataChangeOperation {
* @type { ?string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
key?: string
@ -222,6 +242,7 @@ interface DataChangeOperation {
* @interface MoveIndex
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface MoveIndex {
@ -231,6 +252,7 @@ interface MoveIndex {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
from: number;
@ -240,6 +262,7 @@ interface MoveIndex {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
to: number;
@ -251,6 +274,7 @@ interface MoveIndex {
* @interface ExchangeIndex
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface ExchangeIndex {
@ -260,6 +284,7 @@ interface ExchangeIndex {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
start: number;
@ -269,6 +294,7 @@ interface ExchangeIndex {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
end: number;
@ -280,6 +306,7 @@ interface ExchangeIndex {
* @interface ExchangeKey
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface ExchangeKey {
@ -289,6 +316,7 @@ interface ExchangeKey {
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
start: string;
@ -298,6 +326,7 @@ interface ExchangeKey {
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
end: string;
@ -309,6 +338,7 @@ interface ExchangeKey {
* @interface DataMoveOperation
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface DataMoveOperation {
@ -318,6 +348,7 @@ interface DataMoveOperation {
* @type { DataOperationType.MOVE }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
type: DataOperationType.MOVE,
@ -328,6 +359,7 @@ interface DataMoveOperation {
* @type { MoveIndex }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
index: MoveIndex,
@ -338,6 +370,7 @@ interface DataMoveOperation {
* @type { ?string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
key?: string
@ -349,6 +382,7 @@ interface DataMoveOperation {
* @interface DataExchangeOperation
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface DataExchangeOperation {
@ -358,6 +392,7 @@ interface DataMoveOperation {
* @type { DataOperationType.EXCHANGE }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
type: DataOperationType.EXCHANGE,
@ -368,6 +403,7 @@ interface DataMoveOperation {
* @type { ExchangeIndex }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
index: ExchangeIndex,
@ -378,6 +414,7 @@ interface DataMoveOperation {
* @type { ?ExchangeKey }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
key?: ExchangeKey
@ -389,6 +426,7 @@ interface DataMoveOperation {
* @interface DataReloadOperation
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface DataReloadOperation {
@ -398,6 +436,7 @@ interface DataReloadOperation {
* @type { DataOperationType.RELOAD }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
type: DataOperationType.RELOAD
@ -408,6 +447,7 @@ interface DataReloadOperation {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare type DataOperation =
@ -619,6 +659,7 @@ declare interface DataChangeListener {
* @param { DataOperation[] } dataOperations
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onDatasetChange(dataOperations: DataOperation[]): void;

1
api/@internal/component/ets/linearindicator.d.ts vendored
View File

@ -218,6 +218,7 @@ interface LinearIndicatorInterface {
* @extends CommonMethod<LinearIndicatorAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class LinearIndicatorAttribute extends CommonMethod<LinearIndicatorAttribute> {

2
api/@internal/component/ets/list.d.ts vendored
View File

@ -1115,6 +1115,7 @@ declare class ListAttribute extends ScrollableCommonMethod<ListAttribute> {
* @returns { ListAttribute } the attribute of the list.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fadingEdge(value: Optional<boolean>): ListAttribute;
@ -1561,6 +1562,7 @@ declare class ListAttribute extends ScrollableCommonMethod<ListAttribute> {
* @returns { ListAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onScrollVisibleContentChange(handler: OnScrollVisibleContentChangeCallback): ListAttribute;

1
api/@internal/component/ets/list_item_group.d.ts vendored
View File

@ -328,6 +328,7 @@ declare class ListItemGroupAttribute extends CommonMethod<ListItemGroupAttribute
* @returns { ListItemGroupAttribute } the attribute of the ListItemGroup.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
childrenMainSize(value: ChildrenMainSize): ListItemGroupAttribute;

3
api/@internal/component/ets/loading_progress.d.ts vendored
View File

@ -325,6 +325,7 @@ declare class LoadingProgressAttribute extends CommonMethod<LoadingProgressAttri
* @returns { LoadingProgressAttribute} the attribute of the loading progress
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
contentModifier(modifier: ContentModifier<LoadingProgressConfiguration>): LoadingProgressAttribute;
@ -336,6 +337,7 @@ declare class LoadingProgressAttribute extends CommonMethod<LoadingProgressAttri
* @interface LoadingProgressConfiguration
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface LoadingProgressConfiguration extends CommonConfiguration<LoadingProgressConfiguration> {
@ -345,6 +347,7 @@ declare interface LoadingProgressConfiguration extends CommonConfiguration<Loadi
* @type { boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
enableLoading: boolean;

1
api/@internal/component/ets/marquee.d.ts vendored
View File

@ -336,6 +336,7 @@ declare class MarqueeAttribute extends CommonMethod<MarqueeAttribute> {
* @returns { MarqueeAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
marqueeUpdateStrategy(value: MarqueeUpdateStrategy): MarqueeAttribute;

1
api/@internal/component/ets/matrix2d.d.ts vendored
View File

@ -531,6 +531,7 @@ declare class Matrix2D {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
constructor(unit: LengthMetricsUnit);

7
api/@internal/component/ets/menu.d.ts vendored
View File

@ -76,6 +76,7 @@ interface MenuInterface {
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum SubMenuExpandingMode {
@ -84,6 +85,7 @@ declare enum SubMenuExpandingMode {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
SIDE_EXPAND = 0,
@ -93,6 +95,7 @@ declare enum SubMenuExpandingMode {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
EMBEDDED_EXPAND = 1,
@ -102,6 +105,7 @@ declare enum SubMenuExpandingMode {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
STACK_EXPAND = 2,
@ -218,6 +222,7 @@ declare class MenuAttribute extends CommonMethod<MenuAttribute> {
* @returns { MenuAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
menuItemDivider(options: DividerStyleOptions | undefined): MenuAttribute;
@ -229,6 +234,7 @@ declare class MenuAttribute extends CommonMethod<MenuAttribute> {
* @returns { MenuAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
menuItemGroupDivider(options: DividerStyleOptions | undefined): MenuAttribute;
@ -240,6 +246,7 @@ declare class MenuAttribute extends CommonMethod<MenuAttribute> {
* @returns { MenuAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
subMenuExpandingMode(mode: SubMenuExpandingMode): MenuAttribute;

2
api/@internal/component/ets/menu_item.d.ts vendored
View File

@ -75,6 +75,7 @@ declare interface MenuItemOptions {
* @type { ?SymbolGlyphModifier }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
symbolStartIcon?: SymbolGlyphModifier;
@ -137,6 +138,7 @@ declare interface MenuItemOptions {
* @type { ?SymbolGlyphModifier }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
symbolEndIcon?: SymbolGlyphModifier;

13
api/@internal/component/ets/nav_destination.d.ts vendored
View File

@ -285,6 +285,7 @@ declare interface NavDestinationInterface {
* @interface RouteMapConfig
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface RouteMapConfig {
@ -294,6 +295,7 @@ declare interface RouteMapConfig {
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
name: string;
@ -304,6 +306,7 @@ declare interface RouteMapConfig {
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
pageSourceFile: string;
@ -314,6 +317,7 @@ declare interface RouteMapConfig {
* @type { Object }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
data: Object
@ -357,6 +361,7 @@ declare interface NavDestinationContext {
* @type { ?string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
navDestinationId?: string;
@ -369,6 +374,7 @@ declare interface NavDestinationContext {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
getConfigInRouteMap(): RouteMapConfig | undefined;
@ -580,6 +586,7 @@ declare class NavDestinationAttribute extends CommonMethod<NavDestinationAttribu
* @returns { NavDestinationAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
menus(value: Array<NavigationMenuItem> | CustomBuilder): NavDestinationAttribute;
@ -604,6 +611,7 @@ declare class NavDestinationAttribute extends CommonMethod<NavDestinationAttribu
* @returns { NavDestinationAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onWillAppear(callback: Callback<void>): NavDestinationAttribute;
@ -615,6 +623,7 @@ declare class NavDestinationAttribute extends CommonMethod<NavDestinationAttribu
* @returns { NavDestinationAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onWillDisappear(callback: Callback<void>): NavDestinationAttribute;
@ -626,6 +635,7 @@ declare class NavDestinationAttribute extends CommonMethod<NavDestinationAttribu
* @returns { NavDestinationAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onWillShow(callback: Callback<void>): NavDestinationAttribute;
@ -637,6 +647,7 @@ declare class NavDestinationAttribute extends CommonMethod<NavDestinationAttribu
* @returns { NavDestinationAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onWillHide(callback: Callback<void>): NavDestinationAttribute;
@ -649,6 +660,7 @@ declare class NavDestinationAttribute extends CommonMethod<NavDestinationAttribu
* @returns { NavDestinationAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
ignoreLayoutSafeArea(types?: Array<LayoutSafeAreaType>, edges?: Array<LayoutSafeAreaEdge>): NavDestinationAttribute;
@ -659,6 +671,7 @@ declare class NavDestinationAttribute extends CommonMethod<NavDestinationAttribu
* @param { Optional<SystemBarStyle> } style - The properties of system bar
* @returns { NavDestinationAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
systemBarStyle(style: Optional<SystemBarStyle>): NavDestinationAttribute;

19
api/@internal/component/ets/navigation.d.ts vendored
View File

@ -23,6 +23,7 @@
*
* @typedef { import('../api/@ohos.window').default.SystemBarStyle } SystemBarStyle
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
declare type SystemBarStyle = import('../api/@ohos.window').default.SystemBarStyle;
@ -734,6 +735,7 @@ declare class NavPathInfo {
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum LaunchMode {
@ -742,6 +744,7 @@ declare enum LaunchMode {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
STANDARD = 0,
@ -752,6 +755,7 @@ declare enum LaunchMode {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
MOVE_TO_TOP_SINGLETON = 1,
@ -762,6 +766,7 @@ declare enum LaunchMode {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
POP_TO_SINGLETON = 2,
@ -771,6 +776,7 @@ declare enum LaunchMode {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
NEW_INSTANCE = 3,
@ -782,6 +788,7 @@ declare enum LaunchMode {
* @interface NavigationOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface NavigationOptions {
@ -791,6 +798,7 @@ declare interface NavigationOptions {
* @type { ?LaunchMode }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
launchMode?: LaunchMode;
@ -801,6 +809,7 @@ declare interface NavigationOptions {
* @type { ?boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
animated?: boolean;
@ -866,6 +875,7 @@ declare class NavPathStack {
* @param { NavigationOptions } [options] - Indicates options of stack operation.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
pushPath(info: NavPathInfo, options?: NavigationOptions): void;
@ -922,6 +932,7 @@ declare class NavPathStack {
* @throws { BusinessError } 100006 - NavDestination not found.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
pushDestination(info: NavPathInfo, options?: NavigationOptions): Promise<void>;
@ -1081,6 +1092,7 @@ declare class NavPathStack {
* @param { NavigationOptions } [options] - Indicates options of stack operation.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
replacePath(info: NavPathInfo, options?: NavigationOptions): void;
@ -2620,6 +2632,7 @@ declare class NavigationAttribute extends CommonMethod<NavigationAttribute> {
* @param { Optional<SystemBarStyle> } style - The properties of system bar
* @returns { NavigationAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
systemBarStyle(style: Optional<SystemBarStyle>): NavigationAttribute;
@ -2688,6 +2701,7 @@ declare interface NavigationAnimatedTransition {
* @default false
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
isInteractive?: boolean;
@ -2775,6 +2789,7 @@ declare interface NavigationTransitionProxy {
* @default false
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
isInteractive?: boolean;
@ -2801,6 +2816,7 @@ declare interface NavigationTransitionProxy {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
cancelTransition?(): void;
@ -2811,6 +2827,7 @@ declare interface NavigationTransitionProxy {
* @param { number } progress - The progress of transition animation.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
updateTransition?(progress: number): void;
@ -2897,6 +2914,7 @@ declare interface NavContentInfo {
* @type { ?Object }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
param?: Object;
@ -2907,6 +2925,7 @@ declare interface NavContentInfo {
* @type { ?string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
navDestinationId?: string;

2
api/@internal/component/ets/page_transition.d.ts vendored
View File

@ -235,6 +235,7 @@ declare enum SlideEffect {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
START = 5,
@ -244,6 +245,7 @@ declare enum SlideEffect {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
END = 6,

23
api/@internal/component/ets/particle.d.ts vendored
View File

@ -341,6 +341,7 @@ interface ParticleConfigs {
* @interface EmitterProperty
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface EmitterProperty {
@ -351,6 +352,7 @@ interface EmitterProperty {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
index : number;
@ -361,6 +363,7 @@ interface EmitterProperty {
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
emitRate?: number;
@ -371,6 +374,7 @@ interface EmitterProperty {
* @type { ?PositionT<number> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
position?: PositionT<number>;
@ -381,6 +385,7 @@ interface EmitterProperty {
* @type { ?SizeT<number> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
size?: SizeT<number>;
@ -494,6 +499,7 @@ interface EmitterOptions<PARTICLE extends ParticleType> {
* @default 0
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
lifetimeRange?: number;
@ -818,6 +824,7 @@ interface ParticleColorPropertyOptions<UPDATER extends ParticleUpdater> {
* @default DistributionType.UNIFORM
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
distributionType?: DistributionType;
@ -1122,6 +1129,7 @@ declare enum ParticleEmitterShape {
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum DistributionType {
@ -1130,6 +1138,7 @@ declare enum DistributionType {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
UNIFORM = 0,
@ -1139,6 +1148,7 @@ declare enum DistributionType {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
GAUSSIAN = 1,
@ -1290,6 +1300,7 @@ declare const Particle: ParticleInterface;
* @interface DisturbanceFieldOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface DisturbanceFieldOptions {
@ -1303,6 +1314,7 @@ declare interface DisturbanceFieldOptions {
* @default 0
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
strength?: number;
@ -1314,6 +1326,7 @@ declare interface DisturbanceFieldOptions {
* @default DisturbanceFieldShape.RECT
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
shape?: DisturbanceFieldShape;
@ -1325,6 +1338,7 @@ declare interface DisturbanceFieldOptions {
* @default {width:0,height:0}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
size?: SizeT<number>;
@ -1336,6 +1350,7 @@ declare interface DisturbanceFieldOptions {
* @default {x:0,y:0}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
position?: PositionT<number>;
@ -1351,6 +1366,7 @@ declare interface DisturbanceFieldOptions {
* @default 0
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
feather?: number;
@ -1362,6 +1378,7 @@ declare interface DisturbanceFieldOptions {
* @default 1
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
noiseScale?: number;
@ -1373,6 +1390,7 @@ declare interface DisturbanceFieldOptions {
* @default 1
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
noiseFrequency?: number;
@ -1384,6 +1402,7 @@ declare interface DisturbanceFieldOptions {
* @default 1
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
noiseAmplitude?: number;
@ -1395,6 +1414,7 @@ declare interface DisturbanceFieldOptions {
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum DisturbanceFieldShape {
@ -1404,6 +1424,7 @@ declare enum DisturbanceFieldShape {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
RECT,
@ -1413,6 +1434,7 @@ declare enum DisturbanceFieldShape {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
CIRCLE,
@ -1422,6 +1444,7 @@ declare enum DisturbanceFieldShape {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
ELLIPSE

212
api/@internal/component/ets/pattern_lock.d.ts vendored
View File

@ -25,6 +25,14 @@
* @crossplatform
* @since 11
*/
/**
* The challenge result based on input pattern for control pattern lock component.
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum PatternLockChallengeResult {
/**
* The challenge result is correct.
@ -32,6 +40,13 @@ declare enum PatternLockChallengeResult {
* @crossplatform
* @since 11
*/
/**
* The challenge result is correct.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
CORRECT = 1,
/**
* The challenge result is wrong.
@ -39,6 +54,13 @@ declare enum PatternLockChallengeResult {
* @crossplatform
* @since 11
*/
/**
* The challenge result is wrong.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
WRONG = 2
}
@ -48,6 +70,7 @@ declare enum PatternLockChallengeResult {
* @interface CircleStyleOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface CircleStyleOptions {
@ -57,6 +80,7 @@ declare interface CircleStyleOptions {
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
color?: ResourceColor;
@ -67,6 +91,7 @@ declare interface CircleStyleOptions {
* @type { ?LengthMetrics }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
radius?: LengthMetrics;
@ -77,6 +102,7 @@ declare interface CircleStyleOptions {
* @type { ?boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
enableWaveEffect?: boolean;
@ -95,6 +121,14 @@ declare interface CircleStyleOptions {
* @crossplatform
* @since 10
*/
/**
* Provides methods for control pattern lock component.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class PatternLockController {
/**
* constructor.
@ -109,6 +143,14 @@ declare class PatternLockController {
* @crossplatform
* @since 10
*/
/**
* constructor.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
constructor();
/**
@ -124,6 +166,14 @@ declare class PatternLockController {
* @crossplatform
* @since 10
*/
/**
* Reset pattern lock.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
reset();
/**
@ -133,6 +183,14 @@ declare class PatternLockController {
* @crossplatform
* @since 11
*/
/**
* Set challenge result.
* @param { PatternLockChallengeResult } result - The challenge result based on input pattern.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
setChallengeResult(result: PatternLockChallengeResult): void;
}
@ -151,6 +209,15 @@ declare class PatternLockController {
* @crossplatform
* @since 10
*/
/**
* Provides an interface for generating PatternLock.
*
* @interface PatternLockInterface
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface PatternLockInterface {
/**
* Constructor.
@ -169,6 +236,16 @@ interface PatternLockInterface {
* @crossplatform
* @since 10
*/
/**
* Constructor.
*
* @param { PatternLockController } [controller] controller
* @returns { PatternLockAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
(controller?: PatternLockController): PatternLockAttribute;
}
@ -187,6 +264,15 @@ interface PatternLockInterface {
* @crossplatform
* @since 10
*/
/**
* Provides methods for attribute pattern lock component.
*
* @extends CommonMethod<PatternLockAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class PatternLockAttribute extends CommonMethod<PatternLockAttribute> {
/**
* The square side length of pattern lock component.
@ -205,6 +291,16 @@ declare class PatternLockAttribute extends CommonMethod<PatternLockAttribute> {
* @crossplatform
* @since 10
*/
/**
* The square side length of pattern lock component.
*
* @param { Length } value
* @returns { PatternLockAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
sideLength(value: Length): PatternLockAttribute;
/**
@ -224,6 +320,16 @@ declare class PatternLockAttribute extends CommonMethod<PatternLockAttribute> {
* @crossplatform
* @since 10
*/
/**
* Circle radius.
*
* @param { Length } value
* @returns { PatternLockAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
circleRadius(value: Length): PatternLockAttribute;
/**
@ -243,6 +349,16 @@ declare class PatternLockAttribute extends CommonMethod<PatternLockAttribute> {
* @crossplatform
* @since 10
*/
/**
* The background color.
*
* @param { ResourceColor } value
* @returns { PatternLockAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
backgroundColor(value: ResourceColor): PatternLockAttribute;
/**
@ -262,6 +378,16 @@ declare class PatternLockAttribute extends CommonMethod<PatternLockAttribute> {
* @crossplatform
* @since 10
*/
/**
* Regular color.
*
* @param { ResourceColor } value
* @returns { PatternLockAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
regularColor(value: ResourceColor): PatternLockAttribute;
/**
@ -281,6 +407,16 @@ declare class PatternLockAttribute extends CommonMethod<PatternLockAttribute> {
* @crossplatform
* @since 10
*/
/**
* The color when cell is selected.
*
* @param { ResourceColor } value
* @returns { PatternLockAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
selectedColor(value: ResourceColor): PatternLockAttribute;
/**
@ -300,6 +436,16 @@ declare class PatternLockAttribute extends CommonMethod<PatternLockAttribute> {
* @crossplatform
* @since 10
*/
/**
* The color when cell is active state.
*
* @param { ResourceColor } value
* @returns { PatternLockAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
activeColor(value: ResourceColor): PatternLockAttribute;
/**
@ -319,6 +465,16 @@ declare class PatternLockAttribute extends CommonMethod<PatternLockAttribute> {
* @crossplatform
* @since 10
*/
/**
* The path line color.
*
* @param { ResourceColor } value
* @returns { PatternLockAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
pathColor(value: ResourceColor): PatternLockAttribute;
/**
@ -338,6 +494,16 @@ declare class PatternLockAttribute extends CommonMethod<PatternLockAttribute> {
* @crossplatform
* @since 10
*/
/**
* The path line stroke width.
*
* @param { number | string } value
* @returns { PatternLockAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
pathStrokeWidth(value: number | string): PatternLockAttribute;
/**
@ -357,6 +523,16 @@ declare class PatternLockAttribute extends CommonMethod<PatternLockAttribute> {
* @crossplatform
* @since 10
*/
/**
* Called when the pattern input completed.
*
* @param { function } callback
* @returns { PatternLockAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onPatternComplete(callback: (input: Array<number>) => void): PatternLockAttribute;
/**
@ -376,6 +552,16 @@ declare class PatternLockAttribute extends CommonMethod<PatternLockAttribute> {
* @crossplatform
* @since 10
*/
/**
* Called when judging whether the input state can be reset by touch pattern lock.
*
* @param { boolean } value
* @returns { PatternLockAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
autoReset(value: boolean): PatternLockAttribute;
/**
@ -386,6 +572,15 @@ declare class PatternLockAttribute extends CommonMethod<PatternLockAttribute> {
* @crossplatform
* @since 11
*/
/**
* Called when connecting to a grid dot.
* @param { import('../api/@ohos.base').Callback<number> } callback - A callback instance used when connection to a grid dot.
* @returns { PatternLockAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onDotConnect(callback: import('../api/@ohos.base').Callback<number>): PatternLockAttribute;
/**
@ -395,6 +590,7 @@ declare class PatternLockAttribute extends CommonMethod<PatternLockAttribute> {
* @returns { PatternLockAttribute } PatternLockAttribute
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
activateCircleStyle(options: Optional<CircleStyleOptions>): PatternLockAttribute;
@ -413,6 +609,14 @@ declare class PatternLockAttribute extends CommonMethod<PatternLockAttribute> {
* @crossplatform
* @since 10
*/
/**
* Defines PatternLock Component.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare const PatternLock: PatternLockInterface;
/**
@ -428,4 +632,12 @@ declare const PatternLock: PatternLockInterface;
* @crossplatform
* @since 10
*/
/**
* Defines PatternLock Component instance.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare const PatternLockInstance: PatternLockAttribute;

5
api/@internal/component/ets/progress.d.ts vendored
View File

@ -1513,6 +1513,7 @@ declare class ProgressAttribute<Type extends keyof ProgressStyleMap = keyof Prog
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
privacySensitive(isPrivacySensitiveMode: Optional<boolean>): ProgressAttribute<Type>;
@ -1524,6 +1525,7 @@ declare class ProgressAttribute<Type extends keyof ProgressStyleMap = keyof Prog
* @returns { ProgressAttribute<Type> } the attribute of the progress.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
contentModifier(modifier: ContentModifier<ProgressConfiguration>): ProgressAttribute<Type>;
@ -1535,6 +1537,7 @@ declare class ProgressAttribute<Type extends keyof ProgressStyleMap = keyof Prog
* @interface ProgressConfiguration
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface ProgressConfiguration extends CommonConfiguration<ProgressConfiguration> {
@ -1544,6 +1547,7 @@ declare interface ProgressConfiguration extends CommonConfiguration<ProgressConf
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
value: number;
@ -1554,6 +1558,7 @@ declare interface ProgressConfiguration extends CommonConfiguration<ProgressConf
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
total: number;

11
api/@internal/component/ets/radio.d.ts vendored
View File

@ -25,6 +25,7 @@
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
declare enum RadioIndicatorType {
@ -34,6 +35,7 @@ declare enum RadioIndicatorType {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
TICK = 0,
@ -43,6 +45,7 @@ declare enum RadioIndicatorType {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
DOT = 1,
@ -52,6 +55,7 @@ declare enum RadioIndicatorType {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
CUSTOM = 2,
@ -170,6 +174,7 @@ declare interface RadioOptions {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
indicatorType?: RadioIndicatorType;
@ -180,6 +185,7 @@ declare interface RadioOptions {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
indicatorBuilder?: CustomBuilder;
@ -486,6 +492,7 @@ declare class RadioAttribute extends CommonMethod<RadioAttribute> {
* @returns { RadioAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
contentModifier(modifier: ContentModifier<RadioConfiguration>): RadioAttribute;
@ -497,6 +504,7 @@ declare class RadioAttribute extends CommonMethod<RadioAttribute> {
* @interface RadioConfiguration
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface RadioConfiguration extends CommonConfiguration<RadioConfiguration> {
@ -506,6 +514,7 @@ declare interface RadioConfiguration extends CommonConfiguration<RadioConfigurat
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
value: string;
@ -516,6 +525,7 @@ declare interface RadioConfiguration extends CommonConfiguration<RadioConfigurat
* @type { boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
checked: boolean;
@ -526,6 +536,7 @@ declare interface RadioConfiguration extends CommonConfiguration<RadioConfigurat
* @type { Callback<boolean> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
triggerChange: Callback<boolean>;

7
api/@internal/component/ets/rating.d.ts vendored
View File

@ -100,6 +100,7 @@ interface RatingInterface {
* @interface RatingConfiguration
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface RatingConfiguration extends CommonConfiguration<RatingConfiguration> {
@ -109,6 +110,7 @@ declare interface RatingConfiguration extends CommonConfiguration<RatingConfigur
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
rating: number;
@ -119,6 +121,7 @@ declare interface RatingConfiguration extends CommonConfiguration<RatingConfigur
* @type { boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
indicator: boolean;
@ -129,6 +132,7 @@ declare interface RatingConfiguration extends CommonConfiguration<RatingConfigur
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
stars: number;
@ -139,6 +143,7 @@ declare interface RatingConfiguration extends CommonConfiguration<RatingConfigur
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
stepSize: number;
@ -149,6 +154,7 @@ declare interface RatingConfiguration extends CommonConfiguration<RatingConfigur
* @type { Callback<number> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
triggerChange: Callback<number>;
@ -356,6 +362,7 @@ declare class RatingAttribute extends CommonMethod<RatingAttribute> {
* @returns { RatingAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
contentModifier(modifier: ContentModifier<RatingConfiguration>): RatingAttribute;

3
api/@internal/component/ets/refresh.d.ts vendored
View File

@ -265,6 +265,7 @@ interface RefreshOptions {
* @type { ?ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
promptText?: ResourceStr;
@ -459,6 +460,7 @@ declare class RefreshAttribute extends CommonMethod<RefreshAttribute> {
* @returns { RefreshAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onOffsetChange(callback: Callback<number>): RefreshAttribute;
@ -470,6 +472,7 @@ declare class RefreshAttribute extends CommonMethod<RefreshAttribute> {
* @returns { RefreshAttribute } The attribute of the Refresh.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
pullDownRatio(ratio: Optional<number>): RefreshAttribute;

4
api/@internal/component/ets/repeat.d.ts vendored
View File

@ -25,6 +25,7 @@
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
interface RepeatItem<T> {
@ -35,6 +36,7 @@ interface RepeatItem<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
item: T,
@ -45,6 +47,7 @@ interface RepeatItem<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
index: number
@ -197,6 +200,7 @@ declare class RepeatAttribute<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
declare const Repeat: <T>(arr: Array<T>) => RepeatAttribute<T>;

39
api/@internal/component/ets/rich_editor.d.ts vendored
View File

@ -427,6 +427,7 @@ declare interface RichEditorTextStyle {
* @type { ?(number | string) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
letterSpacing?: number | string;
@ -437,6 +438,7 @@ declare interface RichEditorTextStyle {
* @type { ? (number | string | Resource) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
lineHeight?: number | string | Resource;
@ -452,6 +454,7 @@ declare interface RichEditorTextStyle {
* number of <feature-tag-value> can be single or multiple, and separated by comma ','.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontFeature?: string;
@ -577,6 +580,7 @@ declare interface RichEditorParagraphStyle {
* @type { ?WordBreak }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
wordBreak?: WordBreak;
@ -587,6 +591,7 @@ declare interface RichEditorParagraphStyle {
* @type { ?LineBreakStrategy }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
lineBreakStrategy?: LineBreakStrategy;
@ -1097,6 +1102,7 @@ declare interface RichEditorTextStyleResult {
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
letterSpacing?: number;
@ -1107,6 +1113,7 @@ declare interface RichEditorTextStyleResult {
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
lineHeight?: number;
@ -1122,6 +1129,7 @@ declare interface RichEditorTextStyleResult {
* number of <feature-tag-value> can be single or multiple, and separated by comma ','.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontFeature?: string;
@ -1431,6 +1439,7 @@ declare interface RichEditorTextSpanResult {
* @type { ?RichEditorParagraphStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
paragraphStyle?: RichEditorParagraphStyle;
@ -2521,6 +2530,7 @@ declare interface RichEditorDeleteValue {
* @interface RichEditorChangeValue
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface RichEditorChangeValue {
@ -2530,6 +2540,7 @@ declare interface RichEditorChangeValue {
* @type { TextRange }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
rangeBefore: TextRange;
@ -2540,6 +2551,7 @@ declare interface RichEditorChangeValue {
* @type { Array<RichEditorTextSpanResult> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
replacedSpans: Array<RichEditorTextSpanResult>;
@ -2550,6 +2562,7 @@ declare interface RichEditorChangeValue {
* @type { Array<RichEditorImageSpanResult> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
replacedImageSpans: Array<RichEditorImageSpanResult>;
@ -2560,6 +2573,7 @@ declare interface RichEditorChangeValue {
* @type { Array<RichEditorTextSpanResult> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
replacedSymbolSpans: Array<RichEditorTextSpanResult>;
@ -2607,6 +2621,7 @@ declare interface RichEditorOptions {
* @interface RichEditorStyledStringOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface RichEditorStyledStringOptions {
@ -2616,6 +2631,7 @@ declare interface RichEditorStyledStringOptions {
* @type { RichEditorStyledStringController }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
controller: RichEditorStyledStringController;
@ -2702,6 +2718,7 @@ declare interface SelectionMenuOptions {
* @implements TextEditControllerEx
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class RichEditorBaseController implements TextEditControllerEx {
@ -2825,6 +2842,7 @@ declare class RichEditorBaseController implements TextEditControllerEx {
* @returns { boolean } - true is editing state, false is non editing status
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
isEditing(): boolean;
@ -2834,6 +2852,7 @@ declare class RichEditorBaseController implements TextEditControllerEx {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
stopEditing(): void;
@ -3137,6 +3156,7 @@ declare type RichEditorSpan = RichEditorImageSpanResult | RichEditorTextSpanResu
* @implements StyledStringController
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class RichEditorStyledStringController extends RichEditorBaseController implements StyledStringController {
@ -3146,6 +3166,7 @@ declare class RichEditorStyledStringController extends RichEditorBaseController
* @param { StyledString } styledString - StyledString.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
setStyledString(styledString: StyledString): void;
@ -3155,6 +3176,7 @@ declare class RichEditorStyledStringController extends RichEditorBaseController
*
* @returns { MutableStyledString }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
getStyledString(): MutableStyledString;
@ -3165,6 +3187,7 @@ declare class RichEditorStyledStringController extends RichEditorBaseController
* @returns { RichEditorRange }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
getSelection(): RichEditorRange;
@ -3175,6 +3198,7 @@ declare class RichEditorStyledStringController extends RichEditorBaseController
* @param { StyledStringChangedListener } listener - content changed listener.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onContentChanged(listener: StyledStringChangedListener): void;
@ -3566,6 +3590,7 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
* @returns { RichEditorAttribute } The attribute of the rich editor.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
caretColor(value: ResourceColor): RichEditorAttribute;
@ -3577,6 +3602,7 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
* @returns { RichEditorAttribute } The attribute of the rich editor.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
selectedBackgroundColor(value: ResourceColor): RichEditorAttribute;
@ -3588,6 +3614,7 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
* @returns { RichEditorAttribute } returns The attribute of the rich editor.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onEditingChange(callback: Callback<boolean>): RichEditorAttribute;
@ -3599,6 +3626,7 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
* @returns { RichEditorAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
enterKeyType(value: EnterKeyType): RichEditorAttribute;
@ -3610,6 +3638,7 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
* @returns { RichEditorAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onSubmit(callback: SubmitCallback): RichEditorAttribute;
@ -3621,6 +3650,7 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
* @returns { RichEditorAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onWillChange(callback: Callback<RichEditorChangeValue, boolean>) : RichEditorAttribute;
@ -3632,6 +3662,7 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
* @returns { RichEditorAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onDidChange(callback: OnDidChangeCallback) : RichEditorAttribute;
@ -3643,6 +3674,7 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
* @returns { RichEditorAttribute } returns the instance of the RichEditorAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onCut(callback: Callback<CutEvent>): RichEditorAttribute;
@ -3654,6 +3686,7 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
* @returns { RichEditorAttribute } returns the instance of the RichEditorAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onCopy(callback: Callback<CopyEvent>): RichEditorAttribute;
@ -3676,6 +3709,7 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
* @interface CutEvent
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface CutEvent {
@ -3685,6 +3719,7 @@ declare interface CutEvent {
* @type { ?Callback<void> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
preventDefault?: Callback<void>;
@ -3695,6 +3730,7 @@ declare interface CutEvent {
* @interface CopyEvent
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface CopyEvent {
@ -3704,6 +3740,7 @@ declare interface CopyEvent {
* @type { ?Callback<void> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
preventDefault?: Callback<void>;
@ -3717,6 +3754,7 @@ declare interface CopyEvent {
* @param { SubmitEvent } event - Provides the method of keeping RichEditor editable state when submitted.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare type SubmitCallback = (enterKey: EnterKeyType, event: SubmitEvent) => void;
@ -3790,6 +3828,7 @@ interface RichEditorInterface {
* @returns { RichEditorAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
(options: RichEditorStyledStringOptions): RichEditorAttribute;

8
api/@internal/component/ets/scroll.d.ts vendored
View File

@ -337,6 +337,7 @@ declare interface ScrollAnimationOptions {
* @interface OffsetOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface OffsetOptions {
@ -346,6 +347,7 @@ declare interface OffsetOptions {
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
xOffset?: Dimension;
@ -356,6 +358,7 @@ declare interface OffsetOptions {
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
yOffset?: Dimension;
@ -1021,6 +1024,7 @@ declare class ScrollAttribute extends ScrollableCommonMethod<ScrollAttribute> {
* @returns { ScrollAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onWillScroll(handler: ScrollOnWillScrollCallback): ScrollAttribute;
@ -1033,6 +1037,7 @@ declare class ScrollAttribute extends ScrollableCommonMethod<ScrollAttribute> {
* @returns { ScrollAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onDidScroll(handler: ScrollOnScrollCallback): ScrollAttribute;
@ -1391,6 +1396,7 @@ declare class ScrollAttribute extends ScrollableCommonMethod<ScrollAttribute> {
* @returns { ScrollAttribute } the attribute of the scroll.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
initialOffset(value: OffsetOptions): ScrollAttribute;
@ -1405,6 +1411,7 @@ declare class ScrollAttribute extends ScrollableCommonMethod<ScrollAttribute> {
* @param { ScrollState } scrollState - current scroll state.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare type ScrollOnScrollCallback = (xOffset: number, yOffset: number, scrollState: ScrollState) => void;
@ -1421,6 +1428,7 @@ declare type ScrollOnScrollCallback = (xOffset: number, yOffset: number, scrollS
* same as (xOffset, yOffset) when no OffsetResult is returned.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare type ScrollOnWillScrollCallback =

17
api/@internal/component/ets/search.d.ts vendored
View File

@ -117,6 +117,7 @@ declare class SearchController extends TextContentControllerBase {
* @param { SelectionOptions } [options] - Indicates the options of the text selection.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
setTextSelection(selectionStart: number, selectionEnd: number, options?: SelectionOptions): void;
@ -283,6 +284,7 @@ declare enum SearchType {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
NUMBER_DECIMAL = 12,
@ -774,6 +776,7 @@ declare class SearchAttribute extends CommonMethod<SearchAttribute> {
* @returns { SearchAttribute } The attribute of the text.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
textIndent(value: Dimension): SearchAttribute;
@ -786,6 +789,7 @@ declare class SearchAttribute extends CommonMethod<SearchAttribute> {
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
inputFilter(value: ResourceStr, error?: Callback<string>): SearchAttribute;
@ -797,6 +801,7 @@ declare class SearchAttribute extends CommonMethod<SearchAttribute> {
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onEditChange(callback: Callback<boolean>): SearchAttribute;
@ -808,6 +813,7 @@ declare class SearchAttribute extends CommonMethod<SearchAttribute> {
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
selectedBackgroundColor(value: ResourceColor): SearchAttribute;
@ -927,6 +933,7 @@ declare class SearchAttribute extends CommonMethod<SearchAttribute> {
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
enterKeyType(value: EnterKeyType): SearchAttribute;
@ -1259,6 +1266,7 @@ declare class SearchAttribute extends CommonMethod<SearchAttribute> {
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
minFontSize(value: number | string | Resource): SearchAttribute;
@ -1270,6 +1278,7 @@ declare class SearchAttribute extends CommonMethod<SearchAttribute> {
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
maxFontSize(value: number | string | Resource): SearchAttribute;
@ -1312,6 +1321,7 @@ declare class SearchAttribute extends CommonMethod<SearchAttribute> {
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
decoration(value: TextDecorationOptions): SearchAttribute;
@ -1323,6 +1333,7 @@ declare class SearchAttribute extends CommonMethod<SearchAttribute> {
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
letterSpacing(value: number | string | Resource): SearchAttribute;
@ -1334,6 +1345,7 @@ declare class SearchAttribute extends CommonMethod<SearchAttribute> {
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
lineHeight(value: number | string | Resource): SearchAttribute;
@ -1370,6 +1382,7 @@ declare class SearchAttribute extends CommonMethod<SearchAttribute> {
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontFeature(value: string): SearchAttribute;
@ -1381,6 +1394,7 @@ declare class SearchAttribute extends CommonMethod<SearchAttribute> {
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onWillInsert(callback: Callback<InsertValue, boolean>): SearchAttribute;
@ -1392,6 +1406,7 @@ declare class SearchAttribute extends CommonMethod<SearchAttribute> {
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onDidInsert(callback: Callback<InsertValue>): SearchAttribute;
@ -1403,6 +1418,7 @@ declare class SearchAttribute extends CommonMethod<SearchAttribute> {
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onWillDelete(callback: Callback<DeleteValue, boolean>): SearchAttribute;
@ -1414,6 +1430,7 @@ declare class SearchAttribute extends CommonMethod<SearchAttribute> {
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onDidDelete(callback: Callback<DeleteValue>): SearchAttribute;

37
api/@internal/component/ets/security_component.d.ts vendored
View File

@ -458,6 +458,15 @@ declare class SecurityComponentMethod<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Sets the width of the component.
*
* @param { Length } value - Indicates the width of the security component.
* @returns { T } Returns the attribute of the security component.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
width(value: Length): T;
/**
@ -468,6 +477,15 @@ declare class SecurityComponentMethod<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Sets the height of the component.
*
* @param { Length } value - Indicates the height of the security component.
* @returns { T } Returns the attribute of the security component.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
height(value: Length): T;
/**
@ -478,6 +496,15 @@ declare class SecurityComponentMethod<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* The size of the component.
*
* @param { SizeOptions } value - Indicates the size of the security component.
* @returns { T } Returns the attribute of the security component.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
size(value: SizeOptions): T;
/**
@ -489,5 +516,15 @@ declare class SecurityComponentMethod<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* constraint Size:
* minWidth: minimum Width, maxWidth: maximum Width, minHeight: minimum Height, maxHeight: maximum Height.
*
* @param { ConstraintSizeOptions } value - Indicates the constraint size of the security component.
* @returns { T } Returns the attribute of the security component.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
constraintSize(value: ConstraintSizeOptions): T;
}

31
api/@internal/component/ets/select.d.ts vendored
View File

@ -101,6 +101,7 @@ declare interface SelectOption {
* @type { ?SymbolGlyphModifier }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
symbolIcon?: SymbolGlyphModifier;
@ -737,6 +738,16 @@ declare class SelectAttribute extends CommonMethod<SelectAttribute> {
* @crossplatform
* @since 11
*/
/**
* set the menu's background color
*
* @param { ResourceColor } value - The backgroundColor of menu.
* @returns { SelectAttribute } the attribute of the select.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
menuBackgroundColor(value: ResourceColor): SelectAttribute;
/**
@ -748,6 +759,16 @@ declare class SelectAttribute extends CommonMethod<SelectAttribute> {
* @crossplatform
* @since 11
*/
/**
* set menu background blur Style
*
* @param { BlurStyle } value - The BackgroundBlurStyle of menu.
* @returns { SelectAttribute } the attribute of the select.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
menuBackgroundBlurStyle(value: BlurStyle): SelectAttribute;
/**
@ -757,6 +778,7 @@ declare class SelectAttribute extends CommonMethod<SelectAttribute> {
* @returns { SelectAttribute } the attribute of the select.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
controlSize(value: ControlSize): SelectAttribute;
@ -768,6 +790,7 @@ declare class SelectAttribute extends CommonMethod<SelectAttribute> {
* @returns { SelectAttribute } the attribute of the select.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
menuItemContentModifier(modifier: ContentModifier<MenuItemConfiguration>): SelectAttribute;
@ -779,6 +802,7 @@ declare class SelectAttribute extends CommonMethod<SelectAttribute> {
* @returns { SelectAttribute } the attribute of the select.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
divider(options: Optional<DividerOptions> | null): SelectAttribute;
@ -790,6 +814,7 @@ declare class SelectAttribute extends CommonMethod<SelectAttribute> {
* @interface MenuItemConfiguration
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface MenuItemConfiguration extends CommonConfiguration<MenuItemConfiguration>{
@ -799,6 +824,7 @@ declare interface MenuItemConfiguration extends CommonConfiguration<MenuItemConf
* @type { ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
value: ResourceStr;
@ -809,6 +835,7 @@ declare interface MenuItemConfiguration extends CommonConfiguration<MenuItemConf
* @type { ?ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
icon?: ResourceStr;
@ -819,6 +846,7 @@ declare interface MenuItemConfiguration extends CommonConfiguration<MenuItemConf
* @type { ?SymbolGlyphModifier }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
symbolIcon?: SymbolGlyphModifier;
@ -829,6 +857,7 @@ declare interface MenuItemConfiguration extends CommonConfiguration<MenuItemConf
* @type { boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
selected: boolean;
@ -839,6 +868,7 @@ declare interface MenuItemConfiguration extends CommonConfiguration<MenuItemConf
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
index: number;
@ -850,6 +880,7 @@ declare interface MenuItemConfiguration extends CommonConfiguration<MenuItemConf
* @param { string } value - The value of menu item text.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
triggerSelect(index: number, value: string): void;

20
api/@internal/component/ets/slider.d.ts vendored
View File

@ -122,6 +122,7 @@ declare enum SliderStyle {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
NONE,
@ -297,6 +298,7 @@ declare enum SliderChangeMode {
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum SliderInteraction {
@ -305,6 +307,7 @@ declare enum SliderInteraction {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
SLIDE_AND_CLICK,
@ -314,6 +317,7 @@ declare enum SliderInteraction {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
SLIDE_ONLY,
@ -323,6 +327,7 @@ declare enum SliderInteraction {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
SLIDE_AND_CLICK_UP = 2
@ -334,6 +339,7 @@ declare enum SliderInteraction {
* @interface SlideRange
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface SlideRange {
@ -343,6 +349,7 @@ declare interface SlideRange {
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
from?: number;
@ -353,6 +360,7 @@ declare interface SlideRange {
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
to?: number;
@ -800,6 +808,7 @@ declare interface SliderBlockStyle {
* @param { SliderChangeMode } mode - The changeMode of slider.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare type SliderTriggerChangeCallback = (value: number, mode: SliderChangeMode) => void;
@ -810,6 +819,7 @@ declare type SliderTriggerChangeCallback = (value: number, mode: SliderChangeMod
* @interface SliderConfiguration
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface SliderConfiguration extends CommonConfiguration<SliderConfiguration> {
@ -819,6 +829,7 @@ declare interface SliderConfiguration extends CommonConfiguration<SliderConfigur
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
value: number;
@ -829,6 +840,7 @@ declare interface SliderConfiguration extends CommonConfiguration<SliderConfigur
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
min: number;
@ -839,6 +851,7 @@ declare interface SliderConfiguration extends CommonConfiguration<SliderConfigur
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
max: number;
@ -849,6 +862,7 @@ declare interface SliderConfiguration extends CommonConfiguration<SliderConfigur
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
step: number;
@ -859,6 +873,7 @@ declare interface SliderConfiguration extends CommonConfiguration<SliderConfigur
* @type { SliderTriggerChangeCallback }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
triggerChange: SliderTriggerChangeCallback;
@ -1385,6 +1400,7 @@ declare class SliderAttribute extends CommonMethod<SliderAttribute> {
* @returns { SliderAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
selectedBorderRadius(value: Dimension): SliderAttribute;
@ -1459,6 +1475,7 @@ declare class SliderAttribute extends CommonMethod<SliderAttribute> {
* @returns { SliderAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
sliderInteractionMode(value: SliderInteraction): SliderAttribute;
@ -1470,6 +1487,7 @@ declare class SliderAttribute extends CommonMethod<SliderAttribute> {
* @returns { SliderAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
minResponsiveDistance(value: number): SliderAttribute;
@ -1481,6 +1499,7 @@ declare class SliderAttribute extends CommonMethod<SliderAttribute> {
* @returns { SliderAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
contentModifier(modifier: ContentModifier<SliderConfiguration>): SliderAttribute;
@ -1492,6 +1511,7 @@ declare class SliderAttribute extends CommonMethod<SliderAttribute> {
* @returns { SliderAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
slideRange(value: SlideRange): SliderAttribute;

1
api/@internal/component/ets/span.d.ts vendored
View File

@ -121,6 +121,7 @@ declare class BaseSpan<T> extends CommonMethod<T> {
* @returns { T } The attribute of the Span.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
baselineOffset(value: LengthMetrics): T;

121
api/@internal/component/ets/styled_string.d.ts vendored
View File

@ -23,6 +23,7 @@
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class StyledString {
@ -33,6 +34,7 @@ declare class StyledString {
* @param { Array<StyleOptions> } [styles] - indicates the SpanStyle objects.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
constructor(value: string | ImageAttachment | CustomSpan, styles?: Array<StyleOptions>);
@ -44,6 +46,7 @@ declare class StyledString {
* @readonly
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
readonly length: number;
@ -54,6 +57,7 @@ declare class StyledString {
* @returns { string } - the literal content of the StyledString
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
getString(): string;
@ -71,6 +75,7 @@ declare class StyledString {
* <br> 3. Parameter verification failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
getStyles(start: number, length: number, styledKey?: StyledStringKey): Array<SpanStyle>;
@ -82,6 +87,7 @@ declare class StyledString {
* @returns { boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
equals(other: StyledString): boolean;
@ -98,6 +104,7 @@ declare class StyledString {
* <br> 3. Parameter verification failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
subStyledString(start: number, length?: number): StyledString;
@ -109,6 +116,7 @@ declare class StyledString {
* @interface StyleOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface StyleOptions {
@ -118,6 +126,7 @@ declare interface StyleOptions {
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
start?: number;
@ -128,6 +137,7 @@ declare interface StyleOptions {
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
length?: number;
@ -138,6 +148,7 @@ declare interface StyleOptions {
* @type { StyledStringKey }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
styledKey: StyledStringKey;
@ -148,6 +159,7 @@ declare interface StyleOptions {
* @type { StyledStringValue }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
styledValue: StyledStringValue;
@ -159,6 +171,7 @@ declare interface StyleOptions {
* @interface SpanStyle
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface SpanStyle {
@ -168,6 +181,7 @@ declare interface SpanStyle {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
start: number;
@ -178,6 +192,7 @@ declare interface SpanStyle {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
length: number;
@ -188,6 +203,7 @@ declare interface SpanStyle {
* @type { StyledStringKey }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
styledKey: StyledStringKey;
@ -198,6 +214,7 @@ declare interface SpanStyle {
* @type { StyledStringValue }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
styledValue: StyledStringValue;
@ -208,6 +225,7 @@ declare interface SpanStyle {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class TextStyle {
@ -218,6 +236,7 @@ declare class TextStyle {
* @param { TextStyleInterface } [value] - font property object.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
constructor(value?: TextStyleInterface);
@ -229,6 +248,7 @@ declare class TextStyle {
* @readonly
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
readonly fontColor?: ResourceColor;
@ -240,6 +260,7 @@ declare class TextStyle {
* @readonly
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
readonly fontFamily?: string;
@ -252,6 +273,7 @@ declare class TextStyle {
* @readonly
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
readonly fontSize?: number;
@ -263,6 +285,7 @@ declare class TextStyle {
* @readonly
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
readonly fontWeight?: number;
@ -274,6 +297,7 @@ declare class TextStyle {
* @readonly
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
readonly fontStyle?: FontStyle;
@ -285,6 +309,7 @@ declare class TextStyle {
* @interface TextStyleInterface
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface TextStyleInterface {
@ -294,6 +319,7 @@ declare interface TextStyleInterface {
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontColor?: ResourceColor;
@ -304,6 +330,7 @@ declare interface TextStyleInterface {
* @type { ?ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontFamily?: ResourceStr;
@ -314,6 +341,7 @@ declare interface TextStyleInterface {
* @type { ?LengthMetrics }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontSize?: LengthMetrics;
@ -324,6 +352,7 @@ declare interface TextStyleInterface {
* @type { ?(number | FontWeight | string) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontWeight?: number | FontWeight | string;
@ -334,6 +363,7 @@ declare interface TextStyleInterface {
* @type { ?FontStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontStyle?: FontStyle;
@ -344,6 +374,7 @@ declare interface TextStyleInterface {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class DecorationStyle {
@ -354,6 +385,7 @@ declare class DecorationStyle {
* @param { DecorationStyleInterface } value - text decoration value.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
constructor(value: DecorationStyleInterface);
@ -365,6 +397,7 @@ declare class DecorationStyle {
* @readonly
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
readonly type: TextDecorationType;
@ -376,6 +409,7 @@ declare class DecorationStyle {
* @readonly
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
readonly color?: ResourceColor;
@ -387,6 +421,7 @@ declare class DecorationStyle {
* @readonly
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
readonly style?: TextDecorationStyle;
@ -441,6 +476,7 @@ declare interface DecorationStyleInterface {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class BaselineOffsetStyle {
@ -451,6 +487,7 @@ declare class BaselineOffsetStyle {
* @param { LengthMetrics } value - baseline offset value.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
constructor(value: LengthMetrics);
@ -463,6 +500,7 @@ declare class BaselineOffsetStyle {
* @readonly
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
readonly baselineOffset: number;
@ -473,6 +511,7 @@ declare class BaselineOffsetStyle {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class LetterSpacingStyle {
@ -483,6 +522,7 @@ declare class LetterSpacingStyle {
* @param { LengthMetrics } value - letter space value.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
constructor(value: LengthMetrics);
@ -495,6 +535,7 @@ declare class LetterSpacingStyle {
* @readonly
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
readonly letterSpacing: number;
@ -505,6 +546,7 @@ declare class LetterSpacingStyle {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class TextShadowStyle {
@ -515,6 +557,7 @@ declare class TextShadowStyle {
* @param { ShadowOptions | Array<ShadowOptions> } value - text shadow value.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
constructor(value: ShadowOptions | Array<ShadowOptions>);
@ -526,6 +569,7 @@ declare class TextShadowStyle {
* @readonly
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
readonly textShadow: Array<ShadowOptions>;
@ -536,6 +580,7 @@ declare class TextShadowStyle {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class GestureStyle {
@ -546,6 +591,7 @@ declare class GestureStyle {
* @param { GestureStyleInterface } [value] - gesture event object.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
constructor(value?: GestureStyleInterface);
@ -557,6 +603,7 @@ declare class GestureStyle {
* @interface GestureStyleInterface
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface GestureStyleInterface {
@ -566,6 +613,7 @@ declare interface GestureStyleInterface {
* @type { ?Callback<ClickEvent> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onClick?: Callback<ClickEvent>;
@ -576,6 +624,7 @@ declare interface GestureStyleInterface {
* @type { ?Callback<GestureEvent> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onLongPress?: Callback<GestureEvent>;
@ -586,6 +635,7 @@ declare interface GestureStyleInterface {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class ParagraphStyle {
@ -596,6 +646,7 @@ declare class ParagraphStyle {
* @param { ParagraphStyleInterface } [value] - paragraph property object.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
constructor(value?: ParagraphStyleInterface);
@ -607,6 +658,7 @@ declare class ParagraphStyle {
* @readonly
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
readonly textAlign?: TextAlign;
@ -619,6 +671,7 @@ declare class ParagraphStyle {
* @readonly
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
readonly textIndent?: number;
@ -630,6 +683,7 @@ declare class ParagraphStyle {
* @readonly
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
readonly maxLines?: number;
@ -641,6 +695,7 @@ declare class ParagraphStyle {
* @readonly
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
readonly overflow?: TextOverflow;
@ -652,6 +707,7 @@ declare class ParagraphStyle {
* @readonly
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
readonly wordBreak?: WordBreak;
@ -663,6 +719,7 @@ declare class ParagraphStyle {
* @readonly
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
readonly leadingMargin?: number | LeadingMarginPlaceholder;
@ -674,6 +731,7 @@ declare class ParagraphStyle {
* @interface ParagraphStyleInterface
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface ParagraphStyleInterface {
@ -683,6 +741,7 @@ declare interface ParagraphStyleInterface {
* @type { ?TextAlign }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
textAlign?: TextAlign;
@ -693,6 +752,7 @@ declare interface ParagraphStyleInterface {
* @type { ?LengthMetrics }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
textIndent?: LengthMetrics;
@ -703,6 +763,7 @@ declare interface ParagraphStyleInterface {
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
maxLines?: number;
@ -713,6 +774,7 @@ declare interface ParagraphStyleInterface {
* @type { ?TextOverflow }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
overflow?: TextOverflow;
@ -723,6 +785,7 @@ declare interface ParagraphStyleInterface {
* @type { ?WordBreak }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
wordBreak?: WordBreak;
@ -733,6 +796,7 @@ declare interface ParagraphStyleInterface {
* @type { ?(LengthMetrics | LeadingMarginPlaceholder) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
leadingMargin?: LengthMetrics | LeadingMarginPlaceholder;
@ -743,6 +807,7 @@ declare interface ParagraphStyleInterface {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class LineHeightStyle {
@ -753,6 +818,7 @@ declare class LineHeightStyle {
* @param { LengthMetrics } lineHeight - line height value.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
constructor(lineHeight: LengthMetrics);
@ -765,6 +831,7 @@ declare class LineHeightStyle {
* @readonly
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
readonly lineHeight: number;
@ -777,6 +844,7 @@ declare class LineHeightStyle {
* GestureStyle | ImageAttachment | ParagraphStyle | LineHeightStyle | CustomSpan | UserDataSpan} StyledStringValue
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare type StyledStringValue = TextStyle | DecorationStyle | BaselineOffsetStyle | LetterSpacingStyle | TextShadowStyle |
@ -788,6 +856,7 @@ GestureStyle | ImageAttachment | ParagraphStyle | LineHeightStyle | CustomSpan |
* @extends StyledString
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class MutableStyledString extends StyledString {
@ -803,6 +872,7 @@ declare class MutableStyledString extends StyledString {
* <br> 3. Parameter verification failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
replaceString(start: number, length: number, other: string): void;
@ -818,6 +888,7 @@ declare class MutableStyledString extends StyledString {
* <br> 3. Parameter verification failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
insertString(start: number, other: string): void;
@ -833,6 +904,7 @@ declare class MutableStyledString extends StyledString {
* <br> 3. Parameter verification failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
removeString(start: number, length: number): void;
@ -847,6 +919,7 @@ declare class MutableStyledString extends StyledString {
* <br> 3. Parameter verification failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
replaceStyle(spanStyle: SpanStyle): void;
@ -858,6 +931,7 @@ declare class MutableStyledString extends StyledString {
* @throws { BusinessError } 401 - The parameter check failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
setStyle(spanStyle: SpanStyle): void;
@ -874,6 +948,7 @@ declare class MutableStyledString extends StyledString {
* <br> 3. Parameter verification failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
removeStyle(start: number, length: number, styledKey: StyledStringKey): void;
@ -889,6 +964,7 @@ declare class MutableStyledString extends StyledString {
* <br> 3. Parameter verification failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
removeStyles(start: number, length: number): void;
@ -898,6 +974,7 @@ declare class MutableStyledString extends StyledString {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
clearStyles(): void;
@ -914,6 +991,7 @@ declare class MutableStyledString extends StyledString {
* <br> 3. Parameter verification failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
replaceStyledString(start: number, length: number, other: StyledString): void;
@ -929,6 +1007,7 @@ declare class MutableStyledString extends StyledString {
* <br> 3. Parameter verification failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
insertStyledString(start: number, other: StyledString): void;
@ -939,6 +1018,7 @@ declare class MutableStyledString extends StyledString {
* @param { StyledString } other - new StyledString.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
appendStyledString(other: StyledString): void;
@ -951,6 +1031,7 @@ declare class MutableStyledString extends StyledString {
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum StyledStringKey {
@ -959,6 +1040,7 @@ declare enum StyledStringKey {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
FONT = 0,
@ -968,6 +1050,7 @@ declare enum StyledStringKey {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
DECORATION = 1,
@ -977,6 +1060,7 @@ declare enum StyledStringKey {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
BASELINE_OFFSET = 2,
@ -986,6 +1070,7 @@ declare enum StyledStringKey {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
LETTER_SPACING = 3,
@ -995,6 +1080,7 @@ declare enum StyledStringKey {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
TEXT_SHADOW = 4,
@ -1004,6 +1090,7 @@ declare enum StyledStringKey {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
LINE_HEIGHT = 5,
@ -1013,6 +1100,7 @@ declare enum StyledStringKey {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
GESTURE = 100,
@ -1022,6 +1110,7 @@ declare enum StyledStringKey {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
PARAGRAPH_STYLE = 200,
@ -1031,6 +1120,7 @@ declare enum StyledStringKey {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
IMAGE = 300,
@ -1040,6 +1130,7 @@ declare enum StyledStringKey {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
CUSTOM_SPAN = 400,
@ -1060,6 +1151,7 @@ declare enum StyledStringKey {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class ImageAttachment {
@ -1070,6 +1162,7 @@ declare class ImageAttachment {
* @param { ImageAttachmentInterface } value - image attachment object.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
constructor(value: ImageAttachmentInterface);
@ -1081,6 +1174,7 @@ declare class ImageAttachment {
* @readonly
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
readonly value: PixelMap;
@ -1092,6 +1186,7 @@ declare class ImageAttachment {
* @readonly
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
readonly size?: SizeOptions;
@ -1103,6 +1198,7 @@ declare class ImageAttachment {
* @readonly
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
readonly verticalAlign?: ImageSpanAlignment;
@ -1114,6 +1210,7 @@ declare class ImageAttachment {
* @readonly
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
readonly objectFit?: ImageFit;
@ -1125,6 +1222,7 @@ declare class ImageAttachment {
* @readonly
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
readonly layoutStyle?: ImageAttachmentLayoutStyle;
@ -1136,6 +1234,7 @@ declare class ImageAttachment {
* @interface ImageAttachmentInterface
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface ImageAttachmentInterface {
@ -1145,6 +1244,7 @@ declare interface ImageAttachmentInterface {
* @type { PixelMap }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
value: PixelMap;
@ -1155,6 +1255,7 @@ declare interface ImageAttachmentInterface {
* @type { ?SizeOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
size?: SizeOptions;
@ -1165,6 +1266,7 @@ declare interface ImageAttachmentInterface {
* @type { ?ImageSpanAlignment }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
verticalAlign?: ImageSpanAlignment;
@ -1175,6 +1277,7 @@ declare interface ImageAttachmentInterface {
* @type { ?ImageFit }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
objectFit?: ImageFit;
@ -1185,6 +1288,7 @@ declare interface ImageAttachmentInterface {
* @type { ?ImageAttachmentLayoutStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
layoutStyle?: ImageAttachmentLayoutStyle;
@ -1196,6 +1300,7 @@ declare interface ImageAttachmentInterface {
* @interface ImageAttachmentLayoutStyle
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface ImageAttachmentLayoutStyle {
@ -1205,6 +1310,7 @@ declare interface ImageAttachmentLayoutStyle {
* @type { ?(LengthMetrics | Margin) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
margin?: LengthMetrics | Margin;
@ -1215,6 +1321,7 @@ declare interface ImageAttachmentLayoutStyle {
* @type { ?(LengthMetrics | Padding) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
padding?: LengthMetrics | Padding;
@ -1225,6 +1332,7 @@ declare interface ImageAttachmentLayoutStyle {
* @type { ?(LengthMetrics | BorderRadiuses) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
borderRadius?: LengthMetrics | BorderRadiuses;
@ -1236,6 +1344,7 @@ declare interface ImageAttachmentLayoutStyle {
* @interface CustomSpanMetrics
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface CustomSpanMetrics {
@ -1247,6 +1356,7 @@ declare interface CustomSpanMetrics {
* @default 0
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
width: number;
@ -1258,6 +1368,7 @@ declare interface CustomSpanMetrics {
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
height?: number;
@ -1269,6 +1380,7 @@ declare interface CustomSpanMetrics {
* @interface CustomSpanDrawInfo
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface CustomSpanDrawInfo {
@ -1279,6 +1391,7 @@ declare interface CustomSpanDrawInfo {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
x: number;
@ -1290,6 +1403,7 @@ declare interface CustomSpanDrawInfo {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
lineTop: number;
@ -1301,6 +1415,7 @@ declare interface CustomSpanDrawInfo {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
lineBottom: number;
@ -1312,6 +1427,7 @@ declare interface CustomSpanDrawInfo {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
baseline: number;
@ -1323,6 +1439,7 @@ declare interface CustomSpanDrawInfo {
* @interface CustomSpanMeasureInfo
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface CustomSpanMeasureInfo {
@ -1333,6 +1450,7 @@ declare interface CustomSpanMeasureInfo {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontSize: number;
@ -1343,6 +1461,7 @@ declare interface CustomSpanMeasureInfo {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare abstract class CustomSpan {
@ -1353,6 +1472,7 @@ declare abstract class CustomSpan {
* @returns { CustomSpanMetrics } - CustomSpan Size
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
abstract onMeasure(measureInfo: CustomSpanMeasureInfo) : CustomSpanMetrics;
@ -1364,6 +1484,7 @@ declare abstract class CustomSpan {
* @param { CustomSpanDrawInfo } drawInfo
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
abstract onDraw(context: DrawContext, drawInfo: CustomSpanDrawInfo): void;

17
api/@internal/component/ets/swiper.d.ts vendored
View File

@ -126,6 +126,7 @@ declare class SwiperController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
changeIndex(index: number, useAnimation?: boolean);
@ -278,6 +279,7 @@ declare class Indicator<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
start(value: LengthMetrics): T;
@ -291,6 +293,7 @@ declare class Indicator<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
end(value: LengthMetrics): T;
@ -549,6 +552,7 @@ declare class DotIndicator extends Indicator<DotIndicator> {
* @returns { DotIndicator } return the DotIndicator
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
maxDisplayCount(maxDisplayCount: number): DotIndicator;
@ -1925,6 +1929,7 @@ declare class SwiperAttribute extends CommonMethod<SwiperAttribute> {
* @returns { SwiperAttribute } the attribute of the swiper.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
customContentTransition(transition: SwiperContentAnimatedTransition): SwiperAttribute;
@ -1940,6 +1945,7 @@ declare class SwiperAttribute extends CommonMethod<SwiperAttribute> {
* @returns { SwiperAttribute } the attribute of the swiper.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onContentDidScroll(handler: ContentDidScrollCallback): SwiperAttribute;
@ -1951,6 +1957,7 @@ declare class SwiperAttribute extends CommonMethod<SwiperAttribute> {
* @returns { SwiperAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
indicatorInteractive(value: boolean): SwiperAttribute;
@ -1962,6 +1969,7 @@ declare class SwiperAttribute extends CommonMethod<SwiperAttribute> {
* @interface SwiperContentAnimatedTransition
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface SwiperContentAnimatedTransition {
@ -1973,6 +1981,7 @@ declare interface SwiperContentAnimatedTransition {
* @default 0 ms
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
timeout?: number;
@ -1983,6 +1992,7 @@ declare interface SwiperContentAnimatedTransition {
* @type { Callback<SwiperContentTransitionProxy> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
transition: Callback<SwiperContentTransitionProxy>;
@ -1994,6 +2004,7 @@ declare interface SwiperContentAnimatedTransition {
* @interface SwiperContentTransitionProxy
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface SwiperContentTransitionProxy {
@ -2003,6 +2014,7 @@ declare interface SwiperContentTransitionProxy {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
selectedIndex: number;
@ -2013,6 +2025,7 @@ declare interface SwiperContentTransitionProxy {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
index: number;
@ -2023,6 +2036,7 @@ declare interface SwiperContentTransitionProxy {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
position: number;
@ -2033,6 +2047,7 @@ declare interface SwiperContentTransitionProxy {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
mainAxisLength: number;
@ -2042,6 +2057,7 @@ declare interface SwiperContentTransitionProxy {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
finishTransition(): void;
@ -2057,6 +2073,7 @@ declare interface SwiperContentTransitionProxy {
* @param { number } mainAxisLength - the swiper main axis length for calculating position.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare type ContentDidScrollCallback = (selectedIndex: number, index: number, position: number, mainAxisLength: number) => void;

9
api/@internal/component/ets/tab_content.d.ts vendored
View File

@ -442,6 +442,7 @@ declare interface LabelStyle {
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
selectedColor?: ResourceColor;
@ -452,6 +453,7 @@ declare interface LabelStyle {
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
unselectedColor?: ResourceColor;
@ -463,6 +465,7 @@ declare interface LabelStyle {
* @interface TabBarIconStyle
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface TabBarIconStyle {
@ -472,6 +475,7 @@ declare interface TabBarIconStyle {
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
selectedColor?: ResourceColor;
@ -482,6 +486,7 @@ declare interface TabBarIconStyle {
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
unselectedColor?: ResourceColor;
@ -492,6 +497,7 @@ declare interface TabBarIconStyle {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class TabBarSymbol {
@ -501,6 +507,7 @@ declare class TabBarSymbol {
* @type { SymbolGlyphModifier }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
normal: SymbolGlyphModifier;
@ -511,6 +518,7 @@ declare class TabBarSymbol {
* @type { ?SymbolGlyphModifier }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
selected?: SymbolGlyphModifier;
@ -988,6 +996,7 @@ declare class BottomTabBarStyle {
* @returns { BottomTabBarStyle } the style of the bottom tab bar
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
iconStyle(style: TabBarIconStyle): BottomTabBarStyle;

22
api/@internal/component/ets/text.d.ts vendored
View File

@ -411,6 +411,7 @@ declare class TextAttribute extends CommonMethod<TextAttribute> {
* @returns { TextAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
lineSpacing(value: LengthMetrics): TextAttribute;
@ -921,6 +922,7 @@ declare class TextAttribute extends CommonMethod<TextAttribute> {
* @returns { TextAttribute } The attribute of the text.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
lineBreakStrategy(strategy: LineBreakStrategy): TextAttribute;
@ -1069,6 +1071,7 @@ declare class TextAttribute extends CommonMethod<TextAttribute> {
* @returns { TextAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontFeature(value: string): TextAttribute;
@ -1080,6 +1083,7 @@ declare class TextAttribute extends CommonMethod<TextAttribute> {
* @returns { TextAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
marqueeOptions(value: Optional<MarqueeOptions>): TextAttribute;
@ -1091,6 +1095,7 @@ declare class TextAttribute extends CommonMethod<TextAttribute> {
* @returns { TextAttribute } returns the instance of the TextAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onMarqueeStateChange(callback: Callback<MarqueeState>): TextAttribute;
@ -1102,6 +1107,7 @@ declare class TextAttribute extends CommonMethod<TextAttribute> {
* @returns { TextAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @atomicservice
* @since 12
*/
privacySensitive(supported: boolean): TextAttribute;
@ -1341,6 +1347,7 @@ declare enum TextResponseType {
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum MarqueeState {
@ -1349,6 +1356,7 @@ declare enum MarqueeState {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
START = 0,
@ -1358,6 +1366,7 @@ declare enum MarqueeState {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
BOUNCE = 1,
@ -1367,6 +1376,7 @@ declare enum MarqueeState {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
FINISH = 2,
@ -1378,6 +1388,7 @@ declare enum MarqueeState {
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum MarqueeStartPolicy {
@ -1386,6 +1397,7 @@ declare enum MarqueeStartPolicy {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
DEFAULT = 0,
@ -1395,6 +1407,7 @@ declare enum MarqueeStartPolicy {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
ON_FOCUS = 1,
@ -1444,6 +1457,7 @@ declare interface TextOptions {
* @interface MarqueeOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface MarqueeOptions {
@ -1453,6 +1467,7 @@ declare interface MarqueeOptions {
* @type { boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
start: boolean;
@ -1463,6 +1478,7 @@ declare interface MarqueeOptions {
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
step?: number;
@ -1473,6 +1489,7 @@ declare interface MarqueeOptions {
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
loop?: number;
@ -1483,6 +1500,7 @@ declare interface MarqueeOptions {
* @type { ?boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fromStart?: boolean;
@ -1493,6 +1511,7 @@ declare interface MarqueeOptions {
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
delay?: number;
@ -1503,6 +1522,7 @@ declare interface MarqueeOptions {
* @type { ?boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fadeout?: boolean;
@ -1513,6 +1533,7 @@ declare interface MarqueeOptions {
* @type { ?MarqueeStartPolicy }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
marqueeStartPolicy?: MarqueeStartPolicy;
@ -1557,6 +1578,7 @@ declare class TextController {
* @param { StyledString } value
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
setStyledString(value: StyledString): void;

19
api/@internal/component/ets/text_area.d.ts vendored
View File

@ -391,6 +391,7 @@ declare enum TextAreaType {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
NUMBER_DECIMAL = 12,
@ -919,6 +920,7 @@ declare class TextAreaAttribute extends CommonMethod<TextAreaAttribute> {
* @returns { TextAreaAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
textOverflow(value: TextOverflow): TextAreaAttribute;
@ -930,6 +932,7 @@ declare class TextAreaAttribute extends CommonMethod<TextAreaAttribute> {
* @returns { TextAreaAttribute } The attribute of the text.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
textIndent(value: Dimension): TextAreaAttribute;
@ -973,6 +976,7 @@ declare class TextAreaAttribute extends CommonMethod<TextAreaAttribute> {
* @returns { TextAreaAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
caretStyle(value: CaretStyle): TextAreaAttribute;
@ -984,6 +988,7 @@ declare class TextAreaAttribute extends CommonMethod<TextAreaAttribute> {
* @returns { TextAreaAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
selectedBackgroundColor(value: ResourceColor): TextAreaAttribute;
@ -1361,6 +1366,7 @@ declare class TextAreaAttribute extends CommonMethod<TextAreaAttribute> {
* @returns { TextAreaAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
minFontSize(value: number | string | Resource): TextAreaAttribute;
@ -1372,6 +1378,7 @@ declare class TextAreaAttribute extends CommonMethod<TextAreaAttribute> {
* @returns { TextAreaAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
maxFontSize(value: number | string | Resource): TextAreaAttribute;
@ -1383,6 +1390,7 @@ declare class TextAreaAttribute extends CommonMethod<TextAreaAttribute> {
* @returns { TextAreaAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
heightAdaptivePolicy(value: TextHeightAdaptivePolicy): TextAreaAttribute;
@ -1414,6 +1422,7 @@ declare class TextAreaAttribute extends CommonMethod<TextAreaAttribute> {
* @returns { TextAreaAttribute } returns the instance of the TextAreaAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
wordBreak(value: WordBreak): TextAreaAttribute;
@ -1425,6 +1434,7 @@ declare class TextAreaAttribute extends CommonMethod<TextAreaAttribute> {
* @returns { TextAreaAttribute } The attribute of the TextAreaAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
lineBreakStrategy(strategy: LineBreakStrategy): TextAreaAttribute;
@ -1467,6 +1477,7 @@ declare class TextAreaAttribute extends CommonMethod<TextAreaAttribute> {
* @returns { TextAreaAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
decoration(value: TextDecorationOptions): TextAreaAttribute;
@ -1478,6 +1489,7 @@ declare class TextAreaAttribute extends CommonMethod<TextAreaAttribute> {
* @returns { TextAreaAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
letterSpacing(value: number | string | Resource): TextAreaAttribute;
@ -1489,6 +1501,7 @@ declare class TextAreaAttribute extends CommonMethod<TextAreaAttribute> {
* @returns { TextAreaAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
lineSpacing(value: LengthMetrics): TextAreaAttribute;
@ -1500,6 +1513,7 @@ declare class TextAreaAttribute extends CommonMethod<TextAreaAttribute> {
* @returns { TextAreaAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
lineHeight(value: number | string | Resource): TextAreaAttribute;
@ -1558,6 +1572,7 @@ declare class TextAreaAttribute extends CommonMethod<TextAreaAttribute> {
* @returns { TextAreaAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontFeature(value: string): TextAreaAttribute;
@ -1569,6 +1584,7 @@ declare class TextAreaAttribute extends CommonMethod<TextAreaAttribute> {
* @returns { TextAreaAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onWillInsert(callback: Callback<InsertValue, boolean>): TextAreaAttribute;
@ -1580,6 +1596,7 @@ declare class TextAreaAttribute extends CommonMethod<TextAreaAttribute> {
* @returns { TextAreaAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onDidInsert(callback: Callback<InsertValue>): TextAreaAttribute;
@ -1591,6 +1608,7 @@ declare class TextAreaAttribute extends CommonMethod<TextAreaAttribute> {
* @returns { TextAreaAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onWillDelete(callback: Callback<DeleteValue, boolean>): TextAreaAttribute;
@ -1602,6 +1620,7 @@ declare class TextAreaAttribute extends CommonMethod<TextAreaAttribute> {
* @returns { TextAreaAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onDidDelete(callback: Callback<DeleteValue>): TextAreaAttribute;

5
api/@internal/component/ets/text_clock.d.ts vendored
View File

@ -119,6 +119,7 @@ declare class TextClockController {
* @extends CommonConfiguration<TextClockConfiguration>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface TextClockConfiguration extends CommonConfiguration<TextClockConfiguration> {
@ -130,6 +131,7 @@ declare interface TextClockConfiguration extends CommonConfiguration<TextClockCo
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
timeZoneOffset: number;
@ -140,6 +142,7 @@ declare interface TextClockConfiguration extends CommonConfiguration<TextClockCo
* @type { boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
started: boolean;
@ -150,6 +153,7 @@ declare interface TextClockConfiguration extends CommonConfiguration<TextClockCo
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
timeValue: number;
@ -545,6 +549,7 @@ declare class TextClockAttribute extends CommonMethod<TextClockAttribute> {
* @returns { TextClockAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
contentModifier(modifier: ContentModifier<TextClockConfiguration>): TextClockAttribute;

32
api/@internal/component/ets/text_common.d.ts vendored
View File

@ -161,6 +161,7 @@ declare interface TextDataDetectorConfig {
* @interface TextRange
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface TextRange {
@ -171,6 +172,7 @@ declare interface TextRange {
* @default 0
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
start?: number;
@ -182,6 +184,7 @@ declare interface TextRange {
* @default text length
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
end?: number;
@ -193,6 +196,7 @@ declare interface TextRange {
* @interface InsertValue
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface InsertValue {
@ -202,6 +206,7 @@ declare interface InsertValue {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
insertOffset: number;
@ -212,6 +217,7 @@ declare interface InsertValue {
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
insertValue: string;
@ -223,6 +229,7 @@ declare interface InsertValue {
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum TextDeleteDirection {
@ -231,6 +238,7 @@ declare enum TextDeleteDirection {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
BACKWARD = 0,
@ -240,6 +248,7 @@ declare enum TextDeleteDirection {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
FORWARD = 1,
@ -251,6 +260,7 @@ declare enum TextDeleteDirection {
* @interface DeleteValue
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface DeleteValue {
@ -260,6 +270,7 @@ declare interface DeleteValue {
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
deleteOffset: number;
@ -270,6 +281,7 @@ declare interface DeleteValue {
* @type { TextDeleteDirection }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
direction: TextDeleteDirection;
@ -280,6 +292,7 @@ declare interface DeleteValue {
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
deleteValue: string;
@ -293,6 +306,7 @@ declare interface DeleteValue {
* @param { TextRange } rangeAfter - Range of content that newly added.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare type OnDidChangeCallback = (rangeBefore: TextRange, rangeAfter: TextRange) => void;
@ -316,6 +330,7 @@ declare type EditableTextOnChangeCallback = (value: string, previewText?: Previe
* @interface TextBaseController
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface TextBaseController {
@ -327,6 +342,7 @@ declare interface TextBaseController {
* @param { SelectionOptions } [options] - Indicates the options of selection.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
setSelection(selectionStart: number, selectionEnd: number, options?: SelectionOptions): void;
@ -336,6 +352,7 @@ declare interface TextBaseController {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
closeSelectionMenu(): void;
@ -358,6 +375,7 @@ declare interface TextBaseController {
* @interface TextEditControllerEx
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface TextEditControllerEx extends TextBaseController{
@ -367,6 +385,7 @@ declare interface TextEditControllerEx extends TextBaseController{
* @returns { boolean } - true means that the component is in editing state, false means is non in editing status
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
isEditing(): boolean;
@ -376,6 +395,7 @@ declare interface TextEditControllerEx extends TextBaseController{
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
stopEditing(): void;
@ -387,6 +407,7 @@ declare interface TextEditControllerEx extends TextBaseController{
* @returns { boolean } - Return true if the caret offset was successfully set, false otherwise.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
setCaretOffset(offset: number): boolean;
@ -397,6 +418,7 @@ declare interface TextEditControllerEx extends TextBaseController{
* @returns { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
getCaretOffset(): number;
@ -419,6 +441,7 @@ declare interface TextEditControllerEx extends TextBaseController{
* @interface StyledStringController
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface StyledStringController {
@ -428,6 +451,7 @@ declare interface StyledStringController {
* @param { StyledString } styledString - StyledString.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
setStyledString(styledString: StyledString): void;
@ -438,6 +462,7 @@ declare interface StyledStringController {
* @returns { MutableStyledString }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
getStyledString(): MutableStyledString;
@ -449,6 +474,7 @@ declare interface StyledStringController {
* @interface StyledStringChangedListener
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface StyledStringChangedListener {
@ -458,6 +484,7 @@ declare interface StyledStringChangedListener {
* @type { ?Callback<StyledStringChangeValue, boolean> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onWillChange?: Callback<StyledStringChangeValue, boolean>;
@ -468,6 +495,7 @@ declare interface StyledStringChangedListener {
* @type { ?OnDidChangeCallback }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onDidChange?: OnDidChangeCallback;
@ -479,6 +507,7 @@ declare interface StyledStringChangedListener {
* @interface StyledStringChangeValue
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface StyledStringChangeValue {
@ -488,6 +517,7 @@ interface StyledStringChangeValue {
* @type { TextRange }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
range: TextRange;
@ -498,6 +528,7 @@ interface StyledStringChangeValue {
* @type { StyledString }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
replacementString: StyledString;
@ -702,6 +733,7 @@ declare class TextMenuItemId {
* @returns { boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
equals(id: TextMenuItemId): boolean;

23
api/@internal/component/ets/text_input.d.ts vendored
View File

@ -615,6 +615,7 @@ declare enum EnterKeyType {
* @interface UnderlineColor
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface UnderlineColor {
@ -624,6 +625,7 @@ declare interface UnderlineColor {
* @type { ?(ResourceColor | undefined) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
typing?: ResourceColor | undefined;
@ -633,6 +635,7 @@ declare interface UnderlineColor {
* @type { ?(ResourceColor | undefined) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
normal?: ResourceColor | undefined;
@ -642,6 +645,7 @@ declare interface UnderlineColor {
* @type { ?(ResourceColor | undefined) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
error?: ResourceColor | undefined;
@ -651,6 +655,7 @@ declare interface UnderlineColor {
* @type { ?(ResourceColor | undefined) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
disable?: ResourceColor | undefined;
@ -1197,6 +1202,7 @@ declare class TextInputAttribute extends CommonMethod<TextInputAttribute> {
* @returns { TextInputAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
textOverflow(value: TextOverflow): TextInputAttribute;
@ -1208,6 +1214,7 @@ declare class TextInputAttribute extends CommonMethod<TextInputAttribute> {
* @returns { TextInputAttribute } The attribute of the text.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
textIndent(value: Dimension): TextInputAttribute;
@ -2043,6 +2050,7 @@ declare class TextInputAttribute extends CommonMethod<TextInputAttribute> {
* @returns { TextInputAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
underlineColor(value: ResourceColor | UnderlineColor | undefined): TextInputAttribute;
@ -2114,6 +2122,7 @@ declare class TextInputAttribute extends CommonMethod<TextInputAttribute> {
* @returns { TextInputAttribute } returns the instance of the TextInputAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
wordBreak(value: WordBreak): TextInputAttribute;
@ -2125,6 +2134,7 @@ declare class TextInputAttribute extends CommonMethod<TextInputAttribute> {
* @returns { TextInputAttribute } The attribute of the TextInputAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
lineBreakStrategy(strategy: LineBreakStrategy): TextInputAttribute;
@ -2223,6 +2233,7 @@ declare class TextInputAttribute extends CommonMethod<TextInputAttribute> {
* @returns { TextInputAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
minFontSize(value: number | string | Resource): TextInputAttribute;
@ -2234,6 +2245,7 @@ declare class TextInputAttribute extends CommonMethod<TextInputAttribute> {
* @returns { TextInputAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
maxFontSize(value: number | string | Resource): TextInputAttribute;
@ -2245,6 +2257,7 @@ declare class TextInputAttribute extends CommonMethod<TextInputAttribute> {
* @returns { TextInputAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
heightAdaptivePolicy(value: TextHeightAdaptivePolicy): TextInputAttribute;
@ -2275,6 +2288,7 @@ declare class TextInputAttribute extends CommonMethod<TextInputAttribute> {
* @returns { TextInputAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
decoration(value: TextDecorationOptions): TextInputAttribute;
@ -2286,6 +2300,7 @@ declare class TextInputAttribute extends CommonMethod<TextInputAttribute> {
* @returns { TextInputAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
letterSpacing(value: number | string | Resource): TextInputAttribute;
@ -2297,6 +2312,7 @@ declare class TextInputAttribute extends CommonMethod<TextInputAttribute> {
* @returns { TextInputAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
lineHeight(value: number | string | Resource): TextInputAttribute;
@ -2331,6 +2347,7 @@ declare class TextInputAttribute extends CommonMethod<TextInputAttribute> {
* @returns { TextInputAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontFeature(value: string): TextInputAttribute;
@ -2342,6 +2359,7 @@ declare class TextInputAttribute extends CommonMethod<TextInputAttribute> {
* @returns { TextInputAttribute } Returns the instance of the TextInputAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
showPassword(visible: boolean): TextInputAttribute;
@ -2353,6 +2371,7 @@ declare class TextInputAttribute extends CommonMethod<TextInputAttribute> {
* @returns { TextInputAttribute } Returns the instance of the TextInputAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onSecurityStateChange(callback: Callback<boolean>): TextInputAttribute;
@ -2364,6 +2383,7 @@ declare class TextInputAttribute extends CommonMethod<TextInputAttribute> {
* @returns { TextInputAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onWillInsert(callback: Callback<InsertValue, boolean>): TextInputAttribute;
@ -2375,6 +2395,7 @@ declare class TextInputAttribute extends CommonMethod<TextInputAttribute> {
* @returns { TextInputAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onDidInsert(callback: Callback<InsertValue>): TextInputAttribute;
@ -2386,6 +2407,7 @@ declare class TextInputAttribute extends CommonMethod<TextInputAttribute> {
* @returns { TextInputAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onWillDelete(callback: Callback<DeleteValue, boolean>): TextInputAttribute;
@ -2397,6 +2419,7 @@ declare class TextInputAttribute extends CommonMethod<TextInputAttribute> {
* @returns { TextInputAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onDidDelete(callback: Callback<DeleteValue>): TextInputAttribute;

12
api/@internal/component/ets/text_picker.d.ts vendored
View File

@ -298,6 +298,7 @@ interface TextPickerInterface {
* @interface DividerOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface DividerOptions {
@ -307,6 +308,7 @@ declare interface DividerOptions {
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
strokeWidth?: Dimension;
@ -317,6 +319,7 @@ declare interface DividerOptions {
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
color?: ResourceColor;
@ -327,6 +330,7 @@ declare interface DividerOptions {
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
startMargin?: Dimension;
@ -337,6 +341,7 @@ declare interface DividerOptions {
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
endMargin?: Dimension;
@ -562,6 +567,7 @@ declare class TextPickerAttribute extends CommonMethod<TextPickerAttribute> {
* @returns { TextPickerAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
divider(value: DividerOptions | null): TextPickerAttribute;
@ -573,6 +579,7 @@ declare class TextPickerAttribute extends CommonMethod<TextPickerAttribute> {
* @returns { TextPickerAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
gradientHeight(value: Dimension): TextPickerAttribute;
@ -773,6 +780,7 @@ declare interface TextPickerDialogOptions extends TextPickerOptions {
* @type { ?PickerDialogButtonStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
acceptButtonStyle?: PickerDialogButtonStyle;
@ -783,6 +791,7 @@ declare interface TextPickerDialogOptions extends TextPickerOptions {
* @type { ?PickerDialogButtonStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
cancelButtonStyle?: PickerDialogButtonStyle;
@ -1010,6 +1019,7 @@ declare interface TextPickerDialogOptions extends TextPickerOptions {
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onWillAppear?: () => void;
@ -1020,6 +1030,7 @@ declare interface TextPickerDialogOptions extends TextPickerOptions {
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onWillDisappear?: () => void;
@ -1030,6 +1041,7 @@ declare interface TextPickerDialogOptions extends TextPickerOptions {
* @type { ?(ShadowOptions | ShadowStyle) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
shadow?: ShadowOptions | ShadowStyle;

6
api/@internal/component/ets/text_timer.d.ts vendored
View File

@ -148,6 +148,7 @@ declare class TextTimerController {
* @interface TextTimerConfiguration
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface TextTimerConfiguration extends CommonConfiguration<TextTimerConfiguration> {
@ -159,6 +160,7 @@ declare interface TextTimerConfiguration extends CommonConfiguration<TextTimerCo
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
count: number;
@ -169,6 +171,7 @@ declare interface TextTimerConfiguration extends CommonConfiguration<TextTimerCo
* @type { boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
isCountDown: boolean;
@ -179,6 +182,7 @@ declare interface TextTimerConfiguration extends CommonConfiguration<TextTimerCo
* @type { boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
started: boolean;
@ -190,6 +194,7 @@ declare interface TextTimerConfiguration extends CommonConfiguration<TextTimerCo
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
elapsedTime: number;
@ -646,6 +651,7 @@ declare class TextTimerAttribute extends CommonMethod<TextTimerAttribute> {
* @returns { TextTimerAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
contentModifier(modifier: ContentModifier<TextTimerConfiguration>): TextTimerAttribute;

9
api/@internal/component/ets/time_picker.d.ts vendored
View File

@ -287,6 +287,7 @@ interface TimePickerInterface {
* @typedef { import('../api/@ohos.intl').default.DateTimeOptions } DateTimeOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare type DateTimeOptions = import('../api/@ohos.intl').default.DateTimeOptions
@ -434,6 +435,7 @@ declare class TimePickerAttribute extends CommonMethod<TimePickerAttribute> {
* @returns { TimePickerAttribute } the attribute of the time picker
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
dateTimeOptions(value: DateTimeOptions): TimePickerAttribute;
@ -473,6 +475,7 @@ declare class TimePickerAttribute extends CommonMethod<TimePickerAttribute> {
* @param { boolean } enable - Default value is true, set false to disable haptic feedback.
* @returns { TimePickerAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
enableHapticFeedback(enable: boolean): TimePickerAttribute;
@ -573,6 +576,7 @@ declare interface TimePickerDialogOptions extends TimePickerOptions {
* @type { ?PickerDialogButtonStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
acceptButtonStyle?: PickerDialogButtonStyle;
@ -583,6 +587,7 @@ declare interface TimePickerDialogOptions extends TimePickerOptions {
* @type { ?PickerDialogButtonStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
cancelButtonStyle?: PickerDialogButtonStyle;
@ -811,6 +816,7 @@ declare interface TimePickerDialogOptions extends TimePickerOptions {
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onWillAppear?: () => void;
@ -821,6 +827,7 @@ declare interface TimePickerDialogOptions extends TimePickerOptions {
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onWillDisappear?: () => void;
@ -831,6 +838,7 @@ declare interface TimePickerDialogOptions extends TimePickerOptions {
* @type { ?(ShadowOptions | ShadowStyle) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
shadow?: ShadowOptions | ShadowStyle;
@ -841,6 +849,7 @@ declare interface TimePickerDialogOptions extends TimePickerOptions {
* @type { ?DateTimeOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
dateTimeOptions?: DateTimeOptions;

11
api/@internal/component/ets/toggle.d.ts vendored
View File

@ -156,6 +156,7 @@ declare enum ToggleType {
* @interface SwitchStyle
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface SwitchStyle {
@ -165,6 +166,7 @@ declare interface SwitchStyle {
* @type { ?(number | Resource) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
pointRadius?: number | Resource;
@ -175,6 +177,7 @@ declare interface SwitchStyle {
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
unselectedColor?: ResourceColor;
@ -185,6 +188,7 @@ declare interface SwitchStyle {
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
pointColor?: ResourceColor;
@ -195,6 +199,7 @@ declare interface SwitchStyle {
* @type { ?(number | Resource) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
trackBorderRadius?: number | Resource;
@ -206,6 +211,7 @@ declare interface SwitchStyle {
* @interface ToggleConfiguration
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface ToggleConfiguration extends CommonConfiguration<ToggleConfiguration> {
@ -216,6 +222,7 @@ declare interface ToggleConfiguration extends CommonConfiguration<ToggleConfigur
* @type { boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
isOn: boolean;
@ -226,6 +233,7 @@ declare interface ToggleConfiguration extends CommonConfiguration<ToggleConfigur
* @type { boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
enabled: boolean;
@ -236,6 +244,7 @@ declare interface ToggleConfiguration extends CommonConfiguration<ToggleConfigur
* @type { Callback<boolean> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
triggerChange: Callback<boolean>;
@ -399,6 +408,7 @@ declare class ToggleAttribute extends CommonMethod<ToggleAttribute> {
* @returns { ToggleAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
contentModifier(modifier: ContentModifier<ToggleConfiguration>): ToggleAttribute;
@ -490,6 +500,7 @@ declare class ToggleAttribute extends CommonMethod<ToggleAttribute> {
* @returns { ToggleAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
switchStyle(value: SwitchStyle): ToggleAttribute;

120
api/@internal/component/ets/units.d.ts vendored
View File

@ -735,6 +735,16 @@ declare type EdgeOutlineWidths = {
* @since 11
* @form
*/
/**
* top outline width property.
*
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
top?: Dimension;
/**
@ -746,6 +756,16 @@ declare type EdgeOutlineWidths = {
* @since 11
* @form
*/
/**
* right outline width property.
*
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
right?: Dimension;
/**
@ -757,6 +777,16 @@ declare type EdgeOutlineWidths = {
* @since 11
* @form
*/
/**
* bottom outline width property.
*
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
bottom?: Dimension;
/**
@ -768,6 +798,16 @@ declare type EdgeOutlineWidths = {
* @since 11
* @form
*/
/**
* left outline width property.
*
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
left?: Dimension;
};
@ -1000,6 +1040,16 @@ declare type OutlineRadiuses = {
* @since 11
* @form
*/
/**
* top-left property.
*
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
topLeft?: Dimension;
/**
@ -1011,6 +1061,16 @@ declare type OutlineRadiuses = {
* @since 11
* @form
*/
/**
* top-right property.
*
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
topRight?: Dimension;
/**
@ -1022,6 +1082,16 @@ declare type OutlineRadiuses = {
* @since 11
* @form
*/
/**
* bottom-left property.
*
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
bottomLeft?: Dimension;
/**
@ -1033,6 +1103,16 @@ declare type OutlineRadiuses = {
* @since 11
* @form
*/
/**
* bottom-right property.
*
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
bottomRight?: Dimension;
};
@ -1419,6 +1499,16 @@ declare type EdgeOutlineStyles = {
* @since 11
* @form
*/
/**
* top property.
*
* @type { ?OutlineStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
top?: OutlineStyle;
/**
@ -1430,6 +1520,16 @@ declare type EdgeOutlineStyles = {
* @since 11
* @form
*/
/**
* right property.
*
* @type { ?OutlineStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
right?: OutlineStyle;
/**
@ -1441,6 +1541,16 @@ declare type EdgeOutlineStyles = {
* @since 11
* @form
*/
/**
* bottom property.
*
* @type { ?OutlineStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
bottom?: OutlineStyle;
/**
@ -1452,6 +1562,16 @@ declare type EdgeOutlineStyles = {
* @since 11
* @form
*/
/**
* left property.
*
* @type { ?OutlineStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
left?: OutlineStyle;
};

5
api/@internal/component/ets/video.d.ts vendored
View File

@ -420,6 +420,7 @@ declare interface VideoOptions {
*
* @type { ?ImageAIOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
imageAIOptions?: ImageAIOptions;
@ -647,6 +648,7 @@ declare class VideoController {
* Provide the reset method of video playback.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
reset(): void;
@ -1230,6 +1232,7 @@ declare class VideoAttribute extends CommonMethod<VideoAttribute> {
* @returns { VideoAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onStop(event: Callback<void>): VideoAttribute;
@ -1240,6 +1243,7 @@ declare class VideoAttribute extends CommonMethod<VideoAttribute> {
* @param { boolean } enable
* @returns { VideoAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
enableAnalyzer(enable: boolean): VideoAttribute;
@ -1250,6 +1254,7 @@ declare class VideoAttribute extends CommonMethod<VideoAttribute> {
* @param { ImageAnalyzerConfig } config
* @returns { VideoAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
analyzerConfig(config: ImageAnalyzerConfig): VideoAttribute;

20
api/@internal/component/ets/water_flow.d.ts vendored
View File

@ -26,6 +26,7 @@
* @returns { number } main size of the FlowItem at index
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare type GetItemMainSizeByIndex = (index: number) => number;
@ -35,6 +36,7 @@ declare type GetItemMainSizeByIndex = (index: number) => number;
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class SectionOptions {
@ -44,6 +46,7 @@ declare class SectionOptions {
* @type { number } itemsCount - the number of FlowItems in this section
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
itemsCount: number;
@ -55,6 +58,7 @@ declare class SectionOptions {
* @default 1 one column in vertical layout, or one row in horizontal layout
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
crossCount?: number;
@ -66,6 +70,7 @@ declare class SectionOptions {
* @type { ?GetItemMainSizeByIndex } onGetItemMainSizeByIndex - function that returns item main size by index
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onGetItemMainSizeByIndex?: GetItemMainSizeByIndex;
@ -77,6 +82,7 @@ declare class SectionOptions {
* same with columnsGap of WaterFlow if not set
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
columnsGap?: Dimension;
@ -88,6 +94,7 @@ declare class SectionOptions {
* same with rowsGap of WaterFlow if not set
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
rowsGap?: Dimension;
@ -99,6 +106,7 @@ declare class SectionOptions {
* @default {top: 0, right: 0, bottom: 0, left: 0}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
margin?: Margin | Dimension;
@ -109,6 +117,7 @@ declare class SectionOptions {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class WaterFlowSections {
@ -117,6 +126,7 @@ declare class WaterFlowSections {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
constructor();
@ -130,6 +140,7 @@ declare class WaterFlowSections {
* @returns { boolean } Whether the splice was successful.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
splice(start: number, deleteCount?: number, sections?: Array<SectionOptions>): boolean;
@ -141,6 +152,7 @@ declare class WaterFlowSections {
* @returns { boolean } Whether the push was successful.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
push(section: SectionOptions): boolean;
@ -153,6 +165,7 @@ declare class WaterFlowSections {
* @returns { boolean } Whether the update was successful.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
update(sectionIndex:number, section: SectionOptions): boolean;
@ -163,6 +176,7 @@ declare class WaterFlowSections {
* @returns { Array<SectionOptions> } Returns all the section options in the WaterFlow.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
values(): Array<SectionOptions>;
@ -173,6 +187,7 @@ declare class WaterFlowSections {
* @returns { number } Returns section counts in the WaterFlow.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
length(): number;
@ -184,6 +199,7 @@ declare class WaterFlowSections {
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum WaterFlowLayoutMode {
@ -192,6 +208,7 @@ declare enum WaterFlowLayoutMode {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
ALWAYS_TOP_DOWN = 0,
@ -201,6 +218,7 @@ declare enum WaterFlowLayoutMode {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
SLIDING_WINDOW = 1,
@ -289,6 +307,7 @@ declare interface WaterFlowOptions {
* @type { ?WaterFlowSections } sections - sections with different cross count
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
sections?: WaterFlowSections;
@ -299,6 +318,7 @@ declare interface WaterFlowOptions {
* @type { ?WaterFlowLayoutMode }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
layoutMode?: WaterFlowLayoutMode;

1
api/@internal/component/ets/with_theme.d.ts vendored
View File

@ -71,6 +71,7 @@ declare interface WithThemeOptions {
* @returns { WithThemeAttribute } withThemeAttribute object
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare type WithThemeInterface = (options: WithThemeOptions) => WithThemeAttribute;

1
api/@internal/component/ets/xcomponent.d.ts vendored
View File

@ -298,6 +298,7 @@ declare interface XComponentOptions {
*
* @type { ?ImageAIOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
imageAIOptions?: ImageAIOptions;

141
api/@internal/ets/global.d.ts vendored
View File

@ -262,6 +262,18 @@ export declare class console {
* @crossplatform
* @since 10
*/
/**
* Prints a message if value is false or omitted.
*
* @param { Object } [value] - The value tested for being truthy.
* @param { Object[] } arguments - Used as error message to print.
* @throws { BusinessError } 401 - The parameter check failed.
* @static
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
static assert(value?: Object, ...arguments: Object[]): void;
/**
@ -275,6 +287,18 @@ export declare class console {
* @crossplatform
* @since 10
*/
/**
* Maintains an internal counter specific to label and print the number of times
* console.count() has been called with the given label.
*
* @param { string } [label] - Counter name. Default: "default".
* @throws { BusinessError } 401 - The parameter check failed.
* @static
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
static count(label?: string): void;
/**
@ -287,6 +311,17 @@ export declare class console {
* @crossplatform
* @since 10
*/
/**
* Reset the internal counter specific to label.
*
* @param { string } [label] - Counter name. Default: "default".
* @throws { BusinessError } 401 - The parameter check failed.
* @static
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
static countReset(label?: string): void;
/**
@ -298,6 +333,16 @@ export declare class console {
* @crossplatform
* @since 10
*/
/**
* Prints properties of the specified JavaScript object.
*
* @param { Object } [dir] - A JavaScript object whose properties should be output.
* @static
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
static dir(dir?: Object): void;
/**
@ -310,6 +355,17 @@ export declare class console {
* @crossplatform
* @since 10
*/
/**
* This method calls console.log() passing it the arguments received.
* This method does not produce any XML formatting.
*
* @param { Object[] } arguments - Text to print.
* @static
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
static dirxml(...arguments: Object[]): void;
/**
@ -321,6 +377,16 @@ export declare class console {
* @crossplatform
* @since 10
*/
/**
* Creates a new inline group, causing any subsequent console messages to be indented by an additional level.
*
* @param { Object[] } arguments - messages to print first.
* @static
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
static group(...arguments: Object[]): void;
/**
@ -332,6 +398,16 @@ export declare class console {
* @crossplatform
* @since 10
*/
/**
* Same as console.group()
*
* @param { Object[] } arguments - messages to print first.
* @static
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
static groupCollapsed(...arguments: Object[]): void;
/**
@ -342,6 +418,15 @@ export declare class console {
* @crossplatform
* @since 10
*/
/**
* Exit current inline group.
*
* @static
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
static groupEnd(): void;
/**
@ -353,6 +438,16 @@ export declare class console {
* @crossplatform
* @since 10
*/
/**
* Prints tabular data as a table.
*
* @param { Object } [tableData] - tabular data.
* @static
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
static table(tableData?: Object): void;
/**
@ -365,6 +460,17 @@ export declare class console {
* @crossplatform
* @since 10
*/
/**
* Start a timer.
*
* @param { string } [label] - Timer name. Default: "default".
* @throws { BusinessError } 401 - The parameter check failed.
* @static
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
static time(label?: string): void;
/**
@ -377,6 +483,17 @@ export declare class console {
* @crossplatform
* @since 10
*/
/**
* End a timer and print time duration.
*
* @param { string } [label] - Timer name. Default: "default".
* @throws { BusinessError } 401 - The parameter check failed.
* @static
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
static timeEnd(label?: string): void;
/**
@ -390,6 +507,18 @@ export declare class console {
* @crossplatform
* @since 10
*/
/**
* Print the elapsed time and other data arguments.
*
* @param { string } [label] - Timer name. Default: "default".
* @param { Object[] } arguments - Text to print.
* @throws { BusinessError } 401 - The parameter check failed.
* @static
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
static timeLog(label?: string, ...arguments: Object[]): void;
/**
@ -401,6 +530,16 @@ export declare class console {
* @crossplatform
* @since 10
*/
/**
* Prints stack information for the current code location.
*
* @param { Object[] } arguments - message to print.
* @static
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
static trace(...arguments: Object[]): void;
/**
@ -409,6 +548,7 @@ export declare class console {
* @static
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
static traceHybridStack(): void;
@ -796,6 +936,7 @@ export declare function markModuleCollectable(namespace: Object): void;
* @throws { BusinessError } 10200301 - Loading native module failed.
* @syscap SystemCapability.Utils.Lang
* @stagemodelonly
* @atomicservice
* @since 12
*/
export declare function loadNativeModule(moduleName: string): Object;

292
api/@ohos.PiPWindow.d.ts vendored
View File

@ -29,6 +29,14 @@ import { NodeController } from '@kit.ArkUI';
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Picture In Picture Window Manager
*
* @namespace PiPWindow
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
declare namespace PiPWindow {
/**
* If picture-in-picture enabled in current OS.
@ -37,6 +45,14 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* If picture-in-picture enabled in current OS.
*
* @returns { boolean } true if PictureInPicture enabled, otherwise false
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
function isPiPEnabled(): boolean;
/**
@ -53,6 +69,21 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Create picture-in-picture controller
*
* @param { PiPConfiguration } config - Params for picture-in-picture controller creation. The config must be valid,
* the context and componentController in config should not be null. If templateType is specified, make sure
* it's type of PiPTemplateType. If controlGroups is specified, make sure it correspond to the templateType.
* @returns { Promise<PiPController> } - The promise returned by the function
* @throws { BusinessError } 401 - Params error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* 3. Parameter verification failed
* @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
function create(config: PiPConfiguration): Promise<PiPController>;
/**
@ -62,6 +93,14 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* PiPConfiguration
*
* @interface PiPConfiguration
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
interface PiPConfiguration {
/**
* Indicates window context.
@ -70,6 +109,14 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Indicates window context.
*
* @type { BaseContext }
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
context: BaseContext;
/**
@ -79,6 +126,14 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Indicates the origin XComponentController.
*
* @type { XComponentController }
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
componentController: XComponentController;
/**
@ -88,6 +143,14 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Indicates navigation ID.
*
* @type { ?string }
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
navigationId?: string;
/**
@ -97,6 +160,14 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Picture-in-picture template type.
*
* @type { ?PiPTemplateType }
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
templateType?: PiPTemplateType;
/**
@ -106,6 +177,14 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Describes the width of content to be displayed in PiP window. For adjusting PiP window aspect ratio.
*
* @type { ?number }
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
contentWidth?: number;
/**
@ -115,6 +194,14 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Describes the height of content to be displayed in PiP window. For adjusting PiP window aspect ratio.
*
* @type { ?number }
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
contentHeight?: number;
/**
@ -122,6 +209,7 @@ declare namespace PiPWindow {
*
* @type { ?Array<PiPControlGroup> }
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
controlGroups?: Array<PiPControlGroup>;
@ -131,6 +219,7 @@ declare namespace PiPWindow {
*
* @type { ?NodeController }
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
customUIController?: NodeController;
@ -143,12 +232,26 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Describe the type of picture-in-picture.
*
* @enum { number }.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
enum PiPTemplateType {
/**
* Indicates the content to show in picture-in-picture window is video play
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Indicates the content to show in picture-in-picture window is video play
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
VIDEO_PLAY,
/**
@ -156,6 +259,12 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Indicates the content to show in picture-in-picture window is video call
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
VIDEO_CALL,
/**
@ -163,6 +272,12 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Indicates the content to show in picture-in-picture window is video meeting
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
VIDEO_MEETING,
/**
@ -170,6 +285,12 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Indicates the content to show in picture-in-picture window is video live
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
VIDEO_LIVE,
}
@ -180,6 +301,14 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Enum for PiP window callback event type.
*
* @enum { number }.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
enum PiPState {
/**
* PiP window is about to start.
@ -187,6 +316,13 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* PiP window is about to start.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
ABOUT_TO_START = 1,
/**
@ -195,6 +331,13 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* PiP window started.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
STARTED = 2,
/**
@ -203,6 +346,13 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* PiP window is about to stop.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
ABOUT_TO_STOP = 3,
/**
@ -211,6 +361,13 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* PiP window stopped.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
STOPPED = 4,
/**
@ -219,6 +376,13 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Restore the original page from PiP window
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
ABOUT_TO_RESTORE = 5,
/**
@ -227,6 +391,13 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Error message during start/stop.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
ERROR = 6,
}
@ -235,6 +406,7 @@ declare namespace PiPWindow {
*
* @typedef { VideoPlayControlGroup | VideoCallControlGroup | VideoMeetingControlGroup | VideoLiveControlGroup }
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
type PiPControlGroup = VideoPlayControlGroup | VideoCallControlGroup | VideoMeetingControlGroup | VideoLiveControlGroup;
@ -244,6 +416,7 @@ declare namespace PiPWindow {
*
* @enum { number }.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
enum VideoPlayControlGroup {
@ -251,6 +424,7 @@ declare namespace PiPWindow {
* Previous/Next for video.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
VIDEO_PREVIOUS_NEXT = 101,
@ -259,6 +433,7 @@ declare namespace PiPWindow {
* Forward/Backward for video.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
FAST_FORWARD_BACKWARD = 102,
@ -269,6 +444,7 @@ declare namespace PiPWindow {
*
* @enum { number }.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
enum VideoCallControlGroup {
@ -276,6 +452,7 @@ declare namespace PiPWindow {
* Turn on/off the microphone.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
MICROPHONE_SWITCH = 201,
@ -284,6 +461,7 @@ declare namespace PiPWindow {
* Hang up.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
HANG_UP_BUTTON = 202,
@ -292,6 +470,7 @@ declare namespace PiPWindow {
* Turn on/off the camera
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
CAMERA_SWITCH = 203,
@ -300,6 +479,7 @@ declare namespace PiPWindow {
* Mute switch.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
MUTE_SWITCH = 204,
@ -310,6 +490,7 @@ declare namespace PiPWindow {
*
* @enum { number }.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
enum VideoMeetingControlGroup {
@ -317,6 +498,7 @@ declare namespace PiPWindow {
* Hang up.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
HANG_UP_BUTTON = 301,
@ -325,6 +507,7 @@ declare namespace PiPWindow {
* Turn on/off the camera
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
CAMERA_SWITCH = 302,
@ -333,6 +516,7 @@ declare namespace PiPWindow {
* Mute switch.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
MUTE_SWITCH = 303,
@ -341,6 +525,7 @@ declare namespace PiPWindow {
* Turn on/off the microphone.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
MICROPHONE_SWITCH = 304,
@ -351,6 +536,7 @@ declare namespace PiPWindow {
*
* @enum { number }.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
enum VideoLiveControlGroup {
@ -358,6 +544,7 @@ declare namespace PiPWindow {
* Video play/pause control.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
VIDEO_PLAY_PAUSE = 401,
@ -366,6 +553,7 @@ declare namespace PiPWindow {
* Mute switch.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
MUTE_SWITCH = 402,
@ -376,6 +564,7 @@ declare namespace PiPWindow {
*
* @enum { number }.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
enum PiPControlStatus {
@ -383,6 +572,7 @@ declare namespace PiPWindow {
* The video is in play mode.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
PLAY = 1,
@ -391,6 +581,7 @@ declare namespace PiPWindow {
* The video is in pause mode.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
PAUSE = 0,
@ -399,6 +590,7 @@ declare namespace PiPWindow {
* A control with both open and closed states is in an open state.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
OPEN = 1,
@ -407,6 +599,7 @@ declare namespace PiPWindow {
* A control with both open and closed states is in a close state.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
CLOSE = 0,
@ -417,6 +610,7 @@ declare namespace PiPWindow {
*
* @enum { number }.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
enum PiPControlType {
@ -424,6 +618,7 @@ declare namespace PiPWindow {
* Video play/pause control.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
VIDEO_PLAY_PAUSE = 0,
@ -432,6 +627,7 @@ declare namespace PiPWindow {
* Previous video control.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
VIDEO_PREVIOUS = 1,
@ -440,6 +636,7 @@ declare namespace PiPWindow {
* Next video control.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
VIDEO_NEXT = 2,
@ -448,6 +645,7 @@ declare namespace PiPWindow {
* Fast-forward control.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
FAST_FORWARD = 3,
@ -456,6 +654,7 @@ declare namespace PiPWindow {
* Fast-backward control.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
FAST_BACKWARD = 4,
@ -464,6 +663,7 @@ declare namespace PiPWindow {
* Hang-up control.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
HANG_UP_BUTTON = 5,
@ -472,6 +672,7 @@ declare namespace PiPWindow {
* Microphone state switching control.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
MICROPHONE_SWITCH = 6,
@ -480,6 +681,7 @@ declare namespace PiPWindow {
* Camera state switching control.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
CAMERA_SWITCH = 7,
@ -488,6 +690,7 @@ declare namespace PiPWindow {
* Mute state switching control.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
MUTE_SWITCH = 8,
@ -501,6 +704,14 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Describe picture-in-picture action event type.
*
* @typedef { PiPVideoActionEvent | PiPCallActionEvent | PiPMeetingActionEvent | PiPLiveActionEvent }
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
type PiPActionEventType = PiPVideoActionEvent | PiPCallActionEvent | PiPMeetingActionEvent | PiPLiveActionEvent;
/**
@ -515,6 +726,7 @@ declare namespace PiPWindow {
*
* @typedef { 'playbackStateChanged' | 'nextVideo' | 'previousVideo' | 'fastForward' | 'fastBackward' }
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
type PiPVideoActionEvent = 'playbackStateChanged' | 'nextVideo' | 'previousVideo' | 'fastForward' | 'fastBackward';
@ -531,6 +743,7 @@ declare namespace PiPWindow {
*
* @typedef { 'hangUp' | 'micStateChanged' | 'videoStateChanged' | 'voiceStateChanged' }
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
type PiPCallActionEvent = 'hangUp' | 'micStateChanged' | 'videoStateChanged' | 'voiceStateChanged';
@ -547,6 +760,7 @@ declare namespace PiPWindow {
*
* @typedef { 'hangUp' | 'voiceStateChanged' | 'videoStateChanged' | 'micStateChanged' }
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
type PiPMeetingActionEvent = 'hangUp' | 'voiceStateChanged' | 'videoStateChanged' | 'micStateChanged';
@ -563,6 +777,7 @@ declare namespace PiPWindow {
*
* @typedef { 'playbackStateChanged' | 'voiceStateChanged' }
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
type PiPLiveActionEvent = 'playbackStateChanged' | 'voiceStateChanged';
@ -574,6 +789,7 @@ declare namespace PiPWindow {
* @param { PiPActionEventType } event - the event from controlPanel
* @param { number } [status] - the status of control button
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
type ControlPanelActionEventCallback = (event: PiPActionEventType, status?: number) => void;
@ -583,6 +799,7 @@ declare namespace PiPWindow {
*
* @interface ControlEventParam
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
interface ControlEventParam {
@ -591,6 +808,7 @@ declare namespace PiPWindow {
*
* @type { PiPControlType }
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
controlType: PiPControlType;
@ -600,6 +818,7 @@ declare namespace PiPWindow {
*
* @type { ?PiPControlStatus }
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
status?: PiPControlStatus;
@ -612,6 +831,14 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* PiPController
*
* @interface PiPController
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
interface PiPController {
/**
@ -624,6 +851,17 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Start picture-in-picture
* @returns { Promise<void> } - The promise returned by the function
* @throws { BusinessError } 1300012 - The PiP window state is abnormal.
* @throws { BusinessError } 1300013 - Failed to create the PiP window.
* @throws { BusinessError } 1300014 - PiP internal error.
* @throws { BusinessError } 1300015 - Repeated PiP operation.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
startPiP(): Promise<void>;
/**
@ -635,6 +873,16 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Stop picture-in-picture.
* @returns { Promise<void> } - The promise returned by the function.
* @throws { BusinessError } 1300011 - Failed to destroy the PiP window.
* @throws { BusinessError } 1300012 - The PiP window state is abnormal.
* @throws { BusinessError } 1300015 - Repeated PiP operation.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
stopPiP(): Promise<void>;
/**
@ -643,6 +891,13 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Set if auto start picture-in-picture when back home
* @param { boolean } enable - Enable auto start picture-in-picture when back home
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
setAutoStartEnabled(enable: boolean): void;
/**
@ -654,6 +909,16 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Update source content size to adjust PiP window aspect ratio.
* @param { number } width - Indicate the width of the content. The width can consist of only digits and above 0.
* @param { number } height - Indicate the height of the content. The height can consist of only digits and above 0.
* @throws { BusinessError } 401 - Params error. Possible causes: 1. Mandatory parameters are left unspecified.
* 2. Incorrect parameter types.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
updateContentSize(width: number, height: number): void;
/**
@ -664,6 +929,7 @@ declare namespace PiPWindow {
* 2. Incorrect parameter types.
* 3. Parameter verification failed
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
updatePiPControlStatus(controlType: PiPControlType, status: PiPControlStatus): void;
@ -676,6 +942,7 @@ declare namespace PiPWindow {
* 2. Incorrect parameter types.
* 3. Parameter verification failed
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
setPiPControlEnabled(controlType: PiPControlType, enabled: boolean): void;
@ -687,6 +954,14 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Register picture-in-picture control event listener.
* @param { 'stateChange' } type - Registration type, PiP lifecycle state change, 'stateChange'
* @param { function } callback - Used to handle {'stateChange'} command
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
on(type: 'stateChange', callback: (state: PiPState, reason: string) => void): void;
/**
@ -695,6 +970,13 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Unregister picture-in-picture lifecycle event listener.
* @param { 'stateChange' } type - Used to unregister listener for {'stateChange'} command
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
off(type: 'stateChange'): void;
/**
@ -710,6 +992,7 @@ declare namespace PiPWindow {
* @param { 'controlPanelActionEvent' } type - Registration type, user action event, 'controlPanelActionEvent'
* @param { ControlPanelActionEventCallback } callback - Used to handle {'controlPanelActionEvent'} command.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
on(type: 'controlPanelActionEvent', callback: ControlPanelActionEventCallback): void;
@ -720,6 +1003,13 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Unregister picture-in-picture lifecycle event listener
* @param { 'controlPanelActionEvent' } type - Used to unregister listener for {'controlPanelActionEvent'} command
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
off(type: 'controlPanelActionEvent'): void;
/**
@ -728,6 +1018,7 @@ declare namespace PiPWindow {
* @param { 'controlEvent' } type - Registration type, user action event, 'controlEvent'
* @param { Callback<ControlEventParam> } callback - Used to handle {'controlEvent'} command.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
on(type: 'controlEvent', callback: Callback<ControlEventParam>): void;
@ -737,6 +1028,7 @@ declare namespace PiPWindow {
* @param { 'controlEvent' } type - Used to unregister listener for {'controlEvent'} command
* @param { Callback<ControlEventParam> } callback - Used to handle {'controlEvent'} command.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
off(type: 'controlEvent', callback?: Callback<ControlEventParam>): void;

5
api/@ohos.animator.d.ts vendored
View File

@ -495,6 +495,7 @@ export interface AnimatorResult {
* Trigger when vSync callback.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onFrame: (progress: number) => void;
@ -525,6 +526,7 @@ export interface AnimatorResult {
* The animation is finished.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onFinish: () => void;
@ -555,6 +557,7 @@ export interface AnimatorResult {
* The animation is canceled.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onCancel: () => void;
@ -585,6 +588,7 @@ export interface AnimatorResult {
* The animation is repeated.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onRepeat: () => void;
@ -593,6 +597,7 @@ export interface AnimatorResult {
* The expected frame rate of dynamical of rate range.
* @param { ExpectedFrameRateRange } rateRange - Indicates ExpectedFrameRateRange.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
setExpectedFrameRateRange(rateRange: ExpectedFrameRateRange): void;

4
api/@ohos.arkui.UIContext.d.ts vendored
View File

@ -1232,6 +1232,7 @@ declare type GestureEventListenerCallback = (event: GestureEvent, node?: FrameNo
* @interface PageInfo
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface PageInfo {
@ -1240,6 +1241,7 @@ export interface PageInfo {
*
* @type { ?observer.RouterPageInfo }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
routerPageInfo?: observer.RouterPageInfo;
@ -1249,6 +1251,7 @@ export interface PageInfo {
*
* @type { ?observer.NavDestinationInfo }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
navDestinationInfo?: observer.NavDestinationInfo;
@ -2139,6 +2142,7 @@ export class DragController {
* not fully strict.
* @param { boolean } enable - Indicating enable drag event strict reporting or not.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
setDragEventStrictReportingEnabled(enable: boolean): void;

15
api/@ohos.arkui.advanced.Chip.d.ets
View File

@ -160,6 +160,7 @@ export interface IconCommonOptions {
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
activatedFillColor?: ResourceColor;
@ -233,6 +234,7 @@ export interface PrefixIconOptions extends IconCommonOptions {}
* @interface ChipSymbolGlyphOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface ChipSymbolGlyphOptions {
@ -243,6 +245,7 @@ export interface ChipSymbolGlyphOptions {
* @type { ?SymbolGlyphModifier }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
normal?: SymbolGlyphModifier;
@ -253,6 +256,7 @@ export interface ChipSymbolGlyphOptions {
* @type { ?SymbolGlyphModifier }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
activated?: SymbolGlyphModifier;
@ -322,6 +326,7 @@ export interface LabelMarginOptions {
* @interface LocalizedLabelMarginOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface LocalizedLabelMarginOptions {
@ -332,6 +337,7 @@ export interface LocalizedLabelMarginOptions {
* @type { ?LengthMetrics }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
start?: LengthMetrics;
@ -342,6 +348,7 @@ export interface LocalizedLabelMarginOptions {
* @type { ?LengthMetrics }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
end?: LengthMetrics;
@ -429,6 +436,7 @@ export interface LabelOptions {
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
activatedFontColor?: ResourceColor;
@ -477,6 +485,7 @@ export interface LabelOptions {
* @type { ?LocalizedLabelMarginOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
localizedLabelMargin?: LocalizedLabelMarginOptions;
@ -525,6 +534,7 @@ export interface ChipOptions {
* @type { ?ChipSymbolGlyphOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
prefixSymbol?: ChipSymbolGlyphOptions;
@ -573,6 +583,7 @@ export interface ChipOptions {
* @type { ?ChipSymbolGlyphOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
suffixSymbol?: ChipSymbolGlyphOptions;
@ -621,6 +632,7 @@ export interface ChipOptions {
* @type { ?boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
activated?: boolean;
@ -650,6 +662,7 @@ export interface ChipOptions {
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
activatedBackgroundColor?: ResourceColor;
@ -717,6 +730,7 @@ export interface ChipOptions {
* @type { ?Callback<void> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onClicked?: Callback<void>;
@ -727,6 +741,7 @@ export interface ChipOptions {
* @type { ?Direction }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
direction?: Direction;

39
api/@ohos.arkui.advanced.ChipGroup.d.ets
View File

@ -28,6 +28,7 @@ import { SymbolGlyphModifier } from './@ohos.arkui.modifier';
* @interface IconOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface IconOptions {
@ -38,6 +39,7 @@ export interface IconOptions {
* @type { ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
src: ResourceStr;
@ -48,6 +50,7 @@ export interface IconOptions {
* @type { ?SizeOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
size?: SizeOptions;
@ -59,6 +62,7 @@ export interface IconOptions {
* @interface LabelOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface LabelOptions {
@ -69,6 +73,7 @@ export interface LabelOptions {
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
text: string;
@ -81,6 +86,7 @@ export interface LabelOptions {
* @interface ChipGroupItemOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface ChipGroupItemOptions {
@ -91,6 +97,7 @@ export interface ChipGroupItemOptions {
* @type { ?IconOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
prefixIcon?: IconOptions;
@ -101,6 +108,7 @@ export interface ChipGroupItemOptions {
* @type { ?ChipSymbolGlyphOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
prefixSymbol?: ChipSymbolGlyphOptions;
@ -111,6 +119,7 @@ export interface ChipGroupItemOptions {
* @type { LabelOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
label: LabelOptions;
@ -121,6 +130,7 @@ export interface ChipGroupItemOptions {
* @type { ?IconOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
suffixIcon?: IconOptions;
@ -131,6 +141,7 @@ export interface ChipGroupItemOptions {
* @type { ?ChipSymbolGlyphOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
suffixSymbol?: ChipSymbolGlyphOptions;
@ -141,6 +152,7 @@ export interface ChipGroupItemOptions {
* @type { ?boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
allowClose?: boolean;
@ -153,6 +165,7 @@ export interface ChipGroupItemOptions {
* @interface ChipItemStyle
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface ChipItemStyle {
@ -163,6 +176,7 @@ export interface ChipItemStyle {
* @type { ?(ChipSize | SizeOptions) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
size?: ChipSize | SizeOptions;
@ -173,6 +187,7 @@ export interface ChipItemStyle {
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
backgroundColor?: ResourceColor;
@ -183,6 +198,7 @@ export interface ChipItemStyle {
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontColor?: ResourceColor;
@ -193,6 +209,7 @@ export interface ChipItemStyle {
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
selectedFontColor?: ResourceColor;
@ -203,6 +220,7 @@ export interface ChipItemStyle {
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
selectedBackgroundColor?: ResourceColor;
@ -215,6 +233,7 @@ export interface ChipItemStyle {
* @interface ChipGroupSpaceOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface ChipGroupSpaceOptions {
@ -225,6 +244,7 @@ export interface ChipGroupSpaceOptions {
* @type { ?(string | number) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
itemSpace?: string | number;
@ -235,6 +255,7 @@ export interface ChipGroupSpaceOptions {
* @type { ?Length }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
startSpace?: Length;
@ -245,6 +266,7 @@ export interface ChipGroupSpaceOptions {
* @type { ?Length }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
endSpace?: Length;
@ -256,6 +278,7 @@ export interface ChipGroupSpaceOptions {
* @interface IconItemOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface IconItemOptions {
@ -265,6 +288,7 @@ export interface IconItemOptions {
* @type { IconOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
icon: IconOptions;
@ -275,6 +299,7 @@ export interface IconItemOptions {
* @type { Callback<void> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
action: Callback<void>;
@ -286,6 +311,7 @@ export interface IconItemOptions {
* @interface ChipGroupPaddingOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface ChipGroupPaddingOptions {
@ -295,6 +321,7 @@ export interface ChipGroupPaddingOptions {
* @type { Length }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
top: Length;
@ -305,6 +332,7 @@ export interface ChipGroupPaddingOptions {
* @type { Length }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
bottom: Length;
@ -316,6 +344,7 @@ export interface ChipGroupPaddingOptions {
* @interface IconGroupSuffix
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Component
@ -326,6 +355,7 @@ export declare struct IconGroupSuffix {
* @type { Array<IconItemOptions | SymbolGlyphModifier> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Require @Prop
@ -339,6 +369,7 @@ export declare struct IconGroupSuffix {
* @struct ChipGroup
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Component
@ -350,6 +381,7 @@ export declare struct ChipGroup {
* @type { ChipGroupItemOptions[] }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Require @Prop
@ -361,6 +393,7 @@ export declare struct ChipGroup {
* @type { ?ChipItemStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Prop
@ -372,6 +405,7 @@ export declare struct ChipGroup {
* @type { ?Array<number> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Prop
@ -383,6 +417,7 @@ export declare struct ChipGroup {
* @type { ?boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Prop
@ -394,6 +429,7 @@ export declare struct ChipGroup {
* @type { ?ChipGroupSpaceOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Prop
@ -405,6 +441,7 @@ export declare struct ChipGroup {
* @type { ?ChipGroupPaddingOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Prop
@ -416,6 +453,7 @@ export declare struct ChipGroup {
* @type { ?Callback<Array<number>> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onChange?: Callback<Array<number>>;
@ -426,6 +464,7 @@ export declare struct ChipGroup {
* @type { ?Callback<void> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@BuilderParam

1
api/@ohos.arkui.advanced.Counter.d.ets
View File

@ -738,6 +738,7 @@ declare class CounterOptions {
* @type { ?Direction }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
direction?: Direction;

19
api/@ohos.arkui.advanced.Dialog.d.ets
View File

@ -99,6 +99,7 @@ export declare class ButtonOptions {
* @default ButtonStyleMode.TEXTUAL
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
buttonStyle?: ButtonStyleMode;
@ -108,6 +109,7 @@ export declare class ButtonOptions {
* @default ButtonRole.NORMAL
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
role?: ButtonRole;
@ -248,6 +250,7 @@ export declare struct TipsDialog {
* Sets the TipsDialog CheckBox Callback.
* @type { ?(isChecked: boolean) => void }.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
checkAction?: (isChecked: boolean) => void;
@ -303,6 +306,7 @@ export declare struct TipsDialog {
* Sets the TipsDialog CheckBox Callback.
* @type { ?Callback<boolean> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
onCheckedChange?: Callback<boolean>;
@ -562,6 +566,7 @@ export declare struct ConfirmDialog {
* Sets the ConfirmDialog CheckBox Callback.
* @type { ?Callback<boolean> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
onCheckedChange?: Callback<boolean>;
@ -599,6 +604,7 @@ export declare struct AlertDialog {
* @type { ?ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
primaryTitle?: ResourceStr;
@ -607,6 +613,7 @@ export declare struct AlertDialog {
* @type { ?ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
secondaryTitle?: ResourceStr;
@ -741,6 +748,7 @@ export declare struct LoadingDialog {
* Declare custom content dialog
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@CustomDialog
@ -750,6 +758,7 @@ export declare struct CustomContentDialog {
* @type { CustomDialogController }.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
controller: CustomDialogController;
@ -758,6 +767,7 @@ export declare struct CustomContentDialog {
* @type { ?ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
primaryTitle?: ResourceStr;
@ -766,6 +776,7 @@ export declare struct CustomContentDialog {
* @type { ?ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
secondaryTitle?: ResourceStr;
@ -774,6 +785,7 @@ export declare struct CustomContentDialog {
* @type { () => void }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@BuilderParam contentBuilder: () => void;
@ -782,6 +794,7 @@ export declare struct CustomContentDialog {
* @type { ?Padding }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
contentAreaPadding?: Padding;
@ -799,6 +812,7 @@ export declare struct CustomContentDialog {
* @type { ?ButtonOptions[] }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
buttons?: ButtonOptions[];
@ -829,6 +843,7 @@ export declare struct CustomContentDialog {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Component
@ -839,6 +854,7 @@ export declare struct PopupDialog {
* @type { boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Link
@ -849,6 +865,7 @@ export declare struct PopupDialog {
* @type { PopupDialogOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Prop
@ -859,6 +876,7 @@ export declare struct PopupDialog {
* @type { Callback<void> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@BuilderParam targetBuilder: Callback<void>;
@ -871,6 +889,7 @@ export declare struct PopupDialog {
* @extends CustomPopupOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export declare interface PopupDialogOptions extends CustomPopupOptions {

11
api/@ohos.arkui.advanced.EditableTitleBar.d.ets
View File

@ -93,6 +93,7 @@ export declare class EditableTitleBarMenuItem {
* Declaration of the image item .
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export type EditableTitleBarItem = EditableTitleBarMenuItem;
@ -144,6 +145,7 @@ export declare enum EditableLeftIconType {
* @interface EditableTitleBarOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export declare interface EditableTitleBarOptions {
@ -153,6 +155,7 @@ export declare interface EditableTitleBarOptions {
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
backgroundColor?: ResourceColor;
@ -163,6 +166,7 @@ export declare interface EditableTitleBarOptions {
* @type { ?BlurStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
backgroundBlurStyle?: BlurStyle;
@ -173,6 +177,7 @@ export declare interface EditableTitleBarOptions {
* @type { ?Array<SafeAreaType> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
safeAreaTypes?: Array<SafeAreaType>;
@ -183,6 +188,7 @@ export declare interface EditableTitleBarOptions {
* @type { ?Array<SafeAreaEdge> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
safeAreaEdges?: Array<SafeAreaEdge>;
@ -221,6 +227,7 @@ export declare struct EditableTitleBar {
* @type { ?EditableTitleBarItem }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
imageItem?: EditableTitleBarItem;
@ -245,6 +252,7 @@ export declare struct EditableTitleBar {
* @type { ?ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
subtitle?: ResourceStr;
@ -255,6 +263,7 @@ export declare struct EditableTitleBar {
* @default true
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
isSaveIconRequired: boolean;
@ -310,6 +319,7 @@ export declare struct EditableTitleBar {
* @default {expandSafeAreaTypes: SafeAreaType.SYSTEM, expandSafeAreaEdges: SafeAreaEdge.TOP}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
options: EditableTitleBarOptions;
@ -321,6 +331,7 @@ export declare struct EditableTitleBar {
* <br> end: LengthMetrics.resource($r('sys.float.margin_right'))}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Prop contentMargin?: LocalizedMargin;

7
api/@ohos.arkui.advanced.FormMenu.d.ets
View File

@ -27,6 +27,7 @@ import { AsyncCallback } from './@ohos.base';
*
* @interface FormMenuItemStyle
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
export interface FormMenuItemStyle {
@ -35,6 +36,7 @@ export interface FormMenuItemStyle {
*
* @type { ?MenuItemOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
options?: MenuItemOptions;
@ -45,6 +47,7 @@ export interface FormMenuItemStyle {
*
* @interface AddFormOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
export interface AddFormOptions {
@ -53,6 +56,7 @@ export interface AddFormOptions {
*
* @type { ?formBindingData.FormBindingData }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
formBindingData?: formBindingData.FormBindingData;
@ -62,6 +66,7 @@ export interface AddFormOptions {
*
* @type { ?AsyncCallback<string> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
callback?: AsyncCallback<string>;
@ -71,6 +76,7 @@ export interface AddFormOptions {
*
* @type { ?FormMenuItemStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
style?: FormMenuItemStyle;
@ -83,6 +89,7 @@ export interface AddFormOptions {
* @param { string } componentId - The id of the component used to get form snapshot.
* @param { AddFormOptions } [options] - Add form options.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
@Builder

4
api/@ohos.arkui.advanced.FullScreenLaunchComponent.d.ets
View File

@ -24,6 +24,7 @@ import Callback from '@ohos.base';
/**
* Declare component FullScreenLaunchComponent
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
@Component
@ -32,6 +33,7 @@ export declare struct FullScreenLaunchComponent {
* Sets the component content.
* @type { Callback<void> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
@BuilderParam content: Callback<void>;
@ -39,6 +41,7 @@ export declare struct FullScreenLaunchComponent {
* Indicates atomic service appId.
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
appId: string;
@ -46,6 +49,7 @@ export declare struct FullScreenLaunchComponent {
* Indicates the atomic service start options.
* @type { ?AtomicServiceOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
options?: AtomicServiceOptions;

1
api/@ohos.arkui.advanced.Popup.d.ets
View File

@ -420,6 +420,7 @@ export interface PopupOptions {
* @type { ?Direction }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
direction?: Direction;

9
api/@ohos.arkui.advanced.SegmentButton.d.ets
View File

@ -901,6 +901,15 @@ declare class SegmentButtonItemOptions {
* @crossplatform
* @since 11
*/
/**
* The constructor used to create a SegmentButtonOptionsArray object.
*
* @param { SegmentButtonItemOptionsConstructorOptions } options - item info.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
constructor(options: SegmentButtonItemOptionsConstructorOptions);
}

7
api/@ohos.arkui.advanced.SubHeader.d.ets
View File

@ -290,6 +290,7 @@ export declare struct SubHeader {
* Attributes of Symbol icon.
* @type { SymbolOptions}.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
iconSymbolOptions?: SymbolOptions;
@ -373,6 +374,7 @@ export declare struct SubHeader {
* Attributes of Symbol icons in operation area.
* @type { Array<SymbolOptions> }.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
operationSymbolOptions?: Array<SymbolOptions>;
@ -381,6 +383,7 @@ export declare struct SubHeader {
* Text modifier for primary title.
* @type { TextModifier }.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
primaryTitleModifier?: TextModifier;
@ -389,6 +392,7 @@ export declare struct SubHeader {
* Text modifier for secondary title.
* @type { TextModifier }.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
secondaryTitleModifier?: TextModifier;
@ -397,6 +401,7 @@ export declare struct SubHeader {
* Set the title content.
* @type { () => void }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
@BuilderParam titleBuilder?: () => void;
@ -407,6 +412,7 @@ export declare struct SubHeader {
* @default {start: LengthMetrics.resource($r('sys.float.margin_left')),
* <br> end: LengthMetrics.resource($r('sys.float.margin_right'))}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
@Prop contentMargin?: LocalizedMargin;
@ -418,6 +424,7 @@ export declare struct SubHeader {
* <br> When the left area is secondaryTitle or the group of secondaryTitle and icon,
* <br> the default value is {start: LengthMetrics.vp(12), end: LengthMetrics.vp(12)};
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
@Prop contentPadding?: LocalizedPadding;

13
api/@ohos.arkui.componentSnapshot.d.ts vendored
View File

@ -29,6 +29,15 @@ import image from './@ohos.multimedia.image'
* @crossplatform
* @since 10
*/
/**
* This module allows developers to export snapshot image from a component or a custom builder.
*
* @namespace componentSnapshot
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare namespace componentSnapshot {
/**
* Defines the extra options for snapshot taking.
@ -90,6 +99,7 @@ declare namespace componentSnapshot {
* @throws { BusinessError } 100001 - Invalid ID.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
function get(id: string, callback: AsyncCallback<image.PixelMap>, options?: SnapshotOptions): void;
@ -121,6 +131,7 @@ declare namespace componentSnapshot {
* @throws { BusinessError } 100001 - Invalid ID.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
function get(id: string, options?: SnapshotOptions): Promise<image.PixelMap>;
@ -154,6 +165,7 @@ declare namespace componentSnapshot {
* @throws { BusinessError } 100001 - The builder is not a valid build function.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
function createFromBuilder(builder: CustomBuilder, callback: AsyncCallback<image.PixelMap>,
@ -188,6 +200,7 @@ declare namespace componentSnapshot {
* @throws { BusinessError } 100001 - The builder is not a valid build function.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
function createFromBuilder(builder: CustomBuilder, delay?: number,

21
api/@ohos.arkui.dragController.d.ts vendored
View File

@ -238,6 +238,13 @@ declare namespace dragController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 10
*/
/**
* A unique identifier to identify which touch point.
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
pointerId: number;
/**
@ -246,6 +253,13 @@ declare namespace dragController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 10
*/
/**
* Drag data.
* @type { ?unifiedDataChannel.UnifiedData }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
data?: unifiedDataChannel.UnifiedData;
/**
@ -254,6 +268,13 @@ declare namespace dragController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 10
*/
/**
* Additional information about the drag info.
* @type { ?string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
extraParams?: string;
/**

8
api/@ohos.arkui.drawableDescriptor.d.ts vendored
View File

@ -110,6 +110,7 @@ export class LayeredDrawableDescriptor extends DrawableDescriptor {
* @param { DrawableDescriptor } [background] - Indicates the background option to create LayeredDrawableDescriptor.
* @param { DrawableDescriptor } [mask] - Indicates the mask option to create LayeredDrawableDescriptor.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
constructor(
@ -229,6 +230,7 @@ export class LayeredDrawableDescriptor extends DrawableDescriptor {
*
* @extends DrawableDescriptor
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
export class PixelMapDrawableDescriptor extends DrawableDescriptor {
@ -236,6 +238,7 @@ export class PixelMapDrawableDescriptor extends DrawableDescriptor {
* Creates a new PixelMapDrawableDescriptor.
* @param { image.PixelMap } src - Indicates the resource to create PixelMapDrawableDescriptor.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
constructor(src?: image.PixelMap);
@ -247,6 +250,7 @@ export class PixelMapDrawableDescriptor extends DrawableDescriptor {
* @interface AnimationOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface AnimationOptions {
@ -256,6 +260,7 @@ declare interface AnimationOptions {
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
duration?: number;
@ -265,6 +270,7 @@ declare interface AnimationOptions {
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
iterations?: number;
@ -276,6 +282,7 @@ declare interface AnimationOptions {
* @extends DrawableDescriptor
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export class AnimatedDrawableDescriptor extends DrawableDescriptor {
@ -286,6 +293,7 @@ export class AnimatedDrawableDescriptor extends DrawableDescriptor {
* @param { AnimationOptions } [options] - Animation control options.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
constructor(pixelMaps: Array<image.PixelMap>, options?: AnimationOptions);

53
api/@ohos.arkui.node.d.ts vendored
View File

@ -24,6 +24,13 @@
* @crossplatform
* @since 11
*/
/**
* Export NodeRenderType, RenderOptions, BuilderNode, which is used to create a node trees by builder function and manage the update of the tree.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export { NodeRenderType, RenderOptions, BuilderNode } from './arkui/BuilderNode';
/**
@ -34,6 +41,15 @@ export { NodeRenderType, RenderOptions, BuilderNode } from './arkui/BuilderNode'
* @crossplatform
* @since 11
*/
/**
* Export NodeController, which defines the controller of node container. Provides lifecycle callbacks for the associated NodeContainer
* and methods to control the child node of the NodeContainer.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export { NodeController } from './arkui/NodeController';
/**
@ -43,6 +59,14 @@ export { NodeController } from './arkui/NodeController';
* @crossplatform
* @since 11
*/
/**
* Export FrameNode. FrameNode defines a basic type of node which contains a RenderNode.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export { FrameNode, LayoutConstraint } from './arkui/FrameNode';
/**
@ -50,6 +74,7 @@ export { FrameNode, LayoutConstraint } from './arkui/FrameNode';
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export { typeNode, NodeAdapter } from './arkui/FrameNode';
@ -61,6 +86,14 @@ export { typeNode, NodeAdapter } from './arkui/FrameNode';
* @crossplatform
* @since 11
*/
/**
* Export Graphics. Defines the basic types related to the Graphics.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export { DrawContext, Size, Offset, Position, Pivot, Scale, Translation, Matrix4, Rotation, Frame, RoundRect, Circle, CommandPath, ShapeMask, ShapeClip, BorderRadiuses, CornerRadius, Rect, Edges, edgeColors, edgeWidths, borderStyles, borderRadiuses, LengthMetricsUnit } from './arkui/Graphics';
/**
@ -68,6 +101,7 @@ export { DrawContext, Size, Offset, Position, Pivot, Scale, Translation, Matrix4
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export { LengthUnit, SizeT, LengthMetrics, ColorMetrics } from './arkui/Graphics';
@ -79,6 +113,14 @@ export { LengthUnit, SizeT, LengthMetrics, ColorMetrics } from './arkui/Graphics
* @crossplatform
* @since 11
*/
/**
* Export RenderNode. RenderNode contains node tree operations and render property operations on node.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export { RenderNode } from './arkui/RenderNode';
/**
@ -88,6 +130,14 @@ export { RenderNode } from './arkui/RenderNode';
* @crossplatform
* @since 11
*/
/**
* Export XComponentNode, which extends FrameNode.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export { XComponentNode } from './arkui/XComponentNode';
/**
@ -95,6 +145,7 @@ export { XComponentNode } from './arkui/XComponentNode';
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export { Content } from './arkui/Content';
@ -104,6 +155,7 @@ export { Content } from './arkui/Content';
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export { ComponentContent } from './arkui/ComponentContent';
@ -113,6 +165,7 @@ export { ComponentContent } from './arkui/ComponentContent';
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export { NodeContent } from './arkui/NodeContent';

379
api/@ohos.display.d.ts vendored
View File

@ -128,6 +128,15 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Obtain all displays.
*
* @param { AsyncCallback<Array<Display>> } callback the result of all displays
* @throws { BusinessError } 1400001 - Invalid display or screen.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
function getAllDisplays(callback: AsyncCallback<Array<Display>>): void;
/**
@ -138,6 +147,15 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Obtain all displays.
*
* @returns { Promise<Array<Display>> } the result of all displays
* @throws { BusinessError } 1400001 - Invalid display or screen.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
function getAllDisplays(): Promise<Array<Display>>;
/**
@ -234,6 +252,15 @@ declare namespace display {
* @syscap SystemCapability.Window.SessionManager
* @since 10
*/
/**
* Check whether the device is foldable.
*
* @returns { boolean } true means the device is foldable.
* @throws { BusinessError } 1400003 - This display manager service works abnormally.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
function isFoldable(): boolean;
/**
@ -244,6 +271,15 @@ declare namespace display {
* @syscap SystemCapability.Window.SessionManager
* @since 10
*/
/**
* Get the current fold status of the foldable device.
*
* @returns { FoldStatus } fold status of device.
* @throws { BusinessError } 1400003 - This display manager service works abnormally.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
function getFoldStatus(): FoldStatus;
/**
@ -359,6 +395,7 @@ declare namespace display {
* @returns { boolean } true means the device is captured.
* @throws { BusinessError } 1400003 - This display manager service works abnormally.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
function isCaptured(): boolean;
@ -371,6 +408,15 @@ declare namespace display {
* @syscap SystemCapability.Window.SessionManager
* @since 10
*/
/**
* Get the display mode of the foldable device.
*
* @returns { FoldDisplayMode } display mode of the foldable device.
* @throws { BusinessError } 1400003 - This display manager service works abnormally.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
function getFoldDisplayMode(): FoldDisplayMode;
/**
@ -445,6 +491,15 @@ declare namespace display {
* @syscap SystemCapability.Window.SessionManager
* @since 10
*/
/**
* Get the fold crease region in the current display mode.
*
* @returns { FoldCreaseRegion } fold crease region in the current display mode.
* @throws { BusinessError } 1400003 - This display manager service works abnormally.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
function getCurrentFoldCreaseRegion(): FoldCreaseRegion;
/**
@ -630,6 +685,14 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
/**
* Enumerates the display states.
*
* @enum { number }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
enum DisplayState {
/**
* Unknown.
@ -637,6 +700,13 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
/**
* Unknown.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
STATE_UNKNOWN = 0,
/**
* Screen off.
@ -644,6 +714,13 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
/**
* Screen off.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
STATE_OFF,
/**
* Screen on.
@ -651,6 +728,13 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
/**
* Screen on.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
STATE_ON,
/**
* Doze, but it will update for some important system messages.
@ -658,6 +742,13 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
/**
* Doze, but it will update for some important system messages.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
STATE_DOZE,
/**
* Doze and not update.
@ -665,6 +756,13 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
/**
* Doze and not update.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
STATE_DOZE_SUSPEND,
/**
* VR node.
@ -672,6 +770,13 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
/**
* VR node.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
STATE_VR,
/**
* Screen on and not update.
@ -679,6 +784,13 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
/**
* Screen on and not update.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
STATE_ON_SUSPEND
}
@ -690,6 +802,15 @@ declare namespace display {
* @crossplatform
* @since 10
*/
/**
* Enumerates the display orientation.
*
* @enum { number }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @atomicservice
* @since 12
*/
enum Orientation {
/**
* Indicate that the display content is in portrait mode.
@ -698,6 +819,14 @@ declare namespace display {
* @crossplatform
* @since 10
*/
/**
* Indicate that the display content is in portrait mode.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @atomicservice
* @since 12
*/
PORTRAIT = 0,
/**
@ -707,6 +836,14 @@ declare namespace display {
* @crossplatform
* @since 10
*/
/**
* Indicate that the display content is in landscape mode.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @atomicservice
* @since 12
*/
LANDSCAPE = 1,
/**
@ -716,6 +853,14 @@ declare namespace display {
* @crossplatform
* @since 10
*/
/**
* Indicate that the display content is in the opposite direction of the portrait mode.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @atomicservice
* @since 12
*/
PORTRAIT_INVERTED = 2,
/**
@ -725,6 +870,14 @@ declare namespace display {
* @crossplatform
* @since 10
*/
/**
* Indicate that the display content is in the opposite direction of the landscape mode.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @atomicservice
* @since 12
*/
LANDSCAPE_INVERTED = 3
}
@ -735,6 +888,14 @@ declare namespace display {
* @syscap SystemCapability.Window.SessionManager
* @since 10
*/
/**
* Fold Crease Region
*
* @interface FoldCreaseRegion
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
interface FoldCreaseRegion {
/**
* The display ID is used to identify the screen where the crease is located.
@ -743,6 +904,14 @@ declare namespace display {
* @syscap SystemCapability.Window.SessionManager
* @since 10
*/
/**
* The display ID is used to identify the screen where the crease is located.
*
* @readonly
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
readonly displayId: number;
/**
@ -752,6 +921,14 @@ declare namespace display {
* @syscap SystemCapability.Window.SessionManager
* @since 10
*/
/**
* Crease Region.
*
* @readonly
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
readonly creaseRects: Array<Rect>;
}
@ -762,6 +939,14 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Rectangle
*
* @interface Rect
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
interface Rect {
/**
* The X-axis coordinate of the upper left vertex of the rectangle, in pixels.
@ -769,6 +954,13 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* The X-axis coordinate of the upper left vertex of the rectangle, in pixels.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
left: number;
/**
@ -777,6 +969,13 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* The Y-axis coordinate of the upper left vertex of the rectangle, in pixels.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
top: number;
/**
@ -785,6 +984,13 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Width of the rectangle, in pixels.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
width: number;
/**
@ -793,6 +999,13 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Height of the rectangle, in pixels.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
height: number;
}
@ -803,6 +1016,14 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Curved area rects of the waterfall display.
*
* @interface WaterfallDisplayAreaRects
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
interface WaterfallDisplayAreaRects {
/**
* Indicates the size of left side curved area of the waterfall screen.
@ -810,6 +1031,13 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Indicates the size of left side curved area of the waterfall screen.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
readonly left: Rect;
/**
@ -818,6 +1046,13 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Indicates the size of right side curved area of the waterfall screen.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
readonly right: Rect;
/**
@ -826,6 +1061,13 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Indicates the size of top side curved area of the waterfall screen.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
readonly top: Rect;
/**
@ -834,6 +1076,13 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Indicates the size of bottom side curved area of the waterfall screen.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
readonly bottom: Rect;
}
@ -844,6 +1093,14 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Cutout information of the display.
*
* @interface CutoutInfo
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
interface CutoutInfo {
/**
* Bounding rectangles of the cutout areas of the display.
@ -851,6 +1108,13 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Bounding rectangles of the cutout areas of the display.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
readonly boundingRects: Array<Rect>;
/**
@ -859,6 +1123,13 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Rectangles of curved parts on each side of a waterfall display.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
readonly waterfallDisplayAreaRects: WaterfallDisplayAreaRects;
}
@ -900,6 +1171,14 @@ declare namespace display {
* @crossplatform
* @since 10
*/
/**
* Display ID.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @atomicservice
* @since 12
*/
id: number;
/**
@ -908,6 +1187,13 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
/**
* Display name.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
name: string;
/**
@ -916,6 +1202,13 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
/**
* The display is alive.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
alive: boolean;
/**
@ -924,6 +1217,13 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
/**
* The state of display.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
state: DisplayState;
/**
@ -932,6 +1232,13 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
/**
* Refresh rate, in Hz.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
refreshRate: number;
/**
@ -1013,6 +1320,14 @@ declare namespace display {
* @crossplatform
* @since 11
*/
/**
* Display resolution.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @atomicservice
* @since 12
*/
densityDPI: number;
/**
@ -1022,6 +1337,14 @@ declare namespace display {
* @crossplatform
* @since 10
*/
/**
* Display orientation.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @atomicservice
* @since 12
*/
orientation: Orientation;
/**
@ -1053,6 +1376,14 @@ declare namespace display {
* @crossplatform
* @since 11
*/
/**
* Text scale density of the display.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @atomicservice
* @since 12
*/
scaledDensity: number;
/**
@ -1061,6 +1392,13 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
/**
* DPI on the x-axis.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
xDPI: number;
/**
@ -1069,6 +1407,13 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
/**
* DPI on the y-axis.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
yDPI: number;
/**
@ -1078,6 +1423,14 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 11
*/
/**
* All supported color spaces.
*
* @type { Array<colorSpaceManager.ColorSpace> }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
colorSpaces: Array<colorSpaceManager.ColorSpace>;
/**
@ -1087,6 +1440,14 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 11
*/
/**
* All supported HDR formats.
*
* @type { Array<hdrCapability.HDRFormat> }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
hdrFormats: Array<hdrCapability.HDRFormat>;
/**
@ -1097,6 +1458,15 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Obtain the cutout info of the display.
*
* @param { AsyncCallback<CutoutInfo> } callback
* @throws { BusinessError } 1400001 - Invalid display or screen.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
getCutoutInfo(callback: AsyncCallback<CutoutInfo>): void;
/**
@ -1107,6 +1477,15 @@ declare namespace display {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Obtain the cutout info of the display.
*
* @returns { Promise<CutoutInfo> }
* @throws { BusinessError } 1400001 - Invalid display or screen.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
getCutoutInfo(): Promise<CutoutInfo>;
/**

2
api/@ohos.matrix4.d.ts vendored
View File

@ -765,6 +765,7 @@ declare namespace matrix4 {
* @returns { Matrix4Transit } Return to Matrix4Transit
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
skew(x: number, y: number): Matrix4Transit;
@ -834,6 +835,7 @@ declare namespace matrix4 {
* @returns { Matrix4Transit } Return to Matrix4Transit
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
setPolyToPoly(options: PolyToPolyOptions): Matrix4Transit

232
api/@ohos.pluginComponent.d.ts vendored
View File

@ -28,6 +28,14 @@ import Want from './@ohos.app.ability.Want';
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Plugin component template property.
*
* @interface PluginComponentTemplate
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
interface PluginComponentTemplate {
/**
* Defines the source
@ -36,6 +44,14 @@ interface PluginComponentTemplate {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Defines the source
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
source: string;
/**
@ -45,6 +61,14 @@ interface PluginComponentTemplate {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Defines the ability
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
ability: string;
}
@ -55,6 +79,14 @@ interface PluginComponentTemplate {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Plugin component manager interface.
*
* @namespace pluginComponentManager
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
declare namespace pluginComponentManager {
/**
* Defines KVObject
@ -62,6 +94,13 @@ declare namespace pluginComponentManager {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Defines KVObject
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
type KVObject = { [key: string]: number | string | boolean | [] | KVObject }
/**
@ -71,6 +110,14 @@ declare namespace pluginComponentManager {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Plugin component push parameters.
*
* @interface PushParameters
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
interface PushParameters {
/**
* Defines want.
@ -79,6 +126,14 @@ declare namespace pluginComponentManager {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Defines want.
*
* @type { Want }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
want: Want;
/**
@ -88,6 +143,14 @@ declare namespace pluginComponentManager {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Defines name.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
name: string;
/**
@ -97,6 +160,14 @@ declare namespace pluginComponentManager {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Defines data.
*
* @type { KVObject }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
data: KVObject;
/**
@ -106,6 +177,14 @@ declare namespace pluginComponentManager {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Defines extraData.
*
* @type { KVObject }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
extraData: KVObject;
/**
@ -115,6 +194,14 @@ declare namespace pluginComponentManager {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Defines jsonPath.
*
* @type { ?string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
jsonPath?: string;
}
@ -195,6 +282,14 @@ declare namespace pluginComponentManager {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Plugin component request parameters.
*
* @interface RequestParameters
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
interface RequestParameters {
/**
* Defines want.
@ -203,6 +298,14 @@ declare namespace pluginComponentManager {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Defines want.
*
* @type { Want }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
want: Want;
/**
@ -212,6 +315,14 @@ declare namespace pluginComponentManager {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Defines name.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
name: string;
/**
@ -221,6 +332,14 @@ declare namespace pluginComponentManager {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Defines data.
*
* @type { KVObject }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
data: KVObject;
/**
@ -230,6 +349,14 @@ declare namespace pluginComponentManager {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Defines jsonPath.
*
* @type { ?string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
jsonPath?: string;
}
@ -299,6 +426,14 @@ declare namespace pluginComponentManager {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Plugin component request callback parameters.
*
* @interface RequestCallbackParameters
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
interface RequestCallbackParameters {
/**
@ -308,6 +443,14 @@ declare namespace pluginComponentManager {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Defines componentTemplate.
*
* @type { PluginComponentTemplate }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
componentTemplate: PluginComponentTemplate;
/**
@ -317,6 +460,14 @@ declare namespace pluginComponentManager {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Defines data.
*
* @type { KVObject }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
data: KVObject;
/**
@ -326,6 +477,14 @@ declare namespace pluginComponentManager {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Defines extraData.
*
* @type { KVObject }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
extraData: KVObject;
}
@ -336,6 +495,14 @@ declare namespace pluginComponentManager {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Plugin component request event result value.
*
* @interface RequestEventResult
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
interface RequestEventResult {
/**
* Defines template.
@ -344,6 +511,14 @@ declare namespace pluginComponentManager {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Defines template.
*
* @type { ?string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
template?: string;
/**
@ -353,6 +528,14 @@ declare namespace pluginComponentManager {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Defines data.
*
* @type { ?KVObject }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
data?: KVObject;
/**
@ -362,6 +545,14 @@ declare namespace pluginComponentManager {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Defines extraData.
*
* @type { ?KVObject }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
extraData?: KVObject;
}
@ -371,6 +562,13 @@ declare namespace pluginComponentManager {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Plugin component push event callback.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
type OnPushEventCallback = (source: Want, template: PluginComponentTemplate, data: KVObject,
extraData: KVObject) => void;
@ -380,6 +578,13 @@ declare namespace pluginComponentManager {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Plugin component request event callback.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
type OnRequestEventCallback = (source: Want, name: string, data: KVObject) => RequestEventResult;
@ -391,6 +596,15 @@ declare namespace pluginComponentManager {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Plugin component push method.
*
* @param { PushParameters } param
* @param { AsyncCallback<void> } callback
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
function push(param: PushParameters, callback: AsyncCallback<void>): void;
/**
@ -401,6 +615,15 @@ declare namespace pluginComponentManager {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Plugin component request method.
*
* @param { RequestParameters } param
* @param { AsyncCallback<RequestCallbackParameters> } callback
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
function request(param: RequestParameters, callback: AsyncCallback<RequestCallbackParameters>): void;
/**
@ -435,6 +658,15 @@ declare namespace pluginComponentManager {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
*/
/**
* Plugin component event listener.
*
* @param { string } eventType
* @param { OnPushEventCallback | OnRequestEventCallback } callback
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
function on(eventType: string, callback: OnPushEventCallback | OnRequestEventCallback): void;
}

44
api/@ohos.promptAction.d.ts vendored
View File

@ -170,6 +170,7 @@ declare namespace promptAction {
* @type { ?Alignment }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
alignment?: Alignment;
@ -179,6 +180,7 @@ declare namespace promptAction {
* @type { ?Offset }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
offset?: Offset;
@ -583,6 +585,7 @@ declare namespace promptAction {
* @default Color.Transparent
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
backgroundColor?: ResourceColor;
@ -594,6 +597,7 @@ declare namespace promptAction {
* @default BlurStyle.COMPONENT_ULTRA_THICK
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
backgroundBlurStyle?: BlurStyle;
@ -604,6 +608,7 @@ declare namespace promptAction {
* @type { ?(ShadowOptions | ShadowStyle) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
shadow?: ShadowOptions | ShadowStyle;
@ -731,6 +736,7 @@ declare namespace promptAction {
* @default true
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
autoCancel?: boolean;
@ -741,6 +747,7 @@ declare namespace promptAction {
* @type { ?TransitionEffect }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
transition?: TransitionEffect;
@ -751,6 +758,7 @@ declare namespace promptAction {
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
maskColor?: ResourceColor;
@ -761,6 +769,7 @@ declare namespace promptAction {
* @type { ?Callback<DismissDialogAction> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onWillDismiss?: Callback<DismissDialogAction>;
@ -771,6 +780,7 @@ declare namespace promptAction {
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onDidAppear?: () => void;
@ -781,6 +791,7 @@ declare namespace promptAction {
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onDidDisappear?: () => void;
@ -791,6 +802,7 @@ declare namespace promptAction {
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onWillAppear?: () => void;
@ -801,6 +813,7 @@ declare namespace promptAction {
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onWillDisappear?: () => void;
@ -849,6 +862,7 @@ declare namespace promptAction {
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
backgroundColor?: ResourceColor;
@ -859,6 +873,7 @@ declare namespace promptAction {
* @type { ?(Dimension | BorderRadiuses) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
cornerRadius?: Dimension | BorderRadiuses;
@ -869,6 +884,7 @@ declare namespace promptAction {
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
width?: Dimension;
@ -879,6 +895,7 @@ declare namespace promptAction {
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
height?: Dimension;
@ -889,6 +906,7 @@ declare namespace promptAction {
* @type { ?(Dimension | EdgeWidths) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
borderWidth?: Dimension | EdgeWidths;
@ -899,6 +917,7 @@ declare namespace promptAction {
* @type { ?(ResourceColor | EdgeColors) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
borderColor?: ResourceColor | EdgeColors;
@ -909,6 +928,7 @@ declare namespace promptAction {
* @type { ?(BorderStyle | EdgeStyles) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
borderStyle?: BorderStyle | EdgeStyles;
@ -919,6 +939,7 @@ declare namespace promptAction {
* @type { ?(ShadowOptions | ShadowStyle) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
shadow?: ShadowOptions | ShadowStyle;
@ -930,6 +951,7 @@ declare namespace promptAction {
* @default BlurStyle.COMPONENT_ULTRA_THICK
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
backgroundBlurStyle?: BlurStyle;
@ -1064,6 +1086,16 @@ declare namespace promptAction {
* @crossplatform
* @since 11
*/
/**
* Whether to display in the sub window.
*
* @type { ?boolean }
* @default false
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
showInSubWindow?: boolean;
/**
@ -1074,6 +1106,15 @@ declare namespace promptAction {
* @crossplatform
* @since 11
*/
/**
* Whether it is a modal dialog
* @type { ?boolean }
* @default true
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
isModal?: boolean;
}
@ -1394,6 +1435,7 @@ declare namespace promptAction {
* @interface DismissDialogAction
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface DismissDialogAction {
@ -1403,6 +1445,7 @@ declare interface DismissDialogAction {
* @type { Callback<void> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
dismiss: Callback<void>;
@ -1413,6 +1456,7 @@ declare interface DismissDialogAction {
* @type { DismissReason }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
reason: DismissReason;

4
api/@ohos.router.d.ts vendored
View File

@ -291,6 +291,7 @@ declare namespace router {
* @type { Object }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
params: Object;
@ -731,6 +732,7 @@ declare namespace router {
* @param { Object } [params] - params of page.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
function back(index: number, params?: Object): void;
@ -817,6 +819,7 @@ declare namespace router {
* @returns { RouterState | undefined } Page state.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
function getStateByIndex(index: number): RouterState | undefined;
@ -828,6 +831,7 @@ declare namespace router {
* @returns { Array<RouterState> } Page state.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
function getStateByUrl(url: string): Array<RouterState>;

10
api/@ohos.screenshot.d.ts vendored
View File

@ -34,6 +34,7 @@ import image from './@ohos.multimedia.image';
*
* @namespace screenshot
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
declare namespace screenshot {
@ -101,6 +102,7 @@ declare namespace screenshot {
* @throws { BusinessError } 801 - Capability not supported on this device.
* @throws { BusinessError } 1400003 - This display manager service works abnormally.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
function pick(): Promise<PickInfo>;
@ -110,6 +112,7 @@ declare namespace screenshot {
*
* @interface PickInfo
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
interface PickInfo {
@ -118,6 +121,7 @@ declare namespace screenshot {
*
* @type { Rect }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
pickRect: Rect;
@ -127,6 +131,7 @@ declare namespace screenshot {
*
* @type { image.PixelMap }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
pixelMap: image.PixelMap;
@ -145,6 +150,7 @@ declare namespace screenshot {
*
* @interface Rect
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
interface Rect {
@ -161,6 +167,7 @@ declare namespace screenshot {
*
* @type { number }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
left: number;
@ -178,6 +185,7 @@ declare namespace screenshot {
*
* @type { number }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
top: number;
@ -195,6 +203,7 @@ declare namespace screenshot {
*
* @type { number }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
width: number;
@ -212,6 +221,7 @@ declare namespace screenshot {
*
* @type { number }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
height: number;

435
api/@ohos.window.d.ts vendored
View File

@ -56,6 +56,14 @@ declare namespace window {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
/**
* The type of a window.
*
* @enum { number }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
enum WindowType {
/**
* App.
@ -135,6 +143,15 @@ declare namespace window {
* @StageModelOnly
* @since 9
*/
/**
* Float.
*
* @permission ohos.permission.SYSTEM_FLOAT_WINDOW
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @StageModelOnly
* @atomicservice
* @since 12
*/
TYPE_FLOAT,
/**
* Wallpaper.
@ -206,6 +223,14 @@ declare namespace window {
* @StageModelOnly
* @since 10
*/
/**
* Dialog.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @StageModelOnly
* @atomicservice
* @since 12
*/
TYPE_DIALOG,
/**
* Screenshot.
@ -473,6 +498,14 @@ declare namespace window {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Describes the window status of an application
*
* @enum { number }
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
enum WindowStatusType {
/**
* Undefined status of the window
@ -480,6 +513,13 @@ declare namespace window {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Undefined status of the window
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
UNDEFINED = 0,
/**
* Full screen status of the window
@ -487,6 +527,13 @@ declare namespace window {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Full screen status of the window
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
FULL_SCREEN,
/**
* Maximize status of the window
@ -494,6 +541,13 @@ declare namespace window {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Maximize status of the window
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
MAXIMIZE,
/**
* Minimize status of the window
@ -501,6 +555,13 @@ declare namespace window {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Minimize status of the window
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
MINIMIZE,
/**
* Floating status of the window
@ -508,6 +569,13 @@ declare namespace window {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Floating status of the window
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
FLOATING,
/**
* Split screen status of the window
@ -515,6 +583,13 @@ declare namespace window {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Split screen status of the window
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
SPLIT_SCREEN
}
@ -656,6 +731,7 @@ declare namespace window {
* The content color of the status bar
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
statusBarContentColor?: string;
@ -1204,6 +1280,14 @@ declare namespace window {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 11
*/
/**
* The position relative to the window and size of drawable area
*
* @type { Rect }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
drawableRect: Rect;
/**
@ -1213,6 +1297,14 @@ declare namespace window {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
/**
* Window type
*
* @type { WindowType }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
type: WindowType;
/**
@ -1256,6 +1348,14 @@ declare namespace window {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
/**
* Whether the window can gain focus. The default value is true
*
* @type { boolean }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
focusable: boolean;
/**
@ -1265,6 +1365,14 @@ declare namespace window {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
/**
* Whether the window is touchable. The default value is false
*
* @type { boolean }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
touchable: boolean;
/**
@ -1334,6 +1442,14 @@ declare namespace window {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
/**
* Whether make window in privacy mode or not.
*
* @type { boolean }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
isPrivacyMode: boolean;
/**
@ -1353,6 +1469,14 @@ declare namespace window {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
/**
* Whether is transparent or not.
*
* @type { boolean }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
isTransparent: boolean;
/**
@ -1362,6 +1486,14 @@ declare namespace window {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Window id.
*
* @type { number }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
id: number;
}
@ -1380,6 +1512,15 @@ declare namespace window {
* @crossplatform
* @since 11
*/
/**
* Type of allowing the specified of color space.
*
* @enum { number }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @atomicservice
* @since 12
*/
enum ColorSpace {
/**
* Default color space.
@ -1394,6 +1535,14 @@ declare namespace window {
* @crossplatform
* @since 11
*/
/**
* Default color space.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @atomicservice
* @since 12
*/
DEFAULT,
/**
* Wide gamut color space. The specific wide color gamut depends on thr screen.
@ -1408,6 +1557,14 @@ declare namespace window {
* @crossplatform
* @since 11
*/
/**
* Wide gamut color space. The specific wide color gamut depends on thr screen.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @atomicservice
* @since 12
*/
WIDE_GAMUT
}
/**
@ -1628,6 +1785,14 @@ declare namespace window {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Configuration parameters for window creation.
*
* @interface Configuration
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
interface Configuration {
/**
* Indicates window id.
@ -1635,6 +1800,13 @@ declare namespace window {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Indicates window id.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
name: string;
/**
@ -1644,6 +1816,14 @@ declare namespace window {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Indicates window type
*
* @type { WindowType }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
windowType: WindowType;
/**
@ -1653,6 +1833,14 @@ declare namespace window {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Indicates window context.
*
* @type { ?BaseContext }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
ctx?: BaseContext;
/**
@ -1662,6 +1850,14 @@ declare namespace window {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Indicates display ID.
*
* @type { ?number }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
displayId?: number;
/**
@ -1671,6 +1867,14 @@ declare namespace window {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Indicates Parent window id
*
* @type { ?number }
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
parentId?: number;
/**
@ -1678,6 +1882,7 @@ declare namespace window {
*
* @type { ?boolean }
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
decorEnabled?: boolean;
@ -1687,6 +1892,7 @@ declare namespace window {
*
* @type { ?string }
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
title?: string;
@ -2027,6 +2233,7 @@ declare namespace window {
* @throws { BusinessError } 1300008 - The display device is abnormal.
* @throws { BusinessError } 1300009 - The parent window is invalid.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
function createWindow(config: Configuration, callback: AsyncCallback<Window>): void;
@ -2061,6 +2268,7 @@ declare namespace window {
* @throws { BusinessError } 1300008 - The display device is abnormal.
* @throws { BusinessError } 1300009 - The parent window is invalid.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
function createWindow(config: Configuration): Promise<Window>;
@ -2472,6 +2680,22 @@ declare namespace window {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Shift window focus within the same application. And the window type contains only main window and subwindow.
*
* @param { number } sourceWindowId - Window id which the focus shift from.
* @param { number } targetWindowId - Window id which the focus shift to.
* @returns { Promise<void> } - Promise that returns no value.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types.
* @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities.
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @throws { BusinessError } 1300003 - This window manager service works abnormally.
* @throws { BusinessError } 1300004 - Unauthorized operation.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
function shiftAppWindowFocus(sourceWindowId: number, targetWindowId: number): Promise<void>;
/**
@ -2625,6 +2849,14 @@ declare namespace window {
* @crossplatform
* @since 10
*/
/**
* Default value. The direction mode is not clearly defined. It is determined by the system.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @crossplatform
* @atomicservice
* @since 12
*/
UNSPECIFIED = 0,
/**
@ -2740,6 +2972,13 @@ declare namespace window {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Follow the rotation of the sensor, only work in the vertical direction, ignore auto rotation lock.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
AUTO_ROTATION_PORTRAIT = 6,
/**
@ -2778,6 +3017,13 @@ declare namespace window {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Follow the rotation of the sensor, only work in the vertical direction, controlled by auto rotation lock.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
AUTO_ROTATION_PORTRAIT_RESTRICTED = 9,
/**
@ -2786,6 +3032,13 @@ declare namespace window {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Follow the rotation of the sensor, only work in the horizontal direction, controlled by auto rotation lock.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
AUTO_ROTATION_LANDSCAPE_RESTRICTED = 10,
/**
@ -2794,12 +3047,20 @@ declare namespace window {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Locked mode, keep the same direction as previous one.
*
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
LOCKED = 11,
/**
* Follow the rotation of the sensor, determined by the system, controlled by auto rotation lock.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
AUTO_ROTATION_UNSPECIFIED = 12,
@ -2808,6 +3069,7 @@ declare namespace window {
* Display in portrait orientation, and then, follow the rotation of the sensor, determined by the system, controlled by auto rotation lock.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
USER_ROTATION_PORTRAIT = 13,
@ -2816,6 +3078,7 @@ declare namespace window {
* Display in landscape orientation, and then, follow the rotation of the sensor, determined by the system, controlled by auto rotation lock.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
USER_ROTATION_LANDSCAPE = 14,
@ -2824,6 +3087,7 @@ declare namespace window {
* Display in inverted portrait orientation, and then, follow the rotation of the sensor, determined by the system, controlled by auto rotation lock.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
USER_ROTATION_PORTRAIT_INVERTED = 15,
@ -2832,6 +3096,7 @@ declare namespace window {
* Display in inverted landscape orientation, and then, follow the rotation of the sensor, determined by the system, controlled by auto rotation lock.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
USER_ROTATION_LANDSCAPE_INVERTED = 16,
@ -2840,6 +3105,7 @@ declare namespace window {
* Follow the desktop rotate mode.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
FOLLOW_DESKTOP = 17
@ -4597,6 +4863,18 @@ declare namespace window {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
/**
* Register the callback of keyboardHeightChange
*
* @param { 'keyboardHeightChange' } type - The value is fixed at 'keyboardHeightChange', indicating the keyboard height change event.
* @param { Callback<number> } callback - Callback used to return the current keyboard height.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types;
* 3. Parameter verification failed.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
on(type: 'keyboardHeightChange', callback: Callback<number>): void;
/**
@ -4609,6 +4887,17 @@ declare namespace window {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 7
*/
/**
* Unregister the callback of keyboardHeightChange
*
* @param { 'keyboardHeightChange' } type - The value is fixed at 'keyboardHeightChange', indicating the keyboard height change event.
* @param { Callback<number> } callback - Callback used to return the current keyboard height.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types;
* 2. Parameter verification failed.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
off(type: 'keyboardHeightChange', callback?: Callback<number>): void;
/**
@ -4652,6 +4941,21 @@ declare namespace window {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Window visibility change callback on.
*
* @param { 'windowVisibilityChange' } type - The value is fixed at 'windowVisibilityChange', indicating the window visibility change.
* @param { Callback<boolean> } callback - Callback used to notify the window visibility change.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types;
* 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities.
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @throws { BusinessError } 1300003 - This window manager service works abnormally.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
on(type: 'windowVisibilityChange', callback: Callback<boolean>): void;
/**
@ -4667,6 +4971,20 @@ declare namespace window {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Window visibility change callback off.
*
* @param { 'windowVisibilityChange' } type - The value is fixed at 'windowVisibilityChange', indicating the window visibility change.
* @param { Callback<boolean> } callback - Callback used to notify the window visibility change.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types;
* 2. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities.
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @throws { BusinessError } 1300003 - This window manager service works abnormally.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
off(type: 'windowVisibilityChange', callback?: Callback<boolean>): void;
/**
@ -4682,6 +5000,7 @@ declare namespace window {
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @throws { BusinessError } 1300003 - This window manager service works abnormally.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
on(type: 'noInteractionDetected', timeout: number, callback: Callback<void>): void;
@ -4695,6 +5014,7 @@ declare namespace window {
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @throws { BusinessError } 1300003 - This window manager service works abnormally.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
off(type: 'noInteractionDetected', callback?: Callback<void>): void;
@ -4710,6 +5030,18 @@ declare namespace window {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Register the callback of screenshot, only the focused window called back
*
* @param { 'screenshot' } type - The value is fixed at 'screenshot', indicating the screenshot event.
* @param { Callback<void> } callback - Callback invoked when a screenshot event occurs.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types;
* 3. Parameter verification failed.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
on(type: 'screenshot', callback: Callback<void>): void;
/**
@ -4722,6 +5054,17 @@ declare namespace window {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Unregister the callback of screenshot
*
* @param { 'screenshot' } type - The value is fixed at 'screenshot', indicating the screenshot event.
* @param { Callback<void> } callback - Callback invoked when a screenshot event occurs.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types;
* 2. Parameter verification failed.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
off(type: 'screenshot', callback?: Callback<void>): void;
/**
@ -4735,6 +5078,18 @@ declare namespace window {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 10
*/
/**
* Register the callback of dialogTargetTouch
*
* @param { 'dialogTargetTouch' } type - The value is fixed at 'dialogTargetTouch', indicating the click event of the target window in the modal window mode.
* @param { Callback<void> } callback - Callback invoked when the click event occurs in the target window of the modal window mode.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types;
* 3. Parameter verification failed.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
on(type: 'dialogTargetTouch', callback: Callback<void>): void;
/**
@ -4748,6 +5103,18 @@ declare namespace window {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 10
*/
/**
* Unregister the callback of dialogTargetTouch
*
* @param { 'dialogTargetTouch' } type - The value is fixed at 'dialogTargetTouch',
* indicating the click event of the target window in the modal window mode.
* @param { Callback<void> } callback - Callback invoked when the click event occurs in the target window of the modal window mode.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types;
* 2. Parameter verification failed.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
off(type: 'dialogTargetTouch', callback?: Callback<void>): void;
/**
@ -4812,6 +5179,19 @@ declare namespace window {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Register the callback of windowStatusChange
*
* @param { 'windowStatusChange' } type - The value is fixed at 'windowStatusChange', indicating the window status change event.
* @param { Callback<WindowStatusType> } callback - Callback used to return the window status.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified;
* 2. Incorrect parameter types;
* 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
on(type: 'windowStatusChange', callback: Callback<WindowStatusType>): void;
/**
@ -4825,6 +5205,18 @@ declare namespace window {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Unregister the callback of windowStatusChange
*
* @param { 'windowStatusChange' } type - The value is fixed at 'windowStatusChange', indicating the window status change event.
* @param { Callback<WindowStatusType> } callback - Callback used to return the window status.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Incorrect parameter types;
* 2. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
off(type: 'windowStatusChange', callback?: Callback<WindowStatusType>): void;
/**
@ -4838,6 +5230,7 @@ declare namespace window {
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @throws { BusinessError } 1300004 - Unauthorized operation.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
on(type: 'subWindowClose', callback: Callback<void>): void;
@ -4853,6 +5246,7 @@ declare namespace window {
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @throws { BusinessError } 1300004 - Unauthorized operation.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
off(type: 'subWindowClose', callback?: Callback<void>): void;
@ -6953,6 +7347,14 @@ declare namespace window {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Options for subwindow creation
*
* @interface SubWindowOptions
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
interface SubWindowOptions {
/**
* Indicates subwindow title
@ -6961,6 +7363,14 @@ declare namespace window {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Indicates subwindow title
*
* @type { string }
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
title: string;
/**
* Indicates decor of subwindow
@ -6969,12 +7379,21 @@ declare namespace window {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
/**
* Indicates decor of subwindow
*
* @type { boolean }
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
decorEnabled: boolean;
/**
* Indicates modality of subwindow
*
* @type { ?boolean }
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
isModal?: boolean;
@ -7209,6 +7628,21 @@ declare namespace window {
* @StageModelOnly
* @since 11
*/
/**
* Create sub window of the stage.
*
* @param { string } name - window name of sub window
* @param { SubWindowOptions } options - options of sub window creation
* @returns { Promise<Window> } Promise used to return the subwindow.
* @throws { BusinessError } 401 - Parameter error. Possible cause: Incorrect parameter types.
* @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities.
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @throws { BusinessError } 1300005 - This window stage is abnormal.
* @syscap SystemCapability.Window.SessionManager
* @StageModelOnly
* @atomicservice
* @since 12
*/
createSubWindowWithOptions(name: string, options: SubWindowOptions): Promise<Window>;
/**
* Get sub window of the stage.
@ -7589,6 +8023,7 @@ declare namespace window {
* @throws { BusinessError } 1300005 - This window stage is abnormal.
* @syscap SystemCapability.Window.SessionManager
* @StageModelOnly
* @atomicservice
* @since 12
*/
setDefaultDensityEnabled(enabled: boolean): void;

89
api/@system.app.d.ts vendored
View File

@ -25,6 +25,14 @@
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @since 3
*/
/**
* Defines the AppResponse info.
*
* @interface AppResponse
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @atomicservice
* @since 12
*/
export interface AppResponse {
/**
* Application bundleName.
@ -33,6 +41,14 @@ export interface AppResponse {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 6
*/
/**
* Application bundleName.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
appID: string;
/**
@ -42,6 +58,14 @@ export interface AppResponse {
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @since 3
*/
/**
* Application name.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @atomicservice
* @since 12
*/
appName: string;
/**
@ -51,6 +75,14 @@ export interface AppResponse {
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @since 3
*/
/**
* Application version name.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @atomicservice
* @since 12
*/
versionName: string;
/**
@ -60,6 +92,14 @@ export interface AppResponse {
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @since 3
*/
/**
* Application version.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @atomicservice
* @since 12
*/
versionCode: number;
}
@ -188,6 +228,13 @@ export interface RequestFullWindowOptions {
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @since 3
*/
/**
* Defines the app class info.
*
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @atomicservice
* @since 12
*/
export default class App {
/**
* Obtains the declared information in the config.json file of an application.
@ -196,6 +243,14 @@ export default class App {
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @since 3
*/
/**
* Obtains the declared information in the config.json file of an application.
*
* @returns { AppResponse }
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @atomicservice
* @since 12
*/
static getInfo(): AppResponse;
/**
@ -204,6 +259,13 @@ export default class App {
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @since 3
*/
/**
* Destroys the current ability.
*
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @atomicservice
* @since 12
*/
static terminate(): void;
/**
@ -240,6 +302,15 @@ export default class App {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
*/
/**
* Set image cache capacity of decoded image count.
* if not set, the application will not cache any decoded image.
*
* @param { number } value - capacity of decoded image count.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
static setImageCacheCount(value: number): void;
/**
@ -250,6 +321,15 @@ export default class App {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
*/
/**
* Set image cache capacity of raw image data size in bytes before decode.
* if not set, the application will not cache any raw image data.
*
* @param { number } value - capacity of raw image data size in bytes.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
static setImageRawDataCacheSize(value: number): void;
/**
@ -260,5 +340,14 @@ export default class App {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
*/
/**
* Set image file cache size in bytes on disk before decode.
* if not set, the application will cache 100MB image files on disk.
*
* @param { number } value - capacity of raw image data size in bytes.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
static setImageFileCacheSize(value: number): void;
}

45
api/@system.configuration.d.ts vendored
View File

@ -23,6 +23,12 @@
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @since 3
*/
/**
* @interface LocaleResponse
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @atomicservice
* @since 12
*/
export interface LocaleResponse {
/**
* Current language of the application. Example: zh.
@ -31,6 +37,14 @@ export interface LocaleResponse {
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @since 3
*/
/**
* Current language of the application. Example: zh.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @atomicservice
* @since 12
*/
language: string;
/**
@ -40,6 +54,14 @@ export interface LocaleResponse {
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @since 3
*/
/**
* Country or region. Example: CN.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @atomicservice
* @since 12
*/
countryOrRegion: string;
/**
@ -51,6 +73,16 @@ export interface LocaleResponse {
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @since 3
*/
/**
* Text layout direction. Available values are as follows:
* ltr: The text direction is from left to right.
* rtl: The text direction is from right to left.
*
* @type { "ltr" | "rtl" }
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @atomicservice
* @since 12
*/
dir: "ltr" | "rtl";
}
@ -58,6 +90,11 @@ export interface LocaleResponse {
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @since 3
*/
/**
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @atomicservice
* @since 12
*/
export default class Configuration {
/**
* Obtains the current locale of the application, which is the same as the system locale.
@ -66,5 +103,13 @@ export default class Configuration {
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @since 3
*/
/**
* Obtains the current locale of the application, which is the same as the system locale.
*
* @returns { LocaleResponse }
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @atomicservice
* @since 12
*/
static getLocale(): LocaleResponse;
}

2
api/arkui/AlphabetIndexerModifier.d.ts vendored
View File

@ -26,6 +26,7 @@
* @extends AlphabetIndexerAttribute
* @implements AttributeModifier
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
export declare class AlphabetIndexerModifier extends AlphabetIndexerAttribute implements AttributeModifier<AlphabetIndexerAttribute> {
@ -36,6 +37,7 @@ export declare class AlphabetIndexerModifier extends AlphabetIndexerAttribute im
* @param { AlphabetIndexerAttribute } instance
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
applyNormalAttribute?(instance: AlphabetIndexerAttribute): void;

6
api/arkui/AttributeUpdater.d.ts vendored
View File

@ -25,6 +25,7 @@
* @returns { T }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare type Initializer<T> = () => T;
@ -35,6 +36,7 @@ declare type Initializer<T> = () => T;
* @implements AttributeModifier
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export declare class AttributeUpdater<T, C = Initializer<T>> implements AttributeModifier<T> {
@ -45,6 +47,7 @@ export declare class AttributeUpdater<T, C = Initializer<T>> implements Attribut
* @param { T } instance
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
applyNormalAttribute?(instance: T): void;
@ -55,6 +58,7 @@ export declare class AttributeUpdater<T, C = Initializer<T>> implements Attribut
* @param { T } instance
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
initializeModifier(instance: T): void;
@ -65,6 +69,7 @@ export declare class AttributeUpdater<T, C = Initializer<T>> implements Attribut
* @returns { T | undefined } The attribute of the modifier.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
get attribute(): T | undefined;
@ -75,6 +80,7 @@ export declare class AttributeUpdater<T, C = Initializer<T>> implements Attribut
* @type { C }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
updateConstructorParams: C;

2
api/arkui/BlankModifier.d.ts vendored
View File

@ -26,6 +26,7 @@
* @extends BlankAttribute
* @implements AttributeModifier
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
export declare class BlankModifier extends BlankAttribute implements AttributeModifier<BlankAttribute> {
@ -36,6 +37,7 @@ export declare class BlankModifier extends BlankAttribute implements AttributeMo
* @param { BlankAttribute } instance
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
applyNormalAttribute?(instance: BlankAttribute): void;

2
api/arkui/BuilderNode.d.ts vendored
View File

@ -274,6 +274,7 @@ export class BuilderNode<Args extends Object[]> {
* @param { Object } [param] - Parameters for reusing BuilderNode.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
reuse(param?: Object): void;
@ -283,6 +284,7 @@ export class BuilderNode<Args extends Object[]> {
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
recycle(): void;

2
api/arkui/ButtonModifier.d.ts vendored
View File

@ -26,6 +26,7 @@
* @extends ButtonAttribute
* @implements AttributeModifier
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
export declare class ButtonModifier extends ButtonAttribute implements AttributeModifier<ButtonAttribute> {
@ -36,6 +37,7 @@ export declare class ButtonModifier extends ButtonAttribute implements Attribute
* @param { ButtonAttribute } instance
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
applyNormalAttribute?(instance: ButtonAttribute): void;

Some files were not shown because too many files have changed in this diff Show More