pkpm-comment

pkpm-comment

[TOC]

1.组件描述

pkpm-comment组件主要是提供批注功能，其中包括obv批注插件接口调用、批注持久化接口调用，以及相关的一些类和接口以供使用。

2.前置条件

本组件依赖 windows 上挂载的 EventBus 对象进行通讯，EventBus 对象是北京电力及标准化平台已挂载好的对象,其他项目使用前请检查。

3.安装组件

npm install --save @pkpm/pkpm-comment --registry=http://101.40.70.165:9010/

4.参数及方法

| 参数 | 类型 | 说明 | 默认 | | :------------------------------------------ | ------------------------------------------------------------ | ----------------------------------------------------------- | ---- | | 批注相关 | | | | | routerParams(projectId,guid,fileId,version) | projectId:string,guid:string,fileId:string,version:string | 路由参数 | / | | userTokenInfo | string | 访问令牌 例 '{"access_token":"xxx","token_type":"xxx",...}' | / | | baseUrl | string | 协议名：//主机.域名 例 https://cloud.dev.pkpm.cn | / | | obvApi | ObvApiWrapper | obv相关 | / | | | | | |

5.使用方法

项目中引入bimbox-file-uploader中的UploadFileController类，基于此创建上传相关参数及回调等

import { PKPMComment } from '@pkpm/pkpm-comment';
export default class MarkupController {
    public static PKPMComment: PKPMComment;
    ...
    public static initPKPMComment(args: IPKPMCommentArgs) {
        this.obvApi = args.obvApi;
        this.PKPMComment = new PKPMComment(
            args.parameters,
            args.userInfo,
            BimboxRuntimeUtil.instance.serviceOrigin,
            args.obvApi,
        );
    }
}

6.打包方式

打包

"build": "tsc"

切换为私库

npm config set registry http://101.40.70.165:9010/

发布

npm publish:npmjs

7.参考用例

标准化产品：

​ 文件分享查看-批注

​ 文件详细视图查看-批注