3dd-widget 中文文档教程

Question

3dd-widget

用于 3DDashboard 小部件的紧凑型 API

该库提供了通过小部件访问 3DEXPERIENCE Web 服务的直接便捷方式。 它的作用是：

• performing authentication requests before accessing corresponding 3DEXPERIENCE services (right now, for 3DSpace and 3DSwym, but it's easy to extend);
• providing abstract class Service with static request method;
• retrieving URLs of required services and binding them to appropriate SV* classes, allowing you to make request by URI rather than full URL;
• incrementing confidence in code you write with TypeScript support (everything has types and comments).

3dd-widget 需要在支持 ECMAScript 2015 的浏览器中运行（好消息是现代浏览器都支持它）。

Installation

软件包需要 Node.js。 如果已安装，请运行：

$ npm install 3dd-widget

另外，这非常适合与 Webpack 等捆绑器一起使用，因此所有内容均已正确导入。

请记住，您必须将脚本导出为 AMD 模块才能使用 UWA 框架中的全局 widget 对象。 尽管图书馆对大多数事情都不需要它。

Example

import { Widget } from '3dd-widget';
import { SV3DSpace } from '3dd-widget/dist/services';

export default class extends Widget {
  constructor() {
    super({
      removeDefaultStyles: true
    });
    init();
  }

  async init() {
    widget.body.innerText = 'Hello World!';

    await Widget.fetchServices([SV3DSpace]);
    // If fail occured, next code will not run.

    // `await` keyword in `async` function returns resolved value from child Promise
    // Get projects as plain object:
    const projects = await SV3DSpace.get('/resources/v1/modeler/projects');
    console.log(projects);
  }
}

您还可以实现自定义类并从中扩展：

// VueWidget.ts
import { Widget, Service } from '3dd-widget';
import Vue from 'vue';

export default class VueWidget extends Widget {
  constructor(App: typeof Vue, services: typeof Service[]) {
    super({
      removeDefaultStyles: true
    });
    new Vue({
      el: '.moduleContent',
      render: h => h(App)
    });
    Widget.fetchServices(services);
  }
}

// ChildWidget/index.ts
import { SV3DSpace } from '3dd-widget';
import VueWidget from '../VueWidget';
import App from './App.vue';

export default class ChildWidget extends VueWidget {
  constructor() {
    super(App, [SV3DSpace]);
  }
}

Extras

3dd-widget 还提供 TypeScript 垫片，用于感知以 UWA、DS 和 RequireJS 加载器开头的模块插件不是 Node.js 模块的一部分，这实际上使 TypeScript 编译可以与这些插件一起工作。 当然，它涉及 3DDashboard 小部件框架内的使用。 我们只有几乎完全声明的 DS/WAFData/WAFData。

Build

$ npm run build
# or
$ npx tsc