img-marker
TypeScript icon, indicating that this package has built-in type declarations

0.0.3 • Public • Published

Img Marker

一个基于 canvas 的极简轻量级图片标注库,支持多种图形标注 🚀🚀🚀

使用示例 👉 Demo 图例

安装

  • 使用 cdn
<script src="https://npm.onmicrosoft.cn/img-marker@^0/lib/index.umd.js"></script>
  • 使用 npm
npm install img-marker
  • 使用 yarn
yarn add img-marker
  • 使用 pnpm
pnpm add img-marker

使用

导入包

  • ESModule 导入
import ImageMarker from 'img-marker'

进行图片标注

  • 基础用法
<canvas id="myCanvas"></canvas>
import ImageMarker, { MarkMode, EventType } from 'img-marker'

// 通过 dom 或 css selector 初始化 imgMarker 实例
const imgMarker = new ImgMarker("#myCanvas", "https://lxy520.top/myImage/202310301200291.png")
// 设置初始的默认标注
imgMarker.setData([
  {
    coor: [[12, 40], [640, 100]],
    type: 1
  },
])
// 设置当前行为模式为:点击创建矩形标注
imgMarker.setMode(MarkMode.rect)

// 图片加载完成触发回掉函数
imgMarker.on(EventType.Load, () => {
  console.log('Image loaded')
});
// 添加标注触发回掉函数
imgMarker.on(EventType.Add, (shape) => {
  console.log('added shape', shape)
  // 添加一次标注后将当前行为模式设置为:图形编辑模式,对标注进行移动和放缩
  imgMarker.setMode(MarkMode.edit);
});
// 选中标注触发回掉函数
imgMarker.on(EventType.Select, (shape) => {
  console.log('selected shape', shape)
});

// 将标注结果导出为图片
// const img = imgMarker.exportImg("image/jpeg", 0.9)
// 销毁实例
// imgMarker.destroy()

API

  • 待补充...

Package Sidebar

Install

npm i img-marker

Weekly Downloads

27

Version

0.0.3

License

ISC

Unpacked Size

91.2 kB

Total Files

17

Last publish

Collaborators

  • liuxueyong