• Skip to main content
  • Select language
  • Skip to search
MDN Web Docs
  • Technologies
    • HTML
    • CSS
    • JavaScript
    • Graphics
    • HTTP
    • APIs / DOM
    • WebExtensions
    • MathML
  • References & Guides
    • Learn web development
    • Tutorials
    • References
    • Developer Guides
    • Accessibility
    • Game development
    • ...more docs
Add-ons
  1. MDN
  2. Mozilla
  3. Add-ons
  4. Browser extensions
  5. JavaScript APIs
  6. tabs
  7. tabs.PageSettings

tabs.PageSettings

In This Article
  1. Type
  2. Browser compatibility

The type tabs.PageSettings is used to control how the contents of a tab is printed.

Type

Values of this type are objects. They contain the following properties:

footerCenter Optional
string. The text for the page's center footer. Default: ''.
footerLeft Optional
string. The text for the page's left footer. Default: '&PT'.
footerRight Optional
string. The text for the page's right footer. Default: '&D'.
headerCenter Optional
string. The text for the page's center header. Default: ''.
headerLeft Optional
string. The text for the page's left header. Default: '&T'.
headerRight Optional
string. The text for the page's right header. Default: '&U'.
marginBottom Optional
number. The margin between the page content and the bottom edge of the paper (inches). Default: 0.5.
marginLeft Optional
number. The margin between the page content and the left edge of the paper (inches). Default: 0.5.
marginRight Optional
number. The margin between the page content and the right edge of the paper (inches). Default: 0.5.
marginTop Optional
number. The margin between the page content and the top edge of the paper (inches). Default: 0.5.
orientation Optional
integer. Page orientation: 0 means "portrait", 1 means "landscape". Default: 0.
paperHeight Optional
number. The paper height in paper size units. Default: 11.0.
paperSizeUnit Optional
integer. The paper size unit: 0 = inches, 1 = millimeters. Default: 0.
paperWidth Optional
number. The paper width in paper size units. Default: 8.5.
scaling Optional
number. Page content scaling factor. 1 means 100% or normal size. Default: 1.
showBackgroundColors Optional
boolean. Whether the page background colors should be shown. Default: false.
showBackgroundImages Optional
boolean. Whether the page background images should be shown. Default: false.
shrinkToFit Optional
boolean. Whether the page content should shrink to fit the page width (overrides scaling). Default: true.

Browser compatibility

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Acknowledgements

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

Tags: 
  • Add-ons
  • API
  • Extensions
  • PageSettings
  • Reference
  • tabs
  • Type
  • WebExtensions
 Contributors to this page: wbamberg
 Last updated by: wbamberg, Jul 28, 2017, 5:19:21 PM
See also
  1. Browser extensions
  2. Getting started
    1. What are extensions?
    2. Your first extension
    3. Your second extension
    4. Anatomy of an extension
    5. Example extensions
  3. How to
    1. Intercept HTTP requests
    2. Modify a web page
    3. Add a button to the toolbar
    4. Implement a settings page
  4. User interface
    1. Introduction
    2. Toolbar button
    3. Address bar button
    4. Sidebar
    5. Context menu items
    6. Options page
    7. Bundled web pages
    8. Notifications
    9. Address bar suggestions
    10. Developer tools panels
  5. Concepts
    1. Using the JavaScript APIs
    2. Content scripts
    3. Match patterns
    4. Internationalization
    5. Content Security Policy
    6. Native messaging
  6. Porting
    1. Porting a Google Chrome extension
    2. Porting a legacy Firefox extension
    3. Embedded WebExtensions
    4. Comparison with the Add-on SDK
    5. Comparison with XUL/XPCOM extensions
    6. Chrome incompatibilities
    7. Differences between desktop and Android
  7. Firefox workflow
    1. Temporary Installation in Firefox
    2. Debugging
    3. Developing for Firefox for Android
    4. Getting started with web-ext
    5. web-ext command reference
    6. Extensions and the Add-on ID
    7. Publishing your extension
  8. JavaScript APIs
    1. Browser support for JavaScript APIs
    2. alarms
    3. bookmarks
    4. browserAction
    5. browserSettings
    6. browsingData
    7. commands
    8. contextMenus
    9. contextualIdentities
    10. cookies
    11. devtools.inspectedWindow
    12. devtools.network
    13. devtools.panels
    14. downloads
    15. events
    16. extension
    17. extensionTypes
    18. history
    19. i18n
    20. identity
    21. idle
    22. management
    23. notifications
    24. omnibox
    25. pageAction
    26. permissions
    27. privacy
    28. proxy
    29. runtime
    30. sessions
    31. sidebarAction
    32. storage
    33. tabs
      1. Methods
        1. captureVisibleTab()
        2. connect()
        3. create()
        4. detectLanguage()
        5. duplicate()
        6. executeScript()
        7. get()
        8. getAllInWindow()
        9. getCurrent()
        10. getSelected()
        11. getZoom()
        12. getZoomSettings()
        13. highlight()
        14. insertCSS()
        15. move()
        16. query()
        17. reload()
        18. remove()
        19. removeCSS()
        20. sendMessage()
        21. sendRequest()
        22. setZoom()
        23. setZoomSettings()
        24. update()
      2. Properties
        1. TAB_ID_NONE
      3. Types
        1. MutedInfo
        2. MutedInfoReason
        3. PageSettings
        4. Tab
        5. TabStatus
        6. WindowType
        7. ZoomSettings
        8. ZoomSettingsMode
        9. ZoomSettingsScope
      4. Events
        1. onActivated
        2. onActiveChanged
        3. onAttached
        4. onCreated
        5. onDetached
        6. onHighlightChanged
        7. onHighlighted
        8. onMoved
        9. onRemoved
        10. onReplaced
        11. onSelectionChanged
        12. onUpdated
        13. onZoomChange
    34. theme
    35. topSites
    36. types
    37. webNavigation
    38. webRequest
    39. windows
  9. Manifest keys
    1. applications
    2. author
    3. background
    4. browser_action
    5. chrome_settings_overrides
    6. chrome_url_overrides
    7. commands
    8. content_scripts
    9. content_security_policy
    10. default_locale
    11. description
    12. developer
    13. devtools_page
    14. homepage_url
    15. icons
    16. incognito
    17. manifest_version
    18. name
    19. omnibox
    20. optional_permissions
    21. options_ui
    22. page_action
    23. permissions
    24. protocol_handlers
    25. short_name
    26. sidebar_action
    27. theme
    28. version
    29. web_accessible_resources
  10. Themes
  11. Publishing add-ons
  12. Guides
    1. Signing and distribution overview
    2. Submit an add-on
    3. Creating an appealing listing
    4. Review policies
    5. Developer agreement
    6. Featured add-ons
    7. Contact addons.mozilla.org
  13. Community and support
  14. Channels
    1. Add-ons blog
    2. Add-on forums
    3. Stack Overflow
    4. Development newsgroup
    5. IRC Channel
  15. Legacy add-ons
  16. Legacy technologies
    1. Add-on SDK
    2. Legacy Firefox for Android
    3. Bootstrapped extensions
    4. Overlay extensions