revise name

Signed-off-by: luoying_ace_admin <luoying19@huawei.com>
This commit is contained in:
luoying_ace_admin 2022-11-18 14:38:45 +08:00
parent 7b71522549
commit 08d0b0cfa7
35 changed files with 75 additions and 65 deletions

View File

@ -53,6 +53,7 @@ declare class AlphabetIndexerAttribute extends CommonMethod<AlphabetIndexerAttri
* Index bar selection callback.
* @since 7
* @deprecated since 8
* @useinstead onSelect
*/
onSelected(callback: (index: number) => void): AlphabetIndexerAttribute;

View File

@ -70,7 +70,7 @@ declare class ScrollMotion {
}
/**
* Defines Animtor.
* Defines Animator.
* @since 7
* @systemapi
*/

View File

@ -116,7 +116,7 @@ declare interface BadgeParamWithString extends BadgeParam {
}
/**
* Defines Badge Componrnt.
* Defines Badge Component.
* @since 7
*/
interface BadgeInterface {
@ -140,7 +140,7 @@ interface BadgeInterface {
}
/**
* Defines Badge Componrnt attribute.
* Defines Badge Component attribute.
* @since 7
*/
declare class BadgeAttribute extends CommonMethod<BadgeAttribute> {}

View File

@ -283,7 +283,7 @@ interface CurrentDayStyle {
scheduleMarkerRadius?: number;
/**
* Bound dary row offset.
* Boundary row offset.
* @since 7
* @systemapi
*/

View File

@ -19,7 +19,7 @@
*/
declare enum SelectStatus {
/**
* All checkboxs is selected.
* All checkboxes are selected.
* @since 8
*/
All,

View File

@ -692,12 +692,12 @@ declare enum SourceTool {
/**
* The finger type.
*/
FINGER,
Finger,
/**
* The pen type.
*/
PEN,
Pen,
}
/**
@ -1090,7 +1090,7 @@ declare interface KeyEvent {
}
/**
* Component State Styels.
* Component State Styles.
* @since 8
*/
declare interface StateStyles {
@ -1304,7 +1304,8 @@ declare class CommonMethod<T> {
/**
* Sets the touchable of the current component
* @since 7
* @deprecated since 9, instead of hitTestBehavior.
* @deprecated since 9
* @useinstead hitTestBehavior
*/
touchable(value: boolean): T;
@ -1599,7 +1600,7 @@ declare class CommonMethod<T> {
sepia(value: number): T;
/**
* Inverts the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal.
* Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal.
* A value of 0% does not change the image. (Percentage)
* @since 7
*/
@ -1875,7 +1876,7 @@ declare class CommonMethod<T> {
* path:Motion path for displacement animation, using the svg path string.
* from:Start point of the motion path. The default value is 0.0.
* to:End point of the motion path. The default value is 1.0.
* rotatble:Whether to follow the path for rotation.
* rotatable:Whether to follow the path for rotation.
* @since 7
*/
motionPath(value: MotionPathOptions): T;
@ -1949,7 +1950,7 @@ declare class CommonMethod<T> {
stateStyles(value: StateStyles): T;
/**
* id for distrubte identification.
* id for distribute identification.
* @since 8
*/
restoreId(value: number): T;
@ -2001,7 +2002,7 @@ declare class CommonShapeMethod<T> extends CommonMethod<T> {
/**
* constructor.
* @since 7
* @syetemapi
* @systemapi
*/
constructor();
@ -2214,7 +2215,7 @@ declare class CustomComponent extends CommonAttribute {
declare class View {
/**
* Just use for generate tsbundle
* @ignore ide should ignore this arrtibute
* @ignore ide should ignore this attribute
* @systemapi
* @since 7
*/

View File

@ -368,14 +368,12 @@ interface ISinglePropertyChangeSubscriber<T> extends IPropertySubscriber {
* Defines the Subscribale base class.
* @since 7
* @systemapi
* @hide
*/
declare abstract class SubscribaleAbstract {
/**
* Returns the ownership attribute set by the.
* @since 7
* @systemapi
* @hide
*/
private owningProperties_: Set<number>;
@ -383,7 +381,6 @@ declare abstract class SubscribaleAbstract {
* Constructor.
* @since 7
* @systemapi
* @hide
*/
constructor();
@ -391,7 +388,6 @@ declare abstract class SubscribaleAbstract {
* Called when the notification property has changed.
* @since 7
* @systemapi
* @hide
*/
protected notifyPropertyHasChanged(propName: string, newValue: any): void;
@ -399,7 +395,6 @@ declare abstract class SubscribaleAbstract {
* Called when adding an already owned property.
* @since 7
* @systemapi
* @hide
*/
public addOwningProperty(subscriber: IPropertySubscriber): void;
@ -407,7 +402,6 @@ declare abstract class SubscribaleAbstract {
* Called when an already owned property is deleted.
* @since 7
* @systemapi
* @hide
*/
public removeOwningProperty(property: IPropertySubscriber): void;
@ -415,7 +409,6 @@ declare abstract class SubscribaleAbstract {
* Called when an already owned property is deleted by ID
* @since 7
* @systemapi
* @hide
*/
public removeOwningPropertyById(subscriberId: number): void;
}
@ -429,7 +422,6 @@ declare class Environment {
* Constructor.
* @since 7
* @systemapi
* @hide
*/
constructor();
@ -466,7 +458,6 @@ declare class PersistentStorage {
* Constructor parameters.
* @since 7
* @systemapi
* @hide
*/
constructor(appStorage: AppStorage, storage: Storage);
@ -504,7 +495,6 @@ declare class PersistentStorage {
* Used for ide.
* @since 7
* @systemapi
* @hide
*/
declare const appStorage: AppStorage;
@ -527,7 +517,7 @@ declare const appStorage: AppStorage;
static GetShared(): LocalStorage;
/**
* Return true if prooperty with given name exists
* Return true if property with given name exists
* @since 9
*/
has(propName: string): boolean;

View File

@ -50,7 +50,7 @@ declare interface CustomDialogControllerOptions {
offset?: Offset;
/**
* Defines if use costom style.
* Defines if use custom style.
* @since 7
*/
customStyle?: boolean;

View File

@ -361,7 +361,7 @@ declare enum Curve {
LinearOutSlowIn,
/**
* Fast OutL inear In.
* Fast Out Linear In.
* @since 7
*/
FastOutLinearIn,
@ -1514,13 +1514,13 @@ declare enum HitTestMode {
*/
declare enum TitleHeight {
/**
* Title height when only main title is avaliable.
* Title height when only main title is available.
* @since 9
*/
MainOnly,
/**
* Title height when main title and subtitle are both avaliable.
* Title height when main title and subtitle are both available.
* @since 9
*/
MainWithSub,

View File

@ -53,7 +53,7 @@ declare enum GridDirection {
}
/**
* Defines the grid attibute functions.
* Defines the grid attribute functions.
* @since 7
*/
declare class GridAttribute extends CommonMethod<GridAttribute> {

View File

@ -28,7 +28,7 @@ interface HyperlinkInterface {
}
/**
* Defines the hyperlink attibute functions
* Defines the hyperlink attribute functions
* @since 7
*/
declare class HyperlinkAttribute extends CommonMethod<HyperlinkAttribute> {

View File

@ -17,7 +17,8 @@
* Get inspector node infos.
* @since 7
* @systemapi
* @deprecated
* @deprecated since 9
* @useinstead getInspectorTree
*/
declare function getInspectorNodes(): object;
@ -25,7 +26,8 @@ declare function getInspectorNodes(): object;
* Get inspector node info by node id.
* @since 7
* @systemapi
* @deprecated
* @deprecated since 9
* @useinstead getInspectorByKey
*/
declare function getInspectorNodeById(id: number): object;

View File

@ -28,6 +28,7 @@ declare interface DataChangeListener {
* Data added.
* @since 7
* @deprecated since 8
* @useinstead onDataAdd
*/
onDataAdded(index: number): void;
@ -41,6 +42,7 @@ declare interface DataChangeListener {
* Data moved.
* @since 7
* @deprecated since 8
* @useinstead onDataMove
*/
onDataMoved(from: number, to: number): void;
@ -54,6 +56,7 @@ declare interface DataChangeListener {
* Data deleted.
* @since 7
* @deprecated since 8
* @useinstead onDataDelete
*/
onDataDeleted(index: number): void;
@ -67,6 +70,7 @@ declare interface DataChangeListener {
* Call when has data change.
* @since 7
* @deprecated since 8
* @useinstead onDataChange
*/
onDataChanged(index: number): void;

View File

@ -52,7 +52,7 @@ declare enum EditMode {
None,
/**
* Deleteable.
* Deletable.
* @since 7
*/
Deletable,

View File

@ -50,7 +50,7 @@ interface ListItemGroupInterface {
}
/**
* Defines the item group attibute functions.
* Defines the item group attribute functions.
* @since 9
*/
declare class ListItemGroupAttribute extends CommonMethod<ListItemGroupAttribute> {

View File

@ -50,7 +50,7 @@ declare interface NavigationCustomTitle {
}
/**
* Nativation mode
* Navigation mode
* @since 9
*/
declare enum NavigationMode {

View File

@ -48,7 +48,7 @@ interface PluginComponentInterface {
}
/**
* Defines the plugin component attibute functions.
* Defines the plugin component attribute functions.
* @since 9
* @systemapi
*/

View File

@ -34,6 +34,7 @@
* Sets the style of Progress.
* @since 7
* @deprecated since 8
* @useinstead type
*/
style?: ProgressStyle
@ -92,7 +93,7 @@ declare interface ProgressStyleOptions {
strokeWidth?: Length;
/**
* Defines the scaleCoun property.
* Defines the scaleCount property.
* @since 8
*/
scaleCount?: number;
@ -153,7 +154,7 @@ interface ProgressInterface {
}
/**
* Defines the progress attibute functions.
* Defines the progress attribute functions.
* @since 7
*/
declare class ProgressAttribute extends CommonMethod<ProgressAttribute> {

View File

@ -26,7 +26,7 @@ interface QRCodeInterface {
}
/**
* Defines the qrcode attibute functions.
* Defines the qrcode attribute functions.
* @since 7
*/
declare class QRCodeAttribute extends CommonMethod<QRCodeAttribute> {

View File

@ -26,7 +26,7 @@ interface RatingInterface {
}
/**
* Defines the rating attibute functions.
* Defines the rating attribute functions.
* @since 7
*/
declare class RatingAttribute extends CommonMethod<RatingAttribute> {

View File

@ -62,7 +62,7 @@ interface RefreshInterface {
}
/**
* Defines the refresh attibute functions.
* Defines the refresh attribute functions.
* @since 8
*/
declare class RefreshAttribute extends CommonMethod<RefreshAttribute> {

View File

@ -115,7 +115,7 @@ interface ScrollInterface {
}
/**
* Defines the scroll attibute functions.
* Defines the scroll attribute functions.
* @since 7
*/
declare class ScrollAttribute extends CommonMethod<ScrollAttribute> {
@ -168,7 +168,7 @@ declare class ScrollAttribute extends CommonMethod<ScrollAttribute> {
edgeEffect(edgeEffect: EdgeEffect): ScrollAttribute;
/**
* Event called when sroll will scroll.
* Event called when Scroll will scroll.
* @since 9
*/
onScrollBegin(event: (dx: number, dy: number) => { dxRemain: number, dyRemain: number }): ScrollAttribute;

View File

@ -68,7 +68,7 @@ interface ScrollBarInterface {
}
/**
* Defines the scrollbar attibute functions.
* Defines the scrollbar attribute functions.
* @since 8
*/
declare class ScrollBarAttribute extends CommonMethod<ScrollBarAttribute> {}

View File

@ -14,7 +14,7 @@
*/
/**
* The declare of slectOption.
* The declare of selectOption.
* @since 8
*/
declare interface SelectOption {

View File

@ -69,7 +69,7 @@ declare interface ButtonStyle {
width?: number;
/**
* Set the heigth of control button
* Set the height of control button
* @since 8
*/
height?: number;

View File

@ -56,7 +56,7 @@ interface StepperItemInterface {
}
/**
* Defines the stepper item attrbute functions.
* Defines the stepper item attribute functions.
* @since 8
*/
declare class StepperItemAttribute extends CommonMethod<StepperItemAttribute> {

View File

@ -128,7 +128,7 @@ declare interface IndicatorStyle {
}
/**
* Defines the swiper attibute functions.
* Defines the swiper attribute functions.
* @since 7
*/
declare class SwiperAttribute extends CommonMethod<SwiperAttribute> {

View File

@ -195,6 +195,7 @@ declare class TextInputAttribute extends CommonMethod<TextInputAttribute> {
* Called when judging whether the text editing change finished.
* @since 7
* @deprecated since 8
* @useinstead onEditChange
*/
onEditChanged(callback: (isEditing: boolean) => void): TextInputAttribute;

View File

@ -50,7 +50,7 @@ interface ToggleInterface {
}
/**
* Defines the toggle attibute functions
* Defines the toggle attribute functions
* @since 8
*/
declare class ToggleAttribute extends CommonMethod<ToggleAttribute> {

View File

@ -82,7 +82,7 @@ export declare function setInterval(handler: Function | string, delay: number, .
export declare function setTimeout(handler: Function | string, delay?: number, ...arguments: any[]): number;
/**
* Cancels the interval set by " setInterval()".
* Cancel the interval set by " setInterval()".
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @param intervalID Indicates the timer ID returned by "setInterval()".
* @since 7
@ -90,7 +90,7 @@ export declare function setTimeout(handler: Function | string, delay?: number, .
export declare function clearInterval(intervalID?: number): void;
/**
* Cancels the timer set by "setTimeout()".
* Cancel the timer set by "setTimeout()".
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @param timeoutID Indicates the timer ID returned by "setTimeout()".
* @since 7

View File

@ -76,6 +76,7 @@ declare namespace curves {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
* @deprecated since 9
* @useinstead initCurve
*/
function init(curve?: Curve): string;
@ -97,6 +98,7 @@ declare namespace curves {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
* @deprecated since 9
* @useinstead stepsCurve
*/
function steps(count: number, end: boolean): string;
@ -120,6 +122,7 @@ declare namespace curves {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
* @deprecated since 9
* @useinstead cubicBezierCurve
*/
function cubicBezier(x1: number, y1: number, x2: number, y2: number): string;
@ -145,6 +148,7 @@ declare namespace curves {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
* @deprecated since 9
* @useinstead springCurve
*/
function spring(velocity: number, mass: number, stiffness: number, damping: number): string;

View File

@ -73,7 +73,7 @@ export interface MediaQueryList {
}
/**
* Defines the mediaqurey interface.
* Defines the mediaquery interface.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 3
*/

View File

@ -16,7 +16,8 @@
/**
* Defines the option of router.
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @deprecated since 8, please use @ohos.router instead.
* @deprecated since 8
* @useinstead @ohos.router
* @since 3
*/
export interface RouterOptions {
@ -45,7 +46,8 @@ export interface RouterOptions {
/**
* Defines the option of router back.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @deprecated since 8, please use @ohos.router instead.
* @deprecated since 8
* @useinstead @ohos.router
* @since 7
*/
export interface BackRouterOptions {
@ -68,7 +70,8 @@ export interface BackRouterOptions {
/**
* Defines the state of router.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @deprecated since 8, please use @ohos.router instead.
* @deprecated since 8
* @useinstead @ohos.router
* @since 3
*/
export interface RouterState {
@ -98,7 +101,8 @@ export interface RouterState {
/**
* Defines the option of EnableAlertBeforeBackPage.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @deprecated since 8, please use @ohos.router instead.
* @deprecated since 8
* @useinstead @ohos.router
* @since 6
*/
export interface EnableAlertBeforeBackPageOptions {
@ -134,7 +138,8 @@ export interface EnableAlertBeforeBackPageOptions {
/**
* Defines the option of DisableAlertBeforeBackPage.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @deprecated since 8, please use @ohos.router instead.
* @deprecated since 8
* @useinstead @ohos.router
* @since 6
*/
export interface DisableAlertBeforeBackPageOptions {
@ -167,7 +172,8 @@ type ParamsInterface = {
/**
* Defines the Router interface.
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @deprecated since 8, please use @ohos.router instead.
* @deprecated since 8
* @useinstead @ohos.router
* @since 3
*/
export default class Router {

View File

@ -21,7 +21,7 @@ import { Element } from './viewmodel';
*/
export declare class dom {
/**
* create a dynamic dom by tag, rturn element
* create a dynamic dom by tag, return element
* @param tag dom tag
* @since 8
*/

View File

@ -20,7 +20,7 @@ import image from "../../@ohos.multimedia.image";
import { CanvasPattern } from './canvaspattern';
/**
* Defines the foucs param.
* Defines the focus param.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 3
*/
@ -555,7 +555,7 @@ export interface observer {
observe(callback: string): void;
/**
* Turn off the listenerr.
* Turn off the listener.
* @since 6
*/
unobserve(): void;
@ -2546,7 +2546,7 @@ export interface ViewModel {
$t(path: string, params?: object | Array<any>): string;
/**
* Converses between singular and plural forms based on the system language, for example, this.$tc('strings.plurals').
* Converse between singular and plural forms based on the system language, for example, this.$tc('strings.plurals').
* NOTE
* The resource content is distinguished by the following JSON keys: zero, one, two, few, many, and other.
* @param path Resource file path.
@ -2698,7 +2698,7 @@ export declare class Locate {
language: string;
/**
* country or regin, such ass 'CN'.
* country or region, such ass 'CN'.
* @since 4
*/
countryOrRegion: string;
@ -2796,7 +2796,7 @@ export interface Options<T extends ViewModel, Data = DefaultData<T>> {
/**
* Listens for page active.
* Called when the page is activing.
* Called when the page is active.
* @since 5
*/
onActive?(): void;