当前位置: 萬仟网 > IT编程>开发语言>JavaScript > cropperjs实践及中文文档(自译)

cropperjs实践及中文文档(自译)

2019年12月02日 16:39  | 萬仟网IT编程  | 我要评论

  cropperjs是一款非常强大却又简单的图片裁剪工具,它可以进行非常灵活的配置,支持手机端使用,支持包括ie9以上的现代浏览器。(关键是使用方法简单,几行代码就可以搞定)

实践效果图

  如图,可以对指定的图片进行裁剪,可以自己选择裁剪的交互方式,如大小、纵横比等 还可以预览裁剪区域,确认裁剪后可以生成一个包含裁剪图的canvas对象,借助canvas的todataurl方法可以生成一张base64格式的图片。还有另外一种不使用canvas的方式,利用该工具丰富的api可以拿到裁剪区域相对于原图的各项数据,使用这些数据进行css绝对定位即可展示裁剪后的图,该方式可以保证图片不失真和完整。

实践关键代码

  用vue框架做了一个小demo,使用方法非常简单,关键就是要了解这个工具丰富的能力,并且知道何时使用它。

<template>
  <div class="hello">
    <p>预览</p>
    <div class="before"></div>
    <iy-button style="margin: 30px auto;" type="error" @click="suresava">裁剪</iy-button>
    <div class="container">
      <div class="img-container">
        <img src="../assets/test.jpg" ref="image" alt=""> 
      </div>
      <div class="aftercropper">
        <img :src="afterimg" alt="">
      </div>
    </div>
  </div>
</template>

<script>
import cropper from 'cropperjs'
import 'cropperjs/dist/cropper.css'

export default {
  name: 'helloworld',
  data () {
    return {
      mycropper: null,
      afterimg: ''
    }
  },
  mounted() {
    this.init()
  },
  methods: {
    init(){
      this.mycropper = new cropper(this.$refs.image, {
        viewmode: 1,
        dragmode: 'none',
        initialaspectratio: 1,
        aspectratio: 1,
        preview: '.before',
        background: false,
        autocroparea: 0.6,
        zoomonwheel: false,
      })
    },
    suresava(){
      this.afterimg = this.mycropper.getcroppedcanvas({
        imagesmoothingquality: 'high'
      }).todataurl('image/jpeg')
    }
  },
}
</script>

<!-- add "scoped" attribute to limit css to this component only -->
<style scoped>
.container{
  display: flex;
}
.before{
  width: 100px;
  height: 100px;
  overflow: hidden;
  /* 这个属性可以得到想要的效果 */
}
.img-container{
  height: 400px;
  overflow: hidden;
}
.aftercropper{
  flex: 1;
  margin-left: 20px;
  border: 1px solid salmon; 
  text-align: center;
}
.aftercropper img{
  width: 150px;
  margin-top: 30px;
}
</style>

自译文档

官方github文档:

官方文档通俗易懂,我自己按照理解简单的翻译了一下,懒得翻译的可以参考一下,可能有不准确的地方,请自行判断,尤其是对容器(container)、图片容器(canvas)、图片(image)、裁剪区域(crop box)这几个概念的区分,有几个地方可能不对,先看这张图理解下:

 

下面是文档

# cropper - 裁剪图片 - ie9+

## 使用 cropperjs
```javascript
import cropper from 'cropperjs'
import 'cropperjs/dist/cropper.css'
this.mycropper = new cropper('被裁剪对象', '配置对象') //返回一个cropper对象

this.mycropper.getcroppedcanvas().todataurl('image/jpeg') //拿到裁剪后的base64的图片
this.mycropper.getcropboxdata();    //获取裁剪框数据
this.mycropper.setcropboxdata();    //设置裁剪框数据
this.mycropper.getcanvasdata();      //获取图片数据
this.mycropper.setcanvasdata();      //设置图片数据
```
## 配置对象
> https://github.com/fengyuanchen/cropperjs
__注意:第一个值为默认值__

- viewmode 视图控制
    - 0 无限制
    - 1 限制裁剪框不能超出图片的范围
    - 2 限制裁剪框不能超出图片的范围 且图片填充模式为 cover 最长边填充
    - 3 限制裁剪框不能超出图片的范围 且图片填充模式为 contain 最短边填充
- dragmode 拖拽图片模式
    - crop 形成新的裁剪框
    - move 图片可移动
    - none 什么也没有
- initialaspectratio 裁剪框宽高比的初始值 默认与图片宽高比相同 只有在aspectratio没有设置的情况下可用
- aspectratio 设置裁剪框为固定的宽高比
- data 之前存储的裁剪后的数据 在初始化时会自动设置 只有在autocrop设置为true时可用
- preview 预览 设置一个区域容器预览裁剪后的结果
    - element, array (elements), nodelist or string (selector)
- responsive 在窗口尺寸调整后 进行响应式的重渲染 默认true
- restore 在窗口尺寸调整后 恢复被裁剪的区域 默认true
- checkcrossorigin 检查图片是否跨域 默认true 如果是 会在被复制的图片元素上加上属性crossorigin 并且在src上加上一个时间戳 避免重加载图片时因为浏览器缓存而加载错误
- checkorientation 检查图片的方向信息(仅jpeg图片有)默认true 在旋转图片时会对图片方向值做一些处理 以解决ios设备上的一些问题
- modal 是否显示图片和裁剪框之间的黑色蒙版 默认true
- guides 是否显示裁剪框的虚线 默认true
- center 是否显示裁剪框中间的 ‘+’ 指示器 默认true
- highlight 是否显示裁剪框上面的白色蒙版 (很淡)默认true
- background 是否在容器内显示网格状的背景 默认true
- autocrop 允许初始化时自动的裁剪图片 配合 data 使用 默认true
- autocroparea 设置裁剪区域占图片的大小 值为 0-1 默认 0.8 表示 80%的区域
- movable 是否可以移动图片 默认true
- rotatable 是否可以旋转图片 默认true
- scalable 是否可以缩放图片(可以改变长宽) 默认true
- zoomable 是否可以缩放图片(改变焦距) 默认true
- zoomontouch 是否可以通过拖拽触摸缩放图片 默认true
- zoomonwheel 是否可以通过鼠标滚轮缩放图片 默认true
- wheelzoomratio 设置鼠标滚轮缩放的灵敏度 默认 0.1
- cropboxmovable 是否可以拖拽裁剪框 默认true
- cropboxresizable 是否可以改变裁剪框的尺寸 默认true
- toggledragmodeondblclick 是否可以通过双击切换拖拽图片模式(move和crop)默认true 当拖拽图片模式为none时不可切换 该设置必须浏览器支持双击事件
- mincontainerwidth(200)、mincontainerheight(100)、mincanvaswidth(0)、mincanvasheight(0)、mincropboxwidth(0)、mincropboxheight(0) 容器、图片、裁剪框的 最小宽高 括号内为默认值 注意 裁剪框的最小高宽是相对与页面而言的 并非相对图片


## 方法
__注意:如果方法没有被设置返回任何值,那么它会返回一个cropper的实例 因此多个方法可以使用链式写法__

- crop() 手动显示裁剪框
- reset() 重置图片和裁剪框为初始状态
- replace(url[, hassamesize]) 替换图片路径并且重建裁剪框 
    - url 新路径
    - hassamesize 默认值false 设置为true表示新老图片尺寸一样 只需要更换路径无需重建裁剪框
- enable() 解冻 裁剪框
- disable() 冻结 裁剪框
- destroy() 摧毁裁剪框并且移除cropper实例
- move(offsetx[, offsety]) 移动图片指定距离 一个参数代表横纵向移动距离一样
- moveto(x[, y]) 移动图片到一个指定的点 一个参数代表横纵向移动距离一样
- zoom(ratio) 缩放 ratio大于零是放大 小于零缩小
- zoomto(ratio[, pivot]) 缩放并设置中心点的位置
- rotate(degree) 旋转 类似css
- rotateto(degree) 旋转到绝对角度
- scale(scalex[, scaley])、scalex(scalex)、scaley(scaley) 缩放 一个参数代表横纵向缩放值一样
- getdata([rounded]) 返回裁剪区域基于原图片!原尺寸!的位置和尺寸 rounded默认为false 表示是否显示四舍五入后的数据 有了这些数据可以直接在原图上进行裁剪显示
- setdata(data) 改变裁剪区域基于原图的位置和尺寸 仅当viewmode 不为0时有效
- getcontainerdata()、getimagedata()、getcanvasdata()、setcanvasdata(data)、getcropboxdata()、setcropboxdata(data) 容器、图片容器(画布)、图片、裁剪区域相对容器的数据设置和获取
- getcroppedcanvas([options]) 得到被裁剪图片的一个canvas对象 options设置这个canvas的一些数据
    - width、height、minwidth、minheight、maxwidth、maxheight、fillcolor、imagesmoothingenabled(图片是否是光滑的 默认true)、imagesmoothingquality(图片的质量 默认low 还有medium、high)
- setaspectratio(aspectratio) 改变裁剪区域的宽高比
- setdragmode([mode]) 设置拖拽图片模式

## 事件
- ready 渲染前(图片已经被加载、cropper实例已经准备完毕)的准备工作事件 
- cropstart、cropmove、cropend、crop 开始画裁剪框(或画布)、画裁剪框(或画布)的中途、裁剪框(或画布)画完、进行裁剪事件 event.detail.originalevent、event.detail.action
    - 当autocrop为true crop事件会在ready之前触发
- zoom 裁剪框缩放事件

参考资料

官方github地址:

demo地址:https://gitee.com/eightflying/cropper-demo.git

如对本文有疑问,请在下面进行留言讨论,广大热心网友会与你互动!! 点击进行留言回复

相关文章:

◎已有 0 人评论

Copyright © 2019  萬仟网 保留所有权利. 粤ICP备17035492号-1
站长QQ:2386932994 | 联系邮箱:2386932994@qq.com