Odniesienie do podstawowych metod

W tym dokumencie znajdziesz informacje o podstawowych metodach interfejsu Embed API oraz o tym, jak te metody współdziałają ze komponentami Embed API i bazową biblioteką klienta Analytics.

Podstawowe metody

Podstawowe metody interfejsu Embed API to metody występujące w obiekcie gapi.analytics.

ready

Kolejkuje funkcję wywołania zwrotnego, która ma zostać wywołana, gdy tylko biblioteka interfejsu Embed API zostanie w pełni wczytana. Wywołania zwrotne są wywoływane w kolejności, w jakiej zostały dodane.

Funkcja ready jest definiowana przez fragment kodu Embed API, więc można z niej korzystać od razu. Wszystkie pozostałe funkcje należy umieścić w wywołaniu zwrotnym ready, aby mieć pewność, że biblioteka zostanie wczytana przed ich wywołaniem.

Wykorzystanie

gapi.analytics.ready(callback)

Parametry

Nazwa Typ Opis
callback Function Funkcja, która powinna zostać wywołana, gdy tylko biblioteka interfejsu Embed API zostanie w pełni wczytana.

Przykład

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

createComponent

Tworzy komponent o określonej nazwie i metodach tworzenia prototypu. Utworzony komponent zostanie zapisany w systemie gapi.analytics.ext pod przekazaną nazwą.

Funkcja createCallback powinna być zawsze wywoływana w gotowym wywołaniu zwrotnym, aby mieć pewność, że biblioteka klienta interfejsu Embed API została wczytana.

Wykorzystanie

gapi.analytics.createComponent(name, prototypeMethods)

Parametry

Nazwa Typ Opis
name string Nazwa komponentu.
prototypeMethods Object Obiekt, którego właściwości i metody będą przechowywane w prototypze komponentu.

Przykład

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

});