参数	类型	描述性
选项	地图绘制	上传部件参数地图应用看参数类段全列表可用选项
结果回调	函数转换	可选函数请求事件处理回调法有以下签名`函数(error,结果)`去哪儿`报错`中或`空号`成功或报错报错报错报错报错报错报错报错报错报错报错报错报错报错报错报错报错报错报错报错报错报错`结果`JSON对象详解触发事件处理.

实例

openUploadWidget

创建部件对象和框架内存并打开部件

语法

cloudinary.openUploadWidget(options, resultCallback)

参数	类型	描述性
选项	地图绘制	上传部件参数地图应用看参数类段全列表可用选项
结果回调	函数转换	可选函数请求事件处理回调法有以下签名`函数(error,结果)`去哪儿`报错`中或`空号`成功或报错报错报错报错报错报错报错报错报错报错报错报错报错报错报错报错报错报错报错报错报错报错`结果`JSON对象详解触发事件处理.

实例

applyUploadWidget

创建部件对象和框架存储器,并修改给定元素为蓝按钮(可定制外观和感知),当点击时打开预创上传部件此外,表单并缩略图选项默认设置为给定元素的封装形式

语法

cloudinary.applyUploadWidget(element, options, resultCallback)

参数	类型	描述性
元素化	元素分量	页面内容修改为按钮
选项	地图绘制	上传部件参数地图应用看参数类段全列表可用选项
结果回调	函数转换	可选函数请求事件处理回调法有以下签名`函数(error,结果)`去哪儿`报错`中或`空号`成功或报错报错报错报错报错报错报错报错报错报错报错报错报错报错报错报错报错报错报错报错报错报错`结果`JSON对象详解触发事件处理.

实例

cloudinary_upload_widget

注解

Query-只支持后向兼容

同样applyUploadWidget.Query选择器应用部件匹配元素

实例

参数解析

重要点

除必备参数仅包含其他参数以覆盖默认值.

下表列表所有可用参数(选项)创建并初始化上传部件初始化方法方法 :

注解

标准化 骆驼Case选项名显示在此。
后向兼容上传构件1.x 蛇盒并支持。

所需参数

下图参数需要初始化上传部件时 :

参数	类型	描述性
云化Name	字符串	云化产品环境云名可全局使用`setCludName`或清晰显示部件创建调用示例:`演示文集`
上传预置	字符串 (可选if`上传签名`使用)	上传预设名定义您的产品环境上传部件非签名上传时,请确认指定非签名上传预置,反之,如果选择提供上传预置执行签名上传部件,请确认提供签名上传预置可定义上传预置上传控制台设置页或使用adminAPI 示例:`预置1`

部件参数

参数	类型	描述性
源码	数组字符串	链表源码应在部件中添加标签(web)或源选项(移动/响应)。可能的值 :`本地化`,`URL`,`摄像头`,`滴箱`,`图像搜索`,`百叶窗`,`Getyimages模拟`,`istock使用`,`松开斜线`,`google驱动` 注解: 源显示顺序与添加到此参数的顺序相同。 `摄像头`无关移动设备`本地化`选项还允许从移动设备摄像头中捕捉),目前所有现代浏览器都支持(互联网探索者或桌面搜索不支持)。上头`摄像头`并`滴箱`源选项只有在上传部件嵌入HTTPS页面时才会出现
安全性	布尔	部件使用HTTP协议取代HTTP协议默认值 :`真实性`.
加密	键四配对地图	加密密钥初始化向量加密上传文件示例:`{密钥:ff234fe5267753fa45b3254`
默认源码	字符串	源代码当部件打开时选择默认值 :`本地化`
多重性	布尔	是否允许选择并上传多项资产完全调回所有资产完全上传时才调回设为真时,多隐域资产标识符创建设假时,在源码中只允许单项资产见下文注解. 默认值 :`真实性`
最大Files	整数	最大文件数多上传模式如果用户选择或拖动超出允许量,则不上传文件见下文注解. 默认值 :无限制示例:`10`

注解

云化推荐设置限值 最大Files.部件不限制前端上传数, 后端端有20次同时调用的限制。

裁剪参数

参数	类型	描述性
裁剪	布尔	设为`真实性`允许用户交互裁剪图像交互裁剪允许用户标注图像趣味部分,所选维度以`customCoordinates`或`面坐标`上传参数视使用值而定`croppingCoordinatesMode`. 设置`重力`至`自定义`或`脸部`生成交付URL时提供图像并裁剪用户定义部件收成模式集成保存图像前可应用`自定义`重力上传预设裁剪只支持单文件上传`多重性`部件参数对`虚伪`以启动交互裁剪注解:如果用户上传视频或图像格式而不为浏览器支持,则跳过此步(例如SDF或SVG文件)。默认值 :`虚伪`
showSkipCropButton	布尔	是否显示交互裁剪步骤上“skip”按钮, 强制设置假步仅在相关`裁剪`特征启动注解:在某些情况下,按钮将仍然显示而不计此设置(例如,ifCroppingAspectRatio设置为1.0 用户尝试上传图像上传比例为1.0 默认值 :`真实性`
croppingAspectRatio	小数	如果指定,执行交互裁剪时对选定区域执行给定宽比宽度比定义宽度/高度0.5面向矩形或1平方仅在相关`裁剪`特征启动注解:如果用户试图上传完全相同宽比的资产,则crop按钮将启动停机用户要么点击scrop按钮, 或略微修改裁剪区以启动crop按钮默认值 :`空号` 示例:`0.5`
croppingDefaultSelectionRatio	小数	初始化裁剪选择框大小与默认值不同值按图像大小比例计算仅在相关`裁剪`特征启动默认值 :`1.0`.范围 :`0.1`至`1.0`. 示例:`0.75`
croppingShowDimensions	布尔	是否显示裁剪区左上角的裁剪维度仅在相关`裁剪`特征启动默认值 :`虚伪`.
croppingCoordinatesMode	字符串设置 :`自定义`或`脸部`	判定如何应用所选区域坐标 `自定义`- 所选区域设置为`customCoordinates`上传参数 `脸部`- 所选区域设置为`面坐标`上传参数仅在相关`裁剪`特征启动
croppingShowBackButton	布尔	是否显示回溯按钮裁剪模式仅在相关`裁剪`特征启动默认值 :`真实性`

源参数

看第三方上传源详解各种源工作

参数	类型	描述性
`滴箱 :`
投箱AppKey	字符串	dropbox应用密钥需要时添加`滴箱`源头
`图像搜索 :`
googleapiKey	字符串	API密钥访问GoogleAPIs.需要时添加`图像搜索`源头
搜索BySite	数组字符串	网站URL允许图像搜索如果多网站提供网站搜索下拉加允许搜索全网使用值全默认值 :`全部`
搜索ByRights	布尔	设为`真实性`添加下拉框供用户使用搜索时选择许可滤波默认值 :`虚伪`
`Google驱动器`
googleDriveClientId	字符串	客户码Google驱动程序访问用户Google驱动账号默认使用CloudinaryGoogle驱动应用存取账户

上传参数

参数	类型	描述性
公共标识	字符串	自定义公共标识分配单上传资产未指明则随机生成字符串或原文件名根据未签名上传预置为了确保安全使用,不支持覆盖先前共享相同公共标识资产(除非上传预置中还包含“覆盖=真数”)。默认值 :`空号`. 示例:`剖面图11002`
文件夹	字符串	文件夹名所有上传资产默认值 :`空号`上载文件夹示例:`用户图片`
useAssetFolderAsPublicIdPrefix	布尔	是否使用指定文件夹作为所有公共标识的前缀默认值 :`虚伪`
公共Id前缀	字符串	字符串添加为所有公共标识的前缀
标签标签	数组字符串	一个或多个标签分配上传资产默认值 :`空号`. 示例:`用户和内容`
资源类型	字符串	限值上传文件到指定类型默认时允许所有资源类型可能的值 :`汽车`,`图像显示`,`视频播放`,`原生`. 默认值 :`汽车`.
上下文	键值对映射	贝斯特登录入口官网下载附加上传资源上下文元数据示例:`{alt:My_alt,注解:My_caption`
检测	字符串	调用相关加号设置为 : _[ ] (e.g. `co_v2`)使用检测内容贝斯特平台网址云化AI内容分析加载 `adv-face`检测面部属性使用高级侧属性检测加载 `s_rek_face`检测名人和面部属性使用亚马逊 rekognition名人检测加载
成功	字符串	允许您用JavaScript定义自定义逻辑更新资产,该逻辑在上传云性成功完成后执行视使用结果而定,这可用于有条件添加标签、上下文元数据和结构化元数据`检测`上传参数更多细节见成功更新脚本.
上传签名	字符串或函数	或表示预算所有上传参数签名的字符串使用,或函数动态生成签名字符串函数接受2参数,第一个结果回调(函数),第二个对象带生成签名所需的相关上传参数示例:`c347053314777423cd4f` 细节见生成验证签名.
uploadSignatureTimestamp	数目	ix时间以秒计当前时间时间戳有效一小时唯一相关`上传签名`并提供。示例:`1315060076`

客户端参数

参数	类型	描述性
clientAllowedFormats	数组字符串	允许客户端校验上传文件可指定一个或多个文件扩展项,并/或限制允许文件为“视频”或“图像”。仅在从本地设备上传文件时应用。注解:作为快捷键,您可用字符串传递单值(例如.gif) 默认值 :`空号`. 示例:`Webpggif视频`
最大易分量	整数字节数	指定时执行客户端验证以防止上传大于给定字节大小的文件默认值: null(无客户端端限值) 示例:`5500000`5.5MB 注解: 应用到`本地化`仅文件上传尺寸受服务器侧文件最大尺寸限制 - 预览、裁剪和像素计数选项不适用于大于40MB的文件(文件仍可上传)
maxImageFileSize	整数字节数	指定时执行客户端验证以防止上传大于给定字节大小的图像文件默认值: null(无客户端端限值) 示例:`150000`1.5MB 注解: 覆盖`最大易分量`ifset图像应用到`本地化`仅文件上传尺寸受服务器侧文件最大尺寸限制 - 预览、裁剪和像素计数选项不适用于大于40MB的文件(文件仍可上传)
maxVideoFileSize	整数字节数	指定时执行客户端验证以防止上传大于给定字节大小的视频文件默认值: null(无客户端端限值) 示例:`15000`15MB 注解: 覆盖`最大易分量`视频版(ifset) 应用到`本地化`仅文件上传尺寸受服务器侧文件最大尺寸限制
最大RawFileSize	整数字节数	指定时执行客户端验证以防止上传比给定字节大小更大的原始文件默认值: null(无客户端端限值) 示例:`2000000`2MB 注解: 覆盖`最大易分量`if set原文件应用到`本地化`仅文件上传尺寸受服务器侧文件最大尺寸限制
最大图像Width	整数数像素	if descript,客户端缩放先上传,如果所选文件宽度大于指定值或可同时使用`validateMaxWidthHeight`防止上传超过此值的图像注解:只有在上传本地文件时才相关,而不是从 URL上传文件默认值 :`空号`(不重定大小) 示例:`2000年`
最大图像高度	整数数像素	if descript,客户端缩放前上传,如果所选文件高度大于指定值或可同时使用`validateMaxWidthHeight`防止上传超过此值的图像注解:只有在上传本地文件时才相关,而不是从 URL上传文件默认值 :`空号`(不重定大小) 示例:`2000年`
validateMaxWidthHeight	布尔	指定客户端验证后上传如果图像宽度和/或高度大于`最大图像Width`和/或`最大图像高度`上传取消客户端缩放不发生默认值 :`虚伪`(无验证)
最小图像Width	整数数像素	指定客户端验证后上传如果所选文件宽度小于指定值,则取消上传注解:只有在上传本地文件时才相关,而不是从 URL上传文件默认值 :`空号`(无验证) 示例:`二百`
最小图像Hi	整数数像素	指定客户端验证后上传如果所选文件高度小于指定值,则取消上传注解:只有在上传本地文件时才相关,而不是从 URL上传文件默认值 :`空号`(无验证) 示例:`二百`
croppingValidateDimensions	布尔	仅在相关`裁剪`特征启动并设置下列一个或多个参数`最大图像Width`,`最大图像高度`,`最小图像Width`或`最小图像Hi`. if descript,客户端验证发生于原图像大小和大小`裁剪`区域标识用户默认值 :`虚伪`.
最大chunk规模	整数字节数	配置最大块大小上传大文件值必须至少5M`5000000`) 默认值 :`2000000`

包含页面参数

参数	类型	描述性
表单	ss选择器	选择器(CSS路径)表单中附加隐藏字段并显示上传资产标识符默认隐含式设置给定元素表`applyUploadWidget`或`$.fn.cloudinary_upload_widget`. 默认值 :`空号` 示例:`#My_form`
字段Name	表单字段名	隐藏字段名填全时添加到表单多隐域同名创建多上传资产名中可包含`家常便饭`支持网络框架如Ruby on Rails 默认值 :`图像显示` 示例:`相片`
缩略图	ss选择器	选择器 HTML元素,作为容器附上缩略图默认隐附上上传部件元素完全不显示缩略图设置为false 默认值 :`空号` 示例:`. content.加载`
thumbnailTransformation	字符串或数组地图	云变换(操作)应用上传资产嵌入网站缩略图重构、裁剪、特效和其他云状图像变换选项可以通过指定变换字符串或数组映射变换应用缩图变换在上传时可热切生成,方法是定义定义上传预设中的热变换集默认值 :{宽度:90,高度:60,作物:`限量'} 实例: `{宽度:100,高度:100,作物:fit` `{宽度:200,高度:200,作物:填充}{效果:sepia}` `"w_200,h_200,c_fill"`

自定义参数

参数	类型	描述性
按钮类	字符串	允许您覆盖添加到网站的默认CSS类名。默认CSS样式应用`cloudinary-button`类上使用CSS指令可置换或可指定匹配网站设计的任何类名默认值 :`cloudinary-button`
按钮章	字符串	允许置上传按钮的默认标题于网站默认值 :`上传图像`
主题化	字符串	预定义部件主题名部件行为对所有主题都是一样的支持主题`默认`,`白线`,`最小值`,`紫色`. 默认值 :`默认`
样式学	对象类	高级定制部件外观和感觉提供自定义样式定义,以覆盖部件默认颜色、字体、图标和其他元素看观感定制样本参比实现默认值 : 部件默认值设置用于非特有覆盖的所有元素
文本翻译	对象类	键值对文本覆盖部件默认文本标签看本地化样本参比实现

高级参数

参数	类型	描述性
showPoweredBy	布尔	置之不理云形电源图标显示默认值 :`真实性`. 注解:只支持支付云型账号并需要时间缓存过期
自动最小化	布尔	上传启动后自动最小化部件默认值 :`虚伪`
获取标签	函数转换	函数调用添加标签建议文本修改时`添加标签`高级文本字段
getUploadPresets	函数转换	函数填充上传预置选择字段添加高级选项。
预批量	函数转换	函数执行批前验证上传启动前
prepareUploadParams	函数转换	a函数准备上传参数上传启动前准备UploadParams回调仅支持准备下列参数`apiKey`,`审核Context`,`上下文`,`文件夹`,`无效`,`元数据`,`覆盖覆盖`,`公共标识`,`质量解析`,`资源类型`,`签名`,`标签标签`,`唯一文件名`,`上传预置uploadSignatureTimestamp`,`使用文件名`.
语言类	字符串	确定哪个`文本翻译`参数语言元件使用默认值 :`内`
showAdvancedOptions	布尔	是否显示高级选项帮助用户设置公共身份证,添加标签中选择上传预置仅当`getUploadPresets`定义化) 默认`虚伪`
showCompletedButton	布尔	置之不理补全按钮将在上传完成后显示用户点击按钮时,部件点火`show-fried`事件详解默认`虚伪`
showUploadMoreButton	布尔	置之不理上传更多按钮将在上传完成后显示默认值 :`真实性`
singleUploadAutoClose	布尔	上传部件完成后是否自动关闭默认值 :`真实性`
queueViewPosition	字符串	最小上传队列显示位置从右边缘或左边缘表示偏值,后加结存并取CSS单元偏移值默认`右转:35px`
showInsecurePreview	布尔	部件是否显示从HTTP(非安全性)URL选择上传的资产预览HTTPS URLs中的资产将显示预览,而不管此参数值如何默认`虚伪`
内联容器	字符串选择器或DOM元素	启动部件嵌入网页,而不是模式式对话框默认值 :`空号` 实例: `#my-widget-container` `document.getElementById('my-widget-container');`

实例方法

下方法可用部件对象返回初始化方法:

打开

Renders目前存取的部件,但目前不显示

语法

开源选项

参数	类型	描述性
源码	字符串	源码元件开机默认:null
选项	地图绘制	任选值传递当前支持 : -`文件编程`: (字符串阵列) 可选资产URL,在这种情况下部件要么直接跳转到上传给定资产,要么跳过源选择选项并打开部件并预置给定资产裁剪(如果启用该选项)。