核心方法參考資料

本文件提供核心 Embed API 方法的參考資料,以及這些方法與 Embed API 元件和基礎 Analytics (分析) 用戶端程式庫互動的總覽。

核心方法

Embed API' 的核心方法就是 gapi.analytics 物件上的方法。

ready

將回呼函式函式排入佇列,以便在 Embed API 程式庫載入完成後立即叫用。系統會依新增順序叫用回呼。

ready 函式是由 Embed API 程式碼片段定義,因此可以立即使用。所有其他函式都應放在 ready 回呼中,以確保程式庫會在叫用之前載入。

使用方式

gapi.analytics.ready(callback)

參數

名稱 類型 說明
callback Function 嵌入 API 程式庫完成後立即叫用的函式。

範例

gapi.analytics.ready(function() {
  // Code in here will be invoked once the library fully loads.
});

createComponent

建立具有指定名稱和原型方法的元件。建立的元件會儲存在傳遞名稱的 gapi.analytics.ext 上。

請務必在就緒的回呼中叫用 createCallback 函式,確保載入 Embed API 用戶端程式庫。

使用方式

gapi.analytics.createComponent(name, prototypeMethods)

參數

名稱 類型 說明
name string 元件名稱。
prototypeMethods Object 系統會將屬性和方法儲存在元件原型上的物件。

範例

gapi.analytics.ready(function() {

  gapi.analytics.createComponent('MyComponent', {
    foo: function() {
      alert('foo');
    },
    bar: function() {
      alert('bar');
    }
  });

  var myComponentInstance = new gapi.analytics.ext.MyComponent();
  myComponentInstance.foo(); // Alerts 'foo'.

});