В этом документе содержится ссылка на основные методы Embed API, а также обзор того, как эти методы взаимодействуют с компонентами Embed API и базовой клиентской библиотекой Analytics.
Основные методы
Основные методы Embed API — это методы, находящиеся в gapi.analytics .
ready
Ставит в очередь функцию обратного вызова, которая будет вызвана, как только библиотека Embed API будет полностью загружена. Обратные вызовы вызываются в том порядке, в котором они были добавлены.
ready функция определяется фрагментом 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'.
});