Non-standard
This feature is not on a current W3C standards track, but it is supported on the Firefox OS platform. Although implementations may change in the future and it is not supported widely across browsers, it is suitable for use in code dedicated to Firefox OS apps.
This API is available on Firefox OS for privileged or certified applications only.
The setVisible() method of the HTMLIFrameElement is used to change the visibility state of the browser <iframe>.
The visible state of a browser <iframe> has nothing to do with its actual visibility (which is handled through CSS). The visible state is used to define the level of resources required by the browser <iframe>. If the visible state is set to true, it means that the browser <iframe> should have high priority over the resources needed to render and handle its content. On the contrary, if its visible state is set to false, it has low priority over the resources it needs.
As an example, if the content of a browser <iframe> uses the window.requestAnimationFrame method and if the visible state is set to true, window.requestAnimationFrame will be called as often as necessary. However, if the visible state is set to false, window.requestAnimationFrame will be called only when there are free resources to do it.
Syntax
instanceOfHTMLIframeElement.setVisible(visible);
Returns
Void.
Parameters
Examples
var browser = document.querySelector('iframe');
browser.setVisible(true);
Specification
Not part of any specification.
Browser compatibility
| Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
|---|---|---|---|---|---|
| Basic support | Not supported | Not supported | Not supported | Not supported | Not supported |
| Feature | Android | Firefox Mobile (Gecko) | Firefox OS (Gecko) | IE Phone | Opera Mobile | Safari Mobile |
|---|---|---|---|---|---|---|
| Basic support | Not supported | Not supported | 1.0.1 | Not supported | Not supported | Not supported |
Note: Use of the Browser API requires a privileged app, and browser and/or embed-apps permissions, depending on what you want to do. See Using the Browser API for more details.
