HTMLIFrameElement.getStructuredData()

The getStructuredData() method of the HTMLIFrameElement interface retrieves any structured microdata (and hCard and hCalendar microformat data) contained in the HTML loaded in the browser <iframe> and returns it as JSON.

Syntax

var instanceOfDOMRequest =
instanceOfHTMLIframeElement.getStructuredData();

Returns

A DOMRequest to handle the getStructuredData() request's success and error cases. If the request is successful, the request.result is a JSON object representation of all microdata contained on the page loaded in the browser.

Parameters

None.

Examples

var browser = document.querySelector('iframe');
browser.addEventListener('mozbrowserloadend',function() {
  var request = browser.getStructuredData();
  request.onsuccess = function() {
    console.log(request.result);
  }
});

Running this code in a Browser API app and then loading up a page that contains microdata (such as the website of British alt-country band Salter Cane) will result in a JSON object being returned, along the lines of:

{
  "items":
    [
      {
        "type":["http://microformats.org/profile/hcard"],
        "properties":{"fn":["Chris Askew"],
        "n":[
          {
            "properties":
              {
                "given-name":["Chris"],
                "family-name":["Askew"], 
  ...

Specification

Not part of any specification.

Browser compatibility

[1] Supported in chrome code only.

See also

• Using the Browser API