VantUploader | kdayun 界面引擎API

文件上传

Hierarchy

MVantInputBase
- VantUploader

Index

Constructors

constructor

Properties

Constructors

constructor

new VantUploader(config: any): VantUploader

Inherited from MVantInputBase.constructor
- Defined in YH-Vant/src/form/VantUploader.ts:281
Parameters
- config: any
Returns VantUploader

Properties

accept

accept: String

允许上传的文件类型，参考:https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/Input/file#%E9%99%90%E5%88%B6%E5%85%81%E8%AE%B8%E7%9A%84%E6%96%87%E4%BB%B6%E7%B1%BB%E5%9E%8B

afterReadScript

afterReadScript: string

文件读取完成后的回调函数

arrowDirection

arrowDirection: arrowDirectionType

箭头方向，可选值为 left up down

beforeDeleteScript

beforeDeleteScript: string

文件删除前的回调函数，返回 false 可终止文件读取，支持返回 Promise

beforeReadScript

beforeReadScript: string

文件读取前的回调函数，返回 false 可终止文件读取，支持返回 Promise

border

border: boolean

是否显示内边框

capture

capture: string

图片选取模式，可选值为 camera (直接调起摄像头)

clearable

clearable: boolean

是否启用清除图标，点击清除图标后会清空输入框

clickPreviewScript

clickPreviewScript: string

点击上传区域事件

clickUploadScript

clickUploadScript: string

点击上传区域事件

closePreviewScript

closePreviewScript: string

关闭全屏图片预览事件

colon

colon: boolean

是否在 label 后面添加冒号

css

css: VantUploaderStyle

deletable

deletable: boolean

是否展示删除按钮

deleteScript

deleteScript: string

删除文件预览

imageFit

imageFit: string

预览图裁剪模式: (fill contain cover scale-down)

inputAlign

inputAlign: TextAlign

输入框对齐方式，可选值为 center right

inputId

inputId: string

isLink

isLink: boolean

是否展示右侧箭头并开启点击跳转

isShowLabel

isShowLabel: boolean

是否显示label

labelAlign

labelAlign: TextAlign

左侧文本对齐方式，可选值为 center right

labelCaption

labelCaption: string

label标题

labelWidth

labelWidth: Number

左侧文本宽度，默认单位为px

lazyLoad

lazyLoad: boolean

是否开启图片懒加载，须配合 Lazyload 组件使用

leftIcon

leftIcon: String

左侧图标名称或图片链接

maxCount

maxCount: number

文件上传数量限制

maxSize

maxSize: string

文件大小限制，单位为 byte

multiple

multiple: boolean

是否开启图片多选，部分安卓机型不支持

oversizeScript

oversizeScript: string

文件大小超过限制事件

placeholder

placeholder: string

输入框占位文本

previewFullImage

previewFullImage: boolean

是否在点击预览图后展示全屏图片预览

previewImage

previewImage: boolean

是否在上传完成后展示预览图

previewSize

previewSize: String

预览图和上传区域的尺寸，默认单位为 px

readonly

readonly: boolean

只读

required

required: boolean

是否必填

resultType

resultType: string

文件读取结果类型，可选值为: file text dataUrl

rightIcon

rightIcon: String

右侧图标名称或图片链接

showUpload

showUpload: boolean

是否展示上传区域

size

size: SizeType

控件大小。注：标准表单内的输入框大小限制为 large

slot

slot: string

uploadIcon

uploadIcon: string

上传区域图标名称或图片链接

uploadText

uploadText: string

上传区域文字提示

uploadUrl

uploadUrl: string

上传的地址

verify

verify: string

校验规则

verifyText

verifyText: string

Methods

Protected addFile

addFile(file: IUploadFile): void

- Defined in YH-Vant/src/form/VantUploader.ts:448
增加新上传的文件不管成功还是失败

Parameters
- file: IUploadFile
  
  上传对象
Returns void

Protected addFiles

addFiles(files: IUploadFile[]): void

- Defined in YH-Vant/src/form/VantUploader.ts:457
增加新上传的文件不管成功还是失败

Parameters
- files: IUploadFile[]
  
  上传对象数组
Returns void

doGetClassName

doGetClassName(): any

- Defined in YH-Vant/src/form/VantUploader.ts:313
Returns any

doGetCss

doGetCss(): VantUploaderStyle

- Defined in YH-Vant/src/form/VantUploader.ts:300
Returns VantUploaderStyle

doGetMethods

doGetMethods(): {} & { handleChange: any }

Overrides MVantInputBase.doGetMethods
- Defined in YH-Vant/src/form/VantUploader.ts:467
事件

Returns {} & { handleChange: any }

Protected doGetSlot

doGetSlot(): string

- Defined in YH-Vant/src/form/VantUploader.ts:346
Returns string

Protected doGetVerifyElem

doGetVerifyElem(): JQuery<HTMLElement>

Inherited from MVantInputBase.doGetVerifyElem
- Defined in YH-Vant/src/base/MVantInputBase.ts:245
提示校验信息的jquery 对象子类可以覆盖该函数实现提交时候的"危险"的样式的挂接到组件的那个jquery对象

Returns JQuery<HTMLElement>

Protected doGetVerifyTextElem

doGetVerifyTextElem(verifyText: any): string

Inherited from MVantInputBase.doGetVerifyTextElem
- Defined in YH-Vant/src/base/MVantInputBase.ts:255
展示校验信息的dom节点子类可以覆盖该函数实现提交时候的"危险"的样式的挂接到组件的那个jquery对象

Parameters
- verifyText: any
  
  提示的文字
Returns string

Protected doGetVerifyTipsElem

doGetVerifyTipsElem(): JQuery<HTMLElement>

Inherited from MVantInputBase.doGetVerifyTipsElem
- Defined in YH-Vant/src/base/MVantInputBase.ts:298
设置数据校验的标志的jquery 对象如子类可以覆盖该函数实现提交校验没有通过会把改jquery 对象变成"红色的框框"

Returns JQuery<HTMLElement>

doGetVueData

doGetVueData(): object

Overrides MVantInputBase.doGetVueData
- Defined in YH-Vant/src/form/VantUploader.ts:357
Returns object

Protected doGetVueEvent

doGetVueEvent(): string

Inherited from MVantInputBase.doGetVueEvent
- Defined in YH-Vant/src/base/MVantInputBase.ts:283
定义一些默认的事件

reutrn

返回事件定义的字符串

Returns string

Protected doGetVueHtml

doGetVueHtml(): string

- Defined in YH-Vant/src/form/VantUploader.ts:319
获取组件的html

Returns string

Protected doGetVueVModel

doGetVueVModel(): string

Inherited from MVantInputBase.doGetVueVModel
- Defined in YH-Vant/src/base/MVantInputBase.ts:290
定义一些默认的vmodel字符串

reutrn

返回vmodel字符串

Returns string

Protected doRenderCallback

doRenderCallback(): void

Inherited from MVantInputBase.doRenderCallback
- Defined in YH-Vant/src/base/MVantInputBase.ts:317
Returns void

Protected doRenderComponentWidth

doRenderComponentWidth(): void

Inherited from MVantInputBase.doRenderComponentWidth
- Defined in YH-Vant/src/base/MVantInputBase.ts:367
渲染组件input宽度

Returns void

Protected doRenderLabel

doRenderLabel(): void

Inherited from MVantInputBase.doRenderLabel
- Defined in YH-Vant/src/base/MVantInputBase.ts:313
渲染标题

Returns void

Protected doRenderPlaceholder

doRenderPlaceholder(): void

Inherited from MVantInputBase.doRenderPlaceholder
- Defined in YH-Vant/src/base/MVantInputBase.ts:334
渲染placeholder

Returns void

doVerify

doVerify(): boolean

Inherited from MVantInputBase.doVerify
- Defined in YH-Vant/src/base/MVantInputBase.ts:183
校验数据是否通过设置的校验规则

Returns boolean

true通过,则反之

getAttrEditors

getAttrEditors(): AttributeEditorBase[]

Overrides MVantInputBase.getAttrEditors
- Defined in YH-Vant/src/form/VantUploader.ts:289
注意:使用注解注册属性编辑器这里不能少

Returns AttributeEditorBase[]

Protected getCanEdit

getCanEdit(): boolean

Inherited from MVantInputBase.getCanEdit
- Defined in YH-Vant/src/base/MVantInputBase.ts:327
组件是否可以编辑

Returns boolean

getElemtHtml

getElemtHtml(): string

Inherited from MVantInputBase.getElemtHtml
- Defined in YH-Vant/src/base/MVantInputBase.ts:259
Returns string

getInputElem

getInputElem(): JQuery<HTMLElement>

Overrides MVantInputBase.getInputElem
- Defined in YH-Vant/src/form/VantUploader.ts:474
Returns JQuery<HTMLElement>

getUploadValue

getUploadValue(): IUploadFile[]

- Defined in YH-Vant/src/form/VantUploader.ts:368
得到上传组件的值数组对象

Returns IUploadFile[]

返回数组

getValue

getValue(): any

Inherited from MVantInputBase.getValue
- Defined in YH-Vant/src/base/MVantInputBase.ts:175
得到组件的值

Returns any

返回值

getVueAttrStr

getVueAttrStr(): string

Inherited from MVantInputBase.getVueAttrStr
- Defined in YH-Vant/src/base/MVantInputBase.ts:275
增加 v-model="value"

Returns string

Protected getVueUploadVal

getVueUploadVal(): VantUploadItem[]

- Defined in YH-Vant/src/form/VantUploader.ts:383
得到上传组件的vue的值数组对象

Returns VantUploadItem[]

返回数组

hookMethodhandleParams

hookMethodhandleParams(attr: string, argArray: any): any[]

- Defined in YH-Vant/src/form/VantUploader.ts:420
Parameters
- attr: string
- argArray: any
Returns any[]

Protected removeByIndex

removeByIndex(index: number): void

- Defined in YH-Vant/src/form/VantUploader.ts:398
移除文件

Parameters
- index: number
  
  位置
Returns void

Protected removeFile

removeFile(fileName: any): void

- Defined in YH-Vant/src/form/VantUploader.ts:411
移除文件

Parameters
- fileName: any
  
  文件名
Returns void

verifyTips

verifyTips(): void

Inherited from MVantInputBase.verifyTips
- Defined in YH-Vant/src/base/MVantInputBase.ts:211
显示的提示校验信息当 verifyText 非空时候显示"危险"的样式, 空则去除"危险"的样式

Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: any

Returns VantUploader

Properties

accept

afterReadScript

arrowDirection

beforeDeleteScript

beforeReadScript

border

capture

clearable

clickPreviewScript

clickUploadScript

closePreviewScript

colon

css

deletable

deleteScript

imageFit

inputAlign

inputId

isLink

isShowLabel

labelAlign

labelCaption

labelWidth

lazyLoad

leftIcon

maxCount

maxSize

multiple

oversizeScript

placeholder

previewFullImage

previewImage

previewSize

readonly

required

resultType

rightIcon

showUpload

size

slot

uploadIcon

uploadText

uploadUrl

verify

verifyText

Methods

Protected addFile

Parameters

file: IUploadFile

Returns void

Protected addFiles

Parameters

files: IUploadFile[]

Returns void

doGetClassName

Returns any

doGetCss

Returns VantUploaderStyle

doGetMethods

Returns {} & { handleChange: any }

Protected doGetSlot

Returns string

Protected doGetVerifyElem

Returns JQuery<HTMLElement>

Protected doGetVerifyTextElem

Parameters

verifyText: any

Returns string

Protected doGetVerifyTipsElem