HTML 5+仕様:Zip(管理ファイル圧縮と解凍)
8946 ワード
Zipモジュールはファイルの圧縮と解凍を管理し、plusを通過する.zipは圧縮管理オブジェクトを取得します.
1、方法
1.1.compress:圧縮生成Zipファイル
void plus.zip.compress(src, zipfile, successCB, errorCB);
パラメータ:
src:(String)圧縮するソースファイルパス、ファイルパスまたはディレクトリをサポートするオプション
zipfile:(String)圧縮後に保存するZipファイルパスを選択可能
successCB:(ZipSuccessCallback)必ず圧縮Zipファイル操作成功コールバックを選択し、圧縮操作成功時に呼び出す
errorCB:(ZipErrorCallback)必ず圧縮Zipファイル操作失敗コールバックを選択し、圧縮操作失敗時に呼び出す
戻り値:void:なし
例:
1.1、decompress:Zipファイルを解凍する
void plus.zip.decompress( zipfile, target, successCB, errorCB);
パラメータ:
zipfile:(String)オプションでZipファイルパスを解凍する必要があります
target:(String)オプションでZipファイルのターゲットパスを解凍します.パスでなければなりません.
successCB:(ZipSuccessCallback)Zipファイルの解凍操作が正常にコールバックされ、解凍操作が成功したときに呼び出されます.
ErrorCB:(ZipErrorCallback)必ずZipファイルの解凍操作に失敗したコールバックを選択し、解凍操作に失敗したときに呼び出す.
戻り値:void:なし
例:
1.1.compressImage:画像圧縮変換
void plus.zip.compressImage( options, successCB, errorCB);
説明:画像の品質圧縮、サイズスケール、方向回転、領域トリミング、フォーマット変換などに使用できます.
パラメータ:
options:(CompressImageOptions)必須ピクチャ圧縮変換のパラメータ
successCB:(C o m p r e ssImageSuccessCallback)オプションのピクチャ圧縮変換操作が正常にコールバックされ、操作が成功した場合に呼び出されます.
ErrorCB:(ZipErrorCallback)オプションピクチャ圧縮変換操作失敗コールバック、操作失敗時呼び出し.
戻り値:void:なし
例:
2、対象
2.1、CompressImageOptions:JSONオブジェクト、画像圧縮変換のパラメータを配置する
説明:width/heightプロパティを設定すると、ピクチャのスケール変換操作が必要であることを示します.rotateプロパティを設定すると、画像を回転変換する必要があることを示します.clipプロパティを設定すると、ピクチャをトリミング変換する必要があることを示します.複数の変換操作が同時に設定されている場合は、ズーム、回転、切り取りの順に操作します.
属性:
(1)、src:(Stringタイプ)元のピクチャを圧縮変換するパス.以下の画像パスをサポートします:相対パス-現在のページに対するhost位置、例えば“a.jpg”、現在のページがネットワークアドレスであることに注意してサポートしません;絶対パス-Androidプラットフォーム"/storage/sdcard 0/Android/data/io.dcloud.Hbuilder/.Hbuilder/apps/Hbuilder/www/a.jpg"、iOSプラットフォーム"/var/mobile/Containers/Dataa/Application/757966 CF-3448-B 07 F-EEF 83 CF 9 A 369/Library/Panora/apps/Hbuill/www/a.png";相対パスURL(RelativeURL)-「_www/a.jpg」、「_doc/b.jpg」、「_documents/c.jpg」、「_downloads/d.jpg」などの先頭の相対パス.ローカルパスURL-「file://」で始まり、システムの絶対パスに従います.プラットフォームはAndroid-2.2+(サポート):jpg/jpeg、pngなどのフォーマット画像をサポートします.iOS-5.0+(サポート):jpg/jpeg、png、tif/tiff、gif、bmp、ico、cur、xbmなどのフォーマット画像をサポートします.
(2)、dst:(Stringタイプ)変換先ピクチャのパスを圧縮する.Androidプラットフォーム「/storage/sdcard 0/Android/data/io.dcloud.Hbuilder/.Hbuilder/apps/Hbuilder/doc/a.jpg」、iOSプラットフォーム「/var/mobile/containers/data/Application/757966 CF-345 C-4348-B 07 F-EEF 83 CF 9 A 369/Library/Panora/apps/Hbuiler/doc/a.png」などの絶対パスをサポートします.相対パスURL(RelativeURL)-「_doc/b.jpg」、「_documents/c.jpg」、「_downloads/d.jpg」などの先頭の相対パスは、「_www」の先頭のパスがサポートされていないことに注意してください.ローカルパスURL-「file://」で始まり、システムの絶対パスに従います.注:設定したパスにアクセス権がない場合は、失敗を返します.
(3)、overwrite:(Booleanタイプ)上書き生成新規ファイル.dstが作成したパスファイルが存在する場合にのみ有効:trueは存在するファイルを上書きすることを示す;falseは上書きしないことを示し、ファイルが存在する場合は失敗を返します.デフォルトはfalseです.
(4)、format:(Stringタイプ)圧縮変換後のピクチャフォーマット.「jpg」、「png」をサポートし、指定されていない場合はソースピクチャのフォーマットを使用します.
(5)、quality:(Numberタイプ)圧縮ピクチャの品質.値範囲は1-100で、1は使用最低のピクチャ品質(変換後のピクチャファイルが最小)を表し、100は使用最高のピクチャ品質(変換後のピクチャファイルが最大)を表す.既定値は50です.
(6)、width:(Stringタイプ)ピクチャの幅をスケールします.「100 px」などのピクセル値、「50%」などのパーセント、「auto」などの自動計算をサポートします.すなわち、heightとソースマップの高さのスケールに基づいて計算し、heightを設定しない場合はソースマップの高さを使用します.デフォルトはautoです.注意:widthプロパティ値が不正な場合(0 pxなど)、画像のスケール操作は行われません.
(7)、height:(Stringタイプ)画像の高さをスケールします.「100 px」などのピクセル値、「50%」などのパーセント、「auto」などの自動計算をサポートします.すなわち、widthとソースマップ幅のスケールに基づいて計算し、widthを設定しない場合はソースマップの高さを使用します.デフォルトはautoです.注意:heightプロパティ値が不正な場合(0 pxなど)、画像のスケール操作は行われません.
(8)、rotate:(Numberタイプ)画像を回転させる角度.サポート値:90-90度回転を示します.180-180度回転を表します.270-270度の回転を示します.注意:rotateプロパティ値を設定するのが合法でない場合は、画像を回転させません.
(9)、clip:(ClipImageOptionsタイプ)画像の領域を切り取る.値はClipImageOptions定義を参照し、clip属性値を設定するのが適切でない場合は、画像を切り取る操作は行いません.
2.2、ClipImageOptions:JSONオブジェクト、ピクチャトリミング領域のパラメータ
属性:
(1)、top:(Stringタイプ)ピクチャトリミング領域と元のピクチャ上の境界とのオフセット距離.「10 px」などのピクセル値、パーセンテージ(10%」など)をサポートします.デフォルトは「0 px」です.注意:top値が元のピクチャの高さを超えた場合、ピクチャの切り取りに失敗します.
(2)、left:(Stirngタイプ)ピクチャトリミング領域と元のピクチャの左境界とのオフセット距離.「10 px」などのピクセル値、パーセンテージ(10%」など)をサポートします.デフォルトは「0 px」です.注意:lef値が元のピクチャ幅を超えた場合、ピクチャの切り取りに失敗します.
(3)、width:(Stringタイプ)ピクチャトリミング領域の幅.「100 px」などのピクセル値、「50%」などのパーセント、「auto」などの自動計算、すなわちleft位置からピクチャの右境界までの幅をサポートします.デフォルトはautoです.注意:left値とwidth値が元のピクチャ幅を超えている場合は、「auto」値を使用して切り取ります.
(4)、height:(Stringタイプ)ピクチャトリミング領域の高さ.「100 px」などのピクセル値、「50%」などのパーセント、「auto」などの自動計算、すなわちtop位置から画像の下の境界までの高さをサポートします.デフォルトはautoです.注意:top値とheight値が元のピクチャの高さを超えている場合は、「auto」値を使用して切り取ります.
3、コールバック方法
3.1、C o m p r e ssImageSuccessCallback:画像圧縮変換操作成功コールバックインタフェース
void onSuccess( Event event ){
//Code here
var target = event.target;//変換後の画像urlパスを圧縮し、「file://」で始まる
var size = event.size;//圧縮変換後のピクチャのサイズ、単位はバイト(Byte)
var width = event.width;//圧縮変換後の画像の実際の幅、単位はpxです
var height = event.height;//圧縮変換後の画像の実際の高さ、単位はpxです
}
パラメータ:
event:(Event)オプションピクチャ圧縮変換後のピクチャ情報.通過できるtarget(Stringタイプ)は、圧縮変換後の画像urlパスを取得し、「file://」で始まり、Androidプラットフォームなどのhtmlページでsrc属性で直接参照できます.file:///storage/sdcard0/Android/data/io.dcloud.HBuilder/.HBuilder/apps/HBuilder/doc/ａ.jpg",iOSプラットフォーム"file:///var/mobile/Containers/Data/Application/757966CF-345C-4348-B07F-EEF83CF9A369/Library/Pandora/apps/HBuilder/doc/a.png「;event.size(Numberタイプ)で圧縮変換後のピクチャのサイズをバイト単位で取得でき、event.width(Numberタイプ)で圧縮変換後のピクチャの実際の幅をpx単位で取得でき、event.height(Numberタイプ)で圧縮変換後のピクチャの実際の高さをpx単位で取得できます.
戻り値:void:なし
3.2、ZipSuccessCallback:操作成功コールバック関数インタフェース、Zipファイルを解凍またはZipファイルに圧縮成功時に呼び出す
void onSuccess(){
//Code here
}
戻り値:void:なし
3.3、ZipErrorCallback:エラーコールバック関数インタフェースを操作し、Zipファイルの解凍またはZipファイルの圧縮に失敗した場合に呼び出す
void onError(error){
//Handle the error
var code = error.code;//エラーエンコーディング
var message = error.message;//エラー記述情報
}
パラメータ:error:(Exception)オプションZip操作のエラーメッセージ.error.code(Numberタイプ)エラー符号化を取得する;error.Message(Stringタイプ)エラー記述情報を取得します.
戻り値:void:なし
1、方法
1.1.compress:圧縮生成Zipファイル
void plus.zip.compress(src, zipfile, successCB, errorCB);
パラメータ:
src:(String)圧縮するソースファイルパス、ファイルパスまたはディレクトリをサポートするオプション
zipfile:(String)圧縮後に保存するZipファイルパスを選択可能
successCB:(ZipSuccessCallback)必ず圧縮Zipファイル操作成功コールバックを選択し、圧縮操作成功時に呼び出す
errorCB:(ZipErrorCallback)必ず圧縮Zipファイル操作失敗コールバックを選択し、圧縮操作失敗時に呼び出す
戻り値:void:なし
例:
<!DOCTYPE HTML>
<html>
<head>
<meta charset="UTF-8" />
<script type="text/javascript">
//
function zipCompress(){
var zipfile = "_doc/text11.zip";
var targetPath = '_doc/dir/';
plus.zip.compress(targetPath,zipfile,
function() {
alert("Compress success!");
},function(error) {
alert("Compress error!");
});
}
</script>
</head>
<body >
<input type='button' onclick='zipCompress()' value='zip ' />
</body>
</html>1.1、decompress:Zipファイルを解凍する
void plus.zip.decompress( zipfile, target, successCB, errorCB);
パラメータ:
zipfile:(String)オプションでZipファイルパスを解凍する必要があります
target:(String)オプションでZipファイルのターゲットパスを解凍します.パスでなければなりません.
successCB:(ZipSuccessCallback)Zipファイルの解凍操作が正常にコールバックされ、解凍操作が成功したときに呼び出されます.
ErrorCB:(ZipErrorCallback)必ずZipファイルの解凍操作に失敗したコールバックを選択し、解凍操作に失敗したときに呼び出す.
戻り値:void:なし
例:
<!DOCTYPE HTML>
<html>
<head>
<meta charset="UTF-8" />
<script type="text/javascript">
//
function zipDecompress() {
var zipfile = "_doc/text.zip";
var targetPath = '_doc/dir/';
plus.zip.decompress(zipfile, targetPath,
function() {
alert("Decompress success!");
},function(error) {
alert("Compress error!");
});
}
</script>
</head>
<body >
<input type='button' onclick='zipDecompress()' value='zip ' />
</body>
</html>1.1.compressImage:画像圧縮変換
void plus.zip.compressImage( options, successCB, errorCB);
説明:画像の品質圧縮、サイズスケール、方向回転、領域トリミング、フォーマット変換などに使用できます.
パラメータ:
options:(CompressImageOptions)必須ピクチャ圧縮変換のパラメータ
successCB:(C o m p r e ssImageSuccessCallback)オプションのピクチャ圧縮変換操作が正常にコールバックされ、操作が成功した場合に呼び出されます.
ErrorCB:(ZipErrorCallback)オプションピクチャ圧縮変換操作失敗コールバック、操作失敗時呼び出し.
戻り値:void:なし
例:
<!DOCTYPE HTML>
<html>
<head>
<meta charset="UTF-8" />
<script type="text/javascript">
//
function compressImage(){
plus.zip.compressImage({
src:"_www/a.jpg",
dst:"_doc/a.jpg",
quality:20
},
function() {
alert("Compress success!");
},function(error) {
alert("Compress error!");
});
}
//
function zoomImage(){
plus.zip.compressImage({
src:"_www/a.jpg",
dst:"_doc/a.jpg",
width:"50%" //
},
function() {
alert("Compress success!");
},function(error) {
alert("Compress error!");
});
}
//
function rotateImage(){
plus.zip.compressImage({
src:"_www/a.jpg",
dst:"_doc/a.jpg",
rotate:90 // 90
},
function() {
alert("Compress success!");
},function(error) {
alert("Compress error!");
});
}
//
function clipImage(){
plus.zip.compressImage({
src:"_www/a.jpg",
dst:"_doc/a.jpg",
clip:{top:"25%",left:"25%",width:"50%",height:"50%"} //
},
function() {
alert("Compress success!");
},function(error) {
alert("Compress error!");
});
}
//
function convertImage(){
plus.zip.compressImage({
src:"_www/a.jpg",
dst:"_doc/a.png",
format:"png" // jpg png
},
function() {
alert("Compress success!");
},function(error) {
alert("Compress error!");
});
}
</script>
</head>
<body >
<button onclick="compressImage()"> </button><br/>
<button onclick="zoomImage()"> </button><br/>
<button onclick="rotateImage()"> </button><br/>
<button onclick="clipImage()"> </button><br/>
<button onclick="convertImage()"> </button><br/>
</body>
</html>2、対象
2.1、CompressImageOptions:JSONオブジェクト、画像圧縮変換のパラメータを配置する
説明:width/heightプロパティを設定すると、ピクチャのスケール変換操作が必要であることを示します.rotateプロパティを設定すると、画像を回転変換する必要があることを示します.clipプロパティを設定すると、ピクチャをトリミング変換する必要があることを示します.複数の変換操作が同時に設定されている場合は、ズーム、回転、切り取りの順に操作します.
属性:
(1)、src:(Stringタイプ)元のピクチャを圧縮変換するパス.以下の画像パスをサポートします:相対パス-現在のページに対するhost位置、例えば“a.jpg”、現在のページがネットワークアドレスであることに注意してサポートしません;絶対パス-Androidプラットフォーム"/storage/sdcard 0/Android/data/io.dcloud.Hbuilder/.Hbuilder/apps/Hbuilder/www/a.jpg"、iOSプラットフォーム"/var/mobile/Containers/Dataa/Application/757966 CF-3448-B 07 F-EEF 83 CF 9 A 369/Library/Panora/apps/Hbuill/www/a.png";相対パスURL(RelativeURL)-「_www/a.jpg」、「_doc/b.jpg」、「_documents/c.jpg」、「_downloads/d.jpg」などの先頭の相対パス.ローカルパスURL-「file://」で始まり、システムの絶対パスに従います.プラットフォームはAndroid-2.2+(サポート):jpg/jpeg、pngなどのフォーマット画像をサポートします.iOS-5.0+(サポート):jpg/jpeg、png、tif/tiff、gif、bmp、ico、cur、xbmなどのフォーマット画像をサポートします.
(2)、dst:(Stringタイプ)変換先ピクチャのパスを圧縮する.Androidプラットフォーム「/storage/sdcard 0/Android/data/io.dcloud.Hbuilder/.Hbuilder/apps/Hbuilder/doc/a.jpg」、iOSプラットフォーム「/var/mobile/containers/data/Application/757966 CF-345 C-4348-B 07 F-EEF 83 CF 9 A 369/Library/Panora/apps/Hbuiler/doc/a.png」などの絶対パスをサポートします.相対パスURL(RelativeURL)-「_doc/b.jpg」、「_documents/c.jpg」、「_downloads/d.jpg」などの先頭の相対パスは、「_www」の先頭のパスがサポートされていないことに注意してください.ローカルパスURL-「file://」で始まり、システムの絶対パスに従います.注:設定したパスにアクセス権がない場合は、失敗を返します.
(3)、overwrite:(Booleanタイプ)上書き生成新規ファイル.dstが作成したパスファイルが存在する場合にのみ有効:trueは存在するファイルを上書きすることを示す;falseは上書きしないことを示し、ファイルが存在する場合は失敗を返します.デフォルトはfalseです.
(4)、format:(Stringタイプ)圧縮変換後のピクチャフォーマット.「jpg」、「png」をサポートし、指定されていない場合はソースピクチャのフォーマットを使用します.
(5)、quality:(Numberタイプ)圧縮ピクチャの品質.値範囲は1-100で、1は使用最低のピクチャ品質(変換後のピクチャファイルが最小)を表し、100は使用最高のピクチャ品質(変換後のピクチャファイルが最大)を表す.既定値は50です.
(6)、width:(Stringタイプ)ピクチャの幅をスケールします.「100 px」などのピクセル値、「50%」などのパーセント、「auto」などの自動計算をサポートします.すなわち、heightとソースマップの高さのスケールに基づいて計算し、heightを設定しない場合はソースマップの高さを使用します.デフォルトはautoです.注意:widthプロパティ値が不正な場合(0 pxなど)、画像のスケール操作は行われません.
(7)、height:(Stringタイプ)画像の高さをスケールします.「100 px」などのピクセル値、「50%」などのパーセント、「auto」などの自動計算をサポートします.すなわち、widthとソースマップ幅のスケールに基づいて計算し、widthを設定しない場合はソースマップの高さを使用します.デフォルトはautoです.注意:heightプロパティ値が不正な場合(0 pxなど)、画像のスケール操作は行われません.
(8)、rotate:(Numberタイプ)画像を回転させる角度.サポート値:90-90度回転を示します.180-180度回転を表します.270-270度の回転を示します.注意:rotateプロパティ値を設定するのが合法でない場合は、画像を回転させません.
(9)、clip:(ClipImageOptionsタイプ)画像の領域を切り取る.値はClipImageOptions定義を参照し、clip属性値を設定するのが適切でない場合は、画像を切り取る操作は行いません.
2.2、ClipImageOptions:JSONオブジェクト、ピクチャトリミング領域のパラメータ
属性:
(1)、top:(Stringタイプ)ピクチャトリミング領域と元のピクチャ上の境界とのオフセット距離.「10 px」などのピクセル値、パーセンテージ(10%」など)をサポートします.デフォルトは「0 px」です.注意:top値が元のピクチャの高さを超えた場合、ピクチャの切り取りに失敗します.
(2)、left:(Stirngタイプ)ピクチャトリミング領域と元のピクチャの左境界とのオフセット距離.「10 px」などのピクセル値、パーセンテージ(10%」など)をサポートします.デフォルトは「0 px」です.注意:lef値が元のピクチャ幅を超えた場合、ピクチャの切り取りに失敗します.
(3)、width:(Stringタイプ)ピクチャトリミング領域の幅.「100 px」などのピクセル値、「50%」などのパーセント、「auto」などの自動計算、すなわちleft位置からピクチャの右境界までの幅をサポートします.デフォルトはautoです.注意:left値とwidth値が元のピクチャ幅を超えている場合は、「auto」値を使用して切り取ります.
(4)、height:(Stringタイプ)ピクチャトリミング領域の高さ.「100 px」などのピクセル値、「50%」などのパーセント、「auto」などの自動計算、すなわちtop位置から画像の下の境界までの高さをサポートします.デフォルトはautoです.注意:top値とheight値が元のピクチャの高さを超えている場合は、「auto」値を使用して切り取ります.
3、コールバック方法
3.1、C o m p r e ssImageSuccessCallback:画像圧縮変換操作成功コールバックインタフェース
void onSuccess( Event event ){
//Code here
var target = event.target;//変換後の画像urlパスを圧縮し、「file://」で始まる
var size = event.size;//圧縮変換後のピクチャのサイズ、単位はバイト(Byte)
var width = event.width;//圧縮変換後の画像の実際の幅、単位はpxです
var height = event.height;//圧縮変換後の画像の実際の高さ、単位はpxです
}
パラメータ:
event:(Event)オプションピクチャ圧縮変換後のピクチャ情報.通過できるtarget(Stringタイプ)は、圧縮変換後の画像urlパスを取得し、「file://」で始まり、Androidプラットフォームなどのhtmlページでsrc属性で直接参照できます.file:///storage/sdcard0/Android/data/io.dcloud.HBuilder/.HBuilder/apps/HBuilder/doc/ａ.jpg",iOSプラットフォーム"file:///var/mobile/Containers/Data/Application/757966CF-345C-4348-B07F-EEF83CF9A369/Library/Pandora/apps/HBuilder/doc/a.png「;event.size(Numberタイプ)で圧縮変換後のピクチャのサイズをバイト単位で取得でき、event.width(Numberタイプ)で圧縮変換後のピクチャの実際の幅をpx単位で取得でき、event.height(Numberタイプ)で圧縮変換後のピクチャの実際の高さをpx単位で取得できます.
戻り値:void:なし
3.2、ZipSuccessCallback:操作成功コールバック関数インタフェース、Zipファイルを解凍またはZipファイルに圧縮成功時に呼び出す
void onSuccess(){
//Code here
}
戻り値:void:なし
3.3、ZipErrorCallback:エラーコールバック関数インタフェースを操作し、Zipファイルの解凍またはZipファイルの圧縮に失敗した場合に呼び出す
void onError(error){
//Handle the error
var code = error.code;//エラーエンコーディング
var message = error.message;//エラー記述情報
}
パラメータ:error:(Exception)オプションZip操作のエラーメッセージ.error.code(Numberタイプ)エラー符号化を取得する;error.Message(Stringタイプ)エラー記述情報を取得します.
戻り値:void:なし