مرجع روشهای اصلی

این سند مرجعی برای روش‌های اصلی Embed API و همچنین نمای کلی از نحوه تعامل آن روش‌ها با مؤلفه‌های Embed API و کتابخانه سرویس گیرنده Analytics زیرین ارائه می‌کند.

روش های اصلی

روش‌های اصلی Embed API روش‌هایی هستند که در شی gapi.analytics یافت می‌شوند.

`ready`

به محض بارگیری کامل کتابخانه Embed API، یک تابع پاسخ به تماس را در صف قرار می دهد تا فراخوانی شود. تماس ها به ترتیبی که اضافه شده اند فراخوانی می شوند.

تابع ready توسط قطعه Embed API تعریف شده است، بنابراین می توان بلافاصله از آن استفاده کرد. همه توابع دیگر باید در داخل callback 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'.

});