chrome/common/extensions/docs/devtools.panels.html - Issue 10642015: Basic setup for generating app docs

Unified Diff: chrome/common/extensions/docs/devtools.panels.html

Issue 10642015: Basic setup for generating app docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: Created 8 years, 6 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Index: chrome/common/extensions/docs/devtools.panels.html

diff --git a/chrome/common/extensions/docs/devtools.panels.html b/chrome/common/extensions/docs/devtools.panels.html

deleted file mode 100644

index 07553f79eacd4419138bd48e95969581b1704326..0000000000000000000000000000000000000000

--- a/chrome/common/extensions/docs/devtools.panels.html

+++ /dev/null

@@ -1,1683 +0,0 @@

-<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:

- 1) The <head> information in this page is significant, should be uniform

- across api docs and should be edited only with knowledge of the

- templating mechanism.

- 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a

- browser, it will be re-generated from the template, json schema and

- authored overview content.

- 4) The <body>.innerHTML is also generated by an offline step so that this

- page may easily be indexed by search engines.

---><html xmlns="http://www.w3.org/1999/xhtml"><head>

- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

- <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">

- <link href="css/print.css" rel="stylesheet" type="text/css" media="print">

- <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js">

- </script>

- <script type="text/javascript" src="../../../../third_party/json_minify/minify-sans-regexp.js">

- </script>

- <script type="text/javascript" src="js/api_page_generator.js"></script>

- <script type="text/javascript" src="js/bootstrap.js"></script>

- <script type="text/javascript" src="js/sidebar.js"></script>

- <meta name="description" content="Documentation for the chrome.devtools.panels module, which is part of the Google Chrome extension APIs."><title>chrome.devtools.panels - Google Chrome Extensions - Google Code</title></head>

- <body> <div id="devModeWarning" class="displayModeWarning">

- You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files.

- </div>

- <div id="branchWarning" class="displayModeWarning">

- <span>WARNING: This is the <span id="branchName">BETA</span> documentation.

- It may not work with the stable release of Chrome.</span>

- <select id="branchChooser">

- <option>Choose a different version...

- </option><option value="">Stable

- </option><option value="beta">Beta

- </option><option value="dev">Dev

- </option><option value="trunk">Trunk

- </option></select>

- </div>

- <div id="unofficialWarning" class="displayModeWarning">

- <span>WARNING: This is unofficial documentation. It may not work with the

- current release of Chrome.</span>

- <button id="goToOfficialDocs">Go to the official docs</button>

- </div>

- <div id="gc-container" class="labs">

-

- <!-- In particular, sub-templates that recurse, must be used by allowing

- jstemplate to make a copy of the template in this section which

- are not operated on by way of the jsskip="true" -->

-

- <a id="top"></a>

- <div id="skipto">

- <a href="#gc-pagecontent">Skip to page content</a>

- <a href="#gc-toc">Skip to main navigation</a>

- </div>

-

- <table id="header" width="100%" cellspacing="0" border="0">

- <tbody><tr>

- <td valign="middle"><a href="http://code.google.com/"><img src="images/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:0; margin:0;"></a></td>

- <td valign="middle" width="100%" style="padding-left:0.6em;">

- <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em">

- <div id="gsc-search-box">

- <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno">

- <input type="hidden" name="ie" value="UTF-8">

- <input type="text" name="q" value="" size="55">

- <input class="gsc-search-button" type="submit" name="sa" value="Search">

- <br>

- <span class="greytext">e.g. "page action" or "tabs"</span>

- </div>

- </form>

- <script type="text/javascript" src="https://www.google.com/jsapi"></script>

- <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>

- <script type="text/javascript" src="https://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script>

- <script type="text/javascript" src="https://www.google.com/coop/cse/brand?form=cse&lang=en"></script>

- </td>

- </tr>

- </tbody></table>

- <div id="codesiteContent" class="">

- <a id="gc-topnav-anchor"></a>

- <div id="gc-topnav">

- <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1>

- <ul id="home" class="gc-topnav-tabs">

- <li id="home_link">

- <a href="index.html" title="Google Chrome Extensions home page">Home</a>

- </li>

- <li id="docs_link">

- <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a>

- </li>

- <li id="faq_link">

- <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a>

- </li>

- <li id="samples_link">

- <a href="samples.html" title="Sample extensions (with source code)">Samples</a>

- </li>

- <li id="group_link">

- <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a>

- </li>

- <li id="so_link">

- <a href="http://stackoverflow.com/questions/tagged/google-chrome-extension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>

- </li>

- </ul>

- </div>

- <div class="g-section g-tpl-170">

-

- <div class="g-unit g-first" id="gc-toc">

- <ul>

- <li><a href="getstarted.html">Getting Started</a></li>

- <li><a href="overview.html">Overview</a></li>

- <li><a href="whats_new.html">What's New?</a></li>

- <li><h2><a href="devguide.html">Developer's Guide</a></h2>

- <ul>

- <li>Browser UI

- <ul>

- <li><a href="browserAction.html">Browser Actions</a></li>

- <li><a href="contextMenus.html">Context Menus</a></li>

- <li><a href="notifications.html">Desktop Notifications</a></li>

- <li><a href="omnibox.html">Omnibox</a></li>

- <li><a href="options.html">Options Pages</a></li>

- <li><a href="override.html">Override Pages</a></li>

- <li><a href="pageAction.html">Page Actions</a></li>

- </ul>

- </li>

- <li>Browser Interaction

- <ul>

- <li><a href="bookmarks.html">Bookmarks</a></li>

- <li><a href="cookies.html">Cookies</a></li>

- <li><a href="devtools.html">Developer Tools</a></li>

- <li><a href="events.html">Events</a></li>

- <li><a href="history.html">History</a></li>

- <li><a href="management.html">Management</a></li>

- <li><a href="tabs.html">Tabs</a></li>

- <li><a href="windows.html">Windows</a></li>

- </ul>

- </li>

- <li>Implementation

- <ul>

- <li><a href="a11y.html">Accessibility</a></li>

- <li><a href="background_pages.html">Background Pages</a></li>

- <li><a href="content_scripts.html">Content Scripts</a></li>

- <li><a href="xhr.html">Cross-Origin XHR</a></li>

- <li><a href="i18n.html">Internationalization</a></li>

- <li><a href="messaging.html">Message Passing</a></li>

- <li><a href="permissions.html">Optional Permissions</a></li>

- <li><a href="npapi.html">NPAPI Plugins</a></li>

- </ul>

- </li>

- <li>Finishing

- <ul>

- <li><a href="hosting.html">Hosting</a></li>

- <li><a href="external_extensions.html">Other Deployment Options</a></li>

- </ul>

- </li>

- </ul>

- </li>

- <li><h2><a href="apps.html">Packaged Apps</a></h2></li>

- <li><h2><a href="tutorials.html">Tutorials</a></h2>

- <ul>

- <li><a href="tut_debugging.html">Debugging</a></li>

- <li><a href="tut_analytics.html">Google Analytics</a></li>

- <li><a href="tut_oauth.html">OAuth</a></li>

- </ul>

- </li>

- <li><h2>Reference</h2>

- <ul>

- <li>Formats

- <ul>

- <li><a href="manifest.html">Manifest Files</a></li>

- <li><a href="match_patterns.html">Match Patterns</a></li>

- </ul>

- </li>

- <li><a href="permission_warnings.html">Permission Warnings</a></li>

- <li><a href="api_index.html">chrome.* APIs</a></li>

- <li><a href="api_other.html">Other APIs</a></li>

- </ul>

- </li>

- <li><h2><a href="samples.html">Samples</a></h2></li>

- <div class="line"> </div>

- <li><h2>More</h2>

- <ul>

- <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li>

- <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li>

- <li><a href="themes.html">Themes</a></li>

- </ul>

- </li>

- </ul>

- </div>

- <script>

- initToggles();

- </script>

- <div class="g-unit" id="gc-pagecontent">

- <div id="pageTitle">

- <h1 class="page_title">chrome.devtools.panels</h1>

- </div>

-

- <div id="toc">

- <h2>Contents</h2>

- <ol>

- <li>

- <a href="#H2-0">Overview</a>

- <ol>

- </ol>

- </li><li>

- <a href="#overview-examples">Examples</a>

- <ol>

- </ol>

- </li>

- <li>

- <a href="#apiReference">API reference: chrome.devtools.panels</a>

- <ol>

- <li>

- <a href="#properties">Properties</a>

- <ol>

- <li>

- <a href="#property-elements">elements</a>

- </li>

- </ol>

- </li>

- <li>

- <a href="#global-methods">Methods</a>

- <ol>

- <li>

- <a href="#method-create">create</a>

- </li><li>

- <a href="#method-setOpenResourceHandler">setOpenResourceHandler</a>

- </li>

- </ol>

- </li>

- <li>

- <a href="#types">Types</a>

- <ol>

- <li>

- <a href="#type-ElementsPanel">ElementsPanel</a>

- <ol>

- <li>

- <a href="#global-ElementsPanel-methods">Methods</a>

- <ol>

- <li>

- <a href="#method-ElementsPanel-createSidebarPane">createSidebarPane</a>

- </li>

- </ol>

- </li>

- <li>

- <a href="#global-ElementsPanel-events">Events</a>

- <ol>

- <li>

- <a href="#event-ElementsPanel-onSelectionChanged">onSelectionChanged</a>

- </li>

- </ol>

- </li>

- </ol>

- </li><li>

- <a href="#type-ExtensionPanel">ExtensionPanel</a>

- <ol>

- <li>

- <a href="#global-ExtensionPanel-methods">Methods</a>

- <ol>

- <li>

- <a href="#method-ExtensionPanel-createStatusBarButton">createStatusBarButton</a>

- </li>

- </ol>

- </li>

- <li>

- <a href="#global-ExtensionPanel-events">Events</a>

- <ol>

- <li>

- <a href="#event-ExtensionPanel-onHidden">onHidden</a>

- </li><li>

- <a href="#event-ExtensionPanel-onSearch">onSearch</a>

- </li><li>

- <a href="#event-ExtensionPanel-onShown">onShown</a>

- </li>

- </ol>

- </li>

- </ol>

- </li><li>

- <a href="#type-ExtensionSidebarPane">ExtensionSidebarPane</a>

- <ol>

- <li>

- <a href="#global-ExtensionSidebarPane-methods">Methods</a>

- <ol>

- <li>

- <a href="#method-ExtensionSidebarPane-setExpression">setExpression</a>

- </li><li>

- <a href="#method-ExtensionSidebarPane-setHeight">setHeight</a>

- </li><li>

- <a href="#method-ExtensionSidebarPane-setObject">setObject</a>

- </li><li>

- <a href="#method-ExtensionSidebarPane-setPage">setPage</a>

- </li>

- </ol>

- </li>

- <li>

- <a href="#global-ExtensionSidebarPane-events">Events</a>

- <ol>

- <li>

- <a href="#event-ExtensionSidebarPane-onHidden">onHidden</a>

- </li><li>

- <a href="#event-ExtensionSidebarPane-onShown">onShown</a>

- </li>

- </ol>

- </li>

- </ol>

- </li><li>

- <a href="#type-Button">Button</a>

- <ol>

- <li>

- <a href="#global-Button-methods">Methods</a>

- <ol>

- <li>

- <a href="#method-Button-update">update</a>

- </li>

- </ol>

- </li>

- <li>

- <a href="#global-Button-events">Events</a>

- <ol>

- <li>

- <a href="#event-Button-onClicked">onClicked</a>

- </li>

- </ol>

- </li>

- </ol>

- </li>

- </ol>

- </li>

- </ol>

- </li>

- </ol>

- </div>

-

-

-

- <div id="static">

-<p id="classSummary">

-Use the <code>chrome.devtools.panels</code> module to integrate

-your extension into Developer Tools window UI: create your own panels, access

-existing panels, and add sidebars.

-</p><p>

-See <a href="devtools.html">DevTools APIs summary</a> for

-general introduction to using Developer Tools APIs.

-</p>

-<a name="H2-0"></a><h2>Overview</h2>

-<p>

-Each extension panel and sidebar is displayed as a separate HTML page. All

-extension pages displayed in the Developer Tools window have access to all

-modules in <code>chrome.devtools</code> API, as well as to

-<a href="extension.html">chrome.extension</a> API. Other extension APIs are not

-available to the pages within Developer Tools window, but you may invoke them

-by sending a request to the background page of your extension, similarly to how

-it's done in the <a href="overview.html#contentScripts">content scripts</a>.

-</p><p>

-You can use the <code><a href="#method-setOpenResourceHandler">setOpenResourceHandler()</a></code> method to install a

-callback function that handles user requests to open a resource (typically,

-a click on a resource link in the Developer Tools window). At most one of the

-installed handlers gets called; users can specify (using the Developer Tools

-Settings dialog) either the default behavior or an extension to handle resource

-open requests. If an extension calls <code>setOpenResourceHandler()</code>

-multiple times, only the last handler is retained.

-</p>

-<h2 id="overview-examples">Examples</h2>

-<p>The following code adds a panel contained in <code>Panel.html</code>,

-represented by <code>FontPicker.png</code> on the Developer Tools toolbar

-and labeled as <em>Font Picker</em>:</p>

-<pre>chrome.devtools.panels.create("Font Picker",

- "FontPicker.png",

- "Panel.html"

- function(panel) { ... });

-</pre>

-<p>The following code adds a sidebar pane contained in

-<code>Sidebar.html</code> and titled <em>Font Properties</em> to the Elements

-panel, then sets its height to <code>8ex</code>:

-</p><pre>chrome.devtools.panels.elements.createSidebarPane("Font Properties",

- function(sidebar) {

- sidebar.setPage("Sidebar.html");

- sidebar.setHeight("8ex");

- });

-</pre>

-<p>

-This screenshot demonstrates the effect the above examples would have on

-Developer Tools window:

-<img src="images/devtools-panels.png" style="margin-left: 20px" width="686" height="289" alt="Extension icon panel on DevTools toolbar">

-</p>

-<p>

-You can find examples that use this API in

-<a href="samples.html#Chrome Query">Samples</a>.

-</p>

-

-</div>

-

- <div class="apiPage">

- <a name="apiReference"></a>

- <h2>API reference: chrome.devtools.panels</h2>

-

- <div class="apiGroup">

- <a name="properties"></a>

- <h3 id="properties">Properties</h3>

- <div>

- <a name="property-elements"></a>

- <h4>elements</h4>

- <div class="summary">

-

- <span>chrome.devtools.panels.</span><span>elements</span>

- </div>

- <div>

- <dt>

- <var>elements</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="devtools.panels.html#type-ElementsPanel">ElementsPanel</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Elements panel.</dd>

-

-

-

-

- </div>

- </div>

-

- <div id="methodsTemplate" class="apiGroup">

- <a name="global-methods"></a>

- <h3>Methods</h3>

-

- <div class="apiItem">

- <a name="method-create"></a>

- <h4>create</h4>

- <div class="summary">

-

- <span>chrome.devtools.panels.create</span>(<span class="null"><span>string</span>

- <var><span>title</span></var></span><span class="null"><span>, </span><span>string</span>

- <var><span>iconPath</span></var></span><span class="null"><span>, </span><span>string</span>

- <var><span>pagePath</span></var></span><span class="optional"><span>, </span><span>function</span>

- <var><span>callback</span></var></span>)</div>

- <div class="description">

- <p>Creates an extension panel.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>title</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Title that is displayed next to the extension icon in the Developer Tools toolbar.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>iconPath</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Path of the panel's icon relative to the extension directory.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>pagePath</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Path of the panel's HTML page relative to the extension directory.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>callback</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A function that is called when the panel is created.</dd>

-

-

-

-

- </div>

- </dl>

-

- <dl>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

- If you specify the <em>callback</em> parameter, it should

- specify a function that looks like this:

- </p>

-

- <pre>function(<span>ExtensionPanel panel</span>) <span class="subdued">{...}</span>;</pre>

- <dl>

- <div>

- <dt>

- <var>panel</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="devtools.panels.html#type-ExtensionPanel">ExtensionPanel</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>An ExtensionPanel object representing the created panel.</dd>

-

-

-

-

- </div>

- </dl>

- </div>

-

- </div>

- </div><div class="apiItem">

- <a name="method-setOpenResourceHandler"></a>

- <h4>setOpenResourceHandler</h4>

- <div class="summary">

-

- <span>chrome.devtools.panels.setOpenResourceHandler</span>(<span class="optional"><span>function</span>

- <var><span>callback</span></var></span>)</div>

- <div class="description">

- <p>Specifies the function to be called when the user clicks a resource link in the Developer Tools window. To unset the handler, either call the method with no parameters or pass null as the parameter.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>callback</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A function that is called when the user clicks on a valid resource link in Developer Tools window. Note that if the user clicks an invalid URL or an XHR, this function is not called.</dd>

-

-

-

-

- </div>

- </dl>

-

- <dl>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

- If you specify the <em>callback</em> parameter, it should

- specify a function that looks like this:

- </p>

-

- <pre>function(<span>object devtools.inspectedWindow.Resource</span>) <span class="subdued">{...}</span>;</pre>

- <dl>

- <div>

- <dt>

- <var>devtools.inspectedWindow.Resource</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A <a href="devtools.inspectedWindow.html#type-Resource">Resource</a> object for the resource that was clicked.</dd>

-

-

-

-

- </div>

- </dl>

- </div>

-

- </div>

- </div>

- </div>

-

-

-

- <div class="apiGroup">

- <a name="types"></a>

- <h3 id="types">Types</h3>

-

- <div class="apiItem">

- <a name="type-ElementsPanel"></a>

- <h4>ElementsPanel</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Represents the Elements panel.</dd>

-

-

- <dd>

- <div class="apiGroup">

- <a name="global-ElementsPanel-methods"></a>

- <h3>Methods of ElementsPanel</h3>

-

- <div class="apiItem">

- <a name="method-ElementsPanel-createSidebarPane"></a>

- <h4>createSidebarPane</h4>

- <div class="summary">

-

- <span>elementsPanel.createSidebarPane</span>(<span class="null"><span>string</span>

- <var><span>title</span></var></span><span class="optional"><span>, </span><span>function</span>

- <var><span>callback</span></var></span>)</div>

- <div class="description">

- <p>Creates a pane within panel's sidebar.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>title</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Text that is displayed in sidebar caption.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>callback</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A callback invoked when the sidebar is created.</dd>

-

-

-

-

- </div>

- </dl>

-

- <dl>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

- If you specify the <em>callback</em> parameter, it should

- specify a function that looks like this:

- </p>

-

- <pre>function(<span>ExtensionSidebarPane result</span>) <span class="subdued">{...}</span>;</pre>

- <dl>

- <div>

- <dt>

- <var>result</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="devtools.panels.html#type-ExtensionSidebarPane">ExtensionSidebarPane</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>An ExtensionSidebarPane object for created sidebar pane.</dd>

-

-

-

-

- </div>

- </dl>

- </div>

-

- </div>

- </div>

- </div>

- </dd>

-

- <dd>

- <div class="apiGroup">

- <a name="global-ElementsPanel-events"></a>

- <h3>Events of ElementsPanel</h3>

-

- <div class="apiItem">

- <a name="event-ElementsPanel-onSelectionChanged"></a>

- <h4>onSelectionChanged</h4>

- <div class="summary">

-

- <span class="subdued">elementsPanel.</span><span>onSelectionChanged</span><span class="subdued">.addListener</span>(function(<span></span>) <span class="subdued">{...}</span><span></span>);

- </div>

- <div class="description">

- <p>Fired when an object is selected in the panel.</p>

-

-

-

- <dl>

- </dl>

- </div>

-

- </div>

- </div>

- </dd>

-

- </div>

- </div><div class="apiItem">

- <a name="type-ExtensionPanel"></a>

- <h4>ExtensionPanel</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Represents a panel created by extension.</dd>

-

-

- <dd>

- <div class="apiGroup">

- <a name="global-ExtensionPanel-methods"></a>

- <h3>Methods of ExtensionPanel</h3>

-

- <div class="apiItem">

- <a name="method-ExtensionPanel-createStatusBarButton"></a>

- <h4>createStatusBarButton</h4>

- <div class="summary"><span>Button</span>

-

- <span>extensionPanel.createStatusBarButton</span>(<span class="null"><span>string</span>

- <var><span>iconPath</span></var></span><span class="null"><span>, </span><span>string</span>

- <var><span>tooltipText</span></var></span><span class="null"><span>, </span><span>boolean</span>

- <var><span>disabled</span></var></span>)</div>

- <div class="description">

- <p>Appends a button to the status bar of the panel.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>iconPath</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Path to the icon of the button. The file should contain a 64x24-pixel image composed of two 32x24 icons. The left icon is used when the button is inactive; the right icon is displayed when the button is pressed.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>tooltipText</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Text shown as a tooltip when user hovers the mouse over the button.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>disabled</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>boolean</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Whether the button is disabled.</dd>

-

-

-

-

- </div>

- </dl>

-

- <h4>Returns</h4>

- <dl>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="devtools.panels.html#type-Button">Button</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

-

-

- </div>

- </div>

- </div>

- </dd>

-

- <dd>

- <div class="apiGroup">

- <a name="global-ExtensionPanel-events"></a>

- <h3>Events of ExtensionPanel</h3>

-

- <div class="apiItem">

- <a name="event-ExtensionPanel-onHidden"></a>

- <h4>onHidden</h4>

- <div class="summary">

-

- <span class="subdued">extensionPanel.</span><span>onHidden</span><span class="subdued">.addListener</span>(function(<span></span>) <span class="subdued">{...}</span><span></span>);

- </div>

- <div class="description">

- <p>Fired when the user switches away from the panel.</p>

-

-

-

- <dl>

- </dl>

- </div>

-

- </div><div class="apiItem">

- <a name="event-ExtensionPanel-onSearch"></a>

- <h4>onSearch</h4>

- <div class="summary">

-

- <span class="subdued">extensionPanel.</span><span>onSearch</span><span class="subdued">.addListener</span>(function(<span>string action, string queryString</span>) <span class="subdued">{...}</span><span></span>);

- </div>

- <div class="description">

- <p>Fired upon a search action (start of a new search, search result navigation, or search being canceled).</p>

-

- <div>

- <h4>Listener parameters</h4>

- <dl>

- <div>

- <dt>

- <var>action</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Type of search action being performed.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>queryString</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Query string (only for 'performSearch').</dd>

-

-

-

-

- </div>

- </dl>

- </div>

-

-

- <dl>

- </dl>

- </div>

-

- </div><div class="apiItem">

- <a name="event-ExtensionPanel-onShown"></a>

- <h4>onShown</h4>

- <div class="summary">

-

- <span class="subdued">extensionPanel.</span><span>onShown</span><span class="subdued">.addListener</span>(function(<span>Window window</span>) <span class="subdued">{...}</span><span></span>);

- </div>

- <div class="description">

- <p>Fired when the user switches to the panel.</p>

-

- <div>

- <h4>Listener parameters</h4>

- <dl>

- <div>

- <dt>

- <var>window</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>Window</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The <code>window</code> object of panel's page.</dd>

-

-

-

-

- </div>

- </dl>

- </div>

-

-

- <dl>

- </dl>

- </div>

-

- </div>

- </div>

- </dd>

-

- </div>

- </div><div class="apiItem">

- <a name="type-ExtensionSidebarPane"></a>

- <h4>ExtensionSidebarPane</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A sidebar created by the extension.</dd>

-

-

- <dd>

- <div class="apiGroup">

- <a name="global-ExtensionSidebarPane-methods"></a>

- <h3>Methods of ExtensionSidebarPane</h3>

-

- <div class="apiItem">

- <a name="method-ExtensionSidebarPane-setExpression"></a>

- <h4>setExpression</h4>

- <div class="summary">

-

- <span>extensionSidebarPane.setExpression</span>(<span class="null"><span>string</span>

- <var><span>expression</span></var></span><span class="optional"><span>, </span><span>string</span>

- <var><span>rootTitle</span></var></span><span class="optional"><span>, </span><span>function</span>

- <var><span>callback</span></var></span>)</div>

- <div class="description">

- <p>Sets an expression that is evaluated within the inspected page. The result is displayed in the sidebar pane.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>expression</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>An expression to be evaluated in context of the inspected page. JavaScript objects and DOM nodes are displayed in an expandable tree similar to the console/watch.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>rootTitle</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>An optional title for the root of the expression tree.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>callback</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A callback invoked after the sidebar pane is updated with the expression evaluation results.</dd>

-

-

-

-

- </div>

- </dl>

-

- <dl>

- </dl>

-

-

- </div>

- </div><div class="apiItem">

- <a name="method-ExtensionSidebarPane-setHeight"></a>

- <h4>setHeight</h4>

- <div class="summary">

-

- <span>extensionSidebarPane.setHeight</span>(<span class="null"><span>string</span>

- <var><span>height</span></var></span>)</div>

- <div class="description">

- <p>Sets the height of the sidebar.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>height</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A CSS-like size specification, such as <code>'100px'</code> or <code>'12ex'</code>.</dd>

-

-

-

-

- </div>

- </dl>

-

- <dl>

- </dl>

-

-

- </div>

- </div><div class="apiItem">

- <a name="method-ExtensionSidebarPane-setObject"></a>

- <h4>setObject</h4>

- <div class="summary">

-

- <span>extensionSidebarPane.setObject</span>(<span class="null"><span>string</span>

- <var><span>jsonObject</span></var></span><span class="optional"><span>, </span><span>string</span>

- <var><span>rootTitle</span></var></span><span class="optional"><span>, </span><span>function</span>

- <var><span>callback</span></var></span>)</div>

- <div class="description">

- <p>Sets a JSON-compliant object to be displayed in the sidebar pane.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>jsonObject</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>An object to be displayed in context of the inspected page. Evaluated in the context of the caller (API client).</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>rootTitle</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>An optional title for the root of the expression tree.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>callback</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A callback invoked after the sidebar is updated with the object.</dd>

-

-

-

-

- </div>

- </dl>

-

- <dl>

- </dl>

-

-

- </div>

- </div><div class="apiItem">

- <a name="method-ExtensionSidebarPane-setPage"></a>

- <h4>setPage</h4>

- <div class="summary">

-

- <span>extensionSidebarPane.setPage</span>(<span class="null"><span>string</span>

- <var><span>path</span></var></span>)</div>

- <div class="description">

- <p>Sets an HTML page to be displayed in the sidebar pane.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>path</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Relative path of an extension page to display within the sidebar.</dd>

-

-

-

-

- </div>

- </dl>

-

- <dl>

- </dl>

-

-

- </div>

- </div>

- </div>

- </dd>

-

- <dd>

- <div class="apiGroup">

- <a name="global-ExtensionSidebarPane-events"></a>

- <h3>Events of ExtensionSidebarPane</h3>

-

- <div class="apiItem">

- <a name="event-ExtensionSidebarPane-onHidden"></a>

- <h4>onHidden</h4>

- <div class="summary">

-

- <span class="subdued">extensionSidebarPane.</span><span>onHidden</span><span class="subdued">.addListener</span>(function(<span></span>) <span class="subdued">{...}</span><span></span>);

- </div>

- <div class="description">

- <p>Fired when the sidebar pane becomes hidden as a result of the user switching away from the panel that hosts the sidebar pane.</p>

-

-

-

- <dl>

- </dl>

- </div>

-

- </div><div class="apiItem">

- <a name="event-ExtensionSidebarPane-onShown"></a>

- <h4>onShown</h4>

- <div class="summary">

-

- <span class="subdued">extensionSidebarPane.</span><span>onShown</span><span class="subdued">.addListener</span>(function(<span>Window window</span>) <span class="subdued">{...}</span><span></span>);

- </div>

- <div class="description">

- <p>Fired when the sidebar pane becomes visible as a result of user switching to the panel that hosts it.</p>

-

- <div>

- <h4>Listener parameters</h4>

- <dl>

- <div>

- <dt>

- <var>window</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>Window</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The <code>window</code> object of the sidebar page, if one was set with the <code>setPage()</code> method.</dd>

-

-

-

-

- </div>

- </dl>

- </div>

-

-

- <dl>

- </dl>

- </div>

-

- </div>

- </div>

- </dd>

-

- </div>

- </div><div class="apiItem">

- <a name="type-Button"></a>

- <h4>Button</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A button created by the extension.</dd>

-

-

- <dd>

- <div class="apiGroup">

- <a name="global-Button-methods"></a>

- <h3>Methods of Button</h3>

-

- <div class="apiItem">

- <a name="method-Button-update"></a>

- <h4>update</h4>

- <div class="summary">

-

- <span>button.update</span>(<span class="optional"><span>string</span>

- <var><span>iconPath</span></var></span><span class="optional"><span>, </span><span>string</span>

- <var><span>tooltipText</span></var></span><span class="optional"><span>, </span><span>boolean</span>

- <var><span>disabled</span></var></span>)</div>

- <div class="description">

- <p>Updates the attributes of the button. If some of the arguments are omitted or <code>null</code>, the corresponding attributes are not updated.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>iconPath</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Path to the new icon of the button.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>tooltipText</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Text shown as a tooltip when user hovers the mouse over the button.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>disabled</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>boolean</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Whether the button is disabled.</dd>

-

-

-

-

- </div>

- </dl>

-

- <dl>

- </dl>

-

-

- </div>

- </div>

- </div>

- </dd>

-

- <dd>

- <div class="apiGroup">

- <a name="global-Button-events"></a>

- <h3>Events of Button</h3>

-

- <div class="apiItem">

- <a name="event-Button-onClicked"></a>

- <h4>onClicked</h4>

- <div class="summary">

-

- <span class="subdued">button.</span><span>onClicked</span><span class="subdued">.addListener</span>(function(<span></span>) <span class="subdued">{...}</span><span></span>);

- </div>

- <div class="description">

- <p>Fired when the button is clicked.</p>

-

-

-

- <dl>

- </dl>

- </div>

-

- </div>

- </div>

- </dd>

-

- </div>

- </div>

- </div>

- </div>

- </div>

- </div>

- </div>

- <div id="gc-footer" --="">

- <div class="text">

- <p>

- Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,

- the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons

- Attribution 3.0 License</a>, and code samples are licensed under the

- <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>.

- </p>

- <p>

- </p>

-

-<script src="https://www.google-analytics.com/urchin.js" type="text/javascript"></script>

-<script src="https://www.google-analytics.com/ga.js" type="text/javascript"></script>

-<script type="text/javascript">

- // chrome doc tracking

- try {

- var engdocs = _gat._getTracker("YT-10763712-2");

- engdocs._trackPageview();

- } catch(err) {}

- // code.google.com site-wide tracking

- try {

- _uacct="UA-18071-1";

- _uanchor=1;

- _uff=0;

- urchinTracker();

- }

- catch(e) {/* urchinTracker not available. */}

-</script>

-

- </div>

- </div>

- </div>

-</body></html>

« no previous file with comments | « chrome/common/extensions/docs/devtools.network.html ('k') | chrome/common/extensions/docs/docs.html » ('j') | no next file with comments »