Pentaho Analyzer 外部 JavaScript API 参考
当以嵌入式方式工作时,此API集使OEM可以更好地控制Analyzer。这些API允许与分析器查看器,报告和数据进行更细粒度的交互。
如何访问API
可以使用以下嵌入式 iFrame 方法访问 API:
- 同一域
- 不同的领域
一、嵌入具有相同域的 iFrame 中
在 PUC 内部使用 Analyzer 时,可以通过两种方式执行自定义 API 代码:将代码直接放在父框架中,或者通过将代码包含在外部资源文件中。
1、在父框架内
在父 html 文件中,添加以下脚本块。初始化分析器时,将为打开或创建的每个分析器报告执行该操作。
<script type="text/javascript">
window.onAnalyzerReady = function(api, frameId) {
// Perform Analyzer API actions
};
</script>
Note: 由于初始化Analyzer时将执行onAnalyzerReady代码,因此该代码块中不提供api.event.registerInitListener。
2、作为外部资源
此外,通过将自定义javascript包含为外部资源,可以达到相同的结果。唯一的区别是您不必使用“ onAnalyzerReady”功能,因为分析仪已经在适当的时间加载了此文件。在您自己的plugin.xml文件中,向您的自定义javascript文件添加路径,该路径将在分析器加载时执行:
<file context="analyzer">path/to/your/javascript/ExternalFile.js</file>
有关创建自己的plugin.xml文件的更多详细信息,请参[创建Pentaho Server插件。
第一个javascript块中的相同代码相同,但是未使用“ onAnalyzerReady”功能。相反,您将需要使用RequireJS的API
require([ "analyzer/cv_api" ], function(api) {
api.event.registerInitListener(function(e, cv) {
// Perform Analyzer API actions
});
});
二、嵌入到不同域的 iFrame 中
这些API在每个Analyzer iFrame的全局范围内公开。分析器iFrame查找附加到父窗口的onAnalyzerReady函数。由于跨站点脚本问题,您必须配置嵌入了Analyzer的iFrame。您可以通过将外部资源文件添加到任何插件的plugin.xml文件中来实现。通常使用default-plugin添加此类脚本。它位于pentaho-solutions / system / default-plugin /中。
在插件的plugin.xml文件中,您将向自己的javascript文件添加路径,该路径将在加载Analyzer时执行。
Plugin.xml:
<file context="analyzer">path/to/your/global/javascript/GlobalFile.js</file>
在外部javascript文件中,必须在Analyzer iFrame的窗口上设置自定义域属性。
ExternalFile.js:
// iFrame source = "http://example.company.org:8080/pentaho/api/repos/xanalyzer/editor
window.customDomain = "company.org"
此外,必须在要嵌入分析器的父页面或框架内部设置document.domain。将Analyzer iFrame嵌入到页面中时,可以将onAnalyzerReady函数绑定到窗口。一旦API加载并可用,分析器将自动寻找该功能并执行该功能。
<html>
<head>
<script type="text/javascript">
document.domain = "company.org"
window.onAnalyzerReady = function(api, frameId) {
// Perform Analyzer API actions
};
</script>
</head>
<body>
<iframe id="analyzer-frame" src="http://example.company.org:8080/pentaho/api/repos/xanalyzer/editor"></iframe>
</body>
</html>
加载Analyzer时,您将可以访问API和正在调用代码的框架的frameId,以便可以适当地自定义每个框架。Analyzer 为页面中的每个框架执行onAnalyzerReady代码,因此,每个框架的frameId将有所不同,并且您收到的API将与该框架相关。
window.onAnalyzerReady = function(api, frameId) {
// Perform Analyzer API actions
};
例:
//Example calls into namespaced functions
cv.api.report.setLayoutFields("test");
cv.api.report.getLayoutFields();
1、直接网址
要在通过分析器的URL直接加载分析器时访问API,需要使用“ 作为外部资源”方法。
三、服务电话参考
提供以下JavaScript API服务调用类别的参考: