1.0.9 • Published 6 months ago

osd-pixi v1.0.9

Weekly downloads
-
License
-
Repository
-
Last release
6 months ago

Openseadragon+Pixijs

功能简介

1. 基本参数和数据格式(Props)

变量名功能类型说明备注
iiifData渲染图片所需图片信息Object必填
tileSourcesRenderModetileSources 渲染方式String('normal' or 'iiif')
shapesData所有 shape 数据Object
remarkShapesData备注轮廓数据Object
shapeColorsshape 颜色序列number
mpp单位像素number
imageWidth图片宽度number
imageHeight图片高度number
imagePathId图片地址number
imageTileSize图片瓦片大小number
imageMagnitude最大放大倍数number
hasInteraction是否开启交互boolean
hasZoom是否开启缩放boolean
hasScaleController是否开启放大倍数控制器boolean
hasScaleBar是否开启比例尺boolean
hasRuler是否开启标尺boolean
hasColorSetting是否开启颜色调节boolean
hasRotate是否开启旋转boolean
hasReset是否开启重置boolean
isShowShapeStyle是否显示shape样式boolean
stackNames层级名称string
defaultShapeRenderType默认 shape 渲染类型String('fill' or 'line')
isOnlyShowShapeRange在 shape 显示为 area 时,是否只显示 range 条,这个只在isShowShapeStyle为 true 时起作用boolean默认 false默认显示

2. 方法(Methods)

方法名描述参数返回值
getCurrentOsdViewerImageData获取当前视图图片信息
onNormalMove选择
onNormalClick点击
onRectSelect开始框选
onRectSelectEnd结束框选rectSelectorDoneCallback
onStartDrawPen笔刷color格式(示例:0x880022)
onStartFreeDraw笔刷模式绘制color格式(示例:0x880022)
updateIsNormalDrawMode新绘制模式true
updateIsNormalDrawMode新橡皮擦模式false
onEndFreeDraw结束新绘制或橡皮擦
onEditFreeDraw修改涂抹
onEndEditFreeDraw结束修改涂抹
onStartDrawPolygon开始绘制多边形color格式(示例:0x880022)
onEditPolygroup结束绘制多边形
onStartDrawCircle开始绘制圆color格式(示例:0x880022)
onStartDrawRect开始绘制矩形
onEndDraw结束绘制图形
onStartDrawPolygroup开始绘制Ploygroupcolor格式(示例:0x880022)
onCancelDrawPolygroup取消绘制Ploygroup
getPolygroupData完成绘制Ploygroup
onEditClip编辑切片参数示例({id:"2233",xywh:691,613,489,537})
onEditPolygon编辑多边形
onEditCircle编辑圆
onEditRect编辑矩形
onEditPolygroup编辑Ploygroup
onEndEdit编辑完成
onCancelEdit取消编辑
setEnableDrawRuler允许测量true
setEnableDrawRuler禁止测量false
onEndDrawRuler测量距离结束
onCleanRuler清除所有测量
onHideShapes隐藏shape'shapeid'
onStartDrawShot截图color格式(示例:0x880022)

3. 事件(Events)

事件名描述参数
singleSelectCallback单个选择回调当前选择的shapeData
normalClickCallback普通点击回调
rectSelectorCallback框选回调当前框选的shapeData
rightClickCallback右键点击回调当前点击点的shapeData
drawShotCallback截图回调
drawRectCallback绘制矩形的回调当前绘制的rectData
drawCircleCallback绘制圆形的回调当前绘制的circleData
drawPolygonCallback绘制多边形的回调当前绘制的polygonData
drawPolygroupCallback绘制多边形组回调当前绘制的polygroupData
drawClipCallback绘制切片的回调当前绘制的penData
rulerDrawCallback标尺绘制状态
pointerClickCallback获取点击坐标回调
editPolygonCallback编辑多边形回调
editCircleCallback编辑圆回调
editRectangleCallback编辑矩形回调
editPolygroupCallback编辑多边形组回调
remarkLabelClickCallback备注轮廓回调
editShapeDoneCallback编辑轮廓完成回调
onSlideChangeCallback倍率尺滑动回调

4. 数据格式(Data Format)

shapes格式 { "线段格式(solid or dashed)_颜色格式(示例5118182)": { id: "shapeid", shapeType: "shape类型", color: "颜色", points: "点集合(Array)", area: "面积", extra:{ algCheckId: "算法检测id", algCheckType: "算法检测类型", label: "标签", lineStyle: "线段格式(solid or dashed)", originPoints: "原始点集合(Array)", } } }