0.0.10 • Published 9 months ago

@cooolar/yuanbo-viewer v0.0.10

Weekly downloads
-
License
ISC
Repository
-
Last release
9 months ago

元播插件

本插件用于在H5页面中引入三维预览器,快速查看SKU模型。

使用方法

NPM引入

npm i @cooolar/yuanbo-viewer

使用

import { YuanboViewer } from '@cooolar/yuanbo-viewer'

const viewer = new YuanboViewer({
  container: 'viewer',
  skuId: '28347589851036732',
  onConfig: config => console.log('config - ', config),
  onLoading: value => console.log('loading - ', value),
  onError: err => console.error(err)
})

API参考

YuanboViewer

方法 constructor(options?: object)

  • 构造函数

options - 可选参数如下

参数名类型是否必传默认值说明
containerstringHTMLElement-节点ID或DOM元素,用于挂载预览器内容元素
skuIdstring-SKU ID
modelScalarnumber1模型大小比例,值越小模型越小,例:0.5表示模型显示正常大小的一半
onConfigfunction-SKU配置信息回调
onLoadingfunction-加载进度回调
onErrorfunction-报错信息回调
skuApiUrlstring-私有化部署API路径
debugbooleanfalse调试模式

function initSKU(skuId: string, options?: object)

  • 初始化SKU

skuId - SKU ID

options - 可选参数如下

属性名类型默认值说明
onConfigfunction-SKU配置信息回调
onLoadingfunction-加载进度回调
onErrorfunction-报错信息回调

function setContainer(container: string | HTMLElement)

  • 设置挂载节点

container - 节点ID或DOM元素,用于挂载预览器内容元素

function setRendering(enable: boolean)

  • 控制渲染开始与停止

enable - true开始 | false停止

function playSizeAnimation(enable?: boolean)

  • 调用尺寸动画

enable - 可选,true开启 | false关闭 尺寸动画,默认为当前状态取反

function reset()

  • 重置模型状态

function dispose()

  • 销毁实例
0.0.10

9 months ago

0.0.9

9 months ago

0.0.8

10 months ago

0.0.5

11 months ago

0.0.4

11 months ago

0.0.7

11 months ago

0.0.6

11 months ago

0.0.3

12 months ago

0.0.2

12 months ago

0.0.1

12 months ago