@grapecity-software/wyn-integration
v7.1.150
Published
Provides interfaces for quick creation of Wyn front-end apps, e.g. dashboards/report designers or viewers.
Downloads
21
Readme
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 => {
});
- 添加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.createSemanticDesigner({
baseUrl: 'http://sample.com',
token: 'd3ecc751b250f8129e87f6813c13ee7ec0bf1f01198160f3bdddb6771c20fab9',
theme: 'default',
language: 'zh',
siteTitle: 'sds',
}, '#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 => {
});
- 添加 推送数据集/流式数据集 设计器到
<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 => {
});
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
: boolean, 可选; 指定仪表板高级查看器工具栏的隐藏菜单项。
onMount
: () => void, 可选; 注册一个回调函数,在仪表板高级查看器挂载完成后调用。onClose
: () => void, 可选; 注册一个回调函数,在仪表板高级查看器关闭时调用。onRendered
: (docName: string) => void, 可选; 注册一个回调函数,在仪表板高级查看器渲染完成后调用。onLoaded
: (docName: string) => void, 可选; 注册一个回调函数,在仪表板高级查看器加载完成后调用。onError
: (errorInfo: object) => void, 可选; 注册一个回调函数,在捕获到仪表板高级查看器的错误时调用。
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, 可选; 是否禁用仪表板标准查看器的页面自动切换功能。
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的选择器。
createSemanticDesigner(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的选择器。
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的选择器。
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的选择器。