tabs.setZoomSettings()

Sets zoom settings for the specified tab. These settings are reset to the default settings upon navigating the tab.

This is an asynchronous function that returns a Promise.

Syntax

var settingZoomSettings = browser.tabs.setZoomSettings(
  tabId,           // optional integer
  zoomSettings     // ZoomSettings
)

Parameters

tabIdOptional
integer. The ID of the tab to change the zoom settings for. Defaults to the active tab of the current window.
zoomSettings
tabs.ZoomSettings. Defines how zoom changes are handled and at what scope.

Return value

A Promise that will be fulfilled with no arguments after the zoom settings have been changed. If the tab could not be found or some other error occurs, the promise will be rejected with an error message.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaFirefox for Android
Basic supportChrome Full support YesEdge No support NoFirefox No support NoOpera Full support YesFirefox Android No support No

Legend

Full support  
Full support
No support  
No support

Examples

Disable zooming for the current tab:

function onSet() {
  console.log(`Set zoom factor`);
}

function onError(error) {
  console.log(`Error: ${error}`);
}

var setting = browser.tabs.setZoomSettings({mode:"disabled"});
setting.then(onSet, onError);

Acknowledgements

This API is based on Chromium's chrome.tabs API. This documentation is derived from tabs.json in the Chromium code.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Document Tags and Contributors

Contributors to this page: wbamberg, Makyen
Last updated by: wbamberg,