Ce document fournit une documentation de référence sur les principales méthodes de l'API Embed, ainsi qu'un aperçu de la manière dont elles interagissent avec les composants de l'API Embed et la bibliothèque cliente Analytics sous-jacente.
Méthodes de base
Les principales méthodes de l'API Embed sont celles qui se trouvent sur l'objet gapi.analytics.
ready
Met en file d'attente une fonction de rappel à appeler dès que la bibliothèque de l'API Embed est entièrement chargée. Les rappels sont appelés dans l'ordre dans lequel ils ont été ajoutés.
La fonction ready est définie par l'extrait de code de l'API Embed. Elle peut donc être utilisée immédiatement. Toutes les autres fonctions doivent être placées dans le rappel ready pour vous assurer que la bibliothèque est chargée avant d'être appelée.
Utilisation
gapi.analytics.ready(callback)
Paramètres
| Nom | Type | Description |
|---|---|---|
callback |
Function |
Fonction à appeler dès que la bibliothèque de l'API Embed est entièrement chargée. |
Exemple
gapi.analytics.ready(function() {
// Code in here will be invoked once the library fully loads.
});
createComponent
Crée un composant avec les méthodes de nom et de prototype spécifiées. Le composant créé sera stocké sur gapi.analytics.ext avec le nom transmis.
La fonction createCallback doit toujours être appelée dans un rappel prêt pour garantir le chargement de la bibliothèque cliente de l'API Embed.
Utilisation
gapi.analytics.createComponent(name, prototypeMethods)
Paramètres
| Nom | Type | Description |
|---|---|---|
name |
string |
Nom du composant. |
prototypeMethods |
Object |
Objet dont les propriétés et les méthodes seront stockées sur le prototype du composant. |
Exemple
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'.
});