@ohos.application.formBindingData (formBindingData)
The FormBindingData module provides APIs for widget data binding. You can use the APIs to create a FormBindingData object and obtain related information.
NOTE
The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version. This module is deprecated since API version 9. You are advised to use FormBindingData instead.
Modules to Import
import formBindingData from '@ohos.application.formBindingData';
FormBindingData
Describes a FormBindingData object.
System capability: SystemCapability.Ability.Form
Name | Type | Mandatory | Description |
---|---|---|---|
data | Object | Yes | Data to be displayed on the JS widget. The value can be an object containing multiple key-value pairs or a string in JSON format. |
createFormBindingData
createFormBindingData(obj?: Object | string): FormBindingData
Creates a FormBindingData object.
System capability: SystemCapability.Ability.Form
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
obj | Object|string | No | Data to be displayed on the JS widget. The value can be an object containing multiple key-value pairs or a string in JSON format. The image data is identified by 'formImages', and the content is multiple key-value pairs, each of which consists of an image identifier and image file descriptor. The final format is {'formImages': {'key1': fd1, 'key2': fd2}}. |
Return value
Type | Description |
---|---|
FormBindingData | FormBindingData object created based on the passed data. |
Example
import formBindingData from '@ohos.application.formBindingData';
import fs from '@ohos.file.fs';
import Base from '@ohos.base';
try {
let fd = fs.openSync('/path/to/form.png');
let formImagesParam: Record<string, object> = {
'image': fd
};
let createFormBindingDataParam: Record<string, string | Object> = {
'name': '21°',
'formImages': formImagesParam
};
formBindingData.createFormBindingData(createFormBindingDataParam);
} catch (error) {
console.error(`catch error, error: ${JSON.stringify(error as Base.BusinessError)}`);
}