ArkUI API12元服务标签补充

Signed-off-by: tangjie <1402602435@qq.com>
This commit is contained in:
tangjie 2024-07-29 10:42:31 +08:00
parent 4cc8e53bed
commit 173040a1bf
6 changed files with 52 additions and 0 deletions

View File

@ -27,6 +27,7 @@
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
interface ShapeSize {
@ -35,6 +36,7 @@ interface ShapeSize {
* @type { ? (number | string) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @atomicservice
* @since 12
*/
width?: number | string;
@ -44,6 +46,7 @@ interface ShapeSize {
* @type { ? (number | string) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @atomicservice
* @since 12
*/
height?: number | string;
@ -56,6 +59,7 @@ interface ShapeSize {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
interface RectShapeOptions extends ShapeSize {
@ -64,6 +68,7 @@ interface RectShapeOptions extends ShapeSize {
* @type { ? (number | string | Array<number | string>) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @atomicservice
* @since 12
*/
radius?: number | string | Array<number | string>;
@ -76,6 +81,7 @@ interface RectShapeOptions extends ShapeSize {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
interface RoundRectShapeOptions extends ShapeSize {
@ -84,6 +90,7 @@ interface RoundRectShapeOptions extends ShapeSize {
* @type { ? (number | string) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @atomicservice
* @since 12
*/
radiusWidth?: number | string;
@ -93,6 +100,7 @@ interface RoundRectShapeOptions extends ShapeSize {
* @type { ? (number | string) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @atomicservice
* @since 12
*/
radiusHeight?: number | string;
@ -105,6 +113,7 @@ interface RoundRectShapeOptions extends ShapeSize {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
interface PathShapeOptions {
@ -113,6 +122,7 @@ interface PathShapeOptions {
* @type { ?string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @form
* @atomicservice
* @since 12
*/
commands?: string;
@ -124,6 +134,7 @@ interface PathShapeOptions {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
declare class CommonShapeMethod<T> {
@ -135,6 +146,7 @@ declare class CommonShapeMethod<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
offset(offset: Position): T;
@ -147,6 +159,7 @@ declare class CommonShapeMethod<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
fill(color: ResourceColor): T;
@ -159,6 +172,7 @@ declare class CommonShapeMethod<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
position(position: Position): T;
@ -171,6 +185,7 @@ declare class CommonShapeMethod<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
declare class BaseShape<T> extends CommonShapeMethod<T> {
@ -182,6 +197,7 @@ declare class BaseShape<T> extends CommonShapeMethod<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
width(width: Length): T;
@ -194,6 +210,7 @@ declare class BaseShape<T> extends CommonShapeMethod<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
height(height: Length): T;
@ -206,6 +223,7 @@ declare class BaseShape<T> extends CommonShapeMethod<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
size(size: SizeOptions): T;
@ -218,6 +236,7 @@ declare class BaseShape<T> extends CommonShapeMethod<T> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
export declare class RectShape extends BaseShape<RectShape> {
@ -228,6 +247,7 @@ export declare class RectShape extends BaseShape<RectShape> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
constructor(options?: RectShapeOptions | RoundRectShapeOptions);
@ -240,6 +260,7 @@ export declare class RectShape extends BaseShape<RectShape> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
radiusWidth(rWidth: number | string): RectShape;
@ -252,6 +273,7 @@ export declare class RectShape extends BaseShape<RectShape> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
radiusHeight(rHeight: number | string): RectShape;
@ -264,6 +286,7 @@ export declare class RectShape extends BaseShape<RectShape> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
radius(radius: number | string | Array<number | string>): RectShape;
@ -276,6 +299,7 @@ export declare class RectShape extends BaseShape<RectShape> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
export declare class CircleShape extends BaseShape<CircleShape> {
@ -286,6 +310,7 @@ export declare class CircleShape extends BaseShape<CircleShape> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
constructor(options?: ShapeSize);
@ -298,6 +323,7 @@ export declare class CircleShape extends BaseShape<CircleShape> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
export declare class EllipseShape extends BaseShape<EllipseShape> {
@ -308,6 +334,7 @@ export declare class EllipseShape extends BaseShape<EllipseShape> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
constructor(options?: ShapeSize);
@ -320,6 +347,7 @@ export declare class EllipseShape extends BaseShape<EllipseShape> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
export declare class PathShape extends CommonShapeMethod<PathShape> {
@ -330,6 +358,7 @@ export declare class PathShape extends CommonShapeMethod<PathShape> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
constructor(options?: PathShapeOptions);
@ -342,6 +371,7 @@ export declare class PathShape extends CommonShapeMethod<PathShape> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
commands(commands: string): PathShape;

View File

@ -27,6 +27,7 @@ import window from './@ohos.window';
*
* @namespace uiExtension
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
declare namespace uiExtension {
@ -35,6 +36,7 @@ declare namespace uiExtension {
*
* @interface WindowProxy
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
interface WindowProxy {
@ -48,6 +50,7 @@ declare namespace uiExtension {
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
getWindowAvoidArea(type: window.AvoidAreaType): window.AvoidArea;
@ -62,6 +65,7 @@ declare namespace uiExtension {
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
on(type: 'avoidAreaChange', callback: Callback<AvoidAreaInfo>): void;
@ -76,6 +80,7 @@ declare namespace uiExtension {
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
off(type: 'avoidAreaChange', callback?: Callback<AvoidAreaInfo>): void;
@ -90,6 +95,7 @@ declare namespace uiExtension {
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
on(type: 'windowSizeChange', callback: Callback<window.Size>): void;
@ -104,6 +110,7 @@ declare namespace uiExtension {
* <br> 2. Incorrect parameters types.
* <br> 3. Parameter verification failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
off(type: 'windowSizeChange', callback?: Callback<window.Size>): void;
@ -138,6 +145,7 @@ declare namespace uiExtension {
* @throws { BusinessError } 1300005 - This window proxy is abnormal.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @StageModelOnly
* @atomicservice
* @since 12
*/
createSubWindowWithOptions(name: string, subWindowOptions: window.SubWindowOptions): Promise<window.Window>;
@ -162,6 +170,7 @@ declare namespace uiExtension {
*
* @interface AvoidAreaInfo
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
interface AvoidAreaInfo {
@ -170,6 +179,7 @@ declare namespace uiExtension {
*
* @type { window.AvoidAreaType }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
type: window.AvoidAreaType;
@ -179,6 +189,7 @@ declare namespace uiExtension {
*
* @type { window.AvoidArea }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
area: window.AvoidArea;

View File

@ -189,6 +189,7 @@ export interface TitleOptions {
* @type { ?BarStyle }
* @default BarStyle.STANDARD
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
barStyle?: BarStyle;

View File

@ -164,6 +164,7 @@ declare namespace display {
* @returns { Promise<Array<DisplayPhysicalResolution>> } the result of all display physical resolution
* @throws { BusinessError } 1400003 - This display manager service works abnormally.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
function getAllDisplayPhysicalResolution(): Promise<Array<DisplayPhysicalResolution>>;
@ -1596,6 +1597,7 @@ declare namespace display {
* @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities.
* @throws { BusinessError } 1400001 - Invalid display or screen.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
getAvailableArea(): Promise<Rect>;
@ -1610,6 +1612,7 @@ declare namespace display {
* @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities.
* @throws { BusinessError } 1400003 - This display manager service works abnormally.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
on(type: 'availableAreaChange', callback: Callback<Rect>): void;
@ -1624,6 +1627,7 @@ declare namespace display {
* @throws { BusinessError } 801 - Capability not supported. Failed to call the API due to limited device capabilities.
* @throws { BusinessError } 1400003 - This display manager service works abnormally.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
off(type: 'availableAreaChange', callback?: Callback<Rect>): void;

View File

@ -3394,6 +3394,7 @@ declare namespace window {
*
* @enum { number }
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
enum MaximizePresentation {
@ -3401,6 +3402,7 @@ declare namespace window {
* The value means follow immersive state which set by app
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
FOLLOW_APP_IMMERSIVE_SETTING = 0,
@ -3408,6 +3410,7 @@ declare namespace window {
* The value means exit immersive state
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
EXIT_IMMERSIVE = 1,
@ -3415,6 +3418,7 @@ declare namespace window {
* The value means enter immersive state
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
ENTER_IMMERSIVE = 2,

View File

@ -27,6 +27,7 @@
* @extends ListItemAttribute
* @implements AttributeModifier
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
export declare class ListItemModifier extends ListItemAttribute implements AttributeModifier<ListItemAttribute> {
@ -37,6 +38,7 @@ export declare class ListItemModifier extends ListItemAttribute implements Attri
* @param { ListItemAttribute } instance
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
applyNormalAttribute?(instance: ListItemAttribute): void;