提交 0ac178f4 编写于 作者: X xu-rui-w

示例参数说明

Signed-off-by: Nxu-rui-w <xurui101@huawei.com>
上级 913e3672
...@@ -101,10 +101,11 @@ readPixelsToBuffer(dst: ArrayBuffer): Promise\<void> ...@@ -101,10 +101,11 @@ readPixelsToBuffer(dst: ArrayBuffer): Promise\<void>
**示例:** **示例:**
```js ```js
pixelmap.readPixelsToBuffer(ReadBuffer).then(() => { const readBuffer = new ArrayBuffer(400);
console.log('readPixelsToBuffer succeeded.'); //符合条件则进入 pixelmap.readPixelsToBuffer(readBuffer).then(() => {
console.log('Succeeded in reading image pixel data.'); //符合条件则进入
}).catch(error => { }).catch(error => {
console.log('readPixelsToBuffer failed.'); //不符合条件则进入 console.log('Failed to read image pixel data.'); //不符合条件则进入
}) })
``` ```
...@@ -126,11 +127,12 @@ readPixelsToBuffer(dst: ArrayBuffer, callback: AsyncCallback\<void>): void ...@@ -126,11 +127,12 @@ readPixelsToBuffer(dst: ArrayBuffer, callback: AsyncCallback\<void>): void
**示例:** **示例:**
```js ```js
pixelmap.readPixelsToBuffer(ReadBuffer, (err, res) => { const readBuffer = new ArrayBuffer(400);
pixelmap.readPixelsToBuffer(readBuffer, (err, res) => {
if(err) { if(err) {
console.log('readPixelsToBuffer failed.'); //不符合条件则进入 console.log('Failed to read image pixel data.'); //不符合条件则进入
} else { } else {
console.log('readPixelsToBuffer succeeded.'); //符合条件则进入 console.log('Succeeded in reading image pixel data.'); //符合条件则进入
} }
}) })
``` ```
...@@ -158,10 +160,11 @@ readPixels(area: PositionArea): Promise\<void> ...@@ -158,10 +160,11 @@ readPixels(area: PositionArea): Promise\<void>
**示例:** **示例:**
```js ```js
pixelmap.readPixels(Area).then((data) => { const area = new ArrayBuffer(400);
console.log('readPixels succeeded.'); //符合条件则进入 pixelmap.readPixels(area).then(() => {
console.log('Succeeded in reading the image data in the area.'); //符合条件则进入
}).catch(error => { }).catch(error => {
console.log('readPixels failed.'); //不符合条件则进入 console.log('Failed to read the image data in the area.'); //不符合条件则进入
}) })
``` ```
...@@ -273,9 +276,10 @@ writePixels(area: PositionArea, callback: AsyncCallback\<void>): void ...@@ -273,9 +276,10 @@ writePixels(area: PositionArea, callback: AsyncCallback\<void>): void
**示例:** **示例:**
```js ```js
pixelmap.writePixels(Area, (error) => { const area = new ArrayBuffer(400);
pixelmap.writePixels(area, (error) => {
if (error!=undefined) { if (error!=undefined) {
console.info('writePixels failed.'); console.info('Failed to write pixelmap into the specified area.');
} else { } else {
const readArea = { const readArea = {
pixels: new ArrayBuffer(20), pixels: new ArrayBuffer(20),
...@@ -311,8 +315,9 @@ writeBufferToPixels(src: ArrayBuffer): Promise\<void> ...@@ -311,8 +315,9 @@ writeBufferToPixels(src: ArrayBuffer): Promise\<void>
```js ```js
const color = new ArrayBuffer(96); const color = new ArrayBuffer(96);
const pixelMap = new ArrayBuffer(400);
let bufferArr = new Unit8Array(color); let bufferArr = new Unit8Array(color);
PixelMap.writeBufferToPixels(color).then(() => { pixelMap.writeBufferToPixels(color).then(() => {
console.log("Succeeded in writing data from a buffer to a PixelMap."); console.log("Succeeded in writing data from a buffer to a PixelMap.");
}).catch((err) => { }).catch((err) => {
console.error("Failed to write data from a buffer to a PixelMap."); console.error("Failed to write data from a buffer to a PixelMap.");
...@@ -337,9 +342,10 @@ writeBufferToPixels(src: ArrayBuffer, callback: AsyncCallback\<void>): void ...@@ -337,9 +342,10 @@ writeBufferToPixels(src: ArrayBuffer, callback: AsyncCallback\<void>): void
**示例:** **示例:**
```js ```js
const color = new ArrayBuffer(96); const color = new ArrayBuffer(96);\
const pixelMap = new ArrayBuffer(400);
let bufferArr = new Unit8Array(color); let bufferArr = new Unit8Array(color);
PixelMap.writeBufferToPixels(color, function(err) { pixelMap.writeBufferToPixels(color, function(err) {
if (err) { if (err) {
console.error("Failed to write data from a buffer to a PixelMap."); console.error("Failed to write data from a buffer to a PixelMap.");
return; return;
...@@ -366,7 +372,8 @@ getImageInfo(): Promise\<ImageInfo> ...@@ -366,7 +372,8 @@ getImageInfo(): Promise\<ImageInfo>
**示例:** **示例:**
```js ```js
PixelMap.getImageInfo().then(function(info) { const pixelMap = new ArrayBuffer(400);
pixelMap.getImageInfo().then(function(info) {
console.log("Succeeded in obtaining the image pixel map information."); console.log("Succeeded in obtaining the image pixel map information.");
}).catch((err) => { }).catch((err) => {
console.error("Failed to obtain the image pixel map information."); console.error("Failed to obtain the image pixel map information.");
...@@ -391,9 +398,7 @@ getImageInfo(callback: AsyncCallback\<ImageInfo>): void ...@@ -391,9 +398,7 @@ getImageInfo(callback: AsyncCallback\<ImageInfo>): void
```js ```js
pixelmap.getImageInfo((imageInfo) => { pixelmap.getImageInfo((imageInfo) => {
console.log("getImageInfo succeeded."); console.log("Succeeded in obtaining the image pixel map information..");
}).catch((err) => {
console.error("getImageInfo failed.");
}) })
``` ```
...@@ -417,7 +422,7 @@ getBytesNumberPerRow(): number ...@@ -417,7 +422,7 @@ getBytesNumberPerRow(): number
const color = new ArrayBuffer(96); const color = new ArrayBuffer(96);
let bufferArr = new Unit8Array(color); let bufferArr = new Unit8Array(color);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } } let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(clolr, opts, (err,pixelmap) => { image.createPixelMap(color, opts, (err,pixelmap) => {
let rowCount = pixelmap.getBytesNumberPerRow(); let rowCount = pixelmap.getBytesNumberPerRow();
}) })
``` ```
...@@ -464,9 +469,9 @@ let bufferArr = new Unit8Array(color); ...@@ -464,9 +469,9 @@ let bufferArr = new Unit8Array(color);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } } let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts, (pixelmap) => { image.createPixelMap(color, opts, (pixelmap) => {
pixelmap.release().then(() => { pixelmap.release().then(() => {
console.log('release succeeded.'); console.log('Succeeded in releasing pixelmap object.');
}).catch(error => { }).catch(error => {
console.log('release failed.'); console.log('Failed to release pixelmap object.');
}) })
}) })
``` ```
...@@ -493,9 +498,9 @@ let bufferArr = new Unit8Array(color); ...@@ -493,9 +498,9 @@ let bufferArr = new Unit8Array(color);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } } let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts, (pixelmap) => { image.createPixelMap(color, opts, (pixelmap) => {
pixelmap.release().then(() => { pixelmap.release().then(() => {
console.log('release succeeded.'); console.log('Succeeded in releasing pixelmap object.');
}).catch(error => { }).catch(error => {
console.log('release failed.'); console.log('Failed to release pixelmap object.');
}) })
}) })
``` ```
...@@ -610,9 +615,7 @@ getImageInfo(callback: AsyncCallback\<ImageInfo>): void ...@@ -610,9 +615,7 @@ getImageInfo(callback: AsyncCallback\<ImageInfo>): void
```js ```js
imageSourceApi.getImageInfo(imageInfo => { imageSourceApi.getImageInfo(imageInfo => {
console.log('getImageInfo succeeded.'); console.log('Succeeded in obtaining the image information.');
}).catch(error => {
console.log('getImageInfo failed.');
}) })
``` ```
...@@ -641,9 +644,9 @@ getImageInfo(index?: number): Promise\<ImageInfo> ...@@ -641,9 +644,9 @@ getImageInfo(index?: number): Promise\<ImageInfo>
```js ```js
imageSourceApi.getImageInfo(0) imageSourceApi.getImageInfo(0)
.then(imageInfo => { .then(imageInfo => {
console.log('getImageInfo succeeded.'); console.log('Succeeded in obtaining the image information.');
}).catch(error => { }).catch(error => {
console.log('getImageInfo failed.'); console.log('Failed to obtain the image information.');
}) })
``` ```
...@@ -673,9 +676,7 @@ getImageProperty(key:string, options?: GetImagePropertyOptions): Promise\<string ...@@ -673,9 +676,7 @@ getImageProperty(key:string, options?: GetImagePropertyOptions): Promise\<string
```js ```js
imageSourceApi.getImageProperty("BitsPerSample") imageSourceApi.getImageProperty("BitsPerSample")
.then(data => { .then(data => {
console.log('getImageProperty succeeded.'); console.log('Succeeded in getting the value of the specified attribute key of the image.');
}).catch(error => {
console.log('getImageProperty failed.');
}) })
``` ```
...@@ -699,9 +700,9 @@ getImageProperty(key:string, callback: AsyncCallback\<string>): void ...@@ -699,9 +700,9 @@ getImageProperty(key:string, callback: AsyncCallback\<string>): void
```js ```js
imageSourceApi.getImageProperty("BitsPerSample",(error,data) => { imageSourceApi.getImageProperty("BitsPerSample",(error,data) => {
if(error) { if(error) {
console.log('getImageProperty failed.'); console.log('Failed to get the value of the specified attribute key of the image.');
} else { } else {
console.log('getImageProperty succeeded.'); console.log('Succeeded in getting the value of the specified attribute key of the image.');
} }
}) })
``` ```
...@@ -725,11 +726,12 @@ getImageProperty(key:string, options: GetImagePropertyOptions, callback: AsyncCa ...@@ -725,11 +726,12 @@ getImageProperty(key:string, options: GetImagePropertyOptions, callback: AsyncCa
**示例:** **示例:**
```js ```js
imageSourceApi.getImageProperty("BitsPerSample",Property,(error,data) => { const property = new ArrayBuffer(400);
imageSourceApi.getImageProperty("BitsPerSample",property,(error,data) => {
if(error) { if(error) {
console.log('getImageProperty failed.'); console.log('Failed to get the value of the specified attribute key of the image.');
} else { } else {
console.log('getImageProperty succeeded.'); console.log('Succeeded in getting the value of the specified attribute key of the image.');
} }
}) })
``` ```
...@@ -758,9 +760,9 @@ createPixelMap(options?: DecodingOptions): Promise\<PixelMap> ...@@ -758,9 +760,9 @@ createPixelMap(options?: DecodingOptions): Promise\<PixelMap>
```js ```js
imageSourceApi.createPixelMap().then(pixelmap => { imageSourceApi.createPixelMap().then(pixelmap => {
console.log('createPixelMap succeeded.'); console.log('Succeeded in creating pixelmap object through image decoding parameters.');
}).catch(error => { }).catch(error => {
console.log('createPixelMap failed.'); console.log('Failed to create pixelmap object through image decoding parameters.');
}) })
``` ```
...@@ -782,9 +784,9 @@ createPixelMap(callback: AsyncCallback\<PixelMap>): void ...@@ -782,9 +784,9 @@ createPixelMap(callback: AsyncCallback\<PixelMap>): void
```js ```js
imageSourceApi.createPixelMap(pixelmap => { imageSourceApi.createPixelMap(pixelmap => {
console.log('createPixelMap succeeded.'); console.log('Succeeded in creating pixelmap object.');
}).catch(error => { }).catch(error => {
console.log('createPixelMap failed.'); console.log('Failed to create pixelmap object.');
}) })
``` ```
...@@ -806,11 +808,10 @@ createPixelMap(options: DecodingOptions, callback: AsyncCallback\<PixelMap>): vo ...@@ -806,11 +808,10 @@ createPixelMap(options: DecodingOptions, callback: AsyncCallback\<PixelMap>): vo
**示例:** **示例:**
```js ```js
const decodingOptions = new ArrayBuffer(400);
imageSourceApi.createPixelMap(decodingOptions, pixelmap => { imageSourceApi.createPixelMap(decodingOptions, pixelmap => {
console.log('createPixelMap succeeded.'); console.log('Succeeded in creating pixelmap object.');
}).catch(error => { })
console.log('createPixelMap failed.');
})
``` ```
### release ### release
...@@ -832,8 +833,6 @@ release(callback: AsyncCallback\<void>): void ...@@ -832,8 +833,6 @@ release(callback: AsyncCallback\<void>): void
```js ```js
imageSourceApi.release(() => { imageSourceApi.release(() => {
console.log('release succeeded.'); console.log('release succeeded.');
}).catch(error => {
console.log('release failed.');
}) })
``` ```
...@@ -855,9 +854,9 @@ release(): Promise\<void> ...@@ -855,9 +854,9 @@ release(): Promise\<void>
```js ```js
imageSourceApi.release().then(()=>{ imageSourceApi.release().then(()=>{
console.log('release succeeded.'); console.log('Succeeded in releasing the image source instance.');
}).catch(error => { }).catch(error => {
console.log('release failed.'); console.log('Failed to release the image source instance.');
}) })
``` ```
...@@ -913,7 +912,8 @@ packing(source: ImageSource, option: PackingOption, callback: AsyncCallback\<Arr ...@@ -913,7 +912,8 @@ packing(source: ImageSource, option: PackingOption, callback: AsyncCallback\<Arr
```js ```js
let packOpts = { format:"image/jpeg", quality:98 }; let packOpts = { format:"image/jpeg", quality:98 };
imagePackerApi.packing(ImageSourceApi, packOpts, data => {}) const imageSourceApi = new ArrayBuffer(400);
imagePackerApi.packing(imageSourceApi, packOpts, data => {})
``` ```
### packing ### packing
...@@ -941,7 +941,8 @@ packing(source: ImageSource, option: PackingOption): Promise\<ArrayBuffer> ...@@ -941,7 +941,8 @@ packing(source: ImageSource, option: PackingOption): Promise\<ArrayBuffer>
```js ```js
let packOpts = { format:"image/jpeg", quality:98 } let packOpts = { format:"image/jpeg", quality:98 }
imagePackerApi.packing(ImageSourceApi, packOpts) const imageSourceApi = new ArrayBuffer(400);
imagePackerApi.packing(imageSourceApi, packOpts)
.then( data => { .then( data => {
console.log('packing succeeded.'); console.log('packing succeeded.');
}).catch(error => { }).catch(error => {
...@@ -969,10 +970,11 @@ packing(source: PixelMap, option: PackingOption, callback: AsyncCallback\<ArrayB ...@@ -969,10 +970,11 @@ packing(source: PixelMap, option: PackingOption, callback: AsyncCallback\<ArrayB
```js ```js
let packOpts = { format:"image/jpeg", quality:98 } let packOpts = { format:"image/jpeg", quality:98 }
imagePackerApi.packing(PixelMapApi, packOpts, data => { const pixelMapApi = new ArrayBuffer(400);
console.log('packing succeeded.'); imagePackerApi.packing(pixelMapApi, packOpts, data => {
console.log('Succeeded in packing the image.');
}).catch(error => { }).catch(error => {
console.log('packing failed.'); console.log('Failed to pack the image.');
}) })
``` ```
...@@ -1001,11 +1003,12 @@ packing(source: PixelMap, option: PackingOption): Promise\<ArrayBuffer> ...@@ -1001,11 +1003,12 @@ packing(source: PixelMap, option: PackingOption): Promise\<ArrayBuffer>
```js ```js
let packOpts = { format:"image/jpeg", quality:98 } let packOpts = { format:"image/jpeg", quality:98 }
imagePackerApi.packing(PixelMapApi, packOpts) const pixelMapApi = new ArrayBuffer(400);
imagePackerApi.packing(pixelMapApi, packOpts)
.then( data => { .then( data => {
console.log('packing succeeded.'); console.log('Succeeded in packing the image.');
}).catch(error => { }).catch(error => {
console.log('packing failed.'); console.log('Failed to pack the image..');
}) })
``` ```
...@@ -1027,9 +1030,7 @@ release(callback: AsyncCallback\<void>): void ...@@ -1027,9 +1030,7 @@ release(callback: AsyncCallback\<void>): void
```js ```js
imagePackerApi.release(()=>{ imagePackerApi.release(()=>{
console.log('release succeeded.'); console.log('Succeeded in releasing image packaging.');
}).catch(error => {
console.log('release failed.');
}) })
``` ```
...@@ -1051,9 +1052,9 @@ release(): Promise\<void> ...@@ -1051,9 +1052,9 @@ release(): Promise\<void>
```js ```js
imagePackerApi.release().then(()=>{ imagePackerApi.release().then(()=>{
console.log('release succeeded.'); console.log('Succeeded in releasing image packaging.');
}).catch((error)=>{ }).catch((error)=>{
console.log('release failed.'); console.log('Failed to release image packaging.');
}) })
``` ```
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册