Wyn Integration

Wyn 是葡萄城软件自主研发的嵌入式商业智能和报表软件，通过灵活的数据交互和探索分析能力，全面满足数据分析需求。产品提供自助式 BI 分析、数据可视化、报表统计、多源数据整合以及数据填报等功能，帮助企业用户发现更多的数据潜在价值，为管理者制定决策提供数据支撑。Wyn 具备完整的嵌入式分析能力，能够与其他软件深度集成，也可独立部署使用，快速提升数据展示和分析能力。

安装

安装最新版本:

npm install @grapecity-software/wyn-integration

导入

• Using the package name:

import { WynIntegration } from "@grapecity-software/wyn-integration";

• Use source code for this package

import { WynIntegration } from "@grapecity-software/wyn-integration/index";

使用

• 添加仪表板设计器到 <div id="wyn-root">

import { WynIntegration } from "@grapecity-software/wyn-integration";
WynIntegration.createDashboardDesigner({
    baseUrl: 'http://sample.com/',
    token: 'd3ecc751b250f8129e87f6813c13ee7ec0bf1f01198160f3bdddb6771c20fab9',
    defaults: {
        dashboardId: 'e9ab2113-32bd-403e-9f0a-eb2b0438f864',
        lng: 'en',
    },
}, '#wyn-root').then(ins => {
});

• 添加仪表板到 <div id="wyn-root">

import { WynIntegration } from "@grapecity-software/wyn-integration";
WynIntegration.createDashboardViewer({
    baseUrl: 'http://sample.com',
    token: 'd3ecc751b250f8129e87f6813c13ee7ec0bf1f01198160f3bdddb6771c20fab9',
    defaults: {
        dashboardId: '0bead052-d56a-4fac-897b-a2984c0208e3',
        theme: 'red',
    },
}, '#wyn-root').then(ins => {
});

• 添加轻量仪表板到 <div id="wyn-root">

import { WynIntegration } from "@grapecity-software/wyn-integration";
WynIntegration.createViewerLite(
{
    baseUrl: 'http://sample.com',
    token: 'd3ecc751b250f8129e87f6813c13ee7ec0bf1f01198160f3bdddb6771c20fab9',
    defaults: {
        dashboardId: '0bead052-d56a-4fac-897b-a2984c0208e3',
    },
}, '#wyn-root').then(ins => {
});

• 添加 AI 对话分析到 <div id="wyn-root">

import { WynIntegration } from "@grapecity-software/wyn-integration";
WynIntegration.createAIChatAnalysis({
    baseUrl: 'http://sample.com',
    token: 'd3ecc751b250f8129e87f6813c13ee7ec0bf1f01198160f3bdddb6771c20fab9',
    dataset: '660488d8-8d86-4cb5-94f7-f49fa88f5946',
    availableDatasets: ['660488d8-8d86-4cb5-94f7-f49fa88f5946'],
    datasetSelection: 'manual',
    analysisMode: 'standard',
    showDataPanel: true,
}, '#wyn-root').then(ins => {
});

• 通过 API 在仪表板查看器中绘制图表

import { WynIntegration } from "@grapecity-software/wyn-integration";

const chartBinding = {
    dataSourceType: 'embeddedData',
    dataBinding: {
        Category: ['Region'],
        Series: ['Carrier'],
        Values: [{ name: 'Sales', method: 'sum' }],
    },
    data: {
        Region: ['East', 'West', 'South'],
        Carrier: ['Express', 'Express', 'Parcel'],
        Sales: [120, 90, 70],
    },
};

WynIntegration.createDashboardViewer({
    baseUrl: 'http://sample.com',
    token: 'd3ecc751b250f8129e87f6813c13ee7ec0bf1f01198160f3bdddb6771c20fab9',
    defaults: {
        dashboardId: '0bead052-d56a-4fac-897b-a2984c0208e3',
    },
}, '#wyn-root').then(viewer => {
    viewer
        .addVisual('salesByRegion', 'column', 400, 300, 0, 0)
        .setDataBinding('salesByRegion', chartBinding)
        .update();
});

轻量仪表板查看器支持相同的 draw-by-API 工作流：

import { WynIntegration } from "@grapecity-software/wyn-integration";

WynIntegration.createViewerLite({
    baseUrl: 'http://sample.com',
    token: 'd3ecc751b250f8129e87f6813c13ee7ec0bf1f01198160f3bdddb6771c20fab9',
    defaults: {
        dashboardId: '0bead052-d56a-4fac-897b-a2984c0208e3',
    },
}, '#wyn-root').then(liteViewer => {
    liteViewer
        .addVisual('salesByRegion', 'column', 400, 300, 0, 0)
        .setDataBinding('salesByRegion', {
            dataSourceType: 'serverData',
            dataId: '660488d8-8d86-4cb5-94f7-f49fa88f5946',
            dataBinding: {
                Category: ['Region'],
                Series: ['Carrier'],
                Values: [{ name: 'Sales', method: 'sum' }],
            },
        })
        .update();
});

说明：

• visualName 是视觉对象的唯一标识，后续 setDataBinding 和 removeDataBinding 都通过它定位目标对象。
• visualType 可以是内置图表类型，例如 'column'，也可以是自定义可视化作者定义的名称。
• addVisual 还支持可选参数 scenarioJson，用于直接通过已有 scenario JSON 初始化视觉对象。
• addVisual、setDataBinding、removeDataBinding 都是惰性操作，调用 update() 后才会真正执行。
• update() 返回 Promise，如果需要等待批量操作完成，可以使用 await viewer.update()。
• 坐标和尺寸基于设计态坐标系，查看器会在实际挂载容器中按比例缩放最终布局。

• 添加3D场景设计器到 <div id="wyn-root">

import { WynIntegration } from "@grapecity-software/wyn-integration";
WynIntegration.createSceneDesigner({
    baseUrl: 'http://sample.com/',
    token: 'd3ecc751b250f8129e87f6813c13ee7ec0bf1f01198160f3bdddb6771c20fab9',
}, '#wyn-root').then(ins => {
});

• 添加3D场景到 <div id="wyn-root">

import { WynIntegration } from "@grapecity-software/wyn-integration";
WynIntegration.createSceneViewer({
    baseUrl: 'http://sample.com',
    token: 'd3ecc751b250f8129e87f6813c13ee7ec0bf1f01198160f3bdddb6771c20fab9',
    docId: 'ee799c0e-f4cf-4a13-a8c2-0330f9409841',
}, '#wyn-root').then(ins => {
});

• 添加报表设计器到 <div id="wyn-root">:

import { WynIntegration } from "@grapecity-software/wyn-integration";
WynIntegration.createReportDesigner({
    baseUrl: 'http://sample.com/',
    token: 'd3ecc751b250f8129e87f6813c13ee7ec0bf1f01198160f3bdddb6771c20fab9',
    reportId: '1a8bbca0-51a9-4eb3-b42e-ff1f7b0f4b75',
}, '#wyn-root').then((ins) => {
});

• 添加报表到 <div id="wyn-root">:

import { WynIntegration } from "@grapecity-software/wyn-integration";
WynIntegration.createReportViewer({
    baseUrl: 'http://sample.com',
    token: 'd3ecc751b250f8129e87f6813c13ee7ec0bf1f01198160f3bdddb6771c20fab9',
    reportId: '0ddb33e9-3211-4d96-9d25-ca34458dd8b9',
}, '#wyn-root').then(ins => {
});

• 添加 数据集/数据源/数据模型 的 设计器/视图 到 <div id="wyn-root">:

import { WynIntegration } from "@grapecity-software/wyn-integration";
WynIntegration.createDatasetDesigner({
    baseUrl: 'http://sample.com/',
    token: 'd3ecc751b250f8129e87f6813c13ee7ec0bf1f01198160f3bdddb6771c20fab9',
    theme: 'default',
    language: 'zh',
    siteTitle: 'sds',
    type: 'dashboard',
}, '#wyn-root').then(ins => {
});
WynIntegration.createDatasetViewer({
    baseUrl: 'http://sample.com/',
    token: 'd3ecc751b250f8129e87f6813c13ee7ec0bf1f01198160f3bdddb6771c20fab9',
    theme: 'default',
    language: 'zh',
    siteTitle: 'sds',
    documentId: '840fac96-abac-4276-8fb5-051eb07c95df',
}, '#wyn-root').then(ins => {
});
WynIntegration.createDatasourceDesigner({
    baseUrl: 'http://sample.com/',
    token: 'd3ecc751b250f8129e87f6813c13ee7ec0bf1f01198160f3bdddb6771c20fab9',
    theme: 'default',
    language: 'zh',
    siteTitle: 'sds',
}, '#wyn-root').then(ins => {
});
WynIntegration.createDatasourceViewer({
    baseUrl: 'http://sample.com',
    token: 'd3ecc751b250f8129e87f6813c13ee7ec0bf1f01198160f3bdddb6771c20fab9',
    theme: 'default',
    language: 'zh',
    siteTitle: 'sds',
    documentId: '8ce06a89-85f9-4756-b052-fb3d7c832899',
}, '#wyn-root').then(ins => {
});
WynIntegration.createDirectQueryModelDesigner({
    baseUrl: 'http://sample.com',
    token: 'd3ecc751b250f8129e87f6813c13ee7ec0bf1f01198160f3bdddb6771c20fab9',
    theme: 'default',
    language: 'zh',
    siteTitle: 'sds',
}, '#wyn-root').then(ins => {
});
WynIntegration.createCachedModelDesigner({
    baseUrl: 'http://sample.com',
    token: 'd3ecc751b250f8129e87f6813c13ee7ec0bf1f01198160f3bdddb6771c20fab9',
    theme: 'default',
    language: 'zh',
    siteTitle: 'sds',
}, '#wyn-root').then(ins => {
});
WynIntegration.createAnalysisViewer({
    baseUrl: 'http://sample.com',
    token: 'd3ecc751b250f8129e87f6813c13ee7ec0bf1f01198160f3bdddb6771c20fab9',
    theme: 'default',
    language: 'zh',
    siteTitle: 'sds',
    documentId: '8ce06a89-85f9-4756-b052-fb3d7c832899',
}, '#wyn-root').then(ins => {
});

• 添加 推送数据集/流式数据集 设计器到 <div id="wyn-root">:

WynIntegration.createPushDatasetDesigner({
    baseUrl: 'http://sample.com/',
    token: 'd3ecc751b250f8129e87f6813c13ee7ec0bf1f01198160f3bdddb6771c20fab9',
    theme: 'default',
    language: 'zh',
    siteTitle: 'sds',
    type: 'dashboard',
}, '#wyn-root').then(ins => {
});

WynIntegration.createStreamingDatasetDesigner({
    baseUrl: 'http://sample.com/',
    token: 'd3ecc751b250f8129e87f6813c13ee7ec0bf1f01198160f3bdddb6771c20fab9',
    theme: 'default',
    language: 'zh',
    siteTitle: 'sds',
    type: 'dashboard',
}, '#wyn-root').then(ins => {
});

• 添加原生数据集设计器到 <div id="wyn-root">:

WynIntegration.createNativeQueryDatasetDesigner({
    baseUrl: 'http://sample.com/',
    token: 'd3ecc751b250f8129e87f6813c13ee7ec0bf1f01198160f3bdddb6771c20fab9',
    theme: 'default',
    language: 'zh',
    siteTitle: 'sds',
}, '#wyn-root').then(ins => {
});

• 添加直连数据集设计器到 <div id="wyn-root">:

WynIntegration.createDirectQueryDatasetDesigner({
    baseUrl: 'http://sample.com/',
    token: 'd3ecc751b250f8129e87f6813c13ee7ec0bf1f01198160f3bdddb6771c20fab9',
    theme: 'default',
    language: 'zh',
    siteTitle: 'sds',
}, '#wyn-root').then(ins => {
});

• 添加活页夹设计器到 <div id="wyn-root">:

WynIntegration.createDocumentBinderDesigner({
    baseUrl: 'http://sample.com/',
    token: 'd3ecc751b250f8129e87f6813c13ee7ec0bf1f01198160f3bdddb6771c20fab9',
    theme: 'default',
    language: 'zh',
    siteTitle: 'sds',
}, '#wyn-root').then(ins => {
});

• 添加活页夹到 <div id="wyn-root">:

WynIntegration.createDocumentBinderViewer({
    baseUrl: 'http://sample.com/',
    token: 'd3ecc751b250f8129e87f6813c13ee7ec0bf1f01198160f3bdddb6771c20fab9',
    theme: 'default',
    language: 'zh',
    siteTitle: 'sds',
    documentId: '8ce06a89-85f9-4756-b052-fb3d7c832899',
}, '#wyn-root').then(ins => {
});

• 添加文档门户/管理门门户到 <div id="wyn-root">:

WynIntegration.createDocumentPortal({
    baseUrl: 'http://sample.com/',
    token: 'd3ecc751b250f8129e87f6813c13ee7ec0bf1f01198160f3bdddb6771c20fab9',
    theme: 'default',
    language: 'zh',
    siteTitle: 'sds',
}, '#wyn-root').then(ins => {
});

WynIntegration.createAdminPortal({
    baseUrl: 'http://sample.com/',
    token: 'd3ecc751b250f8129e87f6813c13ee7ec0bf1f01198160f3bdddb6771c20fab9',
    theme: 'default',
    language: 'zh',
    siteTitle: 'sds',
}, '#wyn-root').then(ins => {
});

API

createDashboardDesigner(dashboardDesignerOptions)

• dashboardDesignerOptions: dashboardOptions为创建的仪表板设计器或仪表板查看器指定选项/属性，如下所述。常用选项：
  • baseUrl: string, 必需; Wyn服务器的url。如果您的集成和wyn服务器不在同一个站点上，您应该提供您的wyn服务器主机地址。
  • token: string, 必需; 用来访问服务器的密钥。 可以在管理站点生成。
  • container: DOM, 必需; 用来呈现仪表板的DOM元素。
  • defaults: 可选; 初始化仪表板的默认选项
    • clickAction: string, 可选; 仪表板点击时的行为。
    • containerFilterScope: string, 可选; 仪表板中的过滤器的生效范围。
    • contextMenuActions: string, 可选; 右键点击仪表板时菜单的内容。
    • dashboardId: string, 可选; 仪表板的id，不填为新建，id生效为编辑。
    • datasetId: string, 可选; 为设计器默认选择一个数据集，该数据集的id。
    • documentThemeId: string, 可选; 仪表板主题id。
    • dp: string, 可选; 仪表板参数。
    • enableDeveloperMode: boolean, 可选; 是否允许启动开发者模式来调试自定义可视化组件。
    • lng: string, 可选; 设置界面的语言, 可选: 'zh', 'en', 'en-gb', 'zh-tw', 'pl'。
    • notificationTime: number, 可选; 指定仪表板设计器通知栏的默认停留时长。
    • templateId: string, 可选; 以一个模板来创建仪表板，模板的id。
    • theme: string, 可选; 设计器的主题。
  • features: 可选; 初始化设计器的高级选项。
    • actionbarItems: string[], 可选; 指定仪表板设计器的可用菜单项。
    • componentCategories: string[], 可选; 指定仪表板设计器的可用组件类别。
    • disableAnimation: boolean, 可选; 是否禁用仪表板设计器动画。
    • disableChangeDataset: boolean, 可选; 是否禁用仪表板设计器修改默认数据集。
    • showCloseButton: boolean, 可选; 是否显示关闭按钮。
    • showDataBindingPanel: boolean, 可选; 是否显示数据绑定面板。
    • showHelpButton: boolean, 可选; 是否显示帮助按钮。
    • showInspector: boolean, 可选; 是否显示属性面板。
    • showInspectorWhenOpen: boolean, 可选; 是否在打开仪表板设计器时显示属性面板。
    • showMobileDesigner: boolean, 可选; 是否显示移动端设计器按钮。
    • showPanelWhenOpen: boolean, 可选; 是否在打开仪表板设计器时显示组件工具箱面板。
    • showWizard: boolean, 可选; 是否在打开仪表板设计器时显示智能组件添加向导。
    • toolbar: string, 可选; 控制是否显示仪表板查看器的工具栏，默认是'show', 支持两种值: 'hide', 'show'.
  • onMount: () => void, 可选; 注册一个回调函数，在仪表板高级查看器挂载完成后调用。
  • onClose: () => void, 可选; 注册一个回调函数，在仪表板高级查看器关闭时调用。
  • onSave: (docName: string, id: string) => void, 可选; 注册一个回调函数，在仪表板设计器保存时调用。
  • onLoaded: (docName: string) => void, 可选; 注册一个回调函数，在仪表板设计器加载完成后调用。
  • onError: (errorInfo: object) => void, 可选; 注册一个回调函数，在捕获到仪表板设计器的错误时调用。

createDashboardViewer(dashboardViewerOptions)

• dashboardViewerOptions: dashboardOptions为创建的仪表板设计器或仪表板查看器指定选项/属性，如下所述。常用选项：
  • baseUrl: string, 必需; Wyn服务器的url。如果您的集成和wyn服务器不在同一个站点上，您应该提供您的wyn服务器主机地址。
  • token: string, 必需; 用来访问服务器的密钥。 可以在管理站点生成。
  • container: DOM, 必需; 指定挂载仪表板高级查看器实例的DOM元素。
  • defaults: 可选; 用于初始化仪表板高级查看器的默认选项。
    • dashboardId: string, 必需; 指定仪表板高级查看器打开的文档。
    • clickAction: string, 可选; 指定仪表板高级查看器的鼠标左键选项。
    • containerFilterScope: string, 可选; 指定仪表板高级查看器的容器组件内部切片器的过滤范围。
    • contextMenuActions: string, 可选; 指定仪表板高级查看器的鼠标右键选项。
    • documentThemeId: string, 可选; 指定仪表板高级查看器默认使用的文档主题。
    • dp: string, 可选; 指定仪表板高级查看器默认的参数值。
    • hideErrors: boolean, 可选; 是否隐藏仪表板高级查看器的错误通知。
    • lng: string, 可选; 指定仪表板高级查看器的语言, 可选: 'zh', 'en', 'en-gb', 'zh-tw', 'pl'。
    • notificationTime: number, 可选; 指定仪表板高级查看器通知栏的默认停留时长。
    • pageNumber: number, 可选; 指定仪表版查看器的默认打开页码。
    • scenario: string, 可选; 用于在单个可视化组件集成时指定组件的名称。
    • size: string, 可选; 指定仪表板高级查看器的显示模式， 可选: 'fitheight' , 'fittoheight' , 'fitwidth' , 'fittowidth' , 'fitscreen' , 'fittoscreen' , 'auto'。
    • showScenarioTitle: boolean, 可选; 用于在单个可视化组件集成时指定是否显示组件的标题。
    • theme: string, 可选; 指定仪表板高级查看器的默认主题。
  • features: 可选; 用于打开或关闭仪表板高级查看器特性的功能选项。
    • actionbarItems: string[], 可选; 指定仪表板高级查看器的可用菜单项。
    • disableAnimation: boolean, 可选; 是否禁用仪表板高级查看器动画。
    • disableAutoScroll: boolean, 可选; 是否禁用仪表板高级查看器中组件的自动滚动功能。
    • disableAutoSwitchPage: boolean, 可选; 是否禁用仪表板高级查看器的页面自动切换功能。
    • hideToolbarActions: string[], 可选; 指定仪表板高级查看器工具栏的隐藏菜单项。
  • onMount: () => void, 可选; 注册一个回调函数，在仪表板高级查看器挂载完成后调用。
  • onClose: () => void, 可选; 注册一个回调函数，在仪表板高级查看器关闭时调用。
  • onRendered: (docName: string) => void, 可选; 注册一个回调函数，在仪表板高级查看器渲染完成后调用。
  • onLoaded: (docName: string) => void, 可选; 注册一个回调函数，在仪表板高级查看器加载完成后调用。
  • onError: (errorInfo: object) => void, 可选; 注册一个回调函数，在捕获到仪表板高级查看器的错误时调用。

Dashboard Viewer 实例方法

createDashboardViewer 返回的实例支持以下方法：

• destroy()：释放仪表板高级查看器实例资源。
• executeCommand(option)：执行下钻、切页、场景显隐等仪表板命令。
• requestFullScreen()：请求进入全屏模式。
• getDatasets()：返回当前仪表板使用的数据集列表 Promise。
• setParameterValue(parameters)：设置当前仪表板的参数值。
• addVisual(visualName, visualType, width, height, left, top, scenarioJson?)：通过 API 延迟添加视觉对象。
• setDataBinding(visualName, dataBindingInfo)：为视觉对象延迟设置服务端数据或嵌入数据绑定。
• removeDataBinding(visualName)：延迟移除视觉对象的数据绑定。
• update()：返回 Promise，并应用所有待执行的 draw-by-API 变更。

createViewerLite(dashboardLiteViewerOptions)

• dashboardLiteViewerOptions: dashboardOptions为创建的仪表板查看器指定选项/属性，如下所述。常用选项：
  • baseUrl: string, 必需; Wyn服务器的url。如果您的集成和wyn服务器不在同一个站点上，您应该提供您的wyn服务器主机地址。
  • token: string, 必需; 用来访问服务器的密钥。 可以在管理站点生成。
  • container: DOM, 必需; 指定挂载仪表板标准查看器实例的DOM元素。
  • defaults: 可选; 用于初始化仪表板标准查看器的默认选项。
    • dashboardId: string, 必需; 指定仪表板标准查看器打开的文档。
    • clickAction: string, 可选; 指定仪表板标准查看器的鼠标左键选项。
    • containerFilterScope: string, 可选; 指定仪表板标准查看器的容器组件内部切片器的过滤范围。
    • contextMenuActions: string, 可选; 指定仪表板标准查看器的鼠标右键选项。
    • documentThemeId: string, 可选; 指定仪表板标准查看器默认使用的文档主题。
    • dp: string, 可选; 指定仪表板标准查看器默认的参数值。
    • hideErrors: boolean, 可选; 是否隐藏仪表板标准查看器的错误通知。
    • lng: string, 可选; 指定仪表板标准查看器的语言, 可选: 'zh', 'en', 'en-gb', 'zh-tw', 'pl'。
    • notificationTime: number, 可选; 指定仪表板标准查看器通知栏的默认停留时长。
    • pageNumber: number, 可选; 指定仪表版标准查看器的默认打开页码。
    • scenario: string, 可选; 用于在单个可视化组件集成时指定组件的名称。
    • size: string, 可选; Set the display mode of the dashboard in the viewer, the acceptable Values: 'fitheight' , 'fittoheight' , 'fitwidth' , 'fittowidth' , 'fitscreen' , 'fittoscreen' , 'auto'.
    • showScenarioTitle: boolean, 可选; 用于在单个可视化组件集成时指定是否显示组件的标题。
    • theme: string, 可选; 指定仪表板标准查看器的默认主题。
  • features: 可选; 用于打开或关闭仪表板标准查看器特性的功能选项。
    • actionbarItems: string[], 可选; 指定仪表板标准查看器的可用菜单项。
    • disableAnimation: boolean, 可选; 是否禁用仪表板标准查看器动画。
    • disableAutoScroll: boolean, 可选; 是否禁用仪表板标准查看器中组件的自动滚动功能。
    • disableAutoSwitchPage: boolean, 可选; 是否禁用仪表板标准查看器的页面自动切换功能。

Dashboard Lite Viewer 实例方法

createViewerLite 返回的实例支持以下方法：

• destroy()：释放轻量仪表板查看器实例资源。
• executeCommand(option)：执行下钻、切页、场景显隐等仪表板命令。
• requestFullScreen()：请求进入全屏模式。
• getDatasets()：返回当前仪表板使用的数据集列表 Promise。
• setParameterValue(parameters)：设置当前仪表板的参数值。
• getUIDashboard()：返回底层 UIDashboard 实例。
• addVisual(visualName, visualType, width, height, left, top, scenarioJson?)：通过 API 延迟添加视觉对象。
• setDataBinding(visualName, dataBindingInfo)：为视觉对象延迟设置服务端数据或嵌入数据绑定。
• removeDataBinding(visualName)：延迟移除视觉对象的数据绑定。
• update()：返回 Promise，并应用所有待执行的 draw-by-API 变更。

createAIChatAnalysis(aiChatAnalysisOptions, selector)

• aiChatAnalysisOptions: aiChatAnalysisOptions为创建的 AI 对话分析实例指定选项/属性，如下所述。常用选项：
  • baseUrl: string, 必需; Wyn服务器的url。如果您的集成和wyn服务器不在同一个站点上，您应该提供您的wyn服务器主机地址。
  • token: string, 必需; 用来访问服务器的密钥。可以在管理站点生成。
  • version: string, 可选; Wyn Enterprise服务器版本号。当无法自动解析仪表板资源版本时作为备用值。
  • container: DOM, 可选; 指定挂载 AI 对话分析实例的备用DOM元素。优先使用 selector 参数。
  • tokenKey: string, 可选; 指定查询参数中的令牌键名。未指定时默认使用 'token'。
  • lng: string, 可选; 指定界面语言。
  • theme: string, 可选; 指定界面主题。
  • dataset: string, 可选; 指定默认数据集ID。
  • availableDatasets: string[], 可选; 指定 AI 对话分析可用的数据集ID列表。
  • datasetSelection: 'manual' | 'auto', 可选; 控制由用户手动选择数据集，还是允许 AI 自动选择数据集。
  • insights: boolean, 可选; 控制是否启用洞察相关界面和请求。
  • advancedAnalysis: boolean, 可选; 控制是否启用高级分析。
  • suggestedQuestions: boolean, 可选; 控制是否在回答完成后显示推荐问题。
  • analysisMode: 'standard' | 'advanced', 可选; 控制新会话默认使用的分析模式。
  • showDataPanel: boolean, 可选; 控制是否显示数据面板。
  • setupGuide: 可选; AI 对话分析需要配置时显示的引导内容。
    • title: string, 可选; 主标题。
    • subtitle: string, 可选; 副标题。
    • description: string, 可选; 不可用状态下显示的描述文本。
    • actionText: string, 可选; 操作按钮文本。
    • actionUrl: string, 可选; 操作按钮打开的URL。
  • onError: (error: unknown) => void, 可选; 注册一个回调函数，在创建或初始化 AI 对话分析失败时调用。
• selector: 作为容器的DOM的选择器。

AI 对话分析实例方法

createAIChatAnalysis返回的实例提供以下方法：

• destroy(): 释放 AI 对话分析实例的资源。

createSceneDesigner(sceneDesignerOptions)

• sceneDesignerOptions: sceneDesignerOptions为创建的3D场景设计器指定选项/属性，如下所述。常用选项：
  • baseUrl: string, 必需; Wyn服务器的url。如果您的集成和wyn服务器不在同一个站点上，您应该提供您的wyn服务器主机地址。
  • token: string, 必需; 用来访问服务器的密钥。 可以在管理站点生成。
  • container: DOM, 必需; 指定挂载3D场景设计器实例的DOM元素。
  • onMount: () => void, 可选; 注册一个回调函数，在3D场景设计器挂载完成后调用。
  • onClose: () => void, 可选; 注册一个回调函数，在3D场景设计器关闭时调用。
  • onSave: (docName: string, id: string) => void, 可选; 注册一个回调函数，在3D场景设计器保存时调用。
  • onLoaded: (docName: string) => void, 可选; 注册一个回调函数，在3D场景设计器加载完成后调用。
  • onError: (errorInfo: object) => void, 可选; 注册一个回调函数，在捕获到3D场景设计器的错误时调用。

createSceneViewer(sceneViewerOptions)

• sceneViewerOptions: sceneViewerOptions为创建的3D场景查看器指定选项/属性，如下所述。常用选项：
  • baseUrl: string, 必需; Wyn服务器的url。如果您的集成和wyn服务器不在同一个站点上，您应该提供您的wyn服务器主机地址。
  • token: string, 必需; 用来访问服务器的密钥。 可以在管理站点生成。
  • container: DOM, 必需; 指定挂载3D场景查看器实例的DOM元素。
  • onMount: () => void, 可选; 注册一个回调函数，在3D场景查看器挂载完成后调用。
  • onClose: () => void, 可选; 注册一个回调函数，在3D场景查看器关闭时调用。
  • onRendered: (docName: string) => void, 可选; 注册一个回调函数，在3D场景高级查看器渲染完成后调用。
  • onLoaded: (docName: string) => void, 可选; 注册一个回调函数，在3D场景高级查看器加载完成后调用。
  • onError: (errorInfo: object) => void, 可选; 注册一个回调函数，在捕获到3D场景高级查看器的错误时调用。

createDatasetDesigner(options, selector)

• options: 数据集设计器的初始化参数配置。
  • backendServer: object, 必需; Wyn服务器相关信息。
    • url: string, 必需; Wyn 门户地址。
    • token: string, 必需; Wyn Api 的授权令牌。
  • siteTitle: string, 可选; 浏览器 tab页 标题。
  • parentSelector: HTMLElement, 可选; 渲染 设计器/查看器 所使用的 dom 对象。
  • theme: string, 可选; 设计器/查看器 主题。
  • language: string, 可选; 设计器/查看器 语言, 可选: 'zh', 'en', 'en-gb', 'zh-tw', 'pl'。
  • showCloseButton: string, 可选; 控制是否显示关闭按钮的标志位。
  • documentId: string | null, 可选; 数据集 id。
  • type: string | null, 可选; 数据集使用方式类型, 可选: 'report', 'dashboard'。
  • events: object | null, 可选; 数据集相关事件。
    • afterDocumentSave: void function | null, 可选; 保存事件后的回调函数。
      • success: boolean, 入参. 添加数据集是否成功。
      • documentId: string | null. 入参; 数据集id。
• selector: 作为容器的DOM的选择器。

createDatasetViewer(options, selector)

• options: 数据集查看器的初始化参数配置。
  • backendServer: object, 必需; Wyn服务器相关信息。
    • url: string, 必需; Wyn 门户地址。
    • token: string, 必需; Wyn Api 的授权令牌。
  • siteTitle: string, 可选; 浏览器 tab页 标题。
  • parentSelector: HTMLElement, 可选; 渲染 设计器/查看器 所使用的 dom 对象。
  • theme: string, 可选; 设计器/查看器 主题。
  • language: string, 可选; 设计器/查看器 语言, 可选: 'zh', 'en', 'en-gb', 'zh-tw', 'pl'。
  • documentId: string, 必需; 数据集 id。
• selector: 作为容器的DOM的选择器。

createDatasourceDesigner(options, selector)

• options: 数据源设计器的初始化参数配置。
  • backendServer: object, 必需; Wyn服务器相关信息。
    • url: string, 必需; Wyn 门户地址。
    • token: string, 必需; Wyn Api 的授权令牌。
  • siteTitle: string, 可选; 浏览器 tab页 标题。
  • parentSelector: HTMLElement, 可选; 渲染 设计器/查看器 所使用的 dom 对象。
  • theme: string, 可选; 设计器/查看器 主题。
  • language: string, 可选; 设计器/查看器 语言, 可选: 'zh', 'en', 'en-gb', 'zh-tw', 'pl'。
  • showCloseButton: string, 可选; 控制是否显示关闭按钮的标志位。
  • documentId: string | null, 可选; 数据源 id。
  • inDataset: boolean | null, 可选; 是否在数据集设计器页面中打开数据源设计器的标志位。
  • afterClose: void function | null, 可选; 关闭设计器后的回调函数。
  • events: object | null, 可选; 数据源相关事件。
    • afterDocumentSave: void function | null, 可选; 保存事件后的回调函数。
      • success: boolean, 入参. 添加数据源是否成功。
      • documentId: string | null. 入参; 数据源id。
• selector: 作为容器的DOM的选择器。

createDatasourceViewer(options, selector)

• options: 数据源查看器的初始化参数配置。
  • backendServer: object, 必需; Wyn服务器相关信息。
    • url: string, 必需; Wyn 门户地址。
    • token: string, 必需; Wyn Api 的授权令牌。
  • siteTitle: string, 可选; 浏览器 tab页 标题。
  • parentSelector: HTMLElement, 可选; 渲染 设计器/查看器 所使用的 dom 对象。
  • theme: string, 可选; 设计器/查看器 主题。
  • language: string, 可选; 设计器/查看器 语言, 可选: 'zh', 'en', 'en-gb', 'zh-tw', 'pl'。
  • documentId: string, 必需; 数据源 id。
• selector: 作为容器的DOM的选择器。

createDirectQueryModelDesigner(options, selector)

• options: 直连模型设计器的初始化参数配置。
  • backendServer: object, 必需; Wyn服务器相关信息。
    • url: string, 必需; Wyn 门户地址。
    • token: string, 必需; Wyn Api 的授权令牌。
  • siteTitle: string, 可选; 浏览器 tab页 标题。
  • parentSelector: HTMLElement, 可选; 渲染 设计器/查看器 所使用的 dom 对象。
  • theme: string, 可选; 设计器/查看器 主题。
  • language: string, 可选; 设计器/查看器 语言, 可选: 'zh', 'en', 'en-gb', 'zh-tw', 'pl'。
  • showCloseButton: string, 可选; 控制是否显示 关闭按钮 的标志位。
  • documentId: string | null, 可选; 直连模型id。
  • events: object | null, 可选; 直连模型相关事件。
    • afterDocumentSave: void function | null, 可选; 保存事件后的回调函数。
      • success: boolean, 入参. 添加直连模型是否成功。
      • documentId: string | null. 入参; 直连模型id。
• selector: 作为容器的DOM的选择器。

createCachedModelDesigner(options, selector)

• options: 缓存模型设计器的初始化参数配置。
  • backendServer: object, 必需; Wyn服务器相关信息。
    • url: string, 必需; Wyn 门户地址。
    • token: string, 必需; Wyn Api 的授权令牌。
  • siteTitle: string, 可选; 浏览器 tab页 标题。
  • parentSelector: HTMLElement, 可选; 渲染 设计器/查看器 所使用的 dom 对象。
  • theme: string, 可选; 设计器/查看器 主题。
  • language: string, 可选; 设计器/查看器 语言, 可选: 'zh', 'en', 'en-gb', 'zh-tw', 'pl'。
  • showCloseButton: string, 可选; 控制是否显示 关闭按钮 的标志位。
  • documentId: string | null, 可选; 缓存模型id。
  • events: object | null, 可选; 缓存模型相关事件。
    • afterDocumentSave: void function | null, 可选; 保存事件后的回调函数。
      • success: boolean, 入参. 添加缓存模型是否成功。
      • documentId: string | null. 入参; 缓存模型id。
• selector: 作为容器的DOM的选择器。

createAnalysisViewer(options, selector)

• options: 直连（或缓存）模型查看器初始化参数配置。
  • backendServer: object, 必需; Wyn服务器相关信息。
    • url: string, 必需; Wyn 门户地址。
    • token: string, 必需; Wyn Api 的授权令牌。
  • siteTitle: string, 可选; 浏览器 tab页 标题。
  • parentSelector: HTMLElement, 可选; 渲染 设计器/查看器 所使用的 dom 对象。
  • theme: string, 可选; 设计器/查看器 主题。
  • language: string, 可选; 设计器/查看器 语言, 可选: 'zh', 'en', 'en-gb', 'zh-tw', 'pl'。
  • documentId: string, 必需; 直连（缓存）模型id。
• selector: DOM 元素选择器。

createPushDatasetDesigner(options, selector)

• options: 推送数据集设计器的初始化参数配置。
  • backendServer: object, 必需; Wyn服务器相关信息。
    • url: string, 必需; Wyn 门户地址。
    • token: string, 必需; Wyn Api 的授权令牌。
  • siteTitle: string, 可选; 浏览器 tab页 标题。
  • parentSelector: HTMLElement, 可选; 渲染 设计器/查看器 所使用的 dom 对象。
  • theme: string, 可选; 设计器/查看器 主题。
  • language: string, 可选; 设计器/查看器 语言, 可选: 'zh', 'en', 'en-gb', 'zh-tw', 'pl'。
  • showCloseButton: string, 可选; 控制是否显示 关闭按钮 的标志位。
  • documentId: string | null, 可选; 推送数据集id。
  • type: string | null, 可选; 数据集使用方式类型, 可选: 'report', 'dashboard'。
  • events: object | null, 可选; 推送数据集相关事件。
    • afterDocumentSave: void function | null, 可选; 保存事件后的回调函数。
      • success: boolean, 入参. 添加推送数据集是否成功。
      • documentId: string | null. 入参; 推送数据集id。
• selector: 作为容器的DOM的选择器。

createNativeQueryDatasetDesigner(options, selector)

• options: 原生数据集设计器的初始化参数配置。
  • backendServer: object, 必需; Wyn服务器相关信息。
    • url: string, 必需; Wyn 门户地址。
    • token: string, 必需; Wyn Api 的授权令牌。
  • siteTitle: string, 可选; 浏览器 tab页 标题。
  • parentSelector: HTMLElement, 可选; 渲染 设计器/查看器 所使用的 dom 对象。
  • theme: string, 可选; 设计器/查看器 主题。
  • language: string, 可选; 设计器/查看器 语言, 可选: 'zh', 'en', 'en-gb', 'zh-tw', 'pl'。
  • showCloseButton: string, 可选; 控制是否显示 关闭按钮 的标志位。
  • documentId: string | null, 可选; 原生数据集id。
  • type: string | null, 可选; 数据集使用方式类型, 可选: 'report', 'dashboard'。
  • events: object | null, 可选; 原生数据集相关事件。
    • afterDocumentSave: void function | null, 可选; 保存事件后的回调函数。
      • success: boolean, 入参. 添加原生数据集是否成功。
      • documentId: string | null. 入参; 原生数据集id。
• selector: 作为容器的DOM的选择器。

createDirectQueryDatasetDesigner(options, selector)

• options: 直连数据集设计器的初始化参数配置。
  • backendServer: object, 必需; Wyn服务器相关信息。
    • url: string, 必需; Wyn 门户地址。
    • token: string, 必需; Wyn Api 的授权令牌。
  • siteTitle: string, 可选; 浏览器 tab页 标题。
  • parentSelector: HTMLElement, 可选; 渲染 设计器/查看器 所使用的 dom 对象。
  • theme: string, 可选; 设计器/查看器 主题。
  • language: string, 可选; 设计器/查看器 语言, 可选: 'zh', 'en', 'en-gb', 'zh-tw', 'pl'。
  • showCloseButton: string, 可选; 控制是否显示 关闭按钮 的标志位。
  • documentId: string | null, 可选; 直连数据集id。
  • type: string | null, 可选; 数据集使用方式类型, 可选: 'report', 'dashboard'。
  • events: object | null, 可选; 直连数据集相关事件。
    • afterDocumentSave: void function | null, 可选; 保存事件后的回调函数。
      • success: boolean, 入参. 添加直连数据集是否成功。
      • documentId: string | null. 入参; 直连数据集id。
• selector: 作为容器的DOM的选择器。

createStreamingDatasetDesigner(options, selector)

• options: 流式数据集设计器的初始化参数配置。
  • backendServer: object, 必需; Wyn服务器相关信息。
    • url: string, 必需; Wyn 门户地址。
    • token: string, 必需; Wyn Api 的授权令牌。
  • siteTitle: string, 可选; 浏览器 tab页 标题。
  • parentSelector: HTMLElement, 可选; 渲染 设计器/查看器 所使用的 dom 对象。
  • theme: string, 可选; 设计器/查看器 主题。
  • language: string, 可选; 设计器/查看器 语言, 可选: 'zh', 'en', 'en-gb', 'zh-tw', 'pl'。
  • showCloseButton: string, 可选; 控制是否显示 关闭按钮 的标志位。
  • documentId: string | null, 可选; 流式数据集id。
  • type: string | null, 可选; 数据集使用方式类型, 可选: 'report', 'dashboard'。
  • events: object | null, 可选; 流式数据集相关事件。
    • afterDocumentSave: void function | null, 可选; 保存事件后的回调函数。
      • success: boolean, 入参. 添加流式数据集是否成功。
      • documentId: string | null. 入参; 流式数据集id。
• selector: 作为容器的DOM的选择器。

createDocumentBinderDesigner(options, selector)

• options: 活页夹设计器的初始化参数配置。
  • backendServer: object, 必需; Wyn服务器相关信息。
    • url: string, 必需; Wyn 门户地址。
    • token: string, 必需; Wyn Api 的授权令牌。
  • siteTitle: string, 可选; 浏览器 tab页 标题。
  • parentSelector: HTMLElement, 可选; 渲染 设计器/查看器 所使用的 dom 对象。
  • theme: string, 可选; 设计器/查看器 主题。
  • language: string, 可选; 设计器/查看器 语言, 可选: 'zh', 'en', 'en-gb', 'zh-tw', 'pl'。
  • showCloseButton: string, 可选; 控制是否显示 关闭按钮 的标志位。
  • documentId: string | null, 可选; 活页夹id。
• selector: 作为容器的DOM的选择器。

createDocumentBinderViewer(options, selector)

• options: 活页夹的初始化参数配置。
  • backendServer: object, 必需; Wyn服务器相关信息。
    • url: string, 必需; Wyn 门户地址。
    • token: string, 必需; Wyn Api 的授权令牌。
  • siteTitle: string, 可选; 浏览器 tab页 标题。
  • parentSelector: HTMLElement, 可选; 渲染 设计器/查看器 所使用的 dom 对象。
  • theme: string, 可选; 设计器/查看器 主题。
  • language: string, 可选; 设计器/查看器 语言, 可选: 'zh', 'en', 'en-gb', 'zh-tw', 'pl'。
  • showCloseButton: string, 可选; 控制是否显示 关闭按钮 的标志位。
  • documentId: string | null, 可选; 活页夹id。
• selector: 作为容器的DOM的选择器。

createReportDesigner(options, selector)

函数的返回类型为Promise<DesignerApi>。详见https://wyn.grapecity.com/docs/dev-docs/Report-Designer-API#designer-api。

• options: 报表设计器的初始化参数配置。

  • baseUrl: string, 必需; Wyn服务器的url。如果您的集成和wyn服务器不在同一个站点上，您应该提供您的wyn服务器主机地址。
  • token: string, 必需; 用来访问服务器的密钥。 可以在管理站点生成。
  • language: string, 可选; 设计器/查看器 语言, 可选: 'zh', 'en', 'en-gb', 'zh-tw', 'pl'。
  • reportId: string | null, 可选; 报表id。
  • reportVersion: number | null, 可选; 要打开的报表的版本,不传默认为最新版本。仅reportId被定义时生效。
  • isReportTemplate: boolean, 可选; 当前文档是报表还是模板。 仅reportId 被定义时生效。
  • productTitle: string, 可选; 指定设计器关于我们对话框中显示的产品标题。
  • productVersion: string, 可选; 指定设计器关于我们对话框中显示的产品版本。仅在productTitle 被定义时生效。
  • applicationTitle: string, 可选; 设计器应用标题。
  • reportViewer: object, 可选; { disabled?: boolean; options?: object } options 对象包含的全部属性如下 https://wyn.grapecity.com/docs/dev-docs/Report-Viewer-API#initvieweroptions 期望 element, portalUrl, referenceToken, locale. 如果 disabled 为 true, 设计器不能预览报表。
  • 其余支持的可选配置项参考 https://wyn.grapecity.com/docs/dev-docs/Report-Designer-API#designer-options (期望 portalUrl, referenceToken, locale, openViewer, reportInfo, aboutInfo)。

• selector: 作为容器的DOM的选择器。

createReportViewer(options, selector)

函数的返回类型为Promise<Viewer>。详见https://wyn.grapecity.com/docs/dev-docs/Report-Viewer-API#viewer。

• options: 报表的初始化参数配置。

  • baseUrl: string, 必需; Wyn服务器的url。如果您的集成和wyn服务器不在同一个站点上，您应该提供您的wyn服务器主机地址。
  • token: string, 必需; 用来访问服务器的密钥。 可以在管理站点生成。
  • language: string, 可选; 设计器/查看器 语言, 可选: 'zh', 'en', 'en-gb', 'zh-tw', 'pl'。
  • reportId: string | null, 可选; 报表id。
  • reportParameters: array, 可选; 报表参数,格式为{ name: string; values: any[] }的数据形式.
  • 其他支持的属性参考 https://wyn.grapecity.com/docs/dev-docs/Report-Viewer-API#initvieweroptions (期望 element, portalUrl, referenceToken, locale).

• selector: 作为容器的DOM的选择器。

createDocumentPortal(options, selector)

• options: 文档门户的初始化参数配置。
  • backendServer: object, 必需; Wyn服务器相关信息。
    • url: string, 必需; Wyn 门户地址。
    • token: string, 必需; Wyn Api 的授权令牌。
  • siteTitle: string, 可选; 浏览器 tab页 标题。
  • theme: string, 可选; 门户主题。
  • language: string, 可选; 门户语言, 可选: 'zh', 'en', 'en-gb', 'zh-tw', 'pl'。
  • hideAvatarMenu: boolean, 可选; 是否隐藏头像菜单。
  • hideNav: boolean, 可选; 是否隐藏导航栏。
  • hideNavDetail: boolean, 可选; 是否隐藏导航栏详情。
  • hideNavLogo: boolean, 可选; 是否隐藏导航栏logo。
  • hidePrimaryNav: boolean, 可选; 是否隐藏主导航。
  • entry: string, 可选; 门户入口, 可选: 'home', 'create', 'favorites', 'categories', 'monitoring', 'recycleBin', 'drafts', 'personalCategories'。也可以选择具体的文档类型, 可选: 'datasource', 'dataModel', 'dataset', 'iot', 'dashboard', 'report', 'documentBinder', 'webpage', 'dashboardTemplate', 'vizTemplate', '3dScene', '3dModel', 'reportTemplate', 'reportMasterReport', 'languageResource'。
• selector: 作为容器的DOM的选择器。

createAdminPortal(options, selector)

• options: 管理门户的初始化参数配置。

  • backendServer: object, 必需; Wyn服务器相关信息。
    • url: string, 必需; Wyn 门户地址。
    • token: string, 必需; Wyn Api 的授权令牌。
  • siteTitle: string, 可选; 浏览器 tab页 标题。
  • theme: string, 可选; 门户主题。
  • language: string, 可选; 门户语言, 可选: 'zh', 'en', 'en-gb', 'zh-tw', 'pl'。
  • hideNavLogo: boolean, 可选; 是否隐藏导航栏logo。
  • entry: string, 可选; 门户入口, 可选: 'configuration', 'account', 'security', 'systemManagement', 'documents', 'search'。

• selector: 作为容器的DOM的选择器。