Other

Methods

(static) ajax(url, optionsopt) → {Promise.<object>}

Description:

• 请求

  注意：该方法仅适用于浏览器端。

Source:

• ajax.js, line 44

Since:

• 4.16.0

See:

• XMLHttpRequest

Example

ajax('/somefile').then(res=>{
  // do something
});

ajax('/api', { method: 'post' }).then(res=>{
  // do something
});

Parameters:

Returns:

Type

Promise.<object>

(static) calculateCursorPosition(prevPos, prevCtrlValue, rawValue, ctrlValue, optionsopt) → {number}

Description:

• 计算输入框的值格式化后光标位置

Source:

• calculateCursorPosition.js, line 20

Since:

• 4.6.0

See:

• h5示例
• react示例

Parameters:

Returns:

Type

number

(static) compressImage(img, optionsopt) → {Promise.<(Blob|string)>}

Description:

• 压缩图片。

  注意：该方法仅适用于浏览器端。

  如果是半透明图片并且导出 image/png 格式，建议将背景变成透明 background=transparent，避免出现白边。注意正常图片压缩导出 image/png 格式后文件可能会比原图大。

Source:

• compressImage.js, line 78

Since:

• 4.20.0

See:

• 在线示例

Example

// 默认返回压缩后的 blob 对象
compressImage(file).then(blob=>{
   // do something
});

// 设置返回格式 data url
compressImage(file, { format: 'dataURL' }).then(url=>{
   // do something
});

// 自定义配置
compressImage('https://dummyimage.com/200x300', {
 width: 100,
 height: 100,
 quality: 0.5,
 beforeCompress({ image, blob }){},
 beforeDraw({ image, blob, canvas, context }){}
 afterDraw({ image, blob, canvas, context }){}
}).then(blob=>{
  // do something
});

// 支持不同形式的图片文件
compressImage('data:image/png;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=').then(blob=>{
  // do something
});

Parameters:

Returns:

Type

Promise.<(Blob|string)>

(static) download(data, optionsopt) → {Promise.<void>}

Description:

• 下载

  注意：该方法仅适用于浏览器端，兼容 IE10+ 和现代浏览器。

  注意：微信浏览器不支持H5下载文件。

Source:

• download.js, line 80

Since:

• 4.16.0

See:

• Access-Control-Expose-Headers
• MIME
• 在线示例

Example

// 文本
download('hello world', 'text.txt');

// 远程文件1
// 不带协议的绝对地址，需要通过 dataType 指定为 url 类型
download('/xxx.jpg', { dataType: 'url', fileName: 'test.jpg' });

// 远程文件2
download('https://example.com/xxx.jpg');

// base64
download('data:image/png;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=', 'test.png');

// blob文件
download(new Blob(['hello world']), 'text.txt');

// 本地文件
download(File, 'filename.ext');

Parameters:

Returns:

Type

Promise.<void>

(static) getFileBlob(file, ajaxOptionsopt) → {Promise.<Blob>}

Description:

• 获取文件 Blob 。

Source:

• getFileBlob.js, line 24

Since:

• 4.21.0

Example

getFileBlob(file).then((blob)=>{
   // do something
});

getFileBlob('https://dummyimage.com/200x300').then((blob)=>{
  // do something
});

Parameters:

Returns:

Type

Promise.<Blob>

(static) getImageInfo(img, cacheOptionsopt, ajaxOptionsopt) → {Promise.<ImageInfo>}

Description:

• 获取图片信息。

  注意：该方法仅适用于浏览器端。

Source:

• getImageInfo.js, line 69

Since:

• 4.20.0

Example

getImageInfo(file).then(imageInfo=>{
   // do something
});

getImageInfo('https://dummyimage.com/200x300').then(imageInfo=>{
  // do something
});

getImageInfo('data:image/png;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=').then(imageInfo=>{
  // do something
});

Parameters:

Returns:

Type

Promise.<ImageInfo>

(static) loadImage(img, cacheOptionsopt) → {Promise.<HTMLImageElement>}

Description:

• 加载图片。

  注意：该方法仅适用于浏览器端。

Source:

• loadImage.js, line 46

Since:

• 4.20.0

Example

loadImage(file).then(image=>{
   // do something
});

loadImage('https://dummyimage.com/200x300').then(image=>{
  // do something
});

loadImage('data:image/png;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=').then(image=>{
  // do something
});

Parameters:

Returns:

Type

Promise.<HTMLImageElement>

(static) loadImageWithBlob(img, cacheOptionsopt, ajaxOptionsopt) → {Promise.<ImageWithBlob>}

Description:

• 加载图片，返回图片元素和 blob 对象。

  注意：该方法仅适用于浏览器端。

Source:

• loadImageWithBlob.js, line 47

Since:

• 4.20.0

Example

loadImage(file).then(({image, blob})=>{
   // do something
});

loadImage('https://dummyimage.com/200x300').then(({image, blob})=>{
  // do something
});

loadImage('data:image/png;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=').then(({image, blob})=>{
  // do something
});

Parameters:

Returns:

Type

Promise.<ImageWithBlob>

(static) loadScript(src, optionsopt) → {Promise.<HTMLScriptElement>}

Description:

• 加载 js 文件。

  注意：该方法仅适用于浏览器端。

Source:

• loadScript.js, line 29

Since:

• 4.19.0

Example

loadScript('some.js').then(script=>{
  // do something
})

loadScript('some.js', { id: 'xxx', async: false, attrs: { foo: 'bar' } }).then(script=>{
  // do something
})

Parameters:

Returns:

Type

Promise.<HTMLScriptElement>

(static) randomString(lenopt, optionalCharsopt) → {string}

Description:

• 生成随机字符串

Source:

• randomString.js, line 39

Since:

• 4.8.0

Example

randomString(5); // slk23
randomString(8); // 71mHqo2A

// 自定义允许的字符
randomString(5, 'abc'); // ccbcb
randomString(8, 'abcefg'); // bcgcfabg

Parameters:

Returns:

Type

string

(static) strlen(str) → {number}

Description:

• 获取字符长度。中文汉字占2个字符，英文占1个字符，特殊如emoji占4个字符。

Source:

• strlen.js, line 20

Since:

• 4.10.0

Example

strlen('你好a'); // 5
strlen('你好，世界！'); // 12
strlen('严両丞丽'); // 8
strlen('abcde'); // 5
strlen('𠮷'); // 4
strlen('🍎'); // 4

Parameters:

Returns:

Type

number