super-tools-lib

Appearance

On this page

super-tools-lib - v1.74.0 / Modules / file

Module: file ​

Table of contents ​

Functions ​

Functions ​

addTextToImage ​

▸ addTextToImage(url, text, textStyle, cb?): Promise<unknown>

给图片添加文字

Since

1.66.0

Example

ts

import { addTextToImage } from 'super-tools-lib'
addTextToImage('https://www.baidu.com/img/bd_logo1.png', '百度一下你就知道', ({ x, y }) => {
   return { x, y: y + 100 }
}).then(res => {
  console.log(res)
})

Parameters ​

NameTypeDescription
urlany图片地址
textany文字内容
textStyleCanvasRenderingContext2D文字样式，参考https://developer.mozilla.org/zh-CN/docs/Web/API/CanvasRenderingContext2D
cb?(__namedParameters: { x: number ; y: number }) => { x: number ; y: number }回调函数，返回文字的坐标

Returns ​

Promise<unknown>

  • 返回一个Promise对象，resolve后返回一个base64的图片地址

base64ToFile ​

▸ base64ToFile(urlData, fileName): File

base64转文件

Since

1.0.0

Example

ts
import { base64ToFile } from 'super-tools-lib'

base64ToFile('base64', 'name')

Parameters ​

NameTypeDescription
urlDatastringbase64
fileNamestring文件名

Returns ​

File

返回转换后的文件

blobToDataURL ​

▸ blobToDataURL(blob, callback): void

blob转url

Since

1.0.0

Example

ts
import { blobToDataURL } from 'super-tools-lib'

// blobToDataURL('blob', (url) => {})

Parameters ​

NameTypeDescription
blobBlobblob
callback(result: string | ArrayBuffer) => void回调

Returns ​

void

dowDxfFile ​

▸ dowDxfFile(data, fileName): void

下载dxf文件

Since

1.0.0

Example

ts
import { dowDxfFile } from 'super-tools-lib'

// dowDxfFile('data', '1.dxf')

See

dxf文件格式

Parameters ​

NameTypeDescription
dataanydxf文件内容
fileNamestring下载的文件名

Returns ​

void

downBlob ​

▸ downBlob(data, fileName): void

下载二进制文件流

Since

1.0.0

Example

ts
import { downBlob } from 'super-tools-lib'

// downBlob('data', '1.xslx')

Parameters ​

NameTypeDescription
dataBlobPart文件流
fileNamestring下载的文件名

Returns ​

void

drawAndShareImage ​

▸ drawAndShareImage(bgImgOps, upImgOps, ops?): void

两张图片合并成一张图片

Since

1.0.0

Example

ts
import { drawAndShareImage } from 'super-tools-lib'

// drawAndShareImage({url: url1, width: 1000, height: 1000}, {url: url2, width: 200, height: 20}, {download: true, imgName: '1.png'})

Parameters ​

NameTypeDefault valueDescription
bgImgOpsObjectundefined下层图片配置
bgImgOps.heightnumberundefined图片高度
bgImgOps.urlstringundefinedurl
bgImgOps.widthnumberundefined图片宽度
upImgOpsObjectundefined上层图片配置
upImgOps.heightnumberundefined图片高度
upImgOps.urlstringundefinedurl
upImgOps.widthnumberundefined图片宽度
upImgOps.xnumberundefinedx轴偏移量
upImgOps.ynumberundefinedy轴偏移量
opsObjectundefined操作配置
ops.downloadbooleanfalse是否下载 默认false
ops.imgNamestring'1.png'下载的文件名
ops.success(base64: any) => anyundefined生成成功的回调

Returns ​

void

fileDownload ​

▸ fileDownload(url): boolean

根据url地址下载

Since

1.0.0

Example

ts
import { fileDownload } from 'super-tools-lib'

// fileDownload(url)

Parameters ​

NameTypeDescription
urlstringurl地址

Returns ​

boolean

返回true

getFileBase64 ​

▸ getFileBase64(file, cb): void

将文件Base64编码，

Since

1.0.0

Example

ts
import { getFileBase64 } from 'super-tools-lib'

// getFileBase64(file, (base64) => {})

Parameters ​

NameTypeDescription
fileFile文件
cb(base64: string | ArrayBuffer) => void文件转换成功回调

Returns ​

void

loadImages ​

▸ loadImages(urls): Promise<unknown>

预加载图片

Since

1.66.0

Example

ts
import { loadImages } from 'super-tools-lib'

loadImages([
'https://www.baidu.com/img/bd_logo1.png',
'https://www.baidu.com/img/bd_logo2.png',
'https://www.baidu.com/img/bd_logo3.png',
'https://www.baidu.com/img/bd_logo4.png',
'https://www.baidu.com/img/bd_logo5.png',
'https://www.baidu.com/img/bd_logo6.png',
]).then((imgs) => {
  console.log(imgs)
})

Parameters ​

NameTypeDescription
urlsstring[]图片地址数组

Returns ​

Promise<unknown>

  • 返回一个Promise对象

watermark ​

▸ watermark(img, text, options?): string

图片增加水印

Since

1.63.0

Example

ts
import { watermark } from 'super-tools-lib'

watermark('imgUrl', '水印文字', {
 fontSize: 20,
 color: '#000',
 alpha: 0.5,
 x: 0,
 y: 0,
}).then(res=>{

})

Parameters ​

NameTypeDescription
imgHTMLImageElement图片
textstring水印文字
optionsany水印配置

Returns ​

string

返回添加水印后的图