Documentation de référence sur les méthodes principales

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Ce document fournit une référence pour les principales méthodes de l'API Embed, ainsi qu'un aperçu de la manière dont ces méthodes interagissent avec les composants de l'API Embed et la bibliothèque cliente Analytics sous-jacente.

Méthodes principales

Les méthodes principales de l'API Embed correspondent aux méthodes trouvées sur l'objet gapi.analytics.

ready

Met en file d'attente une fonction de rappel qui sera invoquée une fois la bibliothèque de l'API Embed entièrement chargée. Les rappels sont appelés dans l'ordre dans lequel ils ont été ajoutés.

Comme la fonction ready est définie par l'extrait d'API Embed, elle peut être utilisée immédiatement. Toutes les autres fonctions doivent être placées dans le rappel ready pour garantir le chargement de la bibliothèque avant qu'elles ne soient invoquées.

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é dans gapi.analytics.ext avec le nom transmis.

La fonction createCallback doit toujours être appelée dans un rappel prêt à s'assurer que la bibliothèque cliente de l'API Embed est chargée.

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'.

});