# Interface: ToTempFilePathParams ‹Err

ToTempFilePathParamsErr›()

# Type parameters:

Err: MogsRes

# Type parameters

Err: MogsRes

# Properties

# Optional destHeight

destHeight? : number

目标文件的高度,会将截取的部分拉伸或压缩至该数值

default canvas 的高度

Returns: number


# Optional destWidth

destWidth? : number

目标文件的宽度,会将截取的部分拉伸或压缩至该数值

default canvas 的宽度

Returns: number


# Optional fileType

fileType? : "png" | "jpg"

目标文件的类型

default 'png'

Returns: "png" | "jpg"


# Optional height

height? : number

截取 canvas 的高度

default canvas 的高度

Returns: number


# Optional quality

quality? : number

jpg图片的质量,仅当 fileType 为 jpg 时有效。 取值范围为 0.0(最低)- 1.0(最高),不含 0。 不在范围内时当作 1.0

default 1

Returns: number


# Optional width

width? : number

截取 canvas 的宽度

default canvas 的宽度

Returns: number


# Optional x

x? : number

截取 canvas 的左上角横坐标

default 0

Returns: number


# Optional y

y? : number

截取 canvas 的左上角纵坐标

default 0

Returns: number

# Methods

# Optional complete

complete(res: ToTempFilePathRes | Err): void

Inherited from MogsParams.complete

接口调用结束的回调函数(调用成功、失败都会执行)

# 参数:

属性 类型
res ToTempFilePathRes | Err

# 返回值:

void


# Optional fail

fail(err: Err): void

Inherited from MogsParams.fail

接口调用失败的回调函数

# 参数:

属性 类型
err Err

# 返回值:

void


# Optional success

success(res: ToTempFilePathRes): void

Inherited from MogsParams.success

接口调用成功的回调函数

# 参数:

属性 类型
res ToTempFilePathRes

ToTempFilePathRes

属性 类型 描述
errMsg string API 调用成功/失败的消息
tempFilePath string canvas 生成的临时文件路径 (本地路径)

# 返回值:

void