HTMLIFrameElement.getStructuredData()

Non-standard
This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

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

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support No No471 No No No
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support No No No No No No ?

1. Supported in chrome code only.

See also

Document Tags and Contributors

Contributors to this page: fscholz, chrisdavidmills
Last updated by: fscholz,