本文件提供核心 Embed API 方法的參考資料,並概述這些方法如何與 Embed API 元件和基礎 Analytics (分析) 用戶端程式庫互動。
核心方法
Embed API 的核心方法是指 gapi.analytics
物件中的方法。
ready
將 Embed API 程式庫完全載入時,即會將回呼函式排入佇列。回呼會按照加入的順序叫用。
ready
函式由 Embed API 程式碼片段定義,因此可立即使用。所有其他函式都應置於 ready
回呼內,以確保在叫用程式庫前載入程式庫。
使用方式
gapi.analytics.ready(callback)
參數
名稱 | 類型 | 說明 |
---|---|---|
callback |
Function |
完整載入 Embed 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'. });