openharmony/interface_sdk-js
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk-js synced 2024-10-07 14:13:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
6bd73dffd7
interface_sdk-js/api/@ohos.animator.d.ts
huiqiang 5c239000da fix jsdoc 
Signed-off-by: huiqiang <huiqiangdev@icloud.com>
2024-04-29 15:26:17 +08:00

669 lines
20 KiB
TypeScript
Raw Blame History

/*
* Copyright (c) 2020-2023 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the animator options.
* @interface AnimatorOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 6
*/
/**
* Defines the animator options.
* @interface AnimatorOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Defines the animator options.
* @interface AnimatorOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
export interface AnimatorOptions {
/**
* Duration of the animation, in milliseconds.
* The default value is 0.
* @type {number}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 6
*/
/**
* Duration of the animation, in milliseconds.
* The default value is 0.
* @type {number}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Duration of the animation, in milliseconds.
* The default value is 0.
* @type {number}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
duration: number;
/**
* Time curve of the animation. For details about the supported types.
* linear The animation speed keeps unchanged.
* ease The animation starts and ends at a low speed, cubic-bezier(0.25, 0.1, 0.25, 1.0).
* ease-in The animation starts at a low speed, cubic-bezier(0.42, 0.0, 1.0, 1.0).
* ease-out The animation ends at a low speed, cubic-bezier(0.0, 0.0, 0.58, 1.0).
* ease-in-out The animation starts and ends at a low speed, cubic-bezier(0.42, 0.0, 0.58, 1.0).
* fast-out-slow-in Standard curve, cubic-bezier(0.4, 0.0, 0.2, 1.0).
* linear-out-slow-in Deceleration curve, cubic-bezier(0.0, 0.0, 0.2, 1.0).
* fast-out-linear-in Acceleration curve, cubic-bezier(0.4, 0.0, 1.0, 1.0).
* friction Damping curve, cubic-bezier(0.2, 0.0, 0.2, 1.0).
* extreme-deceleration Extreme deceleration curve, cubic-bezier(0.0, 0.0, 0.0, 1.0).
* sharp Sharp curve, cubic-bezier(0.33, 0.0, 0.67, 1.0).
* rhythm Rhythm curve, cubic-bezier(0.7, 0.0, 0.2, 1.0).
* smooth Smooth curve, cubic-bezier(0.4, 0.0, 0.4, 1.0).
* cubic-bezier(x1, y1, x2, y2) You can customize an animation speed curve in the cubic-bezier() function. The x and y values of each input parameter must be between 0 and 1.
* Step curve. The number must be set and only an integer is supported, step-position is optional. It can be set to start or end. The default value is end.
* The default value is ease.
* @type {string}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 6
*/
/**
* Time curve of the animation. For details about the supported types.
* linear The animation speed keeps unchanged.
* ease The animation starts and ends at a low speed, cubic-bezier(0.25, 0.1, 0.25, 1.0).
* ease-in The animation starts at a low speed, cubic-bezier(0.42, 0.0, 1.0, 1.0).
* ease-out The animation ends at a low speed, cubic-bezier(0.0, 0.0, 0.58, 1.0).
* ease-in-out The animation starts and ends at a low speed, cubic-bezier(0.42, 0.0, 0.58, 1.0).
* fast-out-slow-in Standard curve, cubic-bezier(0.4, 0.0, 0.2, 1.0).
* linear-out-slow-in Deceleration curve, cubic-bezier(0.0, 0.0, 0.2, 1.0).
* fast-out-linear-in Acceleration curve, cubic-bezier(0.4, 0.0, 1.0, 1.0).
* friction Damping curve, cubic-bezier(0.2, 0.0, 0.2, 1.0).
* extreme-deceleration Extreme deceleration curve, cubic-bezier(0.0, 0.0, 0.0, 1.0).
* sharp Sharp curve, cubic-bezier(0.33, 0.0, 0.67, 1.0).
* rhythm Rhythm curve, cubic-bezier(0.7, 0.0, 0.2, 1.0).
* smooth Smooth curve, cubic-bezier(0.4, 0.0, 0.4, 1.0).
* cubic-bezier(x1, y1, x2, y2) You can customize an animation speed curve in the cubic-bezier() function. The x and y values of each input parameter must be between 0 and 1.
* Step curve. The number must be set and only an integer is supported, step-position is optional. It can be set to start or end. The default value is end.
* The default value is ease.
* @type {string}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Time curve of the animation. For details about the supported types.
* linear The animation speed keeps unchanged.
* ease The animation starts and ends at a low speed, cubic-bezier(0.25, 0.1, 0.25, 1.0).
* ease-in The animation starts at a low speed, cubic-bezier(0.42, 0.0, 1.0, 1.0).
* ease-out The animation ends at a low speed, cubic-bezier(0.0, 0.0, 0.58, 1.0).
* ease-in-out The animation starts and ends at a low speed, cubic-bezier(0.42, 0.0, 0.58, 1.0).
* fast-out-slow-in Standard curve, cubic-bezier(0.4, 0.0, 0.2, 1.0).
* linear-out-slow-in Deceleration curve, cubic-bezier(0.0, 0.0, 0.2, 1.0).
* fast-out-linear-in Acceleration curve, cubic-bezier(0.4, 0.0, 1.0, 1.0).
* friction Damping curve, cubic-bezier(0.2, 0.0, 0.2, 1.0).
* extreme-deceleration Extreme deceleration curve, cubic-bezier(0.0, 0.0, 0.0, 1.0).
* sharp Sharp curve, cubic-bezier(0.33, 0.0, 0.67, 1.0).
* rhythm Rhythm curve, cubic-bezier(0.7, 0.0, 0.2, 1.0).
* smooth Smooth curve, cubic-bezier(0.4, 0.0, 0.4, 1.0).
* cubic-bezier(x1, y1, x2, y2) You can customize an animation speed curve in the cubic-bezier() function. The x and y values of each input parameter must be between 0 and 1.
* Step curve. The number must be set and only an integer is supported, step-position is optional. It can be set to start or end. The default value is end.
* interpolating-spring(velocity, mass, stiffness, damping), interpolating spring curve.
* The default value is ease.
* @type {string}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
easing: string;
/**
* Delay for the animation start. The default value indicates no delay.
* The default value is 0.
* @type {number}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 6
*/
/**
* Delay for the animation start. The default value indicates no delay.
* The default value is 0.
* @type {number}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Delay for the animation start. The default value indicates no delay.
* The default value is 0.
* @type {number}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
delay: number;
/**
* Whether to resume to the initial state after the animation is executed.
* none: The initial state is restored after the animation is executed.
* forwards: The state at the end of the animation (defined in the last key frame) is retained after the animation is executed.
* @type {"none" | "forwards" | "backwards" | "both"}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 6
*/
/**
* Whether to resume to the initial state after the animation is executed.
* none: The initial state is restored after the animation is executed.
* forwards: The state at the end of the animation (defined in the last key frame) is retained after the animation is executed.
* @type {"none" | "forwards" | "backwards" | "both"}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Whether to resume to the initial state after the animation is executed.
* none: The initial state is restored after the animation is executed.
* forwards: The state at the end of the animation (defined in the last key frame) is retained after the animation is executed.
* @type {"none" | "forwards" | "backwards" | "both"}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
fill: "none" | "forwards" | "backwards" | "both";
/**
* The animation playback mode.
* The default value is "normal".
* @type {"normal" | "reverse" | "alternate" | "alternate-reverse"}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 6
*/
/**
* The animation playback mode.
* The default value is "normal".
* @type {"normal" | "reverse" | "alternate" | "alternate-reverse"}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* The animation playback mode.
* The default value is "normal".
* @type {"normal" | "reverse" | "alternate" | "alternate-reverse"}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
direction: "normal" | "reverse" | "alternate" | "alternate-reverse";
/**
* Number of times the animation will be played. number indicates a fixed number of playback operations, and -1 an unlimited number of playback operations.
* The default value is 1.
* @type {number}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 6
*/
/**
* Number of times the animation will be played. number indicates a fixed number of playback operations, and -1 an unlimited number of playback operations.
* The default value is 1.
* @type {number}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Number of times the animation will be played. number indicates a fixed number of playback operations, and -1 an unlimited number of playback operations.
* The default value is 1.
* @type {number}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
iterations: number;
/**
* Starting point of animator interpolation.
* The default value is 0.
* @type {number}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 6
*/
/**
* Starting point of animator interpolation.
* The default value is 0.
* @type {number}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Starting point of animator interpolation.
* The default value is 0.
* @type {number}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
begin: number;
/**
* Ending point of Dynamic Interpolation
* The default value is 1.
* @type {number}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 6
*/
/**
* Ending point of Dynamic Interpolation
* The default value is 1.
* @type {number}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Ending point of Dynamic Interpolation
* The default value is 1.
* @type {number}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
end: number;
}
/**
* Defines the Animator result interface.
* @interface AnimatorResult
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 6
*/
/**
* Defines the Animator result interface.
* @interface AnimatorResult
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Defines the Animator result interface.
* @interface AnimatorResult
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
export interface AnimatorResult {
/**
* Update the options for current animator.
* @param { AnimatorOptions } options - Options.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 6
* @deprecated since 9
* @useinstead ohos.animator.reset
*/
update(options: AnimatorOptions): void;
/**
* Reset the options for current animator.
* @param { AnimatorOptions } options - Options.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - if no page is found for pageId or fail to get object property list.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* Reset the options for current animator.
* @param { AnimatorOptions } options - Options.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - if no page is found for pageId or fail to get object property list.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Reset the options for current animator.
* @param { AnimatorOptions } options - Options.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @throws { BusinessError } 100001 - if no page is found for pageId or fail to get object property list.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
reset(options: AnimatorOptions): void;
/**
* Starts the animation.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 6
*/
/**
* Starts the animation.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Starts the animation.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
play(): void;
/**
* Ends the animation.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 6
*/
/**
* Ends the animation.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Ends the animation.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
finish(): void;
/**
* Pauses the animation.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 6
*/
/**
* Pauses the animation.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Pauses the animation.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
pause(): void;
/**
* Cancels the animation.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 6
*/
/**
* Cancels the animation.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Cancels the animation.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
cancel(): void;
/**
* Plays the animation in reverse direction.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 6
*/
/**
* Plays the animation in reverse direction.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Plays the animation in reverse direction.
* Invalid when using interpolating-spring curve.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
reverse(): void;
/**
* Trigger when vsync callback.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 6
*/
/**
* Trigger when vsync callback.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Trigger when vsync callback.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 12
* @useinstead ohos.animator.onFrame
*/
onframe: (progress: number) => void;
/**
* Trigger when vSync callback.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
onFrame: (progress: number) => void;
/**
* The animation is finished.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 6
*/
/**
* The animation is finished.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* The animation is finished.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 12
* @useinstead ohos.animator.onFinish
*/
onfinish: () => void;
/**
* The animation is finished.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
onFinish: () => void;
/**
* The animation is canceled.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 6
*/
/**
* The animation is canceled.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* The animation is canceled.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 12
* @useinstead ohos.animator.onCancel
*/
oncancel: () => void;
/**
* The animation is canceled.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
onCancel: () => void;
/**
* The animation is repeated.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 6
*/
/**
* The animation is repeated.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* The animation is repeated.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 12
* @useinstead ohos.animator.onRepeat
*/
onrepeat: () => void;
/**
* The animation is repeated.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
onRepeat: () => void;
/**
* The expected frame rate of dynamical of rate range.
* @param { ExpectedFrameRateRange } rateRange - Indicates ExpectedFrameRateRange.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 12
*/
setExpectedFrameRateRange(rateRange: ExpectedFrameRateRange): void;
}
/**
* Defines the Animator class.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 6
*/
/**
* Defines the Animator class.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Defines the Animator class.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
export default class Animator {
/**
* Create an animator object for custom animation.
* @param { AnimatorOptions } options - Options.
* @returns { AnimatorResult } animator result
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 6
* @deprecated since 9
* @useinstead ohos.animator.create
*/
static createAnimator(options: AnimatorOptions): AnimatorResult;
/**
* Create an animator object for custom animation.
* @param { AnimatorOptions } options - Options.
* @returns { AnimatorResult } animator result
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 9
*/
/**
* Create an animator object for custom animation.
* @param { AnimatorOptions } options - Options.
* @returns { AnimatorResult } animator result
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
*/
/**
* Create an animator object for custom animation.
* @param { AnimatorOptions } options - Options.
* @returns { AnimatorResult } animator result
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* <br> 1. Mandatory parameters are left unspecified.
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
static create(options: AnimatorOptions): AnimatorResult;
}
Reference in New Issue View Git Blame Copy Permalink