Pentaho Analyzer 外部 JavaScript API 参考

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加载并可用,分析器将自动寻找该功能并执行该功能。

www.company.org/index.html

<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服务调用类别的参考:

  • 分析器模块
    详细介绍了analyzer.AnalyzerModule的方法,该方法允许在DOM元素中部署和控制分析器。

  • 事件
    详细说明cv的方法。api.event类,其中包含创建和注册事件的所有必要调用。

  • 操作
    详细说明cv的方法。api.operation类,其中包含可用的与操作相关的API调用。

  • 报告
    详细介绍了简历的方法。api.report类,其中包含可用的与报告相关的API调用。

  • 用户界面
    详细介绍cv的方法。api.ui类,其中包含与用户界面相关的可用API调用。

  • 实用程序
    详细介绍cv的方法。api.util 类,其中包含可用的与实用程序相关的API调用。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,245评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,749评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,960评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,575评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,668评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,670评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,664评论 3 415
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,422评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,864评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,178评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,340评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,015评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,646评论 3 323
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,265评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,494评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,261评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,206评论 2 352

推荐阅读更多精彩内容

  • 前端开发面试题 面试题目: 根据你的等级和职位的变化,入门级到专家级,广度和深度都会有所增加。 题目类型: 理论知...
    怡宝丶阅读 2,577评论 0 7
  • 基础问题 = 和 == 和 === 的区别?= : 用于赋值== : 用于判断=== : 用于判断,必须类型和值同...
    雪落丶阅读 942评论 0 1
  • 一、Developer center 开发人员中心 集成和定制Pentaho产品,以及执行高级任务。这些部分最适...
    叫兽儿阅读 1,127评论 0 0
  • 9.感悟与道理 反思能力是人类独有的能力之一。尽管如此,我们还是常说“光想是没用的”(“Ideas are che...
    蜗牛0718阅读 253评论 0 1
  • 白蟾 在一些诗歌里 我们总是强调 事实的存在 而从来 不曾想过 真实的 或许不是 生活 而是思想 白檐花 在花盆里...
    毛辣丁阅读 815评论 0 8