SAP 分析云2023第四季度版本后发布后,用户将可以使用新功能:微件加载项。
SAP分析云中的微件加载项架构将为用户带来全新的体验。用户可以使用自己的加载项来拓展优化故事体验中提供的预定义微件加载项集合。
您可以通过开发微件加载项以自定义SAP分析云内置微件的部分内容,例如在图表中添加新的可视化元素、修改工具提示内容或是覆盖现有样式。
在第一阶段,受支持图表的类型是有限的。我们在第一阶段仅对部分图表种类开放加载项功能:
在SAP 分析云租户中,如果您需要使用“微件加载项”,您需要具有以下权限:
你可以在此了解更多关于微件加载项在传输、部署、导出、编辑和其他方面的不同限制。
开发微件加载项与开发自定义微件极为相似,它包括两种文件类型:微件加载项JSON文件和资源文件。
微件加载项JSON文件包括微件加载项的元数据。它定义了微件加载项中的所有成分,并且通过引用URLs的方式引用资源文件。你需要上传你的微件加载项JSON文件至SAP 分析云当中。更多信息,请参阅将您的微件加载项上传至SAP 分析云中(优化故事体验)
资源文件是指所有可以让微件加载项正确运行的文件,举例而言:JavaScript文件、CSS文件、HTML文件、图像文件等等。您可以在您自己的网络服务器和SAP分析云中上传和部署微件加载项的资源文件。您可以在这里学习如何部署您的微件加载项。
作为开发者,您可以通过创建您的微件加载项来自定义SAP 分析云中的部分内容,使其更为契合您的要求。
您可以使用JavaScript在JSON文件中定义微件加载项。下方为示例代码:
{
"id": "com.demo.localVizAddOns",
"version": "1.0.0",
"name": "Widget Customization Local Add-on",
"description": "A widget customization add-on demo",
"icon": "undefined",
"vendor": "Demo",
"eula": "EULA",
"license": "1.0",
"extensions": [
{
"extensionPoint": "sap.addOn.viz.tooltip",
"webcomponents": [
{
"kind": "main",
"tag": "viz-tooltip",
"url": "http://localhost:8088/viz-tooltip.js",
"integrity": "",
"ignoreIntegrity": true
},
{
"kind": "builder",
"tag": "viz-tooltip-build",
"url": "http://localhost:8088/viz-tooltip-builder-panel.js",
"integrity": "",
"ignoreIntegrity": true
}
],
"properties": {
"max": {
"type": "number",
"description": "The max of range value",
"default": "100"
},
"color": {
"type": "string",
"description": "Text Color info",
"default": "lightblue"
}
}
},
{
"extensionPoint": "sap.addOn.viz.plotarea.barColumn",
"webcomponents": [
{
"kind": "main",
"tag": "viz-overlay",
"url": "http://localhost:8088/viz-plotarea.js",
"integrity": "",
"ignoreIntegrity": true
},
{
"kind": "builder",
"tag": "viz-plotarea-build",
"url": "http://localhost:8088/viz-plotarea-builder-panel.js",
"integrity": "",
"ignoreIntegrity": true
}
],
"properties": {
"sapHideOriginalDataPointMark": {
"type": "boolean",
"default": true
},
"sapHideOriginalDataPointLabel": {
"type": "boolean",
"default": true
},
"sapHideOriginalXAxisLabel": {
"type": "boolean",
"default": true
},
"sapHideOriginalYAxisLabel": {
"type": "boolean",
"default": true
},
"rounded": {
"type": "boolean",
"description": "Should bar/column be rounded",
"default": true
},
"sizeIncrement": {
"type": "number",
"description": "The increment rate of bar/column size",
"default": 0
},
"axisLabelColor": {
"type": "string",
"description": "The chart axis label color",
"default": "#fff"
}
}
},
{
"extensionPoint": "sap.addOn.viz.plotarea.numericPoint",
"webcomponents": [
{
"kind": "main",
"tag": "viz-metric-plotarea",
"url": "http://localhost:8088/viz-metric-plotarea.js",
"integrity": "",
"ignoreIntegrity": true
},
{
"kind": "builder",
"tag": "viz-metric-plotarea-build",
"url": "http://localhost:8088/viz-metric-plotarea-build.js",
"integrity": "",
"ignoreIntegrity": true
}
],
"properties": {
"sapHideOriginalPrimaryNumber": {
"type": "boolean",
"default": true
},
"sapHideOriginalPrimaryLabel": {
"type": "boolean",
"default": true
},
"sapHideOriginalSecondaryNumber": {
"type": "boolean",
"default": true
},
"sapHideOriginalSecondaryLabel": {
"type": "boolean",
"default": true
},
"labelColor": {
"type": "string",
"description": "The chart axis label color",
"default": "red"
},
"numberColor": {
"type": "string",
"description": "The chart axis number color",
"default": "green"
},
"max": {
"type": "number",
"description": "The max of range value",
"default": "100"
}
}
}
]}
微件加载项的JSON文件格式和自定义微件类似。二者主要区别在于扩展节点。扩展节点是由扩展点、网络组件、属性和保留设置组成的加载项系列。
扩展点经由SAP 分析云加载项框架向开发人员提供。扩展点指定了内置微件中需要扩展的部分,或者由扩展中定义的Web组件中代替的部分。
目前,下列我们支持下列拓展点:
和自定义微件类似,微件加载项拓展也以Web组件的形式执行。然而,这里有两个主要差异:
和自定义微件类似,微件加载项的属性可以被定义。
与在自定义微件中定义的属性不同,自定义加载项有预定义属性设置,可以改变内置微件的行为或者外观,从而更好地展示或者改进拓展性。例如,绘图区拓展以叠加方式于原图标上显示。为了取得更好的视觉效果,您可以选择隐藏原图表中的数据点标记,这样扩展提供的数据点标记、数据点标签或者轴标签就不会同原图表中的重叠。
保留设置可以直接在属性代码中定义,但是其名称和类型必须遵守API引用规则。
为了添加微件加载项,请确保您已经拥有“微件加载项”这一对象类型的“读取”权限。
您可以在微件加载项DEMO视频中找到微件加载项的资源文件。您可以下载并使用这些文件,并以此为起点构建自己的微件加载项。
最后,我想再强调一次:有了微件加载项这一新功能,你无需从头构建新的自定义微件,就拥有了提升SAC可视化效果的方法。除了现有的自定义微件功能(这一功能让您可以创建新的图表类型),您目前还可以创建您自己的微件加载项,更改SAC已提供的内置微件集的外观和使用体验。
在未来,我们将支持更多的图表类型并增强扩展点,以便您可以进一步扩展预定义的微件集。
原文作者:SAP People Marouene Ferchichi
原文链接:Announcing the new SAP Analytics Cloud feature: Widget Add-on | SAP Blogs