mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-10-07 14:13:45 +00:00
99 lines
3.7 KiB
TypeScript
99 lines
3.7 KiB
TypeScript
/*
|
|
* Copyright (c) 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
|
|
*/
|
|
|
|
import { AsyncCallback } from './@ohos.base';
|
|
import image from './@ohos.multimedia.image'
|
|
|
|
/**
|
|
* This module allows developers to export snapshot image from a component or a custom builder.
|
|
*
|
|
* @namespace componentSnapshot
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
declare namespace componentSnapshot {
|
|
/**
|
|
* Take a snapshot of the target component.
|
|
*
|
|
* @param { string } id - Target component ID, set by developer through .id attribute.
|
|
* @param { AsyncCallback<image.PixelMap> } callback - Callback that contains the snapshot in PixelMap format.
|
|
* @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 id is not valid.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
function get(id: string, callback: AsyncCallback<image.PixelMap>): void;
|
|
|
|
/**
|
|
* Take a snapshot of the target component.
|
|
*
|
|
* @param { string } id - Target component ID, set by developer through .id attribute.
|
|
* @returns { Promise<image.PixelMap> } A Promise with the snapshot in PixelMap format.
|
|
* @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 id is not valid.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
function get(id: string): Promise<image.PixelMap>;
|
|
|
|
/**
|
|
* Generate a snapshot from a custom component builder.
|
|
*
|
|
* @param { CustomBuilder } builder - Builder function of a custom component.
|
|
* @param { AsyncCallback<image.PixelMap> } callback - Callback that contains the snapshot in PixelMap format.
|
|
* @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 builder is not a valid build function.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
function createFromBuilder(builder: CustomBuilder, callback: AsyncCallback<image.PixelMap>): void;
|
|
|
|
/**
|
|
* Generate a snapshot from a custom component builder.
|
|
*
|
|
* @param { CustomBuilder } builder - Builder function of a custom component.
|
|
* @returns { Promise<image.PixelMap> } A Promise with the snapshot in PixelMap format.
|
|
* @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 builder is not a valid build function.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
function createFromBuilder(builder: CustomBuilder): Promise<image.PixelMap>;
|
|
}
|
|
|
|
export default componentSnapshot;
|